chatkitty - npm Package Compare versions

Comparing version 1.9.0 to 1.10.0

package.json

 {
   "name": "chatkitty",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Build chat in minutes with ChatKitty's real-time messaging framework.",
-  "main": "build/main/index.js",
-  "typings": "build/main/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
   "repository": "https://github.com/ChatKitty/chatkitty-js",
@@ -19,3 +20,5 @@ "license": "MIT",
     "build": "run-p build:*",
+    "build:version": "genversion --es6 src/environment/version.ts",
     "build:main": "tsc -p tsconfig.json",
+    "build:module": "tsc -p tsconfig.module.json",
     "fix": "run-s fix:*",
@@ -39,8 +42,8 @@ "fix:prettier": "prettier \"src/**/*.ts\" --write",
     "doc": "run-s doc:html && open-cli build/docs/index.html",
-    "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
-    "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
-    "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
+    "doc:html": "typedoc --name \"ChatKitty JS SDK\" --out docs src/index.ts --excludePrivate --plugin typedoc-plugin-extras --favicon .docs/favicon.ico",
+    "doc:md": "typedoc --name \"ChatKitty JS SDK\" --out docs src/index.ts --excludePrivate --plugin typedoc-plugin-markdown",
     "version": "standard-version",
     "reset-hard": "git clean -dfx && git reset --hard && npm i",
-    "prepare-release": "run-s reset-hard src/tests cov:check doc:html version doc:publish"
+    "prepare-release": "run-s reset-hard src/tests cov:check doc:html version doc:publish",
+    "prepare": "husky install && run-p build:*"
   },
@@ -51,5 +54,7 @@ "engines": {
   "dependencies": {
-    "@stomp/rx-stomp": "^0.3.5",
+    "@stomp/rx-stomp": "^1.1.2",
     "axios": "^0.21.1",
-    "rxjs": "^6.6.3",
+    "base-64": "^1.0.0",
+    "rxjs": "^6.6.7",
+    "sockjs-client": "^1.5.1",
     "text-encoding": "^0.7.0"
@@ -59,28 +64,46 @@ },
     "@ava/typescript": "^1.1.1",
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.6",
+    "@rollup/plugin-replace": "^3.0.0",
+    "@rollup/plugin-typescript": "^8.3.0",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@types/base-64": "^1.0.0",
+    "@types/sockjs-client": "^1.5.0",
     "@types/text-encoding": "0.0.35",
     "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^4.5.0",
-    "@typescript-eslint/parser": "^4.5.0",
-    "ava": "^3.12.1",
-    "codecov": "^3.5.0",
-    "cspell": "^4.1.0",
-    "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^7.11.0",
-    "eslint-config-prettier": "^6.11.0",
+    "@typescript-eslint/eslint-plugin": "^4.22.1",
+    "@typescript-eslint/parser": "^4.22.1",
+    "ava": "^3.15.0",
+    "codecov": "^3.8.2",
+    "cspell": "^4.2.8",
+    "eslint": "^7.25.0",
+    "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.22.0",
+    "genversion": "^2.3.1",
     "gh-pages": "^3.1.0",
+    "husky": "^8.0.1",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "open-cli": "^6.0.1",
-    "prettier": "^2.1.1",
-    "standard-version": "^9.0.0",
-    "ts-node": "^9.0.0",
-    "typedoc": "^0.19.2",
-    "typedoc-plugin-extras": "^1.1.7",
-    "typescript": "^4.0.2"
+    "prettier": "^2.2.1",
+    "rollup": "^2.60.0",
+    "rollup-plugin-analyzer": "^4.0.0",
+    "rollup-plugin-ignore": "^1.0.10",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-terser": "^7.0.2",
+    "semantic-release": "^19.0.3",
+    "standard-version": "^9.5.0",
+    "typedoc": "^0.22.12",
+    "typedoc-plugin-extras": "^2.2.3",
+    "typedoc-plugin-markdown": "^3.11.14",
+    "typescript": "^4.4.4"
   },
   "files": [
-    "build/main",
+    "dist",
     "!**/*.spec.*",
@@ -97,3 +120,3 @@ "!**/*.json",
       "rewritePaths": {
-        "src/": "build/main/"
+        "src/": "dist"
       }
@@ -100,0 +123,0 @@ },

README.md

 # chatkitty-js
 
 <p align="center">
-  <img src="https://www.chatkitty.com/images/banner-logo-dark.png" alt="ChatKitty: Cloud Chat Platform" width="315">
+  <img src="https://www.chatkitty.com/img/banner-logo-dark.png"
+       alt="ChatKitty: Cloud Chat Platform" width="315"/>
   <br/>
 </p>
 
-<p align="center">ChatKitty helps you build real-time chat without any back-end.</p>
+<p align="center">
+  ChatKitty helps you build real-time chat without any back-end.
+</p>
 
-<p align="center"><img src="https://www.chatkitty.com/images/blog/posts/building-a-chat-app-with-react-native-and-gifted-chat-part-4/screenshot-simple-typing-indicator.png" width=344 alt="Realtime Chat Demo"></p>
+<p align="center">
+  <img
+      src="https://chatkitty.com/img/screenshots/chatkitty-demo-app.png"
+      width="344" alt="Realtime Chat Demo"/>
+</p>
 
-<p align="center"><em>The example above was created with ChatKitty. Check it out at <a href="https://demo.chatkitty.com/">demo.chatkitty.com</a>.</em></p>
+<p align="center">
+  <em>The example above was created with ChatKitty. Check it out at <a
+      href="https://demo.chatkitty.com/">demo.chatkitty.com</a>.</em>
+</p>
 
-<a href="https://www.npmjs.com/package/chatkitty"><img src="https://nodei.co/npm/chatkitty.png" alt="NPM Package"></a>  
+<a href="https://www.npmjs.com/package/chatkitty">
+  <img src="https://nodei.co/npm/chatkitty.png" alt="NPM Package"/>
+</a>
 
-[![Build Status](https://travis-ci.com/ChatKitty/chatkitty-js.svg?branch=master)](https://travis-ci.com/ChatKitty/chatkitty-js)
-
 Features
@@ -62,14 +72,14 @@ ------------
 ```js
-const kitty = ChatKitty.getInstance(CHATKITTY_API_KEY);
+const kitty = ChatKittyImpl.getInstance(CHATKITTY_API_KEY);
 
 useEffect(() => {
-  // start real-time chat session
-  let result = kitty.startChatSession({
-    channel: channel,
-    onReceivedMessage: (message) => {
-      showMessage(message); // update your UI as new chat events occur
-    },
-  });
+    // start real-time chat session
+    let result = kitty.startChatSession({
+        channel: channel,
+        onReceivedMessage: (message) => {
+            showMessage(message); // update your UI as new chat events occur
+        },
+    });
 
-  return result.session.end;
+    return result.session.end;
 }, []);
@@ -99,5 +109,6 @@ ```
 ### Initialize the SDK with your API key
-With your API key you can initialize a new instance of the [ChatKitty JS client](https://chatkitty.github.io/chatkitty-js/classes/_lib_chatkitty_.chatkitty.html):
+With your API key you can initialize a new instance of the [ChatKitty JS client](https://chatkitty.github.io/chatkitty-js/classes/default.html):
+
 ```js
-const kitty = ChatKitty.getInstance(CHATKITTY_API_KEY);
+const kitty = ChatKittyImpl.getInstance(CHATKITTY_API_KEY);
 ```
@@ -104,0 +115,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

577507

increased by245.48%

Number of package files

104

increased by55.22%

Lines of code

8317

increased by251.52%

Number of lines in readme file

196

increased by5.95%

Worsened metrics

Dependency count

6

increased by50%

Dev dependency count

42

increased by75%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedbase-64@^1.0.0

• + Addedsockjs-client@^1.5.1

• + Added@stomp/rx-stomp@1.2.0(transitive)

• + Added@stomp/stompjs@6.1.2(transitive)

• + Addedbase-64@1.0.0(transitive)

• + Addeddebug@3.2.7(transitive)

• + Addedeventsource@2.0.2(transitive)

• + Addedfaye-websocket@0.11.4(transitive)

• + Addedhttp-parser-js@0.5.8(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedms@2.1.3(transitive)

• + Addedquerystringify@2.2.0(transitive)

• + Addedrequires-port@1.0.0(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsockjs-client@1.6.1(transitive)

• + Addedurl-parse@1.5.10(transitive)

• + Addedwebsocket-driver@0.7.4(transitive)

• + Addedwebsocket-extensions@0.1.4(transitive)

• - Removed@stomp/rx-stomp@0.3.5(transitive)

• - Removed@stomp/stompjs@5.4.4(transitive)

• Updated@stomp/rx-stomp@^1.1.2

• Updatedrxjs@^6.6.7