Typescript Port

.eslintignore

@@ -0,0 +1,9 @@
+node_modules
+dist
+coverage
+*.min.js
+*.config.js
+webpack.config.js
+jest.config.js
+test-site/dist
+examples/**/dist

.eslintrc.json

@@ -0,0 +1,54 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
+  },
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking"
+  ],
+  "rules": {
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_",
+        "varsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-floating-promises": "error",
+    "@typescript-eslint/no-misused-promises": "error",
+    "no-console": ["warn", { "allow": ["warn", "error"] }],
+    "prefer-const": "error",
+    "no-var": "error"
+  },
+  "ignorePatterns": [
+    "dist",
+    "node_modules",
+    "*.js",
+    "*.config.js",
+    "webpack.config.js",
+    "jest.config.js",
+    "coverage",
+    "*.min.js"
+  ],
+  "overrides": [
+    {
+      "files": ["**/*.spec.ts", "**/*.test.ts", "**/tests/**/*.ts"],
+      "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-member-access": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+        "no-console": "off"
+      }
+    }
+  ]
+}

.github/dependabot.yml

@@ -0,0 +1,106 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "ricky0123"
+    labels:
+      - "dependencies"
+      - "automated"
+    commit-message:
+      prefix: "chore(deps)"
+      include: "scope"
+    # Group all non-major updates together
+    groups:
+      development-dependencies:
+        dependency-type: "development"
+        update-types:
+          - "minor"
+          - "patch"
+      production-dependencies:
+        dependency-type: "production"
+        update-types:
+          - "minor"
+          - "patch"
+
+  # Enable version updates for npm in packages/web
+  - package-ecosystem: "npm"
+    directory: "/packages/web"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "ricky0123"
+    labels:
+      - "dependencies"
+      - "vad-web"
+      - "automated"
+    commit-message:
+      prefix: "chore(deps)"
+      include: "scope"
+    groups:
+      development-dependencies:
+        dependency-type: "development"
+        update-types:
+          - "minor"
+          - "patch"
+      production-dependencies:
+        dependency-type: "production"
+        update-types:
+          - "minor"
+          - "patch"
+
+  # Enable version updates for npm in packages/react
+  - package-ecosystem: "npm"
+    directory: "/packages/react"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "ricky0123"
+    labels:
+      - "dependencies"
+      - "vad-react"
+      - "automated"
+    commit-message:
+      prefix: "chore(deps)"
+      include: "scope"
+    groups:
+      development-dependencies:
+        dependency-type: "development"
+        update-types:
+          - "minor"
+          - "patch"
+      production-dependencies:
+        dependency-type: "production"
+        update-types:
+          - "minor"
+          - "patch"
+
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+    open-pull-requests-limit: 3
+    reviewers:
+      - "ricky0123"
+    labels:
+      - "dependencies"
+      - "github-actions"
+      - "automated"
+    commit-message:
+      prefix: "chore(ci)"
+      include: "scope"

.github/workflows/coverage.yml

@@ -0,0 +1,71 @@
+name: Coverage
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package: [packages/web, packages/react]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run coverage
+        run: cd ${{ matrix.package }} && npm run test:coverage
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: (!cancelled())
+        with:
+          files: |
+            ${{ matrix.package }}/test-results/**/*.xml
+            ${{ matrix.package }}/test-results/**/*.trx
+            ${{ matrix.package }}/test-results/**/*.json
+          check_name: Test Results (${{ matrix.package }})
+        continue-on-error: true
+
+      - name: Determine lcov path
+        id: lcov-path
+        run: |
+          if [ -f "${{ matrix.package }}/lcov.info" ]; then
+            echo "path=${{ matrix.package }}/lcov.info" >> $GITHUB_OUTPUT
+          elif [ -f "${{ matrix.package }}/coverage/lcov.info" ]; then
+            echo "path=${{ matrix.package }}/coverage/lcov.info" >> $GITHUB_OUTPUT
+          else
+            echo "path=${{ matrix.package }}/lcov.info" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Upload coverage to Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: ${{ matrix.package }}
+          parallel: true
+          file: ${{ steps.lcov-path.outputs.path }}
+        continue-on-error: true
+
+  finish:
+    needs: coverage
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+          carryforward: true

CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Comprehensive test suite for React package with 14 tests covering useMicVAD hook
+- Additional test coverage for web package (messages, asset-path, model fetcher, real-time VAD)
+- ESLint configuration with TypeScript support for code quality enforcement
+- CONTRIBUTING.md with detailed development guidelines
+- CHANGELOG.md for tracking project changes
+- Coverage workflow for both web and react packages in CI
+- Performance tracking utilities (VADPerformanceTracker, PerformanceTimer)
+- Validation utilities for browser compatibility and audio constraints
+- Configurable logging system with log levels
+- Test infrastructure using vitest with coverage reporting
+
+### Changed
+- Updated test:coverage script to run for all workspaces
+- Improved React hook to properly handle device changes
+- Updated ESLint and TypeScript configurations for stricter type checking
+
+### Removed
+- Dead code and commented-out functions from React package
+- Console.log statements from React package for cleaner production code
+
+### Fixed
+- Coverage workflow now properly tests both packages
+- React package properly recreates VAD instance when getStream changes
+
+## [0.0.28] - 2024-XX-XX
+
+### Added
+- Export new public APIs for validation, logging, and performance tracking
+- TypeScript improvements with stricter type checking
+- Exported `ort` from real-time-vad for advanced usage
+
+### Fixed
+- Start on load mic permissions handling
+
+## [0.0.27] - Earlier
+
+Previous versions tracked in git history. See https://github.com/ricky0123/vad for details.
+
+---
+
+## Types of Changes
+
+- **Added** for new features
+- **Changed** for changes in existing functionality
+- **Deprecated** for soon-to-be removed features
+- **Removed** for now removed features
+- **Fixed** for any bug fixes
+- **Security** in case of vulnerabilities