@rtsdk/topia 0.8.5 → 0.9.0

package/dist/index.js

@@ -39715,7 +39715,7 @@ class SDKController {
  */
 class Asset extends SDKController {
     constructor(topia, id, options = { attributes: {}, credentials: {} }) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         // assetId and urlSlug should only be used when Asset is extended by DroppedAsset
         super(topia, {
             apiKey: (_a = options === null || options === void 0 ? void 0 : options.credentials) === null || _a === void 0 ? void 0 : _a.apiKey,
@@ -39725,12 +39725,23 @@ class Asset extends SDKController {
             visitorId: (_e = options === null || options === void 0 ? void 0 : options.credentials) === null || _e === void 0 ? void 0 : _e.visitorId,
         });
         this.id = id;
+        this.urlSlug = (_f = options === null || options === void 0 ? void 0 : options.credentials) === null || _f === void 0 ? void 0 : _f.urlSlug;
         Object.assign(this, options.attributes);
     }
+    /**
+     * @summary
+     * Retrieves platform asset details.
+     *
+     * @usage
+     * ```ts
+     * await asset.fetchAssetById();
+     * const { assetName } = asset;
+     * ```
+     */
     fetchAssetById() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/assets/${this.id}`, this.requestOptions);
+                const response = yield this.topiaPublicApi().get(`/assets/${this.urlSlug}/${this.id}`, this.requestOptions);
                 return response.data;
             }
             catch (error) {
@@ -39850,8 +39861,8 @@ class DroppedAsset extends Asset {
     setDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -39876,8 +39887,8 @@ class DroppedAsset extends Asset {
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/update-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -39902,8 +39913,8 @@ class DroppedAsset extends Asset {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({
@@ -40311,6 +40322,16 @@ class Scene extends SDKController {
         this.id = id;
         Object.assign(this, options.attributes);
     }
+    /**
+     * @summary
+     * Retrieves scene details.
+     *
+     * @usage
+     * ```ts
+     * await scene.fetchSceneById();
+     * const { name } = scene;
+     * ```
+     */
     fetchSceneById() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -40411,8 +40432,8 @@ class World extends SDKController {
          */
         this.setDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -40435,8 +40456,8 @@ class World extends SDKController {
          */
         this.updateDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/update-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -40828,8 +40849,8 @@ class World extends SDKController {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
+                const { analytics, lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({
@@ -40953,6 +40974,12 @@ class User extends SDKController {
     /**
      * @summary
      * Returns all assets owned by User when an email address is provided.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchAssets();
+     * const userAssets = user.assets;
+     * ```
      */
     fetchAssets() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40975,7 +41002,12 @@ class User extends SDKController {
     }
     /**
      * @summary
-     * Returns all platform assets
+     * Returns all platform assets.
+     *
+     * @usage
+     * ```ts
+     * const assets = await user.fetchPlatformAssets();
+     * ```
      */
     fetchPlatformAssets() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -40990,7 +41022,13 @@ class User extends SDKController {
     }
     /**
      * @summary
-     * Returns all scenes owned by User
+     * Returns all scenes owned by User.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchScenes();
+     * const userScenes = user.scenes;
+     * ```
      */
     fetchScenes() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -41139,8 +41177,8 @@ class User extends SDKController {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/set-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -41166,8 +41204,8 @@ class User extends SDKController {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/update-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -41192,8 +41230,8 @@ class User extends SDKController {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { path, amount, options }, sdkMethod: "User.incrementDataObjectValue" });
@@ -41464,8 +41502,8 @@ class Visitor extends User {
     setDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/set-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -41489,8 +41527,8 @@ class Visitor extends User {
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/update-data-object`, { dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -41515,8 +41553,8 @@ class Visitor extends User {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/increment-data-object-value`, { path, amount, lock }, this.requestOptions);
+                const { analytics = [], lock = {} } = options;
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({
@@ -41711,23 +41749,62 @@ class Topia {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Asset = new AssetFactory(myTopiaInstance);
+ * ```
+ */
 class AssetFactory {
     constructor(topia) {
         this.topia = topia;
         this.create;
     }
+    /**
+     * @summary
+     * Instantiate a new instance of Asset class.
+     *
+     * @usage
+     * ```
+     * const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id, options) {
         return new Asset(this.topia, id, options);
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
+ * ```
+ */
 class DroppedAssetFactory extends SDKController {
     constructor(topia) {
         super(topia);
     }
+    /**
+     * @summary
+     * Instantiate a new instance of DroppedAsset class.
+     *
+     * @usage
+     * ```
+     * const droppedAssetInstance = await DroppedAsset.create(assetId, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id, urlSlug, options) {
         return new DroppedAsset(this.topia, id, urlSlug, options);
     }
+    /**
+     * @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, urlSlug, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const droppedAsset = new DroppedAsset(this.topia, id, urlSlug, options);
@@ -41735,6 +41812,15 @@ class DroppedAssetFactory extends SDKController {
             return 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, urlSlug, credentials) {
         return __awaiter(this, void 0, void 0, function* () {
             const { apiKey, interactivePublicKey, interactiveSecret } = credentials;
@@ -41757,6 +41843,26 @@ class DroppedAssetFactory extends SDKController {
             }
         });
     }
+    /**
+     * @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, { assetScale = 1, flipped, interactivePublicKey, isInteractive, layer0 = "", layer1 = "", position: { x, y }, sceneDropId, text, textColor, textSize, textWeight, textWidth, uniqueName, urlSlug, yOrderAdjust, }) {
         return __awaiter(this, void 0, void 0, function* () {
             let specialType = null;
@@ -41801,14 +41907,38 @@ class DroppedAssetFactory extends SDKController {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Scene = new SceneFactory(myTopiaInstance);
+ * ```
+ */
 class SceneFactory {
     constructor(topia) {
         this.topia = topia;
         this.create;
     }
+    /**
+     * @summary
+     * Instantiate a new instance of Scene class.
+     *
+     * @usage
+     * ```
+     * const sceneInstance = await Scene.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id, options) {
         return new Scene(this.topia, id, options);
     }
+    /**
+     * @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, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const scene = yield new Scene(this.topia, id, options);
@@ -41818,22 +41948,61 @@ class SceneFactory {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const User = new UserFactory(myTopiaInstance);
+ * ```
+ */
 class UserFactory {
     constructor(topia) {
         this.topia = topia;
     }
+    /**
+     * @summary
+     * Instantiate a new instance of User class.
+     *
+     * @usage
+     * ```
+     * const userInstance = await User.create({ credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(options) {
         return new User(this.topia, options);
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const Visitor = new VisitorFactory(myTopiaInstance);
+ * ```
+ */
 class VisitorFactory {
     constructor(topia) {
         this.topia = topia;
     }
+    /**
+     * @summary
+     * Instantiate a new instance of Visitor class.
+     *
+     * @usage
+     * ```
+     * const visitorInstance = await Visitor.create(id, urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(id, urlSlug, options) {
         return new Visitor(this.topia, id, urlSlug, options);
     }
+    /**
+     * @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, urlSlug, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const visitor = new Visitor(this.topia, id, urlSlug, options);
@@ -41843,22 +42012,61 @@ class VisitorFactory {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const WorldActivity = new WorldActivityFactory(myTopiaInstance);
+ * ```
+ */
 class WorldActivityFactory {
     constructor(topia) {
         this.topia = topia;
     }
+    /**
+     * @summary
+     * Instantiate a new instance of WorldActivity class.
+     *
+     * @usage
+     * ```
+     * const worldActivityInstance = await WorldActivity.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(urlSlug, options) {
         return new WorldActivity(this.topia, urlSlug, options);
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const World = new WorldFactory(myTopiaInstance);
+ * ```
+ */
 class WorldFactory extends SDKController {
     constructor(topia) {
         super(topia);
     }
+    /**
+     * @summary
+     * Instantiate a new instance of World class.
+     *
+     * @usage
+     * ```
+     * const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
+     * ```
+     */
     create(urlSlug, options) {
         return new World(this.topia, urlSlug, options);
     }
+    /**
+     * @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, droppedAssetIds, credentials) {
         return __awaiter(this, void 0, void 0, function* () {
             const { apiKey, interactivePublicKey, interactiveSecret } = credentials;

package/package.json

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