@instruments/materialgraph 0.38.0 → 0.39.0

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

@@ -47,14 +47,14 @@ export type FindVariantsByColorInput = {
     variantIds?: string[];
 };
 export type ColorConditionReceipt = {
-    /** OKLab distance to the matched swatch. Never a probability. */
+    /** CIEDE2000 difference to the assigned settled swatch. Never a probability. */
     distance: number;
     hex: string;
     /** Position in the request's `colors[]`. */
     index: number;
-    /** The matched swatch's share of its image, 0 to 1. */
+    /** The assigned swatch's share of the settled palette, 0 to 1. */
     proportion: number;
-    /** Requested target share, palette only; null otherwise. Ranked by, not filtered. */
+    /** Requested share used for ColorVec retrieval, palette only; null otherwise. */
     target: number | null;
 };
 export type PaintCatalogVariant = {
@@ -71,7 +71,7 @@ export type ResolvedColor = {
     index: number;
     /** `region`: a named meaning's own OKLCh bounds, kept — never collapsed to one hex. */
     kind: "point" | "region";
-    /** Renormalised share, image-extracted colors only; else null. */
+    /** Image-extracted or stored target-variant swatch share; else null. */
     share: number | null;
 };
 export type ColorAlternative = {
@@ -143,14 +143,12 @@ export type ColorRankedSeed = {
     /** 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 two ranking-only fields. */
+/** RERANK's own card — the same shape `ColorVariantMatch` above (`brandId`, `code`), plus its perceptual distance. */
 export type ColorRankMatch = {
     brand: string;
     brandId: string;
     code: string | null;
-    /** Color similarity in [0,1], 1 = identical palette; null when unembedded. */
-    colorSimilarity: number | null;
-    /** Cosine distance computed in TypeScript (0 = identical); null when unembedded. */
+    /** CIEDE2000 difference to the settled reference color (0 = identical); null without a settled palette. */
     distance: number | null;
     imageUrl: string | null;
     product: string;

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

@@ -1,3 +1,4 @@
+import type { PaintCatalogVariant } from "./find-variants-by-color-types.js";
 /**
  * @module find-variants-by-vector-types
  * @description Hand-maintained mirror of `find_variants_by_vector`'s
@@ -61,6 +62,8 @@ export type FindVariantsByVectorOutput = {
     items: FindVariantsByVectorItem[];
     mode: FindVariantsByVectorMode;
     reference: FindVariantsByVectorReference;
+    /** The exact brand paint named by the text query, when held in the catalogue. */
+    namedPaint?: PaintCatalogVariant;
     scan: FindVariantsByVectorScan;
     timings: FindVariantsByVectorTimings;
     /** Explicit `{field: "variant", op: "in"}` filter ids that named no eligible variant — present only when at least one did. */

package/get-variant-types.d.ts

@@ -8,6 +8,7 @@
  * server types.
  */
 import type { ListVariantsNotApplicable, ListVariantsSpecifications, SampleSubject } 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 = {
     /** Canonical attribute ids, e.g. `["nrc_rating"]`. */
@@ -21,6 +22,20 @@ export type GetVariantOptions = {
  * false or zero.
  */
 export type GetVariantOutput = {
+    eligible: boolean;
+    channels: string[];
+    palette: {
+        hex: string;
+        share: number;
+        dominant: boolean;
+        method: "stated" | "isolated" | "crop";
+    }[];
+    attributes: Record<string, {
+        value: unknown;
+        valueSource: "brand" | "material_bank" | "samplize" | "measured" | null;
+        wording: string | null;
+        level: "variant" | "product" | "brand";
+    }>;
     category: {
         id: string;
         name: string;
@@ -56,7 +71,13 @@ export type GetVariantOutput = {
         id: string;
         name: string;
     };
-    specifications?: ListVariantsSpecifications;
+    specifications?: ListVariantsSpecifications & {
+        color?: Record<string, unknown> & {
+            /** Measured bands, largest share first; paints use one declared color band. Absent means unknown. */
+            color_palette?: VariantColorPalette;
+            light_reflectance_value?: unknown;
+        };
+    };
     url: string | null;
     variantId: string;
 };

package/http-transport.d.ts

@@ -1,4 +1,5 @@
 import type { RateLimit } from "./errors.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>;
@@ -63,6 +64,6 @@ export declare class HttpTransport {
      */
     openStream(sdkOperation: SdkOperation, options: StreamRequestOptions): Promise<ReadableStream<Uint8Array>>;
     /** Execute a registered JSON operation and return its typed body. */
-    requestJson<T>(sdkOperation: SdkOperation, options?: RequestOptions): Promise<T>;
+    requestJson<K extends JsonOperationId>(sdkOperation: SdkOperation<K>, options?: RequestOptions): Promise<OperationResponses[K]>;
 }
 export {};

package/http-transport.js

@@ -7,18 +7,19 @@
  */
 import { MaterialGraphError } from "./errors.js";
 import { operationPath } from "./operations.js";
-const parseIntOrNull = (value) => {
-    if (value === null) {
+import { parseOperationResponse } from "./parse-operation-response.js";
+const parseNumberOrNull = (value) => {
+    if (value === null || value.trim() === "") {
         return null;
     }
-    const parsed = Number.parseInt(value, 10);
-    return Number.isNaN(parsed) ? null : parsed;
+    const parsed = Number(value);
+    return Number.isFinite(parsed) ? parsed : null;
 };
 const parseRateLimit = (headers) => {
-    const limit = parseIntOrNull(headers.get("x-ratelimit-limit"));
-    const remaining = parseIntOrNull(headers.get("x-ratelimit-remaining"));
-    const reset = parseIntOrNull(headers.get("x-ratelimit-reset"));
-    const retryAfter = parseIntOrNull(headers.get("retry-after"));
+    const limit = parseNumberOrNull(headers.get("x-ratelimit-limit"));
+    const remaining = parseNumberOrNull(headers.get("x-ratelimit-remaining"));
+    const reset = parseNumberOrNull(headers.get("x-ratelimit-reset"));
+    const retryAfter = parseNumberOrNull(headers.get("retry-after"));
     if (limit === null &&
         remaining === null &&
         reset === null &&
@@ -214,7 +215,8 @@ export class HttpTransport {
             body: hasBody ? JSON.stringify(options.body) : undefined,
             headers: this.authHeaders({
                 ...(hasBody ? { "Content-Type": "application/json" } : {}),
-                ...(options.idempotencyKey
+                ...(options.idempotencyKey !== undefined &&
+                    options.idempotencyKey !== ""
                     ? { "Idempotency-Key": options.idempotencyKey }
                     : {}),
             }),
@@ -222,6 +224,6 @@ export class HttpTransport {
             signal: options.signal,
             url,
         });
-        return parsed;
+        return await parseOperationResponse(sdkOperation.operationId, parsed);
     }
 }

package/index.d.ts

@@ -1,33 +1,34 @@
 export { MaterialGraphClient, DEFAULT_BASE_URL } from "./client.js";
 export type { MaterialGraphClientOptions } from "./client.js";
-export type * from "./list-variants-types.js";
-export type * from "./list-variant-facets-types.js";
-export type * from "./search-variants-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-sampled-together-types.js";
-export type * from "./find-variants-by-color-types.js";
+export type { FilterOp, FilterTermCondition, FilterNumericCondition, FilterPresenceCondition, FilterAnyFieldCondition, FilterCondition, FilterGroups, OptionalFilterGroups, OrderByEntry, ListVariantsInclude, ListVariantsCollapse, ColorRegion, ColorRangeCondition, ListVariantsInput, ListVariantsPreference, ListVariantsSpecifications, ListVariantsNotApplicable, SampleSubject, ListVariantsItem, ListVariantsOutput, } 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, SearchVariantsChoice, SearchVariantsOutput, } from "./search-variants-types.js";
+export type { ListEnumValuesOptions, EnumValueMatch, EnumValueItem, ListEnumValuesResult, } from "./list-enum-values-types.js";
+export type { 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 { 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";
-export type * from "./find-variants-by-vector-types.js";
+export type { FindVariantsByVectorMode, FindVariantsByVectorQuery, FindVariantsByVectorInput, FindVariantsByVectorItem, FindVariantsByVectorReference, FindVariantsByVectorScan, FindVariantsByVectorTimings, FindVariantsByVectorOutput, } from "./find-variants-by-vector-types.js";
 export { MATERIALGRAPH_API_VERSION, SDK_OPERATIONS } from "./operations.js";
 export type { SdkOperation, SdkOperationId } from "./operations.js";
-export type * from "./identifiers.js";
+export type { OpaqueId, VariantId, ProductId, RunId, BatchId, SourceFileId, ProjectId, SchemeId, SlotId, Cursor, } from "./identifiers.js";
 export { TERMINAL_RUN_EVENT_TYPES } from "./run-types.js";
-export type * from "./run-types.js";
+export type { FileInput, UploadSourceMaterialInput, SourceMaterialReceiptFile, SourceMaterialBatchReceipt, PublicRunStatus, PublicRunFailure, PublicRunArtifactRef, PublicRun, CreatePublicRunRequest, CreatePublicRunResponse, PublicRunResponse, RunEvent, StreamRunEventsOptions, DrainRunEventsOptions, } from "./run-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 * from "./types.js";
-export type * from "./resolve-variant-types.js";
-export type * from "./catalogue-types.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, ResolveColorCatalogueVariant, ResolveColorVariant, ResolveColorResponse, BySpecVerdictState, BySpecVerdictCell, BySpecVerdict, MaterialVerdict, BySpecUnresolvedCriterion, } from "./types.js";
+export type { ResolveVariantInput, ResolveVariantSubject, ResolveVariantEvidence, ResolveVariantReceipt, ResolveVariantUnresolvedReason, ResolveVariantOutput, } from "./resolve-variant-types.js";
+export type { CatalogueReference, CatalogueReferenceAbsenceReason, CatalogueReferencePublication, CatalogueReferenceResult, CatalogueReferenceBatchResponse, CatalogueCollectionsOptions, CatalogueCollectionSampleProduct, CatalogueChannelCollection, CatalogueChannelCollectionsResponse, CatalogueDocumentAccess, CatalogueDocumentAccessResult, CatalogDocument, CatalogEdition, CatalogAvailableReceipt, CatalogFailureReceipt, UnavailableCatalogDocument, CatalogPublication, CatalogDocumentList, CatalogProductReferenceList, CatalogProductReferenceUnavailable, CatalogProductReferenceReadResult, CataloguePageRequiredArtifact, CataloguePageAvailableArtifact, CataloguePage, CatalogPageListResult, CataloguePageRepresentationReadResult, } from "./catalogue-types.js";
 export { CategoriesClient } from "./categories-client.js";
-export type * from "./category-types.js";
+export type { CategoryRef, CategoryKind, CategoryMatch, CategoryItem, CategoriesPageInfo, CategoriesListInput, CategoriesListResult, CategoryConcept, CategoryProductCategory, CategoriesGetResult, } from "./category-types.js";
 export { ColorsClient } from "./colors-client.js";
 export type { ColorsTransport } from "./colors-client.js";
-export type * from "./color-profiles-types.js";
-export type * from "./association-types.js";
-export type * from "./brand-types.js";
-export type * from "./material-asset-types.js";
-export type * from "./material-block-types.js";
-export type * from "./schema-resource-types.js";
+export type { CategoryTier, CategoryColor, CategoryColorProfile, CategoryColorProfilesResponse, ColorProfilesParams, } from "./color-profiles-types.js";
+export type { DeclaredProvenance, DeclaredAssociationSubject, DeclaredAssociation, DeclaredAssociationsResponse, AssociatedOptions, ApplicabilitySubject, ApplicabilityCoverageState, ApplicabilityCoverage, ApplicabilityFact, ApplicabilitySourceEntry, UnresolvedApplicabilityEndpoint, ApplicabilityResponse, ApplicabilityOptions, } from "./association-types.js";
+export type { BrandsOptions, BrandItem, ListBrandsPage, } from "./brand-types.js";
+export type { VariantAssetAvailability, VariantImageRole, VariantImagePresentation, VariantDocumentType, VariantAssetKind, VariantAssetItem, VariantDocumentCoverageState, VariantAssetPageInfo, ListVariantAssetsOptions, VariantAssetPage, MaterialDocumentStatus, MaterialDocumentCoverageState, MaterialDocumentScope, MaterialDocumentSource, MaterialDocumentProjectionItem, MaterialDocumentCoverageSource, MaterialDocumentCoverage, MaterialDocumentCoverageSummary, MaterialDocumentPageOptions, MaterialDocumentPage, } from "./material-asset-types.js";
+export type { MaterialCoverageStatus, MaterialBlockStatus, MaterialBlockFieldStatus, MaterialBlockFieldValue, MaterialBlockProjectionField, MaterialBlockProjectionItem, MaterialBlockProjection, VariantColorPalette, } from "./material-block-types.js";
+export type { SchemaResource, SCHEMA_RESOURCE_OPERATION_IDS, SchemaResourceRequest, SchemaLifecycle, SchemaExternalMapping, SchemaMatchStrength, SchemaValueDictionaryTerm, SchemaValueDictionaryItem, SchemaResourceItemMap, SchemaResourceResponse, } from "./schema-resource-types.js";
 export type { SamplizePublicationSource, SamplizeLrvObservation, SamplizeDemand, SamplizeCollectionMembership, SamplizeCatalogueOptions, SamplizeCataloguePage, SamplizeCatalogueProduct, SamplizeHexObservation, } from "./samplize-catalogue-types.js";
+export type { NearestPaintsParams, NearestPaintCard, NearestPaintsHexResult, NearestPaintsOutput, } from "./nearest-paints-types.js";

package/material-block-types.d.ts

@@ -35,6 +35,12 @@ import type { OpenEnum } from "./types.js";
 export type MaterialCoverageStatus = OpenEnum<"complete" | "partial" | "missing" | "not_applicable">;
 export type MaterialBlockStatus = MaterialCoverageStatus;
 export type MaterialBlockFieldStatus = MaterialCoverageStatus;
+/** Stored image bands, or one declared paint color regardless of image bands. Hexes use uppercase #RRGGBB. */
+export type VariantColorPalette = {
+    hex: string;
+    share: number;
+    dominant: boolean;
+}[];
 /**
  * A field's value. `null` is AMBIGUOUS on its own — pair it with `status`:
  * `complete` + `null` is a determined absence, `missing` + `null` is unread.
@@ -55,7 +61,7 @@ export type MaterialBlockProjectionField = {
     unit?: string;
     status: MaterialBlockFieldStatus;
     /** Provenance supplied by the graph when a source-backed claim supports this field. */
-    valueOrigin?: string;
+    valueSource?: string;
     /** Claim confidence supplied by the graph; absence means no confidence was emitted. */
     confidence?: number;
 };

package/material-resources-client.js

@@ -1,6 +1,9 @@
 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 });
+export const materialBlocks = async (transport, variantId, signal) => await transport.requestJson(resolveOperation("list_material_blocks"), {
+    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

package/nearest-paints-types.d.ts

@@ -0,0 +1,33 @@
+export type NearestPaintsParams = {
+    hexes: string[];
+    limit?: number;
+};
+export type NearestPaintCard = {
+    variantId: string;
+    name: string;
+    brand: {
+        id: string;
+        name: string;
+    };
+    code: string | null;
+    hex: string;
+    sampleSubject: "material" | "paint_color_sample" | "unknown" | "conflict";
+    productType: {
+        id: string;
+        name: string;
+    } | null;
+    image: {
+        url: string;
+        alt: string;
+    } | null;
+    lrv: number | null;
+    deltaE: number;
+    closeness: "very-near" | "very-close" | "close" | "related" | "unrelated";
+};
+export type NearestPaintsHexResult = {
+    hex: string;
+    paints: NearestPaintCard[];
+};
+export type NearestPaintsOutput = {
+    results: NearestPaintsHexResult[];
+};

package/nearest-paints-types.js

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

package/operation-responses.d.ts

@@ -0,0 +1,65 @@
+/** Response types belong to operation ids, never a caller-selected generic. */
+import type { ApplicabilityResponse, DeclaredAssociationsResponse } from "./association-types.js";
+import type { ListBrandsPage } from "./brand-types.js";
+import type { CatalogDocumentList, CatalogPageListResult, CatalogProductReferenceReadResult, CatalogueChannelCollectionsResponse, CatalogueDocumentAccessResult, CataloguePageRepresentationReadResult, CatalogueReferenceBatchResponse } from "./catalogue-types.js";
+import type { CategoriesGetResult, CategoriesListResult } from "./category-types.js";
+import type { CategoryColorProfilesResponse } from "./color-profiles-types.js";
+import type { FindSampledTogetherOutput } from "./find-sampled-together-types.js";
+import type { FindVariantsByColorOutput } from "./find-variants-by-color-types.js";
+import type { FindVariantsByVectorOutput } from "./find-variants-by-vector-types.js";
+import type { GetVariantOutput } from "./get-variant-types.js";
+import type { ListEnumValuesResult } from "./list-enum-values-types.js";
+import type { ListVariantFacetsOutput } from "./list-variant-facets-types.js";
+import type { ListVariantsOutput } from "./list-variants-types.js";
+import type { MaterialDocumentPage, VariantAssetPage } from "./material-asset-types.js";
+import type { MaterialBlockProjection } from "./material-block-types.js";
+import type { NearestPaintsOutput } from "./nearest-paints-types.js";
+import type { ResolveVariantOutput } from "./resolve-variant-types.js";
+import type { CreatePublicRunResponse, PublicRunResponse, SourceMaterialBatchReceipt } from "./run-types.js";
+import type { SamplizeCataloguePage } from "./samplize-catalogue-types.js";
+import type { SchemaResourceResponse } from "./schema-resource-types.js";
+import type { SearchVariantsOutput } from "./search-variants-types.js";
+import type { ExtractPaletteResponse, ListAttributesResult, PairingsResponse, ResolveColorResponse, WhoamiResponse } from "./types.js";
+export type OperationResponses = {
+    find_nearest_paints: NearestPaintsOutput;
+    get_catalogue_generation: {
+        generation: number;
+    };
+    catalog_list_attributes: ListAttributesResult;
+    catalog_list_enum_values: ListEnumValuesResult;
+    create_public_run: CreatePublicRunResponse;
+    extract_image_palette: ExtractPaletteResponse;
+    find_sampled_together: FindSampledTogetherOutput;
+    find_variants_by_color: FindVariantsByColorOutput;
+    find_variants_by_vector: FindVariantsByVectorOutput;
+    get_applicability: ApplicabilityResponse;
+    get_catalog_page_representation: CataloguePageRepresentationReadResult;
+    get_catalogue_document_access: CatalogueDocumentAccessResult;
+    get_catalogue_references_batch: CatalogueReferenceBatchResponse;
+    get_category: CategoriesGetResult;
+    get_category_color_profiles: CategoryColorProfilesResponse;
+    get_material_pairings: PairingsResponse;
+    get_public_run: PublicRunResponse;
+    get_variant: GetVariantOutput;
+    list_associated_finishes: DeclaredAssociationsResponse;
+    list_associated_products: DeclaredAssociationsResponse;
+    list_brands: ListBrandsPage;
+    list_catalog_documents: CatalogDocumentList;
+    list_catalog_pages: CatalogPageListResult;
+    list_catalog_product_references: CatalogProductReferenceReadResult;
+    list_catalogue_channel_collections: CatalogueChannelCollectionsResponse;
+    list_categories: CategoriesListResult;
+    list_material_blocks: MaterialBlockProjection;
+    list_material_documents: MaterialDocumentPage;
+    list_schema_value_dictionaries: SchemaResourceResponse;
+    list_variant_assets: VariantAssetPage;
+    list_variant_facets: ListVariantFacetsOutput;
+    list_variants: ListVariantsOutput;
+    resolve_color_name: ResolveColorResponse;
+    resolve_variant: ResolveVariantOutput;
+    samplize_catalogue_products: SamplizeCataloguePage;
+    search_variants: SearchVariantsOutput;
+    upload_source_material: SourceMaterialBatchReceipt;
+    whoami: WhoamiResponse;
+};
+export type JsonOperationId = keyof OperationResponses;

package/operation-responses.js

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

package/operations.d.ts

@@ -1,13 +1,6 @@
-export declare const MATERIALGRAPH_API_VERSION = "0.8.0";
-declare const OPERATION_DEFINITIONS: readonly [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 ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], 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 ["searchVariants", "POST", "/api/v1/variants/search", "search_variants"], readonly ["findVariantsByColor", "POST", "/api/v1/variants/by-color", "find_variants_by_color"], readonly ["findVariantsByVector", "POST", "/api/v1/variants/by-vector", "find_variants_by_vector"], readonly ["findSampledTogether", "POST", "/api/v1/variants/sampled-together", "find_sampled_together"], readonly ["resolveVariant", "POST", "/api/v1/variants/resolve", "resolve_variant"], readonly ["getVariant", "GET", "/api/v1/variants/{variantId}", "get_variant"], readonly ["resolveColor", "GET", "/api/v1/search/colors/resolve", "resolve_color_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 ["colors.profiles", "GET", "/api/v1/colors/profiles", "get_category_color_profiles"], 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 ["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];
-    method: (typeof OPERATION_DEFINITIONS)[number][1];
-    path: (typeof OPERATION_DEFINITIONS)[number][2];
-    operationId: SdkOperationId;
-}>;
-export declare const SDK_OPERATIONS: readonly SdkOperation[];
+import { type SdkOperation, type SdkOperationId } from "./operations.generated.js";
+export { MATERIALGRAPH_API_VERSION, SDK_OPERATIONS, } from "./operations.generated.js";
+export type { SdkOperation, SdkOperationId } from "./operations.generated.js";
 /** Look up a registered operation by its OpenAPI `operationId`. */
 export declare const findSdkOperation: (operationId: SdkOperationId) => SdkOperation | undefined;
 /**
@@ -15,7 +8,6 @@ export declare const findSdkOperation: (operationId: SdkOperationId) => SdkOpera
  * a literal `operationId` wants — lived as a private copy in `client.ts`
  * before the association lens would have made it a second.
  */
-export declare const resolveOperation: (operationId: SdkOperationId) => SdkOperation;
+export declare const resolveOperation: <K extends SdkOperationId>(operationId: K) => SdkOperation<K>;
 /** Substitute `{param}` path placeholders with percent-encoded values. */
 export declare const operationPath: (sdkOperation: SdkOperation, pathParams?: Readonly<Record<string, string>>) => string;
-export {};

package/operations.generated.d.ts

@@ -0,0 +1,11 @@
+export declare const MATERIALGRAPH_API_VERSION = "0.8.0";
+declare const OPERATION_DEFINITIONS: readonly [readonly ["colors.nearestPaints", "GET", "/api/v1/colors/nearest-paints", "find_nearest_paints"], readonly ["getCatalogueGeneration", "GET", "/api/v1/catalog/generation", "get_catalogue_generation"], 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 ["samplizeCatalogue", "GET", "/api/v1/catalogues/samplize/products", "samplize_catalogue_products"], 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 ["searchVariants", "POST", "/api/v1/variants/search", "search_variants"], readonly ["findVariantsByColor", "GET", "/api/v1/variants/by-color", "find_variants_by_color"], readonly ["findVariantsByVector", "POST", "/api/v1/variants/by-vector", "find_variants_by_vector"], readonly ["findSampledTogether", "GET", "/api/v1/variants/sampled-together", "find_sampled_together"], readonly ["resolveVariant", "POST", "/api/v1/variants/resolve", "resolve_variant"], readonly ["getVariant", "GET", "/api/v1/variants/{variantId}", "get_variant"], readonly ["resolveColor", "GET", "/api/v1/search/colors/resolve", "resolve_color_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 ["colors.profiles", "GET", "/api/v1/colors/profiles", "get_category_color_profiles"], 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 ["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<K extends SdkOperationId = SdkOperationId> = Readonly<{
+    clientMethod: (typeof OPERATION_DEFINITIONS)[number][0];
+    method: (typeof OPERATION_DEFINITIONS)[number][1];
+    path: (typeof OPERATION_DEFINITIONS)[number][2];
+    operationId: K;
+}>;
+export declare const SDK_OPERATIONS: readonly SdkOperation[];
+export {};

package/operations.generated.js

@@ -0,0 +1,189 @@
+// GENERATED by apps/web/scripts/generate-openapi-v1.ts. Do not edit.
+export const MATERIALGRAPH_API_VERSION = "0.8.0";
+const OPERATION_DEFINITIONS = [
+    [
+        "colors.nearestPaints",
+        "GET",
+        "/api/v1/colors/nearest-paints",
+        "find_nearest_paints",
+    ],
+    [
+        "getCatalogueGeneration",
+        "GET",
+        "/api/v1/catalog/generation",
+        "get_catalogue_generation",
+    ],
+    ["catalogs", "GET", "/api/v1/catalogs", "list_catalog_documents"],
+    [
+        "catalogPages",
+        "GET",
+        "/api/v1/catalogs/{catalogId}/pages",
+        "list_catalog_pages",
+    ],
+    [
+        "catalogPageRepresentation",
+        "GET",
+        "/api/v1/catalog-pages/{pageId}/representation",
+        "get_catalog_page_representation",
+    ],
+    [
+        "catalogReferences",
+        "GET",
+        "/api/v1/catalogs/{catalogId}/references",
+        "list_catalog_product_references",
+    ],
+    [
+        "samplizeCatalogue",
+        "GET",
+        "/api/v1/catalogues/samplize/products",
+        "samplize_catalogue_products",
+    ],
+    [
+        "catalogueReferences",
+        "POST",
+        "/api/v1/catalogues/references",
+        "get_catalogue_references_batch",
+    ],
+    [
+        "catalogueCollections",
+        "GET",
+        "/api/v1/catalogues/collections",
+        "list_catalogue_channel_collections",
+    ],
+    [
+        "catalogueDocumentAccess",
+        "GET",
+        "/api/v1/catalogues/documents/{documentId}",
+        "get_catalogue_document_access",
+    ],
+    [
+        "materialBlocks",
+        "GET",
+        "/api/v1/materials/{variantId}/blocks",
+        "list_material_blocks",
+    ],
+    [
+        "listVariantAssets",
+        "GET",
+        "/api/v1/variants/{variantId}/assets",
+        "list_variant_assets",
+    ],
+    [
+        "materialDocuments",
+        "GET",
+        "/api/v1/materials/{variantId}/documents",
+        "list_material_documents",
+    ],
+    [
+        "schema",
+        "GET",
+        "/api/v1/schema/value-dictionaries",
+        "list_schema_value_dictionaries",
+    ],
+    [
+        "pairings",
+        "GET",
+        "/api/v1/materials/{variantId}/pairings",
+        "get_material_pairings",
+    ],
+    [
+        "associatedFinishes",
+        "GET",
+        "/api/v1/associated/finishes",
+        "list_associated_finishes",
+    ],
+    [
+        "associatedProducts",
+        "GET",
+        "/api/v1/associated/products",
+        "list_associated_products",
+    ],
+    ["applicability", "GET", "/api/v1/applicability", "get_applicability"],
+    ["listVariants", "GET", "/api/v1/variants", "list_variants"],
+    [
+        "listVariantFacets",
+        "POST",
+        "/api/v1/variants/facets",
+        "list_variant_facets",
+    ],
+    ["searchVariants", "POST", "/api/v1/variants/search", "search_variants"],
+    [
+        "findVariantsByColor",
+        "GET",
+        "/api/v1/variants/by-color",
+        "find_variants_by_color",
+    ],
+    [
+        "findVariantsByVector",
+        "POST",
+        "/api/v1/variants/by-vector",
+        "find_variants_by_vector",
+    ],
+    [
+        "findSampledTogether",
+        "GET",
+        "/api/v1/variants/sampled-together",
+        "find_sampled_together",
+    ],
+    ["resolveVariant", "POST", "/api/v1/variants/resolve", "resolve_variant"],
+    ["getVariant", "GET", "/api/v1/variants/{variantId}", "get_variant"],
+    [
+        "resolveColor",
+        "GET",
+        "/api/v1/search/colors/resolve",
+        "resolve_color_name",
+    ],
+    [
+        "listAttributes",
+        "GET",
+        "/api/v1/catalog/attributes",
+        "catalog_list_attributes",
+    ],
+    [
+        "listEnumValues",
+        "GET",
+        "/api/v1/catalog/enum-values",
+        "catalog_list_enum_values",
+    ],
+    ["categories.list", "GET", "/api/v1/categories", "list_categories"],
+    ["categories.get", "GET", "/api/v1/categories/{id}", "get_category"],
+    ["whoami", "GET", "/api/v1/whoami", "whoami"],
+    [
+        "colors.profiles",
+        "GET",
+        "/api/v1/colors/profiles",
+        "get_category_color_profiles",
+    ],
+    [
+        "extractPalette",
+        "POST",
+        "/api/v1/search/palettes/extract",
+        "extract_image_palette",
+    ],
+    ["brands", "GET", "/api/v1/brands", "list_brands"],
+    [
+        "uploadSourceMaterial",
+        "POST",
+        "/api/v1/source-material",
+        "upload_source_material",
+    ],
+    [
+        "workflows.start",
+        "POST",
+        "/api/v1/workflows/{workflowId}/runs",
+        "create_public_run",
+    ],
+    [
+        "workflows.run",
+        "GET",
+        "/api/v1/workflows/{workflowId}/runs/{runId}",
+        "get_public_run",
+    ],
+    [
+        "workflows.streamRunEvents",
+        "GET",
+        "/api/v1/workflows/{workflowId}/runs/{runId}/events",
+        "list_public_run_events",
+    ],
+];
+export const SDK_OPERATIONS = Object.freeze(OPERATION_DEFINITIONS.map(([clientMethod, method, path, operationId]) => Object.freeze({ clientMethod, method, operationId, path })));