@instruments/materialgraph 0.46.0 → 1.0.0

package/association-types.d.ts

@@ -12,7 +12,7 @@ import type { ProductTypeReceipt } from "./material-types.js";
  * with {@link PairingItem}, so the two can never be concatenated into one list.
  * Present them as separate sections, and never describe a pairing as available.
  */
-import type { SearchCatalogueSubset } from "./search-catalogue-subset-types.js";
+import type { SearchCatalogSubset } from "./search-catalog-subset-types.js";
 /**
  * Why an association is believed.
  *
@@ -102,7 +102,7 @@ export type AssociatedOptions = {
      * carrying a Material Bank id; absent or `all` is the whole declared set.
      * Membership does not establish sampleability; use `sampleableOnly` for that.
      */
-    searchCatalogueSubset?: SearchCatalogueSubset;
+    searchCatalogSubset?: SearchCatalogSubset;
     /** Return only associations whose effective sampleability is true. */
     sampleableOnly?: boolean;
     /**

package/brand-types.d.ts

@@ -3,7 +3,7 @@
  * (`GET /api/v1/brands`), the same page and the same input the MCP
  * `list_brands` tool and the `mg brand list` command take.
  */
-import type { SearchCatalogueSubset } from "./search-catalogue-subset-types.js";
+import type { SearchCatalogSubset } from "./search-catalog-subset-types.js";
 export type BrandsOptions = {
     /**
      * A brand name, alias or misspelling, e.g. `"Kvadrat"`. Omit to browse the
@@ -21,10 +21,10 @@ export type BrandsOptions = {
      * per-variant test `listVariants()` applies. Absent or `"all"` is every brand
      * that carries materials.
      */
-    searchCatalogueSubset?: SearchCatalogueSubset;
+    searchCatalogSubset?: SearchCatalogSubset;
     /** Page size, 1 to 50. Never a bound on the list. */
     limit?: number;
-    /** The previous page's `pageInfo.endCursor`, with the same `query`, `categoryId` and `searchCatalogueSubset`. */
+    /** The previous page's `pageInfo.endCursor`, with the same `query`, `categoryId` and `searchCatalogSubset`. */
     cursor?: string;
 };
 export type BrandItem = {

package/brands-client.d.ts

@@ -3,7 +3,7 @@
  * {@link HttpTransport}. `MaterialGraphClient.brands` delegates here; the
  * contract lives in this file.
  *
- * A brand is a COMPANY, not a catalogue. The list says which brands have
+ * A brand is a COMPANY, not a catalog. The list says which brands have
  * eligible materials in the scope asked for, and nothing about how many
  * products a brand sells.
  */
@@ -18,11 +18,11 @@ import type { HttpTransport } from "./http-transport.js";
  * name) as the `brand` filter value:
  *
  * @example
- * const { items } = await mg.brands({ query: "Autex", searchCatalogueSubset: "materialBankNaOrderable" });
+ * const { items } = await mg.brands({ query: "Autex", searchCatalogSubset: "materialBankNaOrderable" });
  * const brand = items.find((b) => b.brandId === "autex-acoustics");
  * if (!brand) throw new Error("autex-acoustics is not on this page");
  * const page = await mg.listVariants({
- *   searchCatalogueSubset: "materialBankNaOrderable",
+ *   searchCatalogSubset: "materialBankNaOrderable",
  *   filters: { terms: [{ field: "brand", op: "in", values: [brand.brandId] }] },
  *   limit: 3,
  * });

package/brands-client.js

@@ -8,11 +8,11 @@ import { resolveOperation } from "./operations.js";
  * name) as the `brand` filter value:
  *
  * @example
- * const { items } = await mg.brands({ query: "Autex", searchCatalogueSubset: "materialBankNaOrderable" });
+ * const { items } = await mg.brands({ query: "Autex", searchCatalogSubset: "materialBankNaOrderable" });
  * const brand = items.find((b) => b.brandId === "autex-acoustics");
  * if (!brand) throw new Error("autex-acoustics is not on this page");
  * const page = await mg.listVariants({
- *   searchCatalogueSubset: "materialBankNaOrderable",
+ *   searchCatalogSubset: "materialBankNaOrderable",
  *   filters: { terms: [{ field: "brand", op: "in", values: [brand.brandId] }] },
  *   limit: 3,
  * });
@@ -23,7 +23,7 @@ export const listBrands = async (transport, options = {}, signal) => await trans
         cursor: options.cursor,
         limit: options.limit,
         query: options.query,
-        searchCatalogueSubset: options.searchCatalogueSubset,
+        searchCatalogSubset: options.searchCatalogSubset,
     },
     signal,
 });

package/{catalogue-client.d.ts → catalog-client.d.ts}

@@ -1,16 +1,16 @@
-import type { CatalogDocumentList, CatalogPageListResult, CatalogProductReferenceReadResult, CatalogueChannelCollectionsResponse, CatalogueCollectionsOptions, CatalogueDocumentAccessResult, CataloguePageRepresentationReadResult, CatalogueReferenceBatchResponse } from "./catalogue-types.js";
+import type { CatalogDocumentList, CatalogPageListResult, CatalogProductReferenceReadResult, CatalogChannelCollectionsResponse, CatalogCollectionsOptions, CatalogDocumentAccessResult, CatalogPageRepresentationReadResult, CatalogReferenceBatchResponse } from "./catalog-types.js";
 import type { HttpTransport } from "./http-transport.js";
 import type { VariantId } from "./identifiers.js";
 import type { ResolveVariantInput, ResolveVariantOutput } from "./resolve-variant-types.js";
-import type { SamplizeCatalogueOptions, SamplizeCataloguePage } from "./samplize-catalogue-types.js";
-/** Catalogue publication operations inherited by the public SDK client. */
-export declare class CatalogueClient {
+import type { SamplizeCatalogOptions, SamplizeCatalogPage } from "./samplize-catalog-types.js";
+/** Catalog publication operations inherited by the public SDK client. */
+export declare class CatalogClient {
     #private;
     protected constructor(transport: HttpTransport);
     /**
      * THE QUESTION: "what does this brand page or code resolve to in the
      * graph?" Give `input.url` alone, or `input.code` with `input.brandId` (from
-     * {@link CatalogueClient.brands} - inherited by {@link MaterialGraphClient})
+     * {@link CatalogClient.brands} - inherited by {@link MaterialGraphClient})
      * when there is no page to read.
      *
      * Exact and scoreless: a sibling colorway, a similar image or a brand match
@@ -21,17 +21,17 @@ export declare class CatalogueClient {
      */
     resolveVariant(input: ResolveVariantInput, signal?: AbortSignal): Promise<ResolveVariantOutput>;
     /** Complete version-pinned Samplize paint corpus; stock never limits eligibility. */
-    samplizeCatalogue(options?: SamplizeCatalogueOptions, signal?: AbortSignal): Promise<SamplizeCataloguePage>;
+    samplizeCatalog(options?: SamplizeCatalogOptions, signal?: AbortSignal): Promise<SamplizeCatalogPage>;
     /**
      * Read exact, verified brand-publication page relationships for variants.
      * Missing evidence stays explicit; this operation never guesses a page from
      * a generic PDF.
      */
-    catalogueReferences(input: {
+    catalogReferencesForVariants(input: {
         variantIds: VariantId[];
-    }, signal?: AbortSignal): Promise<CatalogueReferenceBatchResponse>;
-    /** List product collections with governed catalogue-channel membership. */
-    catalogueCollections(options?: CatalogueCollectionsOptions, signal?: AbortSignal): Promise<CatalogueChannelCollectionsResponse>;
+    }, signal?: AbortSignal): Promise<CatalogReferenceBatchResponse>;
+    /** List product collections with governed catalog-channel membership. */
+    catalogCollections(options?: CatalogCollectionsOptions, signal?: AbortSignal): Promise<CatalogChannelCollectionsResponse>;
     /** List immutable catalog documents retained from verified source material. */
     catalogs(signal?: AbortSignal): Promise<CatalogDocumentList>;
     /** List stable one-based page identities and their representation status. */
@@ -40,9 +40,9 @@ export declare class CatalogueClient {
         offset?: number;
     }, signal?: AbortSignal): Promise<CatalogPageListResult>;
     /** Read a retained page representation or its exact missing-artifact receipt. */
-    catalogPageRepresentation(pageId: string, signal?: AbortSignal): Promise<CataloguePageRepresentationReadResult>;
+    catalogPageRepresentation(pageId: string, signal?: AbortSignal): Promise<CatalogPageRepresentationReadResult>;
     /** Read every verified product/page reference for one retained catalog. */
     catalogReferences(catalogId: string, signal?: AbortSignal): Promise<CatalogProductReferenceReadResult>;
-    /** Resolve browser-safe access to one immutable catalogue document. */
-    catalogueDocumentAccess(documentId: string, signal?: AbortSignal): Promise<CatalogueDocumentAccessResult>;
+    /** Resolve browser-safe access to one immutable catalog document. */
+    catalogDocumentAccess(documentId: string, signal?: AbortSignal): Promise<CatalogDocumentAccessResult>;
 }

package/{catalogue-client.js → catalog-client.js}

@@ -1,6 +1,6 @@
 import { resolveOperation } from "./operations.js";
-/** Catalogue publication operations inherited by the public SDK client. */
-export class CatalogueClient {
+/** Catalog publication operations inherited by the public SDK client. */
+export class CatalogClient {
     #transport;
     constructor(transport) {
         this.#transport = transport;
@@ -8,7 +8,7 @@ export class CatalogueClient {
     /**
      * THE QUESTION: "what does this brand page or code resolve to in the
      * graph?" Give `input.url` alone, or `input.code` with `input.brandId` (from
-     * {@link CatalogueClient.brands} - inherited by {@link MaterialGraphClient})
+     * {@link CatalogClient.brands} - inherited by {@link MaterialGraphClient})
      * when there is no page to read.
      *
      * Exact and scoreless: a sibling colorway, a similar image or a brand match
@@ -21,20 +21,20 @@ export class CatalogueClient {
         return await this.#transport.requestJson(resolveOperation("resolve_variant"), { body: input, signal });
     }
     /** Complete version-pinned Samplize paint corpus; stock never limits eligibility. */
-    async samplizeCatalogue(options = {}, signal) {
-        return await this.#transport.requestJson(resolveOperation("samplize_catalogue_products"), { query: { ...options }, signal });
+    async samplizeCatalog(options = {}, signal) {
+        return await this.#transport.requestJson(resolveOperation("samplize_catalog_products"), { query: { ...options }, signal });
     }
     /**
      * Read exact, verified brand-publication page relationships for variants.
      * Missing evidence stays explicit; this operation never guesses a page from
      * a generic PDF.
      */
-    async catalogueReferences(input, signal) {
-        return await this.#transport.requestJson(resolveOperation("get_catalogue_references_batch"), { body: input, signal });
+    async catalogReferencesForVariants(input, signal) {
+        return await this.#transport.requestJson(resolveOperation("get_catalog_references_batch"), { body: input, signal });
     }
-    /** List product collections with governed catalogue-channel membership. */
-    async catalogueCollections(options = {}, signal) {
-        return await this.#transport.requestJson(resolveOperation("list_catalogue_channel_collections"), {
+    /** List product collections with governed catalog-channel membership. */
+    async catalogCollections(options = {}, signal) {
+        return await this.#transport.requestJson(resolveOperation("list_catalog_channel_collections"), {
             query: {
                 limit: options.limit,
                 offset: options.offset,
@@ -59,8 +59,8 @@ export class CatalogueClient {
     async catalogReferences(catalogId, signal) {
         return await this.#transport.requestJson(resolveOperation("list_catalog_product_references"), { pathParams: { catalogId }, signal });
     }
-    /** Resolve browser-safe access to one immutable catalogue document. */
-    async catalogueDocumentAccess(documentId, signal) {
-        return await this.#transport.requestJson(resolveOperation("get_catalogue_document_access"), { pathParams: { documentId }, signal });
+    /** Resolve browser-safe access to one immutable catalog document. */
+    async catalogDocumentAccess(documentId, signal) {
+        return await this.#transport.requestJson(resolveOperation("get_catalog_document_access"), { pathParams: { documentId }, signal });
     }
 }

package/{catalogue-types.d.ts → catalog-types.d.ts}

@@ -1,5 +1,5 @@
 /** A verified product location in a specific immutable brand publication. */
-export type CatalogueReference = {
+export type CatalogReference = {
     anchor: {
         coordinateSpace: "normalized_0_1000";
         /** Page carrying the printed code; defaults to page.documentPage. Do not draw it on another page. */
@@ -33,7 +33,7 @@ export type CatalogueReference = {
         id: string;
         name: string;
     };
-    catalogue: {
+    catalog: {
         id: string;
         title: string;
     };
@@ -62,7 +62,7 @@ export type CatalogueReference = {
  * product is missing from the printed book; nobody records how many of a
  * brand's products a publication contains.
  */
-export type CatalogueReferenceAbsenceReason = 
+export type CatalogReferenceAbsenceReason = 
 /**
  * The registry retains no publication for the variant's brand. It says
  * nothing about whether the brand publishes one.
@@ -75,12 +75,12 @@ export type CatalogueReferenceAbsenceReason =
 /** Pages were reviewed and this product is not among the references yet. */
  | "product_not_yet_referenced";
 /** The brand publication a `no_verified_reference` result was judged against. */
-export type CatalogueReferencePublication = {
+export type CatalogReferencePublication = {
     brand: {
         id: string;
         name: string;
     };
-    catalogue: {
+    catalog: {
         id: string;
         title: string;
     };
@@ -94,16 +94,16 @@ export type CatalogueReferencePublication = {
     /** Reviewed references the publication holds; present only when its pages were reviewed. */
     referencedProductCount?: number;
 };
-export type CatalogueReferenceResult = {
+export type CatalogReferenceResult = {
     variantId: string;
     status: "verified";
-    reference: CatalogueReference;
+    reference: CatalogReference;
 } | {
     variantId: string;
     status: "no_verified_reference";
-    reason: CatalogueReferenceAbsenceReason;
+    reason: CatalogReferenceAbsenceReason;
     /** Absent only when `reason` is `no_publication_on_record`. */
-    publication?: CatalogueReferencePublication;
+    publication?: CatalogReferencePublication;
 } | {
     variantId: string;
     status: "unresolved_variant";
@@ -114,8 +114,8 @@ export type CatalogueReferenceResult = {
     variantId: string;
     status: "upstream_failure";
 };
-export type CatalogueReferenceBatchResponse = {
-    results: CatalogueReferenceResult[];
+export type CatalogReferenceBatchResponse = {
+    results: CatalogReferenceResult[];
     coverage: {
         requested: number;
         verified: number;
@@ -125,14 +125,14 @@ export type CatalogueReferenceBatchResponse = {
         upstreamFailure: number;
     };
 };
-/** Bounds for the flat catalogue-channel collection shelf. */
-export type CatalogueCollectionsOptions = {
+/** Bounds for the flat catalog-channel collection shelf. */
+export type CatalogCollectionsOptions = {
     limit?: number;
     offset?: number;
     sampleLimit?: number;
 };
-/** One representative product image carried by a catalogue collection. */
-export type CatalogueCollectionSampleProduct = {
+/** One representative product image carried by a catalog collection. */
+export type CatalogCollectionSampleProduct = {
     imageUrl: string | null;
     hex?: string | null;
     productId: string;
@@ -140,21 +140,21 @@ export type CatalogueCollectionSampleProduct = {
     variantId: string;
     variantName: string | null;
 };
-/** A product collection whose variants have governed catalogue membership. */
-export type CatalogueChannelCollection = {
+/** A product collection whose variants have governed catalog membership. */
+export type CatalogChannelCollection = {
     id: string;
     slug: string;
     name: string;
     homepageUrl: string | null;
     productCount: number;
     variantCount: number;
-    sampleProducts: CatalogueCollectionSampleProduct[];
+    sampleProducts: CatalogCollectionSampleProduct[];
 };
-/** The flat, paginated catalogue-channel collection read model. */
-export type CatalogueChannelCollectionsResponse = {
-    collections: CatalogueChannelCollection[];
+/** The flat, paginated catalog-channel collection read model. */
+export type CatalogChannelCollectionsResponse = {
+    collections: CatalogChannelCollection[];
     channel: {
-        token: "catalogue";
+        token: "catalog";
         basis: "governed_variant_membership";
     };
     counts: {
@@ -168,17 +168,17 @@ export type CatalogueChannelCollectionsResponse = {
         hasMore: boolean;
     };
 };
-export type CatalogueDocumentAccess = {
+export type CatalogDocumentAccess = {
     documentId: string;
     contentType: "application/pdf";
     readerUrl: string;
     originalUrl: string;
     byteRanges: "supported" | "unknown";
 };
-export type CatalogueDocumentAccessResult = {
+export type CatalogDocumentAccessResult = {
     documentId: string;
     status: "available";
-    access: CatalogueDocumentAccess;
+    access: CatalogDocumentAccess;
 } | {
     documentId: string;
     status: "unresolved_document";
@@ -296,7 +296,7 @@ export type CatalogProductReferenceList = {
         };
         pagesWithReferences: number;
         precision: {
-            reason: "labelled_denominator_not_recorded";
+            reason: "labeled_denominator_not_recorded";
             status: "not_measured";
         };
         productCoverage: {
@@ -309,7 +309,7 @@ export type CatalogProductReferenceList = {
             status: "not_measured";
         };
     };
-    references: CatalogueReference[];
+    references: CatalogReference[];
     source: "verified-source-material-registry";
     status: "available";
 };
@@ -319,17 +319,17 @@ export type CatalogProductReferenceUnavailable = {
     status: "source_unavailable";
 };
 export type CatalogProductReferenceReadResult = CatalogProductReferenceList | CatalogProductReferenceUnavailable;
-export type CataloguePageRequiredArtifact = {
+export type CatalogPageRequiredArtifact = {
     mediaType: "image/webp";
-    version: "catalogue-page-webp-v1";
+    version: "catalog-page-webp-v1";
 };
-export type CataloguePageAvailableArtifact = {
+export type CatalogPageAvailableArtifact = {
     bucket: "materialgraph";
     key: string;
     url: string;
-    mediaType: CataloguePageRequiredArtifact["mediaType"];
+    mediaType: CatalogPageRequiredArtifact["mediaType"];
 };
-export type CataloguePage = {
+export type CatalogPage = {
     catalogId: string;
     documentId: string;
     editionId: string;
@@ -343,7 +343,7 @@ export type CataloguePage = {
         printedPageLabel?: string;
     };
     representation: {
-        artifact: CataloguePageAvailableArtifact;
+        artifact: CatalogPageAvailableArtifact;
         status: "available";
     };
 } | {
@@ -360,24 +360,24 @@ export type CataloguePage = {
         printedPageLabel?: string;
     };
     representation: {
-        requiredArtifact: CataloguePageRequiredArtifact;
+        requiredArtifact: CatalogPageRequiredArtifact;
         reason: "retained_representation_not_found";
         status: "unavailable";
     };
 };
-type CataloguePageAvailable = Extract<CataloguePage, {
+type CatalogPageAvailable = Extract<CatalogPage, {
     representation: {
         status: "available";
     };
 }>;
-type CataloguePageUnavailable = Extract<CataloguePage, {
+type CatalogPageUnavailable = Extract<CatalogPage, {
     representation: {
         status: "unavailable";
     };
 }>;
 export type CatalogPageListResult = {
     catalog: CatalogDocument;
-    pages: CataloguePage[];
+    pages: CatalogPage[];
     pagination: {
         count: number;
         hasMore: boolean;
@@ -400,13 +400,13 @@ export type CatalogPageListResult = {
     reason: "retained_source_not_found";
     status: "source_unavailable";
 };
-export type CataloguePageRepresentationReadResult = {
-    artifact: CataloguePageAvailableArtifact;
-    page: CataloguePageAvailable;
+export type CatalogPageRepresentationReadResult = {
+    artifact: CatalogPageAvailableArtifact;
+    page: CatalogPageAvailable;
     status: "available";
 } | {
-    requiredArtifact: CataloguePageRequiredArtifact;
-    page: CataloguePageUnavailable;
+    requiredArtifact: CatalogPageRequiredArtifact;
+    page: CatalogPageUnavailable;
     reason: "retained_representation_not_found";
     status: "unavailable";
 } | {

package/client-response-schema.js

@@ -3,7 +3,7 @@ const isRecord = (value) => typeof value === "object" && value !== null && !Arra
 // discriminants stay closed so their associated object shapes remain true.
 const openStrings = new Set([
     "CategoryColorProfilesResponse.profiles.level",
-    "FindVariantsByColorResponse.searchCatalogueSubset.scope",
+    "FindVariantsByColorResponse.searchCatalogSubset.scope",
     "GetCategoryResponse.kind",
     "ListAttributesResponse.items.match.method",
     "ListCategoriesResponse.items.match.method",

package/client-vocabulary.js

@@ -1,6 +1,6 @@
 import { resolveOperation } from "./operations.js";
 export const resolveColor = async (transport, name, signal, options) => await transport.requestJson(resolveOperation("resolve_color_name"), {
-    query: { searchCatalogueSubset: options?.searchCatalogueSubset, name },
+    query: { searchCatalogSubset: options?.searchCatalogSubset, name },
     signal,
 });
 /**

package/client.d.ts

@@ -1,6 +1,6 @@
 import type { ApplicabilityOptions, AssociatedOptions } from "./association-types.js";
 import type { BrandsOptions } from "./brand-types.js";
-import { CatalogueClient } from "./catalogue-client.js";
+import { CatalogClient } from "./catalog-client.js";
 import { CategoriesClient } from "./categories-client.js";
 import type { MaterialGraphClientOptions } from "./client-config.js";
 import { ColorsClient } from "./colors-client.js";
@@ -56,7 +56,7 @@ export type { MaterialGraphClientOptions } from "./client-config.js";
  * And three reading rules that apply to every lens: ids are opaque (see
  * `./identifiers.ts`), absent is not false, and a page is not a corpus.
  */
-export declare class MaterialGraphClient extends CatalogueClient {
+export declare class MaterialGraphClient extends CatalogClient {
     #private;
     readonly baseUrl: string;
     /**
@@ -76,7 +76,7 @@ export declare class MaterialGraphClient extends CatalogueClient {
     /**
      * THE QUESTION: "what colors does this category come in?" (`profiles`).
      * `profiles` is an aggregate over a category, not a list of materials, and
-     * carries a `basis` naming the snapshot it read.
+     * is counted live at request time.
      *
      * Instead use {@link MaterialGraphClient.findVariantsByColor} (`mode:
      * "palette"`) for the materials near one or several colors and
@@ -97,8 +97,8 @@ export declare class MaterialGraphClient extends CatalogueClient {
     readonly workflows: WorkflowsClient;
     constructor(options: MaterialGraphClientOptions);
     get lastRateLimit(): RateLimit | null;
-    /** Current catalogue generation; authenticated, no SQL and no rate-limit charge. */
-    getCatalogueGeneration(signal?: AbortSignal): Promise<{
+    /** Current catalog generation; authenticated, no SQL and no rate-limit charge. */
+    getCatalogGeneration(signal?: AbortSignal): Promise<{
         generation: number;
     }>;
     /**
@@ -159,10 +159,10 @@ export declare class MaterialGraphClient extends CatalogueClient {
      * condition across all four ANDed, 20 at most), or a category/brand listing. An explicit
      * `variant in` id that does not resolve to an eligible variant is
      * reported in `unresolvedVariantIds` when it names no variant, in
-     * `unavailableVariantIds` when it names a catalogue variant this list
+     * `unavailableVariantIds` when it names a catalog variant this list
      * cannot show in the requested scope (a retired one, for example), or in
-     * `excludedBySearchCatalogueSubset` when it names a real variant outside the
-     * materials catalogue, never silently dropped from the page.
+     * `excludedBySearchCatalogSubset` when it names a real variant outside the
+     * materials catalog, never silently dropped from the page.
      *
      * `filters`/`optionalFilters`/`orderBy`/`colors` are sent as URL-encoded
      * JSON; `attributes`/`include`/`words` as comma-separated lists — the server
@@ -190,7 +190,7 @@ export declare class MaterialGraphClient extends CatalogueClient {
      * answered with one and listed in `choices`; send its `handle` with an
      * alternative's `group` and `id` in `selections` to switch it, or its
      * `text` in `leaveOut` to drop the condition. A query that
-     * applies nothing returns no items, never the whole catalogue; a preference
+     * applies nothing returns no items, never the whole catalog; a preference
      * alone still ranks it.
      */
     searchVariants(input: SearchVariantsInput, signal?: AbortSignal): Promise<SearchVariantsOutput>;
@@ -221,11 +221,12 @@ export declare class MaterialGraphClient extends CatalogueClient {
      * an image reference, or both fused into one embedding. `filters` is the
      * same tree {@link MaterialGraphClient.listVariants} takes, less its `orText`
      * and `unstated` additions. `query.mode`
-     * values other than `"text"` embed through Voyage and spend the shared
-     * per-key `embed` rate budget.
+     * values other than `"text"` embed through Voyage and spend the key's own
+     * `embed` rate limit, 10 a minute by default. An upload is embedded once and
+     * its vector kept, so a repeat image-only query on it spends nothing.
      */
     findVariantsByVector(input: FindVariantsByVectorInput, signal?: AbortSignal): Promise<FindVariantsByVectorOutput>;
-    /** Resolve a color name to its hex, and the named paint's catalogue variant. */
+    /** Resolve a color name to its hex, and the named paint's catalog variant. */
     resolveColor(name: string, signal?: AbortSignal, options?: ResolveColorOptions): Promise<ResolveColorResponse>;
     /**
      * THE QUESTION: "which attribute means this phrase?" or "what could a

package/client.js

@@ -1,6 +1,6 @@
 import { applicability, declaredFinishes, declaredProducts, } from "./associations-client.js";
 import { listBrands } from "./brands-client.js";
-import { CatalogueClient } from "./catalogue-client.js";
+import { CatalogClient } from "./catalog-client.js";
 import { CategoriesClient } from "./categories-client.js";
 import { DEFAULT_BASE_URL } from "./client-config.js";
 import { listAttributes as listAttributesCall, listEnumValues as listEnumValuesCall, resolveColor as resolveColorCall, } from "./client-vocabulary.js";
@@ -50,7 +50,7 @@ export { DEFAULT_BASE_URL } from "./client-config.js";
  * And three reading rules that apply to every lens: ids are opaque (see
  * `./identifiers.ts`), absent is not false, and a page is not a corpus.
  */
-export class MaterialGraphClient extends CatalogueClient {
+export class MaterialGraphClient extends CatalogClient {
     baseUrl;
     /**
      * THE QUESTION: "what kinds of thing exist, and what are their keys?"
@@ -69,7 +69,7 @@ export class MaterialGraphClient extends CatalogueClient {
     /**
      * THE QUESTION: "what colors does this category come in?" (`profiles`).
      * `profiles` is an aggregate over a category, not a list of materials, and
-     * carries a `basis` naming the snapshot it read.
+     * is counted live at request time.
      *
      * Instead use {@link MaterialGraphClient.findVariantsByColor} (`mode:
      * "palette"`) for the materials near one or several colors and
@@ -129,9 +129,9 @@ export class MaterialGraphClient extends CatalogueClient {
             signal,
         });
     }
-    /** Current catalogue generation; authenticated, no SQL and no rate-limit charge. */
-    async getCatalogueGeneration(signal) {
-        return await this.#get("get_catalogue_generation", undefined, signal);
+    /** Current catalog generation; authenticated, no SQL and no rate-limit charge. */
+    async getCatalogGeneration(signal) {
+        return await this.#get("get_catalog_generation", undefined, signal);
     }
     // ── Materials ──────────────────────────────────────────────────────────────
     /**
@@ -159,6 +159,7 @@ export class MaterialGraphClient extends CatalogueClient {
             blocks: options?.blocks !== undefined && options.blocks.length > 0
                 ? options.blocks.join(",")
                 : undefined,
+            ifc: options?.ifc === true ? "true" : undefined,
         }, signal, { variantId });
     }
     async materialBlocks(variantId, signal) {
@@ -220,10 +221,10 @@ export class MaterialGraphClient extends CatalogueClient {
      * condition across all four ANDed, 20 at most), or a category/brand listing. An explicit
      * `variant in` id that does not resolve to an eligible variant is
      * reported in `unresolvedVariantIds` when it names no variant, in
-     * `unavailableVariantIds` when it names a catalogue variant this list
+     * `unavailableVariantIds` when it names a catalog variant this list
      * cannot show in the requested scope (a retired one, for example), or in
-     * `excludedBySearchCatalogueSubset` when it names a real variant outside the
-     * materials catalogue, never silently dropped from the page.
+     * `excludedBySearchCatalogSubset` when it names a real variant outside the
+     * materials catalog, never silently dropped from the page.
      *
      * `filters`/`optionalFilters`/`orderBy`/`colors` are sent as URL-encoded
      * JSON; `attributes`/`include`/`words` as comma-separated lists — the server
@@ -238,7 +239,7 @@ export class MaterialGraphClient extends CatalogueClient {
             colors: input.colors !== undefined && input.colors.length > 0
                 ? JSON.stringify(input.colors)
                 : undefined,
-            searchCatalogueSubset: input.searchCatalogueSubset,
+            searchCatalogSubset: input.searchCatalogSubset,
             cursor: input.cursor,
             filters: input.filters ? JSON.stringify(input.filters) : undefined,
             include: input.include !== undefined && input.include.length > 0
@@ -280,7 +281,7 @@ export class MaterialGraphClient extends CatalogueClient {
      * answered with one and listed in `choices`; send its `handle` with an
      * alternative's `group` and `id` in `selections` to switch it, or its
      * `text` in `leaveOut` to drop the condition. A query that
-     * applies nothing returns no items, never the whole catalogue; a preference
+     * applies nothing returns no items, never the whole catalog; a preference
      * alone still ranks it.
      */
     async searchVariants(input, signal) {
@@ -332,13 +333,14 @@ export class MaterialGraphClient extends CatalogueClient {
      * an image reference, or both fused into one embedding. `filters` is the
      * same tree {@link MaterialGraphClient.listVariants} takes, less its `orText`
      * and `unstated` additions. `query.mode`
-     * values other than `"text"` embed through Voyage and spend the shared
-     * per-key `embed` rate budget.
+     * values other than `"text"` embed through Voyage and spend the key's own
+     * `embed` rate limit, 10 a minute by default. An upload is embedded once and
+     * its vector kept, so a repeat image-only query on it spends nothing.
      */
     async findVariantsByVector(input, signal) {
         return await this.#post("find_variants_by_vector", input, signal);
     }
-    /** Resolve a color name to its hex, and the named paint's catalogue variant. */
+    /** Resolve a color name to its hex, and the named paint's catalog variant. */
     async resolveColor(name, signal, options) {
         return await resolveColorCall(this.#transport, name, signal, options);
     }

package/color-profiles-types.d.ts

@@ -55,6 +55,6 @@ export type ColorProfilesParams = {
     groupBy?: "group" | "type" | "merged";
     /** Representative colors per category, 1 to 64. The server defaults to 8. */
     topN?: number;
-    /** `"diverse"` maximises visual distinctness instead of frequency. */
+    /** `"diverse"` maximizes visual distinctness instead of frequency. */
     select?: "frequency" | "diverse";
 };