@instruments/materialgraph 0.33.0 → 0.35.0

package/search-card-types.d.ts

@@ -1,86 +0,0 @@
-/**
- * @module sdk/search-card-types
- * @description The `view:"card"` search projection — the lean grid item and the
- * envelope that carries it.
- *
- * Split out of `types.ts` — which is over the repository's source-size limit —
- * along the same seam `match-types.ts` took: one view of one surface, and
- * nothing else. The full-view item and the shared envelope stay in `types.ts`,
- * which this module reads `SearchResponse` from.
- */
-import type { ProductId, VariantId } from "./identifiers.js";
-import type { OpenEnum, SearchData, SearchResponse } from "./types.js";
-/**
- * The lean `view:"card"` result item — identity + name + code + thumbnail +
- * score.
- *
- * A PROJECTION, not a smaller answer: a field the card omits (palette, verdict,
- * signals, availability) is unread here, never known-absent. Re-read the same
- * `variantId` at `view: "full"` or via `getVariant()` before claiming anything the
- * card does not carry.
- */
-export type SearchCardItem = {
-    /** Accepted sampleability fact. Absent means unknown, never false. */
-    sampleable?: boolean;
-    /** Opaque — round-trip verbatim. */
-    variantId: VariantId;
-    productId: ProductId | null;
-    brandSlug: string | null;
-    brand: string;
-    /** Product name (the full item's `product`). */
-    name: string;
-    variantName: string | null;
-    imageUrl: string | null;
-    /**
-     * SHA-256 of the displayed image `imageUrl` points at, as a hex digest. Key a
-     * cache or dedupe on it rather than the URL. ABSENT means no hash is on
-     * record, never that there is no image.
-     */
-    imageSha256?: string;
-    /**
-     * How many eligible variants the row's product has, the same set
-     * `listVariants` pages, so a follow-up list returns this many: the card's
-     * "12 colourways". ABSENT means the product is unknown or has no eligible
-     * variant.
-     */
-    variantCount?: number;
-    /**
-     * The manufacturer's own item code, the same key the full item carries.
-     * Reach for it when two cards read alike: `name` is the PRODUCT name, and a
-     * paint product is a whole collection, so brand, product name and variant
-     * name together are shared by most of the catalogue. ABSENT means no code is
-     * recorded, never that the variant cannot be ordered.
-     */
-    manufacturerCode?: string;
-    projectSaveCapability?: "allowed";
-    sourceStatus?: "provisional";
-    score: number;
-    /**
-     * Resolved values for the attribute ids sent in `returnAttributes`, keyed by
-     * attribute id. ABSENT entirely when `returnAttributes` was not sent.
-     *
-     * Three states, all different, and reading them as two is the mistake this
-     * shape exists to prevent: no `attributes` key means you did not ask; a key
-     * whose value is `null` means this material carries no accepted value for that
-     * attribute; anything else is what the graph holds. Values resolve with the
-     * normal variant-over-product precedence, and an array is a multi-valued
-     * attribute rather than a list of candidates.
-     */
-    attributes?: Record<string, string | string[] | null>;
-};
-/** The `view:"card"` response form — the lean grid projection of {@link SearchResponse}. */
-export type SearchCardResponse = {
-    data: Omit<SearchData, "view" | "results"> & {
-        view: OpenEnum<"card">;
-        results: SearchCardItem[];
-    };
-} & Omit<SearchResponse, "data">;
-/**
- * The request forms the server answers with {@link SearchCardResponse}:
- * `view: "card"`, or `intent: "typeahead"`, which forces the card view.
- */
-export type CardProjectionRequest = {
-    view: "card";
-} | {
-    intent: "typeahead";
-};

package/search-card-types.js

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

package/search-index-plan-types.d.ts

@@ -1,74 +0,0 @@
-/**
- * @module search-index-plan-types
- * @description The plan the one search ran on, as `/search` reports it under
- * `explain.plan` (ADR 0031). Mirrors `searchIndexPlanReceiptSchema` in
- * `@materialgraph/products/search-index/plan-schema`; `key-parity.test.ts`
- * holds the two to the same fields.
- */
-import type { ColourRegionRange } from "./colour-region-types.js";
-import type { CorpusScope } from "./corpus-scope-types.js";
-/** One attribute the plan wants: its terms, or any value when `presence`. */
-type SearchIndexPlanWant = {
-    attributeId: string;
-    /** Share of the category's materials stating the attribute, 0 to 1. */
-    fill: number;
-    /** The words it was read from, or `"(filter)"` for a caller's filter. */
-    phrase: string;
-    /** Any stated value satisfies it; `terms` is then empty. */
-    presence?: true;
-    /** A hard want removes rows; a soft one only counts toward the order. */
-    strength: "hard" | "soft";
-    terms: string[];
-};
-/**
- * The query's plan: the category, brands, wanted and excluded attribute terms,
- * the colour, the words left for text, and the caller's corpus scope.
- */
-export type SearchIndexPlan = {
-    brands: {
-        ids: string[];
-        names: string[];
-        phrase: string;
-    } | null;
-    category: {
-        label: string;
-        phrase: string;
-        productTypeIds: string[];
-    } | null;
-    colour: {
-        family12: string[];
-        familyId: string;
-        hex: string;
-        oklab: [number, number, number];
-        phrase: string;
-        /** The colour's region, when the plan holds one rather than a point. */
-        range?: ColourRegionRange;
-    } | null;
-    /** Present only when the caller sent a scope narrower than the whole graph. */
-    corpusScope?: Exclude<CorpusScope, "all">;
-    excludeBrands: string[];
-    excludes: {
-        attributeId: string;
-        phrase: string;
-        term: string;
-    }[];
-    /** Words the reading did not place, left for the text match. */
-    leftover: string[];
-    normalised: string;
-    softAlone: boolean;
-    vendorColourNames: string[];
-    wants: SearchIndexPlanWant[];
-};
-/**
- * Which reading a search ran on (`version`, `source`), whether it came from
- * the cache, the plan itself, and its signature, so two runs of one request
- * can be compared plan for plan.
- */
-export type SearchPlanReceipt = {
-    cached: boolean;
-    plan: SearchIndexPlan;
-    signature: string;
-    source: "dictionary" | "jev";
-    version: string;
-};
-export {};

package/search-index-plan-types.js

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

package/search-refinement-types.d.ts

@@ -1,103 +0,0 @@
-/** The spec-filter vocabulary MaterialGraph's filter and preference inputs share. */
-/**
- * A hard canonical-attribute filter accepted by the search engine — a term match
- * (`{ attributeId, term }`), a presence check (`{ attributeId, hasValue: true }`)
- * or a NUMERIC RANGE (`{ attributeId, min, max }`, bounds inclusive, at least one
- * stated). Applied as a restriction BEFORE ranking.
- *
- * The `attributeId` may be a real registry id (`"fire_classifications"`,
- * `"environmental_product_declaration"`) OR the virtual
- * `"certification_programme"` (see `CERTIFICATION_PROGRAMME_ATTRIBUTE_ID`),
- * which matches a programme — GREENGUARD, FloorScore, LEED, an EPD — wherever it
- * landed across the four certification buckets. Presence (`hasValue`) is NOT
- * supported for the virtual programme attribute. The typed `spec-types` mirror
- * and the `specifications` builders produce values assignable to this type.
- */
-/**
- * Optional per-filter TRUST bar the matching value must clear.
- *
- * Raising the bar shrinks the result set for a reason worth stating: the
- * materials it removes are not materials that fail the spec, they are materials
- * whose claim is weaker than you demanded. That distinction is the whole point
- * of this object — without it, "no GREENGUARD results" reads as "nobody is
- * certified" when it means "nobody is certified TO THIS EVIDENTIAL STANDARD".
- */
-export type SearchFilterTrust = {
-    /** Confidence floor, 0–1. A value below it is excluded, not marked failed. */
-    minConfidence?: number;
-    /**
-     * Demand an EXACT source basis (closed enum — an unknown basis is rejected).
-     * Strongest to weakest as evidence:
-     *  - `declared` — the manufacturer stated it. Attributable, not independent.
-     *  - `catalog_feed` — it arrived in a catalog feed. Trusted at ingest, unreviewed.
-     *  - `derived` — MaterialGraph inferred it. Ours, not the manufacturer's — never
-     *    present a `derived` value as something the brand claims.
-     *
-     * There is NO `tested` basis. This docblock advertised one as "the strongest
-     * claim available" through 0.12.0, and the union listed `declared` twice in
-     * its place — so a caller reading the documentation would write a value the
-     * server rejects with a 400, and the type would not stop them because the
-     * fourth arm was a duplicate rather than the value described.
-     * `packages/schema/src/source-basis.test.ts` asserts `tested` parses false;
-     * its absence is deliberate, not an omission.
-     */
-    sourceBasis?: "catalog_feed" | "declared" | "derived";
-    /** Fold the attribute's own registry confidence requirement in, server-side. */
-    meetsRequirement?: true;
-};
-/**
- * One HARD criterion. Applied as a restriction BEFORE ranking, so a filtered
- * search's empty result means "nothing on record satisfies this", never "nothing
- * exists" — the corpus's silence and the world's are different things. Use
- * `preferences` instead when a miss should demote rather than remove.
- */
-export type SearchFilter = {
-    attributeId: string;
-    term: string;
-    trust?: SearchFilterTrust;
-} | {
-    attributeId: string;
-    excludesTerm: string;
-    trust?: SearchFilterTrust;
-    /**
-     * What an UNKNOWN effective value does. Absent or `"drop"` (default)
-     * requires a known effective value — a variant that never states the
-     * attribute does not pass. `"pass"` admits it — a variant only fails by
-     * STATING the excluded term.
-     */
-    whenUnstated?: "drop" | "pass";
-}
-/**
- * TERM SET — the attribute must equal any ONE of these. OR within the entry;
- * AND still holds between entries, so a filter rail composes the same way
- * whatever it is filtering on.
- *
- * The server has accepted this since the term-set arm shipped, and a consumer
- * has been sending it successfully on the wire — but it was missing from this
- * union through 0.12.0, so multi-value filtering type-checked nowhere while
- * working everywhere. Brand multi-select is the common case:
- * `{attributeId: "brand", terms: ["kvadrat", "interface"]}`.
- */
- | {
-    attributeId: string;
-    terms: string[];
-    trust?: SearchFilterTrust;
-} | {
-    attributeId: string;
-    hasValue: true;
-    trust?: SearchFilterTrust;
-}
-/** Date-sensitive presence is currently executable only for EPD expiration. */
- | {
-    attributeId: "epd_expiration_date";
-    hasValue: true;
-    asOf: string;
-    trust?: SearchFilterTrust;
-} | {
-    attributeId: string;
-    /** Inclusive lower bound. Omit for a ceiling-only range. */
-    min?: number;
-    /** Inclusive upper bound. Omit for a floor-only range. */
-    max?: number;
-    trust?: SearchFilterTrust;
-};

package/search-refinement-types.js

@@ -1,2 +0,0 @@
-/** The spec-filter vocabulary MaterialGraph's filter and preference inputs share. */
-export {};

package/search-request-types.d.ts

@@ -1,170 +0,0 @@
-/**
- * @module search-request-types
- * The two request shapes for the `/search` surface: the POST JSON body and the
- * GET query-string form. Split out of `types.ts` so neither file outgrows the
- * repo's source-size gate; every name here is re-exported from `types.ts`, so
- * no import path changes.
- */
-import type { ColourRegionRange } from "./colour-region-types.js";
-import type { CorpusScope } from "./corpus-scope-types.js";
-import type { Cursor, VariantId } from "./identifiers.js";
-import type { OpenEnum, SearchImageInput } from "./types.js";
-/**
- * One attribute filter the one search runs as a hard token set on its index
- * (ADR 0031, MG-2158). Entries on one attribute are OR'd; entries on different
- * attributes AND together.
- *
- * - `term`: the value must carry this canonical term.
- * - `terms`: any one of these terms satisfies it.
- * - `excludesTerm`: the value must not carry this term. A material that states
- *   nothing for the attribute passes.
- * - `hasValue: true`: any stated value.
- * - `min` and/or `max`: an inclusive numeric range, on a numeric attribute
- *   (`"nrc_rating"`), a dimensions lens in millimetres
- *   (`"dimensions.thickness_mm"`, `"dimensions.short_side_mm"`) or a
- *   composition share on 0 to 1 (`"composition_weighted.wool"`). It is read as
- *   the number bands wholly inside it, so a bound between two band edges is
- *   read inward; a range no band fits inside is a 400.
- *
- * `attributeId` is an attribute the index carries tokens for, or
- * `"certification_programme"` for any certification programme. Terms are
- * canonical dictionary terms, not display names. Numeric attributes take
- * `hasValue` or a range. An attribute or term the index does not carry is a
- * 400 naming it.
- */
-export type SearchIndexFilter = {
-    attributeId: string;
-    term: string;
-} | {
-    attributeId: string;
-    terms: string[];
-} | {
-    attributeId: string;
-    excludesTerm: string;
-} | {
-    attributeId: string;
-    hasValue: true;
-} | {
-    attributeId: string;
-    min?: number;
-    max?: number;
-};
-/**
- * The POST `/search` JSON body (ADR 0031): the words, or a look-alike seed, and
- * the page wanted. `category`, `filters`, `corpusScope`, `colour` and `brands`
- * become fields of the query's plan and run in the same index query. The order
- * is the index's own, so nothing here sets weights, a blend or a sort. Send
- * `text`, `similarTo`, `image`, `colour`, `category`, `filters` or `brands`; a
- * corpus scope alone does not say what to find. Any other field is a 400
- * naming it.
- */
-export type SearchInput = {
-    /**
-     * Free text ("oak flooring", "sage green velvet", "Kvadrat wool"). Brands,
-     * categories, colours and attributes are read from the words unless
-     * `brands`, `category` or `colour` says so instead; a corrected word is
-     * reported under `correctedQuery`.
-     */
-    text?: string;
-    /** A query image (URL or base64); `text`, when also given, narrows it. */
-    image?: SearchImageInput;
-    /**
-     * Materials that LOOK like a seed: an existing variant, a Material Bank SKU
-     * (an unknown SKU is a 400 naming it), or a pre-computed image vector.
-     */
-    similarTo?: {
-        variantId: VariantId;
-    } | {
-        materialBankId: string;
-    } | {
-        vector: string;
-    };
-    /**
-     * A hard category gate: public category-group or product-type names, or
-     * taxonomy keys. It replaces the category the words were read as. An
-     * unknown value is a 400 listing every valid name.
-     */
-    category?: {
-        filter: string[];
-    };
-    /** Hard attribute filters, 1 to 24. See {@link SearchIndexFilter}. */
-    filters?: SearchIndexFilter[];
-    /**
-     * Order the page by a colour: a `hex`, or `variantId` for the colour of an
-     * existing Variant. The page is the colour's family, nearest first by OKLab
-     * distance; it replaces any colour read from `text`. A Variant with no colour
-     * on the index is a 400.
-     *
-     * `oklab` and `range` are additive: send them when you already resolved the
-     * exact OKLab point or the named colour's region (see `resolveColour()`), and
-     * the plan carries that colour without re-deriving it from `hex`. `hex` stays
-     * required.
-     */
-    colour?: {
-        hex: string;
-        oklab?: [number, number, number];
-        range?: ColourRegionRange;
-    } | {
-        variantId: VariantId;
-    };
-    /**
-     * Brands the page must come from: canonical brand ids, exact slugs
-     * ("sherwin-williams") or exact display names ("Sherwin-Williams"), up to
-     * 50. They replace the brands `text` was read as. An empty list is the
-     * same request as omitting it — every brand. An unrecognised value is a
-     * 400 naming it; a display name shared by more than one brand is a 400
-     * naming the exact slugs to choose between; a brand MaterialGraph holds no
-     * materials under is a 400 naming a populated sibling when one exists.
-     */
-    brands?: string[];
-    /**
-     * Attribute ids (at most 8) whose resolved value should ride each result
-     * under `attributes`, keyed by attribute id. Not a plan field: it changes
-     * no ordering and plays no part in the cursor. An attribute you did not
-     * ask for is not a key on `attributes` at all; one you asked for that a
-     * result carries no accepted value for is `null`; anything else is the
-     * value. An unknown attribute id is a 400 naming it.
-     */
-    returnAttributes?: string[];
-    /**
-     * Which corpus to answer from, applied inside the index query. ABSENT (or
-     * `"all"`) means the whole graph. `"materialBankOrderable"` is a provenance
-     * signal (a Material Bank identity), not a storefront; the channel-backed
-     * scopes (`"materialBankNaOrderable"`, `"materialBankEuOrderable"`,
-     * `"designShopOrderable"`) answer where a material can be ordered,
-     * `"materialBankNaAndCatalogue"` is a governed discovery corpus (the union
-     * of Material Bank North America and Catalogue editorial membership, not a
-     * buyability claim), and `"samplizeCatalogue"` admits published US Samplize
-     * paint colours, regardless of stock.
-     */
-    corpusScope?: CorpusScope;
-    /** Products per page (max 60). Absent, the search's own page size. */
-    limit?: number;
-    /**
-     * The previous response's `cursor`, passed back verbatim. A cursor from
-     * another query (other words, filters or scope) is a 409.
-     */
-    cursor?: Cursor;
-    /** Add `timings` and `explain.plan`, the plan the search ran on. */
-    explain?: boolean;
-    /** Result projection: `"full"` (default) or the lean `"card"` grid form. */
-    view?: OpenEnum<"full" | "card">;
-};
-/**
- * Query-string params for the GET `/search` form. `category` and `filters`
- * have no query-string form; send them through `search()`.
- */
-export type SearchGetParams = {
-    q?: string;
-    /** Seed the search from this variant's image. Opaque; pass it through verbatim. */
-    variantId?: VariantId;
-    /** Corpus applied inside the index query; absent means the whole graph. */
-    corpusScope?: CorpusScope;
-    limit?: number;
-    /** The previous response's `cursor`, passed back verbatim. */
-    cursor?: Cursor;
-    /** Result projection: `"full"` (default) or the lean `"card"` grid form. */
-    view?: OpenEnum<"full" | "card">;
-    /** `"1"` adds `timings` and `explain.plan`. */
-    explain?: OpenEnum<"0" | "1">;
-};

package/search-request-types.js

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

package/search-response-receipt-types.d.ts

@@ -1,24 +0,0 @@
-/**
- * @module sdk/search-response-receipt-types
- * @description The ranking source and the explain-only plan receipt a Search
- * response carries.
- */
-import type { SearchPlanReceipt } from "./search-index-plan-types.js";
-import type { OpenEnum } from "./types.js";
-/**
- * What ordered the page: `image` (a look-alike), `colour` (colour distance
- * inside the named colour's family), `lexical` (the query's words, by text
- * rank on the index), `attribute` (the category and filters alone define the
- * page) or `agent` (the search agent chose the variants and their order).
- */
-export type SearchMode = OpenEnum<"image" | "colour" | "lexical" | "agent" | "attribute">;
-/** The explain-only receipt shared by full and card search responses. */
-export type SearchResponseExplainReceipts = {
-    /**
-     * Present under `explain` only: the receipt of the plan the one search ran
-     * on, with the plan itself (ADR 0031). Diagnostic, like `timings`.
-     */
-    explain?: {
-        plan: SearchPlanReceipt;
-    };
-};

package/search-response-receipt-types.js

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

package/search-response-types.d.ts

@@ -1,11 +0,0 @@
-import type { SearchData } from "./types.js";
-/** Canonical Search wire response. Raw SDK methods preserve this envelope. */
-export type SearchResponse = {
-    data: SearchData;
-    meta: {
-        operationId: "search_materials_post" | "search_materials_get";
-        requestId: string;
-    };
-    links: Record<string, never>;
-    warnings: never[];
-};

package/search-response-types.js

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

package/search-result-validation.d.ts

@@ -1,9 +0,0 @@
-import type { ValidationFailure } from "./validation.js";
-/**
- * Prove one wire value is a {@link SearchResultItem}, raising through `fail` at
- * the first field that does not match `searchResultItemSchema`. Checks the shape
- * only — unknown keys ride through untouched, per the SDK's pass-through
- * contract (nothing on the emit path parses, so stripping would invent a
- * normalisation the wire never had).
- */
-export declare const checkSearchResultItem: (value: unknown, what: string, fail: ValidationFailure) => void;

package/search-result-validation.js

@@ -1,83 +0,0 @@
-/**
- * The one runtime validator for a {@link SearchResultItem} on the wire — the
- * hand-rolled, zero-runtime-dependency mirror of `searchResultItemSchema`
- * (`packages/products/src/search/search-result-schema.ts`) and its full
- * transitive closure, including `searchResultSignalsSchema`.
- *
- * WHY THIS EXISTS SEPARATELY FROM THE TYPE MIRROR. `contract-parity.test.ts`
- * proves the SDK's STATIC types match the canonical schemas. That is a
- * compile-time proof about shapes; it validates nothing at run time. A malformed
- * result item arriving over a stream was caught by neither, so the Match reader
- * now checks every item through here.
- *
- * ONE HOME. This module is the single implementation — no copy lives inside
- * `match-stream.ts`. It is package-internal (not re-exported from `index.ts`)
- * because a published symbol is a permanent contract, and nothing outside the
- * SDK needs to call it yet; promoting it later is additive.
- *
- * ENUMS ARE CLOSED, matching the canonical `z.enum(…)` members.
- */
-import { requireArray, requireBoolean, requireEnum, requireNullableString, requireNumber, requireOptionalBoolean, requireOptionalString, requireRecord, requireString, } from "./validation.js";
-// ── Leaf checks ──────────────────────────────────────────────────────────────
-/** `palette[]` — `{ hex, proportion, name: string.nullable().optional() }`. */
-const checkPaletteSwatch = (value, what, fail) => {
-    const record = requireRecord(value, what, fail);
-    requireString(record.hex, `${what}.hex`, fail);
-    requireNumber(record.proportion, `${what}.proportion`, fail);
-    // `.nullable().optional()` — absent OR null OR a string.
-    if (record.name !== undefined) {
-        requireNullableString(record.name, `${what}.name`, fail);
-    }
-};
-/** `colourMeta` — three independently optional strings. */
-const checkColourMeta = (value, what, fail) => {
-    const record = requireRecord(value, what, fail);
-    requireOptionalString(record.mood, `${what}.mood`, fail);
-    requireOptionalString(record.dominantFamily, `${what}.dominantFamily`, fail);
-    requireOptionalString(record.dominantHex, `${what}.dominantHex`, fail);
-};
-// ── The item ─────────────────────────────────────────────────────────────────
-/**
- * Prove one wire value is a {@link SearchResultItem}, raising through `fail` at
- * the first field that does not match `searchResultItemSchema`. Checks the shape
- * only — unknown keys ride through untouched, per the SDK's pass-through
- * contract (nothing on the emit path parses, so stripping would invent a
- * normalisation the wire never had).
- */
-export const checkSearchResultItem = (value, what, fail) => {
-    const record = requireRecord(value, what, fail);
-    requireString(record.variantId, `${what}.variantId`, fail);
-    requireString(record.brand, `${what}.brand`, fail);
-    requireString(record.product, `${what}.product`, fail);
-    requireNullableString(record.brandSlug, `${what}.brandSlug`, fail);
-    requireNullableString(record.productId, `${what}.productId`, fail);
-    // `z.string().optional()` — absent, or a string. NOT nullable: the emit path
-    // omits the key rather than sending null when no MB identity is known.
-    requireOptionalString(record.materialBankId, `${what}.materialBankId`, fail);
-    requireOptionalString(record.manufacturerCode, `${what}.manufacturerCode`, fail);
-    if (record.projectSaveCapability !== undefined) {
-        requireEnum(record.projectSaveCapability, ["allowed"], `${what}.projectSaveCapability`, fail);
-    }
-    if (record.sourceStatus !== undefined) {
-        requireEnum(record.sourceStatus, ["provisional"], `${what}.sourceStatus`, fail);
-    }
-    // Same shape as `materialBankId`: absent, or a string. The emit path omits
-    // the key when no primary product type is on record rather than sending null,
-    // so "we don't know what this is" and "this is a null kind of thing" cannot
-    // be confused.
-    requireOptionalString(record.productType, `${what}.productType`, fail);
-    requireNullableString(record.color, `${what}.color`, fail);
-    requireNullableString(record.variantName, `${what}.variantName`, fail);
-    requireNullableString(record.imageUrl, `${what}.imageUrl`, fail);
-    requireBoolean(record.hasImage, `${what}.hasImage`, fail);
-    requireNumber(record.score, `${what}.score`, fail);
-    const palette = requireArray(record.palette, `${what}.palette`, fail);
-    palette.forEach((swatch, index) => {
-        checkPaletteSwatch(swatch, `${what}.palette[${index}]`, fail);
-    });
-    if (record.colourMeta !== undefined) {
-        checkColourMeta(record.colourMeta, `${what}.colourMeta`, fail);
-    }
-    requireOptionalBoolean(record.retired, `${what}.retired`, fail);
-    requireOptionalBoolean(record.sampleable, `${what}.sampleable`, fail);
-};