@instruments/materialgraph 0.26.0 → 0.27.0

package/material-query-plan-types.d.ts

@@ -1,154 +1,70 @@
 /** Hand-mirrored wire types for `POST /api/v1/search/plan`. */
-import type { QuerySense } from "./query-understanding-types.js";
-import type { ResolvedMeaning } from "./resolve-types.js";
-import type { SearchInput } from "./search-request-types.js";
 import type { OpenEnum } from "./types.js";
-export type MaterialQueryVocabularyKind = OpenEnum<"attribute" | "dictionary_term" | "inline_enum" | "product_type" | "product_type_group">;
-export type MaterialQuerySpan = {
-    start: number;
-    end: number;
-    text: string;
-};
-export type MaterialQueryOwner = {
+/** One wanted value: hard filters the page, soft only orders it. */
+export type MaterialQueryWant = {
     attributeId: string;
-    attributeName: string;
-};
-export type MaterialQueryLifecycle = {
-    status: string;
-    introducedIn?: string;
-    deprecatedIn?: string;
-    supersededBy?: string;
+    terms: string[];
+    phrase: string;
+    strength: OpenEnum<"hard" | "soft">;
+    fill: number;
 };
-export type MaterialQueryOntologyContext = {
-    description: string;
-    valueKind: string;
-    valueDictionaryId?: string;
-} | {
-    dictionaryId: string;
-    dictionaryName: string;
-    owningAttributes: {
-        id: string;
-        name: string;
-    }[];
-    lifecycle: MaterialQueryLifecycle;
-} | {
+export type MaterialQueryExclusion = {
     attributeId: string;
-    attributeName: string;
-} | {
-    description: string;
-    lifecycle: MaterialQueryLifecycle;
-    parentProductTypeGroupId?: string;
-} | {
-    description: string;
-};
-export type MaterialQueryApplicability = {
-    status: OpenEnum<"all" | "some" | "none" | "unknown">;
-    categoryId?: string;
-    productTypeIds: string[];
-    applicableProductTypeIds: string[];
+    term: string;
+    phrase: string;
 };
-export type MaterialQueryCoverage = {
-    variants: number;
-    basis: OpenEnum<"facet_index">;
-    scope: OpenEnum<"corpus">;
-};
-export type MaterialQueryReachability = {
-    status: OpenEnum<"positive" | "zero" | "unknown">;
-    categoryId: string;
-    basis: OpenEnum<"bounded_probe" | "unmeasured">;
-};
-export type MaterialQueryCandidate = {
-    kind: MaterialQueryVocabularyKind;
-    subjectType: MaterialQueryVocabularyKind;
-    subjectId: string;
-    label: string;
-    context: MaterialQueryOntologyContext;
-    score: number;
-    tier: OpenEnum<"exact_id" | "exact_alias" | "lexical" | "semantic">;
-    evidence: {
-        source: OpenEnum<"registry" | "query_domain_embedding">;
-        span: MaterialQuerySpan;
-    };
-    outcome: OpenEnum<"recognized" | "suggested" | "executable" | "ambiguous" | "refused">;
-    owners: MaterialQueryOwner[];
-    selectedOwner?: MaterialQueryOwner;
-    applicability?: MaterialQueryApplicability;
-    coverage?: MaterialQueryCoverage;
-    reachability?: MaterialQueryReachability;
-    reason?: string;
+/** The dictionary reading of one query, as the index search runs it. */
+export type MaterialQueryReading = {
+    normalised: string;
+    category: {
+        productTypeIds: string[];
+        label: string;
+        phrase: string;
+    } | null;
+    brands: {
+        ids: string[];
+        names: string[];
+        phrase: string;
+    } | null;
+    wants: MaterialQueryWant[];
+    excludes: MaterialQueryExclusion[];
+    excludeBrands: string[];
+    colour: {
+        phrase: string;
+        familyId: string;
+        hex: string;
+        oklab: [number, number, number];
+        family12: string[];
+    } | null;
+    vendorColourNames: string[];
+    leftover: string[];
+    softAlone: boolean;
 };
-export type MaterialQueryCriterion = {
-    source: {
-        subjectType: MaterialQueryVocabularyKind;
-        subjectId: string;
-        span: MaterialQuerySpan;
-    };
-    attribute: {
-        id: string;
-        name: string;
-    };
-    ownerAlternatives: MaterialQueryOwner[];
-    operator: OpenEnum<"term" | "presence" | "numeric_range">;
-    term?: string;
-    min?: number;
-    max?: number;
-    coverage: MaterialQueryCoverage;
-    applicability: MaterialQueryApplicability;
-    reachability?: MaterialQueryReachability;
+/** Present when a word no material carries was corrected: showing results for `to`. */
+export type MaterialQueryCorrection = {
+    from: string;
+    to: string;
+    words: {
+        word: string;
+        correction: string;
+    }[];
 };
-export type MaterialQueryStandardMeaning = ResolvedMeaning | QuerySense;
-export type MaterialQueryAmbiguityAlternative = (MaterialQueryOwner & {
-    kind: OpenEnum<"owner">;
-}) | {
-    kind: OpenEnum<"subject">;
-    subjectType: MaterialQueryVocabularyKind;
-    subjectId: string;
-    label: string;
-} | {
-    kind: OpenEnum<"standard_meaning">;
-    meaning: MaterialQueryStandardMeaning;
+/** One search over the index. */
+export type MaterialSearchRequest = {
+    text: string;
+    view?: OpenEnum<"card" | "full">;
+    limit?: number;
+    cursor?: string;
 };
 export type MaterialQueryPlan = {
-    version: OpenEnum<"1">;
-    verdict: OpenEnum<"executable" | "partial" | "refused">;
+    version: OpenEnum<"2">;
     rawQuery: string;
     normalisedQuery: string;
-    registry: {
-        corpusSize: number;
-        contentHash: string;
-    };
-    candidates: MaterialQueryCandidate[];
-    category: {
-        key: string;
-        name: string;
-        level: OpenEnum<"group" | "type">;
-        parentKey: string | null;
-        source: {
-            subjectType: MaterialQueryVocabularyKind;
-            subjectId: string;
-            span: MaterialQuerySpan;
-        };
-    } | null;
-    criteria: MaterialQueryCriterion[];
-    colour: {
-        family?: string;
-        undertone?: string;
-    } | null;
-    residualText: string;
-    unspentSpans: (MaterialQuerySpan & {
-        reason: OpenEnum<"residual" | "ambiguous" | "refused">;
-    })[];
-    ambiguities: {
-        subjectType: MaterialQueryVocabularyKind;
-        subjectId: string;
-        span: MaterialQuerySpan;
-        reason: string;
-        alternatives: MaterialQueryAmbiguityAlternative[];
-    }[];
-    standardMeanings: {
-        span: MaterialQuerySpan;
-        meanings: MaterialQueryStandardMeaning[];
-    }[];
-    /** Complete ordinary-search requests authored by MaterialGraph. Execute verbatim. */
-    requests: SearchInput[];
+    readingVersion: string;
+    source: OpenEnum<"dictionary" | "jev">;
+    cached: boolean;
+    plan: MaterialQueryReading;
+    correction: MaterialQueryCorrection | null;
+    /** The one search to run, in the phrasing that was read. */
+    requests: MaterialSearchRequest[];
 };

package/material-resources-client.d.ts

@@ -1,15 +1,17 @@
-/** Material blocks, safe assets, and technical documents over one shared transport. */
+/** Material blocks, a variant's assets, and technical documents over one shared transport. */
 import type { HttpTransport } from "./http-transport.js";
 import type { VariantId } from "./identifiers.js";
-import type { MaterialAssetProjection, MaterialDocumentPage, MaterialDocumentPageOptions } from "./material-asset-types.js";
+import type { ListVariantAssetsOptions, MaterialDocumentPage, MaterialDocumentPageOptions, VariantAssetPage } from "./material-asset-types.js";
 import type { MaterialBlockProjection } from "./material-block-types.js";
-import type { MaterialRenderAssets } from "./render-assets-types.js";
 /** Read known and explicitly unobserved canonical material fields. */
 export declare const materialBlocks: (transport: HttpTransport, variantId: VariantId, signal?: AbortSignal) => Promise<MaterialBlockProjection>;
-/** Read only redistribution-safe images and downloads for a material. */
-export declare const materialAssets: (transport: HttpTransport, variantId: VariantId, signal?: AbortSignal) => Promise<MaterialAssetProjection>;
-/** Read the accepted render-ready appearance projection, or an explicit unavailable reason. */
-export declare const materialRenderAssets: (transport: HttpTransport, variantId: VariantId, signal?: AbortSignal) => Promise<MaterialRenderAssets>;
+/**
+ * Read one bounded, filtered, cursor-paged page of a variant's images and
+ * files. `imageRoles` narrows only images and `documentTypes` narrows only
+ * documents, each implying its own kind; the server refuses either paired
+ * with other kinds, or with each other, rather than silently widening.
+ */
+export declare const listVariantAssets: (transport: HttpTransport, variantId: VariantId, options?: ListVariantAssetsOptions, signal?: AbortSignal) => Promise<VariantAssetPage>;
 /**
  * Read the owning Product's URL-deduplicated document page. Variant declarations
  * retain exact attribution; consumers inspect `appliesToRequestedVariant`

package/material-resources-client.js

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

package/material-types.d.ts

@@ -78,19 +78,6 @@ export type MaterialTile = {
      */
     colourName?: string;
 };
-/**
- * A sibling card: the tile, plus — when another variant of the same product
- * shares both its `variantName` and its `colourName` — the one attribute that
- * tells them apart (MG-1857: IndoTeak's Reclaimed Teak is ten "Unfinished"
- * variants that differ only by product code). Declared size first, then product
- * code. The two fields arrive together or not at all; absent means nothing
- * collides, or neither attribute separates every look-alike.
- */
-export type SiblingTile = {
-    distinguishedBy?: OpenEnum<"size" | "code">;
-    /** This sibling's value of `distinguishedBy`, e.g. `"3.5 in"`. */
-    distinction?: string;
-} & MaterialTile;
 /**
  * A canonical attribute/term pair carried on a detail record.
  *
@@ -154,8 +141,13 @@ export interface MaterialDetail extends MaterialTile {
     /** Opaque — the product family; siblings share it. */
     productId: ProductId;
     color: string | null;
-    /** Material Bank's own opaque id, when one is mapped. Null = unmapped, not absent. */
+    /** The variant's Material Bank SKU. Null means none is recorded, not unknown. */
     materialBankId: string | null;
+    /**
+     * The manufacturer's own item code from `variants.code`, the same key search
+     * results carry. ABSENT means no code is recorded, never an invented one.
+     */
+    manufacturerCode?: string;
     /**
      * Explicit source-governed permission to save this exact source-coded variant
      * to a Project. Absent means unknown/not allowed; never infer it from identity.

package/operations.d.ts

@@ -1,5 +1,5 @@
 export declare const MATERIALGRAPH_API_VERSION = "0.7.0";
-declare const OPERATION_DEFINITIONS: readonly [readonly ["brandMostSampled", "GET", "/api/v1/brands/most-sampled", "brands.most_sampled"], readonly ["colours.complete", "POST", "/api/v1/colours/palettes/complete", "complete_interior_palette"], readonly ["colours.discover", "GET", "/api/v1/colours/palettes", "discover_interior_palettes"], readonly ["samplizeColorVecCache", "GET", "/api/v1/catalogues/samplize/colorvec", "samplize_colorvec_cache"], readonly ["samplizeCatalogueSearch", "POST", "/api/v1/catalogues/samplize/search", "samplize_catalogue_search"], readonly ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"], readonly ["catalogPages", "GET", "/api/v1/catalogs/{catalogId}/pages", "list_catalog_pages"], readonly ["catalogPageRepresentation", "GET", "/api/v1/catalog-pages/{pageId}/representation", "get_catalog_page_representation"], readonly ["catalogReferences", "GET", "/api/v1/catalogs/{catalogId}/references", "list_catalog_product_references"], readonly ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["identify", "POST", "/api/v1/identify", "retrieval.identify"], readonly ["compare", "POST", "/api/v1/compare", "retrieval.compare"], readonly ["createCorrection", "POST", "/api/v1/corrections", "corrections.create"], readonly ["getCorrection", "GET", "/api/v1/corrections/{correctionId}", "corrections.get"], readonly ["listCorrections", "GET", "/api/v1/corrections", "corrections.list"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], readonly ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], readonly ["searchGet", "GET", "/api/v1/search", "search_materials_get"], readonly ["match", "POST", "/api/v1/search/match", "match_material"], readonly ["rejectMatchResult", "POST", "/api/v1/search/match/{responseId}/rejections", "reject_match_result"], readonly ["matchRejections", "GET", "/api/v1/search/match/{responseId}/rejections", "list_match_rejections"], readonly ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"], readonly ["material", "GET", "/api/v1/materials/{variantId}", "get_material"], readonly ["catalogueReferences", "POST", "/api/v1/catalogues/references", "get_catalogue_references_batch"], readonly ["catalogueCollections", "GET", "/api/v1/catalogues/collections", "list_catalogue_channel_collections"], readonly ["catalogueDocumentAccess", "GET", "/api/v1/catalogues/documents/{documentId}", "get_catalogue_document_access"], readonly ["siblings", "GET", "/api/v1/materials/{variantId}/siblings", "get_material_siblings"], readonly ["materialBlocks", "GET", "/api/v1/materials/{variantId}/blocks", "list_material_blocks"], readonly ["materialAssets", "GET", "/api/v1/materials/{variantId}/assets", "list_material_assets"], readonly ["materialRenderAssets", "GET", "/api/v1/materials/{variantId}/render-assets", "get_material_render_assets"], readonly ["materialDocuments", "GET", "/api/v1/materials/{variantId}/documents", "list_material_documents"], readonly ["exploration.operators", "GET", "/api/v1/materials/{variantId}/operators", "list_material_operators"], readonly ["exploration.candidates", "POST", "/api/v1/materials/{variantId}/candidates", "read_material_candidates"], readonly ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"], readonly ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"], readonly ["schema", "GET", "/api/v1/schema/verticals", "list_schema_verticals"], readonly ["schema", "GET", "/api/v1/schema/product-types", "list_schema_product_types"], readonly ["schema", "GET", "/api/v1/schema/units", "list_schema_units"], readonly ["schema", "GET", "/api/v1/schema/value-dictionaries", "list_schema_value_dictionaries"], readonly ["schema", "GET", "/api/v1/schema/source-requirements", "list_schema_source_requirements"], readonly ["schema", "GET", "/api/v1/schema/product-type-templates", "list_schema_product_type_templates"], readonly ["schema", "GET", "/api/v1/schema/mappings", "list_schema_mappings"], readonly ["pairings", "GET", "/api/v1/materials/{variantId}/pairings", "get_material_pairings"], readonly ["findSubstitutes", "POST", "/api/v1/materials/{variantId}/substitutes", "find_material_substitutes"], readonly ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], readonly ["applicability", "GET", "/api/v1/applicability", "get_applicability"], readonly ["materials", "POST", "/api/v1/materials/batch", "get_materials_batch_post"], readonly ["materialsCached", "GET", "/api/v1/materials/batch", "get_materials_batch_get"], readonly ["browse", "GET", "/api/v1/search/browse", "search_browse_by_colour"], readonly ["colourFacets", "GET", "/api/v1/colours/facets", "get_colour_facets"], readonly ["colours.profiles", "GET", "/api/v1/colours/profiles", "get_category_colour_profiles"], readonly ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"], readonly ["resolveColour", "GET", "/api/v1/search/colours/resolve", "resolve_colour_name"], readonly ["suggestColour", "GET", "/api/v1/search/colours/suggest", "suggest_colour_names"], readonly ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"], readonly ["resolveAttribute", "GET", "/api/v1/catalog/attributes/resolve", "catalog_resolve_attribute"], readonly ["resolveAttributeValue", "GET", "/api/v1/catalog/attributes/{attributeId}/values/resolve", "catalog_resolve_value"], readonly ["searchVocabulary", "GET", "/api/v1/catalog/vocabulary/search", "catalog_vocabulary_search"], readonly ["resolve", "POST", "/api/v1/resolve", "resolve_phrases"], readonly ["bySpec", "GET", "/api/v1/search/specifications", "catalog_by_spec"], readonly ["taxonomy", "GET", "/api/v1/taxonomy/categories", "get_category_taxonomy"], readonly ["productTypeCoverage", "GET", "/api/v1/taxonomy/coverage", "get_product_type_status_coverage"], readonly ["whoami", "GET", "/api/v1/whoami", "whoami"], readonly ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"], readonly ["demand", "GET", "/api/v1/demand", "get_material_demand"], readonly ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"], readonly ["extractPalette", "POST", "/api/v1/search/palettes/extract", "extract_image_palette"], readonly ["colours.gradient", "POST", "/api/v1/search/gradients", "search_by_gradient"], readonly ["specificationFacets", "GET", "/api/v1/catalog/specifications/facets", "list_spec_facets"], readonly ["attributeValues", "GET", "/api/v1/catalog/attributes/{attributeId}/values", "list_attribute_values"], readonly ["applicableSpecs", "GET", "/api/v1/taxonomy/categories/{key}/specs", "get_applicable_specs"], readonly ["glossary", "GET", "/api/v1/glossary/{term}", "explain_material_term"], readonly ["brands", "GET", "/api/v1/brands", "list_brands"], readonly ["brand", "GET", "/api/v1/brands/{brandSlug}", "get_brand_profile"], readonly ["brandColourDeck", "GET", "/api/v1/brands/{brandSlug}/colours", "brand_colour_deck"], readonly ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"], readonly ["sourceMaterialBatch", "GET", "/api/v1/source-material/{batchId}", "get_source_material_batch"], readonly ["sourceMaterialComments.list", "GET", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "list_source_material_comments"], readonly ["sourceMaterialComments.post", "POST", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "post_source_material_comment"], readonly ["capabilities", "GET", "/api/v1/capabilities", "list_public_capabilities"], readonly ["createRun", "POST", "/api/v1/runs", "create_public_run"], readonly ["listRuns", "GET", "/api/v1/runs", "list_public_runs"], readonly ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"], readonly ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"], readonly ["streamRunEvents", "GET", "/api/v1/runs/{runId}/events", "list_public_run_events"], readonly ["resumeRun", "POST", "/api/v1/runs/{runId}/resume", "resume_public_run"], readonly ["cancelRun", "POST", "/api/v1/runs/{runId}/cancel", "cancel_public_run"], readonly ["varyScheme", "POST", "/api/v1/schemes/vary", "vary_schemes"], readonly ["slotPools", "POST", "/api/v1/schemes/pools", "slot_pools"], readonly ["demandBatch", "POST", "/api/v1/demand/batch", "get_demand_batch"], readonly ["codeAdvisory", "POST", "/api/v1/codes/advisory", "resolveCodeAdvisory"], readonly ["codes.context", "GET", "/api/v1/codes/context", "list_code_context"], readonly ["codes.requirements", "GET", "/api/v1/codes/requirements", "list_code_requirements"]];
+declare const OPERATION_DEFINITIONS: readonly [readonly ["samplizeColorVecCache", "GET", "/api/v1/catalogues/samplize/colorvec", "samplize_colorvec_cache"], readonly ["samplizeCatalogueSearch", "POST", "/api/v1/catalogues/samplize/search", "samplize_catalogue_search"], readonly ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"], readonly ["catalogPages", "GET", "/api/v1/catalogs/{catalogId}/pages", "list_catalog_pages"], readonly ["catalogPageRepresentation", "GET", "/api/v1/catalog-pages/{pageId}/representation", "get_catalog_page_representation"], readonly ["catalogReferences", "GET", "/api/v1/catalogs/{catalogId}/references", "list_catalog_product_references"], readonly ["search", "POST", "/api/v1/search", "search_materials_post"], readonly ["identify", "POST", "/api/v1/identify", "retrieval.identify"], readonly ["match", "POST", "/api/v1/search/match", "match_material"], readonly ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"], readonly ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"], readonly ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"], readonly ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"], readonly ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], readonly ["searchGet", "GET", "/api/v1/search", "search_materials_get"], readonly ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"], readonly ["material", "GET", "/api/v1/materials/{variantId}", "get_material"], readonly ["catalogueReferences", "POST", "/api/v1/catalogues/references", "get_catalogue_references_batch"], readonly ["catalogueCollections", "GET", "/api/v1/catalogues/collections", "list_catalogue_channel_collections"], readonly ["catalogueDocumentAccess", "GET", "/api/v1/catalogues/documents/{documentId}", "get_catalogue_document_access"], readonly ["materialBlocks", "GET", "/api/v1/materials/{variantId}/blocks", "list_material_blocks"], readonly ["listVariantAssets", "GET", "/api/v1/variants/{variantId}/assets", "list_variant_assets"], readonly ["materialDocuments", "GET", "/api/v1/materials/{variantId}/documents", "list_material_documents"], readonly ["compositionReport", "GET", "/api/v1/composition/report", "get_composition_report"], readonly ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"], readonly ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"], readonly ["schema", "GET", "/api/v1/schema/verticals", "list_schema_verticals"], readonly ["schema", "GET", "/api/v1/schema/product-types", "list_schema_product_types"], readonly ["schema", "GET", "/api/v1/schema/units", "list_schema_units"], readonly ["schema", "GET", "/api/v1/schema/value-dictionaries", "list_schema_value_dictionaries"], readonly ["schema", "GET", "/api/v1/schema/source-requirements", "list_schema_source_requirements"], readonly ["schema", "GET", "/api/v1/schema/product-type-templates", "list_schema_product_type_templates"], readonly ["schema", "GET", "/api/v1/schema/mappings", "list_schema_mappings"], readonly ["pairings", "GET", "/api/v1/materials/{variantId}/pairings", "get_material_pairings"], readonly ["associatedFinishes", "GET", "/api/v1/associated/finishes", "list_associated_finishes"], readonly ["associatedProducts", "GET", "/api/v1/associated/products", "list_associated_products"], readonly ["applicability", "GET", "/api/v1/applicability", "get_applicability"], readonly ["listVariants", "GET", "/api/v1/variants", "list_variants"], readonly ["listVariantFacets", "POST", "/api/v1/variants/facets", "list_variant_facets"], readonly ["colours.profiles", "GET", "/api/v1/colours/profiles", "get_category_colour_profiles"], readonly ["resolveColour", "GET", "/api/v1/search/colours/resolve", "resolve_colour_name"], readonly ["suggestColour", "GET", "/api/v1/search/colours/suggest", "suggest_colour_names"], readonly ["listAttributes", "GET", "/api/v1/catalog/attributes", "catalog_list_attributes"], readonly ["searchVocabulary", "GET", "/api/v1/catalog/vocabulary/search", "catalog_vocabulary_search"], readonly ["resolve", "POST", "/api/v1/resolve", "resolve_phrases"], readonly ["categories.list", "GET", "/api/v1/categories", "list_categories"], readonly ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"], readonly ["productTypeCoverage", "GET", "/api/v1/taxonomy/coverage", "get_product_type_status_coverage"], readonly ["whoami", "GET", "/api/v1/whoami", "whoami"], readonly ["demand", "GET", "/api/v1/demand", "get_material_demand"], readonly ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"], readonly ["extractPalette", "POST", "/api/v1/search/palettes/extract", "extract_image_palette"], readonly ["colours.gradient", "POST", "/api/v1/search/gradients", "search_by_gradient"], readonly ["specificationFacets", "GET", "/api/v1/catalog/specifications/facets", "list_spec_facets"], readonly ["brands", "GET", "/api/v1/brands", "list_brands"], readonly ["uploadSourceMaterial", "POST", "/api/v1/source-material", "upload_source_material"], readonly ["sourceMaterialBatch", "GET", "/api/v1/source-material/{batchId}", "get_source_material_batch"], readonly ["sourceMaterialComments.list", "GET", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "list_source_material_comments"], readonly ["sourceMaterialComments.post", "POST", "/api/v1/source-material/{batchId}/sources/{sourceId}/comments", "post_source_material_comment"], readonly ["createRun", "POST", "/api/v1/runs", "create_public_run"], readonly ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"], readonly ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"], readonly ["streamRunEvents", "GET", "/api/v1/runs/{runId}/events", "list_public_run_events"], readonly ["demandBatch", "POST", "/api/v1/demand/batch", "get_demand_batch"], readonly ["codeAdvisory", "POST", "/api/v1/codes/advisory", "resolveCodeAdvisory"], readonly ["codes.context", "GET", "/api/v1/codes/context", "list_code_context"], readonly ["codes.requirements", "GET", "/api/v1/codes/requirements", "list_code_requirements"]];
 export type SdkOperationId = (typeof OPERATION_DEFINITIONS)[number][3];
 export type SdkOperation = Readonly<{
     clientMethod: (typeof OPERATION_DEFINITIONS)[number][0];

package/operations.js

@@ -1,24 +1,6 @@
 import { MaterialGraphError } from "./errors.js";
 export const MATERIALGRAPH_API_VERSION = "0.7.0";
 const OPERATION_DEFINITIONS = [
-    [
-        "brandMostSampled",
-        "GET",
-        "/api/v1/brands/most-sampled",
-        "brands.most_sampled",
-    ],
-    [
-        "colours.complete",
-        "POST",
-        "/api/v1/colours/palettes/complete",
-        "complete_interior_palette",
-    ],
-    [
-        "colours.discover",
-        "GET",
-        "/api/v1/colours/palettes",
-        "discover_interior_palettes",
-    ],
     [
         "samplizeColorVecCache",
         "GET",
@@ -52,15 +34,10 @@ const OPERATION_DEFINITIONS = [
     ],
     ["search", "POST", "/api/v1/search", "search_materials_post"],
     ["identify", "POST", "/api/v1/identify", "retrieval.identify"],
-    ["compare", "POST", "/api/v1/compare", "retrieval.compare"],
-    ["createCorrection", "POST", "/api/v1/corrections", "corrections.create"],
-    [
-        "getCorrection",
-        "GET",
-        "/api/v1/corrections/{correctionId}",
-        "corrections.get",
-    ],
-    ["listCorrections", "GET", "/api/v1/corrections", "corrections.list"],
+    ["match", "POST", "/api/v1/search/match", "match_material"],
+    ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"],
+    ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"],
+    ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"],
     ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"],
     [
         "samplizeCatalogue",
@@ -69,19 +46,6 @@ const OPERATION_DEFINITIONS = [
         "samplize_catalogue_products",
     ],
     ["searchGet", "GET", "/api/v1/search", "search_materials_get"],
-    ["match", "POST", "/api/v1/search/match", "match_material"],
-    [
-        "rejectMatchResult",
-        "POST",
-        "/api/v1/search/match/{responseId}/rejections",
-        "reject_match_result",
-    ],
-    [
-        "matchRejections",
-        "GET",
-        "/api/v1/search/match/{responseId}/rejections",
-        "list_match_rejections",
-    ],
     ["byColour", "GET", "/api/v1/search/colours", "search_by_colour"],
     ["material", "GET", "/api/v1/materials/{variantId}", "get_material"],
     [
@@ -102,12 +66,6 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/catalogues/documents/{documentId}",
         "get_catalogue_document_access",
     ],
-    [
-        "siblings",
-        "GET",
-        "/api/v1/materials/{variantId}/siblings",
-        "get_material_siblings",
-    ],
     [
         "materialBlocks",
         "GET",
@@ -115,16 +73,10 @@ const OPERATION_DEFINITIONS = [
         "list_material_blocks",
     ],
     [
-        "materialAssets",
+        "listVariantAssets",
         "GET",
-        "/api/v1/materials/{variantId}/assets",
-        "list_material_assets",
-    ],
-    [
-        "materialRenderAssets",
-        "GET",
-        "/api/v1/materials/{variantId}/render-assets",
-        "get_material_render_assets",
+        "/api/v1/variants/{variantId}/assets",
+        "list_variant_assets",
     ],
     [
         "materialDocuments",
@@ -133,16 +85,10 @@ const OPERATION_DEFINITIONS = [
         "list_material_documents",
     ],
     [
-        "exploration.operators",
+        "compositionReport",
         "GET",
-        "/api/v1/materials/{variantId}/operators",
-        "list_material_operators",
-    ],
-    [
-        "exploration.candidates",
-        "POST",
-        "/api/v1/materials/{variantId}/candidates",
-        "read_material_candidates",
+        "/api/v1/composition/report",
+        "get_composition_report",
     ],
     ["schema", "GET", "/api/v1/schema/blocks", "list_schema_blocks"],
     ["schema", "GET", "/api/v1/schema/attributes", "list_schema_attributes"],
@@ -179,12 +125,6 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/materials/{variantId}/pairings",
         "get_material_pairings",
     ],
-    [
-        "findSubstitutes",
-        "POST",
-        "/api/v1/materials/{variantId}/substitutes",
-        "find_material_substitutes",
-    ],
     [
         "associatedFinishes",
         "GET",
@@ -198,22 +138,19 @@ const OPERATION_DEFINITIONS = [
         "list_associated_products",
     ],
     ["applicability", "GET", "/api/v1/applicability", "get_applicability"],
-    ["materials", "POST", "/api/v1/materials/batch", "get_materials_batch_post"],
+    ["listVariants", "GET", "/api/v1/variants", "list_variants"],
     [
-        "materialsCached",
-        "GET",
-        "/api/v1/materials/batch",
-        "get_materials_batch_get",
+        "listVariantFacets",
+        "POST",
+        "/api/v1/variants/facets",
+        "list_variant_facets",
     ],
-    ["browse", "GET", "/api/v1/search/browse", "search_browse_by_colour"],
-    ["colourFacets", "GET", "/api/v1/colours/facets", "get_colour_facets"],
     [
         "colours.profiles",
         "GET",
         "/api/v1/colours/profiles",
         "get_category_colour_profiles",
     ],
-    ["colours.stats", "GET", "/api/v1/colours/stats", "get_colour_stats"],
     [
         "resolveColour",
         "GET",
@@ -226,18 +163,11 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/search/colours/suggest",
         "suggest_colour_names",
     ],
-    ["suggest", "GET", "/api/v1/search/suggest", "search_suggest"],
-    [
-        "resolveAttribute",
-        "GET",
-        "/api/v1/catalog/attributes/resolve",
-        "catalog_resolve_attribute",
-    ],
     [
-        "resolveAttributeValue",
+        "listAttributes",
         "GET",
-        "/api/v1/catalog/attributes/{attributeId}/values/resolve",
-        "catalog_resolve_value",
+        "/api/v1/catalog/attributes",
+        "catalog_list_attributes",
     ],
     [
         "searchVocabulary",
@@ -246,8 +176,8 @@ const OPERATION_DEFINITIONS = [
         "catalog_vocabulary_search",
     ],
     ["resolve", "POST", "/api/v1/resolve", "resolve_phrases"],
-    ["bySpec", "GET", "/api/v1/search/specifications", "catalog_by_spec"],
-    ["taxonomy", "GET", "/api/v1/taxonomy/categories", "get_category_taxonomy"],
+    ["categories.list", "GET", "/api/v1/categories", "list_categories"],
+    ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"],
     [
         "productTypeCoverage",
         "GET",
@@ -255,7 +185,6 @@ const OPERATION_DEFINITIONS = [
         "get_product_type_status_coverage",
     ],
     ["whoami", "GET", "/api/v1/whoami", "whoami"],
-    ["coordinate", "POST", "/api/v1/pairings/coordinate", "coordinate_materials"],
     ["demand", "GET", "/api/v1/demand", "get_material_demand"],
     ["colours.palette", "POST", "/api/v1/search/palettes", "search_by_palette"],
     [
@@ -276,27 +205,7 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/catalog/specifications/facets",
         "list_spec_facets",
     ],
-    [
-        "attributeValues",
-        "GET",
-        "/api/v1/catalog/attributes/{attributeId}/values",
-        "list_attribute_values",
-    ],
-    [
-        "applicableSpecs",
-        "GET",
-        "/api/v1/taxonomy/categories/{key}/specs",
-        "get_applicable_specs",
-    ],
-    ["glossary", "GET", "/api/v1/glossary/{term}", "explain_material_term"],
     ["brands", "GET", "/api/v1/brands", "list_brands"],
-    ["brand", "GET", "/api/v1/brands/{brandSlug}", "get_brand_profile"],
-    [
-        "brandColourDeck",
-        "GET",
-        "/api/v1/brands/{brandSlug}/colours",
-        "brand_colour_deck",
-    ],
     [
         "uploadSourceMaterial",
         "POST",
@@ -321,9 +230,7 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/source-material/{batchId}/sources/{sourceId}/comments",
         "post_source_material_comment",
     ],
-    ["capabilities", "GET", "/api/v1/capabilities", "list_public_capabilities"],
     ["createRun", "POST", "/api/v1/runs", "create_public_run"],
-    ["listRuns", "GET", "/api/v1/runs", "list_public_runs"],
     ["run", "GET", "/api/v1/runs/{runId}", "get_public_run"],
     ["citation", "GET", "/api/v1/citations/{citationId}", "get_verdict_citation"],
     [
@@ -332,10 +239,6 @@ const OPERATION_DEFINITIONS = [
         "/api/v1/runs/{runId}/events",
         "list_public_run_events",
     ],
-    ["resumeRun", "POST", "/api/v1/runs/{runId}/resume", "resume_public_run"],
-    ["cancelRun", "POST", "/api/v1/runs/{runId}/cancel", "cancel_public_run"],
-    ["varyScheme", "POST", "/api/v1/schemes/vary", "vary_schemes"],
-    ["slotPools", "POST", "/api/v1/schemes/pools", "slot_pools"],
     ["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"],

package/package.json

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