@stream-io/video-react-bindings 0.0.1-alpha.13

package/dist/src/hooks/call.js

@@ -0,0 +1,116 @@
+import { useObservableValue } from './helpers/useObservableValue';
+import { useCallState, useStore } from './store';
+/**
+ * Utility hook which provides information whether the current call is being recorded.
+ *
+ * @category Call State
+ */
+export const useIsCallRecordingInProgress = () => {
+    const { callRecordingInProgress$ } = useCallState();
+    return useObservableValue(callRecordingInProgress$);
+};
+/**
+ * Utility hook which provides a boolean indicating whether there is
+ * a participant in the current call which shares their screen.
+ *
+ * @category Call State
+ */
+export const useHasOngoingScreenShare = () => {
+    const { hasOngoingScreenShare$ } = useCallState();
+    return useObservableValue(hasOngoingScreenShare$);
+};
+/**
+ * Utility hook which provides the latest stats report of the current call.
+ *
+ * The latest stats report of the current call.
+ * When stats gathering is enabled, this observable will emit a new value
+ * at a regular (configurable) interval.
+ *
+ * Consumers of this observable can implement their own batching logic
+ * in case they want to show historical stats data.
+ *
+ * @category Call State
+ */
+export const useCurrentCallStatsReport = () => {
+    const { callStatsReport$ } = useCallState();
+    return useObservableValue(callStatsReport$);
+};
+/**
+ * Utility hook which provides the dominant speaker of the current call.
+ *
+ * @category Call State
+ */
+export const useDominantSpeaker = () => {
+    const { dominantSpeaker$ } = useCallState();
+    return useObservableValue(dominantSpeaker$);
+};
+/**
+ * Utility hook which provides a list of all notifications about created calls.
+ * In the ring call settings, these calls can be outgoing (I have called somebody)
+ * or incoming (somebody has called me).
+ *
+ * @category Client State
+ */
+export const useCalls = () => {
+    const { calls$ } = useStore();
+    return useObservableValue(calls$);
+};
+/**
+ * Utility hook which provides a list of all incoming ring calls (somebody calls me).
+ *
+ * @deprecated derive from useCalls()/useCall() instead.
+ * @internal
+ * @category Client State
+ */
+export const useIncomingCalls = () => {
+    const { incomingCalls$ } = useStore();
+    return useObservableValue(incomingCalls$);
+};
+/**
+ * Utility hook which provides a list of all outgoing ring calls (I call somebody).
+ *
+ * @deprecated derive from useCalls()/useCall() instead.
+ * @internal
+ * @category Client State
+ */
+export const useOutgoingCalls = () => {
+    const { outgoingCalls$ } = useStore();
+    return useObservableValue(outgoingCalls$);
+};
+/**
+ * Utility hook which provides call metadata (such as blocked users and own capabilities).
+ *
+ * @category Call State
+ */
+export const useCallMetadata = () => {
+    const { metadata$ } = useCallState();
+    return useObservableValue(metadata$);
+};
+/**
+ * Utility hook which provides a list of call members.
+ *
+ * @category Call State
+ */
+export const useCallMembers = () => {
+    const { members$ } = useCallState();
+    return useObservableValue(members$);
+};
+/**
+ * Utility hook providing the latest list of recordings performed during the active call
+ *
+ * @category Call State
+ */
+export const useCallRecordings = () => {
+    const { callRecordingList$ } = useCallState();
+    return useObservableValue(callRecordingList$);
+};
+/**
+ * Utility hook providing the current calling state of the call.
+ *
+ * @category Call State
+ */
+export const useCallCallingState = () => {
+    const { callingState$ } = useCallState();
+    return useObservableValue(callingState$);
+};
+//# sourceMappingURL=call.js.map

package/dist/src/hooks/call.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"call.js","sourceRoot":"","sources":["../../../src/hooks/call.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEjD;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAG,EAAE;IAC/C,MAAM,EAAE,wBAAwB,EAAE,GAAG,YAAY,EAAE,CAAC;IACpD,OAAO,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,EAAE;IAC3C,MAAM,EAAE,sBAAsB,EAAE,GAAG,YAAY,EAAE,CAAC;IAClD,OAAO,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,EAAE;IAC5C,MAAM,EAAE,gBAAgB,EAAE,GAAG,YAAY,EAAE,CAAC;IAC5C,OAAO,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,EAAE;IACrC,MAAM,EAAE,gBAAgB,EAAE,GAAG,YAAY,EAAE,CAAC;IAC5C,OAAO,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,EAAE;IAC3B,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IAC9B,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtC,OAAO,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtC,OAAO,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,EAAE,CAAC;IACrC,OAAO,kBAAkB,CAAC,SAAS,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE;IACjC,MAAM,EAAE,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC;IACpC,OAAO,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACpC,MAAM,EAAE,kBAAkB,EAAE,GAAG,YAAY,EAAE,CAAC;IAC9C,OAAO,kBAAkB,CAAC,kBAAkB,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE;IACtC,MAAM,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,CAAC;IACzC,OAAO,kBAAkB,CAAC,aAAa,CAAC,CAAC;AAC3C,CAAC,CAAC"}

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

@@ -0,0 +1,33 @@
+import { StreamClientOptions, StreamVideoClient, TokenOrProvider, User } from '@stream-io/video-client';
+/**
+ * Exclude types from documentation site, but we should still add doc comments
+ * @internal
+ */
+export type StreamVideoClientInit = {
+    /**
+     * The Stream API key.
+     */
+    apiKey: string;
+    /**
+     * The token or token provider.
+     */
+    tokenOrProvider: TokenOrProvider;
+    /**
+     * The client options.
+     */
+    options?: StreamClientOptions;
+    /**
+     * The user to connect.
+     */
+    user: User;
+    /**
+     * Whether the user is anonymous. Defaults to `false`.
+     */
+    isAnonymous?: boolean;
+};
+/**
+ * Creates a new `StreamVideoClient` instance and connects the given user.
+ *
+ * @category Client State
+ */
+export declare const useCreateStreamVideoClient: ({ apiKey, tokenOrProvider, user, options, isAnonymous, }: StreamVideoClientInit) => StreamVideoClient;

package/dist/src/hooks/client.js

@@ -0,0 +1,36 @@
+import { StreamVideoClient, } from '@stream-io/video-client';
+import { useEffect, useRef, useState } from 'react';
+/**
+ * Creates a new `StreamVideoClient` instance and connects the given user.
+ *
+ * @category Client State
+ */
+export const useCreateStreamVideoClient = ({ apiKey, tokenOrProvider, user, options, isAnonymous = false, }) => {
+    const [client] = useState(() => new StreamVideoClient(apiKey, options));
+    const disconnectRef = useRef(Promise.resolve());
+    useEffect(() => {
+        const connectionPromise = disconnectRef.current.then(() => {
+            if (isAnonymous) {
+                return client
+                    .connectAnonymousUser(user, tokenOrProvider)
+                    .catch((err) => {
+                    console.error(`Failed to establish connection`, err);
+                });
+            }
+            return client.connectUser(user, tokenOrProvider).catch((err) => {
+                console.error(`Failed to establish connection`, err);
+            });
+        });
+        return () => {
+            disconnectRef.current = connectionPromise
+                .then(() => client.disconnectUser())
+                .catch((err) => {
+                console.error(`Failed to disconnect`, err);
+            });
+        };
+        // we want to re-run this effect only in some special cases
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [apiKey, tokenOrProvider, client, isAnonymous, user === null || user === void 0 ? void 0 : user.id]);
+    return client;
+};
+//# sourceMappingURL=client.js.map

package/dist/src/hooks/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/hooks/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,GAGlB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AA6BpD;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,EACzC,MAAM,EACN,eAAe,EACf,IAAI,EACJ,OAAO,EACP,WAAW,GAAG,KAAK,GACG,EAAE,EAAE;IAC1B,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAExE,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAChD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE;YACxD,IAAI,WAAW,EAAE;gBACf,OAAO,MAAM;qBACV,oBAAoB,CAAC,IAAI,EAAE,eAAe,CAAC;qBAC3C,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACb,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAC;gBACvD,CAAC,CAAC,CAAC;aACN;YACD,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC7D,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,aAAa,CAAC,OAAO,GAAG,iBAAiB;iBACtC,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;iBACnC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACF,2DAA2D;QAC3D,uDAAuD;IACzD,CAAC,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,CAAC,CAAC,CAAC;IAE7D,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/dist/src/hooks/helpers/useObservableValue.d.ts

@@ -0,0 +1,6 @@
+import type { Observable } from 'rxjs';
+/**
+ *
+ * @internal
+ */
+export declare const useObservableValue: <T>(observable$: Observable<T>) => T;

package/dist/src/hooks/helpers/useObservableValue.js

@@ -0,0 +1,17 @@
+import { useEffect, useState } from 'react';
+import { RxUtils } from '@stream-io/video-client';
+/**
+ *
+ * @internal
+ */
+export const useObservableValue = (observable$) => {
+    const [value, setValue] = useState(() => RxUtils.getCurrentValue(observable$));
+    useEffect(() => {
+        const subscription = observable$.subscribe(setValue);
+        return () => {
+            subscription.unsubscribe();
+        };
+    }, [observable$]);
+    return value;
+};
+//# sourceMappingURL=useObservableValue.js.map

package/dist/src/hooks/helpers/useObservableValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useObservableValue.js","sourceRoot":"","sources":["../../../../src/hooks/helpers/useObservableValue.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAElD;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAI,WAA0B,EAAE,EAAE;IAClE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAI,GAAG,EAAE,CACzC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CACrC,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,YAAY,GAAG,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACrD,OAAO,GAAG,EAAE;YACV,YAAY,CAAC,WAAW,EAAE,CAAC;QAC7B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}

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

@@ -0,0 +1,6 @@
+export * from './call';
+export * from './client';
+export * from './participants';
+export * from './permissions';
+export * from './store';
+export * from './user';

package/dist/src/hooks/index.js

@@ -0,0 +1,7 @@
+export * from './call';
+export * from './client';
+export * from './participants';
+export * from './permissions';
+export * from './store';
+export * from './user';
+//# sourceMappingURL=index.js.map

package/dist/src/hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC"}

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

@@ -0,0 +1,30 @@
+import type { Comparator, StreamVideoParticipant } from '@stream-io/video-client';
+/**
+ * A hook which provides a list of all participants that have joined an active call.
+ *
+ * @category Call State
+ *
+ * @param options.sortBy - A comparator function to sort the participants by.
+ * Make sure to memoize output of the `combineComparators` function
+ * (or keep it out of component's scope if possible) before passing it down to this property.
+ */
+export declare const useParticipants: ({ sortBy, }?: {
+    /**
+     * Make sure to memoize output of the `combineComparators` function
+     * (or keep it out of component's scope if possible) before passing it down to this property.
+     */
+    sortBy?: Comparator<StreamVideoParticipant> | undefined;
+}) => (StreamVideoParticipant | import("@stream-io/video-client").StreamVideoLocalParticipant)[];
+/**
+ * A hook which provides a StreamVideoLocalParticipant object.
+ * It signals that I have joined a call.
+ *
+ * @category Call State
+ */
+export declare const useLocalParticipant: () => import("@stream-io/video-client").StreamVideoLocalParticipant | undefined;
+/**
+ * A hook which provides a list of all other participants than me that have joined an active call.
+ *
+ * @category Call State
+ */
+export declare const useRemoteParticipants: () => StreamVideoParticipant[];

package/dist/src/hooks/participants.js

@@ -0,0 +1,42 @@
+import { useObservableValue } from './helpers/useObservableValue';
+import { useCallState } from './store';
+import { useMemo } from 'react';
+/**
+ * A hook which provides a list of all participants that have joined an active call.
+ *
+ * @category Call State
+ *
+ * @param options.sortBy - A comparator function to sort the participants by.
+ * Make sure to memoize output of the `combineComparators` function
+ * (or keep it out of component's scope if possible) before passing it down to this property.
+ */
+export const useParticipants = ({ sortBy, } = {}) => {
+    const { participants$ } = useCallState();
+    const participants = useObservableValue(participants$);
+    return useMemo(() => {
+        if (sortBy) {
+            return [...participants].sort(sortBy);
+        }
+        return participants;
+    }, [participants, sortBy]);
+};
+/**
+ * A hook which provides a StreamVideoLocalParticipant object.
+ * It signals that I have joined a call.
+ *
+ * @category Call State
+ */
+export const useLocalParticipant = () => {
+    const { localParticipant$ } = useCallState();
+    return useObservableValue(localParticipant$);
+};
+/**
+ * A hook which provides a list of all other participants than me that have joined an active call.
+ *
+ * @category Call State
+ */
+export const useRemoteParticipants = () => {
+    const { remoteParticipants$ } = useCallState();
+    return useObservableValue(remoteParticipants$);
+};
+//# sourceMappingURL=participants.js.map

package/dist/src/hooks/participants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"participants.js","sourceRoot":"","sources":["../../../src/hooks/participants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAKvC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,EAC9B,MAAM,MAOJ,EAAE,EAAE,EAAE;IACR,MAAM,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,CAAC;IACzC,MAAM,YAAY,GAAG,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAEvD,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,IAAI,MAAM,EAAE;YACV,OAAO,CAAC,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE;IACtC,MAAM,EAAE,iBAAiB,EAAE,GAAG,YAAY,EAAE,CAAC;IAC7C,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,EAAE;IACxC,MAAM,EAAE,mBAAmB,EAAE,GAAG,YAAY,EAAE,CAAC;IAC/C,OAAO,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;AACjD,CAAC,CAAC"}

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

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

package/dist/src/hooks/permissions.js

@@ -0,0 +1,24 @@
+import { useCallMetadata } from './call';
+/**
+ * Hook that returns true if the current user has all the given permissions.
+ *
+ * @param permissions the permissions to check.
+ *
+ * @category Call State
+ */
+export const useHasPermissions = (...permissions) => {
+    const metadata = useCallMetadata();
+    if (!metadata)
+        return false;
+    return permissions.every((permission) => metadata.own_capabilities.includes(permission));
+};
+/**
+ * A hook which returns the current user's own capabilities.
+ *
+ * @category Call State
+ */
+export const useOwnCapabilities = () => {
+    const metadata = useCallMetadata();
+    return (metadata === null || metadata === void 0 ? void 0 : metadata.own_capabilities) || [];
+};
+//# sourceMappingURL=permissions.js.map

package/dist/src/hooks/permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../../src/hooks/permissions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,GAAG,WAA4B,EAAE,EAAE;IACnE,MAAM,QAAQ,GAAG,eAAe,EAAE,CAAC;IACnC,IAAI,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5B,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,EAAE,CACtC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAC/C,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,EAAE;IACrC,MAAM,QAAQ,GAAG,eAAe,EAAE,CAAC;IACnC,OAAO,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,gBAAgB,KAAI,EAAE,CAAC;AAC1C,CAAC,CAAC"}

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

@@ -0,0 +1,11 @@
+import { CallState } from '@stream-io/video-client';
+/**
+ * Utility hook which provides access to client's state store.
+ */
+export declare const useStore: () => import("@stream-io/video-client").StreamVideoReadOnlyStateStore;
+/**
+ * Utility hook which provides the current call's state.
+ *
+ * @category Call State
+ */
+export declare const useCallState: () => CallState;

package/dist/src/hooks/store.js

@@ -0,0 +1,28 @@
+import { CallState } from '@stream-io/video-client';
+import { useCall, useStreamVideoClient } from '../contexts';
+/**
+ * Utility hook which provides access to client's state store.
+ */
+export const useStore = () => {
+    const client = useStreamVideoClient();
+    if (!client) {
+        throw new Error(`StreamVideoClient isn't initialized or this hook is called outside of <StreamVideo> context.`);
+    }
+    return client.readOnlyStateStore;
+};
+/**
+ * Utility hook which provides the current call's state.
+ *
+ * @category Call State
+ */
+export const useCallState = () => {
+    const call = useCall();
+    // return an empty and unlinked CallState object if there is no call in the provider
+    // this ensures that the hooks always return a value and many null checks can be avoided
+    if (!call) {
+        console.warn(`You are using useCallState() outside a Call context. Please wrap your component in <StreamCallProvider />`);
+        return new CallState();
+    }
+    return call.state;
+};
+//# sourceMappingURL=store.js.map

package/dist/src/hooks/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../../src/hooks/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE5D;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,EAAE;IAC3B,MAAM,MAAM,GAAG,oBAAoB,EAAE,CAAC;IACtC,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CACb,8FAA8F,CAC/F,CAAC;KACH;IACD,OAAO,MAAM,CAAC,kBAAkB,CAAC;AACnC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,EAAE;IAC/B,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;IACvB,oFAAoF;IACpF,wFAAwF;IACxF,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,CAAC,IAAI,CACV,2GAA2G,CAC5G,CAAC;QACF,OAAO,IAAI,SAAS,EAAE,CAAC;KACxB;IACD,OAAO,IAAI,CAAC,KAAK,CAAC;AACpB,CAAC,CAAC"}

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

@@ -0,0 +1,7 @@
+/**
+ *
+ * @returns
+ *
+ * @category Client State
+ */
+export declare const useConnectedUser: () => import("@stream-io/video-client").User | undefined;

package/dist/src/hooks/user.js

@@ -0,0 +1,13 @@
+import { useStore } from './store';
+import { useObservableValue } from './helpers/useObservableValue';
+/**
+ *
+ * @returns
+ *
+ * @category Client State
+ */
+export const useConnectedUser = () => {
+    const { connectedUser$ } = useStore();
+    return useObservableValue(connectedUser$);
+};
+//# sourceMappingURL=user.js.map

package/dist/src/hooks/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/hooks/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtC,OAAO,kBAAkB,CAAC,cAAc,CAAC,CAAC;AAC5C,CAAC,CAAC"}

package/index.ts

@@ -0,0 +1,2 @@
+export * from './src/contexts';
+export * from './src/hooks';

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@stream-io/video-react-bindings",
+  "packageManager": "yarn@3.2.4",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "license": "See license in LICENSE",
+  "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"
+  },
+  "files": [
+    "dist",
+    "src",
+    "index.ts",
+    "package.json",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "rxjs": "~7.5.7"
+  },
+  "peerDependencies": {
+    "@stream-io/i18n": "^0.0.1-alpha.10",
+    "@stream-io/video-client": "^0.0.1-alpha.124",
+    "react": ">=17.0.0"
+  },
+  "devDependencies": {
+    "@stream-io/i18n": "^0.0.1-alpha.10",
+    "@stream-io/video-client": "^0.0.1-alpha.124",
+    "@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.23.23",
+    "typedoc-plugin-markdown": "^3.13.6",
+    "typescript": "^4.9.5"
+  },
+  "version": "0.0.1-alpha.13"
+}

package/src/contexts/StreamCallContext.tsx

@@ -0,0 +1,41 @@
+import { createContext, PropsWithChildren, useContext } from 'react';
+import { Call } from '@stream-io/video-client';
+
+const StreamCallContext = createContext<Call | undefined>(undefined);
+
+/**
+ *
+ * We don't expose types in our docs site but we should still add doc comments
+ * @internal
+ */
+export interface StreamCallProviderProps {
+  call?: Call;
+}
+
+/**
+ *
+ * @param props
+ * @returns
+ *
+ * @category Call State
+ */
+export const StreamCallProvider = (
+  props: PropsWithChildren<StreamCallProviderProps>,
+) => {
+  const { call, children } = props;
+  return (
+    <StreamCallContext.Provider value={call}>
+      {children}
+    </StreamCallContext.Provider>
+  );
+};
+
+/**
+ *
+ * @returns
+ *
+ * @category Call State
+ */
+export const useCall = () => {
+  return useContext(StreamCallContext);
+};

package/src/contexts/StreamI18nContext.tsx

@@ -0,0 +1,70 @@
+import {
+  createContext,
+  PropsWithChildren,
+  useContext,
+  useEffect,
+  useState,
+} from 'react';
+import {
+  defaultTranslationFunction,
+  StreamI18n,
+  TranslationsMap,
+} from '@stream-io/i18n';
+
+type StreamI18nContextValue = {
+  t: StreamI18n['t'];
+  i18n?: StreamI18n;
+};
+
+const StreamI18nContext = createContext<StreamI18nContextValue>({
+  t: defaultTranslationFunction,
+});
+
+export type StreamI18nProviderProps = CreateI18nParams;
+
+export const StreamI18nProvider = ({
+  children,
+  ...createI18nParams
+}: PropsWithChildren<StreamI18nProviderProps>) => {
+  const { i18n, t } = useCreateI18n(createI18nParams);
+
+  return (
+    <StreamI18nContext.Provider value={{ t, i18n }}>
+      {children}
+    </StreamI18nContext.Provider>
+  );
+};
+
+type CreateI18nParams = {
+  i18nInstance?: StreamI18n;
+  language?: string;
+  translationsOverrides?: TranslationsMap;
+};
+
+export const useCreateI18n = ({
+  i18nInstance,
+  language,
+  translationsOverrides,
+}: CreateI18nParams) => {
+  const [i18n] = useState<StreamI18n>(
+    () =>
+      i18nInstance ||
+      new StreamI18n({ currentLanguage: language, translationsOverrides }),
+  );
+  const [t, setTranslationFn] = useState<StreamI18n['t']>(
+    () => defaultTranslationFunction,
+  );
+
+  useEffect(() => {
+    if (i18n.isInitialized && language && i18n?.currentLanguage !== language) {
+      i18n.changeLanguage(language);
+    } else if (!i18n.isInitialized) {
+      if (!language) i18n.changeLanguage();
+      i18n.init().then((_i18n) => setTranslationFn(() => _i18n.i18nInstance.t));
+    }
+  }, [i18n, i18nInstance, language, translationsOverrides]);
+
+  return { i18n, t };
+};
+
+export const useI18n = () => useContext(StreamI18nContext);

package/src/contexts/StreamVideoContext.tsx

@@ -0,0 +1,54 @@
+import { createContext, PropsWithChildren, useContext } from 'react';
+import { StreamVideoClient } from '@stream-io/video-client';
+import {
+  StreamI18nProvider,
+  StreamI18nProviderProps,
+} from './StreamI18nContext';
+
+const StreamVideoContext = createContext<StreamVideoClient | undefined>(
+  undefined,
+);
+
+/**
+ * Exclude types from documentaiton site, but we should still add doc comments
+ * @internal
+ */
+export type StreamVideoProps = StreamI18nProviderProps & {
+  client: StreamVideoClient;
+};
+
+/**
+ * StreamVideo is a provider component which should be used to wrap the entire application.
+ * It provides the client object to all children components and initializes the i18n instance.
+ *  @param PropsWithChildren<StreamVideoProps>
+ *  @category Client State
+ */
+export const StreamVideo = ({
+  children,
+  client,
+  i18nInstance,
+  language,
+  translationsOverrides,
+}: PropsWithChildren<StreamVideoProps>) => {
+  return (
+    <StreamVideoContext.Provider value={client}>
+      <StreamI18nProvider
+        i18nInstance={i18nInstance}
+        language={language}
+        translationsOverrides={translationsOverrides}
+      >
+        {children}
+      </StreamI18nProvider>
+    </StreamVideoContext.Provider>
+  );
+};
+
+/**
+ *
+ * @returns
+ *
+ * @category Client State
+ */
+export const useStreamVideoClient = () => {
+  return useContext(StreamVideoContext);
+};

package/src/contexts/index.ts

@@ -0,0 +1,3 @@
+export * from './StreamCallContext';
+export * from './StreamI18nContext';
+export * from './StreamVideoContext';