@threekit/analytics - npm Package Compare versions

Comparing version 0.1.102 to 0.1.103

package.json

 {
   "name": "@threekit/analytics",
-  "version": "0.1.102",
+  "version": "0.1.103",
   "type": "module",
@@ -9,7 +9,7 @@ "main": "dist/index.js",
     "@threekit/diagnostics": "*",
-    "@threekit/rest-api": "^0.1.102",
+    "@threekit/rest-api": "^0.1.103",
     "uuid": "^9.0.1"
   },
   "sideEffects": false,
-  "gitHead": "800bdf4d1c06e4c22bdb4f6445b042d6c0e96369"
+  "gitHead": "9a00149f48c3755dd5606d64739eb6b4411ef453"
 }

README.md

@@ -122,3 +122,3 @@ # @Threekit/Analytics
 
-## Errors
+### Errors
 
@@ -172,2 +172,46 @@ You can record any errors on the frontend to analytics, just pass in the error object (which must be derived from the JavaScript Error class):
 
+### Augmented Reality
+
+When the user requests a augmented reality experience, two events can be sent. The first is to request an AR experience and then a second once that AR experience ia launched.
+
+```ts
+getCurrentSession().ar({
+  arStage: ARStage.Offered,
+  arHandoffId: userId
+});
+```
+
+### Personalize Text
+
+When the user is personalizing an item with custom text, use this event:
+
+```ts
+getCurrentSession().personalizeText({
+  personalizeId: 'Label Text',
+  personalizedText: labelText
+});
+```
+
+### Parametric Value
+
+When the user sets parametric values on an item, record those changes with this event:
+
+```ts
+getCurrentSession().parametricValue({
+  parametricId: 'Table Width',
+  parametricValue: tableWidth
+});
+```
+
+### Image Upload
+
+When you allow a user to upload custom images, record those uploads with this event:
+
+```ts
+getCurrentSession().imageUpload({
+  imageUploadId: 'Front Image',
+  imageUploadFileId: fileID
+});
+```
+
 ### Share
@@ -174,0 +218,0 @@

No alert changes

Improved metrics

Total package byte prevSize

197823

increased by0.48%

Number of lines in readme file

289

increased by17.96%

Dependency changes

• Updated@threekit/rest-api@^0.1.103