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

package/runtime/AuxLibraryDefinitions.def

@@ -3704,6 +3704,206 @@ export interface ListDataOptions extends RecordActionOptions {
     sort?: 'ascending' | 'descending';
 }
 
+/**
+ * Defines a node that search clients can use to connect to the search engine.
+ *
+ * @dochash types/records/search
+ * @docname SearchNode
+ */
+export interface SearchNode {
+    /**
+     * The host of the node.
+     */
+    host: string;
+
+    /**
+     * The port number of the node.
+     */
+    port: number;
+
+    /**
+     * The protocol to use when connecting to the node.
+     */
+    protocol?: 'http' | 'https';
+}
+
+/**
+ * Defines a record that represents a collection of documents that can be searched.
+ *
+ * @dochash types/records/search
+ * @docName SearchRecord
+ */
+export interface SearchRecord extends CrudRecord {
+    /**
+     * The name of the collection that this search record is attached to.
+     */
+    collectionName: string;
+
+    /**
+     * The API key that is used to query the collection.
+     */
+    searchApiKey: string;
+
+    /**
+     * The search nodes that should be used by clients to connect to the search engine.
+     */
+    nodes?: SearchNode[];
+}
+
+
+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 a field for a search collection schema.
+ * 
+ * @dochash types/records/search
+ * @docname SearchCollectionField
+ */
+export interface SearchCollectionField {
+    /**
+     * The type of the field.
+     */
+    type:
+        | 'string'
+        | 'string[]'
+        | 'int32'
+        | 'int32[]'
+        | 'int64'
+        | 'int64[]'
+        | 'float'
+        | 'float[]'
+        | 'bool'
+        | 'bool[]'
+        | 'geopoint'
+        | 'geopoint[]'
+        | 'geopolygon'
+        | 'object'
+        | 'object[]'
+        | 'string*'
+        | 'image'
+        | 'auto';
+
+    /**
+     * Enables faceting on the field.
+     *
+     * Defaults to `false`.
+     */
+    facet?: boolean;
+
+    /**
+     * When set to `true`, the field can have empty, null or missing values. Default: `false`.
+     */
+    optional?: boolean;
+
+    /**
+     * When set to `false`, the field will not be indexed in any in-memory index (e.g. search/sort/filter/facet). Default: `true`.
+     */
+    index?: boolean;
+
+    /**
+     * When set to `false`, the field value will not be stored on disk. Default: `true`.
+     */
+    store?: boolean;
+
+    /**
+     * When set to true, the field will be sortable. Default: `true` for numbers, `false` otherwise.
+     */
+    sort?: boolean;
+
+    /**
+     * When set to `true`, the field value can be infix-searched. Incurs significant memory overhead. Default: `false`.
+     */
+    infix?: boolean;
+
+    /**
+     * For configuring language specific tokenization, e.g. `jp` for Japanese. Default: `en` which also broadly supports most European languages.
+     */
+    locale?: string;
+}
+
+/**
+ * Defines the schema for a search collection.
+ * 
+ * @dochash types/records/search
+ * @docName SearchCollectionSchema
+ */
+export interface SearchCollectionSchema {
+    /**
+     * The schema that defines the fields in the search collection.
+     */
+    [key: string]: SearchCollectionField;
+}
+
+/**
+ * Defines a document that can be stored in a search collection.
+ * 
+ * @dochash types/records/search
+ * @docname SearchDocument
+ */
+export interface SearchDocument {
+    /**
+     * The ID of the document.
+     * If not provided, a new ID will be generated.
+     */
+    id?: string;
+
+    /**
+     * The properties of the document.
+     */
+    [key: string]: any;
+}
+
+export type RecordSearchDocumentResult = RecordSearchDocumentSuccess | RecordSearchDocumentFailure;
+
+export interface RecordSearchDocumentSuccess extends SearchDocument {
+    success: true;
+}
+
+export interface RecordSearchDocumentFailure {
+    success: false;
+    errorCode: string;
+    errorMessage: string;
+}
+
+export type EraseSearchDocumentResult = EraseSearchDocumentSuccess | EraseSearchDocumentFailure;
+
+export interface EraseSearchDocumentSuccess extends SearchDocument {
+    success: true;
+}
+
+export interface EraseSearchDocumentFailure {
+    success: false;
+    errorCode: string;
+    errorMessage: string;
+}
+
+export interface RecordSearchDocumentApiRequest {
+    recordName: string;
+    address: string;
+    document: SearchDocument;
+}
+
 export type RecordDataResult = RecordDataSuccess | RecordDataFailure;
 
 export interface RecordDataSuccess {
@@ -11310,6 +11510,11 @@ export interface SharedDocument extends SubscriptionLike {
      */
     onEvents: Observable<Action[]>;
 
+    /**
+     * Gets the observable list of updates from the partition.
+     */
+    onUpdates: Observable<string[]>;
+
     /**
      * Gets the observable list of status updates from the partition.
      */
@@ -11371,6 +11576,12 @@ export interface SharedDocument extends SubscriptionLike {
      * @param updates The updates to apply.
      */
     applyStateUpdates(updates: InstUpdate[]): void;
+
+    /**
+     * Applies the given raw updates to the document.
+     * @param updates The updates to apply.
+     */
+    applyUpdates(updates: string[]): void;
 }
 
 export type SharedType = SharedMap | SharedArray | SharedText;
@@ -13244,6 +13455,20 @@ interface Os {
      * Exits fullscreen mode.
      */
     exitFullscreenMode(): ExitFullscreenAction;
+    
+    /**
+     * 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
+     */
+    hideLoadingScreen(): Promise<void>;
 
     /**
      * Shares some information via the device's social sharing functionality.
@@ -15194,6 +15419,192 @@ interface Os {
      */
     listInstalledPackages(options?: RecordActionOptions): Promise<ListInstalledPackagesResult>;
 
+    /**
+     * 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',
+               }
+     *      }
+     * });
+     * 
+     * @dochash actions/os/records
+     * @docgroup 02-search
+     * @docname os.recordSearchCollection
+     */
+    recordSearchCollection(
+        request: RecordSearchCollectionApiRequest,
+        options?: RecordActionOptions
+    ): Promise<CrudRecordItemResult>;
+
+    /**
+     * 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
+     * @docgroup 02-search
+     * @docname os.eraseSearchCollection
+     */
+    eraseSearchCollection(
+        recordName: string,
+        address: string,
+        options?: RecordActionOptions
+    ): Promise<CrudRecordItemResult>;
+
+    /**
+     * 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
+     * @docgroup 02-search
+     * @docname os.listSearchCollections
+     */
+    listSearchCollections(
+        recordName: string,
+        startingAddress?: string,
+        options?: ListDataOptions
+    ): Promise<CrudRecordItemResult>;
+
+    /**
+     * 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
+     * @docgroup 02-search
+     * @docname os.listSearchCollectionsByMarker
+     */
+    listSearchCollectionsByMarker(
+        recordName: string,
+        marker: string,
+        startingAddress?: string,
+        options?: ListDataOptions
+    ): Promise<CrudListItemsResult<SearchRecord>>;
+
+    /**
+     * 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');
+     *
+     * @dochash actions/os/records
+     * @docgroup 02-search
+     * @docname os.getSearchCollection
+     */
+    getSearchCollection(
+        recordName: string,
+        address: string,
+        options?: RecordActionOptions,
+    ): Promise<CrudGetItemResult<SearchRecord>>;
+
+    /**
+     * 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
+     * @docgroup 02-search
+     * @docname os.recordSearchDocument
+     */
+    recordSearchDocument(
+        request: RecordSearchDocumentApiRequest,
+        options?: RecordActionOptions
+    ): Promise<RecordSearchDocumentResult>;
+
+    /**
+     * 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
+     * @docgroup 02-search
+     * @docname os.eraseSearchDocument
+     */
+    eraseSearchDocument(
+        recordName: string,
+        address: string,
+        documentId: string,
+        options?: RecordActionOptions
+    ): Promise<EraseSearchDocumentResult>;
+
     /**
      * Gets the list of studios that the currently logged in user has access to.
      * 

package/runtime/AuxRuntime.js

@@ -508,13 +508,10 @@ export class AuxRuntime {
                 }
             }
         }
-        if (isUrl(moduleName)) {
-            return {
-                id: moduleName,
-                url: moduleName,
-            };
-        }
-        return null;
+        return {
+            id: moduleName,
+            url: moduleName,
+        };
     }
     getShoutTimers() {
         return {};