@casual-simulation/aux-common 3.0.12 → 3.0.14-alpha.2499890262

package/runtime/AuxLibrary.js

@@ -11,7 +11,7 @@ import { DEBUG_STRING, debugStringifyFunction, } from './AuxGlobalContext';
 import { hasValue, trimTag, isBot, BOT_SPACE_TAG, toast as toastMessage, tip as tipMessage, hideTips as hideTipMessages, 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, getAverageFrameRate as calcGetAverageFrameRate, 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, 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, getBotRotation as calcGetBotRotation, isRuntimeBot, SET_TAG_MASK_SYMBOL, CLEAR_TAG_MASKS_SYMBOL, getBotScale, EDIT_TAG_SYMBOL, EDIT_TAG_MASK_SYMBOL, circleWipe, addDropSnap as calcAddDropSnap, addDropGrid as calcAddDropGrid, 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, meetFunction as calcMeetFunction, listDataRecord, recordEvent as calcRecordEvent, getEventCount as calcGetEventCount, openImageClassifier as calcOpenImageClassifier, isBotDate, DATE_TAG_PREFIX, parseBotDate, realNumberOrDefault, } 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, getBotRotation as calcGetBotRotation, isRuntimeBot, SET_TAG_MASK_SYMBOL, CLEAR_TAG_MASKS_SYMBOL, getBotScale, EDIT_TAG_SYMBOL, EDIT_TAG_MASK_SYMBOL, circleWipe, addDropSnap as calcAddDropSnap, addDropGrid as calcAddDropGrid, 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, meetFunction as calcMeetFunction, listDataRecord, recordEvent as calcRecordEvent, getEventCount as calcGetEventCount, openImageClassifier as calcOpenImageClassifier, isBotDate, DATE_TAG_PREFIX, parseBotDate, realNumberOrDefault, joinRoom as calcJoinRoom, leaveRoom as calcLeaveRoom, setRoomOptions as calcSetRoomOptions, getRoomOptions as calcGetRoomOptions, getRoomTrackOptions as calcGetRoomTrackOptions, setRoomTrackOptions as calcSetRoomTrackOptions, getRoomRemoteOptions as calcGetRoomRemoteOptions, } from '../bots';
 import { sortBy, every, cloneDeep, union, isEqual, flatMap } from 'lodash';
 import { remote as calcRemote, } from '@casual-simulation/causal-trees';
 import { RanOutOfEnergyError } from './AuxResults';
@@ -124,6 +124,8 @@ function getBotSnapshot(bot) {
     return b;
 }
 const DEAD_RECKONING_OFFSET = 50;
+const DEG_TO_RAD = Math.PI / 180;
+const RAD_TO_DEG = 180 / Math.PI;
 /**
  * Creates a library that includes the default functions and APIs.
  * @param context The global context that should be used.
@@ -235,8 +237,6 @@ export function createDefaultLibrary(context) {
                 device,
                 isCollaborative,
                 getAB1BootstrapURL,
-                getMediaPermission,
-                getAverageFrameRate,
                 enableAR,
                 disableAR,
                 enableVR,
@@ -346,6 +346,15 @@ export function createDefaultLibrary(context) {
                 getPointerDirection,
                 getInputState,
                 getInputList,
+                getMediaPermission,
+                getAverageFrameRate,
+                joinRoom,
+                leaveRoom,
+                setRoomOptions,
+                getRoomOptions,
+                getRoomTrackOptions,
+                setRoomTrackOptions,
+                getRoomRemoteOptions,
                 registerTagPrefix: registerPrefix,
                 registerApp: registerApp,
                 unregisterApp,
@@ -482,6 +491,8 @@ export function createDefaultLibrary(context) {
                 setRandomSeed,
                 randomInt,
                 random,
+                degreesToRadians,
+                radiansToDegrees,
                 getForwardDirection,
                 intersectPlane,
                 getAnchorPointOffset,
@@ -3892,6 +3903,20 @@ export function createDefaultLibrary(context) {
         }
         return Math.random();
     }
+    /**
+     * Converts the given number of degrees to radians and returns the result.
+     * @param degrees The number of degrees.
+     */
+    function degreesToRadians(degrees) {
+        return degrees * DEG_TO_RAD;
+    }
+    /**
+     * Converts the given number of radians to degrees and returns the result.
+     * @param radians The number of radians.
+     */
+    function radiansToDegrees(radians) {
+        return radians * RAD_TO_DEG;
+    }
     /**
      * Gets the forward direction for the given rotation.
      * @param pointerRotation The rotation that the pointer has represented in radians.
@@ -5353,6 +5378,78 @@ export function createDefaultLibrary(context) {
         const event = calcGetAverageFrameRate(task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Attempts to join the given meeting room.
+     * @param roomName The name of the meeting room to join.
+     * @param options The options for the meeting.
+     */
+    function joinRoom(roomName, options = {}) {
+        const task = context.createTask();
+        const event = calcJoinRoom(roomName, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Attempts to leave the given meeting room.
+     * @param roomName THe name of the meeting room to leave.
+     * @param options The options.
+     */
+    function leaveRoom(roomName, options = {}) {
+        const task = context.createTask();
+        const event = calcLeaveRoom(roomName, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Attempts to set the options for the given meeting room.
+     * Useful for enabling/disabling video, audio, and screensharing.
+     * @param roomName The name of the room.
+     * @param options The options to set. Omitted properties remain unchanged.
+     */
+    function setRoomOptions(roomName, options) {
+        const task = context.createTask();
+        const event = calcSetRoomOptions(roomName, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets the options for the given meeting room.
+     * Returns a promise that resolves with the options.
+     * @param roomName The name of the room that the options should be retrieved for.
+     */
+    function getRoomOptions(roomName) {
+        const task = context.createTask();
+        const event = calcGetRoomOptions(roomName, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets the options for the track with the given address in the given room.
+     * @param roomName The name of the room.
+     * @param address The address of the track that the options should be retrieved for.
+     */
+    function getRoomTrackOptions(roomName, address) {
+        const task = context.createTask();
+        const event = calcGetRoomTrackOptions(roomName, address, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Sets the options for the track with the given address in the given room.
+     * @param roomName The name of the room.
+     * @param address The address of the track that the options should be retrieved for.
+     * @param options The options that should be set for the track.
+     */
+    function setRoomTrackOptions(roomName, address, options) {
+        const task = context.createTask();
+        const event = calcSetRoomTrackOptions(roomName, address, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets the options for the specified remote user in the specified room.
+     * @param roomName The name of the room.
+     * @param remoteId The ID of the remote user.
+     */
+    function getRoomRemoteOptions(roomName, remoteId) {
+        const task = context.createTask();
+        const event = calcGetRoomRemoteOptions(roomName, remoteId, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Runs an event on the given bots.
      * @param name The name of the event to run.