@reactionary/source 0.3.18 → 0.6.2

package/core/src/providers/product-search.provider.ts

@@ -1,15 +1,21 @@
-import type { Category, FacetIdentifier, FacetValueIdentifier, Result } from '../index.js';
-import type { ProductSearchResult, ProductSearchResultFacet, ProductSearchResultFacetValue, ProductSearchResultItemVariant } from '../schemas/models/product-search.model.js';
-import type { ProductSearchQueryByTerm, ProductSearchQueryCreateNavigationFilter } from '../schemas/queries/product-search.query.js';
+import type { Category, FacetValueIdentifier, Result } from '../index.js';
+import type { ProductSearchResult } from '../schemas/models/product-search.model.js';
+import type {
+  ProductSearchQueryByTerm,
+  ProductSearchQueryCreateNavigationFilter,
+} from '../schemas/queries/product-search.query.js';
 import { BaseProvider } from './base.provider.js';
 
-export abstract class ProductSearchProvider extends BaseProvider {
+export abstract class ProductSearchProvider<
+  TProductSearchResult extends ProductSearchResult = ProductSearchResult,
+> extends BaseProvider {
   protected override getResourceName(): string {
     return 'product-search';
   }
 
-public abstract queryByTerm(payload: ProductSearchQueryByTerm): Promise<Result<ProductSearchResult>>;
-
+  public abstract queryByTerm(
+    payload: ProductSearchQueryByTerm,
+  ): Promise<Result<TProductSearchResult>>;
 
   /**
    * Since each platform has it own way of representing categories and their hierarchy, we leave it to the platform to tell us how to get from a
@@ -29,7 +35,9 @@ public abstract queryByTerm(payload: ProductSearchQueryByTerm): Promise<Result<P
    *
    * @param categoryPath
    */
-  public abstract createCategoryNavigationFilter(payload: ProductSearchQueryCreateNavigationFilter): Promise<Result<FacetValueIdentifier>>;
+  public abstract createCategoryNavigationFilter(
+    payload: ProductSearchQueryCreateNavigationFilter,
+  ): Promise<Result<FacetValueIdentifier>>;
 
   /**
    * Parses a facet value from the search response.
@@ -37,25 +45,4 @@ public abstract queryByTerm(payload: ProductSearchQueryByTerm): Promise<Result<P
    * @param label The label for the facet value.
    * @param count The count for the facet value.
    */
-  protected abstract parseFacetValue(facetValueIdentifier: FacetValueIdentifier,  label: string, count: number) : ProductSearchResultFacetValue;
-
-  /**
-   * Parses a facet from the search response.
-   * @param facetIdentifier The identifier for the facet.
-   * @param facetValue The value for the facet.
-   *
-   * Usecase: Override this to customize the parsing of facets.
-   */
-  protected abstract parseFacet(facetIdentifier: FacetIdentifier,  facetValue: unknown) : ProductSearchResultFacet;
-
-  /**
-   * Parses a product variant from the search response.
-   * @param variant The variant data from the search response.
-   * @param product The product data from the search response.
-   *
-   * Usecase: Override this to customize the parsing of product variants.
-   */
-  protected abstract parseVariant(variant: unknown, product: unknown): ProductSearchResultItemVariant;
 }
-
-

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

@@ -4,7 +4,7 @@ import type { ProductQueryById, ProductQueryBySKU, ProductQueryBySlug } from '..
 import type { Result } from '../schemas/result.js';
 import type { NotFoundError } from '../schemas/index.js';
 
-export abstract class ProductProvider extends BaseProvider {
+export abstract class ProductProvider<TProduct extends Product = Product> extends BaseProvider {
 
 
   /**
@@ -17,7 +17,7 @@ export abstract class ProductProvider extends BaseProvider {
    * Marketing will TYPICALLY recommend products, and in some cases maybe HeroVariants of a product.
    * In that case, you would need to resolve the product to its hero variant first, and then get the SKU from there.
    */
-  public abstract getById(payload: ProductQueryById): Promise<Result<Product>>;
+  public abstract getById(payload: ProductQueryById): Promise<Result<TProduct>>;
 
 
   /**
@@ -27,7 +27,7 @@ export abstract class ProductProvider extends BaseProvider {
    *
    * Usecase: You are rendering a product detail page, and you need to fetch the product by its slug.
    */
-  public abstract getBySlug(payload: ProductQueryBySlug): Promise<Result<Product, NotFoundError>>;
+  public abstract getBySlug(payload: ProductQueryBySlug): Promise<Result<TProduct, NotFoundError>>;
 
 
   /**
@@ -39,9 +39,9 @@ export abstract class ProductProvider extends BaseProvider {
    * and you need to fetch the product details for that SKU. You will get the a Product back, with the variant matching the SKU set as heroSku.
    * It might also be used on a quick-order page, or product recommendations from external system.
    */
-  public abstract getBySKU(payload: ProductQueryBySKU): Promise<Result<Product>>;
+  public abstract getBySKU(payload: ProductQueryBySKU): Promise<Result<TProduct>>;
 
-  protected createEmptyProduct(id: string): Product {
+  protected createEmptyProduct(id: string): TProduct {
     // FIXME: We can probably get rid of this once we switch to errors as values, as we shouldn't even
     // be materializing an empty product...
     const product = {
@@ -73,7 +73,7 @@ export abstract class ProductProvider extends BaseProvider {
       variants: [],
     } satisfies Product;
 
-    return product;
+    return product as unknown as TProduct;
   }
 
   /**

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

@@ -5,7 +5,7 @@ import type { ProfileQuerySelf as ProfileQueryById } from '../schemas/queries/in
 import type { Result } from '../schemas/result.js';
 import { BaseProvider } from './base.provider.js';
 
-export abstract class ProfileProvider extends BaseProvider {
+export abstract class ProfileProvider<TProfile extends Profile = Profile> extends BaseProvider {
 
   /**
    * Returns the profile of the currently authenticated (registered) user.
@@ -13,7 +13,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: Fetch the profile of the logged-in user for display in header, or account settings.
    * @param payload
    */
-  public abstract getById(payload: ProfileQueryById): Promise<Result<Profile, NotFoundError>>;
+  public abstract getById(payload: ProfileQueryById): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Updates the base profile information of the currently authenticated (registered) user.
@@ -26,7 +26,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: Update the user's name, email, or phone number.
    * @param payload
    */
-  public abstract update(payload: ProfileMutationUpdate): Promise<Result<Profile, NotFoundError>>;
+  public abstract update(payload: ProfileMutationUpdate): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Creates a new shipping address for the currently authenticated (registered) user.
@@ -36,7 +36,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * done at checkout should be considered local to that session, unless the addressbook is empty.
    * @param payload
    */
-  public abstract addShippingAddress(payload: ProfileMutationAddShippingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract addShippingAddress(payload: ProfileMutationAddShippingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Updates an existing shipping address for the currently authenticated (registered) user.
@@ -45,7 +45,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * done at checkout should be considered local to that session/order, unless the addressbook is empty.
    * @param payload
    */
-  public abstract updateShippingAddress(payload: ProfileMutationUpdateShippingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract updateShippingAddress(payload: ProfileMutationUpdateShippingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Removes an existing shipping address for the currently authenticated (registered) user.
@@ -55,7 +55,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: User deletes a shipping address from their profile.
    * @param payload
    */
-  public abstract removeShippingAddress(payload: ProfileMutationRemoveShippingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract removeShippingAddress(payload: ProfileMutationRemoveShippingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Configures an existing shipping address as the default shipping address for the currently authenticated (registered) user.
@@ -63,7 +63,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * Usecase: User selects a default shipping address in their profile.
    * @param payload
    */
-  public abstract makeShippingAddressDefault(payload: ProfileMutationMakeShippingAddressDefault): Promise<Result<Profile, NotFoundError>>;
+  public abstract makeShippingAddressDefault(payload: ProfileMutationMakeShippingAddressDefault): Promise<Result<TProfile, NotFoundError>>;
 
   /**
    * Sets the current/active billing address for the currently authenticated (registered) user.
@@ -74,7 +74,7 @@ export abstract class ProfileProvider extends BaseProvider {
    * entity being billed, and as such it makes sense to have a single authoritative billing address.
    * @param payload
    */
-  public abstract setBillingAddress(payload: ProfileMutationSetBillingAddress): Promise<Result<Profile, NotFoundError>>;
+  public abstract setBillingAddress(payload: ProfileMutationSetBillingAddress): Promise<Result<TProfile, NotFoundError>>;
 
   protected override getResourceName(): string {
     return 'profile';

package/core/src/providers/store.provider.ts

@@ -3,8 +3,8 @@ import type { StoreQueryByProximity } from '../schemas/queries/index.js';
 import type { Result } from '../schemas/result.js';
 import { BaseProvider } from './base.provider.js';
 
-export abstract class StoreProvider extends BaseProvider {
-  public abstract queryByProximity(payload: StoreQueryByProximity): Promise<Result<Array<Store>>>;
+export abstract class StoreProvider<TStore extends Store = Store> extends BaseProvider {
+  public abstract queryByProximity(payload: StoreQueryByProximity): Promise<Result<Array<TStore>>>;
 
   protected override getResourceName(): string {
     return 'store';

package/core/src/test/client-builder.spec.ts

@@ -8,6 +8,7 @@ import { NoOpCache } from "../cache/noop-cache.js";
 import { createInitialRequestContext } from "../initialization.js";
 import { ClientBuilder } from "../client/client-builder.js";
 import type { Client } from "../client/client.js";
+import { ProductProvider } from "../providers/product.provider.js";
 
 export class MockAnalyticsProvider extends AnalyticsProvider {
     public events: Array<AnalyticsMutation> = [];
@@ -57,4 +58,84 @@ describe('Client Builder', () => {
     expect(secondaryAnalyticsProvider.events.length).toBe(1);
     expect(secondaryAnalyticsProvider.events[0].event).toBe('product-details-view');
   });
+
+  it('supports capability factories with args object signature', () => {
+    const cache = new NoOpCache();
+    const context = createInitialRequestContext();
+    const builder = new ClientBuilder(context);
+    const analyticsProvider = new MockAnalyticsProvider(cache, context);
+
+    const client = builder
+      .withCache(cache)
+      .withCapability(({ cache: sharedCache, context: sharedContext }) => {
+        expect(sharedCache).toBe(cache);
+        expect(sharedContext).toBe(context);
+        return { analytics: analyticsProvider };
+      })
+      .build();
+
+    expect(client.analytics).toBeDefined();
+  });
+
+  it('supports throw collision strategy', () => {
+    const cache = new NoOpCache();
+    const context = createInitialRequestContext();
+    const builder = new ClientBuilder(context);
+
+    class TestProductProvider extends ProductProvider {
+      public override async getById(): Promise<any> {
+        throw new Error('not implemented');
+      }
+      public override async getBySlug(): Promise<any> {
+        throw new Error('not implemented');
+      }
+      public override async getBySKU(): Promise<any> {
+        throw new Error('not implemented');
+      }
+    }
+
+    expect(() =>
+      builder
+        .withCache(cache)
+        .withCollisionStrategy('throw')
+        .withCapability(() => ({ product: new TestProductProvider(cache, context) }))
+        .withCapability(() => ({ product: new TestProductProvider(cache, context) }))
+        .build(),
+    ).toThrow(/Capability collision detected for "product"/);
+  });
+
+  it('supports first-wins collision strategy', () => {
+    const cache = new NoOpCache();
+    const context = createInitialRequestContext();
+    const builder = new ClientBuilder(context);
+
+    class TestProductProvider extends ProductProvider {
+      public name: string;
+      constructor(cache: Cache, context: RequestContext, name: string) {
+        super(cache, context);
+        this.name = name;
+      }
+      public override async getById(): Promise<any> {
+        throw new Error('not implemented');
+      }
+      public override async getBySlug(): Promise<any> {
+        throw new Error('not implemented');
+      }
+      public override async getBySKU(): Promise<any> {
+        throw new Error('not implemented');
+      }
+    }
+
+    const first = new TestProductProvider(cache, context, 'first');
+    const second = new TestProductProvider(cache, context, 'second');
+
+    const client = builder
+      .withCache(cache)
+      .withCollisionStrategy('first-wins')
+      .withCapability(() => ({ product: first }))
+      .withCapability(() => ({ product: second }))
+      .build();
+
+    expect((client.product as TestProductProvider).name).toBe('first');
+  });
 });

package/examples/node/package.json

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

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

@@ -7,6 +7,7 @@ import {
   ProductSchema
 } from '@reactionary/core';
 import {
+  FakeProductFactory,
   FakeProductProvider,
   withFakeCapabilities,
 } from '@reactionary/provider-fake';
@@ -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,6 +9,7 @@ import {
   ProductSchema
 } from '@reactionary/core';
 import {
+  FakeProductFactory,
   FakeProductProvider,
   withFakeCapabilities,
 } from '@reactionary/provider-fake';
@@ -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

@@ -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

@@ -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

@@ -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.3.18",
+  "version": "0.6.2",
   "license": "MIT",
   "private": false,
   "dependencies": {