@reactionary/source 0.3.16 → 0.3.18

package/examples/node/src/utils.ts

@@ -112,7 +112,7 @@ export function createClient(provider: PrimaryProvider) {
           productAssociations: true,
           orderSearch: true,
           store: true,
-          profile: true
+          profile: true,
         })
       );
     }
@@ -120,6 +120,9 @@ export function createClient(provider: PrimaryProvider) {
     if (provider === PrimaryProvider.FAKE) {
       builder = builder.withCapability(
         withFakeCapabilities( getFakeConfiguration() , {
+          price: true,
+          inventory: true,
+          product: true,
           productReviews: true,
           productAssociations: true,
         }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@reactionary/source",
-  "version": "0.3.16",
+  "version": "0.3.18",
   "license": "MIT",
   "private": false,
   "dependencies": {
-    "@commercetools/platform-sdk": "^8.16.0",
-    "@commercetools/ts-client": "^4.2.1",
+    "@commercetools/platform-sdk": "^8.25.0",
+    "@commercetools/ts-client": "^4.9.1",
     "@commercetools/ts-sdk-apm": "^4.0.0",
     "@docusaurus/core": "^3.9.2",
     "@docusaurus/preset-classic": "^3.9.2",

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

@@ -37,14 +37,7 @@ export class AlgoliaProductSearchProvider extends ProductSearchProvider {
     this.config = config;
   }
 
-  @Reactionary({
-    inputSchema: ProductSearchQueryByTermSchema,
-    outputSchema: ProductSearchResultSchema
-  })
-  public override async queryByTerm(
-    payload: ProductSearchQueryByTerm
-  ): Promise<Result<ProductSearchResult>> {
-    const client = algoliasearch(this.config.appId, this.config.apiKey);
+  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;
@@ -60,11 +53,7 @@ export class AlgoliaProductSearchProvider extends ProductSearchProvider {
     if (categoryFacet) {
       finalFilters.push(`categories:"${categoryFacet.key}"`);
     }
-
-
-    const remote = await client.search<AlgoliaNativeRecord>({
-      requests: [
-        {
+    return {
           indexName: this.config.indexName,
           query: payload.search.term,
           page: payload.search.paginationOptions.pageNumber - 1,
@@ -75,7 +64,23 @@ export class AlgoliaProductSearchProvider extends ProductSearchProvider {
           facetFilters: finalFacetFilters,
           filters: (finalFilters || [])
             .join(' AND '),
-        },
+        };
+  }
+
+  @Reactionary({
+    inputSchema: ProductSearchQueryByTermSchema,
+    outputSchema: ProductSearchResultSchema
+  })
+  public override async queryByTerm(
+    payload: ProductSearchQueryByTerm
+  ): Promise<Result<ProductSearchResult>> {
+    const client = algoliasearch(this.config.appId, this.config.apiKey);
+
+
+
+    const remote = await client.search<AlgoliaNativeRecord>({
+      requests: [
+        this.queryByTermPayload(payload)
       ],
     });
 

package/providers/commercetools/src/core/client.ts

@@ -16,19 +16,23 @@ import {
 import * as crypto from 'crypto';
 import createDebug from 'debug';
 import { RequestContextTokenCache } from './token-cache.js';
+import { CommercetoolsSessionSchema, type CommercetoolsSession } from '../schema/session.schema.js';
 const debug = createDebug('reactionary:commercetools');
 
+export const PROVIDER_SESSION_KEY = 'COMMERCETOOLS_PROVIDER';
+
+
 export class CommercetoolsAPI {
   protected config: CommercetoolsConfiguration;
   protected context: RequestContext;
-  protected cache: RequestContextTokenCache;
+  protected tokenCache: RequestContextTokenCache;
   protected client: Promise<ApiRoot> | undefined;
   protected adminClient: Promise<ApiRoot> | undefined;
 
   constructor(config: CommercetoolsConfiguration, context: RequestContext) {
     this.config = config;
     this.context = context;
-    this.cache = new RequestContextTokenCache(this.context);
+    this.tokenCache = new RequestContextTokenCache(this.context, PROVIDER_SESSION_KEY);
   }
 
   public async getClient() {
@@ -47,6 +51,105 @@ export class CommercetoolsAPI {
     return this.adminClient;
   }
 
+  public getSessionData(): CommercetoolsSession {
+    return this.context.session[PROVIDER_SESSION_KEY]
+      ? this.context.session[PROVIDER_SESSION_KEY] as CommercetoolsSession
+      : CommercetoolsSessionSchema.parse({});
+  }
+
+  public setSessionData(sessionData: Partial<CommercetoolsSession>): void {
+    const existingData = this.context.session[PROVIDER_SESSION_KEY] as Partial<CommercetoolsSession>;
+
+    this.context.session[PROVIDER_SESSION_KEY] = {
+      ...existingData,
+      ...sessionData,
+    };
+  }
+
+  /**
+   * Only caches it pr session for now...... but still better than every call
+   * @param key
+   * @returns
+   */
+  public async resolveChannelIdByKey(key: string): Promise<string> {
+    const sessionData = this.getSessionData();
+
+    const cacheKey = `___channel_${key}`;
+    const cachedValue = sessionData[cacheKey];
+    if (cachedValue) {
+      if (debug.enabled) {
+        debug(`Resolved channel ${key} from cache`);
+      }
+      return cachedValue + '';
+    }
+
+    const client = await this.getAdminClient();
+    const response = await client
+      .withProjectKey({ projectKey: this.config.projectKey })
+      .channels()
+      .withKey({ key: key })
+      .get()
+      .execute();
+
+    const channel = response.body;
+    this.setSessionData({
+      cacheKey: channel.id,
+    })
+    if (debug.enabled) {
+      debug(`Resolved channel ${key} from API and cached it`);
+    }
+
+    return channel.id;
+  }
+
+  /**
+   * Only caches it pr session for now...... but still better than every call
+   * @param key
+   * @returns
+   */
+  public async resolveChannelIdByRole(role: string): Promise<string> {
+    const sessionData = this.getSessionData();
+
+    const cacheKey = `___channel_role_${role}`;
+    const cachedValue = sessionData[cacheKey];
+    if (cachedValue) {
+      if (debug.enabled) {
+        debug(`Resolved channel ${role} from cache`);
+      }
+      return cachedValue + '';
+    }
+
+    const client = await this.getAdminClient();
+    const response = await client
+      .withProjectKey({ projectKey: this.config.projectKey })
+      .channels()
+      .get({
+        queryArgs: {
+          where: `roles contains any (:role)`,
+          'var.role': role,
+        }
+      })
+      .execute();
+
+    const channels = response.body;
+    if (channels.results.length === 0) {
+      throw new Error(`No channel found with role ${role}`);
+    }
+
+    const channel = channels.results[0];
+    this.setSessionData({
+      [cacheKey]: channel.id,
+    });
+
+    if (debug.enabled) {
+      debug(`Resolved channel ${role} from API and cached it`);
+    }
+
+    return channel.id;
+  }
+
+
+
   protected async createAdminClient() {
     let builder = this.createBaseClientBuilder();
     builder = builder.withAnonymousSessionFlow({
@@ -62,13 +165,13 @@ export class CommercetoolsAPI {
   }
 
   protected async createClient() {
-    let session = await this.cache.get();
+    let session = await this.tokenCache.get();
     const isNewSession = !session || !session.refreshToken;
 
     if (isNewSession) {
       await this.becomeGuest();
 
-      session = await this.cache.get();
+      session = await this.tokenCache.get();
     }
 
     let builder = this.createBaseClientBuilder();
@@ -80,7 +183,7 @@ export class CommercetoolsAPI {
       host: this.config.authUrl,
       projectKey: this.config.projectKey,
       refreshToken: session?.refreshToken || '',
-      tokenCache: this.cache,
+      tokenCache: this.tokenCache,
     });
 
     return createApiBuilderFromCtpClient(builder.build());
@@ -128,7 +231,7 @@ export class CommercetoolsAPI {
         clientSecret: this.config.clientSecret,
         user: { username, password },
       },
-      tokenCache: this.cache,
+      tokenCache: this.tokenCache,
       scopes: this.config.scopes,
     });
 
@@ -161,7 +264,7 @@ export class CommercetoolsAPI {
   }
 
   public async logout() {
-    await this.cache.set({ token: '', refreshToken: '', expirationTime: 0 });
+    await this.tokenCache.set({ token: '', refreshToken: '', expirationTime: 0 });
 
     // TODO: We could do token revocation here, if we wanted to. The above simply whacks the session.
     const identity = {
@@ -174,7 +277,7 @@ export class CommercetoolsAPI {
   public async introspect(): Promise<
     AnonymousIdentity | GuestIdentity | RegisteredIdentity
   > {
-    const session = await this.cache.get();
+    const session = await this.tokenCache.get();
 
     if (!session || !session.token) {
       const identity = {
@@ -267,7 +370,7 @@ export class CommercetoolsAPI {
 
     const result = await response.json();
 
-    this.cache.set({
+    this.tokenCache.set({
       expirationTime:
         Date.now() + Number(result.expires_in) * 1000 - 5 * 60 * 1000,
       token: result.access_token,

package/providers/commercetools/src/core/token-cache.ts

@@ -2,15 +2,14 @@ import type { TokenCache, TokenCacheOptions, TokenStore } from "@commercetools/t
 import type { RequestContext } from "@reactionary/core";
 import { CommercetoolsSessionSchema } from "../schema/session.schema.js";
 
-export const PROVIDER_COMMERCETOOLS_SESSION_KEY = 'PROVIDER_COMMERCETOOLS';
 export class RequestContextTokenCache implements TokenCache {
-  constructor(protected context: RequestContext) {}
+  constructor(protected context: RequestContext, protected sessionProviderKey: string) {}
 
   public async get(
     tokenCacheOptions?: TokenCacheOptions
   ): Promise<TokenStore | undefined> {
     const session = CommercetoolsSessionSchema.parse(
-      this.context.session[PROVIDER_COMMERCETOOLS_SESSION_KEY] || {}
+      this.context.session[this.sessionProviderKey] || {}
     );
 
     if (!session) {
@@ -33,10 +32,10 @@ export class RequestContextTokenCache implements TokenCache {
     tokenCacheOptions?: TokenCacheOptions
   ): Promise<void> {
     const session = CommercetoolsSessionSchema.parse(
-      this.context.session[PROVIDER_COMMERCETOOLS_SESSION_KEY] || {}
+      this.context.session[this.sessionProviderKey] || {}
     );
 
-    this.context.session[PROVIDER_COMMERCETOOLS_SESSION_KEY] = session;
+    this.context.session[this.sessionProviderKey] = session;
 
     session.refreshToken = cache.refreshToken;
     session.token = cache.token;

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

@@ -35,6 +35,7 @@ import type {
   CostBreakDown,
   Result,
   NotFoundError,
+  Promotion,
 } from '@reactionary/core';
 import type { CommercetoolsConfiguration } from '../schema/configuration.schema.js';
 import type {
@@ -49,7 +50,7 @@ import type { CommercetoolsAPI } from '../core/client.js';
 export class CommercetoolsCartProvider extends CartProvider {
   protected config: CommercetoolsConfiguration;
   protected commercetools: CommercetoolsAPI;
-
+  protected expandedCartFields = ['discountCodes[*].discountCode'];
   constructor(
     config: CommercetoolsConfiguration,
     cache: Cache,
@@ -71,7 +72,12 @@ export class CommercetoolsCartProvider extends CartProvider {
     const ctId = payload.cart as CommercetoolsCartIdentifier;
 
     try {
-      const remote = await client.carts.withId({ ID: ctId.key }).get().execute();
+      const remote = await client.carts.withId({ ID: ctId.key }).get(
+        {
+          queryArgs: {
+             expand: this.expandedCartFields
+          }
+        }).execute();
 
       return success(this.parseSingle(remote.body));
     } catch(err) {
@@ -92,6 +98,8 @@ export class CommercetoolsCartProvider extends CartProvider {
       cartIdentifier = await this.createCart();
     }
 
+    const channelId = await this.commercetools.resolveChannelIdByRole('Primary');
+
     const result = await this.applyActions(cartIdentifier, [
       {
         action: 'addLineItem',
@@ -100,7 +108,7 @@ export class CommercetoolsCartProvider extends CartProvider {
         // FIXME: This should be dynamic, probably as part of the context...
         distributionChannel: {
           typeId: 'channel',
-          key: 'OnlineFfmChannel',
+          id: channelId,
         },
       },
       {
@@ -184,7 +192,6 @@ export class CommercetoolsCartProvider extends CartProvider {
 
   @Reactionary({
     inputSchema: CartMutationDeleteCartSchema,
-    outputSchema: CartSchema,
   })
   public override async deleteCart(
     payload: CartMutationDeleteCart
@@ -234,11 +241,28 @@ export class CommercetoolsCartProvider extends CartProvider {
   public override async removeCouponCode(
     payload: CartMutationRemoveCoupon
   ): Promise<Result<Cart>> {
+
+    const client = await this.getClient();
+    const currentCart = await client.carts
+      .withId({ ID: payload.cart.key })
+      .get({
+        queryArgs: {
+          expand: this.expandedCartFields
+        }
+      })
+      .execute();
+
+    const discountCodeReference = currentCart.body.discountCodes?.find(dc => dc.discountCode.obj?.code === payload.couponCode)?.discountCode;
+
+    if (!discountCodeReference) {
+      // Coupon code is not applied to the cart, so we can just return the cart as is.
+      return success(this.parseSingle(currentCart.body));
+    }
     const result = await this.applyActions(payload.cart, [
       {
         action: 'removeDiscountCode',
         discountCode: {
-          id: payload.couponCode,
+          id: discountCodeReference.id,
           typeId: 'discount-code',
         },
       },
@@ -319,6 +343,9 @@ export class CommercetoolsCartProvider extends CartProvider {
           country: this.context.taxJurisdiction.countryCode || 'US',
           locale: this.context.languageContext.locale,
         },
+        queryArgs: {
+            expand: this.expandedCartFields
+        }
       })
       .execute();
 
@@ -343,6 +370,9 @@ export class CommercetoolsCartProvider extends CartProvider {
             version: ctId.version,
             actions,
           },
+          queryArgs: {
+              expand: this.expandedCartFields
+          }
         })
         .execute();
 
@@ -378,7 +408,19 @@ export class CommercetoolsCartProvider extends CartProvider {
   protected parseCartItem(remoteItem: LineItem): CartItem {
     const unitPrice = remoteItem.price.value.centAmount;
     const totalPrice = remoteItem.totalPrice.centAmount || 0;
-    const totalDiscount = remoteItem.price.discounted?.value.centAmount || 0;
+    let itemDiscount = 0;
+
+    // look, discounts are weird in commercetools.... i think the .price.discount only applies for embedded prices maybe?
+
+    if (remoteItem.discountedPricePerQuantity && remoteItem.discountedPricePerQuantity.length > 0) {
+        itemDiscount = remoteItem.discountedPricePerQuantity.reduce((sum, discPrQty) => {
+          return sum + discPrQty.quantity * discPrQty.discountedPrice?.includedDiscounts?.
+              reduce((sum, discount) => sum + discount.discountedAmount.centAmount, 0) || 0
+        }, 0);
+    }
+
+    const totalDiscount = (remoteItem.price.discounted?.value.centAmount || 0) + itemDiscount;
+
     const unitDiscount = totalDiscount / remoteItem.quantity;
     const currency =
       remoteItem.price.value.currencyCode.toUpperCase() as Currency;
@@ -423,12 +465,23 @@ export class CommercetoolsCartProvider extends CartProvider {
       version: remote.version || 0,
     } satisfies CommercetoolsCartIdentifier;
 
+
+    const items = new Array<CartItem>();
+    for (const remoteItem of remote.lineItems) {
+      const item = this.parseCartItem(remoteItem);
+
+      items.push(item);
+    }
+
+
     const grandTotal = remote.totalPrice.centAmount || 0;
     const shippingTotal = remote.shippingInfo?.price.centAmount || 0;
     const productTotal = grandTotal - shippingTotal;
     const taxTotal = remote.taxedPrice?.totalTax?.centAmount || 0;
+
+    // i think this is missing some elements still?
     const discountTotal =
-      remote.discountOnTotalPrice?.discountedAmount.centAmount || 0;
+      (remote.discountOnTotalPrice?.discountedAmount.centAmount || 0) + items.reduce((sum, item) => sum + (item.price.totalDiscount.value * 100 || 0), 0);
     const surchargeTotal = 0;
     const currency = remote.totalPrice.currencyCode as Currency;
 
@@ -459,13 +512,24 @@ export class CommercetoolsCartProvider extends CartProvider {
       },
     } satisfies CostBreakDown;
 
-    const items = new Array<CartItem>();
-    for (const remoteItem of remote.lineItems) {
-      const item = this.parseCartItem(remoteItem);
 
-      items.push(item);
+    const localeString = this.context.languageContext.locale || 'en'
+    const appliedPromotions = [];
+    if (remote.discountCodes) {
+      for (const promo of remote.discountCodes) {
+        appliedPromotions.push({
+          code: promo.discountCode.obj?.code || '',
+          isCouponCode: true,
+          name: promo.discountCode.obj?.name?.[localeString] || '',
+          description: promo.discountCode.obj?.description?.[localeString] || '',
+        } satisfies Promotion);
+      }
     }
 
+    // if we want to include the nice name and description of the non-coupon promotions, we have to do some extra work to fetch the referenced promotions and include them here,
+    // as the max expand level is 3, and the information is at level 5.
+    // For now, we will just include the coupon codes, as that is the most common use case.
+
     const cart = {
       identifier,
       userId: {
@@ -474,6 +538,7 @@ export class CommercetoolsCartProvider extends CartProvider {
       name: remote.custom?.fields['name'] || '',
       description: remote.custom?.fields['description'] || '',
       price,
+      appliedPromotions,
       items,
     } satisfies Cart;
 

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

@@ -35,6 +35,10 @@ export class CommercetoolsInventoryProvider extends InventoryProvider {
   }
 
   @Reactionary({
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: false,
     inputSchema: InventoryQueryBySKUSchema,
     outputSchema: InventorySchema,
   })
@@ -45,13 +49,7 @@ export class CommercetoolsInventoryProvider extends InventoryProvider {
 
       // TODO: We can't query by supplyChannel.key, so we have to resolve it first.
       // This is probably a good candidate for internal data caching at some point.
-      const channel = await client
-        .channels()
-        .withKey({ key: payload.fulfilmentCenter.key })
-        .get()
-        .execute();
-
-      const channelId = channel.body.id;
+      const channelId = await this.commercetools.resolveChannelIdByKey(payload.fulfilmentCenter.key);
 
       const remote = await client
         .inventory()

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

@@ -48,7 +48,12 @@ export class CommercetoolsPriceProvider extends PriceProvider {
     payload: CustomerPriceQuery
   ): Promise<Result<Price>> {
     const client = await this.getClient();
-    const priceChannelId = 'ee6e75e9-c9ab-4e2f-85f1-d8c734d0cb86';
+    let priceChannelId;
+    if (this.config.customerPriceChannelKey) {
+      priceChannelId = await this.commercetools.resolveChannelIdByKey(this.config.customerPriceChannelKey);
+    } else {
+      priceChannelId = await this.commercetools.resolveChannelIdByRole('Primary');
+    }
 
     const response = await client
       .productProjections()
@@ -80,8 +85,12 @@ export class CommercetoolsPriceProvider extends PriceProvider {
   })
   public override async getListPrice(payload: ListPriceQuery): Promise<Result<Price>> {
     const client = await this.getClient();
-    const priceChannelId = 'ee6e75e9-c9ab-4e2f-85f1-d8c734d0cb86';
-
+    let priceChannelId;
+    if (this.config.listPriceChannelKey) {
+      priceChannelId = await this.commercetools.resolveChannelIdByKey(this.config.listPriceChannelKey);
+    } else {
+      priceChannelId = await this.commercetools.resolveChannelIdByRole('Primary');
+    }
     const response = await client
       .productProjections()
       .get({
@@ -127,9 +136,12 @@ export class CommercetoolsPriceProvider extends PriceProvider {
       currency: price.value.currencyCode as Currency,
     } satisfies MonetaryAmount;
 
+    let isOnSale = false;
     if (options.includeDiscounts) {
       const discountedPrice = price.discounted?.value || price.value;
-
+      if (price.discounted) {
+        isOnSale = true;
+      }
       unitPrice = {
         value: discountedPrice.centAmount / 100,
         currency: price.value.currencyCode as Currency,
@@ -146,35 +158,10 @@ export class CommercetoolsPriceProvider extends PriceProvider {
       identifier,
       tieredPrices: [],
       unitPrice,
+      onSale: isOnSale,
     } satisfies Price;
 
     return result;
   }
 
-  protected async getChannels() {
-    const adminClient = await this.commercetools.getAdminClient();
-
-    const offerPriceChannelPromise = adminClient
-      .withProjectKey({ projectKey: this.config.projectKey })
-      .channels()
-      .withKey({ key: 'Offer Price' })
-      .get()
-      .execute();
-    const listPriceChannelPromise = adminClient
-      .withProjectKey({ projectKey: this.config.projectKey })
-      .channels()
-      .withKey({ key: 'List Price' })
-      .get()
-      .execute();
-
-    const [offerChannel, listChannel] = await Promise.all([
-      offerPriceChannelPromise,
-      listPriceChannelPromise,
-    ]);
-
-    return {
-      offer: offerChannel.body.id,
-      list: listChannel.body.id,
-    };
-  }
 }

package/providers/commercetools/src/schema/configuration.schema.ts

@@ -8,8 +8,12 @@ export const CommercetoolsConfigurationSchema = z.looseObject({
     clientId: z.string(),
     clientSecret: z.string(),
     scopes: z.array(z.string()).default(() => []),
+    adminClientId: z.string().optional(),
+    adminClientSecret: z.string().optional(),
     paymentMethods: PaymentMethodSchema.array().optional().default(() => []),
     facetFieldsForSearch: z.array(z.string()).default(() => []),
+    listPriceChannelKey: z.string().optional(),
+    customerPriceChannelKey: z.string().optional(),
 });
 
 export type CommercetoolsConfiguration = z.infer<typeof CommercetoolsConfigurationSchema>;

package/providers/commercetools/src/schema/session.schema.ts

@@ -4,4 +4,6 @@ export const CommercetoolsSessionSchema = z.looseObject({
     token: z.string().default(''),
     refreshToken: z.string().optional(),
     expirationTime: z.number().default(0)
-});
+});
+
+export type CommercetoolsSession = z.infer<typeof CommercetoolsSessionSchema>;

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

@@ -274,6 +274,7 @@ export class FakeCartProvider extends CartProvider {
           currency: 'XXX',
         },
       },
+      appliedPromotions: [],
       userId: {
         userId: '',
       },