@rtsdk/topia 0.1.1 → 0.2.0

package/dist/index.cjs

@@ -39751,21 +39751,20 @@ const {
  */
 class SDKController {
     constructor(topia, credentials = {}) {
-        const { assetId, interactiveNonce, visitorId, apiKey } = credentials;
+        const { assetId = null, interactiveNonce = null, visitorId = null, apiKey = null } = 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;
-        }
+        payload = {
+            interactiveNonce,
+            visitorId,
+            assetId,
+            date: new Date(),
+        };
+        this.jwt = jwt.sign(payload, topia.interactiveSecret);
+        headers.InteractiveJWT = this.jwt;
         if (apiKey) {
             headers.Authorization = apiKey;
         }
@@ -40022,7 +40021,7 @@ class DroppedAsset extends Asset {
      * });
      * ```
      */
-    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, portalName, position, }) {
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }) {
         try {
             return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, {
                 clickType,
@@ -40030,6 +40029,8 @@ class DroppedAsset extends Asset {
                 clickableLinkTitle,
                 clickableDisplayTextDescription,
                 clickableDisplayTextHeadline,
+                isForceLinkInIframe,
+                isOpenLinkInDrawer,
                 portalName,
                 position,
             }, "change-click-type");
@@ -40579,7 +40580,7 @@ var _User_assetsMap, _User_scenesMap, _User_worldsMap;
  * ```
  */
 class User extends SDKController {
-    constructor(topia, options = { credentials: {} }) {
+    constructor(topia, options = { profileId: null, credentials: {} }) {
         super(topia, options.credentials);
         _User_assetsMap.set(this, void 0);
         _User_scenesMap.set(this, void 0);
@@ -40587,6 +40588,9 @@ class User extends SDKController {
         __classPrivateFieldSet(this, _User_assetsMap, {}, "f");
         __classPrivateFieldSet(this, _User_scenesMap, {}, "f");
         __classPrivateFieldSet(this, _User_worldsMap, {}, "f");
+        this.profileId = options.profileId;
+        this.dataObject = {};
+        this.profile = {};
     }
     get assets() {
         return __classPrivateFieldGet(this, _User_assetsMap, "f");
@@ -40679,6 +40683,85 @@ class User extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieves the data object for a visitor.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchUserDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    fetchUserDataObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!this.profileId)
+                    throw "This method requires the use of a profileId";
+                const response = yield this.topiaPublicApi().get(`/user/dataObjects/${this.profileId}/get-data-object`, this.requestOptions);
+                this.dataObject = response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Sets the data object for a visitor.
+     *
+     * 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.setUserDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    setUserDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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, lock }, this.requestOptions);
+                this.dataObject = dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Updates the data object for a visitor.
+     *
+     * 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.updateUserDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    updateUserDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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, lock }, this.requestOptions);
+                this.dataObject = dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
 }
 _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
@@ -40762,6 +40845,79 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieves the data object for a visitor.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchVisitorDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    fetchVisitorDataObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/visitor/${this.urlSlug}/visitors/${this.id}/get-data-object`, this.requestOptions);
+                this.dataObject = response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Sets the data object for a visitor.
+     *
+     * 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.setVisitorDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    setVisitorDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { lock = {} } = options;
+                yield this.topiaPublicApi().put(`/visitor/${this.urlSlug}/visitors/${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 visitor.
+     *
+     * 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.updateVisitorDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    updateVisitorDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { lock = {} } = options;
+                yield this.topiaPublicApi().put(`/visitor/${this.urlSlug}/visitors/${this.id}/update-data-object`, { dataObject, lock }, this.requestOptions);
+                this.dataObject = dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
 }
 
 var _WorldActivity_visitorsMap;

package/dist/index.js

@@ -39749,21 +39749,20 @@ const {
  */
 class SDKController {
     constructor(topia, credentials = {}) {
-        const { assetId, interactiveNonce, visitorId, apiKey } = credentials;
+        const { assetId = null, interactiveNonce = null, visitorId = null, apiKey = null } = 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;
-        }
+        payload = {
+            interactiveNonce,
+            visitorId,
+            assetId,
+            date: new Date(),
+        };
+        this.jwt = jwt.sign(payload, topia.interactiveSecret);
+        headers.InteractiveJWT = this.jwt;
         if (apiKey) {
             headers.Authorization = apiKey;
         }
@@ -40020,7 +40019,7 @@ class DroppedAsset extends Asset {
      * });
      * ```
      */
-    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, portalName, position, }) {
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }) {
         try {
             return __classPrivateFieldGet(this, _DroppedAsset_updateDroppedAsset, "f").call(this, {
                 clickType,
@@ -40028,6 +40027,8 @@ class DroppedAsset extends Asset {
                 clickableLinkTitle,
                 clickableDisplayTextDescription,
                 clickableDisplayTextHeadline,
+                isForceLinkInIframe,
+                isOpenLinkInDrawer,
                 portalName,
                 position,
             }, "change-click-type");
@@ -40577,7 +40578,7 @@ var _User_assetsMap, _User_scenesMap, _User_worldsMap;
  * ```
  */
 class User extends SDKController {
-    constructor(topia, options = { credentials: {} }) {
+    constructor(topia, options = { profileId: null, credentials: {} }) {
         super(topia, options.credentials);
         _User_assetsMap.set(this, void 0);
         _User_scenesMap.set(this, void 0);
@@ -40585,6 +40586,9 @@ class User extends SDKController {
         __classPrivateFieldSet(this, _User_assetsMap, {}, "f");
         __classPrivateFieldSet(this, _User_scenesMap, {}, "f");
         __classPrivateFieldSet(this, _User_worldsMap, {}, "f");
+        this.profileId = options.profileId;
+        this.dataObject = {};
+        this.profile = {};
     }
     get assets() {
         return __classPrivateFieldGet(this, _User_assetsMap, "f");
@@ -40677,6 +40681,85 @@ class User extends SDKController {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieves the data object for a visitor.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchUserDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    fetchUserDataObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!this.profileId)
+                    throw "This method requires the use of a profileId";
+                const response = yield this.topiaPublicApi().get(`/user/dataObjects/${this.profileId}/get-data-object`, this.requestOptions);
+                this.dataObject = response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Sets the data object for a visitor.
+     *
+     * 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.setUserDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    setUserDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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, lock }, this.requestOptions);
+                this.dataObject = dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Updates the data object for a visitor.
+     *
+     * 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.updateUserDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    updateUserDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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, lock }, this.requestOptions);
+                this.dataObject = dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
 }
 _User_assetsMap = new WeakMap(), _User_scenesMap = new WeakMap(), _User_worldsMap = new WeakMap();
 
@@ -40760,6 +40843,79 @@ class Visitor extends User {
             }
         });
     }
+    /**
+     * @summary
+     * Retrieves the data object for a visitor.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchVisitorDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    fetchVisitorDataObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.topiaPublicApi().get(`/visitor/${this.urlSlug}/visitors/${this.id}/get-data-object`, this.requestOptions);
+                this.dataObject = response.data;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
+    /**
+     * @summary
+     * Sets the data object for a visitor.
+     *
+     * 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.setVisitorDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    setVisitorDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { lock = {} } = options;
+                yield this.topiaPublicApi().put(`/visitor/${this.urlSlug}/visitors/${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 visitor.
+     *
+     * 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.updateVisitorDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    updateVisitorDataObject(dataObject, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { lock = {} } = options;
+                yield this.topiaPublicApi().put(`/visitor/${this.urlSlug}/visitors/${this.id}/update-data-object`, { dataObject, lock }, this.requestOptions);
+                this.dataObject = dataObject;
+            }
+            catch (error) {
+                throw this.errorHandler({ error });
+            }
+        });
+    }
 }
 
 var _WorldActivity_visitorsMap;

package/dist/types/src/controllers/DroppedAsset.d.ts

@@ -127,7 +127,7 @@ export declare class DroppedAsset extends Asset implements DroppedAssetInterface
      * });
      * ```
      */
-    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType>;
+    updateClickType({ clickType, clickableLink, clickableLinkTitle, clickableDisplayTextDescription, clickableDisplayTextHeadline, isForceLinkInIframe, isOpenLinkInDrawer, portalName, position, }: UpdateClickTypeInterface): Promise<void | ResponseType>;
     /**
      * @summary
      * Updates text and style of a dropped asset.

package/dist/types/src/controllers/User.d.ts

@@ -16,6 +16,9 @@ import { ResponseType } from "types";
  */
 export declare class User extends SDKController {
     #private;
+    profileId?: string | null;
+    dataObject?: object;
+    profile?: object;
     constructor(topia: Topia, options?: UserOptionalInterface);
     get assets(): {
         [key: string]: Asset;
@@ -54,5 +57,56 @@ export declare class User extends SDKController {
      * ```
      */
     fetchWorldsByKey(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Retrieves the data object for a visitor.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchUserDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    fetchUserDataObject(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Sets the data object for a visitor.
+     *
+     * 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.setUserDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    setUserDataObject(dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates the data object for a visitor.
+     *
+     * 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.updateUserDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    updateUserDataObject(dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 export default User;

package/dist/types/src/controllers/Visitor.d.ts

@@ -46,5 +46,56 @@ export declare class Visitor extends User implements VisitorInterface {
      * Updates each Visitor instance and world.visitors map.
      */
     moveVisitor({ shouldTeleportVisitor, x, y }: MoveVisitorInterface): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Retrieves the data object for a visitor.
+     *
+     * @usage
+     * ```ts
+     * await droppedAsset.fetchVisitorDataObject();
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    fetchVisitorDataObject(): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Sets the data object for a visitor.
+     *
+     * 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.setVisitorDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    setVisitorDataObject(dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
+    /**
+     * @summary
+     * Updates the data object for a visitor.
+     *
+     * 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.updateVisitorDataObject({
+     *   "exampleKey": "exampleValue",
+     * });
+     * const { dataObject } = droppedAsset;
+     * ```
+     */
+    updateVisitorDataObject(dataObject: object, options?: {
+        lock?: {
+            lockId: string;
+            releaseLock?: boolean;
+        };
+    }): Promise<void | ResponseType>;
 }
 export default Visitor;

package/dist/types/src/interfaces/DroppedAssetInterfaces.d.ts

@@ -79,6 +79,8 @@ export interface UpdateClickTypeInterface {
     clickableLinkTitle: string;
     clickableDisplayTextDescription: string;
     clickableDisplayTextHeadline: string;
+    isForceLinkInIframe?: boolean;
+    isOpenLinkInDrawer?: boolean;
     portalName: string;
     position: {
         x: number;

package/dist/types/src/interfaces/UserInterfaces.d.ts

@@ -1,6 +1,7 @@
 import { InteractiveCredentials } from "types";
 export interface UserOptionalInterface {
     credentials?: InteractiveCredentials | object;
+    profileId?: string | null;
     visitorId?: number | null;
     urlSlug?: string;
 }

package/package.json

@@ -56,6 +56,5 @@
     "local-publish": "yarn build && yalc publish --push --no-scripts"
   },
   "type": "module",
-  "types": "dist/types/src/index.d.ts",
-  "version": "0.1.1"
+  "version": "0.2.0"
 }