@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/catalog/properties.d.ts

@@ -33,6 +33,11 @@ export interface Property {
     position: number;
     config: PropertyConfig | null;
     facetId: string | null;
+    /**
+     * A filterable `content_item` property's field-level facets, one per content field it filters
+     * by, as `configureFieldFacets` last wrote them; null when it has none.
+     */
+    fieldFacets: PropertyFieldFacet[] | null;
     translations: Array<{
         id: string;
         languageCode: LanguageCode;
@@ -40,6 +45,25 @@ export interface Property {
         helpText: string | null;
     }>;
 }
+/** One field-level facet of a `content_item` property: the facet a content field's values fill. */
+export interface PropertyFieldFacet {
+    fieldSlug: string;
+    /** The content field's type (`enum`, `multi_enum`, `boolean`). */
+    fieldType: string;
+    facetId: string;
+}
+/** A content field a `content_item` property filters by (`configureFieldFacets`). */
+export interface FieldFacetDefinition {
+    /** The content type's field slug. */
+    fieldSlug: string;
+    /** The content field's type (`enum`, `multi_enum`, `boolean`). */
+    fieldType: string;
+    /** For an `enum` / `multi_enum` field: its options, each becoming one facet value. */
+    options?: Array<{
+        value: string;
+        label: string;
+    }>;
+}
 export interface PropertyGroup {
     id: string;
     createdAt: string;
@@ -186,49 +210,151 @@ export interface ContentFacetSyncResult {
  */
 export interface PropertiesModule {
     groups: {
-        /** The complete list, as one terminal page — the query takes no paging. */
+        /**
+         * The store's own groups, the complete list as one terminal page (the query takes no paging).
+         *
+         * @effect read
+         */
         list(options?: Call): Promise<Page<PropertyGroup>>;
+        /**
+         * One of the store's own groups, or null.
+         *
+         * @effect read
+         */
         get(id: string, options?: Call): Promise<PropertyGroup | null>;
+        /** @effect write */
         create(input: CreatePropertyGroupInput, options?: Call): Promise<PropertyGroup>;
+        /** @effect write */
         update(input: UpdatePropertyGroupInput, options?: Call): Promise<PropertyGroup>;
-        /** Deletes the group AND every property in it, with their values. */
+        /**
+         * Deletes the group AND every property in it, with their values on every product and the
+         * filter values (facets) the filterable ones mirror. Not undoable.
+         *
+         * @effect destructive
+         */
         delete(id: string, options?: Call): Promise<void>;
         /**
          * Pass EVERY group id of the store, in the order wanted. Only the store's own groups:
          * a workspace group (`editableHere` false) or another store's id refuses the whole call.
+         *
+         * @effect write
          */
         reorder(ids: string[], options?: Call): Promise<PropertyGroup[]>;
     };
+    /** @effect write */
     create(input: CreatePropertyInput, options?: Call): Promise<Property>;
+    /** @effect write */
     update(input: UpdatePropertyInput, options?: Call): Promise<Property>;
+    /**
+     * Deletes the property with its values on every product, and the filter values (facets) a
+     * filterable one mirrors. Not undoable.
+     *
+     * @effect destructive
+     */
     delete(id: string, options?: Call): Promise<void>;
-    /** Pass every property id of the group, in the order wanted. */
+    /**
+     * Pass every property id of the group, in the order wanted.
+     *
+     * @effect write
+     */
     reorder(groupId: string, propertyIds: string[], options?: Call): Promise<Property[]>;
+    /**
+     * Sets which content fields a filterable `content_item` property filters by: one field-level
+     * facet per field named, its values the field's options (an `enum` / `multi_enum` field) or
+     * yes/no (a `boolean` one). Needs `UpdateCatalog`.
+     *
+     * `fields` is the WHOLE set: a field already configured keeps its facet (its values follow the
+     * options sent), a new one gets a facet, and a field left out loses its facet, which is removed
+     * from every product of the store. `[]` removes them all. Send the fields the property was
+     * SAVED with (`config.filterableFieldSlugs`), never an unsaved form's. The products' field
+     * values are filled by `catalog.syncContentFacets`, not here. It resolves with nothing (the
+     * engine answers only that it is done): the property's `fieldFacets`, read again through
+     * `groups.get`, holds what was written.
+     *
+     * Refusals (nothing is written):
+     * - `PROPERTY_NOT_FOUND` → `NotFoundError` (404): no such property among the store's own groups.
+     * - `PROPERTY_FACET_SYNC_INVALID` → `ValidationError` (400): not a `content_item` property, or
+     *   not saved as filterable.
+     * - `MANAGED_BY_ORGANIZATION` → `BusinessRuleError` (422): in a store of an organization, a
+     *   property of the workspace's groups (`editableHere` false): configure it in the workspace.
+     *
+     * Not idempotent by key; repeating the same `fields` writes the same facets again.
+     *
+     * Destructive: a dropped field's facet and a dropped option's filter value leave every product.
+     *
+     * @effect destructive
+     */
+    configureFieldFacets(propertyId: string, fields: FieldFacetDefinition[], options?: Call): Promise<void>;
     values: {
         /**
          * Every group of the store, each with this product's stored values in every language. For a
          * product the store holds from its organization, the workspace's groups and values come too,
          * with `group.editableHere` false.
+         *
+         * @effect read
          */
         get(productId: string, options?: Call): Promise<ProductPropertyGroupValues[]>;
-        /** Upsert the given values; properties not named keep theirs. */
+        /**
+         * Upsert the given values; properties not named keep theirs.
+         *
+         * @effect write
+         */
         set(productId: string, values: SetPropertyValueInput[], options?: Call): Promise<void>;
     };
 }
-export declare const PROPERTY_GROUP_FIELDS = "\n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n";
-export declare const PROPERTY_GROUPS_QUERY = "\n  query CatalogPropertyGroups {\n    propertyGroups { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
-export declare const PROPERTY_GROUP_QUERY = "\n  query CatalogPropertyGroup($id: ID!) {\n    propertyGroup(id: $id) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
-export declare const CREATE_PROPERTY_GROUP_MUTATION = "\n  mutation CatalogCreatePropertyGroup($input: CreatePropertyGroupInput!) {\n    createPropertyGroup(input: $input) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
-export declare const UPDATE_PROPERTY_GROUP_MUTATION = "\n  mutation CatalogUpdatePropertyGroup($input: UpdatePropertyGroupInput!) {\n    updatePropertyGroup(input: $input) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
+export declare const PROPERTY_GROUP_FIELDS = "\n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n";
+export declare const PROPERTY_GROUPS_QUERY = "\n  query CatalogPropertyGroups {\n    propertyGroups { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
+export declare const PROPERTY_GROUP_QUERY = "\n  query CatalogPropertyGroup($id: ID!) {\n    propertyGroup(id: $id) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
+export declare const CREATE_PROPERTY_GROUP_MUTATION = "\n  mutation CatalogCreatePropertyGroup($input: CreatePropertyGroupInput!) {\n    createPropertyGroup(input: $input) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
+export declare const UPDATE_PROPERTY_GROUP_MUTATION = "\n  mutation CatalogUpdatePropertyGroup($input: UpdatePropertyGroupInput!) {\n    updatePropertyGroup(input: $input) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
 export declare const DELETE_PROPERTY_GROUP_MUTATION = "\n  mutation CatalogDeletePropertyGroup($id: ID!) {\n    deletePropertyGroup(id: $id) { \n  result\n  message\n }\n  }\n";
-export declare const REORDER_PROPERTY_GROUPS_MUTATION = "\n  mutation CatalogReorderPropertyGroups($ids: [ID!]!) {\n    reorderPropertyGroups(ids: $ids) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
-export declare const CREATE_PROPERTY_MUTATION = "\n  mutation CatalogCreateProperty($input: CreatePropertyInput!) {\n    createProperty(input: $input) { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  }\n";
-export declare const UPDATE_PROPERTY_MUTATION = "\n  mutation CatalogUpdateProperty($input: UpdatePropertyInput!) {\n    updateProperty(input: $input) { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  }\n";
+export declare const REORDER_PROPERTY_GROUPS_MUTATION = "\n  mutation CatalogReorderPropertyGroups($ids: [ID!]!) {\n    reorderPropertyGroups(ids: $ids) { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n  }\n";
+export declare const CREATE_PROPERTY_MUTATION = "\n  mutation CatalogCreateProperty($input: CreatePropertyInput!) {\n    createProperty(input: $input) { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  }\n";
+export declare const UPDATE_PROPERTY_MUTATION = "\n  mutation CatalogUpdateProperty($input: UpdatePropertyInput!) {\n    updateProperty(input: $input) { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  }\n";
 export declare const DELETE_PROPERTY_MUTATION = "\n  mutation CatalogDeleteProperty($id: ID!) {\n    deleteProperty(id: $id) { \n  result\n  message\n }\n  }\n";
-export declare const REORDER_PROPERTIES_MUTATION = "\n  mutation CatalogReorderProperties($groupId: ID!, $propertyIds: [ID!]!) {\n    reorderProperties(groupId: $groupId, propertyIds: $propertyIds) { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  }\n";
-export declare const PRODUCT_PROPERTY_VALUES_QUERY = "\n  query CatalogProductPropertyValues($productId: ID!) {\n    productPropertyValues(productId: $productId) {\n      group { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n      values {\n        id\n        propertyId\n        languageCode\n        value\n      }\n    }\n  }\n";
+export declare const REORDER_PROPERTIES_MUTATION = "\n  mutation CatalogReorderProperties($groupId: ID!, $propertyIds: [ID!]!) {\n    reorderProperties(groupId: $groupId, propertyIds: $propertyIds) { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  }\n";
+export declare const CONFIGURE_FIELD_FACETS_MUTATION = "\n  mutation CatalogConfigureFieldFacets($propertyId: ID!, $fields: [FieldFacetDefinitionInput!]!) {\n    configureFieldFacets(propertyId: $propertyId, fields: $fields)\n  }\n";
+export declare const PRODUCT_PROPERTY_VALUES_QUERY = "\n  query CatalogProductPropertyValues($productId: ID!) {\n    productPropertyValues(productId: $productId) {\n      group { \n  id\n  createdAt\n  updatedAt\n  position\n  translations {\n    id\n    languageCode\n    name\n  }\n  properties { \n  id\n  createdAt\n  updatedAt\n  slug\n  fieldType\n  isFilterable\n  isRequired\n  position\n  config {\n    options {\n      value\n      label\n    }\n    min\n    max\n    maxLength\n    allowedCollectionIds\n    filterableFieldSlugs\n    productFilter\n  }\n  facetId\n  fieldFacets {\n    fieldSlug\n    fieldType\n    facetId\n  }\n  translations {\n    id\n    languageCode\n    name\n    helpText\n  }\n }\n  editableHere\n }\n      values {\n        id\n        propertyId\n        languageCode\n        value\n      }\n    }\n  }\n";
 export declare const SET_PRODUCT_PROPERTY_VALUES_MUTATION = "\n  mutation CatalogSetProductPropertyValues($productId: ID!, $values: [SetProductPropertyValueInput!]!) {\n    setProductPropertyValues(productId: $productId, values: $values)\n  }\n";
 export declare const SYNC_PROPERTY_FACETS_MUTATION = "\n  mutation CatalogSyncPropertyFacets($propertyId: ID!) {\n    syncPropertyFacets(propertyId: $propertyId) {\n      propertyId\n      items\n      unresolved\n      fieldFacets\n    }\n  }\n";
 /** `catalog.syncContentFacets`; its contract is on {@link CatalogModule.syncContentFacets}. */
 export declare function syncContentFacets(transport: Transport, propertyId: string, options?: Call): Promise<ContentFacetSyncResult>;
+/**
+ * The most different content item ids one {@link CatalogModule.syncContentItemFacets} call takes
+ * (the engine's own bound); repeats count once.
+ */
+export declare const MAX_CONTENT_ITEM_FACET_SYNC_IDS = 500;
+/** A property {@link CatalogModule.syncContentItemFacets} did not sync, and why. */
+export interface ContentItemFacetSyncSkip {
+    propertyId: string;
+    /**
+     * The refusal the property's own sync gave: `MANAGED_BY_ORGANIZATION` for a property of the
+     * store's organization workspace (it is synced in the workspace), or any refusal
+     * {@link CatalogModule.syncContentFacets} documents.
+     */
+    code: string;
+    /** The refusal's sentence, as the engine words it. */
+    message: string;
+}
+/** What {@link CatalogModule.syncContentItemFacets} did. */
+export interface ContentItemFacetSyncResult {
+    /**
+     * Each filterable `content_item` property of the store whose values name at least one of the
+     * items, synced as {@link CatalogModule.syncContentFacets} syncs it.
+     */
+    synced: ContentFacetSyncResult[];
+    /** Each such property that was refused; nothing of it was written, the others were synced. */
+    skipped: ContentItemFacetSyncSkip[];
+    /**
+     * Whether the call wrote anything: a filter value created, renamed or removed, or a product's
+     * filter assignments changed. False on a repeat that found everything in line.
+     */
+    changed: boolean;
+}
+export declare const SYNC_CONTENT_ITEM_FACETS_MUTATION = "\n  mutation CatalogSyncContentItemFacets($contentItemIds: [ID!]!) {\n    syncContentItemFacets(contentItemIds: $contentItemIds) {\n      synced {\n        propertyId\n        items\n        unresolved\n        fieldFacets\n      }\n      skipped {\n        propertyId\n        code\n        message\n      }\n      changed\n    }\n  }\n";
+/**
+ * `catalog.syncContentItemFacets`; its contract is on
+ * {@link CatalogModule.syncContentItemFacets}. The engine's own id checks run before sending.
+ */
+export declare function syncContentItemFacets(transport: Transport, contentItemIds: readonly string[], options?: Call): Promise<ContentItemFacetSyncResult>;
 export declare function createPropertiesModule(transport: Transport): PropertiesModule;

package/dist/catalog/properties.js

@@ -1,4 +1,4 @@
-import { createPage } from '@sixtyninecommerce/core';
+import { createPage, ValidationError } from '@sixtyninecommerce/core';
 import { assertDeleted, DELETION_FIELDS, fieldOf, } from './types.js';
 const PROPERTY_FIELDS = /* GraphQL */ `
   id
@@ -22,6 +22,11 @@ const PROPERTY_FIELDS = /* GraphQL */ `
     productFilter
   }
   facetId
+  fieldFacets {
+    fieldSlug
+    fieldType
+    facetId
+  }
   translations {
     id
     languageCode
@@ -92,6 +97,11 @@ export const REORDER_PROPERTIES_MUTATION = /* GraphQL */ `
     reorderProperties(groupId: $groupId, propertyIds: $propertyIds) { ${PROPERTY_FIELDS} }
   }
 `;
+export const CONFIGURE_FIELD_FACETS_MUTATION = /* GraphQL */ `
+  mutation CatalogConfigureFieldFacets($propertyId: ID!, $fields: [FieldFacetDefinitionInput!]!) {
+    configureFieldFacets(propertyId: $propertyId, fields: $fields)
+  }
+`;
 export const PRODUCT_PROPERTY_VALUES_QUERY = /* GraphQL */ `
   query CatalogProductPropertyValues($productId: ID!) {
     productPropertyValues(productId: $productId) {
@@ -124,6 +134,57 @@ export const SYNC_PROPERTY_FACETS_MUTATION = /* GraphQL */ `
 export function syncContentFacets(transport, propertyId, options) {
     return fieldOf(transport, SYNC_PROPERTY_FACETS_MUTATION, 'syncPropertyFacets', { propertyId }, options);
 }
+/**
+ * The most different content item ids one {@link CatalogModule.syncContentItemFacets} call takes
+ * (the engine's own bound); repeats count once.
+ */
+export const MAX_CONTENT_ITEM_FACET_SYNC_IDS = 500;
+export const SYNC_CONTENT_ITEM_FACETS_MUTATION = /* GraphQL */ `
+  mutation CatalogSyncContentItemFacets($contentItemIds: [ID!]!) {
+    syncContentItemFacets(contentItemIds: $contentItemIds) {
+      synced {
+        propertyId
+        items
+        unresolved
+        fieldFacets
+      }
+      skipped {
+        propertyId
+        code
+        message
+      }
+      changed
+    }
+  }
+`;
+function refuseContentItemIds(message) {
+    return new ValidationError({
+        code: 'CONTENT_ITEM_IDS_INVALID',
+        message: `${message} Nothing was sent.`,
+        status: 400,
+        service: 'vendure',
+    });
+}
+/**
+ * `catalog.syncContentItemFacets`; its contract is on
+ * {@link CatalogModule.syncContentItemFacets}. The engine's own id checks run before sending.
+ */
+export function syncContentItemFacets(transport, contentItemIds, options) {
+    if (!Array.isArray(contentItemIds)) {
+        return Promise.reject(refuseContentItemIds('Send the content item ids as a list.'));
+    }
+    const distinct = new Set();
+    for (const id of contentItemIds) {
+        if (typeof id !== 'string' || id.trim() === '') {
+            return Promise.reject(refuseContentItemIds('A content item id is blank.'));
+        }
+        distinct.add(id.trim().toLowerCase());
+    }
+    if (distinct.size > MAX_CONTENT_ITEM_FACET_SYNC_IDS) {
+        return Promise.reject(refuseContentItemIds(`Send at most ${String(MAX_CONTENT_ITEM_FACET_SYNC_IDS)} different content item ids per call; this one named ${String(distinct.size)}. Split them into several calls.`));
+    }
+    return fieldOf(transport, SYNC_CONTENT_ITEM_FACETS_MUTATION, 'syncContentItemFacets', { contentItemIds: [...contentItemIds] }, options);
+}
 export function createPropertiesModule(transport) {
     const call = (document, field, variables, options) => fieldOf(transport, document, field, variables, options);
     const deleted = async (document, field, code, id, options) => {
@@ -148,6 +209,9 @@ export function createPropertiesModule(transport) {
         update: (input, options) => call(UPDATE_PROPERTY_MUTATION, 'updateProperty', { input }, options),
         delete: (id, options) => deleted(DELETE_PROPERTY_MUTATION, 'deleteProperty', 'PROPERTY_NOT_DELETED', id, options),
         reorder: (groupId, propertyIds, options) => call(REORDER_PROPERTIES_MUTATION, 'reorderProperties', { groupId, propertyIds }, options),
+        async configureFieldFacets(propertyId, fields, options) {
+            await call(CONFIGURE_FIELD_FACETS_MUTATION, 'configureFieldFacets', { propertyId, fields }, options);
+        },
         values: {
             get: (productId, options) => call(PRODUCT_PROPERTY_VALUES_QUERY, 'productPropertyValues', { productId }, options),
             async set(productId, values, options) {

package/dist/catalog/recommendations.d.ts

@@ -0,0 +1,288 @@
+/**
+ * Product recommendations (headless spec §9.2 `catalog`: "recommendations"; W10-13): the store's
+ * recommendation groups ("Customers also bought", "Complete the look"), what each one draws its
+ * products from, and the products hand-picked per product for a manual group.
+ *
+ * - **A `DYNAMIC` group's entries are its rules**, read in `position` order: one named product
+ *   (`PRODUCT`), the products of a collection (`COLLECTION`) or with a facet value
+ *   (`FACET_VALUE`), or the viewed product's own collections (`SAME_COLLECTION`) or properties
+ *   (`SAME_PROPERTIES`). The storefront fills the group up to `maxItems` from the first entry on,
+ *   never with the viewed product, a disabled product or one the store hides from the shopper.
+ * - **A `MANUAL` group has no entries**: its products are picked per viewed product
+ *   (`manual.set`), and the storefront shows them in the order picked. A group's mode is chosen
+ *   when it is created and never changes.
+ * - **A disabled group** (`enabled: false`) is kept but never shown on the storefront.
+ * - **Positions** are integers; a group or entry created without one goes after the last.
+ *   `reorder` rewrites them as `0, 1, 2…` in the order given.
+ *
+ * Permissions: reads need `ReadCatalog`, writes `UpdateCatalog`. Every row is the store's own: a
+ * group or entry of another store is never answered and never changed (a read answers `null` or
+ * leaves it out; a write refuses it as unknown), and a rule only ever draws from the store's own
+ * products, collections and facet values.
+ *
+ * Refusals, GraphQL errors mapped by `core`. An unknown id and another store's get the same answer,
+ * so none tells whether another store holds the row:
+ * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a group or entry the store does not have, and the
+ *   viewed product of `manual.set` when the store does not hold it.
+ * - `RECOMMENDATION_SOURCE_NOT_FOUND` → `NotFoundError` (404): a rule's `sourceId` that is not a
+ *   product, collection or facet value of the store (`entries.create`, `entries.update`).
+ * - `RECOMMENDATION_TARGET_NOT_FOUND` → `NotFoundError` (404): `manual.set` picks the store does
+ *   not hold, each named in the message and in `details` (`field` `/targetProductIds/<index>`).
+ * - `RECOMMENDATION_GROUP_SLUG_TAKEN` → `ConflictError` (409): another of the store's groups holds
+ *   the slug, also when two writes race for one free slug.
+ * - `RECOMMENDATION_MAX_ITEMS_INVALID` → `ValidationError` (400): a group's `maxItems` that is not
+ *   a whole number from 1 to 50 ({@link RECOMMENDATION_MAX_ITEMS_RANGE}), on `groups.create` and
+ *   on a `groups.update` that sends it, `details[0].field` `/input/maxItems`. This SDK refuses it
+ *   before anything is sent, with the same code and detail, so an older platform release (which
+ *   stores any value) never receives one.
+ * - `USER_INPUT_ERROR` → `ValidationError` (400), in the engine's words: a rule that does not fit
+ *   its group or its type (a `MANUAL` group, a `sourceId` missing or sent where none goes), picks
+ *   in a `DYNAMIC` group.
+ * - `FORBIDDEN` → `PermissionDeniedError` (403) without the permission.
+ *
+ * An id that is not a uuid (any id argument, a `sourceId` and each pick included) is refused
+ * before all of these with core's `ENTITY_NOT_FOUND` (`NotFoundError`, 404, no `details`), so
+ * branch on the class for not-found and on the code only to tell which row is missing.
+ *
+ * A platform release older than these codes answers each not-found and a taken slug as
+ * `USER_INPUT_ERROR` (400) in its own words ("Recommendation group not found"), a slug lost in a
+ * race as `DUPLICATE_RECORD`, and takes another store's collection or facet value as a rule's
+ * source.
+ *
+ * No release gate: every operation here is served by every platform release this SDK supports.
+ * No method deduplicates on `idempotencyKey`: repeating a `create` makes a second row.
+ */
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/**
+ * The fewest and the most products a group may show (`maxItems`), both included. The platform
+ * refuses any other value with `RECOMMENDATION_MAX_ITEMS_INVALID`, and so does this SDK before
+ * sending.
+ */
+export declare const RECOMMENDATION_MAX_ITEMS_RANGE: {
+    readonly min: 1;
+    readonly max: 50;
+};
+/** What a `DYNAMIC` group's entry draws its products from. */
+export type RecommendationSourceType = 'PRODUCT' | 'COLLECTION' | 'FACET_VALUE' | 'SAME_COLLECTION' | 'SAME_PROPERTIES';
+/** `DYNAMIC`: rules (entries). `MANUAL`: products picked per viewed product (`manual.set`). */
+export type RecommendationGroupMode = 'DYNAMIC' | 'MANUAL';
+/** The source types whose entry names a row (`sourceId`); the others must name none. */
+export declare const RECOMMENDATION_SOURCE_TYPES_WITH_ID: readonly RecommendationSourceType[];
+/** One rule of a `DYNAMIC` group. */
+export interface RecommendationEntry {
+    id: string;
+    groupId: string;
+    sourceType: RecommendationSourceType;
+    /**
+     * The product, collection or facet value for `PRODUCT`, `COLLECTION` and `FACET_VALUE`; `null`
+     * for `SAME_COLLECTION` and `SAME_PROPERTIES`. Always a row of this store when it was written:
+     * `entries.create` and `entries.update` refuse any other (`RECOMMENDATION_SOURCE_NOT_FOUND`). A
+     * row deleted or taken out of the store since adds nothing, and the storefront never draws from
+     * another store's collection or facet value, a rule stored before the refusal included. A deleted
+     * product's `PRODUCT` entries are removed with it.
+     */
+    sourceId: string | null;
+    position: number;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+}
+/** A group without its entries, as `manual.get` and `manual.set` answer it. */
+export interface RecommendationGroupSummary {
+    id: string;
+    name: string;
+    /** Unique within the store; the storefront asks for one group by it. */
+    slug: string;
+    description: string | null;
+    /**
+     * The most products the storefront shows for this group. Written as 1 to 50; a group stored
+     * outside that range before the platform enforced it keeps its value until `maxItems` is sent.
+     */
+    maxItems: number;
+    position: number;
+    enabled: boolean;
+    mode: RecommendationGroupMode;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+}
+export interface RecommendationGroup extends RecommendationGroupSummary {
+    /** In `position` order (ties: the older first). Always empty on a `MANUAL` group. */
+    entries: RecommendationEntry[];
+}
+/** One `MANUAL` group and the products picked in it for one viewed product. */
+export interface ProductManualRecommendations {
+    group: RecommendationGroupSummary;
+    /** In the order picked; empty when none are. */
+    productIds: string[];
+}
+export interface CreateRecommendationGroupInput {
+    name: string;
+    /** Defaults to the name, lower-cased, every run of other characters than `a-z0-9` a `-`. */
+    slug?: string;
+    description?: string;
+    /**
+     * Defaults to 10. A whole number from 1 to 50 ({@link RECOMMENDATION_MAX_ITEMS_RANGE}); any
+     * other is refused `RECOMMENDATION_MAX_ITEMS_INVALID` before it is sent.
+     */
+    maxItems?: number;
+    /** Defaults to after the store's last group. */
+    position?: number;
+    /** Defaults to true. */
+    enabled?: boolean;
+    /** Defaults to `DYNAMIC`; never changes afterwards. */
+    mode?: RecommendationGroupMode;
+}
+/** Only the fields named change; `description: null` clears it. */
+export interface UpdateRecommendationGroupInput {
+    name?: string;
+    slug?: string;
+    description?: string | null;
+    /**
+     * A whole number from 1 to 50, else refused `RECOMMENDATION_MAX_ITEMS_INVALID` before it is
+     * sent. Left out, the stored value stays (and is not judged, so a group stored outside the
+     * range before the rule can still be renamed, moved or disabled).
+     */
+    maxItems?: number;
+    position?: number;
+    enabled?: boolean;
+}
+export interface CreateRecommendationEntryInput {
+    groupId: string;
+    sourceType: RecommendationSourceType;
+    /** Required for `PRODUCT`, `COLLECTION` and `FACET_VALUE`; refused for the other two. */
+    sourceId?: string;
+    /** Defaults to after the group's last entry. */
+    position?: number;
+}
+/** Only the fields named change; `sourceId: null` clears it (for a `SAME_*` source type). */
+export interface UpdateRecommendationEntryInput {
+    sourceType?: RecommendationSourceType;
+    sourceId?: string | null;
+    position?: number;
+}
+export interface RecommendationsModule {
+    groups: {
+        /**
+         * Every group of the store, in `position` order (ties: the older first), each with its
+         * entries. The engine answers them all at once; there are no pages.
+         *
+         * @effect read
+         */
+        list(options?: Call): Promise<RecommendationGroup[]>;
+        /**
+         * One group with its entries; `null` when the store has no group with that id.
+         *
+         * @effect read
+         */
+        get(id: string, options?: Call): Promise<RecommendationGroup | null>;
+        /**
+         * Refused: a `maxItems` outside 1–50 (`RECOMMENDATION_MAX_ITEMS_INVALID`, before anything is
+         * sent); a slug the store's other group already holds, the defaulted one included
+         * (`RECOMMENDATION_GROUP_SLUG_TAKEN`).
+         *
+         * @effect write
+         */
+        create(input: CreateRecommendationGroupInput, options?: Call): Promise<RecommendationGroup>;
+        /**
+         * Refused: a `maxItems` sent outside 1–50 (`RECOMMENDATION_MAX_ITEMS_INVALID`, before anything
+         * is sent); a group the store does not have (`ENTITY_NOT_FOUND`); a slug another of its groups
+         * holds (`RECOMMENDATION_GROUP_SLUG_TAKEN`).
+         *
+         * @effect write
+         */
+        update(id: string, input: UpdateRecommendationGroupInput, options?: Call): Promise<RecommendationGroup>;
+        /**
+         * Deletes the group, its entries and every product's picks in it. Refused
+         * (`ENTITY_NOT_FOUND`) for a group the store does not have.
+         *
+         * @effect destructive
+         */
+        delete(id: string, options?: Call): Promise<void>;
+        /**
+         * Gives the named groups the positions `0, 1, 2…` in the order given, and answers every group
+         * as `list` does. An id the store does not hold is skipped without a word; a group left out
+         * keeps its position, which may then equal a named one's: name them all.
+         *
+         * @effect write
+         */
+        reorder(ids: string[], options?: Call): Promise<RecommendationGroup[]>;
+    };
+    /** The rules of `DYNAMIC` groups. */
+    entries: {
+        /**
+         * Refused: a group the store does not have (`ENTITY_NOT_FOUND`); a `sourceId` that is not a
+         * product, collection or facet value of the store (`RECOMMENDATION_SOURCE_NOT_FOUND`: another
+         * store's is refused like an unknown id); a `MANUAL` group, or a `sourceId` missing for
+         * `PRODUCT` / `COLLECTION` / `FACET_VALUE` or sent for `SAME_COLLECTION` / `SAME_PROPERTIES`
+         * (`USER_INPUT_ERROR`).
+         *
+         * @effect write
+         */
+        create(input: CreateRecommendationEntryInput, options?: Call): Promise<RecommendationEntry>;
+        /**
+         * Refused: an entry the store does not have (`ENTITY_NOT_FOUND`); a source type and
+         * `sourceId` that do not go together once the change is applied (`USER_INPUT_ERROR`); a
+         * change of either that leaves the rule naming no row of the store
+         * (`RECOMMENDATION_SOURCE_NOT_FOUND`). A change of `position` alone is not judged.
+         *
+         * @effect write
+         */
+        update(id: string, input: UpdateRecommendationEntryInput, options?: Call): Promise<RecommendationEntry>;
+        /**
+         * Refused (`ENTITY_NOT_FOUND`) for an entry the store does not have.
+         *
+         * @effect destructive
+         */
+        delete(id: string, options?: Call): Promise<void>;
+        /**
+         * Gives the group's named entries the positions `0, 1, 2…` in the order given, and answers
+         * the group's entries in `position` order. An id that is not one of THIS group's entries is
+         * skipped without a word (another group's entry never moves); an entry left out keeps its
+         * position. Refused (`ENTITY_NOT_FOUND`) for a group the store does not have.
+         *
+         * @effect write
+         */
+        reorder(groupId: string, ids: string[], options?: Call): Promise<RecommendationEntry[]>;
+    };
+    /** The products picked per viewed product in `MANUAL` groups (the product page's card). */
+    manual: {
+        /**
+         * Every `MANUAL` group of the store, in `position` order, each with the products picked for
+         * `productId`. A product with no picks (or none of this store) answers every group with an
+         * empty `productIds`; a store with no manual group answers `[]`.
+         *
+         * @effect read
+         */
+        get(productId: string, options?: Call): Promise<ProductManualRecommendations[]>;
+        /**
+         * Replaces the products picked for `productId` in one `MANUAL` group, in the order given:
+         * `[]` clears them. The product itself and repeats are dropped (the first one kept). One
+         * write: refused, nothing changes.
+         *
+         * Refused: a group the store does not have, or `productId` not a product of this store
+         * (`ENTITY_NOT_FOUND`); a picked product that is not (`RECOMMENDATION_TARGET_NOT_FOUND`,
+         * naming each, `details` pointing at where it was sent); a `DYNAMIC` group
+         * (`USER_INPUT_ERROR`).
+         *
+         * @effect write
+         */
+        set(productId: string, groupId: string, productIds: string[], options?: Call): Promise<RecommendationGroupSummary>;
+    };
+}
+export declare const RECOMMENDATION_GROUPS_QUERY = "\n  query CatalogRecommendationGroups {\n    recommendationGroups { \n  \n  id\n  name\n  slug\n  description\n  maxItems\n  position\n  enabled\n  mode\n  createdAt\n  updatedAt\n\n  entries { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n }\n  }\n";
+export declare const RECOMMENDATION_GROUP_QUERY = "\n  query CatalogRecommendationGroup($id: ID!) {\n    recommendationGroup(id: $id) { \n  \n  id\n  name\n  slug\n  description\n  maxItems\n  position\n  enabled\n  mode\n  createdAt\n  updatedAt\n\n  entries { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n }\n  }\n";
+export declare const CREATE_RECOMMENDATION_GROUP_MUTATION = "\n  mutation CatalogCreateRecommendationGroup($input: CreateRecommendationGroupInput!) {\n    createRecommendationGroup(input: $input) { \n  \n  id\n  name\n  slug\n  description\n  maxItems\n  position\n  enabled\n  mode\n  createdAt\n  updatedAt\n\n  entries { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n }\n  }\n";
+export declare const UPDATE_RECOMMENDATION_GROUP_MUTATION = "\n  mutation CatalogUpdateRecommendationGroup($id: ID!, $input: UpdateRecommendationGroupInput!) {\n    updateRecommendationGroup(id: $id, input: $input) { \n  \n  id\n  name\n  slug\n  description\n  maxItems\n  position\n  enabled\n  mode\n  createdAt\n  updatedAt\n\n  entries { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n }\n  }\n";
+export declare const DELETE_RECOMMENDATION_GROUP_MUTATION = "\n  mutation CatalogDeleteRecommendationGroup($id: ID!) {\n    deleteRecommendationGroup(id: $id) { \n  result\n  message\n }\n  }\n";
+export declare const REORDER_RECOMMENDATION_GROUPS_MUTATION = "\n  mutation CatalogReorderRecommendationGroups($ids: [ID!]!) {\n    reorderRecommendationGroups(ids: $ids) { \n  \n  id\n  name\n  slug\n  description\n  maxItems\n  position\n  enabled\n  mode\n  createdAt\n  updatedAt\n\n  entries { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n }\n  }\n";
+export declare const CREATE_RECOMMENDATION_ENTRY_MUTATION = "\n  mutation CatalogCreateRecommendationEntry($input: CreateRecommendationEntryInput!) {\n    createRecommendationEntry(input: $input) { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const UPDATE_RECOMMENDATION_ENTRY_MUTATION = "\n  mutation CatalogUpdateRecommendationEntry($id: ID!, $input: UpdateRecommendationEntryInput!) {\n    updateRecommendationEntry(id: $id, input: $input) { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const DELETE_RECOMMENDATION_ENTRY_MUTATION = "\n  mutation CatalogDeleteRecommendationEntry($id: ID!) {\n    deleteRecommendationEntry(id: $id) { \n  result\n  message\n }\n  }\n";
+export declare const REORDER_RECOMMENDATION_ENTRIES_MUTATION = "\n  mutation CatalogReorderRecommendationEntries($groupId: ID!, $ids: [ID!]!) {\n    reorderRecommendationEntries(groupId: $groupId, ids: $ids) { \n  id\n  groupId\n  sourceType\n  sourceId\n  position\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const PRODUCT_MANUAL_RECOMMENDATIONS_QUERY = "\n  query CatalogProductManualRecommendations($productId: ID!) {\n    productManualRecommendations(productId: $productId) {\n      group { \n  id\n  name\n  slug\n  description\n  maxItems\n  position\n  enabled\n  mode\n  createdAt\n  updatedAt\n }\n      productIds\n    }\n  }\n";
+export declare const SET_PRODUCT_MANUAL_RECOMMENDATIONS_MUTATION = "\n  mutation CatalogSetProductManualRecommendations(\n    $productId: ID!\n    $groupId: ID!\n    $targetProductIds: [ID!]!\n  ) {\n    setProductManualRecommendations(\n      productId: $productId\n      groupId: $groupId\n      targetProductIds: $targetProductIds\n    ) { \n  id\n  name\n  slug\n  description\n  maxItems\n  position\n  enabled\n  mode\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare function createRecommendationsModule(transport: Transport): RecommendationsModule;