@crewdle/web-sdk-types 1.0.0

package/dist/key-value-database/KeyValueDatabaseTableConnector.d.ts

@@ -0,0 +1,56 @@
+import { IDatabaseTableQuery, IValueType, ValueTypeOmitId } from '.';
+/**
+ * The key-value database table connector interface.
+ * @category Key-Value Database
+ */
+export interface IKeyValueDatabaseTableConnector<T extends IValueType> {
+    /**
+     * Get the value for a key.
+     * @param key The key to get the value for.
+     * @returns A promise that resolves with the value for the key, or undefined if the key was not found.
+     */
+    get(key: string): Promise<T | undefined>;
+    /**
+     * Set the value for a key.
+     * @param key The key to set the value for.
+     * @param value The value to set for the key. It must be a {@link SupportedIndexTypes}.
+     */
+    set(key: string, value: ValueTypeOmitId<T>): Promise<T>;
+    /**
+     * Add a value to the database.
+     * @param value  The value to add. It must be a {@link SupportedIndexTypes}.
+     * @returns A promise that resolves with the value added.
+     */
+    add(value: ValueTypeOmitId<T>): Promise<T>;
+    /**
+     * Delete a key.
+     * @param key The key to delete.
+     * @returns A promise that resolves when the key has been deleted.
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Clear the database.
+     * Fires a {@link IDatabaseTableEvent} for each key deleted.
+     * @returns A promise that resolves when the database has been cleared.
+     */
+    clear(): Promise<void>;
+    /**
+     * Get all the values matching the query in the database.
+     * @param query The query to use to filter the values.
+     * If no query is provided, all the values in the database are returned.
+     * @returns A promise that resolves with all the values matching the query.
+     */
+    list(query?: IDatabaseTableQuery): Promise<T[]>;
+    /**
+     * Count the number of keys matching the query in the database.
+     * @param query The query to use to filter the keys.
+     * If no query is provided, all the keys in the database are counted.
+     * @returns A promise that resolves with the number of keys matching the query.
+     */
+    count(query?: IDatabaseTableQuery): Promise<number>;
+    /**
+     * Calculate the size of the table.
+     * @returns A promise that resolves with the size of the table in bytes.
+     */
+    calculateSize(): Promise<number>;
+}

package/dist/key-value-database/KeyValueDatabaseTableConnector.js

@@ -0,0 +1 @@
+export {};

package/dist/key-value-database/LayoutBuilder.d.ts

@@ -0,0 +1,18 @@
+import { IDatabaseLayout, ITableBuilder } from '.';
+/**
+ * The layout builder interface for the {@link IKeyValueDatabase}.
+ * @category Key-Value Database
+ */
+export interface ILayoutBuilder {
+    /**
+     * Adds a table to the layout.
+     * @param name The name of the table.
+     * @returns A table builder.
+     */
+    table(name: string): ITableBuilder;
+    /**
+     * Gets the layout.
+     * @returns The layout: {@link IDatabaseLayout}.
+     */
+    getLayout(): IDatabaseLayout;
+}

package/dist/key-value-database/LayoutBuilder.js

@@ -0,0 +1 @@
+export {};

package/dist/key-value-database/QueryBuilder.d.ts

@@ -0,0 +1,54 @@
+import { IDatabaseTableQuery, IDatabaseTableQueryWhereValue, IDatabaseTableQueryWhereValues, IDatabaseTableQueryWhereBetween } from '.';
+/**
+ * The Query Builder interface for building queries for the {@link IDatabaseTable}.
+ * @category Key-Value Database
+ */
+export interface IQueryBuilder {
+    /**
+     * Gets the query.
+     * @returns The query: {@link IDatabaseTableQuery}.
+     */
+    getQuery(): IDatabaseTableQuery;
+    /**
+     * @overload A where clause with basic operators and a single value.
+     * @param operator A basic operator.
+     * @param value A single value.
+     * @returns A QueryBuilder instance with a where clause added.
+     */
+    where(operator: IDatabaseTableQueryWhereValue['operator'], value: IDatabaseTableQueryWhereValue['value']): IQueryBuilder;
+    /**
+     * @overload A where clause with 'in' or 'not-in' the given values.
+     * @param operator An 'in' or 'not-in' operator.
+     * @param value An array of values.
+     * @returns A QueryBuilder instance with a where clause added.
+     */
+    where(operator: IDatabaseTableQueryWhereValues['operator'], value: IDatabaseTableQueryWhereValues['value']): IQueryBuilder;
+    /**
+     * @overload A where clause with 'between' the given values.
+     * @param operator A 'between' operator.
+     * @param value An array of two values.
+     * @returns A QueryBuilder instance with a where clause added.
+    */
+    where(operator: IDatabaseTableQueryWhereBetween['operator'], value: IDatabaseTableQueryWhereBetween['value']): IQueryBuilder;
+    /**
+     * Adds an order by clause to the query.
+     * @param order The order for the order by clause, either 'asc' or 'desc'.
+     * @returns A QueryBuilder instance with an order by clause added.
+     * @throws an SDKClientError with the code `SDKClientErrorCodes.QueryBuilderInvalidArgument` if the order is not 'asc' or 'desc'.
+     */
+    orderBy(order: 'asc' | 'desc'): IQueryBuilder;
+    /**
+     * Adds a limit to the query.
+     * @param limit The limit for the query.
+     * @returns A QueryBuilder instance with a limit added.
+     * @throws an SDKClientError with the code `SDKClientErrorCodes.QueryBuilderInvalidArgument` if the limit is not a positive number.
+     */
+    limit(limit: number): IQueryBuilder;
+    /**
+     * Adds an offset to the query.
+     * @param offset The offset for the query.
+     * @returns A QueryBuilder instance with an offset added.
+     * @throws an SDKClientError with the code `SDKClientErrorCodes.QueryBuilderInvalidArgument` and a descriptive message if the offset is not a positive number.
+     */
+    offset(offset: number): IQueryBuilder;
+}

package/dist/key-value-database/QueryBuilder.js

@@ -0,0 +1 @@
+export {};

package/dist/key-value-database/SupportedIndexType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The supported types for indexed keys.
+ * @category Key-Value Database
+ */
+export type SupportedIndexType = string | number | boolean;

package/dist/key-value-database/SupportedIndexType.js

@@ -0,0 +1 @@
+export {};

package/dist/key-value-database/TableBuilder.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A table builder for the {@link IKeyValueDatabase}.
+ * @category Key-Value Database
+ */
+export interface ITableBuilder {
+    /**
+     * Adds an index to the table.
+     * @param name The name of the index.
+     * @returns The table builder.
+     */
+    index(name: string): ITableBuilder;
+}

package/dist/key-value-database/TableBuilder.js

@@ -0,0 +1 @@
+export {};

package/dist/key-value-database/ValueType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Base interface for all value types.
+ * Value types define the value of objects in a {@link IDatabaseTable}.
+ * @category Key-Value Database
+ */
+export interface IValueType {
+    /**
+     * The primary key of the object.
+     */
+    id: string;
+}

package/dist/key-value-database/ValueType.js

@@ -0,0 +1 @@
+export {};

package/dist/key-value-database/ValueTypeOmitId.d.ts

@@ -0,0 +1,6 @@
+import { IValueType } from '.';
+/**
+ * An helper type used to set or add object values in a {@link IDatabaseTable} without explicitely defining an id.
+ * @category Key-Value Database
+ */
+export type ValueTypeOmitId<T extends IValueType> = Omit<T, 'id'>;

package/dist/key-value-database/ValueTypeOmitId.js

@@ -0,0 +1 @@
+export {};

package/dist/key-value-database/index.d.ts

@@ -0,0 +1,21 @@
+export { DatabaseEvent, IDatabaseEvent } from './DatabaseEvent';
+export { IDatabaseLayout } from './DatabaseLayout';
+export { IDatabaseTable } from './DatabaseTable';
+export { IDatabaseTableAction } from './DatabaseTableAction';
+export { IDatabaseTableEvent } from './DatabaseTableEvent';
+export { IDatabaseTableIndex } from './DatabaseTableIndex';
+export { IDatabaseTableLayout } from './DatabaseTableLayout';
+export { IDatabaseTableQuery } from './DatabaseTableQuery';
+export { IDatabaseTableQueryWhereBetween } from './DatabaseTableQueryWhereBetween';
+export { IDatabaseTableQueryWhereValue } from './DatabaseTableQueryWhereValue';
+export { IDatabaseTableQueryWhereValues } from './DatabaseTableQueryWhereValues';
+export { IKeyValueDatabase } from './KeyValueDatabase';
+export { IKeyValueDatabaseConnector } from './KeyValueDatabaseConnector';
+export { KeyValueDatabaseConnectorConstructor } from './KeyValueDatabaseConnectorConstructor';
+export { IKeyValueDatabaseTableConnector } from './KeyValueDatabaseTableConnector';
+export { ILayoutBuilder } from './LayoutBuilder';
+export { IQueryBuilder } from './QueryBuilder';
+export { SupportedIndexType } from './SupportedIndexType';
+export { ITableBuilder } from './TableBuilder';
+export { IValueType } from './ValueType';
+export { ValueTypeOmitId } from './ValueTypeOmitId';

package/dist/key-value-database/index.js

@@ -0,0 +1 @@
+export { DatabaseEvent } from './DatabaseEvent';

package/dist/media-stream/AudioSubscriptionParams.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The subscription parameters for an audio track.
+ * @category Media Stream
+ */
+export type AudioSubscriptionParams = {};

package/dist/media-stream/AudioSubscriptionParams.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/DynamicMediaStream.d.ts

@@ -0,0 +1,12 @@
+import { IMediaStream, MediaStreamTransformer } from '.';
+/**
+ * The dynamic media stream interface.
+ * @category Media Stream
+ */
+export interface IDynamicMediaStream extends IMediaStream {
+    /**
+     * Set the transformations to apply to the stream.
+     * @param transformations The transformations to apply to the stream.
+     */
+    setTransformations(transformations: MediaStreamTransformer[]): void;
+}

package/dist/media-stream/DynamicMediaStream.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/LocalDynamicMediaStream.d.ts

@@ -0,0 +1,23 @@
+import { IDynamicMediaStream, ILocalMediaStream, MediaTrackKind } from '.';
+/**
+ * The local dynamic media stream interface.
+ * @category Media Stream
+ */
+export interface ILocalDynamicMediaStream extends ILocalMediaStream, IDynamicMediaStream {
+    /**
+     * Add a track to the stream. This will replace any existing track of the same kind.
+     * @param track The track to add.
+     */
+    addTrack(track: MediaStreamTrack): void;
+    /**
+     * Remove a track from the stream.
+     * @param param The track or kind of track to remove.
+     * @returns The removed track or null if the track was not found.
+     */
+    removeTrack(param: MediaStreamTrack | MediaTrackKind): MediaStreamTrack | null;
+    /**
+     * Replace the track with same kind as the new track in the stream.
+     * @param track The track to replace.
+     */
+    replaceTrack(track: MediaStreamTrack): void;
+}

package/dist/media-stream/LocalDynamicMediaStream.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/LocalMediaStream.d.ts

@@ -0,0 +1,16 @@
+import { IMediaStream, MediaStreamPriority } from '.';
+/**
+ * The local media stream interface.
+ * @category Media Stream
+ */
+export interface ILocalMediaStream extends IMediaStream {
+    /**
+     * Set the priority of the stream.
+     * @param priority The priority of the stream.
+     */
+    setPriority(priority: MediaStreamPriority): void;
+    /**
+     * Unpublish the stream.
+     */
+    unpublish(): void;
+}

package/dist/media-stream/LocalMediaStream.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/MediaStream.d.ts

@@ -0,0 +1,17 @@
+import { IStream } from '../core/stream';
+/**
+ * The media stream interface.
+ * @category Core
+ */
+export interface IMediaStream extends IStream {
+    /**
+     * Get the label of the stream.
+     * @returns The label of the stream.
+     */
+    getLabel(): string;
+    /**
+     * Get the media stream.
+     * @returns The media stream.
+     */
+    getMediaStream(): MediaStream;
+}

package/dist/media-stream/MediaStream.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/MediaStreamPriority.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The priority of a media stream. Higher priority streams will be prioritized over lower priority streams for quality of experience.
+ * @category Media Stream
+ */
+export declare enum MediaStreamPriority {
+    /**
+     * The highest priority.
+     */
+    High = 1,
+    /**
+     * The default priority.
+     */
+    Default = 2,
+    /**
+     * The lowest priority.
+     */
+    Low = 3
+}

package/dist/media-stream/MediaStreamPriority.js

@@ -0,0 +1,19 @@
+/**
+ * The priority of a media stream. Higher priority streams will be prioritized over lower priority streams for quality of experience.
+ * @category Media Stream
+ */
+export var MediaStreamPriority;
+(function (MediaStreamPriority) {
+    /**
+     * The highest priority.
+     */
+    MediaStreamPriority[MediaStreamPriority["High"] = 1] = "High";
+    /**
+     * The default priority.
+     */
+    MediaStreamPriority[MediaStreamPriority["Default"] = 2] = "Default";
+    /**
+     * The lowest priority.
+     */
+    MediaStreamPriority[MediaStreamPriority["Low"] = 3] = "Low";
+})(MediaStreamPriority || (MediaStreamPriority = {}));

package/dist/media-stream/MediaStreamSource.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The media source. Can be either a media stream or a HTML video element.
+ * @category Media Stream
+ */
+export type MediaStreamSource = MediaStream | HTMLVideoElement;

package/dist/media-stream/MediaStreamSource.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/MediaStreamTransformer.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The media stream transformer. Used to transform the media stream before it is sent.
+ * @param imageData The image data to transform.
+ * @returns The transformed image data.
+ * @category Media Stream
+ */
+export type MediaStreamTransformer = (imageData: ImageData) => ImageData;

package/dist/media-stream/MediaStreamTransformer.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/MediaSubscriptionParams.d.ts

@@ -0,0 +1,15 @@
+import { AudioSubscriptionParams, VideoSubscriptionParams } from '.';
+/**
+ * The subscription parameters for a media stream.
+ * @category Media Stream
+ */
+export type MediaSubscriptionParams = {
+    /**
+     * The video subscription parameters.
+     */
+    video?: VideoSubscriptionParams | boolean;
+    /**
+     * The audio subscription parameters.
+     */
+    audio?: AudioSubscriptionParams | boolean;
+};

package/dist/media-stream/MediaSubscriptionParams.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/MediaTrackKind.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The media track kind. Can be either 'audio' or 'video'.
+ * @category Media Stream
+ */
+export type MediaTrackKind = 'audio' | 'video';

package/dist/media-stream/MediaTrackKind.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/RemoteMediaStream.d.ts

@@ -0,0 +1,40 @@
+import { IMediaStream, MediaTrackKind, MediaSubscriptionParams } from '.';
+/**
+ * The unsubscribe callback.
+ * @category Media Stream
+ */
+export type Unsubscribe = () => void;
+/**
+ * The remote media stream interface.
+ * @category Media Stream
+ */
+export interface IRemoteMediaStream extends IMediaStream {
+    /**
+     * Get the available track kinds.
+     * @returns The available track kinds.
+     */
+    getAvailableTrackKinds(): MediaTrackKind[];
+    /**
+     * Subscribe to track kinds of the stream. Passing no track kinds will subscribe to all available track kinds.
+     * @param params The subscription parameters.
+     * @throws {@link SDKClientErrorCodes.SubscriptionRequestInProgress} if the subscription is already in progress.
+     * @throws {@link SDKClientErrorCodes.RemoteMediaStreamInvalidSubscriptionParams} if the subscription parameters are invalid.
+     */
+    subscribe(params?: MediaSubscriptionParams): void;
+    /**
+     * Update the subscription parameters.
+     * @param params The subscription parameters.
+     * @throws {@link SDKClientErrorCodes.RemoteMediaStreamInvalidSubscriptionParams} if the subscription parameters are invalid.
+     */
+    update(params: MediaSubscriptionParams): void;
+    /**
+     * Unsubscribe from track kinds of the stream. Passing no track kinds will unsubscribe from all subscribed track kinds.
+     * @param trackKinds The track kinds to unsubscribe from.
+     */
+    unsubscribe(trackKinds?: MediaTrackKind | MediaTrackKind[]): void;
+    /**
+     * Subscribe to when the provider of the stream changes.
+     * @param callback The callback to invoke when the provider changes.
+     */
+    onProviderChanged(callback: (providerId: string | undefined) => void): Unsubscribe;
+}

package/dist/media-stream/RemoteMediaStream.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/Resolution.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The maximum resolution for a video track.
+ * @category Media Stream
+ */
+export type Resolution = {
+    /**
+     * The width of the resolution.
+     */
+    width: number;
+    /**
+     * The height of the resolution.
+     */
+    height: number;
+};

package/dist/media-stream/Resolution.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/TrackSubscriptionParams.d.ts

@@ -0,0 +1,6 @@
+import { AudioSubscriptionParams, VideoSubscriptionParams } from '.';
+/**
+ * The subscription parameters for a track.
+ * @category Media Stream
+ */
+export type TrackSubscriptionParams = VideoSubscriptionParams | AudioSubscriptionParams;

package/dist/media-stream/TrackSubscriptionParams.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/VideoSubscriptionParams.d.ts

@@ -0,0 +1,15 @@
+import { Resolution } from '.';
+/**
+ * The subscription parameters for a video track.
+ * @category Media Stream
+ */
+export type VideoSubscriptionParams = {
+    /**
+     * The maximum resolution for the video track.
+     */
+    maxResolution?: Resolution;
+    /**
+     * The HTML element to render the video track to.
+     */
+    renderElement?: HTMLVideoElement;
+};

package/dist/media-stream/VideoSubscriptionParams.js

@@ -0,0 +1 @@
+export {};

package/dist/media-stream/index.d.ts

@@ -0,0 +1,15 @@
+export { AudioSubscriptionParams } from './AudioSubscriptionParams';
+export { IDynamicMediaStream } from './DynamicMediaStream';
+export { isValidMediaSubscriptionParams } from './isValidMediaSubscriptionParams';
+export { ILocalDynamicMediaStream } from './LocalDynamicMediaStream';
+export { ILocalMediaStream } from './LocalMediaStream';
+export { IMediaStream } from './MediaStream';
+export { MediaStreamPriority } from './MediaStreamPriority';
+export { MediaStreamSource } from './MediaStreamSource';
+export { MediaStreamTransformer } from './MediaStreamTransformer';
+export { MediaSubscriptionParams } from './MediaSubscriptionParams';
+export { MediaTrackKind } from './MediaTrackKind';
+export { IRemoteMediaStream } from './RemoteMediaStream';
+export { Resolution } from './Resolution';
+export { TrackSubscriptionParams } from './TrackSubscriptionParams';
+export { VideoSubscriptionParams } from './VideoSubscriptionParams';

package/dist/media-stream/index.js

@@ -0,0 +1,2 @@
+export { isValidMediaSubscriptionParams } from './isValidMediaSubscriptionParams';
+export { MediaStreamPriority } from './MediaStreamPriority';

package/dist/media-stream/isValidMediaSubscriptionParams.d.ts

@@ -0,0 +1,8 @@
+import { MediaSubscriptionParams } from '.';
+/**
+ * A function that validates media subscription parameters.
+ * @param params The media subscription parameters to validate.
+ * @returns True if the media subscription parameters are valid.
+ * @category Media Stream
+ */
+export declare function isValidMediaSubscriptionParams(params: unknown): params is MediaSubscriptionParams;

package/dist/media-stream/isValidMediaSubscriptionParams.js

@@ -0,0 +1,28 @@
+/**
+ * A function that validates media subscription parameters.
+ * @param params The media subscription parameters to validate.
+ * @returns True if the media subscription parameters are valid.
+ * @category Media Stream
+ */
+export function isValidMediaSubscriptionParams(params) {
+    if (!params) {
+        throw new Error('Invalid params');
+    }
+    if (typeof params !== 'object') {
+        throw new Error('Invalid params');
+    }
+    const paramsObj = params;
+    if (paramsObj.video && typeof paramsObj.video !== 'boolean') {
+        if (paramsObj.video.maxResolution) {
+            if (typeof paramsObj.video.maxResolution.width !== 'number' || typeof paramsObj.video.maxResolution.height !== 'number') {
+                throw new Error('Invalid resolution');
+            }
+        }
+        if (paramsObj.video.renderElement) {
+            if (!(paramsObj.video.renderElement instanceof HTMLVideoElement)) {
+                throw new Error('Invalid render element');
+            }
+        }
+    }
+    return true;
+}

package/dist/object-storage/FileDescriptor.d.ts

@@ -0,0 +1,31 @@
+import { ObjectKind } from '.';
+/**
+ * The file descriptor interface.
+ * @category Object Storage
+ */
+export interface IFileDescriptor {
+    /**
+     * The object kind.
+     */
+    kind: ObjectKind.File;
+    /**
+     * The name of the file.
+     */
+    name: string;
+    /**
+     * The type of the file.
+     */
+    type: string;
+    /**
+     * The size of the file.
+     */
+    size: number;
+    /**
+     * The path of the file.
+     */
+    path: string;
+    /**
+     * The path name of the file (a combination of the path and the name).
+     */
+    pathName: string;
+}

package/dist/object-storage/FileDescriptor.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/FilePayload.d.ts

@@ -0,0 +1,19 @@
+import { PayloadAction } from '.';
+/**
+ * The file payload interface.
+ * @category Object Storage
+ */
+export interface IFilePayload {
+    /**
+     * The file store payload action.
+     */
+    action: PayloadAction.File;
+    /**
+     * The file to publish.
+     */
+    file: File;
+    /**
+     * The path of the file.
+     */
+    path?: string;
+}

package/dist/object-storage/FilePayload.js

@@ -0,0 +1 @@
+export {};