@crewdle/web-sdk-types 1.0.0

package/dist/core/sdk/LoggingConnector.d.ts

@@ -0,0 +1,25 @@
+import { LoggingConnectorEvent } from '.';
+/**
+ * The logging connector interface.
+ * @category Core
+ */
+export interface ILoggingConnector {
+    /**
+     * Logs a message with the specified data. Used to connect a custom logging system to log events from the SDK.
+     * @param message The message to log.
+     * @param event The event to log.
+     */
+    log(message: string, event: LoggingConnectorEvent): void;
+    /**
+     * Logs a warning with the specified data. Used to connect a custom logging system to log events from the SDK.
+     * @param message The message to log.
+     * @param event The event to log.
+     */
+    warn(message: string, event: LoggingConnectorEvent): void;
+    /**
+     * Logs an error with the specified data. Used to connect a custom logging system to log events from the SDK.
+     * @param message The message to log.
+     * @param event The event to log.
+     */
+    error(message: string, event: LoggingConnectorEvent): void;
+}

package/dist/core/sdk/LoggingConnector.js

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

package/dist/core/sdk/LoggingConnectorEvent.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The logging connector event.
+ * @category Core
+ */
+export type LoggingConnectorEvent = {
+    vendorId: string;
+    clusterId?: string;
+    nodeId: string;
+    nodeType: string;
+    remoteId?: string;
+    data?: Record<string, unknown>;
+};

package/dist/core/sdk/LoggingConnectorEvent.js

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

package/dist/core/sdk/SDK.d.ts

@@ -0,0 +1,28 @@
+import { ICluster } from '../cluster';
+import { IAgentCredentials, IAuthAgent } from '../node/agent';
+import { IAuthUser, IUserCredentials } from '../node/user';
+/**
+ * The SDK interface.
+ * @category Core
+ */
+export interface ISDK {
+    /**
+     * Authenticate a user.
+     * @param credentials The credentials to authenticate the user with.
+     * @returns A promise that resolves with the authenticated user.
+     */
+    authenticateUser(credentials: IUserCredentials): Promise<IAuthUser>;
+    /**
+     * Authenticate an agent.
+     * @param agentGroupId The ID of the agent group to authenticate the agent with.
+     * @returns A promise that resolves with the authenticated agent.
+     */
+    authenticateAgent(credentials: IAgentCredentials): Promise<IAuthAgent>;
+    /**
+     * Join a cluster.
+     * @param clusterId The ID of the cluster to join.
+     * @returns A promise that resolves with the cluster.
+     * @throws {@link SDKClientErrorCodes.NodeNotAuthenticated} if the node is not authenticated.
+     */
+    joinCluster(clusterId: string): Promise<ICluster>;
+}

package/dist/core/sdk/SDK.js

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

package/dist/core/sdk/SDKOptions.d.ts

@@ -0,0 +1,61 @@
+import { KeyValueDatabaseConnectorConstructor } from 'key-value-database';
+import { ILoggingConnector } from '.';
+import { ObjectStoreConnectorConstructor } from 'object-storage';
+import { PeerConnectionConnectorConstructor } from '../connection';
+/**
+ * Options to configure the SDK.
+ * @category Core
+ */
+export interface ISDKOptions {
+    /**
+     * The audio context to use for audio processing.
+     */
+    audioContext?: AudioContext;
+    /**
+     * The flag to disable the interval hack that ensures the intervals run at the correct time.
+     */
+    disableIntervalHack?: boolean;
+    /**
+     * The custom logging connector to use for logging events.
+     */
+    loggingConnectors?: ILoggingConnector[];
+    /**
+     * The custom object store connector to use for storing objects.
+     * If not provided, the default object store connector is OPFS.
+     */
+    objectStoreConnector?: ObjectStoreConnectorConstructor;
+    /**
+     * The custom key-value database connector to use for storing key-value pairs.
+     * If not provided, the default key-value database connector is IndexedDB.
+     */
+    keyValueDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
+    /**
+     * The custom peer connection connector to use for creating peer connections.
+     * If not provided, the default peer connection connector is WebRTC in browser.
+     */
+    peerConnectionConnector?: PeerConnectionConnectorConstructor;
+    /**
+     * The maximum number of outgoing subscriptions.
+     */
+    maxOutgoingSubscriptions?: number;
+    /**
+     * The minimum number of initial connections.
+     */
+    minConnections?: number;
+    /**
+     * The maximum number of connections a node can have.
+     */
+    maxConnections?: number;
+    /**
+     * The maximum distance allowed between two nodes in the network.
+     */
+    maxDistance?: number;
+    /**
+     * The maximum frame rate to use for video.
+     */
+    maxFps?: number;
+    /**
+     * The maximum bits per pixel to use for video.
+     */
+    maxBpp?: number;
+}

package/dist/core/sdk/SDKOptions.js

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

package/dist/core/sdk/index.d.ts

@@ -0,0 +1,4 @@
+export { ILoggingConnector } from './LoggingConnector';
+export { LoggingConnectorEvent } from './LoggingConnectorEvent';
+export { ISDK } from './SDK';
+export { ISDKOptions } from './SDKOptions';

package/dist/core/sdk/index.js

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

package/dist/core/stream/ContentType.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The type of content of a stream.
+ * @category Core
+ */
+export declare enum ContentType {
+    /**
+     * The content is data.
+     */
+    Data = "data",
+    /**
+     * The content is media.
+     */
+    Media = "media",
+    /**
+     * The content is a file.
+     */
+    File = "file",
+    /**
+     * @ignore
+     */
+    PubSub = "pubsub",
+    /**
+     * @ignore
+     */
+    ObjectStore = "objectstore",
+    /**
+     * @ignore
+     */
+    KeyValueDatabase = "keyvaluedatabase"
+}

package/dist/core/stream/ContentType.js

@@ -0,0 +1,32 @@
+/**
+ * The type of content of a stream.
+ * @category Core
+ */
+export var ContentType;
+(function (ContentType) {
+    /**
+     * The content is data.
+     */
+    ContentType["Data"] = "data";
+    /**
+     * The content is media.
+     */
+    ContentType["Media"] = "media";
+    /**
+     * The content is a file.
+     */
+    ContentType["File"] = "file";
+    // TODO - move this to an internal type
+    /**
+     * @ignore
+     */
+    ContentType["PubSub"] = "pubsub";
+    /**
+     * @ignore
+     */
+    ContentType["ObjectStore"] = "objectstore";
+    /**
+     * @ignore
+     */
+    ContentType["KeyValueDatabase"] = "keyvaluedatabase";
+})(ContentType || (ContentType = {}));

package/dist/core/stream/DataStream.d.ts

@@ -0,0 +1,12 @@
+import { IStream } from '.';
+/**
+ * The data stream interface.
+ * @category Core
+ */
+export interface IDataStream extends IStream {
+    /**
+     * Get the name of the stream.
+     * @returns The name of the stream.
+     */
+    getName(): string;
+}

package/dist/core/stream/DataStream.js

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

package/dist/core/stream/Stream.d.ts

@@ -0,0 +1,18 @@
+import { ContentType } from '.';
+/**
+ * The stream interface.
+ * @category Core
+ */
+export interface IStream {
+    /**
+     * Get the owner ID of the stream.
+     * @returns The owner ID of the stream.
+     */
+    getOwnerId(): string;
+    /**
+     * @internal
+     * Get the content type of the stream.
+     * @returns The content type of the stream.
+     */
+    getContentType(): ContentType;
+}

package/dist/core/stream/Stream.js

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

package/dist/core/stream/index.d.ts

@@ -0,0 +1,3 @@
+export { ContentType } from './ContentType';
+export { IDataStream } from './DataStream';
+export { IStream } from './Stream';

package/dist/core/stream/index.js

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

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './core';
+export * from './key-value-database';
+export * from './media-stream';
+export * from './object-storage';
+export * from './pubsub';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from './core';
+export * from './key-value-database';
+export * from './media-stream';
+export * from './object-storage';
+export * from './pubsub';

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

@@ -0,0 +1,20 @@
+/**
+ * The supported key-value database events.
+ * @category Key-Value Database
+ */
+export declare enum DatabaseEvent {
+    /**
+     * The database synchronization is complete.
+     */
+    SyncComplete = "sync-complete"
+}
+/**
+ * Interface for key-value database events.
+ * @category Key-Value Database
+ */
+export interface IDatabaseEvent {
+    /**
+     * The event type.
+     */
+    event: DatabaseEvent;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * The supported key-value database events.
+ * @category Key-Value Database
+ */
+export var DatabaseEvent;
+(function (DatabaseEvent) {
+    /**
+     * The database synchronization is complete.
+     */
+    DatabaseEvent["SyncComplete"] = "sync-complete";
+})(DatabaseEvent || (DatabaseEvent = {}));

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

@@ -0,0 +1,27 @@
+import { IDatabaseTableLayout } from '.';
+/**
+ * Interface for a key-value database layout.
+ * Example:
+ * {
+ *   'table1': {
+ *     indexes: [
+ *       { keyPath: 'key1' },
+ *       { keyPath: 'key2' },
+ *     ],
+ *   },
+ * }
+ * @category Key-Value Database
+ */
+export interface IDatabaseLayout {
+    /**
+     * The tables in the database.
+     * The primary key of each table is automatically generated by the database.
+     */
+    tables: {
+        [tableName: string]: IDatabaseTableLayout;
+    };
+    /**
+     * The version of the layout.
+     */
+    version: number;
+}

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

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

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

@@ -0,0 +1,62 @@
+import { IDatabaseTableQuery, ValueTypeOmitId, IValueType, IDatabaseTableEvent, IQueryBuilder } from '.';
+/**
+ * Interface for a key-value database table.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTable<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.
+     */
+    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 {@link https://html.spec.whatwg.org/multipage/structured-data.html#serializable-objects | serializable }.
+     * @returns A promise that resolves with the value set.
+     */
+    set(key: string, value: ValueTypeOmitId<T>): Promise<T>;
+    /**
+     * Add a value to the database.
+     * @param value The value to add.
+     * @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.
+     * @returns A promise that resolves when the database has been cleared.
+     */
+    clear(): Promise<void>;
+    /**
+     * Get all the values 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.
+     * The query can either be a {@link IDatabaseTableQuery} or a {@link QueryBuilder}.
+     * @returns A promise that resolves with all the values in the database.
+     */
+    list(query?: IDatabaseTableQuery | IQueryBuilder): Promise<T[]>;
+    /**
+     * Count the number of keys 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.
+     * The query can either be a {@link IDatabaseTableQuery} or a {@link QueryBuilder}.
+     * @returns A promise that resolves with the number of keys in the database.
+     */
+    count(query?: IDatabaseTableQuery | IQueryBuilder): Promise<number>;
+    /**
+     * Subscribe to changes in the database table.
+     * @params callback The callback to call when the database table changes.
+     */
+    subscribe(callback: (event: IDatabaseTableEvent<T>) => void): void;
+    /**
+     * Unsubscribe from changes in the database table.
+     */
+    unsubscribe(): void;
+}

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

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

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

@@ -0,0 +1,5 @@
+/**
+ * The supported key-value database table actions.
+ * @category Key-Value Database
+ */
+export type IDatabaseTableAction = 'add' | 'update' | 'delete';

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

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

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

@@ -0,0 +1,15 @@
+import { IDatabaseTableAction, IValueType } from '.';
+/**
+ * Interface for key-value database table events.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTableEvent<T extends IValueType> {
+    /**
+     * The action performed on the table.
+     */
+    action: IDatabaseTableAction;
+    /**
+     * The value of the object.
+     */
+    value: T;
+}

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * Interface for a key-value database table index layout.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTableIndex {
+    /**
+     * The key path for the index.
+     */
+    keyPath: string;
+}

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

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

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

@@ -0,0 +1,11 @@
+import { IDatabaseTableIndex } from '.';
+/**
+ * Interface for a key-value database table layout.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTableLayout {
+    /**
+     * The secondary indexes for the table.
+     */
+    indexes?: IDatabaseTableIndex[];
+}

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

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

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

@@ -0,0 +1,27 @@
+import { IDatabaseTableQueryWhereBetween, IDatabaseTableQueryWhereValue, IDatabaseTableQueryWhereValues } from '.';
+/**
+ * Interface for a key-value database table query.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTableQuery {
+    /**
+     * The where clause for the query.
+     */
+    where?: IDatabaseTableQueryWhereValue | IDatabaseTableQueryWhereValues | IDatabaseTableQueryWhereBetween;
+    /**
+     * The order by clause for the query.
+     * The key must be a valid indexed key path for the table and match the where clause key, if provided.
+     */
+    orderBy?: {
+        key: string;
+        direction: 'asc' | 'desc';
+    };
+    /**
+     * The limit for the query, allowing pagination.
+     */
+    limit?: number;
+    /**
+     * The offset for the query, allowing pagination.
+     */
+    offset?: number;
+}

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

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

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

@@ -0,0 +1,20 @@
+import { SupportedIndexType } from '.';
+/**
+ * Interface for a where values are 'between' the lower and upper bounds.
+ * Between is always inclusive.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTableQueryWhereBetween {
+    /**
+     * The key must be a valid indexed key path for the table.
+     */
+    key: string;
+    /**
+     * The operator must be 'between'.
+     */
+    operator: 'between';
+    /**
+     * The value must be an array of two elements. The first element is the lower bound and the second element is the upper bound.
+     */
+    value: [SupportedIndexType, SupportedIndexType];
+}

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

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

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

@@ -0,0 +1,19 @@
+import { SupportedIndexType } from '.';
+/**
+ * Interface for a where clause with basic operators and a single value.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTableQueryWhereValue {
+    /**
+     * The key must be a valid indexed key path for the table.
+     */
+    key: string;
+    /**
+     * The operator must be a valid operator for the key type.
+     */
+    operator: '==' | '!=' | '>' | '<' | '<=' | '>=';
+    /**
+     * The value must be a single valid value for the key type.
+     */
+    value: SupportedIndexType;
+}

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

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

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

@@ -0,0 +1,19 @@
+import { SupportedIndexType } from '.';
+/**
+ * Interface for a where values are 'in' or 'not-in' the given values.
+ * @category Key-Value Database
+ */
+export interface IDatabaseTableQueryWhereValues {
+    /**
+     * The key must be a valid indexed key path for the table.
+     */
+    key: string;
+    /**
+     * The operator must be 'in' or 'not-in'.
+     */
+    operator: 'in' | 'not-in';
+    /**
+     * The value must be an array of values.
+     */
+    value: SupportedIndexType[];
+}

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

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

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

@@ -0,0 +1,35 @@
+import { IDataStream } from '../core/stream';
+import { IDatabaseEvent, IDatabaseTable, IValueType } from '.';
+/**
+ * Interface for a key-value database.
+ * @category Key-Value Database
+ */
+export interface IKeyValueDatabase extends IDataStream {
+    /**
+     * Get the name of the database.
+     */
+    getName(): string;
+    /**
+     * Get the owner ID of the database.
+     */
+    getOwnerId(): string;
+    /**
+     * Close the database.
+     */
+    close(): void;
+    /**
+     * Gets the table with the given name.
+     * @param tableName The name of the table to get.
+     * @returns The table.
+     */
+    getTable<T extends IValueType>(tableName: string): IDatabaseTable<T>;
+    /**
+     * Subscribe to datase events.
+     * @param callback The callback to call when a database event is published.
+     */
+    subscribe(callback: (event: IDatabaseEvent) => void): void;
+    /**
+     * Unsubscribe from database events.
+     */
+    unsubscribe(): void;
+}

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

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

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

@@ -0,0 +1,30 @@
+import { IValueType, IKeyValueDatabaseTableConnector } from '.';
+/**
+ * The key-value database connector interface.
+ * @category Key-Value Database
+ */
+export interface IKeyValueDatabaseConnector {
+    /**
+     * Open the database and run a migration on it if necessary.
+     */
+    open(): Promise<void>;
+    /**
+     * Close the database.
+     */
+    close(): void;
+    /**
+     * Check if a table exists in the database.
+     * @returns True if the table exists, false otherwise.
+     */
+    hasTable(tableName: string): boolean;
+    /**
+     * Create a table in the database.
+     * @param tableName The name of the table to create.
+     */
+    createTable(tableName: string): void;
+    /**
+     * Get the table connector for a table in the database.
+     * @param tableName The name of the table to get the connector for.
+     */
+    getTableConnector<T extends IValueType>(tableName: string): IKeyValueDatabaseTableConnector<T>;
+}

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

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

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

@@ -0,0 +1,6 @@
+import { IDatabaseLayout, IKeyValueDatabaseConnector } from '.';
+/**
+ * The key-value database connector constructor type.
+ * @category Key-Value Database
+ */
+export type KeyValueDatabaseConnectorConstructor = new (dbKey: string, layout: IDatabaseLayout) => IKeyValueDatabaseConnector;

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

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