@casual-simulation/aux-runtime 3.8.0-alpha.18508342733 → 3.8.1-alpha.18755991904

package/runtime/AuxLibraryDefinitions.def

@@ -1,4 +1,3 @@
-
 // Preact Hooks Types
 type Inputs = ReadonlyArray<unknown>;
 
@@ -6,11 +5,11 @@ export type StateUpdater<S> = (value: S | ((prevState: S) => S)) => void;
 
 export type Reducer<S, A> = (prevState: S, action: A) => S;
 interface Ref<T> {
-	readonly current: T | null;
+    readonly current: T | null;
 }
 
 interface MutableRef<T> {
-	current: T;
+    current: T;
 }
 // End Preact Hooks Types
 
@@ -262,6 +261,7 @@ declare type AsyncActions =
     | AsyncErrorAction
     | ShowInputAction
     | ShowConfirmAction
+    | ShowAlertAction
     | ShareAction
     | CreateCertificateAction
     | SignTagAction
@@ -580,25 +580,25 @@ export interface FocusOnOptions {
      * The tag that should be focused.
      * Only supported by the system portal.
      */
-     tag?: string;
-
-     /**
-      * The space of the tag that should be focused.
-      * Only supported by the system portal.
-      */
-     space?: string;
- 
-     /**
-      * The line number that should be focued.
-      * Only supported by the system portal.
-      */
-     lineNumber?: number;
- 
-     /**
-      * The column number that should be focused.
-      * Only supported by the system portal.
-      */
-     columnNumber?: number;
+    tag?: string;
+
+    /**
+     * The space of the tag that should be focused.
+     * Only supported by the system portal.
+     */
+    space?: string;
+
+    /**
+     * The line number that should be focued.
+     * Only supported by the system portal.
+     */
+    lineNumber?: number;
+
+    /**
+     * The column number that should be focused.
+     * Only supported by the system portal.
+     */
+    columnNumber?: number;
 
     /**
      * The portal that the bot should be focused in.
@@ -1506,6 +1506,38 @@ declare interface ShowConfirmOptions {
     cancelText?: string;
 }
 
+/**
+ * Defines an event that is used to show an alert dialog.
+ */
+declare interface ShowAlertAction extends AsyncAction {
+    type: 'show_alert';
+
+    /**
+     * The options for the alert dialog.
+     */
+    options: ShowAlertOptions;
+}
+
+/**
+ * Defines an interface that represents the options that can be used for an alert dialog.
+ */
+declare interface ShowAlertOptions {
+    /**
+     * The title that should be shown for the dialog.
+     */
+    title: string;
+
+    /**
+     * The content of the dialog.
+     */
+    content: string;
+
+    /**
+     * The text that should be shown on the dismiss button.
+     */
+    dismissText?: string;
+}
+
 /**
  * Defines an event for actions.
  * Actions are basically user-defined events.
@@ -2014,7 +2046,7 @@ export interface AddDropSnapAction extends Action {
      * The ID of the bot that, when it is a drop target, the snap points should be enabled.
      * If null, then the targets apply globally during the drag operation.
      */
-     botId?: string;
+    botId?: string;
 }
 
 /**
@@ -2287,7 +2319,7 @@ declare interface RegisterPrefixOptions {
     /**
      * The name of the prefix.
      */
-     name?: string;
+    name?: string;
 }
 
 
@@ -3045,15 +3077,15 @@ export interface CreatePublicRecordKeyFailure {
     /**
      * The type of error that occurred.
      */
-     errorCode:
-        | UnauthorizedToCreateRecordKeyError
-        | NotLoggedInError
-        | 'unacceptable_session_key'
-        | 'invalid_key'
-        | 'session_expired'
-        | 'invalid_policy'
-        | ServerError
-        | 'not_supported';
+    errorCode:
+    | UnauthorizedToCreateRecordKeyError
+    | NotLoggedInError
+    | 'unacceptable_session_key'
+    | 'invalid_key'
+    | 'session_expired'
+    | 'invalid_policy'
+    | ServerError
+    | 'not_supported';
 
     /**
      * The error message.
@@ -3063,7 +3095,7 @@ export interface CreatePublicRecordKeyFailure {
     /**
      * The unique reason as to why the error occurred.
      */
-    errorReason: 
+    errorReason:
     | 'user_denied'
     | NotLoggedInError
     | 'record_owned_by_different_user'
@@ -3108,12 +3140,12 @@ export type NotAuthorizedError = 'not_authorized';
 
 
 export type AuthorizeDeniedError = ServerError
-| CreatePublicRecordKeyFailure['errorCode']
-| 'action_not_supported'
-| 'not_logged_in'
-| NotAuthorizedError
-| 'unacceptable_request'
-| 'subscription_limit_reached';
+    | CreatePublicRecordKeyFailure['errorCode']
+    | 'action_not_supported'
+    | 'not_logged_in'
+    | NotAuthorizedError
+    | 'unacceptable_request'
+    | 'subscription_limit_reached';
 
 export type UpdateUserPolicyError = 'policy_too_large';
 
@@ -3492,8 +3524,8 @@ export interface GrantMarkerPermissionFailure {
      * The error code that indicates why the request failed.
      */
     errorCode:
-        | ServerError
-        | AuthorizeDeniedError;
+    | ServerError
+    | AuthorizeDeniedError;
 
     /**
      * The error message that indicates why the request failed.
@@ -3539,8 +3571,8 @@ export interface GrantResourcePermissionFailure {
      * The error code that indicates why the request failed.
      */
     errorCode:
-        | ServerError
-        | AuthorizeDeniedError;
+    | ServerError
+    | AuthorizeDeniedError;
 
     /**
      * The error message that indicates why the request failed.
@@ -3587,9 +3619,9 @@ export interface RevokePermissionFailure {
      * The error code that indicates why the request failed.
      */
     errorCode:
-        | ServerError
-        | 'permission_not_found'
-        | AuthorizeDeniedError;
+    | ServerError
+    | 'permission_not_found'
+    | AuthorizeDeniedError;
 
     /**
      * The error message that indicates why the request failed.
@@ -3669,9 +3701,9 @@ export interface ListPermissionsSuccess {
 export interface ListPermissionsFailure {
     success: false;
     errorCode:
-        | ServerError
-        | ValidatePublicRecordKeyFailure['errorCode']
-        | AuthorizeSubjectFailure['errorCode'];
+    | ServerError
+    | ValidatePublicRecordKeyFailure['errorCode']
+    | AuthorizeSubjectFailure['errorCode'];
     errorMessage: string;
 }
 
@@ -3712,8 +3744,8 @@ export interface RevokeRoleFailure {
      * The error code that indicates why the request failed.
      */
     errorCode:
-        | ServerError
-        | AuthorizeDeniedError;
+    | ServerError
+    | AuthorizeDeniedError;
 
     /**
      * The error message that indicates why the request failed.
@@ -3730,9 +3762,9 @@ export interface GrantRoleSuccess {
 export interface GrantRoleFailure {
     success: false;
     errorCode:
-        | ServerError
-        | AuthorizeDeniedError
-        | 'roles_too_large';
+    | ServerError
+    | AuthorizeDeniedError
+    | 'roles_too_large';
     errorMessage: string;
 }
 
@@ -3767,13 +3799,13 @@ export interface EraseInstFailure {
      * The error code that indicates why the request failed.
      */
     errorCode:
-        | ServerError
-        | 'inst_not_found'
-        | NotSupportedError
-        | NotLoggedInError
-        | InvalidRecordKey
-        | RecordNotFoundError
-        | 'not_authorized';
+    | ServerError
+    | 'inst_not_found'
+    | NotSupportedError
+    | NotLoggedInError
+    | InvalidRecordKey
+    | RecordNotFoundError
+    | 'not_authorized';
 
     /**
      * The error message that indicates why the request failed.
@@ -3784,7 +3816,7 @@ export interface EraseInstFailure {
 /**
  * The options for data record actions.
  */
- export interface RecordDataOptions {
+export interface RecordDataOptions {
     /**
      * The HTTP Endpoint that should be queried.
      */
@@ -3908,24 +3940,24 @@ export interface SearchCollectionField {
      * The type of the field.
      */
     type:
-        | 'string'
-        | 'string[]'
-        | 'int32'
-        | 'int32[]'
-        | 'int64'
-        | 'int64[]'
-        | 'float'
-        | 'float[]'
-        | 'bool'
-        | 'bool[]'
-        | 'geopoint'
-        | 'geopoint[]'
-        | 'geopolygon'
-        | 'object'
-        | 'object[]'
-        | 'string*'
-        | 'image'
-        | 'auto';
+    | 'string'
+    | 'string[]'
+    | 'int32'
+    | 'int32[]'
+    | 'int64'
+    | 'int64[]'
+    | 'float'
+    | 'float[]'
+    | 'bool'
+    | 'bool[]'
+    | 'geopoint'
+    | 'geopoint[]'
+    | 'geopolygon'
+    | 'object'
+    | 'object[]'
+    | 'string*'
+    | 'image'
+    | 'auto';
 
     /**
      * Enables faceting on the field.
@@ -4261,7 +4293,7 @@ export interface ListStudiosSuccess {
  */
 export interface ListStudiosFailure {
     success: false;
-    
+
     /**
      * The error code.
      */
@@ -4379,19 +4411,19 @@ export interface RoomOptions {
      * Whether to stream video.
      * Defaults to true.
      */
-     video?: boolean;
+    video?: boolean;
 
-     /**
-      * Whether to stream audio.
-      * Defaults to true.
-      */
-     audio?: boolean;
- 
-     /**
-      * Whether to stream the screen.
-      * Defaults to false.
-      */
-     screen?: boolean;
+    /**
+     * Whether to stream audio.
+     * Defaults to true.
+     */
+    audio?: boolean;
+
+    /**
+     * Whether to stream the screen.
+     * Defaults to false.
+     */
+    screen?: boolean;
 }
 
 
@@ -4508,37 +4540,37 @@ export interface JoinRoomActionOptions extends Partial<RoomOptions> {
      * The HTTP endpoint of the records website that should host the meeting.
      * If omitted, then the preconfigured records endpoint will be used.
      */
-     endpoint?: string;
+    endpoint?: string;
 
     /**
      * The defaults that should be used for recording audio.
      * Should be an object.
      * See https://docs.livekit.io/client-sdk-js/interfaces/AudioCaptureOptions.html for a full list of properties.
      */
-     audioCaptureDefaults: object;
-
-     /**
-      * The defaults that should be used for recording video. Should be an object.
-      * See https://docs.livekit.io/client-sdk-js/interfaces/VideoCaptureOptions.html for a full list of properties.
-      */
-     videoCaptureDefaults: object;
- 
-     /**
-      * The defaults that should be used for uploading audio/video content.
-      * See https://docs.livekit.io/client-sdk-js/interfaces/TrackPublishDefaults.html for a full list of properties.
-      */
-     publishDefaults: object;
- 
-     /**
-      * Whether to enable dynacast.
-      * See https://docs.livekit.io/client-sdk-js/interfaces/RoomOptions.html#dynacast for more info.
-      */
-     dynacast: boolean;
- 
-     /**
-      * Whether to enable adaptive streaming. Alternatively accepts an object with properties from this page: https://docs.livekit.io/client-sdk-js/modules.html#AdaptiveStreamSettings
-      */
-     adaptiveStream: boolean | object;
+    audioCaptureDefaults: object;
+
+    /**
+     * The defaults that should be used for recording video. Should be an object.
+     * See https://docs.livekit.io/client-sdk-js/interfaces/VideoCaptureOptions.html for a full list of properties.
+     */
+    videoCaptureDefaults: object;
+
+    /**
+     * The defaults that should be used for uploading audio/video content.
+     * See https://docs.livekit.io/client-sdk-js/interfaces/TrackPublishDefaults.html for a full list of properties.
+     */
+    publishDefaults: object;
+
+    /**
+     * Whether to enable dynacast.
+     * See https://docs.livekit.io/client-sdk-js/interfaces/RoomOptions.html#dynacast for more info.
+     */
+    dynacast: boolean;
+
+    /**
+     * Whether to enable adaptive streaming. Alternatively accepts an object with properties from this page: https://docs.livekit.io/client-sdk-js/modules.html#AdaptiveStreamSettings
+     */
+    adaptiveStream: boolean | object;
 }
 
 export interface LeaveRoomActionOptions {
@@ -4546,7 +4578,7 @@ export interface LeaveRoomActionOptions {
      * The HTTP endpoint of the records website that should host the meeting.
      * If omitted, then the preconfigured records endpoint will be used.
      */
-     endpoint?: string;
+    endpoint?: string;
 }
 
 export type GetRoomRemoteOptionsResult =
@@ -4602,7 +4634,7 @@ export interface RoomRemoteOptions {
 /**
  * Defines an interface that represents an update that has been applied to an inst.
  */
- export interface InstUpdate {
+export interface InstUpdate {
     /**
      * The ID of the update.
      */
@@ -7998,7 +8030,7 @@ export interface QuaternionRotation {
 /**
  * Defines an interface that represents a rotation transforms (0, 1, 0) and (0, 0, 1) to look along the given direction and upwards axes.
  */
- export interface LookRotation {
+export interface LookRotation {
     /**
      * The direction that (0, 1, 0) should be pointing along after the rotation is applied.
      */
@@ -8034,7 +8066,7 @@ export interface QuaternionRotation {
 /**
  * Defines an interface that represents the result of a raycast operation.
  */
- export interface RaycastResult {
+export interface RaycastResult {
     /**
      * The list of intersections.
      */
@@ -8085,9 +8117,9 @@ export interface BotIntersection {
      */
     portal: string;
 
-     /**
-      * The dimension that the bot is in.
-      */
+    /**
+     * The dimension that the bot is in.
+     */
     dimension: string;
 }
 
@@ -9486,7 +9518,7 @@ interface DebuggerBase {
     * Creates a tag value that can be used to link to the given bots.
     * @param bots The bots that the link should point to.
     */
-     getLink(...bots: (Bot | string | (Bot | string)[])[]): string;
+    getLink(...bots: (Bot | string | (Bot | string)[])[]): string;
 
     /**
      * Gets the list of bot links that are stored in this bot's tags.
@@ -10051,7 +10083,7 @@ interface DebuggerBase {
      * Defines a set of functions that are used to create and transform mods.
      */
     mod: ModFuncs;
-    
+
     /**
      * Defines a set of functions that are used to transform byte arrays.
      */
@@ -10100,18 +10132,18 @@ interface Debugger extends DebuggerBase {
      */
     create(...mods: Mod[]): Bot | Bot[];
 
-     /**
-      * Destroys the given bot, bot ID, or list of bots.
-      * @param bot The bot, bot ID, or list of bots to destroy.
-      */
+    /**
+     * Destroys the given bot, bot ID, or list of bots.
+     * @param bot The bot, bot ID, or list of bots to destroy.
+     */
     destroy(bot: Bot | string | Bot[]): void;
 
-     /**
-     * Shouts the given events in order until a bot returns a result.
-     * Returns the result that was produced or undefined if no result was produced.
-     * @param eventNames The names of the events to shout.
-     * @param arg The argument to shout.
-     */
+    /**
+    * Shouts the given events in order until a bot returns a result.
+    * Returns the result that was produced or undefined if no result was produced.
+    * @param eventNames The names of the events to shout.
+    * @param arg The argument to shout.
+    */
     priorityShout(eventNames: string[], arg?: any): any;
 
     /**
@@ -10196,18 +10228,18 @@ interface PausableDebugger extends DebuggerBase {
      */
     create(...mods: Mod[]): Promise<Bot | Bot[]>;
 
-     /**
-      * Destroys the given bot, bot ID, or list of bots.
-      * @param bot The bot, bot ID, or list of bots to destroy.
-      */
+    /**
+     * Destroys the given bot, bot ID, or list of bots.
+     * @param bot The bot, bot ID, or list of bots to destroy.
+     */
     destroy(bot: Bot | string | Bot[]): Promise<void>;
 
-     /**
-     * Shouts the given events in order until a bot returns a result.
-     * Returns the result that was produced or undefined if no result was produced.
-     * @param eventNames The names of the events to shout.
-     * @param arg The argument to shout.
-     */
+    /**
+    * Shouts the given events in order until a bot returns a result.
+    * Returns the result that was produced or undefined if no result was produced.
+    * @param eventNames The names of the events to shout.
+    * @param arg The argument to shout.
+    */
     priorityShout(eventNames: string[], arg?: any): Promise<any>;
 
     /**
@@ -10370,7 +10402,7 @@ export interface StopFormAnimationOptions {
 /**
  * Defines an interface that contains animation information.
  */
- export interface FormAnimationData {
+export interface FormAnimationData {
     /**
      * The name of the animation.
      */
@@ -10751,11 +10783,11 @@ export interface AIHumeGetAccessTokenFailure {
     success: false;
 
     errorCode:
-        | ServerError
-        | NotLoggedInError
-        | NotSupportedError
-        | NotAuthorizedError
-        | 'hume_api_error';
+    | ServerError
+    | NotLoggedInError
+    | NotSupportedError
+    | NotAuthorizedError
+    | 'hume_api_error';
     errorMessage: string;
 }
 
@@ -10825,10 +10857,10 @@ export interface AISloydGenerateModelFailure {
      * The error code.
      */
     errorCode:
-        | ServerError
-        | NotLoggedInError
-        | NotSupportedError
-        | NotAuthorizedError;
+    | ServerError
+    | NotLoggedInError
+    | NotSupportedError
+    | NotAuthorizedError;
 
     /**
      * The error message.
@@ -11274,17 +11306,17 @@ export interface CrudListItemsSuccess<T> {
 export interface CrudListItemsFailure {
     success: false;
     errorCode:
-        | ServerError
-        | NotLoggedInError
-        | NotAuthorizedError
-        | 'data_not_found';
+    | ServerError
+    | NotLoggedInError
+    | NotAuthorizedError
+    | 'data_not_found';
     errorMessage: string;
 }
 
 /**
  * Defines a record that represents a database that can be queried using SQL.
  */
-export interface DatabaseRecord extends CrudRecord {}
+export interface DatabaseRecord extends CrudRecord { }
 
 /**
  * Defines a statement that can be sent to the database.
@@ -11315,12 +11347,12 @@ export type GenericSuccess<T> = T extends Array<any>
     ? { success: true; items: T }
     : T extends object
     ? {
-          success: true;
-      } & T
+        success: true;
+    } & T
     : {
-          success: true;
-          value: T;
-      };
+        success: true;
+        value: T;
+    };
 
 export type GenericFailure<E extends ErrorType> = {
     success: false;
@@ -11524,10 +11556,10 @@ export interface HandleWebhookFailure {
      * The error code if the webhook was not successfully handled.
      */
     errorCode:
-        | ServerError
-        | 'not_found'
-        | NotAuthorizedError
-        | 'invalid_webhook_target';
+    | ServerError
+    | 'not_found'
+    | NotAuthorizedError
+    | 'invalid_webhook_target';
 
     /**
      * The error message if the webhook was not successfully handled.
@@ -12373,7 +12405,7 @@ export interface SharedTextDeleteOp {
     count: number;
 }
 
-export interface RelativePosition {}
+export interface RelativePosition { }
 
 /**
  * Defines a record that represents a notification.
@@ -13400,7 +13432,7 @@ interface Os {
      * @docid os.addBotListener
      */
     addBotListener(bot: Bot, tagName: string, listener: DynamicListener): void;
-    
+
     /**
      * Removes the given listener from a bot for a specific tag.
      * @param bot The bot that the listener should be removed from.
@@ -13574,11 +13606,11 @@ interface Os {
      */
     joinRoom(roomName: string, options?: JoinRoomActionOptions): Promise<JoinRoomResult>;
 
-     /**
-      * Attempts to leave the given meeting room.
-      * @param roomName The name of the meeting room to leave.
-      * @param options The options.
-      */
+    /**
+     * Attempts to leave the given meeting room.
+     * @param roomName The name of the meeting room to leave.
+     * @param options The options.
+     */
     leaveRoom(roomName: string, options?: LeaveRoomActionOptions): Promise<LeaveRoomResult>;
 
     /**
@@ -13813,7 +13845,7 @@ interface Os {
      * Exits fullscreen mode.
      */
     exitFullscreenMode(): ExitFullscreenAction;
-    
+
     /**
      * Hides the loading screen.
      * 
@@ -14306,7 +14338,7 @@ interface Os {
      * @docgroup 10-load-inst
      */
     unloadServer(id: string): UnloadServerAction | void;
-    
+
     /**
      * Unloads the given inst from the current browser tab. When the inst is unloaded, the {@tag @onInstLeave} shout will be triggered.
      *
@@ -14448,6 +14480,12 @@ interface Os {
      */
     showConfirm(options: ShowConfirmOptions): Promise<boolean>;
 
+    /**
+     * Shows an alert dialog. Returns a promise that resolves when the dialog is dismissed.
+     * @param options The options that indicate how the alert dialog should be customized.
+     */
+    showAlert(options: ShowAlertOptions): Promise<void>;
+
     /**
      * Gets the dimension that the player is currently viewing.
      */
@@ -14792,7 +14830,7 @@ interface Os {
     getSubjectlessPublicRecordKey(
         recordName: string
     ): Promise<CreatePublicRecordKeyResult>;
-    
+
     /**
      * Grants the given permission in the given record.
      *
@@ -15095,7 +15133,7 @@ interface Os {
      */
     eraseManualApprovalData(recordKey: string, address: string, endpoint?: string): Promise<EraseDataResult>;
 
-    
+
     /**
      * Creates or updates a [webhook](glossary:webhook-record) in the given record using the given options.
      *
@@ -15139,7 +15177,7 @@ interface Os {
         webhook: WebhookRecord,
         options?: RecordActionOptions
     ): Promise<CrudRecordItemResult>;
-    
+
     /**
      * Runs the webhook in the given record with the provided input.
      * @param recordName the name of the record.
@@ -15826,7 +15864,7 @@ interface Os {
         address: string,
         key?: string | PackageRecordVersionKeySpecifier,
     ): Promise<InstallPackageResult>;
-    
+
     /**
      * Gets the list of packages that are installed in the inst.
      * @param options the options for the request.
@@ -16544,7 +16582,7 @@ interface Os {
      * This is valuable for situations where you want to ensure that all players observe the same state.
      * @param bots The bots.
      */
-     createInitializationUpdate(bots: Bot[]): Promise<InstUpdate>;
+    createInitializationUpdate(bots: Bot[]): Promise<InstUpdate>;
 
     /**
      * Applies the given updates to the inst.
@@ -16677,7 +16715,7 @@ interface Os {
      * @docid os.addMapLayer
      */
     addMapLayer(portal: 'map' | 'miniMap', layer: MapLayer): Promise<string>;
-    
+
     /**
      * Removes a layer from the map or miniMap portal.
      * 
@@ -16944,10 +16982,10 @@ interface Bytes {
      */
     toBase64String(bytes: Uint8Array): string;
 
-     /**
-      * Converts the given base64 formatted string into an array of bytes.
-      * @param base64 The base64 that should be converted to bytes.
-      */
+    /**
+     * Converts the given base64 formatted string into an array of bytes.
+     * @param base64 The base64 that should be converted to bytes.
+     */
     fromBase64String(base64: string): Uint8Array;
 
     /**
@@ -17018,7 +17056,7 @@ interface Crypto {
      * @param data The data that should be hashed.
      */
     hash(algorithm: 'sha256' | 'sha512' | 'sha1', format: 'raw', ...data: unknown[]): Uint8Array;
- 
+
     /**
      * Calculates the cryptographic hash for the given data and returns the result in the specified format.
      * @param algorithm The algorithm that should be used to hash the data.
@@ -17055,7 +17093,7 @@ interface Crypto {
      * @param data The data that should be hashed.
      */
     hmac(algorithm: 'hmac-sha256' | 'hmac-sha512' | 'hmac-sha1', format: 'raw', key: string, ...data: unknown[]): Uint8Array;
- 
+
     /**
      * Calculates the HMAC of the given data and returns the result in the specified format.
      * HMAC is commonly used to verify that a message was created with a specific key.
@@ -17608,7 +17646,7 @@ interface Loom {
      * @docid loom.watchVideo-sharedUrl
      */
     watchVideo(sharedUrl: string): Promise<void>;
-    
+
     watchVideo(sharedUrlOrVideo: string | LoomVideo): Promise<void>;
 
     /**