bluestone-commercetools

@evolve-framework/bluestone-commercetools · v1.0.0

Keeps a commercetools catalog in step with Bluestone PIM, by syncing the categories, products, variants and related products that changed after each Bluestone publish.

When to use

Use it when a shop on @evolve-framework/commercetools gets its product data from Bluestone PIM. The package writes to commercetools:

Categories: the subtree under BLUESTONE_CATEGORY_WEBSHOP_ID, with the category custom type COMMERCETOOLS_CATEGORY_TYPE_KEY.
Products and variants: keyed by the Bluestone product number, with a product type from BLUESTONE_PRODUCT_TYPE_MAPPING and the tax category COMMERCETOOLS_TAX_CATEGORY_KEY. Products are published.
Specifications: the Bluestone attributes of each variant, as a custom object in the COMMERCETOOLS_PRODUCT_SPECIFICATIONS_CONTAINER container.
Related products: the related-products attribute.

The commercetools project must already have the category custom type, the product types and the tax category. The product types need the variant attributes syncId, syncDate, specifications and related-products, and the category type needs the fields syncId and syncDate. Every product must be in a category that BLUESTONE_PRODUCT_TYPE_MAPPING maps to a product type.

A shop on Medusa uses @evolve-framework/medusa-plugin-bluestone instead.

Get started

Install the package. It comes from the Evolve registry, which needs a one-time sign-in.
```
pnpm add @evolve-framework/bluestone-commercetools
```

For example:

import { createSyncContext } from "@evolve-framework/bluestone-commercetools";
import { BluestoneCommercetoolsConfig } from "@evolve-framework/bluestone-commercetools/config";
import { handleProductSyncDone } from "@evolve-framework/bluestone-commercetools/events/product-sync-done";
import { webhookPayloadSchema } from "@evolve-framework/bluestone-commercetools/messages";
import { BluestoneCommercetoolsModule } from "@evolve-framework/bluestone-commercetools/module";
import { createSQSHandler, SqsPublisher } from "@evolve-framework/cloud-adapter-aws";
import { createApplication } from "@evolve-framework/core";

const config = await BluestoneCommercetoolsConfig.load();

// The web service: it checks Bluestone's webhook and queues the payload.
const publisher = new SqsPublisher(config.BLUESTONE_WEBHOOK_TARGET);

const app = await createApplication({
  name: "bluestone-commercetools",
  module: new BluestoneCommercetoolsModule({
    config: {
      webhookSecret: config.BLUESTONE_WEBHOOK_SECRET,
      validateSignature: config.BLUESTONE_WEBHOOK_VALIDATE_SIGNATURE,
    },
    publishMessage: (payload) => publisher.publish(payload),
  }),
  http: { address: { host: "0.0.0.0", port: 8080 } },
});
await app.start();

// The queue consumer, usually a separate function: it runs the sync.
const ctx = await createSyncContext(config);

export const handler = createSQSHandler(
  (payload) => handleProductSyncDone(ctx, payload),
  (message) => webhookPayloadSchema.parse(message),
);

Modules