@casual-simulation/aux-common 2.0.32 → 3.0.0-alpha.1826142686

package/runtime/AuxLibrary.js

@@ -8,10 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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, 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, 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, 
+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, getMediaPermission as calcGetMediaPermission, 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, 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, eraseRecordData, recordFile as calcRecordFile, eraseFile as calcEraseFile, meetCommand as calcMeetCommand, } 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, meetCommand as calcMeetCommand, listDataRecord, recordEvent as calcRecordEvent, getEventCount as calcGetEventCount, openImageClassifier as calcOpenImageClassifier, } from '../bots';
 import { sortBy, every, cloneDeep, union, isEqual, flatMap } from 'lodash';
 import { remote as calcRemote, } from '@casual-simulation/causal-trees';
 import { RanOutOfEnergyError } from './AuxResults';
@@ -222,6 +222,7 @@ export function createDefaultLibrary(context) {
                 device,
                 isCollaborative,
                 getAB1BootstrapURL,
+                getMediaPermission,
                 enableAR,
                 disableAR,
                 enableVR,
@@ -244,6 +245,8 @@ export function createDefaultLibrary(context) {
                 closeBarcodeScanner,
                 showBarcode,
                 hideBarcode,
+                openImageClassifier,
+                closeImageClassifier,
                 loadServer,
                 unloadServer,
                 loadInst: loadServer,
@@ -298,11 +301,14 @@ export function createDefaultLibrary(context) {
                 recordManualApprovalData,
                 getData,
                 getManualApprovalData,
+                listData,
                 eraseData,
                 eraseManualApprovalData,
                 recordFile,
                 getFile,
                 eraseFile,
+                recordEvent,
+                countEvents,
                 convertGeolocationToWhat3Words,
                 setupInst: setupServer,
                 remotes,
@@ -1502,6 +1508,25 @@ export function createDefaultLibrary(context) {
         const event = calcShowBarcode(false);
         return addAction(event);
     }
+    /**
+     * Shows an image classifier for the given ML Model.
+     * Returns a promise that resolves when the image classifier has been opened.
+     * @param options The options for the classifier.
+     */
+    function openImageClassifier(options) {
+        const task = context.createTask();
+        const action = calcOpenImageClassifier(true, options, task.taskId);
+        return addAsyncAction(task, action);
+    }
+    /**
+     * Hides the image classifier.
+     * Returns a promise that resolves when the image classifier has been hidden.
+     */
+    function closeImageClassifier() {
+        const task = context.createTask();
+        const action = calcOpenImageClassifier(false, {}, task.taskId);
+        return addAsyncAction(task, action);
+    }
     /**
      * Loads the instance with the given ID.
      * @param id The ID of the inst to load.
@@ -2075,6 +2100,19 @@ export function createDefaultLibrary(context) {
         const event = getRecordData(recordName, address, requiresApproval, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Lists the data stored in the given record starting with the given address.
+     * @param recordKeyOrName The record that the data should be retrieved from.
+     * @param startingAddress The address that the list should start with.
+     */
+    function listData(recordKeyOrName, startingAddress = null) {
+        let recordName = isRecordKey(recordKeyOrName)
+            ? parseRecordKey(recordKeyOrName)[0]
+            : recordKeyOrName;
+        const task = context.createTask();
+        const event = listDataRecord(recordName, startingAddress, 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.
@@ -2189,6 +2227,53 @@ export function createDefaultLibrary(context) {
         const event = calcEraseFile(recordKey, url, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Records that the given event occurred.
+     * @param recordKey The key that should be used to record the event.
+     * @param eventName The name of the event.
+     */
+    function recordEvent(recordKey, eventName) {
+        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(eventName)) {
+            throw new Error('A eventName must be provided.');
+        }
+        else if (typeof eventName !== 'string') {
+            throw new Error('eventName must be a string.');
+        }
+        const task = context.createTask();
+        const event = calcRecordEvent(recordKey, eventName, 1, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets the number of times that the given event has been recorded.
+     * @param recordNameOrKey The name of the record.
+     * @param eventName The name of the event.
+     */
+    function countEvents(recordNameOrKey, eventName) {
+        if (!hasValue(recordNameOrKey)) {
+            throw new Error('A recordNameOrKey must be provided.');
+        }
+        else if (typeof recordNameOrKey !== 'string') {
+            throw new Error('recordNameOrKey must be a string.');
+        }
+        if (!hasValue(eventName)) {
+            throw new Error('A eventName must be provided.');
+        }
+        else if (typeof eventName !== 'string') {
+            throw new Error('eventName must be a string.');
+        }
+        let recordName = isRecordKey(recordNameOrKey)
+            ? parseRecordKey(recordNameOrKey)[0]
+            : recordNameOrKey;
+        const task = context.createTask();
+        const event = calcGetEventCount(recordName, eventName, 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.
@@ -3384,6 +3469,11 @@ export function createDefaultLibrary(context) {
         const action = calcEndRecording(task.taskId);
         return addAsyncAction(task, action);
     }
+    /**
+     * Sends commands to the Jitsi Meet API.
+     * @param command The command to execute.
+     * @param args The args for the command (if any).
+     */
     function meetCommand(command, ...args) {
         return addAction(calcMeetCommand(command, ...args));
     }
@@ -4826,6 +4916,15 @@ export function createDefaultLibrary(context) {
         }
         return user.tags.inputList || [];
     }
+    /**
+     * Gets permission from user to access audio and/or video streams from the device.
+     * @param options The options.
+     */
+    function getMediaPermission(options) {
+        const task = context.createTask();
+        const event = calcGetMediaPermission(options, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Runs an event on the given bots.
      * @param name The name of the event to run.