@reactionary/google-analytics 0.3.1

package/README.md

@@ -0,0 +1,11 @@
+# google-analytics
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build google-analytics` to build the library.
+
+## Running unit tests
+
+Run `nx test google-analytics` to execute the unit tests via [Vitest](https://vitest.dev/).

package/core/initialize.js

@@ -0,0 +1,13 @@
+import { GoogleAnalyticsAnalyticsProvider } from "../providers/analytics.provider.js";
+function googleAnalyticsCapabilities(configuration, capabilities) {
+  return (cache, context) => {
+    const client = {};
+    if (capabilities.analytics) {
+      client.analytics = new GoogleAnalyticsAnalyticsProvider(cache, context, configuration);
+    }
+    return client;
+  };
+}
+export {
+  googleAnalyticsCapabilities
+};

package/index.js

@@ -0,0 +1,4 @@
+export * from "./core/initialize.js";
+export * from "./providers/analytics.provider.js";
+export * from "./schema/capabilities.schema.js";
+export * from "./schema/configuration.schema.js";

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@reactionary/google-analytics",
+  "version": "0.3.1",
+  "main": "index.js",
+  "types": "src/index.d.ts",
+  "dependencies": {
+    "@reactionary/core": "0.3.1",
+    "zod": "4.1.9"
+  },
+  "devDependencies": {
+    "vitest": "*",
+    "@vitest/ui": "*",
+    "@vitest/coverage-v8": "*",
+    "vite-tsconfig-paths": "*"
+  },
+  "type": "module",
+  "sideEffects": false
+}

package/providers/analytics.provider.js

@@ -0,0 +1,127 @@
+import {
+  AnalyticsProvider
+} from "@reactionary/core";
+class GoogleAnalyticsAnalyticsProvider extends AnalyticsProvider {
+  constructor(cache, context, configuration) {
+    super(cache, context);
+    this.config = configuration;
+  }
+  async processProductSummaryView(event) {
+    const gaEvent = {
+      client_id: this.context.session.identityContext.personalizationKey,
+      user_id: this.context.session.identityContext.personalizationKey,
+      events: [
+        {
+          name: "view_item_list",
+          params: {
+            currency: this.context.languageContext.currencyCode,
+            items: event.products.map((x) => {
+              return {
+                item_id: x.key
+              };
+            })
+          }
+        }
+      ]
+    };
+    await this.sendEvent(gaEvent);
+  }
+  async processProductSummaryClick(event) {
+    const gaEvent = {
+      client_id: this.context.session.identityContext.personalizationKey,
+      user_id: this.context.session.identityContext.personalizationKey,
+      events: [
+        {
+          name: "select_item",
+          params: {
+            currency: this.context.languageContext.currencyCode,
+            items: [
+              {
+                item_id: event.product.key,
+                index: event.position
+              }
+            ]
+          }
+        }
+      ]
+    };
+    await this.sendEvent(gaEvent);
+  }
+  async processProductDetailsView(event) {
+    const gaEvent = {
+      client_id: this.context.session.identityContext.personalizationKey,
+      user_id: this.context.session.identityContext.personalizationKey,
+      events: [
+        {
+          name: "view_item",
+          params: {
+            currency: this.context.languageContext.currencyCode,
+            items: [
+              {
+                item_id: event.product.key
+              }
+            ]
+          }
+        }
+      ]
+    };
+    await this.sendEvent(gaEvent);
+  }
+  async processProductAddToCart(event) {
+    const gaEvent = {
+      client_id: this.context.session.identityContext.personalizationKey,
+      user_id: this.context.session.identityContext.personalizationKey,
+      events: [
+        {
+          name: "add_to_cart",
+          params: {
+            currency: this.context.languageContext.currencyCode,
+            items: [
+              {
+                item_id: event.product.key
+              }
+            ]
+          }
+        }
+      ]
+    };
+    await this.sendEvent(gaEvent);
+  }
+  async processPurchase(event) {
+    const gaEvent = {
+      client_id: this.context.session.identityContext.personalizationKey,
+      user_id: this.context.session.identityContext.personalizationKey,
+      events: [
+        {
+          name: "purchase",
+          params: {
+            currency: this.context.languageContext.currencyCode,
+            transaction_id: event.order.identifier.key,
+            value: event.order.price.grandTotal.value,
+            tax: event.order.price.totalTax.value,
+            shipping: event.order.price.totalShipping.value,
+            items: event.order.items.map((item) => ({
+              item_id: item.variant.sku,
+              quantity: item.quantity,
+              price: item.price.unitPrice.value
+            }))
+          }
+        }
+      ]
+    };
+    await this.sendEvent(gaEvent);
+  }
+  async sendEvent(event) {
+    const url = `${this.config.url}?measurement_id=${this.config.measurementId}&api_secret=${this.config.apiSecret}`;
+    await fetch(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(event)
+    });
+  }
+}
+export {
+  GoogleAnalyticsAnalyticsProvider
+};

package/schema/capabilities.schema.js

@@ -0,0 +1,7 @@
+import { CapabilitiesSchema } from "@reactionary/core";
+const GoogleAnalyticsCapabilitiesSchema = CapabilitiesSchema.pick({
+  analytics: true
+}).partial();
+export {
+  GoogleAnalyticsCapabilitiesSchema
+};

package/schema/configuration.schema.js

@@ -0,0 +1,9 @@
+import { z } from "zod";
+const GoogleAnalyticsConfigurationSchema = z.looseObject({
+  url: z.string(),
+  measurementId: z.string(),
+  apiSecret: z.string()
+});
+export {
+  GoogleAnalyticsConfigurationSchema
+};

package/src/core/initialize.d.ts

@@ -0,0 +1,4 @@
+import type { Cache, ClientFromCapabilities, RequestContext } from "@reactionary/core";
+import type { GoogleAnalyticsCapabilities } from "../schema/capabilities.schema.js";
+import type { GoogleAnalyticsConfiguration } from "../schema/configuration.schema.js";
+export declare function googleAnalyticsCapabilities<T extends GoogleAnalyticsCapabilities>(configuration: GoogleAnalyticsConfiguration, capabilities: T): (cache: Cache, context: RequestContext) => ClientFromCapabilities<T>;

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './core/initialize.js';
+export * from './providers/analytics.provider.js';
+export * from './schema/capabilities.schema.js';
+export * from './schema/configuration.schema.js';

package/src/providers/analytics.provider.d.ts

@@ -0,0 +1,12 @@
+import { AnalyticsProvider, type RequestContext, type Cache, type AnalyticsMutationProductSummaryViewEvent, type AnalyticsMutationProductSummaryClickEvent, type AnalyticsMutationProductDetailsViewEvent, type AnalyticsMutationProductAddToCartEvent, type AnalyticsMutationPurchaseEvent } from '@reactionary/core';
+import type { GoogleAnalyticsConfiguration } from '../schema/configuration.schema.js';
+export declare class GoogleAnalyticsAnalyticsProvider extends AnalyticsProvider {
+    protected config: GoogleAnalyticsConfiguration;
+    constructor(cache: Cache, context: RequestContext, configuration: GoogleAnalyticsConfiguration);
+    protected processProductSummaryView(event: AnalyticsMutationProductSummaryViewEvent): Promise<void>;
+    protected processProductSummaryClick(event: AnalyticsMutationProductSummaryClickEvent): Promise<void>;
+    protected processProductDetailsView(event: AnalyticsMutationProductDetailsViewEvent): Promise<void>;
+    protected processProductAddToCart(event: AnalyticsMutationProductAddToCartEvent): Promise<void>;
+    protected processPurchase(event: AnalyticsMutationPurchaseEvent): Promise<void>;
+    protected sendEvent(event: unknown): Promise<void>;
+}

package/src/schema/capabilities.schema.d.ts

@@ -0,0 +1,5 @@
+import type { z } from 'zod';
+export declare const GoogleAnalyticsCapabilitiesSchema: z.ZodObject<{
+    analytics: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$loose>;
+export type GoogleAnalyticsCapabilities = z.infer<typeof GoogleAnalyticsCapabilitiesSchema>;

package/src/schema/configuration.schema.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export declare const GoogleAnalyticsConfigurationSchema: z.ZodObject<{
+    url: z.ZodString;
+    measurementId: z.ZodString;
+    apiSecret: z.ZodString;
+}, z.core.$loose>;
+export type GoogleAnalyticsConfiguration = z.infer<typeof GoogleAnalyticsConfigurationSchema>;