@casual-simulation/aux-records 3.2.6 → 3.2.7-alpha.6227012901

package/websockets/Utils.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Gets the namespace that the given branch should use.
+ * @param branch The branch.
+ */
+export declare function branchNamespace(mode: string, recordName: string | null, inst: string, branch: string): string;
+/**
+ * Gets the namespace that should be used for watching devices connected to branches.
+ * @param branch The branch to watch.
+ */
+export declare function watchBranchNamespace(recordName: string | null, inst: string, branch: string): string;
+export declare function branchFromNamespace(mode: string, namespace: string): {
+    recordName: string;
+    inst: string;
+    branch: string;
+};
+//# sourceMappingURL=Utils.d.ts.map

package/websockets/Utils.js

@@ -0,0 +1,26 @@
+/**
+ * Gets the namespace that the given branch should use.
+ * @param branch The branch.
+ */
+export function branchNamespace(mode, recordName, inst, branch) {
+    return `/${mode}/${recordName !== null && recordName !== void 0 ? recordName : ''}/${inst}/${branch}`;
+}
+/**
+ * Gets the namespace that should be used for watching devices connected to branches.
+ * @param branch The branch to watch.
+ */
+export function watchBranchNamespace(recordName, inst, branch) {
+    return `/watched_branch/${recordName !== null && recordName !== void 0 ? recordName : ''}/${inst}/${branch}`;
+}
+export function branchFromNamespace(mode, namespace) {
+    // e.g. /branch/recordName/inst/branch
+    const [recordName, inst, branch] = namespace
+        .slice(mode.length + 2)
+        .split('/');
+    return {
+        recordName: recordName === '' ? null : recordName,
+        inst,
+        branch,
+    };
+}
+//# sourceMappingURL=Utils.js.map

package/websockets/Utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["Utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC3B,IAAY,EACZ,UAAyB,EACzB,IAAY,EACZ,MAAc;IAEd,OAAO,IAAI,IAAI,IAAI,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAChC,UAAyB,EACzB,IAAY,EACZ,MAAc;IAEd,OAAO,mBAAmB,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAY,EAAE,SAAiB;IAC/D,sCAAsC;IACtC,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,SAAS;SACvC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACtB,KAAK,CAAC,GAAG,CAAC,CAAC;IAChB,OAAO;QACH,UAAU,EAAE,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU;QACjD,IAAI;QACJ,MAAM;KACT,CAAC;AACN,CAAC"}

package/websockets/WebsocketConnectionStore.d.ts

@@ -0,0 +1,141 @@
+/**
+ * Defines an interface that defines a connection store for information about available connections.
+ */
+export interface WebsocketConnectionStore {
+    /**
+     * Saves the given connection to the store.
+     * @param connection The connection to save.
+     */
+    saveConnection(connection: DeviceConnection): Promise<void>;
+    /**
+     * Saves the given namespace connection to the store.
+     * @param connection The connection to save.
+     */
+    saveBranchConnection(connection: DeviceBranchConnection): Promise<void>;
+    /**
+     * Deletes the given connection from the store.
+     * @param connectionId The ID of the connection.
+     * @param mode The mode of the connection.
+     * @param recordName The name of the record that the branch exists in.
+     * @param inst The name of the inst that the branch exists in.
+     * @param branch The name of the branch.
+     */
+    deleteBranchConnection(connectionId: string, mode: BranchConnectionMode, recordName: string | null, inst: string, branch: string): Promise<void>;
+    /**
+     * Deletes all the connections with the given connection ID.
+     * @param connectionId The ID of the connection.
+     */
+    clearConnection(connectionId: string): Promise<void>;
+    /**
+     * Marks all the connections associated with the given connection ID as expired so that they can be deleted in the future.
+     * Works similarly to clearConnection(), but instead of deleting the connection, it marks them as expired.
+     *
+     * After calling this, the given connection ID will not be present in getConnectionsByNamespace() or countConnections(),
+     * but the connection will still be present in getConnection() (until the connection expires).
+     *
+     * @param connectionId The ID of the connection.
+     */
+    expireConnection(connectionId: string): Promise<void>;
+    /**
+     * Gets all the connections for the given branch.
+     * @param mode The mode of the connections.
+     * @param recordName The name of the record that the branch exists in.
+     * @param inst The name of the inst that the branch exists in.
+     * @param branch The name of the branch.
+     */
+    getConnectionsByBranch(mode: BranchConnectionMode, recordName: string | null, inst: string, branch: string): Promise<DeviceBranchConnection[]>;
+    /**
+     * Counts the number of active connections for the given branch.
+     */
+    countConnectionsByBranch(mode: BranchConnectionMode, recordName: string | null, inst: string, branch: string): Promise<number>;
+    /**
+     * Gets the given connection with the connection ID.
+     * @param connectionId The ID of the connection to get.
+     */
+    getConnection(connectionId: string): Promise<DeviceConnection>;
+    /**
+     * Gets the connection for the given connection ID and branch.
+     * @param connectionId The ID of the connection to get.
+     * @param recordName The name of the record that the branch exists in.
+     * @param inst The name of the inst that the branch exists in.
+     * @param branch The name of the branch.
+     */
+    getBranchConnection(connectionId: string, mode: BranchConnectionMode, recordName: string | null, inst: string, branch: string): Promise<DeviceBranchConnection>;
+    /**
+     * Gets the list of connections that are present for the given connection ID.
+     * @param connectionId The ID of the connection.
+     */
+    getConnections(connectionId: string): Promise<DeviceBranchConnection[]>;
+    /**
+     * Counts the number of active connections.
+     */
+    countConnections(): Promise<number>;
+    /**
+     * Gets the last time that the connection rate limit was exceeded for the given connection ID.
+     * @param connectionId The ID of the connection.
+     */
+    getConnectionRateLimitExceededTime(connectionId: string): Promise<number | null>;
+    /**
+     * Sets the last time that the connection rate limit was exceeded for the given connection ID.
+     * @param connectionId The ID of the connection.
+     * @param timeMs The unix time in miliseconds.
+     */
+    setConnectionRateLimitExceededTime(connectionId: string, timeMs: number | null): Promise<void>;
+}
+/**
+ * Defines an interface that represents the connection of a device to the apiary.
+ */
+export interface DeviceConnection {
+    /**
+     * The server-created ID of the connection.
+     */
+    serverConnectionId: string;
+    /**
+     * The client-created ID of the connection.
+     */
+    clientConnectionId: string;
+    /**
+     * The ID of the user that the connection is associated with.
+     */
+    userId: string;
+    /**
+     * The ID of the session that the user used to connect.
+     */
+    sessionId: string;
+    /**
+     * The token that the device is using.
+     */
+    token: string;
+}
+/**
+ * Defines a list of modes that a connection can be in.
+ * - "branch": The connection is connected to a branch.
+ * - "watch": The connection is watching a branch for connection changes.
+ */
+export type BranchConnectionMode = 'branch' | 'watch_branch';
+/**
+ * Defines an interface that represents the connection of a device to a branch.
+ */
+export interface DeviceBranchConnection extends DeviceConnection {
+    /**
+     * The mode of the connection.
+     */
+    mode: BranchConnectionMode;
+    /**
+     * The name of the record that the device is connected to.
+     */
+    recordName: string | null;
+    /**
+     * The name of the inst that the device is connected to.
+     */
+    inst: string;
+    /**
+     * The name of the branch that the device is connected to.
+     */
+    branch: string;
+    /**
+     * Whether the data stored by the connection is supposed to be temporary.
+     */
+    temporary: boolean;
+}
+//# sourceMappingURL=WebsocketConnectionStore.d.ts.map

package/websockets/WebsocketConnectionStore.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=WebsocketConnectionStore.js.map

package/websockets/WebsocketConnectionStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebsocketConnectionStore.js","sourceRoot":"","sources":["WebsocketConnectionStore.ts"],"names":[],"mappings":""}

package/websockets/WebsocketController.d.ts

@@ -0,0 +1,97 @@
+import { StoredAux } from '@casual-simulation/aux-common/bots';
+import { WebsocketMessenger } from './WebsocketMessenger';
+import { DeviceSelector } from '@casual-simulation/aux-common/common/RemoteActions';
+import { DeviceConnection, WebsocketConnectionStore } from './WebsocketConnectionStore';
+import { AddUpdatesMessage, LoginMessage, SendActionMessage, TimeSyncRequestMessage, UploadHttpHeaders, WatchBranchMessage, WebsocketErrorEvent, WebsocketEvent } from '@casual-simulation/aux-common/websockets/WebsocketEvents';
+import { ConnectionInfo } from '@casual-simulation/aux-common/common/ConnectionInfo';
+import { AuthController } from '../AuthController';
+import { InstRecordsStore } from './InstRecordsStore';
+import { TemporaryInstRecordsStore } from './TemporaryInstRecordsStore';
+import { ZodIssue } from 'zod';
+/**
+ * Defines a class that is able to serve causal repos in realtime.
+ */
+export declare class WebsocketController {
+    private _connectionStore;
+    private _messenger;
+    private _instStore;
+    private _temporaryStore;
+    private _auth;
+    /**
+     * Gets or sets the default device selector that should be used
+     * for events that are sent without a selector.
+     */
+    defaultDeviceSelector: DeviceSelector;
+    mergeUpdatesOnMaxSizeExceeded: boolean;
+    get messenger(): WebsocketMessenger;
+    constructor(connectionStore: WebsocketConnectionStore, messenger: WebsocketMessenger, instStore: InstRecordsStore, temporaryInstStore: TemporaryInstRecordsStore, auth: AuthController);
+    /**
+     * Attempts to log the given connection in.
+     * @param connectionId The ID of the connection.
+     * @param requestId The ID of the request.
+     * @param message The login message.
+     */
+    login(connectionId: string, requestId: number, message: LoginMessage): Promise<void>;
+    disconnect(connectionId: string): Promise<void>;
+    watchBranch(connectionId: string, event: WatchBranchMessage): Promise<void>;
+    private _getOrCreateInst;
+    private _getOrCreateBranch;
+    unwatchBranch(connectionId: string, recordName: string | null, inst: string, branch: string): Promise<void>;
+    addUpdates(connectionId: string, event: AddUpdatesMessage): Promise<void>;
+    sendAction(connectionId: string, event: SendActionMessage): Promise<void>;
+    watchBranchDevices(connectionId: string, recordName: string | null, inst: string, branch: string): Promise<void>;
+    unwatchBranchDevices(connectionId: string, recordName: string | null, inst: string, branch: string): Promise<void>;
+    deviceCount(connectionId: string, recordName: string | null, inst: string | null, branch: string | null): Promise<void>;
+    getBranchData(recordName: string | null, inst: string, branch: string): Promise<StoredAux>;
+    getUpdates(connectionId: string, recordName: string | null, inst: string, branch: string): Promise<void>;
+    /**
+     * Processes a webhook and returns the status code that should be returned.
+     * @param branch The branch that the webhook is for.
+     * @param method The HTTP method that was used for the webhook.
+     * @param url The URL that was requested.
+     * @param headers The headers that were included in the request.
+     * @param data The data included in the request.
+     */
+    webhook(recordName: string | null, inst: string, branch: string, method: string, url: string, headers: object, data: object): Promise<number>;
+    syncTime(connectionId: string, event: TimeSyncRequestMessage, requestTime: number): Promise<void>;
+    /**
+     * Handles when the rate limit has been exceeded by the given connection.
+     * @param connectionId The ID of the connection.
+     * @param retryAfter The Retry-After header value.
+     * @param totalHits The total number of hits by the connection.
+     * @param timeMs The current time in unix time in miliseconds.
+     */
+    rateLimitExceeded(connectionId: string, retryAfter: number, totalHits: number, timeMs: number): Promise<void>;
+    /**
+     * Processes the given upload request.
+     * @param connectionId The ID of the connection that is requesting the upload.
+     * @param requestId The ID of the request.
+     */
+    uploadRequest(connectionId: string, requestId: number): Promise<void>;
+    downloadRequest(connectionId: string, requestId: number, url: string, method: string, headers: UploadHttpHeaders): Promise<DownloadRequestResult>;
+    sendError(connectionId: string, error: WebsocketControllerError): Promise<void>;
+    sendEvent(connectionId: string, event: WebsocketEvent): Promise<void>;
+}
+export declare function connectionInfo(device: DeviceConnection): ConnectionInfo;
+/**
+ * Determines if the given event targets the given device connection.
+ * @param event The event to check.
+ * @param device The device to check.
+ */
+export declare function isEventForDevice(event: DeviceSelector, device: DeviceConnection): boolean;
+export type DownloadRequestResult = DownloadRequestSuccess | DownloadRequestFailure;
+export interface DownloadRequestSuccess {
+    success: true;
+    requestId: number;
+    message: string;
+}
+export interface DownloadRequestFailure extends WebsocketControllerError {
+    success: false;
+}
+export interface WebsocketControllerError {
+    requestId: number;
+    errorCode: WebsocketErrorEvent[2];
+    errorMessage: string;
+    issues?: ZodIssue[];
+}
+//# sourceMappingURL=WebsocketController.d.ts.map