@rtsdk/topia 0.18.0 → 0.18.1

package/dist/index.cjs

@@ -43278,7 +43278,7 @@ class Visitor extends User {
     /**
      * Grants an inventory item to this visitor.
      *
-     * @param itemId The ID of the inventory item to grant.
+     * @param item The ID of the inventory item to grant.
      * @param quantity The quantity to grant (default 1).
      *
      * @example
@@ -43313,7 +43313,7 @@ class Visitor extends User {
     /**
      * Modifies the quantity of an inventory item in this visitor's inventory.
      *
-     * @param itemId The ID of the inventory item to modify.
+     * @param item The ID of the inventory item to modify.
      * @param quantity The new quantity to set.
      *
      * @example

package/dist/index.d.ts

@@ -74,7 +74,7 @@ type DroppedAssetLinkType = {
     linkSamlQueryParams?: string;
 };
 
-type InteractiveCredentials$1 = {
+type InteractiveCredentials = {
     apiKey?: string;
     assetId?: string;
     interactiveNonce?: string;
@@ -88,22 +88,22 @@ type InteractiveCredentials$1 = {
 
 type AssetOptions = {
     attributes?: AssetInterface | undefined;
-    credentials?: InteractiveCredentials$1 | undefined;
+    credentials?: InteractiveCredentials | undefined;
 };
 type DroppedAssetOptions = {
     attributes?: DroppedAssetInterface | undefined;
-    credentials?: InteractiveCredentials$1 | undefined;
+    credentials?: InteractiveCredentials | undefined;
 };
 type UserOptions = {
-    credentials?: InteractiveCredentials$1 | undefined;
+    credentials?: InteractiveCredentials | undefined;
 };
 type VisitorOptions = {
     attributes?: VisitorInterface | undefined;
-    credentials?: InteractiveCredentials$1 | undefined;
+    credentials?: InteractiveCredentials | undefined;
 };
 type WorldOptions = {
     attributes?: WorldDetailsInterface | undefined;
-    credentials?: InteractiveCredentials$1 | undefined;
+    credentials?: InteractiveCredentials | undefined;
 };
 
 type ResponseType$1 = {
@@ -2055,7 +2055,7 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Grants an inventory item to this visitor.
      *
-     * @param itemId The ID of the inventory item to grant.
+     * @param item The ID of the inventory item to grant.
      * @param quantity The quantity to grant (default 1).
      *
      * @example
@@ -2069,7 +2069,7 @@ declare class Visitor extends User implements VisitorInterface {
     /**
      * Modifies the quantity of an inventory item in this visitor's inventory.
      *
-     * @param itemId The ID of the inventory item to modify.
+     * @param item The ID of the inventory item to modify.
      * @param quantity The new quantity to set.
      *
      * @example
@@ -2122,7 +2122,7 @@ declare enum WorldActivityType {
 }
 
 interface SDKInterface {
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
     jwt?: string;
     requestOptions: object;
     topia: Topia;
@@ -2159,7 +2159,7 @@ interface AssetInterface extends SDKInterface {
 }
 type AssetOptionalInterface = {
     attributes?: AssetInterface | object;
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
 };
 
 interface DroppedAssetInterface extends AssetInterface {
@@ -2281,7 +2281,7 @@ interface DroppedAssetOptionalInterface {
         text?: string;
         urlSlug?: string;
     };
-    credentials?: InteractiveCredentials$1 | object;
+    credentials?: InteractiveCredentials | object;
 }
 interface UpdateBroadcastInterface {
     assetBroadcast?: boolean;
@@ -2373,7 +2373,7 @@ interface EcosystemInterface {
     incrementDataObjectValue(path: string, amount: number, options: object): Promise<void | ResponseType$1>;
 }
 interface EcosystemOptionalInterface {
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
 }
 
 interface SceneInterface {
@@ -2401,7 +2401,7 @@ interface SceneInterface {
 }
 type SceneOptionalInterface = {
     attributes?: SceneInterface | object;
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
 };
 
 interface FireToastInterface {
@@ -2444,7 +2444,7 @@ interface UserInterface {
     dataObject?: object | null;
 }
 interface UserOptionalInterface {
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
     profileId?: string | null;
     visitorId?: number | null;
     urlSlug?: string;
@@ -2515,7 +2515,7 @@ interface VisitorInterface extends SDKInterface {
 }
 interface VisitorOptionalInterface {
     attributes?: VisitorInterface | object;
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
 }
 interface MoveVisitorInterface {
     shouldTeleportVisitor: boolean;
@@ -2548,12 +2548,12 @@ interface WebRTCConnectorInterface {
     getTwilioConfig(): Promise<void | ResponseType$1>;
 }
 interface WebRTCConnectorOptionalInterface {
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
     twilioConfig?: object;
 }
 
 interface WorldActivityOptionalInterface {
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
 }
 interface MoveAllVisitorsInterface {
     shouldFetchVisitors?: boolean;
@@ -2643,13 +2643,13 @@ interface WorldInterface extends SDKInterface, WorldDetailsInterface {
 }
 interface WorldOptionalInterface {
     attributes?: WorldDetailsInterface | object;
-    credentials?: InteractiveCredentials$1;
+    credentials?: InteractiveCredentials;
 }
 interface WorldWebhooksInterface {
     webhooks: Array<WebhookInterface>;
 }
 
-type InteractiveCredentials = {
+type InteractiveCredentials$1 = {
     apiKey?: string;
     assetId?: string;
     interactiveNonce?: string;
@@ -2678,7 +2678,7 @@ interface InventoryItemInterface extends SDKInterface {
 }
 type InventoryItemOptionalInterface = {
     attributes?: InventoryItemInterface | object;
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 };
 
 /**
@@ -2696,7 +2696,7 @@ interface UserInventoryItemInterface extends InventoryItemInterface {
 }
 type UserInventoryItemOptionalInterface = {
     attributes?: UserInventoryItemInterface | object;
-    credentials?: InteractiveCredentials;
+    credentials?: InteractiveCredentials$1;
 };
 
 /**
@@ -2752,11 +2752,11 @@ declare class Topia implements TopiaInterface {
  * ```
  */
 declare abstract class SDKController implements SDKInterface {
-    credentials: InteractiveCredentials$1 | undefined;
+    credentials: InteractiveCredentials | undefined;
     jwt?: string;
     requestOptions: object;
     topia: Topia;
-    constructor(topia: Topia, credentials?: InteractiveCredentials$1);
+    constructor(topia: Topia, credentials?: InteractiveCredentials);
     topiaPublicApi(): axios.AxiosInstance;
     errorHandler({ error, message, params, sdkMethod, }: {
         error?: Error | AxiosError | unknown;
@@ -3336,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$1): Promise<DroppedAsset>;
+    getWithUniqueName(uniqueName: string, urlSlug: string, interactiveSecret: string, credentials: InteractiveCredentials): Promise<DroppedAsset>;
     /**
      * Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
      *
@@ -3918,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$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 };
+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, 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 };

package/dist/index.js

@@ -43276,7 +43276,7 @@ class Visitor extends User {
     /**
      * Grants an inventory item to this visitor.
      *
-     * @param itemId The ID of the inventory item to grant.
+     * @param item The ID of the inventory item to grant.
      * @param quantity The quantity to grant (default 1).
      *
      * @example
@@ -43311,7 +43311,7 @@ class Visitor extends User {
     /**
      * Modifies the quantity of an inventory item in this visitor's inventory.
      *
-     * @param itemId The ID of the inventory item to modify.
+     * @param item The ID of the inventory item to modify.
      * @param quantity The new quantity to set.
      *
      * @example

package/package.json

@@ -27,6 +27,7 @@
     "rollup-plugin-typescript2": "^0.34.1",
     "ts-jest": "^29.0.3",
     "typedoc": "^0.28.8",
+    "typedoc-plugin-frontmatter": "^1.3.0",
     "typescript": "^5.0.4",
     "yalc": "^1.0.0-pre.53"
   },
@@ -60,5 +61,5 @@
     "yalc-push": "yarn build && yalc publish --push --dev --no-scripts"
   },
   "type": "module",
-  "version": "0.18.00"
+  "version": "0.18.01"
 }