@rtsdk/topia 0.11.10 → 0.12.0

package/README.md

@@ -48,7 +48,7 @@ Topia offers a robust SDK and API that allows anyone to build custom apps or int
   - [Github](https://github.com/metaversecloud-com/sdk-quest)
   - [Demo](https://topia.io/quest-prod)
 
-Questions, comments, or have something exciting to share with the Topia team? Reach out to [developers@topia.io](mailto:developers@topia.io)!
+Questions, comments, or have something exciting to share with the Topia team? Reach out to [apps@topia.io](mailto:apps@topia.io)!
 <br/>
 
 ## Authorization

package/dist/index.cjs

@@ -39637,7 +39637,7 @@ const {
  */
 class SDKController {
     constructor(topia, credentials = {}) {
-        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, urlSlug = null, visitorId = null, } = credentials;
+        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, urlSlug = null, visitorId = null, iframeId = null, gameEngineId = null, } = credentials;
         this.topia = topia;
         this.credentials = credentials;
         this.requestOptions = {};
@@ -39657,6 +39657,12 @@ class SDKController {
             if (apiKey) {
                 headers.Authorization = apiKey;
             }
+            if (iframeId) {
+                headers.iframeId = iframeId;
+            }
+            if (gameEngineId) {
+                headers.gameEngineId = gameEngineId;
+            }
             this.requestOptions = { headers };
         }
         catch (error) {
@@ -39717,7 +39723,7 @@ class SDKController {
  */
 class Asset extends SDKController {
     constructor(topia, id, options = { attributes: {}, credentials: {} }) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         // 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,
@@ -39727,7 +39733,6 @@ 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);
     }
     /**
@@ -39743,7 +39748,8 @@ class Asset extends SDKController {
     fetchAssetById() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/assets/${this.urlSlug}/${this.id}`, this.requestOptions);
+                const response = yield this.topiaPublicApi().get(`/assets/${this.id}`, this.requestOptions);
+                Object.assign(this, response.data);
                 return response.data;
             }
             catch (error) {
@@ -39751,6 +39757,44 @@ class Asset extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Updates platform asset details.
+     *
+     * @usage
+     * ```ts
+     * await asset.updateAsset({
+     *   assetName: "exampleAsset",
+     *   bottomLayerURL: null,
+     *   creatorTags: { "decorations": true },
+     *   isPublic: true,
+     *   shouldUploadImages: true,
+     *   tagJson: "[{"label":"decorations","value":"decorations"}]",
+     *   topLayerURL: "https://example.topLayerURL"
+     *  });
+     * const { assetName } = asset;
+     * ```
+     */
+    updateAsset({ assetName, bottomLayerURL, creatorTags, isPublic, shouldUploadImages, tagJson, topLayerURL, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                assetName,
+                bottomLayerURL,
+                creatorTags,
+                isPublic,
+                shouldUploadImages,
+                tagJson,
+                topLayerURL,
+            };
+            try {
+                const response = yield this.topiaPublicApi().put(`/assets/${this.id}`, params, this.requestOptions);
+                Object.assign(this, response.data);
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params, sdkMethod: "Asset.updateAsset" });
+            }
+        });
+    }
 }
 
 var _DroppedAsset_updateDroppedAsset;
@@ -40395,6 +40439,44 @@ const scatterVisitors = (original, scatterBy) => {
     return Math.floor(Math.random() * (max - min) + min);
 };
 
+/**
+ * @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",
+ * });
+ * ```
+ */
+class Topia {
+    constructor({ apiDomain, apiKey, apiProtocol, interactiveKey, interactiveSecret, mcAuthorizationKey, }) {
+        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;
+        if (mcAuthorizationKey)
+            headers.MCAuthorizationKey = mcAuthorizationKey;
+        this.axios = axios.create({
+            baseURL: `${this.apiProtocol}://${this.apiDomain}/api/v1`,
+            headers,
+        });
+    }
+}
+
 var _World_droppedAssetsMap;
 /**
  * @summary
@@ -40922,6 +41004,7 @@ class World extends SDKController {
      * ```
      */
     triggerParticle({ id, name, duration = 10, position = { x: 1, y: 1 }, }) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             if (!id && !name)
                 throw "A particle name is required.";
@@ -40929,8 +41012,10 @@ class World extends SDKController {
                 let particleId = id;
                 if (name) {
                     const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
-                    particleId = response.data[0].id;
+                    particleId = (_a = response === null || response === void 0 ? void 0 : response.data[0]) === null || _a === void 0 ? void 0 : _a.id;
                 }
+                if (!particleId)
+                    return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position, duration }, this.requestOptions);
                 return result;
             }
@@ -41047,13 +41132,15 @@ var _User_adminWorldsMap, _User_assetsMap, _User_scenesMap, _User_worldsMap;
  */
 class User extends SDKController {
     constructor(topia, options = { profileId: null, credentials: {} }) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         super(topia, {
             apiKey: (_a = options === null || options === void 0 ? void 0 : options.credentials) === null || _a === void 0 ? void 0 : _a.apiKey,
             interactiveNonce: (_b = options === null || options === void 0 ? void 0 : options.credentials) === null || _b === void 0 ? void 0 : _b.interactiveNonce,
             profileId: options === null || options === void 0 ? void 0 : options.profileId,
             urlSlug: (_c = options === null || options === void 0 ? void 0 : options.credentials) === null || _c === void 0 ? void 0 : _c.urlSlug,
             visitorId: (_d = options === null || options === void 0 ? void 0 : options.credentials) === null || _d === void 0 ? void 0 : _d.visitorId,
+            iframeId: (_e = options === null || options === void 0 ? void 0 : options.credentials) === null || _e === void 0 ? void 0 : _e.iframeId,
+            gameEngineId: (_f = options === null || options === void 0 ? void 0 : options.credentials) === null || _f === void 0 ? void 0 : _f.gameEngineId,
         });
         _User_adminWorldsMap.set(this, void 0);
         _User_assetsMap.set(this, void 0);
@@ -41819,6 +41906,7 @@ class Visitor extends User {
      * ```
      */
     triggerParticle({ id, name, duration = 10, }) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             if (!id && !name)
                 throw "A particle name is required.";
@@ -41826,8 +41914,10 @@ class Visitor extends User {
                 let particleId = id;
                 if (name) {
                     const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
-                    particleId = response.data[0].id;
+                    particleId = (_a = response === null || response === void 0 ? void 0 : response.data[0]) === null || _a === void 0 ? void 0 : _a.id;
                 }
+                if (!particleId)
+                    return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position: { x: 1, y: 1 }, duration, followPlayerId: this.id }, this.requestOptions);
                 return result;
             }
@@ -41953,6 +42043,75 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * @summary
+     * Setup signal to visitor
+     *
+     * @usage
+     * ```ts
+     * await visitor.sendSignalToVisitor(iceServers);
+     * ```
+     */
+    sendSignalToVisitor(signal) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/send-signal-to-visitor`, { signal }, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({
+                    error,
+                    params: { signal },
+                    sdkMethod: "Visitor.sendSignalToVisitor",
+                });
+            }
+        });
+    }
+}
+
+/**
+ * @summary
+ * Create an instance of WebRTCConnector class with optional session credentials.
+ *
+ * @usage
+ * ```ts
+ * await new WebRTCConnector(topia, {
+ *   credentials: { interactiveNonce: "exampleNonce", urlSlug: "exampleWorld", visitorId: 1 }
+ * });
+ * ```
+ */
+class WebRTCConnector extends SDKController {
+    constructor(topia, urlSlug, options = { twilioConfig: {}, credentials: {} }) {
+        var _a, _b, _c;
+        super(topia, {
+            interactiveNonce: (_a = options === null || options === void 0 ? void 0 : options.credentials) === null || _a === void 0 ? void 0 : _a.interactiveNonce,
+            urlSlug: (_b = options === null || options === void 0 ? void 0 : options.credentials) === null || _b === void 0 ? void 0 : _b.urlSlug,
+            visitorId: (_c = options === null || options === void 0 ? void 0 : options.credentials) === null || _c === void 0 ? void 0 : _c.visitorId,
+        });
+        this.twilioConfig = options === null || options === void 0 ? void 0 : options.twilioConfig;
+        this.urlSlug = urlSlug;
+    }
+    /**
+     * @summary
+     * Get twilio
+     *
+     * @usage
+     * ```ts
+     * await webRTCConnector.getTwilioConfig();
+     * ```
+     */
+    getTwilioConfig() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/webrtc/twilio-config`, this.requestOptions);
+                this.twilioConfig = response.data.twilioConfig;
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "WebRTCConnector.getTwilioConfig" });
+            }
+        });
+    }
 }
 
 var _WorldActivity_visitorsMap;
@@ -42132,52 +42291,15 @@ class WorldActivity extends SDKController {
 }
 _WorldActivity_visitorsMap = new WeakMap();
 
-/**
- * @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",
- * });
- * ```
- */
-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,
-        });
-    }
-}
-
 /**
  * @usage
  * ```ts
  * const Asset = new AssetFactory(myTopiaInstance);
  * ```
  */
-class AssetFactory {
+class AssetFactory extends SDKController {
     constructor(topia) {
-        this.topia = topia;
-        this.create;
+        super(topia);
     }
     /**
      * @summary
@@ -42191,6 +42313,38 @@ class AssetFactory {
     create(id, options) {
         return new Asset(this.topia, id, options);
     }
+    /**
+     * @summary
+     * Upload a new Asset and return a new instance of Asset class.
+     *
+     * @usage
+     * ```
+     * const assetPayload = {
+     *   assetName: "exampleAssetName"
+     *   bottomLayerURL: "https://example.bottomLayerURL"
+     *   creatorTags: { "decorations": true },
+     *   tagJson: "[{"label":"decorations","value":"decorations"}]",
+     *   isPublic: true,
+     *   topLayerURL: "https://example.topLayerURL"
+     * }
+     * const asset = await Asset.upload(assetPayload, apiKey);
+     * ```
+     */
+    upload(assetPayload, apiKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!apiKey)
+                    throw "A valid API Key is required.";
+                const headers = { Authorization: apiKey };
+                const response = yield this.topiaPublicApi().post("/assets", assetPayload, { headers });
+                const { assetId, asset } = response.data;
+                return new Asset(this.topia, assetId, { attributes: asset });
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: assetPayload, sdkMethod: "AssetFactory.upload" });
+            }
+        });
+    }
 }
 
 /**
@@ -42425,6 +42579,30 @@ class VisitorFactory {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const WebRTCConnector = new WebRTCConnectorFactory(myTopiaInstance);
+ * ```
+ */
+class WebRTCConnectorFactory {
+    constructor(topia) {
+        this.topia = topia;
+    }
+    /**
+     * @summary
+     * Instantiate a new instance of WebRTCConnector class.
+     *
+     * @usage
+     * ```
+     * const userInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, urlSlug, visitorId }, twilioConfig: {} });
+     * ```
+     */
+    create(urlSlug, options) {
+        return new WebRTCConnector(this.topia, urlSlug, options);
+    }
+}
+
 /**
  * @usage
  * ```ts
@@ -42541,6 +42719,8 @@ exports.User = User;
 exports.UserFactory = UserFactory;
 exports.Visitor = Visitor;
 exports.VisitorFactory = VisitorFactory;
+exports.WebRTCConnector = WebRTCConnector;
+exports.WebRTCConnectorFactory = WebRTCConnectorFactory;
 exports.World = World;
 exports.WorldActivity = WorldActivity;
 exports.WorldActivityFactory = WorldActivityFactory;

package/dist/index.d.ts

@@ -10,6 +10,17 @@ type AnalyticType = {
     urlSlug?: string;
 };
 
+type AssetType = {
+    assetName: string;
+    bottomLayerURL: string;
+    creatorTags: {
+        [key: string]: boolean;
+    };
+    tagJson: string;
+    isPublic: true;
+    topLayerURL: string;
+};
+
 declare enum DroppedAssetClickType {
     NONE = "none",
     LINK = "link",
@@ -30,6 +41,8 @@ type InteractiveCredentials = {
     profileId?: string | null;
     urlSlug?: string;
     visitorId?: number;
+    iframeId?: string;
+    gameEngineId?: string;
 };
 
 type AssetOptions = {
@@ -708,7 +721,7 @@ declare class World extends SDKController implements WorldInterface {
         name?: string;
         duration?: number;
         position?: object;
-    }): Promise<object | ResponseType$1>;
+    }): Promise<object | ResponseType$1 | string>;
     /**
      * @summary
      * Retrieves the data object for a world. Must have valid interactive credentials from a visitor in the world.
@@ -1296,7 +1309,7 @@ declare class Visitor extends User implements VisitorInterface {
         id?: string;
         name?: string;
         duration?: number;
-    }): Promise<object | ResponseType$1>;
+    }): Promise<object | ResponseType$1 | string>;
     /**
      * @summary
      * Retrieves the data object for a visitor.
@@ -1375,6 +1388,18 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     updatePublicKeyAnalytics(analytics?: AnalyticType[]): Promise<void | ResponseType$1>;
+    /**
+     * @summary
+     * Setup signal to visitor
+     *
+     * @usage
+     * ```ts
+     * await visitor.sendSignalToVisitor(iceServers);
+     * ```
+     */
+    sendSignalToVisitor(signal: any): Promise<void | (ResponseType$1 & {
+        answerSignal: any;
+    })>;
 }
 
 type VisitorType = {
@@ -1702,6 +1727,14 @@ interface WebhookInterface {
     urlSlug: string;
 }
 
+interface WebRTCConnectorInterface {
+    getTwilioConfig(): Promise<void | ResponseType$1>;
+}
+interface WebRTCConnectorOptionalInterface {
+    credentials?: InteractiveCredentials;
+    twilioConfig?: object;
+}
+
 interface WorldActivityOptionalInterface {
     credentials?: InteractiveCredentials;
 }
@@ -1790,12 +1823,14 @@ declare class Topia implements TopiaInterface {
     apiProtocol?: string;
     interactiveKey?: string;
     interactiveSecret?: jwt.Secret;
-    constructor({ apiDomain, apiKey, apiProtocol, interactiveKey, interactiveSecret, }: {
+    mcAuthorizationKey?: string;
+    constructor({ apiDomain, apiKey, apiProtocol, interactiveKey, interactiveSecret, mcAuthorizationKey, }: {
         apiDomain?: string;
         apiKey?: string;
         apiProtocol?: string;
         interactiveKey?: string;
         interactiveSecret?: jwt.Secret;
+        mcAuthorizationKey?: string;
     });
 }
 
@@ -1861,7 +1896,6 @@ 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
@@ -1874,6 +1908,60 @@ declare class Asset extends SDKController implements AssetInterface {
      * ```
      */
     fetchAssetById(): Promise<object | ResponseType$1>;
+    /**
+     * @summary
+     * Updates platform asset details.
+     *
+     * @usage
+     * ```ts
+     * await asset.updateAsset({
+     *   assetName: "exampleAsset",
+     *   bottomLayerURL: null,
+     *   creatorTags: { "decorations": true },
+     *   isPublic: true,
+     *   shouldUploadImages: true,
+     *   tagJson: "[{"label":"decorations","value":"decorations"}]",
+     *   topLayerURL: "https://example.topLayerURL"
+     *  });
+     * const { assetName } = asset;
+     * ```
+     */
+    updateAsset({ assetName, bottomLayerURL, creatorTags, isPublic, shouldUploadImages, tagJson, topLayerURL, }: {
+        assetName: string;
+        bottomLayerURL?: string;
+        creatorTags: object;
+        isPublic: boolean;
+        shouldUploadImages?: boolean;
+        tagJson: string;
+        topLayerURL?: string;
+    }): Promise<void | ResponseType$1>;
+}
+
+/**
+ * @summary
+ * Create an instance of WebRTCConnector class with optional session credentials.
+ *
+ * @usage
+ * ```ts
+ * await new WebRTCConnector(topia, {
+ *   credentials: { interactiveNonce: "exampleNonce", urlSlug: "exampleWorld", visitorId: 1 }
+ * });
+ * ```
+ */
+declare class WebRTCConnector extends SDKController implements WebRTCConnectorInterface {
+    twilioConfig?: object | null | undefined;
+    urlSlug: string;
+    constructor(topia: Topia, urlSlug: string, options?: WebRTCConnectorOptionalInterface);
+    /**
+     * @summary
+     * Get twilio
+     *
+     * @usage
+     * ```ts
+     * await webRTCConnector.getTwilioConfig();
+     * ```
+     */
+    getTwilioConfig(): Promise<void | ResponseType$1>;
 }
 
 /**
@@ -1980,8 +2068,7 @@ declare class WorldActivity extends SDKController {
  * const Asset = new AssetFactory(myTopiaInstance);
  * ```
  */
-declare class AssetFactory {
-    topia: Topia;
+declare class AssetFactory extends SDKController {
     constructor(topia: Topia);
     /**
      * @summary
@@ -1993,6 +2080,24 @@ declare class AssetFactory {
      * ```
      */
     create(id: string, options?: AssetOptionalInterface): Asset;
+    /**
+     * @summary
+     * Upload a new Asset and return a new instance of Asset class.
+     *
+     * @usage
+     * ```
+     * const assetPayload = {
+     *   assetName: "exampleAssetName"
+     *   bottomLayerURL: "https://example.bottomLayerURL"
+     *   creatorTags: { "decorations": true },
+     *   tagJson: "[{"label":"decorations","value":"decorations"}]",
+     *   isPublic: true,
+     *   topLayerURL: "https://example.topLayerURL"
+     * }
+     * const asset = await Asset.upload(assetPayload, apiKey);
+     * ```
+     */
+    upload(assetPayload: AssetType, apiKey: string): Promise<Asset>;
 }
 
 /**
@@ -2163,6 +2268,27 @@ declare class VisitorFactory {
     get(id: number, urlSlug: string, options?: VisitorOptionalInterface): Promise<Visitor>;
 }
 
+/**
+ * @usage
+ * ```ts
+ * const WebRTCConnector = new WebRTCConnectorFactory(myTopiaInstance);
+ * ```
+ */
+declare class WebRTCConnectorFactory {
+    topia: Topia;
+    constructor(topia: Topia);
+    /**
+     * @summary
+     * Instantiate a new instance of WebRTCConnector class.
+     *
+     * @usage
+     * ```
+     * const userInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, urlSlug, visitorId }, twilioConfig: {} });
+     * ```
+     */
+    create(urlSlug: string, options?: WebRTCConnectorOptionalInterface): WebRTCConnector;
+}
+
 /**
  * @usage
  * ```ts
@@ -2220,4 +2346,4 @@ declare class WorldFactory extends SDKController {
     }>;
 }
 
-export { Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };
+export { Asset, AssetFactory, AssetInterface, AssetOptionalInterface, AssetOptions, AssetType, DroppedAsset, DroppedAssetClickType, DroppedAssetFactory, DroppedAssetInterface, DroppedAssetMediaType, DroppedAssetOptionalInterface, DroppedAssetOptions, FireToastInterface, InteractiveCredentials, MoveAllVisitorsInterface, MoveVisitorInterface, OpenIframeInterface, ResponseType$1 as ResponseType, SDKController, SDKInterface, Scene, SceneFactory, SceneInterface, SceneOptionalInterface, Topia, TopiaInterface, UpdateBroadcastInterface, UpdateClickTypeInterface, UpdateMediaTypeInterface, UpdatePrivateZoneInterface, User, UserFactory, UserInterface, UserOptionalInterface, UserOptions, Visitor, VisitorFactory, VisitorInterface, VisitorOptionalInterface, VisitorOptions, VisitorType, VisitorsToMoveArrayType, VisitorsToMoveType, WebRTCConnector, WebRTCConnectorFactory, WebRTCConnectorInterface, WebRTCConnectorOptionalInterface, WebhookInterface, World, WorldActivity, WorldActivityFactory, WorldActivityOptionalInterface, WorldDetailsInterface, WorldFactory, WorldInterface, WorldOptionalInterface, WorldOptions, WorldWebhooksInterface };

package/dist/index.js

@@ -39635,7 +39635,7 @@ const {
  */
 class SDKController {
     constructor(topia, credentials = {}) {
-        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, urlSlug = null, visitorId = null, } = credentials;
+        const { apiKey = null, assetId = null, interactiveNonce = null, profileId = null, urlSlug = null, visitorId = null, iframeId = null, gameEngineId = null, } = credentials;
         this.topia = topia;
         this.credentials = credentials;
         this.requestOptions = {};
@@ -39655,6 +39655,12 @@ class SDKController {
             if (apiKey) {
                 headers.Authorization = apiKey;
             }
+            if (iframeId) {
+                headers.iframeId = iframeId;
+            }
+            if (gameEngineId) {
+                headers.gameEngineId = gameEngineId;
+            }
             this.requestOptions = { headers };
         }
         catch (error) {
@@ -39715,7 +39721,7 @@ class SDKController {
  */
 class Asset extends SDKController {
     constructor(topia, id, options = { attributes: {}, credentials: {} }) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         // 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,7 +39731,6 @@ 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);
     }
     /**
@@ -39741,7 +39746,8 @@ class Asset extends SDKController {
     fetchAssetById() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const response = yield this.topiaPublicApi().get(`/assets/${this.urlSlug}/${this.id}`, this.requestOptions);
+                const response = yield this.topiaPublicApi().get(`/assets/${this.id}`, this.requestOptions);
+                Object.assign(this, response.data);
                 return response.data;
             }
             catch (error) {
@@ -39749,6 +39755,44 @@ class Asset extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Updates platform asset details.
+     *
+     * @usage
+     * ```ts
+     * await asset.updateAsset({
+     *   assetName: "exampleAsset",
+     *   bottomLayerURL: null,
+     *   creatorTags: { "decorations": true },
+     *   isPublic: true,
+     *   shouldUploadImages: true,
+     *   tagJson: "[{"label":"decorations","value":"decorations"}]",
+     *   topLayerURL: "https://example.topLayerURL"
+     *  });
+     * const { assetName } = asset;
+     * ```
+     */
+    updateAsset({ assetName, bottomLayerURL, creatorTags, isPublic, shouldUploadImages, tagJson, topLayerURL, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const params = {
+                assetName,
+                bottomLayerURL,
+                creatorTags,
+                isPublic,
+                shouldUploadImages,
+                tagJson,
+                topLayerURL,
+            };
+            try {
+                const response = yield this.topiaPublicApi().put(`/assets/${this.id}`, params, this.requestOptions);
+                Object.assign(this, response.data);
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params, sdkMethod: "Asset.updateAsset" });
+            }
+        });
+    }
 }
 
 var _DroppedAsset_updateDroppedAsset;
@@ -40393,6 +40437,44 @@ const scatterVisitors = (original, scatterBy) => {
     return Math.floor(Math.random() * (max - min) + min);
 };
 
+/**
+ * @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",
+ * });
+ * ```
+ */
+class Topia {
+    constructor({ apiDomain, apiKey, apiProtocol, interactiveKey, interactiveSecret, mcAuthorizationKey, }) {
+        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;
+        if (mcAuthorizationKey)
+            headers.MCAuthorizationKey = mcAuthorizationKey;
+        this.axios = axios.create({
+            baseURL: `${this.apiProtocol}://${this.apiDomain}/api/v1`,
+            headers,
+        });
+    }
+}
+
 var _World_droppedAssetsMap;
 /**
  * @summary
@@ -40920,6 +41002,7 @@ class World extends SDKController {
      * ```
      */
     triggerParticle({ id, name, duration = 10, position = { x: 1, y: 1 }, }) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             if (!id && !name)
                 throw "A particle name is required.";
@@ -40927,8 +41010,10 @@ class World extends SDKController {
                 let particleId = id;
                 if (name) {
                     const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
-                    particleId = response.data[0].id;
+                    particleId = (_a = response === null || response === void 0 ? void 0 : response.data[0]) === null || _a === void 0 ? void 0 : _a.id;
                 }
+                if (!particleId)
+                    return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position, duration }, this.requestOptions);
                 return result;
             }
@@ -41045,13 +41130,15 @@ var _User_adminWorldsMap, _User_assetsMap, _User_scenesMap, _User_worldsMap;
  */
 class User extends SDKController {
     constructor(topia, options = { profileId: null, credentials: {} }) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         super(topia, {
             apiKey: (_a = options === null || options === void 0 ? void 0 : options.credentials) === null || _a === void 0 ? void 0 : _a.apiKey,
             interactiveNonce: (_b = options === null || options === void 0 ? void 0 : options.credentials) === null || _b === void 0 ? void 0 : _b.interactiveNonce,
             profileId: options === null || options === void 0 ? void 0 : options.profileId,
             urlSlug: (_c = options === null || options === void 0 ? void 0 : options.credentials) === null || _c === void 0 ? void 0 : _c.urlSlug,
             visitorId: (_d = options === null || options === void 0 ? void 0 : options.credentials) === null || _d === void 0 ? void 0 : _d.visitorId,
+            iframeId: (_e = options === null || options === void 0 ? void 0 : options.credentials) === null || _e === void 0 ? void 0 : _e.iframeId,
+            gameEngineId: (_f = options === null || options === void 0 ? void 0 : options.credentials) === null || _f === void 0 ? void 0 : _f.gameEngineId,
         });
         _User_adminWorldsMap.set(this, void 0);
         _User_assetsMap.set(this, void 0);
@@ -41817,6 +41904,7 @@ class Visitor extends User {
      * ```
      */
     triggerParticle({ id, name, duration = 10, }) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             if (!id && !name)
                 throw "A particle name is required.";
@@ -41824,8 +41912,10 @@ class Visitor extends User {
                 let particleId = id;
                 if (name) {
                     const response = yield this.topiaPublicApi().get(`/particles?name=${name}`, this.requestOptions);
-                    particleId = response.data[0].id;
+                    particleId = (_a = response === null || response === void 0 ? void 0 : response.data[0]) === null || _a === void 0 ? void 0 : _a.id;
                 }
+                if (!particleId)
+                    return "No particleId found.";
                 const result = yield this.topiaPublicApi().post(`/world/${this.urlSlug}/particles`, { particleId, position: { x: 1, y: 1 }, duration, followPlayerId: this.id }, this.requestOptions);
                 return result;
             }
@@ -41951,6 +42041,75 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * @summary
+     * Setup signal to visitor
+     *
+     * @usage
+     * ```ts
+     * await visitor.sendSignalToVisitor(iceServers);
+     * ```
+     */
+    sendSignalToVisitor(signal) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/send-signal-to-visitor`, { signal }, this.requestOptions);
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({
+                    error,
+                    params: { signal },
+                    sdkMethod: "Visitor.sendSignalToVisitor",
+                });
+            }
+        });
+    }
+}
+
+/**
+ * @summary
+ * Create an instance of WebRTCConnector class with optional session credentials.
+ *
+ * @usage
+ * ```ts
+ * await new WebRTCConnector(topia, {
+ *   credentials: { interactiveNonce: "exampleNonce", urlSlug: "exampleWorld", visitorId: 1 }
+ * });
+ * ```
+ */
+class WebRTCConnector extends SDKController {
+    constructor(topia, urlSlug, options = { twilioConfig: {}, credentials: {} }) {
+        var _a, _b, _c;
+        super(topia, {
+            interactiveNonce: (_a = options === null || options === void 0 ? void 0 : options.credentials) === null || _a === void 0 ? void 0 : _a.interactiveNonce,
+            urlSlug: (_b = options === null || options === void 0 ? void 0 : options.credentials) === null || _b === void 0 ? void 0 : _b.urlSlug,
+            visitorId: (_c = options === null || options === void 0 ? void 0 : options.credentials) === null || _c === void 0 ? void 0 : _c.visitorId,
+        });
+        this.twilioConfig = options === null || options === void 0 ? void 0 : options.twilioConfig;
+        this.urlSlug = urlSlug;
+    }
+    /**
+     * @summary
+     * Get twilio
+     *
+     * @usage
+     * ```ts
+     * await webRTCConnector.getTwilioConfig();
+     * ```
+     */
+    getTwilioConfig() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/webrtc/twilio-config`, this.requestOptions);
+                this.twilioConfig = response.data.twilioConfig;
+                return response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error, sdkMethod: "WebRTCConnector.getTwilioConfig" });
+            }
+        });
+    }
 }
 
 var _WorldActivity_visitorsMap;
@@ -42130,52 +42289,15 @@ class WorldActivity extends SDKController {
 }
 _WorldActivity_visitorsMap = new WeakMap();
 
-/**
- * @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",
- * });
- * ```
- */
-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,
-        });
-    }
-}
-
 /**
  * @usage
  * ```ts
  * const Asset = new AssetFactory(myTopiaInstance);
  * ```
  */
-class AssetFactory {
+class AssetFactory extends SDKController {
     constructor(topia) {
-        this.topia = topia;
-        this.create;
+        super(topia);
     }
     /**
      * @summary
@@ -42189,6 +42311,38 @@ class AssetFactory {
     create(id, options) {
         return new Asset(this.topia, id, options);
     }
+    /**
+     * @summary
+     * Upload a new Asset and return a new instance of Asset class.
+     *
+     * @usage
+     * ```
+     * const assetPayload = {
+     *   assetName: "exampleAssetName"
+     *   bottomLayerURL: "https://example.bottomLayerURL"
+     *   creatorTags: { "decorations": true },
+     *   tagJson: "[{"label":"decorations","value":"decorations"}]",
+     *   isPublic: true,
+     *   topLayerURL: "https://example.topLayerURL"
+     * }
+     * const asset = await Asset.upload(assetPayload, apiKey);
+     * ```
+     */
+    upload(assetPayload, apiKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!apiKey)
+                    throw "A valid API Key is required.";
+                const headers = { Authorization: apiKey };
+                const response = yield this.topiaPublicApi().post("/assets", assetPayload, { headers });
+                const { assetId, asset } = response.data;
+                return new Asset(this.topia, assetId, { attributes: asset });
+            }
+            catch (error) {
+                throw this.errorHandler({ error, params: assetPayload, sdkMethod: "AssetFactory.upload" });
+            }
+        });
+    }
 }
 
 /**
@@ -42423,6 +42577,30 @@ class VisitorFactory {
     }
 }
 
+/**
+ * @usage
+ * ```ts
+ * const WebRTCConnector = new WebRTCConnectorFactory(myTopiaInstance);
+ * ```
+ */
+class WebRTCConnectorFactory {
+    constructor(topia) {
+        this.topia = topia;
+    }
+    /**
+     * @summary
+     * Instantiate a new instance of WebRTCConnector class.
+     *
+     * @usage
+     * ```
+     * const userInstance = await WebRTCConnector.create({ credentials: { interactiveNonce, interactivePublicKey, urlSlug, visitorId }, twilioConfig: {} });
+     * ```
+     */
+    create(urlSlug, options) {
+        return new WebRTCConnector(this.topia, urlSlug, options);
+    }
+}
+
 /**
  * @usage
  * ```ts
@@ -42527,4 +42705,4 @@ process.on("uncaughtException", function (err) {
     process.exit(1);
 });
 
-export { Asset, AssetFactory, DroppedAsset, DroppedAssetFactory, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, World, WorldActivity, WorldActivityFactory, WorldFactory };
+export { Asset, AssetFactory, DroppedAsset, DroppedAssetFactory, SDKController, Scene, SceneFactory, Topia, User, UserFactory, Visitor, VisitorFactory, WebRTCConnector, WebRTCConnectorFactory, World, WorldActivity, WorldActivityFactory, WorldFactory };

package/package.json

@@ -56,8 +56,9 @@
     "lint": "eslint \"src/**\"",
     "docs": "typedoc",
     "pkg": "yarn && yarn build && yarn docs && npm publish",
-    "local-publish": "yarn build && yalc publish --push --no-scripts"
+    "yalc-publish": "yarn build && yalc publish",
+    "yalc-push": "yarn build && yalc publish --push --dev --no-scripts"
   },
   "type": "module",
-  "version": "0.11.10"
+  "version": "0.12.00"
 }