@instruments/materialgraph 0.14.0 → 0.16.0

package/by-colour-types.d.ts

@@ -100,6 +100,15 @@ export interface ColourFamilyGate {
      */
     dropped: number;
 }
+/** Receipt for the hard category gate and its treatment of unknown typing. */
+export interface ColourCategoryGate {
+    /** Category names or keys the caller asked the gate to keep. */
+    requested: string[];
+    /** Only accepted primary product types can establish membership. */
+    requiresAcceptedPrimaryProductType: true;
+    /** Unknown/unclassified variants were ineligible, not proven non-members. */
+    unclassifiedVariantsExcluded: true;
+}
 /**
  * Receipt for the colour-identity collapse that turns a variant-grain ranking
  * into a page of TILES — one per (brand, product, dominant hex), one per stored
@@ -177,6 +186,12 @@ export interface ByColourResponse {
      * what says so in counts rather than adjectives.
      */
     familyGate?: ColourFamilyGate;
+    /**
+     * Present only when `category` was asked for. It states that variants without
+     * an accepted primary product type were excluded by the hard gate; absence
+     * means no category gate ran.
+     */
+    categoryGate?: ColourCategoryGate;
     /**
      * What the colour-identity collapse cost this page. Matches are TILES: a page
      * can be SHORTER than `limit` when the pool collapsed harder than the

package/catalogue-client.d.ts

@@ -0,0 +1,18 @@
+import type { CatalogueDocumentAccessResult, CatalogueReferenceBatchResponse } from "./catalogue-types.js";
+import type { HttpTransport } from "./http-transport.js";
+import type { VariantId } from "./identifiers.js";
+/** Catalogue publication operations inherited by the public SDK client. */
+export declare class CatalogueClient {
+    #private;
+    protected constructor(transport: HttpTransport);
+    /**
+     * 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: {
+        variantIds: VariantId[];
+    }, signal?: AbortSignal): Promise<CatalogueReferenceBatchResponse>;
+    /** Resolve browser-safe access to one immutable catalogue document. */
+    catalogueDocumentAccess(documentId: string, signal?: AbortSignal): Promise<CatalogueDocumentAccessResult>;
+}

package/catalogue-client.js

@@ -0,0 +1,20 @@
+import { resolveOperation } from "./operations.js";
+/** Catalogue publication operations inherited by the public SDK client. */
+export class CatalogueClient {
+    #transport;
+    constructor(transport) {
+        this.#transport = transport;
+    }
+    /**
+     * 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, signal) {
+        return this.#transport.requestJson(resolveOperation("get_catalogue_references_batch"), { body: input, signal });
+    }
+    /** Resolve browser-safe access to one immutable catalogue document. */
+    catalogueDocumentAccess(documentId, signal) {
+        return this.#transport.requestJson(resolveOperation("get_catalogue_document_access"), { pathParams: { documentId }, signal });
+    }
+}

package/catalogue-types.d.ts

@@ -0,0 +1,65 @@
+/** A verified product location in a specific immutable brand publication. */
+export interface CatalogueReference {
+    variantId: string;
+    brand: {
+        id: string;
+        name: string;
+    };
+    catalogue: {
+        id: string;
+        title: string;
+    };
+    edition: {
+        id: string;
+        label: string;
+        title?: string;
+    };
+    document: {
+        id: string;
+        mediaType: "application/pdf";
+    };
+    page: {
+        documentPage: number;
+        printedPageLabel?: string;
+        pageCount?: number;
+    };
+    source: {
+        brandItemCode: string;
+    };
+    status: "verified";
+    isPrimary: true;
+}
+export type CatalogueReferenceResult = {
+    variantId: string;
+    status: "verified";
+    reference: CatalogueReference;
+} | {
+    variantId: string;
+    status: "no_verified_reference" | "unresolved_variant" | "unavailable" | "upstream_failure";
+};
+export interface CatalogueReferenceBatchResponse {
+    results: CatalogueReferenceResult[];
+    coverage: {
+        requested: number;
+        verified: number;
+        noVerifiedReference: number;
+        unresolvedVariant: number;
+        unavailable: number;
+        upstreamFailure: number;
+    };
+}
+export interface CatalogueDocumentAccess {
+    documentId: string;
+    contentType: "application/pdf";
+    readerUrl: string;
+    originalUrl: string;
+    byteRanges: "supported" | "unknown";
+}
+export type CatalogueDocumentAccessResult = {
+    documentId: string;
+    status: "available";
+    access: CatalogueDocumentAccess;
+} | {
+    documentId: string;
+    status: "unresolved_document" | "unavailable" | "forbidden" | "upstream_failure";
+};

package/catalogue-types.js

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

package/client.d.ts

@@ -1,3 +1,4 @@
+import { CatalogueClient } from "./catalogue-client.js";
 import type { MaterialGraphClientOptions } from "./client-config.js";
 import { type RateLimit } from "./errors.js";
 export * from "./client-config.js";
@@ -8,7 +9,7 @@ export type { ExplorationNamespace } from "./client-exploration.js";
 import { type SourceMaterialCommentsNamespace } from "./client-source-material-comments.js";
 export type { SourceMaterialCommentsNamespace } from "./client-source-material-comments.js";
 import type { AssociatedOptions } from "./association-types.js";
-import type { BrandCatalogListPage, BrandsOptions } from "./brand-types.js";
+import type { BrandsOptions } from "./brand-types.js";
 import type { ByColourParams, ByColourResponse } from "./by-colour-types.js";
 import { CodesClient } from "./codes-client.js";
 import type { CodeAdvisoryInput, CodeAdvisoryResponse } from "./codes-types.js";
@@ -26,7 +27,7 @@ import type { CapabilityManifestResponse, CreatePublicRunRequest, CreatePublicRu
 import type { FinishScheduleResponse, GetRunScheduleOptions } from "./schedule-types.js";
 import type { SchemaResource, SchemaResourceResponse } from "./schema-resource-types.js";
 import type { SlotPoolsRequest, SlotPoolsResponse } from "./slot-pool-types.js";
-import type { ApplicableSpecsResponse, BrandOptions, BrandProfileResponse, 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, 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.
  *
@@ -59,11 +60,10 @@ import type { ApplicableSpecsResponse, BrandOptions, BrandProfileResponse, BySpe
  *   `pairings()` returns companionship the graph INFERRED. The response shapes
  *   share no field, on purpose — render them as separate sections and never
  *   concatenate them.
- *
  * 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 {
+export declare class MaterialGraphClient extends CatalogueClient {
     #private;
     readonly baseUrl: string;
     /**
@@ -483,9 +483,9 @@ export declare class MaterialGraphClient {
      */
     glossary(term: string, signal?: AbortSignal): Promise<GlossaryTermResponse>;
     /** "Whose catalogs are in here, and how big is each?" — {@link listBrands}. */
-    brands(options?: BrandsOptions, signal?: AbortSignal): Promise<BrandCatalogListPage>;
+    brands(options?: BrandsOptions, signal?: AbortSignal): Promise<import("./brand-types.js").BrandCatalogListPage>;
     /** "Who is this brand, and what do they claim?" — {@link brandProfile}. */
-    brand(brandSlug: string, options?: BrandOptions, signal?: AbortSignal): Promise<BrandProfileResponse>;
+    brand(brandSlug: string, options?: BrandOptions, signal?: AbortSignal): Promise<import("./types.js").BrandProfileResponse>;
     /** "This maker's whole range, the way a fan deck reads" — {@link brandColourDeck}. */
     brandColourDeck(brandSlug: string, signal?: AbortSignal): Promise<import("./fan-deck-types.js").BrandFanDeck>;
     /**

package/client.js

@@ -1,3 +1,4 @@
+import { CatalogueClient } from "./catalogue-client.js";
 import { DEFAULT_BASE_URL, MAX_BATCH_IDS } from "./client-config.js";
 import { MaterialGraphError } from "./errors.js";
 import { HttpTransport } from "./http-transport.js";
@@ -52,11 +53,10 @@ import { suggestQuery } from "./suggest-types.js";
  *   `pairings()` returns companionship the graph INFERRED. The response shapes
  *   share no field, on purpose — render them as separate sections and never
  *   concatenate them.
- *
  * 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 {
+export class MaterialGraphClient extends CatalogueClient {
     baseUrl;
     /**
      * THE QUESTION: "show me everything in this category / this brand, in a plain
@@ -112,12 +112,14 @@ export class MaterialGraphClient {
         if (!options.apiKey) {
             throw MaterialGraphError.unexpected("MaterialGraphClient: `apiKey` is required.");
         }
-        this.#transport = new HttpTransport({
+        const transport = new HttpTransport({
             apiKey: options.apiKey,
             baseUrl: options.baseUrl ?? DEFAULT_BASE_URL,
             fetch: options.fetch ?? globalThis.fetch,
         });
-        this.baseUrl = this.#transport.baseUrl;
+        super(transport);
+        this.#transport = transport;
+        this.baseUrl = transport.baseUrl;
         this.browse = createBrowseNamespace((params, signal) => this.#get("search_browse_by_colour", browseQuery(params), signal));
         this.codes = new CodesClient({
             get: (operationId, query, signal) => this.#get(operationId, query, signal),

package/codes-client.d.ts

@@ -45,7 +45,7 @@ export declare class CodesClient {
      * The vocabulary for stating a code context (GET `/api/v1/codes/context`):
      * seeded jurisdictions and their coverage tier, the occupancy groups the
      * registry keys on, finish locations, dimensions, classification scales with
-     * classes ordered best-first, and which `ms_room` term correlates to which
+     * classes ordered best-first, and which `room` term correlates to which
      * regulatory axes.
      *
      * Start here — every value the other two calls accept is listed in this one

package/codes-client.js

@@ -14,7 +14,7 @@ export class CodesClient {
      * The vocabulary for stating a code context (GET `/api/v1/codes/context`):
      * seeded jurisdictions and their coverage tier, the occupancy groups the
      * registry keys on, finish locations, dimensions, classification scales with
-     * classes ordered best-first, and which `ms_room` term correlates to which
+     * classes ordered best-first, and which `room` term correlates to which
      * regulatory axes.
      *
      * Start here — every value the other two calls accept is listed in this one

package/codes-types.d.ts

@@ -62,7 +62,7 @@ export interface CodeContextRequest {
      */
     spaceType?: string;
     /**
-     * An `ms_room` term id (e.g. `"hotel_room"`) to correlate the regulatory axes
+     * A `room` term id (e.g. `"hotel_room"`) to correlate the regulatory axes
      * from. Explicit `occupancyGroup` / `spaceType` always win. A room that
      * correlates to neither axis is a 400 naming the axis — never a guess.
      */
@@ -224,7 +224,7 @@ export interface ResolvedCodeContext {
     spaceType: string;
     sprinklered: boolean;
     basis: OpenEnum<"explicit" | "derived_from_room">;
-    /** The `ms_room` term the axes were correlated from, or null. */
+    /** The `room` term the axes were correlated from, or null. */
     roomType: string | null;
 }
 /**
@@ -271,7 +271,7 @@ export interface CodeContextResponse {
         /** Ordered BEST FIRST: index 0 outranks index 1. */
         classes: string[];
     }[];
-    /** `ms_room` → regulatory axes. `null` where the registry refuses to correlate. */
+    /** `room` → regulatory axes. `null` where the registry refuses to correlate. */
     roomCorrelations: {
         roomType: string;
         label: string;

package/composition-types.d.ts

@@ -86,6 +86,23 @@ export interface CompliancePresetRule {
 export interface CompliancePreset {
     rules: CompliancePresetRule[];
 }
+/** Exact project regulatory axes used to attach bounded code citations. */
+export interface ProgrammeRegulatoryAxes {
+    jurisdictionId: string;
+    occupancyGroup: string;
+    sprinklered: boolean;
+}
+/** One caller-declared Programme space. `spaceType` remains open descriptive text. */
+export interface ComposeDeclaredSpace {
+    name: string;
+    spaceType?: string;
+    /** Exact active canonical `room` id used for bounded code evaluation. */
+    regulatoryRoomType?: string;
+}
+/** The spaces this run is explicitly for; omit to retain brief inference. */
+export interface ComposeDeclaredScope {
+    spaces: ComposeDeclaredSpace[];
+}
 /**
  * The `inputJson` for a `compose-material-schemes` run. `batchId` is required;
  * everything else has a server default. `anchors` (max 24) carry externally
@@ -101,6 +118,10 @@ export interface ComposeMaterialSchemesInput {
     exclusions?: SchemeExclusions;
     anchors?: ComposeAnchorInput[];
     compliancePreset?: CompliancePreset;
+    /** Omit to leave Programme code coverage explicitly unevaluated. */
+    regulatoryAxes?: ProgrammeRegulatoryAxes;
+    /** Explicit caller-held space facts; regulatoryRoomType is never inferred. */
+    scope?: ComposeDeclaredScope;
 }
 /**
  * The state of one criterion verdict cell (MG-627: the shared MaterialGraph

package/exploration-types.d.ts

@@ -7,6 +7,8 @@ export interface GraphOperatorAvailability {
     label: string;
     available: boolean;
     basis: string;
+    discoverable: boolean;
+    discoveryBasis: string;
     count?: number;
 }
 export interface GraphOperatorEvidence {

package/index.d.ts

@@ -19,6 +19,7 @@ export type { MaterialGraphErrorInit, MaterialGraphErrorKind, MaterialGraphReque
 export type * from "./types.js";
 export type * from "./match-types.js";
 export type * from "./browse-types.js";
+export type * from "./catalogue-types.js";
 export type * from "./by-colour-types.js";
 export { MATCH_IMAGE_TYPES, MATCH_OUTCOMES, MATCH_MATERIAL_FUNCTIONS, MATCH_STREAM_EVENT_TYPES, MATCH_SURFACE_STATUSES, MATCH_WORKFLOW_STEPS, } from "./match-stream-types.js";
 export type * from "./match-stream-types.js";
@@ -37,6 +38,7 @@ export type * from "./material-asset-types.js";
 export type * from "./material-block-types.js";
 export type * from "./schema-resource-types.js";
 export type * from "./search-refinement-types.js";
+export type * from "./search-window-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/material-types.d.ts

@@ -120,6 +120,16 @@ export interface MaterialDetail extends MaterialTile {
     color: string | null;
     /** Material Bank's own opaque id, when one is mapped. Null = unmapped, not absent. */
     materialBankId: string | null;
+    /**
+     * Explicit source-governed permission to save this exact source-coded variant
+     * to a Project. Absent means unknown/not allowed; never infer it from identity.
+     */
+    projectSaveCapability?: "allowed";
+    /**
+     * The governed source status behind Project capture. Provisional remains
+     * source-backed, but is not a verified catalogue claim.
+     */
+    sourceStatus?: "provisional";
     installationImageUrl: string | null;
     displayCategory: string | null;
     categoryPath: string[];

package/operations.d.ts

@@ -1,5 +1,5 @@
 export declare const MATERIALGRAPH_API_VERSION = "0.7.0";
-declare const OPERATION_DEFINITIONS: readonly [readonly ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], 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 ["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 ["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 ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], 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 ["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", "GET", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "list_source_material_comments"], readonly ["sourceMaterialComments", "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 ["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 ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], 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 ["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 ["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 ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], 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 ["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", "GET", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "list_source_material_comments"], readonly ["sourceMaterialComments", "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 ["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

@@ -7,6 +7,18 @@ const OPERATION_DEFINITIONS = [
     ["match", "POST", "/api/v1/search/match", "match_material"],
     ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"],
     ["material", "GET", "/api/v1/materials/{variantId}", "get_material"],
+    [
+        "catalogueReferences",
+        "POST",
+        "/api/v1/catalogues/references",
+        "get_catalogue_references_batch",
+    ],
+    [
+        "catalogueDocumentAccess",
+        "GET",
+        "/api/v1/catalogues/documents/{documentId}",
+        "get_catalogue_document_access",
+    ],
     [
         "siblings",
         "GET",

package/package.json

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

package/resolve-types.d.ts

@@ -25,7 +25,7 @@
  * - `category` — a product-category taxonomy node key.
  * - `attribute` — a registry attribute id: the LEFT half of an `attribute:value`
  *   pair, for `mg.bySpec()` or `search({ filters })`.
- * - `attribute_value` — a value-dictionary term, namespaced (`ms_sheen.matte`):
+ * - `attribute_value` — a value-dictionary term, namespaced (`sheen.matte`):
  *   the RIGHT half.
  * - `jurisdiction` — a code jurisdiction id (`us-tx`), for `mg.codeAdvisory()`.
  * - `occupancy_group` — an IBC occupancy group (`R-1`), the other axis the code

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

@@ -0,0 +1,90 @@
+/**
+ * @module sdk/search-response-receipt-types
+ * @description Inspectable routing, rerank, and compound-constraint receipts
+ * emitted by ordinary Search responses.
+ */
+import type { OpenEnum } from "./types.js";
+/** The single candidate source a query resolved to. */
+export type SearchMode = OpenEnum<"image" | "colour" | "text" | "lexical" | "entity-browse">;
+/** Rerank-term report (absent in colour mode — there colour IS the source). */
+export interface SearchRerankReport {
+    colour?: OpenEnum<"ok" | "failed" | "skipped">;
+    colourWeight?: number;
+    colourLabel?: string;
+}
+/** One stage in the explain-only ledger of transformations that actually ran. */
+export type SearchQueryTransformStage = {
+    stage: OpenEnum<"normalise" | "resolve-spec" | "resolve-paint" | "resolve-brand">;
+    applied: true;
+} | {
+    stage: OpenEnum<"normalise" | "resolve-spec" | "resolve-paint" | "resolve-brand">;
+    applied: false;
+    reason: string;
+};
+/** Explain-only category gate selected by query understanding. */
+export interface SearchCategoryAnchor {
+    productTypeId: string;
+    displayName: string;
+    similarity: number;
+    margin: number | null;
+    source: OpenEnum<"synonym" | "display-name" | "vector">;
+    applied: boolean;
+}
+/** Explain-only brand gate selected by query understanding. */
+export interface SearchBrandAnchor {
+    brandSlug: string;
+    brandName: string;
+    confidence: number;
+    margin: number | null;
+    tier: OpenEnum<"exact_id" | "exact_alias" | "lexical" | "semantic">;
+    variantCount: number;
+    applied: boolean;
+}
+/** A real brand candidate the engine deliberately declined to gate on. */
+export interface SearchBrandSkip {
+    reason: OpenEnum<"ambiguous" | "weak-tier" | "too-broad">;
+    candidates?: string[];
+}
+/**
+ * EXPLAIN-only receipt of the query shape that executed. This is distinct from
+ * the separate Search Plan compiler operation: it reports execution and never
+ * causes it.
+ */
+export interface SearchExecutionPlan {
+    grain: OpenEnum<"variant" | "product">;
+    weights: {
+        image: number;
+        category: number;
+        colour: number;
+        lexical: number;
+        text: number;
+    };
+    queryTransform: SearchQueryTransformStage[];
+    categoryAnchor?: SearchCategoryAnchor;
+    brandAnchor?: SearchBrandAnchor;
+    brandSkipped?: SearchBrandSkip;
+}
+/** Why a compound colour constraint returned a full or short page. */
+export interface CompoundColourAbundanceReceipt {
+    grain: OpenEnum<"variant" | "product">;
+    requested: number;
+    eligible: number;
+    candidateWindow: number;
+    sourceExhausted: boolean;
+    state: OpenEnum<"filled" | "corpus_scarcity" | "evidence_unavailable" | "retrieval_window_exhausted">;
+}
+/**
+ * Eligibility proof for an explicit or taxonomy-backed colour inside a compound
+ * text query. Counts describe the bounded candidate pool, not the whole corpus.
+ */
+export interface CompoundColourConstraintReceipt {
+    provenance: OpenEnum<"explicit" | "detected-strong">;
+    family: string;
+    queryHexes: string[];
+    considered: number;
+    kept: number;
+    dropped: number;
+    unknown: number;
+    adjacent: number;
+    abundance?: CompoundColourAbundanceReceipt;
+}

package/search-response-receipt-types.js

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

package/search-window-types.d.ts

@@ -0,0 +1,17 @@
+/** The bounded candidate window that produced a search page. */
+export interface SearchWindowReceipt {
+    /** Versioned budget profile; interpret the remaining fields under this version. */
+    profile: "interactive-r1" | (string & {});
+    /** Candidate depth used by the final retrieval. */
+    candidateTier: number;
+    /** Every candidate retrieval, including required fallbacks and optional recovery. */
+    retrievalRounds: number;
+    /** Candidate-retrieval wall time only, in milliseconds. */
+    retrievalMs: number;
+    /** True when the serving source proved there were no more candidates. */
+    exhaustive: boolean;
+    /** True when product-grain scarcity caused one jump to the deep ceiling. */
+    deepened: boolean;
+    /** True when a still-short page exhausted its bounded recovery allowance. */
+    budgetExhausted: boolean;
+}

package/search-window-types.js

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

package/types.d.ts

@@ -5,7 +5,7 @@ import type { BySpecVerdict } from "./by-spec-types.js";
  * These interfaces intentionally have NO runtime dependency on any
  * `@materialgraph/*` package — they are a standalone, publishable mirror of the
  * shapes in `apps/web/public/openapi.yaml` and the captured fixtures under
- * `docs/surface/fixtures/v0.5.0/`. The `contract-parity` test re-checks them
+ * `src/__tests__/fixtures/v0.5.0/`. The `contract-parity` test re-checks them
  * against the real Zod schemas so the mirror cannot silently drift.
  * TOLERANT-PARSING CONTRACT: the public surface declares open response enums —
  * "clients must tolerate unknown enum values and unknown fields". Every union
@@ -31,7 +31,9 @@ import type { Cursor, ProductId, VariantId } from "./identifiers.js";
 import type { MaterialDetail, MaterialTile } from "./material-types.js";
 import type { QueryUnderstanding } from "./query-understanding-types.js";
 import type { SearchDisambiguation, SearchSuggestion } from "./search-refinement-types.js";
-/** A widened string-literal union: known members autocomplete, unknown values still type-check. */
+import type { CompoundColourConstraintReceipt, SearchExecutionPlan, SearchMode, SearchRerankReport } from "./search-response-receipt-types.js";
+import type { SearchWindowReceipt } from "./search-window-types.js";
+export type * from "./search-response-receipt-types.js";
 export type OpenEnum<T extends string> = T | (string & {});
 /**
  * A JSON value, recursively — exactly what survives a `jsonb` round-trip
@@ -389,14 +391,6 @@ export interface SearchRefinementReceipt {
     schemaVersion: string;
     projectionVersion: number;
 }
-/** The single candidate source a query resolved to. */
-export type SearchMode = OpenEnum<"image" | "colour" | "text" | "lexical" | "entity-browse">;
-/** Rerank-term report (absent in colour mode — there colour IS the source). */
-export interface SearchRerankReport {
-    colour?: OpenEnum<"ok" | "failed" | "skipped">;
-    colourWeight?: number;
-    colourLabel?: string;
-}
 /**
  * The search response envelope. `view` discriminates the `results` union:
  * `"full"` (default) carries {@link SearchResultItem}s, `"card"` the lean
@@ -418,7 +412,13 @@ export interface SearchResponse {
     maxScore: number;
     /** Opaque keyset for the next page. Absent = end of the walk, not an error. */
     cursor?: Cursor;
+    /** Boundedness and retrieval-cost receipt on current Search responses. */
+    window?: SearchWindowReceipt;
     rerank?: SearchRerankReport;
+    /** Hard compound-colour eligibility and abundance receipt, when applied. */
+    colourConstraint?: CompoundColourConstraintReceipt;
+    /** Explain-only receipt of the query shape and transform ledger that ran. */
+    plan?: SearchExecutionPlan;
     counts?: SearchCounts;
     /**
      * The `#rrggbb` colours the colour signal ACTUALLY ran on, after