@casual-simulation/aux-common 2.0.27 → 2.0.31

package/runtime/AuxLibrary.d.ts

@@ -1,5 +1,5 @@
 import { AuxGlobalContext, DEBUG_STRING } from './AuxGlobalContext';
-import { BotTags, Bot, ShowChatOptions, BotAction, BotsState, CameraType, BarcodeFormat, PortalType, ShowInputOptions, StartCheckoutOptions, LocalFormAnimationAction, ShareOptions, Easing, BotAnchorPoint, RuntimeBot, BotSpace, EaseType, RegisterPrefixOptions, OpenCircleWipeOptions, SuperShoutAction, ShowToastAction, ShowJoinCodeAction, RequestFullscreenAction, ExitFullscreenAction, ShowHtmlAction, HideHtmlAction, SetClipboardAction, FocusOnBotAction, ShowChatBarAction, EnableARAction, EnableVRAction, DownloadAction, ShowUploadAuxFileAction, OpenQRCodeScannerAction, ShowQRCodeAction, OpenBarcodeScannerAction, ShowBarcodeAction, LoadServerAction, UnloadServerAction, ImportAUXAction, ReplaceDragBotAction, ShowInputForTagAction, GoToDimensionAction, GoToURLAction, OpenURLAction, OpenConsoleAction, StartCheckoutAction, FinishCheckoutAction, ApplyStateAction, RejectAction, FocusOnOptions, SnapTarget, AddDropSnapTargetsAction, RecordingOptions, Recording, SyntheticVoice, EnablePOVAction, EnableCustomDraggingAction, SetAppOutputAction, Record, RecordReference, PartialBotsState, ParsedBotLink, ConvertGeolocationToWhat3WordsOptions } from '../bots';
+import { BotTags, Bot, ShowChatOptions, BotAction, BotsState, CameraType, BarcodeFormat, PortalType, ShowInputOptions, StartCheckoutOptions, LocalFormAnimationAction, ShareOptions, Easing, BotAnchorPoint, RuntimeBot, BotSpace, EaseType, RegisterPrefixOptions, OpenCircleWipeOptions, SuperShoutAction, ShowToastAction, ShowJoinCodeAction, RequestFullscreenAction, ExitFullscreenAction, ShowHtmlAction, HideHtmlAction, SetClipboardAction, FocusOnBotAction, ShowChatBarAction, EnableARAction, EnableVRAction, DownloadAction, ShowUploadAuxFileAction, OpenQRCodeScannerAction, ShowQRCodeAction, OpenBarcodeScannerAction, ShowBarcodeAction, LoadServerAction, UnloadServerAction, ImportAUXAction, ReplaceDragBotAction, ShowInputForTagAction, GoToDimensionAction, GoToURLAction, OpenURLAction, OpenConsoleAction, StartCheckoutAction, FinishCheckoutAction, ApplyStateAction, RejectAction, FocusOnOptions, SnapTarget, AddDropSnapTargetsAction, RecordingOptions, Recording, SyntheticVoice, EnablePOVAction, EnableCustomDraggingAction, SetAppOutputAction, Record, RecordReference, PartialBotsState, ParsedBotLink, ConvertGeolocationToWhat3WordsOptions, BeginAudioRecordingAction } from '../bots';
 import { RemoteAction } from '@casual-simulation/causal-trees';
 import '../polyfill/Array.first.polyfill';
 import '../polyfill/Array.last.polyfill';
@@ -8,7 +8,7 @@ import './PerformanceNowPolyfill';
 import './BlobPolyfill';
 import { AuxDevice } from './AuxDevice';
 import { AuxVersion } from './AuxVersion';
-import { CreatePublicRecordKeyResult, GetDataResult, RecordDataResult, RecordFileFailure } from '@casual-simulation/aux-records';
+import { CreatePublicRecordKeyResult, GetDataResult, RecordDataResult, RecordFileFailure, EraseDataResult, EraseFileResult } from '@casual-simulation/aux-records';
 /**
  * Defines an interface for a function that provides HTML VDOM capabilities to bots.
  */
@@ -260,39 +260,6 @@ export interface TagSpecificApiOptions {
      */
     config: RuntimeBot;
 }
-/**
- * Defines an interface that represents the list of bots and tags that are included in a bundle.
- */
-export interface BundleModules {
-    [id: string]: Set<string>;
-}
-/**
- * Defines an interface that represents a bundle of code.
- */
-export interface CodeBundle {
-    /**
-     * The tag the bundle was built from.
-     */
-    tag: string;
-    /**
-     * The source code that the bundle contains.
-     * If an error occurred, then this will be null/undefined.
-     */
-    source?: string;
-    /**
-     * The error that occurred while building the bundle.
-     * Null/Undefined if an error did not happen.
-     */
-    error?: string;
-    /**
-     * The list of warnings that occurred while building the bundle.
-     */
-    warnings: string[];
-    /**
-     * The list of modules that the bundle contains.
-     */
-    modules: BundleModules;
-}
 /**
  * Defines an interface that represents a set of records that were retrieved.
  */
@@ -597,12 +564,20 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             getPublicRecordKey: (name: string) => Promise<CreatePublicRecordKeyResult>;
             isRecordKey: (key: unknown) => boolean;
             recordData: (recordKey: string, address: string, data: any) => Promise<RecordDataResult>;
+            recordManualApprovalData: (recordKey: string, address: string, data: any) => Promise<RecordDataResult>;
             getData: (recordKeyOrName: string, address: string) => Promise<GetDataResult>;
+            getManualApprovalData: (recordKeyOrName: string, address: string) => Promise<GetDataResult>;
+            eraseData: (recordKey: string, address: string) => Promise<EraseDataResult>;
+            eraseManualApprovalData: (recordKey: string, address: string) => Promise<EraseDataResult>;
             recordFile: (recordKey: string, data: any, options?: RecordFileOptions) => Promise<RecordFileApiResult>;
             getFile: {
                 (result: RecordFileApiSuccess): Promise<any>;
                 (url: string): Promise<any>;
             };
+            eraseFile: {
+                (recordKey: string, result: RecordFileApiSuccess): Promise<EraseFileResult>;
+                (recordKey: string, url: string): Promise<EraseFileResult>;
+            };
             convertGeolocationToWhat3Words: (location: ConvertGeolocationToWhat3WordsOptions) => Promise<string>;
             setupInst: (inst: string, botOrMod?: Mod) => Promise<any>;
             remotes: () => Promise<string[]>;
@@ -613,6 +588,8 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
                 inst: string;
                 lastUpdateTime: Date;
             }[]>;
+            beginAudioRecording: (options?: Omit<BeginAudioRecordingAction, 'type' | 'taskId'>) => Promise<void>;
+            endAudioRecording: () => Promise<Blob>;
             readonly vars: any;
         };
         portal: {
@@ -715,7 +692,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
                 y: number;
                 z: number;
             };
-            beginAudioRecording: () => Promise<void>;
+            beginAudioRecording: (options?: Omit<BeginAudioRecordingAction, 'type' | 'taskId'>) => Promise<void>;
             endAudioRecording: () => Promise<Blob>;
             beginRecording: (options?: RecordingOptions) => Promise<void>;
             endRecording: () => Promise<Recording>;

package/runtime/AuxLibrary.js

@@ -11,7 +11,7 @@ import { DEBUG_STRING, debugStringifyFunction, } from './AuxGlobalContext';
 import { hasValue, trimTag, isBot, BOT_SPACE_TAG, toast as toastMessage, showJoinCode as calcShowJoinCode, requestFullscreen, exitFullscreen, html as htmlMessage, hideHtml as hideHtmlMessage, setClipboard as calcSetClipboard, tweenTo as calcTweenTo, showChat as calcShowChat, hideChat as calcHideChat, runScript, enableAR as calcEnableAR, disableAR as calcDisableAR, enableVR as calcEnableVR, disableVR as calcDisableVR, showUploadAuxFile as calcShowUploadAuxFile, openQRCodeScanner as calcOpenQRCodeScanner, showQRCode as calcShowQRCode, openBarcodeScanner as calcOpenBarcodeScanner, showBarcode as calcShowBarcode, importAUX as calcImportAUX, showInputForTag as calcShowInputForTag, showInput as calcShowInput, replaceDragBot as calcReplaceDragBot, goToDimension as calcGoToDimension, goToURL as calcGoToURL, openURL as calcOpenURL, checkout as calcCheckout, playSound as calcPlaySound, bufferSound as calcBufferSound, cancelSound as calcCancelSound, setupServer as calcSetupServer, shell as calcShell, backupToGithub as calcBackupToGithub, backupAsDownload as calcBackupAsDownload, finishCheckout as calcFinishCheckout, markHistory as calcMarkHistory, browseHistory as calcBrowseHistory, restoreHistoryMark as calcRestoreHistoryMark, loadFile as calcLoadFile, saveFile as calcSaveFile, reject as calcReject, localFormAnimation as calcLocalFormAnimation, webhook as calcWebhook, superShout as calcSuperShout, share as calcShare, registerPrefix as calcRegisterPrefix, createCertificate as calcCreateCertificate, signTag as calcSignTag, revokeCertificate as calcRevokeCertificate, 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, unlockSpace, getRemoteCount, getServers, getRemotes, action, getServerStatuses, setSpacePassword, exportGpioPin, unexportGpioPin, setGpioPin, getGpioPin, rpioInitPin, rpioExitPin, rpioOpenPin, rpioModePin, rpioReadPin, rpioReadSequencePin, rpioWritePin, rpioWriteSequencePin, rpioReadpadPin, rpioWritepadPin, rpioPudPin, rpioPollPin, rpioClosePin, rpioI2CBeginPin, rpioI2CSetSlaveAddressPin, rpioI2CSetBaudRatePin, rpioI2CSetClockDividerPin, rpioI2CReadPin, rpioI2CWritePin, 
 // rpioI2CReadRegisterRestartPin,
 // rpioI2CWriteReadRestartPin,
-rpioI2CEndPin, rpioPWMSetClockDividerPin, rpioPWMSetRangePin, rpioPWMSetDataPin, rpioSPIBeginPin, rpioSPIChipSelectPin, rpioSPISetCSPolarityPin, rpioSPISetClockDividerPin, rpioSPISetDataModePin, rpioSPITransferPin, rpioSPIWritePin, rpioSPIEndPin, serialConnectPin, serialOpenPin, serialStreamPin, serialUpdatePin, serialWritePin, serialReadPin, serialClosePin, serialFlushPin, serialDrainPin, serialPausePin, serialResumePin, calculateAnchorPoint, calculateAnchorPointOffset, getBotPosition as calcGetBotPosition, isRuntimeBot, SET_TAG_MASK_SYMBOL, CLEAR_TAG_MASKS_SYMBOL, getBotScale, EDIT_TAG_SYMBOL, EDIT_TAG_MASK_SYMBOL, circleWipe, addDropSnap as calcAddDropSnap, 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, getPublicRecordKey as calcGetPublicRecordKey, recordData as calcRecordData, getRecordData, recordFile as calcRecordFile, } from '../bots';
+rpioI2CEndPin, rpioPWMSetClockDividerPin, rpioPWMSetRangePin, rpioPWMSetDataPin, rpioSPIBeginPin, rpioSPIChipSelectPin, rpioSPISetCSPolarityPin, rpioSPISetClockDividerPin, rpioSPISetDataModePin, rpioSPITransferPin, rpioSPIWritePin, rpioSPIEndPin, serialConnectPin, serialOpenPin, serialStreamPin, serialUpdatePin, serialWritePin, serialReadPin, serialClosePin, serialFlushPin, serialDrainPin, serialPausePin, serialResumePin, calculateAnchorPoint, calculateAnchorPointOffset, getBotPosition as calcGetBotPosition, isRuntimeBot, SET_TAG_MASK_SYMBOL, CLEAR_TAG_MASKS_SYMBOL, getBotScale, EDIT_TAG_SYMBOL, EDIT_TAG_MASK_SYMBOL, circleWipe, addDropSnap as calcAddDropSnap, 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, getPublicRecordKey as calcGetPublicRecordKey, recordData as calcRecordData, getRecordData, eraseRecordData, recordFile as calcRecordFile, eraseFile as calcEraseFile, } from '../bots';
 import { sortBy, every, cloneDeep, union, isEqual, flatMap } from 'lodash';
 import { remote as calcRemote, } from '@casual-simulation/causal-trees';
 import { RanOutOfEnergyError } from './AuxResults';
@@ -293,9 +293,14 @@ export function createDefaultLibrary(context) {
                 getPublicRecordKey,
                 isRecordKey,
                 recordData,
+                recordManualApprovalData,
                 getData,
+                getManualApprovalData,
+                eraseData,
+                eraseManualApprovalData,
                 recordFile,
                 getFile,
+                eraseFile,
                 convertGeolocationToWhat3Words,
                 setupInst: setupServer,
                 remotes,
@@ -303,6 +308,8 @@ export function createDefaultLibrary(context) {
                 remoteCount: serverRemoteCount,
                 totalRemoteCount: totalRemoteCount,
                 instStatuses: serverStatuses,
+                beginAudioRecording,
+                endAudioRecording,
                 get vars() {
                     return context.global;
                 },
@@ -1948,10 +1955,14 @@ export function createDefaultLibrary(context) {
     function requestAuthBot() {
         return __awaiter(this, void 0, void 0, function* () {
             const data = yield requestAuthData();
+            if (!data) {
+                return null;
+            }
             let bot = getBot('id', data.userId);
             if (!bot) {
                 bot = context.createBot(createBot(data.userId, {
                     avatarAddress: data.avatarUrl,
+                    avatarPortraitAddress: data.avatarPortraitUrl,
                     name: data.name,
                 }, TEMPORARY_BOT_PARTITION_ID));
             }
@@ -1992,8 +2003,28 @@ export function createDefaultLibrary(context) {
      * @param data The data that should be stored.
      */
     function recordData(recordKey, address, data) {
+        return baseRecordData(recordKey, address, data, false);
+    }
+    /**
+     * Records the given data to the given address inside the record for the given record key.
+     * Requires manual approval in order to read, write, or erase this data.
+     *
+     * @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.
+     */
+    function recordManualApprovalData(recordKey, address, data) {
+        return baseRecordData(recordKey, address, data, true);
+    }
+    /**
+     * 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.
+     */
+    function baseRecordData(recordKey, address, data, requiresApproval) {
         const task = context.createTask();
-        const event = calcRecordData(recordKey, address, data, task.taskId);
+        const event = calcRecordData(recordKey, address, convertToCopiableValue(data), requiresApproval, task.taskId);
         return addAsyncAction(task, event);
     }
     /**
@@ -2002,11 +2033,66 @@ export function createDefaultLibrary(context) {
      * @param address The address that the data is stored at.
      */
     function getData(recordKeyOrName, address) {
+        return baseGetData(recordKeyOrName, address, false);
+    }
+    /**
+     * 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.
+     */
+    function getManualApprovalData(recordKeyOrName, address) {
+        return baseGetData(recordKeyOrName, address, true);
+    }
+    /**
+     * 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.
+     */
+    function baseGetData(recordKeyOrName, address, requiresApproval) {
         let recordName = isRecordKey(recordKeyOrName)
             ? parseRecordKey(recordKeyOrName)[0]
             : recordKeyOrName;
         const task = context.createTask();
-        const event = getRecordData(recordName, address, task.taskId);
+        const event = getRecordData(recordName, address, requiresApproval, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Erases the data stored in the given record at the given address.
+     * @param recordKey The key that should be used to access the record.
+     * @param address The address that the data should be erased from.
+     */
+    function eraseData(recordKey, address) {
+        return baseEraseData(recordKey, address, false);
+    }
+    /**
+     * Erases the data stored in the given record at the given address.
+     *
+     * @param recordKey The key that should be used to access the record.
+     * @param address The address that the data should be erased from.
+     */
+    function eraseManualApprovalData(recordKey, address) {
+        return baseEraseData(recordKey, address, true);
+    }
+    /**
+     * Erases the data stored in the given record at the given address.
+     * @param recordKey The key that should be used to access the record.
+     * @param address The address that the data should be erased from.
+     */
+    function baseEraseData(recordKey, address, requiresApproval) {
+        if (!hasValue(recordKey)) {
+            throw new Error('A recordKey must be provided.');
+        }
+        else if (typeof recordKey !== 'string') {
+            throw new Error('recordKey must be a string.');
+        }
+        if (!hasValue(address)) {
+            throw new Error('A address must be provided.');
+        }
+        else if (typeof address !== 'string') {
+            throw new Error('address must be a string.');
+        }
+        const task = context.createTask();
+        const event = eraseRecordData(recordKey, address, requiresApproval, task.taskId);
         return addAsyncAction(task, event);
     }
     /**
@@ -2026,7 +2112,7 @@ export function createDefaultLibrary(context) {
             throw new Error('data must be provided.');
         }
         const task = context.createTask();
-        const event = calcRecordFile(recordKey, data, options === null || options === void 0 ? void 0 : options.description, options === null || options === void 0 ? void 0 : options.mimeType, task.taskId);
+        const event = calcRecordFile(recordKey, convertToCopiableValue(data), options === null || options === void 0 ? void 0 : options.description, options === null || options === void 0 ? void 0 : options.mimeType, task.taskId);
         return addAsyncAction(task, event);
     }
     /**
@@ -2055,6 +2141,35 @@ export function createDefaultLibrary(context) {
         final[ORIGINAL_OBJECT] = action;
         return final;
     }
+    /**
+     * Deletes the specified file using the given record key.
+     * @param recordKey The key that should be used to delete the file.
+     * @param urlOrRecordFileResult The URL or the successful result of the record file operation.
+     */
+    function eraseFile(recordKey, fileUrlOrRecordFileResult) {
+        if (!hasValue(recordKey)) {
+            throw new Error('A recordKey must be provided.');
+        }
+        else if (typeof recordKey !== 'string') {
+            throw new Error('recordKey must be a string.');
+        }
+        if (!hasValue(fileUrlOrRecordFileResult)) {
+            throw new Error('A url or successful os.recordFile() result must be provided.');
+        }
+        let url;
+        if (typeof fileUrlOrRecordFileResult === 'string') {
+            url = fileUrlOrRecordFileResult;
+        }
+        else {
+            if (!fileUrlOrRecordFileResult.success) {
+                throw new Error('The result must be a successful os.recordFile() result.');
+            }
+            url = fileUrlOrRecordFileResult.url;
+        }
+        const task = context.createTask();
+        const event = calcEraseFile(recordKey, url, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * 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.
@@ -3217,9 +3332,9 @@ export function createDefaultLibrary(context) {
     /**
      * Starts a new audio recording.
      */
-    function beginAudioRecording() {
+    function beginAudioRecording(options) {
         const task = context.createTask();
-        const action = calcBeginAudioRecording(task.taskId);
+        const action = calcBeginAudioRecording(options !== null && options !== void 0 ? options : {}, task.taskId);
         return addAsyncAction(task, action);
     }
     /**