@instruments/materialgraph 0.29.0 → 0.31.0

package/list-enum-values-types.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @module list-enum-values-types
+ * @description Hand-maintained mirror of `list_enum_values`'s (MG-2225) input
+ * and output wire shapes. The source of truth is
+ * `packages/products/src/materials/list-enum-values.ts`; this SDK has no
+ * runtime dependency on `@materialgraph/products`, so the shapes are copied
+ * here and `contract-parity.test.ts` keeps them honest.
+ */
+import type { OpenEnum } from "./types.js";
+/** Options for `listEnumValues()` (GET `/api/v1/catalog/enum-values`). */
+export type ListEnumValuesOptions = {
+    /**
+     * A value dictionary id, from a `listAttributes()` item's `dictionaryId`.
+     * Required without a `query`; with a `query`, omit it to search every
+     * dictionary.
+     */
+    dictionaryId?: string;
+    /** A value name, alias, misspelling or meaning. Omit to browse a dictionary. */
+    query?: string;
+    /** Items per page, 1 to 50. Default 20. */
+    limit?: number;
+    /** `pageInfo.endCursor` from the previous page, with the same query and dictionary. */
+    cursor?: string;
+};
+/** How an item was found. A distance or similarity compares only within one method. */
+export type EnumValueMatch = {
+    method: OpenEnum<"exact" | "alias" | "fuzzy" | "vector">;
+    /** The id, label or alias that matched, or null for a match by meaning. */
+    matchedText: string | null;
+    /** Fuse distance, 0 best. */
+    distance?: number;
+    /** Set when the query named a deprecated term: the active term it was resolved from. */
+    resolvedFrom?: string;
+    /** Cosine similarity, 1 best. */
+    similarity?: number;
+};
+/** One allowed value of a dictionary. */
+export type EnumValueItem = {
+    /** The attributes this value can filter `listVariants()` on; empty when it cannot be filtered on. */
+    attributeIds: string[];
+    /** The taxonomy's definition when the value resolves to a canonical concept, otherwise null. */
+    definition: string | null;
+    dictionaryId: string;
+    label: string;
+    /** Present only when the page answers a query. */
+    match?: EnumValueMatch;
+    /** The bare term id `listVariants()` accepts for any of `attributeIds`. */
+    valueId: string;
+};
+export type ListEnumValuesResult = {
+    /** The dictionary the page was read from; null when a query searched every dictionary. */
+    dictionaryId: string | null;
+    items: EnumValueItem[];
+    pageInfo: {
+        endCursor: string | null;
+        hasNextPage: boolean;
+    };
+};

package/list-variants-types.d.ts

@@ -107,14 +107,14 @@ export type ListVariantsNotApplicable = {
 };
 /**
  * One list item: the compact identity needed to pick a variant, with image
- * and maker page only when requested (`include`) and selected attributes
+ * and brand page only when requested (`include`) and selected attributes
  * under `specifications`. Leaner than `get_variant`'s item on purpose.
  */
 export type ListVariantsItem = {
     category: string;
     code: string | null;
     image?: string | null;
-    maker: {
+    brand: {
         id: string;
         name: string;
     };
@@ -137,6 +137,8 @@ export type ListVariantsItem = {
     variantId: string;
 };
 export type ListVariantsOutput = {
+    /** Explicit `{field: "variant", op: "in"}` ids that name a real variant outside the materials catalogue. Present only when at least one did. */
+    excludedByCorpusScope?: string[];
     items: ListVariantsItem[];
     pageInfo: {
         endCursor: string | null;
@@ -146,4 +148,6 @@ export type ListVariantsOutput = {
     preferenceMatchesRemain?: boolean;
     /** Explicit `{field: "variant", op: "in"}` ids anywhere in `filters.terms` that did not resolve to an eligible variant in the requested `corpusScope`. */
     unresolvedVariantIds?: string[];
+    /** Filtered attributes no variant in scope states at all. Present only on an empty first page, so its absence means the empty page is a genuine no-match. */
+    unstated?: string[];
 };

package/material-asset-types.d.ts

@@ -12,7 +12,7 @@ import type { VariantId } from "./identifiers.js";
 import type { OpenEnum } from "./types.js";
 /**
  * `available`: MaterialGraph serves the file at `url`. `unknown`: `url` is the
- * maker's own link, unchecked. `unavailable`: no working copy is known and
+ * brand's own link, unchecked. `unavailable`: no working copy is known and
  * `url` is null.
  */
 export type VariantAssetAvailability = OpenEnum<"available" | "unknown" | "unavailable">;
@@ -51,7 +51,7 @@ export type VariantAssetItem = {
     /** Images only; absent when unknown. */
     width?: number;
 };
-/** Whether the maker's document source was read for this variant. Absent when documents are filtered out. */
+/** Whether the brand's document source was read for this variant. Absent when documents are filtered out. */
 export type VariantDocumentCoverageState = OpenEnum<"available" | "none_declared" | "not_ingested" | "unavailable_source" | "dead_link" | "failed_ingest">;
 export type VariantAssetPageInfo = {
     nextCursor: string | null;

package/material-types.d.ts

@@ -1,7 +1,7 @@
-import type { ProductId, VariantId } from "./identifiers.js";
+import type { VariantId } from "./identifiers.js";
 /**
- * Hand-mirrored wire types for the material projections — the grid-card tile,
- * the detail record, and the availability/successor block they carry.
+ * Hand-mirrored wire types for the material projections — the grid-card tile
+ * and the availability it carries.
  *
  * Extracted from `./types.ts` (which re-exports everything here) so that module
  * stays within the repository's source-size budget. Same contract, same
@@ -9,20 +9,15 @@ import type { ProductId, VariantId } from "./identifiers.js";
  * widened — a new server state still type-checks.
  *
  * ABSENT IS NOT FALSE, and it is the rule this whole file hangs on. A material
- * record reports what the graph HOLDS, never what is true of the object in the
- * world. `null` and a missing key both mean UNKNOWN:
- *  - `dimensions: null` does not mean the material has no dimensions.
- *  - `supersededBy: null` does not mean the product is current.
- *  - a `facets` array without an attribute does not mean the material lacks that
- *    property — it means nobody has recorded one.
- *  - most dangerously, no boolean here may be inverted from an absence. Never
- *    render "not certified" / "no fire rating" from a missing entry; render
- *    "not on record".
+ * projection reports what the graph HOLDS, never what is true of the object in
+ * the world. `null` and a missing key both mean UNKNOWN, and no boolean here may
+ * be inverted from an absence: never render "not certified" / "no fire rating"
+ * from a missing entry; render "not on record".
  * Read {@link MaterialBlockProjection} when you need to tell "we looked and
  * there is none" apart from "nobody has looked" — that is the only projection
  * that says which.
  */
-import type { ImageSource, MaterialColour, OpenEnum, PaletteSwatch } from "./types.js";
+import type { ImageSource, MaterialColour, OpenEnum } from "./types.js";
 /**
  * Whether a material can still be bought.
  *
@@ -31,30 +26,13 @@ import type { ImageSource, MaterialColour, OpenEnum, PaletteSwatch } from "./typ
  *    listing state, not a reviewed manufacturer-discontinuation claim; do not
  *    present it as the manufacturer having discontinued the product.
  *  - `superseded` — a reviewed product relationship names a successor and the
- *    material is no longer listed. See `MaterialDetail.supersededBy`.
+ *    material is no longer listed.
  *  - `unknown` — never checked. A real answer, not an error.
  */
 export type MaterialAvailability = OpenEnum<"available" | "discontinued" | "superseded" | "unknown">;
 /**
- * The variant a reviewed product relationship names as replacing another.
- * `availability` is the successor's OWN state, resolved ONE HOP only — a
- * successor that has itself been superseded reports `discontinued`/`unknown`
- * here; follow `variantId` for the next link in the chain.
- */
-export type MaterialSuccessor = {
-    /** Opaque — round-trip verbatim to read the successor. */
-    variantId: VariantId;
-    brandSlug: string;
-    productId: ProductId;
-    brand: string;
-    product: string;
-    variant: string;
-    color: string | null;
-    availability: MaterialAvailability;
-};
-/**
- * The grid-card projection of a material. Tiles carry `availability` but not the
- * successor record — read the detail projection for that.
+ * The grid-card projection of a material. Tiles carry `availability` but not a
+ * successor record.
  */
 export type MaterialTile = {
     /** Accepted sampleability fact. Absent means unknown, never false. */
@@ -78,26 +56,8 @@ export type MaterialTile = {
      */
     colourName?: string;
 };
-/**
- * A canonical attribute/term pair carried on a detail record.
- *
- * `attributeId` and `term` are canonical VOCABULARY, not opaque ids — the same
- * tokens `bySpec` / `search({ filters })` accept, discoverable through
- * `specificationFacets()` and `attributeValues()`. An attribute absent from
- * `facets` is unrecorded, never known-false.
- */
-export type MaterialFacet = {
-    attributeId: string;
-    term: string;
-    /**
-     * Whether this value identifies the variant or specifies its performance /
-     * composition. Present on current responses; optional for captured older
-     * payloads. Only `specification` facets are valid inputs to `bySpec`.
-     */
-    role?: "identity" | "specification";
-};
 /** A retained product-type proposal. It is review evidence, never a category. */
-export type ProposedProductType = {
+type ProposedProductType = {
     id: string;
     displayName: string;
     confidence: number | null;
@@ -111,102 +71,4 @@ export type ProductTypeReceipt = {
     state: "accepted" | "proposed" | "unknown";
     proposedProductTypes: ProposedProductType[];
 };
-/**
- * One dimensional configuration of a material. Numeric fields are millimetres
- * (mass in kilograms); string fields are the source's own descriptors. The
- * index signature preserves the corpus's long tail of rarer keys.
- */
-export interface DimensionEntry {
-    label?: string;
-    tile_size?: string;
-    measurement_basis?: string;
-    width_mm?: number;
-    length_mm?: number;
-    height_mm?: number;
-    depth_mm?: number;
-    thickness_mm?: number;
-    diameter_mm?: number;
-    visible_projection_mm?: number;
-    weight_kg?: number;
-    [key: string]: unknown;
-}
-/**
- * The record projection of a material — the tile plus detail-only fields.
- *
- * The deepest read of ONE material, and still not an assertion about the object:
- * every `| null` below is UNKNOWN, not "none". See the module docblock.
- */
-export interface MaterialDetail extends MaterialTile {
-    brandSlug: string;
-    /** Opaque — the product family; siblings share it. */
-    productId: ProductId;
-    color: string | null;
-    /** The variant's Material Bank SKU. Null means none is recorded, not unknown. */
-    materialBankId: string | null;
-    /**
-     * The manufacturer's own item code from `variants.code`, the same key search
-     * results carry. ABSENT means no code is recorded, never an invented one.
-     */
-    manufacturerCode?: string;
-    /**
-     * Explicit source-governed permission to save this exact source-coded variant
-     * to a Project. Absent means unknown/not allowed; never infer it from identity.
-     */
-    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;
-    productTypeReceipt: ProductTypeReceipt;
-    categoryPath: string[];
-    /** Durable state of image-colour extraction and its variant projection. */
-    colourEvidence: {
-        status: "no_eligible_asset";
-    } | {
-        status: "extractor_not_run";
-        origin: {
-            assetId: string;
-            method: "colorscope_primary_image";
-        };
-    } | {
-        status: "available";
-        basis: "palette" | "palette_and_dominant_oklab" | "dominant_oklab";
-        extractedAt: string;
-        extractionVersion: string | null;
-        origin: {
-            assetId: string;
-            method: "colorscope_primary_image";
-        };
-    } | {
-        status: "projection_missing";
-        extractedAt: string;
-        extractionVersion: string | null;
-        origin: {
-            assetId: string;
-            method: "colorscope_primary_image";
-        };
-    } | {
-        status: "genuinely_colourless";
-        extractedAt: string;
-        extractionVersion: string | null;
-        origin: {
-            assetId: string;
-            method: "colorscope_primary_image";
-        };
-    };
-    /** Extracted from imagery — visual likeness, never a declared colour spec. */
-    palette: PaletteSwatch[];
-    /** What is ON RECORD. An absent attribute is unrecorded, never known-false. */
-    facets: MaterialFacet[];
-    /** `null` = no dimensions recorded, NOT a dimensionless material. */
-    dimensions: DimensionEntry[] | null;
-    /**
-     * The declared successor, or null when NO REVIEWED RELATIONSHIP NAMES ONE —
-     * which is not the same as "this product is current". Read `availability` for
-     * that, and even then `unknown` is a real answer.
-     */
-    supersededBy: MaterialSuccessor | null;
-}
+export {};

package/operations.d.ts

@@ -1,5 +1,5 @@
 export declare const MATERIALGRAPH_API_VERSION = "0.7.0";
-declare const OPERATION_DEFINITIONS: readonly [readonly ["samplizeColorVecCache", "GET", "/api/v1/catalogues/samplize/colorvec", "samplize_colorvec_cache"], readonly ["samplizeCatalogueSearch", "POST", "/api/v1/catalogues/samplize/search", "samplize_catalogue_search"], readonly ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"], readonly ["catalogPages", "GET", "/api/v1/catalogs/{catalogId}/pages", "list_catalog_pages"], readonly ["catalogPageRepresentation", "GET", "/api/v1/catalog-pages/{pageId}/representation", "get_catalog_page_representation"], readonly ["catalogReferences", "GET", "/api/v1/catalogs/{catalogId}/references", "list_catalog_product_references"], readonly ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["identify", "POST", "/api/v1/identify", "retrieval.identify"], readonly ["match", "POST", "/api/v1/search/match", "match_material"], readonly ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"], readonly ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"], readonly ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], readonly ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], readonly ["searchGet", "GET", "/api/v1/search", "search_materials_get"], readonly ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"], readonly ["material", "GET", "/api/v1/materials/{variantId}", "get_material"], readonly ["catalogueReferences", "POST", "/api/v1/catalogues/references", "get_catalogue_references_batch"], readonly ["catalogueCollections", "GET", "/api/v1/catalogues/collections", "list_catalogue_channel_collections"], readonly ["catalogueDocumentAccess", "GET", "/api/v1/catalogues/documents/{documentId}", "get_catalogue_document_access"], readonly ["materialBlocks", "GET", "/api/v1/materials/{variantId}/blocks", "list_material_blocks"], readonly ["listVariantAssets", "GET", "/api/v1/variants/{variantId}/assets", "list_variant_assets"], readonly ["materialDocuments", "GET", "/api/v1/materials/{variantId}/documents", "list_material_documents"], readonly ["compositionReport", "GET", "/api/v1/composition/report", "get_composition_report"], readonly ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"], readonly ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"], readonly ["schema", "GET", "/api/v1/schema/verticals", "list_schema_verticals"], readonly ["schema", "GET", "/api/v1/schema/product-types", "list_schema_product_types"], readonly ["schema", "GET", "/api/v1/schema/units", "list_schema_units"], readonly ["schema", "GET", "/api/v1/schema/value-dictionaries", "list_schema_value_dictionaries"], readonly ["schema", "GET", "/api/v1/schema/source-requirements", "list_schema_source_requirements"], readonly ["schema", "GET", "/api/v1/schema/product-type-templates", "list_schema_product_type_templates"], readonly ["schema", "GET", "/api/v1/schema/mappings", "list_schema_mappings"], readonly ["pairings", "GET", "/api/v1/materials/{variantId}/pairings", "get_material_pairings"], readonly ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], readonly ["applicability", "GET", "/api/v1/applicability", "get_applicability"], readonly ["listVariants", "GET", "/api/v1/variants", "list_variants"], readonly ["listVariantFacets", "POST", "/api/v1/variants/facets", "list_variant_facets"], readonly ["colours.profiles", "GET", "/api/v1/colours/profiles", "get_category_colour_profiles"], readonly ["resolveColour", "GET", "/api/v1/search/colours/resolve", "resolve_colour_name"], readonly ["suggestColour", "GET", "/api/v1/search/colours/suggest", "suggest_colour_names"], readonly ["listAttributes", "GET", "/api/v1/catalog/attributes", "catalog_list_attributes"], readonly ["categories.list", "GET", "/api/v1/categories", "list_categories"], readonly ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"], readonly ["productTypeCoverage", "GET", "/api/v1/taxonomy/coverage", "get_product_type_status_coverage"], readonly ["whoami", "GET", "/api/v1/whoami", "whoami"], readonly ["demand", "GET", "/api/v1/demand", "get_material_demand"], readonly ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"], readonly ["extractPalette", "POST", "/api/v1/search/palettes/extract", "extract_image_palette"], readonly ["colours.gradient", "POST", "/api/v1/search/gradients", "search_by_gradient"], readonly ["specificationFacets", "GET", "/api/v1/catalog/specifications/facets", "list_spec_facets"], readonly ["brands", "GET", "/api/v1/brands", "list_brands"], readonly ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"], readonly ["sourceMaterialBatch", "GET", "/api/v1/source-material/{batchId}", "get_source_material_batch"], readonly ["sourceMaterialComments.list", "GET", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "list_source_material_comments"], readonly ["sourceMaterialComments.post", "POST", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "post_source_material_comment"], readonly ["createRun", "POST", "/api/v1/runs", "create_public_run"], readonly ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"], readonly ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"], readonly ["streamRunEvents", "GET", "/api/v1/runs/{runId}/events", "list_public_run_events"], readonly ["demandBatch", "POST", "/api/v1/demand/batch", "get_demand_batch"], readonly ["codeAdvisory", "POST", "/api/v1/codes/advisory", "resolveCodeAdvisory"], readonly ["codes.context", "GET", "/api/v1/codes/context", "list_code_context"], readonly ["codes.requirements", "GET", "/api/v1/codes/requirements", "list_code_requirements"]];
+declare const OPERATION_DEFINITIONS: readonly [readonly ["samplizeColorVecCache", "GET", "/api/v1/catalogues/samplize/colorvec", "samplize_colorvec_cache"], readonly ["samplizeCatalogueSearch", "POST", "/api/v1/catalogues/samplize/search", "samplize_catalogue_search"], readonly ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"], readonly ["catalogPages", "GET", "/api/v1/catalogs/{catalogId}/pages", "list_catalog_pages"], readonly ["catalogPageRepresentation", "GET", "/api/v1/catalog-pages/{pageId}/representation", "get_catalog_page_representation"], readonly ["catalogReferences", "GET", "/api/v1/catalogs/{catalogId}/references", "list_catalog_product_references"], readonly ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["match", "POST", "/api/v1/search/match", "match_material"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], readonly ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], readonly ["searchGet", "GET", "/api/v1/search", "search_materials_get"], readonly ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"], readonly ["catalogueReferences", "POST", "/api/v1/catalogues/references", "get_catalogue_references_batch"], readonly ["catalogueCollections", "GET", "/api/v1/catalogues/collections", "list_catalogue_channel_collections"], readonly ["catalogueDocumentAccess", "GET", "/api/v1/catalogues/documents/{documentId}", "get_catalogue_document_access"], readonly ["materialBlocks", "GET", "/api/v1/materials/{variantId}/blocks", "list_material_blocks"], readonly ["listVariantAssets", "GET", "/api/v1/variants/{variantId}/assets", "list_variant_assets"], readonly ["materialDocuments", "GET", "/api/v1/materials/{variantId}/documents", "list_material_documents"], readonly ["schema", "GET", "/api/v1/schema/value-dictionaries", "list_schema_value_dictionaries"], readonly ["pairings", "GET", "/api/v1/materials/{variantId}/pairings", "get_material_pairings"], readonly ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], readonly ["applicability", "GET", "/api/v1/applicability", "get_applicability"], readonly ["listVariants", "GET", "/api/v1/variants", "list_variants"], readonly ["listVariantFacets", "POST", "/api/v1/variants/facets", "list_variant_facets"], readonly ["findVariantsByColour", "POST", "/api/v1/variants/by-colour", "find_variants_by_colour"], readonly ["findVariantsByVector", "POST", "/api/v1/variants/by-vector", "find_variants_by_vector"], readonly ["findCompanions", "POST", "/api/v1/variants/companions", "find_companions"], readonly ["resolveVariant", "POST", "/api/v1/variants/resolve", "resolve_variant"], readonly ["getVariant", "GET", "/api/v1/variants/{variantId}", "get_variant"], readonly ["resolveColour", "GET", "/api/v1/search/colours/resolve", "resolve_colour_name"], readonly ["listAttributes", "GET", "/api/v1/catalog/attributes", "catalog_list_attributes"], readonly ["listEnumValues", "GET", "/api/v1/catalog/enum-values", "catalog_list_enum_values"], readonly ["categories.list", "GET", "/api/v1/categories", "list_categories"], readonly ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"], readonly ["whoami", "GET", "/api/v1/whoami", "whoami"], readonly ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"], readonly ["extractPalette", "POST", "/api/v1/search/palettes/extract", "extract_image_palette"], readonly ["brands", "GET", "/api/v1/brands", "list_brands"], readonly ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"], readonly ["workflows.start", "POST", "/api/v1/workflows/{workflowId}/runs", "create_public_run"], readonly ["workflows.run", "GET", "/api/v1/workflows/{workflowId}/runs/{runId}", "get_public_run"], readonly ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"], readonly ["workflows.streamRunEvents", "GET", "/api/v1/workflows/{workflowId}/runs/{runId}/events", "list_public_run_events"]];
 export type SdkOperationId = (typeof OPERATION_DEFINITIONS)[number][3];
 export type SdkOperation = Readonly<{
     clientMethod: (typeof OPERATION_DEFINITIONS)[number][0];

package/operations.js

@@ -33,11 +33,7 @@ const OPERATION_DEFINITIONS = [
         "list_catalog_product_references",
     ],
     ["search", "POST", "/api/v1/search", "search_materials_post"],
-    ["identify", "POST", "/api/v1/identify", "retrieval.identify"],
     ["match", "POST", "/api/v1/search/match", "match_material"],
-    ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"],
-    ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"],
-    ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"],
     ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"],
     [
         "samplizeCatalogue",
@@ -47,7 +43,6 @@ const OPERATION_DEFINITIONS = [
     ],
     ["searchGet", "GET", "/api/v1/search", "search_materials_get"],
     ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"],
-    ["material", "GET", "/api/v1/materials/{variantId}", "get_material"],
     [
         "catalogueReferences",
         "POST",
@@ -84,41 +79,12 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/materials/{variantId}/documents",
         "list_material_documents",
     ],
-    [
-        "compositionReport",
-        "GET",
-        "/api/v1/composition/report",
-        "get_composition_report",
-    ],
-    ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"],
-    ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"],
-    ["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/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/mappings", "list_schema_mappings"],
     [
         "pairings",
         "GET",
@@ -146,39 +112,41 @@ const OPERATION_DEFINITIONS = [
         "list_variant_facets",
     ],
     [
-        "colours.profiles",
-        "GET",
-        "/api/v1/colours/profiles",
-        "get_category_colour_profiles",
+        "findVariantsByColour",
+        "POST",
+        "/api/v1/variants/by-colour",
+        "find_variants_by_colour",
     ],
+    [
+        "findVariantsByVector",
+        "POST",
+        "/api/v1/variants/by-vector",
+        "find_variants_by_vector",
+    ],
+    ["findCompanions", "POST", "/api/v1/variants/companions", "find_companions"],
+    ["resolveVariant", "POST", "/api/v1/variants/resolve", "resolve_variant"],
+    ["getVariant", "GET", "/api/v1/variants/{variantId}", "get_variant"],
     [
         "resolveColour",
         "GET",
         "/api/v1/search/colours/resolve",
         "resolve_colour_name",
     ],
-    [
-        "suggestColour",
-        "GET",
-        "/api/v1/search/colours/suggest",
-        "suggest_colour_names",
-    ],
     [
         "listAttributes",
         "GET",
         "/api/v1/catalog/attributes",
         "catalog_list_attributes",
     ],
-    ["categories.list", "GET", "/api/v1/categories", "list_categories"],
-    ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"],
     [
-        "productTypeCoverage",
+        "listEnumValues",
         "GET",
-        "/api/v1/taxonomy/coverage",
-        "get_product_type_status_coverage",
+        "/api/v1/catalog/enum-values",
+        "catalog_list_enum_values",
     ],
+    ["categories.list", "GET", "/api/v1/categories", "list_categories"],
+    ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"],
     ["whoami", "GET", "/api/v1/whoami", "whoami"],
-    ["demand", "GET", "/api/v1/demand", "get_material_demand"],
     ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"],
     [
         "extractPalette",
@@ -186,18 +154,6 @@ const OPERATION_DEFINITIONS = [
         "/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",
-    ],
     ["brands", "GET", "/api/v1/brands", "list_brands"],
     [
         "uploadSourceMaterial",
@@ -206,41 +162,24 @@ const OPERATION_DEFINITIONS = [
         "upload_source_material",
     ],
     [
-        "sourceMaterialBatch",
-        "GET",
-        "/api/v1/source-material/{batchId}",
-        "get_source_material_batch",
+        "workflows.start",
+        "POST",
+        "/api/v1/workflows/{workflowId}/runs",
+        "create_public_run",
     ],
     [
-        "sourceMaterialComments.list",
+        "workflows.run",
         "GET",
-        "/api/v1/source-material/{batchId}/sources/{sourceId}/comments",
-        "list_source_material_comments",
-    ],
-    [
-        "sourceMaterialComments.post",
-        "POST",
-        "/api/v1/source-material/{batchId}/sources/{sourceId}/comments",
-        "post_source_material_comment",
+        "/api/v1/workflows/{workflowId}/runs/{runId}",
+        "get_public_run",
     ],
-    ["createRun", "POST", "/api/v1/runs", "create_public_run"],
-    ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"],
     ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"],
     [
-        "streamRunEvents",
+        "workflows.streamRunEvents",
         "GET",
-        "/api/v1/runs/{runId}/events",
+        "/api/v1/workflows/{workflowId}/runs/{runId}/events",
         "list_public_run_events",
     ],
-    ["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",
-    ],
 ];
 export const SDK_OPERATIONS = Object.freeze(OPERATION_DEFINITIONS.map(([clientMethod, method, path, operationId]) => Object.freeze({ clientMethod, method, operationId, path })));
 /** Look up a registered operation by its OpenAPI `operationId`. */

package/package.json

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

package/palette-search-types.d.ts

@@ -1,17 +1,14 @@
 import type { ColourCategoryGate } from "./by-colour-types.js";
 import type { CorpusScope, CorpusScopeReceipt } from "./corpus-scope-types.js";
 /**
- * Wire types for MULTI-COLOUR search — `POST /api/v1/search/palettes` and
- * `POST /api/v1/search/gradients`.
+ * Wire types for MULTI-COLOUR search — `POST /api/v1/search/palettes`.
  *
- * Kept out of `types.ts` for the same reason `colour-aggregate-types.ts` and
- * `codes-types.ts` are: the shared mirror is at its source-size budget. Same
+ * Kept out of `types.ts` for the repository's source-file size budget. Same
  * tolerant-parsing contract as the rest of the mirror — response enums are
  * widened so a new server value still type-checks.
  *
  * The MATCH SEMANTICS these types carry are the server's, stated on
- * {@link SearchPaletteInput.logic} and {@link GradientMatch.coverage} rather
- * than left to the endpoint docs.
+ * {@link SearchPaletteInput.logic} rather than left to the endpoint docs.
  */
 import type { VariantId } from "./identifiers.js";
 import type { OklabTriple, OpenEnum } from "./types.js";
@@ -30,11 +27,6 @@ export type PaletteQueryColour = {
     /** Relative importance. Not applied: a palette is ordered by its first colour. */
     weight?: number;
 };
-/** One gradient stop — exactly one of `hex` or `oklab`. Order is meaningful. */
-export type GradientStop = {
-    hex?: string;
-    oklab?: OklabTriple;
-};
 export type SearchPaletteInput = {
     /**
      * HARD category filter: category-group or product-type names or keys.
@@ -57,19 +49,6 @@ export type SearchPaletteInput = {
     /** Results to return; defaults to 24, capped at 48. */
     limit?: number;
 };
-export type SearchGradientInput = {
-    /**
-     * HARD category filter: category-group or product-type names or keys.
-     * Absent, the page holds surface materials only, so lights, taps and
-     * furniture are left out.
-     */
-    category?: string[];
-    corpusScope?: CorpusScope;
-    /** The ordered colour transition, 2–6 stops. */
-    stops: GradientStop[];
-    /** Results to return; defaults to 24, capped at 48. */
-    limit?: number;
-};
 /**
  * One swatch used for scoring. Samplize paint uses its selected published hex;
  * other materials use colorscope palettes extracted from imagery. `name` is null when no human
@@ -143,15 +122,6 @@ export type PaletteMatch = {
     /** One receipt per queried colour, in query order. */
     colours: ColourMatchReceipt[];
 } & MultiColourMatchBase;
-export type GradientMatch = {
-    /**
-     * Thirds of the path where the material holds a swatch near a sampled point,
-     * over 3. A receipt beside the order, which is by the first stop.
-     */
-    coverage: number;
-    /** One receipt per sampled point along the path, in path order. */
-    samples: ColourMatchReceipt[];
-} & MultiColourMatchBase;
 /**
  * The thresholds behind every receipt's `hueCompatible`: the exact values
  * passed to colorscope's `isHueCompatible`, fixed server-side with no request
@@ -199,19 +169,3 @@ export type SearchPaletteResponse = {
     count: number;
     matches: PaletteMatch[];
 };
-/** A PAGE, NOT A CORPUS — see {@link SearchPaletteResponse}. */
-export type SearchGradientResponse = {
-    /** The category gate the page ran under. */
-    categoryGate?: ColourCategoryGate;
-    corpusScope?: CorpusScopeReceipt;
-    query: {
-        stops: string[];
-        /** The sampled path points the search actually ran against. */
-        samples: string[];
-    };
-    /** The thresholds behind each sample receipt's `hueCompatible`. */
-    hueGate?: HueGateReceipt;
-    /** `matches.length`, capped by `limit`. Never a corpus total. */
-    count: number;
-    matches: GradientMatch[];
-};