@reactionary/source 0.6.1 → 0.6.3

package/README.md

@@ -144,18 +144,8 @@ Vendors:  Commercetools
   - Add to Shopping List
 
 
-### Roadmap to V0.7
-Usecase: As a B2B user i want to shop using my own prices
-Vendors:  Commercetools, Medusa
-
-- PDP / PLP
-  - [ ] External Pricing
-  - [ ] Customer specific pricing
-  - [ ] Organizational/Entitlement Context. Choose to shop private or for company?
-  - [ ] Multi currency/Multi lingual
-
 
-### Roadmap to V0.8
+### Roadmap to V0.7
 Usecase: As a B2B user i want to see my organization data
 Vendors:  Commercetools, Medusa
 
@@ -167,6 +157,19 @@ Vendors:  Commercetools, Medusa
   - [ ] Self management of users and roles
 
 
+### Roadmap to V0.8
+Usecase: As a B2B user i want to shop using my own prices
+Vendors:  Commercetools, Medusa
+
+- PDP / PLP
+  - [ ] External Pricing / Pushed prices
+  - [ ] Customer specific pricing
+  - [ ] Organizational/Entitlement Context. Choose to shop private or for company?
+  - [ ] Multi currency/Multi lingual
+
+
+
+
 ### Roadmap to V0.9
 Usecase: As a B2B user i want have multiple carts and requisition lists
 Vendors:  Commercetools
@@ -212,6 +215,25 @@ Vendors:  Commercetools
 So, you want to add to the fun, and add a new provider.
 A new provider can be as partial or as complete as you need it to be, but each capability it undertakes, must be fully supported.
 
+For creating the library in NX, the suitable command is:
+
+```npx nx g @nx/js:library packages/commercetools --publishable --importPath=@reactionary/commercetools --bundler=esbuild --linter=eslint --unitTestRunner=vitest```
+
+After that is done, there are a few manual steps for aligning the build process for the library:
+
+- In package.json
+  - Change type from "commonjs" to "module"
+  - Change main from "index.cjs" to "index.js"
+  - Change types from "./index.d.ts" to "./src/index.d.ts"
+  - Add "sideEffects": false
+- In tsconfig.json
+  - Change module from "commonjs" to "nodenext"
+  - Add "moduleResolution": "nodenext",
+- In project.json
+  - Change format from ["cjs"] to ["esm"]
+  - Remove the generatePackageJson line, if the generator still incorrectly generates it for libraries
+  - Add "bundle": false for the build target options
+
 ## Step 0
 Make sure you have a clean test environment. Ie not some half-baked instance with broken test data. Ideally, you are able to spin up and preconfigure instances via scripts.
 

package/examples/node/package.json

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

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

@@ -7,9 +7,10 @@ import {
   ProductSchema
 } from '@reactionary/core';
 import {
+  FakeProductFactory,
   FakeProductProvider,
   withFakeCapabilities,
-} from '@reactionary/provider-fake';
+} from '@reactionary/fake';
 import { createInitialRequestContext } from '@reactionary/core'
 import * as z from 'zod';
 import { describe, expect, it } from 'vitest';
@@ -23,9 +24,9 @@ describe('basic node provider extension (models)', () => {
   type ExtendedProduct = z.infer<typeof ExtendedProductModel>;
 
   class ExtendedProductProvider extends FakeProductProvider {
-    protected override parseSingle(body: string): ExtendedProduct {
+    protected override composeSingle(body: string): ExtendedProduct {
       const result = {
-        ...super.parseSingle(body),
+        ...super.composeSingle(body),
         gtin: 'gtin-1234'
       } satisfies ExtendedProduct;
 
@@ -44,7 +45,8 @@ describe('basic node provider extension (models)', () => {
             search: 1
           } },
           cache,
-          context
+          context,
+          new FakeProductFactory(ExtendedProductModel)
         ),
       };
 
@@ -66,7 +68,11 @@ describe('basic node provider extension (models)', () => {
             search: 1
           }
         },
-        { productSearch: true, product: false, identity: false }
+        {
+          productSearch: { enabled: true },
+          product: { enabled: false },
+          identity: { enabled: false },
+        }
       )
     )
     .withCapability(withExtendedCapabilities())

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

@@ -9,9 +9,10 @@ import {
   ProductSchema
 } from '@reactionary/core';
 import {
+  FakeProductFactory,
   FakeProductProvider,
   withFakeCapabilities,
-} from '@reactionary/provider-fake';
+} from '@reactionary/fake';
 import * as z from 'zod';
 import { describe, expect, it } from 'vitest';
 
@@ -60,7 +61,8 @@ describe('basic node provider extension (models)', () => {
             search: 1
           }},
           cache,
-          context
+          context,
+          new FakeProductFactory(ProductSchema)
         ),
       };
 
@@ -83,7 +85,11 @@ describe('basic node provider extension (models)', () => {
             search: 1
           }
         },
-        { productSearch: true, product: false, identity: false }
+        {
+          productSearch: { enabled: true },
+          product: { enabled: false },
+          identity: { enabled: false },
+        }
       )
     )
     .withCapability(withExtendedCapabilities())

package/examples/node/src/basic/basic-node-setup.spec.ts

@@ -6,7 +6,7 @@ import {
   type Client,
   type RequestContext,
 } from '@reactionary/core';
-import { withFakeCapabilities } from '@reactionary/provider-fake';
+import { withFakeCapabilities } from '@reactionary/fake';
 import { assert, beforeAll, beforeEach, describe, expect, it } from 'vitest';
 
 describe('basic node setup', () => {
@@ -29,7 +29,11 @@ describe('basic node setup', () => {
               search: 1,
             },
           },
-          { productSearch: true, product: true, identity: false }
+          {
+            productSearch: { enabled: true },
+            product: { enabled: true },
+            identity: { enabled: false },
+          }
         )
       )
       .withCache(new NoOpCache())

package/examples/node/src/basic/client-creation.spec.ts

@@ -1,8 +1,8 @@
 import { describe, expect, it } from 'vitest';
 import { ClientBuilder, createInitialRequestContext, NoOpCache } from '@reactionary/core';
-import { FakeProductProvider, withFakeCapabilities  } from '@reactionary/provider-fake';
-import { CommercetoolsCartProvider, withCommercetoolsCapabilities } from '@reactionary/provider-commercetools';
-import { AlgoliaProductSearchProvider, withAlgoliaCapabilities } from '@reactionary/provider-algolia';
+import { FakeProductProvider, withFakeCapabilities  } from '@reactionary/fake';
+import { CommercetoolsCartProvider, withCommercetoolsCapabilities } from '@reactionary/commercetools';
+import { AlgoliaProductSearchProvider, withAlgoliaCapabilities } from "@reactionary/algolia";
 
 describe('client creation', () => {
   it('should be able to mix providers and get a valid, typed client', async () => {
@@ -21,7 +21,7 @@ describe('client creation', () => {
               search: 1,
             },
           },
-          { product: true }
+          { product: { enabled: true } }
         )
       )
       .withCapability(
@@ -34,14 +34,14 @@ describe('client creation', () => {
          projectKey: '',
          scopes: [],
          facetFieldsForSearch: []
-        }, { cart: true })
+        }, { cart: { enabled: true } })
       )
       .withCapability(
         withAlgoliaCapabilities({
             apiKey: '',
             appId: '',
             indexName: ''
-        }, { productSearch: true })
+        }, { productSearch: { enabled: true } })
       )
       .withCache(new NoOpCache())
       .build();

package/examples/node/src/utils.ts

@@ -3,13 +3,13 @@ import {
   ClientBuilder,
   NoOpCache,
 } from '@reactionary/core';
-import type { CommercetoolsConfiguration } from '@reactionary/provider-commercetools';
-import { withCommercetoolsCapabilities } from '@reactionary/provider-commercetools';
-import { withAlgoliaCapabilities } from '@reactionary/provider-algolia';
-import { withMedusaCapabilities } from '@reactionary/provider-medusa';
-import { withMeilisearchCapabilities } from '@reactionary/provider-meilisearch';
-import { withFakeCapabilities } from '@reactionary/provider-fake';
-import type { FakeConfiguration } from '@reactionary/provider-fake';
+import type { CommercetoolsConfiguration } from '@reactionary/commercetools';
+import { withCommercetoolsCapabilities } from '@reactionary/commercetools';
+import { withAlgoliaCapabilities } from "@reactionary/algolia";
+import { withMedusaCapabilities } from '@reactionary/medusa';
+import { withMeilisearchCapabilities } from '@reactionary/meilisearch';
+import { withFakeCapabilities } from '@reactionary/fake';
+import type { FakeConfiguration } from '@reactionary/fake';
 
 export function getAlgoliaTestConfiguration() {
   return {
@@ -99,20 +99,20 @@ export function createClient(provider: PrimaryProvider) {
     if (provider === PrimaryProvider.MEDUSA) {
       builder = builder.withCapability(
         withMedusaCapabilities( getMedusaTestConfiguration(), {
-          cart: true,
-          product: true,
-          category: true,
-          checkout: true,
-          identity: true,
-          inventory: true,
-          order: true,
-          price: true,
-          productSearch: true,
-          productRecommendations: true,
-          productAssociations: true,
-          orderSearch: true,
-          store: true,
-          profile: true,
+          cart: { enabled: true },
+          product: { enabled: true },
+          category: { enabled: true },
+          checkout: { enabled: true },
+          identity: { enabled: true },
+          inventory: { enabled: true },
+          order: { enabled: true },
+          price: { enabled: true },
+          productSearch: { enabled: true },
+          productRecommendations: { enabled: true },
+          productAssociations: { enabled: true },
+          orderSearch: { enabled: true },
+          store: { enabled: true },
+          profile: { enabled: true },
         })
       );
     }
@@ -120,11 +120,11 @@ export function createClient(provider: PrimaryProvider) {
     if (provider === PrimaryProvider.FAKE) {
       builder = builder.withCapability(
         withFakeCapabilities( getFakeConfiguration() , {
-          price: true,
-          inventory: true,
-          product: true,
-          productReviews: true,
-          productAssociations: true,
+          price: { enabled: true },
+          inventory: { enabled: true },
+          product: { enabled: true },
+          productReviews: { enabled: true },
+          productAssociations: { enabled: true },
         }
       ))
     }
@@ -132,21 +132,21 @@ export function createClient(provider: PrimaryProvider) {
     if (provider === PrimaryProvider.COMMERCETOOLS) {
       builder = builder.withCapability(
         withCommercetoolsCapabilities(getCommercetoolsTestConfiguration(), {
-          cart: true,
-          product: true,
-          category: true,
-          checkout: true,
-          identity: true,
-          inventory: true,
-          order: true,
-          price: true,
-          productSearch: true,
-          productAssociations: true,
-          productReviews: true,
-          productList: true,
-          orderSearch: true,
-          store: true,
-          profile: true,
+          cart: { enabled: true },
+          product: { enabled: true },
+          category: { enabled: true },
+          checkout: { enabled: true },
+          identity: { enabled: true },
+          inventory: { enabled: true },
+          order: { enabled: true },
+          price: { enabled: true },
+          productSearch: { enabled: true },
+          productAssociations: { enabled: true },
+          productReviews: { enabled: true },
+          productList: { enabled: true },
+          orderSearch: { enabled: true },
+          store: { enabled: true },
+          profile: { enabled: true },
         })
       );
     }
@@ -155,8 +155,8 @@ export function createClient(provider: PrimaryProvider) {
   if (provider === PrimaryProvider.ALGOLIA) {
     builder = builder.withCapability(
       withAlgoliaCapabilities(getAlgoliaTestConfiguration(), {
-        productSearch: true,
-        productRecommendations: true,
+        productSearch: { enabled: true },
+        productRecommendations: { enabled: true },
       })
     );
   }
@@ -164,15 +164,15 @@ export function createClient(provider: PrimaryProvider) {
   if (provider === PrimaryProvider.MEILISEARCH) {
     builder = builder.withCapability(
       withMeilisearchCapabilities(getMeilisearchTestConfiguration(), {
-        productSearch: true,
-        orderSearch: true,
-        productRecommendations: true,
+        productSearch: { enabled: true },
+        orderSearch: { enabled: true },
+        productRecommendations: { enabled: true },
       }),
     );
     builder = builder.withCapability(
       withMedusaCapabilities(getMedusaTestConfiguration(), {
-        cart: true,
-        identity: true,
+        cart: { enabled: true },
+        identity: { enabled: true },
       })
     );
   }

package/examples/node/tsconfig.lib.json

@@ -5,5 +5,6 @@
     "declaration": true,
     "types": ["node"]
   },
-  "include": ["src/**/*.ts"]
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.spec.ts", "src/utils.ts"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/source",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "license": "MIT",
   "private": false,
   "dependencies": {

package/packages/algolia/README.md

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

package/{providers/google-analytics → packages/algolia}/eslint.config.mjs

@@ -12,9 +12,7 @@ export default [
             '{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'],
         },
       ],
     },

package/{providers → packages}/algolia/package.json

@@ -1,13 +1,15 @@
 {
-  "name": "@reactionary/provider-algolia",
+  "name": "@reactionary/algolia",
   "version": "0.0.1",
-  "main": "index.js",
-  "types": "src/index.d.ts",
+  "type": "module",
+  "main": "./index.js",
+  "types": "./src/index.d.ts",
   "dependencies": {
     "@reactionary/core": "0.0.1",
+    "zod": "4.1.9",
     "algoliasearch": "^5.48.0",
-    "zod": "4.1.9"
+    "vitest": "^4.0.9",
+    "@nx/vite": "22.4.5"
   },
-  "type": "module",
   "sideEffects": false
 }

package/{providers/posthog → packages/algolia}/project.json

@@ -1,7 +1,7 @@
 {
-  "name": "posthog",
+  "name": "algolia",
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "providers/posthog/src",
+  "sourceRoot": "packages/algolia/src",
   "projectType": "library",
   "release": {
     "version": {
@@ -16,10 +16,10 @@
       "executor": "@nx/esbuild:esbuild",
       "outputs": ["{options.outputPath}"],
       "options": {
-        "outputPath": "dist/providers/posthog",
-        "main": "providers/posthog/src/index.ts",
-        "tsConfig": "providers/posthog/tsconfig.lib.json",
-        "assets": ["providers/posthog/*.md"],
+        "outputPath": "dist/packages/algolia",
+        "main": "packages/algolia/src/index.ts",
+        "tsConfig": "packages/algolia/tsconfig.lib.json",
+        "assets": ["packages/algolia/*.md"],
         "format": ["esm"],
         "bundle": false
       }

package/{providers/algolia/src/providers/analytics.provider.ts → packages/algolia/src/capabilities/analytics.capability.ts}

@@ -1,5 +1,5 @@
 import {
-  AnalyticsProvider,
+  AnalyticsCapability,
   type AnalyticsMutationProductAddToCartEvent,
   type AnalyticsMutationProductSummaryClickEvent,
   type AnalyticsMutationProductSummaryViewEvent,
@@ -18,7 +18,7 @@ import {
 import type { AlgoliaConfiguration } from '../schema/configuration.schema.js';
 import type { AlgoliaProductSearchIdentifier } from '../schema/search.schema.js';
 
-export class AlgoliaAnalyticsProvider extends AnalyticsProvider {
+export class AlgoliaAnalyticsCapability extends AnalyticsCapability {
   protected client: InsightsClient;
   protected config: AlgoliaConfiguration;
 
@@ -48,7 +48,7 @@ export class AlgoliaAnalyticsProvider extends AnalyticsProvider {
           .key,
       } satisfies AddedToCartObjectIDsAfterSearch;
 
-      const response = await this.client.pushEvents({
+      await this.client.pushEvents({
         events: [algoliaEvent],
       });
     }
@@ -69,7 +69,7 @@ export class AlgoliaAnalyticsProvider extends AnalyticsProvider {
           .key,
       } satisfies ClickedObjectIDsAfterSearch;
 
-      const response = await this.client.pushEvents({
+      await this.client.pushEvents({
         events: [algoliaEvent],
       });
     }
@@ -87,7 +87,7 @@ export class AlgoliaAnalyticsProvider extends AnalyticsProvider {
         userToken: this.context.session.identityContext.personalizationKey,
       } satisfies ViewedObjectIDs;
 
-      const response = await this.client.pushEvents({
+      await this.client.pushEvents({
         events: [algoliaEvent],
       });
     }
@@ -107,7 +107,7 @@ export class AlgoliaAnalyticsProvider extends AnalyticsProvider {
       userToken: this.context.session.identityContext.personalizationKey,
     } satisfies PurchasedObjectIDs;
 
-    const response = await this.client.pushEvents({
+    await this.client.pushEvents({
       events: [algoliaEvent],
     });
   }

package/packages/algolia/src/capabilities/index.ts

@@ -0,0 +1,3 @@
+export * from './analytics.capability.js';
+export * from './product-search.capability.js';
+export * from './product-recommendations.capability.js';

package/{providers/algolia/src/providers/product-recommendations.provider.ts → packages/algolia/src/capabilities/product-recommendations.capability.ts}

@@ -1,6 +1,6 @@
 import {
   type Cache,
-  ProductRecommendationsProvider,
+  ProductRecommendationsCapability,
   type ProductRecommendation,
   type ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery,
   type ProductRecommendationAlgorithmSimilarProductsQuery,
@@ -29,7 +29,7 @@ import type { AlgoliaNativeRecord, AlgoliaNativeVariant } from '../schema/search
 
 
 /**
- * AlgoliaProductRecommendationsProvider
+ * AlgoliaProductRecommendationsCapability
  *
  * Provides product recommendations using Algolia's Recommend API.
  * Supports frequentlyBoughtTogether, similar, related, and trendingInCategory algorithms.
@@ -41,7 +41,7 @@ import type { AlgoliaNativeRecord, AlgoliaNativeVariant } from '../schema/search
 
 
 
-export class AlgoliaProductRecommendationsProvider extends ProductRecommendationsProvider {
+export class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapability {
   protected config: AlgoliaConfiguration;
   protected client: LiteClient;
 

package/packages/algolia/src/capabilities/product-search.capability.ts

@@ -0,0 +1,119 @@
+import {
+  type Cache,
+  type FacetIdentifier,
+  FacetIdentifierSchema,
+  type FacetValueIdentifier,
+  FacetValueIdentifierSchema,
+  ProductSearchCapability,
+  type ProductSearchFactory,
+  type ProductSearchFactoryOutput,
+  type ProductSearchFactoryWithOutput,
+  type ProductSearchQueryByTerm,
+  ProductSearchQueryByTermSchema,
+  type ProductSearchQueryCreateNavigationFilter,
+  type RequestContext,
+  type Result,
+  ProductSearchResultSchema,
+  Reactionary,
+  success,
+} from '@reactionary/core';
+import { algoliasearch } from 'algoliasearch';
+import type { AlgoliaConfiguration } from '../schema/configuration.schema.js';
+import type { AlgoliaNativeRecord } from '../schema/search.schema.js';
+import type { AlgoliaProductSearchFactory } from '../factories/product-search/product-search.factory.js';
+
+export class AlgoliaProductSearchCapability<
+  TFactory extends ProductSearchFactory = AlgoliaProductSearchFactory,
+> extends ProductSearchCapability<ProductSearchFactoryOutput<TFactory>> {
+  protected config: AlgoliaConfiguration;
+  protected factory: ProductSearchFactoryWithOutput<TFactory>;
+
+  constructor(
+    cache: Cache,
+    context: RequestContext,
+    config: AlgoliaConfiguration,
+    factory: ProductSearchFactoryWithOutput<TFactory>,
+  ) {
+    super(cache, context);
+    this.config = config;
+    this.factory = factory;
+  }
+
+  protected queryByTermPayload(payload: ProductSearchQueryByTerm) {
+    const facetsThatAreNotCategory = payload.search.facets.filter(
+      (x) => x.facet.key !== 'categories',
+    );
+    const categoryFacet =
+      payload.search.facets.find((x) => x.facet.key === 'categories') ||
+      payload.search.categoryFilter;
+
+    const finalFilters = [...(payload.search.filters || [])];
+
+    const finalFacetFilters = [
+      ...facetsThatAreNotCategory.map((x) => `${x.facet.key}:${x.key}`),
+    ];
+
+    if (categoryFacet) {
+      finalFilters.push(`categories:"${categoryFacet.key}"`);
+    }
+
+    return {
+      indexName: this.config.indexName,
+      query: payload.search.term,
+      page: payload.search.paginationOptions.pageNumber - 1,
+      hitsPerPage: payload.search.paginationOptions.pageSize,
+      facets: ['*'],
+      analytics: true,
+      clickAnalytics: true,
+      facetFilters: finalFacetFilters,
+      filters: finalFilters.join(' AND '),
+    };
+  }
+
+  @Reactionary({
+    inputSchema: ProductSearchQueryByTermSchema,
+    outputSchema: ProductSearchResultSchema,
+  })
+  public override async queryByTerm(
+    payload: ProductSearchQueryByTerm,
+  ): Promise<Result<ProductSearchFactoryOutput<TFactory>>> {
+    const client = algoliasearch(this.config.appId, this.config.apiKey);
+
+    const remote = await client.search<AlgoliaNativeRecord>({
+      requests: [this.queryByTermPayload(payload)],
+    });
+
+    const input = remote.results[0];
+    const result = this.factory.parseSearchResult(this.context, input, payload);
+
+    for (const selectedFacet of payload.search.facets) {
+      const facet = result.facets.find(
+        (f) => f.identifier.key === selectedFacet.facet.key,
+      );
+      if (!facet) {
+        continue;
+      }
+      const value = facet.values.find((v) => v.identifier.key === selectedFacet.key);
+      if (value) {
+        value.active = true;
+      }
+    }
+
+    return success(result);
+  }
+
+  public override async createCategoryNavigationFilter(
+    payload: ProductSearchQueryCreateNavigationFilter,
+  ): Promise<Result<FacetValueIdentifier>> {
+    const facetIdentifier = FacetIdentifierSchema.parse({
+      key: 'categories',
+    } satisfies Partial<FacetIdentifier>);
+
+    const facetValueIdentifier = FacetValueIdentifierSchema.parse({
+      facet: facetIdentifier,
+      key: payload.categoryPath.map((c) => c.name).join(' > '),
+    } satisfies Partial<FacetValueIdentifier>);
+
+    return success(facetValueIdentifier);
+  }
+}