@reactionary/source 0.6.1 → 0.6.3

package/packages/commercetools/src/capabilities/product.capability.ts

@@ -0,0 +1,133 @@
+import {
+  ProductCapability,
+  ProductQueryByIdSchema,
+  ProductQueryBySKUSchema,
+  ProductQueryBySlugSchema,
+  ProductSchema,
+  Reactionary,
+  success,
+  error,
+  type ProductFactory,
+  type ProductFactoryOutput,
+  type ProductFactoryWithOutput,
+} from '@reactionary/core';
+import type { CommercetoolsConfiguration } from '../schema/configuration.schema.js';
+import type {
+  ProductQueryById,
+  ProductQueryBySKU,
+  ProductQueryBySlug,
+  RequestContext,
+  Result,
+} from '@reactionary/core';
+import type { Cache } from '@reactionary/core';
+import type { CommercetoolsAPI } from '../core/client.js';
+import type { NotFoundError } from '@reactionary/core';
+import type { CommercetoolsProductFactory } from '../factories/product/product.factory.js';
+
+export class CommercetoolsProductCapability<
+  TFactory extends ProductFactory = CommercetoolsProductFactory
+> extends ProductCapability<ProductFactoryOutput<TFactory>> {
+  constructor(
+    cache: Cache,
+    context: RequestContext,
+    protected config: CommercetoolsConfiguration,
+    protected commercetools: CommercetoolsAPI,
+    protected factory: ProductFactoryWithOutput<TFactory>
+  ) {
+    super(cache, context);
+  }
+
+  protected async getClient() {
+    const client = await this.commercetools.getClient();
+    return client
+      .withProjectKey({ projectKey: this.config.projectKey })
+      .productProjections();
+  }
+
+  @Reactionary({
+    inputSchema: ProductQueryByIdSchema,
+    outputSchema: ProductSchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: true
+  })
+  public override async getById(
+    payload: ProductQueryById
+  ): Promise<Result<ProductFactoryOutput<TFactory>>> {
+    const client = await this.getClient();
+    const remote = await client
+      .withKey({ key: payload.identifier.key })
+      .get()
+      .execute();
+
+    const value = this.factory.parseProduct(this.context, remote.body);
+
+    return success(value);
+  }
+
+  @Reactionary({
+    inputSchema: ProductQueryBySlugSchema,
+    outputSchema: ProductSchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: true
+  })
+  public override async getBySlug(
+    payload: ProductQueryBySlug
+  ): Promise<Result<ProductFactoryOutput<TFactory>, NotFoundError>> {
+    const client = await this.getClient();
+
+    const remote = await client
+      .get({
+        queryArgs: {
+          // FIXME: Hardcoded locale
+          where: 'slug(en = :slug)',
+          'var.slug': payload.slug,
+        },
+      })
+      .execute();
+
+    if (remote.body.count === 0) {
+      return error<NotFoundError>({
+        type: 'NotFound',
+        identifier: payload.slug,
+      });
+    }
+    const result = this.factory.parseProduct(this.context, remote.body.results[0]);
+
+    return success(result);
+  }
+
+  @Reactionary({
+    inputSchema: ProductQueryBySKUSchema,
+    outputSchema: ProductSchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: true
+  })
+  public override async getBySKU(
+    payload: ProductQueryBySKU
+  ): Promise<Result<ProductFactoryOutput<TFactory>>> {
+    const client = await this.getClient();
+
+    const remote = await client
+      .get({
+        queryArgs: {
+          staged: false,
+          limit: 1,
+          where: 'variants(sku in (:skus)) OR (masterVariant(sku in (:skus))) ',
+          'var.skus': [payload].map((p) => p.variant.sku),
+        },
+      })
+      .execute();
+
+    // PAIN: the lack of knowing the non-generic type signature of the factory (the scopedown to the CT product capability)
+    // this is due to the Typescript construct for ProductFactoryOutput<TFactory>
+    const result = this.factory.parseProduct(this.context, remote.body.results[0]);
+
+    return success(result);
+  }
+}

package/{providers/commercetools/src/providers/profile.provider.ts → packages/commercetools/src/capabilities/profile.capability.ts}

@@ -1,5 +1,7 @@
 import type {
-  Profile,
+  ProfileFactory,
+  ProfileFactoryOutput,
+  ProfileFactoryWithOutput,
   ProfileMutationAddShippingAddress,
   ProfileMutationMakeShippingAddressDefault,
   ProfileMutationRemoveShippingAddress,
@@ -10,12 +12,12 @@ import type {
   Result,
   NotFoundError,
   InvalidInputError,
+  ProfileMutationUpdateShippingAddress,
   Address,
-  ProfileMutationUpdateShippingAddress
 } from '@reactionary/core';
 import {
   ProfileMutationUpdateSchema,
-  ProfileProvider,
+  ProfileCapability,
   ProfileSchema,
   Reactionary,
   success,
@@ -27,23 +29,29 @@ import {
 import type * as z from 'zod';
 import type { CommercetoolsConfiguration } from '../schema/configuration.schema.js';
 import type { Cache } from '@reactionary/core';
-import type { Customer, MyCustomerUpdateAction, Address as CTAddress } from '@commercetools/platform-sdk';
+import type { MyCustomerUpdateAction, Address as CTAddress } from '@commercetools/platform-sdk';
 import type { CommercetoolsAPI } from '../core/client.js';
+import type { CommercetoolsProfileFactory } from '../factories/profile/profile.factory.js';
 
-export class CommercetoolsProfileProvider extends ProfileProvider {
+export class CommercetoolsProfileCapability<
+  TFactory extends ProfileFactory = CommercetoolsProfileFactory,
+> extends ProfileCapability<ProfileFactoryOutput<TFactory>> {
   protected config: CommercetoolsConfiguration;
   protected commercetools: CommercetoolsAPI;
+  protected factory: ProfileFactoryWithOutput<TFactory>;
 
   constructor(
     config: CommercetoolsConfiguration,
     cache: Cache,
     context: RequestContext,
-    commercetools: CommercetoolsAPI
+    commercetools: CommercetoolsAPI,
+    factory: ProfileFactoryWithOutput<TFactory>,
   ) {
     super(cache, context);
 
     this.config = config;
     this.commercetools = commercetools;
+    this.factory = factory;
   }
 
   protected async getClient() {
@@ -51,7 +59,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
     return client.withProjectKey({ projectKey: this.config.projectKey });
   }
 
-  public override async getById(payload: ProfileQuerySelf): Promise<Result<Profile, NotFoundError>> {
+  public override async getById(payload: ProfileQuerySelf): Promise<Result<ProfileFactoryOutput<TFactory>, NotFoundError>> {
     const client = await this.getClient();
 
     const remote = await client.me().get().execute();
@@ -63,7 +71,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
       });
     }
 
-    const model = this.parseSingle(remote.body);
+    const model = this.factory.parseProfile(this.context, remote.body);
     return success(model);
   }
 
@@ -73,7 +81,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
     inputSchema: ProfileMutationAddShippingAddressSchema,
     outputSchema: ProfileSchema,
   })
-  public override async addShippingAddress(payload: ProfileMutationAddShippingAddress): Promise<Result<Profile, NotFoundError>> {
+  public override async addShippingAddress(payload: ProfileMutationAddShippingAddress): Promise<Result<ProfileFactoryOutput<TFactory>, NotFoundError>> {
     const client = await this.getClient();
 
     const remote = await client.me().get().execute();
@@ -101,11 +109,11 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
       })
       .execute();
     customer = updateResponse.body;
-    const model = this.parseSingle(customer);
+    const model = this.factory.parseProfile(this.context, customer);
     return success(model);
   }
 
-  public override async updateShippingAddress(payload: ProfileMutationUpdateShippingAddress): Promise<Result<Profile, NotFoundError>> {
+  public override async updateShippingAddress(payload: ProfileMutationUpdateShippingAddress): Promise<Result<ProfileFactoryOutput<TFactory>, NotFoundError>> {
     const client = await this.getClient();
 
     const remote = await client.me().get().execute();
@@ -144,7 +152,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
       })
       .execute();
     customer = updateResponse.body;
-    const model = this.parseSingle(customer);
+    const model = this.factory.parseProfile(this.context, customer);
     return success(model);
   }
 
@@ -152,7 +160,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
     inputSchema: ProfileMutationRemoveShippingAddressSchema,
     outputSchema: ProfileSchema,
   })
-  public override async removeShippingAddress(payload: ProfileMutationRemoveShippingAddress): Promise<Result<Profile, NotFoundError>> {
+  public override async removeShippingAddress(payload: ProfileMutationRemoveShippingAddress): Promise<Result<ProfileFactoryOutput<TFactory>, NotFoundError>> {
     const client = await this.getClient();
 
     const remote = await client.me().get().execute();
@@ -207,13 +215,13 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
       .execute();
     customer = updateResponse.body;
 
-    const model = this.parseSingle(customer);
+    const model = this.factory.parseProfile(this.context, customer);
     return success(model);
   }
 
 
 
-  public override async makeShippingAddressDefault(payload: ProfileMutationMakeShippingAddressDefault): Promise<Result<Profile, NotFoundError>> {
+  public override async makeShippingAddressDefault(payload: ProfileMutationMakeShippingAddressDefault): Promise<Result<ProfileFactoryOutput<TFactory>, NotFoundError>> {
     const client = await this.getClient();
 
     const remote = await client.me().get().execute();
@@ -257,7 +265,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
       })
       .execute();
     customer = updateResponse.body;
-    const model = this.parseSingle(customer);
+    const model = this.factory.parseProfile(this.context, customer);
     return success(model);
   }
 
@@ -266,7 +274,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
     inputSchema: ProfileMutationSetBillingAddressSchema,
     outputSchema: ProfileSchema,
   })
-  public override async setBillingAddress(payload: ProfileMutationSetBillingAddress): Promise<Result<Profile, NotFoundError>> {
+  public override async setBillingAddress(payload: ProfileMutationSetBillingAddress): Promise<Result<ProfileFactoryOutput<TFactory>, NotFoundError>> {
     const client = await this.getClient();
 
     const remote = await client.me().get().execute();
@@ -311,7 +319,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
         .execute();
       customer = updateResponse.body;
     }
-    const model = this.parseSingle(customer);
+    const model = this.factory.parseProfile(this.context, customer);
     return success(model);
   }
 
@@ -319,7 +327,7 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
     inputSchema: ProfileMutationUpdateSchema,
     outputSchema: ProfileSchema,
   })
-  public override async update(payload: ProfileMutationUpdate): Promise<Result<Profile, NotFoundError>> {
+  public override async update(payload: ProfileMutationUpdate): Promise<Result<ProfileFactoryOutput<TFactory>, NotFoundError>> {
     const client = await this.getClient();
 
     const remote = await client.me().get().execute();
@@ -381,65 +389,11 @@ export class CommercetoolsProfileProvider extends ProfileProvider {
         .execute();
       customer = updateResponse.body;
     }
-    const model = this.parseSingle(customer);
+    const model = this.factory.parseProfile(this.context, customer);
     return success(model);
 
   }
 
-  protected parseAddress(address: CTAddress): Address {
-    const result = {
-      identifier: {
-        nickName: address.key || '',
-      },
-      firstName: address.firstName || '',
-      lastName: address.lastName || '',
-      streetAddress: address.streetName || '',
-      streetNumber: address.streetNumber || '',
-      city: address.city || '',
-      region: address.region || '',
-      postalCode: address.postalCode || '',
-      countryCode: address.country,
-    } satisfies Address;
-
-    return result;
-  }
-
-  protected parseSingle(body: Customer): Profile {
-    const email = body.email;
-    const emailVerified = body.isEmailVerified;
-    let defaultCTBillingAddress = body.addresses.find(addr => addr.id === body.defaultBillingAddressId);
-    const phone = defaultCTBillingAddress?.phone ?? '';
-
-
-    // if we only have the phone number on the billing address, we dont really have a billing address, so we ignore it
-    if (this.isIncompleteAddress(defaultCTBillingAddress)) {
-      defaultCTBillingAddress = undefined;
-    }
-
-    const defaultCTShippingAddress = body.addresses.find(addr => addr.id === body.defaultShippingAddressId);
-
-    const alternateShippingAddresses = body.addresses.filter(x => x.id !== body.defaultBillingAddressId && x.id !== body.defaultShippingAddressId).map(addr => this.parseAddress(addr));
-    const billingAddress = defaultCTBillingAddress ? this.parseAddress(defaultCTBillingAddress) : undefined;
-    const shippingAddress = defaultCTShippingAddress ? this.parseAddress(defaultCTShippingAddress) : undefined;
-
-    const result = {
-      identifier: {
-        userId: body.id
-      },
-      email,
-      emailVerified,
-      alternateShippingAddresses,
-      billingAddress: billingAddress,
-      shippingAddress: shippingAddress,
-      createdAt: body.createdAt,
-      phone,
-      phoneVerified: false,
-      updatedAt: body.lastModifiedAt
-    } satisfies Profile;
-
-    return result;
-  }
-
   protected createCTAddressDraft( address: Address): CTAddress {
     return {
       key: address.identifier.nickName,

package/{providers/commercetools/src/providers/store.provider.ts → packages/commercetools/src/capabilities/store.capability.ts}

@@ -1,32 +1,37 @@
 import type {
   RequestContext,
   Cache,
+  StoreFactory,
+  StoreFactoryOutput,
+  StoreFactoryWithOutput,
   StoreQueryByProximity,
-  Store,
-  StoreIdentifier,
-  FulfillmentCenterIdentifier,
   Result,
 } from '@reactionary/core';
-import { Reactionary, StoreProvider, StoreQueryByProximitySchema, StoreSchema, success, error } from '@reactionary/core';
+import { Reactionary, StoreCapability, StoreQueryByProximitySchema, StoreSchema, success, error } from '@reactionary/core';
 import * as z from 'zod';
 import type { CommercetoolsConfiguration } from '../schema/configuration.schema.js';
-import type { Channel } from '@commercetools/platform-sdk';
 import type { CommercetoolsAPI } from '../core/client.js';
+import type { CommercetoolsStoreFactory } from '../factories/store/store.factory.js';
 
-export class CommercetoolsStoreProvider extends StoreProvider {
+export class CommercetoolsStoreCapability<
+  TFactory extends StoreFactory = CommercetoolsStoreFactory,
+> extends StoreCapability<StoreFactoryOutput<TFactory>> {
   protected config: CommercetoolsConfiguration;
   protected commercetools: CommercetoolsAPI;
+  protected factory: StoreFactoryWithOutput<TFactory>;
 
   constructor(
     config: CommercetoolsConfiguration,
     cache: Cache,
     context: RequestContext,
-    commercetools: CommercetoolsAPI
+    commercetools: CommercetoolsAPI,
+    factory: StoreFactoryWithOutput<TFactory>,
   ) {
     super(cache, context);
 
     this.config = config;
     this.commercetools = commercetools;
+    this.factory = factory;
   }
 
   protected async getClient() {
@@ -40,7 +45,7 @@ export class CommercetoolsStoreProvider extends StoreProvider {
   })
   public override async queryByProximity(
     payload: StoreQueryByProximity
-  ): Promise<Result<Array<Store>>> {
+  ): Promise<Result<Array<StoreFactoryOutput<TFactory>>>> {
     const client = await this.getClient();
 
     const remote = await client
@@ -60,33 +65,10 @@ export class CommercetoolsStoreProvider extends StoreProvider {
     const results = [];
 
     for (const r of remote.body.results) {
-      results.push(this.parseSingle(r));
+      results.push(this.factory.parseStore(this.context, r));
     }
 
     return success(results);
   }
 
-  protected parseSingle(body: Channel): Store {
-
-    let name = '';
-    if (body.name && body.name['la']) {
-      name = body.name['la'];
-    }
-
-    const identifier = {
-      key: body.key,
-    } satisfies StoreIdentifier;
-
-    const fulfillmentCenter = {
-      key: body.key,
-    } satisfies FulfillmentCenterIdentifier;
-
-    const result = {
-      identifier,
-      fulfillmentCenter,
-      name,
-    } satisfies Store;
-
-    return result;
-  }
 }