@stream-io/video-react-bindings 0.0.22 → 0.0.24

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+### [0.0.24](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-bindings-0.0.23...@stream-io/video-react-bindings-0.0.24) (2023-06-22)
+
+### Dependency Updates
+
+* `@stream-io/video-client` updated to version `0.0.1`
+### [0.0.23](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-bindings-0.0.22...@stream-io/video-react-bindings-0.0.23) (2023-06-21)
+
+### Dependency Updates
+
+* `@stream-io/i18n` updated to version `0.0.6`
+* `@stream-io/video-client` updated to version `0.0.1`
+
+### Documentation
+
+* Add reference tables to state docs ([#676](https://github.com/GetStream/stream-video-js/issues/676)) ([39e7a05](https://github.com/GetStream/stream-video-js/commit/39e7a05a79ba1754be7f62412666ec1f9f85aba9))
+* cleanup ([#679](https://github.com/GetStream/stream-video-js/issues/679)) ([58c86bd](https://github.com/GetStream/stream-video-js/commit/58c86bd0354ebe444af361056dcc3fa82c4a926d))
+
 ### [0.0.22](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-bindings-0.0.21...@stream-io/video-react-bindings-0.0.22) (2023-06-21)
 
 ### Dependency Updates

package/dist/src/hooks/call.d.ts

@@ -1,5 +1,5 @@
 /**
- * Utility hook which provides information whether the current call is being recorded.
+ * Utility hook which provides information whether the current call is being recorded. It will return `true` if the call is being recorded.
  *
  * @category Call State
  */
@@ -69,13 +69,13 @@ export declare const useCallMembers: () => import("@stream-io/video-client").Mem
  */
 export declare const useCallRecordings: () => import("@stream-io/video-client").CallRecording[];
 /**
- * Utility hook providing the current calling state of the call.
+ * Utility hook providing the current calling state of the call. For example, `RINGING` or `JOINED`.
  *
  * @category Call State
  */
 export declare const useCallCallingState: () => import("@stream-io/video-client").CallingState;
 /**
- * Utility hook providing the actual start time of the call.
+ * Utility hook providing the actual start time of the current session.
  * Useful for calculating the call duration.
  *
  * @category Call State

package/dist/src/hooks/call.js

@@ -1,7 +1,7 @@
 import { useObservableValue } from './helpers/useObservableValue';
 import { useCallState, useStore } from './store';
 /**
- * Utility hook which provides information whether the current call is being recorded.
+ * Utility hook which provides information whether the current call is being recorded. It will return `true` if the call is being recorded.
  *
  * @category Call State
  */
@@ -101,7 +101,7 @@ export const useCallRecordings = () => {
     return useObservableValue(callRecordingList$);
 };
 /**
- * Utility hook providing the current calling state of the call.
+ * Utility hook providing the current calling state of the call. For example, `RINGING` or `JOINED`.
  *
  * @category Call State
  */
@@ -110,7 +110,7 @@ export const useCallCallingState = () => {
     return useObservableValue(callingState$);
 };
 /**
- * Utility hook providing the actual start time of the call.
+ * Utility hook providing the actual start time of the current session.
  * Useful for calculating the call duration.
  *
  * @category Call State

package/dist/src/hooks/permissions.d.ts

@@ -1,6 +1,6 @@
 import { OwnCapability, PermissionRequestEvent } from '@stream-io/video-client';
 /**
- * Hook that returns true if the current user has all the given permissions.
+ * Hook that returns true if the local participant has all the given permissions.
  *
  * @param permissions the permissions to check.
  *
@@ -8,7 +8,7 @@ import { OwnCapability, PermissionRequestEvent } from '@stream-io/video-client';
  */
 export declare const useHasPermissions: (...permissions: OwnCapability[]) => boolean;
 /**
- * A hook which returns the current user's own capabilities.
+ * A hook which returns the local participant's own capabilities.
  *
  * @category Call State
  */

package/dist/src/hooks/permissions.js

@@ -1,7 +1,7 @@
 import { useCallState } from './store';
 import { useObservableValue } from './helpers/useObservableValue';
 /**
- * Hook that returns true if the current user has all the given permissions.
+ * Hook that returns true if the local participant has all the given permissions.
  *
  * @param permissions the permissions to check.
  *
@@ -12,7 +12,7 @@ export const useHasPermissions = (...permissions) => {
     return permissions.every((permission) => capabilities.includes(permission));
 };
 /**
- * A hook which returns the current user's own capabilities.
+ * A hook which returns the local participant's own capabilities.
  *
  * @category Call State
  */

package/package.json

@@ -7,8 +7,7 @@
   "scripts": {
     "clean": "rimraf dist",
     "start": "tsc --project tsconfig.json --watch",
-    "build": "tsc --project tsconfig.production.json",
-    "generate-docs": "rimraf generated-docs && typedoc --options typedoc.json ./index.ts && replace-in-file '# @stream-io/video-react-bindings' '# Hooks' temp-docs/** && replace-in-file '.md' '' 'temp-docs/**' && mkdir generated-docs && cp temp-docs/modules.md generated-docs/hooks.md && rm -rf temp-docs"
+    "build": "tsc --project tsconfig.production.json"
   },
   "files": [
     "dist",
@@ -23,21 +22,19 @@
     "rxjs": "~7.8.1"
   },
   "peerDependencies": {
-    "@stream-io/i18n": "^0.0.5",
-    "@stream-io/video-client": "^0.0.21",
+    "@stream-io/i18n": "^0.0.6",
+    "@stream-io/video-client": "^0.0.23",
     "react": ">=17.0.0"
   },
   "devDependencies": {
-    "@stream-io/i18n": "^0.0.5",
-    "@stream-io/video-client": "^0.0.21",
+    "@stream-io/i18n": "^0.0.6",
+    "@stream-io/video-client": "^0.0.23",
     "@types/react": "^18.0.26",
     "@types/rimraf": "^3.0.2",
     "react": "^18.2.0",
     "replace-in-file": "^6.3.5",
     "rimraf": "^3.0.2",
-    "typedoc": "^0.24.7",
-    "typedoc-plugin-markdown": "^3.15.3",
     "typescript": "^4.9.5"
   },
-  "version": "0.0.22"
+  "version": "0.0.24"
 }

package/src/hooks/call.ts

@@ -2,7 +2,7 @@ import { useObservableValue } from './helpers/useObservableValue';
 import { useCallState, useStore } from './store';
 
 /**
- * Utility hook which provides information whether the current call is being recorded.
+ * Utility hook which provides information whether the current call is being recorded. It will return `true` if the call is being recorded.
  *
  * @category Call State
  */
@@ -112,7 +112,7 @@ export const useCallRecordings = () => {
 };
 
 /**
- * Utility hook providing the current calling state of the call.
+ * Utility hook providing the current calling state of the call. For example, `RINGING` or `JOINED`.
  *
  * @category Call State
  */
@@ -122,7 +122,7 @@ export const useCallCallingState = () => {
 };
 
 /**
- * Utility hook providing the actual start time of the call.
+ * Utility hook providing the actual start time of the current session.
  * Useful for calculating the call duration.
  *
  * @category Call State

package/src/hooks/permissions.ts

@@ -3,7 +3,7 @@ import { useCallState } from './store';
 import { useObservableValue } from './helpers/useObservableValue';
 
 /**
- * Hook that returns true if the current user has all the given permissions.
+ * Hook that returns true if the local participant has all the given permissions.
  *
  * @param permissions the permissions to check.
  *
@@ -15,7 +15,7 @@ export const useHasPermissions = (...permissions: OwnCapability[]): boolean => {
 };
 
 /**
- * A hook which returns the current user's own capabilities.
+ * A hook which returns the local participant's own capabilities.
  *
  * @category Call State
  */