@instruments/materialgraph 0.25.0 → 0.27.0

package/resolve-types.d.ts

@@ -51,7 +51,7 @@ export type ResolutionKind = "brand" | "paint_identity" | "colour" | "category"
  */
 export type ResolutionRung = "exact" | "alias" | "lexical";
 /** One thing a phrase turned out to mean. */
-export interface ResolvedMeaning {
+export type ResolvedMeaning = {
     kind: ResolutionKind;
     /**
      * The canonical token. OPAQUE — hand it back verbatim, never parse, tidy or
@@ -91,9 +91,9 @@ export interface ResolvedMeaning {
      * nothing rather than a figure measured a different way.
      */
     coverage?: MeaningCoverage;
-}
+};
 /** How much of the catalogue stands behind one reading. */
-export interface MeaningCoverage {
+export type MeaningCoverage = {
     /**
      * How many variants carry this reading, CORPUS-WIDE and across every brand —
      * never scoped to the `category` you sent, even when you sent one. `0` is a
@@ -121,9 +121,9 @@ export interface MeaningCoverage {
      * category holds SOME value for the attribute, not that it holds this one.
      */
     inCategory?: boolean;
-}
+};
 /** What one phrase resolved to — including, explicitly, nothing. */
-export interface PhraseResolution {
+export type PhraseResolution = {
     /** The phrase exactly as you sent it, so you can rejoin the batch by value. */
     phrase: string;
     /**
@@ -147,9 +147,9 @@ export interface PhraseResolution {
      * material world.
      */
     unresolved: boolean;
-}
+};
 /** Optional scoping for a resolve call. */
-export interface ResolvePhrasesOptions {
+export type ResolvePhrasesOptions = {
     /**
      * The product category you are grounding these words FOR — a slot, not a
      * filter. It adds {@link MeaningCoverage.inCategory} to every `attribute` and
@@ -157,7 +157,7 @@ export interface ResolvePhrasesOptions {
      */
     category?: string;
     signal?: AbortSignal;
-}
+};
 /**
  * What `mg.resolve()` accepts as its second argument. A bare `AbortSignal` is
  * still accepted, exactly as before {@link ResolvePhrasesOptions} existed, so no
@@ -165,7 +165,7 @@ export interface ResolvePhrasesOptions {
  */
 export type ResolvePhrasesScope = AbortSignal | ResolvePhrasesOptions;
 /** The resolve response: one entry per phrase, in the order you sent them. */
-export interface ResolveResponse {
+export type ResolveResponse = {
     /** One per phrase, in request order — never reordered, never deduplicated. */
     resolutions: PhraseResolution[];
-}
+};

package/response-schemas.d.ts

@@ -0,0 +1,20 @@
+import type { RESPONSE_SCHEMA_OPERATION_IDS } from "./response-schemas.generated.js";
+export { RESPONSE_SCHEMA_API_VERSION, RESPONSE_SCHEMA_OPERATION_IDS, } from "./response-schemas.generated.js";
+/** Every operation {@link responseSchema} answers for. */
+export type ResponseSchemaOperationId = (typeof RESPONSE_SCHEMA_OPERATION_IDS)[number];
+/** A JSON Schema document or subschema, as plain JSON. */
+export type JsonSchema = {
+    [keyword: string]: unknown;
+};
+/** A self-contained schema: every `$ref` resolves inside its own `$defs`. */
+export type ResponseJsonSchema = JsonSchema & {
+    $schema: typeof JSON_SCHEMA_DIALECT;
+    $defs?: Record<string, JsonSchema>;
+};
+declare const JSON_SCHEMA_DIALECT = "https://json-schema.org/draft/2020-12/schema";
+/**
+ * The success-response schema for one operation, self-contained and carrying
+ * only the definitions it reaches. Each call returns a fresh copy, so a caller
+ * that annotates or mutates it cannot change what the next caller gets.
+ */
+export declare const responseSchema: (operationId: ResponseSchemaOperationId) => ResponseJsonSchema;

package/response-schemas.generated.d.ts

@@ -0,0 +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", "retrieval.identify", "match_material", "search_suggest", "get_colour_stats", "coordinate_materials", "plan_material_query", "samplize_catalogue_products", "search_materials_get", "search_by_colour", "get_material", "get_catalogue_references_batch", "list_catalogue_channel_collections", "get_catalogue_document_access", "list_material_blocks", "list_variant_assets", "list_material_documents", "get_composition_report", "list_schema_blocks", "list_schema_attributes", "list_schema_verticals", "list_schema_product_types", "list_schema_units", "list_schema_value_dictionaries", "list_schema_source_requirements", "list_schema_product_type_templates", "list_schema_mappings", "get_material_pairings", "list_associated_finishes", "list_associated_products", "get_applicability", "list_variants", "list_variant_facets", "get_category_colour_profiles", "resolve_colour_name", "suggest_colour_names", "catalog_list_attributes", "catalog_vocabulary_search", "resolve_phrases", "list_categories", "get_category", "get_product_type_status_coverage", "whoami", "get_material_demand", "search_by_palette", "extract_image_palette", "search_by_gradient", "list_spec_facets", "list_brands", "upload_source_material", "get_source_material_batch", "list_source_material_comments", "post_source_material_comment", "create_public_run", "get_public_run", "get_verdict_citation", "get_demand_batch", "resolveCodeAdvisory", "list_code_context", "list_code_requirements"];
+export declare const RESPONSE_SCHEMA_CATALOGUE_JSON: string;