@instruments/materialgraph 0.9.1 → 0.11.0

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 ["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 ["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 ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"], readonly ["sourceMaterialBatch", "GET", "/api/v1/source-material/{batchId}", "get_source_material_batch"], 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 ["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 ["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"]];
 export type SdkOperationId = (typeof OPERATION_DEFINITIONS)[number][3];
 export type SdkOperation = Readonly<{
     clientMethod: (typeof OPERATION_DEFINITIONS)[number][0];

package/operations.js

@@ -6,38 +6,130 @@ 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"],
-    ["siblings", "GET", "/api/v1/materials/{variantId}/siblings", "get_material_siblings"],
-    ["materialBlocks", "GET", "/api/v1/materials/{variantId}/blocks", "list_material_blocks"],
-    ["materialAssets", "GET", "/api/v1/materials/{variantId}/assets", "list_material_assets"],
+    [
+        "siblings",
+        "GET",
+        "/api/v1/materials/{variantId}/siblings",
+        "get_material_siblings",
+    ],
+    [
+        "materialBlocks",
+        "GET",
+        "/api/v1/materials/{variantId}/blocks",
+        "list_material_blocks",
+    ],
+    [
+        "materialAssets",
+        "GET",
+        "/api/v1/materials/{variantId}/assets",
+        "list_material_assets",
+    ],
+    [
+        "exploration.operators",
+        "GET",
+        "/api/v1/materials/{variantId}/operators",
+        "list_material_operators",
+    ],
+    [
+        "exploration.candidates",
+        "POST",
+        "/api/v1/materials/{variantId}/candidates",
+        "read_material_candidates",
+    ],
     ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"],
     ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"],
     ["schema", "GET", "/api/v1/schema/verticals", "list_schema_verticals"],
-    ["schema", "GET", "/api/v1/schema/product-types", "list_schema_product_types"],
+    [
+        "schema",
+        "GET",
+        "/api/v1/schema/product-types",
+        "list_schema_product_types",
+    ],
     ["schema", "GET", "/api/v1/schema/units", "list_schema_units"],
-    ["schema", "GET", "/api/v1/schema/value-dictionaries", "list_schema_value_dictionaries"],
-    ["schema", "GET", "/api/v1/schema/source-requirements", "list_schema_source_requirements"],
-    ["schema", "GET", "/api/v1/schema/product-type-templates", "list_schema_product_type_templates"],
+    [
+        "schema",
+        "GET",
+        "/api/v1/schema/value-dictionaries",
+        "list_schema_value_dictionaries",
+    ],
+    [
+        "schema",
+        "GET",
+        "/api/v1/schema/source-requirements",
+        "list_schema_source_requirements",
+    ],
+    [
+        "schema",
+        "GET",
+        "/api/v1/schema/product-type-templates",
+        "list_schema_product_type_templates",
+    ],
     ["schema", "GET", "/api/v1/schema/mappings", "list_schema_mappings"],
-    ["pairings", "GET", "/api/v1/materials/{variantId}/pairings", "get_material_pairings"],
-    ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"],
-    ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"],
+    [
+        "pairings",
+        "GET",
+        "/api/v1/materials/{variantId}/pairings",
+        "get_material_pairings",
+    ],
+    [
+        "associatedFinishes",
+        "GET",
+        "/api/v1/associated/finishes",
+        "list_associated_finishes",
+    ],
+    [
+        "associatedProducts",
+        "GET",
+        "/api/v1/associated/products",
+        "list_associated_products",
+    ],
     ["materials", "POST", "/api/v1/materials/batch", "get_materials_batch_post"],
-    ["materialsCached", "GET", "/api/v1/materials/batch", "get_materials_batch_get"],
+    [
+        "materialsCached",
+        "GET",
+        "/api/v1/materials/batch",
+        "get_materials_batch_get",
+    ],
     ["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.profiles",
+        "GET",
+        "/api/v1/colours/profiles",
+        "get_category_colour_profiles",
+    ],
     ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"],
-    ["resolveColour", "GET", "/api/v1/search/colours/resolve", "resolve_colour_name"],
-    ["suggestColour", "GET", "/api/v1/search/colours/suggest", "suggest_colour_names"],
+    [
+        "resolveColour",
+        "GET",
+        "/api/v1/search/colours/resolve",
+        "resolve_colour_name",
+    ],
+    [
+        "suggestColour",
+        "GET",
+        "/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"],
+    [
+        "resolveAttribute",
+        "GET",
+        "/api/v1/catalog/attributes/resolve",
+        "catalog_resolve_attribute",
+    ],
     [
         "resolveAttributeValue",
         "GET",
         "/api/v1/catalog/attributes/{attributeId}/values/resolve",
         "catalog_resolve_value",
     ],
-    ["searchVocabulary", "GET", "/api/v1/catalog/vocabulary/search", "catalog_vocabulary_search"],
+    [
+        "searchVocabulary",
+        "GET",
+        "/api/v1/catalog/vocabulary/search",
+        "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"],
@@ -45,38 +137,107 @@ const OPERATION_DEFINITIONS = [
     ["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"],
-    ["extractPalette", "POST", "/api/v1/search/palettes/extract", "extract_image_palette"],
-    ["colours.gradient", "POST", "/api/v1/search/gradients", "search_by_gradient"],
-    ["specificationFacets", "GET", "/api/v1/catalog/specifications/facets", "list_spec_facets"],
+    [
+        "extractPalette",
+        "POST",
+        "/api/v1/search/palettes/extract",
+        "extract_image_palette",
+    ],
+    [
+        "colours.gradient",
+        "POST",
+        "/api/v1/search/gradients",
+        "search_by_gradient",
+    ],
+    [
+        "specificationFacets",
+        "GET",
+        "/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"],
+    [
+        "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"],
-    ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"],
-    ["sourceMaterialBatch", "GET", "/api/v1/source-material/{batchId}", "get_source_material_batch"],
+    [
+        "brandColourDeck",
+        "GET",
+        "/api/v1/brands/{brandSlug}/colours",
+        "brand_colour_deck",
+    ],
+    [
+        "uploadSourceMaterial",
+        "POST",
+        "/api/v1/source-material",
+        "upload_source_material",
+    ],
+    [
+        "sourceMaterialBatch",
+        "GET",
+        "/api/v1/source-material/{batchId}",
+        "get_source_material_batch",
+    ],
+    [
+        "sourceMaterialComments",
+        "GET",
+        "/api/v1/source-material/{batchId}/sources/{sourceId}/comments",
+        "list_source_material_comments",
+    ],
+    [
+        "sourceMaterialComments",
+        "POST",
+        "/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"],
-    ["streamRunEvents", "GET", "/api/v1/runs/{runId}/events", "list_public_run_events"],
+    [
+        "runSchedule",
+        "GET",
+        "/api/v1/runs/{runId}/schedule",
+        "get_run_finish_schedule",
+    ],
+    [
+        "streamRunEvents",
+        "GET",
+        "/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"],
+    [
+        "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"],
-    ["codes.requirements", "GET", "/api/v1/codes/requirements", "list_code_requirements"],
+    [
+        "codes.requirements",
+        "GET",
+        "/api/v1/codes/requirements",
+        "list_code_requirements",
+    ],
 ];
 export const SDK_OPERATIONS = Object.freeze(OPERATION_DEFINITIONS.map(([clientMethod, method, path, operationId]) => Object.freeze({ clientMethod, method, path, operationId })));
 /** Look up a registered operation by its OpenAPI `operationId`. */

package/package.json

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

package/palette-search-types.d.ts

@@ -86,6 +86,18 @@ export interface MultiColourMatchBase {
     imageUrl: string | null;
     /** MB has retired or hidden this SKU. */
     retired: boolean;
+    /**
+     * The catalog GROUP — "Flooring", "Textile Materials", "Coatings" — or null
+     * when the material has no accepted primary product type.
+     *
+     * A palette query is cross-category BY INTENT: a designer building a scheme,
+     * not browsing one aisle. So this is the field that says whether a result
+     * answers the question — one real palette returned 30 of 40 results in a
+     * single category while every one of the fourteen groups held something
+     * closer on the same colours (MG-1245). Group by it, and keep null as its own
+     * bucket: null means UNKNOWN, not uncategorised, and it is not rare.
+     */
+    category: string | null;
     /** The candidate's full extracted palette — the evidence scored against. */
     palette: CandidateSwatch[];
     /** The aggregate match score in [0,1]; higher is closer. */
@@ -105,6 +117,23 @@ export interface GradientMatch extends MultiColourMatchBase {
     /** One receipt per sampled point along the path, in path order. */
     samples: ColourMatchReceipt[];
 }
+/**
+ * The hue-family ADMISSION gate the page was scored under: a candidate swatch
+ * may satisfy a query colour only if colorscope's `isHueCompatible` admits it
+ * at these exact thresholds. A refused swatch is absent from that colour's
+ * matching entirely — it did not merely rank low. Admission, not ranking: it
+ * decides which swatches count, never their order. Server-side and fixed (no
+ * request knob); the receipt exists so a threshold change is visible on the
+ * wire.
+ */
+export interface HueGateReceipt {
+    /** Below this query chroma the colour is achromatic and any hue is admitted. */
+    achromaticQueryChroma: number;
+    /** A swatch must carry at least this share of the query colour's chroma. */
+    minChromaRatio: number;
+    /** Floor on the cosine agreement between the two hue vectors. */
+    minHueCosine: number;
+}
 /**
  * A PAGE, NOT A CORPUS. `count` is `matches.length` under `limit` (24 default,
  * 48 max) — this surface states no corpus total and has no cursor, so "N
@@ -120,6 +149,8 @@ export interface SearchPaletteResponse {
         }>;
         logic: PaletteLogic;
     };
+    /** The hue-family admission gate this page was scored under. */
+    hueGate: HueGateReceipt;
     /** `matches.length`, capped by `limit`. Never a corpus total. */
     count: number;
     matches: PaletteMatch[];

package/resolve-client.d.ts

@@ -24,13 +24,19 @@
  * - You want MATERIALS → `mg.search()`. This lens never returns one.
  */
 import type { HttpTransport } from "./http-transport.js";
-import type { ResolveResponse } from "./resolve-types.js";
+import type { ResolvePhrasesScope, ResolveResponse } from "./resolve-types.js";
 import type { VocabularySearchOptions, VocabularySearchResponse } from "./types.js";
 /**
  * THE QUESTION: "I have words — what do they mean in YOUR vocabulary?" Send up
  * to 50 phrases as your users typed them; each comes back with every canonical
  * token MaterialGraph knows it as — brand, exact paint, colour family, category,
- * attribute, value — best first, in request order. Backs `mg.resolve()`.
+ * attribute, value, and the two code axes (jurisdiction, occupancy group) — best
+ * first, in request order. Backs `mg.resolve()`.
+ *
+ * The code axes read out of a sentence: "a maximum security prison in Kansas"
+ * returns `us-ks` and `I-3`, the pair `mg.codeAdvisory()` is keyed on. They are
+ * half a context, not a whole one — that call also wants a space type and a
+ * sprinklered flag, and validates the combination before it answers.
  *
  * A phrase can legitimately mean several things at once ("sage" is two vendor
  * paints AND a colour family), so each entry carries a LIST of readings rather
@@ -54,10 +60,23 @@ import type { VocabularySearchOptions, VocabularySearchResponse } from "./types.
  * complete a name as someone types, and `mg.glossary()` to EXPLAIN a token you
  * have already resolved.
  *
+ * - **Every reading says what stands behind it.** `coverage.variants` is how
+ *   many variants carry it corpus-wide, and `0` is a measured answer rather
+ *   than missing data — a word this vocabulary knows and the catalogue holds
+ *   nothing under. That is the case you would otherwise discover only by making
+ *   a second call, on a hot path, where a second call gets skipped. An ABSENT
+ *   `coverage` means it could not be determined; never read it as none.
+ *
+ * Pass `category` when you are grounding these words for a SLOT, and read
+ * `coverage.inCategory`: a corpus-wide count is not a promise the reading is
+ * reachable inside a given category, and that conflation is what turns a
+ * top-ranked suggestion into an unsatisfiable requirement.
+ *
  * @param phrases 1-50 phrases, each 1-200 characters. Sent as-is; each is
  * resolved independently, so one meaningless phrase never spoils the batch.
+ * @param options `category` to scope the coverage answer, and an `AbortSignal`.
  */
-export declare function resolvePhrasesRequest(transport: HttpTransport, phrases: string[], signal?: AbortSignal): Promise<ResolveResponse>;
+export declare function resolvePhrasesRequest(transport: HttpTransport, phrases: string[], scope?: ResolvePhrasesScope): Promise<ResolveResponse>;
 /**
  * THE QUESTION: "is 'FloorScore' an attribute or a value, and what is it called
  * here?" The catch-all for ONE phrase when you do not know which half of an

package/resolve-client.js

@@ -3,7 +3,13 @@ import { resolveOperation } from "./operations.js";
  * THE QUESTION: "I have words — what do they mean in YOUR vocabulary?" Send up
  * to 50 phrases as your users typed them; each comes back with every canonical
  * token MaterialGraph knows it as — brand, exact paint, colour family, category,
- * attribute, value — best first, in request order. Backs `mg.resolve()`.
+ * attribute, value, and the two code axes (jurisdiction, occupancy group) — best
+ * first, in request order. Backs `mg.resolve()`.
+ *
+ * The code axes read out of a sentence: "a maximum security prison in Kansas"
+ * returns `us-ks` and `I-3`, the pair `mg.codeAdvisory()` is keyed on. They are
+ * half a context, not a whole one — that call also wants a space type and a
+ * sprinklered flag, and validates the combination before it answers.
  *
  * A phrase can legitimately mean several things at once ("sage" is two vendor
  * paints AND a colour family), so each entry carries a LIST of readings rather
@@ -27,13 +33,34 @@ import { resolveOperation } from "./operations.js";
  * complete a name as someone types, and `mg.glossary()` to EXPLAIN a token you
  * have already resolved.
  *
+ * - **Every reading says what stands behind it.** `coverage.variants` is how
+ *   many variants carry it corpus-wide, and `0` is a measured answer rather
+ *   than missing data — a word this vocabulary knows and the catalogue holds
+ *   nothing under. That is the case you would otherwise discover only by making
+ *   a second call, on a hot path, where a second call gets skipped. An ABSENT
+ *   `coverage` means it could not be determined; never read it as none.
+ *
+ * Pass `category` when you are grounding these words for a SLOT, and read
+ * `coverage.inCategory`: a corpus-wide count is not a promise the reading is
+ * reachable inside a given category, and that conflation is what turns a
+ * top-ranked suggestion into an unsatisfiable requirement.
+ *
  * @param phrases 1-50 phrases, each 1-200 characters. Sent as-is; each is
  * resolved independently, so one meaningless phrase never spoils the batch.
+ * @param options `category` to scope the coverage answer, and an `AbortSignal`.
  */
-export function resolvePhrasesRequest(transport, phrases, signal) {
+export function resolvePhrasesRequest(transport, phrases, scope) {
+    // A bare signal is what this took before `category` existed; keep accepting it
+    // so no published call site had to change to gain coverage.
+    const options = scope instanceof AbortSignal ? { signal: scope } : (scope ?? {});
     return transport.requestJson(resolveOperation("resolve_phrases"), {
-        body: { phrases },
-        signal,
+        body: {
+            phrases,
+            ...(options.category === undefined
+                ? {}
+                : { category: options.category }),
+        },
+        signal: options.signal,
     });
 }
 /**

package/resolve-types.d.ts

@@ -27,8 +27,18 @@
  *   pair, for `mg.bySpec()` or `search({ filters })`.
  * - `attribute_value` — a value-dictionary term, namespaced (`ms_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
+ *   endpoints are keyed on. BARE, not namespaced, even though the groups live in
+ *   a value dictionary: `R-1` is the token those endpoints take.
+ *
+ * The two code axes are half a context, not a whole one. `/codes/advisory` also
+ * needs a `spaceType` (or a `roomType` to correlate one from) and a
+ * `sprinklered` flag — neither of which a phrase can state — and it validates
+ * the combination before it answers, so send them and read its verdict rather
+ * than assuming a resolved pair is usable.
  */
-export type ResolutionKind = "brand" | "paint_identity" | "colour" | "category" | "attribute" | "attribute_value";
+export type ResolutionKind = "brand" | "paint_identity" | "colour" | "category" | "attribute" | "attribute_value" | "jurisdiction" | "occupancy_group";
 /**
  * How the phrase matched, strongest first. `exact` — it IS the canonical token;
  * `alias` — it IS a recorded alternative name for it; `lexical` — it resembles
@@ -68,6 +78,49 @@ export interface ResolvedMeaning {
     ambiguity?: {
         gap: number;
     };
+    /**
+     * How much of the catalogue stands behind this reading — so you never have to
+     * make a second, differently-shaped call to find out that a confident answer
+     * is empty.
+     *
+     * ABSENT means coverage could not be determined for this reading; it is a
+     * statement about the MEASUREMENT, never about the catalogue. A measured
+     * nothing is `{ variants: 0 }`. Do not collapse the two: `attribute` and
+     * `attribute_value` readings (and `brand`, whose corpus weight comes free)
+     * carry it; the rest have no equivalently cheap count behind them and report
+     * nothing rather than a figure measured a different way.
+     */
+    coverage?: MeaningCoverage;
+}
+/** How much of the catalogue stands behind one reading. */
+export interface MeaningCoverage {
+    /**
+     * How many variants carry this reading, CORPUS-WIDE and across every brand —
+     * never scoped to the `category` you sent, even when you sent one. `0` is a
+     * measured answer, not missing data: MaterialGraph knows the word and the
+     * catalogue holds nothing under it, which is the case worth catching before
+     * you spend the token on a filter.
+     *
+     * For an `attribute` reading over an ARRAY-valued attribute a variant is
+     * counted once per token it carries, so the figure is an upper bound on
+     * distinct variants there. It is exact for scalar attributes, exact for every
+     * `attribute_value`, and the zero is exact in every case.
+     */
+    variants: number;
+    /**
+     * Whether the `category` you sent holds ANY accepted value for the attribute
+     * behind this reading. Present only when you sent a category AND the answer
+     * could be determined — its absence is a statement about the measurement, not
+     * a `false`.
+     *
+     * `false` means no criterion built on this reading can be satisfied inside
+     * that category at any rung of retrieval's relaxation ladder, however large
+     * `variants` is. Read this rather than inferring reachability from the count:
+     * an attribute with forty thousand values across the catalogue can hold none
+     * at all in Wall Finishes. The probe is ATTRIBUTE-level, so `true` says the
+     * category holds SOME value for the attribute, not that it holds this one.
+     */
+    inCategory?: boolean;
 }
 /** What one phrase resolved to — including, explicitly, nothing. */
 export interface PhraseResolution {
@@ -95,6 +148,22 @@ export interface PhraseResolution {
      */
     unresolved: boolean;
 }
+/** Optional scoping for a resolve call. */
+export interface ResolvePhrasesOptions {
+    /**
+     * The product category you are grounding these words FOR — a slot, not a
+     * filter. It adds {@link MeaningCoverage.inCategory} to every `attribute` and
+     * `attribute_value` reading. Omit for corpus-wide only.
+     */
+    category?: string;
+    signal?: AbortSignal;
+}
+/**
+ * What `mg.resolve()` accepts as its second argument. A bare `AbortSignal` is
+ * still accepted, exactly as before {@link ResolvePhrasesOptions} existed, so no
+ * existing call site had to move.
+ */
+export type ResolvePhrasesScope = AbortSignal | ResolvePhrasesOptions;
 /** The resolve response: one entry per phrase, in the order you sent them. */
 export interface ResolveResponse {
     /** One per phrase, in request order — never reordered, never deduplicated. */

package/run-events.d.ts

@@ -1,3 +1,4 @@
+import type { RunEvent } from "./run-types.js";
 /**
  * Typed payloads for the composition Run event family — the friction fix flagged
  * by the MG-443 walk. These narrow the loose {@link RunEvent.payloadJson} so
@@ -13,7 +14,6 @@
  * as standalone TS types (no cross-package import; the SDK is publishable).
  */
 import type { OpenEnum } from "./types.js";
-import type { RunEvent } from "./run-types.js";
 export declare const COMPOSITION_PHASE_EVENT_TYPES: readonly ["composition.phase", "material-box.phase"];
 export declare const COMPOSITION_PROGRAMME_EVENT_TYPES: readonly ["composition.programme", "material-box.brief"];
 export declare const COMPOSITION_REVIEW_CRITERIA_EVENT_TYPES: readonly ["composition.review-criteria", "material-box.review-criteria"];

package/run-events.js

@@ -1,5 +1,8 @@
 // ── Wire event-type strings (both generations) ───────────────────────────────
-export const COMPOSITION_PHASE_EVENT_TYPES = ["composition.phase", "material-box.phase"];
+export const COMPOSITION_PHASE_EVENT_TYPES = [
+    "composition.phase",
+    "material-box.phase",
+];
 export const COMPOSITION_PROGRAMME_EVENT_TYPES = [
     "composition.programme",
     "material-box.brief",