@reactionary/source 0.3.0 → 0.3.1

package/documentation/docusaurus.config.js

@@ -0,0 +1,33 @@
+const path = require('path');
+
+module.exports = {
+  title: 'My Project',
+  tagline: 'Documentation',
+  url: 'https://your-site.com',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  staticDirectories: [path.resolve(__dirname, 'static')],
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+  markdown: {
+    format: 'md',
+  },
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          path: path.resolve(__dirname, 'docs'),
+          routeBasePath: '/',
+          sidebarPath: path.resolve(__dirname, 'sidebars.js'),
+        },
+        blog: false,
+        theme: {
+          customCss: path.resolve(__dirname, 'src/css/custom.css'),
+        },
+      },
+    ],
+  ],
+};

package/documentation/scripts/generate.ts

@@ -0,0 +1,52 @@
+import { zod2md } from 'zod2md';
+import { writeFileSync } from 'fs';
+import * as td from 'typedoc';
+import type { TypeDocOptions } from 'typedoc';
+import type { PluginOptions as MarkdownPluginOptions } from 'typedoc-plugin-markdown';
+import fs from 'fs/promises';
+import path from 'path';
+
+type TypedocWithMarkdownOptions = TypeDocOptions & MarkdownPluginOptions;
+
+const projects = [
+  {
+    entry: 'core/src/schemas/index.ts',
+    title: 'Schemas',
+    output: 'documentation/docs/schemas/schemas.md',
+  },
+];
+
+async function main() {
+  for (const project of projects) {
+    const markdown = await zod2md({
+      entry: project.entry,
+      title: `${project.title} Schemas`,
+      tsconfig: './core/tsconfig.lib.json',
+    });
+    writeFileSync(project.output, markdown);
+  }
+
+  const typedocConfig = {
+    entryPoints: ['core/src/providers/*.provider.ts'],
+    tsconfig: 'core/tsconfig.lib.json',
+    plugin: ['typedoc-plugin-markdown'],
+    out: 'documentation/docs/providers',
+    outputFileStrategy: 'modules',
+    categorizeByGroup: true,
+    readme: 'none',
+    membersWithOwnFile: [],
+    modulesFileName: undefined,
+  } satisfies TypedocWithMarkdownOptions;
+  const app = await td.Application.bootstrapWithPlugins(typedocConfig);
+
+  const project = await app.convert();
+  if (project) {
+    await app.generateOutputs(project);
+
+    await fs.rm(path.join('documentation/docs/providers', 'README.md'), {
+      force: true,
+    });
+  }
+}
+
+main();

package/documentation/sidebars.js

@@ -0,0 +1,8 @@
+module.exports = {
+  docs: [
+    {
+      type: 'autogenerated',
+      dirName: '.',
+    },
+  ],
+};

package/documentation/src/css/custom.css

@@ -0,0 +1,3 @@
+:root {
+  --ifm-color-primary: #2e8555;
+}

package/documentation/src/pages/index.js

@@ -0,0 +1,12 @@
+import Layout from '@theme/Layout';
+
+export default function Home() {
+  return (
+    <Layout title="Home">
+      <main style={{ padding: '2rem' }}>
+        <h1>Welcome to My Docs</h1>
+        <p>Get started by reading the <a href="/docs/intro">introduction</a>.</p>
+      </main>
+    </Layout>
+  );
+}

package/eslint.config.mjs

@@ -9,7 +9,7 @@ export default [
       '**/dist',
       '**/vite.config.*.timestamp*',
       '**/vitest.config.*.timestamp*',
-      '**/vitest.config.ts'
+      '**/vitest.config.ts',
     ],
   },
   {

package/examples/node/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@reactionary/examples-node",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {
-    "@reactionary/core": "0.3.0",
-    "@reactionary/provider-commercetools": "0.3.0",
-    "@reactionary/provider-algolia": "0.3.0",
-    "@reactionary/provider-medusa": "0.3.0",
-    "@reactionary/provider-meilisearch": "0.3.0"
+    "@reactionary/core": "0.3.1",
+    "@reactionary/provider-commercetools": "0.3.1",
+    "@reactionary/provider-algolia": "0.3.1",
+    "@reactionary/provider-medusa": "0.3.1",
+    "@reactionary/provider-meilisearch": "0.3.1"
   },
   "type": "module"
 }

package/examples/node/src/basic/basic-node-provider-model-extension.spec.ts

@@ -1,7 +1,5 @@
 import type {
   Cache,
-  ProductQueryById,
-  ProductQueryBySlug,
   RequestContext} from '@reactionary/core';
 import {
   ClientBuilder,

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@reactionary/source",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "license": "MIT",
   "private": false,
   "dependencies": {
     "@commercetools/platform-sdk": "^8.16.0",
     "@commercetools/ts-client": "^4.2.1",
+    "@commercetools/ts-sdk-apm": "^4.0.0",
+    "@docusaurus/core": "^3.9.2",
+    "@docusaurus/preset-classic": "^3.9.2",
     "@faker-js/faker": "^9.8.0",
     "@medusajs/js-sdk": "^2.13.0",
     "@opentelemetry/api": "^1.9.0",
@@ -19,7 +22,6 @@
     "meilisearch": "^0.55.0",
     "node-object-hash": "^3.1.1",
     "posthog-node": "^5.24.0",
-    "search-insights": "^2.17.3",
     "zod": "4.1.9"
   },
   "devDependencies": {
@@ -44,15 +46,23 @@
     "@types/debug": "^4.1.12",
     "@types/node": "^24.0.0",
     "@typescript-eslint/utils": "^8.33.1",
+    "@vitest/coverage-v8": "^4.0.0",
+    "docusaurus-plugin-typedoc": "^1.4.2",
+    "esbuild": "^0.19.2",
+    "jsonc-eslint-parser": "^2.1.0",
     "nx": "22.4.5",
-    "prettier": "^2.6.2",
+    "prettier": "~3.6.2",
     "ts-node": "10.9.1",
     "tslib": "^2.3.0",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "5.9.3",
     "typescript-eslint": "^8.33.1",
+    "verdaccio": "^6.0.5",
     "vite": "7.1.9",
     "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^4.0.9"
+    "vitest": "^4.0.9",
+    "zod2md": "^0.2.5"
   },
   "nx": {
     "includedScripts": []
@@ -62,5 +72,9 @@
     "provenance": false
   },
   "packageManager": "pnpm@8.15.9+sha512.499434c9d8fdd1a2794ebf4552b3b25c0a633abcee5bb15e7b5de90f32f47b513aca98cd5cfd001c31f0db454bc3804edccd578501e4ca293a6816166bbd9f81",
-  "scripts": {}
+  "scripts": {
+    "docs:start": "docusaurus start --config documentation/docusaurus.config.js",
+    "docs:build": "docusaurus build --config documentation/docusaurus.config.js",
+    "docs:generate": "node ./documentation/scripts/generate.ts"
+  }
 }

package/providers/algolia/project.json

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

package/providers/algolia/src/core/initialize.ts

@@ -2,6 +2,7 @@ import type { Cache, ClientFromCapabilities, RequestContext } from "@reactionary
 import { AlgoliaSearchProvider } from "../providers/product-search.provider.js";
 import type { AlgoliaCapabilities } from "../schema/capabilities.schema.js";
 import type { AlgoliaConfiguration } from "../schema/configuration.schema.js";
+import { AlgoliaAnalyticsProvider } from "../providers/analytics.provider.js";
 
 export function withAlgoliaCapabilities<T extends AlgoliaCapabilities>(configuration: AlgoliaConfiguration, capabilities: T) {
     return (cache: Cache, context: RequestContext): ClientFromCapabilities<T> => {
@@ -11,6 +12,10 @@ export function withAlgoliaCapabilities<T extends AlgoliaCapabilities>(configura
             client.productSearch = new AlgoliaSearchProvider(configuration, cache, context);
         }
 
+        if (capabilities.analytics) {
+            client.analytics = new AlgoliaAnalyticsProvider(cache, context, configuration);
+        }
+
         return client;
     };
 }

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

@@ -0,0 +1,112 @@
+import {
+  AnalyticsProvider,
+  type AnalyticsMutationProductAddToCartEvent,
+  type AnalyticsMutationProductSummaryClickEvent,
+  type AnalyticsMutationProductSummaryViewEvent,
+  type AnalyticsMutationPurchaseEvent,
+  type Cache,
+  type RequestContext,
+} from '@reactionary/core';
+import {
+  insightsClient,
+  type InsightsClient,
+  type ViewedObjectIDs,
+  type ClickedObjectIDsAfterSearch,
+  type AddedToCartObjectIDsAfterSearch,
+  type PurchasedObjectIDs,
+} from 'algoliasearch';
+import type { AlgoliaConfiguration } from '../schema/configuration.schema.js';
+import type { AlgoliaProductSearchIdentifier } from '../schema/search.schema.js';
+
+export class AlgoliaAnalyticsProvider extends AnalyticsProvider {
+  protected client: InsightsClient;
+  protected config: AlgoliaConfiguration;
+
+  constructor(
+    cache: Cache,
+    requestContext: RequestContext,
+    config: AlgoliaConfiguration
+  ) {
+    super(cache, requestContext);
+
+    this.config = config;
+    this.client = insightsClient(this.config.appId, this.config.apiKey);
+  }
+
+  protected override async processProductAddToCart(
+    event: AnalyticsMutationProductAddToCartEvent
+  ) {
+    if (event.source && event.source.type === 'search') {
+      const algoliaEvent = {
+        eventName: 'addToCart',
+        eventType: 'conversion',
+        eventSubtype: 'addToCart',
+        index: this.config.indexName,
+        objectIDs: [event.product.key],
+        userToken: this.context.session.identityContext.personalizationKey,
+        queryID: (event.source.identifier as AlgoliaProductSearchIdentifier)
+          .key,
+      } satisfies AddedToCartObjectIDsAfterSearch;
+
+      this.client.pushEvents({
+        events: [algoliaEvent],
+      });
+    }
+  }
+
+  protected override async processProductSummaryClick(
+    event: AnalyticsMutationProductSummaryClickEvent
+  ) {
+    if (event.source && event.source.type === 'search') {
+      const algoliaEvent = {
+        eventName: 'click',
+        eventType: 'click',
+        index: this.config.indexName,
+        objectIDs: [event.product.key],
+        userToken: this.context.session.identityContext.personalizationKey,
+        positions: [event.position],
+        queryID: (event.source.identifier as AlgoliaProductSearchIdentifier)
+          .key,
+      } satisfies ClickedObjectIDsAfterSearch;
+
+      this.client.pushEvents({
+        events: [algoliaEvent],
+      });
+    }
+  }
+
+  protected override async processProductSummaryView(
+    event: AnalyticsMutationProductSummaryViewEvent
+  ) {
+    if (event.source && event.source.type === 'search') {
+      const algoliaEvent = {
+        eventName: 'view',
+        eventType: 'view',
+        index: this.config.indexName,
+        objectIDs: event.products.map((x) => x.key),
+        userToken: this.context.session.identityContext.personalizationKey,
+      } satisfies ViewedObjectIDs;
+
+      this.client.pushEvents({
+        events: [algoliaEvent],
+      });
+    }
+  }
+
+  protected override async processPurchase(
+    event: AnalyticsMutationPurchaseEvent
+  ): Promise<void> {
+    const algoliaEvent = {
+      eventName: 'purchase',
+      eventType: 'conversion',
+      eventSubtype: 'purchase',
+      index: this.config.indexName,
+      objectIDs: event.order.items.map((x) => x.identifier.key),
+      userToken: this.context.session.identityContext.personalizationKey,
+    } satisfies PurchasedObjectIDs;
+
+    this.client.pushEvents({
+      events: [algoliaEvent],
+    });
+  }
+}

package/providers/algolia/src/providers/index.ts

@@ -1 +1,2 @@
+export * from './analytics.provider.js';
 export * from './product-search.provider.js';

package/providers/commercetools/project.json

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

package/providers/commercetools/src/providers/profile.provider.ts

@@ -237,10 +237,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
     if (addressToMakeDefault.id === customer.defaultBillingAddressId) {
       return error<InvalidInputError>({
         type: 'InvalidInput',
-        error: {
-          field: 'addressIdentifier',
-          message: 'Cannot set shipping address as default billing address',
-        }
+        error: 'Cannot set shipping address as default billing address'
       });
     }
 

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,18 @@
+{
+  "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"
+  },
+  "devDependencies": {
+    "vitest": "*",
+    "@vitest/ui": "*",
+    "@vitest/coverage-v8": "*",
+    "vite-tsconfig-paths": "*"
+  },
+  "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}"
+      }
+    }
+  }
+}