@casual-simulation/aux-runtime 4.2.6 → 4.2.7-alpha.28681314276

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casual-simulation/aux-runtime",
-  "version": "4.2.6",
+  "version": "4.2.7-alpha.28681314276",
   "description": "Runtime for AUX projects",
   "main": "index.js",
   "types": "index.d.ts",
@@ -25,8 +25,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@casual-simulation/aux-common": "^4.2.6",
-    "@casual-simulation/aux-records": "^4.2.6",
+    "@casual-simulation/aux-common": "^4.2.7-alpha.28681314276",
+    "@casual-simulation/aux-records": "^4.2.7-alpha.28681314276",
     "@casual-simulation/crypto": "^4.0.5",
     "@casual-simulation/engine262": "0.0.1-4de2170374e22761996e46eb1362f4496ee57f8f",
     "@casual-simulation/error-stack-parser": "^2.0.7",

package/runtime/AuxDevice.d.ts

@@ -38,5 +38,9 @@ export interface AuxDevice {
      * Null if it was not loaded from a comID.
      */
     comID: string | null;
+    /**
+     * Whether the CasualOS frontend was loaded inside an iframe.
+     */
+    isEmbedded: boolean;
 }
 //# sourceMappingURL=AuxDevice.d.ts.map

package/runtime/AuxLibrary.d.ts

@@ -11,7 +11,7 @@ import '@casual-simulation/aux-common/BlobPolyfill';
 import type { AuxDevice } from './AuxDevice';
 import type { AuxVersion } from './AuxVersion';
 import { Vector3, Vector2, Quaternion, Rotation } from '@casual-simulation/aux-common/math';
-import type { AIChatMessage, CreateRecordResult, GrantResourcePermissionResult, ListStudiosResult, ListRecordsResult, ListSubscriptionsResult, NotificationRecord, PushNotificationPayload, RevokePermissionResult, ListPermissionsResult, SendNotificationResult, SubscribeToNotificationResult, UnsubscribeToNotificationResult, WebhookRecord, CreatePublicRecordKeyResult, GetDataResult, RecordDataResult, RecordFileFailure, EraseDataResult, EraseFileResult, ListDataResult, AddCountResult, GetCountResult, GrantMarkerPermissionResult, GrantRoleResult, RevokeRoleResult, PackageRecord, ListInstalledPackagesResult, ListInstsResult, EraseInstResult, PurchasableItem, PayoutDestination, ContractPricing, JSONAccountBalancesAndSubscriptionInfo, PurchaseCreditsResult } from '@casual-simulation/aux-records';
+import type { AIChatMessage, CreateRecordResult, GrantResourcePermissionResult, ListStudiosResult, ListRecordsResult, ListSubscriptionsResult, NotificationRecord, PushNotificationPayload, RevokePermissionResult, ListPermissionsResult, SendNotificationResult, SubscribeToNotificationResult, UnsubscribeToNotificationResult, WebhookRecord, CreatePublicRecordKeyResult, GetDataResult, RecordDataResult, RecordFileFailure, EraseDataResult, EraseFileResult, ListDataResult, AddCountResult, GetCountResult, GrantMarkerPermissionResult, GrantRoleResult, RevokeRoleResult, PackageRecord, ListInstalledPackagesResult, ListInstsResult, EraseInstResult, PurchasableItem, PayoutDestination, ContractPricing, JSONAccountBalancesAndSubscriptionInfo, PurchaseCreditsResult, SetRecordBudgetResult, GetRecordBudgetResult } from '@casual-simulation/aux-records';
 import { DateTime } from 'luxon';
 import * as hooks from 'preact/hooks';
 import { render, createRef, createContext } from 'preact';
@@ -74,6 +74,36 @@ export interface APIPurchaseCreditsRequest {
      */
     successUrl: string;
 }
+/**
+ * Defines an interface that represents the options for setting a record's budget.
+ *
+ * @dochash types/records/extra
+ * @docname SetRecordBudgetRequest
+ * @docid SetRecordBudgetRequest
+ */
+export interface APISetRecordBudgetRequest {
+    /**
+     * The name of the record that the budget should be set for.
+     */
+    recordName: string;
+    /**
+     * The budget that should be set for the record.
+     * Setting this value to null will clear the budget, causing billing for the record to go to the owner's account.
+     */
+    budget: {
+        /**
+         * The type of the budget.
+         * - "fixed" means that a set number of credits will be transferred to the record from the owner's account upon a subscription credit grant.
+         * - "percent" means that the record will be granted a percentage of the total amount that the owner's account receives upon a subscription credit grant.
+         */
+        type: 'fixed' | 'percent';
+        /**
+         * The budget amount. Can be a string containing a bigint value. Must be an integer.
+         * Must be between 0 and 100 if type is "percent".
+         */
+        amount: number | string;
+    } | null;
+}
 export interface APIInvoiceContractRequest {
     contractId: string;
     amount: number;
@@ -2601,6 +2631,7 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             cancelSound: (soundId: number | string | object) => Promise<any>;
             hasBotInMiniPortal: (bots: Bot | Bot[]) => boolean;
             share: (options: ShareOptions) => Promise<void>;
+            sendEmbedMessage: (message: any, targetOrigin?: string) => Promise<void>;
             closeCircleWipe: (options?: Partial<OpenCircleWipeOptions>) => Promise<void>;
             openCircleWipe: (options?: Partial<OpenCircleWipeOptions>) => Promise<void>;
             addDropSnap: (...targets: SnapTarget[]) => AddDropSnapTargetsAction;
@@ -2908,6 +2939,8 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             payout: (request: APIPayoutRequest, options?: RecordActionOptions) => Promise<GenericResult<void, SimpleError>>;
             getAccountBalances: (options?: GetAccountBalancesActionOptions) => Promise<GenericResult<JSONAccountBalancesAndSubscriptionInfo, SimpleError>>;
             purchaseCredits: (request: APIPurchaseCreditsRequest, options?: RecordActionOptions) => Promise<PurchaseCreditsResult>;
+            setRecordBudget: (request: APISetRecordBudgetRequest, options?: RecordActionOptions) => Promise<SetRecordBudgetResult>;
+            getRecordBudget: (recordName: string, options?: RecordActionOptions) => Promise<GetRecordBudgetResult>;
         };
         portal: {
             registerPrefix: (prefix: string, options?: RegisterPrefixOptions) => Promise<void>;

package/runtime/AuxLibrary.js

@@ -1,5 +1,5 @@
 import { DEBUG_STRING, debugStringifyFunction } from './AuxGlobalContext';
-import { hasValue, trimTag, isBot, BOT_SPACE_TAG, toast as toastMessage, getScriptIssues as scriptIssues, configureTypeChecking as calcConfigureTypeChecking, tip as tipMessage, hideTips as hideTipMessages, showJoinCode as calcShowJoinCode, requestFullscreen, exitFullscreen, promptToInstallPWA as calcPromptToInstallPWA, 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, generateQRCode as calcGenerateQRCode, openBarcodeScanner as calcOpenBarcodeScanner, showBarcode as calcShowBarcode, importAUX as calcImportAUX, showInputForTag as calcShowInputForTag, showInput as calcShowInput, showConfirm as calcShowConfirm, showAlert as calcShowAlert, replaceDragBot as calcReplaceDragBot, goToDimension as calcGoToDimension, goToURL as calcGoToURL, openURL as calcOpenURL, playSound as calcPlaySound, bufferSound as calcBufferSound, cancelSound as calcCancelSound, shell as calcShell, reject as calcReject, localFormAnimation as calcLocalFormAnimation, webhook as calcWebhook, superShout as calcSuperShout, share as calcShare, registerPrefix as calcRegisterPrefix, 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, getRemoteCount, getRemotes, listInstUpdates as calcListInstUpdates, getInstStateFromUpdates as calcGetInstStateFromUpdates, action, 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, signOut as calcSignOut, createBot, defineGlobalBot as calcDefineGlobalBot, TEMPORARY_BOT_PARTITION_ID, convertToString, GET_TAG_MASKS_SYMBOL, isBotLink, parseBotLink, createBotLink, convertGeolocationToWhat3Words as calcConvertGeolocationToWhat3Words, meetCommand as calcMeetCommand, meetFunction as calcMeetFunction, openImageClassifier as calcOpenImageClassifier, classifyImages as calcOpenClassifyImages, isBotDate, DATE_TAG_PREFIX, parseBotDate, realNumberOrDefault, raycastFromCamera as calcRaycastFromCamera, raycastInPortal as calcRaycastInPortal, calculateRayFromCamera as calcCalculateRayFromCamera, bufferFormAddressGltf, startFormAnimation as calcStartFormAnimation, stopFormAnimation as calcStopFormAnimation, listFormAnimations as calcListFormAnimations, calculateStringTagValue, createInitializationUpdate as calcCreateInitalizationUpdate, applyUpdatesToInst as calcApplyUpdatesToInst, configureWakeLock, getWakeLockConfiguration as calcGetWakeLockConfiguration, analyticsRecordEvent as calcAnalyticsRecordEvent, KNOWN_TAGS, isStoredVersion2, getCurrentInstUpdate as calcGetCurrentInstUpdate, openPhotoCamera as calcOpenPhotoCamera, getEasing, enableCollaboration as calcEnableCollaboration, showAccountInfo as calcShowAccountInfo, reportInst as calcReportInst, getRecordsEndpoint as calcGetRecordsEndpoint, ldrawCountAddressBuildSteps as calcLdrawCountAddressBuildSteps, ldrawCountTextBuildSteps as calcLdrawCountTextBuildSteps, calculateViewportCoordinatesFromPosition as calcCalculateViewportCoordinatesFromPosition, calculateScreenCoordinatesFromViewportCoordinates as calcCalculateScreenCoordinatesFromViewportCoordinates, calculateViewportCoordinatesFromScreenCoordinates as calcCalculateViewportCoordinatesFromScreenCoordinates, capturePortalScreenshot as calcCapturePortalScreenshot, createStaticHtml as calcCreateStaticHtmlFromBots, recordLoom, watchLoom, getLoomMetadata, loadSharedDocument, installAuxFile as calcInstallAuxFile, calculateStringListTagValue, calculateScreenCoordinatesFromPosition as calcCalculateScreenCoordinatesFromPosition, addMapLayer as calcAddMapLayer, removeMapLayer as calcRemoveMapLayer, GET_DYNAMIC_LISTENERS_SYMBOL, ADD_BOT_LISTENER_SYMBOL, REMOVE_BOT_LISTENER_SYMBOL, trackConfigBotTags as calcTrackConfigBotTags, } from '@casual-simulation/aux-common/bots';
+import { hasValue, trimTag, isBot, BOT_SPACE_TAG, toast as toastMessage, getScriptIssues as scriptIssues, configureTypeChecking as calcConfigureTypeChecking, tip as tipMessage, hideTips as hideTipMessages, showJoinCode as calcShowJoinCode, requestFullscreen, exitFullscreen, promptToInstallPWA as calcPromptToInstallPWA, 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, generateQRCode as calcGenerateQRCode, openBarcodeScanner as calcOpenBarcodeScanner, showBarcode as calcShowBarcode, importAUX as calcImportAUX, showInputForTag as calcShowInputForTag, showInput as calcShowInput, showConfirm as calcShowConfirm, showAlert as calcShowAlert, replaceDragBot as calcReplaceDragBot, goToDimension as calcGoToDimension, goToURL as calcGoToURL, openURL as calcOpenURL, playSound as calcPlaySound, bufferSound as calcBufferSound, cancelSound as calcCancelSound, shell as calcShell, reject as calcReject, localFormAnimation as calcLocalFormAnimation, webhook as calcWebhook, superShout as calcSuperShout, share as calcShare, sendEmbedMessage as calcSendEmbedMessage, registerPrefix as calcRegisterPrefix, 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, getRemoteCount, getRemotes, listInstUpdates as calcListInstUpdates, getInstStateFromUpdates as calcGetInstStateFromUpdates, action, 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, signOut as calcSignOut, createBot, defineGlobalBot as calcDefineGlobalBot, TEMPORARY_BOT_PARTITION_ID, convertToString, GET_TAG_MASKS_SYMBOL, isBotLink, parseBotLink, createBotLink, convertGeolocationToWhat3Words as calcConvertGeolocationToWhat3Words, meetCommand as calcMeetCommand, meetFunction as calcMeetFunction, openImageClassifier as calcOpenImageClassifier, classifyImages as calcOpenClassifyImages, isBotDate, DATE_TAG_PREFIX, parseBotDate, realNumberOrDefault, raycastFromCamera as calcRaycastFromCamera, raycastInPortal as calcRaycastInPortal, calculateRayFromCamera as calcCalculateRayFromCamera, bufferFormAddressGltf, startFormAnimation as calcStartFormAnimation, stopFormAnimation as calcStopFormAnimation, listFormAnimations as calcListFormAnimations, calculateStringTagValue, createInitializationUpdate as calcCreateInitalizationUpdate, applyUpdatesToInst as calcApplyUpdatesToInst, configureWakeLock, getWakeLockConfiguration as calcGetWakeLockConfiguration, analyticsRecordEvent as calcAnalyticsRecordEvent, KNOWN_TAGS, isStoredVersion2, getCurrentInstUpdate as calcGetCurrentInstUpdate, openPhotoCamera as calcOpenPhotoCamera, getEasing, enableCollaboration as calcEnableCollaboration, showAccountInfo as calcShowAccountInfo, reportInst as calcReportInst, getRecordsEndpoint as calcGetRecordsEndpoint, ldrawCountAddressBuildSteps as calcLdrawCountAddressBuildSteps, ldrawCountTextBuildSteps as calcLdrawCountTextBuildSteps, calculateViewportCoordinatesFromPosition as calcCalculateViewportCoordinatesFromPosition, calculateScreenCoordinatesFromViewportCoordinates as calcCalculateScreenCoordinatesFromViewportCoordinates, calculateViewportCoordinatesFromScreenCoordinates as calcCalculateViewportCoordinatesFromScreenCoordinates, capturePortalScreenshot as calcCapturePortalScreenshot, createStaticHtml as calcCreateStaticHtmlFromBots, recordLoom, watchLoom, getLoomMetadata, loadSharedDocument, installAuxFile as calcInstallAuxFile, calculateStringListTagValue, calculateScreenCoordinatesFromPosition as calcCalculateScreenCoordinatesFromPosition, addMapLayer as calcAddMapLayer, removeMapLayer as calcRemoveMapLayer, GET_DYNAMIC_LISTENERS_SYMBOL, ADD_BOT_LISTENER_SYMBOL, REMOVE_BOT_LISTENER_SYMBOL, trackConfigBotTags as calcTrackConfigBotTags, } from '@casual-simulation/aux-common/bots';
 import { aiChat, aiChatStream, aiListChatModels, aiGenerateSkybox, aiGenerateImage, grantRecordPermission as calcGrantRecordPermission, revokeRecordPermission as calcRevokeRecordPermission, listPermissions as calcListPermissions, grantInstAdminPermission as calcGrantInstAdminPermission, grantUserRole as calcGrantUserRole, revokeUserRole as calcRevokeUserRole, grantInstRole as calcGrantInstRole, revokeInstRole as calcRevokeInstRole, listUserStudios as calcListUserStudios, listStudioRecords as calcListStudioRecords, joinRoom as calcJoinRoom, leaveRoom as calcLeaveRoom, setRoomOptions as calcSetRoomOptions, getRoomOptions as calcGetRoomOptions, getRoomTrackOptions as calcGetRoomTrackOptions, setRoomTrackOptions as calcSetRoomTrackOptions, getRoomRemoteOptions as calcGetRoomRemoteOptions, listDataRecord, recordEvent as calcRecordEvent, getEventCount as calcGetEventCount, getFile as calcGetFile, eraseFile as calcEraseFile, getPublicRecordKey as calcGetPublicRecordKey, recordData as calcRecordData, getRecordData, eraseRecordData, recordFile as calcRecordFile, listDataRecordByMarker, aiHumeGetAccessToken, aiSloydGenerateModel, recordWebhook as calcRecordWebhook, getWebhook as calcGetWebhook, listWebhooks as calcListWebhooks, listWebhooksByMarker as calcListWebhooksByMarker, eraseWebhook as calcEraseWebhook, runWebhook as calcRunWebhook, recordNotification as calcRecordNotification, getNotification as calcGetNotification, listNotifications as calcListNotifications, listNotificationsByMarker as calcListNotificationsByMarker, eraseNotification as calcEraseNotification, subscribeToNotification as calcSubscribeToNotification, unsubscribeFromNotification as calcUnsubscribeFromNotification, sendNotification as calcSendNotification, listNotificationSubscriptions as calcListNotificationSubscriptions, listUserNotificationSubscriptions as calcListUserNotificationSubscriptions, 
 // getXpUserMeta,
 // createXpContract,
@@ -651,6 +651,7 @@ export function createDefaultLibrary(context) {
                 cancelSound,
                 hasBotInMiniPortal,
                 share,
+                sendEmbedMessage,
                 closeCircleWipe,
                 openCircleWipe,
                 addDropSnap,
@@ -829,6 +830,8 @@ export function createDefaultLibrary(context) {
                 payout: xpPayout,
                 getAccountBalances: xpGetAccountBalances,
                 purchaseCredits: xpPurchaseCredits,
+                setRecordBudget: xpSetRecordBudget,
+                getRecordBudget: xpGetRecordBudget,
             },
             portal: {
                 registerPrefix,
@@ -3005,6 +3008,7 @@ export function createDefaultLibrary(context) {
             allowCollaborationUpgrade: null,
             ab1BootstrapUrl: null,
             comID: null,
+            isEmbedded: null,
         };
     }
     /**
@@ -4748,6 +4752,33 @@ export function createDefaultLibrary(context) {
         const event = calcShare(options, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Sends a message to the parent window that this CasualOS instance is embedded in.
+     * Returns a Promise that resolves when the message has been sent.
+     * Throws an error if this CasualOS instance is not embedded in an iframe.
+     *
+     * The message must be structure cloneable (transferrables are not supported).
+     *
+     * @param message the message to send to the parent window.
+     * @param targetOrigin the origin that the parent window must have in order to receive the message. If not specified, then the message will be sent to the parent window regardless of its origin.
+     *
+     * @example Send a message to the parent window.
+     * await os.sendEmbedMessage({ hello: 'world' });
+     *
+     * @example Send a message to the parent window with a specific target origin.
+     * await os.sendEmbedMessage({ hello: 'world' }, 'https://example.com');
+     *
+     * @dochash actions/os/system
+     * @docname os.sendEmbedMessage
+     */
+    function sendEmbedMessage(message, targetOrigin) {
+        if (!context.device?.isEmbedded) {
+            throw new Error('os.sendEmbedMessage() can only be used when CasualOS is embedded in an iframe.');
+        }
+        const task = context.createTask();
+        const event = calcSendEmbedMessage(message, targetOrigin, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Causes a circular wipe animation to close around the screen.
      * This can be used to cover the grid portal while transitioning between scenes.
@@ -5443,6 +5474,78 @@ export function createDefaultLibrary(context) {
         }, options, task.taskId);
         return addAsyncAction(task, event);
     }
+    /**
+     * Sets the budget that should be used to automatically transfer credits from a record's owner to the record's own credit account whenever the owner is granted credits from their subscription.
+     * Setting the budget to null clears it, causing billing for the record to go to the owner's account.
+     * Only studio admins and superUsers are authorized to set a record's budget.
+     *
+     * @param request The options for the request.
+     * @returns A promise that resolves with the result of the request.
+     *
+     * @example Set a fixed record budget
+     * const result = await xp.setRecordBudget({
+     *   recordName: "myRecord",
+     *   budget: {
+     *     type: "fixed",
+     *     amount: 100
+     *   }
+     * });
+     *
+     * @example Set a percent record budget
+     * const result = await xp.setRecordBudget({
+     *   recordName: "myRecord",
+     *   budget: {
+     *     type: "percent",
+     *     amount: 10
+     *   }
+     * });
+     *
+     * @example Clear a record budget
+     * const result = await xp.setRecordBudget({
+     *   recordName: "myRecord",
+     *   budget: null
+     * });
+     *
+     * @dochash actions/xp
+     * @docname xp.setRecordBudget
+     */
+    function xpSetRecordBudget(request, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            setRecordBudget: {
+                input: {
+                    recordName: request.recordName,
+                    budget: request.budget,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Gets the budget that has been configured for the given record.
+     *
+     * @param recordName The name of the record to get the budget for.
+     * @param options The options for the request.
+     * @returns A promise that resolves with the result of the request.
+     *
+     * @example Get a record's budget
+     * const result = await xp.getRecordBudget("myRecord");
+     * console.log(result);
+     *
+     * @dochash actions/xp
+     * @docname xp.getRecordBudget
+     */
+    function xpGetRecordBudget(recordName, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            getRecordBudget: {
+                input: {
+                    recordName,
+                },
+            },
+        }, options, task.taskId);
+        return addAsyncAction(task, event);
+    }
     /**
      * Specifies that the given prefix should be used to indicate that the tag contains script content.
      * Use this function to specify custom prefixes that function similarly to `@` or `🧬`.