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

package/runtime/AuxLibrary.js

@@ -11,13 +11,13 @@ 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, publishRecord as calcPublishRecord, DEFAULT_RECORD_SPACE, getRecords as calcGetRecords, requestPermanentAuthToken as calcRequestPermanentAuthToken, deleteRecord, convertToString, GET_TAG_MASKS_SYMBOL, isBotLink, parseBotLink, createBotLink, } 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, recordFile as calcRecordFile, } from '../bots';
 import { sortBy, every, cloneDeep, union, isEqual, flatMap } from 'lodash';
 import { remote as calcRemote, } from '@casual-simulation/causal-trees';
 import { RanOutOfEnergyError } from './AuxResults';
 import '../polyfill/Array.first.polyfill';
 import '../polyfill/Array.last.polyfill';
-import { convertToCopiableValue, embedBase64InPdf, formatAuthToken, getEasing, getEmbeddedBase64FromPdf, } from './Utils';
+import { convertToCopiableValue, embedBase64InPdf, getEasing, getEmbeddedBase64FromPdf, } from './Utils';
 import { sha256 as hashSha256, sha512 as hashSha512, hmac } from 'hash.js';
 import stableStringify from '@casual-simulation/fast-json-stable-stringify';
 import { encrypt as realEncrypt, decrypt as realDecrypt, keypair as realKeypair, sign as realSign, verify as realVerify, asymmetricKeypair as realAsymmetricKeypair, asymmetricEncrypt as realAsymmetricEncrypt, asymmetricDecrypt as realAsymmetricDecrypt, isAsymmetricKeypair, isAsymmetricEncrypted, isEncrypted, } from '@casual-simulation/crypto';
@@ -32,6 +32,7 @@ import { Fragment, h } from 'preact';
 import htm from 'htm';
 import { fromByteArray, toByteArray } from 'base64-js';
 import expect, { iterableEquality } from '@casual-simulation/expect';
+import { parseRecordKey, isRecordKey as calcIsRecordKey, } from '@casual-simulation/aux-records';
 const _html = htm.bind(h);
 const html = ((...args) => {
     return _html(...args);
@@ -130,6 +131,14 @@ export function createDefaultLibrary(context) {
     };
     const webhookFunc = makeMockableFunction(webhook, 'webhook');
     webhookFunc.post = makeMockableFunction(webhook.post, 'webhook.post');
+    const shoutImpl = shout;
+    const shoutProxy = new Proxy(shoutImpl, {
+        get(target, name, reciever) {
+            return (arg) => {
+                return shout(name, arg);
+            };
+        },
+    });
     return {
         api: {
             getBots,
@@ -162,7 +171,7 @@ export function createDefaultLibrary(context) {
             updateBotLinks,
             superShout,
             priorityShout,
-            shout,
+            shout: shoutProxy,
             whisper,
             byTag,
             byID,
@@ -175,10 +184,6 @@ export function createDefaultLibrary(context) {
             byCreator,
             either,
             not,
-            byAuthID,
-            byAddress,
-            withAuthToken,
-            byPrefix,
             remote,
             sendRemoteData: remoteWhisper,
             remoteWhisper,
@@ -285,16 +290,22 @@ export function createDefaultLibrary(context) {
                 unregisterApp,
                 compileApp: setAppContent,
                 requestAuthBot,
-                requestPermanentAuthToken: makeMockableFunction(requestPermanentAuthToken, 'os.requestPermanentAuthToken'),
-                publishRecord: makeMockableFunction(publishRecord, 'os.publishRecord'),
-                getRecords: makeMockableFunction(getRecords, 'os.getRecords'),
-                destroyRecord: makeMockableFunction(destroyRecord, 'os.destroyRecord'),
+                getPublicRecordKey,
+                isRecordKey,
+                recordData,
+                getData,
+                recordFile,
+                getFile,
+                convertGeolocationToWhat3Words,
                 setupInst: setupServer,
                 remotes,
                 instances: servers,
                 remoteCount: serverRemoteCount,
                 totalRemoteCount: totalRemoteCount,
                 instStatuses: serverStatuses,
+                get vars() {
+                    return context.global;
+                },
             },
             portal: {
                 registerPrefix,
@@ -952,50 +963,6 @@ export function createDefaultLibrary(context) {
     function not(filter) {
         return (bot) => !filter(bot);
     }
-    /**
-     * 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) {
-        return {
-            recordFilter: true,
-            authID,
-            [DEBUG_STRING]: debugStringifyFunction('byAuthID', [authID]),
-        };
-    }
-    /**
-     * Creates a record filter that retrieves records with the given address.
-     * @param address The address that the record was stored at.
-     */
-    function byAddress(address) {
-        return {
-            recordFilter: true,
-            address,
-            [DEBUG_STRING]: debugStringifyFunction('byAddress', [address]),
-        };
-    }
-    /**
-     * 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) {
-        return {
-            recordFilter: true,
-            authToken: token,
-            [DEBUG_STRING]: debugStringifyFunction('withAuthToken', [token]),
-        };
-    }
-    /**
-     * 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) {
-        return {
-            recordFilter: true,
-            prefix,
-            [DEBUG_STRING]: debugStringifyFunction('byPrefix', [prefix]),
-        };
-    }
     /**
      * Gets the value of the given tag stored in the given bot.
      * @param bot The bot.
@@ -1984,8 +1951,6 @@ export function createDefaultLibrary(context) {
             let bot = getBot('id', data.userId);
             if (!bot) {
                 bot = context.createBot(createBot(data.userId, {
-                    authToken: formatAuthToken(data.token, data.service),
-                    authBundle: data.service,
                     avatarAddress: data.avatarUrl,
                     name: data.name,
                 }, TEMPORARY_BOT_PARTITION_ID));
@@ -2005,144 +1970,98 @@ export function createDefaultLibrary(context) {
         return addAsyncAction(task, event);
     }
     /**
-     * Requests an auth token that does not expire and can be used to authorize other app bundles to publish records for this app bundle.
+     * Gets an access key for the given public record.
+     * @param name The name of the record.
      */
-    function requestPermanentAuthToken() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const task = context.createTask();
-            const event = calcRequestPermanentAuthToken(task.taskId);
-            const data = yield addAsyncAction(task, event);
-            return formatAuthToken(data.token, data.service);
-        });
+    function getPublicRecordKey(name) {
+        const task = context.createTask();
+        const event = calcGetPublicRecordKey(name, task.taskId);
+        return addAsyncAction(task, event);
     }
     /**
-     * Publishes a record that can be used across instances.
-     * @param recordDefinition The data that should be used to publish the record.
+     * Determines if the given value is a record key.
+     * @param key The value to check.
      */
-    function publishRecord(recordDefinition) {
-        var _a, _b, _c, _d, _e;
-        let address;
-        if ('address' in recordDefinition) {
-            if (!hasValue(recordDefinition.address)) {
-                throw new Error('A non-null or empty address must be used when specifying an address.');
-            }
-            address = recordDefinition.address;
-        }
-        else {
-            if (!hasValue(recordDefinition.prefix)) {
-                if (hasValue(recordDefinition.id)) {
-                    throw new Error('A prefix must be specified when declaring an ID for the record.');
-                }
-                address = uuid();
-            }
-            else {
-                address = `${recordDefinition.prefix}-${(_a = recordDefinition.id) !== null && _a !== void 0 ? _a : uuid()}`;
-            }
-        }
-        const space = (_b = recordDefinition.space) !== null && _b !== void 0 ? _b : DEFAULT_RECORD_SPACE;
-        const token = (_c = recordDefinition.authToken) !== null && _c !== void 0 ? _c : (_e = (_d = context.global.authBot) === null || _d === void 0 ? void 0 : _d.tags) === null || _e === void 0 ? void 0 : _e.authToken;
-        if (!hasValue(token)) {
-            throw new Error('authToken is required when there is no authBot.');
-        }
-        if (!hasValue(recordDefinition.record)) {
-            throw new Error('The record property is required.');
-        }
+    function isRecordKey(key) {
+        return calcIsRecordKey(key);
+    }
+    /**
+     * 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 recordData(recordKey, address, data) {
         const task = context.createTask();
-        const event = calcPublishRecord(token, address, recordDefinition.record, space, task.taskId);
+        const event = calcRecordData(recordKey, address, data, task.taskId);
         return addAsyncAction(task, event);
     }
     /**
-     * Retrives a list of records using the given filters.
-     * @param filters The list of filters that should be used to retrieve some records.
-     *
-     * @example
-     * // Get a record by address
-     * let result = await os.getRecords(byAuthID('myAuthID'), byAddress('myAddress'));
-     */
-    function getRecords(...filters) {
-        var _a, _b, _c, _d, _e;
-        let token = (_c = (_b = (_a = context.global.authBot) === null || _a === void 0 ? void 0 : _a.tags) === null || _b === void 0 ? void 0 : _b.authToken) !== null && _c !== void 0 ? _c : null;
-        let address;
-        let prefix;
-        let authID = (_e = (_d = context.global.authBot) === null || _d === void 0 ? void 0 : _d.id) !== null && _e !== void 0 ? _e : null;
-        let id;
-        let space = 'tempRestricted';
-        for (let filter of filters) {
-            if ('address' in filter) {
-                address = filter.address;
-            }
-            if ('authID' in filter) {
-                authID = filter.authID;
-            }
-            if ('space' in filter) {
-                space = filter.space;
-            }
-            if ('authToken' in filter) {
-                token = filter.authToken;
-            }
-            if ('prefix' in filter) {
-                prefix = filter.prefix;
-            }
-            if ('id' in filter) {
-                id = filter.id;
-            }
+     * 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 getData(recordKeyOrName, address) {
+        let recordName = isRecordKey(recordKeyOrName)
+            ? parseRecordKey(recordKeyOrName)[0]
+            : recordKeyOrName;
+        const task = context.createTask();
+        const event = getRecordData(recordName, address, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * 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.
+     */
+    function recordFile(recordKey, data, options) {
+        if (!hasValue(recordKey)) {
+            throw new Error('A recordKey must be provided.');
         }
-        if (!hasValue(authID)) {
-            throw new Error('An authID must be specified as a filter when there is no authBot.');
-        }
-        if (!hasValue(address) && !hasValue(prefix) && !hasValue(id)) {
-            throw new Error('An address, prefix, or ID must be specified as a filter.');
-        }
-        if (!hasValue(address) && hasValue(prefix) && hasValue(id)) {
-            address = prefix + id;
-        }
-        else if (!hasValue(address) && hasValue(id)) {
-            address = id;
-        }
-        let query = hasValue(address) ? { address } : { prefix };
-        return issueEvent(query);
-        function issueEvent(query) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const task = context.createTask();
-                const event = calcGetRecords(token, authID, space, query, task.taskId);
-                const result = yield addAsyncAction(task, event);
-                return {
-                    records: result.records,
-                    hasMoreRecords: result.hasMoreRecords,
-                    totalCount: result.totalCount,
-                    getMoreRecords: () => __awaiter(this, void 0, void 0, function* () {
-                        if (result.hasMoreRecords && hasValue(result.cursor)) {
-                            return issueEvent(Object.assign(Object.assign({}, query), { cursor: result.cursor }));
-                        }
-                        else {
-                            throw new Error('No more records to retrieve.');
-                        }
-                    }),
-                };
-            });
+        else if (typeof recordKey !== 'string') {
+            throw new Error('recordKey must be a string.');
+        }
+        if (!hasValue(data)) {
+            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);
+        return addAsyncAction(task, event);
     }
     /**
-     * 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.
      */
-    function destroyRecord(record) {
-        var _a, _b, _c;
-        let address;
-        if (!hasValue(record.address)) {
-            throw new Error('the address property is required in order to delete a record.');
+    function getFile(urlOrRecordFileResult) {
+        if (!hasValue(urlOrRecordFileResult)) {
+            throw new Error('A url or successful os.recordFile() result must be provided.');
         }
-        address = record.address;
-        if (!hasValue(record.space)) {
-            throw new Error('the space property is required in order to delete a record.');
+        let url;
+        if (typeof urlOrRecordFileResult === 'string') {
+            url = urlOrRecordFileResult;
         }
-        const space = record.space;
-        const token = (_a = record.authToken) !== null && _a !== void 0 ? _a : (_c = (_b = context.global.authBot) === null || _b === void 0 ? void 0 : _b.tags) === null || _c === void 0 ? void 0 : _c.authToken;
-        if (!hasValue(token)) {
-            throw new Error('authToken is required when there is no authBot.');
+        else {
+            if (!urlOrRecordFileResult.success) {
+                throw new Error('The result must be a successful os.recordFile() result.');
+            }
+            url = urlOrRecordFileResult.url;
         }
+        let promise = webGet(url);
+        let action = promise[ORIGINAL_OBJECT];
+        let final = promise.then((result) => {
+            return result.data;
+        });
+        final[ORIGINAL_OBJECT] = action;
+        return final;
+    }
+    /**
+     * 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.
+     */
+    function convertGeolocationToWhat3Words(location) {
         const task = context.createTask();
-        const event = deleteRecord(token, address, space, task.taskId);
+        const event = calcConvertGeolocationToWhat3Words(location, task.taskId);
         return addAsyncAction(task, event);
     }
     /**