getstream - npm Package Compare versions

Comparing version 8.0.0 to 8.0.1

lib/reaction.d.ts

@@ -38,2 +38,4 @@ import { StreamClient, APIResponse, UR, DefaultGenerics } from './client';
     activity_id?: string;
+    children_user_id?: string;
+    filter_user_id?: string;
     id_gt?: string;
@@ -40,0 +42,0 @@ id_gte?: string;

package.json

@@ -14,4 +14,6 @@ {
   "license": "BSD-3-Clause",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "scripts": {
+    "changelog": "standard-version --release-as $VERSION --skip.tag --skip.commit --tag-prefix=v",
+    "commitlinter": "commitlint",
     "transpile": "babel src --out-dir lib --extensions '.ts'",
@@ -76,2 +78,4 @@ "types": "tsc --emitDeclarationOnly",
     "chai": "^4.3.4",
+    "@commitlint/cli": "^16.0.2",
+    "@commitlint/config-conventional": "^16.0.0",
     "dotenv": "^10.0.0",
@@ -101,2 +105,3 @@ "eslint": "^8.6.0",
     "request": "^2.88.2",
+    "standard-version": "^9.3.2",
     "testdouble": "^3.16.4",
@@ -103,0 +108,0 @@ "typescript": "^4.5.4",

README.md

@@ -1,7 +0,22 @@
-# Stream-JS
+# Official JavaScript SDK for [Stream Feeds](https://getstream.io/activity-feeds/)
 
-[![build](https://github.com/GetStream/stream-js/workflows/build/badge.svg)](https://github.com/GetStream/stream-js/actions)
-
+[![build](https://github.com/GetStream/stream-js/workflows/build/badge.svg)](https://github.com/GetStream/stream-js/actions) 
 [![NPM](https://nodei.co/npm/getstream.png)](https://nodei.co/npm/getstream/)
 
+<p align="center">
+    <img src="./assets/logo.svg" width="50%" height="50%">
+</p>
+<p align="center">
+    Official JavaScript API client for Stream Feeds, a web service for building scalable newsfeeds and activity streams.
+    <br />
+    <a href="https://getstream.io/activity-feeds/docs/?language=javascript"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/GetStream/stream-js/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/GetStream/stream-js/issues">Request Feature</a>
+</p>
+
+## 📝 About Stream
+
 [stream-js](https://github.com/GetStream/stream-js) is the official JavaScript client for [Stream](https://getstream.io/), a web service for building scalable newsfeeds and activity streams.
@@ -13,5 +28,5 @@
 
-### Installation
+## ⚙️ Installation
 
-#### Install from NPM/YARN
+### Install from NPM/YARN
 
@@ -40,3 +55,3 @@ ```bash
 
-#### Install by downloading the JS file
+### Install by downloading the JS file
 
@@ -48,3 +63,3 @@ [JS](https://raw.githubusercontent.com/GetStream/stream-js/main/dist/js/getstream.js) /
 
-### Full documentation
+## 📚 Full documentation
 
@@ -57,3 +72,3 @@ Documentation for this JavaScript client are available at the [Stream website](https://getstream.io/docs/?language=js).
 
-### Usage
+## ✨ Getting started
 
@@ -366,3 +381,3 @@ ### API client setup Node
 
-#### Node version requirements & Browser support
+## ⚠️ Node version requirements & Browser support
 
@@ -373,5 +388,5 @@ This API Client project requires Node.js v10 at a minimum.
 
-See the [github action configuration](.github/workflows/ci.yml) for details of how it is built, tested and packaged.
+See the [github action configuration](.github/workflows/) for details of how it is built, tested and packaged.
 
-## Contributing
+## ♻️ Contributing
 
@@ -386,4 +401,6 @@ See extensive at [test documentation](test/README.md) for your changes.
 
-## We are hiring!
+We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our [license file](./LICENSE) for more details.
 
+## 🧑‍💻 We are hiring!
+
 We've recently closed a [$38 million Series B funding round](https://techcrunch.com/2021/03/04/stream-raises-38m-as-its-chat-and-activity-feed-apis-power-communications-for-1b-users/) and we keep actively growing.
@@ -390,0 +407,0 @@ Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.

src/reaction.ts

@@ -66,2 +66,4 @@ import { StreamClient, APIResponse, UR, DefaultGenerics } from './client';
   activity_id?: string;
+  children_user_id?: string;
+  filter_user_id?: string;
   id_gt?: string;
@@ -68,0 +70,0 @@ id_gte?: string;

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

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

776958

increased by0.26%

Lines of code

15590

increased by0.03%

Number of lines in readme file

403

increased by4.4%

Worsened metrics

Dev dependency count

46

increased by6.98%

No dependency changes