@reactionary/commercetools 0.8.0 → 0.9.1

package/capabilities/personalization-profile.capability.js

@@ -0,0 +1,86 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  PersonalizationProfileCapability,
+  PersonalizationProfileSchema,
+  PersonalizationProfileQueryGetProfileSchema,
+  Reactionary,
+  success
+} from "@reactionary/core";
+import createDebug from "debug";
+const debug = createDebug("reactionary:commercetools:personalization-profile");
+class CommercetoolsPersonalizationProfileCapability extends PersonalizationProfileCapability {
+  config;
+  commercetools;
+  factory;
+  constructor(config, cache, context, commercetools, factory) {
+    super(cache, context);
+    this.config = config;
+    this.commercetools = commercetools;
+    this.factory = factory;
+  }
+  async getClient() {
+    const client = await this.commercetools.getClient();
+    return client.withProjectKey({ projectKey: this.config.projectKey });
+  }
+  async getPersonalizationProfile(payload) {
+    const identity = payload.identity;
+    debug("getPersonalizationProfile", payload);
+    if (identity.type === "Anonymous") {
+      return success(
+        this.factory.parsePersonalizationProfile(this.context, {
+          id: "anonymous:",
+          version: 0,
+          createdAt: "",
+          lastModifiedAt: "",
+          email: "",
+          addresses: [],
+          isEmailVerified: false,
+          authenticationMode: "Password",
+          customerGroupAssignments: []
+        })
+      );
+    }
+    if (identity.type === "Guest") {
+      return success(
+        this.factory.parsePersonalizationProfile(this.context, {
+          id: identity.id.userId,
+          version: 0,
+          createdAt: "",
+          lastModifiedAt: "",
+          email: "",
+          addresses: [],
+          isEmailVerified: false,
+          authenticationMode: "Password",
+          customerGroupAssignments: []
+        })
+      );
+    }
+    const client = await this.getClient();
+    const response = await client.me().get({
+      queryArgs: {
+        expand: ["customerGroupAssignments[*].customerGroup"]
+      }
+    }).execute();
+    const model = this.factory.parsePersonalizationProfile(this.context, response.body);
+    return success(model);
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: PersonalizationProfileQueryGetProfileSchema,
+    outputSchema: PersonalizationProfileSchema
+  })
+], CommercetoolsPersonalizationProfileCapability.prototype, "getPersonalizationProfile", 1);
+export {
+  CommercetoolsPersonalizationProfileCapability
+};

package/core/capability-descriptors.js

@@ -27,6 +27,7 @@ import {
   PriceSchema,
   ShippingMethodSchema,
   StoreSchema,
+  PersonalizationProfileSchema,
   CartPaginatedSearchResultSchema
 } from "@reactionary/core";
 import {
@@ -68,6 +69,8 @@ import { CommercetoolsCompanyFactory } from "../factories/company/company.factor
 import { CommercetoolsEmployeeFactory } from "../factories/employee/employee.factory.js";
 import { CommercetoolsEmployeeCapability } from "../capabilities/employee.capability.js";
 import { CommercetoolsEmployeeInvitationCapability } from "../capabilities/employee-invitation.capability.js";
+import { CommercetoolsPersonalizationProfileCapability } from "../capabilities/personalization-profile.capability.js";
+import { CommercetoolsPersonalizationProfileFactory } from "../factories/personalization-profile/personalization-profile.factory.js";
 import { CommercetoolsEmployeeInvitationFactory } from "../factories/employee-invitation/employee-invitation.factory.js";
 const capabilityKeys = [
   "product",
@@ -88,7 +91,8 @@ const capabilityKeys = [
   "companyRegistration",
   "company",
   "employee",
-  "employeeInvitation"
+  "employeeInvitation",
+  "personalizationProfile"
 ];
 const capabilityDescriptors = {
   product: {
@@ -331,6 +335,18 @@ const capabilityDescriptors = {
       args.commercetoolsApi,
       args.factory
     )
+  },
+  personalizationProfile: {
+    isEnabled: (caps) => caps.personalizationProfile?.enabled,
+    getOverride: (caps) => caps.personalizationProfile,
+    createDefaultFactory: () => new CommercetoolsPersonalizationProfileFactory(PersonalizationProfileSchema),
+    createDefaultCapability: (args) => new CommercetoolsPersonalizationProfileCapability(
+      args.config,
+      args.cache,
+      args.context,
+      args.commercetoolsApi,
+      args.factory
+    )
   }
 };
 export {

package/factories/personalization-profile/personalization-profile.factory.js

@@ -0,0 +1,18 @@
+class CommercetoolsPersonalizationProfileFactory {
+  personalizationProfileSchema;
+  constructor(personalizationProfileSchema) {
+    this.personalizationProfileSchema = personalizationProfileSchema;
+  }
+  parsePersonalizationProfile(_context, data) {
+    const segments = (data.customerGroupAssignments ?? []).map((assignment) => assignment.customerGroup.obj?.key).filter((key) => key != null);
+    const result = {
+      identifier: { key: data.id },
+      segments,
+      blurb: ""
+    };
+    return this.personalizationProfileSchema.parse(result);
+  }
+}
+export {
+  CommercetoolsPersonalizationProfileFactory
+};

package/index.js

@@ -13,6 +13,7 @@ export * from "./capabilities/company-registration.capability.js";
 export * from "./capabilities/company.capability.js";
 export * from "./capabilities/employee.capability.js";
 export * from "./capabilities/employee-invitation.capability.js";
+export * from "./capabilities/personalization-profile.capability.js";
 export * from "./factories/product/product.factory.js";
 export * from "./factories/checkout/checkout.factory.js";
 export * from "./factories/product-search/product-search.factory.js";
@@ -32,5 +33,6 @@ export * from "./factories/company-registration/company-registration.factory.js"
 export * from "./factories/company/company.factory.js";
 export * from "./factories/employee/employee.factory.js";
 export * from "./factories/employee-invitation/employee-invitation.factory.js";
+export * from "./factories/personalization-profile/personalization-profile.factory.js";
 export * from "./schema/capabilities.schema.js";
 export * from "./schema/configuration.schema.js";

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@reactionary/commercetools",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",
   "dependencies": {
     "vitest": "^4.0.9",
     "@nx/vite": "22.4.5",
-    "@reactionary/core": "0.8.0",
+    "@reactionary/core": "0.9.1",
     "zod": "4.1.9",
     "@commercetools/ts-client": "^4.9.1",
     "@commercetools/platform-sdk": "^8.25.0",

package/schema/capabilities.schema.js

@@ -23,7 +23,8 @@ const CommercetoolsCapabilitiesSchema = CapabilitiesSchema.pick({
   price: true,
   category: true,
   store: true,
-  profile: true
+  profile: true,
+  personalizationProfile: true
 }).extend({
   productSearch: EnabledCapabilitySchema.optional(),
   productAssociations: EnabledCapabilitySchema.optional(),
@@ -38,6 +39,7 @@ const CommercetoolsCapabilitiesSchema = CapabilitiesSchema.pick({
   category: EnabledCapabilitySchema.optional(),
   store: EnabledCapabilitySchema.optional(),
   profile: EnabledCapabilitySchema.optional(),
+  personalizationProfile: EnabledCapabilitySchema.optional(),
   companyRegistration: EnabledCapabilitySchema.optional(),
   company: EnabledCapabilitySchema.optional(),
   employee: EnabledCapabilitySchema.optional(),

package/src/capabilities/personalization-profile.capability.d.ts

@@ -0,0 +1,13 @@
+import type { Cache, PersonalizationProfileFactory, PersonalizationProfileFactoryOutput, PersonalizationProfileFactoryWithOutput, PersonalizationProfileQueryGetProfile, NotFoundError, RequestContext, Result } from '@reactionary/core';
+import { PersonalizationProfileCapability } from '@reactionary/core';
+import type { CommercetoolsAPI } from '../core/client.js';
+import type { CommercetoolsConfiguration } from '../schema/configuration.schema.js';
+import type { CommercetoolsPersonalizationProfileFactory } from '../factories/personalization-profile/personalization-profile.factory.js';
+export declare class CommercetoolsPersonalizationProfileCapability<TFactory extends PersonalizationProfileFactory = CommercetoolsPersonalizationProfileFactory> extends PersonalizationProfileCapability<PersonalizationProfileFactoryOutput<TFactory>> {
+    protected config: CommercetoolsConfiguration;
+    protected commercetools: CommercetoolsAPI;
+    protected factory: PersonalizationProfileFactoryWithOutput<TFactory>;
+    constructor(config: CommercetoolsConfiguration, cache: Cache, context: RequestContext, commercetools: CommercetoolsAPI, factory: PersonalizationProfileFactoryWithOutput<TFactory>);
+    protected getClient(): Promise<import("@commercetools/platform-sdk").ByProjectKeyRequestBuilder>;
+    getPersonalizationProfile(payload: PersonalizationProfileQueryGetProfile): Promise<Result<PersonalizationProfileFactoryOutput<TFactory>, NotFoundError>>;
+}

package/src/core/capability-descriptors.d.ts

@@ -1,6 +1,6 @@
 import type * as z from 'zod';
 import { type CommercetoolsCapabilities, type CommercetoolsCapabilitiesSchema } from '../schema/capabilities.schema.js';
-export declare const capabilityKeys: readonly ["product", "profile", "productSearch", "productAssociations", "productList", "productReviews", "identity", "cart", "inventory", "price", "category", "checkout", "store", "order", "orderSearch", "companyRegistration", "company", "employee", "employeeInvitation"];
+export declare const capabilityKeys: readonly ["product", "profile", "productSearch", "productAssociations", "productList", "productReviews", "identity", "cart", "inventory", "price", "category", "checkout", "store", "order", "orderSearch", "companyRegistration", "company", "employee", "employeeInvitation", "personalizationProfile"];
 export type OverridableCapabilityKey = (typeof capabilityKeys)[number];
 type ParsedCapabilities = z.infer<typeof CommercetoolsCapabilitiesSchema>;
 export type CapabilityDescriptor = {

package/src/core/initialize.types.d.ts

@@ -1,4 +1,4 @@
-import type { CartFactory, CategoryFactory, CheckoutFactory, ClientFromCapabilities, IdentityFactory, InventoryFactory, OrderFactory, OrderSearchFactory, PriceFactory, ProductAssociationsFactory, ProductFactory, ProductListFactory, ProductReviewsFactory, ProductSearchFactory, ProfileFactory, StoreFactory } from '@reactionary/core';
+import type { CartFactory, CategoryFactory, CheckoutFactory, ClientFromCapabilities, IdentityFactory, InventoryFactory, PersonalizationProfileFactory, OrderFactory, OrderSearchFactory, PriceFactory, ProductAssociationsFactory, ProductFactory, ProductListFactory, ProductReviewsFactory, ProductSearchFactory, ProfileFactory, StoreFactory } from '@reactionary/core';
 import type { CommercetoolsCapabilities } from '../schema/capabilities.schema.js';
 import type { OverridableCapabilityKey } from './capability-descriptors.js';
 import type { CommercetoolsCartFactory } from '../factories/cart/cart.factory.js';
@@ -16,6 +16,7 @@ import type { CommercetoolsProductReviewsFactory } from '../factories/product-re
 import type { CommercetoolsProductSearchFactory } from '../factories/product-search/product-search.factory.js';
 import type { CommercetoolsProfileFactory } from '../factories/profile/profile.factory.js';
 import type { CommercetoolsStoreFactory } from '../factories/store/store.factory.js';
+import type { CommercetoolsPersonalizationProfileFactory } from '../factories/personalization-profile/personalization-profile.factory.js';
 import type { CommercetoolsCompanyRegistrationFactory } from '../factories/company-registration/company-registration.factory.js';
 import type { CommercetoolsCompanyFactory } from '../factories/company/company.factory.js';
 import type { CommercetoolsEmployeeFactory } from '../factories/employee/employee.factory.js';
@@ -39,6 +40,7 @@ import type { CommercetoolsCompanyRegistrationCapability } from '../capabilities
 import type { CommercetoolsCompanyCapability } from '../capabilities/company.capability.js';
 import type { CommercetoolsEmployeeCapability } from '../capabilities/employee.capability.js';
 import type { CommercetoolsEmployeeInvitationCapability } from '../capabilities/employee-invitation.capability.js';
+import type { CommercetoolsPersonalizationProfileCapability } from '../capabilities/personalization-profile.capability.js';
 type EnabledCapability<TCapability> = TCapability extends {
     enabled: true;
 } ? true : false;
@@ -73,6 +75,7 @@ type FactoryContractMap = {
     company: CommercetoolsCompanyFactory;
     employee: CommercetoolsEmployeeFactory;
     employeeInvitation: CommercetoolsEmployeeInvitationFactory;
+    personalizationProfile: PersonalizationProfileFactory;
 };
 type DefaultFactoryMap = {
     product: CommercetoolsProductFactory;
@@ -94,6 +97,7 @@ type DefaultFactoryMap = {
     company: CommercetoolsCompanyFactory;
     employee: CommercetoolsEmployeeFactory;
     employeeInvitation: CommercetoolsEmployeeInvitationFactory;
+    personalizationProfile: CommercetoolsPersonalizationProfileFactory;
 };
 type ResolvedFactoryMap<T extends CommercetoolsCapabilities> = {
     [K in OverridableCapabilityKey]: ExtractCapabilityFactory<T[K], FactoryContractMap[K], DefaultFactoryMap[K]>;
@@ -118,6 +122,7 @@ type DefaultCapabilityMap<T extends CommercetoolsCapabilities> = {
     company: CommercetoolsCompanyCapability;
     employee: CommercetoolsEmployeeCapability;
     employeeInvitation: CommercetoolsEmployeeInvitationCapability;
+    personalizationProfile: CommercetoolsPersonalizationProfileCapability<ResolvedFactoryMap<T>['personalizationProfile']>;
 };
 type CapabilityImplementationMap<T extends CommercetoolsCapabilities> = {
     [K in OverridableCapabilityKey]: ExtractCapabilityImplementation<T[K], DefaultCapabilityMap<T>[K]>;

package/src/factories/personalization-profile/personalization-profile.factory.d.ts

@@ -0,0 +1,8 @@
+import type { AnyPersonalizationProfileSchema, PersonalizationProfileFactory, PersonalizationProfileSchema, RequestContext } from '@reactionary/core';
+import type { Customer } from '@commercetools/platform-sdk';
+import type * as z from 'zod';
+export declare class CommercetoolsPersonalizationProfileFactory<TPersonalizationProfileSchema extends AnyPersonalizationProfileSchema = typeof PersonalizationProfileSchema> implements PersonalizationProfileFactory<TPersonalizationProfileSchema> {
+    readonly personalizationProfileSchema: TPersonalizationProfileSchema;
+    constructor(personalizationProfileSchema: TPersonalizationProfileSchema);
+    parsePersonalizationProfile(_context: RequestContext, data: Customer): z.output<TPersonalizationProfileSchema>;
+}

package/src/index.d.ts

@@ -13,6 +13,7 @@ export * from './capabilities/company-registration.capability.js';
 export * from './capabilities/company.capability.js';
 export * from './capabilities/employee.capability.js';
 export * from './capabilities/employee-invitation.capability.js';
+export * from './capabilities/personalization-profile.capability.js';
 export * from './factories/product/product.factory.js';
 export * from './factories/checkout/checkout.factory.js';
 export * from './factories/product-search/product-search.factory.js';
@@ -32,5 +33,6 @@ export * from './factories/company-registration/company-registration.factory.js'
 export * from './factories/company/company.factory.js';
 export * from './factories/employee/employee.factory.js';
 export * from './factories/employee-invitation/employee-invitation.factory.js';
+export * from './factories/personalization-profile/personalization-profile.factory.js';
 export * from './schema/capabilities.schema.js';
 export * from './schema/configuration.schema.js';

package/src/schema/capabilities.schema.d.ts

@@ -1,4 +1,4 @@
-import type { Cache, CartFactory, CartFactoryWithOutput, CartCapability, CategoryFactory, CategoryFactoryWithOutput, CategoryCapability, CheckoutFactory, CheckoutFactoryWithOutput, CheckoutCapability, IdentityFactory, IdentityFactoryWithOutput, IdentityCapability, InventoryFactory, InventoryFactoryWithOutput, InventoryCapability, OrderFactory, OrderFactoryWithOutput, OrderCapability, OrderSearchFactory, OrderSearchFactoryWithOutput, OrderSearchCapability, PriceFactory, PriceFactoryWithOutput, PriceCapability, ProductAssociationsFactory, ProductAssociationsFactoryWithOutput, ProductAssociationsCapability, ProductFactory, ProductFactoryWithOutput, ProductListFactory, ProductListFactoryWithOutput, ProductListCapability, ProductCapability, ProductReviewsFactory, ProductReviewsFactoryWithOutput, ProductReviewsCapability, ProductSearchFactory, ProductSearchFactoryWithOutput, ProductSearchCapability, ProfileFactory, ProfileFactoryWithOutput, ProfileCapability, RequestContext, StoreFactory, StoreFactoryWithOutput, StoreCapability, CompanyRegistrationCapability, CompanyCapability, EmployeeCapability, EmployeeInvitationCapability } from '@reactionary/core';
+import type { Cache, CartFactory, CartFactoryWithOutput, CartCapability, CategoryFactory, CategoryFactoryWithOutput, CategoryCapability, CheckoutFactory, CheckoutFactoryWithOutput, CheckoutCapability, IdentityFactory, IdentityFactoryWithOutput, IdentityCapability, InventoryFactory, InventoryFactoryWithOutput, InventoryCapability, OrderFactory, OrderFactoryWithOutput, OrderCapability, OrderSearchFactory, OrderSearchFactoryWithOutput, OrderSearchCapability, PriceFactory, PriceFactoryWithOutput, PriceCapability, ProductAssociationsFactory, ProductAssociationsFactoryWithOutput, ProductAssociationsCapability, ProductFactory, ProductFactoryWithOutput, ProductListFactory, ProductListFactoryWithOutput, ProductListCapability, ProductCapability, ProductReviewsFactory, ProductReviewsFactoryWithOutput, ProductReviewsCapability, ProductSearchFactory, ProductSearchFactoryWithOutput, ProductSearchCapability, ProfileFactory, ProfileFactoryWithOutput, ProfileCapability, RequestContext, StoreFactory, StoreFactoryWithOutput, StoreCapability, PersonalizationProfileFactory, PersonalizationProfileFactoryWithOutput, PersonalizationProfileCapability, CompanyRegistrationCapability, CompanyCapability, EmployeeCapability, EmployeeInvitationCapability } from '@reactionary/core';
 import type { CommercetoolsAPI } from '../core/client.js';
 import type { CommercetoolsConfiguration } from './configuration.schema.js';
 import type { CommercetoolsCompanyRegistrationFactory } from '../factories/company-registration/company-registration.factory.js';
@@ -46,6 +46,9 @@ export declare const CommercetoolsCapabilitiesSchema: z.ZodObject<{
     profile: z.ZodOptional<z.ZodOptional<z.ZodObject<{
         enabled: z.ZodBoolean;
     }, z.core.$loose>>>;
+    personalizationProfile: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+    }, z.core.$loose>>>;
     companyRegistration: z.ZodOptional<z.ZodOptional<z.ZodObject<{
         enabled: z.ZodBoolean;
     }, z.core.$loose>>>;
@@ -98,6 +101,7 @@ export type CommercetoolsStoreCapabilityConfig = CommercetoolsCapabilityConfig<S
 export type CommercetoolsProfileCapabilityConfig = CommercetoolsCapabilityConfig<ProfileFactoryWithOutput<ProfileFactory>, ProfileCapability>;
 export type CommercetoolsOrderCapabilityConfig = CommercetoolsCapabilityConfig<OrderFactoryWithOutput<OrderFactory>, OrderCapability>;
 export type CommercetoolsOrderSearchCapabilityConfig = CommercetoolsCapabilityConfig<OrderSearchFactoryWithOutput<OrderSearchFactory>, OrderSearchCapability>;
+export type CommercetoolsPersonalizationProfileCapabilityConfig = CommercetoolsCapabilityConfig<PersonalizationProfileFactoryWithOutput<PersonalizationProfileFactory>, PersonalizationProfileCapability>;
 export type CommercetoolsCompanyRegistrationCapabilityConfig = CommercetoolsCapabilityConfig<CommercetoolsCompanyRegistrationFactory, CompanyRegistrationCapability>;
 export type CommercetoolsCompanyCapabilityConfig = CommercetoolsCapabilityConfig<CommercetoolsCompanyFactory, CompanyCapability>;
 export type CommercetoolsEmployeeCapabilityConfig = CommercetoolsCapabilityConfig<CommercetoolsEmployeeFactory, EmployeeCapability>;
@@ -121,6 +125,7 @@ export type CommercetoolsCapabilityConfigMap<TProductFactory extends ProductFact
     company: EnabledCapabilityConfig<CommercetoolsCompanyFactory, CompanyCapability>;
     employee: EnabledCapabilityConfig<CommercetoolsEmployeeFactory, EmployeeCapability>;
     employeeInvitation: EnabledCapabilityConfig<CommercetoolsEmployeeInvitationFactory, EmployeeInvitationCapability>;
+    personalizationProfile: EnabledCapabilityConfig<PersonalizationProfileFactoryWithOutput<PersonalizationProfileFactory>, PersonalizationProfileCapability>;
 };
 type CommercetoolsCapabilitiesBase = z.infer<typeof CommercetoolsCapabilitiesSchema>;
 export type CommercetoolsCapabilities<TProductFactory extends ProductFactory = ProductFactory, TProductCapability extends ProductCapability = ProductCapability, TCheckoutFactory extends CheckoutFactory = CheckoutFactory, TCheckoutCapability extends CheckoutCapability = CheckoutCapability> = Omit<CommercetoolsCapabilitiesBase, keyof CommercetoolsCapabilityConfigMap<TProductFactory, TProductCapability, TCheckoutFactory, TCheckoutCapability>> & Partial<CommercetoolsCapabilityConfigMap<TProductFactory, TProductCapability, TCheckoutFactory, TCheckoutCapability>>;