@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/catalog/products.d.ts

@@ -2,8 +2,8 @@ import { type Page, type Transport } from '@sixtyninecommerce/core';
 import type { JobHandle } from '../jobs/index.js';
 import type { Call, ListOptions } from '../types.js';
 import { type ProductBulkInput, type ProductBulkRun } from './products-bulk.js';
-import { type AssetRef, type Availability, type AvailabilityInput, type CatalogueOwnership, type FacetValueRef, type LanguageCode, type PriceBasis, type ProductAvailabilityState, type TranslationInput, type VariantAvailabilityState } from './types.js';
-import { type ParcelPacking, type VariantBackorderPolicy, type VariantPriceInput } from './variants.js';
+import { type AssetRef, type Availability, type AvailabilityInput, type CatalogueOwnership, type FacetValueRef, type LanguageCode, type PriceBasis, type ProductAvailabilityState, type TranslationInput, type VariantAvailabilityState, type WireAssetRef } from './types.js';
+import { type ParcelPacking, type VariantBackorderPolicy, type VariantPriceInput, type VariantStorePrice } from './variants.js';
 export interface ProductOptionRef {
     id: string;
     code: string;
@@ -13,7 +13,18 @@ export interface ProductOptionGroupRef {
     id: string;
     code: string;
     name: string;
+    /**
+     * The group is offered for reuse on the store's other products (the option-group editor's
+     * "shared" switch); false for a group made for this product alone.
+     */
+    isShared: boolean;
     options: ProductOptionRef[];
+    /** The group's name in each language it has one in. */
+    translations: Array<{
+        id: string;
+        languageCode: LanguageCode;
+        name: string;
+    }>;
 }
 export interface ProductTranslation {
     id: string;
@@ -51,6 +62,27 @@ export interface Product extends Availability<ProductAvailabilityState> {
      * product and in an organization's workspace.
      */
     excludedFromStore: boolean;
+    /** The brand feeds name; null when none is set. */
+    brand: string | null;
+    /**
+     * The condition feeds state; null when none is set. A string on the wire: a stored value
+     * outside {@link ProductCondition} is answered as it is.
+     */
+    condition: ProductCondition | (string & {}) | null;
+}
+/** A collection a product is in, as {@link ProductsModule.get} names it. */
+export interface ProductCollectionRef {
+    id: string;
+    name: string;
+    slug: string;
+}
+/** A product as {@link ProductsModule.get} reads it: the {@link Product} and its collections. */
+export interface ProductDetail extends Product {
+    /**
+     * Every collection of the store the product is in, by hand or through a collection's other
+     * filters, in the language the call asked for.
+     */
+    collections: ProductCollectionRef[];
 }
 export interface ProductTranslationInput extends TranslationInput {
     name?: string;
@@ -102,6 +134,24 @@ export interface ProductListOptions extends ListOptions {
 }
 /** The engine's bound on one `exclude` or `include` call (`STORE_EXCLUSION_BATCH_LIMIT`). */
 export declare const MAX_STORE_EXCLUSION_PRODUCTS = 500;
+/** At most this many distinct products per {@link ProductsModule.storePriceRanges} call. */
+export declare const MAX_STORE_PRICE_RANGE_PRODUCTS = 100;
+/**
+ * The cheapest and the dearest of a product's variants in the ACTIVE store and the request's
+ * currency, as `ProductVariant.storePrice` prices them (stored prices and prices converted at the
+ * store's rate, compared). `price` is net and `priceWithTax` gross, as on `storePrice`.
+ */
+export interface ProductStorePriceRange {
+    min: VariantStorePrice;
+    max: VariantStorePrice;
+    /** At least one variant the store holds has no price in it; it is left out of min and max, never counted as 0. */
+    someVariantsUnpriced: boolean;
+}
+export interface ProductStorePriceRangeEntry {
+    productId: string;
+    /** Null when the store prices none of the product's variants it holds. */
+    range: ProductStorePriceRange | null;
+}
 /**
  * The engine's bounds on one `setAvailabilityInStores` or `availabilityInStores` call
  * (`AVAILABILITY_*_LIMIT`).
@@ -320,14 +370,66 @@ export interface SaveProductResult {
  * refuses".
  */
 export interface ProductsModule {
+    /** @effect read */
     list(options?: ProductListOptions): Promise<Page<Product>>;
-    /** Null for an id this store does not have — the same answer another tenant's product gets. */
-    get(id: string, options?: Call): Promise<Product | null>;
+    /**
+     * One product with the collections it is in; null for an id this store does not have — the
+     * same answer another tenant's product gets. Its variants are not part of it, however few: read
+     * them a page at a time with `catalog.variants.list(productId)` (a product can have 100,000).
+     *
+     * @effect read
+     */
+    get(id: string, options?: Call): Promise<ProductDetail | null>;
+    /**
+     * Create a product, without variants (`catalog.variants.create` adds them). Needs
+     * `CreateCatalog` or `CreateProduct`.
+     *
+     * A new translation needs a name; its slug, when left out, is made from the name in that
+     * language, and its description is `''` (multi-region decision 106).
+     *
+     * Refusals (nothing is written):
+     * - `INVALID_PRODUCT_INPUT` → `ValidationError` (400): no translation; refused before sending.
+     * - `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. `details[].field` points at the translation entry
+     *   (`/input/translations/<i>`); `message` names the language and the ones the store offers.
+     * - `FEED_IDENTIFIER_INVALID` → `ValidationError` (400): a brand over 70 characters.
+     * - `INVALID_DATETIME` → `ValidationError` (400): an `availableFrom` without an offset;
+     *   refused before sending.
+     *
+     * @effect write
+     */
     create(input: CreateProductInput, options?: Call): Promise<Product>;
+    /**
+     * A PATCH of the product's own fields. A translation for a language the product has no row in
+     * is a NEW row, judged as on {@link create}; an existing row keeps what the input leaves out,
+     * and setting its name or slug to null is refused `TRANSLATION_INPUT_INVALID`. The other
+     * refusals are {@link create}'s, plus `FIELD_GROUP_LOCKED` and `MANAGED_BY_ORGANIZATION`
+     * (see above).
+     *
+     * @effect write
+     */
     update(input: UpdateProductInput, options?: Call): Promise<Product>;
     /**
-     * Soft-deletes the product and its variants. `PRODUCT_NOT_DELETED`
-     * (`ConflictError`) carries the engine's own reason when it refuses.
+     * Soft-deletes the product and its variants: they are no longer listed, and orders keep the
+     * lines that name them. Nothing in this SDK restores it. Needs `DeleteCatalog` or
+     * `DeleteProduct`.
+     *
+     * Refusals (nothing is deleted):
+     * - `PRODUCT_NOT_DELETED` → `ConflictError` (409): the engine declined, in its own words.
+     * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a product this store does not hold.
+     * - `SHARED_PRODUCT_NOT_ALLOWED` → `PermissionDeniedError` (403): another store also holds it,
+     *   and you may not delete there.
+     * - `MANAGED_BY_ORGANIZATION` → `BusinessRuleError` (422): a product of the store's
+     *   organization.
+     * - `FIELD_GROUP_LOCKED` → `BusinessRuleError` (422): an app or API token owns a field group of
+     *   the product or its variants.
+     * - `EXTERNAL_LINE_CARRIER_PROTECTED` → `BusinessRuleError` (422): the platform's carrier.
+     *
+     * @effect destructive
      */
     delete(id: string, options?: Call): Promise<void>;
     /**
@@ -428,6 +530,23 @@ export interface ProductsModule {
      *   store that is not a member.
      */
     availabilityInStores(input: AvailabilityInStoresInput, options?: Call): Promise<OrganizationProductStoreAvailability[]>;
+    /**
+     * Each product's price range in the ACTIVE store and the request's currency
+     * (`Product.storePriceRange`), for a page of products in ONE request: the engine ranks only the
+     * variants the store holds, by the store's own prices. Use it rather than the first and last
+     * variant of a price-sorted variant list, which cannot compare stored prices with converted ones
+     * nor say that some variants are unpriced. One entry per distinct product, in the order named;
+     * a product the store does not hold is left out, the same answer another tenant's product gets.
+     * No ids answers none, without a request. Needs `ReadCatalog`.
+     *
+     * Refusals:
+     * - `PRODUCT_STORE_PRICE_RANGE_INPUT_INVALID` → `ValidationError` (400): more than
+     *   {@link MAX_STORE_PRICE_RANGE_PRODUCTS} distinct ids; refused before sending.
+     * - An engine without `Product.storePriceRange` (vendure-server before #1580) refuses the
+     *   document before running it: `ValidationError`, `GRAPHQL_VALIDATION_FAILED` (or
+     *   `BAD_REQUEST`), never an empty answer.
+     */
+    storePriceRanges(productIds: string[], options?: Call): Promise<ProductStorePriceRangeEntry[]>;
     /**
      * Make the ACTIVE member store's own copy of a product its organization shares with it, and
      * stop offering the shared one, in one step (a local copy, or detach; spec §7.2.8). The copy
@@ -617,28 +736,46 @@ export interface ProductsModule {
      */
     bulkRun(runId: string, options?: Call): Promise<ProductBulkRun>;
 }
-export declare const PRODUCT_FIELDS = "\n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n";
-export declare const PRODUCTS_QUERY = "\n  query CatalogProducts($options: ProductListOptions) {\n    products(options: $options) {\n      items { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n      totalItems\n    }\n  }\n";
-export declare const PRODUCT_QUERY = "\n  query CatalogProduct($id: ID!) {\n    product(id: $id) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n  }\n";
-export declare const CREATE_PRODUCT_MUTATION = "\n  mutation CatalogCreateProduct($input: CreateProductInput!) {\n    createProduct(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n  }\n";
-export declare const UPDATE_PRODUCT_MUTATION = "\n  mutation CatalogUpdateProduct($input: UpdateProductInput!) {\n    updateProduct(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n  }\n";
+export declare const PRODUCT_FIELDS = "\n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n";
+export declare const PRODUCTS_QUERY = "\n  query CatalogProducts($options: ProductListOptions) {\n    products(options: $options) {\n      items { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n      totalItems\n    }\n  }\n";
+export declare const PRODUCT_STORE_PRICE_RANGES_QUERY = "\n  query CatalogProductStorePriceRanges($options: ProductListOptions) {\n    products(options: $options) {\n      items {\n        id\n        storePriceRange {\n          min { price priceWithTax currencyCode }\n          max { price priceWithTax currencyCode }\n          someVariantsUnpriced\n        }\n      }\n    }\n  }\n";
+/**
+ * One product, with the collections it is in. No variant data beyond `variantList`'s count: a
+ * product can have 100,000 variants, and core's `variants` would hand back the first 1,000 with
+ * no sign of the rest (`catalog.variants.list` pages them).
+ */
+export declare const PRODUCT_QUERY = "\n  query CatalogProduct($id: ID!) {\n    product(id: $id) {\n      \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n\n      collections {\n        id\n        name\n        slug\n      }\n    }\n  }\n";
+export declare const CREATE_PRODUCT_MUTATION = "\n  mutation CatalogCreateProduct($input: CreateProductInput!) {\n    createProduct(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n  }\n";
+export declare const UPDATE_PRODUCT_MUTATION = "\n  mutation CatalogUpdateProduct($input: UpdateProductInput!) {\n    updateProduct(input: $input) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n  }\n";
 export declare const DELETE_PRODUCT_MUTATION = "\n  mutation CatalogDeleteProduct($id: ID!) {\n    deleteProduct(id: $id) { \n  result\n  message\n }\n  }\n";
 export declare const CLONE_PRODUCT_MUTATION = "\n  mutation CatalogCloneProduct($id: ID!) {\n    cloneProduct(id: $id)\n  }\n";
-export declare const ADD_OPTION_GROUP_MUTATION = "\n  mutation CatalogAddOptionGroup($productId: ID!, $optionGroupId: ID!) {\n    addOptionGroupToProduct(productId: $productId, optionGroupId: $optionGroupId) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n  }\n";
-export declare const REMOVE_OPTION_GROUP_MUTATION = "\n  mutation CatalogRemoveOptionGroup($productId: ID!, $optionGroupId: ID!, $force: Boolean) {\n    removeOptionGroupFromProduct(productId: $productId, optionGroupId: $optionGroupId, force: $force) {\n      ... on Product { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n      ... on ErrorResult {\n        errorCode\n        message\n      }\n    }\n  }\n";
-export declare const EXCLUDE_PRODUCTS_FROM_STORE_MUTATION = "\n  mutation CatalogExcludeProductsFromStore($productIds: [ID!]!) {\n    excludeProductsFromStore(productIds: $productIds) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n  }\n";
-export declare const INCLUDE_PRODUCTS_IN_STORE_MUTATION = "\n  mutation CatalogIncludeProductsInStore($productIds: [ID!]!) {\n    includeProductsInStore(productIds: $productIds) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n  }\n";
+export declare const ADD_OPTION_GROUP_MUTATION = "\n  mutation CatalogAddOptionGroup($productId: ID!, $optionGroupId: ID!) {\n    addOptionGroupToProduct(productId: $productId, optionGroupId: $optionGroupId) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n  }\n";
+export declare const REMOVE_OPTION_GROUP_MUTATION = "\n  mutation CatalogRemoveOptionGroup($productId: ID!, $optionGroupId: ID!, $force: Boolean) {\n    removeOptionGroupFromProduct(productId: $productId, optionGroupId: $optionGroupId, force: $force) {\n      ... on Product { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n      ... on ErrorResult {\n        errorCode\n        message\n      }\n    }\n  }\n";
+export declare const EXCLUDE_PRODUCTS_FROM_STORE_MUTATION = "\n  mutation CatalogExcludeProductsFromStore($productIds: [ID!]!) {\n    excludeProductsFromStore(productIds: $productIds) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n  }\n";
+export declare const INCLUDE_PRODUCTS_IN_STORE_MUTATION = "\n  mutation CatalogIncludeProductsInStore($productIds: [ID!]!) {\n    includeProductsInStore(productIds: $productIds) { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n  }\n";
 export declare const SET_ORGANIZATION_PRODUCT_AVAILABILITY_MUTATION = "\n  mutation CatalogSetOrganizationProductAvailability(\n    $productIds: [ID!]!\n    $channelIds: [ID!]!\n    $available: Boolean!\n  ) {\n    setOrganizationProductAvailability(\n      productIds: $productIds\n      channelIds: $channelIds\n      available: $available\n    ) {\n      productId\n      channelId\n      action\n    }\n  }\n";
 export declare const ORGANIZATION_PRODUCT_AVAILABILITY_QUERY = "\n  query CatalogOrganizationProductAvailability($productIds: [ID!]!, $channelIds: [ID!]!) {\n    organizationProductAvailability(productIds: $productIds, channelIds: $channelIds) {\n      productId\n      channelId\n      state\n      localCopyId\n    }\n  }\n";
-export declare const MAKE_LOCAL_COPY_MUTATION = "\n  mutation CatalogMakeLocalCopy($productId: ID!, $skus: [LocalCopySkuInput!]) {\n    makeLocalCopy(productId: $productId, skus: $skus) {\n      product { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n      originalProductId\n      original\n      droppedOrganizationPropertyCount\n    }\n  }\n";
+export declare const MAKE_LOCAL_COPY_MUTATION = "\n  mutation CatalogMakeLocalCopy($productId: ID!, $skus: [LocalCopySkuInput!]) {\n    makeLocalCopy(productId: $productId, skus: $skus) {\n      product { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n      originalProductId\n      original\n      droppedOrganizationPropertyCount\n    }\n  }\n";
 export declare const SET_PRODUCT_COLLECTIONS_MUTATION = "\n  mutation CatalogSetProductCollections(\n    $productId: ID!\n    $collectionIds: [ID!]!\n    $fromCollectionIds: [ID!]\n  ) {\n    setProductCollections(\n      productId: $productId\n      collectionIds: $collectionIds\n      fromCollectionIds: $fromCollectionIds\n    ) {\n      added\n      removed\n      unchanged\n      notRemoved {\n        collectionId\n        reason\n      }\n    }\n  }\n";
-export declare const SAVE_PRODUCT_MUTATION = "\n  mutation CatalogSaveProduct($input: SaveProductInput!, $idempotencyKey: String) {\n    saveProduct(input: $input, idempotencyKey: $idempotencyKey) {\n      product { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\n  featuredAsset { \n  id\n  name\n  preview\n  source\n }\n  assets { \n  id\n  name\n  preview\n  source\n }\n  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    options {\n      id\n      code\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n  }\n }\n      collections {\n        added\n        removed\n        unchanged\n        notRemoved {\n          collectionId\n          reason\n        }\n      }\n      warnings {\n        code\n        message\n        propertyIds\n      }\n    }\n  }\n";
+export declare const SAVE_PRODUCT_MUTATION = "\n  mutation CatalogSaveProduct($input: SaveProductInput!, $idempotencyKey: String) {\n    saveProduct(input: $input, idempotencyKey: $idempotencyKey) {\n      product { \n  id\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n  createdAt\n  updatedAt\n  languageCode\n  name\n  slug\n  description\n  enabled\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  facetValues { \n  id\n  code\n  name\n  facet {\n    id\n    code\n    name\n  }\n }\n  optionGroups {\n    id\n    code\n    name\n    customFields {\n      isShared\n    }\n    options {\n      id\n      code\n      name\n    }\n    translations {\n      id\n      languageCode\n      name\n    }\n  }\n  translations {\n    id\n    languageCode\n    name\n    slug\n    description\n  }\n  excludedFromStore\n  variantList(options: { take: 1 }) {\n    totalItems\n  }\n  customFields {\n    availabilityState\n    availableFrom\n    preorderLimit\n    brand\n    condition\n  }\n }\n      collections {\n        added\n        removed\n        unchanged\n        notRemoved {\n          collectionId\n          reason\n        }\n      }\n      warnings {\n        code\n        message\n        propertyIds\n      }\n    }\n  }\n";
+/** An option group as the Admin API answers it inside a product, before `toProduct`. */
+interface WireProductOptionGroup extends Omit<ProductOptionGroupRef, 'isShared'> {
+    customFields: {
+        isShared?: boolean | null;
+    } | null;
+}
 /** The product as the Admin API answers it, before `toProduct`. */
-export interface WireProduct extends Omit<Product, keyof Availability<string> | 'variantCount'> {
+export interface WireProduct extends Omit<Product, keyof Availability<string> | 'variantCount' | 'featuredAsset' | 'assets' | 'optionGroups' | 'brand' | 'condition'> {
+    featuredAsset: WireAssetRef | null;
+    assets: WireAssetRef[];
+    optionGroups: WireProductOptionGroup[];
     variantList: {
         totalItems: number;
     };
-    customFields: Partial<Availability<ProductAvailabilityState>> | null;
+    customFields: (Partial<Availability<ProductAvailabilityState>> & {
+        brand?: string | null;
+        condition?: string | null;
+    }) | null;
 }
 /**
  * Lift the availability custom fields to first-class fields. A server older
@@ -647,4 +784,7 @@ export interface WireProduct extends Omit<Product, keyof Availability<string> |
  */
 export declare function toProduct(wire: WireProduct): Product;
 export declare function productFilter(filter: ProductListFilter | undefined): Record<string, unknown>;
+/** The engine's `ProductListOptions` for one page of {@link ProductListOptions}. */
+export declare function productListOptions(options: ProductListOptions | undefined, skip: number, take: number): Record<string, unknown>;
 export declare function createProductsModule(transport: Transport): ProductsModule;
+export {};

package/dist/catalog/products.js

@@ -1,9 +1,11 @@
 import { ValidationError } from '@sixtyninecommerce/core';
 import { bulkProducts, readProductBulkRun, } from './products-bulk.js';
-import { ASSET_REF_FIELDS, assertDeleted, availabilityCustomFields, CATALOGUE_OWNERSHIP_FIELDS, DELETION_FIELDS, FACET_VALUE_REF_FIELDS, fieldOf, unwrapResult, vendureListPage, } from './types.js';
+import { ASSET_REF_FIELDS, assertDeleted, availabilityCustomFields, CATALOGUE_OWNERSHIP_FIELDS, DELETION_FIELDS, FACET_VALUE_REF_FIELDS, fieldOf, toAssetRef, unwrapResult, vendureListPage, } from './types.js';
 import { assertPricesStateBasis, } from './variants.js';
 /** The engine's bound on one `exclude` or `include` call (`STORE_EXCLUSION_BATCH_LIMIT`). */
 export const MAX_STORE_EXCLUSION_PRODUCTS = 500;
+/** At most this many distinct products per {@link ProductsModule.storePriceRanges} call. */
+export const MAX_STORE_PRICE_RANGE_PRODUCTS = 100;
 /**
  * The engine's bounds on one `setAvailabilityInStores` or `availabilityInStores` call
  * (`AVAILABILITY_*_LIMIT`).
@@ -29,11 +31,19 @@ export const PRODUCT_FIELDS = /* GraphQL */ `
     id
     code
     name
+    customFields {
+      isShared
+    }
     options {
       id
       code
       name
     }
+    translations {
+      id
+      languageCode
+      name
+    }
   }
   translations {
     id
@@ -50,6 +60,8 @@ export const PRODUCT_FIELDS = /* GraphQL */ `
     availabilityState
     availableFrom
     preorderLimit
+    brand
+    condition
   }
 `;
 export const PRODUCTS_QUERY = /* GraphQL */ `
@@ -60,9 +72,36 @@ export const PRODUCTS_QUERY = /* GraphQL */ `
     }
   }
 `;
+const STORE_PRICE_FIELDS = 'price priceWithTax currencyCode';
+export const PRODUCT_STORE_PRICE_RANGES_QUERY = /* GraphQL */ `
+  query CatalogProductStorePriceRanges($options: ProductListOptions) {
+    products(options: $options) {
+      items {
+        id
+        storePriceRange {
+          min { ${STORE_PRICE_FIELDS} }
+          max { ${STORE_PRICE_FIELDS} }
+          someVariantsUnpriced
+        }
+      }
+    }
+  }
+`;
+/**
+ * One product, with the collections it is in. No variant data beyond `variantList`'s count: a
+ * product can have 100,000 variants, and core's `variants` would hand back the first 1,000 with
+ * no sign of the rest (`catalog.variants.list` pages them).
+ */
 export const PRODUCT_QUERY = /* GraphQL */ `
   query CatalogProduct($id: ID!) {
-    product(id: $id) { ${PRODUCT_FIELDS} }
+    product(id: $id) {
+      ${PRODUCT_FIELDS}
+      collections {
+        id
+        name
+        slug
+      }
+    }
   }
 `;
 export const CREATE_PRODUCT_MUTATION = /* GraphQL */ `
@@ -196,15 +235,28 @@ export const SAVE_PRODUCT_MUTATION = /* GraphQL */ `
  * outright, so the defaults below only cover a NULL value, never an absent one.
  */
 export function toProduct(wire) {
-    const { variantList, customFields, ...rest } = wire;
+    const { variantList, customFields, featuredAsset, assets, optionGroups, ...rest } = wire;
     return {
         ...rest,
+        featuredAsset: featuredAsset ? toAssetRef(featuredAsset) : null,
+        assets: assets.map(toAssetRef),
+        optionGroups: optionGroups.map(({ customFields: groupFields, ...group }) => ({
+            ...group,
+            isShared: groupFields?.isShared === true,
+        })),
         variantCount: variantList.totalItems,
         availabilityState: customFields?.availabilityState ?? 'none',
         availableFrom: customFields?.availableFrom ?? null,
         preorderLimit: customFields?.preorderLimit ?? null,
+        brand: customFields?.brand ?? null,
+        condition: customFields?.condition ?? null,
     };
 }
+/** {@link toProduct}, plus the collections. */
+function toProductDetail(wire) {
+    const { collections, ...rest } = wire;
+    return { ...toProduct(rest), collections };
+}
 function toWireInput(input) {
     const { availabilityState, availableFrom, preorderLimit, brand, condition, ...rest } = input;
     const customFields = availabilityCustomFields({
@@ -237,6 +289,16 @@ export function productFilter(filter) {
     }
     return out;
 }
+/** The engine's `ProductListOptions` for one page of {@link ProductListOptions}. */
+export function productListOptions(options, skip, take) {
+    const filter = productFilter(options?.filter);
+    return {
+        skip,
+        take,
+        ...(Object.keys(filter).length > 0 ? { filter, filterOperator: 'AND' } : {}),
+        ...(options?.sort ? { sort: { [options.sort.field]: options.sort.direction } } : {}),
+    };
+}
 function refuse(code, message) {
     return new ValidationError({ code, message, status: 400, service: 'vendure' });
 }
@@ -290,19 +352,11 @@ export function createProductsModule(transport) {
     };
     return {
         async list(options) {
-            const filter = productFilter(options?.filter);
-            return vendureListPage(transport, PRODUCTS_QUERY, 'products', (skip, take) => ({
-                options: {
-                    skip,
-                    take,
-                    ...(Object.keys(filter).length > 0 ? { filter, filterOperator: 'AND' } : {}),
-                    ...(options?.sort ? { sort: { [options.sort.field]: options.sort.direction } } : {}),
-                },
-            }), options, toProduct);
+            return vendureListPage(transport, PRODUCTS_QUERY, 'products', (skip, take) => ({ options: productListOptions(options, skip, take) }), options, toProduct);
         },
         async get(id, options) {
             const product = await fieldOf(transport, PRODUCT_QUERY, 'product', { id }, options);
-            return product ? toProduct(product) : null;
+            return product ? toProductDetail(product) : null;
         },
         // `async` so every refusal below — including `toWireInput`'s datetime
         // check — arrives as a rejection, never as a synchronous throw a caller's
@@ -362,6 +416,27 @@ export function createProductsModule(transport) {
             assertAvailabilityInput(input, 'read');
             return fieldOf(transport, ORGANIZATION_PRODUCT_AVAILABILITY_QUERY, 'organizationProductAvailability', { productIds: input.productIds, channelIds: input.channelIds }, options);
         },
+        async storePriceRanges(productIds, options) {
+            // The engine stores a uuid lower-case, so an upper-case repeat is the same product.
+            const named = new Map();
+            for (const id of productIds) {
+                const key = String(id).toLowerCase();
+                if (!named.has(key))
+                    named.set(key, id);
+            }
+            if (named.size > MAX_STORE_PRICE_RANGE_PRODUCTS) {
+                throw refuse('PRODUCT_STORE_PRICE_RANGE_INPUT_INVALID', `Ask for at most ${String(MAX_STORE_PRICE_RANGE_PRODUCTS)} products per call; this one named ${String(named.size)}. Nothing was sent.`);
+            }
+            if (named.size === 0)
+                return [];
+            const ids = [...named.values()];
+            const page = await fieldOf(transport, PRODUCT_STORE_PRICE_RANGES_QUERY, 'products', { options: { filter: { id: { in: ids } }, take: ids.length } }, options);
+            const answered = new Map(page.items.map((item) => [item.id.toLowerCase(), item]));
+            return [...named.keys()].flatMap((key) => {
+                const item = answered.get(key);
+                return item ? [{ productId: item.id, range: item.storePriceRange }] : [];
+            });
+        },
         async makeLocalCopy(productId, options) {
             const { skus, ...call } = options ?? {};
             const result = await fieldOf(transport, MAKE_LOCAL_COPY_MUTATION, 'makeLocalCopy', {