@rtsdk/topia 0.11.3 → 0.11.5

package/README.md

@@ -243,10 +243,38 @@ try {
 Once complete be sure to also call `await keyAsset.updateDataObject({ turnCount: turnCount + 1 });` so that the next player is free to take their turn!
 
 **Custom analytics**
-You can leverage the data object methods for all types to track analytics unique to your Public Key by passing `analytics` as an optional array to all calls that set, update, or increment data objects!
+You can leverage the data object methods for all types to track analytics unique to your Public Key by passing `analytics` as an optional array along with `profileId`, `urlSlug`, and/or `uniqueKey` to all calls that set, update, or increment data objects!
+
+**World** and **Dropped Asset** classes will automatically include `urlSlug`. In addition to `analytics` you can also pass `profileId` if you want to track event per user and/or a `uniqueKey` to additionally track uniqueness of the event for all time, per user (if `profileId` is included), and per world.
+
+Examples leveraging World data objects calls:
+
+```js
+await world.setDataObject({ hello: "world" }, { analytics: [{ analyticName: "resets"} ], lock: { lockId, releaseLock: true });
+
+await world.updateDataObject({}, { analytics: [ {analyticName: "matches", uniqueKey: `${playerOneProfileId}-${playerTwoProfileId}`, urlSlug }], });
+
+await world.incrementDataObjectValue(`keyAssets.${assetId}.completions`, 1, { analytics: [{ analyticName:"completions", incrementBy: 2, profileId, uniqueKey: profileId, urlSlug }] });
+```
+
+**Visitor** and **User** classes will automatically include `profileId`. In addition to `analytics` you can also pass `urlSlug` if you want to track event per world and/or a `uniqueKey` to additionally track uniqueness of the event for all time, per user, and per world (if `urlSlug` is included).
+
+Examples leveraging Visitor data objects calls:
 
 ```js
-await droppedAsset.updateDataObject({ isResetInProgress: true }, { analytics: ["resetCount"], lock: { lockId } });
+await visitor.setDataObject(
+  { hello: "world" },
+  { analytics: [{ analyticName: "starts" }], lock: { lockId, releaseLock: true } },
+);
+
+await visitor.updateDataObject(
+  {},
+  { analytics: [{ analyticName: "emotesUnlocked", profileId, uniqueKey: profileId }] },
+);
+
+await visitor.incrementDataObjectValue(`completions`, 1, {
+  analytics: [{ analyticName: "completions", incrementBy: 2, profileId, urlSlug, uniqueKey: profileId }],
+});
 ```
 
 Note: This does NOT impact the data objects themselves but rather allows you to track custom analytics (incremented by 1) across all instances of your application with a given Public Key.

package/dist/index.cjs

@@ -39863,8 +39863,7 @@ class DroppedAsset extends Asset {
     setDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -39889,8 +39888,7 @@ class DroppedAsset extends Asset {
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -39915,8 +39913,7 @@ class DroppedAsset extends Asset {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({
@@ -40461,8 +40458,7 @@ class World extends SDKController {
          */
         this.setDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -40485,8 +40481,7 @@ class World extends SDKController {
          */
         this.updateDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -40964,8 +40959,7 @@ class World extends SDKController {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics, lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({
@@ -41519,8 +41513,7 @@ class User extends SDKController {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -41546,8 +41539,7 @@ class User extends SDKController {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -41572,8 +41564,7 @@ class User extends SDKController {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { path, amount, options }, sdkMethod: "User.incrementDataObjectValue" });
@@ -41891,8 +41882,7 @@ class Visitor extends User {
     setDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -41916,8 +41906,7 @@ class Visitor extends User {
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -41942,8 +41931,7 @@ class Visitor extends User {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({

package/dist/index.d.ts

@@ -77,6 +77,14 @@ declare class Scene extends SDKController implements SceneInterface {
     fetchSceneById(): Promise<void | ResponseType$1>;
 }
 
+type AnalyticType = {
+    analyticName: string;
+    incrementBy?: number;
+    profileId?: string;
+    uniqueKey?: string;
+    urlSlug?: string;
+};
+
 /**
  * @summary
  * Create an instance of Dropped Asset class with a given dropped asset id, url slug, and optional attributes and session credentials.
@@ -147,7 +155,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     setDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -167,7 +175,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -188,7 +196,7 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -729,7 +737,7 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     setDataObject: (dataObject: object | null | undefined, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -750,7 +758,7 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     updateDataObject: (dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -771,7 +779,7 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1108,7 +1116,7 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1128,7 +1136,7 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1149,7 +1157,7 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1321,7 +1329,7 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1341,7 +1349,7 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
@@ -1362,7 +1370,7 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;

package/dist/index.js

@@ -39861,8 +39861,7 @@ class DroppedAsset extends Asset {
     setDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -39887,8 +39886,7 @@ class DroppedAsset extends Asset {
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -39913,8 +39911,7 @@ class DroppedAsset extends Asset {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/assets/${this.id}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({
@@ -40459,8 +40456,7 @@ class World extends SDKController {
          */
         this.setDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -40483,8 +40479,7 @@ class World extends SDKController {
          */
         this.updateDataObject = (dataObject, options = {}) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -40962,8 +40957,7 @@ class World extends SDKController {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics, lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({
@@ -41517,8 +41511,7 @@ class User extends SDKController {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -41544,8 +41537,7 @@ class User extends SDKController {
             try {
                 if (!this.profileId)
                     throw "This method requires the use of a profileId";
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -41570,8 +41562,7 @@ class User extends SDKController {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/user/dataObjects/${this.profileId}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({ error, params: { path, amount, options }, sdkMethod: "User.incrementDataObjectValue" });
@@ -41889,8 +41880,7 @@ class Visitor extends User {
     setDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/set-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/set-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = Object.assign(Object.assign({}, (this.dataObject || {})), (dataObject || {}));
             }
             catch (error) {
@@ -41914,8 +41904,7 @@ class Visitor extends User {
     updateDataObject(dataObject, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/update-data-object`, { analytics, dataObject: dataObject || this.dataObject, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/update-data-object`, Object.assign(Object.assign({}, options), { dataObject: dataObject || this.dataObject }), this.requestOptions);
                 this.dataObject = dataObject || this.dataObject;
             }
             catch (error) {
@@ -41940,8 +41929,7 @@ class Visitor extends User {
     incrementDataObjectValue(path, amount, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const { analytics = [], lock = {} } = options;
-                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/increment-data-object-value`, { path, amount, analytics, lock }, this.requestOptions);
+                yield this.topiaPublicApi().put(`/world/${this.urlSlug}/visitors/${this.id}/increment-data-object-value`, Object.assign({ path, amount }, options), this.requestOptions);
             }
             catch (error) {
                 throw this.errorHandler({

package/package.json

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