@speechly/react-client - npm Package Compare versions

Comparing version 0.0.22 to 0.0.23

package.json

 {
   "name": "@speechly/react-client",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "React client for Speechly SLU API",
-  "private": false,
   "keywords": [
@@ -27,5 +26,19 @@ "react",
   ],
+  "scripts": {
+    "getdeps": "pnpm install --force --frozen-lockfile",
+    "build": "pnpm run lint && rm -rf ./dist/ && npx tsc",
+    "build:watch": "rm -rf ./dist/ && npx tsc",
+    "lint": "npx eslint --cache --max-warnings 0 'src/**/*.{ts,tsx}'",
+    "test": "echo 'Pending...'",
+    "check": "pnpm run build && npx api-extractor run --verbose",
+    "docs": "pnpm run prepdist && npx typedoc --readme none --includeDeclarations --excludeExternals --excludeNotExported --excludePrivate --excludeProtected --out ./docs/ --plugin typedoc-plugin-markdown ./dist/index.d.ts",
+    "prepdist": "node ./config/prepare_dist.js",
+    "precommit": "npx prettier --write src/**/*.ts && pnpm run build && npx api-extractor run --local && pnpm run docs",
+    "prerelease": "pnpm run check && pnpm run prepdist",
+    "watch": "rm -rf ./dist/ && mkdir dist && pnpm run prepdist && npx tsc-watch"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/speechly/react-client.git"
+    "url": "git+https://github.com/speechly/speechly.git",
+    "directory": "libraries/react-client"
   },
@@ -35,15 +48,15 @@ "bugs": {
   },
-  "main": "./index.js",
-  "types": "./index.d.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "author": "Speechly",
   "license": "MIT",
   "dependencies": {
-    "@speechly/browser-client": "^1.0.18"
+    "@speechly/browser-client": ">=1.0.19"
   },
   "peerDependencies": {
-    "react": "^17.0.2"
+    "react": ">=16.13.1"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.10.4",
-    "@types/react": "^17.0.3",
+    "@types/react": ">=16.13.1",
     "@typescript-eslint/eslint-plugin": "^4.4.0",
@@ -60,3 +73,3 @@ "@typescript-eslint/parser": "^4.4.0",
     "prettier": "^2.1.2",
-    "react": "^17.0.2",
+    "react": ">=16.13.1",
     "ts-loader": "^8.0.4",
@@ -66,4 +79,7 @@ "tsc-watch": "^4.2.9",
     "typedoc-plugin-markdown": "^3.0.7",
-    "typescript": "4.1.5"
+    "typescript": "^4.3.5"
   },
+  "files": [
+    "dist/**/*"
+  ],  
   "publishConfig": {
@@ -70,0 +86,0 @@ "access": "public"

README.md

@@ -1,10 +0,21 @@
-<h1 align="center">
-<a href="https://www.speechly.com/?utm_source=github&utm_medium=react-client&utm_campaign=header"><img src="https://www.speechly.com/img/logo-speechly.svg" height="100" alt="Speechly"></a>
-</h1>
-<h1 align="center">
-Speechly is the Fast, Accurate, and Simple Voice Interface API for Web, Mobile and E-commerce.
-</h1>
+<div align="center" markdown="1">
+<a href="https://www.speechly.com/?utm_source=github&utm_medium=browser-client&utm_campaign=header">
+   <img src="https://d33wubrfki0l68.cloudfront.net/1e70457a60b0627de6ab966f1e0a40cf56f465f5/b4144/img/logo-speechly-colors.svg" height="48">
+</a>
 
-[Speechly website](https://www.speechly.com/?utm_source=github&utm_medium=react-client&utm_campaign=header)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Docs](https://www.speechly.com/docs/?utm_source=github&utm_medium=react-client&utm_campaign=header)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Blog](https://www.speechly.com/blog/?utm_source=github&utm_medium=react-client&utm_campaign=header)
+### Speechly is the Fast, Accurate, and Simple Voice Interface API for Web, Mobile and E‑commerce
 
+[Website](https://www.speechly.com/?utm_source=github&utm_medium=browser-client&utm_campaign=header)
+&ensp;|&ensp;
+[Docs](https://docs.speechly.com/)
+&ensp;|&ensp;
+[Discussions](https://github.com/speechly/speechly/discussions)
+&ensp;|&ensp;
+[Blog](https://www.speechly.com/blog/?utm_source=github&utm_medium=browser-client&utm_campaign=header)
+&ensp;|&ensp;
+[Podcast](https://anchor.fm/the-speechly-podcast)
+
+---
+</div>
+
 # React client for Speechly SLU API
@@ -18,3 +29,3 @@
 
-Check out [Speechly documentation](https://www.speechly.com/docs/client-libraries/react-client/?utm_source=github&utm_medium=react-client&utm_campaign=text) for a tutorial on how to build a voice filtering app using this client.
+Check out [Speechly documentation](https://docs.speechly.com//client-libraries/react-client/?utm_source=github&utm_medium=react-client&utm_campaign=text) for a tutorial on how to build a voice filtering app using this client.
 
@@ -68,23 +79,7 @@ ## Usage
 
-You can find the detailed API documentation in [GitHub repository](https://github.com/speechly/react-client/blob/master/docs/modules/_index_d_.md).
+You can find the detailed API documentation in [GitHub repository](docs/modules/_index_d_.md).
 
 ## Contributing
 
-See contribution guide in [CONTRIBUTING.md](https://github.com/speechly/react-client/blob/master/CONTRIBUTING.md).
+See contribution guide in [CONTRIBUTING.md](https://github.com/speechly/speechly/blob/main/CONTRIBUTING.md).
 
-## About Speechly
-
-Speechly is a developer tool for building real-time multimodal voice user interfaces. It enables developers and designers to enhance their current touch user interface with voice functionalities for better user experience. Speechly key features:
-
-#### Speechly key features
-
-- Fully streaming API
-- Multi modal from the ground up
-- Easy to configure for any use case
-- Fast to integrate to any touch screen application
-- Supports natural corrections such as "Show me red – i mean blue t-shirts"
-- Real time visual feedback encourages users to go on with their voice
-
-|                  Example application                  | Description                                                                                                                                                                                                                                                                                                                               |
-| :---------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <img src="https://i.imgur.com/v9o1JHf.gif" width=50%> | Instead of using buttons, input fields and dropdowns, Speechly enables users to interact with the application by using voice. <br />User gets real-time visual feedback on the form as they speak and are encouraged to go on. If there's an error, the user can either correct it by using traditional touch user interface or by voice. |

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

45338

decreased by-14.11%

Number of package files

18

decreased by-5.26%

Lines of code

735

decreased by-24.07%

Number of lines in readme file

84

decreased by-5.62%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Added@speechly/browser-client@2.6.6(transitive)

• + Addedreact@19.0.0(transitive)

• - Removed@speechly/browser-client@1.5.0(transitive)

• - Removedjs-tokens@4.0.0(transitive)

• - Removedloose-envify@1.4.0(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedreact@17.0.2(transitive)

• Updated@speechly/browser-client@>=1.0.19