@instruments/materialgraph 3.1.0 → 3.3.0

package/find-variants-by-color-types.d.ts

@@ -15,7 +15,7 @@ import type { ImageReferenceInput } from "./image-reference-types.js";
 import type { SearchCatalogSubset, SearchCatalogSubsetReceipt } from "./search-catalog-subset-types.js";
 export type FindVariantsByColorMode = "contains" | "palette" | "rerank";
 /** One color condition. `role` defaults to `required`; every other field defaults to absent/false/0. */
-export type ColorConditionInput = {
+export interface ColorConditionInput {
     /** Name, code or hex (e.g. "sage green"). */
     color?: string;
     /** Must be the swatch's largest color. */
@@ -25,8 +25,8 @@ export type ColorConditionInput = {
     share?: number;
     /** Maximum share, e.g. an accent. */
     shareMax?: number;
-};
-export type FindVariantsByColorInput = {
+}
+export interface FindVariantsByColorInput {
     /** Brand slugs or names to filter to. */
     brands?: string[];
     /** One entry per color (exactly one for rerank). */
@@ -37,6 +37,7 @@ export type FindVariantsByColorInput = {
     cursor?: string;
     /** Palette only: targets from this image's colors, not `colors[]`. */
     image?: ImageReferenceInput;
+    /** Variants a page, 1 to 24 (a larger value is a 400). Omitted: 16 for contains and palette, every given id for rerank. */
     limit?: number;
     mode: FindVariantsByColorMode;
     /** Independent specification type or group keys, e.g. wallcovering or coatings; filters specification types, not source categories. */
@@ -45,8 +46,8 @@ export type FindVariantsByColorInput = {
     targetVariantId?: string;
     /** Ids to reorder by color (rerank). */
     variantIds?: string[];
-};
-export type ColorConditionReceipt = {
+}
+export interface ColorConditionReceipt {
     /** CIEDE2000 difference to the assigned settled swatch. Never a probability. */
     distance: number;
     hex: string;
@@ -56,8 +57,8 @@ export type ColorConditionReceipt = {
     proportion: number;
     /** Requested share used for ColorVec retrieval, palette only; null otherwise. */
     target: number | null;
-};
-export type PaintCatalogVariant = {
+}
+export interface PaintCatalogVariant {
     brand: string;
     color: string | null;
     imageUrl: string | null;
@@ -65,8 +66,8 @@ export type PaintCatalogVariant = {
     product: string;
     variantId: string;
     variantName: string | null;
-};
-export type ResolvedColor = {
+}
+export interface ResolvedColor {
     /** Other meanings of the same words, offered: ColorScope's color when a paint's exact name led. */
     alternatives?: ColorAlternative[];
     catalogVariant: PaintCatalogVariant | null;
@@ -76,21 +77,21 @@ export type ResolvedColor = {
     kind: "point" | "region";
     /** Image-extracted or stored target-variant swatch share; else null. */
     share: number | null;
-};
-export type ColorAlternative = {
+}
+export interface ColorAlternative {
     code?: string;
     hex: string;
     libraryId: string;
     libraryName: string;
     name: string;
     query: string;
-};
-export type UnresolvedColor = {
+}
+export interface UnresolvedColor {
     alternatives: ColorAlternative[];
     index: number;
     input: string | null;
-};
-export type ColorVariantMatch = {
+}
+export interface ColorVariantMatch {
     /** The trimmed source variant label; null when unknown or for a paint color sample. Separate from surface finish, color family and derived color names. */
     variantLabel: string | null;
     productType: {
@@ -116,8 +117,8 @@ export type ColorVariantMatch = {
     productId: string;
     variantId: string;
     variantName: string;
-};
-export type ColorPageInfo = {
+}
+export interface ColorPageInfo {
     endCursor: string | null;
     hasNextPage: boolean;
     /**
@@ -128,15 +129,15 @@ export type ColorPageInfo = {
      * the page where paging stops at the pool's 400 cap.
      */
     poolTruncated: boolean;
-};
-type ContainsOrPaletteResult = {
+}
+interface ContainsOrPaletteResult {
     /** Color-matched candidates dropped by `list_variants`' hard filters or eligibility. */
     gatedOut: number;
     matches: ColorVariantMatch[];
     pageInfo: ColorPageInfo;
     resolvedColors: ResolvedColor[];
     unresolvedColors: UnresolvedColor[];
-};
+}
 export type FindVariantsByColorContainsResult = ContainsOrPaletteResult & {
     mode: "contains";
 };
@@ -144,7 +145,7 @@ export type FindVariantsByColorPaletteResult = ContainsOrPaletteResult & {
     mode: "palette";
 };
 /** `reference.candidates`/`reference.seed`'s shape — mirrors `compare-color-similarity.ts`'s own seed, unlike `matches[]` below. */
-export type ColorRankedSeed = {
+export interface ColorRankedSeed {
     brand: string;
     brandSlug: string;
     color: string | null;
@@ -155,9 +156,9 @@ export type ColorRankedSeed = {
     variantId: string;
     /** The variant's own name — paint colorway names live here (label contract). */
     variantName: string | null;
-};
+}
 /** RERANK's own card — the same shape `ColorVariantMatch` above (`brandId`, `code`), plus its perceptual distance. */
-export type ColorRankMatch = {
+export interface ColorRankMatch {
     /** The trimmed source variant label; null when unknown or for a paint color sample. Separate from surface finish, color family and derived color names. */
     variantLabel: string | null;
     brand: string;
@@ -171,13 +172,13 @@ export type ColorRankMatch = {
     productId: string;
     variantId: string;
     variantName: string | null;
-};
-export type ResolvedColorReference = {
+}
+export interface ResolvedColorReference {
     hex: string;
     name: string | null;
     ref: string;
-};
-export type CompareColorSimilarityReference = {
+}
+export interface CompareColorSimilarityReference {
     /** Best-per-brand candidates when `resolution === "ambiguous"`; empty otherwise. */
     candidates: ColorRankedSeed[];
     /** The resolved color when the reference was a `color`, else null. */
@@ -197,8 +198,8 @@ export type CompareColorSimilarityReference = {
     resolution: "resolved" | "ambiguous";
     /** The resolved seed when the reference was a `material`/`variantId`, else null. */
     seed: ColorRankedSeed | null;
-};
-export type FindVariantsByColorRerankResult = {
+}
+export interface FindVariantsByColorRerankResult {
     /** Present ONLY when the request narrowed it. ABSENT means the whole graph. */
     searchCatalogSubset?: SearchCatalogSubsetReceipt;
     /** Real variant ids outside `searchCatalogSubset` or the materials catalog. Present when a scope narrowed or any was excluded. */
@@ -212,6 +213,6 @@ export type FindVariantsByColorRerankResult = {
     resolvedColors: ResolvedColor[];
     /** Candidate ids that did not resolve to any variant. */
     unresolved: string[];
-};
+}
 export type FindVariantsByColorOutput = FindVariantsByColorContainsResult | FindVariantsByColorPaletteResult | FindVariantsByColorRerankResult;
 export {};

package/find-variants-by-vector-types.d.ts

@@ -12,14 +12,14 @@ import type { FilterGroups, VariantCard } from "./list-variants-types.js";
 import type { SearchCatalogSubset } from "./search-catalog-subset-types.js";
 export declare const FIND_VARIANTS_BY_VECTOR_MODES: readonly ["text", "image", "text_and_image"];
 export type FindVariantsByVectorMode = (typeof FIND_VARIANTS_BY_VECTOR_MODES)[number];
-export type FindVariantsByVectorQuery = {
+export interface FindVariantsByVectorQuery {
     /** One to six image references, each with exactly one field. Several are combined into one query, and every seed image's variant is left out. Only for image modes. Each image that has to be embedded spends one of the embed requests. */
     images?: ImageReferenceInput[];
     mode: FindVariantsByVectorMode;
     /** Description, mood words included. Only for text modes. */
     text?: string;
-};
-export type FindVariantsByVectorInput = {
+}
+export interface FindVariantsByVectorInput {
     /** Attribute or block ids to add. */
     attributes?: string[];
     /** Variant ids to leave out. A seed image's own variant is always left out. */
@@ -30,26 +30,26 @@ export type FindVariantsByVectorInput = {
     query: FindVariantsByVectorQuery;
     /** Only this corpus scope. Absent or all: every variant. */
     searchCatalogSubset?: SearchCatalogSubset;
-};
+}
 export type FindVariantsByVectorItem = Omit<VariantCard, "materialBankId"> & {
     /** The variant's Material Bank SKU; null means none is recorded. Always present here, unlike `list_variants`' optional field. */
     materialBankId: string | null;
     /** Voyage cosine to the query. Ranks only; not a probability. */
     similarity: number;
 };
-export type FindVariantsByVectorReference = {
+export interface FindVariantsByVectorReference {
     id: string;
     kind: "url" | "assetId" | "variantId" | "sourceId";
-};
-export type FindVariantsByVectorScan = {
+}
+export interface FindVariantsByVectorScan {
     /** True when no further candidates match; false means more may exist. */
     exhausted: boolean;
     read: number;
     rejected: number;
     /** How filters reached the vector search. Always "metadata": every filter runs inside the kNN. */
     route: "lane" | "metadata" | "allowlist";
-};
-export type FindVariantsByVectorTimings = {
+}
+export interface FindVariantsByVectorTimings {
     embedMs: number;
     /** Time spent filtering outside the kNN. Always 0: filters run inside it. */
     filterMs: number;
@@ -57,8 +57,8 @@ export type FindVariantsByVectorTimings = {
     totalMs: number;
     vectorMs: number;
     verifyMs: number;
-};
-export type FindVariantsByVectorOutput = {
+}
+export interface FindVariantsByVectorOutput {
     /** Explicit `{field: "variant", op: "in"}` filter ids that name a real variant outside the materials catalog — present only when at least one did. */
     excludedBySearchCatalogSubset?: string[];
     items: FindVariantsByVectorItem[];
@@ -71,6 +71,6 @@ export type FindVariantsByVectorOutput = {
     timings: FindVariantsByVectorTimings;
     /** Explicit `{field: "variant", op: "in"}` filter ids that named no eligible variant — present only when at least one did. */
     unresolvedVariantIds?: string[];
-    /** Filtered attributes no variant in scope states at all. Present only on an empty page, so its absence means the empty page is a genuine no-match. */
+    /** Filter fields no variant in scope states at all. Present only on an empty page, so its absence means the empty page is a genuine no-match. */
     unstated?: string[];
-};
+}

package/get-variant-demand-types.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @module get-variant-demand-types
+ * @description Hand-maintained mirror of `get_variant_demand`'s and
+ * `list_rising_variants`' wire shapes.
+ * The source of truth is `packages/demand/src/contract.ts`; this SDK has
+ * no runtime dependency on `@materialgraph/demand`, so the shapes are copied
+ * here.
+ */
+import type { OpenEnum } from "./types.js";
+export interface GetVariantDemandInput {
+    /** 1 to 48 variant ids. */
+    variantIds: string[];
+    /** One Material Bank project type; omit for every project type together. */
+    projectType?: string;
+}
+export type DemandTrend = OpenEnum<"rising" | "steady" | "falling">;
+export type VariantDemand = {
+    state: "measured";
+    variantId: string;
+    /** The category the percentile is ranked within. */
+    category: string;
+    /** Share of the category's variants sampled as much or less, 1 to 100. */
+    samplePercentile: number;
+    /** Null when the year before cannot be shown. */
+    trend: DemandTrend | null;
+    /** This year against the year before; 0.4 is 40% more. Null with `trend`. */
+    change: number | null;
+}
+/** Too few members sampled it to show, or nobody did. */
+ | {
+    state: "not_shown";
+    variantId: string;
+} | {
+    state: "unknown_variant";
+    variantId: string;
+};
+export interface GetVariantDemandOutput {
+    /** Last day of the measured year, as an ISO date. */
+    asOf: string;
+    basis: "measured";
+    source: string;
+    /** One reading per requested id, in request order, duplicates kept. */
+    results: VariantDemand[];
+}
+export interface ListRisingVariantsInput {
+    /** A MaterialGraph category id, such as `wallcovering`. */
+    category: string;
+    /** Variants to return, at most 100. Default 20. */
+    limit?: number;
+    /** One Material Bank project type; omit for every project type together. */
+    projectType?: string;
+}
+export interface RisingVariant {
+    variantId: string;
+    /** Share of the category's variants sampled as much or less, 1 to 100. */
+    samplePercentile: number;
+    trend: DemandTrend | null;
+    /** This year against the year before; 0.4 is 40% more. */
+    change: number | null;
+}
+export interface ListRisingVariantsOutput {
+    /** Last day of the measured year, as an ISO date. */
+    asOf: string;
+    basis: "measured";
+    category: string;
+    /** Largest change first. */
+    results: RisingVariant[];
+    source: string;
+}

package/get-variant-demand-types.js

@@ -0,0 +1 @@
+export {};

package/get-variant-types.d.ts

@@ -10,7 +10,7 @@
 import type { ListVariantsNotApplicable, ListVariantsSpecifications, SampleSubject, VariantObservations } from "./list-variants-types.js";
 import type { VariantColorPalette } from "./material-block-types.js";
 /** The detail to add under `specifications`; absent, the answer is the compact item alone. */
-export type GetVariantOptions = {
+export interface GetVariantOptions {
     /** Canonical attribute ids, e.g. `["nrc"]`. */
     attributes?: readonly string[];
     /** Canonical block ids, returned whole, e.g. `["acoustic"]`. */
@@ -19,12 +19,12 @@ export type GetVariantOptions = {
     observations?: readonly string[];
     /** Add `ifc`: the IFC 4.3 manufacturer property set and classification references. */
     ifc?: boolean;
-};
+}
 /**
  * The variant as an IFC 4.3 type states it. Properties the record does not
  * hold are left out, so an absent property is unknown.
  */
-export type GetVariantIfc = {
+export interface GetVariantIfc {
     propertySets: {
         name: "Pset_ManufacturerTypeInformation";
         properties: {
@@ -41,13 +41,13 @@ export type GetVariantIfc = {
         name?: string;
         edition?: string;
     }[];
-};
+}
 /**
  * One variant: the compact identity, and `specifications` only for the
  * attributes and blocks that were asked for. Only stated values appear there:
  * an unknown value, and a block with none, is absent, never false or zero.
  */
-export type GetVariantOutput = {
+export interface GetVariantOutput {
     /** Whether this variant may appear in its Brand's catalog. Material-only lists also require Search Catalog membership. Reads by id include ineligible variants. */
     eligible: boolean;
     channels: string[];
@@ -59,7 +59,7 @@ export type GetVariantOutput = {
     }[];
     attributes: Record<string, {
         value: unknown;
-        valueSource: "brand" | "material_bank" | "measured" | "manual" | null;
+        valueSource: "brand" | "material_bank" | "measured" | "manual" | "inferred" | null;
         wording: string | null;
         level: "variant" | "product" | "brand";
     }>;
@@ -117,4 +117,4 @@ export type GetVariantOutput = {
     };
     url: string | null;
     variantId: string;
-};
+}

package/http-transport.d.ts

@@ -1,37 +1,38 @@
 import type { RateLimit } from "./errors.js";
+import type { JsonValue } from "./json-value-types.js";
 import type { JsonOperationId, OperationResponses } from "./operation-responses.js";
 import type { SdkOperation } from "./operations.js";
 type QueryValue = string | number | boolean | undefined | null | (string | number | boolean)[];
 export type QueryParams = Record<string, QueryValue>;
-export type RequestOptions = {
+export interface RequestOptions {
     /** Required by state-changing operations that support safe retries. */
     idempotencyKey?: string;
     query?: QueryParams;
     body?: unknown;
     signal?: AbortSignal;
     pathParams?: Readonly<Record<string, string>>;
-};
+}
 /** A read, status-checked HTTP response with its parsed body. */
-export type SentResponse = {
+export interface SentResponse {
     response: Response;
     text: string;
-    parsed: unknown;
-};
-type SendInput = {
+    parsed: JsonValue | undefined;
+}
+interface SendInput {
     method: string;
     url: string;
     headers: Record<string, string>;
     /** The only bodies the SDK sends: a JSON string or a multipart `FormData`. */
     body?: string | FormData;
     signal?: AbortSignal;
-};
-export type HttpTransportOptions = {
+}
+export interface HttpTransportOptions {
     apiKey: string;
     baseUrl: string;
     fetch: typeof fetch;
     /** Deadline in milliseconds for each JSON or upload request. Not applied to streams. */
     timeoutMs?: number;
-};
+}
 export declare class HttpTransport {
     #private;
     readonly baseUrl: string;
@@ -40,7 +41,10 @@ export declare class HttpTransport {
     constructor(options: HttpTransportOptions);
     get lastRateLimit(): RateLimit | null;
     /** The bearer + JSON `Accept` headers, plus any per-request additions. */
-    authHeaders(extra?: Record<string, string>): Record<string, string>;
+    authHeaders(extra?: Record<string, string>): {
+        Accept: string;
+        Authorization: string;
+    };
     buildUrl(path: string, query?: QueryParams): string;
     /**
      * Send one request, capture rate limits, read the body, and map a non-2xx or

package/http-transport.js

@@ -6,6 +6,7 @@
  * failure surfaces as one {@link MaterialGraphError}.
  */
 import { MaterialGraphError } from "./errors.js";
+import { parseJson } from "./json.js";
 import { operationPath } from "./operations.js";
 import { parseOperationResponse } from "./parse-operation-response.js";
 const parseNumberOrNull = (value) => {
@@ -106,11 +107,11 @@ export class HttpTransport {
                 signal,
             });
         }
-        catch (cause) {
+        catch (error) {
             throw MaterialGraphError.fromTransport({
                 ...metadata,
                 callerSignal: signal,
-                cause,
+                cause: error,
             });
         }
         const rateLimit = parseRateLimit(response.headers);
@@ -119,17 +120,17 @@ export class HttpTransport {
         try {
             text = await response.text();
         }
-        catch (cause) {
+        catch (error) {
             throw MaterialGraphError.fromTransport({
                 ...metadata,
                 callerSignal: signal,
-                cause,
+                cause: error,
             });
         }
         let parsed;
         if (text.length > 0) {
             try {
-                parsed = JSON.parse(text);
+                parsed = parseJson(text);
             }
             catch {
                 parsed = text;
@@ -152,15 +153,16 @@ export class HttpTransport {
     async requestJson(sdkOperation, options = {}) {
         const url = this.buildUrl(operationPath(sdkOperation, options.pathParams), options.query);
         const hasBody = options.body !== undefined;
+        const extraHeaders = {};
+        if (hasBody) {
+            extraHeaders["Content-Type"] = "application/json";
+        }
+        if (options.idempotencyKey !== undefined && options.idempotencyKey !== "") {
+            extraHeaders["Idempotency-Key"] = options.idempotencyKey;
+        }
         const { parsed } = await this.send({
             body: hasBody ? JSON.stringify(options.body) : undefined,
-            headers: this.authHeaders({
-                ...(hasBody ? { "Content-Type": "application/json" } : {}),
-                ...(options.idempotencyKey !== undefined &&
-                    options.idempotencyKey !== ""
-                    ? { "Idempotency-Key": options.idempotencyKey }
-                    : {}),
-            }),
+            headers: this.authHeaders(extraHeaders),
             method: sdkOperation.method,
             signal: options.signal,
             url,

package/image-reference-types.d.ts

@@ -6,7 +6,7 @@
  * or an existing variant's own image. Exactly one field is set per call; the
  * server refuses more than one.
  */
-export type ImageReferenceInput = {
+export interface ImageReferenceInput {
     /** Catalog asset id. */
     assetId?: string;
     /** Upload id (`smf_...`) from source-material. */
@@ -15,4 +15,4 @@ export type ImageReferenceInput = {
     url?: string;
     /** Variant whose image to use. */
     variantId?: string;
-};
+}

package/index.d.ts

@@ -4,10 +4,12 @@ export type { MaterialGraphClientOptions } from "./client.js";
 export type { FilterOp, FilterTermCondition, FilterNumericCondition, FilterPresenceCondition, FilterAnyFieldCondition, FilterCondition, FilterGroups, OptionalFilterGroups, OrderByEntry, ListVariantsInclude, ListVariantsCollapse, ColorRegion, ColorRangeCondition, ListVariantsInput, ListVariantsPreference, ListVariantsSpecifications, ListVariantsNotApplicable, SampleSizeObservation, VariantObservations, SampleSubject, ListVariantsItem, ListVariantsOutput, VariantCard, } from "./list-variants-types.js";
 export type { ListVariantFacetsInput, VariantFacetValue, CategoricalVariantFacet, BooleanVariantFacet, NumericVariantFacet, VariantFacet, ListVariantFacetsOutput, } from "./list-variant-facets-types.js";
 export type { SearchVariantsSelection, SearchVariantsInput, SearchVariantsUnderstood, SearchVariantsReading, SearchVariantsSuggestion, SearchVariantsChoice, SearchVariantsOutput, } from "./search-variants-types.js";
+export type { Baseline, BaselineResult, BaselineSource, BaselineStrength, BaselineWayToMeet, CheckBaselinesInput, CheckBaselinesResult, ListBaselinesOptions, ListBaselinesResult, } from "./baseline-types.js";
 export type { ListEnumValuesOptions, EnumValueMatch, EnumValueItem, ListEnumValuesResult, } from "./list-enum-values-types.js";
 export type { GetVariantIfc, GetVariantOptions, GetVariantOutput, } from "./get-variant-types.js";
 export type { ImageReferenceInput } from "./image-reference-types.js";
 export type { SampledTogetherProjectType, FindSampledTogetherInput, FindSampledTogetherRow, FindSampledTogetherOutput, } from "./find-sampled-together-types.js";
+export type { GetVariantDemandInput, GetVariantDemandOutput, DemandTrend, VariantDemand, ListRisingVariantsInput, ListRisingVariantsOutput, RisingVariant, } from "./get-variant-demand-types.js";
 export type { ListSampledTogetherPairsInput, ListSampledTogetherPairsOutput, SampledTogetherPair, } from "./list-sampled-together-pairs-types.js";
 export type { FindVariantsByColorMode, ColorConditionInput, FindVariantsByColorInput, ColorConditionReceipt, PaintCatalogVariant, ResolvedColor, ColorAlternative, UnresolvedColor, ColorVariantMatch, ColorPageInfo, FindVariantsByColorContainsResult, FindVariantsByColorPaletteResult, ColorRankedSeed, ColorRankMatch, ResolvedColorReference, CompareColorSimilarityReference, FindVariantsByColorRerankResult, FindVariantsByColorOutput, } from "./find-variants-by-color-types.js";
 export { FIND_VARIANTS_BY_VECTOR_MODES } from "./find-variants-by-vector-types.js";
@@ -18,7 +20,7 @@ export type { OpaqueId, VariantId, ProductId, BatchId, SourceFileId, ProjectId,
 export type { FileInput, UploadSourceMaterialInput, SourceMaterialReceiptFile, SourceMaterialBatchReceipt, } from "./source-material-types.js";
 export { MATERIALGRAPH_PROBLEM_EXTENSIONS, MaterialGraphError, } from "./errors.js";
 export type { MaterialGraphErrorInit, MaterialGraphErrorKind, MaterialGraphRequestMetadata, ProblemDetail, RateLimit, SanitizedErrorValue, SanitizedIssue, SimpleErrorBody, } from "./errors.js";
-export type { OpenEnum, JsonValue, OklabTriple, MaterialColor, ImageSource, MaterialAvailability, MaterialTile, DemandMomentum, CompanionDemand, ProjectTypeShare, CospecPairing, ColorPairing, PairingOrderMode, PairingRanking, PairingOrdering, PairingItem, PairingsResponse, AttributeMatch, AttributeListItem, OutsideScopeAttribute, ListAttributesResult, WhoamiResponse, PairingsOptions, ListAttributesOptions, ExtractedPalette, ExtractPaletteResponse, ExtractPaletteInput, ResolveValueCandidate, ValueResolution, ResolveColorOptions, ResolveColorCatalogVariant, ResolveColorVariant, ResolveColorResponse, BySpecVerdictState, BySpecVerdictCell, BySpecVerdict, MaterialVerdict, BySpecUnresolvedCriterion, } from "./types.js";
+export type { OpenEnum, JsonValue, OklabTriple, MaterialColor, ImageSource, MaterialAvailability, MaterialTile, CompanionDemand, ProjectTypeShare, CospecPairing, ColorPairing, PairingOrderMode, PairingRanking, PairingOrdering, PairingItem, PairingsResponse, AttributeMatch, AttributeListItem, OutsideScopeAttribute, ListAttributesResult, WhoamiResponse, PairingsOptions, ListAttributesOptions, ExtractedPalette, ExtractPaletteResponse, ExtractPaletteInput, ResolveValueCandidate, ValueResolution, ResolveColorOptions, ResolveColorCatalogVariant, ResolveColorVariant, ResolveColorResponse, BySpecVerdictState, BySpecVerdictCell, BySpecVerdict, MaterialVerdict, BySpecUnresolvedCriterion, } from "./types.js";
 export type { ResolveVariantInput, ResolveVariantSubject, ResolveVariantEvidence, ResolveVariantReceipt, ResolveVariantUnresolvedReason, ResolveVariantOutput, } from "./resolve-variant-types.js";
 export { CategoriesClient } from "./categories-client.js";
 export type { CategoryRef, CategoryKind, CategoryMatch, CategoryItem, CategoriesPageInfo, CategoriesListInput, CategoriesListResult, CategoryConcept, CategoryProductCategory, CategoriesGetResult, } from "./category-types.js";

package/json.d.ts

@@ -0,0 +1,18 @@
+import type { JsonValue } from "./json-value-types.js";
+/** A JSON object: string keys, JSON values. */
+export interface JsonObject {
+    [key: string]: JsonValue;
+}
+export type JsonKind = "array" | "boolean" | "null" | "number" | "object" | "string" | "undefined";
+/** What a parsed JSON value is, or `undefined` for a key an object lacks. */
+export declare const jsonKind: (value: JsonValue | undefined) => JsonKind;
+export declare const isJsonObject: (value: JsonValue | undefined) => value is JsonObject;
+export declare const isJsonString: (value: JsonValue | undefined) => value is string;
+export declare const isJsonNumber: (value: JsonValue | undefined) => value is number;
+/** Parses JSON text; throws on text that is not JSON. */
+export declare const parseJson: (text: string) => JsonValue;
+/**
+ * Reads a value of unknown origin as the JSON it would serialize to. A value
+ * JSON cannot represent, such as a `bigint`, reads as absent.
+ */
+export declare const toJsonValue: (value: unknown) => JsonValue | undefined;

package/json.js

@@ -0,0 +1,36 @@
+/** What a parsed JSON value is, or `undefined` for a key an object lacks. */
+export const jsonKind = (value) => {
+    if (value === null) {
+        return "null";
+    }
+    if (Array.isArray(value)) {
+        return "array";
+    }
+    // oxlint-disable-next-line anti-slop/no-runtime-typeof -- This is the one place a parsed JSON value is classified; every other check calls it.
+    const kind = typeof value;
+    if (kind === "boolean" || kind === "number" || kind === "string") {
+        return kind;
+    }
+    return kind === "undefined" ? "undefined" : "object";
+};
+export const isJsonObject = (value) => jsonKind(value) === "object";
+export const isJsonString = (value) => jsonKind(value) === "string";
+export const isJsonNumber = (value) => jsonKind(value) === "number";
+/** Parses JSON text; throws on text that is not JSON. */
+export const parseJson = (text) => 
+// oxlint-disable-next-line typescript/no-unsafe-return -- `JSON.parse` returns exactly the values `JsonValue` names.
+JSON.parse(text);
+/**
+ * Reads a value of unknown origin as the JSON it would serialize to. A value
+ * JSON cannot represent, such as a `bigint`, reads as absent.
+ */
+// oxlint-disable-next-line anti-slop/no-unknown-parameters -- A published caller may pass any body; this is where it becomes JSON.
+export const toJsonValue = (value) => {
+    try {
+        const text = JSON.stringify(value);
+        return text === undefined ? undefined : parseJson(text);
+    }
+    catch {
+        return undefined;
+    }
+};

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

@@ -8,7 +8,7 @@
  */
 import type { OpenEnum } from "./types.js";
 /** Options for `listEnumValues()` (GET `/api/v1/catalog/enum-values`). */
-export type ListEnumValuesOptions = {
+export interface ListEnumValuesOptions {
     /**
      * A value dictionary id, from a `listAttributes()` item's `dictionaryId`.
      * Required without a `query`; with a `query`, omit it to search every
@@ -21,9 +21,9 @@ export type ListEnumValuesOptions = {
     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 = {
+export interface EnumValueMatch {
     method: OpenEnum<"exact" | "alias" | "fuzzy" | "vector">;
     /** The id, label or alias that matched, or null for a match by meaning. */
     matchedText: string | null;
@@ -33,9 +33,9 @@ export type EnumValueMatch = {
     resolvedFrom?: string;
     /** Cosine similarity, 1 best. */
     similarity?: number;
-};
+}
 /** One allowed value of a dictionary. */
-export type EnumValueItem = {
+export interface 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. */
@@ -46,8 +46,8 @@ export type EnumValueItem = {
     match?: EnumValueMatch;
     /** The bare term id `listVariants()` accepts for any of `attributeIds`. */
     valueId: string;
-};
-export type ListEnumValuesResult = {
+}
+export interface ListEnumValuesResult {
     /** The dictionary the page was read from; null when a query searched every dictionary. */
     dictionaryId: string | null;
     items: EnumValueItem[];
@@ -55,4 +55,4 @@ export type ListEnumValuesResult = {
         endCursor: string | null;
         hasNextPage: boolean;
     };
-};
+}