@instruments/materialgraph 0.25.0 → 0.27.0

package/material-resources-client.js

@@ -1,29 +1,34 @@
-/** Material blocks, safe assets, and technical documents over one shared transport. */
-import { HttpTransport } from "./http-transport.js";
 import { resolveOperation } from "./operations.js";
 /** Read known and explicitly unobserved canonical material fields. */
-export function materialBlocks(transport, variantId, signal) {
-    return transport.requestJson(resolveOperation("list_material_blocks"), { signal, pathParams: { variantId } });
-}
-/** Read only redistribution-safe images and downloads for a material. */
-export function materialAssets(transport, variantId, signal) {
-    return transport.requestJson(resolveOperation("list_material_assets"), { signal, pathParams: { variantId } });
-}
-/** Read the accepted render-ready appearance projection, or an explicit unavailable reason. */
-export function materialRenderAssets(transport, variantId, signal) {
-    return transport.requestJson(resolveOperation("get_material_render_assets"), { signal, pathParams: { variantId } });
-}
+export const materialBlocks = async (transport, variantId, signal) => await transport.requestJson(resolveOperation("list_material_blocks"), { pathParams: { variantId }, signal });
+/**
+ * Read one bounded, filtered, cursor-paged page of a variant's images and
+ * files. `imageRoles` narrows only images and `documentTypes` narrows only
+ * documents, each implying its own kind; the server refuses either paired
+ * with other kinds, or with each other, rather than silently widening.
+ */
+export const listVariantAssets = async (transport, variantId, options, signal) => await transport.requestJson(resolveOperation("list_variant_assets"), {
+    pathParams: { variantId },
+    query: options
+        ? {
+            cursor: options.cursor,
+            documentTypes: options.documentTypes?.join(","),
+            imageRoles: options.imageRoles?.join(","),
+            kinds: options.kinds?.join(","),
+            limit: options.limit,
+        }
+        : undefined,
+    signal,
+});
 /**
  * Read the owning Product's URL-deduplicated document page. Variant declarations
  * retain exact attribution; consumers inspect `appliesToRequestedVariant`
  * before presenting a sibling Variant declaration as applicable.
  */
-export function materialDocuments(transport, variantId, options, signal) {
-    return transport.requestJson(resolveOperation("list_material_documents"), {
-        query: options
-            ? { cursor: options.cursor, limit: options.limit }
-            : undefined,
-        signal,
-        pathParams: { variantId },
-    });
-}
+export const materialDocuments = async (transport, variantId, options, signal) => await transport.requestJson(resolveOperation("list_material_documents"), {
+    pathParams: { variantId },
+    query: options
+        ? { cursor: options.cursor, limit: options.limit }
+        : undefined,
+    signal,
+});

package/material-types.d.ts

@@ -41,7 +41,7 @@ export type MaterialAvailability = OpenEnum<"available" | "discontinued" | "supe
  * successor that has itself been superseded reports `discontinued`/`unknown`
  * here; follow `variantId` for the next link in the chain.
  */
-export interface MaterialSuccessor {
+export type MaterialSuccessor = {
     /** Opaque — round-trip verbatim to read the successor. */
     variantId: VariantId;
     brandSlug: string;
@@ -51,12 +51,12 @@ export interface MaterialSuccessor {
     variant: string;
     color: string | null;
     availability: MaterialAvailability;
-}
+};
 /**
  * The grid-card projection of a material. Tiles carry `availability` but not the
  * successor record — read the detail projection for that.
  */
-export interface MaterialTile {
+export type MaterialTile = {
     /** Accepted sampleability fact. Absent means unknown, never false. */
     sampleable?: boolean;
     /** Opaque — round-trip verbatim into every other material read. */
@@ -77,20 +77,7 @@ export interface MaterialTile {
      * the attribute is absent — never render a missing key as "unnamed".
      */
     colourName?: string;
-}
-/**
- * A sibling card: the tile, plus — when another variant of the same product
- * shares both its `variantName` and its `colourName` — the one attribute that
- * tells them apart (MG-1857: IndoTeak's Reclaimed Teak is ten "Unfinished"
- * variants that differ only by product code). Declared size first, then product
- * code. The two fields arrive together or not at all; absent means nothing
- * collides, or neither attribute separates every look-alike.
- */
-export interface SiblingTile extends MaterialTile {
-    distinguishedBy?: OpenEnum<"size" | "code">;
-    /** This sibling's value of `distinguishedBy`, e.g. `"3.5 in"`. */
-    distinction?: string;
-}
+};
 /**
  * A canonical attribute/term pair carried on a detail record.
  *
@@ -99,7 +86,7 @@ export interface SiblingTile extends MaterialTile {
  * `specificationFacets()` and `attributeValues()`. An attribute absent from
  * `facets` is unrecorded, never known-false.
  */
-export interface MaterialFacet {
+export type MaterialFacet = {
     attributeId: string;
     term: string;
     /**
@@ -108,9 +95,9 @@ export interface MaterialFacet {
      * payloads. Only `specification` facets are valid inputs to `bySpec`.
      */
     role?: "identity" | "specification";
-}
+};
 /** A retained product-type proposal. It is review evidence, never a category. */
-export interface ProposedProductType {
+export type ProposedProductType = {
     id: string;
     displayName: string;
     confidence: number | null;
@@ -118,12 +105,12 @@ export interface ProposedProductType {
     sourceUrl: string | null;
     isPrimary: boolean;
     scope: "variant" | "product";
-}
+};
 /** Accepted display categories remain separate from this review-state receipt. */
-export interface ProductTypeReceipt {
+export type ProductTypeReceipt = {
     state: "accepted" | "proposed" | "unknown";
     proposedProductTypes: ProposedProductType[];
-}
+};
 /**
  * One dimensional configuration of a material. Numeric fields are millimetres
  * (mass in kilograms); string fields are the source's own descriptors. The
@@ -154,8 +141,13 @@ export interface MaterialDetail extends MaterialTile {
     /** Opaque — the product family; siblings share it. */
     productId: ProductId;
     color: string | null;
-    /** Material Bank's own opaque id, when one is mapped. Null = unmapped, not absent. */
+    /** The variant's Material Bank SKU. Null means none is recorded, not unknown. */
     materialBankId: string | null;
+    /**
+     * The manufacturer's own item code from `variants.code`, the same key search
+     * results carry. ABSENT means no code is recorded, never an invented one.
+     */
+    manufacturerCode?: string;
     /**
      * Explicit source-governed permission to save this exact source-coded variant
      * to a Project. Absent means unknown/not allowed; never infer it from identity.

package/ndjson.js

@@ -32,8 +32,9 @@ export class NdjsonDecoder {
         const lines = [];
         for (;;) {
             const index = this.#buffer.indexOf("\n");
-            if (index === -1)
+            if (index === -1) {
                 break;
+            }
             lines.push(this.#buffer.slice(0, index));
             this.#buffer = this.#buffer.slice(index + 1);
         }
@@ -46,8 +47,9 @@ export class NdjsonDecoder {
      * raise, not this decoder's fragment to discard.
      */
     flush() {
-        if (this.#buffer.length === 0)
+        if (this.#buffer.length === 0) {
             return [];
+        }
         const remainder = this.#buffer;
         this.#buffer = "";
         return [remainder];
@@ -66,34 +68,40 @@ export async function* readNdjsonLines(body, signal) {
     const ndjson = new NdjsonDecoder();
     try {
         for (;;) {
-            if (signal?.aborted)
+            if (signal?.aborted) {
                 return;
+            }
             let result;
             try {
                 result = await reader.read();
             }
             catch (error) {
-                if (signal?.aborted)
+                if (signal?.aborted) {
                     return;
+                }
                 throw error;
             }
             if (result.done) {
                 // `decode()` with no argument flushes any dangling multi-byte sequence.
                 for (const line of ndjson.push(decoder.decode())) {
-                    if (line.trim().length > 0)
+                    if (line.trim().length > 0) {
                         yield line;
+                    }
                 }
                 for (const line of ndjson.flush()) {
-                    if (line.trim().length > 0)
+                    if (line.trim().length > 0) {
                         yield line;
+                    }
                 }
                 return;
             }
             for (const line of ndjson.push(decoder.decode(result.value, { stream: true }))) {
-                if (signal?.aborted)
+                if (signal?.aborted) {
                     return;
-                if (line.trim().length > 0)
+                }
+                if (line.trim().length > 0) {
                     yield line;
+                }
             }
         }
     }

package/operations.d.ts

@@ -1,5 +1,5 @@
 export declare const MATERIALGRAPH_API_VERSION = "0.7.0";
-declare const OPERATION_DEFINITIONS: readonly [readonly ["brandMostSampled", "GET", "/api/v1/brands/most-sampled", "brands.most_sampled"], readonly ["colours.complete", "POST", "/api/v1/colours/palettes/complete", "complete_interior_palette"], readonly ["colours.discover", "GET", "/api/v1/colours/palettes", "discover_interior_palettes"], readonly ["samplizeColorVecCache", "GET", "/api/v1/catalogues/samplize/colorvec", "samplize_colorvec_cache"], readonly ["samplizeCatalogueSearch", "POST", "/api/v1/catalogues/samplize/search", "samplize_catalogue_search"], readonly ["scheduleReferences.list", "GET", "/api/v1/schedules/{scheduleId}/references", "list_schedule_reference_feedback"], readonly ["scheduleReferences.put", "PUT", "/api/v1/schedules/{scheduleId}/references/{referenceId}", "put_schedule_reference_feedback"], readonly ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"], readonly ["catalogPages", "GET", "/api/v1/catalogs/{catalogId}/pages", "list_catalog_pages"], readonly ["catalogPageRepresentation", "GET", "/api/v1/catalog-pages/{pageId}/representation", "get_catalog_page_representation"], readonly ["catalogReferences", "GET", "/api/v1/catalogs/{catalogId}/references", "list_catalog_product_references"], readonly ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["identify", "POST", "/api/v1/identify", "retrieval.identify"], readonly ["compare", "POST", "/api/v1/compare", "retrieval.compare"], readonly ["createCorrection", "POST", "/api/v1/corrections", "corrections.create"], readonly ["getCorrection", "GET", "/api/v1/corrections/{correctionId}", "corrections.get"], readonly ["listCorrections", "GET", "/api/v1/corrections", "corrections.list"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], readonly ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], readonly ["searchGet", "GET", "/api/v1/search", "search_materials_get"], readonly ["match", "POST", "/api/v1/search/match", "match_material"], readonly ["rejectMatchResult", "POST", "/api/v1/search/match/{responseId}/rejections", "reject_match_result"], readonly ["matchRejections", "GET", "/api/v1/search/match/{responseId}/rejections", "list_match_rejections"], readonly ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"], readonly ["material", "GET", "/api/v1/materials/{variantId}", "get_material"], readonly ["catalogueReferences", "POST", "/api/v1/catalogues/references", "get_catalogue_references_batch"], readonly ["catalogueCollections", "GET", "/api/v1/catalogues/collections", "list_catalogue_channel_collections"], readonly ["catalogueDocumentAccess", "GET", "/api/v1/catalogues/documents/{documentId}", "get_catalogue_document_access"], readonly ["siblings", "GET", "/api/v1/materials/{variantId}/siblings", "get_material_siblings"], readonly ["materialBlocks", "GET", "/api/v1/materials/{variantId}/blocks", "list_material_blocks"], readonly ["materialAssets", "GET", "/api/v1/materials/{variantId}/assets", "list_material_assets"], readonly ["materialRenderAssets", "GET", "/api/v1/materials/{variantId}/render-assets", "get_material_render_assets"], readonly ["materialDocuments", "GET", "/api/v1/materials/{variantId}/documents", "list_material_documents"], readonly ["exploration.operators", "GET", "/api/v1/materials/{variantId}/operators", "list_material_operators"], readonly ["exploration.candidates", "POST", "/api/v1/materials/{variantId}/candidates", "read_material_candidates"], readonly ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"], readonly ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"], readonly ["schema", "GET", "/api/v1/schema/verticals", "list_schema_verticals"], readonly ["schema", "GET", "/api/v1/schema/product-types", "list_schema_product_types"], readonly ["schema", "GET", "/api/v1/schema/units", "list_schema_units"], readonly ["schema", "GET", "/api/v1/schema/value-dictionaries", "list_schema_value_dictionaries"], readonly ["schema", "GET", "/api/v1/schema/source-requirements", "list_schema_source_requirements"], readonly ["schema", "GET", "/api/v1/schema/product-type-templates", "list_schema_product_type_templates"], readonly ["schema", "GET", "/api/v1/schema/mappings", "list_schema_mappings"], readonly ["pairings", "GET", "/api/v1/materials/{variantId}/pairings", "get_material_pairings"], readonly ["findSubstitutes", "POST", "/api/v1/materials/{variantId}/substitutes", "find_material_substitutes"], readonly ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], readonly ["applicability", "GET", "/api/v1/applicability", "get_applicability"], readonly ["materials", "POST", "/api/v1/materials/batch", "get_materials_batch_post"], readonly ["materialsCached", "GET", "/api/v1/materials/batch", "get_materials_batch_get"], readonly ["browse", "GET", "/api/v1/search/browse", "search_browse_by_colour"], readonly ["colourFacets", "GET", "/api/v1/colours/facets", "get_colour_facets"], readonly ["colours.profiles", "GET", "/api/v1/colours/profiles", "get_category_colour_profiles"], readonly ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"], readonly ["resolveColour", "GET", "/api/v1/search/colours/resolve", "resolve_colour_name"], readonly ["suggestColour", "GET", "/api/v1/search/colours/suggest", "suggest_colour_names"], readonly ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"], readonly ["resolveAttribute", "GET", "/api/v1/catalog/attributes/resolve", "catalog_resolve_attribute"], readonly ["resolveAttributeValue", "GET", "/api/v1/catalog/attributes/{attributeId}/values/resolve", "catalog_resolve_value"], readonly ["searchVocabulary", "GET", "/api/v1/catalog/vocabulary/search", "catalog_vocabulary_search"], readonly ["resolve", "POST", "/api/v1/resolve", "resolve_phrases"], readonly ["bySpec", "GET", "/api/v1/search/specifications", "catalog_by_spec"], readonly ["taxonomy", "GET", "/api/v1/taxonomy/categories", "get_category_taxonomy"], readonly ["productTypeCoverage", "GET", "/api/v1/taxonomy/coverage", "get_product_type_status_coverage"], readonly ["whoami", "GET", "/api/v1/whoami", "whoami"], readonly ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"], readonly ["demand", "GET", "/api/v1/demand", "get_material_demand"], readonly ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"], readonly ["extractPalette", "POST", "/api/v1/search/palettes/extract", "extract_image_palette"], readonly ["colours.gradient", "POST", "/api/v1/search/gradients", "search_by_gradient"], readonly ["specificationFacets", "GET", "/api/v1/catalog/specifications/facets", "list_spec_facets"], readonly ["attributeValues", "GET", "/api/v1/catalog/attributes/{attributeId}/values", "list_attribute_values"], readonly ["applicableSpecs", "GET", "/api/v1/taxonomy/categories/{key}/specs", "get_applicable_specs"], readonly ["glossary", "GET", "/api/v1/glossary/{term}", "explain_material_term"], readonly ["brands", "GET", "/api/v1/brands", "list_brands"], readonly ["brand", "GET", "/api/v1/brands/{brandSlug}", "get_brand_profile"], readonly ["brandColourDeck", "GET", "/api/v1/brands/{brandSlug}/colours", "brand_colour_deck"], readonly ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"], readonly ["sourceMaterialBatch", "GET", "/api/v1/source-material/{batchId}", "get_source_material_batch"], readonly ["sourceMaterialComments.list", "GET", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "list_source_material_comments"], readonly ["sourceMaterialComments.post", "POST", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "post_source_material_comment"], readonly ["capabilities", "GET", "/api/v1/capabilities", "list_public_capabilities"], readonly ["createRun", "POST", "/api/v1/runs", "create_public_run"], readonly ["listRuns", "GET", "/api/v1/runs", "list_public_runs"], readonly ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"], readonly ["runSchedule", "GET", "/api/v1/runs/{runId}/schedule", "get_run_finish_schedule"], readonly ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"], readonly ["streamRunEvents", "GET", "/api/v1/runs/{runId}/events", "list_public_run_events"], readonly ["resumeRun", "POST", "/api/v1/runs/{runId}/resume", "resume_public_run"], readonly ["cancelRun", "POST", "/api/v1/runs/{runId}/cancel", "cancel_public_run"], readonly ["varyScheme", "POST", "/api/v1/schemes/vary", "vary_schemes"], readonly ["slotPools", "POST", "/api/v1/schemes/pools", "slot_pools"], readonly ["createProject", "POST", "/api/v1/projects", "create_box_project"], readonly ["listProjects", "GET", "/api/v1/projects", "list_box_projects"], readonly ["getProject", "GET", "/api/v1/projects/{projectId}", "get_box_project"], readonly ["appendProjectEvent", "POST", "/api/v1/projects/{projectId}/events", "append_box_project_event"], readonly ["demandBatch", "POST", "/api/v1/demand/batch", "get_demand_batch"], readonly ["codeAdvisory", "POST", "/api/v1/codes/advisory", "resolveCodeAdvisory"], readonly ["codes.context", "GET", "/api/v1/codes/context", "list_code_context"], readonly ["codes.requirements", "GET", "/api/v1/codes/requirements", "list_code_requirements"]];
+declare const OPERATION_DEFINITIONS: readonly [readonly ["samplizeColorVecCache", "GET", "/api/v1/catalogues/samplize/colorvec", "samplize_colorvec_cache"], readonly ["samplizeCatalogueSearch", "POST", "/api/v1/catalogues/samplize/search", "samplize_catalogue_search"], readonly ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"], readonly ["catalogPages", "GET", "/api/v1/catalogs/{catalogId}/pages", "list_catalog_pages"], readonly ["catalogPageRepresentation", "GET", "/api/v1/catalog-pages/{pageId}/representation", "get_catalog_page_representation"], readonly ["catalogReferences", "GET", "/api/v1/catalogs/{catalogId}/references", "list_catalog_product_references"], readonly ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["identify", "POST", "/api/v1/identify", "retrieval.identify"], readonly ["match", "POST", "/api/v1/search/match", "match_material"], readonly ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"], readonly ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"], readonly ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], readonly ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], readonly ["searchGet", "GET", "/api/v1/search", "search_materials_get"], readonly ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"], readonly ["material", "GET", "/api/v1/materials/{variantId}", "get_material"], readonly ["catalogueReferences", "POST", "/api/v1/catalogues/references", "get_catalogue_references_batch"], readonly ["catalogueCollections", "GET", "/api/v1/catalogues/collections", "list_catalogue_channel_collections"], readonly ["catalogueDocumentAccess", "GET", "/api/v1/catalogues/documents/{documentId}", "get_catalogue_document_access"], readonly ["materialBlocks", "GET", "/api/v1/materials/{variantId}/blocks", "list_material_blocks"], readonly ["listVariantAssets", "GET", "/api/v1/variants/{variantId}/assets", "list_variant_assets"], readonly ["materialDocuments", "GET", "/api/v1/materials/{variantId}/documents", "list_material_documents"], readonly ["compositionReport", "GET", "/api/v1/composition/report", "get_composition_report"], readonly ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"], readonly ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"], readonly ["schema", "GET", "/api/v1/schema/verticals", "list_schema_verticals"], readonly ["schema", "GET", "/api/v1/schema/product-types", "list_schema_product_types"], readonly ["schema", "GET", "/api/v1/schema/units", "list_schema_units"], readonly ["schema", "GET", "/api/v1/schema/value-dictionaries", "list_schema_value_dictionaries"], readonly ["schema", "GET", "/api/v1/schema/source-requirements", "list_schema_source_requirements"], readonly ["schema", "GET", "/api/v1/schema/product-type-templates", "list_schema_product_type_templates"], readonly ["schema", "GET", "/api/v1/schema/mappings", "list_schema_mappings"], readonly ["pairings", "GET", "/api/v1/materials/{variantId}/pairings", "get_material_pairings"], readonly ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], readonly ["applicability", "GET", "/api/v1/applicability", "get_applicability"], readonly ["listVariants", "GET", "/api/v1/variants", "list_variants"], readonly ["listVariantFacets", "POST", "/api/v1/variants/facets", "list_variant_facets"], readonly ["colours.profiles", "GET", "/api/v1/colours/profiles", "get_category_colour_profiles"], readonly ["resolveColour", "GET", "/api/v1/search/colours/resolve", "resolve_colour_name"], readonly ["suggestColour", "GET", "/api/v1/search/colours/suggest", "suggest_colour_names"], readonly ["listAttributes", "GET", "/api/v1/catalog/attributes", "catalog_list_attributes"], readonly ["searchVocabulary", "GET", "/api/v1/catalog/vocabulary/search", "catalog_vocabulary_search"], readonly ["resolve", "POST", "/api/v1/resolve", "resolve_phrases"], readonly ["categories.list", "GET", "/api/v1/categories", "list_categories"], readonly ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"], readonly ["productTypeCoverage", "GET", "/api/v1/taxonomy/coverage", "get_product_type_status_coverage"], readonly ["whoami", "GET", "/api/v1/whoami", "whoami"], readonly ["demand", "GET", "/api/v1/demand", "get_material_demand"], readonly ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"], readonly ["extractPalette", "POST", "/api/v1/search/palettes/extract", "extract_image_palette"], readonly ["colours.gradient", "POST", "/api/v1/search/gradients", "search_by_gradient"], readonly ["specificationFacets", "GET", "/api/v1/catalog/specifications/facets", "list_spec_facets"], readonly ["brands", "GET", "/api/v1/brands", "list_brands"], readonly ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"], readonly ["sourceMaterialBatch", "GET", "/api/v1/source-material/{batchId}", "get_source_material_batch"], readonly ["sourceMaterialComments.list", "GET", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "list_source_material_comments"], readonly ["sourceMaterialComments.post", "POST", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "post_source_material_comment"], readonly ["createRun", "POST", "/api/v1/runs", "create_public_run"], readonly ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"], readonly ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"], readonly ["streamRunEvents", "GET", "/api/v1/runs/{runId}/events", "list_public_run_events"], readonly ["demandBatch", "POST", "/api/v1/demand/batch", "get_demand_batch"], readonly ["codeAdvisory", "POST", "/api/v1/codes/advisory", "resolveCodeAdvisory"], readonly ["codes.context", "GET", "/api/v1/codes/context", "list_code_context"], readonly ["codes.requirements", "GET", "/api/v1/codes/requirements", "list_code_requirements"]];
 export type SdkOperationId = (typeof OPERATION_DEFINITIONS)[number][3];
 export type SdkOperation = Readonly<{
     clientMethod: (typeof OPERATION_DEFINITIONS)[number][0];
@@ -9,13 +9,13 @@ export type SdkOperation = Readonly<{
 }>;
 export declare const SDK_OPERATIONS: readonly SdkOperation[];
 /** Look up a registered operation by its OpenAPI `operationId`. */
-export declare function findSdkOperation(operationId: SdkOperationId): SdkOperation | undefined;
+export declare const findSdkOperation: (operationId: SdkOperationId) => SdkOperation | undefined;
 /**
  * Look up a registered operation, or throw. The lookup every caller that holds
- * a literal `operationId` wants — lived as a private copy in `client.ts` and
- * `projects.ts` before the association lens would have made it a third.
+ * a literal `operationId` wants — lived as a private copy in `client.ts`
+ * before the association lens would have made it a second.
  */
-export declare function resolveOperation(operationId: SdkOperationId): SdkOperation;
+export declare const resolveOperation: (operationId: SdkOperationId) => SdkOperation;
 /** Substitute `{param}` path placeholders with percent-encoded values. */
-export declare function operationPath(sdkOperation: SdkOperation, pathParams?: Readonly<Record<string, string>>): string;
+export declare const operationPath: (sdkOperation: SdkOperation, pathParams?: Readonly<Record<string, string>>) => string;
 export {};

package/operations.js

@@ -1,24 +1,6 @@
 import { MaterialGraphError } from "./errors.js";
 export const MATERIALGRAPH_API_VERSION = "0.7.0";
 const OPERATION_DEFINITIONS = [
-    [
-        "brandMostSampled",
-        "GET",
-        "/api/v1/brands/most-sampled",
-        "brands.most_sampled",
-    ],
-    [
-        "colours.complete",
-        "POST",
-        "/api/v1/colours/palettes/complete",
-        "complete_interior_palette",
-    ],
-    [
-        "colours.discover",
-        "GET",
-        "/api/v1/colours/palettes",
-        "discover_interior_palettes",
-    ],
     [
         "samplizeColorVecCache",
         "GET",
@@ -31,18 +13,6 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/catalogues/samplize/search",
         "samplize_catalogue_search",
     ],
-    [
-        "scheduleReferences.list",
-        "GET",
-        "/api/v1/schedules/{scheduleId}/references",
-        "list_schedule_reference_feedback",
-    ],
-    [
-        "scheduleReferences.put",
-        "PUT",
-        "/api/v1/schedules/{scheduleId}/references/{referenceId}",
-        "put_schedule_reference_feedback",
-    ],
     ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"],
     [
         "catalogPages",
@@ -64,15 +34,10 @@ const OPERATION_DEFINITIONS = [
     ],
     ["search", "POST", "/api/v1/search", "search_materials_post"],
     ["identify", "POST", "/api/v1/identify", "retrieval.identify"],
-    ["compare", "POST", "/api/v1/compare", "retrieval.compare"],
-    ["createCorrection", "POST", "/api/v1/corrections", "corrections.create"],
-    [
-        "getCorrection",
-        "GET",
-        "/api/v1/corrections/{correctionId}",
-        "corrections.get",
-    ],
-    ["listCorrections", "GET", "/api/v1/corrections", "corrections.list"],
+    ["match", "POST", "/api/v1/search/match", "match_material"],
+    ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"],
+    ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"],
+    ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"],
     ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"],
     [
         "samplizeCatalogue",
@@ -81,19 +46,6 @@ const OPERATION_DEFINITIONS = [
         "samplize_catalogue_products",
     ],
     ["searchGet", "GET", "/api/v1/search", "search_materials_get"],
-    ["match", "POST", "/api/v1/search/match", "match_material"],
-    [
-        "rejectMatchResult",
-        "POST",
-        "/api/v1/search/match/{responseId}/rejections",
-        "reject_match_result",
-    ],
-    [
-        "matchRejections",
-        "GET",
-        "/api/v1/search/match/{responseId}/rejections",
-        "list_match_rejections",
-    ],
     ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"],
     ["material", "GET", "/api/v1/materials/{variantId}", "get_material"],
     [
@@ -114,12 +66,6 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/catalogues/documents/{documentId}",
         "get_catalogue_document_access",
     ],
-    [
-        "siblings",
-        "GET",
-        "/api/v1/materials/{variantId}/siblings",
-        "get_material_siblings",
-    ],
     [
         "materialBlocks",
         "GET",
@@ -127,16 +73,10 @@ const OPERATION_DEFINITIONS = [
         "list_material_blocks",
     ],
     [
-        "materialAssets",
+        "listVariantAssets",
         "GET",
-        "/api/v1/materials/{variantId}/assets",
-        "list_material_assets",
-    ],
-    [
-        "materialRenderAssets",
-        "GET",
-        "/api/v1/materials/{variantId}/render-assets",
-        "get_material_render_assets",
+        "/api/v1/variants/{variantId}/assets",
+        "list_variant_assets",
     ],
     [
         "materialDocuments",
@@ -145,16 +85,10 @@ const OPERATION_DEFINITIONS = [
         "list_material_documents",
     ],
     [
-        "exploration.operators",
+        "compositionReport",
         "GET",
-        "/api/v1/materials/{variantId}/operators",
-        "list_material_operators",
-    ],
-    [
-        "exploration.candidates",
-        "POST",
-        "/api/v1/materials/{variantId}/candidates",
-        "read_material_candidates",
+        "/api/v1/composition/report",
+        "get_composition_report",
     ],
     ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"],
     ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"],
@@ -191,12 +125,6 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/materials/{variantId}/pairings",
         "get_material_pairings",
     ],
-    [
-        "findSubstitutes",
-        "POST",
-        "/api/v1/materials/{variantId}/substitutes",
-        "find_material_substitutes",
-    ],
     [
         "associatedFinishes",
         "GET",
@@ -210,22 +138,19 @@ const OPERATION_DEFINITIONS = [
         "list_associated_products",
     ],
     ["applicability", "GET", "/api/v1/applicability", "get_applicability"],
-    ["materials", "POST", "/api/v1/materials/batch", "get_materials_batch_post"],
+    ["listVariants", "GET", "/api/v1/variants", "list_variants"],
     [
-        "materialsCached",
-        "GET",
-        "/api/v1/materials/batch",
-        "get_materials_batch_get",
+        "listVariantFacets",
+        "POST",
+        "/api/v1/variants/facets",
+        "list_variant_facets",
     ],
-    ["browse", "GET", "/api/v1/search/browse", "search_browse_by_colour"],
-    ["colourFacets", "GET", "/api/v1/colours/facets", "get_colour_facets"],
     [
         "colours.profiles",
         "GET",
         "/api/v1/colours/profiles",
         "get_category_colour_profiles",
     ],
-    ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"],
     [
         "resolveColour",
         "GET",
@@ -238,18 +163,11 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/search/colours/suggest",
         "suggest_colour_names",
     ],
-    ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"],
-    [
-        "resolveAttribute",
-        "GET",
-        "/api/v1/catalog/attributes/resolve",
-        "catalog_resolve_attribute",
-    ],
     [
-        "resolveAttributeValue",
+        "listAttributes",
         "GET",
-        "/api/v1/catalog/attributes/{attributeId}/values/resolve",
-        "catalog_resolve_value",
+        "/api/v1/catalog/attributes",
+        "catalog_list_attributes",
     ],
     [
         "searchVocabulary",
@@ -258,8 +176,8 @@ const OPERATION_DEFINITIONS = [
         "catalog_vocabulary_search",
     ],
     ["resolve", "POST", "/api/v1/resolve", "resolve_phrases"],
-    ["bySpec", "GET", "/api/v1/search/specifications", "catalog_by_spec"],
-    ["taxonomy", "GET", "/api/v1/taxonomy/categories", "get_category_taxonomy"],
+    ["categories.list", "GET", "/api/v1/categories", "list_categories"],
+    ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"],
     [
         "productTypeCoverage",
         "GET",
@@ -267,7 +185,6 @@ const OPERATION_DEFINITIONS = [
         "get_product_type_status_coverage",
     ],
     ["whoami", "GET", "/api/v1/whoami", "whoami"],
-    ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"],
     ["demand", "GET", "/api/v1/demand", "get_material_demand"],
     ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"],
     [
@@ -288,27 +205,7 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/catalog/specifications/facets",
         "list_spec_facets",
     ],
-    [
-        "attributeValues",
-        "GET",
-        "/api/v1/catalog/attributes/{attributeId}/values",
-        "list_attribute_values",
-    ],
-    [
-        "applicableSpecs",
-        "GET",
-        "/api/v1/taxonomy/categories/{key}/specs",
-        "get_applicable_specs",
-    ],
-    ["glossary", "GET", "/api/v1/glossary/{term}", "explain_material_term"],
     ["brands", "GET", "/api/v1/brands", "list_brands"],
-    ["brand", "GET", "/api/v1/brands/{brandSlug}", "get_brand_profile"],
-    [
-        "brandColourDeck",
-        "GET",
-        "/api/v1/brands/{brandSlug}/colours",
-        "brand_colour_deck",
-    ],
     [
         "uploadSourceMaterial",
         "POST",
@@ -333,16 +230,8 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/source-material/{batchId}/sources/{sourceId}/comments",
         "post_source_material_comment",
     ],
-    ["capabilities", "GET", "/api/v1/capabilities", "list_public_capabilities"],
     ["createRun", "POST", "/api/v1/runs", "create_public_run"],
-    ["listRuns", "GET", "/api/v1/runs", "list_public_runs"],
     ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"],
-    [
-        "runSchedule",
-        "GET",
-        "/api/v1/runs/{runId}/schedule",
-        "get_run_finish_schedule",
-    ],
     ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"],
     [
         "streamRunEvents",
@@ -350,19 +239,6 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/runs/{runId}/events",
         "list_public_run_events",
     ],
-    ["resumeRun", "POST", "/api/v1/runs/{runId}/resume", "resume_public_run"],
-    ["cancelRun", "POST", "/api/v1/runs/{runId}/cancel", "cancel_public_run"],
-    ["varyScheme", "POST", "/api/v1/schemes/vary", "vary_schemes"],
-    ["slotPools", "POST", "/api/v1/schemes/pools", "slot_pools"],
-    ["createProject", "POST", "/api/v1/projects", "create_box_project"],
-    ["listProjects", "GET", "/api/v1/projects", "list_box_projects"],
-    ["getProject", "GET", "/api/v1/projects/{projectId}", "get_box_project"],
-    [
-        "appendProjectEvent",
-        "POST",
-        "/api/v1/projects/{projectId}/events",
-        "append_box_project_event",
-    ],
     ["demandBatch", "POST", "/api/v1/demand/batch", "get_demand_batch"],
     ["codeAdvisory", "POST", "/api/v1/codes/advisory", "resolveCodeAdvisory"],
     ["codes.context", "GET", "/api/v1/codes/context", "list_code_context"],
@@ -373,23 +249,20 @@ const OPERATION_DEFINITIONS = [
         "list_code_requirements",
     ],
 ];
-export const SDK_OPERATIONS = Object.freeze(OPERATION_DEFINITIONS.map(([clientMethod, method, path, operationId]) => Object.freeze({ clientMethod, method, path, operationId })));
+export const SDK_OPERATIONS = Object.freeze(OPERATION_DEFINITIONS.map(([clientMethod, method, path, operationId]) => Object.freeze({ clientMethod, method, operationId, path })));
 /** Look up a registered operation by its OpenAPI `operationId`. */
-export function findSdkOperation(operationId) {
-    return SDK_OPERATIONS.find((candidate) => candidate.operationId === operationId);
-}
+export const findSdkOperation = (operationId) => SDK_OPERATIONS.find((candidate) => candidate.operationId === operationId);
 /**
  * Look up a registered operation, or throw. The lookup every caller that holds
- * a literal `operationId` wants — lived as a private copy in `client.ts` and
- * `projects.ts` before the association lens would have made it a third.
+ * a literal `operationId` wants — lived as a private copy in `client.ts`
+ * before the association lens would have made it a second.
  */
-export function resolveOperation(operationId) {
+export const resolveOperation = (operationId) => {
     const match = findSdkOperation(operationId);
-    if (!match)
+    if (!match) {
         throw MaterialGraphError.unexpected(`Unknown SDK operation: ${operationId}`);
+    }
     return match;
-}
+};
 /** Substitute `{param}` path placeholders with percent-encoded values. */
-export function operationPath(sdkOperation, pathParams = {}) {
-    return Object.entries(pathParams).reduce((path, [name, value]) => path.replace(`{${name}}`, encodeURIComponent(value)), sdkOperation.path);
-}
+export const operationPath = (sdkOperation, pathParams = {}) => Object.entries(pathParams).reduce((path, [name, value]) => path.replace(`{${name}}`, encodeURIComponent(value)), sdkOperation.path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instruments/materialgraph",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "type": "module",
   "exports": {
     ".": {
@@ -14,6 +14,10 @@
     "./samplize-colorvec": {
       "types": "./samplize-colorvec.d.ts",
       "import": "./samplize-colorvec.js"
+    },
+    "./response-schemas": {
+      "types": "./response-schemas.d.ts",
+      "import": "./response-schemas.js"
     }
   },
   "dependencies": {