@casual-simulation/aux-runtime 4.2.3-alpha.24207542449 → 4.2.3-alpha.24530182529

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casual-simulation/aux-runtime",
-  "version": "4.2.3-alpha.24207542449",
+  "version": "4.2.3-alpha.24530182529",
   "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.3-alpha.24207542449",
-    "@casual-simulation/aux-records": "^4.2.3-alpha.24207542449",
+    "@casual-simulation/aux-common": "^4.2.3-alpha.24530182529",
+    "@casual-simulation/aux-records": "^4.2.3-alpha.24530182529",
     "@casual-simulation/crypto": "^4.0.5",
     "@casual-simulation/engine262": "0.0.1-4de2170374e22761996e46eb1362f4496ee57f8f",
     "@casual-simulation/error-stack-parser": "^2.0.7",

package/runtime/AuxLibrary.d.ts

@@ -1,8 +1,8 @@
 import type { AuxGlobalContext } from './AuxGlobalContext';
 import { DEBUG_STRING } from './AuxGlobalContext';
 import type { BotTags, Bot, ShowChatOptions, BotAction, BotsState, CameraType, BarcodeFormat, PortalType, ShowInputOptions, 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, ReplaceDragBotAction, ShowInputForTagAction, GoToDimensionAction, GoToURLAction, OpenURLAction, OpenConsoleAction, RejectAction, FocusOnOptions, SnapTarget, AddDropSnapTargetsAction, RecordingOptions, Recording, SyntheticVoice, EnablePOVAction, EnableCustomDraggingAction, SetAppOutputAction, PartialBotsState, ParsedBotLink, ConvertGeolocationToWhat3WordsOptions, BeginAudioRecordingAction, MediaPermssionOptions, ImageClassifierOptions, ClassifyImagesOptions, ClassifyImagesResult, AddDropGridTargetsAction, InstUpdate, StartFormAnimationOptions, StopFormAnimationOptions, FormAnimationData, WakeLockConfiguration, EnableXROptions, ShowConfirmOptions, ShowAlertOptions, StoredAux, Geolocation, OpenPhotoCameraOptions, Photo, Point2D, RecordLoomOptions, LoomVideo, LoomVideoEmbedMetadata, InstallAuxFileMode, LoadServerConfigAction, InstConfig, UnloadServerConfigAction, Point3D, MapLayer, DynamicListener, TrackConfigBotTagsAction, GenerateQRCodeOptions, ConfigureTypeCheckingOptions } from '@casual-simulation/aux-common/bots';
-import type { AIChatOptions, AIGenerateSkyboxOptions, AIGenerateImageOptions, JoinRoomActionOptions, RoomOptions, RoomTrackOptions, SetRoomTrackOptions, RoomRemoteOptions, DataRecordOptions, RecordActionOptions, ListDataOptions, AISloydGenerateModelOptions, ListWebhooksOptions, ListNotificationsOptions, SendNotificationOptions, GrantEntitlementsRequest, GrantEntitlementsResult, InstallPackageResult, ListPermissionsRequest, ListedChatModel, StoreItem, PurchasableItemReference, InstallPackageOptions, AIListChatModelsOptions } from './RecordsEvents';
-import type { RemoteAction, AvailablePermissions, Entitlement, VersionNumber, GenericResult, SimpleError, JSONAccountBalance } from '@casual-simulation/aux-common';
+import type { AIChatOptions, AIGenerateSkyboxOptions, AIGenerateImageOptions, JoinRoomActionOptions, RoomOptions, RoomTrackOptions, SetRoomTrackOptions, RoomRemoteOptions, DataRecordOptions, RecordActionOptions, ListDataOptions, AISloydGenerateModelOptions, ListWebhooksOptions, ListNotificationsOptions, SendNotificationOptions, GrantEntitlementsRequest, GrantEntitlementsResult, InstallPackageResult, ListPermissionsRequest, ListedChatModel, StoreItem, PurchasableItemReference, InstallPackageOptions, GetAccountBalancesActionOptions, AIListChatModelsOptions } from './RecordsEvents';
+import type { RemoteAction, AvailablePermissions, Entitlement, VersionNumber, GenericResult, SimpleError } from '@casual-simulation/aux-common';
 import '@casual-simulation/aux-common/polyfill/Array.first.polyfill';
 import '@casual-simulation/aux-common/polyfill/Array.last.polyfill';
 import { isAsymmetricKeypair, isAsymmetricEncrypted, isEncrypted } from '@casual-simulation/crypto';
@@ -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 } 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 } from '@casual-simulation/aux-records';
 import { DateTime } from 'luxon';
 import * as hooks from 'preact/hooks';
 import { render, createRef, createContext } from 'preact';
@@ -47,6 +47,33 @@ export interface APIPurchaseContractRequest {
     returnUrl: string;
     successUrl: string;
 }
+/**
+ * Defines an interface that represents the options for purchasing credits for an account.
+ *
+ * @dochash types/records/extra
+ * @docname PurchaseCreditsRequest
+ * @docid PurchaseCreditsRequest
+ */
+export interface APIPurchaseCreditsRequest {
+    /**
+     * The ID of the user that the credits should be purchased for.
+     * Currently, credits can only be purchased for yourself.
+     */
+    targetUserId?: string;
+    /**
+     * The ID of the studio that the credits should be purchased for.
+     * Currently, only studio admins can purchase credits.
+     */
+    targetStudioId?: string;
+    /**
+     * The URL that the user should be sent to if they cancel the purchase.
+     */
+    returnUrl: string;
+    /**
+     * The URL that the user should be sent to if the purchase completes successfully.
+     */
+    successUrl: string;
+}
 export interface APIInvoiceContractRequest {
     contractId: string;
     amount: number;
@@ -2879,7 +2906,8 @@ export declare function createDefaultLibrary(context: AuxGlobalContext): {
             listInvoices: (contractId: string, options?: RecordActionOptions) => Promise<GenericResult<ContractInvoice[], SimpleError>>;
             payInvoice: (invoiceId: string, options?: RecordActionOptions) => Promise<GenericResult<void, SimpleError>>;
             payout: (request: APIPayoutRequest, options?: RecordActionOptions) => Promise<GenericResult<void, SimpleError>>;
-            getAccountBalances: (options?: RecordActionOptions) => Promise<GenericResult<JSONAccountBalance, SimpleError>>;
+            getAccountBalances: (options?: GetAccountBalancesActionOptions) => Promise<GenericResult<JSONAccountBalancesAndSubscriptionInfo, SimpleError>>;
+            purchaseCredits: (request: APIPurchaseCreditsRequest, options?: RecordActionOptions) => Promise<PurchaseCreditsResult>;
         };
         portal: {
             registerPrefix: (prefix: string, options?: RegisterPrefixOptions) => Promise<void>;

package/runtime/AuxLibrary.js

@@ -828,6 +828,7 @@ export function createDefaultLibrary(context) {
                 payInvoice: xpPayInvoice,
                 payout: xpPayout,
                 getAccountBalances: xpGetAccountBalances,
+                purchaseCredits: xpPurchaseCredits,
             },
             portal: {
                 registerPrefix,
@@ -5359,19 +5360,85 @@ export function createDefaultLibrary(context) {
         return addAsyncAction(task, event);
     }
     /**
-     * Attempts to retrieve the account balances for the user's account.
+     * Attempts to retrieve the account balances for the account.
      *
      * @param options The options for the request.
      * @returns A promise that resolves with the account balances.
      *
+     * @example Get the current user's account balances and log them to the console.
+     * const balancesResult = await xp.getAccountBalances();
+     * console.log(balancesResult);
+     *
+     * @example Get the account balances for a studio
+     * const balances = await xp.getAccountBalances({
+     *  studioId: "myStudioId"
+     * });
+     *
+     * @example Get the account balances for a contract
+     * const balances = await xp.getAccountBalances({
+     *  contractId: "myContractId"
+     * });
+     *
      * @dochash actions/xp
      * @docname xp.getAccountBalances
      */
     function xpGetAccountBalances(options = {}) {
         const task = context.createTask();
+        const { userId, studioId, contractId, ...rest } = options;
         const event = recordsCallProcedure({
             getBalances: {
-                input: {},
+                input: {
+                    userId,
+                    studioId,
+                    contractId,
+                },
+            },
+        }, rest, task.taskId);
+        return addAsyncAction(task, event);
+    }
+    /**
+     * Creates a new checkout session that can be used to purchase credits for an account. Returns a promise which resolves with the URL that the user should be redirected to in order to complete the purchase.
+     *
+     * @param options The options for the request.
+     * @returns A promise that resolves with the account balances.
+     *
+     * @example Purchase credits for the current user.
+     * const purchaseResult = await xp.purchaseCredits({
+     *   targetUserId: authBot.id,
+     *   returnUrl: configBot.tags.url,
+     *   successUrl: configBot.tags.url
+     * });
+     * if (purchaseResult.success) {
+     *   os.goToURL(purchaseResult.url);
+     * } else {
+     *   os.toast("Failed to create checkout session")
+     * }
+     *
+     * @example Purchase credits for a studio.
+     * const purchaseResult = await xp.purchaseCredits({
+     *   targetUserId: "studioId",
+     *   returnUrl: configBot.tags.url,
+     *   successUrl: configBot.tags.url
+     * });
+     * if (purchaseResult.success) {
+     *   os.goToURL(purchaseResult.url);
+     * } else {
+     *   os.toast("Failed to create checkout session")
+     * }
+     *
+     * @dochash actions/xp
+     * @docname xp.purchaseCredits
+     */
+    function xpPurchaseCredits(request, options = {}) {
+        const task = context.createTask();
+        const event = recordsCallProcedure({
+            purchaseCredits: {
+                input: {
+                    targetUserId: request.targetUserId,
+                    targetStudioId: request.targetStudioId,
+                    returnUrl: request.returnUrl,
+                    successUrl: request.successUrl,
+                },
             },
         }, options, task.taskId);
         return addAsyncAction(task, event);