@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/catalog/collections.js

@@ -1,4 +1,30 @@
-import { ASSET_REF_FIELDS, assertDeleted, CATALOGUE_OWNERSHIP_FIELDS, DELETION_FIELDS, fieldOf, vendureListPage, } from './types.js';
+import { pageFromVendureList, ValidationError, } from '@sixtyninecommerce/core';
+import { createSearchModule } from '../search/index.js';
+import { ASSET_REF_FIELDS, assertDeleted, CATALOGUE_OWNERSHIP_FIELDS, DEFAULT_PAGE_SIZE, DELETION_FIELDS, fieldOf, toAssetRef, vendureListPage, } from './types.js';
+/** The most collections one {@link CollectionsModule.search} answers. */
+export const MAX_COLLECTION_SEARCH_TAKE = 100;
+const SEO_FIELDS = /* GraphQL */ `
+  customFields {
+    isRoutable
+    isCanonical
+    noindex
+    nofollow
+    metaRobotsMaxImagePreview
+    socialImageId
+    socialOgType
+    twitterCardType
+  }
+`;
+const TRANSLATION_SEO_FIELDS = /* GraphQL */ `
+  customFields {
+    seoTitle
+    seoDescription
+    canonicalUrl
+    socialTitle
+    socialDescription
+    socialImageAlt
+  }
+`;
 export const COLLECTION_FIELDS = /* GraphQL */ `
   id
   ${CATALOGUE_OWNERSHIP_FIELDS}
@@ -26,12 +52,14 @@ export const COLLECTION_FIELDS = /* GraphQL */ `
     slug
   }
   productVariantCount
+  ${SEO_FIELDS}
   translations {
     id
     languageCode
     name
     slug
     description
+    ${TRANSLATION_SEO_FIELDS}
   }
 `;
 export const COLLECTIONS_QUERY = /* GraphQL */ `
@@ -44,7 +72,19 @@ export const COLLECTIONS_QUERY = /* GraphQL */ `
 `;
 export const COLLECTION_QUERY = /* GraphQL */ `
   query CatalogCollection($id: ID!) {
-    collection(id: $id) { ${COLLECTION_FIELDS} }
+    collection(id: $id) {
+      ${COLLECTION_FIELDS}
+      parent {
+        id
+        name
+      }
+      children {
+        id
+        name
+        slug
+        position
+      }
+    }
   }
 `;
 export const CREATE_COLLECTION_MUTATION = /* GraphQL */ `
@@ -67,25 +107,216 @@ export const MOVE_COLLECTION_MUTATION = /* GraphQL */ `
     moveCollection(input: $input) { ${COLLECTION_FIELDS} }
   }
 `;
+export const COLLECTION_FILTER_DEFINITIONS_QUERY = /* GraphQL */ `
+  query CatalogCollectionFilterDefinitions {
+    collectionFilters {
+      code
+      description
+      args {
+        name
+        type
+        list
+        required
+        defaultValue
+        label
+        description
+        ui
+      }
+    }
+  }
+`;
+/**
+ * The preview's price is `storePrice` (null for a variant the store has no price for), never
+ * core's `price` / `priceWithTax` / `currencyCode`, which raise "No price information was
+ * found…" for such a variant and, being non-null, empty the whole preview (#1504).
+ */
+export const PREVIEW_COLLECTION_VARIANTS_QUERY = /* GraphQL */ `
+  query CatalogPreviewCollectionVariants(
+    $input: PreviewCollectionVariantsInput!
+    $options: ProductVariantListOptions
+  ) {
+    previewCollectionVariants(input: $input, options: $options) {
+      items {
+        id
+        name
+        sku
+        storePrice {
+          price
+          priceWithTax
+          currencyCode
+        }
+        product {
+          id
+          name
+          featuredAsset { ${ASSET_REF_FIELDS} }
+        }
+      }
+      totalItems
+    }
+  }
+`;
+const COLLECTION_SORT_FIELDS = [
+    'position',
+    'name',
+    'createdAt',
+    'updatedAt',
+    'id',
+];
+function toPreviewVariant(wire) {
+    const { featuredAsset, ...product } = wire.product;
+    return {
+        ...wire,
+        product: { ...product, featuredAsset: featuredAsset ? toAssetRef(featuredAsset) : null },
+    };
+}
+function toSeo(wire) {
+    return {
+        isRoutable: wire?.isRoutable ?? null,
+        isCanonical: wire?.isCanonical ?? null,
+        noindex: wire?.noindex ?? null,
+        nofollow: wire?.nofollow ?? null,
+        metaRobotsMaxImagePreview: wire?.metaRobotsMaxImagePreview ?? null,
+        socialImageId: wire?.socialImageId ?? null,
+        socialOgType: wire?.socialOgType ?? null,
+        twitterCardType: wire?.twitterCardType ?? null,
+    };
+}
+function toTranslationSeo(wire) {
+    return {
+        seoTitle: wire?.seoTitle ?? null,
+        seoDescription: wire?.seoDescription ?? null,
+        canonicalUrl: wire?.canonicalUrl ?? null,
+        socialTitle: wire?.socialTitle ?? null,
+        socialDescription: wire?.socialDescription ?? null,
+        socialImageAlt: wire?.socialImageAlt ?? null,
+    };
+}
+function toCollection(wire) {
+    const { customFields, translations, featuredAsset, assets, ...rest } = wire;
+    return {
+        ...rest,
+        featuredAsset: featuredAsset ? toAssetRef(featuredAsset) : null,
+        assets: (assets ?? []).map(toAssetRef),
+        seo: toSeo(customFields),
+        translations: (translations ?? []).map(({ customFields: seo, ...translation }) => ({
+            ...translation,
+            seo: toTranslationSeo(seo),
+        })),
+    };
+}
+/** `seo` goes on the wire as the engine's `customFields`, only the keys the caller named. */
+function toWireTranslation(translation) {
+    const { seo, ...rest } = translation;
+    return seo === undefined ? rest : { ...rest, customFields: { ...seo } };
+}
+function toWireInput(input) {
+    const { seo, translations, ...rest } = input;
+    return {
+        ...rest,
+        ...(translations === undefined ? {} : { translations: translations.map(toWireTranslation) }),
+        ...(seo === undefined ? {} : { customFields: { ...seo } }),
+    };
+}
+function invalidSort(sort) {
+    return new ValidationError({
+        code: 'INVALID_COLLECTION_SORT',
+        message: `sort must name one of ${COLLECTION_SORT_FIELDS.join(', ')} and the direction ASC or DESC; got ${JSON.stringify(sort)}. Nothing was sent.`,
+        status: 400,
+        service: 'vendure',
+    });
+}
+function listOptionsOf(options) {
+    const filter = {};
+    if (options?.parentId !== undefined)
+        filter.parentId = { eq: options.parentId };
+    if (options?.name !== undefined)
+        filter.name = { contains: options.name };
+    if (options?.ids !== undefined)
+        filter.id = { in: [...options.ids] };
+    const sort = options?.sort;
+    if (sort !== undefined &&
+        (!COLLECTION_SORT_FIELDS.includes(sort.field) ||
+            (sort.direction !== 'ASC' && sort.direction !== 'DESC'))) {
+        throw invalidSort(sort);
+    }
+    return {
+        ...(options?.topLevelOnly === true ? { topLevelOnly: true } : {}),
+        ...(Object.keys(filter).length > 0 ? { filter } : {}),
+        ...(sort === undefined ? {} : { sort: { [sort.field]: sort.direction } }),
+    };
+}
+function invalidSearch(message) {
+    return new ValidationError({
+        code: 'SEARCH_INPUT_INVALID',
+        message: `${message} Nothing was sent.`,
+        status: 400,
+        service: 'vendure',
+    });
+}
 export function createCollectionsModule(transport) {
+    const write = async (document, field, variables, options) => toCollection(await fieldOf(transport, document, field, variables, options));
+    const list = async (options) => {
+        const listOptions = listOptionsOf(options);
+        if (options?.ids !== undefined && options.ids.length === 0) {
+            return pageFromVendureList({ items: [], totalItems: 0 }, 0, options.limit ?? DEFAULT_PAGE_SIZE, () => Promise.reject(new Error('an empty page has no next page')));
+        }
+        return vendureListPage(transport, COLLECTIONS_QUERY, 'collections', (skip, take) => ({ options: { skip, take, ...listOptions } }), options, toCollection);
+    };
     return {
-        list: (options) => {
-            const filter = {};
-            if (options?.parentId !== undefined)
-                filter.parentId = { eq: options.parentId };
-            if (options?.name !== undefined)
-                filter.name = { contains: options.name };
-            return vendureListPage(transport, COLLECTIONS_QUERY, 'collections', (skip, take) => ({
-                options: { skip, take, ...(Object.keys(filter).length > 0 ? { filter } : {}) },
-            }), options);
+        list,
+        async get(id, options) {
+            const collection = await fieldOf(transport, COLLECTION_QUERY, 'collection', { id }, options);
+            return collection ? toCollection(collection) : null;
         },
-        get: (id, options) => fieldOf(transport, COLLECTION_QUERY, 'collection', { id }, options),
-        create: (input, options) => fieldOf(transport, CREATE_COLLECTION_MUTATION, 'createCollection', { input }, options),
-        update: (input, options) => fieldOf(transport, UPDATE_COLLECTION_MUTATION, 'updateCollection', { input }, options),
+        async search(term, options = {}) {
+            const { take = DEFAULT_PAGE_SIZE, skip = 0, ...call } = options;
+            if (!Number.isInteger(take) || take < 1 || take > MAX_COLLECTION_SEARCH_TAKE) {
+                throw invalidSearch(`take must be a whole number from 1 to ${String(MAX_COLLECTION_SEARCH_TAKE)}; got ${String(take)}.`);
+            }
+            if (!Number.isInteger(skip) || skip < 0) {
+                throw invalidSearch(`skip must be a whole number from 0; got ${String(skip)}.`);
+            }
+            const hits = await createSearchModule(transport).index('collections', { term, take, skip }, call);
+            const ids = [...new Set(hits.items.map((hit) => hit.id))];
+            if (ids.length === 0)
+                return { items: [], total: hits.total };
+            // The index says which and in what order; the rows are the engine's, read in the store the
+            // call acts on, so a collection the store no longer holds is not answered.
+            const page = await list({ ...call, ids, limit: ids.length });
+            const byId = new Map(page.items.map((collection) => [collection.id, collection]));
+            return {
+                items: ids.flatMap((id) => {
+                    const collection = byId.get(id);
+                    return collection ? [collection] : [];
+                }),
+                total: hits.total,
+            };
+        },
+        create: (input, options) => write(CREATE_COLLECTION_MUTATION, 'createCollection', { input: toWireInput(input) }, options),
+        update: (input, options) => write(UPDATE_COLLECTION_MUTATION, 'updateCollection', { input: toWireInput(input) }, options),
         async delete(id, options) {
             const response = await fieldOf(transport, DELETE_COLLECTION_MUTATION, 'deleteCollection', { id }, options);
             assertDeleted('COLLECTION_NOT_DELETED', [response]);
         },
-        move: (collectionId, parentId, index, options) => fieldOf(transport, MOVE_COLLECTION_MUTATION, 'moveCollection', { input: { collectionId, parentId, index } }, options),
+        move: (collectionId, parentId, index, options) => write(MOVE_COLLECTION_MUTATION, 'moveCollection', { input: { collectionId, parentId, index } }, options),
+        filterDefinitions: (options) => fieldOf(transport, COLLECTION_FILTER_DEFINITIONS_QUERY, 'collectionFilters', {}, options),
+        previewVariants(input, options = {}) {
+            const { term: rawTerm, ...listOptions } = options;
+            const term = rawTerm?.trim() ?? '';
+            const filter = term === ''
+                ? {}
+                : {
+                    filter: { name: { contains: term }, sku: { contains: term } },
+                    filterOperator: 'OR',
+                };
+            return vendureListPage(transport, PREVIEW_COLLECTION_VARIANTS_QUERY, 'previewCollectionVariants', (skip, take) => ({
+                input: {
+                    filters: input.filters,
+                    inheritFilters: input.inheritFilters,
+                    ...(input.parentId === undefined ? {} : { parentId: input.parentId }),
+                },
+                options: { skip, take, ...filter },
+            }), listOptions, toPreviewVariant);
+        },
     };
 }

package/dist/catalog/documents.d.ts

@@ -0,0 +1,142 @@
+/**
+ * A product's documents (headless spec §9.2 `catalog`: "documents"; W10-10): the downloads the
+ * storefront lists on a product page (a data sheet, a manual, a certificate), each pointing at a
+ * file in the asset library.
+ *
+ * - **Universal or localized.** A universal document (`isLocalized: false`) has exactly ONE
+ *   translation, with no language code, and it names the file. A localized one has one
+ *   translation per language (each language once), and at least one of them names a file; the
+ *   storefront shows the request's language, else the store's default, else one with a file.
+ * - **Who sees it** on the storefront: everyone (`PUBLIC`), signed-in customers
+ *   (`AUTHENTICATED`), or customers in the listed groups (`CUSTOMER_GROUP`, which needs at least
+ *   one group). The Admin API always lists every document.
+ * - **Order.** A new document goes after the product's last; `reorder` sets the order.
+ *
+ * Every document is the store's own: a product, document or customer group of another store is
+ * never answered and never written.
+ *
+ * Permissions: `list` needs `ReadCatalog`, the writes `UpdateCatalog`.
+ *
+ * Refusals, GraphQL errors mapped by `core`:
+ * - `USER_INPUT_ERROR` → `ValidationError` (400), in the engine's words: a product of another
+ *   store or none ("Product … not found"), a document of another store or none
+ *   ("ProductDocument … not found"), a translation set that breaks the rules above, a
+ *   `CUSTOMER_GROUP` document with no group, a `reorder` naming a document that is not one of the
+ *   product's.
+ * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a customer group the store does not hold.
+ * - `TRANSLATION_LANGUAGE_NOT_OFFERED` → `ValidationError` (400): a translation in a language the
+ *   store does not offer (a language the document already has stays editable).
+ * - `FORBIDDEN` → `PermissionDeniedError` (403) without the permission.
+ *
+ * No release gate: every operation here is served by every platform release this SDK supports.
+ * No method deduplicates on `idempotencyKey`: repeating a `create` adds a second document.
+ */
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+import { type LanguageCode } from './types.js';
+export type ProductDocumentVisibility = 'PUBLIC' | 'AUTHENTICATED' | 'CUSTOMER_GROUP';
+/** The file a document translation points at: an asset of the library. */
+export interface ProductDocumentFile {
+    id: string;
+    name: string;
+    /** A string on the wire: a newer engine may add a type. */
+    type: 'IMAGE' | 'VIDEO' | 'BINARY' | (string & {});
+    mimeType: string;
+    /** Bytes. */
+    fileSize: number;
+    /** The asset's own URL (absolute or relative to the engine). */
+    source: string;
+    preview: string;
+}
+export interface ProductDocumentTranslation {
+    id: string;
+    /** Null on a universal document's one translation. */
+    languageCode: LanguageCode | null;
+    title: string;
+    description: string | null;
+    assetId: string | null;
+    /** Null when the translation names no file, or its file is gone. */
+    asset: ProductDocumentFile | null;
+}
+export interface ProductDocument {
+    id: string;
+    productId: string;
+    /** 0 first. */
+    position: number;
+    visibility: ProductDocumentVisibility | (string & {});
+    isLocalized: boolean;
+    translations: ProductDocumentTranslation[];
+    /** The groups a `CUSTOMER_GROUP` document is shown to; empty under the other two. */
+    customerGroups: Array<{
+        id: string;
+        name: string;
+    }>;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+}
+export interface ProductDocumentTranslationInput {
+    /** Null (or omitted) on a universal document; required, once per language, on a localized one. */
+    languageCode?: LanguageCode | null;
+    title: string;
+    description?: string | null;
+    /** The asset (`catalog.assets`) the translation points at. */
+    assetId?: string | null;
+}
+export interface CreateProductDocumentInput {
+    productId: string;
+    visibility: ProductDocumentVisibility;
+    isLocalized: boolean;
+    /** Required (one or more) under `CUSTOMER_GROUP`; ignored under the other two. */
+    customerGroupIds?: string[];
+    translations: ProductDocumentTranslationInput[];
+}
+/**
+ * Only the fields named change. `translations`, when sent, REPLACES the document's translations;
+ * `customerGroupIds`, when sent, replaces its groups. Leaving `CUSTOMER_GROUP` drops its groups.
+ */
+export interface UpdateProductDocumentInput {
+    visibility?: ProductDocumentVisibility;
+    isLocalized?: boolean;
+    customerGroupIds?: string[];
+    translations?: ProductDocumentTranslationInput[];
+}
+export interface ProductDocumentsModule {
+    /**
+     * The product's documents, in their order (ties: the older first). A product of another store,
+     * or none, answers `[]`.
+     *
+     * @effect read
+     */
+    list(productId: string, options?: Call): Promise<ProductDocument[]>;
+    /**
+     * Adds a document after the product's last.
+     *
+     * @effect write
+     */
+    create(input: CreateProductDocumentInput, options?: Call): Promise<ProductDocument>;
+    /** @effect write */
+    update(id: string, input: UpdateProductDocumentInput, options?: Call): Promise<ProductDocument>;
+    /**
+     * Deletes the document; its file stays in the asset library. A document the store does not
+     * have (another store's, or already deleted) is refused `PRODUCT_DOCUMENT_NOT_FOUND`
+     * (`NotFoundError`, 404, raised by this SDK: the engine answers it as `false`).
+     *
+     * @effect destructive
+     */
+    delete(id: string, options?: Call): Promise<void>;
+    /**
+     * Puts the named documents in this order (`0, 1, 2…`). Name the product's documents: one that
+     * is not the product's refuses the whole call and nothing moves; one left out keeps its position.
+     *
+     * @effect write
+     */
+    reorder(productId: string, orderedIds: string[], options?: Call): Promise<void>;
+}
+export declare const PRODUCT_DOCUMENTS_QUERY = "\n  query CatalogProductDocuments($productId: ID!) {\n    productDocuments(productId: $productId) { \n  id\n  productId\n  position\n  visibility\n  isLocalized\n  createdAt\n  updatedAt\n  translations {\n    id\n    languageCode\n    title\n    description\n    assetId\n    asset {\n      id\n      name\n      type\n      mimeType\n      fileSize\n      source\n      preview\n    }\n  }\n  customerGroups {\n    id\n    name\n  }\n }\n  }\n";
+export declare const CREATE_PRODUCT_DOCUMENT_MUTATION = "\n  mutation CatalogCreateProductDocument($input: CreateProductDocumentInput!) {\n    createProductDocument(input: $input) { \n  id\n  productId\n  position\n  visibility\n  isLocalized\n  createdAt\n  updatedAt\n  translations {\n    id\n    languageCode\n    title\n    description\n    assetId\n    asset {\n      id\n      name\n      type\n      mimeType\n      fileSize\n      source\n      preview\n    }\n  }\n  customerGroups {\n    id\n    name\n  }\n }\n  }\n";
+export declare const UPDATE_PRODUCT_DOCUMENT_MUTATION = "\n  mutation CatalogUpdateProductDocument($input: UpdateProductDocumentInput!) {\n    updateProductDocument(input: $input) { \n  id\n  productId\n  position\n  visibility\n  isLocalized\n  createdAt\n  updatedAt\n  translations {\n    id\n    languageCode\n    title\n    description\n    assetId\n    asset {\n      id\n      name\n      type\n      mimeType\n      fileSize\n      source\n      preview\n    }\n  }\n  customerGroups {\n    id\n    name\n  }\n }\n  }\n";
+export declare const DELETE_PRODUCT_DOCUMENT_MUTATION = "\n  mutation CatalogDeleteProductDocument($id: ID!) {\n    deleteProductDocument(id: $id)\n  }\n";
+export declare const REORDER_PRODUCT_DOCUMENTS_MUTATION = "\n  mutation CatalogReorderProductDocuments($productId: ID!, $orderedIds: [ID!]!) {\n    reorderProductDocuments(productId: $productId, orderedIds: $orderedIds)\n  }\n";
+export declare function createProductDocumentsModule(transport: Transport): ProductDocumentsModule;

package/dist/catalog/documents.js

@@ -0,0 +1,114 @@
+/**
+ * A product's documents (headless spec §9.2 `catalog`: "documents"; W10-10): the downloads the
+ * storefront lists on a product page (a data sheet, a manual, a certificate), each pointing at a
+ * file in the asset library.
+ *
+ * - **Universal or localized.** A universal document (`isLocalized: false`) has exactly ONE
+ *   translation, with no language code, and it names the file. A localized one has one
+ *   translation per language (each language once), and at least one of them names a file; the
+ *   storefront shows the request's language, else the store's default, else one with a file.
+ * - **Who sees it** on the storefront: everyone (`PUBLIC`), signed-in customers
+ *   (`AUTHENTICATED`), or customers in the listed groups (`CUSTOMER_GROUP`, which needs at least
+ *   one group). The Admin API always lists every document.
+ * - **Order.** A new document goes after the product's last; `reorder` sets the order.
+ *
+ * Every document is the store's own: a product, document or customer group of another store is
+ * never answered and never written.
+ *
+ * Permissions: `list` needs `ReadCatalog`, the writes `UpdateCatalog`.
+ *
+ * Refusals, GraphQL errors mapped by `core`:
+ * - `USER_INPUT_ERROR` → `ValidationError` (400), in the engine's words: a product of another
+ *   store or none ("Product … not found"), a document of another store or none
+ *   ("ProductDocument … not found"), a translation set that breaks the rules above, a
+ *   `CUSTOMER_GROUP` document with no group, a `reorder` naming a document that is not one of the
+ *   product's.
+ * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a customer group the store does not hold.
+ * - `TRANSLATION_LANGUAGE_NOT_OFFERED` → `ValidationError` (400): a translation in a language the
+ *   store does not offer (a language the document already has stays editable).
+ * - `FORBIDDEN` → `PermissionDeniedError` (403) without the permission.
+ *
+ * No release gate: every operation here is served by every platform release this SDK supports.
+ * No method deduplicates on `idempotencyKey`: repeating a `create` adds a second document.
+ */
+import { NotFoundError } from '@sixtyninecommerce/core';
+import { fieldOf } from './types.js';
+const DOCUMENT_FIELDS = /* GraphQL */ `
+  id
+  productId
+  position
+  visibility
+  isLocalized
+  createdAt
+  updatedAt
+  translations {
+    id
+    languageCode
+    title
+    description
+    assetId
+    asset {
+      id
+      name
+      type
+      mimeType
+      fileSize
+      source
+      preview
+    }
+  }
+  customerGroups {
+    id
+    name
+  }
+`;
+export const PRODUCT_DOCUMENTS_QUERY = /* GraphQL */ `
+  query CatalogProductDocuments($productId: ID!) {
+    productDocuments(productId: $productId) { ${DOCUMENT_FIELDS} }
+  }
+`;
+export const CREATE_PRODUCT_DOCUMENT_MUTATION = /* GraphQL */ `
+  mutation CatalogCreateProductDocument($input: CreateProductDocumentInput!) {
+    createProductDocument(input: $input) { ${DOCUMENT_FIELDS} }
+  }
+`;
+export const UPDATE_PRODUCT_DOCUMENT_MUTATION = /* GraphQL */ `
+  mutation CatalogUpdateProductDocument($input: UpdateProductDocumentInput!) {
+    updateProductDocument(input: $input) { ${DOCUMENT_FIELDS} }
+  }
+`;
+export const DELETE_PRODUCT_DOCUMENT_MUTATION = /* GraphQL */ `
+  mutation CatalogDeleteProductDocument($id: ID!) {
+    deleteProductDocument(id: $id)
+  }
+`;
+export const REORDER_PRODUCT_DOCUMENTS_MUTATION = /* GraphQL */ `
+  mutation CatalogReorderProductDocuments($productId: ID!, $orderedIds: [ID!]!) {
+    reorderProductDocuments(productId: $productId, orderedIds: $orderedIds)
+  }
+`;
+/** The engine reads the list in `position` order; keep that, with the older first on a tie. */
+function byPosition(documents) {
+    return [...documents].sort((a, b) => a.position - b.position || a.createdAt.localeCompare(b.createdAt));
+}
+export function createProductDocumentsModule(transport) {
+    return {
+        list: async (productId, options) => byPosition(await fieldOf(transport, PRODUCT_DOCUMENTS_QUERY, 'productDocuments', { productId }, options)),
+        create: (input, options) => fieldOf(transport, CREATE_PRODUCT_DOCUMENT_MUTATION, 'createProductDocument', { input }, options),
+        update: (id, input, options) => fieldOf(transport, UPDATE_PRODUCT_DOCUMENT_MUTATION, 'updateProductDocument', { input: { ...input, id } }, options),
+        async delete(id, options) {
+            const deleted = await fieldOf(transport, DELETE_PRODUCT_DOCUMENT_MUTATION, 'deleteProductDocument', { id }, options);
+            if (!deleted) {
+                throw new NotFoundError({
+                    code: 'PRODUCT_DOCUMENT_NOT_FOUND',
+                    message: `This store has no product document ${id}.`,
+                    status: 404,
+                    service: 'vendure',
+                });
+            }
+        },
+        async reorder(productId, orderedIds, options) {
+            await fieldOf(transport, REORDER_PRODUCT_DOCUMENTS_MUTATION, 'reorderProductDocuments', { productId, orderedIds }, options);
+        },
+    };
+}

package/dist/catalog/index.d.ts

@@ -2,16 +2,21 @@ import type { Transport } from '@sixtyninecommerce/core';
 import type { Call } from '../types.js';
 import { type AssetsModule } from './assets.js';
 import { type CollectionsModule } from './collections.js';
+import { type ProductDocumentsModule } from './documents.js';
 import { type FacetsModule } from './facets.js';
+import { type ProductMetadataModule } from './metadata.js';
 import { type OptionsModule } from './options.js';
 import { type ProductsModule } from './products.js';
-import { type ContentFacetSyncResult, type PropertiesModule } from './properties.js';
+import { type ContentFacetSyncResult, type ContentItemFacetSyncResult, type PropertiesModule } from './properties.js';
+import { type RecommendationsModule } from './recommendations.js';
+import { type ReviewsModule } from './reviews.js';
 import { type VariantsModule } from './variants.js';
 import { type VisibilityModule } from './visibility.js';
 /**
  * The catalogue (spec §9.2 `catalog`): products, variants, options, facets,
- * collections, assets, storefront visibility and product properties — one
- * resource per namespace, over the Admin API the dashboard itself uses.
+ * collections, assets, storefront visibility, product documents, product SEO metadata, product
+ * properties, product recommendations and product reviews — one resource per namespace, over the
+ * Admin API the dashboard itself uses.
  *
  * **Per-resource, not per-intent.** Saving a product form is several calls
  * here (the product, its variants, its properties, its collections), and they
@@ -69,7 +74,15 @@ export interface CatalogModule {
     collections: CollectionsModule;
     assets: AssetsModule;
     visibility: VisibilityModule;
+    /** A product's downloads: data sheets, manuals, certificates (W10-10). */
+    documents: ProductDocumentsModule;
+    /** A product's SEO, social and AI-agent metadata, and the SEO coverage list (W10-10). */
+    metadata: ProductMetadataModule;
     properties: PropertiesModule;
+    /** Recommendation groups, their rules and the products picked per product (W10-13). */
+    recommendations: RecommendationsModule;
+    /** Product reviews: moderation, the store's replies, statistics, review attributes (W10-117). */
+    reviews: ReviewsModule;
     /**
      * "Sync filter values" for one filterable `content_item` or `product` property, done by the
      * engine (headless spec §7 `catalog.syncContentFacets`, by property, the unit the merchant syncs).
@@ -86,9 +99,11 @@ export interface CatalogModule {
      * anything changes. Repeating the call is safe: a label that did not change is not written
      * again, so a repeat answers the same counts and changes nothing.
      *
-     * Nothing runs it automatically in this release: rename a content item or a product, then call
-     * it (or press "Sync filter values") to update the filter label (ruling G17; an event-driven
-     * update is a later phase).
+     * Automatic for PUBLISHED content items (headless W10-19, ruling G115): when a published item
+     * is edited, published or unpublished, the platform syncs the properties naming it by itself
+     * within about a minute ({@link CatalogModule.syncContentItemFacets}). Call this after renaming
+     * a DRAFT or archived item (the content system announces nothing for one until it is
+     * published), after renaming a product, or to sync one property at once.
      *
      * Needs `UpdateCatalog`. Platform releases before this method do not have the mutation and refuse
      * it as `ValidationError` `GRAPHQL_VALIDATION_FAILED` (400).
@@ -109,7 +124,40 @@ export interface CatalogModule {
      * - `PROPERTY_SYNC_SOURCE_UNAVAILABLE` → `BusinessRuleError` (422): a `content_item` property on
      *   a platform with no content system wired.
      * - `FORBIDDEN` → `PermissionDeniedError` (403): no `UpdateCatalog`.
+     *
+     * @effect write
      */
     syncContentFacets(propertyId: string, options?: Call): Promise<ContentFacetSyncResult>;
+    /**
+     * "Sync filter values" for every filterable `content_item` property of the store whose values
+     * name one of `contentItemIds` (headless W10-19): each is synced as
+     * {@link CatalogModule.syncContentFacets} syncs it, so a renamed content item's filter label
+     * follows its title. The platform calls it by itself, within about a minute, for the items a
+     * change to a PUBLISHED item touched (published, edited while published, unpublished); call it
+     * yourself for items you know changed otherwise (an app importing content, a draft renamed).
+     *
+     * Per property: a property its own sync refuses is reported in `skipped` with that refusal
+     * (`MANAGED_BY_ORGANIZATION` for the organization workspace's property, synced in the
+     * workspace) and nothing of it is written; the others are synced. `changed` says whether
+     * anything was written. Every label is read before anything is written, and the writes are
+     * one transaction: a content system that cannot be read, or any failure other than a
+     * property's refusal, refuses the whole call and writes nothing. Repeating it is safe.
+     *
+     * At most {@link MAX_CONTENT_ITEM_FACET_SYNC_IDS} different ids per call (repeats count once);
+     * an id no property names syncs nothing. Needs `UpdateCatalog`. Platform releases before this
+     * method do not have the mutation and refuse it as `ValidationError`
+     * `GRAPHQL_VALIDATION_FAILED` (400).
+     *
+     * Refusals of the whole call (nothing is written):
+     * - `CONTENT_ITEM_IDS_INVALID` → `ValidationError` (400): a blank id, or more than 500
+     *   different ids; checked before sending as well.
+     * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): an id that is not a uuid.
+     * - `CMS_REQUEST_FAILED` → `BusinessRuleError` (422): the content system could not be read;
+     *   try again.
+     * - `FORBIDDEN` → `PermissionDeniedError` (403): no `UpdateCatalog`.
+     *
+     * @effect write
+     */
+    syncContentItemFacets(contentItemIds: readonly string[], options?: Call): Promise<ContentItemFacetSyncResult>;
 }
 export declare function createCatalogModule(transport: Transport): CatalogModule;