@instruments/materialgraph 0.30.0 → 0.31.0

package/client.d.ts

@@ -7,6 +7,7 @@ import type { ResolvedVerdictCitation } from "./citation-types.js";
 import type { MaterialGraphClientOptions } from "./client-config.js";
 import { ColoursClient } from "./colours-client.js";
 import type { RateLimit } from "./errors.js";
+import type { FindCompanionsInput, FindCompanionsOutput } from "./find-companions-types.js";
 import type { FindVariantsByColourInput, FindVariantsByColourOutput } from "./find-variants-by-colour-types.js";
 import type { FindVariantsByVectorInput, FindVariantsByVectorOutput } from "./find-variants-by-vector-types.js";
 import type { GetVariantOptions, GetVariantOutput } from "./get-variant-types.js";
@@ -265,6 +266,17 @@ export declare class MaterialGraphClient extends CatalogueClient {
      * search index rather than the canonical variant graph.
      */
     findVariantsByColour(input: FindVariantsByColourInput, signal?: AbortSignal): Promise<FindVariantsByColourOutput>;
+    /**
+     * THE QUESTION: "what did designers sample together with these?" (POST
+     * `/api/v1/variants/companions`, MG-2332). Give `variantIds` and/or
+     * `materials` (free-text names, one variant each, at most twelve together);
+     * companions come back strongest first, each with its `lift`,
+     * `seedMatchCount`, `relation` and a one-line `reason`. `projectType` reads one
+     * sector; `include` adds `image` and `colour` fields a lean page leaves out.
+     * A sample order shows sampling, never specification. Read `unresolved`
+     * before presenting: a scheme of four that resolved two is a different claim.
+     */
+    findCompanions(input: FindCompanionsInput, signal?: AbortSignal): Promise<FindCompanionsOutput>;
     /**
      * THE QUESTION: "what looks or feels like this?" (POST
      * `/api/v1/variants/by-vector`, MG-2231). Eligible variants ranked by

package/client.js

@@ -341,6 +341,19 @@ export class MaterialGraphClient extends CatalogueClient {
     async findVariantsByColour(input, signal) {
         return await this.#post("find_variants_by_colour", input, signal);
     }
+    /**
+     * THE QUESTION: "what did designers sample together with these?" (POST
+     * `/api/v1/variants/companions`, MG-2332). Give `variantIds` and/or
+     * `materials` (free-text names, one variant each, at most twelve together);
+     * companions come back strongest first, each with its `lift`,
+     * `seedMatchCount`, `relation` and a one-line `reason`. `projectType` reads one
+     * sector; `include` adds `image` and `colour` fields a lean page leaves out.
+     * A sample order shows sampling, never specification. Read `unresolved`
+     * before presenting: a scheme of four that resolved two is a different claim.
+     */
+    async findCompanions(input, signal) {
+        return await this.#post("find_companions", input, signal);
+    }
     /**
      * THE QUESTION: "what looks or feels like this?" (POST
      * `/api/v1/variants/by-vector`, MG-2231). Eligible variants ranked by

package/errors.d.ts

@@ -89,7 +89,7 @@ type TransportErrorInput = {
  * member to a problem response means adding it here too, and
  * `problem-extension-parity.test.ts` fails when the two disagree.
  */
-export declare const MATERIALGRAPH_PROBLEM_EXTENSIONS: readonly ["ambiguous_brands", "brand_candidates", "content_length", "did_you_mean", "empty_brands", "limit_bytes", "missing_env", "orderable_attributes", "populated_alternatives", "refused_criteria", "unknown_attributes", "unknown_brands", "unknown_fields", "unorderable_attribute", "valid_group_keys", "valid_type_keys"];
+export declare const MATERIALGRAPH_PROBLEM_EXTENSIONS: readonly ["ambiguous_brands", "brand_candidates", "content_length", "did_you_mean", "empty_brands", "limit_bytes", "missing_env", "orderable_attributes", "populated_alternatives", "refused_criteria", "unknown_attributes", "unknown_brands", "unknown_fields", "unknown_parameters", "unorderable_attribute", "valid_group_keys", "valid_type_keys"];
 /** The one error class thrown by all SDK transport and HTTP failures. */
 export declare class MaterialGraphError extends Error {
     readonly kind: MaterialGraphErrorKind;

package/errors.js

@@ -36,6 +36,7 @@ export const MATERIALGRAPH_PROBLEM_EXTENSIONS = [
     "unknown_attributes",
     "unknown_brands",
     "unknown_fields",
+    "unknown_parameters",
     "unorderable_attribute",
     "valid_group_keys",
     "valid_type_keys",

package/find-companions-types.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @module find-companions-types
+ * @description Hand-maintained mirror of `find_companions`' (MG-2332) input and
+ * output wire shapes. The source of truth is
+ * `packages/products/src/cospec/schema.ts` (`findCompanionsInputSchema`,
+ * `findCompanionsResultSchema`). This SDK has no RUNTIME dependency on
+ * `@materialgraph/products` (it's a devDependency only, for the parity tests in
+ * `__tests__/`), so the shapes are copied here rather than imported.
+ * `contract-parity.test.ts` keeps this mirror honest against the server types,
+ * the project-type list included.
+ */
+/** The closed sector vocabulary co-specification evidence is tagged with. */
+export type CompanionProjectType = "Workplace" | "Residential" | "Institution Education" | "Hospitality: Hotel" | "Mixed-Use & Multi-Unit Residential" | "Healthcare" | "Hospitality: Restaurant" | "Government" | "Senior Living" | "Retail" | "Other" | "Sports Entertainment" | "Wellness" | "Medical Dental" | "Aviation" | "Industrial" | "Tech" | "Transportation" | "Single Family" | "Condominium Cooperative" | "Marine" | "Power & Energy" | "University Design Program: Interior Design" | "Non-Billable" | "University Design Program: Interior Architecture" | "University Design Program: Architecture" | "Historic Preservation";
+/** At least one of `variantIds` and `materials`, at most twelve together. */
+export type FindCompanionsInput = {
+    /** Optional row fields: image adds imageUrl, colour adds swatches. */
+    include?: ("image" | "colour")[];
+    /** Ops and audit switch: leave sample cards in. Default false. */
+    includeSamplingArtifacts?: boolean;
+    /** Companions to return, default 20, at most 100. */
+    limit?: number;
+    /** Names to resolve when you hold no ids. Misses come back unresolved. */
+    materials?: string[];
+    /** Only companions sampled together in projects of this sector. */
+    projectType?: CompanionProjectType;
+    /** Variants to find companions for. */
+    variantIds?: string[];
+};
+export type FindCompanionsRow = {
+    brand: string;
+    /** Palette likeness to the seeds. Present with `include: ["colour"]`; never reorders. */
+    colourFit?: number | null;
+    /** Present with `include: ["image"]`. */
+    imageUrl?: string | null;
+    /** Mean lift over the seeds it pairs with; above 1 is above average. */
+    lift: number;
+    product: string;
+    /** Why it was suggested, in one line. */
+    reason: string;
+    /** `companion` is another brand; `brand_sibling` and `colourway` share the seed's. */
+    relation: "companion" | "brand_sibling" | "colourway";
+    /** How many seeds it was sampled with. */
+    seedMatchCount: number;
+    /** Present with `include: ["colour"]`. */
+    swatches?: {
+        hex: string;
+        proportion: number;
+    }[];
+    variantId: string;
+    variantName: string | null;
+};
+export type FindCompanionsOutput = {
+    /** Strongest first: seeds matched, then summed lift, one row per product. */
+    companions: FindCompanionsRow[];
+    /** The seeds as resolved, so a caller sees what a name became. */
+    seeds: {
+        brand: string;
+        /** Present with `include: ["image"]`. */
+        imageUrl?: string | null;
+        product: string;
+        /** The id or name this seed came from. */
+        resolvedFrom: string;
+        variantId: string;
+        variantName: string | null;
+    }[];
+    /** Seed ids outside the materials catalogue; present only when at least one was. */
+    excludedByCorpusScope?: string[];
+    /** References that matched no variant. */
+    unresolved: string[];
+};

package/find-companions-types.js

@@ -0,0 +1,12 @@
+/**
+ * @module find-companions-types
+ * @description Hand-maintained mirror of `find_companions`' (MG-2332) input and
+ * output wire shapes. The source of truth is
+ * `packages/products/src/cospec/schema.ts` (`findCompanionsInputSchema`,
+ * `findCompanionsResultSchema`). This SDK has no RUNTIME dependency on
+ * `@materialgraph/products` (it's a devDependency only, for the parity tests in
+ * `__tests__/`), so the shapes are copied here rather than imported.
+ * `contract-parity.test.ts` keeps this mirror honest against the server types,
+ * the project-type list included.
+ */
+export {};

package/http-transport.d.ts

@@ -1,6 +1,6 @@
 import type { RateLimit } from "./errors.js";
 import type { SdkOperation } from "./operations.js";
-export type QueryValue = string | number | boolean | undefined | null | (string | number | boolean)[];
+type QueryValue = string | number | boolean | undefined | null | (string | number | boolean)[];
 export type QueryParams = Record<string, QueryValue>;
 export type RequestOptions = {
     /** Required by state-changing operations that support safe retries. */

package/index.d.ts

@@ -5,6 +5,7 @@ export type * from "./list-variant-facets-types.js";
 export type * from "./list-enum-values-types.js";
 export type * from "./get-variant-types.js";
 export type * from "./image-reference-types.js";
+export type * from "./find-companions-types.js";
 export type * from "./find-variants-by-colour-types.js";
 export { FIND_VARIANTS_BY_VECTOR_MODES } from "./find-variants-by-vector-types.js";
 export type * from "./find-variants-by-vector-types.js";

package/material-types.d.ts

@@ -57,7 +57,7 @@ export type MaterialTile = {
     colourName?: string;
 };
 /** A retained product-type proposal. It is review evidence, never a category. */
-export type ProposedProductType = {
+type ProposedProductType = {
     id: string;
     displayName: string;
     confidence: number | null;
@@ -71,3 +71,4 @@ export type ProductTypeReceipt = {
     state: "accepted" | "proposed" | "unknown";
     proposedProductTypes: ProposedProductType[];
 };
+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 ["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 ["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 ["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

@@ -123,6 +123,7 @@ const OPERATION_DEFINITIONS = [
         "/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"],
     [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instruments/materialgraph",
-  "version": "0.30.0",
+  "version": "0.31.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", "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", "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_CATALOGUE_JSON: string;