@instruments/materialgraph 3.4.0 → 3.5.0

package/index.d.ts

@@ -1,7 +1,7 @@
 export type { DiscoveryReference, DiscoveryTerms, InterpretDiscoveryTermsInput, ColorlessVariantsResult, VariantSibling, } from "./discovery-context-types.js";
 export { MaterialGraphClient, DEFAULT_BASE_URL } from "./client.js";
 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 { FilterOp, FilterTermCondition, FilterNumericCondition, FilterPresenceCondition, FilterAnyFieldCondition, FilterCondition, FilterGroups, OptionalFilterGroups, OrderByEntry, ListVariantsInclude, ListVariantsCollapse, ColorRegion, ColorRangeCondition, ListVariantsInput, ListVariantsPreference, ListVariantsSpecifications, ListVariantsNotApplicable, SampleSizeObservation, VariantObservations, SampleSubject, ListVariantsItem, Market, 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";

package/list-variants-types.d.ts

@@ -93,7 +93,7 @@ export interface OptionalFilterGroups {
 }
 export interface OrderByEntry {
     direction: "asc" | "desc";
-    /** A numeric attribute id. */
+    /** A single-valued numeric attribute id (`getAttribute` says orderable), or `color_lightness` or `color_chroma`: the lightness and chroma of the variant's dominant measured color. */
     field: string;
 }
 export type ListVariantsInclude = "image" | "url";
@@ -196,6 +196,8 @@ export interface ListVariantsNotApplicable {
 }
 /** What a sample represents, independently of its specification type. */
 export type SampleSubject = "material" | "paint_color_sample" | "unknown" | "conflict";
+/** A Material Bank market: North America or Europe. */
+export type Market = "na" | "eu";
 /**
  * One list item: the compact identity needed to pick a variant, with image
  * and brand page only when requested (`include`) and selected attributes
@@ -234,6 +236,8 @@ export interface ListVariantsItem {
     };
     /** The variant's Material Bank SKU. Absent means none is recorded. */
     materialBankId?: string;
+    /** The Material Bank markets it is orderable in: `na`, `eu`, both or neither. The `market` filter field takes them. */
+    markets: Market[];
     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;

package/package.json

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