From fb79de051e9213318e19f4a6a47014cecd227679 Mon Sep 17 00:00:00 2001 From: DaniloLima122 Date: Fri, 10 Nov 2023 09:55:30 -0300 Subject: [PATCH 1/2] feat(zaity): it adds main features --- .github/workflows/build_release.yml | 6 ++++++ .gitignore | 1 + .releaserc | 2 +- CHANGELOG.md | 6 ------ package.json | 4 ++-- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.github/workflows/build_release.yml b/.github/workflows/build_release.yml index d0454a9..2ca709d 100644 --- a/.github/workflows/build_release.yml +++ b/.github/workflows/build_release.yml @@ -42,6 +42,12 @@ jobs: - name: Install dependencies run: npm ci --ignore-scripts + - name: Build + run: npm run build --if-present + + - name: Create Zip + run: mkdir temp && zip -r temp/zaity.zip lib package.json LICENSE + - name: Release env: GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} diff --git a/.gitignore b/.gitignore index 88edb62..aaba4a0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ node_modules/ lib/ +index.html \ No newline at end of file diff --git a/.releaserc b/.releaserc index 14d671c..92a59db 100644 --- a/.releaserc +++ b/.releaserc @@ -23,7 +23,7 @@ "@semantic-release/github", { "assets": [ - "lib/**/*", + "lib/*", "CHANGELOG.md" ] } diff --git a/CHANGELOG.md b/CHANGELOG.md index bf77c41..e69de29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +0,0 @@ -# [1.0.0-beta.2](https://github.com/danilolmc/zaity/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2023-10-30) - - -### Bug Fixes - -* **bundling:** it fixes bundling configs ([fedf400](https://github.com/danilolmc/zaity/commit/fedf400f78a30a85f338f487d27d94b3a180e32f)) diff --git a/package.json b/package.json index 2654b3d..970da16 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "zaity", - "version": "1.0.0-beta.1", + "name": "@zaity/web", + "version": "1.0.0", "description": "Your voice accessibility library for web", "exports": { ".": { From 263b316d04f05e0a073d763dadd3de235a5ea06a Mon Sep 17 00:00:00 2001 From: Danilo Lima Date: Fri, 10 Nov 2023 21:42:59 -0300 Subject: [PATCH 2/2] Chore/commits (#17) * fix(lib): it fixes commit history messages --- .github/workflows/build_release.yml | 20 -- .gitignore | 2 +- package-lock.json | 360 +++++++--------------------- package.json | 12 +- src/browser/index.js | 4 +- src/error/index.js | 6 + src/features/transcription/index.js | 9 +- src/features/voiceAction/index.js | 8 +- src/index.js | 9 + src/utils/index.js | 8 + tsconfig.json | 3 +- 11 files changed, 136 insertions(+), 305 deletions(-) create mode 100644 src/error/index.js create mode 100644 src/index.js create mode 100644 src/utils/index.js diff --git a/.github/workflows/build_release.yml b/.github/workflows/build_release.yml index 2ca709d..1155615 100644 --- a/.github/workflows/build_release.yml +++ b/.github/workflows/build_release.yml @@ -6,28 +6,8 @@ on: - main - beta jobs: - build: - name: Build - runs-on: ubuntu-latest - steps: - - name: Clone repository - uses: actions/checkout@v3 - - - name: Use Node.js - uses: actions/setup-node@v3 - with: - node-version: lts/* - cache: "npm" - - name: Install dependencies - run: npm ci --ignore-scripts - - - name: Build - run: npm run build --if-present - release: name: Release - needs: - - build runs-on: ubuntu-latest steps: - name: Checkout diff --git a/.gitignore b/.gitignore index aaba4a0..99c513e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ node_modules/ lib/ -index.html \ No newline at end of file +index.html diff --git a/package-lock.json b/package-lock.json index a553f96..9c0295b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "zaity", - "version": "1.0.0-beta.1", + "version": "1.0.6", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "zaity", - "version": "1.0.0-beta.1", + "version": "1.0.6", "hasInstallScript": true, "license": "ISC", "devDependencies": { @@ -2582,95 +2582,6 @@ "node": ">=v14" } }, - "node_modules/@commitlint/cli/node_modules/execa": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", - "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", - "dev": true, - "dependencies": { - "cross-spawn": "^7.0.3", - "get-stream": "^6.0.0", - "human-signals": "^2.1.0", - "is-stream": "^2.0.0", - "merge-stream": "^2.0.0", - "npm-run-path": "^4.0.1", - "onetime": "^5.1.2", - "signal-exit": "^3.0.3", - "strip-final-newline": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/execa?sponsor=1" - } - }, - "node_modules/@commitlint/cli/node_modules/human-signals": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", - "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", - "dev": true, - "engines": { - "node": ">=10.17.0" - } - }, - "node_modules/@commitlint/cli/node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", - "dev": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@commitlint/cli/node_modules/mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/@commitlint/cli/node_modules/npm-run-path": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", - "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", - "dev": true, - "dependencies": { - "path-key": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@commitlint/cli/node_modules/onetime": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", - "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", - "dev": true, - "dependencies": { - "mimic-fn": "^2.1.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@commitlint/cli/node_modules/strip-final-newline": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", - "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/@commitlint/config-conventional": { "version": "17.6.7", "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-17.6.7.tgz", @@ -2911,95 +2822,6 @@ "node": ">=v14" } }, - "node_modules/@commitlint/rules/node_modules/execa": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", - "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", - "dev": true, - "dependencies": { - "cross-spawn": "^7.0.3", - "get-stream": "^6.0.0", - "human-signals": "^2.1.0", - "is-stream": "^2.0.0", - "merge-stream": "^2.0.0", - "npm-run-path": "^4.0.1", - "onetime": "^5.1.2", - "signal-exit": "^3.0.3", - "strip-final-newline": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/execa?sponsor=1" - } - }, - "node_modules/@commitlint/rules/node_modules/human-signals": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", - "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", - "dev": true, - "engines": { - "node": ">=10.17.0" - } - }, - "node_modules/@commitlint/rules/node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", - "dev": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@commitlint/rules/node_modules/mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/@commitlint/rules/node_modules/npm-run-path": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", - "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", - "dev": true, - "dependencies": { - "path-key": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/@commitlint/rules/node_modules/onetime": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", - "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", - "dev": true, - "dependencies": { - "mimic-fn": "^2.1.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@commitlint/rules/node_modules/strip-final-newline": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", - "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/@commitlint/to-lines": { "version": "17.4.0", "resolved": "https://registry.npmjs.org/@commitlint/to-lines/-/to-lines-17.4.0.tgz", @@ -7697,95 +7519,6 @@ "node": ">= 10" } }, - "node_modules/default-gateway/node_modules/execa": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", - "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", - "dev": true, - "dependencies": { - "cross-spawn": "^7.0.3", - "get-stream": "^6.0.0", - "human-signals": "^2.1.0", - "is-stream": "^2.0.0", - "merge-stream": "^2.0.0", - "npm-run-path": "^4.0.1", - "onetime": "^5.1.2", - "signal-exit": "^3.0.3", - "strip-final-newline": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/execa?sponsor=1" - } - }, - "node_modules/default-gateway/node_modules/human-signals": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", - "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", - "dev": true, - "engines": { - "node": ">=10.17.0" - } - }, - "node_modules/default-gateway/node_modules/is-stream": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", - "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", - "dev": true, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/default-gateway/node_modules/mimic-fn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", - "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/default-gateway/node_modules/npm-run-path": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", - "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", - "dev": true, - "dependencies": { - "path-key": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/default-gateway/node_modules/onetime": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", - "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", - "dev": true, - "dependencies": { - "mimic-fn": "^2.1.0" - }, - "engines": { - "node": ">=6" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/default-gateway/node_modules/strip-final-newline": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", - "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/defaults": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", @@ -9159,6 +8892,86 @@ "safe-buffer": "^5.1.1" } }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dev": true, + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/execa/node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/execa/node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/execa/node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/execa/node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dev": true, + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/execa/node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/expand-brackets": { "version": "2.1.4", "resolved": "https://registry.npmjs.org/expand-brackets/-/expand-brackets-2.1.4.tgz", @@ -10517,6 +10330,15 @@ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", "dev": true }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "dev": true, + "engines": { + "node": ">=10.17.0" + } + }, "node_modules/husky": { "version": "8.0.3", "resolved": "https://registry.npmjs.org/husky/-/husky-8.0.3.tgz", diff --git a/package.json b/package.json index 970da16..dfc2bba 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,9 @@ { - "name": "@zaity/web", + "name": "zaity-kit", "version": "1.0.0", "description": "Your voice accessibility library for web", + "main": "./lib/cjs/browser.cjs.js", + "module": "./lib/esm/browser.esm.js", "exports": { ".": { "import": "./lib/esm/browser.esm.js", @@ -19,12 +21,16 @@ "types": "./lib/types/middlewares/index.d.ts" } }, + "types": "./lib/types/index.d.ts", "files": [ - "lib/**/*", + "lib", "README.md", "LICENSE", "logolibrary.svg" ], + "publishConfig": { + "access": "public" + }, "scripts": { "build": "npm run build:prod", "build:dev": "webpack --config webpack.config.js --mode development && npm run types", @@ -33,7 +39,7 @@ "prepare": "husky install", "postinstall": "npx husky install", "docs": "jsdoc -c jsdoc.config.json", - "types": "tsc --allowJs -d --emitDeclarationOnly", + "types": "tsc", "ci": "npm pkg delete scripts.prepare & npm ci --omit=dev", "semantic-release": "semantic-release" }, diff --git a/src/browser/index.js b/src/browser/index.js index 3491a01..84999ad 100644 --- a/src/browser/index.js +++ b/src/browser/index.js @@ -1,3 +1,3 @@ -export * from '../features/recognition'; +export * from '../features/voiceSyntesis'; export * from '../features/voiceAction'; -export * from '../features/voiceSyntesis'; \ No newline at end of file +export * from '../features/recognition'; \ No newline at end of file diff --git a/src/error/index.js b/src/error/index.js new file mode 100644 index 0000000..edc9c96 --- /dev/null +++ b/src/error/index.js @@ -0,0 +1,6 @@ +export * from './commandNotFound' +export * from './deniedPermission' +export * from './invalidLangCode' +export * from './invalidRecognitionCallbackType' +export * from './invalidVoiceCommandCallbackType' +export * from './deniedPermission' \ No newline at end of file diff --git a/src/features/transcription/index.js b/src/features/transcription/index.js index fb7fe17..edf2020 100644 --- a/src/features/transcription/index.js +++ b/src/features/transcription/index.js @@ -2,8 +2,11 @@ import { StartTranscriptionJobCommand, TranscribeClient } from "@aws-sdk/client- /** * Creates a transcriber for transcription services. - * @param {object} credentials - The authentication credentials for the transcription service. - * @returns {object} - An object containing methods for configuration and transcription. + * @param {import("@aws-sdk/client-transcribe").TranscribeClientConfig} credentials - The authentication credentials for the transcription service. + * @returns {{ + * setJobParams: (params: import("@aws-sdk/client-transcribe").StartTranscriptionJobCommandInput) => void, + * transcribe(success: Function, error: Function): void + * }} */ export function Transcriber(credentials) { let transribeClient; @@ -50,12 +53,10 @@ export function Transcriber(credentials) { }); } - // Configure the transcriber if credentials are provided if (credentials) { config(credentials); } - // Return an object with configured methods return { setJobParams, transcribe diff --git a/src/features/voiceAction/index.js b/src/features/voiceAction/index.js index 4fc2af1..53499fe 100644 --- a/src/features/voiceAction/index.js +++ b/src/features/voiceAction/index.js @@ -86,10 +86,10 @@ export function VoiceCommand(commandParams) { * @param {Function} [options.onStart=() => {}] - A callback function to be executed when listening starts. * @returns {void} */ - function listenVoiceCommand({ - onEnd = () => { }, - onStart = () => { } - }) { + function listenVoiceCommand( + onStart = () => { }, + onEnd = () => { } + ) { createInstance(); recognitionInstance.onresult = event => { diff --git a/src/index.js b/src/index.js new file mode 100644 index 0000000..993519a --- /dev/null +++ b/src/index.js @@ -0,0 +1,9 @@ +export * from './browser' +export * from './features/recognition' +export * from './features/transcription' +export * from './features/voiceSyntesis' +export * from './features/voiceAction' +export * from './middlewares' +export * from './error' +export * from './utils' +export * from './node' \ No newline at end of file diff --git a/src/utils/index.js b/src/utils/index.js new file mode 100644 index 0000000..6de6f47 --- /dev/null +++ b/src/utils/index.js @@ -0,0 +1,8 @@ +export * from './IsSpeechRecognitionSupported' +export * from './IsSpeechSyntesisSupported' +export * from './applyMiddlewares' +export * from './builders/speechRecognitionBuilder' +export * from './builders/speechSynthesisBuilder' +export * from './constantsValues' +export * from './debounce' +export * from './isBrowserEnv' \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json index 7cfdbda..870da1a 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,7 +1,6 @@ { "include": [ - "src/features/**/*.js", - "src/middlewares/**/*.js" + "src/index.js" ], "compilerOptions": { "allowJs": true,