@sixtyninecommerce/admin 0.9.0 → 0.11.0

package/dist/catalog/collections.d.ts

@@ -1,6 +1,49 @@
-import type { Page, Transport } from '@sixtyninecommerce/core';
-import type { Call, ListOptions } from '../types.js';
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call, ConfigurableOperationDefinition, ListOptions } from '../types.js';
 import { type AssetRef, type CatalogueOwnership, type ConfigurableOperation, type ConfigurableOperationInput, type LanguageCode } from './types.js';
+import type { VariantStorePrice } from './variants.js';
+/**
+ * A collection's search-engine settings for the whole store, which the storefront renders into
+ * the collection's page. Null for a setting the collection has no value for: the storefront then
+ * uses its default (`isRoutable` true, `isCanonical` false, `noindex` and `nofollow` false,
+ * `metaRobotsMaxImagePreview` `large`, `socialOgType` `website`, `twitterCardType`
+ * `summary_large_image`).
+ */
+export interface CollectionSeo {
+    /**
+     * A top-level collection only: whether its subtree gets storefront URLs. Off, the subtree is
+     * for filtering only. Read nowhere for a collection below the top level.
+     */
+    isRoutable: boolean | null;
+    /**
+     * A top-level collection only: whether products listed under it take its path as their
+     * canonical URL (the lowest position wins when several do).
+     */
+    isCanonical: boolean | null;
+    noindex: boolean | null;
+    nofollow: boolean | null;
+    /** `none`, `standard` or `large`. */
+    metaRobotsMaxImagePreview: string | null;
+    /** The asset the social (OpenGraph) image shows; the featured asset when null. */
+    socialImageId: string | null;
+    /** `website` or `product`. */
+    socialOgType: string | null;
+    /** `summary` or `summary_large_image`. */
+    twitterCardType: string | null;
+}
+/**
+ * A collection's search-engine texts in ONE language; each null falls back as the storefront
+ * documents it (the SEO title to the name, the description to the collection's description, the
+ * social texts to the SEO ones).
+ */
+export interface CollectionTranslationSeo {
+    seoTitle: string | null;
+    seoDescription: string | null;
+    canonicalUrl: string | null;
+    socialTitle: string | null;
+    socialDescription: string | null;
+    socialImageAlt: string | null;
+}
 /**
  * A collection. Membership is DERIVED: the engine applies `filters` (and the
  * parent's, when `inheritFilters`) and recomputes the member variants in a
@@ -10,8 +53,8 @@ import { type AssetRef, type CatalogueOwnership, type ConfigurableOperation, typ
  * The filters this platform ships: `facet-value-filter`, `variant-name-filter`,
  * `product-id-filter` (arguments `productIds` — a JSON array of ids as a
  * string — and `combineWithAnd`), `variant-id-filter`, and the import
- * pipeline's `pipeline-manual-assignment`. The Admin API's
- * `collectionFilters` query lists them with their argument definitions.
+ * pipeline's `pipeline-manual-assignment`. `catalog.collections.filterDefinitions()`
+ * lists them with their argument definitions.
  */
 export interface Collection {
     id: string;
@@ -23,11 +66,16 @@ export interface Collection {
     isPrivate: boolean;
     /** The root collection's id for a top-level collection. */
     parentId: string;
+    /** The place among its siblings; sort by it to show them in the merchant's order. */
     position: number;
     inheritFilters: boolean;
     filters: ConfigurableOperation[];
     featuredAsset: AssetRef | null;
     assets: AssetRef[];
+    /**
+     * The path from the store's root (first, named `__root_collection__`) down to the collection
+     * itself (last).
+     */
     breadcrumbs: Array<{
         id: string;
         name: string;
@@ -35,21 +83,45 @@ export interface Collection {
     }>;
     /** How many variants the last membership run matched. */
     productVariantCount: number;
+    /** The store-wide search-engine settings. */
+    seo: CollectionSeo;
     translations: Array<{
         id: string;
         languageCode: LanguageCode;
         name: string;
         slug: string;
         description: string;
+        /** The search-engine texts in this language. */
+        seo: CollectionTranslationSeo;
     }>;
     /** The store's own collection, or its organization's; see {@link CatalogueOwnership}. */
     catalogueOwnership: CatalogueOwnership;
 }
+/** A collection as {@link CollectionsModule.get} reads it: the {@link Collection}, its parent and children. */
+export interface CollectionDetail extends Collection {
+    /**
+     * The collection above it: for a top-level collection, the store's root, named
+     * `__root_collection__`. Null only for a root itself.
+     */
+    parent: {
+        id: string;
+        name: string;
+    } | null;
+    /** The collections right under it, every one, in no set order: sort them by `position`. */
+    children: Array<{
+        id: string;
+        name: string;
+        slug: string;
+        position: number;
+    }>;
+}
 export interface CollectionTranslationInput {
     languageCode: LanguageCode;
     name: string;
     slug: string;
     description: string;
+    /** The search-engine texts in this language; what is left out keeps its value. */
+    seo?: Partial<CollectionTranslationSeo>;
 }
 export interface CreateCollectionInput {
     translations: CollectionTranslationInput[];
@@ -60,6 +132,8 @@ export interface CreateCollectionInput {
     inheritFilters?: boolean;
     featuredAssetId?: string | null;
     assetIds?: string[];
+    /** The store-wide search-engine settings; what is left out keeps its value (or default). */
+    seo?: Partial<CollectionSeo>;
 }
 export interface UpdateCollectionInput extends Partial<Omit<CreateCollectionInput, 'translations'>> {
     id: string;
@@ -68,42 +142,233 @@ export interface UpdateCollectionInput extends Partial<Omit<CreateCollectionInpu
         id?: string;
     }>;
 }
+/** What a collection list can be sorted by. */
+export type CollectionSortField = 'position' | 'name' | 'createdAt' | 'updatedAt' | 'id';
 export interface CollectionListOptions extends ListOptions {
     /** Only the direct children of this collection. */
     parentId?: string;
     /** Case-insensitive substring of the name. */
     name?: string;
+    /** Only the collections right under the store's root: the top level of its tree. */
+    topLevelOnly?: boolean;
+    /**
+     * Only these collections. An id the store does not hold is left out, never an error; an empty
+     * list answers an empty page without asking the engine.
+     */
+    ids?: readonly string[];
+    /**
+     * ONE sort key; the engine's own order (unsorted) when omitted. Use `position` to show
+     * siblings in the merchant's order. The engine adds no tie-breaker, and every sibling group
+     * numbers its positions from 0: to walk EVERY collection page by page, sort by `id`, or rows
+     * tied across a page boundary can repeat or go missing.
+     */
+    sort?: {
+        field: CollectionSortField;
+        direction: 'ASC' | 'DESC';
+    };
+}
+/** The most collections one {@link CollectionsModule.search} answers. */
+export declare const MAX_COLLECTION_SEARCH_TAKE = 100;
+export interface CollectionSearchOptions extends Call {
+    /** Collections to answer, 1 to {@link MAX_COLLECTION_SEARCH_TAKE}; 25 when omitted. */
+    take?: number;
+    /** Best matches to skip, 0 when omitted. */
+    skip?: number;
+}
+export interface CollectionSearchResult {
+    /** The matching collections, best match first. */
+    items: Collection[];
+    /** Every match the search index counts, not only this page's. */
+    total: number;
+}
+/** What {@link CollectionsModule.previewVariants} computes the members of. */
+export interface CollectionPreviewInput {
+    /** The filters to apply, as a save would send them; unsaved ones included. */
+    filters: ConfigurableOperationInput[];
+    /** Also apply the parent's filters (and its parent's, as far as they inherit). */
+    inheritFilters: boolean;
+    /** The parent whose filters `inheritFilters` adds; none for a top-level collection. */
+    parentId?: string;
+}
+export interface CollectionPreviewOptions extends ListOptions {
+    /** Only variants whose name or SKU contains this, capitals ignored. */
+    term?: string;
+}
+/** A variant a collection's filters would take in, as the preview lists it. */
+export interface CollectionPreviewVariant {
+    id: string;
+    name: string;
+    sku: string;
+    /**
+     * The variant's price in the store, or null when the store has no price for it: a preview
+     * lists an unpriced variant like any other. Never 0 for a missing price.
+     */
+    storePrice: VariantStorePrice | null;
+    product: {
+        id: string;
+        name: string;
+        featuredAsset: AssetRef | null;
+    };
 }
 /**
  * Collections. Reading needs `ReadCatalog` (or `ReadCollection`), writing the
  * matching Create/Update/Delete permission.
  *
- * Refusals in the engine's words: "Cannot move a Collection into itself" on
- * `move` (`ValidationError`), an unknown id as `NotFoundError`
+ * Refusals in the engine's words: an unknown id as `NotFoundError`
  * (`ENTITY_NOT_FOUND`), and a refused delete as `ConflictError`
  * (`COLLECTION_NOT_DELETED`) with the engine's message. Deleting a collection
  * deletes its descendants too.
  *
+ * **An organization's collections** (multi-region decision 62): a member store may put a
+ * collection of its own under its organization's collection (`create` or `update` with that
+ * `parentId`), and it stays the store's to change. It may not reorder or re-parent the
+ * organization's collections: those writes, and a `move` under an organization's collection
+ * (which renumbers its siblings), are refused `MANAGED_BY_ORGANIZATION` (422 `BusinessRuleError`).
+ *
  * There is no `addProducts`: a manual collection's list lives INSIDE its
  * `product-id-filter` arguments, so adding one product is a read-modify-write
  * of the whole filter list, and doing that from a client (`update`) races
  * every other writer. To put a product in collections, or take it out, use
  * `catalog.products.setCollections`, which the engine runs under a row lock.
+ *
+ * No write deduplicates on `idempotencyKey`: a repeated `create` makes a second collection.
  */
 export interface CollectionsModule {
+    /**
+     * One page of the store's collections (`limit` 1 to 1,000, default 25). Walk them all with
+     * `for await`: every following page re-sends the same filters, sort and store.
+     *
+     * Refused before sending: `INVALID_PAGE_SIZE` (`ValidationError`, 400) for a `limit` outside
+     * 1 to 1,000; `INVALID_COLLECTION_SORT` (`ValidationError`, 400) for a sort field or direction
+     * not named in {@link CollectionListOptions.sort}.
+     *
+     * @effect read
+     */
     list(options?: CollectionListOptions): Promise<Page<Collection>>;
-    get(id: string, options?: Call): Promise<Collection | null>;
+    /**
+     * One collection with its parent and children; null for an id this store does not have, the
+     * same answer another store's collection gets.
+     *
+     * @effect read
+     */
+    get(id: string, options?: Call): Promise<CollectionDetail | null>;
+    /**
+     * The store's collections that best match `term` (by name, by the names of the collections
+     * above it, by slug; a typo is forgiven), best first: the search index finds them, and each is
+     * read from the engine, so what it answers is current. A collection the index still lists
+     * but the store no longer holds is left out, so a page can be shorter than `take`. A blank
+     * term matches every collection.
+     *
+     * A collection created or renamed a moment ago may be missing for a few seconds: the index is
+     * written by a job after the change.
+     *
+     * Refusals: `SEARCH_INPUT_INVALID` (`ValidationError`, 400) for a `take` outside 1 to
+     * {@link MAX_COLLECTION_SEARCH_TAKE} or a `skip` that is not a whole number, before sending;
+     * `SERVICE_UNAVAILABLE` (503, retryable) when the search service does not answer;
+     * `PermissionDeniedError` without `ReadCatalog` or `ReadCollection`.
+     *
+     * @effect read
+     */
+    search(term: string, options?: CollectionSearchOptions): Promise<CollectionSearchResult>;
+    /**
+     * Create a collection. Needs `CreateCatalog` or `CreateCollection`.
+     *
+     * A new translation needs a name; its slug, when left out, is made from the name in that
+     * language (multi-region decision 106).
+     *
+     * Refusals (nothing is written):
+     * - `TRANSLATION_INPUT_INVALID` → `ValidationError` (400): a translation without a name, or
+     *   with a name no slug can be made from (`!!!`) and no slug. One `details` entry per refused
+     *   field, each message naming the language and the field; the entries carry no `field`
+     *   pointer (the engine refuses below the call's arguments).
+     * - `TRANSLATION_LANGUAGE_NOT_OFFERED` → `BusinessRuleError` (422): a translation in a
+     *   language the store does not offer.
+     * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a `parentId` this store does not hold.
+     * - `SHARED_COLLECTION_NOT_ALLOWED` → `PermissionDeniedError` (403): the parent is also
+     *   another store's, and you may not change that store's catalogue.
+     *
+     * @effect write
+     */
     create(input: CreateCollectionInput, options?: Call): Promise<Collection>;
+    /**
+     * A PATCH of the collection: what the input leaves out keeps its value, but `filters`, when
+     * sent, replace the whole list. A translation for a language the collection has no row in is
+     * a NEW row, judged as on {@link create}. A `parentId` re-parents it (the store's root puts it
+     * at the top level); a parent inside its own subtree is refused `ILLEGAL_OPERATION`
+     * (`BusinessRuleError`, 422, "Cannot move a Collection into itself"). The other refusals are
+     * {@link create}'s, plus `MANAGED_BY_ORGANIZATION` for an organization's collection.
+     *
+     * @effect write
+     */
     update(input: UpdateCollectionInput, options?: Call): Promise<Collection>;
+    /**
+     * Delete a collection AND every collection below it. Products are not deleted; they leave the
+     * deleted collections. Nothing in this SDK restores a collection. Needs `DeleteCatalog` or
+     * `DeleteCollection`.
+     *
+     * Refusals (nothing is deleted):
+     * - `COLLECTION_NOT_DELETED` → `ConflictError` (409): the engine declined, in its own words.
+     * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a collection this store does not hold.
+     * - `SHARED_COLLECTION_NOT_ALLOWED` → `PermissionDeniedError` (403): another store also holds
+     *   it, and you may not delete there.
+     * - `MANAGED_BY_ORGANIZATION` → `BusinessRuleError` (422): a collection of the store's
+     *   organization.
+     *
+     * @effect destructive
+     */
     delete(id: string, options?: Call): Promise<void>;
-    /** Re-parent and/or reorder: `index` is the position among the new parent's children. */
+    /**
+     * Re-parent and/or reorder: `index` is the position among the new parent's children, counted
+     * over ALL of them (not one page's). The store's root as `parentId` keeps it at the top level.
+     * Needs `UpdateCatalog` or `UpdateCollection`.
+     *
+     * Refusals (nothing moves):
+     * - `ILLEGAL_OPERATION` → `BusinessRuleError` (422): the new parent is the collection itself
+     *   or one of its descendants ("Cannot move a Collection into itself").
+     * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a collection or parent this store does not
+     *   hold, another store's root included.
+     * - `MANAGED_BY_ORGANIZATION` → `BusinessRuleError` (422): the collection is the store's
+     *   organization's, or the new parent is (a move renumbers the parent's other children; put a
+     *   collection of your own under it with `update({ id, parentId })` instead).
+     * - `SHARED_COLLECTION_NOT_ALLOWED` → `PermissionDeniedError` (403): the collection or the
+     *   parent is also another store's, and you may not change that store's catalogue.
+     *
+     * @effect write
+     */
     move(collectionId: string, parentId: string, index: number, options?: Call): Promise<Collection>;
+    /**
+     * The filters a collection may use, with the arguments each takes (labels and descriptions in
+     * the language of the request): the same for every store. `args[].required` is NOT the
+     * enforced rule (see `ConfigArgDefinition.required`).
+     *
+     * @effect read
+     */
+    filterDefinitions(options?: Call): Promise<ConfigurableOperationDefinition[]>;
+    /**
+     * The variants a collection WOULD hold with these filters, computed now and saved nowhere: a
+     * page of them (`limit` 1 to 1,000, default 25), in no set order. It works before a collection
+     * exists and for unsaved changes. No filters at all (and none inherited) answers every variant
+     * of the store, not none; so does a lone filter sent with `combineWithAnd` `false` (send `true`).
+     *
+     * Refusals: `INVALID_PAGE_SIZE` (`ValidationError`, 400) before sending; a filter code the
+     * engine does not know, or an argument it cannot read, in the engine's words.
+     *
+     * @effect read
+     */
+    previewVariants(input: CollectionPreviewInput, options?: CollectionPreviewOptions): Promise<Page<CollectionPreviewVariant>>;
 }
-export declare const COLLECTION_FIELDS = "\n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n";
-export declare const COLLECTIONS_QUERY = "\n  query CatalogCollections($options: CollectionListOptions) {\n    collections(options: $options) {\n      items { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n }\n      totalItems\n    }\n  }\n";
-export declare const COLLECTION_QUERY = "\n  query CatalogCollection($id: ID!) {\n    collection(id: $id) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n }\n  }\n";
-export declare const CREATE_COLLECTION_MUTATION = "\n  mutation CatalogCreateCollection($input: CreateCollectionInput!) {\n    createCollection(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n }\n  }\n";
-export declare const UPDATE_COLLECTION_MUTATION = "\n  mutation CatalogUpdateCollection($input: UpdateCollectionInput!) {\n    updateCollection(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n }\n  }\n";
+export declare const COLLECTION_FIELDS = "\n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  assets { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  \n  customFields {\n    isRoutable\n    isCanonical\n    noindex\n    nofollow\n    metaRobotsMaxImagePreview\n    socialImageId\n    socialOgType\n    twitterCardType\n  }\n\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n    \n  customFields {\n    seoTitle\n    seoDescription\n    canonicalUrl\n    socialTitle\n    socialDescription\n    socialImageAlt\n  }\n\n  }\n";
+export declare const COLLECTIONS_QUERY = "\n  query CatalogCollections($options: CollectionListOptions) {\n    collections(options: $options) {\n      items { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  assets { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  \n  customFields {\n    isRoutable\n    isCanonical\n    noindex\n    nofollow\n    metaRobotsMaxImagePreview\n    socialImageId\n    socialOgType\n    twitterCardType\n  }\n\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n    \n  customFields {\n    seoTitle\n    seoDescription\n    canonicalUrl\n    socialTitle\n    socialDescription\n    socialImageAlt\n  }\n\n  }\n }\n      totalItems\n    }\n  }\n";
+export declare const COLLECTION_QUERY = "\n  query CatalogCollection($id: ID!) {\n    collection(id: $id) {\n      \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  assets { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  \n  customFields {\n    isRoutable\n    isCanonical\n    noindex\n    nofollow\n    metaRobotsMaxImagePreview\n    socialImageId\n    socialOgType\n    twitterCardType\n  }\n\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n    \n  customFields {\n    seoTitle\n    seoDescription\n    canonicalUrl\n    socialTitle\n    socialDescription\n    socialImageAlt\n  }\n\n  }\n\n      parent {\n        id\n        name\n      }\n      children {\n        id\n        name\n        slug\n        position\n      }\n    }\n  }\n";
+export declare const CREATE_COLLECTION_MUTATION = "\n  mutation CatalogCreateCollection($input: CreateCollectionInput!) {\n    createCollection(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  assets { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  \n  customFields {\n    isRoutable\n    isCanonical\n    noindex\n    nofollow\n    metaRobotsMaxImagePreview\n    socialImageId\n    socialOgType\n    twitterCardType\n  }\n\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n    \n  customFields {\n    seoTitle\n    seoDescription\n    canonicalUrl\n    socialTitle\n    socialDescription\n    socialImageAlt\n  }\n\n  }\n }\n  }\n";
+export declare const UPDATE_COLLECTION_MUTATION = "\n  mutation CatalogUpdateCollection($input: UpdateCollectionInput!) {\n    updateCollection(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  assets { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  \n  customFields {\n    isRoutable\n    isCanonical\n    noindex\n    nofollow\n    metaRobotsMaxImagePreview\n    socialImageId\n    socialOgType\n    twitterCardType\n  }\n\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n    \n  customFields {\n    seoTitle\n    seoDescription\n    canonicalUrl\n    socialTitle\n    socialDescription\n    socialImageAlt\n  }\n\n  }\n }\n  }\n";
 export declare const DELETE_COLLECTION_MUTATION = "\n  mutation CatalogDeleteCollection($id: ID!) {\n    deleteCollection(id: $id) { \n  result\n  message\n }\n  }\n";
-export declare const MOVE_COLLECTION_MUTATION = "\n  mutation CatalogMoveCollection($input: MoveCollectionInput!) {\n    moveCollection(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n }\n  }\n";
+export declare const MOVE_COLLECTION_MUTATION = "\n  mutation CatalogMoveCollection($input: MoveCollectionInput!) {\n    moveCollection(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  name\n  slug\n  description\n  isPrivate\n  parentId\n  position\n  inheritFilters\n  filters {\n    code\n    args {\n      name\n      value\n    }\n  }\n  featuredAsset { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  assets { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n  breadcrumbs {\n    id\n    name\n    slug\n  }\n  productVariantCount\n  \n  customFields {\n    isRoutable\n    isCanonical\n    noindex\n    nofollow\n    metaRobotsMaxImagePreview\n    socialImageId\n    socialOgType\n    twitterCardType\n  }\n\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n    \n  customFields {\n    seoTitle\n    seoDescription\n    canonicalUrl\n    socialTitle\n    socialDescription\n    socialImageAlt\n  }\n\n  }\n }\n  }\n";
+export declare const COLLECTION_FILTER_DEFINITIONS_QUERY = "\n  query CatalogCollectionFilterDefinitions {\n    collectionFilters {\n      code\n      description\n      args {\n        name\n        type\n        list\n        required\n        defaultValue\n        label\n        description\n        ui\n      }\n    }\n  }\n";
+/**
+ * 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 declare const PREVIEW_COLLECTION_VARIANTS_QUERY = "\n  query CatalogPreviewCollectionVariants(\n    $input: PreviewCollectionVariantsInput!\n    $options: ProductVariantListOptions\n  ) {\n    previewCollectionVariants(input: $input, options: $options) {\n      items {\n        id\n        name\n        sku\n        storePrice {\n          price\n          priceWithTax\n          currencyCode\n        }\n        product {\n          id\n          name\n          featuredAsset { \n  id\n  name\n  preview\n  source\n  type\n  mimeType\n  customFields {\n    altText\n  }\n }\n        }\n      }\n      totalItems\n    }\n  }\n";
 export declare function createCollectionsModule(transport: Transport): CollectionsModule;