@rtsdk/topia 0.17.9 → 0.18.0

package/dist/index.d.ts

@@ -74,7 +74,7 @@ type DroppedAssetLinkType = {
     linkSamlQueryParams?: string;
 };
 
-type InteractiveCredentials = {
+type InteractiveCredentials$1 = {
     apiKey?: string;
     assetId?: string;
     interactiveNonce?: string;
@@ -88,22 +88,22 @@ type InteractiveCredentials = {
 
 type AssetOptions = {
     attributes?: AssetInterface | undefined;
-    credentials?: InteractiveCredentials | undefined;
+    credentials?: InteractiveCredentials$1 | undefined;
 };
 type DroppedAssetOptions = {
     attributes?: DroppedAssetInterface | undefined;
-    credentials?: InteractiveCredentials | undefined;
+    credentials?: InteractiveCredentials$1 | undefined;
 };
 type UserOptions = {
-    credentials?: InteractiveCredentials | undefined;
+    credentials?: InteractiveCredentials$1 | undefined;
 };
 type VisitorOptions = {
     attributes?: VisitorInterface | undefined;
-    credentials?: InteractiveCredentials | undefined;
+    credentials?: InteractiveCredentials$1 | undefined;
 };
 type WorldOptions = {
     attributes?: WorldDetailsInterface | undefined;
-    credentials?: InteractiveCredentials | undefined;
+    credentials?: InteractiveCredentials$1 | undefined;
 };
 
 type ResponseType$1 = {
@@ -1172,6 +1172,38 @@ declare class World extends SDKController implements WorldInterface {
     }): Promise<void | ResponseType$1>;
 }
 
+/**
+ * Controller for a user's owned inventory item.
+ *
+ * @remarks
+ * This class should be instantiated via UserInventoryItemFactory only.
+ *
+ * @property inventoryItemId - The root inventory item's id
+ */
+declare class UserInventoryItem extends InventoryItem implements UserInventoryItemInterface {
+    userItemId: string;
+    user_id: string;
+    item_id: string;
+    quantity: number;
+    created_at?: Date;
+    updated_at?: Date;
+    metadata?: object | null;
+    grant_source: string;
+    type: string;
+    constructor(topia: Topia, id: string, options?: UserInventoryItemOptionalInterface);
+    /**
+     * Fetches the user inventory item details from the platform and assigns them to this instance.
+     *
+     * @example
+     * ```ts
+     * await userInventoryItem.fetchUserInventoryItemById();
+     * ```
+     *
+     * @returns {Promise<void>} Returns when the item has been fetched and assigned.
+     */
+    fetchUserInventoryItemById(): Promise<void>;
+}
+
 /**
  * Create an instance of User class with optional session credentials.
  *
@@ -1615,6 +1647,53 @@ declare class User extends SDKController implements UserInterface {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType$1>;
+    /**
+     * Retrieves all inventory items owned by this visitor and app's key.
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     *
+     * @example
+     * ```ts
+     * const items = await visitor.fetchInventoryItems();
+     * ```
+     *
+     * @returns {Promise<void>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItems(): Promise<void>;
+    get inventoryItems(): UserInventoryItem[];
+}
+
+/**
+ * InventoryItem represents an item in a user's inventory.
+ *
+ * @remarks
+ * This class should be instantiated via InventoryFactory only.
+ *
+ * @keywords inventory, item, asset, object
+ */
+declare class InventoryItem extends SDKController implements InventoryItemInterface {
+    id: string;
+    name?: string;
+    description?: string;
+    type?: string;
+    created_at?: Date;
+    updated_at?: Date;
+    metadata?: object | null;
+    image_path?: string;
+    interactive_key_id?: string;
+    status?: string;
+    constructor(topia: Topia, id: string, options?: InventoryItemOptionalInterface);
+    /**
+     * Fetches the inventory item details from the platform and assigns them to this instance.
+     *
+     * @example
+     * ```ts
+     * await item.fetchInventoryItemById();
+     * ```
+     *
+     * @returns {Promise<InventoryItem>} Returns when the item has been fetched and assigned.
+     */
+    fetchInventoryItemById(): Promise<InventoryItem>;
 }
 
 /**
@@ -1628,6 +1707,7 @@ declare class User extends SDKController implements UserInterface {
  * ```
  */
 declare class Visitor extends User implements VisitorInterface {
+    #private;
     readonly id: number;
     urlSlug: string;
     user?: User;
@@ -1945,6 +2025,61 @@ declare class Visitor extends User implements VisitorInterface {
     sendSignalToVisitor(signal: any): Promise<void | (ResponseType$1 & {
         answerSignal: any;
     })>;
+    /**
+     * Retrieves all inventory items owned by this visitor and app's key.
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     *
+     * @example
+     * ```ts
+     * const items = await visitor.fetchInventoryItems();
+     * ```
+     *
+     * @returns {Promise<void>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItem(item: InventoryItem): Promise<UserInventoryItem>;
+    /**
+     * Retrieves all inventory items owned by this visitor and app's key.
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, visitor
+     *
+     * @example
+     * ```ts
+     * const items = await visitor.fetchInventoryItems();
+     * ```
+     *
+     * @returns {Promise<void>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItems(): Promise<void>;
+    get inventoryItems(): UserInventoryItem[];
+    /**
+     * Grants an inventory item to this visitor.
+     *
+     * @param itemId The ID of the inventory item to grant.
+     * @param quantity The quantity to grant (default 1).
+     *
+     * @example
+     * ```ts
+     * await visitor.grantInventoryItem("item-id-123", 2);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the updated inventory or a response object.
+     */
+    grantInventoryItem(item: InventoryItem, quantity?: number): Promise<UserInventoryItem>;
+    /**
+     * Modifies the quantity of an inventory item in this visitor's inventory.
+     *
+     * @param itemId The ID of the inventory item to modify.
+     * @param quantity The new quantity to set.
+     *
+     * @example
+     * ```ts
+     * await visitor.modifyInventoryItemQuantity("item-id-123", 5);
+     * ```
+     *
+     * @returns {Promise<UserInventoryItem>} Returns the updated inventory or a response object.
+     */
+    modifyInventoryItemQuantity(item: UserInventoryItem, quantity: number): Promise<UserInventoryItem>;
 }
 
 type VisitorType = {
@@ -1987,7 +2122,7 @@ declare enum WorldActivityType {
 }
 
 interface SDKInterface {
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
     jwt?: string;
     requestOptions: object;
     topia: Topia;
@@ -2024,7 +2159,7 @@ interface AssetInterface extends SDKInterface {
 }
 type AssetOptionalInterface = {
     attributes?: AssetInterface | object;
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 };
 
 interface DroppedAssetInterface extends AssetInterface {
@@ -2146,7 +2281,7 @@ interface DroppedAssetOptionalInterface {
         text?: string;
         urlSlug?: string;
     };
-    credentials?: InteractiveCredentials | object;
+    credentials?: InteractiveCredentials$1 | object;
 }
 interface UpdateBroadcastInterface {
     assetBroadcast?: boolean;
@@ -2238,7 +2373,7 @@ interface EcosystemInterface {
     incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
 }
 interface EcosystemOptionalInterface {
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 }
 
 interface SceneInterface {
@@ -2266,7 +2401,7 @@ interface SceneInterface {
 }
 type SceneOptionalInterface = {
     attributes?: SceneInterface | object;
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 };
 
 interface FireToastInterface {
@@ -2309,7 +2444,7 @@ interface UserInterface {
     dataObject?: object | null;
 }
 interface UserOptionalInterface {
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
     profileId?: string | null;
     visitorId?: number | null;
     urlSlug?: string;
@@ -2332,19 +2467,24 @@ interface VisitorInterface extends SDKInterface {
         name?: string;
     }): Promise<ResponseType$1>;
     getAllParticles(): Promise<ResponseType$1>;
+    fetchInventoryItems(): Promise<void>;
+    inventoryItems: UserInventoryItem[];
+    grantInventoryItem(item: InventoryItem, quantity: number): Promise<UserInventoryItem>;
+    modifyInventoryItemQuantity(item: UserInventoryItem, quantity: number): Promise<UserInventoryItem>;
+    fetchInventoryItem(item: InventoryItem): Promise<UserInventoryItem>;
     triggerParticle({ id, name, duration, }: {
         id?: string;
         name?: string;
         duration?: number;
-        fetchDataObject(appPublicKey?: string, appJWT?: string, sharedAppPublicKey?: string, sharedAppJWT?: string): Promise<void | ResponseType$1>;
-        setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
-        updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
-        incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
-        updatePublicKeyAnalytics(analytics?: AnalyticType[]): Promise<void | ResponseType$1>;
-        sendSignalToVisitor(signal: any): Promise<void | (ResponseType$1 & {
-            answerSignal: any;
-        })>;
     }): Promise<ResponseType$1 | string>;
+    fetchDataObject(appPublicKey?: string, appJWT?: string, sharedAppPublicKey?: string, sharedAppJWT?: string): Promise<void | ResponseType$1>;
+    setDataObject(dataObject: object | null | undefined, options: object): Promise<void | ResponseType$1>;
+    updateDataObject(dataObject: object, options: object): Promise<void | ResponseType$1>;
+    incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
+    updatePublicKeyAnalytics(analytics?: AnalyticType[]): Promise<void | ResponseType$1>;
+    sendSignalToVisitor(signal: any): Promise<void | (ResponseType$1 & {
+        answerSignal: any;
+    })>;
     color?: string;
     dataObject?: object | null | undefined;
     displayName?: string;
@@ -2375,7 +2515,7 @@ interface VisitorInterface extends SDKInterface {
 }
 interface VisitorOptionalInterface {
     attributes?: VisitorInterface | object;
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 }
 interface MoveVisitorInterface {
     shouldTeleportVisitor: boolean;
@@ -2408,12 +2548,12 @@ interface WebRTCConnectorInterface {
     getTwilioConfig(): Promise<void | ResponseType$1>;
 }
 interface WebRTCConnectorOptionalInterface {
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
     twilioConfig?: object;
 }
 
 interface WorldActivityOptionalInterface {
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 }
 interface MoveAllVisitorsInterface {
     shouldFetchVisitors?: boolean;
@@ -2503,12 +2643,62 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
 }
 interface WorldOptionalInterface {
     attributes?: WorldDetailsInterface | object;
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 }
 interface WorldWebhooksInterface {
     webhooks: Array<WebhookInterface>;
 }
 
+type InteractiveCredentials = {
+    apiKey?: string;
+    assetId?: string;
+    interactiveNonce?: string;
+    interactivePublicKey?: string;
+    profileId?: string | null;
+    urlSlug?: string;
+    visitorId?: number;
+    iframeId?: string;
+    gameEngineId?: string;
+};
+
+/**
+ * Interface for an inventory item.
+ */
+interface InventoryItemInterface extends SDKInterface {
+    id: string;
+    name?: string;
+    description?: string;
+    type?: string;
+    created_at?: Date;
+    updated_at?: Date;
+    metadata?: object | null;
+    image_path?: string;
+    interactive_key_id?: string;
+    status?: string;
+}
+type InventoryItemOptionalInterface = {
+    attributes?: InventoryItemInterface | object;
+    credentials?: InteractiveCredentials;
+};
+
+/**
+ * Interface for a user-owned inventory item.
+ */
+interface UserInventoryItemInterface extends InventoryItemInterface {
+    userItemId: string;
+    user_id: string;
+    item_id: string;
+    quantity: number;
+    created_at?: Date;
+    updated_at?: Date;
+    metadata?: object | null;
+    grant_source: string;
+}
+type UserInventoryItemOptionalInterface = {
+    attributes?: UserInventoryItemInterface | object;
+    credentials?: InteractiveCredentials;
+};
+
 /**
  * Create a single instance of Topia axios used for all calls to the public API in all classes
  *
@@ -2562,11 +2752,11 @@ declare class Topia implements TopiaInterface {
  * ```
  */
 declare abstract class SDKController implements SDKInterface {
-    credentials: InteractiveCredentials | undefined;
+    credentials: InteractiveCredentials$1 | undefined;
     jwt?: string;
     requestOptions: object;
     topia: Topia;
-    constructor(topia: Topia, credentials?: InteractiveCredentials);
+    constructor(topia: Topia, credentials?: InteractiveCredentials$1);
     topiaPublicApi(): axios.AxiosInstance;
     errorHandler({ error, message, params, sdkMethod, }: {
         error?: Error | AxiosError | unknown;
@@ -2660,6 +2850,7 @@ declare class Asset extends SDKController implements AssetInterface {
  * ```
  */
 declare class Ecosystem extends SDKController {
+    #private;
     dataObject?: object | null | undefined;
     constructor(topia: Topia, options?: EcosystemOptionalInterface);
     /**
@@ -2778,6 +2969,20 @@ declare class Ecosystem extends SDKController {
             releaseLock?: boolean;
         };
     }): Promise<void | ResponseType$1>;
+    /**
+     * Retrieves all inventory items for a given keyholder (app public key).
+     *
+     * @keywords get, fetch, retrieve, list, inventory, items, keyholder
+     *
+     * @example
+     * ```ts
+     * const items = await ecosystem.fetchInventoryItems("appPublicKey", "appJWT");
+     * ```
+     *
+     * @returns {Promise<object[]>} Returns an array of InventoryItem objects.
+     */
+    fetchInventoryItems(): Promise<void>;
+    get inventoryItems(): InventoryItem[];
 }
 
 /**
@@ -2942,7 +3147,7 @@ declare class WorldActivity extends SDKController {
 declare class AssetFactory extends SDKController {
     constructor(topia: Topia);
     /**
-     * Instantiate a new instance of Asset class with the specified asset ID.
+     * Instantiate a new instance of Asset class with the specified asset id.
      *
      * @remarks
      * This method creates a new Asset controller instance that can be used to interact with an existing asset.
@@ -3104,7 +3309,7 @@ declare class DroppedAssetFactory extends SDKController {
      *
      * @remarks
      * This method leverages the handleGetDroppedAssetByUniqueName endpoint in the Public API and assumes there is exactly one dropped asset with the matching uniqueName for the given urlSlug.
-     * Use this when you need to find a dropped asset by its uniqueName rather than its ID.
+     * Use this when you need to find a dropped asset by its uniqueName rather than its id.
      *
      * @keywords find, search, unique name, retrieve, locate, lookup, dropped asset
      *
@@ -3131,7 +3336,7 @@ declare class DroppedAssetFactory extends SDKController {
      *
      * @returns {Promise<DroppedAsset>} Returns a new DroppedAsset object with all properties already fetched.
      */
-    getWithUniqueName(uniqueName: string, urlSlug: string, interactiveSecret: string, credentials: InteractiveCredentials): Promise<DroppedAsset>;
+    getWithUniqueName(uniqueName: string, urlSlug: string, interactiveSecret: string, credentials: InteractiveCredentials$1): Promise<DroppedAsset>;
     /**
      * Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
      *
@@ -3301,7 +3506,7 @@ declare class SceneFactory {
      *
      * @remarks
      * This method creates a controller instance for working with a scene but does not fetch its properties.
-     * Use this when you need to interact with a specific scene by its ID.
+     * Use this when you need to interact with a specific scene by its id.
      *
      * @keywords create, instantiate, scene, initialize, instance, template
      *
@@ -3369,7 +3574,7 @@ declare class UserFactory {
      *
      * @remarks
      * This method creates a controller instance for interacting with user-specific operations.
-     * The User controller doesn't require an ID since it represents the currently authenticated user.
+     * The User controller doesn't require an id since it represents the currently authenticated user.
      *
      * @keywords create, instantiate, user, initialize, account, profile, member
      *
@@ -3435,7 +3640,7 @@ declare class VisitorFactory {
      *
      * // Create a Visitor instance with credentials
      * const visitorInstance = Visitor.create(
-     *   12345, // visitor ID
+     *   12345, // visitor id
      *   "my-world-slug",
      *   {
      *     credentials: {
@@ -3471,7 +3676,7 @@ declare class VisitorFactory {
      *
      * // Get a fully populated Visitor instance
      * const visitorInstance = await Visitor.get(
-     *   12345, // visitor ID
+     *   12345, // visitor id
      *   "my-world-slug",
      *   {
      *     credentials: {
@@ -3713,4 +3918,4 @@ declare class WorldFactory extends SDKController {
     }>;
 }
 
-export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetLinkType, DroppedAssetMediaType, DroppedAssetMediaVolumeRadius, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, RemoveClickableLinkInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, SetClickableLinkMultiInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateClickableLinkMultiInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
+export { AnalyticType, AnimationMetaType, Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetLinkType, DroppedAssetMediaType, DroppedAssetMediaVolumeRadius, DroppedAssetOptionalInterface, DroppedAssetOptions, Ecosystem, EcosystemFactory, EcosystemInterface, EcosystemOptionalInterface, FireToastInterface, FrameType, InteractiveCredentials$1 as InteractiveCredentials, InventoryItemInterface, InventoryItemOptionalInterface, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, RemoveClickableLinkInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, SetClickableLinkMultiInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateClickableLinkMultiInterface, UpdateDroppedAssetInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserInventoryItemInterface, UserInventoryItemOptionalInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldActivityType, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };