@casual-simulation/aux-runtime 3.5.4 → 3.7.0-alpha.16977445547

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@casual-simulation/aux-runtime",
-    "version": "3.5.4",
+    "version": "3.7.0-alpha.16977445547",
     "description": "Runtime for AUX projects",
     "main": "index.js",
     "types": "index.d.ts",
@@ -32,8 +32,8 @@
         "access": "public"
     },
     "dependencies": {
-        "@casual-simulation/aux-common": "^3.5.3",
-        "@casual-simulation/aux-records": "^3.5.3",
+        "@casual-simulation/aux-common": "^3.7.0-alpha.16977445547",
+        "@casual-simulation/aux-records": "^3.7.0-alpha.16977445547",
         "@casual-simulation/crypto": "^3.5.0",
         "@casual-simulation/engine262": "0.0.1-4de2170374e22761996e46eb1362f4496ee57f8f",
         "@casual-simulation/error-stack-parser": "^2.0.7",
@@ -64,6 +64,7 @@
         "rxjs": "8.0.0-alpha.14",
         "seedrandom": "3.0.5",
         "stackframe": "^1.2.0",
+        "typesense": "2.0.3",
         "uuid": "10.0.0",
         "yjs": "13.6.8"
     },
@@ -81,5 +82,5 @@
         "**/*.d.ts",
         "**/*.def"
     ],
-    "gitHead": "71b094c249473e20221f54c54fb7b1c955897616"
+    "gitHead": "d22abb62ddde636eefe58909962668df3d6c9566"
 }

package/runtime/AuxLibrary.d.ts

@@ -27,6 +27,7 @@ import type { HandleWebhookResult } from '@casual-simulation/aux-records/webhook
 import type { SharedDocument } from '@casual-simulation/aux-common/documents/SharedDocument';
 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';
 /**
  * Defines an interface for a function that provides HTML VDOM capabilities to bots.
  */
@@ -251,6 +252,41 @@ export interface RecordPackageVersionApiRequest {
      */
     markers?: string[];
 }
+/**
+ * Defines an interface that represents a request for {@link recordSearchCollection}.
+ *
+ * @dochash types/records/search
+ * @docname RecordSearchCollectionRequest
+ */
+export interface RecordSearchCollectionApiRequest {
+    /**
+     * The name of the record that the package version should be recorded to.
+     */
+    recordName: string;
+    /**
+     * The address that the package version should be recorded to.
+     */
+    address: string;
+    /**
+     * The schema that should be used for the collection.
+     */
+    schema: SearchCollectionSchema;
+    /**
+     * The markers that should be applied to the package version.
+     */
+    markers?: string[];
+}
+/**
+ * Defines an interface that represents a request for {@link recordSearchDocument}.
+ *
+ * @dochash types/records/search
+ * @docname RecordSearchDocumentRequest
+ */
+export interface RecordSearchDocumentApiRequest {
+    recordName: string;
+    address: string;
+    document: SearchDocument;
+}
 /**
  * Defines a set of options for {@link animateTag-byTag}.
  *
@@ -2154,6 +2190,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             showJoinCode: (inst?: string, dimension?: string) => ShowJoinCodeAction;
             requestFullscreenMode: () => RequestFullscreenAction;
             exitFullscreenMode: () => ExitFullscreenAction;
+            hideLoadingScreen: () => Promise<void>;
             showHtml: (html: string) => ShowHtmlAction;
             hideHtml: () => HideHtmlAction;
             setClipboard: (text: string) => SetClipboardAction;
@@ -2521,6 +2558,13 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             getPackageContainer: (recordName: string, address: string, options?: RecordActionOptions) => Promise<CrudGetItemResult<PackageRecord>>;
             installPackage: (recordName: string, address: string, key?: string | PackageRecordVersionKeySpecifier, options?: RecordActionOptions) => Promise<InstallPackageResult>;
             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>;
+            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>;
             listUserStudios: (endpoint?: string) => Promise<ListStudiosResult>;
             getRecordsEndpoint: () => Promise<string>;
             convertGeolocationToWhat3Words: (location: ConvertGeolocationToWhat3WordsOptions) => Promise<string>;

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, } from './RecordsEvents';
+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 { sortBy, every, cloneDeep, union, isEqual, flatMap } from 'lodash';
 import { remote as calcRemote, DEFAULT_BRANCH_NAME, formatVersionNumber, parseVersionNumber, PRIVATE_MARKER, } from '@casual-simulation/aux-common';
 import { RanOutOfEnergyError } from './AuxResults';
@@ -335,6 +335,7 @@ export function createDefaultLibrary(context) {
                 showJoinCode,
                 requestFullscreenMode,
                 exitFullscreenMode,
+                hideLoadingScreen,
                 showHtml,
                 hideHtml,
                 setClipboard,
@@ -593,6 +594,13 @@ export function createDefaultLibrary(context) {
                 getPackageContainer,
                 installPackage,
                 listInstalledPackages,
+                recordSearchCollection,
+                getSearchCollection,
+                eraseSearchCollection,
+                listSearchCollections,
+                listSearchCollectionsByMarker,
+                recordSearchDocument,
+                eraseSearchDocument,
                 listUserStudios,
                 getRecordsEndpoint,
                 convertGeolocationToWhat3Words,
@@ -2317,6 +2325,26 @@ export function createDefaultLibrary(context) {
     function exitFullscreenMode() {
         return addAction(exitFullscreen());
     }
+    /**
+     * Hides the loading screen.
+     *
+     * Returns a promise that resolves when the loading screen has been hidden.
+     *
+     * @example Hide the loading screen.
+     * await os.hideLoadingScreen();
+     *
+     * @dochash actions/os/portals
+     * @docname os.hideLoadingScreen
+     * @docgroup 11-loading
+     */
+    function hideLoadingScreen() {
+        const task = context.createTask();
+        const action = {
+            type: 'hide_loading_screen',
+            taskId: task.taskId,
+        };
+        return addAsyncAction(task, action);
+    }
     /**
      * Shows some HTML to the player in a popup modal. This can be useful for loading a separate webpage or providing some formatted text.
      *
@@ -6648,6 +6676,317 @@ export function createDefaultLibrary(context) {
         const event = calcListInstalledPackages(options, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Creates or updates a search collection in the given record.
+     *
+     * Returns a promise that resolves with the result of the operation.
+     *
+     * @param request The request to create or update the search collection.
+     * @param options the options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Record a search collection with an automatic schema
+     * const result = await os.recordSearchCollection({
+     *      recordName: 'myRecord',
+     *      address: 'mySearchCollection',
+     *      schema: {
+     *          '.*': {
+     *              type: 'auto'
+     *           }
+     *      }
+     * });
+     *
+     * @example Record a search collection with a custom schema
+     * const result = await os.recordSearchCollection({
+     *      recordName: 'myRecord',
+     *      address: 'mySearchCollection',
+     *      schema: {
+               title: {
+                  type: 'string',
+               },
+               description: {
+                  type: 'string',
+               },
+               price: {
+                  type: 'int32',
+               }
+     *      }
+     * });
+     *
+     * @example Record a private search collection
+     * const result = await os.recordSearchCollection({
+     *      recordName: 'myRecord',
+     *      address: 'mySearchCollection',
+     *      schema: {
+               '.*': {
+     *             type: 'auto'
+     *          }
+     *      },
+     *      markers: ['private']
+     * });
+     *
+     * @example Record and search through a search collection
+     * import Typesense from 'typesense';
+     * const result = await os.recordSearchCollection({
+     *      recordName: 'myRecord',
+     *      address: 'mySearchCollection',
+     *      schema: {
+     *          '.*': {
+     *              type: 'auto'
+     *           }
+     *      }
+     * });
+     *
+     * if (!result.success) {
+     *   os.toast('Failed to record search collection: ' + result.errorMessage);
+     *   return;
+     * }
+     *
+     * const collection = await os.getSearchCollection('myRecord', 'mySearchCollection');
+     *
+     * if (!collection.success) {
+     *    os.toast('Failed to get search collection: ' + collection.errorMessage);
+     *    return;
+     * }
+     *
+     * const client = new Typesense.Client({
+     *   nodes: collection.item.nodes,
+     *   apiKey: collection.item.searchApiKey,
+     * });
+     *
+     * const searchResults = await client.collections(collection.item.collectionName).documents().search({
+     *   q: 'search term',
+     *   query_by: 'title,description',
+     *   sort_by: 'price:asc',
+     * });
+     *
+     * console.log('search results', searchResults);
+     *
+     *
+     * @doctitle Search Actions
+     * @docsidebar Search
+     * @docdescription Search actions allow you to create and manage search collections in your records. Search collections enable efficient searching and indexing of data within your records, making it easier to retrieve relevant information quickly.
+     * @dochash actions/os/records/search
+     * @docgroup 02-search
+     * @docname os.recordSearchCollection
+     */
+    function recordSearchCollection(request, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            recordSearchCollection: {
+                input: {
+                    recordName: request.recordName,
+                    item: {
+                        address: request.address,
+                        schema: request.schema,
+                        markers: request.markers,
+                    },
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Deletes a search collection along with all the documents in it.
+     *
+     * 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 address The address of the search collection to delete.
+     * @param options the options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Erase a search collection
+     * const result = await os.eraseSearchCollection('recordName', 'mySearchCollection');
+     *
+     * @dochash actions/os/records/search
+     * @docgroup 02-search
+     * @docname os.eraseSearchCollection
+     */
+    function eraseSearchCollection(recordName, address, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            eraseSearchCollection: {
+                input: {
+                    recordName,
+                    address,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Lists the search collections 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 search collections
+     * const result = await os.listSearchCollections('recordName', 'mySearchCollection');
+     *
+     * @dochash actions/os/records/search
+     * @docgroup 02-search
+     * @docname os.listSearchCollections
+     */
+    function listSearchCollections(recordName, startingAddress, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            listSearchCollections: {
+                input: {
+                    recordName,
+                    address: startingAddress,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Lists the search collections in a record by a specific marker.
+     * @param recordName The name of the record to list the search collections 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 search collections
+     * const result = await os.listSearchCollectionsByMarker('recordName', 'publicRead');
+     *
+     * @example List private search collections
+     * const result = await os.listSearchCollectionsByMarker('recordName', 'private');
+     *
+     * @dochash actions/os/records/search
+     * @docgroup 02-search
+     * @docname os.listSearchCollectionsByMarker
+     */
+    function listSearchCollectionsByMarker(recordName, marker, startingAddress, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            listSearchCollections: {
+                input: {
+                    recordName,
+                    marker,
+                    address: startingAddress,
+                    sort: options === null || options === void 0 ? void 0 : options.sort,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets a search collection from the specified record.
+     * @param recordName The name of the record to retrieve the search collection from.
+     * @param address The address of the search collection to retrieve.
+     * @param options The options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Get a search collection
+     * const result = await os.getSearchCollection('myRecord', 'mySearchCollection');
+     *
+     * @example Search through a search collection
+     * import Typesense from 'typesense';
+     * const collection = await os.getSearchCollection('myRecord', 'mySearchCollection');
+     *
+     * if (!collection.success) {
+     *    os.toast('Failed to get search collection: ' + collection.errorMessage);
+     *    return;
+     * }
+     *
+     * const client = new Typesense.Client({
+     *   nodes: collection.item.nodes,
+     *   apiKey: collection.item.searchApiKey,
+     * });
+     *
+     * const searchResults = await client.collections(collection.item.collectionName).documents().search({
+     *   q: 'search term',
+     *   query_by: 'title,description',
+     *   sort_by: 'price:asc',
+     * });
+     *
+     * console.log('search results', searchResults);
+     *
+     * @dochash actions/os/records/search
+     * @docgroup 02-search
+     * @docname os.getSearchCollection
+     */
+    function getSearchCollection(recordName, address, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            getSearchCollection: {
+                input: {
+                    recordName,
+                    address,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Records a search document to the specified search collection in the given record.
+     * @param request The request to record the search document.
+     * @param options The options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Record a search document
+     * const result = await os.recordSearchDocument({
+     *    recordName: 'myRecord',
+     *    address: 'mySearchCollection',
+     *    document: {
+     *      // ensure that the document matches the schema of the search collection
+     *      title: 'My Document',
+     *      description: 'This is the content of my document.'
+     *      price: 10,
+     *    }
+     * });
+     *
+     * @dochash actions/os/records/search
+     * @docgroup 02-search
+     * @docname os.recordSearchDocument
+     */
+    function recordSearchDocument(request, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            recordSearchDocument: {
+                input: {
+                    recordName: request.recordName,
+                    address: request.address,
+                    document: request.document,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Erases a search document from the specified search collection in the given record.
+     * @param recordName The name of the record that the search document is in.
+     * @param address The address of the search collection that the document is in.
+     * @param documentId The ID of the document that should be erased.
+     * @param options The options for the request.
+     * @returns A promise that resolves with the result of the operation.
+     *
+     * @example Erase a search document
+     * const result = await os.eraseSearchDocument('myRecord', 'mySearchCollection', 'documentId');
+     *
+     * @dochash actions/os/records/search
+     * @docgroup 02-search
+     * @docname os.eraseSearchDocument
+     */
+    function eraseSearchDocument(recordName, address, documentId, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            eraseSearchDocument: {
+                input: {
+                    recordName: recordName,
+                    address: address,
+                    documentId: documentId,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Gets the list of studios that the currently logged in user has access to.
      *