@casual-simulation/aux-runtime 3.7.0 → 3.7.1-alpha.17809973136

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@casual-simulation/aux-runtime",
-    "version": "3.7.0",
+    "version": "3.7.1-alpha.17809973136",
     "description": "Runtime for AUX projects",
     "main": "index.js",
     "types": "index.d.ts",
@@ -32,8 +32,8 @@
         "access": "public"
     },
     "dependencies": {
-        "@casual-simulation/aux-common": "^3.7.0",
-        "@casual-simulation/aux-records": "^3.7.0",
+        "@casual-simulation/aux-common": "^3.7.1-alpha.17809973136",
+        "@casual-simulation/aux-records": "^3.7.1-alpha.17809973136",
         "@casual-simulation/crypto": "^3.5.0",
         "@casual-simulation/engine262": "0.0.1-4de2170374e22761996e46eb1362f4496ee57f8f",
         "@casual-simulation/error-stack-parser": "^2.0.7",
@@ -83,5 +83,5 @@
         "**/*.d.ts",
         "**/*.def"
     ],
-    "gitHead": "d4436ee3adb292c986779e358d1987405424b3be"
+    "gitHead": "354e44de04bd26e9f898a4e893b704f4fe6d02e8"
 }

package/runtime/AuxLibrary.d.ts

@@ -1,8 +1,8 @@
 import type { AuxGlobalContext } from './AuxGlobalContext';
 import { DEBUG_STRING } from './AuxGlobalContext';
 import type { BotTags, Bot, ShowChatOptions, BotAction, BotsState, CameraType, BarcodeFormat, PortalType, ShowInputOptions, LocalFormAnimationAction, ShareOptions, Easing, BotAnchorPoint, RuntimeBot, BotSpace, EaseType, RegisterPrefixOptions, OpenCircleWipeOptions, SuperShoutAction, ShowToastAction, ShowJoinCodeAction, RequestFullscreenAction, ExitFullscreenAction, ShowHtmlAction, HideHtmlAction, SetClipboardAction, FocusOnBotAction, ShowChatBarAction, EnableARAction, EnableVRAction, DownloadAction, ShowUploadAuxFileAction, OpenQRCodeScannerAction, ShowQRCodeAction, OpenBarcodeScannerAction, ShowBarcodeAction, LoadServerAction, UnloadServerAction, ReplaceDragBotAction, ShowInputForTagAction, GoToDimensionAction, GoToURLAction, OpenURLAction, OpenConsoleAction, RejectAction, FocusOnOptions, SnapTarget, AddDropSnapTargetsAction, RecordingOptions, Recording, SyntheticVoice, EnablePOVAction, EnableCustomDraggingAction, SetAppOutputAction, PartialBotsState, ParsedBotLink, ConvertGeolocationToWhat3WordsOptions, BeginAudioRecordingAction, MediaPermssionOptions, ImageClassifierOptions, ClassifyImagesOptions, ClassifyImagesResult, AddDropGridTargetsAction, InstUpdate, StartFormAnimationOptions, StopFormAnimationOptions, FormAnimationData, WakeLockConfiguration, EnableXROptions, ShowConfirmOptions, StoredAux, Geolocation, OpenPhotoCameraOptions, Photo, Point2D, RecordLoomOptions, LoomVideo, LoomVideoEmbedMetadata, InstallAuxFileMode, LoadServerConfigAction, InstConfig, UnloadServerConfigAction, Point3D, MapLayer, DynamicListener } from '@casual-simulation/aux-common/bots';
-import type { AIChatOptions, AIGenerateSkyboxOptions, AIGenerateImageOptions, JoinRoomActionOptions, RoomOptions, RoomTrackOptions, SetRoomTrackOptions, RoomRemoteOptions, DataRecordOptions, RecordActionOptions, ListDataOptions, AISloydGenerateModelOptions, ListWebhooksOptions, ListNotificationsOptions, SendNotificationOptions, GrantEntitlementsRequest, GrantEntitlementsResult, InstallPackageResult } from './RecordsEvents';
-import type { RemoteAction, AvailablePermissions, Entitlement, VersionNumber } from '@casual-simulation/aux-common';
+import type { AIChatOptions, AIGenerateSkyboxOptions, AIGenerateImageOptions, JoinRoomActionOptions, RoomOptions, RoomTrackOptions, SetRoomTrackOptions, RoomRemoteOptions, DataRecordOptions, RecordActionOptions, ListDataOptions, AISloydGenerateModelOptions, ListWebhooksOptions, ListNotificationsOptions, SendNotificationOptions, GrantEntitlementsRequest, GrantEntitlementsResult, InstallPackageResult, ListPermissionsRequest } from './RecordsEvents';
+import type { RemoteAction, AvailablePermissions, Entitlement, VersionNumber, GenericResult, SimpleError } from '@casual-simulation/aux-common';
 import '@casual-simulation/aux-common/polyfill/Array.first.polyfill';
 import '@casual-simulation/aux-common/polyfill/Array.last.polyfill';
 import { isAsymmetricKeypair, isAsymmetricEncrypted, isEncrypted } from '@casual-simulation/crypto';
@@ -11,7 +11,7 @@ import '@casual-simulation/aux-common/BlobPolyfill';
 import type { AuxDevice } from './AuxDevice';
 import type { AuxVersion } from './AuxVersion';
 import { Vector3, Vector2, Quaternion, Rotation } from '@casual-simulation/aux-common/math';
-import type { AIChatMessage, GrantResourcePermissionResult, ListStudiosResult, ListSubscriptionsResult, NotificationRecord, PushNotificationPayload, RevokePermissionResult, SendNotificationResult, SubscribeToNotificationResult, UnsubscribeToNotificationResult, WebhookRecord, CreatePublicRecordKeyResult, GetDataResult, RecordDataResult, RecordFileFailure, EraseDataResult, EraseFileResult, ListDataResult, AddCountResult, GetCountResult, GrantMarkerPermissionResult, GrantRoleResult, RevokeRoleResult, PackageRecord, ListInstalledPackagesResult } from '@casual-simulation/aux-records';
+import type { AIChatMessage, CreateRecordResult, GrantResourcePermissionResult, ListStudiosResult, ListRecordsResult, ListSubscriptionsResult, NotificationRecord, PushNotificationPayload, RevokePermissionResult, ListPermissionsResult, SendNotificationResult, SubscribeToNotificationResult, UnsubscribeToNotificationResult, WebhookRecord, CreatePublicRecordKeyResult, GetDataResult, RecordDataResult, RecordFileFailure, EraseDataResult, EraseFileResult, ListDataResult, AddCountResult, GetCountResult, GrantMarkerPermissionResult, GrantRoleResult, RevokeRoleResult, PackageRecord, ListInstalledPackagesResult, ListInstsResult } from '@casual-simulation/aux-records';
 import { DateTime } from 'luxon';
 import * as hooks from 'preact/hooks';
 import { render, createRef, createContext } from 'preact';
@@ -28,6 +28,7 @@ import type { SharedDocument } from '@casual-simulation/aux-common/documents/Sha
 import type { CreateRealtimeSessionTokenRequest } from '@casual-simulation/aux-records/AIOpenAIRealtimeInterface';
 import type { PackageRecordVersion, PackageRecordVersionKey, PackageRecordVersionKeySpecifier, RecordPackageVersionResult } from '@casual-simulation/aux-records/packages/version';
 import type { EraseDocumentResult, SearchCollectionSchema, SearchDocument, SearchRecord, SearchRecordOutput, StoreDocumentResult } from '@casual-simulation/aux-records/search';
+import type { DatabaseRecordOutput, DatabaseStatement, QueryResult } from '@casual-simulation/aux-records/database';
 /**
  * Defines an interface for a function that provides HTML VDOM capabilities to bots.
  */
@@ -260,11 +261,11 @@ export interface RecordPackageVersionApiRequest {
  */
 export interface RecordSearchCollectionApiRequest {
     /**
-     * The name of the record that the package version should be recorded to.
+     * The name of the record that the collection should be recorded to.
      */
     recordName: string;
     /**
-     * The address that the package version should be recorded to.
+     * The address that the collection should be recorded to.
      */
     address: string;
     /**
@@ -272,7 +273,7 @@ export interface RecordSearchCollectionApiRequest {
      */
     schema: SearchCollectionSchema;
     /**
-     * The markers that should be applied to the package version.
+     * The markers that should be applied to the collection.
      */
     markers?: string[];
 }
@@ -287,6 +288,26 @@ export interface RecordSearchDocumentApiRequest {
     address: string;
     document: SearchDocument;
 }
+/**
+ * Defines an interface that represents a request for {@link recordDatabase}.
+ *
+ * @dochash types/records/database
+ * @docname RecordDatabaseRequest
+ */
+export interface RecordDatabaseApiRequest {
+    /**
+     * The name of the record that the database should be recorded to.
+     */
+    recordName: string;
+    /**
+     * The address that the database should be recorded to.
+     */
+    address: string;
+    /**
+     * The markers that should be applied to the database.
+     */
+    markers?: string[];
+}
 /**
  * Defines a set of options for {@link animateTag-byTag}.
  *
@@ -1997,6 +2018,158 @@ export interface UploadedFile {
      */
     data: string | ArrayBuffer;
 }
+/**
+ * Defines the result of an API query.
+ *
+ * @dochash types/records/database
+ * @docname QueryResult
+ */
+export interface ApiQueryResult {
+    /**
+     * The rows that were returned from the query.
+     */
+    rows: Record<string, any>[];
+    /**
+     * The number of rows that were modified by the query.
+     */
+    affectedRowCount: number;
+    /**
+     * The ID of the last row that was inserted by the query.
+     */
+    lastInsertId?: number | string;
+}
+/**
+ * Defines the result of a batch query.
+ *
+ * @dochash types/records/database
+ * @docname BatchResult
+ */
+export interface BatchResult {
+    /**
+     * The results of the individual statements.
+     */
+    results: ApiQueryResult[];
+}
+/**
+ * Represents a connection to a database record.
+ *
+ * @dochash types/records/database
+ * @docname Database
+ *
+ * @example Get a database connection.
+ * const database = os.getDatabase('myRecord', 'myDatabase');
+ */
+export declare class ApiDatabase {
+    private _recordName;
+    private _address;
+    private _options;
+    private _context;
+    constructor(recordName: string, address: string, options: RecordActionOptions, context: AuxGlobalContext);
+    /**
+     * Constructs a database statement from the given [template string literal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals).
+     *
+     * Once constructed, the returned statement can be used with `run()` or `batch()`.
+     *
+     * @param templates The string templates.
+     * @param params The parameters to interpolate into the templates.
+     * @returns A database statement.
+     *
+     * @example Create a database statement from a SQL query
+     * const statement = database.sql`SELECT * FROM items`;
+     *
+     * @example Use a parameter in a database statement
+     * const itemId = 'abc';
+     * const statement = database.sql`SELECT * FROM items WHERE id = ${itemId}`;
+     */
+    sql(templates: TemplateStringsArray, ...params: unknown[]): DatabaseStatement;
+    /**
+     * Creates a new database statement from the given SQL and parameters.
+     * @param sql The SQL query string.
+     * @param params The parameters to include in the query.
+     * @returns A new database statement.
+     */
+    statement(sql: string, ...params: unknown[]): DatabaseStatement;
+    /**
+     * Runs the given readonly query against the database.
+     * This method requires queries to be read-only. This means that queries can only select data, they cannot insert, update, or delete data.
+     *
+     * Supports [template string literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) for parameterized queries.
+     *
+     * **Warning:** To avoid [SQL Injection attacks](https://en.wikipedia.org/wiki/SQL_injection), always use template literals with expressions. Never use the `+` operator to concatenate strings containing SQL code.
+     *
+     * @param templates The string templates.
+     * @param params The parameters that should be used.
+     * @returns A promise that resolves when the query has completed.
+     *
+     * @example Select all items from a table
+     * const result = await database.query`SELECT * FROM items`;
+     *
+     * @example Use a parameter in a query
+     * const itemId = 'abc';
+     * const result = await database.query`SELECT * FROM items WHERE id = ${itemId}`;
+     */
+    query(templates: TemplateStringsArray, ...params: unknown[]): Promise<GenericResult<ApiQueryResult, SimpleError>>;
+    /**
+     * Runs the given SQL on the database and returns the result.
+     * This method supports read-write queries. This means that queries can be used to select, insert, update, and delete data.
+     *
+     * Supports [template string literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) for parameterized queries.
+     *
+     * **Warning:** To avoid [SQL Injection attacks](https://en.wikipedia.org/wiki/SQL_injection), always use template literals with expressions. Never use the `+` operator to concatenate strings containing SQL code.
+     *
+     * @param templates The string templates.
+     * @param params The parameters that should be used.
+     * @returns A promise that resolves when the SQL has completed.
+     *
+     * @example Insert a new item into a table
+     * const name = "New Item";
+     * const value = 100;
+     * const result = await database.execute`INSERT INTO items (name, value) VALUES (${name}, ${value})`;
+     *
+     */
+    execute(templates: TemplateStringsArray, ...params: unknown[]): Promise<GenericResult<ApiQueryResult, SimpleError>>;
+    /**
+     * Runs the given statements in a single transaction. Transactions can be used to group multiple statements together.
+     * If one statement fails, then none of the statements will have any effect.
+     *
+     * @param func The function that should be used to build the statements.
+     * @param readonly Whether the statements are read-only. If true, then the statements cannot modify data.
+     *
+     * @example Run multiple select queries at once
+     * const results = await database.batch([
+     *      database.sql`SELECT * FROM items WHERE id = 'abc'`,
+     *      database.sql`SELECT * FROM items WHERE id = 'def'`,
+     *      database.sql`SELECT * FROM items WHERE id = 'ghi'`,
+     * ]);
+     *
+     * @example Insert multiple items at once
+     * const results = await database.batch([
+     *      database.sql`INSERT INTO items (name, value) VALUES ('Item 1', 100)`,
+     *      database.sql`INSERT INTO items (name, value) VALUES ('Item 2', 200)`,
+     *      database.sql`INSERT INTO items (name, value) VALUES ('Item 3', 300)`,
+     * ], false);
+     */
+    batch(statements: DatabaseStatement[], readonly?: boolean): Promise<GenericResult<BatchResult, SimpleError>>;
+    /**
+     * Runs the given database statement.
+     *
+     * @param statement The statement to run.
+     * @param readonly Whether the statement is read-only. If true, then the statement cannot modify data.
+     */
+    run(statement: DatabaseStatement, readonly?: boolean): Promise<GenericResult<ApiQueryResult, SimpleError>>;
+    /**
+     * Gets an interface to the database that returns unmodified query results.
+     */
+    get raw(): {
+        sql: any;
+        query: (templates: TemplateStringsArray, ...params: unknown[]) => Promise<GenericResult<QueryResult[], SimpleError>>;
+        execute: (templates: TemplateStringsArray, ...params: unknown[]) => Promise<GenericResult<QueryResult[], SimpleError>>;
+        batch: (statements: DatabaseStatement[], readonly?: boolean) => Promise<GenericResult<QueryResult[], SimpleError>>;
+        run: (statement: DatabaseStatement, readonly?: boolean) => Promise<GenericResult<QueryResult[], SimpleError>>;
+    };
+    private _mapResult;
+    private _run;
+}
 /**
  * Creates a library that includes the default functions and APIs.
  * @param context The global context that should be used.
@@ -2491,10 +2664,12 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             reportInst: () => Promise<void>;
             requestAuthBot: () => Promise<Bot>;
             requestAuthBotInBackground: () => Promise<Bot>;
+            createRecord: (recordName: string, studioId?: string) => Promise<CreateRecordResult>;
             getPublicRecordKey: (name: string) => Promise<CreatePublicRecordKeyResult>;
             getSubjectlessPublicRecordKey: (name: string) => Promise<CreatePublicRecordKeyResult>;
             grantPermission: (recordName: string, permission: AvailablePermissions, options?: RecordActionOptions) => Promise<GrantMarkerPermissionResult | GrantResourcePermissionResult>;
             revokePermission: (recordName: string, permissionId: string, options?: RecordActionOptions) => Promise<RevokePermissionResult>;
+            listPermissions: (request: ListPermissionsRequest) => Promise<ListPermissionsResult>;
             grantInstAdminPermission: (recordName: string, options?: RecordActionOptions) => Promise<GrantRoleResult>;
             grantUserRole: (recordName: string, role: string, userId: string, expireTimeMs?: number, options?: RecordActionOptions) => Promise<GrantRoleResult>;
             revokeUserRole: (recordName: string, role: string, userId: string, options?: RecordActionOptions) => Promise<RevokeRoleResult>;
@@ -2509,6 +2684,8 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             listDataByMarker: (recordKeyOrName: string, marker: string, startingAddress?: string, options?: ListDataOptions) => Promise<ListDataResult>;
             eraseData: (recordKeyOrName: string, address: string, endpoint?: string) => Promise<EraseDataResult>;
             eraseManualApprovalData: (recordKeyOrName: string, address: string, endpoint?: string) => Promise<EraseDataResult>;
+            listInsts: (recordName: string, startingInst?: string | null, endpoint?: string | null) => Promise<ListInstsResult>;
+            listInstsByMarker: (recordName: string, marker: string, startingInst?: string | null, options?: RecordActionOptions) => Promise<ListInstsResult>;
             recordWebhook: (recordName: string, webhook: WebhookRecord, options?: RecordActionOptions) => Promise<CrudRecordItemResult>;
             runWebhook: (recordName: string, address: string, input: any, options?: RecordActionOptions) => Promise<HandleWebhookResult>;
             getWebhook: (recordName: string, address: string, options?: RecordActionOptions) => Promise<CrudGetItemResult<WebhookRecord>>;
@@ -2560,12 +2737,18 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             listInstalledPackages: (options?: RecordActionOptions) => Promise<ListInstalledPackagesResult>;
             recordSearchCollection: (request: RecordSearchCollectionApiRequest, options?: RecordActionOptions) => Promise<CrudRecordItemResult>;
             getSearchCollection: (recordName: string, address: string, options?: RecordActionOptions) => Promise<CrudGetItemResult<SearchRecordOutput>>;
-            eraseSearchCollection: (recordName: string, address: string, options?: RecordActionOptions) => Promise<CrudRecordItemResult>;
-            listSearchCollections: (recordName: string, startingAddress?: string, options?: ListDataOptions) => Promise<CrudRecordItemResult>;
+            eraseSearchCollection: (recordName: string, address: string, options?: RecordActionOptions) => Promise<CrudEraseItemResult>;
+            listSearchCollections: (recordName: string, startingAddress?: string, options?: ListDataOptions) => Promise<CrudListItemsResult<SearchRecord>>;
             listSearchCollectionsByMarker: (recordName: string, marker: string, startingAddress?: string, options?: ListDataOptions) => Promise<CrudListItemsResult<SearchRecord>>;
             recordSearchDocument: (request: RecordSearchDocumentApiRequest, options?: RecordActionOptions) => Promise<StoreDocumentResult>;
             eraseSearchDocument: (recordName: string, address: string, documentId: string, options?: RecordActionOptions) => Promise<EraseDocumentResult>;
+            recordDatabase: (request: RecordSearchCollectionApiRequest, options?: RecordActionOptions) => Promise<CrudRecordItemResult>;
+            getDatabase: (recordName: string, address: string, options?: RecordActionOptions) => ApiDatabase;
+            eraseDatabase: (recordName: string, address: string, options?: RecordActionOptions) => Promise<CrudRecordItemResult>;
+            listDatabases: (recordName: string, startingAddress?: string, options?: ListDataOptions) => Promise<CrudListItemsResult<DatabaseRecordOutput>>;
+            listDatabasesByMarker: (recordName: string, marker: string, startingAddress?: string, options?: ListDataOptions) => Promise<CrudListItemsResult<DatabaseRecordOutput>>;
             listUserStudios: (endpoint?: string) => Promise<ListStudiosResult>;
+            listStudioRecords: (studioId: string, endpoint?: string) => Promise<ListRecordsResult>;
             getRecordsEndpoint: () => Promise<string>;
             convertGeolocationToWhat3Words: (location: ConvertGeolocationToWhat3WordsOptions) => Promise<string>;
             raycastFromCamera: (portal: "grid" | "miniGrid" | "map" | "miniMap", viewportCoordinates: Vector2) => Promise<RaycastResult>;
@@ -2588,6 +2771,13 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             detachDebugger: (debug: DebuggerInterface) => Promise<void>;
             addMapLayer: (portal: "map" | "miniMap", layer: MapLayer) => Promise<string>;
             removeMapLayer: (layerId: string) => Promise<void>;
+            addBotMapLayer: (bot: Bot | string, overlay: {
+                overlayType?: "geojson";
+                type?: "geojson";
+                data: any;
+                overlayId?: string;
+            }) => Promise<string>;
+            removeBotMapLayer: (bot: Bot | string, overlayId: string) => Promise<void>;
             remotes: () => Promise<string[]>;
             listInstUpdates: () => Promise<InstUpdate[]>;
             getInstStateFromUpdates: (updates: InstUpdate[]) => Promise<BotsState>;
@@ -2600,6 +2790,12 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             getSharedDocument: {
                 (name: string): Promise<SharedDocument>;
                 (recordName: string | null, inst: string, name: string): Promise<SharedDocument>;
+                (name: string, options: {
+                    markers?: string[];
+                }): Promise<SharedDocument>;
+                (recordName: string | null, inst: string, name: string, options: {
+                    markers?: string[];
+                }): Promise<SharedDocument>;
             };
             getLocalDocument: (name: string) => Promise<SharedDocument>;
             getMemoryDocument: () => Promise<SharedDocument>;