@reactionary/source 0.3.0 → 0.3.2

package/providers/commercetools/src/test/identity.spec.ts

@@ -1,6 +1,6 @@
 import 'dotenv/config';
 import { describe, expect, it } from 'vitest';
-import { CommercetoolsClient } from '../core/client.js';
+import { CommercetoolsAPI } from '../core/client.js';
 import { getCommercetoolsTestConfiguration } from './test-utils.js';
 import {
   createInitialRequestContext,
@@ -12,7 +12,7 @@ import type { CommercetoolsConfiguration } from '../schema/configuration.schema.
 function setup() {
   const config = getCommercetoolsTestConfiguration();
   const context = createInitialRequestContext();
-  const root = new CommercetoolsClient(config, context);
+  const root = new CommercetoolsAPI(config, context);
 
   return {
     config,

package/providers/fake/project.json

@@ -1,5 +1,5 @@
 {
-  "name": "provider-fake",
+  "name": "fake",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "providers/fake/src",
   "projectType": "library",

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

@@ -1,4 +1,5 @@
 import type {
+  AnalyticsMutation,
   Cache,
   RequestContext} from '@reactionary/core';
 import {
@@ -15,4 +16,8 @@ export class FakeAnalyticsProvider extends AnalyticsProvider {
 
     this.config = config;
   }
+
+  public override async track(event: AnalyticsMutation): Promise<void> {
+    // No-op
+  }
 }

package/providers/fake/src/providers/checkout.provider.ts

@@ -29,9 +29,12 @@ import {
   CheckoutMutationFinalizeCheckoutSchema,
   success,
   type CheckoutIdentifier,
+  PaymentMethodSchema,
+  ShippingMethodSchema,
 } from '@reactionary/core';
 import type { FakeConfiguration } from '../schema/configuration.schema.js';
 import { base, en, Faker } from '@faker-js/faker';
+import z from 'zod';
 
 export class FakeCheckoutProvider extends CheckoutProvider {
   protected config: FakeConfiguration;
@@ -90,7 +93,7 @@ export class FakeCheckoutProvider extends CheckoutProvider {
 
   @Reactionary({
     inputSchema: CheckoutQueryForAvailableShippingMethodsSchema,
-    outputSchema: CheckoutSchema,
+    outputSchema: z.array(ShippingMethodSchema),
   })
   public override async getAvailableShippingMethods(
     payload: CheckoutQueryForAvailableShippingMethods
@@ -116,7 +119,7 @@ export class FakeCheckoutProvider extends CheckoutProvider {
 
   @Reactionary({
     inputSchema: CheckoutQueryForAvailablePaymentMethodsSchema,
-    outputSchema: CheckoutSchema,
+    outputSchema: z.array(PaymentMethodSchema),
   })
   public override async getAvailablePaymentMethods(
     payload: CheckoutQueryForAvailablePaymentMethods

package/providers/fake/src/providers/product.provider.ts

@@ -14,7 +14,7 @@ import {
   type Result,
   error,
   success,
-  type NotFoundError
+  type NotFoundError,
 } from '@reactionary/core';
 import type z from 'zod';
 import type { FakeConfiguration } from '../schema/configuration.schema.js';
@@ -23,7 +23,11 @@ import { base, en, Faker } from '@faker-js/faker';
 export class FakeProductProvider extends ProductProvider {
   protected config: FakeConfiguration;
 
-  constructor(config: FakeConfiguration, cache: ReactinaryCache, context: RequestContext) {
+  constructor(
+    config: FakeConfiguration,
+    cache: ReactinaryCache,
+    context: RequestContext
+  ) {
     super(cache, context);
 
     this.config = config;
@@ -31,7 +35,11 @@ export class FakeProductProvider extends ProductProvider {
 
   @Reactionary({
     inputSchema: ProductQueryByIdSchema,
-    outputSchema: ProductSchema
+    outputSchema: ProductSchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: true,
   })
   public override async getById(
     payload: ProductQueryById
@@ -41,7 +49,7 @@ export class FakeProductProvider extends ProductProvider {
 
   @Reactionary({
     inputSchema: ProductQueryBySlugSchema,
-    outputSchema: ProductSchema
+    outputSchema: ProductSchema,
   })
   public override async getBySlug(
     payload: ProductQueryBySlug
@@ -53,7 +61,9 @@ export class FakeProductProvider extends ProductProvider {
     inputSchema: ProductQueryBySKUSchema,
     outputSchema: ProductSchema,
   })
-  public override async getBySKU(payload: ProductQueryBySKU): Promise<Result<Product>> {
+  public override async getBySKU(
+    payload: ProductQueryBySKU
+  ): Promise<Result<Product>> {
     return success(this.parseSingle(payload.variant.sku));
   }
 
@@ -79,12 +89,12 @@ export class FakeProductProvider extends ProductProvider {
         ean: '',
         gtin: '',
         identifier: {
-          sku: ''
+          sku: '',
         },
         images: [],
         name: '',
         options: [],
-        upc: ''
+        upc: '',
       },
       description: generator.commerce.productDescription(),
       manufacturer: '',
@@ -93,7 +103,7 @@ export class FakeProductProvider extends ProductProvider {
       published: true,
       sharedAttributes: [],
       variants: [],
-    } satisfies Product
+    } satisfies Product;
 
     return result;
   }

package/providers/fake/src/test/cart.provider.spec.ts

@@ -72,8 +72,6 @@ describe('Fake Cart Provider', () => {
       expect(updatedCart.value.items.length).toBe(1);
       expect(updatedCart.value.items[0].variant.sku).toBe(testData.skuWithoutTiers);
       expect(updatedCart.value.items[0].quantity).toBe(3);
-      expect(updatedCart.value.items[0].price.totalPrice.value).toBe(cart.value.items[0].price.totalPrice.value * 3);
-      expect(updatedCart.value.items[0].price.unitPrice.value).toBe(cart.value.items[0].price.unitPrice.value);
     });
 
     it('should be able to remove an item from a cart', async () => {

package/providers/fake/src/test/category.provider.spec.ts

@@ -158,16 +158,16 @@ describe('Faker Category Provider', () => {
     expect(result.value.text).not.toBe('');
   });
 
-  it('returns a placeholder if you search for a category that does not exist', async () => {
+  it('returns a not found error for categories that do not exist', async () => {
     const result = await provider.getById({
       id: { key: 'non-existent-category' },
     });
 
-    if (!result.success) {
+    if (result.success) {
       assert.fail();
     }
     
-    expect(result.value.identifier.key).toBe('non-existent-category');
+    expect(result.error.type).toBe('NotFound');
   });
 
   describe('caching', () => {

package/providers/fake/src/test/checkout.provider.spec.ts

@@ -1,15 +1,11 @@
 import 'dotenv/config';
 import type { RequestContext } from '@reactionary/core';
 import {
-  CartSchema,
-  IdentitySchema,
   NoOpCache,
   createInitialRequestContext,
 } from '@reactionary/core';
 import { getFakerTestConfiguration } from './test-utils.js';
-import { FakeCartProvider } from '../providers/cart.provider.js';
-import { FakeIdentityProvider } from '../providers/index.js';
-import { describe, expect, it, beforeAll, beforeEach, assert } from 'vitest';
+import { describe, expect, it, beforeEach, assert } from 'vitest';
 import { FakeCheckoutProvider } from '../providers/checkout.provider.js';
 
 describe('Fake Checkout Provider', () => {
@@ -200,7 +196,7 @@ describe('Fake Checkout Provider', () => {
     });
 
     if (!result.success) {
-      assert.fail();
+      assert.fail(JSON.stringify(result.error));
     }
 
     expect(result.value.length).toBeGreaterThan(0);
@@ -214,7 +210,7 @@ describe('Fake Checkout Provider', () => {
     });
 
     if (!result.success) {
-      assert.fail();
+      assert.fail(JSON.stringify(result.error));
     }
 
     expect(result.value.length).toBeGreaterThan(0);

package/providers/google-analytics/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/providers/google-analytics/eslint.config.mjs

@@ -0,0 +1,25 @@
+import baseConfig from '../../eslint.config.mjs';
+
+export default [
+  ...baseConfig,
+  {
+    files: ['**/*.json'],
+    rules: {
+      '@nx/dependency-checks': [
+        'error',
+        {
+          ignoredFiles: [
+            '{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}',
+            '{projectRoot}/esbuild.config.{js,ts,mjs,mts}',
+            '{projectRoot}/vite.config.{js,ts,mjs,mts}',
+            '{projectRoot}/**/*.spec.ts',
+          ],
+          ignoredDependencies: ['vitest', '@nx/vite'],
+        },
+      ],
+    },
+    languageOptions: {
+      parser: await import('jsonc-eslint-parser'),
+    },
+  },
+];

package/providers/google-analytics/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@reactionary/google-analytics",
+  "version": "0.0.1",
+  "main": "index.js",
+  "types": "src/index.d.ts",
+  "dependencies": {
+    "@reactionary/core": "0.0.1",
+    "zod": "4.1.9"
+  },
+  "type": "module",
+  "sideEffects": false
+}

package/providers/google-analytics/project.json

@@ -0,0 +1,33 @@
+{
+  "name": "google-analytics",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "providers/google-analytics/src",
+  "projectType": "library",
+  "release": {
+    "version": {
+      "manifestRootsToUpdate": ["dist/{projectRoot}"],
+      "currentVersionResolver": "git-tag",
+      "fallbackCurrentVersionResolver": "disk"
+    }
+  },
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/esbuild:esbuild",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/providers/google-analytics",
+        "main": "providers/google-analytics/src/index.ts",
+        "tsConfig": "providers/google-analytics/tsconfig.lib.json",
+        "assets": ["providers/google-analytics/*.md"],
+        "format": ["esm"],
+        "bundle": false
+      }
+    },
+    "nx-release-publish": {
+      "options": {
+        "packageRoot": "dist/{projectRoot}"
+      }
+    }
+  }
+}

package/providers/google-analytics/src/core/initialize.ts

@@ -0,0 +1,16 @@
+import type { Cache, ClientFromCapabilities, RequestContext } from "@reactionary/core";
+import type { GoogleAnalyticsCapabilities } from "../schema/capabilities.schema.js";
+import type { GoogleAnalyticsConfiguration } from "../schema/configuration.schema.js";
+import { GoogleAnalyticsAnalyticsProvider } from "../providers/analytics.provider.js";
+
+export function googleAnalyticsCapabilities<T extends GoogleAnalyticsCapabilities>(configuration: GoogleAnalyticsConfiguration, capabilities: T) {
+    return (cache: Cache, context: RequestContext): ClientFromCapabilities<T> => {
+        const client: any = {};
+
+        if (capabilities.analytics) {
+            client.analytics = new GoogleAnalyticsAnalyticsProvider(cache, context, configuration);
+        }
+
+        return client;
+    };
+}

package/providers/google-analytics/src/index.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/providers/google-analytics/src/providers/analytics.provider.ts

@@ -0,0 +1,162 @@
+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 class GoogleAnalyticsAnalyticsProvider extends AnalyticsProvider {
+  protected config: GoogleAnalyticsConfiguration;
+
+  constructor(
+    cache: Cache,
+    context: RequestContext,
+    configuration: GoogleAnalyticsConfiguration
+  ) {
+    super(cache, context);
+
+    this.config = configuration;
+  }
+
+  protected override async processProductSummaryView(
+    event: AnalyticsMutationProductSummaryViewEvent
+  ) {
+    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);
+  }
+
+  protected override async processProductSummaryClick(
+    event: AnalyticsMutationProductSummaryClickEvent
+  ) {
+    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);
+  }
+
+  protected override async processProductDetailsView(
+    event: AnalyticsMutationProductDetailsViewEvent
+  ) {
+    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);
+  }
+
+  protected override async processProductAddToCart(
+    event: AnalyticsMutationProductAddToCartEvent
+  ) {
+    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);
+  }
+
+  protected override async processPurchase(
+    event: AnalyticsMutationPurchaseEvent
+  ) {
+    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);
+  }
+
+  protected async sendEvent(event: unknown) {
+    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),
+    });
+  }
+}

package/providers/google-analytics/src/schema/capabilities.schema.ts

@@ -0,0 +1,10 @@
+import { CapabilitiesSchema } from '@reactionary/core';
+import type { z } from 'zod';
+
+export const GoogleAnalyticsCapabilitiesSchema = CapabilitiesSchema.pick({
+  analytics: true,
+}).partial();
+
+export type GoogleAnalyticsCapabilities = z.infer<
+  typeof GoogleAnalyticsCapabilitiesSchema
+>;

package/providers/google-analytics/src/schema/configuration.schema.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+
+export const GoogleAnalyticsConfigurationSchema = z.looseObject({
+    url: z.string(),
+    measurementId: z.string(),
+    apiSecret: z.string()
+});
+
+export type GoogleAnalyticsConfiguration = z.infer<typeof GoogleAnalyticsConfigurationSchema>;

package/providers/google-analytics/src/test/analytics.provider.spec.ts

@@ -0,0 +1,93 @@
+import 'dotenv/config';
+import type { AnalyticsMutationProductSummaryViewEvent, AnalyticsMutationPurchaseEvent, RequestContext } from '@reactionary/core';
+import {
+  CartSchema,
+  IdentitySchema,
+  NoOpCache,
+  createInitialRequestContext,
+} from '@reactionary/core';
+import { describe, expect, it, beforeAll, beforeEach, assert } from 'vitest';
+import { GoogleAnalyticsAnalyticsProvider } from '../providers/analytics.provider.js';
+import type { GoogleAnalyticsConfiguration } from '../schema/configuration.schema.js';
+
+describe('Google Analytics Analytics Provider', () => {
+  let provider: GoogleAnalyticsAnalyticsProvider;
+  let reqCtx: RequestContext;
+
+  beforeEach(() => {
+    reqCtx = createInitialRequestContext();
+    const config = {
+      apiSecret: process.env['GOOGLE_ANALYTICS_API_SECRET'] || '',
+      measurementId: process.env['GOOGLE_ANALYTICS_MEASUREMENT_ID'] || '',
+      url: process.env['GOOGLE_ANALYTICS_URL'] || '',
+    } satisfies GoogleAnalyticsConfiguration;
+
+    provider = new GoogleAnalyticsAnalyticsProvider(
+      new NoOpCache(),
+      reqCtx,
+      config
+    );
+  });
+
+  describe('tracking', () => {
+    it('should be able to add an item to a cart', async () => {
+        const event = {
+            event: 'product-summary-view',
+            products: [{
+                key: 'P-5000'
+            }]
+        } satisfies AnalyticsMutationProductSummaryViewEvent;
+
+        const result = await provider.track(event);
+    });
+
+    it('should be able to track a purchase', async () => {
+        const event = {
+            event: 'purchase',
+            order: {
+                identifier: { key: 'ORDER-12345' },
+                userId: { userId: 'test-user-123' },
+                items: [
+                    {
+                        identifier: { key: 'item-1' },
+                        variant: { sku: 'SKU-001' },
+                        quantity: 2,
+                        price: {
+                            unitPrice: { value: 29.99, currency: 'EUR' },
+                            unitDiscount: { value: 0, currency: 'EUR' },
+                            totalPrice: { value: 59.98, currency: 'EUR' },
+                            totalDiscount: { value: 0, currency: 'EUR' },
+                        },
+                        inventoryStatus: 'Allocated',
+                    },
+                    {
+                        identifier: { key: 'item-2' },
+                        variant: { sku: 'SKU-002' },
+                        quantity: 1,
+                        price: {
+                            unitPrice: { value: 49.99, currency: 'EUR' },
+                            unitDiscount: { value: 5, currency: 'EUR' },
+                            totalPrice: { value: 44.99, currency: 'EUR' },
+                            totalDiscount: { value: 5, currency: 'EUR' },
+                        },
+                        inventoryStatus: 'Allocated',
+                    },
+                ],
+                price: {
+                    totalTax: { value: 21.99, currency: 'EUR' },
+                    totalDiscount: { value: 5, currency: 'EUR' },
+                    totalSurcharge: { value: 0, currency: 'EUR' },
+                    totalShipping: { value: 4.99, currency: 'EUR' },
+                    totalProductPrice: { value: 104.97, currency: 'EUR' },
+                    grandTotal: { value: 126.95, currency: 'EUR' },
+                },
+                orderStatus: 'AwaitingPayment',
+                inventoryStatus: 'Allocated',
+                paymentInstructions: [],
+            },
+        } satisfies AnalyticsMutationPurchaseEvent;
+
+        await provider.track(event);
+    });
+  });
+});

package/providers/google-analytics/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "importHelpers": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/providers/google-analytics/tsconfig.lib.json

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vitest.config.ts",
+    "vitest.config.mts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx"
+  ]
+}