@instruments/materialgraph 3.3.0 → 3.5.0

package/client.d.ts

@@ -117,13 +117,13 @@ export declare class MaterialGraphClient {
     resolveVariant(input: ResolveVariantInput, signal?: AbortSignal): Promise<ResolveVariantOutput>;
     /**
      * How much each of 1 to 48 variants is sampled by Material Bank members
-     * (POST `/api/v1/demand`): `samplePercentile` within its category, with a
+     * (POST `/api/v1/demand`): `samplePercentile` within its product type, with a
      * `trend` and the `change` of this year against the year before. Results
      * keep request order. No count is returned.
      */
     getVariantDemand(input: GetVariantDemandInput, signal?: AbortSignal): Promise<GetVariantDemandOutput>;
     /**
-     * The variants of one category sampled at least 15% more this year than
+     * The variants of one product type sampled at least 15% more this year than
      * the year before (GET `/api/v1/demand/rising`), largest `change` first.
      * No count is returned.
      */

package/client.js

@@ -155,7 +155,7 @@ export class MaterialGraphClient {
     }
     /**
      * How much each of 1 to 48 variants is sampled by Material Bank members
-     * (POST `/api/v1/demand`): `samplePercentile` within its category, with a
+     * (POST `/api/v1/demand`): `samplePercentile` within its product type, with a
      * `trend` and the `change` of this year against the year before. Results
      * keep request order. No count is returned.
      */
@@ -166,14 +166,14 @@ export class MaterialGraphClient {
         });
     }
     /**
-     * The variants of one category sampled at least 15% more this year than
+     * The variants of one product type sampled at least 15% more this year than
      * the year before (GET `/api/v1/demand/rising`), largest `change` first.
      * No count is returned.
      */
     async listRisingVariants(input, signal) {
         return await this.#get("list_rising_variants", {
-            category: input.category,
             limit: input.limit === undefined ? undefined : String(input.limit),
+            productType: input.productType,
             projectType: input.projectType,
         }, signal);
     }

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

@@ -10,16 +10,20 @@ 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. */
+    /**
+     * One Material Bank project type, spelled as Material Bank spells it, such
+     * as "Hospitality: Hotel"; omit for every project type together. One the
+     * published build did not measure is a 400 that lists the ones it did.
+     */
     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. */
+    /** The id of the product type the percentile is ranked within. */
+    productType: string;
+    /** Share of the product type's variants sampled as much or less, 1 to 100. */
     samplePercentile: number;
     /** Null when the year before cannot be shown. */
     trend: DemandTrend | null;
@@ -43,16 +47,16 @@ export interface GetVariantDemandOutput {
     results: VariantDemand[];
 }
 export interface ListRisingVariantsInput {
-    /** A MaterialGraph category id, such as `wallcovering`. */
-    category: string;
+    /** A MaterialGraph product type id, such as `wallcovering`. An unknown id is a 400. */
+    productType: string;
     /** Variants to return, at most 100. Default 20. */
     limit?: number;
-    /** One Material Bank project type; omit for every project type together. */
+    /** One Material Bank project type, as in `GetVariantDemandInput`. */
     projectType?: string;
 }
 export interface RisingVariant {
     variantId: string;
-    /** Share of the category's variants sampled as much or less, 1 to 100. */
+    /** Share of the product type'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. */
@@ -62,7 +66,7 @@ export interface ListRisingVariantsOutput {
     /** Last day of the measured year, as an ISO date. */
     asOf: string;
     basis: "measured";
-    category: string;
+    productType: string;
     /** Largest change first. */
     results: RisingVariant[];
     source: string;

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.3.0",
+  "version": "3.5.0",
   "type": "module",
   "exports": {
     ".": {