@rtsdk/topia 0.3.8 → 0.4.0

package/README.md

@@ -10,8 +10,22 @@ A Topia provided API Key can be included with every object initialization as a p
 
 ### Want to build interactive assets? This is how you can get started:
 
-- Email developers@metaversecloud.com and Topia wil send you a Public/Private key pair.
-- When you want to make an asset “interactive” add your PUBLIC key to the integrations page of the asset editor. Now webhooks that fire from this asset and iframes that open from this asset include the following values:
+Getting a Key Pair:
+
+- Navigate directly to your [integrations page](https://topia.io/t/dashboard/integrations) or follow the steps below from within a world.
+  - Click on your image (or circle) at the top left of the left hand navbar.
+  - Click Edit Profile. This will bring you to a separate dashboard.
+  - Click Integrations on the left nav
+- Click the “Add Key Pair” button. This is going to be your public / private key pair for your app.
+
+Adding a Key Pair to an asset:
+
+Make an asset “interactive” by adding your PUBLIC key to the integrations page of the asset editor.
+
+- Go back to your world. Make sure you are in “Edit Mode” by toggling on Edit on the left nav bar
+- Hover over any asset. Click the pencil icon that should show up on hover and select “Edit”
+- Go to the Integrations tab
+- At the bottom, you'll see a section that says “Add player session credentials to asset interactions”. Toggle that on. Now webhooks that fire from this asset and iframes that open from this asset will include the following values:
   - assetId
   - interactivePublicKey
   - interactiveNonce

package/dist/index.cjs

@@ -39637,14 +39637,14 @@ const {
  */
 class SDKController {
     constructor(topia, credentials = {}) {
-        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, visitorId = null } = credentials;
+        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, urlSlug = null, visitorId = null, } = credentials;
         this.topia = topia;
         this.credentials = credentials;
         this.requestOptions = {};
         let payload = {};
         const headers = {};
         try {
-            if (topia.interactiveSecret && (profileId || assetId)) {
+            if (topia.interactiveSecret && (profileId || assetId || urlSlug)) {
                 payload = {
                     interactiveNonce,
                     visitorId,
@@ -40049,9 +40049,9 @@ class DroppedAsset extends Asset {
      * await droppedAsset.updatePosition(100,200);
      * ```
      */
-    updatePosition(x, y) {
+    updatePosition(x, y, yOrderAdjust) {
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { x, y }, "set-position");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { x, y, yOrderAdjust }, "set-position");
         }
         catch (error) {
             throw this.errorHandler({ error });
@@ -40267,7 +40267,7 @@ var _World_droppedAssetsMap;
  */
 class World extends SDKController {
     constructor(topia, urlSlug, options = { attributes: {}, credentials: {} }) {
-        super(topia, options.credentials);
+        super(topia, Object.assign({ urlSlug }, options.credentials));
         _World_droppedAssetsMap.set(this, void 0);
         ////////// data objects
         /**
@@ -40534,6 +40534,8 @@ class World extends SDKController {
         });
     }
     /**
+     * @deprecated Use {@link fetchScenes} instead.
+     *
      * @summary
      * Fetch a list of all scene drop ids in a world that include at least one asset with an interactivePublicKey
      *
@@ -40559,6 +40561,46 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Fetch a list of all scene drop ids and dropped assets in a world
+     *
+     * @usage
+     * ```ts
+     * await world.fetchScenes();
+     * ```
+     *
+     * @result
+     * ```ts
+     * { "scenes": {
+     *     "sceneDropId_1": {
+     *         "droppedAssets": {
+     *             "droppedAssetId_1": {
+     *                 "metaName": "hello"
+     *                 "metaNameReversed": "olleh"
+     *             },
+     *             "droppedAssetId_2": {
+     *                 "metaName": "world"
+     *                 "metaNameReversed": "dlorw"
+     *             }
+     *         }
+     *     },
+     *   }
+     * }
+     * ```
+     */
+    fetchScenes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/scenes-with-dropped-assets`, this.requestOptions);
+                this.scenes = response.data;
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
     /**
      * @summary
      * Drops a scene in a world and returns sceneDropId.
@@ -41393,14 +41435,16 @@ class DroppedAssetFactory extends SDKController {
             return droppedAsset;
         });
     }
-    drop(asset, { interactivePublicKey, position: { x, y }, uniqueName, urlSlug, }) {
+    drop(asset, { interactivePublicKey, position: { x, y }, sceneDropId, uniqueName, urlSlug, yOrderAdjust, }) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const response = yield this.topiaPublicApi().post(`/world/${urlSlug}/assets`, {
                     assetId: asset.id,
                     interactivePublicKey,
                     position: { x, y },
+                    sceneDropId,
                     uniqueName,
+                    yOrderAdjust,
                 }, asset.requestOptions);
                 const { id } = response.data;
                 return new DroppedAsset(this.topia, id, urlSlug, { credentials: asset.credentials });

package/dist/index.d.ts

@@ -270,7 +270,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * await droppedAsset.updatePosition(100,200);
      * ```
      */
-    updatePosition(x: number, y: number): Promise<void | ResponseType>;
+    updatePosition(x: number, y: number, yOrderAdjust?: number): Promise<void | ResponseType>;
     /**
      * @summary
      * Updates private zone options for a dropped asset.
@@ -374,6 +374,7 @@ declare class World extends SDKController implements WorldInterface {
     urlSlug: string;
     dataObject?: object | null | undefined;
     sceneDropIds?: [string] | null | undefined;
+    scenes?: [string] | null | undefined;
     webhooks?: WorldWebhooksInterface | null | undefined;
     constructor(topia: Topia, urlSlug: string, options?: WorldOptionalInterface);
     get droppedAssets(): {
@@ -478,6 +479,8 @@ declare class World extends SDKController implements WorldInterface {
      */
     updateCustomTextDroppedAssets(droppedAssetsToUpdate: Array<DroppedAsset>, style: object): Promise<object>;
     /**
+     * @deprecated Use {@link fetchScenes} instead.
+     *
      * @summary
      * Fetch a list of all scene drop ids in a world that include at least one asset with an interactivePublicKey
      *
@@ -492,6 +495,35 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     fetchSceneDropIds(): Promise<object | ResponseType>;
+    /**
+     * @summary
+     * Fetch a list of all scene drop ids and dropped assets in a world
+     *
+     * @usage
+     * ```ts
+     * await world.fetchScenes();
+     * ```
+     *
+     * @result
+     * ```ts
+     * { "scenes": {
+     *     "sceneDropId_1": {
+     *         "droppedAssets": {
+     *             "droppedAssetId_1": {
+     *                 "metaName": "hello"
+     *                 "metaNameReversed": "olleh"
+     *             },
+     *             "droppedAssetId_2": {
+     *                 "metaName": "world"
+     *                 "metaNameReversed": "dlorw"
+     *             }
+     *         }
+     *     },
+     *   }
+     * }
+     * ```
+     */
+    fetchScenes(): Promise<object | ResponseType>;
     /**
      * @summary
      * Drops a scene in a world and returns sceneDropId.
@@ -999,7 +1031,7 @@ interface DroppedAssetInterface extends AssetInterface {
     updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }: UpdateMediaTypeInterface): Promise<void | ResponseType>;
     updateMuteZone(isMutezone: boolean): Promise<void | ResponseType>;
     updateWebhookZone(isWebhookZoneEnabled: boolean): Promise<void | ResponseType>;
-    updatePosition(x: number, y: number): Promise<void | ResponseType>;
+    updatePosition(x: number, y: number, yOrderAdjust: number): Promise<void | ResponseType>;
     updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }: UpdatePrivateZoneInterface): Promise<void | ResponseType>;
     updateScale(assetScale: number): Promise<void | ResponseType>;
     updateUploadedMediaSelected(mediaId: string): Promise<void | ResponseType>;
@@ -1485,14 +1517,16 @@ declare class DroppedAssetFactory extends SDKController {
     constructor(topia: Topia);
     create(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): DroppedAsset;
     get(id: string, urlSlug: string, options?: DroppedAssetOptionalInterface): Promise<DroppedAsset>;
-    drop(asset: Asset, { interactivePublicKey, position: { x, y }, uniqueName, urlSlug, }: {
+    drop(asset: Asset, { interactivePublicKey, position: { x, y }, sceneDropId, uniqueName, urlSlug, yOrderAdjust, }: {
         interactivePublicKey?: string;
         position: {
             x: number;
             y: number;
         };
+        sceneDropId?: string;
         uniqueName?: string;
         urlSlug: string;
+        yOrderAdjust?: number;
     }): Promise<DroppedAsset>;
 }
 

package/dist/index.js

@@ -39635,14 +39635,14 @@ const {
  */
 class SDKController {
     constructor(topia, credentials = {}) {
-        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, visitorId = null } = credentials;
+        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, urlSlug = null, visitorId = null, } = credentials;
         this.topia = topia;
         this.credentials = credentials;
         this.requestOptions = {};
         let payload = {};
         const headers = {};
         try {
-            if (topia.interactiveSecret && (profileId || assetId)) {
+            if (topia.interactiveSecret && (profileId || assetId || urlSlug)) {
                 payload = {
                     interactiveNonce,
                     visitorId,
@@ -40047,9 +40047,9 @@ class DroppedAsset extends Asset {
      * await droppedAsset.updatePosition(100,200);
      * ```
      */
-    updatePosition(x, y) {
+    updatePosition(x, y, yOrderAdjust) {
         try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { x, y }, "set-position");
+            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { x, y, yOrderAdjust }, "set-position");
         }
         catch (error) {
             throw this.errorHandler({ error });
@@ -40265,7 +40265,7 @@ var _World_droppedAssetsMap;
  */
 class World extends SDKController {
     constructor(topia, urlSlug, options = { attributes: {}, credentials: {} }) {
-        super(topia, options.credentials);
+        super(topia, Object.assign({ urlSlug }, options.credentials));
         _World_droppedAssetsMap.set(this, void 0);
         ////////// data objects
         /**
@@ -40532,6 +40532,8 @@ class World extends SDKController {
         });
     }
     /**
+     * @deprecated Use {@link fetchScenes} instead.
+     *
      * @summary
      * Fetch a list of all scene drop ids in a world that include at least one asset with an interactivePublicKey
      *
@@ -40557,6 +40559,46 @@ class World extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Fetch a list of all scene drop ids and dropped assets in a world
+     *
+     * @usage
+     * ```ts
+     * await world.fetchScenes();
+     * ```
+     *
+     * @result
+     * ```ts
+     * { "scenes": {
+     *     "sceneDropId_1": {
+     *         "droppedAssets": {
+     *             "droppedAssetId_1": {
+     *                 "metaName": "hello"
+     *                 "metaNameReversed": "olleh"
+     *             },
+     *             "droppedAssetId_2": {
+     *                 "metaName": "world"
+     *                 "metaNameReversed": "dlorw"
+     *             }
+     *         }
+     *     },
+     *   }
+     * }
+     * ```
+     */
+    fetchScenes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/scenes-with-dropped-assets`, this.requestOptions);
+                this.scenes = response.data;
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
     /**
      * @summary
      * Drops a scene in a world and returns sceneDropId.
@@ -41391,14 +41433,16 @@ class DroppedAssetFactory extends SDKController {
             return droppedAsset;
         });
     }
-    drop(asset, { interactivePublicKey, position: { x, y }, uniqueName, urlSlug, }) {
+    drop(asset, { interactivePublicKey, position: { x, y }, sceneDropId, uniqueName, urlSlug, yOrderAdjust, }) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const response = yield this.topiaPublicApi().post(`/world/${urlSlug}/assets`, {
                     assetId: asset.id,
                     interactivePublicKey,
                     position: { x, y },
+                    sceneDropId,
                     uniqueName,
+                    yOrderAdjust,
                 }, asset.requestOptions);
                 const { id } = response.data;
                 return new DroppedAsset(this.topia, id, urlSlug, { credentials: asset.credentials });

package/package.json

@@ -59,5 +59,5 @@
     "local-publish": "yarn build && yalc publish --push --no-scripts"
   },
   "type": "module",
-  "version": "0.3.8"
+  "version": "0.4.0"
 }