@stream-io/video-client 0.1.0 → 0.1.2

package/dist/src/StreamVideoClient.d.ts

@@ -1,8 +1,8 @@
 import { Call } from './Call';
 import { StreamClient } from './coordinator/connection/client';
-import { StreamVideoReadOnlyStateStore } from './store';
-import type { ConnectedEvent, CreateCallTypeRequest, CreateCallTypeResponse, CreateDeviceRequest, CreateGuestRequest, CreateGuestResponse, GetCallTypeResponse, GetEdgesResponse, ListCallTypeResponse, ListDevicesResponse, QueryCallsRequest, UpdateCallTypeRequest, UpdateCallTypeResponse } from './gen/coordinator';
-import type { EventHandler, EventTypes, Logger, StreamClientOptions, TokenOrProvider, TokenProvider, User } from './coordinator/connection/types';
+import { StreamVideoReadOnlyStateStore, StreamVideoWriteableStateStore } from './store';
+import type { ConnectedEvent, CreateDeviceRequest, CreateGuestRequest, CreateGuestResponse, GetEdgesResponse, ListDevicesResponse, QueryCallsRequest } from './gen/coordinator';
+import type { EventHandler, EventTypes, Logger, StreamClientOptions, TokenOrProvider, TokenProvider, User, UserWithId } from './coordinator/connection/types';
 /**
  * A `StreamVideoClient` instance lets you communicate with our API, and authenticate users.
  */
@@ -14,11 +14,11 @@ export declare class StreamVideoClient {
     readonly user?: User;
     readonly token?: TokenOrProvider;
     readonly logger: Logger;
-    private readonly writeableStateStore;
+    protected readonly writeableStateStore: StreamVideoWriteableStateStore;
     streamClient: StreamClient;
-    private eventHandlersToUnregister;
-    private connectionPromise;
-    private disconnectionPromise;
+    protected eventHandlersToUnregister: Array<() => void>;
+    protected connectionPromise: Promise<void | ConnectedEvent> | undefined;
+    protected disconnectionPromise: Promise<void> | undefined;
     /**
      * You should create only one instance of `StreamVideoClient`.
      */
@@ -91,11 +91,6 @@ export declare class StreamVideoClient {
     }>;
     queryUsers: () => Promise<void>;
     edges: () => Promise<GetEdgesResponse>;
-    createCallType: (data: CreateCallTypeRequest) => Promise<CreateCallTypeResponse>;
-    getCallType: (name: string) => Promise<GetCallTypeResponse>;
-    updateCallType: (name: string, data: UpdateCallTypeRequest) => Promise<UpdateCallTypeResponse>;
-    deleteCallType: (name: string) => Promise<unknown>;
-    listCallTypes: () => Promise<ListCallTypeResponse>;
     /**
      * addDevice - Adds a push device for a user.
      *
@@ -128,18 +123,6 @@ export declare class StreamVideoClient {
      *
      */
     removeDevice: (id: string, userID?: string) => Promise<unknown>;
-    /**
-     * createToken - Creates a token to authenticate this user. This function is used server side.
-     * The resulting token should be passed to the client side when the users register or logs in.
-     *
-     * @param {string} userID The User ID
-     * @param {number} [exp] The expiration time for the token expressed in the number of seconds since the epoch
-     * @param {number} [iat] The timestamp when a token has been issued
-     * @param call_cids for anonymous tokens you have to provide the call cids the use can join
-     *
-     * @return {string} Returns a token
-     */
-    createToken(userID: string, exp?: number, iat?: number, call_cids?: string[]): string;
     /**
      * A callback that can be used to create ringing calls from push notifications. If the call already exists, it will do nothing.
      * @param call_cid
@@ -152,5 +135,5 @@ export declare class StreamVideoClient {
      * @param user the user to connect.
      * @param tokenOrProvider a token or a function that returns a token.
      */
-    private connectAnonymousUser;
+    protected connectAnonymousUser: (user: UserWithId, tokenOrProvider: TokenOrProvider) => Promise<void | ConnectedEvent>;
 }

package/dist/src/StreamVideoServerClient.d.ts

@@ -0,0 +1,23 @@
+import { StreamVideoClient } from './StreamVideoClient';
+import { StreamClientOptions } from './coordinator/connection/types';
+import { CreateCallTypeRequest, CreateCallTypeResponse, GetCallTypeResponse, ListCallTypeResponse, UpdateCallTypeRequest, UpdateCallTypeResponse } from './gen/coordinator';
+export declare class StreamVideoServerClient extends StreamVideoClient {
+    constructor(apiKey: string, options: StreamClientOptions);
+    /**
+     * createToken - Creates a token to authenticate this user. This function is used server side.
+     * The resulting token should be passed to the client side when the users register or logs in.
+     *
+     * @param {string} userID The User ID
+     * @param {number} [exp] The expiration time for the token expressed in the number of seconds since the epoch
+     * @param {number} [iat] The timestamp when a token has been issued
+     * @param call_cids for anonymous tokens you have to provide the call cids the use can join
+     *
+     * @return {string} Returns a token
+     */
+    createToken(userID: string, exp?: number, iat?: number, call_cids?: string[]): string;
+    getCallTypes: () => Promise<ListCallTypeResponse>;
+    getCallType: (name: string) => Promise<GetCallTypeResponse>;
+    createCallType: (data: CreateCallTypeRequest) => Promise<CreateCallTypeResponse>;
+    deleteCallType: (name: string) => Promise<void>;
+    updateCallType: (name: string, data: UpdateCallTypeRequest) => Promise<UpdateCallTypeResponse>;
+}

package/dist/src/__tests__/StreamVideoServerClient.test.d.ts

@@ -0,0 +1 @@
+import 'dotenv/config';

package/dist/src/coordinator/connection/client.d.ts

@@ -37,7 +37,7 @@ export declare class StreamClient {
     defaultWSTimeout: number;
     resolveConnectionId: Function;
     rejectConnectionId: Function;
-    connectionIdPromise: Promise<string | undefined>;
+    connectionIdPromise?: Promise<string | undefined>;
     private nextRequestAbortController;
     private waitForConnectPromise?;
     private resolveConnectPromise?;

package/dist/src/gen/coordinator/index.d.ts

@@ -1180,6 +1180,12 @@ export interface CallSessionParticipantJoinedEvent {
      * @memberof CallSessionParticipantJoinedEvent
      */
     created_at: string;
+    /**
+     *
+     * @type {CallParticipantResponse}
+     * @memberof CallSessionParticipantJoinedEvent
+     */
+    participant: CallParticipantResponse;
     /**
      * Call session ID
      * @type {string}
@@ -1192,18 +1198,6 @@ export interface CallSessionParticipantJoinedEvent {
      * @memberof CallSessionParticipantJoinedEvent
      */
     type: string;
-    /**
-     *
-     * @type {UserResponse}
-     * @memberof CallSessionParticipantJoinedEvent
-     */
-    user: UserResponse;
-    /**
-     * The user session ID of the user that joined the call session
-     * @type {string}
-     * @memberof CallSessionParticipantJoinedEvent
-     */
-    user_session_id: string;
 }
 /**
  * This event is sent when a participant leaves a call session
@@ -1223,6 +1217,12 @@ export interface CallSessionParticipantLeftEvent {
      * @memberof CallSessionParticipantLeftEvent
      */
     created_at: string;
+    /**
+     *
+     * @type {CallParticipantResponse}
+     * @memberof CallSessionParticipantLeftEvent
+     */
+    participant: CallParticipantResponse;
     /**
      * Call session ID
      * @type {string}
@@ -1235,18 +1235,6 @@ export interface CallSessionParticipantLeftEvent {
      * @memberof CallSessionParticipantLeftEvent
      */
     type: string;
-    /**
-     *
-     * @type {UserResponse}
-     * @memberof CallSessionParticipantLeftEvent
-     */
-    user: UserResponse;
-    /**
-     * The user session ID of the user that left the call session
-     * @type {string}
-     * @memberof CallSessionParticipantLeftEvent
-     */
-    user_session_id: string;
 }
 /**
  *

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.1.0";
+export declare const version = "0.1.2";

package/index.ts

@@ -13,6 +13,7 @@ export * from './src/stats/types';
 export * from './src/Call';
 export * from './src/CallType';
 export * from './src/StreamVideoClient';
+export * from './src/StreamVideoServerClient';
 export * from './src/StreamSfuClient';
 export * from './src/devices';
 export * from './src/store';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -53,6 +53,7 @@
     "@types/ua-parser-js": "^0.7.36",
     "@types/ws": "^8.5.4",
     "@vitest/coverage-c8": "^0.31.0",
+    "dotenv": "^16.3.1",
     "prettier": "^2.8.4",
     "rimraf": "^3.0.2",
     "rollup": "^3.25.1",

package/src/StreamVideoClient.ts

@@ -6,19 +6,13 @@ import {
 } from './store';
 import type {
   ConnectedEvent,
-  CreateCallTypeRequest,
-  CreateCallTypeResponse,
   CreateDeviceRequest,
   CreateGuestRequest,
   CreateGuestResponse,
-  GetCallTypeResponse,
   GetEdgesResponse,
-  ListCallTypeResponse,
   ListDevicesResponse,
   QueryCallsRequest,
   QueryCallsResponse,
-  UpdateCallTypeRequest,
-  UpdateCallTypeResponse,
 } from './gen/coordinator';
 import type {
   ConnectionChangedEvent,
@@ -48,12 +42,12 @@ export class StreamVideoClient {
   readonly token?: TokenOrProvider;
   readonly logger: Logger;
 
-  private readonly writeableStateStore: StreamVideoWriteableStateStore;
+  protected readonly writeableStateStore: StreamVideoWriteableStateStore;
   streamClient: StreamClient;
 
-  private eventHandlersToUnregister: Array<() => void> = [];
-  private connectionPromise: Promise<void | ConnectedEvent> | undefined;
-  private disconnectionPromise: Promise<void> | undefined;
+  protected eventHandlersToUnregister: Array<() => void> = [];
+  protected connectionPromise: Promise<void | ConnectedEvent> | undefined;
+  protected disconnectionPromise: Promise<void> | undefined;
 
   /**
    * You should create only one instance of `StreamVideoClient`.
@@ -379,30 +373,6 @@ export class StreamVideoClient {
     return this.streamClient.get<GetEdgesResponse>(`/edges`);
   };
 
-  // server-side only endpoints
-  createCallType = async (data: CreateCallTypeRequest) => {
-    return this.streamClient.post<CreateCallTypeResponse>(`/calltypes`, data);
-  };
-
-  getCallType = async (name: string) => {
-    return this.streamClient.get<GetCallTypeResponse>(`/calltypes/${name}`);
-  };
-
-  updateCallType = async (name: string, data: UpdateCallTypeRequest) => {
-    return this.streamClient.put<UpdateCallTypeResponse>(
-      `/calltypes/${name}`,
-      data,
-    );
-  };
-
-  deleteCallType = async (name: string) => {
-    return this.streamClient.delete(`/calltypes/${name}`);
-  };
-
-  listCallTypes = async () => {
-    return this.streamClient.get<ListCallTypeResponse>(`/calltypes`);
-  };
-
   /**
    * addDevice - Adds a push device for a user.
    *
@@ -476,26 +446,6 @@ export class StreamVideoClient {
     });
   };
 
-  /**
-   * createToken - Creates a token to authenticate this user. This function is used server side.
-   * The resulting token should be passed to the client side when the users register or logs in.
-   *
-   * @param {string} userID The User ID
-   * @param {number} [exp] The expiration time for the token expressed in the number of seconds since the epoch
-   * @param {number} [iat] The timestamp when a token has been issued
-   * @param call_cids for anonymous tokens you have to provide the call cids the use can join
-   *
-   * @return {string} Returns a token
-   */
-  createToken(
-    userID: string,
-    exp?: number,
-    iat?: number,
-    call_cids?: string[],
-  ) {
-    return this.streamClient.createToken(userID, exp, iat, call_cids);
-  }
-
   /**
    * A callback that can be used to create ringing calls from push notifications. If the call already exists, it will do nothing.
    * @param call_cid
@@ -529,7 +479,7 @@ export class StreamVideoClient {
    * @param user the user to connect.
    * @param tokenOrProvider a token or a function that returns a token.
    */
-  private connectAnonymousUser = async (
+  protected connectAnonymousUser = async (
     user: UserWithId,
     tokenOrProvider: TokenOrProvider,
   ) => {

package/src/StreamVideoServerClient.ts

@@ -0,0 +1,59 @@
+import { StreamVideoClient } from './StreamVideoClient';
+import { StreamClientOptions } from './coordinator/connection/types';
+import {
+  CreateCallTypeRequest,
+  CreateCallTypeResponse,
+  GetCallTypeResponse,
+  ListCallTypeResponse,
+  UpdateCallTypeRequest,
+  UpdateCallTypeResponse,
+} from './gen/coordinator';
+
+export class StreamVideoServerClient extends StreamVideoClient {
+  constructor(apiKey: string, options: StreamClientOptions) {
+    super({ apiKey, options });
+  }
+
+  /**
+   * createToken - Creates a token to authenticate this user. This function is used server side.
+   * The resulting token should be passed to the client side when the users register or logs in.
+   *
+   * @param {string} userID The User ID
+   * @param {number} [exp] The expiration time for the token expressed in the number of seconds since the epoch
+   * @param {number} [iat] The timestamp when a token has been issued
+   * @param call_cids for anonymous tokens you have to provide the call cids the use can join
+   *
+   * @return {string} Returns a token
+   */
+  createToken(
+    userID: string,
+    exp?: number,
+    iat?: number,
+    call_cids?: string[],
+  ) {
+    return this.streamClient.createToken(userID, exp, iat, call_cids);
+  }
+
+  getCallTypes = () => {
+    return this.streamClient.get<ListCallTypeResponse>('/calltypes');
+  };
+
+  getCallType = (name: string) => {
+    return this.streamClient.get<GetCallTypeResponse>(`/calltypes/${name}`);
+  };
+
+  createCallType = (data: CreateCallTypeRequest) => {
+    return this.streamClient.post<CreateCallTypeResponse>('/calltypes', data);
+  };
+
+  deleteCallType = (name: string) => {
+    return this.streamClient.delete<void>(`/calltypes/${name}`);
+  };
+
+  updateCallType = (name: string, data: UpdateCallTypeRequest) => {
+    return this.streamClient.put<UpdateCallTypeResponse>(
+      `/calltypes/${name}`,
+      data,
+    );
+  };
+}

package/src/__tests__/StreamVideoServerClient.test.ts

@@ -0,0 +1,88 @@
+import { StreamVideoServerClient } from '../StreamVideoServerClient';
+import 'dotenv/config';
+import jwt from 'jsonwebtoken';
+import { beforeEach, describe, expect, it } from 'vitest';
+import { generateUUIDv4 } from '../coordinator/connection/utils';
+
+const apiKey = process.env.STREAM_API_KEY!;
+const secret = process.env.STREAM_SECRET!;
+
+describe('StreamVideoServerClient - docs snippets', () => {
+  let client: StreamVideoServerClient;
+
+  beforeEach(() => {
+    client = new StreamVideoServerClient(apiKey, {
+      secret,
+      // turn off
+      logger: () => {},
+    });
+  });
+
+  describe('creating tokens', () => {
+    const userId = 'john';
+
+    it('with no expiration', () => {
+      const token = client.createToken(userId);
+      const decodedToken = jwt.verify(token, secret) as any;
+
+      expect(decodedToken.user_id).toBe(userId);
+    });
+
+    it('with expiration and issued at provided', () => {
+      const exp = Math.round(new Date().getTime() / 1000) + 60 * 60;
+      const iat = Math.round(new Date().getTime() / 1000);
+      const token = client.createToken(userId, exp, iat);
+      const decodedToken = jwt.verify(token, secret) as any;
+
+      expect(decodedToken.exp).toBe(exp);
+      expect(decodedToken.iat).toBe(iat);
+    });
+
+    it('with call IDs provided', () => {
+      const call_cids = ['default:call1', 'livestream:call2'];
+      const token = client.createToken(userId, undefined, undefined, call_cids);
+      const decodedToken = jwt.verify(token, secret) as any;
+
+      expect(decodedToken.call_cids).toEqual(call_cids);
+    });
+  });
+
+  describe('call type CRUD API', () => {
+    const callTypeName = `calltype${generateUUIDv4()}`;
+
+    it('create', async () => {
+      const createResponse = await client.createCallType({
+        name: callTypeName,
+      });
+
+      expect(createResponse.name).toBe(callTypeName);
+    });
+
+    it('read', async () => {
+      const readResponse = await client.getCallTypes();
+
+      expect(readResponse.call_types[callTypeName]).toContain({
+        name: callTypeName,
+      });
+    });
+
+    it('update', async () => {
+      const updateResponse = await client.updateCallType(callTypeName, {
+        settings: {
+          audio: { mic_default_on: false, default_device: 'earpiece' },
+        },
+      });
+
+      expect(updateResponse.settings.audio.mic_default_on).toBeFalsy();
+      expect(updateResponse.settings.audio.default_device).toBe('earpiece');
+    });
+
+    it('delete', async () => {
+      await client.deleteCallType(callTypeName);
+
+      await expect(() =>
+        client.getCallType(callTypeName),
+      ).rejects.toThrowError();
+    });
+  });
+});

package/src/coordinator/connection/client.ts

@@ -69,7 +69,7 @@ export class StreamClient {
   defaultWSTimeout: number;
   resolveConnectionId!: Function;
   rejectConnectionId!: Function;
-  connectionIdPromise: Promise<string | undefined>;
+  connectionIdPromise?: Promise<string | undefined>;
   private nextRequestAbortController: AbortController | null = null;
   private waitForConnectPromise?: Promise<void>;
   private resolveConnectPromise?: Function;
@@ -125,12 +125,12 @@ export class StreamClient {
       });
     }
 
-    this.connectionIdPromise = new Promise<string | undefined>(
-      (resolve, reject) => {
-        this.resolveConnectionId = resolve;
-        this.rejectConnectionId = reject;
-      },
-    );
+    this.connectionIdPromise = this.secret
+      ? undefined
+      : new Promise<string | undefined>((resolve, reject) => {
+          this.resolveConnectionId = resolve;
+          this.rejectConnectionId = reject;
+        });
 
     this.setBaseURL(
       this.options.baseURL || 'https://video.stream-io-api.com/video',

package/src/events/__tests__/sessions.test.ts

@@ -63,24 +63,24 @@ describe('call.session events', () => {
     const handler = watchCallSessionParticipantJoined(state);
     handler({
       type: 'call.session_participant_joined',
-      // @ts-ignore
-      user: {
-        id: 'user-id',
-        role: 'user',
+      participant: {
+        // @ts-ignore
+        user: {
+          id: 'user-id',
+          role: 'user',
+        },
+        user_session_id: '123',
       },
-      user_session_id: '123',
     });
     expect(state.metadata).toEqual({
       session: {
         participants: [
           {
-            joined_at: expect.any(String),
             user: {
               id: 'user-id',
               role: 'user',
             },
             user_session_id: '123',
-            role: 'user',
           },
         ],
         participants_count_by_role: {
@@ -114,12 +114,14 @@ describe('call.session events', () => {
     const handler = watchCallSessionParticipantLeft(state);
     handler({
       type: 'call.session_participant_left',
-      // @ts-ignore
-      user: {
-        id: 'user-id',
-        role: 'user',
+      participant: {
+        // @ts-ignore
+        user: {
+          id: 'user-id',
+          role: 'user',
+        },
+        user_session_id: '123',
       },
-      user_session_id: '123',
     });
     expect(state.metadata).toEqual({
       session: {

package/src/events/sessions.ts

@@ -33,7 +33,7 @@ export const watchCallSessionEnded = (state: CallState) => {
 export const watchCallSessionParticipantJoined = (state: CallState) => {
   return function onCallParticipantJoined(event: StreamVideoEvent) {
     if (event.type !== 'call.session_participant_joined') return;
-    const { user, user_session_id } = event;
+    const { participant } = event;
     state.setMetadata((metadata) => {
       if (!metadata || !metadata.session) {
         state.logger(
@@ -45,20 +45,12 @@ export const watchCallSessionParticipantJoined = (state: CallState) => {
       }
       const { session } = metadata;
       const { participants, participants_count_by_role } = session;
+      const { user } = participant;
       return {
         ...metadata,
         session: {
           ...session,
-          participants: [
-            ...participants,
-            {
-              // FIXME OL: ideally, this comes from the backend
-              joined_at: new Date().toISOString(),
-              user,
-              role: user.role,
-              user_session_id,
-            },
-          ],
+          participants: [...participants, participant],
           participants_count_by_role: {
             ...participants_count_by_role,
             [user.role]: (participants_count_by_role[user.role] || 0) + 1,
@@ -77,7 +69,7 @@ export const watchCallSessionParticipantJoined = (state: CallState) => {
 export const watchCallSessionParticipantLeft = (state: CallState) => {
   return function onCallParticipantLeft(event: StreamVideoEvent) {
     if (event.type !== 'call.session_participant_left') return;
-    const { user, user_session_id } = event;
+    const { user, user_session_id } = event.participant;
     state.setMetadata((metadata) => {
       if (!metadata || !metadata.session) {
         state.logger(

package/src/gen/coordinator/index.ts

@@ -1180,6 +1180,12 @@ export interface CallSessionParticipantJoinedEvent {
    * @memberof CallSessionParticipantJoinedEvent
    */
   created_at: string;
+  /**
+   *
+   * @type {CallParticipantResponse}
+   * @memberof CallSessionParticipantJoinedEvent
+   */
+  participant: CallParticipantResponse;
   /**
    * Call session ID
    * @type {string}
@@ -1192,18 +1198,6 @@ export interface CallSessionParticipantJoinedEvent {
    * @memberof CallSessionParticipantJoinedEvent
    */
   type: string;
-  /**
-   *
-   * @type {UserResponse}
-   * @memberof CallSessionParticipantJoinedEvent
-   */
-  user: UserResponse;
-  /**
-   * The user session ID of the user that joined the call session
-   * @type {string}
-   * @memberof CallSessionParticipantJoinedEvent
-   */
-  user_session_id: string;
 }
 /**
  * This event is sent when a participant leaves a call session
@@ -1223,6 +1217,12 @@ export interface CallSessionParticipantLeftEvent {
    * @memberof CallSessionParticipantLeftEvent
    */
   created_at: string;
+  /**
+   *
+   * @type {CallParticipantResponse}
+   * @memberof CallSessionParticipantLeftEvent
+   */
+  participant: CallParticipantResponse;
   /**
    * Call session ID
    * @type {string}
@@ -1235,18 +1235,6 @@ export interface CallSessionParticipantLeftEvent {
    * @memberof CallSessionParticipantLeftEvent
    */
   type: string;
-  /**
-   *
-   * @type {UserResponse}
-   * @memberof CallSessionParticipantLeftEvent
-   */
-  user: UserResponse;
-  /**
-   * The user session ID of the user that left the call session
-   * @type {string}
-   * @memberof CallSessionParticipantLeftEvent
-   */
-  user_session_id: string;
 }
 /**
  *