@instruments/materialgraph 0.22.0 → 0.24.0

package/catalogue-client.d.ts

@@ -5,6 +5,7 @@ import type { CreateCorrectionInput, CorrectionResponse, CorrectionsListResponse
 import type { HttpTransport } from "./http-transport.js";
 import type { VariantId } from "./identifiers.js";
 import type { IdentifySelectedPageInput, IdentifySelectedPageResult } from "./identify-types.js";
+import type { MatchRejection, MatchRejectionList, RejectMatchResultInput } from "./match-rejection-types.js";
 import type { SamplizeCatalogueOptions, SamplizeCataloguePage } from "./samplize-catalogue-types.js";
 import type { SamplizeColorVecCache } from "./samplize-colorvec.js";
 /** Catalogue publication operations inherited by the public SDK client. */
@@ -27,6 +28,16 @@ export declare class CatalogueClient {
         cursor?: string;
         limit?: number;
     }, signal?: AbortSignal): Promise<CorrectionsListResponse>;
+    /**
+     * Record "not this" on one result a match showed, against the response it
+     * came from. `responseId` is that response's `attribution.responseId`; the
+     * call needs the same key the match was made with. Repeating a rejection
+     * returns the original receipt. This judges the match ranking and is never a
+     * catalogue correction - wrong product facts go through `createCorrection`.
+     */
+    rejectMatchResult(responseId: string, input: RejectMatchResultInput, signal?: AbortSignal): Promise<MatchRejection>;
+    /** Read one match response back with every rejection recorded against it. */
+    matchRejections(responseId: string, signal?: AbortSignal): Promise<MatchRejectionList>;
     /** Identify the canonical graph subject for one explicitly selected page. */
     identify(input: IdentifySelectedPageInput, signal?: AbortSignal): Promise<IdentifySelectedPageResult>;
     /** Complete producer-owned vectors and classifications for portable colour matching. */

package/catalogue-client.js

@@ -37,6 +37,20 @@ export class CatalogueClient {
             signal,
         });
     }
+    /**
+     * Record "not this" on one result a match showed, against the response it
+     * came from. `responseId` is that response's `attribution.responseId`; the
+     * call needs the same key the match was made with. Repeating a rejection
+     * returns the original receipt. This judges the match ranking and is never a
+     * catalogue correction - wrong product facts go through `createCorrection`.
+     */
+    rejectMatchResult(responseId, input, signal) {
+        return this.#transport.requestJson(resolveOperation("reject_match_result"), { pathParams: { responseId }, body: input, signal });
+    }
+    /** Read one match response back with every rejection recorded against it. */
+    matchRejections(responseId, signal) {
+        return this.#transport.requestJson(resolveOperation("list_match_rejections"), { pathParams: { responseId }, signal });
+    }
     /** Identify the canonical graph subject for one explicitly selected page. */
     identify(input, signal) {
         return this.#transport.requestJson(resolveOperation("retrieval.identify"), { body: input, signal });

package/client-vocabulary.d.ts

@@ -1,7 +1,7 @@
 import { HttpTransport } from "./http-transport.js";
-import type { ColourFacetsResponse, ResolveAttributeOptions, ResolveAttributeResponse, ResolveAttributeValueOptions, ResolveAttributeValueResponse, ResolveColourResponse, SuggestColourResponse, SuggestOptions, SuggestResponse } from "./types.js";
+import type { ColourFacetsResponse, ResolveAttributeOptions, ResolveAttributeResponse, ResolveAttributeValueOptions, ResolveAttributeValueResponse, ResolveColourOptions, ResolveColourResponse, SuggestColourResponse, SuggestOptions, SuggestResponse } from "./types.js";
 export declare function colourFacets(transport: HttpTransport, signal?: AbortSignal): Promise<ColourFacetsResponse>;
-export declare function resolveColour(transport: HttpTransport, name: string, signal?: AbortSignal): Promise<ResolveColourResponse>;
+export declare function resolveColour(transport: HttpTransport, name: string, signal?: AbortSignal, options?: ResolveColourOptions): Promise<ResolveColourResponse>;
 export declare function suggestColour(transport: HttpTransport, q: string, options?: {
     limit?: number;
 }, signal?: AbortSignal): Promise<SuggestColourResponse>;

package/client-vocabulary.js

@@ -4,8 +4,8 @@ import { suggestQuery } from "./suggest-types.js";
 export function colourFacets(transport, signal) {
     return transport.requestJson(resolveOperation("get_colour_facets"), { signal });
 }
-export function resolveColour(transport, name, signal) {
-    return transport.requestJson(resolveOperation("resolve_colour_name"), { query: { name }, signal });
+export function resolveColour(transport, name, signal, options) {
+    return transport.requestJson(resolveOperation("resolve_colour_name"), { query: { name, corpusScope: options?.corpusScope }, signal });
 }
 export function suggestColour(transport, q, options, signal) {
     return transport.requestJson(resolveOperation("suggest_colour_names"), { query: { q, limit: options?.limit }, signal });

package/client.d.ts

@@ -30,7 +30,7 @@ import type { SchemaResource, SchemaResourceResponse } from "./schema-resource-t
 import type { SlotPoolsRequest, SlotPoolsResponse } from "./slot-pool-types.js";
 import type { FindSubstitutesOptions, FindSubstitutesResponse } from "./substitute-types.js";
 import type { ProductTypeCoverageOptions, ProductTypeStatusCoverage } from "./taxonomy-coverage-types.js";
-import type { ApplicableSpecsResponse, BrandOptions, BySpecOptions, BySpecResponse, ColourFacetsResponse, CoordinateInput, CoordinateResponse, DemandBatchInput, DemandBatchResponse, DemandParams, DemandResponse, ExtractPaletteInput, ExtractPaletteResponse, GlossaryTermResponse, MaterialResponse, MaterialsBatchDetailResponse, MaterialsBatchGetOptions, MaterialsBatchOptions, MaterialsBatchTileResponse, PairingsOptions, PairingsResponse, ResolveAttributeOptions, ResolveAttributeResponse, ResolveAttributeValueOptions, ResolveAttributeValueResponse, ResolveColourResponse, SearchGetParams, SearchInput, SearchResponse, SiblingsResponse, SpecFacetsDistributionResponse, SpecFacetsListResponse, SuggestColourResponse, SuggestOptions, SuggestResponse, TaxonomyResponse, VocabularySearchOptions, WhoamiResponse } from "./types.js";
+import type { ApplicableSpecsResponse, BrandOptions, BySpecOptions, BySpecResponse, ColourFacetsResponse, CoordinateInput, CoordinateResponse, DemandBatchInput, DemandBatchResponse, DemandParams, DemandResponse, ExtractPaletteInput, ExtractPaletteResponse, GlossaryTermResponse, MaterialResponse, MaterialsBatchDetailResponse, MaterialsBatchGetOptions, MaterialsBatchOptions, MaterialsBatchTileResponse, PairingsOptions, PairingsResponse, ResolveAttributeOptions, ResolveAttributeResponse, ResolveAttributeValueOptions, ResolveAttributeValueResponse, ResolveColourOptions, ResolveColourResponse, SearchGetParams, SearchInput, SearchResponse, SiblingsResponse, SpecFacetsDistributionResponse, SpecFacetsListResponse, SuggestColourResponse, SuggestOptions, SuggestResponse, TaxonomyResponse, VocabularySearchOptions, WhoamiResponse } from "./types.js";
 /**
  * The MaterialGraph client — every lens on the graph, on one object.
  *
@@ -287,8 +287,8 @@ export declare class MaterialGraphClient extends CatalogueClient {
     }, signal?: AbortSignal): Promise<MaterialsBatchTileResponse>;
     /** Vocabulary families and counts; use `colours.profiles()` for a material palette. */
     colourFacets(signal?: AbortSignal): Promise<ColourFacetsResponse>;
-    /** Resolve a colour name to its canonical hex when recognised. */
-    resolveColour(name: string, signal?: AbortSignal): Promise<ResolveColourResponse>;
+    /** Resolve a colour name to its hex, and the named paint's catalogue variant. */
+    resolveColour(name: string, signal?: AbortSignal, options?: ResolveColourOptions): Promise<ResolveColourResponse>;
     /** Ranked colour-name typeahead (GET `/api/v1/search/colours/suggest`). */
     suggestColour(q: string, options?: {
         limit?: number;

package/client.js

@@ -362,9 +362,9 @@ export class MaterialGraphClient extends CatalogueClient {
     colourFacets(signal) {
         return colourFacetsCall(this.#transport, signal);
     }
-    /** Resolve a colour name to its canonical hex when recognised. */
-    resolveColour(name, signal) {
-        return resolveColourCall(this.#transport, name, signal);
+    /** Resolve a colour name to its hex, and the named paint's catalogue variant. */
+    resolveColour(name, signal, options) {
+        return resolveColourCall(this.#transport, name, signal, options);
     }
     /** Ranked colour-name typeahead (GET `/api/v1/search/colours/suggest`). */
     suggestColour(q, options, signal) {

package/index.d.ts

@@ -50,6 +50,7 @@ export type * from "./substitute-types.js";
 export type * from "./search-refinement-types.js";
 export type * from "./search-window-types.js";
 export type * from "./attribution-types.js";
+export type * from "./match-rejection-types.js";
 export { CERTIFICATION_PROGRAMME_ATTRIBUTE_ID } from "./spec-types.js";
 export type * from "./spec-types.js";
 export { certificationProgramme, certificationProgrammeCriterion, hasSpec, specCriterion, specRangeCriterion, specTerm, } from "./specifications.js";

package/match-rejection-types.d.ts

@@ -0,0 +1,43 @@
+/**
+ * "Not this" on a photo match result (MG-1859). A rejection is feedback on the
+ * match ranking, recorded against the response that showed the result. It is
+ * never a catalogue correction; wrong facts about a product go through
+ * `createCorrection`.
+ */
+export interface RejectMatchResultInput {
+    /**
+     * The surface the result was shown under - `surfaces[].surface.id` on a scene
+     * match. Omit it for a result from the run-level `results` list.
+     */
+    surfaceId?: string;
+    /** The rejected result's `variantId`, verbatim. */
+    variantId: string;
+    /** Optional free text, up to 500 characters. Stored as given. */
+    reason?: string;
+}
+/** The receipt for one rejection. A repeat of the same rejection returns the original. */
+export interface MatchRejection {
+    rejectionId: string;
+    /** The match response's `attribution.responseId`. */
+    responseId: string;
+    /** Null when the result came from the run-level list. */
+    surfaceId: string | null;
+    variantId: string;
+    /** The 1-based position the match response showed this result at, within its surface. */
+    rank: number;
+    reason: string | null;
+    /** ISO-8601. */
+    rejectedAt: string;
+}
+/** One match response and every rejection recorded against it. */
+export interface MatchRejectionList {
+    responseId: string;
+    /** `stream` for a scene match, `buffered` for the single-image JSON response. */
+    lane: "buffered" | "stream";
+    /** ISO-8601 time the match response was issued. */
+    issuedAt: string;
+    /** Ranked results the response showed, across every surface - a rejection rate's denominator. */
+    resultCount: number;
+    /** Oldest first. Empty means nothing was rejected. */
+    rejections: MatchRejection[];
+}

package/match-rejection-types.js

@@ -0,0 +1,7 @@
+/**
+ * "Not this" on a photo match result (MG-1859). A rejection is feedback on the
+ * match ranking, recorded against the response that showed the result. It is
+ * never a catalogue correction; wrong facts about a product go through
+ * `createCorrection`.
+ */
+export {};

package/material-types.d.ts

@@ -78,6 +78,19 @@ export interface MaterialTile {
      */
     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.
  *

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 ["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 ["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"]];
 export type SdkOperationId = (typeof OPERATION_DEFINITIONS)[number][3];
 export type SdkOperation = Readonly<{
     clientMethod: (typeof OPERATION_DEFINITIONS)[number][0];

package/operations.js

@@ -82,6 +82,18 @@ const OPERATION_DEFINITIONS = [
     ],
     ["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"],
     [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instruments/materialgraph",
-  "version": "0.22.0",
+  "version": "0.24.0",
   "type": "module",
   "exports": {
     ".": {

package/resolve-colour-types.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Colour-name resolution (GET `/api/v1/search/colours/resolve`): the resolved
+ * colour, and whether the named paint is a variant in the catalogue.
+ */
+import type { CorpusScope } from "./corpus-scope-types.js";
+import type { VariantId } from "./identifiers.js";
+import type { OpenEnum } from "./types.js";
+/** Options for `resolveColour`. */
+export interface ResolveColourOptions {
+    /**
+     * Sets `inScope` on each catalogue variant the lookup reports. It never
+     * narrows the lookup. Absent leaves every `inScope` null.
+     */
+    corpusScope?: CorpusScope;
+}
+/** One catalogue variant carrying the named paint. */
+export interface ResolveColourCatalogueVariant {
+    variantId: VariantId;
+    /** The brand exactly as stored, suspect or not. */
+    brand: {
+        id: string;
+        slug: string;
+        name: string;
+    };
+    /** Whether the variant is in the requested scope; null when none was asked for. */
+    inScope: boolean | null;
+    /**
+     * True when the stored brand is Samplize, a sampling channel, and the listing
+     * is not Samplize's own: the colour is another maker's, so `brand` is not who
+     * made it. The variant is still the right one for the name.
+     */
+    parentageSuspect: boolean;
+}
+/**
+ * Whether the named paint is a variant in the catalogue. Exact, global, and
+ * never narrowed by `corpusScope`, and run only for a `brand` library hit.
+ * `not-in-catalogue` means the catalogue was searched and nothing carries the
+ * paint; `not-looked-up` means there was no one maker's paint to search for.
+ */
+export type ResolveColourVariant = ({
+    status: "matched";
+} & ResolveColourCatalogueVariant) | {
+    status: "ambiguous";
+    candidates: ResolveColourCatalogueVariant[];
+} | {
+    status: "not-in-catalogue";
+} | {
+    status: "not-looked-up";
+    reason: OpenEnum<"reference-colour" | "descriptive-colour" | "no-paint-identity" | "generic-colour" | "several-paints">;
+};
+export interface ResolveColourResponse {
+    match: {
+        hex: string;
+        name: string;
+        code?: string;
+        /** The ColorScope library the colour resolved in. Not necessarily a maker. */
+        libraryId?: string;
+        /**
+         * The library's own type: `brand` is a maker's paint, `reference` a colour
+         * standard (RAL, Pantone, HKS), `core` ColorScope's descriptive vocabulary.
+         * Present exactly when `libraryId` is. Only a `brand` hit is looked up.
+         */
+        libraryType?: OpenEnum<"brand" | "reference" | "core" | "consumer">;
+        /** The catalogue lookup for the name. Absent from servers that predate it. */
+        variant?: ResolveColourVariant;
+    } | null;
+}

package/resolve-colour-types.js

@@ -0,0 +1 @@
+export {};

package/search-response-receipt-types.d.ts

@@ -37,7 +37,7 @@ export interface SearchEmptyOutcomeCounts {
  */
 export type SearchEmptyOutcome = {
     kind: "proven-corpus-empty";
-    basis: OpenEnum<"spec-allowlist" | "brand-scope">;
+    basis: OpenEnum<"spec-allowlist" | "brand-scope" | "brand-product-type">;
     exhaustive: true;
     sourceEmpty?: boolean | null;
     counts?: SearchEmptyOutcomeCounts;

package/types.d.ts

@@ -29,7 +29,7 @@ import type { BySpecVerdict } from "./by-spec-types.js";
  */
 import type { CorpusScopeReceipt } from "./corpus-scope-types.js";
 import type { Cursor, ProductId, VariantId } from "./identifiers.js";
-import type { MaterialDetail, MaterialTile } from "./material-types.js";
+import type { MaterialDetail, MaterialTile, SiblingTile } from "./material-types.js";
 import type { QueryUnderstanding } from "./query-understanding-types.js";
 import type { CollapsedVariant, SearchAnatomyMember } from "./search-collapse-types.js";
 import type { MoodInterpretation } from "./search-mood-types.js";
@@ -83,7 +83,7 @@ export interface MaterialColour {
 }
 /** Where the served image came from. */
 export type ImageSource = OpenEnum<"r2" | "origin">;
-export type { DimensionEntry, MaterialAvailability, MaterialDetail, MaterialFacet, MaterialSuccessor, MaterialTile, } from "./material-types.js";
+export type { DimensionEntry, MaterialAvailability, MaterialDetail, MaterialFacet, MaterialSuccessor, MaterialTile, SiblingTile, } from "./material-types.js";
 /** Per-signal scores, present on a result when `explain` was requested. */
 export interface SearchResultSignals {
     /** Voyage similarity in the dedicated variant text-portrait space. */
@@ -602,10 +602,10 @@ export interface PairingsResponse {
 export interface MaterialResponse {
     material: MaterialDetail;
     /** Present only when `include: "siblings"` was requested. */
-    siblings?: MaterialTile[];
+    siblings?: SiblingTile[];
 }
 export interface SiblingsResponse {
-    siblings: MaterialTile[];
+    siblings: SiblingTile[];
 }
 /**
  * Batch read of tile projections. `materials` is NOT positional — resolve by
@@ -625,14 +625,6 @@ export interface MaterialsBatchDetailResponse {
     /** Requested ids that resolved to nothing. Echoed verbatim, opaque. */
     missingIds: VariantId[];
 }
-export interface ResolveColourResponse {
-    match: {
-        hex: string;
-        name: string;
-        code?: string;
-        libraryId?: string;
-    } | null;
-}
 export interface SuggestColourResponse {
     suggestions: Array<{
         term: string;
@@ -655,6 +647,7 @@ export interface ResolveAttributeResponse {
 }
 export type * from "./catalog-discovery-types.js";
 export type * from "./resolve-types.js";
+export type * from "./resolve-colour-types.js";
 export type * from "./suggest-types.js";
 export type * from "./by-spec-types.js";
 export interface WhoamiResponse {