@rtsdk/topia 0.8.5 → 0.9.0

package/dist/index.d.ts

@@ -64,6 +64,16 @@ type ResponseType$1 = {
 declare class Scene extends SDKController implements SceneInterface {
     readonly id: string;
     constructor(topia: Topia, id: string, options?: SceneOptionalInterface);
+    /**
+     * @summary
+     * Retrieves scene details.
+     *
+     * @usage
+     * ```ts
+     * await scene.fetchSceneById();
+     * const { name } = scene;
+     * ```
+     */
     fetchSceneById(): Promise<void | ResponseType$1>;
 }
 
@@ -137,6 +147,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     setDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -156,6 +167,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -176,6 +188,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -662,6 +675,7 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     setDataObject: (dataObject: object | null | undefined, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -682,6 +696,7 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     updateDataObject: (dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -702,6 +717,7 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -771,16 +787,33 @@ declare class User extends SDKController implements UserInterface {
     /**
      * @summary
      * Returns all assets owned by User when an email address is provided.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchAssets();
+     * const userAssets = user.assets;
+     * ```
      */
     fetchAssets(): Promise<void | ResponseType$1>;
     /**
      * @summary
-     * Returns all platform assets
+     * Returns all platform assets.
+     *
+     * @usage
+     * ```ts
+     * const assets = await user.fetchPlatformAssets();
+     * ```
      */
     fetchPlatformAssets(): Promise<object | ResponseType$1>;
     /**
      * @summary
-     * Returns all scenes owned by User
+     * Returns all scenes owned by User.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchScenes();
+     * const userScenes = user.scenes;
+     * ```
      */
     fetchScenes(): Promise<void | ResponseType$1>;
     /**
@@ -849,6 +882,7 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -868,6 +902,7 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -888,6 +923,7 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1035,6 +1071,7 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1054,6 +1091,7 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1074,6 +1112,7 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
+        analytics?: string[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1563,7 +1602,18 @@ declare abstract class SDKController implements SDKInterface {
  */
 declare class Asset extends SDKController implements AssetInterface {
     readonly id?: string;
+    urlSlug?: string;
     constructor(topia: Topia, id: string, options?: AssetOptionalInterface);
+    /**
+     * @summary
+     * Retrieves platform asset details.
+     *
+     * @usage
+     * ```ts
+     * await asset.fetchAssetById();
+     * const { assetName } = asset;
+     * ```
+     */
     fetchAssetById(): Promise<object | ResponseType$1>;
 }
 
@@ -1650,21 +1700,89 @@ declare class WorldActivity extends SDKController {
     moveVisitors(visitorsToMove: VisitorsToMoveArrayType): Promise<(void | ResponseType$1)[]>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Asset = new AssetFactory(myTopiaInstance);
+ * ```
+ */
 declare class AssetFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of Asset class.
+     *
+     * @usage
+     * ```
+     * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: string, options?: AssetOptionalInterface): Asset;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
+ * ```
+ */
 declare class DroppedAssetFactory extends SDKController {
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of DroppedAsset class.
+     *
+     * @usage
+     * ```
+     * const droppedAssetInstance = await DroppedAsset.create(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): DroppedAsset;
+    /**
+     * @summary
+     * Instantiate a new instance of DroppedAsset class and retrieve all properties.
+     *
+     * @usage
+     * ```
+     * const droppedAssetInstance = await DroppedAsset.get(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     get(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): Promise<DroppedAsset>;
+    /**
+     * @summary
+     * Searches dropped assets within a world by a provide `uniqueName`. If a single match is found, a new instance of DroppedAsset class is returned all properties.
+     *
+     * @usage
+     * ```
+     * const droppedAssetInstance = await DroppedAsset.getWithUniqueName("exampleUniqueName", urlSlug, { interactivePublicKey, interactiveSecret });
+     * ```
+     */
     getWithUniqueName(uniqueName: string, urlSlug: string, credentials: {
         apiKey?: string;
         interactivePublicKey?: string;
         interactiveSecret?: string;
     }): Promise<DroppedAsset>;
+    /**
+     * @summary
+     * Drops an asset in a world and returns a new instance of DroppedAsset class with all properties.
+     *
+     * @usage
+     * ```
+     * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * const droppedAssetInstance = await DroppedAsset.get(assetInstance, {
+          assetScale: 1.5,
+          flipped: true,
+          layer0: "",
+          layer1: "https://pathtoimage.png",
+          interactivePublicKey,
+          isInteractive: true,
+          position: { x: 0, y: 0 },
+          uniqueName: "exampleUniqueName",
+          urlSlug,
+        });
+     * ```
+     */
     drop(asset: Asset, { assetScale, flipped, interactivePublicKey, isInteractive, layer0, layer1, position: { x, y }, sceneDropId, text, textColor, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }: {
         assetScale?: number;
         flipped?: boolean;
@@ -1688,35 +1806,137 @@ declare class DroppedAssetFactory extends SDKController {
     }): Promise<DroppedAsset>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Scene = new SceneFactory(myTopiaInstance);
+ * ```
+ */
 declare class SceneFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of Scene class.
+     *
+     * @usage
+     * ```
+     * const sceneInstance = await Scene.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: string, options?: SceneOptionalInterface): Scene;
+    /**
+     * @summary
+     * Instantiate a new instance of Scene class and retrieve all properties.
+     *
+     * @usage
+     * ```
+     * const sceneInstance = await Scene.get(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     get(id: string, options?: SceneOptionalInterface): Promise<Scene>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const User = new UserFactory(myTopiaInstance);
+ * ```
+ */
 declare class UserFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of User class.
+     *
+     * @usage
+     * ```
+     * const userInstance = await User.create({ credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(options?: UserOptionalInterface): User;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Visitor = new VisitorFactory(myTopiaInstance);
+ * ```
+ */
 declare class VisitorFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of Visitor class.
+     *
+     * @usage
+     * ```
+     * const visitorInstance = await Visitor.create(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id: number, urlSlug: string, options?: VisitorOptionalInterface): Visitor;
+    /**
+     * @summary
+     * Instantiate a new instance of Visitor class and retrieve all properties.
+     *
+     * @usage
+     * ```
+     * const visitorInstance = await Visitor.get(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     get(id: number, urlSlug: string, options?: VisitorOptionalInterface): Promise<Visitor>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const WorldActivity = new WorldActivityFactory(myTopiaInstance);
+ * ```
+ */
 declare class WorldActivityFactory {
     topia: Topia;
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of WorldActivity class.
+     *
+     * @usage
+     * ```
+     * const worldActivityInstance = await WorldActivity.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(urlSlug: string, options?: WorldOptionalInterface): WorldActivity;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const World = new WorldFactory(myTopiaInstance);
+ * ```
+ */
 declare class WorldFactory extends SDKController {
     constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of World class.
+     *
+     * @usage
+     * ```
+     * const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(urlSlug: string, options?: WorldOptionalInterface): World;
+    /**
+     * @summary
+     * Deletes an array of Dropped Assets from within a world and returns success: true
+     *
+     * @usage
+     * ```
+     * await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactiveNonce, interactivePublicKey, visitorId });
+     * ```
+     */
     deleteDroppedAssets(urlSlug: string, droppedAssetIds: string[], credentials: {
         apiKey?: string;
         interactivePublicKey?: string;