@instruments/taxonomy 2.15.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -23,7 +23,7 @@ https://taxonomy.materialinstruments.com/id/facet/palette/family
23
23
  https://taxonomy.materialinstruments.com/id/material/walnut
24
24
  ```
25
25
 
26
- ColorScope owns colour; Taxonomy shows it and authors none. The Palette axis lists ColorScope's families, temperature levels, basic tones and palette compositions as graph nodes under ColorScope's own URIs (for example `https://colorscope.materialinstruments.com/id/family/green`), so any term can relate to a colour. Named colours are not nodes: lexical records reference them at ColorScope without merging them into Taxonomy hierarchy. For example, `walnut` has a governed primary material meaning and a secondary ColorScope meaning. Two more phrases carry an ordered meaning between two material concepts: `quartz` (engineered quartz before the mineral) and `melamine` (melamine-faced board before the resin).
26
+ ColorScope owns color; Taxonomy shows it and authors none. The Palette axis lists ColorScope's families, temperature levels, basic tones and palette compositions as graph nodes under ColorScope's own URIs (for example `https://colorscope.materialinstruments.com/id/family/green`), so any term can relate to a color. Named colors are not nodes: lexical records reference them at ColorScope without merging them into Taxonomy hierarchy. For example, `walnut` has a governed primary material meaning and a secondary ColorScope meaning. Two more phrases carry an ordered meaning between two material concepts: `quartz` (engineered quartz before the mineral) and `melamine` (melamine-faced board before the resin).
27
27
 
28
28
  ## Install and consume
29
29
 
@@ -35,7 +35,7 @@ export interface ResolvedAssertion extends ParsedAssertion {
35
35
  }
36
36
  /**
37
37
  * Split `evokes(place.region.nordic)` into its predicate and target. A bare term reference parses
38
- * to a target and no predicate. An unrecognised predicate does NOT parse: `foo(bar)` is not an
38
+ * to a target and no predicate. An unrecognized predicate does NOT parse: `foo(bar)` is not an
39
39
  * assertion with an exotic predicate, it is a string nobody has defined.
40
40
  */
41
41
  export declare const parseAssertion: (assertion: string) => ParsedAssertion | undefined;
@@ -55,7 +55,7 @@ export declare const resolveAssertion: (assertion: string) => ResolvedAssertion
55
55
  *
56
56
  * An assertion this package cannot resolve folds to ITSELF rather than to nothing. That is the
57
57
  * difference between a matcher and a gate: a consumer's private tag must still match its own
58
- * counterpart on the other side, and only the canon's own artefacts are held to resolving.
58
+ * counterpart on the other side, and only the canon's own artifacts are held to resolving.
59
59
  */
60
60
  export declare const canonicalAssertion: (assertion: string) => string;
61
61
  /** True when this package can resolve the assertion to a canonical term. */
@@ -1,6 +1,6 @@
1
1
  import type { CanonicalConceptUri, ConceptUri } from "./v1.js";
2
2
  /** Evidence routes are consumer contracts, never new appearance concepts. */
3
- export type AssessmentEvidenceRoute = "photo-candidate" | "capture-conditional" | "catalogue-only" | "context-required" | "external-authority" | "unreviewed";
3
+ export type AssessmentEvidenceRoute = "photo-candidate" | "capture-conditional" | "catalog-only" | "context-required" | "external-authority" | "unreviewed";
4
4
  /** A restriction needs an explicit list AND evidence; absence never means prohibited. */
5
5
  export type MaterialApplicability = {
6
6
  status: "unreviewed";
@@ -12,7 +12,7 @@ export { ASSERTION_KEYS, canonicalAssertion, deprecatedAssertions, isCanonicalAs
12
12
  export { isInterchangeable, MATCH_STRENGTHS, SKOS_MATCH_PREDICATE, } from "./crosswalks/strength.js";
13
13
  export { ambiguous as ambiguousMapping, approximates as approximateMapping, constitutive as constitutiveMapping, type CrosswalkMapping, declined as declinedMapping, resolved as resolvedMapping, } from "./crosswalks/mapping.js";
14
14
  export { AXES, AXIS_SLUGS, type Axis, type AxisFacet, type AxisSlug, axisBySlug, axisTerms, CONSTRUCTION_TERMS, DAYLIGHT_ASPECT_TERMS, DAYLIGHT_FACETS, DAYLIGHT_LIGHT_TERMS, type DaylightFacet, ELEMENT_TERMS, FINISH_TERMS, FORMAT_TERMS, INSTALLATION_LAYOUT_TERMS, MATERIAL_TERMS, MOOD_TERMS, PALETTE_CHARACTER_TERMS, PALETTE_COMPOSITION_TERMS, PALETTE_DEPRECATED_FACETS, PALETTE_FACETS, PALETTE_FAMILY_TERMS, PALETTE_TEMPERATURE_TERMS, PALETTE_TONE_TERMS, PATTERN_TERMS, type PaletteFacet, PERIOD_TERMS, periodAt, periodsAt, PLACE_FACETS, PLACE_LANDSCAPE_TERMS, PLACE_REGION_TERMS, PRODUCT_CATEGORY_TERMS, REQUIREMENT_TERMS, SEASON_TERMS, type PlaceFacet, MARKET_NEUTRAL_SPACES, marketsServed, MOOD_ANCHORS, moodAnchorsFor, PERIOD_ANCHORS, periodAnchorsFor, PLACE_ANCHORS, placeAnchorsFor, SPACE_ANCHORS, spaceAnchorsFor, SPACE_SECTORS, SPACE_TERMS, type SpaceSector, type Anchors, anchorsFor, STYLE_ANCHORS, type StyleSlug, STYLE_TERMS, TYPOLOGY_TERMS, UNIT_SHAPE_TERMS, } from "./axes/index.js";
15
- export { assertionMeaningFrom, type AmbiguousCanonicalisation, type CanonicalisationInput, type CanonicalisationVerdict, type DeclinedCanonicalisation, type ResolvedCanonicalisation, type UnresolvedCanonicalisation, } from "./canonicalisation.js";
15
+ export { assertionMeaningFrom, type AmbiguousCanonicalization, type CanonicalizationInput, type CanonicalizationVerdict, type DeclinedCanonicalization, type ResolvedCanonicalization, type UnresolvedCanonicalization, } from "./canonicalization.js";
16
16
  export { type AmbiguousAssertionMeaning, type AssertionAuthority, type AssertionMeaning, type AssertionPolarity, type AssertionProvenance, type AssertionRole, type AssertionScope, type PortableAssertionTestVector, type PortableTasteAssertion, PORTABLE_ASSERTION_TEST_VECTORS, type ProjectContextAssertion, type RequirementAssertion, type RequirementConstraint, type RequirementOperator, type ResolvedAssertionMeaning, TAXONOMY_SNAPSHOT_VERSION, TASTE_ASSERTION_CONTRACT_VERSION, type TasteAssertion, type UnresolvedAssertionMeaning, } from "./taste-assertion.js";
17
17
  export { APPLICATION_TERMS, MATERIAL_FAMILY_TERMS, SECTOR_TERMS, } from "./dictionaries.js";
18
18
  export declare const PROVENANCE: {
@@ -23,7 +23,7 @@ export { KNOWLEDGE_GRAPH, PHRASE_ENTRIES, TAXONOMY_BASE_URI, type AxisNode, type
23
23
  export declare const MATERIAL_FAMILIES: readonly ["paint", "wall-finish", "wallcovering", "textile", "upholstery", "carpet", "wood", "stone", "tile", "terrazzo", "metal", "glass", "resilient-flooring", "composite", "concrete", "leather", "other"];
24
24
  export type MaterialFamily = (typeof MATERIAL_FAMILIES)[number];
25
25
  export declare const isMaterialFamily: (value: string) => value is MaterialFamily;
26
- export declare const SECTORS: readonly ["hospitality", "healthcare", "workplace", "residential", "retail", "education", "civic", "mixed-use", "transportation", "other", "commercial", "industrial", "senior-living", "government", "science-technology", "cultural", "sports-recreation", "marine", "urban-design-planning", "energy-utilities", "mission-critical-data-centres", "aviation"];
26
+ export declare const SECTORS: readonly ["hospitality", "healthcare", "workplace", "residential", "retail", "education", "civic", "mixed-use", "transportation", "other", "commercial", "industrial", "senior-living", "government", "science-technology", "cultural", "sports-recreation", "marine", "urban-design-planning", "energy-utilities", "mission-critical-data-centers", "aviation"];
27
27
  export type Sector = (typeof SECTORS)[number];
28
28
  export declare const isSector: (value: string) => value is Sector;
29
29
  export declare const APPLICATIONS: readonly ["wall", "flooring", "ceiling", "bath", "kitchen", "furniture", "lighting", "door", "window", "facade", "countertop", "fireplace", "stair-elevator", "bedding", "decor", "vertically-hanging", "transportation", "pool-fountain", "paving-deck", "partition", "millwork", "cabinetry", "masonry", "roof", "garage", "bar", "awning-umbrella", "recreation-sport", "ornamentation", "aquatic-environments", "upholstery", "trim", "wall-backsplash", "wall-upholstered", "wall-wet-shower", "flooring-wet-area", "flooring-entrance", "flooring-radiant-heat", "flooring-or-lab", "flooring-anti-fatigue", "flooring-esd", "flooring-safety-slip", "flooring-raised-access", "flooring-rigid-core", "flooring-dining-area", "flooring-subject-oil", "flooring-walk-in-freezer", "flooring-ramps-inclines", "furniture-seating", "furniture-headboard", "furniture-slipcover", "furniture-systems", "furniture-tackboard", "furniture-throw-pillow", "fireplace-firebox", "fireplace-hearth", "fireplace-mantel", "fireplace-surround", "bedding-bed-scarf", "bedding-sheets", "bedding-skirt", "bedding-bedspread", "bedding-box-spring-cover", "stair-riser", "stair-tread", "stair-railing", "stair-elevator-cladding", "vh-drapery", "vh-privacy-curtain", "vh-shower-curtain", "vh-theatrical-curtain", "vh-window-shade", "transportation-automotive", "transportation-aviation", "transportation-marine", "pool-coping", "pool-decking", "pool-lining", "paving-covered-areas", "paving-patio", "partition-toilet", "masonry-structural", "masonry-veneer", "recreation-gymnasium", "recreation-playground", "recreation-weightlifting", "awning", "tensile-structure", "umbrella", "countertop-chemical-resistant"];
@@ -30,7 +30,7 @@ export interface Axis {
30
30
  /** The question the axis answers, in a reader's words. One line. */
31
31
  question: string;
32
32
  /**
33
- * Where this axis ends and its nearest neighbour begins, with the criterion that decides it.
33
+ * Where this axis ends and its nearest neighbor begins, with the criterion that decides it.
34
34
  * Rendered verbatim on the axis page, because a boundary nobody can read is a boundary that gets
35
35
  * re-litigated.
36
36
  */
@@ -4,5 +4,5 @@ export declare const authored: (slug: string, label: string, definition: string,
4
4
  export declare const term: (slug: string, label: string, definition: string) => Term;
5
5
  /** Vendored verbatim from a materials-retrieval dictionary; `rank` carries the ladder's order. */
6
6
  export declare const vendored: (source: string, slug: string, label: string, definition: string, rank?: number) => Term;
7
- /** Restored from the source column a normalisation dropped it from; `usage` carries the band. */
7
+ /** Restored from the source column a normalization dropped it from; `usage` carries the band. */
8
8
  export declare const repaired: (slug: string, label: string, definition: string, band: UsageBand, note: string) => Term;
@@ -2,9 +2,9 @@ import type { Term } from "../term.js";
2
2
  import type { AxisFacet, AxisGovernance } from "./axis.js";
3
3
  export { COLORSCOPE_VERSION } from "./palette.generated.js";
4
4
  /** The date this layer entered the published corpus. */
5
- export declare const COLOUR_LAYER_DATE = "2026-10-23";
5
+ export declare const COLOR_LAYER_DATE = "2026-10-23";
6
6
  /** ColorScope's concept kinds that Taxonomy lists, each with the reference kind its phrase targets use. */
7
- export declare const COLOUR_LAYER_KINDS: {
7
+ export declare const COLOR_LAYER_KINDS: {
8
8
  readonly composition: {
9
9
  readonly colorScopeKind: "palette";
10
10
  readonly referenceKind: "palette-mood";
@@ -25,7 +25,7 @@ export declare const COLOUR_LAYER_KINDS: {
25
25
  /**
26
26
  * The one place Taxonomy words a ColorScope concept differently: ColorScope's `colorful` palette
27
27
  * composition reads as Polychrome here. ColorScope's own label is kept as an alternate label, so
28
- * the concept stays recognisable under both.
28
+ * the concept stays recognizable under both.
29
29
  */
30
30
  export declare const PALETTE_LABEL_OVERRIDES: Readonly<Record<string, string>>;
31
31
  export declare const PALETTE_FAMILY_TERMS: readonly Term[];
@@ -37,7 +37,7 @@ export declare const COLORSCOPE_WASHED_URI: string;
37
37
  /**
38
38
  * The one term the deprecated `character` facet still holds, and the only palette term ever
39
39
  * authored here. `/id/palette/character/faded` was published, so it keeps resolving; ColorScope's
40
- * `washed` modifier has since taken faded as an alternate label, and that is where colour wording
40
+ * `washed` modifier has since taken faded as an alternate label, and that is where color wording
41
41
  * now lives.
42
42
  */
43
43
  export declare const PALETTE_CHARACTER_TERMS: readonly Term[];
@@ -1,5 +1,5 @@
1
1
  export declare const COLORSCOPE_VERSION = "10.4.0";
2
- export interface ColourLayerEntry {
2
+ export interface ColorLayerEntry {
3
3
  readonly altLabels: readonly string[];
4
4
  readonly definition: string | null;
5
5
  readonly hex: string | null;
@@ -7,7 +7,7 @@ export interface ColourLayerEntry {
7
7
  readonly label: string;
8
8
  readonly uri: string;
9
9
  }
10
- export declare const COLOUR_LAYER: {
10
+ export declare const COLOR_LAYER: {
11
11
  readonly "basic-tone": readonly [{
12
12
  readonly altLabels: readonly [];
13
13
  readonly definition: "High-lightness colors inside a family.";
@@ -5,11 +5,11 @@ export declare const relatedTo: (target: string) => TermRelation;
5
5
  export declare const readsAs: (target: string) => TermRelation;
6
6
  export declare const TAX57_DATE = "2026-09-26";
7
7
  export declare const TAX57_SOURCE = "Linear TAX-57 visual-vocabulary review";
8
- export declare const PIM_MOTIF_SOURCE = "the pattern-motif column in a materials-marketplace catalogue (src-04), non-Samplize SKUs";
9
- export declare const PIM_FIGURE_SOURCE = "the surface-figure column in a materials-marketplace catalogue (src-04), non-Samplize SKUs";
8
+ export declare const PIM_MOTIF_SOURCE = "the pattern-motif column in a materials-marketplace catalog (src-04), non-Samplize SKUs";
9
+ export declare const PIM_FIGURE_SOURCE = "the surface-figure column in a materials-marketplace catalog (src-04), non-Samplize SKUs";
10
10
  /** Evidenced from the Material Bank PIM at the TAX-57 snapshot. */
11
11
  export declare const pimTerm: (slug: string, label: string, definition: string, source: string, extra?: Partial<Term>) => Term;
12
- /** Written for TAX-57 with no public authority or catalogue column behind it. */
12
+ /** Written for TAX-57 with no public authority or catalog column behind it. */
13
13
  export declare const authoredTax57: (slug: string, label: string, definition: string, extra?: Partial<Term>) => Term;
14
14
  export declare const wikidata: (id: string, label: string) => string;
15
15
  /** Completed NBS searches from the TAX-65 external-vocabulary review. */
@@ -1,14 +1,14 @@
1
1
  import type { Sector } from "../authoring.js";
2
2
  import type { Term } from "../term.js";
3
3
  /**
4
- * A sector of the SPACE axis: a group of rooms that answer the same programme question.
4
+ * A sector of the SPACE axis: a group of rooms that answer the same program question.
5
5
  *
6
6
  * NOT THE SECTOR AXIS, despite the shared word, and the collision is old rather than chosen:
7
- * these are PROGRAMME groups (where you sleep, wash, eat), while `sector.*` is the market a
7
+ * these are PROGRAM groups (where you sleep, wash, eat), while `sector.*` is the market a
8
8
  * project serves. The market claim lives on individual terms as `serves` edges - see
9
9
  * `marketsServed` below and the register in `space/market-neutral.ts` - and this grouping makes
10
10
  * no market claim at all: the "healthcare" file holds `clean_room`, which serves no single
11
- * market, and the "domestic" file is a programme word, not `sector.residential`.
11
+ * market, and the "domestic" file is a program word, not `sector.residential`.
12
12
  *
13
13
  * NOT A FACET, and not part of a term's identifier. `space.scullery` is the id whatever sector the
14
14
  * scullery is filed under, and re-filing a room must never move its URI. This is a browse
@@ -30,8 +30,8 @@ export interface SpaceSector {
30
30
  /**
31
31
  * The seventeen sectors, in the order a browse page should show them.
32
32
  *
33
- * Ordered by programme rather than alphabetically or by size: where you arrive, where you move,
34
- * where you sleep, wash, eat, gather, and so on out to the specialised sectors and the unclassified
33
+ * Ordered by program rather than alphabetically or by size: where you arrive, where you move,
34
+ * where you sleep, wash, eat, gather, and so on out to the specialized sectors and the unclassified
35
35
  * tail. A reader looking for their own corner of the built environment finds it by walking through
36
36
  * a building, which is the order this list is in.
37
37
  *
@@ -1,7 +1,7 @@
1
1
  import type { Term } from "../term.js";
2
2
  /**
3
3
  * The positioning ladder. Where a brand, a product line or a project sits in the market, as a
4
- * judgement anyone in the trade would recognise.
4
+ * judgment anyone in the trade would recognize.
5
5
  *
6
6
  * The five values a materials-retrieval system's brand extractor is instructed to choose between, minus
7
7
  * `trade-only`, which is a channel and already has its own dictionary there. `evidenced` rather
@@ -15,7 +15,7 @@ import type { Term } from "../term.js";
15
15
  * of these rungs and it would be easy to list them, but `seenAs` is an evidence claim - it says a
16
16
  * corpus was seen to use this word for this term - and filling it from plausibility would make the
17
17
  * crosswalk unusable for the one job it has. Editorial synonyms go in `altLabels`, where they are
18
- * a judgement rather than an observation.
18
+ * a judgment rather than an observation.
19
19
  */
20
20
  export declare const TIER_MARKET_TERMS: readonly Term[];
21
21
  /**
@@ -1,17 +1,17 @@
1
1
  import type { CanonicalAlternatives, CanonicalBundle } from "./match.js";
2
2
  import type { AssertionMeaning, AssertionProvenance } from "./taste-assertion.js";
3
3
  import type { MatchStrength } from "./term.js";
4
- export interface CanonicalisationInput {
4
+ export interface CanonicalizationInput {
5
5
  sourceSystem: string;
6
6
  sourceField: string;
7
7
  sourceValue: string;
8
8
  provenance: AssertionProvenance;
9
9
  }
10
- interface CanonicalisationBase extends CanonicalisationInput {
10
+ interface CanonicalizationBase extends CanonicalizationInput {
11
11
  crosswalkVersion: string;
12
12
  taxonomySnapshotVersion: string;
13
13
  }
14
- export interface ResolvedCanonicalisation extends CanonicalisationBase {
14
+ export interface ResolvedCanonicalization extends CanonicalizationBase {
15
15
  status: "resolved";
16
16
  canonical: CanonicalBundle;
17
17
  /**
@@ -23,22 +23,22 @@ export interface ResolvedCanonicalisation extends CanonicalisationBase {
23
23
  /** Why the row is not exact. Present whenever `match` is not `exact`. */
24
24
  note?: string;
25
25
  }
26
- export interface AmbiguousCanonicalisation extends CanonicalisationBase {
26
+ export interface AmbiguousCanonicalization extends CanonicalizationBase {
27
27
  status: "ambiguous";
28
28
  alternatives: CanonicalAlternatives;
29
29
  /** How strongly each alternative would stand for the source value, were it the right meaning. */
30
30
  match: MatchStrength;
31
31
  note?: string;
32
32
  }
33
- export interface UnresolvedCanonicalisation extends CanonicalisationBase {
33
+ export interface UnresolvedCanonicalization extends CanonicalizationBase {
34
34
  status: "unresolved";
35
35
  }
36
- export interface DeclinedCanonicalisation extends CanonicalisationBase {
36
+ export interface DeclinedCanonicalization extends CanonicalizationBase {
37
37
  status: "declined";
38
38
  reason: string;
39
39
  }
40
40
  /** Four honest outcomes: absence of a mapping is never silently treated as a decline or a match. */
41
- export type CanonicalisationVerdict = ResolvedCanonicalisation | AmbiguousCanonicalisation | UnresolvedCanonicalisation | DeclinedCanonicalisation;
41
+ export type CanonicalizationVerdict = ResolvedCanonicalization | AmbiguousCanonicalization | UnresolvedCanonicalization | DeclinedCanonicalization;
42
42
  /** Convert a usable verdict to assertion meaning; a declined value does not assert anything. */
43
- export declare const assertionMeaningFrom: (verdict: CanonicalisationVerdict) => AssertionMeaning | null;
43
+ export declare const assertionMeaningFrom: (verdict: CanonicalizationVerdict) => AssertionMeaning | null;
44
44
  export {};
@@ -105,7 +105,7 @@ export declare const agreementSummary: () => {
105
105
  *
106
106
  * A SHARE AND NOT A COUNT, and the distinction is the whole reason this function exists rather than
107
107
  * a consumer meaning `ROOM_SCHEME_STYLE_COUNTS` directly. The underlying figures are a third
108
- * party's catalogue volumes and are not ours to publish. The claim anything downstream actually
108
+ * party's catalog volumes and are not ours to publish. The claim anything downstream actually
109
109
  * needs is that `Modern` and `Contemporary` sit at comparable volume and together account for a
110
110
  * large slice of the corpus - which a percentage carries exactly as well and a count carries no
111
111
  * better.
@@ -27,10 +27,10 @@ export declare const CITED_SOURCES: {
27
27
  readonly name: "a furnishings retailer";
28
28
  readonly slug: "furnishings-retailer";
29
29
  };
30
- readonly MARKETPLACE_CATALOGUE: {
30
+ readonly MARKETPLACE_CATALOG: {
31
31
  readonly id: "src-04";
32
- readonly label: "materials-marketplace catalogue";
33
- readonly name: "a materials-marketplace catalogue";
32
+ readonly label: "materials-marketplace catalog";
33
+ readonly name: "a materials-marketplace catalog";
34
34
  readonly slug: "materials-marketplace";
35
35
  };
36
36
  readonly MATERIALS_RETRIEVAL: {
@@ -92,13 +92,13 @@ export declare const RETAIL_PRODUCT_STYLES: EstateVocabulary;
92
92
  export declare const RETRIEVAL_MS_STYLE: EstateVocabulary;
93
93
  export declare const RETRIEVAL_MS_MOOD: EstateVocabulary;
94
94
  export declare const RETRIEVAL_MS_CHARACTER: EstateVocabulary;
95
- export declare const PAINT_SAMPLE_COLOUR_COLLECTIONS: EstateVocabulary;
95
+ export declare const PAINT_SAMPLE_COLOR_COLLECTIONS: EstateVocabulary;
96
96
  /**
97
97
  * A standing fact, visible in this capture rather than asserted.
98
98
  *
99
99
  * THE PAINT-SAMPLE RETAILER IS A SAMPLING CHANNEL, NOT A PAINT BRAND. It prints peel-and-stick
100
100
  * sheets of other manufacturers' colors and manufactures nothing. Its own product index groups by
101
- * brand, and every brand is somebody else: the largest share of the catalogue sits in a
101
+ * brand, and every brand is somebody else: the largest share of the catalog sits in a
102
102
  * `benjamin-moore` collection, then `sherwin-williams`, then `behr`. If a query ever returns the
103
103
  * retailer as the brand of a color, the query is wrong and this is the evidence.
104
104
  */