@rtsdk/topia 0.0.10 → 0.0.12

package/README.md

@@ -0,0 +1,19 @@
+# Javascript RTSDK - Topia Client Library
+
+The Topia Client Library leverages the Topia Public API and allows users to interact with the topia systems and modify their world programmatically. With the SDK you can now build new features to be used in Topia! Check out a few awesome examples [here](https://sdk-examples.metaversecloud.com/).
+
+## Get Started
+
+Run `yarn add @rtsdk/topia` or `npm install @rtsdk/topia`
+
+## Authorization
+
+A Topia provided API Key should be included with every object initialization as a parameter named `apiKey`. This API Key is used to in authorization headers in all calls to the Public API.
+
+## Testing
+
+We use Jest for testing and take advantage of dependency injection to pass mock data into our services.
+
+To run the test suite, please run:
+
+`yarn test`

package/dist/controllers/Asset.js

@@ -1,13 +1,24 @@
-import { getErrorMessage, publicAPI } from "utils";
-export class Asset {
-    constructor({ apiKey, args }) {
-        this.apiKey = apiKey;
-        Object.assign(this, args);
+// controllers
+import { SDKController } from "controllers/SDKController";
+// utils
+import { getErrorMessage } from "utils";
+/**
+ * Create an instance of Asset class with a given apiKey and optional arguments.
+ *
+ * ```ts
+ * await new Asset({ args: { assetName: "My Asset", isPublic: false } });
+ * ```
+ */
+export class Asset extends SDKController {
+    constructor(topia, id, options = { args: {}, creds: {} }) {
+        super(topia, options.creds);
+        this.id = id;
+        Object.assign(this, options.args);
     }
-    fetchAssetsByEmail(ownerEmail) {
+    fetchPlatformAssets() {
         return new Promise((resolve, reject) => {
-            publicAPI(this.apiKey)
-                .get(`/assets/my-assets?email=${ownerEmail}`)
+            this.topia.axios
+                .get("/assets/topia-assets", this.requestOptions)
                 .then((response) => {
                 resolve(response.data);
             })

package/dist/controllers/DroppedAsset.js

@@ -1,19 +1,23 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _DroppedAsset_updateDroppedAsset;
-import { getErrorMessage, publicAPI } from "utils";
-import Asset from "./Asset";
+// controllers
+import { Asset } from "controllers/Asset";
+// utils
+import { getErrorMessage } from "utils";
+/**
+ * Create an instance of Dropped Asset class with a given apiKey and optional arguments.
+ *
+ * ```ts
+ * await new DroppedAsset({ id: "1giFZb0sQ3X27L7uGyQX", urlSlug: "magic" });
+ * ```
+ */
 export class DroppedAsset extends Asset {
-    constructor({ apiKey, id, args, urlSlug, }) {
-        super({ apiKey, args });
+    constructor(topia, id, urlSlug, options = { args: { text: "" }, creds: {} }) {
+        var _a;
+        super(topia, id, options);
         // update dropped assets
-        _DroppedAsset_updateDroppedAsset.set(this, (payload, updateType) => {
+        this.updateDroppedAsset = (payload, updateType) => {
             return new Promise((resolve, reject) => {
-                publicAPI(this.apiKey)
-                    .put(`/world/${this.urlSlug}/assets/${this.id}/${updateType}`, Object.assign({}, payload))
+                this.topia.axios
+                    .put(`/world/${this.urlSlug}/assets/${this.id}/${updateType}`, Object.assign({}, payload), this.requestOptions)
                     .then(() => {
                     resolve("Success!");
                 })
@@ -21,19 +25,27 @@ export class DroppedAsset extends Asset {
                     reject(new Error(getErrorMessage(error)));
                 });
             });
-        });
-        Object.assign(this, args);
-        this.apiKey = apiKey;
+        };
         this.id = id;
-        this.text = args.text;
+        this.text = (_a = options.args) === null || _a === void 0 ? void 0 : _a.text;
         this.urlSlug = urlSlug;
-        this.updateCustomText;
+        Object.assign(this, options.args);
     }
+    /**
+     * @summary
+     * Retrieves dropped asset details.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchDroppedAssetById();
+     * const { assetName } = droppedAsset;
+     * ```
+     */
     // get dropped asset
     fetchDroppedAssetById() {
         return new Promise((resolve, reject) => {
-            publicAPI(this.apiKey)
-                .get(`/world/${this.urlSlug}/assets/${this.id}`)
+            this.topia.axios
+                .get(`/world/${this.urlSlug}/assets/${this.id}`, this.requestOptions)
                 .then((response) => {
                 Object.assign(this, response.data);
                 resolve("Success!");
@@ -46,9 +58,59 @@ export class DroppedAsset extends Asset {
     // delete dropped asset
     deleteDroppedAsset() {
         return new Promise((resolve, reject) => {
-            publicAPI(this.apiKey)
-                .delete(`/world/${this.urlSlug}/assets/${this.id}`)
+            this.topia.axios
+                .delete(`/world/${this.urlSlug}/assets/${this.id}`, this.requestOptions)
+                .then(() => {
+                resolve("Success!");
+            })
+                .catch((error) => {
+                reject(new Error(getErrorMessage(error)));
+            });
+        });
+    }
+    /**
+     * @summary
+     * Retrieves the data object for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchDroppedAssetDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    // get dropped asset
+    fetchDroppedAssetDataObject() {
+        return new Promise((resolve, reject) => {
+            this.topia.axios
+                .get(`/world/${this.urlSlug}/assets/${this.id}/data-object`, this.requestOptions)
+                .then((response) => {
+                this.dataObject = response.data;
+                resolve("Success!");
+            })
+                .catch((error) => {
+                reject(new Error(getErrorMessage(error)));
+            });
+        });
+    }
+    /**
+     * @summary
+     * Updates the data object for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateDroppedAssetDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    // get dropped asset
+    updateDroppedAssetDataObject(dataObject) {
+        return new Promise((resolve, reject) => {
+            this.topia.axios
+                .put(`/world/${this.urlSlug}/assets/${this.id}/set-data-object`, dataObject, this.requestOptions)
                 .then(() => {
+                this.dataObject = dataObject;
                 resolve("Success!");
             })
                 .catch((error) => {
@@ -56,90 +118,213 @@ export class DroppedAsset extends Asset {
             });
         });
     }
+    /**
+     * @summary
+     * Updates broadcast options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateBroadcast({
+     *   assetBroadcast: true,
+     *   assetBroadcastAll: true,
+     *   broadcasterEmail: "example@email.com"
+     * });
+     * ```
+     */
     updateBroadcast({ assetBroadcast, assetBroadcastAll, broadcasterEmail }) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { assetBroadcast, assetBroadcastAll, broadcasterEmail }, "set-asset-broadcast")
+            return this.updateDroppedAsset({ assetBroadcast, assetBroadcastAll, broadcasterEmail }, "set-asset-broadcast")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Updates click options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateClickType({
+     *   "clickType": "portal",
+     *   "clickableLink": "https://topia.io",
+     *   "clickableLinkTitle": "My awesome link!",
+     *   "position": {
+     *     "x": 0,
+     *     "y": 0
+     *   },
+     *   "portalName": "community"
+     * });
+     * ```
+     */
     updateClickType({ clickType, clickableLink, clickableLinkTitle, portalName, position, }) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { clickType, clickableLink, clickableLinkTitle, portalName, position }, "change-click-type")
+            return this.updateDroppedAsset({ clickType, clickableLink, clickableLinkTitle, portalName, position }, "change-click-type")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Updates text and style of a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * const style = {
+     *   "textColor": "#abc123",
+     *   "textFontFamily": "Arial",
+     *   "textSize": 40,
+     *   "textWeight": "normal",
+     *   "textWidth": 200
+     * };
+     * await droppedAsset.updateCustomText(style, "hello world");
+     * ```
+     */
     updateCustomText(style, text) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { style, text }, "set-custom-text")
+            return this.updateDroppedAsset({ style, text }, "set-custom-text")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Updates media options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateMediaType({
+     *   "mediaType": "link",
+     *   "mediaLink": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+     *   "isVideo": true,
+     *   "syncUserMedia": true,
+     *   "audioVolume": -1,
+     *   "portalName": "community",
+     *   "audioRadius": 0,
+     *   "mediaName": "string"
+     * });
+     * ```
+     */
     updateMediaType({ audioRadius, audioVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { audioRadius, audioVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia }, "change-media-type")
+            return this.updateDroppedAsset({ audioRadius, audioVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia }, "change-media-type")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Updates mute zone options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateMuteZone(true);
+     * ```
+     */
     updateMuteZone(isMutezone) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isMutezone }, "set-mute-zone")
+            return this.updateDroppedAsset({ isMutezone }, "set-mute-zone")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Moves a dropped asset to specified coordinates.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updatePosition(100,200);
+     * ```
+     */
     updatePosition(x, y) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { x, y }, "set-position")
+            return this.updateDroppedAsset({ x, y }, "set-position")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Updates private zone options for a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateMuteZone({
+     *   "isPrivateZone": false,
+     *   "isPrivateZoneChatDisabled": true,
+     *   "privateZoneUserCap": 10
+     * });
+     * ```
+     */
     updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap }, "set-private-zone")
+            return this.updateDroppedAsset({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap }, "set-private-zone")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Updates the size of a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.assetScale(.5);
+     * ```
+     */
     updateScale(assetScale) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { assetScale }, "change-scale")
+            return this.updateDroppedAsset({ assetScale }, "change-scale")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Change or remove media embedded in a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
+     * ```
+     */
     updateUploadedMediaSelected(mediaId) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { mediaId }, "change-uploaded-media-selected")
+            return this.updateDroppedAsset({ mediaId }, "change-uploaded-media-selected")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
             });
         });
     }
+    /**
+     * @summary
+     * Change or remove top and bottom layers of a dropped asset.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.updateWebImageLayers("","https://www.shutterstock.com/image-vector/colorful-illustration-test-word-260nw-1438324490.jpg");
+     * ```
+     */
     updateWebImageLayers(bottom, top) {
         return new Promise((resolve, reject) => {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { bottom, top }, "set-webimage-layers")
+            return this.updateDroppedAsset({ bottom, top }, "set-webimage-layers")
                 .then(resolve)
                 .catch((error) => {
                 reject(new Error(getErrorMessage(error)));
@@ -147,5 +332,4 @@ export class DroppedAsset extends Asset {
         });
     }
 }
-_DroppedAsset_updateDroppedAsset = new WeakMap();
 export default DroppedAsset;

package/dist/controllers/SDKController.js

@@ -0,0 +1,36 @@
+// utils
+import jwt from "jsonwebtoken";
+/**
+ * Create an instance of SDKController class with credentials.
+ *
+ * ```ts
+ * const creds = {
+ *   assetId: "exampleAsset",
+ *   interactiveNonce: "exampleNonce"
+ *   interactivePublicKey: "examplePublicKey",
+ *   playerId: 1,
+ *   url: "https://topia.io",
+ * }
+ * const topia = await new Topia({
+ *   apiDomain: "api.topia.io",
+ *   apiKey: "exampleKey",
+ *   interactiveKey: "key",
+ *   interactiveSecret: "secret",
+ * }
+ * await new SDKController({ creds, topia });
+ * ```
+ */
+export class SDKController {
+    constructor(topia, creds) {
+        this.creds = creds;
+        this.topia = topia;
+        if (creds && topia.interactiveSecret) {
+            this.jwt = jwt.sign(creds, topia.interactiveSecret);
+            this.requestOptions = { headers: { Interactivejwt: this.jwt } };
+        }
+        else {
+            this.requestOptions = {};
+        }
+    }
+}
+export default SDKController;

package/dist/controllers/Topia.js

@@ -0,0 +1,32 @@
+import axios from "axios";
+/**
+ * Create a single instance of Topia axios used for all calls to the public API in all classes
+ *
+ * ```ts
+ * const topia = await new Topia({
+ *   apiDomain: "api.topia.io",
+ *   apiKey: "exampleKey",
+ *   interactiveKey: "key",
+ *   interactiveSecret: "secret",
+ * });
+ * ```
+ */
+export class Topia {
+    constructor({ apiKey, apiDomain, interactiveKey, interactiveSecret, }) {
+        this.apiKey = apiKey;
+        this.apiDomain = apiDomain || "api.topia.io";
+        this.interactiveSecret = interactiveSecret;
+        const headers = {
+            "Content-Type": "application/json",
+        };
+        if (apiKey)
+            headers.Authorization = apiKey;
+        if (interactiveKey)
+            headers.Publickey = interactiveKey;
+        this.axios = axios.create({
+            baseURL: `https://${apiDomain}/api`,
+            headers,
+        });
+    }
+}
+export default Topia;

package/dist/controllers/User.js

@@ -10,24 +10,54 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _User_worldsMap;
+// controllers
+import { SDKController } from "controllers/SDKController";
 import { World } from "controllers/World";
-import { getErrorMessage, publicAPI } from "utils";
-export class User {
-    constructor({ apiKey, email }) {
+// utils
+import { getErrorMessage } from "utils";
+/**
+ * Create an instance of User class with a given apiKey.
+ *
+ * ```ts
+ * await new User({ email: "example@email.io" });
+ * ```
+ */
+export class User extends SDKController {
+    constructor(topia, email, options = { creds: {} }) {
+        super(topia, options.creds);
         _User_worldsMap.set(this, void 0);
         __classPrivateFieldSet(this, _User_worldsMap, {}, "f");
-        this.apiKey = apiKey;
         this.email = email;
     }
     get worlds() {
         return __classPrivateFieldGet(this, _User_worldsMap, "f");
     }
+    /**
+     * @summary
+     * Returns all assets owned by User when an email address is provided.
+     */
+    fetchAssetsByEmail(ownerEmail) {
+        return new Promise((resolve, reject) => {
+            this.topia.axios
+                .get(`/assets/my-assets?email=${ownerEmail}`, this.requestOptions)
+                .then((response) => {
+                resolve(response.data);
+            })
+                .catch((error) => {
+                reject(new Error(getErrorMessage(error)));
+            });
+        });
+    }
+    /**
+     * @summary
+     * Returns all scenes owned by User when an email address is provided.
+     */
     fetchScenesByEmail() {
         return new Promise((resolve, reject) => {
             if (!this.email)
                 reject("There is no email associated with this user.");
-            publicAPI(this.apiKey)
-                .get(`/scenes/my-scenes?email=${this.email}`)
+            this.topia.axios
+                .get(`/scenes/my-scenes?email=${this.email}`, this.requestOptions)
                 .then((response) => {
                 resolve(response.data);
             })
@@ -36,19 +66,32 @@ export class User {
             });
         });
     }
+    /**
+     * @summary
+     * Retrieves all worlds owned by user with matching API Key,
+     * creates a new World object for each,
+     * and creates new map of Worlds accessible via user.worlds.
+     *
+     * @usage
+     * ```ts
+     * await user.fetchWorldsByKey();
+     * const userWorlds = user.worlds;
+     * ```
+     *
+     * @result
+     * ```ts
+     * { urlSlug: new World({ apiKey, worldArgs, urlSlug }) }
+     * ```
+     */
     fetchWorldsByKey() {
         return new Promise((resolve, reject) => {
-            publicAPI(this.apiKey)
-                .get("/user/worlds")
+            this.topia.axios
+                .get("/user/worlds", this.requestOptions)
                 .then((response) => {
                 const tempWorldsMap = {};
                 for (const i in response.data) {
                     const worldDetails = response.data[i];
-                    tempWorldsMap[worldDetails.urlSlug] = new World({
-                        apiKey: this.apiKey,
-                        args: worldDetails,
-                        urlSlug: worldDetails.urlSlug,
-                    });
+                    tempWorldsMap[worldDetails.urlSlug] = new World(this.topia, worldDetails.urlSlug, { args: worldDetails });
                 }
                 __classPrivateFieldSet(this, _User_worldsMap, tempWorldsMap, "f");
                 resolve("Success!");

package/dist/controllers/Visitor.js

@@ -1,25 +1,49 @@
-import { getErrorMessage, publicAPI } from "utils";
-export class Visitor {
-    constructor({ apiKey, args, urlSlug }) {
-        Object.assign(this, args);
-        this.apiKey = apiKey;
-        this.moveTo = args.moveTo;
-        this.playerId = args.playerId;
+// controllers
+import { SDKController } from "controllers/SDKController";
+// utils
+import { getErrorMessage } from "utils";
+/**
+ * Create an instance of Visitor class with a given apiKey and optional arguments.
+ *
+ * ```ts
+ * await new Visitor(this.topia, id, urlSlug, { options });
+ * ```
+ */
+export class Visitor extends SDKController {
+    constructor(topia, id, urlSlug, options = { args: {}, creds: {} }) {
+        super(topia, options.creds);
+        Object.assign(this, options.args);
+        this.id = id;
         this.urlSlug = urlSlug;
         this.moveVisitor;
     }
-    moveVisitor(shouldTeleportVisitor, x, y) {
+    /**
+     * @summary
+     * Teleport or walk a visitor currently in a world to a single set of coordinates.
+     *
+     * @usage
+     * ```ts
+     * await visitor.moveVisitor({
+     *   shouldTeleportVisitor: true,
+     *   x: 100,
+     *   y: 100,
+     * });
+     * ```
+     *
+     * @result
+     * Updates each Visitor instance and world.visitors map.
+     */
+    moveVisitor({ shouldTeleportVisitor, x, y }) {
         return new Promise((resolve, reject) => {
-            publicAPI(this.apiKey)
-                .put(`/world/${this.urlSlug}/visitors/${this.playerId}/move`, {
+            this.topia.axios
+                .put(`/world/${this.urlSlug}/visitors/${this.id}/move`, {
                 moveTo: {
                     x,
                     y,
                 },
                 teleport: shouldTeleportVisitor,
-            })
+            }, this.requestOptions)
                 .then(() => {
-                this.moveTo = { x, y };
                 resolve("Success!");
             })
                 .catch((error) => {