@casual-simulation/aux-runtime 3.8.1 → 3.10.2

package/runtime/RecordsEvents.d.ts

@@ -4,7 +4,7 @@ import type { APPROVED_SYMBOL, AsyncAction, AvailablePermissions, Entitlement, E
 import type { CreateRealtimeSessionTokenRequest } from '@casual-simulation/aux-records/AIOpenAIRealtimeInterface';
 import type { PackageRecordVersionKey, PackageRecordVersionKeySpecifier, PackageRecordVersionWithMetadata } from '@casual-simulation/aux-records/packages/version';
 export type RecordsActions = RecordsAsyncActions;
-export type RecordsAsyncActions = RecordDataAction | GetRecordDataAction | ListRecordDataAction | ListRecordDataByMarkerAction | EraseRecordDataAction | RecordFileAction | GetFileAction | EraseFileAction | RecordEventAction | GetEventCountAction | AIChatAction | AIChatStreamAction | AIGenerateImageAction | AIGenerateSkyboxAction | AIHumeGetAccessTokenAction | AISloydGenerateModelAction | ListUserStudiosAction | GetPublicRecordKeyAction | GrantRecordPermissionAction | RevokeRecordPermissionAction | GrantInstAdminPermissionAction | GrantRoleAction | RevokeRoleAction | JoinRoomAction | LeaveRoomAction | SetRoomOptionsAction | GetRoomOptionsAction | GetRoomTrackOptionsAction | SetRoomTrackOptionsAction | GetRoomRemoteOptionsAction | RecordsCallProcedureAction | SubscribeToNotificationAction | GrantEntitlementsAction | RevokeEntitlementGrantAction | RecordPackageVersionAction | InstallPackageAction | ListInstalledPackagesAction;
+export type RecordsAsyncActions = RecordDataAction | GetRecordDataAction | ListRecordDataAction | ListRecordDataByMarkerAction | EraseRecordDataAction | RecordFileAction | GetFileAction | EraseFileAction | RecordEventAction | GetEventCountAction | AIChatAction | AIChatStreamAction | AIGenerateImageAction | AIGenerateSkyboxAction | AIHumeGetAccessTokenAction | AISloydGenerateModelAction | ListUserStudiosAction | GetPublicRecordKeyAction | GrantRecordPermissionAction | RevokeRecordPermissionAction | GrantInstAdminPermissionAction | GrantRoleAction | RevokeRoleAction | JoinRoomAction | LeaveRoomAction | SetRoomOptionsAction | GetRoomOptionsAction | GetRoomTrackOptionsAction | SetRoomTrackOptionsAction | GetRoomRemoteOptionsAction | RecordsCallProcedureAction | SubscribeToNotificationAction | GrantEntitlementsAction | RevokeEntitlementGrantAction | RecordPackageVersionAction | InstallPackageAction | ListInstalledPackagesAction | RecordStoreItemAction | GetStoreItemAction | EraseStoreItemAction | ListStoreItemsAction | ListStoreItemsByMarkerAction | PurchaseStoreItemAction;
 /**
  * An event that is used to chat with an AI.
  */
@@ -304,6 +304,18 @@ export interface RecordActionOptions {
      */
     endpoint?: string;
 }
+/**
+ * Defines an interface that represents the options for installing a package.
+ *
+ * @dochash types/records/extra
+ * @docname InstallPackageOptions
+ */
+export interface InstallPackageOptions extends RecordActionOptions {
+    /**
+     * Whether to downgrade the package if the installed version is newer than the requested version.
+     */
+    downgrade?: boolean;
+}
 /**
  * Defines an interface that represents the base for actions that deal with records.
  */
@@ -630,7 +642,7 @@ export interface InstallPackageAction extends RecordsAction {
     /**
      * The options for the request.
      */
-    options: RecordActionOptions;
+    options: InstallPackageOptions;
 }
 export type InstallPackageResult = InstallPackageSuccess | InstallPackageFailure;
 export interface InstallPackageSuccess {
@@ -751,6 +763,149 @@ export interface RecordPackageVersionAction extends RecordsAction {
 export interface ListUserStudiosAction extends RecordsAction {
     type: 'list_user_studios';
 }
+export interface RecordStoreItemAction extends RecordsAction {
+    type: 'record_store_item';
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+    /**
+     * The address of the item.
+     */
+    address: string;
+    /**
+     * The item that should be recorded.
+     */
+    item: Omit<StoreItem, 'address'>;
+}
+export interface GetStoreItemAction extends RecordsAction {
+    type: 'get_store_item';
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+    /**
+     * The address of the item.
+     */
+    address: string;
+}
+export interface EraseStoreItemAction extends RecordsAction {
+    type: 'erase_store_item';
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+    /**
+     * The address of the item.
+     */
+    address: string;
+}
+export interface ListStoreItemsAction extends RecordsAction {
+    type: 'list_store_items';
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+    /**
+     * The address to start listing items after.
+     */
+    address: string | null;
+}
+export interface ListStoreItemsByMarkerAction extends Omit<ListStoreItemsAction, 'type'> {
+    type: 'list_store_items_by_marker';
+    /**
+     * The marker that should be used to filter the list.
+     */
+    marker: string;
+}
+export interface PurchaseStoreItemAction extends RecordsAction {
+    type: 'purchase_store_item';
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+    /**
+     * The item that should be purchased.
+     */
+    item: PurchasableItemReference;
+}
+/**
+ * Defines an interface that represents a reference to a store item.
+ *
+ * @dochash types/records/store
+ * @docname PurchasableItemReference
+ * @docid PurchasableItemReference
+ */
+export interface PurchasableItemReference {
+    /**
+     * The address of the item.
+     */
+    address: string;
+    /**
+     * The currency that the item is priced in.
+     */
+    currency: string;
+    /**
+     * The expected cost of the item in the currency's smallest unit (cents, etc.).
+     */
+    cost: number;
+}
+/**
+ * Defines an interface that represents a store item.
+ * That is, an item that can be purchased by a user to grant them a role.
+ *
+ * @dochash types/records/store
+ * @doctitle Store Types
+ * @docdescription Types that are used for store actions.
+ * @docsidebar Store
+ * @docname StoreItem
+ * @docid StoreItem
+ */
+export interface StoreItem {
+    /**
+     * The markers that are associated with the item.
+     */
+    markers: string[];
+    /**
+     * The name of the item.
+     */
+    name: string;
+    /**
+     * The description of the item.
+     */
+    description: string;
+    /**
+     * The list of image URLs that represent the item.
+     */
+    imageUrls: string[];
+    /**
+     * The [3-letter ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) that the item is priced in.
+     *
+     * See https://www.iso.org/iso-4217-currency-codes.html
+     */
+    currency: string;
+    /**
+     * The cost of the item in the currency's smallest unit. (e.g. cents, pence, etc.)
+     * Must be an interger.
+     */
+    cost: number;
+    /**
+     * The [tax code](https://docs.stripe.com/tax/tax-codes) for the item.
+     * Currently only stripe tax codes are supported.
+     *
+     * See https://docs.stripe.com/tax/tax-codes
+     */
+    taxCode?: string | null;
+    /**
+     * The name of the role that the item grants.
+     */
+    roleName: string;
+    /**
+     * The amount of time in miliseconds that the role is granted for after purchase.
+     * If null, then the role is granted forever.
+     */
+    roleGrantTimeMs: number | null;
+}
 /**
  * Defines an interface that represents an action that requests a key to a public record.
  */
@@ -1120,6 +1275,83 @@ export interface RoomRemoteOptions {
      */
     audioLevel: number;
 }
+/**
+ * Defines an interface that represents a reference to a store item.
+ *
+ * @dochash types/records/store
+ * @docname PurchasableItemReference
+ * @docid PurchasableItemReference
+ */
+export interface PurchasableItemReference {
+    /**
+     * The address of the item.
+     */
+    address: string;
+    /**
+     * The currency that the item is priced in.
+     */
+    currency: string;
+    /**
+     * The expected cost of the item in the currency's smallest unit (cents, etc.).
+     */
+    cost: number;
+}
+/**
+ * Defines an interface that represents a store item.
+ * That is, an item that can be purchased by a user to grant them a role.
+ *
+ * @dochash types/records/store
+ * @doctitle Store Types
+ * @docdescription Types that are used for store actions.
+ * @docsidebar Store
+ * @docname StoreItem
+ * @docid StoreItem
+ */
+export interface StoreItem {
+    /**
+     * The markers that are associated with the item.
+     */
+    markers: string[];
+    /**
+     * The name of the item.
+     */
+    name: string;
+    /**
+     * The description of the item.
+     */
+    description: string;
+    /**
+     * The list of image URLs that represent the item.
+     */
+    imageUrls: string[];
+    /**
+     * The [3-letter ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) that the item is priced in.
+     *
+     * See https://www.iso.org/iso-4217-currency-codes.html
+     */
+    currency: string;
+    /**
+     * The cost of the item in the currency's smallest unit. (e.g. cents, pence, etc.)
+     * Must be an interger.
+     */
+    cost: number;
+    /**
+     * The [tax code](https://docs.stripe.com/tax/tax-codes) for the item.
+     * Currently only stripe tax codes are supported.
+     *
+     * See https://docs.stripe.com/tax/tax-codes
+     */
+    taxCode?: string | null;
+    /**
+     * The name of the role that the item grants.
+     */
+    roleName: string;
+    /**
+     * The amount of time in miliseconds that the role is granted for after purchase.
+     * If null, then the role is granted forever.
+     */
+    roleGrantTimeMs: number | null;
+}
 /**
  * Creates a new AIChatAction.
  *
@@ -1459,6 +1691,16 @@ export declare function listNotificationSubscriptions(recordName: string, addres
  * @param taskId The ID of the task.
  */
 export declare function listUserNotificationSubscriptions(options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+export interface xpUserIdQuery {
+    /** The auth user Id of the xp user. */
+    userId?: string;
+    /** The xp user Id of the xp user. */
+    xpId?: string;
+}
+/**
+ * Possible statuses for an xp contract.
+ */
+export type xpContractStatus = 'open' | 'draft' | 'closed';
 /**
  * Creates a RecordFileAction.
  * @param recordKey The key that should be used to access the record.
@@ -1540,6 +1782,56 @@ export declare function listUserStudios(options: RecordActionOptions, taskId?: n
  * @param taskId The ID of the task.
  */
 export declare function listStudioRecords(studioId: string, options: RecordActionOptions, taskId?: number | string): RecordsCallProcedureAction;
+/**
+ * Creates a RecordStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address of the item in the record.
+ * @param item The item.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function recordStoreItem(recordName: string, address: string, item: StoreItem, options: RecordActionOptions, taskId?: number | string): RecordStoreItemAction;
+/**
+ * Creates a GetStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address of the item in the record.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function getStoreItem(recordName: string, address: string, options: RecordActionOptions, taskId?: number | string): GetStoreItemAction;
+/**
+ * Creates a EraseStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address of the item in the record.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function eraseStoreItem(recordName: string, address: string, options: RecordActionOptions, taskId?: number | string): EraseStoreItemAction;
+/**
+ * Creates a EraseStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address to start listing items after.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function listStoreItems(recordName: string, address: string | null, options: RecordActionOptions, taskId?: number | string): ListStoreItemsAction;
+/**
+ * Creates a ListStoreItemsByMarkerAction.
+ * @param recordName The name of the record.
+ * @param marker The marker to filter by.
+ * @param address The address to start listing items after.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export declare function listStoreItemsByMarker(recordName: string, marker: string, address: string | null, options: RecordActionOptions, taskId?: number | string): ListStoreItemsByMarkerAction;
+/**
+ * Creates a PurchaseStoreItemAction.
+ * @param recordName The name of the record.
+ * @param item The item to purchase.
+ * @param options The options to use.
+ * @param taskId The ID of the task.
+ */
+export declare function purchaseStoreItem(recordName: string, item: PurchasableItemReference, options: RecordActionOptions, taskId?: number | string): PurchaseStoreItemAction;
 /**
  * Creates a new JoinRoomAction.
  * @param roomName The name of the room.

package/runtime/RecordsEvents.js

@@ -9,7 +9,7 @@ export function aiChat(messages, options, taskId) {
     return {
         type: 'ai_chat',
         messages,
-        options: options !== null && options !== void 0 ? options : {},
+        options: options ?? {},
         taskId,
     };
 }
@@ -24,7 +24,7 @@ export function aiChatStream(messages, options, taskId) {
     return {
         type: 'ai_chat_stream',
         messages,
-        options: options !== null && options !== void 0 ? options : {},
+        options: options ?? {},
         taskId,
     };
 }
@@ -39,7 +39,7 @@ export function aiListChatModels(options, taskId) {
         aiListChatModels: {
             input: {},
         },
-    }, options !== null && options !== void 0 ? options : {}, taskId);
+    }, options ?? {}, taskId);
 }
 /**
  * Creates a new AIGenerateSkyboxAction.
@@ -53,7 +53,7 @@ export function aiGenerateSkybox(prompt, negativePrompt, options, taskId) {
         type: 'ai_generate_skybox',
         prompt,
         negativePrompt,
-        options: options !== null && options !== void 0 ? options : {},
+        options: options ?? {},
         taskId,
     };
 }
@@ -66,7 +66,7 @@ export function aiGenerateImage(parameters, options, taskId) {
     return {
         type: 'ai_generate_image',
         ...parameters,
-        options: options !== null && options !== void 0 ? options : {},
+        options: options ?? {},
         taskId,
     };
 }
@@ -79,7 +79,7 @@ export function aiHumeGetAccessToken(recordName, options, taskId) {
     return {
         type: 'ai_hume_get_access_token',
         recordName,
-        options: options !== null && options !== void 0 ? options : {},
+        options: options ?? {},
         taskId,
     };
 }
@@ -451,7 +451,7 @@ export function listWebhooks(recordName, startingAddress, options, taskId) {
             input: {
                 recordName,
                 address: startingAddress,
-                sort: options === null || options === void 0 ? void 0 : options.sort,
+                sort: options?.sort,
             },
         },
     }, options, taskId);
@@ -470,7 +470,7 @@ export function listWebhooksByMarker(recordName, marker, startingAddress, option
             input: {
                 recordName,
                 address: startingAddress,
-                sort: options === null || options === void 0 ? void 0 : options.sort,
+                sort: options?.sort,
                 marker: marker,
             },
         },
@@ -594,7 +594,7 @@ export function listNotificationsByMarker(recordName, marker, startingAddress, o
                 recordName,
                 marker,
                 address: startingAddress,
-                sort: options === null || options === void 0 ? void 0 : options.sort,
+                sort: options?.sort,
             },
         },
     }, options, taskId);
@@ -631,7 +631,7 @@ export function sendNotification(recordName, address, payload, options, taskId)
                 recordName,
                 address,
                 payload,
-                topic: options === null || options === void 0 ? void 0 : options.topic,
+                topic: options?.topic,
             },
         },
     }, options, taskId);
@@ -666,6 +666,72 @@ export function listUserNotificationSubscriptions(options, taskId) {
         },
     }, options, taskId);
 }
+// /**
+//  * Creates an action that can be used to provide meta data on an auth users Xp (user) identity.
+//  */
+// export function getXpUserMeta(
+//     by: xpUserIdQuery | string | undefined,
+//     options: RecordActionOptions,
+//     taskId: string | number
+// ): RecordsCallProcedureAction {
+//     if (typeof by === 'string') by = { userId: by };
+//     if (!by) by = {};
+//     return recordsCallProcedure(
+//         {
+//             getXpUserMeta: {
+//                 input: {
+//                     ...by,
+//                 },
+//             },
+//         },
+//         options,
+//         taskId
+//     );
+// }
+// /**
+//  * Creates an action that can be used to create a contract between two xp users.
+//  */
+// export function createXpContract(
+//     contractMeta: {
+//         forUser: xpUserIdQuery | string | null;
+//         gigRate: number;
+//         gigs: number;
+//         status: Exclude<xpContractStatus, 'closed'>;
+//         description?: string;
+//         accountCurrency?: string;
+//     },
+//     options: RecordActionOptions,
+//     taskId: string | number
+// ): RecordsCallProcedureAction {
+//     if (typeof contractMeta.forUser === 'string')
+//         contractMeta.forUser = { userId: contractMeta.forUser };
+//     return recordsCallProcedure(
+//         {
+//             createXpContract: {
+//                 input: {
+//                     contract: {
+//                         contractedUserId: contractMeta.forUser,
+//                         gigRate: contractMeta.gigRate,
+//                         gigs: contractMeta.gigs,
+//                         status: contractMeta.status,
+//                         description: contractMeta.description,
+//                         accountCurrency: contractMeta.accountCurrency,
+//                     },
+//                 },
+//             },
+//         },
+//         options,
+//         taskId
+//     );
+// }
+// TODO: Implement this
+// export function issueDraftXpContractToUser(config: {
+//     draftContractId: string;
+//     receivingUserId: string;
+// }): RecordsCallProcedureAction  {
+//     return recordsCallProcedure({
+//     });
+// }
 /**
  * Creates a RecordFileAction.
  * @param recordKey The key that should be used to access the record.
@@ -857,7 +923,7 @@ export function listPackageContainers(recordName, address, options, taskId) {
             input: {
                 recordName,
                 address,
-                sort: options === null || options === void 0 ? void 0 : options.sort,
+                sort: options?.sort,
             },
         },
     }, options, taskId);
@@ -868,7 +934,7 @@ export function listPackageContainersByMarker(recordName, marker, address, optio
             input: {
                 recordName,
                 address,
-                sort: options === null || options === void 0 ? void 0 : options.sort,
+                sort: options?.sort,
                 marker,
             },
         },
@@ -928,6 +994,106 @@ export function listStudioRecords(studioId, options, taskId) {
         },
     }, options, taskId);
 }
+/**
+ * Creates a RecordStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address of the item in the record.
+ * @param item The item.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export function recordStoreItem(recordName, address, item, options, taskId) {
+    return {
+        type: 'record_store_item',
+        recordName,
+        address,
+        item,
+        options,
+        taskId,
+    };
+}
+/**
+ * Creates a GetStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address of the item in the record.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export function getStoreItem(recordName, address, options, taskId) {
+    return {
+        type: 'get_store_item',
+        recordName,
+        address,
+        options,
+        taskId,
+    };
+}
+/**
+ * Creates a EraseStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address of the item in the record.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export function eraseStoreItem(recordName, address, options, taskId) {
+    return {
+        type: 'erase_store_item',
+        recordName,
+        address,
+        options,
+        taskId,
+    };
+}
+/**
+ * Creates a EraseStoreItemAction.
+ * @param recordName The name of the record.
+ * @param address The address to start listing items after.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export function listStoreItems(recordName, address, options, taskId) {
+    return {
+        type: 'list_store_items',
+        recordName,
+        address,
+        options,
+        taskId,
+    };
+}
+/**
+ * Creates a ListStoreItemsByMarkerAction.
+ * @param recordName The name of the record.
+ * @param marker The marker to filter by.
+ * @param address The address to start listing items after.
+ * @param options The options.
+ * @param taskId The ID of the task.
+ */
+export function listStoreItemsByMarker(recordName, marker, address, options, taskId) {
+    return {
+        type: 'list_store_items_by_marker',
+        recordName,
+        address,
+        marker,
+        options,
+        taskId,
+    };
+}
+/**
+ * Creates a PurchaseStoreItemAction.
+ * @param recordName The name of the record.
+ * @param item The item to purchase.
+ * @param options The options to use.
+ * @param taskId The ID of the task.
+ */
+export function purchaseStoreItem(recordName, item, options, taskId) {
+    return {
+        type: 'purchase_store_item',
+        recordName,
+        item,
+        options,
+        taskId,
+    };
+}
 /**
  * Creates a new JoinRoomAction.
  * @param roomName The name of the room.