@rtsdk/topia 0.1.0 → 0.2.0

package/dist/src/controllers/DroppedAsset.js

@@ -1,461 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-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;
-// controllers
-import { Asset } from "controllers/Asset";
-/**
- * @summary
- * Create an instance of Dropped Asset class with a given dropped asset id, url slug, and optional attributes and session credentials.
- *
- * @usage
- * ```ts
- * await new DroppedAsset(topia, "1giFZb0sQ3X27L7uGyQX", "example", { attributes: { text: "" }, credentials: { assetId: "1giFZb0sQ3X27L7uGyQX" } } });
- * ```
- */
-export class DroppedAsset extends Asset {
-    constructor(topia, id, urlSlug, options = { attributes: { text: "" }, credentials: {} }) {
-        var _a;
-        super(topia, id, options);
-        // update dropped assets
-        _DroppedAsset_updateDroppedAsset.set(this, (payload, updateType) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/${updateType}`, Object.assign({}, payload), this.requestOptions);
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        }));
-        Object.assign(this, options.attributes);
-        this.id = id;
-        this.text = (_a = options.attributes) === null || _a === void 0 ? void 0 : _a.text;
-        this.urlSlug = urlSlug;
-    }
-    /**
-     * @summary
-     * Retrieves dropped asset details.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.fetchDroppedAssetById();
-     * const { assetName } = droppedAsset;
-     * ```
-     */
-    fetchDroppedAssetById() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets/${this.id}`, this.requestOptions);
-                const droppedAssetDetails = response.data;
-                droppedAssetDetails.urlSlug = this.urlSlug;
-                Object.assign(this, droppedAssetDetails);
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-    /**
-     * @summary
-     * Delete dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.deleteDroppedAsset();
-     * ```
-     */
-    deleteDroppedAsset() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.topiaPublicApi().delete(`/world/${this.urlSlug}/assets/${this.id}`, this.requestOptions);
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-    /**
-     * @summary
-     * Retrieves the data object for a dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.fetchDroppedAssetDataObject();
-     * const { dataObject } = droppedAsset;
-     * ```
-     */
-    fetchDroppedAssetDataObject() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this.topiaPublicApi().get(`/world/${this.urlSlug}/assets/${this.id}/data-object`, this.requestOptions);
-                this.dataObject = response.data;
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-    /**
-     * @summary
-     * Sets the data object for a dropped asset.
-     *
-     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.setDroppedAssetDataObject({
-     *   "exampleKey": "exampleValue",
-     * });
-     * const { dataObject } = droppedAsset;
-     * ```
-     */
-    setDroppedAssetDataObject(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, lock }, this.requestOptions);
-                this.dataObject = dataObject;
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-    /**
-     * @summary
-     * Updates the data object for a dropped asset.
-     *
-     * Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.updateDroppedAssetDataObject({
-     *   "exampleKey": "exampleValue",
-     * });
-     * const { dataObject } = droppedAsset;
-     * ```
-     */
-    // get dropped asset
-    updateDroppedAssetDataObject(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, lock }, this.requestOptions);
-                this.dataObject = dataObject;
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-    /**
-     * @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, }) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { assetBroadcast, assetBroadcastAll, broadcasterEmail }, "set-asset-broadcast");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Updates click options for a dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.updateClickType({
-     *   "clickType": "portal",
-     *   "clickableLink": "https://topia.io",
-     *   "clickableLinkTitle": "My awesome link!",
-     *   "clickableDisplayTextDescription": "Description",
-     *   "clickableDisplayTextHeadline": "Title",
-     *   "position": {
-     *     "x": 0,
-     *     "y": 0
-     *   },
-     *   "portalName": "community"
-     * });
-     * ```
-     */
-    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, portalName, position, }) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, {
-                clickType,
-                clickableLink,
-                clickableLinkTitle,
-                clickableDisplayTextDescription,
-                clickableDisplayTextHeadline,
-                portalName,
-                position,
-            }, "change-click-type");
-        }
-        catch (error) {
-            throw this.errorHandler({ 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.updateCustomTextAsset(style, "hello world");
-     * ```
-     */
-    updateCustomTextAsset(style, text) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { style, text }, "set-custom-text");
-        }
-        catch (error) {
-            throw this.errorHandler({ 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,
-     *   "audioSliderVolume: 30"
-     *   "portalName": "community",
-     *   "audioRadius": 0,
-     *   "mediaName": "string"
-     * });
-     * ```
-     */
-    updateMediaType({ audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia, }) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { audioRadius, audioSliderVolume, isVideo, mediaLink, mediaName, mediaType, portalName, syncUserMedia }, "change-media-type");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Updates mute zone options for a dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.updateMuteZone(true);
-     * ```
-     */
-    updateMuteZone(isMutezone) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isMutezone }, "set-mute-zone");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Updates webhook zone options for a dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.updateWebhookZone(true);
-     * ```
-     */
-    updateWebhookZone(isWebhookZoneEnabled) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isWebhookZoneEnabled }, "set-webhook-zone");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Moves a dropped asset to specified coordinates.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.updatePosition(100,200);
-     * ```
-     */
-    updatePosition(x, y) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { x, y }, "set-position");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Updates private zone options for a dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.updatePrivateZone({
-     *   "isPrivateZone": false,
-     *   "isPrivateZoneChatDisabled": true,
-     *   "privateZoneUserCap": 10
-     * });
-     * ```
-     */
-    updatePrivateZone({ isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap, }) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { isPrivateZone, isPrivateZoneChatDisabled, privateZoneUserCap }, "set-private-zone");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Updates the size of a dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.assetScale(.5);
-     * ```
-     */
-    updateScale(assetScale) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { assetScale }, "change-scale");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Change or remove media embedded in a dropped asset.
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.updateUploadedMediaSelected("LVWyxwNxI96eLjnXWwYO");
-     * ```
-     */
-    updateUploadedMediaSelected(mediaId) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { mediaId }, "change-uploaded-media-selected");
-        }
-        catch (error) {
-            throw this.errorHandler({ 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) {
-        try {
-            return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, { bottom, top }, "set-webimage-layers");
-        }
-        catch (error) {
-            throw this.errorHandler({ error });
-        }
-    }
-    /**
-     * @summary
-     * Add a webhook to a dropped asset
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.addWebhook({
-     *   active: true,
-     *   dataObject: {},
-     *   description: "Webhook desc",
-     *   enteredBy: "you",
-     *   isUniqueOnly: false,
-     *   title: "title",
-     *   type: "type",
-     *   url: "https://url.com",
-     *   urlSlug: "world",
-     * });
-     * ```
-     */
-    addWebhook({ dataObject, description, isUniqueOnly, title, type, url, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/webhooks`, {
-                    active: true,
-                    assetId: this.id,
-                    dataObject,
-                    description,
-                    enteredBy: "",
-                    isUniqueOnly,
-                    title,
-                    type,
-                    url,
-                    urlSlug: this.urlSlug,
-                }, this.requestOptions);
-                return response.data.webhookId;
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-    /**
-     * @summary
-     * Set the interactive settings on a dropped asset
-     *
-     * @usage
-     * ```ts
-     * await droppedAsset.setInteractiveSettings({
-     *   isInteractive: true,
-     *   interactivePublicKey: "xyz"
-     * });
-     * ```
-     */
-    setInteractiveSettings({ isInteractive = false, interactivePublicKey = "", }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-asset-interactive-settings`, {
-                    interactivePublicKey,
-                    isInteractive,
-                }, this.requestOptions);
-                this.isInteractive = isInteractive;
-                this.interactivePublicKey = interactivePublicKey;
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-}
-_DroppedAsset_updateDroppedAsset = new WeakMap();
-export default DroppedAsset;

package/dist/src/controllers/SDKController.js

@@ -1,85 +0,0 @@
-// utils
-import jwt from "jsonwebtoken";
-import { AxiosError } from "axios";
-/**
- * @summary
- * Create an instance of SDKController class with credentials.
- *
- * @usage
- * ```ts
- * const credentials = {
- *   assetId: "exampleAsset",
- *   interactiveNonce: "exampleNonce"
- *   interactivePublicKey: "examplePublicKey",
- *   visitorId: 1,
- *   url: "https://topia.io",
- * }
- * const topia = await new Topia({
- *   apiDomain: "api.topia.io",
- *   apiKey: "exampleKey",
- *   interactiveKey: "key",
- *   interactiveSecret: "secret",
- * }
- * await new SDKController({ credentials, topia });
- * ```
- */
-export class SDKController {
-    constructor(topia, credentials = {}) {
-        const { assetId, interactiveNonce, visitorId, apiKey } = credentials;
-        this.topia = topia;
-        this.credentials = credentials;
-        this.requestOptions = {};
-        let payload = {};
-        const headers = {};
-        if (visitorId && assetId && interactiveNonce) {
-            payload = {
-                interactiveNonce,
-                visitorId,
-                assetId,
-            };
-            this.jwt = jwt.sign(payload, topia.interactiveSecret);
-            headers.InteractiveJWT = this.jwt;
-        }
-        if (apiKey) {
-            headers.Authorization = apiKey;
-        }
-        this.requestOptions = { headers };
-    }
-    topiaPublicApi() {
-        return this.topia.axios;
-    }
-    errorHandler({ error, message = "Something went wrong. Please try again or contact support.", }) {
-        var _a, _b;
-        const stackTrace = new Error("Thrown here:");
-        let data = {}, errorMessage = message, method = "unknown", stack = "empty", status = 500, url = "unknown";
-        if (error instanceof AxiosError) {
-            errorMessage = (error === null || error === void 0 ? void 0 : error.message) || message;
-            if (error.response) {
-                status = error.response.status;
-                data = error.response.data;
-                if (error.response.data.errors)
-                    errorMessage = error.response.data.errors[0].message;
-            }
-            if ((_a = error === null || error === void 0 ? void 0 : error.config) === null || _a === void 0 ? void 0 : _a.url)
-                url = error.config.url;
-            if ((_b = error === null || error === void 0 ? void 0 : error.config) === null || _b === void 0 ? void 0 : _b.method)
-                method = error.config.method;
-            stack = `${error.stack}\n${stackTrace.stack}`;
-        }
-        else if (error instanceof Error) {
-            errorMessage = (error === null || error === void 0 ? void 0 : error.message) || message;
-            stack = `${error.stack}\n${stackTrace.stack}`;
-        }
-        return {
-            data,
-            message: errorMessage,
-            method,
-            stack,
-            stackTrace,
-            status,
-            success: false,
-            url,
-        };
-    }
-}
-export default SDKController;

package/dist/src/controllers/Scene.js

@@ -1,39 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-// controllers
-import { SDKController } from "controllers/SDKController";
-/**
- * @summary
- * Create an instance of Scene class with a given scene id and optional attributes and session credentials.
- *
- * @usage
- * ```ts
- * await new Scene(topia, "sceneId", { attributes: { name: "My Scene" } });
- * ```
- */
-export class Scene extends SDKController {
-    constructor(topia, id, options = { attributes: {}, credentials: {} }) {
-        super(topia, options.credentials);
-        this.id = id;
-        Object.assign(this, options.attributes);
-    }
-    fetchSceneById() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const response = yield this.topiaPublicApi().get(`/scenes/${this.id}`, this.requestOptions);
-                Object.assign(this, response.data);
-            }
-            catch (error) {
-                throw this.errorHandler({ error });
-            }
-        });
-    }
-}
-export default Scene;

package/dist/src/controllers/Topia.js

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