@casual-simulation/aux-common 2.0.19-alpha.1523438944 → 2.0.22

package/runtime/AuxLibraryDefinitions.def

@@ -2238,96 +2238,26 @@ declare interface UnsuccessfulGeolocation {
  */
 declare type GeoLocation = SuccessfulGeolocation | UnsuccessfulGeolocation;
 
-
 /**
- * Defines an event that publishes a record.
+ * Defines an interface that represents options for converting a geolocation to a what3words address.
  */
- export interface PublishRecordAction extends AsyncAction {
-    type: 'publish_record';
-
+export interface ConvertGeolocationToWhat3WordsOptions {
     /**
-     * The auth token that should be used to authenticate the publish record request.
+     * The latitude to convert.
      */
-    token: string;
-
-    /**
-     * The address that the record should be published to.
-     */
-    address: string;
+    latitude: number;
 
     /**
-     * The record data that should be published.
+     * The longitude to convert.
      */
-    record: any;
+    longitude: number;
 
     /**
-     * The space that the record should be published in.
+     * The identifier of the language that should be used for the resulting what3words address.
      */
-    space: RecordSpace;
-
-    uncopiable: true;
+    language?: string;
 }
 
-export interface RecordDefinition {
-    /**
-     * The auth token that should be used to authenticate the publish record request.
-     * Different auth tokens can be used to publish records to different CasualOS.me accounts.
-     * Defaults to using the auth token in the auth bot.
-     */
-    authToken?: string;
-
-    /**
-     * The space that the record should be published in.
-     * Defaults to tempRestricted.
-     */
-    space?: RecordSpace;
-
-    /**
-     * The record that should be published.
-     */
-    record: any;
-}
-
-export interface AddressedRecord extends RecordDefinition {
-    /**
-     * The address that the record should be published to.
-     */
-    address: string;
-}
-
-export interface PrefixedRecord extends RecordDefinition {
-    /**
-     * The prefix that the record should be published with.
-     */
-    prefix?: string;
-
-    /**
-     * The ID that the record should be published with.
-     * Defaults to a UUID.
-     */
-    id?: string;
-}
-
-export type PublishableRecord = AddressedRecord | PrefixedRecord;
-
-
-export interface DeletableRecord {
-    /**
-     * The auth token that should be used to authenticate the delete record request.
-     */
-     authToken?: string;
-     
-    /**
-     * The space that the record lives in.
-     */
-     space: RecordSpace;
-
-     /**
-      * The address that the record was published to.
-      */
-     address: string;
-};
-
 /**
  * Defines an interface for options that show a payment box.
  */
@@ -2472,6 +2402,10 @@ declare interface ParsedBotLink {
     botIDs: string[];
 }
 
+declare interface BotVars {
+    [variable: string]: any;
+}
+
 /**
  * Defines an interface that represents the bot links a bot can have.
  */
@@ -2513,6 +2447,11 @@ export interface Bot {
      */
     links: BotLinks;
 
+    /**
+     * THe variables that are stored in this bot.
+     */
+    vars: BotVars;
+
     /**
      * The raw tag values that the bot contains.
      * If you want to access the script code for a formula, use this.
@@ -2892,6 +2831,170 @@ export interface DebuggerOptions {
     configBot: Bot | BotTags;
 }
 
+
+/**
+ * Defines an interface that represents the result of a "create public record key" operation.
+ */
+ export type CreatePublicRecordKeyResult =
+ | CreatePublicRecordKeySuccess
+ | CreatePublicRecordKeyFailure;
+
+/**
+ * Defines an interface that represents a successful "create public record key" result.
+ */
+export interface CreatePublicRecordKeySuccess {
+    /**
+     * Whether the operation was successful.
+     */
+    success: true;
+
+    /**
+     * The key that was created.
+     */
+    recordKey: string;
+
+    /**
+     * The name of the record the key was created for.
+     */
+    recordName: string;
+}
+
+/**
+ * Defines an interface that represents a failed "create public record key" result.
+ */
+export interface CreatePublicRecordKeyFailure {
+    /**
+     * Whether the operation was successful.
+     */
+    success: false;
+
+    /**
+     * The type of error that occurred.
+     */
+    errorCode: UnauthorizedToCreateRecordKeyError | GeneralRecordError;
+
+    /**
+     * The error message.
+     */
+    errorMessage: string;
+}
+
+/**
+ * Defines an error that occurs when a user is not authorized to create a key for the public record.
+ * This may happen when the user is not the owner of the record.
+ */
+export type UnauthorizedToCreateRecordKeyError =
+    'unauthorized_to_create_record_key';
+
+/**
+ * Defines an error that occurs when an unspecified error occurs while creating a public record key.
+ */
+export type GeneralRecordError = 'general_record_error';
+
+/**
+ * Defines an error that occurs when an unspecified error occurs while creating a public record key.
+ */
+export type InvalidRecordKey = 'invalid_record_key';
+
+/**
+ * Defines an error that occurs when an unspecified error occurs while creating a public record key.
+ */
+ export type ServerError = 'server_error';
+
+ /**
+  * Defines an error that occurs when the user is not logged in but they are required to be in order to perform an action.
+  */
+ export type NotLoggedInError = 'not_logged_in';
+
+export type RecordNotFoundError = 'record_not_found';
+ 
+
+
+export type RecordDataResult = RecordDataSuccess | RecordDataFailure;
+
+export interface RecordDataSuccess {
+    success: true;
+    recordName: string;
+    address: string;
+}
+
+export interface RecordDataFailure {
+    success: false;
+    errorCode:
+        | ServerError
+        | NotLoggedInError
+        | InvalidRecordKey
+        | RecordNotFoundError
+        | 'data_too_large';
+    errorMessage: string;
+}
+
+export type GetDataResult = GetDataSuccess | GetDataFailure;
+
+/**
+ * Defines an interface that represents a successful "get data" result.
+ */
+export interface GetDataSuccess {
+    success: true;
+
+    /**
+     * The data that was stored.
+     */
+    data: any;
+
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+
+    /**
+     * The ID of the user that owns the record.
+     */
+    publisherId: string;
+
+    /**
+     * The ID of the user that sent the data.
+     */
+    subjectId: string;
+}
+
+export interface GetDataFailure {
+    success: false;
+    errorCode: ServerError | 'data_not_found';
+    errorMessage: string;
+}
+
+
+export type RecordFileResult = RecordFileSuccess | RecordFileFailure;
+
+export interface RecordFileSuccess {
+    success: true;
+
+    /**
+     * The URL that the file can be accessed at.
+     */
+    url: string;
+
+    /**
+     * The SHA-256 hash of the file.
+     * When downloading the URL, the resulting data is guaranteed to have a SHA-256 hash that matches this value.
+     */
+    sha256Hash: string;
+}
+
+export interface RecordFileFailure {
+    success: false;
+    errorCode:
+        | ServerError
+        | NotLoggedInError
+        | InvalidRecordKey
+        | RecordNotFoundError
+        | 'file_already_exists'
+        | 'invalid_file_data';
+    errorMessage: string;
+}
+
+
 declare global {
 
     /**
@@ -3072,7 +3175,39 @@ declare global {
      * // Tell every bot say "Hi" to you.
      * shout("sayHi()", "My Name");
      */
-    function shout(name: string, arg?: any): any[];
+    const shout: {
+        /**
+         * Asks every bot in the inst to run the given action.
+         * In effect, this is like shouting to a bunch of people in a room.
+         *
+         * @param name The event name.
+         * @param arg The optional argument to include in the shout.
+         * @returns Returns a list which contains the values returned from each script that was run for the shout.
+         *
+         * @example
+         * // Tell every bot to reset themselves.
+         * shout("reset()");
+         *
+         * @example
+         * // Ask every bot for its name.
+         * const names = shout("getName()");
+         *
+         * @example
+         * // Tell every bot say "Hi" to you.
+         * shout("sayHi()", "My Name");
+         */
+        (name: string, arg?: any): any[],
+        [name: string]: {
+            /**
+             * Asks every bot in the inst to run the given action.
+             * In effect, this is like shouting to a bunch of people in a room.
+             *
+             * @param arg The optional argument to include in the shout.
+             * @returns Returns a list which contains the values returned from each script that was run for the shout.
+             */
+            (arg?: any): any[]
+        }
+    };
 
     /**
      * Asks the given bots to run the given action.
@@ -3465,30 +3600,6 @@ declare global {
      */
     function not(filter: BotFilterFunction): BotFilterFunction;
 
-    /**
-     * Creates a record filter that retrieves records created by the given Auth ID.
-     * @param authID The ID of the creator of the records.
-     */
-     function byAuthID(authID: string): AuthIdRecordFilter;
-
-    /**
-     * Creates a record filter that retrieves records with the given address.
-     * @param address The address that the record was stored at.
-     */
-     function byAddress(address: string): AddressRecordFilter;
-
-    /**
-     * Creates a record filter that retrieves records with the given address.
-     * @param token The auth token that should be used to authenticate the getRecords() request.
-     */
-    function withAuthToken(token: string): AuthTokenRecordFilter;
-
-    /**
-     * Creates a record filter that retrieves records with the given prefix in their address.
-     * @param prefix The prefix that should be matched to record addresses.
-     */
-    function byPrefix(prefix: string): PrefixRecordFilter;
-
     /**
      * Gets the value of the given tag stored in the given bot.
      * @param bot The bot.
@@ -4238,30 +4349,6 @@ interface Debugger {
       */
      not(filter: BotFilterFunction): BotFilterFunction;
  
-     /**
-      * Creates a record filter that retrieves records created by the given Auth ID.
-      * @param authID The ID of the creator of the records.
-      */
-      byAuthID(authID: string): AuthIdRecordFilter;
- 
-     /**
-      * Creates a record filter that retrieves records with the given address.
-      * @param address The address that the record was stored at.
-      */
-      byAddress(address: string): AddressRecordFilter;
- 
-     /**
-      * Creates a record filter that retrieves records with the given address.
-      * @param token The auth token that should be used to authenticate the getRecords() request.
-      */
-     withAuthToken(token: string): AuthTokenRecordFilter;
- 
-     /**
-      * Creates a record filter that retrieves records with the given prefix in their address.
-      * @param prefix The prefix that should be matched to record addresses.
-      */
-     byPrefix(prefix: string): PrefixRecordFilter;
- 
      /**
       * Gets the value of the given tag stored in the given bot.
       * @param bot The bot.
@@ -4452,6 +4539,22 @@ interface Debugger {
      perf: Perf;
 }
 
+/**
+ * Defines an interface that represents the set of additional options that can be provided when recording a file.
+ */
+interface RecordFileOptions {
+    /**
+     * The description of the file.
+     */
+    description?: string;
+
+    /**
+     * The MIME type of the file. 
+     * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types for more information.
+     */
+    mimeType?: string;
+}
+
 interface Os {
     /**
          * Sleeps for time in ms.
@@ -5074,35 +5177,80 @@ interface Os {
       */
      requestAuthBot(): Promise<Bot>;
 
-     /**
-      * Requests an auth token that does not expire and can be used to authorize other app bundles to publish records for this app bundle.
-      */
-     requestPermanentAuthToken: MaskFunc<() => Promise<string>>;
+    /**
+     * Gets an access key for the given public record.
+     * @param name The name of the record.
+     */
+    getPublicRecordKey(recordName: string): Promise<CreatePublicRecordKeyResult>;
 
-     /**
-      * Publishes a record that can be used across instances.
-      * @param recordDefinition The data that should be used to publish the record.
-      */
-     publishRecord: MaskFunc<(recordDefinition: PublishableRecord) => Promise<void>>;
+    /**
+     * Determines if the given value is a record key.
+     * @param key The value to check.
+     */
+    isRecordKey(key: unknown): boolean;
+
+    /**
+     * Records the given data to the given address inside the record for the given record key.
+     * @param recordKey The key that should be used to access the record.
+     * @param address The address that the data should be stored at inside the record.
+     * @param data The data that should be stored.
+     */
+     recordData(
+        recordKey: string,
+        address: string,
+        data: any
+    ): Promise<RecordDataResult>;
+
+    /**
+     * Gets the data stored in the given record at the given address.
+     * @param recordKeyOrName The record that the data should be retrieved from.
+     * @param address The address that the data is stored at.
+     */
+    getData(
+        recordKeyOrName: string,
+        address: string
+    ): Promise<GetDataResult>;
+
+    /**
+     * Records the given data as a file.
+     * @param recordKey The record that the file should be recorded in.
+     * @param data The data that should be recorded.
+     * @param options The options that should be used to record the file.
+     */
+     recordFile(
+        recordKey: string,
+        data: any,
+        options?: RecordFileOptions
+    ): Promise<RecordFileResult>;
 
+    /**
+     * Gets the data stored in the given file.
+     * @param result The successful result of a os.recordFile() call.
+     */
+     getFile(result: RecordFileSuccess): Promise<any>;
      /**
-      * Retrives a list of records using the given filters.
-      * @param filters The list of filters that should be used to retrieve some records.
+      * Gets the data stored in the given file.
+      * @param url The URL that the file is stored at.
       */
-     getRecords: MaskFunc<(...filters: RecordFilters[]) => Promise<GetRecordsResult>>;
-
+     getFile(url: string): Promise<any>;
      /**
-      * Requests that the given record be destroyed.
-      * @param record The record that should be deleted.
+      * Gets the data stored in the given file.
+      * @param urlOrRecordFileResult The URL or the successful result of the record file operation.
       */
-     destroyRecord: MaskFunc<(record: DeletableRecord) => Promise<void>>;
+     getFile(urlOrRecordFileResult: string | RecordFileSuccess): Promise<any>;
+
+    /**
+     * Converts the given geolocation to a what3words (https://what3words.com/) address.
+     * @param location The latitude and longitude that should be converted to a 3 word address.
+     */
+    convertGeolocationToWhat3Words(location: ConvertGeolocationToWhat3WordsOptions): Promise<string>;
 
      /**
       * Specifies that the given prefix should be interpreted as code.
       * @param prefix The prefix that code tags should start with.
       * @param options The options that should be used for the prefix.
       */
-      registerTagPrefix(prefix: string, options?: RegisterPrefixOptions): Promise<void>;
+    registerTagPrefix(prefix: string, options?: RegisterPrefixOptions): Promise<void>;
 
      /**
       * Gets the number of devices that are viewing the current inst.
@@ -5150,6 +5298,11 @@ interface Os {
       * Gets the debugger that this script is currently running in.
       */
      getExecutingDebugger(): Debugger;
+
+     /**
+      * The global variables that are stored in the OS.
+      */
+     vars: typeof globalThis;
 }
 
 interface Server {

package/runtime/AuxRuntime.js

@@ -12,7 +12,7 @@ import { addToContext, MemoryGlobalContext, removeFromContext, isInContext, } fr
 import { createDefaultLibrary, } from './AuxLibrary';
 import { createRuntimeBot, RealtimeEditMode, } from './RuntimeBot';
 import { RanOutOfEnergyError } from './AuxResults';
-import { convertToCopiableValue, DeepObjectError, formatAuthToken, } from './Utils';
+import { convertToCopiableValue, DeepObjectError, } from './Utils';
 import { DefaultRealtimeEditModeProvider, } from './AuxRealtimeEditModeProvider';
 import { sortBy, forOwn, merge, union } from 'lodash';
 import { tagValueHash } from '../aux-format-2/AuxOpTypes';
@@ -326,12 +326,6 @@ export class AuxRuntime {
                 this._processCore([asyncResult(action.taskId, null)]);
             }
         }
-        else if (action.type === 'update_auth_data') {
-            const bot = this._compiledState[action.data.userId];
-            if (bot) {
-                this.updateTag(bot, 'authToken', formatAuthToken(action.data.token, action.data.service));
-            }
-        }
         else {
             this._actionBatch.push(action);
         }
@@ -1254,7 +1248,7 @@ export class AuxRuntime {
                 throw data;
             },
             constants: Object.assign(Object.assign({}, this._library.api), { tagName: tag, globalThis: this._globalObject }),
-            variables: Object.assign(Object.assign({}, this._library.tagSpecificApi), { this: (ctx) => (ctx.bot ? ctx.bot.script : null), thisBot: (ctx) => (ctx.bot ? ctx.bot.script : null), bot: (ctx) => (ctx.bot ? ctx.bot.script : null), tags: (ctx) => (ctx.bot ? ctx.bot.script.tags : null), raw: (ctx) => (ctx.bot ? ctx.bot.script.raw : null), masks: (ctx) => (ctx.bot ? ctx.bot.script.masks : null), creatorBot: (ctx) => ctx.creator, configBot: () => this.context.playerBot }),
+            variables: Object.assign(Object.assign({}, this._library.tagSpecificApi), { this: (ctx) => (ctx.bot ? ctx.bot.script : null), thisBot: (ctx) => (ctx.bot ? ctx.bot.script : null), bot: (ctx) => (ctx.bot ? ctx.bot.script : null), tags: (ctx) => (ctx.bot ? ctx.bot.script.tags : null), raw: (ctx) => (ctx.bot ? ctx.bot.script.raw : null), masks: (ctx) => (ctx.bot ? ctx.bot.script.masks : null), creatorBot: (ctx) => ctx.creator, configBot: () => this.context.playerBot, links: (ctx) => (ctx.bot ? ctx.bot.script.links : null) }),
             arguments: [['that', 'data']],
         });
         if (hasValue(bot)) {