@instruments/materialgraph 1.1.0 → 1.3.0

package/find-sampled-together-types.d.ts

@@ -48,6 +48,8 @@ export type FindSampledTogetherRow = {
         proportion: number;
     }[];
     variantId: string;
+    /** 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;
     variantName: string | null;
 };
 export type FindSampledTogetherOutput = {
@@ -63,6 +65,8 @@ export type FindSampledTogetherOutput = {
         /** The id or name this seed came from. */
         resolvedFrom: string;
         variantId: string;
+        /** 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;
         variantName: string | null;
     }[];
     /** Seed ids outside the materials catalog; present only when at least one was. */

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

@@ -91,6 +91,8 @@ export type UnresolvedColor = {
     input: string | null;
 };
 export type 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: {
         id: string;
         name: string;
@@ -156,6 +158,8 @@ export type ColorRankedSeed = {
 };
 /** RERANK's own card — the same shape `ColorVariantMatch` above (`brandId`, `code`), plus its perceptual distance. */
 export type 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;
     brandId: string;
     code: string | null;

package/get-variant-types.d.ts

@@ -46,6 +46,7 @@ export type GetVariantIfc = {
  * false or zero.
  */
 export type 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[];
     palette: {
@@ -93,6 +94,8 @@ export type GetVariantOutput = {
     /** The variant's Material Bank SKU. Absent means none is recorded. */
     materialBankId?: string;
     name: string;
+    /** The trimmed source variant label; null when unknown or for a paint color sample, whose own name identifies its color. Separate from surface finish, color family and derived color names. */
+    variantLabel: string | null;
     /** Requested blocks or attributes the variant's product type does not carry. */
     notApplicable?: ListVariantsNotApplicable;
     /** Present when `ifc` was asked for. */

package/list-variants-types.d.ts

@@ -207,6 +207,8 @@ export type ListVariantsItem = {
     /** The variant's Material Bank SKU. Absent means none is recorded. */
     materialBankId?: string;
     name: string;
+    /** The trimmed source variant label; null when unknown or for a paint color sample, whose own name identifies its color. Separate from surface finish, color family and derived color names. */
+    variantLabel: string | null;
     notApplicable?: ListVariantsNotApplicable;
     preference?: ListVariantsPreference;
     product: {

package/package.json

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