@instruments/materialgraph 0.31.0 → 0.32.0

package/client.d.ts

@@ -15,8 +15,6 @@ import type { VariantId } from "./identifiers.js";
 import type { ListEnumValuesOptions, ListEnumValuesResult } from "./list-enum-values-types.js";
 import type { ListVariantFacetsInput, ListVariantFacetsOutput } from "./list-variant-facets-types.js";
 import type { ListVariantsInput, ListVariantsOutput } from "./list-variants-types.js";
-import type { MatchStreamEvent } from "./match-stream-types.js";
-import type { MatchAnswer, MatchInput } from "./match-types.js";
 import type { ListVariantAssetsOptions, MaterialDocumentPageOptions, VariantAssetPage } from "./material-asset-types.js";
 import type { MaterialQueryPlan } from "./material-query-plan-types.js";
 import type { SourceMaterialBatchReceipt, UploadSourceMaterialInput } from "./run-types.js";
@@ -35,7 +33,6 @@ export * from "./client-config.js";
  * | --- | --- |
  * | "find me something like this / matching these words" | {@link MaterialGraphClient.search} |
  * | "tell me about THIS variant" | {@link MaterialGraphClient.getVariant} |
- * | "what's IN this photo?" | {@link MaterialGraphClient.match} / {@link MaterialGraphClient.matchStream} |
  * | "which materials, from anyone, meet this hard spec?" | {@link MaterialGraphClient.listVariants} |
  * | "what's near this colour / this palette?" | {@link MaterialGraphClient.byColour}, `colours.palette()` |
  * | "what goes with THIS material?" | {@link MaterialGraphClient.pairings}, {@link MaterialGraphClient.listVariants} (same product, other colourways) |
@@ -107,7 +104,7 @@ export declare class MaterialGraphClient extends CatalogueClient {
      * (ranking would be noise), {@link MaterialGraphClient.byColour} /
      * `colours.palette()` for visual colour intent (`text` matches WORDS — "sage
      * green" finds materials that SAY sage, not ones that look it),
-     * {@link MaterialGraphClient.match} for a photo, {@link MaterialGraphClient.pairings}
+     * {@link MaterialGraphClient.pairings}
      * for what goes WITH something, {@link MaterialGraphClient.suggest} for typeahead.
      *
      * The full POST search primitive. `input.filters` are hard token sets on
@@ -130,44 +127,6 @@ export declare class MaterialGraphClient extends CatalogueClient {
         view: "card";
     }, signal?: AbortSignal): Promise<SearchCardResponse>;
     searchGet(params: SearchGetParams, signal?: AbortSignal): Promise<SearchResponse>;
-    /**
-     * THE QUESTION: "what materials are in this PHOTO?" — Material Match classifies
-     * the image, decomposes it into surfaces, and answers each one.
-     *
-     * Instead use {@link MaterialGraphClient.matchStream} whenever a human is
-     * watching, {@link MaterialGraphClient.search} with `image` for ONE ranked list
-     * rather than a per-surface decomposition, and
-     * {@link MaterialGraphClient.extractPalette} for the image's colours only.
-     *
-     * Exactly one of `imageBase64`, `imageUrl` or `vector`. Read `qualityFloor` and
-     * `droppedBelowFloor` before reporting an empty result: "nothing was good
-     * enough" and "nothing was found" are different answers.
-     */
-    match(input: MatchInput, signal?: AbortSignal): Promise<MatchAnswer>;
-    /**
-     * Material Match as a PROGRESSIVE stream — the same POST
-     * `/api/v1/search/match` endpoint negotiated with `Accept:
-     * application/x-ndjson`, which runs the scene workflow (classify → decompose →
-     * one match per surface) and emits an event as each surface resolves. Use this
-     * wherever the user watches a photo come apart; use {@link match} when you only
-     * want the finished answer.
-     *
-     * Iterate it directly — the request opens on the first `next()`:
-     *
-     * ```ts
-     * for await (const event of client.matchStream({ imageBase64 })) {
-     *   if (event.type === "surface") render(event.surface);
-     * }
-     * ```
-     *
-     * Every frame is validated before it is yielded, and the iterator ends only on
-     * a `complete` or `error` event — a truncated connection raises rather than
-     * passing for a short run. `signal` cancels the in-flight request itself, as
-     * does breaking out of the loop; a cancelled stream ends without raising.
-     * Requires an image (`imageBase64` or `imageUrl`); a `vector` input is
-     * buffered-only.
-     */
-    matchStream(input: MatchInput, signal?: AbortSignal): AsyncGenerator<MatchStreamEvent, void, unknown>;
     /**
      * THE QUESTION: "what materials are near THIS colour?" — one colour (or a small
      * palette), ranked by OKLab closeness to colour extracted from product imagery.
@@ -321,7 +280,7 @@ export declare class MaterialGraphClient extends CatalogueClient {
      * materials. The bridge from an inspiration image into the colour lens: extract
      * here, then feed the swatches to `colours.palette()` or
      * {@link MaterialGraphClient.byColour}. Instead use
-     * {@link MaterialGraphClient.match} for the MATERIALS in the photo.
+  
      */
     extractPalette(input: ExtractPaletteInput, signal?: AbortSignal): Promise<ExtractPaletteResponse>;
     /** "Whose catalogs are in here, and how big is each?" — {@link listBrands}. */

package/client.js

@@ -7,7 +7,6 @@ import { listAttributes as listAttributesCall, listEnumValues as listEnumValuesC
 import { ColoursClient } from "./colours-client.js";
 import { MaterialGraphError } from "./errors.js";
 import { HttpTransport } from "./http-transport.js";
-import { matchStream as matchStreamCall } from "./match-stream.js";
 import { listVariantAssets as listVariantAssetsCall, materialBlocks as materialBlocksCall, materialDocuments as materialDocumentsCall, } from "./material-resources-client.js";
 // Aliased to `operation` — the local name every call site here already used.
 import { resolveOperation as operation } from "./operations.js";
@@ -26,7 +25,6 @@ export * from "./client-config.js";
  * | --- | --- |
  * | "find me something like this / matching these words" | {@link MaterialGraphClient.search} |
  * | "tell me about THIS variant" | {@link MaterialGraphClient.getVariant} |
- * | "what's IN this photo?" | {@link MaterialGraphClient.match} / {@link MaterialGraphClient.matchStream} |
  * | "which materials, from anyone, meet this hard spec?" | {@link MaterialGraphClient.listVariants} |
  * | "what's near this colour / this palette?" | {@link MaterialGraphClient.byColour}, `colours.palette()` |
  * | "what goes with THIS material?" | {@link MaterialGraphClient.pairings}, {@link MaterialGraphClient.listVariants} (same product, other colourways) |
@@ -135,48 +133,6 @@ export class MaterialGraphClient extends CatalogueClient {
     async searchGet(params, signal) {
         return await this.#get("search_materials_get", { ...params }, signal);
     }
-    /**
-     * THE QUESTION: "what materials are in this PHOTO?" — Material Match classifies
-     * the image, decomposes it into surfaces, and answers each one.
-     *
-     * Instead use {@link MaterialGraphClient.matchStream} whenever a human is
-     * watching, {@link MaterialGraphClient.search} with `image` for ONE ranked list
-     * rather than a per-surface decomposition, and
-     * {@link MaterialGraphClient.extractPalette} for the image's colours only.
-     *
-     * Exactly one of `imageBase64`, `imageUrl` or `vector`. Read `qualityFloor` and
-     * `droppedBelowFloor` before reporting an empty result: "nothing was good
-     * enough" and "nothing was found" are different answers.
-     */
-    async match(input, signal) {
-        return await this.#post("match_material", input, signal);
-    }
-    /**
-     * Material Match as a PROGRESSIVE stream — the same POST
-     * `/api/v1/search/match` endpoint negotiated with `Accept:
-     * application/x-ndjson`, which runs the scene workflow (classify → decompose →
-     * one match per surface) and emits an event as each surface resolves. Use this
-     * wherever the user watches a photo come apart; use {@link match} when you only
-     * want the finished answer.
-     *
-     * Iterate it directly — the request opens on the first `next()`:
-     *
-     * ```ts
-     * for await (const event of client.matchStream({ imageBase64 })) {
-     *   if (event.type === "surface") render(event.surface);
-     * }
-     * ```
-     *
-     * Every frame is validated before it is yielded, and the iterator ends only on
-     * a `complete` or `error` event — a truncated connection raises rather than
-     * passing for a short run. `signal` cancels the in-flight request itself, as
-     * does breaking out of the loop; a cancelled stream ends without raising.
-     * Requires an image (`imageBase64` or `imageUrl`); a `vector` input is
-     * buffered-only.
-     */
-    matchStream(input, signal) {
-        return matchStreamCall(this.#transport, input, signal);
-    }
     /**
      * THE QUESTION: "what materials are near THIS colour?" — one colour (or a small
      * palette), ranked by OKLab closeness to colour extracted from product imagery.
@@ -419,7 +375,7 @@ export class MaterialGraphClient extends CatalogueClient {
      * materials. The bridge from an inspiration image into the colour lens: extract
      * here, then feed the swatches to `colours.palette()` or
      * {@link MaterialGraphClient.byColour}. Instead use
-     * {@link MaterialGraphClient.match} for the MATERIALS in the photo.
+  
      */
     async extractPalette(input, signal) {
         return await this.#post("extract_image_palette", input, signal);

package/index.d.ts

@@ -28,9 +28,6 @@ export { ColoursClient } from "./colours-client.js";
 export type { ColoursTransport } from "./colours-client.js";
 export type * from "./palette-search-types.js";
 export type * from "./query-understanding-types.js";
-export type * from "./match-types.js";
-export { MATCH_ERROR_REASONS, MATCH_IMAGE_TYPES, MATCH_OUTCOMES, MATCH_MATERIAL_FUNCTIONS, MATCH_STREAM_EVENT_TYPES, MATCH_SURFACE_STATUSES, MATCH_WORKFLOW_STEPS, } from "./match-stream-types.js";
-export type * from "./match-stream-types.js";
 export type * from "./material-query-plan-types.js";
 export type * from "./association-types.js";
 export type * from "./brand-types.js";

package/index.js

@@ -5,6 +5,5 @@ export { TERMINAL_RUN_EVENT_TYPES } from "./run-types.js";
 export { MATERIALGRAPH_PROBLEM_EXTENSIONS, MaterialGraphError, } from "./errors.js";
 export { CategoriesClient } from "./categories-client.js";
 export { ColoursClient } from "./colours-client.js";
-export { MATCH_ERROR_REASONS, MATCH_IMAGE_TYPES, MATCH_OUTCOMES, MATCH_MATERIAL_FUNCTIONS, MATCH_STREAM_EVENT_TYPES, MATCH_SURFACE_STATUSES, MATCH_WORKFLOW_STEPS, } from "./match-stream-types.js";
 export { CERTIFICATION_PROGRAMME_ATTRIBUTE_ID } from "./spec-types.js";
 export { certificationProgramme, hasSpec, specTerm } from "./specifications.js";

package/ndjson.d.ts

@@ -1,6 +1,6 @@
 /**
  * A minimal, dependency-free NDJSON (newline-delimited JSON) line reader — the
- * primitive behind {@link MaterialGraphClient.matchStream}. Hand-rolled so the
+ * primitive for line-oriented JSON streams. Hand-rolled so the
  * SDK stays zero-runtime-dep and works unchanged inside Node route handlers,
  * where `fetch` yields a byte `ReadableStream`.
  *

package/ndjson.js

@@ -1,6 +1,6 @@
 /**
  * A minimal, dependency-free NDJSON (newline-delimited JSON) line reader — the
- * primitive behind {@link MaterialGraphClient.matchStream}. Hand-rolled so the
+ * primitive for line-oriented JSON streams. Hand-rolled so the
  * SDK stays zero-runtime-dep and works unchanged inside Node route handlers,
  * where `fetch` yields a byte `ReadableStream`.
  *

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 ["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"]];
+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 ["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,7 +33,6 @@ const OPERATION_DEFINITIONS = [
         "list_catalog_product_references",
     ],
     ["search", "POST", "/api/v1/search", "search_materials_post"],
-    ["match", "POST", "/api/v1/search/match", "match_material"],
     ["planQuery", "POST", "/api/v1/search/plan", "plan_material_query"],
     [
         "samplizeCatalogue",

package/package.json

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

package/response-schemas.generated.d.ts

@@ -1,5 +1,5 @@
 /** The API contract version the schemas were generated from. */
 export declare const RESPONSE_SCHEMA_API_VERSION = "0.7.0";
 /** Every SDK operation whose success response has a published JSON Schema. */
-export declare const RESPONSE_SCHEMA_OPERATION_IDS: readonly ["samplize_colorvec_cache", "samplize_catalogue_search", "list_catalog_documents", "list_catalog_pages", "get_catalog_page_representation", "list_catalog_product_references", "search_materials_post", "match_material", "plan_material_query", "samplize_catalogue_products", "search_materials_get", "search_by_colour", "get_catalogue_references_batch", "list_catalogue_channel_collections", "get_catalogue_document_access", "list_material_blocks", "list_variant_assets", "list_material_documents", "list_schema_value_dictionaries", "get_material_pairings", "list_associated_finishes", "list_associated_products", "get_applicability", "list_variants", "list_variant_facets", "find_variants_by_colour", "find_variants_by_vector", "find_companions", "resolve_variant", "get_variant", "resolve_colour_name", "catalog_list_attributes", "catalog_list_enum_values", "list_categories", "get_category", "whoami", "search_by_palette", "extract_image_palette", "list_brands", "upload_source_material", "create_public_run", "get_public_run", "get_verdict_citation"];
+export declare const RESPONSE_SCHEMA_OPERATION_IDS: readonly ["samplize_colorvec_cache", "samplize_catalogue_search", "list_catalog_documents", "list_catalog_pages", "get_catalog_page_representation", "list_catalog_product_references", "search_materials_post", "plan_material_query", "samplize_catalogue_products", "search_materials_get", "search_by_colour", "get_catalogue_references_batch", "list_catalogue_channel_collections", "get_catalogue_document_access", "list_material_blocks", "list_variant_assets", "list_material_documents", "list_schema_value_dictionaries", "get_material_pairings", "list_associated_finishes", "list_associated_products", "get_applicability", "list_variants", "list_variant_facets", "find_variants_by_colour", "find_variants_by_vector", "find_companions", "resolve_variant", "get_variant", "resolve_colour_name", "catalog_list_attributes", "catalog_list_enum_values", "list_categories", "get_category", "whoami", "search_by_palette", "extract_image_palette", "list_brands", "upload_source_material", "create_public_run", "get_public_run", "get_verdict_citation"];
 export declare const RESPONSE_SCHEMA_CATALOGUE_JSON: string;