@chordcommerce/analytics 1.17.0 → 1.17.1

package/README.md

@@ -110,6 +110,46 @@ export const cartFormatter: CartFormatter<StorefrontCart> = (props) => {
 }
 ```
 
+addSourceMiddleware(func: AnalyticsMiddleware)
+
+Registers a middleware function to modify event properties before they are
+sent to analytics providers. Middleware functions are executed
+synchronously in the order they were added during event tracking.
+
+Parameters
+
+- func (AnalyticsMiddleware) - A middleware function that receives event
+  data and can return additional properties to merge into the event payload.
+
+Return Value
+
+The middleware function can return:
+
+- Partial<EventProperties> - Properties to merge into the event payload
+- void - No additional properties to add
+
+Useage Example
+
+```
+  analytics.addSourceMiddleware(({ payload }) => {
+    const { searchParams } = payload.obj.context.page;
+
+    return {
+      utm_source: searchParams.utm_source,
+      utm_medium: searchParams.utm_medium,
+      utm_campaign: searchParams.utm_campaign
+    };
+  });
+
+  analytics.addSourceMiddleware(({ payload }) => {
+    return {
+      session_id: getSessionId(),
+      user_agent: navigator.userAgent,
+      timestamp: Date.now()
+    };
+  });
+```
+
 ## API Reference
 
 See [Chord’s documentation](https://docs.chord.co/api-reference) for a full API reference.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chordcommerce/analytics",
   "description": "Chord Commerce event tracking",
-  "version": "1.17.0",
+  "version": "1.17.1",
   "author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
   "type": "module",
   "main": "dist/index.js",