@rtsdk/topia 0.11.4 → 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.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,13 +155,11 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     setDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        profileId?: string;
-        uniqueKey?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -169,13 +175,11 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        profileId?: string;
-        uniqueKey?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -192,13 +196,11 @@ declare class DroppedAsset extends Asset implements DroppedAssetInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        profileId?: string;
-        uniqueKey?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -735,13 +737,11 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     setDataObject: (dataObject: object | null | undefined, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        profileId?: string;
-        uniqueKey?: string;
     }) => Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -758,13 +758,11 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     updateDataObject: (dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        profileId?: string;
-        uniqueKey?: string;
     }) => Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -781,13 +779,11 @@ declare class World extends SDKController implements WorldInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        profileId?: string;
-        uniqueKey?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -1120,13 +1116,11 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        uniqueKey?: string;
-        urlSlug?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -1142,13 +1136,11 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        uniqueKey?: string;
-        urlSlug?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -1165,13 +1157,11 @@ declare class User extends SDKController implements UserInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        uniqueKey?: string;
-        urlSlug?: string;
     }): Promise<void | ResponseType$1>;
 }
 
@@ -1339,12 +1329,11 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     setDataObject(dataObject: object | null | undefined, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        uniqueKey?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -1360,12 +1349,11 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     updateDataObject(dataObject: object, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        uniqueKey?: string;
     }): Promise<void | ResponseType$1>;
     /**
      * @summary
@@ -1382,12 +1370,11 @@ declare class Visitor extends User implements VisitorInterface {
      * ```
      */
     incrementDataObjectValue(path: string, amount: number, options?: {
-        analytics?: string[];
+        analytics?: AnalyticType[];
         lock?: {
             lockId: string;
             releaseLock?: boolean;
         };
-        uniqueKey?: string;
     }): Promise<void | ResponseType$1>;
 }
 

package/package.json

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