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

package/runtime/AuxLibrary.js

@@ -1,6 +1,6 @@
 import { DEBUG_STRING, debugStringifyFunction } from './AuxGlobalContext';
 import { hasValue, trimTag, isBot, BOT_SPACE_TAG, toast as toastMessage, getScriptIssues as scriptIssues, tip as tipMessage, hideTips as hideTipMessages, showJoinCode as calcShowJoinCode, requestFullscreen, exitFullscreen, html as htmlMessage, hideHtml as hideHtmlMessage, setClipboard as calcSetClipboard, tweenTo as calcTweenTo, showChat as calcShowChat, hideChat as calcHideChat, runScript, getMediaPermission as calcGetMediaPermission, getAverageFrameRate as calcGetAverageFrameRate, enableAR as calcEnableAR, disableAR as calcDisableAR, enableVR as calcEnableVR, disableVR as calcDisableVR, arSupported as calcARSupported, vrSupported as calcVRSupported, showUploadAuxFile as calcShowUploadAuxFile, openQRCodeScanner as calcOpenQRCodeScanner, showQRCode as calcShowQRCode, openBarcodeScanner as calcOpenBarcodeScanner, showBarcode as calcShowBarcode, importAUX as calcImportAUX, showInputForTag as calcShowInputForTag, showInput as calcShowInput, showConfirm as calcShowConfirm, replaceDragBot as calcReplaceDragBot, goToDimension as calcGoToDimension, goToURL as calcGoToURL, openURL as calcOpenURL, playSound as calcPlaySound, bufferSound as calcBufferSound, cancelSound as calcCancelSound, shell as calcShell, reject as calcReject, localFormAnimation as calcLocalFormAnimation, webhook as calcWebhook, superShout as calcSuperShout, share as calcShare, registerPrefix as calcRegisterPrefix, localPositionTween as calcLocalPositionTween, localRotationTween as calcLocalRotationTween, showUploadFiles as calcShowUploadFiles, download, loadSimulation, unloadSimulation, getUploadState, addState, getPortalTag, KNOWN_PORTALS, openConsole, tagsOnBot, getOriginalObject, getBotSpace, trimEvent, CREATE_ACTION_NAME, CREATE_ANY_ACTION_NAME, DESTROY_ACTION_NAME, ORIGINAL_OBJECT, getRemoteCount, getRemotes, listInstUpdates as calcListInstUpdates, getInstStateFromUpdates as calcGetInstStateFromUpdates, action, calculateAnchorPoint, calculateAnchorPointOffset, getBotPosition as calcGetBotPosition, getBotRotation as calcGetBotRotation, isRuntimeBot, SET_TAG_MASK_SYMBOL, CLEAR_TAG_MASKS_SYMBOL, getBotScale, EDIT_TAG_SYMBOL, EDIT_TAG_MASK_SYMBOL, circleWipe, addDropSnap as calcAddDropSnap, addDropGrid as calcAddDropGrid, animateToPosition, beginAudioRecording as calcBeginAudioRecording, endAudioRecording as calcEndAudioRecording, beginRecording as calcBeginRecording, endRecording as calcEndRecording, speakText as calcSpeakText, getVoices as calcGetVoices, getGeolocation as calcGetGeolocation, cancelAnimation, disablePOV, enablePOV, enableCustomDragging as calcEnableCustomDragging, MINI_PORTAL, registerCustomApp, setAppOutput, unregisterCustomApp, requestAuthData as calcRequestAuthData, createBot, defineGlobalBot as calcDefineGlobalBot, TEMPORARY_BOT_PARTITION_ID, convertToString, GET_TAG_MASKS_SYMBOL, isBotLink, parseBotLink, createBotLink, convertGeolocationToWhat3Words as calcConvertGeolocationToWhat3Words, meetCommand as calcMeetCommand, meetFunction as calcMeetFunction, openImageClassifier as calcOpenImageClassifier, classifyImages as calcOpenClassifyImages, isBotDate, DATE_TAG_PREFIX, parseBotDate, realNumberOrDefault, raycastFromCamera as calcRaycastFromCamera, raycastInPortal as calcRaycastInPortal, calculateRayFromCamera as calcCalculateRayFromCamera, bufferFormAddressGltf, startFormAnimation as calcStartFormAnimation, stopFormAnimation as calcStopFormAnimation, listFormAnimations as calcListFormAnimations, calculateStringTagValue, createInitializationUpdate as calcCreateInitalizationUpdate, applyUpdatesToInst as calcApplyUpdatesToInst, configureWakeLock, getWakeLockConfiguration as calcGetWakeLockConfiguration, analyticsRecordEvent as calcAnalyticsRecordEvent, KNOWN_TAGS, isStoredVersion2, getCurrentInstUpdate as calcGetCurrentInstUpdate, openPhotoCamera as calcOpenPhotoCamera, getEasing, enableCollaboration as calcEnableCollaboration, showAccountInfo as calcShowAccountInfo, reportInst as calcReportInst, getRecordsEndpoint as calcGetRecordsEndpoint, ldrawCountAddressBuildSteps as calcLdrawCountAddressBuildSteps, ldrawCountTextBuildSteps as calcLdrawCountTextBuildSteps, calculateViewportCoordinatesFromPosition as calcCalculateViewportCoordinatesFromPosition, calculateScreenCoordinatesFromViewportCoordinates as calcCalculateScreenCoordinatesFromViewportCoordinates, calculateViewportCoordinatesFromScreenCoordinates as calcCalculateViewportCoordinatesFromScreenCoordinates, capturePortalScreenshot as calcCapturePortalScreenshot, createStaticHtml as calcCreateStaticHtmlFromBots, recordLoom, watchLoom, getLoomMetadata, loadSharedDocument, installAuxFile as calcInstallAuxFile, calculateStringListTagValue, calculateScreenCoordinatesFromPosition as calcCalculateScreenCoordinatesFromPosition, addMapLayer as calcAddMapLayer, removeMapLayer as calcRemoveMapLayer, GET_DYNAMIC_LISTENERS_SYMBOL, ADD_BOT_LISTENER_SYMBOL, REMOVE_BOT_LISTENER_SYMBOL, } from '@casual-simulation/aux-common/bots';
-import { aiChat, aiChatStream, aiGenerateSkybox, aiGenerateImage, grantRecordPermission as calcGrantRecordPermission, revokeRecordPermission as calcRevokeRecordPermission, grantInstAdminPermission as calcGrantInstAdminPermission, grantUserRole as calcGrantUserRole, revokeUserRole as calcRevokeUserRole, grantInstRole as calcGrantInstRole, revokeInstRole as calcRevokeInstRole, listUserStudios as calcListUserStudios, joinRoom as calcJoinRoom, leaveRoom as calcLeaveRoom, setRoomOptions as calcSetRoomOptions, getRoomOptions as calcGetRoomOptions, getRoomTrackOptions as calcGetRoomTrackOptions, setRoomTrackOptions as calcSetRoomTrackOptions, getRoomRemoteOptions as calcGetRoomRemoteOptions, listDataRecord, recordEvent as calcRecordEvent, getEventCount as calcGetEventCount, getFile as calcGetFile, eraseFile as calcEraseFile, getPublicRecordKey as calcGetPublicRecordKey, recordData as calcRecordData, getRecordData, eraseRecordData, recordFile as calcRecordFile, listDataRecordByMarker, aiHumeGetAccessToken, aiSloydGenerateModel, recordWebhook as calcRecordWebhook, getWebhook as calcGetWebhook, listWebhooks as calcListWebhooks, listWebhooksByMarker as calcListWebhooksByMarker, eraseWebhook as calcEraseWebhook, runWebhook as calcRunWebhook, recordNotification as calcRecordNotification, getNotification as calcGetNotification, listNotifications as calcListNotifications, listNotificationsByMarker as calcListNotificationsByMarker, eraseNotification as calcEraseNotification, subscribeToNotification as calcSubscribeToNotification, unsubscribeFromNotification as calcUnsubscribeFromNotification, sendNotification as calcSendNotification, listNotificationSubscriptions as calcListNotificationSubscriptions, listUserNotificationSubscriptions as calcListUserNotificationSubscriptions, aiOpenAICreateRealtimeSession, grantEntitlements as calcGrantEntitlements, recordPackageVersion as calcRecordPackageVersion, erasePackageVersion as calcErasePackageVersion, listPackageVersions as calcListPackageVersions, getPackageVersion as calcGetPackageVersion, recordPackageContainer as calcRecordPackageContainer, erasePackageContaienr as calcErasePackageContainer, listPackageContainers as calcListPackageContainers, listPackageContainersByMarker as calcListPackageContainersByMarker, getPackageContainer as calcGetPackageContainer, installPackage as calcInstallPackage, listInstalledPackages as calcListInstalledPackages, recordsCallProcedure, } from './RecordsEvents';
+import { aiChat, aiChatStream, aiGenerateSkybox, aiGenerateImage, grantRecordPermission as calcGrantRecordPermission, revokeRecordPermission as calcRevokeRecordPermission, listPermissions as calcListPermissions, grantInstAdminPermission as calcGrantInstAdminPermission, grantUserRole as calcGrantUserRole, revokeUserRole as calcRevokeUserRole, grantInstRole as calcGrantInstRole, revokeInstRole as calcRevokeInstRole, listUserStudios as calcListUserStudios, listStudioRecords as calcListStudioRecords, joinRoom as calcJoinRoom, leaveRoom as calcLeaveRoom, setRoomOptions as calcSetRoomOptions, getRoomOptions as calcGetRoomOptions, getRoomTrackOptions as calcGetRoomTrackOptions, setRoomTrackOptions as calcSetRoomTrackOptions, getRoomRemoteOptions as calcGetRoomRemoteOptions, listDataRecord, recordEvent as calcRecordEvent, getEventCount as calcGetEventCount, getFile as calcGetFile, eraseFile as calcEraseFile, getPublicRecordKey as calcGetPublicRecordKey, recordData as calcRecordData, getRecordData, eraseRecordData, recordFile as calcRecordFile, listDataRecordByMarker, aiHumeGetAccessToken, aiSloydGenerateModel, recordWebhook as calcRecordWebhook, getWebhook as calcGetWebhook, listWebhooks as calcListWebhooks, listWebhooksByMarker as calcListWebhooksByMarker, eraseWebhook as calcEraseWebhook, runWebhook as calcRunWebhook, recordNotification as calcRecordNotification, getNotification as calcGetNotification, listNotifications as calcListNotifications, listNotificationsByMarker as calcListNotificationsByMarker, eraseNotification as calcEraseNotification, subscribeToNotification as calcSubscribeToNotification, unsubscribeFromNotification as calcUnsubscribeFromNotification, sendNotification as calcSendNotification, listNotificationSubscriptions as calcListNotificationSubscriptions, listUserNotificationSubscriptions as calcListUserNotificationSubscriptions, aiOpenAICreateRealtimeSession, grantEntitlements as calcGrantEntitlements, recordPackageVersion as calcRecordPackageVersion, erasePackageVersion as calcErasePackageVersion, listPackageVersions as calcListPackageVersions, getPackageVersion as calcGetPackageVersion, recordPackageContainer as calcRecordPackageContainer, erasePackageContaienr as calcErasePackageContainer, listPackageContainers as calcListPackageContainers, listPackageContainersByMarker as calcListPackageContainersByMarker, getPackageContainer as calcGetPackageContainer, installPackage as calcInstallPackage, listInstalledPackages as calcListInstalledPackages, listInsts as calcListInsts, listInstsByMarker as calcListInstsByMarker, recordsCallProcedure, } from './RecordsEvents';
 import { sortBy, cloneDeep, union, isEqual } from 'es-toolkit/compat';
 import { remote as calcRemote, DEFAULT_BRANCH_NAME, formatVersionNumber, parseVersionNumber, PRIVATE_MARKER, } from '@casual-simulation/aux-common';
 import { RanOutOfEnergyError } from './AuxResults';
@@ -33,6 +33,7 @@ import { INTERPRETABLE_FUNCTION } from './AuxCompiler';
 import { constructInitializationUpdate, mergeInstUpdates as calcMergeInstUpdates, } from '@casual-simulation/aux-common/partitions/PartitionUtils';
 import { CasualOSError } from './CasualOSError';
 import { attachRuntime, detachRuntime } from './RuntimeEvents';
+import { query as q } from './database/DatabaseUtils';
 const _html = htm.bind(h);
 const html = ((...args) => {
     return _html(...args);
@@ -142,6 +143,201 @@ function getBotSnapshot(bot) {
 const DEAD_RECKONING_OFFSET = 50;
 const DEG_TO_RAD = Math.PI / 180;
 const RAD_TO_DEG = 180 / Math.PI;
+/**
+ * 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 class ApiDatabase {
+    constructor(recordName, address, options, context) {
+        this._recordName = recordName;
+        this._address = address;
+        this._options = options;
+        this._context = context;
+    }
+    /**
+     * 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, ...params) {
+        return q(templates, ...params);
+    }
+    /**
+     * 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, ...params) {
+        return {
+            query: sql,
+            params,
+        };
+    }
+    /**
+     * 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}`;
+     */
+    async query(templates, ...params) {
+        return this.run(q(templates, ...params), true);
+    }
+    /**
+     * 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})`;
+     *
+     */
+    async execute(templates, ...params) {
+        return this.run(q(templates, ...params), false);
+    }
+    /**
+     * 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);
+     */
+    async batch(statements, readonly = true) {
+        const result = await this._run(statements, readonly);
+        if (result.success === false) {
+            return result;
+        }
+        else {
+            return {
+                success: true,
+                results: result.items.map((r) => this._mapResult(r)),
+            };
+        }
+    }
+    /**
+     * 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.
+     */
+    async run(statement, readonly = true) {
+        const batch = await this.batch([statement], readonly);
+        if (batch.success === false) {
+            return batch;
+        }
+        else {
+            const firstResult = batch.results[0];
+            return {
+                success: true,
+                ...firstResult,
+            };
+        }
+    }
+    /**
+     * Gets an interface to the database that returns unmodified query results.
+     */
+    get raw() {
+        return {
+            sql: this.sql.bind(this),
+            query: (templates, ...params) => {
+                return this._run([q(templates, ...params)], true);
+            },
+            execute: (templates, ...params) => {
+                return this._run([q(templates, ...params)], false);
+            },
+            batch: (statements, readonly = true) => {
+                return this._run(statements, readonly);
+            },
+            run: (statement, readonly = true) => {
+                return this._run([statement], readonly);
+            },
+        };
+    }
+    _mapResult(result) {
+        const rows = [];
+        for (let row of result.rows) {
+            const value = {};
+            for (let i = 0; i < result.columns.length; i++) {
+                value[result.columns[i]] = row[i];
+            }
+            rows.push(value);
+        }
+        return {
+            rows,
+            lastInsertId: result.lastInsertId,
+            affectedRowCount: result.affectedRowCount,
+        };
+    }
+    _run(statements, readonly) {
+        const task = this._context.createTask();
+        const action = recordsCallProcedure({
+            queryDatabase: {
+                input: {
+                    recordName: this._recordName,
+                    address: this._address,
+                    statements,
+                    readonly,
+                },
+            },
+        }, this._options, task.taskId);
+        this._context.enqueueAction(action);
+        let promise = task.promise;
+        promise[ORIGINAL_OBJECT] = action;
+        return promise;
+    }
+}
 /**
  * Creates a library that includes the default functions and APIs.
  * @param context The global context that should be used.
@@ -539,10 +735,12 @@ export function createDefaultLibrary(context) {
                 reportInst,
                 requestAuthBot,
                 requestAuthBotInBackground,
+                createRecord,
                 getPublicRecordKey,
                 getSubjectlessPublicRecordKey,
                 grantPermission,
                 revokePermission,
+                listPermissions,
                 grantInstAdminPermission,
                 grantUserRole,
                 revokeUserRole,
@@ -557,6 +755,8 @@ export function createDefaultLibrary(context) {
                 listDataByMarker,
                 eraseData,
                 eraseManualApprovalData,
+                listInsts,
+                listInstsByMarker,
                 recordWebhook,
                 runWebhook,
                 getWebhook,
@@ -601,7 +801,13 @@ export function createDefaultLibrary(context) {
                 listSearchCollectionsByMarker,
                 recordSearchDocument,
                 eraseSearchDocument,
+                recordDatabase,
+                getDatabase,
+                eraseDatabase,
+                listDatabases,
+                listDatabasesByMarker,
                 listUserStudios,
+                listStudioRecords,
                 getRecordsEndpoint,
                 convertGeolocationToWhat3Words,
                 raycastFromCamera,
@@ -621,6 +827,8 @@ export function createDefaultLibrary(context) {
                 detachDebugger,
                 addMapLayer,
                 removeMapLayer,
+                addBotMapLayer,
+                removeBotMapLayer,
                 remotes,
                 listInstUpdates,
                 getInstStateFromUpdates,
@@ -5018,6 +5226,61 @@ export function createDefaultLibrary(context) {
         const event = calcDefineGlobalBot(name, botId, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Creates a record with the given name. If a studio is specified, then the record will be created in the given studio.
+     * If not specified, then the record will be owned by the current user.
+     *
+     * Returns a promise that resolves with an object that indicates if the request was successful.
+     *
+     * Permissions: User must be logged in. If a studio is specified, then the user must be a member of the studio.
+     *
+     * @param recordName the name of the record to create.
+     * @param studioId the ID of the studio that should own the record. If not specified, the record will be owned by the current user.
+     *
+     * @example Create a record owned by the current user.
+     * const result = await os.createRecord('myRecord');
+     *
+     * if (result.success) {
+     *     os.toast('Record created successfully!');
+     * } else {
+     *     os.toast('Failed to create record: ' + result.errorMessage);
+     * }
+     *
+     * @example Create a record in a studio.
+     * const result = await os.createRecord('myStudioRecord', 'myStudioId');
+     *
+     * if (result.success) {
+     *     os.toast('Studio record created successfully!');
+     * } else {
+     *     os.toast('Failed to create studio record: ' + result.errorMessage);
+     * }
+     *
+     * @dochash actions/os/records
+     * @docid os.createRecord
+     * @docname os.createRecord
+     * @docgroup 01-records
+     */
+    function createRecord(recordName, studioId) {
+        if (!hasValue(recordName)) {
+            throw new Error('recordName must be provided.');
+        }
+        else if (typeof recordName !== 'string') {
+            throw new Error('recordName must be a string.');
+        }
+        if (hasValue(studioId) && typeof studioId !== 'string') {
+            throw new Error('studioId must be a string.');
+        }
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            createRecord: {
+                input: {
+                    recordName,
+                    studioId,
+                },
+            },
+        }, {}, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Requests an [access key](glossary:record-key) for the [public record](glossary:record) with the given name.
      * Returns a promise that resolves with an object that contains the record key (if successful) or information about the error that occurred.
@@ -5132,6 +5395,40 @@ export function createDefaultLibrary(context) {
         const event = calcRevokeRecordPermission(recordName, permissionId, options !== null && options !== void 0 ? options : {}, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Gets the list of permissions that have been assigned in the given record.
+     *
+     * @param request the request containing the record name and optional filters.
+     * @param options the options for the operation.
+     *
+     * @example List all permissions in a record.
+     * const result = await os.listPermissions({
+     *     recordName: 'myRecord'
+     * });
+     *
+     * @example List permissions for a specific marker.
+     * const result = await os.listPermissions({
+     *     recordName: 'myRecord',
+     *     marker: 'secret'
+     * });
+     *
+     * @example List permissions for a specific resource.
+     * const result = await os.listPermissions({
+     *     recordName: 'myRecord',
+     *     resourceKind: 'data',
+     *     resourceId: 'address'
+     * });
+     *
+     * @dochash actions/os/records
+     * @docgroup 01-records
+     * @docid os.listPermissions
+     * @docname os.listPermissions
+     */
+    function listPermissions(request) {
+        const task = context.createTask();
+        const event = calcListPermissions(request, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Attempts to grant the current inst admin permissions in the given record for the rest of the day.
      *
@@ -5568,6 +5865,64 @@ export function createDefaultLibrary(context) {
         const event = listDataRecordByMarker(recordName, marker, startingAddress, options, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Gets the list of insts that are in the record with the given name.
+     * Returns a promise that resolves with an object that contains the list of insts (if successful) or information about the error that occurred.
+     * @param recordName the name of the record that the insts should be listed from.
+     * @param startingInst the inst that the list should start at. This can be used to paginate through the list of insts. If omitted, then the list will start from the beginning.
+     * @param endpoint the HTTP Endpoint of the records website that the insts should be listed from.
+     * If omitted, then the preconfigured records endpoint will be used.
+     *
+     * @example List insts in a record
+     * const result = await os.listInsts('myRecord');
+     *
+     * if (result.success) {
+     *     os.toast(`Found ${result.insts.length} insts!`);
+     * } else {
+     *     os.toast("Failed " + result.errorMessage);
+     * }
+     *
+     * @dochash actions/os/records
+     * @docgroup 01-records
+     * @docname os.listInsts
+     * @docid os.listInsts
+     */
+    function listInsts(recordName, startingInst = null, endpoint = null) {
+        let options = {};
+        if (hasValue(endpoint)) {
+            options.endpoint = endpoint;
+        }
+        const task = context.createTask();
+        const event = calcListInsts(recordName, startingInst, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets the list of insts that are in the record with the given name and given marker.
+     * Returns a promise that resolves with an object that contains the list of insts (if successful) or information about the error that occurred.
+     * @param recordName the name of the record that the insts should be listed from.
+     * @param marker the marker that the insts should have.
+     * @param startingInst the inst that the list should start at. This can be used to paginate through the list of insts. If omitted, then the list will start from the beginning.
+     * @param options the options that should be used for the action.
+     *
+     * @example List insts by marker in a record
+     * const result = await os.listInstsByMarker('myRecord', 'public');
+     *
+     * if (result.success) {
+     *     os.toast(`Found ${result.insts.length} insts!`);
+     * } else {
+     *     os.toast("Failed " + result.errorMessage);
+     * }
+     *
+     * @dochash actions/os/records
+     * @docgroup 01-records
+     * @docname os.listInstsByMarker
+     * @docid os.listInstsByMarker
+     */
+    function listInstsByMarker(recordName, marker, startingInst = null, options = {}) {
+        const task = context.createTask();
+        const event = calcListInstsByMarker(recordName, marker, startingInst, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Erases the [data](glossary:data-record) stored at the given address in the given [record](glossary:record).
      * Returns a promise that resolves with an object that contains the data (if successful) or information about the error that occurred.
@@ -6987,6 +7342,184 @@ export function createDefaultLibrary(context) {
         }, options, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Creates or updates a database in the given record.
+     *
+     * Databases are used to store and manage structured data within a record.
+     * They use the [SQL programming language](https://www.sqlite.org/lang.html), which is a powerful programming language designed to manage relational databases.
+     *
+     * Returns a promise that resolves with the result of the operation.
+     *
+     * @param request The request to create or update the database.
+     * @param options the options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Record a database.
+     * const result = await os.recordDatabase({
+     *      recordName: 'myRecord',
+     *      address: 'myDatabase',
+     * });
+     *
+     * @example Record a private database
+     * const result = await os.recordDatabase({
+     *      recordName: 'myRecord',
+     *      address: 'myDatabase',
+     *      markers: ['private']
+     * });
+     *
+     *
+     * @doctitle Database Actions
+     * @docsidebar Database
+     * @docdescription Database actions allow you to create and manage databases in your records. Databases enable efficient storage and retrieval of structured data within your records, making it easier to manage and query information.
+     * @dochash actions/os/records/database
+     * @docgroup 02-database
+     * @docname os.recordDatabase
+     * @docid recordDatabase
+     */
+    function recordDatabase(request, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            recordDatabase: {
+                input: {
+                    recordName: request.recordName,
+                    item: {
+                        address: request.address,
+                        markers: request.markers,
+                    },
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Deletes a database along with all the data in it.
+     *
+     * Returns a promise that resolves with the result of the operation.
+     *
+     * @param recordName The name of the record to delete the database from.
+     * @param address The address of the database to delete.
+     * @param options the options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Erase a database
+     * const result = await os.eraseDatabase('recordName', 'myDatabase');
+     *
+     * @dochash actions/os/records/database
+     * @docgroup 02-database
+     * @docname os.eraseDatabase
+     * @docid eraseDatabase
+     */
+    function eraseDatabase(recordName, address, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            eraseDatabase: {
+                input: {
+                    recordName,
+                    address,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Lists the databases in a record.
+     *
+     * Returns a promise that resolves with the result of the operation.
+     *
+     * @param recordName The name of the record to delete the search collection from.
+     * @param startingAddress the address that the listing should start after.
+     * @param options the options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example List databases
+     * const result = await os.listDatabases('recordName', 'myDatabase');
+     *
+     * @dochash actions/os/records/database
+     * @docgroup 02-database
+     * @docname os.listDatabases
+     * @docid listDatabases
+     */
+    function listDatabases(recordName, startingAddress, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            listDatabases: {
+                input: {
+                    recordName,
+                    address: startingAddress,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Lists the databases in a record by a specific marker.
+     * @param recordName The name of the record to list the databases from.
+     * @param marker The marker to filter the list by.
+     * @param startingAddress The address that the listing should start after.
+     * @param options The options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example List public read databases
+     * const result = await os.listDatabasesByMarker('recordName', 'publicRead');
+     *
+     * @example List private databases
+     * const result = await os.listDatabasesByMarker('recordName', 'private');
+     *
+     * @dochash actions/os/records/database
+     * @docgroup 02-database
+     * @docname os.listDatabasesByMarker
+     */
+    function listDatabasesByMarker(recordName, marker, startingAddress, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            listDatabases: {
+                input: {
+                    recordName,
+                    marker,
+                    address: startingAddress,
+                    sort: options === null || options === void 0 ? void 0 : options.sort,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets basic info about a database from the specified record.
+     *
+     * @param recordName The name of the record to retrieve the database from.
+     * @param address The address of the database to retrieve.
+     * @param options The options for the request.
+     *
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Get a database and query a table
+     * const db = os.getDatabase('myRecord', 'myDatabase');
+     * const result = await db.query`SELECT * FROM myTable`;
+     *
+     * @example Insert a new row
+     * const value1 = 'abc';
+     * const value2 = 123;
+     * const result = await db.execute`INSERT INTO myTable (column1, column2) VALUES (${value1}, ${value2})`;
+     *
+     * @example Run multiple queries in a transaction
+     * const values = [
+     *   ['apple', 10],
+     *   ['car', 25000],
+     *   ['strawberry', 1],
+     *   ['lego', 5]
+     * ];
+     *
+     * const result = await db.batch(
+     *   values.map(([name, value]) => db.sql`INSERT INTO data (name, value) VALUES (${name}, ${value})`)
+     * );
+     *
+     * @dochash actions/os/records/database
+     * @docgroup 02-database
+     * @docname os.getDatabase
+     */
+    function getDatabase(recordName, address, options = {}) {
+        return new ApiDatabase(recordName, address, options, context);
+    }
     /**
      * Gets the list of studios that the currently logged in user has access to.
      *
@@ -7016,6 +7549,41 @@ export function createDefaultLibrary(context) {
         const event = calcListUserStudios(options, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Gets the list of records that are in the studio with the given ID.
+     *
+     * Returns a promise that resolves with an object that contains the list of records (if successful) or information about the error that occurred.
+     * The user must be a member of the studio to access its records.
+     *
+     * @param studioId The ID of the studio to list records for.
+     * @param endpoint the HTTP Endpoint of the records website that the data should be retrieved from. If omitted, then the preconfigured records endpoint will be used.
+     *
+     * @example Get the list of records in a studio
+     * const result = await os.listStudioRecords('studioId123');
+     *
+     * if (result.success) {
+     *      os.toast(`Found ${result.records.length} records in studio`);
+     *      for (const record of result.records) {
+     *          os.toast(`Record: ${record.name}`);
+     *      }
+     * } else {
+     *      os.toast('Failed to list studio records: ' + result.errorMessage);
+     * }
+     *
+     * @dochash actions/os/records
+     * @docgroup 01-records
+     * @docid os.listStudioRecords
+     * @docname os.listStudioRecords
+     */
+    function listStudioRecords(studioId, endpoint) {
+        let options = {};
+        if (hasValue(endpoint)) {
+            options.endpoint = endpoint;
+        }
+        const task = context.createTask();
+        const event = calcListStudioRecords(studioId, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Gets the default records endpoint. That is, the records endpoint that is used for records actions when no endpoint is specified.
      *
@@ -7550,6 +8118,58 @@ export function createDefaultLibrary(context) {
         const event = calcRemoveMapLayer(layerId, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Adds a map layer to a bot with form: "map".
+     *
+     * Returns a promise that resolves with the ID of the layer that was added.
+     *
+     * @param bot The bot that should have the layer added.
+     * @param overlay The overlay configuration.
+     *
+     * @example Add a GeoJSON layer to a map bot
+     * const layerId = await os.addBotMapLayer(bot, {
+     *     type: 'geojson',
+     *     data: {
+     *         type: "FeatureCollection",
+     *         features: [...]
+     *     }
+     * });
+     */
+    function addBotMapLayer(bot, overlay) {
+        const task = context.createTask();
+        const botId = typeof bot === 'string' ? bot : bot.id;
+        const normalizedOverlay = {
+            ...overlay,
+            overlayType: overlay.overlayType || overlay.type || 'geojson',
+        };
+        const action = {
+            type: 'add_bot_map_layer',
+            botId: botId,
+            overlay: normalizedOverlay,
+            taskId: task.taskId,
+        };
+        return addAsyncAction(task, action);
+    }
+    /**
+     * Removes a layer from a bot with form: "map".
+     *
+     * @param bot The bot that has the layer.
+     * @param overlayId The ID of the overlay to remove.
+     *
+     * @example Remove a layer from a map bot
+     * await os.removeBotMapLayer(bot, 'my-layer-id');
+     */
+    function removeBotMapLayer(bot, overlayId) {
+        const task = context.createTask();
+        const botId = typeof bot === 'string' ? bot : bot.id;
+        const action = {
+            type: 'remove_bot_map_layer',
+            botId: botId,
+            overlayId: overlayId,
+            taskId: task.taskId,
+        };
+        return addAsyncAction(task, action);
+    }
     /**
      * Executes the given shell script on the server.
      * @param script The shell script  that should be executed.
@@ -7601,22 +8221,36 @@ export function createDefaultLibrary(context) {
         const event = calcRemote(getRemoteCount(), undefined, undefined, task.taskId);
         return addAsyncAction(task, event);
     }
-    function getSharedDocument(recordOrName, inst, name) {
+    function getSharedDocument(recordOrName, inst, name, options) {
         const task = context.createTask();
         let recordName;
         let instName;
         let branchName;
-        if (!inst && !name) {
+        let markers;
+        if (typeof inst === 'object' && !name && !options) {
+            // Called as getSharedDocument(name, options)
+            instName = getCurrentServer();
+            recordName = getCurrentInstRecord();
+            branchName = recordOrName;
+            markers = inst === null || inst === void 0 ? void 0 : inst.markers;
+        }
+        else if (!inst && !name) {
+            // Called as getSharedDocument(name)
             instName = getCurrentServer();
             recordName = getCurrentInstRecord();
             branchName = recordOrName;
         }
         else {
+            // Called as getSharedDocument(recordName, inst, name) or getSharedDocument(recordName, inst, name, options)
+            if (typeof inst === 'object') {
+                throw new Error('The second argument (inst) must be a string when calling getSharedDocument() with three or more arguments.');
+            }
             recordName = recordOrName;
             instName = inst;
             branchName = name;
+            markers = options === null || options === void 0 ? void 0 : options.markers;
         }
-        const event = loadSharedDocument(recordName, instName, `doc/${branchName}`, task.taskId);
+        const event = loadSharedDocument(recordName, instName, `doc/${branchName}`, task.taskId, markers);
         return addAsyncAction(task, event);
     }
     /**