@casual-simulation/aux-records 3.4.6-alpha.14668890889 → 3.5.0-alpha.15119114602

package/websockets/WebsocketController.d.ts

@@ -5,14 +5,17 @@ import type { DeviceConnection, WebsocketConnectionStore } from './WebsocketConn
 import type { AddUpdatesMessage, LoginMessage, RequestMissingPermissionMessage, RequestMissingPermissionResponseMessage, SendActionMessage, TimeSyncRequestMessage, UploadHttpHeaders, WatchBranchMessage, WebsocketErrorInfo, WebsocketEvent } from '@casual-simulation/aux-common/websockets/WebsocketEvents';
 import type { ConnectionInfo } from '@casual-simulation/aux-common/common/ConnectionInfo';
 import type { AuthController } from '../AuthController';
-import type { InstRecord, InstRecordsStore, InstWithSubscriptionInfo, SaveInstFailure } from './InstRecordsStore';
+import type { InstRecord, InstRecordsStore, InstWithSubscriptionInfo, LoadedPackage, SaveInstFailure } from './InstRecordsStore';
 import type { TemporaryInstRecordsStore } from './TemporaryInstRecordsStore';
-import type { DenialReason, ServerError, NotSupportedError } from '@casual-simulation/aux-common';
+import type { DenialReason, ServerError, NotSupportedError, KnownErrorCodes, UserRole } from '@casual-simulation/aux-common';
+import type { ZodIssue } from 'zod';
 import type { AuthorizationContext, AuthorizeSubjectFailure, ConstructAuthorizationContextFailure, PolicyController } from '../PolicyController';
 import type { ConfigurationStore } from '../ConfigurationStore';
 import type { FeaturesConfiguration } from '../SubscriptionConfiguration';
 import type { MetricsStore } from '../MetricsStore';
 import type { AuthStore } from '../AuthStore';
+import type { PackageRecordVersionWithMetadata } from '../packages/version';
+import { type PackageVersionRecordsController, type PackageVersionSpecifier } from '../packages/version';
 export declare const SAVE_PERMANENT_BRANCHES_LOCK = "savePermanentBranches";
 /**
  * Defines a class that is able to serve causal repos in realtime.
@@ -27,6 +30,7 @@ export declare class WebsocketController {
     private _config;
     private _metrics;
     private _authStore;
+    private _packageVersions;
     /**
      * Gets or sets the default device selector that should be used
      * for events that are sent without a selector.
@@ -34,7 +38,7 @@ export declare class WebsocketController {
     defaultDeviceSelector: DeviceSelector;
     mergeUpdatesOnMaxSizeExceeded: boolean;
     get messenger(): WebsocketMessenger;
-    constructor(connectionStore: WebsocketConnectionStore, messenger: WebsocketMessenger, instStore: InstRecordsStore, temporaryInstStore: TemporaryInstRecordsStore, auth: AuthController, policies: PolicyController, config: ConfigurationStore, metrics: MetricsStore, authStore: AuthStore);
+    constructor(connectionStore: WebsocketConnectionStore, messenger: WebsocketMessenger, instStore: InstRecordsStore, temporaryInstStore: TemporaryInstRecordsStore, auth: AuthController, policies: PolicyController, config: ConfigurationStore, metrics: MetricsStore, authStore: AuthStore, packageVersions?: PackageVersionRecordsController);
     /**
      * Attempts to log the given connection in.
      * @param connectionId The ID of the connection.
@@ -46,6 +50,7 @@ export declare class WebsocketController {
     watchBranch(connectionId: string, event: WatchBranchMessage): Promise<void>;
     unwatchBranch(connectionId: string, recordName: string | null, inst: string, branch: string): Promise<void>;
     addUpdates(connectionId: string, event: AddUpdatesMessage): Promise<void>;
+    addUserUpdates(request: AddUpdatesRequest): Promise<AddInstUpdatesResult>;
     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>;
@@ -83,6 +88,12 @@ export declare class WebsocketController {
      * @param event The response to the missing permission request.
      */
     respondToPermissionRequest(connectionId: string, event: RequestMissingPermissionResponseMessage): Promise<void>;
+    /**
+     * Attempts to install a package into an inst.
+     * @param request The request to load the package.
+     */
+    installPackage(request: LoadPackageRequest): Promise<LoadPackageResult>;
+    listInstalledPackages(request: ListInstalledPackagesRequest): Promise<ListInstalledPackagesResult>;
     syncTime(connectionId: string, event: TimeSyncRequestMessage, requestTime: number): Promise<void>;
     /**
      * Handles when the rate limit has been exceeded by the given connection.
@@ -201,4 +212,137 @@ export interface EraseInstFailure {
     errorMessage: string;
     reason?: DenialReason;
 }
+export interface AddUpdatesRequest {
+    /**
+     * The ID of the currently logged in user.
+     */
+    userId: string | null;
+    /**
+     * The role of the currently logged in user.
+     */
+    userRole?: UserRole | null;
+    /**
+     * The name of the record that the branch is for.
+     * Null if the branch should be public and non-permanent.
+     */
+    recordName: string | null;
+    /**
+     * The name of the inst.
+     */
+    inst: string;
+    /**
+     * The branch that the updates are for.
+     */
+    branch: string;
+    /**
+     * The updates that should be added.
+     */
+    updates: string[];
+    /**
+     * Whether this message should be treated as the first message
+     * after a watch_branch event.
+     * This flag MUST be included on the first message as large apiary messages may appear out of order.
+     */
+    initial?: boolean;
+    /**
+     * The list of timestamps that the updates occurred at.
+     */
+    timestamps?: number[];
+}
+export type AddInstUpdatesResult = AddInstUpdatesSuccess | AddInstUpdatesFailure;
+export interface AddInstUpdatesSuccess {
+    success: true;
+}
+export interface AddInstUpdatesFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+    reason?: DenialReason;
+}
+export interface LoadPackageRequest {
+    /**
+     * The ID of the currently logged in user.
+     */
+    userId: string | null;
+    /**
+     * The role of the currently logged in user.
+     */
+    userRole?: UserRole | null;
+    /**
+     * The name of the record that the package should be loaded into.
+     * Null if the inst is a public inst.
+     */
+    recordName: string | null;
+    /**
+     * The inst that the package should be loaded into.
+     */
+    inst: string;
+    /**
+     * The branch that the package should be loaded into.
+     * If omitted, then the default branch will be used.
+     */
+    branch?: string;
+    /**
+     * The package that should be loaded.
+     */
+    package: PackageVersionSpecifier;
+    /**
+     * The list of instances that are currently loaded.
+     */
+    instances?: string[];
+}
+export type LoadPackageResult = LoadPackageSuccess | LoadPackageFailure;
+export interface LoadPackageSuccess {
+    success: true;
+    /**
+     * The ID of the record which records that the package was loaded into the inst.
+     */
+    packageLoadId: string;
+    /**
+     * The package that was loaded.
+     */
+    package: PackageRecordVersionWithMetadata;
+}
+export interface LoadPackageFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+    reason?: DenialReason;
+    issues?: ZodIssue[];
+}
+export interface ListInstalledPackagesRequest {
+    /**
+     * The ID of the currently logged in user.
+     */
+    userId: string | null;
+    /**
+     * The role of the currently logged in user.
+     */
+    userRole?: UserRole | null;
+    /**
+     * The name of the record that the installed packages should be listed from.
+     * If null, then the inst is a public inst.
+     */
+    recordName: string | null;
+    /**
+     * The inst that the installed packages should be listed from.
+     */
+    inst: string;
+    /**
+     * The instances that are trying to list the packages.
+     */
+    instances?: string[];
+}
+export type ListInstalledPackagesResult = ListInstalledPackagesRequestSuccess | ListInstalledPackagesFailure;
+export interface ListInstalledPackagesRequestSuccess {
+    success: true;
+    packages: LoadedPackage[];
+}
+export interface ListInstalledPackagesFailure {
+    success: false;
+    errorCode: KnownErrorCodes;
+    errorMessage: string;
+    reason?: DenialReason;
+    issues?: ZodIssue[];
+}
 //# sourceMappingURL=WebsocketController.d.ts.map