@instruments/taxonomy 5.1.1 → 5.3.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 +16 -15
- package/dist/application-shared.d.ts +1 -1
- package/dist/assertions.d.ts +5 -5
- package/dist/assessment-policy.d.ts +3 -3
- package/dist/authoring.d.ts +3 -5
- package/dist/axes/axis.d.ts +3 -1
- package/dist/axes/construction-shared.d.ts +7 -0
- package/dist/axes/construction-tile-body.d.ts +7 -0
- package/dist/axes/index.d.ts +1 -6
- package/dist/axes/material-everyday-shared.d.ts +1 -1
- package/dist/axes/material-polymers-shared.d.ts +4 -1
- package/dist/axes/palette.d.ts +1 -20
- package/dist/axes/palette.generated.d.ts +131 -95
- package/dist/axes/product-category-shared.d.ts +1 -1
- package/dist/axes/registry.d.ts +6 -0
- package/dist/axes/space/shared.d.ts +1 -2
- package/dist/axes/space.d.ts +1 -1
- package/dist/corpus-test-helpers.d.ts +4 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.js +5224 -3849
- package/dist/match.d.ts +1 -1
- package/dist/term.d.ts +11 -38
- package/dist/v1.d.ts +17 -23
- package/package.json +5 -3
- package/dist/canonicalization.d.ts +0 -44
- package/dist/taste-assertion.d.ts +0 -112
- package/dist/taste.d.ts +0 -2
package/README.md
CHANGED
|
@@ -2,28 +2,31 @@
|
|
|
2
2
|
|
|
3
3
|
The canonical, data-only interiors and architecture terminology corpus.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 5.3.0 release notes
|
|
6
|
+
|
|
7
|
+
Adds three tile body concepts to the construction facet beside through body and red clay body: color body (`936nub9`), double loaded (`jgt7y9p`) and white body (`dfyjc1b`). Removes the internal taste assertion code, which was never exported; taste is not part of the open standard. No concept ID changes.
|
|
8
|
+
|
|
9
|
+
## 5.2.0 release notes
|
|
10
|
+
|
|
11
|
+
This is a breaking change shipped as a minor release. Concept identity moves from addresses to permanent 7-character IDs, and ColorScope colors become Taxonomy concepts with IDs and exact-match source links.
|
|
12
|
+
|
|
13
|
+
Consumers must migrate stored addresses and source references using [`migrations/taxonomy-address-to-id.json`](../../migrations/taxonomy-address-to-id.json). The mapping file is deleted once every consumer has migrated. There is no runtime address resolver. The matching client release is 4.1.0 and Criteria is 0.2.0.
|
|
14
|
+
|
|
15
|
+
## Data contract
|
|
6
16
|
|
|
7
17
|
The package root exports the governed corpus and its release metadata:
|
|
8
18
|
|
|
9
|
-
- `TAXONOMY_BASE_URI` - the authority used for every canonical concept URI.
|
|
10
19
|
- `KNOWLEDGE_GRAPH` - normalized axis, facet, and concept nodes plus typed, bidirectional edges.
|
|
11
20
|
- `PHRASE_ENTRIES` - exhaustive declarative `equivalent`, `ambiguous`, and `declined` records for every canonical or observed authored spelling.
|
|
12
21
|
- `TAXONOMY_CORPUS_METADATA` - deterministic node, edge, and lexical counts with the corpus revision, snapshot, and package version.
|
|
13
22
|
- `TAXONOMY_CORPUS_REVISION`, `TAXONOMY_SNAPSHOT`, and `TAXONOMY_VERSION` - the exact content fingerprint, source snapshot, and package release identifiers.
|
|
14
23
|
- `CONCEPT_ASSESSMENT_POLICIES`, `ASSESSMENT_POLICY_REVISION`, and `ASSESSMENT_AUTHORITY_REFERENCES` - evidence requirements and explicit applicability-review status for every active concept. These are not measured consumer accuracy or a claim of standards compliance.
|
|
15
24
|
|
|
16
|
-
It also exports the TypeScript types for those values. It does not export a resolver, matcher, ranker, search route,
|
|
17
|
-
|
|
18
|
-
Every public identity is a permanent HTTPS URI with lowercase kebab-case path segments:
|
|
25
|
+
It also exports the TypeScript types for those values. It does not export a resolver, matcher, ranker, search route, address constructors or aliases. Consumers build policy on top of the same data; the repository's private HTTP adapter is one such consumer.
|
|
19
26
|
|
|
20
|
-
|
|
21
|
-
https://taxonomy.materialinstruments.com/id/axis/material
|
|
22
|
-
https://taxonomy.materialinstruments.com/id/facet/palette/family
|
|
23
|
-
https://taxonomy.materialinstruments.com/id/material/walnut
|
|
24
|
-
```
|
|
27
|
+
Taxonomy concepts, axes and facets carry permanent 7-character opaque IDs. The graph's `id`, `axis`, `facet`, edge endpoints and lexical targets use these IDs. Labels and slugs can change without changing identity. IDs are never reused or changed. A linked-data address will be derived from the ID at the first RDF, SKOS or bSDD export.
|
|
25
28
|
|
|
26
|
-
ColorScope
|
|
29
|
+
Palette imports ColorScope's families, temperature levels, basic tones and palette compositions once from `data/colorscope-2026-11-18.json` (ColorScope 10.4.0, captured November 18, 2026). Each is an ordinary Taxonomy concept with a permanent opaque ID, an `exactMatch` source address and the unchanged authority-sourced hex where one exists. `COLORSCOPE_SNAPSHOT` exports the import's source, version and date. `pnpm generate:color-layer` reads only the committed snapshot; future ColorScope releases cannot change the corpus. Named colors are not graph nodes: lexical records still reference them externally without merging them into Taxonomy hierarchy. For example, `walnut` has a primary material meaning and a secondary external color 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
30
|
|
|
28
31
|
## Install and consume
|
|
29
32
|
|
|
@@ -39,9 +42,7 @@ import {
|
|
|
39
42
|
} from "@instruments/taxonomy";
|
|
40
43
|
|
|
41
44
|
const walnut = KNOWLEDGE_GRAPH.nodes.find(
|
|
42
|
-
(node) =>
|
|
43
|
-
node.kind === "concept" &&
|
|
44
|
-
node.uri === "https://taxonomy.materialinstruments.com/id/material/walnut"
|
|
45
|
+
(node) => node.kind === "concept" && node.id === "p3n9fdp"
|
|
45
46
|
);
|
|
46
47
|
|
|
47
48
|
const walnutReadings = PHRASE_ENTRIES.find(
|
|
@@ -49,7 +50,7 @@ const walnutReadings = PHRASE_ENTRIES.find(
|
|
|
49
50
|
);
|
|
50
51
|
```
|
|
51
52
|
|
|
52
|
-
Changes to canonical meaning
|
|
53
|
+
Changes to canonical meaning are governed corpus changes. Consumers migrate stored addresses once to IDs; there is no compatibility lookup. Authors mint a new ID with `pnpm --filter @instruments/taxonomy mint:id` and put the literal in source. boubakikid is a development dependency used only by the minting and one-time assignment tools.
|
|
53
54
|
|
|
54
55
|
Pin the exact package version and compare `TAXONOMY_CORPUS_REVISION` when a deployment needs to detect content drift. The revision is computed from the normalized graph and lexical entries, so it changes when governed corpus content changes even if the V1 API shape does not.
|
|
55
56
|
|
|
@@ -13,7 +13,7 @@ export declare const typicallyIn: (...spaces: readonly string[]) => TermRelation
|
|
|
13
13
|
export declare const relatedTo: (...targets: readonly string[]) => TermRelation[];
|
|
14
14
|
/**
|
|
15
15
|
* "This application is a component of that one": a tread of a stair, a hearth of a fireplace. The
|
|
16
|
-
* component is not a kind of its whole, so the edge is never `
|
|
16
|
+
* component is not a kind of its whole, so the edge is never `broaderId`.
|
|
17
17
|
*/
|
|
18
18
|
export declare const partOf: (whole: string) => TermRelation;
|
|
19
19
|
export declare const uniclass: (identifier: string, label: string, match: MatchStrength) => ExternalMapping;
|
package/dist/assertions.d.ts
CHANGED
|
@@ -14,8 +14,8 @@ export interface TermLocation {
|
|
|
14
14
|
axisSlug: string;
|
|
15
15
|
facetSlug: string;
|
|
16
16
|
termSlug: string;
|
|
17
|
-
/**
|
|
18
|
-
|
|
17
|
+
/** The assigned permanent ID. */
|
|
18
|
+
id: string;
|
|
19
19
|
term: Term;
|
|
20
20
|
}
|
|
21
21
|
/** A parsed assertion: an optional relation predicate wrapping a term reference. */
|
|
@@ -26,16 +26,16 @@ export interface ParsedAssertion {
|
|
|
26
26
|
}
|
|
27
27
|
export interface ResolvedAssertion extends ParsedAssertion {
|
|
28
28
|
location: TermLocation;
|
|
29
|
-
/** The spelling the matcher compares on: `predicate(
|
|
29
|
+
/** The spelling the matcher compares on: `predicate(id)` or a bare ID. */
|
|
30
30
|
canonical: string;
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
|
-
* Split `evokes(
|
|
33
|
+
* Split `evokes(73tu18p)` into its predicate and target. A bare term reference parses
|
|
34
34
|
* to a target and no predicate. An unrecognized predicate does NOT parse: `foo(bar)` is not an
|
|
35
35
|
* assertion with an exotic predicate, it is a string nobody has defined.
|
|
36
36
|
*/
|
|
37
37
|
export declare const parseAssertion: (assertion: string) => ParsedAssertion | undefined;
|
|
38
|
-
/** Every canonical term
|
|
38
|
+
/** Every canonical term and its permanent ID. */
|
|
39
39
|
export declare const AUTHORING_LOCATIONS: readonly TermLocation[];
|
|
40
40
|
/** Every accepted spelling of every term, folded. Exported so a consumer can size the vocabulary. */
|
|
41
41
|
export declare const ASSERTION_KEYS: ReadonlySet<string>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ConceptId } from "./v1.js";
|
|
2
2
|
/** Evidence routes are consumer contracts, never new appearance concepts. */
|
|
3
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. */
|
|
@@ -10,11 +10,11 @@ export type MaterialApplicability = {
|
|
|
10
10
|
evidence: readonly string[];
|
|
11
11
|
} | {
|
|
12
12
|
status: "restricted";
|
|
13
|
-
|
|
13
|
+
categoryIds: readonly ConceptId[];
|
|
14
14
|
evidence: readonly string[];
|
|
15
15
|
};
|
|
16
16
|
export interface ConceptAssessmentPolicy {
|
|
17
|
-
|
|
17
|
+
conceptId: ConceptId;
|
|
18
18
|
evidenceRoute: AssessmentEvidenceRoute;
|
|
19
19
|
materialApplicability: MaterialApplicability;
|
|
20
20
|
requirements: readonly string[];
|
package/dist/authoring.d.ts
CHANGED
|
@@ -12,14 +12,12 @@ export { ASSERTION_KEYS, canonicalAssertion, isCanonicalAssertion, type ParsedAs
|
|
|
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_COMPOSITION_TERMS, PALETTE_FACETS, PALETTE_FAMILY_TERMS, PALETTE_TEMPERATURE_TERMS, PALETTE_TONE_TERMS, PATTERN_TERMS, type PaletteFacet, PERIOD_TERMS, type PeriodQuery, 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 AmbiguousCanonicalization, type CanonicalizationInput, type CanonicalizationVerdict, type DeclinedCanonicalization, type ResolvedCanonicalization, type UnresolvedCanonicalization, } from "./canonicalization.js";
|
|
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
15
|
export { APPLICATION_TERMS, MATERIAL_FAMILY_TERMS, SECTOR_TERMS, } from "./dictionaries.js";
|
|
18
16
|
export declare const PROVENANCE: {
|
|
19
17
|
readonly snapshot: "2026-07-08";
|
|
20
18
|
readonly source: "value dictionaries in a materials-retrieval system (src-05)";
|
|
21
19
|
};
|
|
22
|
-
export { KNOWLEDGE_GRAPH, PHRASE_ENTRIES,
|
|
20
|
+
export { KNOWLEDGE_GRAPH, PHRASE_ENTRIES, type AxisNode, type ConceptId, type ColorScopeTarget, type ConceptNode, type ExternalReference, type FacetNode, type GraphPredicate, type KnowledgeGraph, type KnowledgeGraphEdge, type KnowledgeGraphNode, type PhraseEntry, type MeaningContext, type PhraseMeaning, type Lifecycle, type Governance, TAXONOMY_SNAPSHOT, type TaxonomyTarget, } from "./v1.js";
|
|
23
21
|
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
22
|
export type MaterialFamily = (typeof MATERIAL_FAMILIES)[number];
|
|
25
23
|
export declare const isMaterialFamily: (value: string) => value is MaterialFamily;
|
|
@@ -29,5 +27,5 @@ export declare const isSector: (value: string) => value is Sector;
|
|
|
29
27
|
export declare const APPLICATIONS: readonly ["wall", "flooring", "ceiling", "furniture", "door", "window", "facade", "countertop", "fireplace", "stair", "window-covering", "pool", "fountain", "paving", "deck", "partition", "millwork", "cabinetry", "masonry", "roof", "ornamentation", "upholstery", "trim", "wall-backsplash", "wall-upholstered", "wall-shower", "flooring-raised-access", "flooring-ramp", "furniture-seating", "furniture-systems", "furniture-tackboard", "furniture-throw-pillow", "fireplace-firebox", "fireplace-hearth", "fireplace-mantel", "stair-riser", "stair-tread", "stair-railing", "elevator-cladding", "pool-coping", "pool-decking", "pool-lining", "partition-toilet", "masonry-structural", "masonry-veneer", "tensile-structure", "furniture-tabletop", "window-sill", "countertop-vanity-top", "wall-column-cladding", "wainscoting", "flooring-shower"];
|
|
30
28
|
export type Application = (typeof APPLICATIONS)[number];
|
|
31
29
|
export declare const isApplication: (value: string) => value is Application;
|
|
32
|
-
export declare const APPLICATION_PARENTS:
|
|
33
|
-
export declare const applicationTopLevelOf: (
|
|
30
|
+
export declare const APPLICATION_PARENTS: Record<string, string>;
|
|
31
|
+
export declare const applicationTopLevelOf: (id: string) => string;
|
package/dist/axes/axis.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export interface AxisGovernance {
|
|
|
9
9
|
/** How many terms one described thing may carry from a facet. */
|
|
10
10
|
export type FacetHolds = "one" | "several";
|
|
11
11
|
export interface AxisFacet {
|
|
12
|
+
id: string;
|
|
12
13
|
governance?: AxisGovernance;
|
|
13
14
|
/**
|
|
14
15
|
* `one` means a thing has a single reading of this facet. `several` means each stated term is a
|
|
@@ -21,6 +22,7 @@ export interface AxisFacet {
|
|
|
21
22
|
terms: readonly Term[];
|
|
22
23
|
}
|
|
23
24
|
export interface Axis {
|
|
25
|
+
id: string;
|
|
24
26
|
slug: AxisSlug;
|
|
25
27
|
label: string;
|
|
26
28
|
/** The question the axis answers, in a reader's words. One line. */
|
|
@@ -40,4 +42,4 @@ export interface Axis {
|
|
|
40
42
|
/** Why the axis has no terms yet. Present only when status is "declared". */
|
|
41
43
|
gap?: string;
|
|
42
44
|
}
|
|
43
|
-
export declare const single: (slug: string, label: string, terms: readonly Term[], governance?: AxisGovernance, holds?: FacetHolds) => readonly AxisFacet[];
|
|
45
|
+
export declare const single: (id: string, slug: string, label: string, terms: readonly Term[], governance?: AxisGovernance, holds?: FacetHolds) => readonly AxisFacet[];
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Term } from "../term.js";
|
|
2
|
+
export declare const JACQUARD_WEAVING = "Jacquard weaving";
|
|
3
|
+
export declare const wikidata: (id: string, label: string) => string;
|
|
4
|
+
export declare const reviewed: (slug: string, label: string, definition: string, source: string, extra?: Partial<Term>) => Term;
|
|
5
|
+
export declare const authored: (slug: string, label: string, definition: string, extra?: Partial<Term>) => Term;
|
|
6
|
+
export declare const term: (slug: string, label: string, definition: string) => Term;
|
|
7
|
+
export declare const reviewedTax57: (slug: string, label: string, definition: string, source: string, extra?: Partial<Term>) => Term;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Term } from "../term.js";
|
|
2
|
+
/**
|
|
3
|
+
* Color body, double loaded and white body join through body (`n8137pe`) and red clay body
|
|
4
|
+
* (`8gdiocg`) as the tile body types a spec sheet gives. Glazed is a finish (finish.treatment),
|
|
5
|
+
* not a body.
|
|
6
|
+
*/
|
|
7
|
+
export declare const TILE_BODY_TERMS: readonly Term[];
|
package/dist/axes/index.d.ts
CHANGED
|
@@ -1,10 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
import type { Axis, AxisSlug } from "./axis.js";
|
|
3
|
-
export declare const AXES: readonly Axis[];
|
|
1
|
+
export { AXES, axisBySlug, axisTerms } from "./registry.js";
|
|
4
2
|
export { type Axis, type AxisFacet, AXIS_SLUGS, type AxisGovernance, type AxisSlug, type FacetHolds, } from "./axis.js";
|
|
5
|
-
export declare const axisBySlug: (slug: AxisSlug) => Axis | undefined;
|
|
6
|
-
/** Every term on an axis, across all its facets. */
|
|
7
|
-
export declare const axisTerms: (axis: Axis) => readonly Term[];
|
|
8
3
|
export { ELEMENT_TERMS } from "./element.js";
|
|
9
4
|
export { CONSTRUCTION_TERMS } from "./construction.js";
|
|
10
5
|
export { DAYLIGHT_ASPECT_TERMS, DAYLIGHT_FACETS, DAYLIGHT_LIGHT_TERMS, type DaylightFacet, } from "./daylight.js";
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Term } from "../term.js";
|
|
2
2
|
export declare const REVIEW_DATE = "2026-09-11";
|
|
3
3
|
export declare const REVIEW_SOURCE = "everyday-interiors vocabulary review";
|
|
4
|
-
export declare const STONE_TARGET = "
|
|
4
|
+
export declare const STONE_TARGET = "0g49m92";
|
|
5
5
|
export declare const wikidata: (id: string, label: string) => string;
|
|
6
6
|
export declare const reviewed: (slug: string, label: string, definition: string, source: string, extra?: Partial<Term>) => Term;
|
|
7
7
|
export declare const authored: (slug: string, label: string, definition: string, extra?: Partial<Term>) => Term;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ExternalScheme, SearchedWithout, TermRelation } from "../term.js";
|
|
1
|
+
import type { ExternalMapping, ExternalScheme, SearchedWithout, TermRelation } from "../term.js";
|
|
2
2
|
export declare const searchedUniclass: (query: string) => readonly SearchedWithout[];
|
|
3
3
|
export declare const EU_1007_2011: ExternalScheme;
|
|
4
4
|
export declare const FTC_16CFR303: ExternalScheme;
|
|
@@ -18,3 +18,6 @@ export declare const PLASTIC_SLUG = "plastic";
|
|
|
18
18
|
*/
|
|
19
19
|
export declare const FILED_UNDER_PLASTIC: TermRelation;
|
|
20
20
|
export declare const PLASTIC_DATE = "2026-10-14";
|
|
21
|
+
export declare const same: (scheme: ExternalScheme, name: string) => ExternalMapping;
|
|
22
|
+
export declare const narrowFiberNames: (name: string) => readonly ExternalMapping[];
|
|
23
|
+
export declare const fiberNames: (name: string, extra?: readonly ExternalMapping[]) => readonly ExternalMapping[];
|
package/dist/axes/palette.d.ts
CHANGED
|
@@ -1,27 +1,7 @@
|
|
|
1
1
|
import type { Term } from "../term.js";
|
|
2
2
|
import type { AxisFacet, AxisGovernance } from "./axis.js";
|
|
3
|
-
export { COLORSCOPE_VERSION } from "./palette.generated.js";
|
|
4
3
|
/** The date this layer entered the published corpus. */
|
|
5
4
|
export declare const COLOR_LAYER_DATE = "2026-10-23";
|
|
6
|
-
/** ColorScope's concept kinds that Taxonomy lists, each with the reference kind its phrase targets use. */
|
|
7
|
-
export declare const COLOR_LAYER_KINDS: {
|
|
8
|
-
readonly composition: {
|
|
9
|
-
readonly colorScopeKind: "palette";
|
|
10
|
-
readonly referenceKind: "palette-mood";
|
|
11
|
-
};
|
|
12
|
-
readonly family: {
|
|
13
|
-
readonly colorScopeKind: "family";
|
|
14
|
-
readonly referenceKind: "color-family";
|
|
15
|
-
};
|
|
16
|
-
readonly temperature: {
|
|
17
|
-
readonly colorScopeKind: "temperature";
|
|
18
|
-
readonly referenceKind: "temperature-level";
|
|
19
|
-
};
|
|
20
|
-
readonly tone: {
|
|
21
|
-
readonly colorScopeKind: "basic-tone";
|
|
22
|
-
readonly referenceKind: "basic-tone";
|
|
23
|
-
};
|
|
24
|
-
};
|
|
25
5
|
/**
|
|
26
6
|
* The one place Taxonomy words a ColorScope concept differently: ColorScope's `colorful` palette
|
|
27
7
|
* composition reads as Polychrome here. ColorScope's own label is kept as an alternate label, so
|
|
@@ -46,3 +26,4 @@ export declare const PALETTE_AXIS_FACETS: readonly AxisFacet[];
|
|
|
46
26
|
/** The four palette facets, each a ColorScope kind shown in Taxonomy. */
|
|
47
27
|
export declare const PALETTE_FACETS: readonly ["family", "temperature", "tone", "composition"];
|
|
48
28
|
export type PaletteFacet = (typeof PALETTE_FACETS)[number];
|
|
29
|
+
export {};
|
|
@@ -1,232 +1,268 @@
|
|
|
1
|
-
export declare const
|
|
1
|
+
export declare const COLORSCOPE_SNAPSHOT: {
|
|
2
|
+
readonly date: "2026-11-18";
|
|
3
|
+
readonly source: "@materialinstruments/colorscope/identities";
|
|
4
|
+
readonly version: "10.4.0";
|
|
5
|
+
};
|
|
2
6
|
export interface ColorLayerEntry {
|
|
3
7
|
readonly altLabels: readonly string[];
|
|
4
8
|
readonly definition: string | null;
|
|
5
9
|
readonly hex: string | null;
|
|
6
10
|
readonly id: string;
|
|
7
11
|
readonly label: string;
|
|
8
|
-
readonly
|
|
12
|
+
readonly slug: string;
|
|
13
|
+
readonly exactMatch: string;
|
|
9
14
|
}
|
|
10
15
|
export declare const COLOR_LAYER: {
|
|
11
16
|
readonly "basic-tone": readonly [{
|
|
17
|
+
readonly id: "71fgbgy";
|
|
18
|
+
readonly slug: "light";
|
|
19
|
+
readonly label: "Light";
|
|
12
20
|
readonly altLabels: readonly [];
|
|
13
21
|
readonly definition: "High-lightness colors inside a family.";
|
|
14
22
|
readonly hex: null;
|
|
15
|
-
readonly
|
|
16
|
-
readonly label: "Light";
|
|
17
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/basic-tone/light";
|
|
23
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/basic-tone/light";
|
|
18
24
|
}, {
|
|
25
|
+
readonly id: "hc3ujrt";
|
|
26
|
+
readonly slug: "mid";
|
|
27
|
+
readonly label: "Medium";
|
|
19
28
|
readonly altLabels: readonly [];
|
|
20
29
|
readonly definition: "Canonical product-facing colors inside a family.";
|
|
21
30
|
readonly hex: null;
|
|
22
|
-
readonly
|
|
23
|
-
readonly label: "Medium";
|
|
24
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/basic-tone/mid";
|
|
31
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/basic-tone/mid";
|
|
25
32
|
}, {
|
|
33
|
+
readonly id: "y8l02h5";
|
|
34
|
+
readonly slug: "dark";
|
|
35
|
+
readonly label: "Dark";
|
|
26
36
|
readonly altLabels: readonly [];
|
|
27
37
|
readonly definition: "Low-lightness colors inside a family.";
|
|
28
38
|
readonly hex: null;
|
|
29
|
-
readonly
|
|
30
|
-
readonly label: "Dark";
|
|
31
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/basic-tone/dark";
|
|
39
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/basic-tone/dark";
|
|
32
40
|
}, {
|
|
41
|
+
readonly id: "80sef0f";
|
|
42
|
+
readonly slug: "muted";
|
|
43
|
+
readonly label: "Muted";
|
|
33
44
|
readonly altLabels: readonly [];
|
|
34
45
|
readonly definition: "Lower-chroma colors inside a family.";
|
|
35
46
|
readonly hex: null;
|
|
36
|
-
readonly
|
|
37
|
-
readonly label: "Muted";
|
|
38
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/basic-tone/muted";
|
|
47
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/basic-tone/muted";
|
|
39
48
|
}, {
|
|
49
|
+
readonly id: "64g81ud";
|
|
50
|
+
readonly slug: "vivid";
|
|
51
|
+
readonly label: "Vivid";
|
|
40
52
|
readonly altLabels: readonly [];
|
|
41
53
|
readonly definition: "Higher-chroma colors inside a family.";
|
|
42
54
|
readonly hex: null;
|
|
43
|
-
readonly
|
|
44
|
-
readonly label: "Vivid";
|
|
45
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/basic-tone/vivid";
|
|
55
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/basic-tone/vivid";
|
|
46
56
|
}];
|
|
47
57
|
readonly family: readonly [{
|
|
58
|
+
readonly id: "id4m1ts";
|
|
59
|
+
readonly slug: "white";
|
|
60
|
+
readonly label: "White";
|
|
48
61
|
readonly altLabels: readonly [];
|
|
49
62
|
readonly definition: "Light neutral colors spanning crisp whites, cool whites, soft chalks, and paper-like off-whites.";
|
|
50
63
|
readonly hex: "#f3efe6";
|
|
51
|
-
readonly
|
|
52
|
-
readonly label: "White";
|
|
53
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/white";
|
|
64
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/white";
|
|
54
65
|
}, {
|
|
66
|
+
readonly id: "nb2cjb6";
|
|
67
|
+
readonly slug: "cream";
|
|
68
|
+
readonly label: "Cream";
|
|
55
69
|
readonly altLabels: readonly [];
|
|
56
70
|
readonly definition: "Warm white and pale cream colors spanning ivory, linen white, vanilla, eggshell, and softened cream tones.";
|
|
57
71
|
readonly hex: "#f3ead8";
|
|
58
|
-
readonly
|
|
59
|
-
readonly label: "Cream";
|
|
60
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/cream";
|
|
72
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/cream";
|
|
61
73
|
}, {
|
|
74
|
+
readonly id: "79jujer";
|
|
75
|
+
readonly slug: "gray";
|
|
76
|
+
readonly label: "Gray";
|
|
62
77
|
readonly altLabels: readonly ["Grey"];
|
|
63
78
|
readonly definition: "Cool and warm grays spanning mist, stone, slate, pewter, and architectural neutrals.";
|
|
64
79
|
readonly hex: "#8c8d8f";
|
|
65
|
-
readonly
|
|
66
|
-
readonly label: "Gray";
|
|
67
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/gray";
|
|
80
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/gray";
|
|
68
81
|
}, {
|
|
82
|
+
readonly id: "ro9ha00";
|
|
83
|
+
readonly slug: "black";
|
|
84
|
+
readonly label: "Black";
|
|
69
85
|
readonly altLabels: readonly [];
|
|
70
86
|
readonly definition: "Near-black and black-led colors with mineral, ink, soot, and shadow character.";
|
|
71
87
|
readonly hex: "#232425";
|
|
72
|
-
readonly
|
|
73
|
-
readonly label: "Black";
|
|
74
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/black";
|
|
88
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/black";
|
|
75
89
|
}, {
|
|
90
|
+
readonly id: "p55qccg";
|
|
91
|
+
readonly slug: "beige";
|
|
92
|
+
readonly label: "Beige";
|
|
76
93
|
readonly altLabels: readonly [];
|
|
77
94
|
readonly definition: "Light warm neutrals built from sand, linen, oat, ecru, and mellow mineral undertones.";
|
|
78
95
|
readonly hex: "#d1c2a5";
|
|
79
|
-
readonly
|
|
80
|
-
readonly label: "Beige";
|
|
81
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/beige";
|
|
96
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/beige";
|
|
82
97
|
}, {
|
|
98
|
+
readonly id: "0ie8fqh";
|
|
99
|
+
readonly slug: "taupe";
|
|
100
|
+
readonly label: "Taupe";
|
|
83
101
|
readonly altLabels: readonly [];
|
|
84
102
|
readonly definition: "Grey-brown and mushroom neutrals sitting between beige, brown, and grey.";
|
|
85
103
|
readonly hex: "#8b7d6b";
|
|
86
|
-
readonly
|
|
87
|
-
readonly label: "Taupe";
|
|
88
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/taupe";
|
|
104
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/taupe";
|
|
89
105
|
}, {
|
|
106
|
+
readonly id: "of8q93e";
|
|
107
|
+
readonly slug: "brown";
|
|
108
|
+
readonly label: "Brown";
|
|
90
109
|
readonly altLabels: readonly [];
|
|
91
110
|
readonly definition: "Earth and wood colors spanning bark, spice, soil, cocoa, leather, and dark timber tones.";
|
|
92
111
|
readonly hex: "#7b5738";
|
|
93
|
-
readonly
|
|
94
|
-
readonly label: "Brown";
|
|
95
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/brown";
|
|
112
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/brown";
|
|
96
113
|
}, {
|
|
114
|
+
readonly id: "oj8ntdu";
|
|
115
|
+
readonly slug: "red";
|
|
116
|
+
readonly label: "Red";
|
|
97
117
|
readonly altLabels: readonly [];
|
|
98
118
|
readonly definition: "Red-led colors spanning crimson, vermilion, tomato, signal red, and deep wine hues.";
|
|
99
119
|
readonly hex: "#b4403f";
|
|
100
|
-
readonly
|
|
101
|
-
readonly label: "Red";
|
|
102
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/red";
|
|
120
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/red";
|
|
103
121
|
}, {
|
|
122
|
+
readonly id: "iad7ht2";
|
|
123
|
+
readonly slug: "orange";
|
|
124
|
+
readonly label: "Orange";
|
|
104
125
|
readonly altLabels: readonly [];
|
|
105
126
|
readonly definition: "Orange-led colors spanning terracotta, rust, clay, amber, spice, and peel-bright hues.";
|
|
106
127
|
readonly hex: "#c77448";
|
|
107
|
-
readonly
|
|
108
|
-
readonly label: "Orange";
|
|
109
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/orange";
|
|
128
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/orange";
|
|
110
129
|
}, {
|
|
130
|
+
readonly id: "dgbo16c";
|
|
131
|
+
readonly slug: "yellow";
|
|
132
|
+
readonly label: "Yellow";
|
|
111
133
|
readonly altLabels: readonly [];
|
|
112
134
|
readonly definition: "Yellow-led colors ranging from straw and butter tones through gold, citrus, and saffron.";
|
|
113
135
|
readonly hex: "#d5b468";
|
|
114
|
-
readonly
|
|
115
|
-
readonly label: "Yellow";
|
|
116
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/yellow";
|
|
136
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/yellow";
|
|
117
137
|
}, {
|
|
138
|
+
readonly id: "fplfl5e";
|
|
139
|
+
readonly slug: "green";
|
|
140
|
+
readonly label: "Green";
|
|
118
141
|
readonly altLabels: readonly [];
|
|
119
142
|
readonly definition: "Green-led colors spanning sage, herb, leaf, forest, mint, and botanical families.";
|
|
120
143
|
readonly hex: "#5c8a57";
|
|
121
|
-
readonly
|
|
122
|
-
readonly label: "Green";
|
|
123
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/green";
|
|
144
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/green";
|
|
124
145
|
}, {
|
|
146
|
+
readonly id: "tj155f1";
|
|
147
|
+
readonly slug: "teal";
|
|
148
|
+
readonly label: "Teal";
|
|
125
149
|
readonly altLabels: readonly ["Blue Green", "Blue-Green"];
|
|
126
150
|
readonly definition: "Blue-green colors spanning aqua, lagoon, patina, seafoam, and mineral teal tones.";
|
|
127
151
|
readonly hex: "#4e8e8e";
|
|
128
|
-
readonly
|
|
129
|
-
readonly label: "Teal";
|
|
130
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/teal";
|
|
152
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/teal";
|
|
131
153
|
}, {
|
|
154
|
+
readonly id: "narsna8";
|
|
155
|
+
readonly slug: "blue";
|
|
156
|
+
readonly label: "Blue";
|
|
132
157
|
readonly altLabels: readonly [];
|
|
133
158
|
readonly definition: "Blue-led colors spanning sky, sea, teal-leaning, ink, navy, and mineral blue families.";
|
|
134
159
|
readonly hex: "#4a6e8e";
|
|
135
|
-
readonly
|
|
136
|
-
readonly label: "Blue";
|
|
137
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/blue";
|
|
160
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/blue";
|
|
138
161
|
}, {
|
|
162
|
+
readonly id: "o264jfc";
|
|
163
|
+
readonly slug: "purple";
|
|
164
|
+
readonly label: "Purple";
|
|
139
165
|
readonly altLabels: readonly [];
|
|
140
166
|
readonly definition: "Purple-led colors covering lavender, mauve, plum, indigo, and smoke-violet concepts.";
|
|
141
167
|
readonly hex: "#7a5a88";
|
|
142
|
-
readonly
|
|
143
|
-
readonly label: "Purple";
|
|
144
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/purple";
|
|
168
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/purple";
|
|
145
169
|
}, {
|
|
170
|
+
readonly id: "3e8ajfy";
|
|
171
|
+
readonly slug: "pink";
|
|
172
|
+
readonly label: "Pink";
|
|
146
173
|
readonly altLabels: readonly [];
|
|
147
174
|
readonly definition: "Pink-led colors spanning powder, rose, salmon, blossom, and berry-pink concepts.";
|
|
148
175
|
readonly hex: "#c98da0";
|
|
149
|
-
readonly
|
|
150
|
-
readonly label: "Pink";
|
|
151
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/family/pink";
|
|
176
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/family/pink";
|
|
152
177
|
}];
|
|
153
178
|
readonly palette: readonly [{
|
|
179
|
+
readonly id: "b3mu1uo";
|
|
180
|
+
readonly slug: "vibrant";
|
|
181
|
+
readonly label: "Vibrant";
|
|
154
182
|
readonly altLabels: readonly [];
|
|
155
183
|
readonly definition: "A palette of high vibrancy that does not spread across three or more distinct hues.";
|
|
156
184
|
readonly hex: null;
|
|
157
|
-
readonly
|
|
158
|
-
readonly label: "Vibrant";
|
|
159
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/palette/vibrant";
|
|
185
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/palette/vibrant";
|
|
160
186
|
}, {
|
|
187
|
+
readonly id: "mau73fo";
|
|
188
|
+
readonly slug: "muted";
|
|
189
|
+
readonly label: "Muted";
|
|
161
190
|
readonly altLabels: readonly [];
|
|
162
191
|
readonly definition: "A palette of low vibrancy and middle lightness: the default when no other composition applies.";
|
|
163
192
|
readonly hex: null;
|
|
164
|
-
readonly
|
|
165
|
-
readonly label: "Muted";
|
|
166
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/palette/muted";
|
|
193
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/palette/muted";
|
|
167
194
|
}, {
|
|
195
|
+
readonly id: "lgbu6u8";
|
|
196
|
+
readonly slug: "dark";
|
|
197
|
+
readonly label: "Dark";
|
|
168
198
|
readonly altLabels: readonly [];
|
|
169
199
|
readonly definition: "A palette whose proportion-weighted lightness is low, and which is neither monochrome nor vibrant.";
|
|
170
200
|
readonly hex: null;
|
|
171
|
-
readonly
|
|
172
|
-
readonly label: "Dark";
|
|
173
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/palette/dark";
|
|
201
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/palette/dark";
|
|
174
202
|
}, {
|
|
203
|
+
readonly id: "c4eha6e";
|
|
204
|
+
readonly slug: "light";
|
|
205
|
+
readonly label: "Light";
|
|
175
206
|
readonly altLabels: readonly [];
|
|
176
207
|
readonly definition: "A palette whose proportion-weighted lightness is high, and which is neither monochrome nor vibrant.";
|
|
177
208
|
readonly hex: null;
|
|
178
|
-
readonly
|
|
179
|
-
readonly label: "Light";
|
|
180
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/palette/light";
|
|
209
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/palette/light";
|
|
181
210
|
}, {
|
|
211
|
+
readonly id: "yhmf2sf";
|
|
212
|
+
readonly slug: "monochrome";
|
|
213
|
+
readonly label: "Monochrome";
|
|
182
214
|
readonly altLabels: readonly [];
|
|
183
215
|
readonly definition: "A palette built from a single hue with little variety between its colors.";
|
|
184
216
|
readonly hex: null;
|
|
185
|
-
readonly
|
|
186
|
-
readonly label: "Monochrome";
|
|
187
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/palette/monochrome";
|
|
217
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/palette/monochrome";
|
|
188
218
|
}, {
|
|
219
|
+
readonly id: "m4n78pc";
|
|
220
|
+
readonly slug: "colorful";
|
|
221
|
+
readonly label: "Colorful";
|
|
189
222
|
readonly altLabels: readonly [];
|
|
190
223
|
readonly definition: "A palette of high vibrancy spread across three or more distinct hues.";
|
|
191
224
|
readonly hex: null;
|
|
192
|
-
readonly
|
|
193
|
-
readonly label: "Colorful";
|
|
194
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/palette/colorful";
|
|
225
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/palette/colorful";
|
|
195
226
|
}];
|
|
196
227
|
readonly temperature: readonly [{
|
|
228
|
+
readonly id: "srgosym";
|
|
229
|
+
readonly slug: "cold";
|
|
230
|
+
readonly label: "Cold";
|
|
197
231
|
readonly altLabels: readonly [];
|
|
198
232
|
readonly definition: "The strongest cool reading: a highly chromatic color in the cyan to blue-violet hues.";
|
|
199
233
|
readonly hex: null;
|
|
200
|
-
readonly
|
|
201
|
-
readonly label: "Cold";
|
|
202
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/temperature/cold";
|
|
234
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/temperature/cold";
|
|
203
235
|
}, {
|
|
236
|
+
readonly id: "bnegsfn";
|
|
237
|
+
readonly slug: "cool";
|
|
238
|
+
readonly label: "Cool";
|
|
204
239
|
readonly altLabels: readonly [];
|
|
205
240
|
readonly definition: "A color that reads cool: blue-green to violet hues at modest chroma, and strongly chromatic greens and magentas.";
|
|
206
241
|
readonly hex: null;
|
|
207
|
-
readonly
|
|
208
|
-
readonly label: "Cool";
|
|
209
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/temperature/cool";
|
|
242
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/temperature/cool";
|
|
210
243
|
}, {
|
|
244
|
+
readonly id: "d2sbd2y";
|
|
245
|
+
readonly slug: "neutral";
|
|
246
|
+
readonly label: "Neutral";
|
|
211
247
|
readonly altLabels: readonly [];
|
|
212
248
|
readonly definition: "Neither warm nor cool: achromatic colors, and weakly chromatic ones in the yellow-green, green and magenta hues.";
|
|
213
249
|
readonly hex: null;
|
|
214
|
-
readonly
|
|
215
|
-
readonly label: "Neutral";
|
|
216
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/temperature/neutral";
|
|
250
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/temperature/neutral";
|
|
217
251
|
}, {
|
|
252
|
+
readonly id: "h3rs7qm";
|
|
253
|
+
readonly slug: "warm";
|
|
254
|
+
readonly label: "Warm";
|
|
218
255
|
readonly altLabels: readonly [];
|
|
219
256
|
readonly definition: "A color that reads warm: red, orange and yellow hues at modest chroma, and strongly chromatic yellow-greens.";
|
|
220
257
|
readonly hex: null;
|
|
221
|
-
readonly
|
|
222
|
-
readonly label: "Warm";
|
|
223
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/temperature/warm";
|
|
258
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/temperature/warm";
|
|
224
259
|
}, {
|
|
260
|
+
readonly id: "40gr04f";
|
|
261
|
+
readonly slug: "hot";
|
|
262
|
+
readonly label: "Hot";
|
|
225
263
|
readonly altLabels: readonly [];
|
|
226
264
|
readonly definition: "The strongest warm reading: a highly chromatic red, orange or yellow.";
|
|
227
265
|
readonly hex: null;
|
|
228
|
-
readonly
|
|
229
|
-
readonly label: "Hot";
|
|
230
|
-
readonly uri: "https://colorscope.materialinstruments.com/id/temperature/hot";
|
|
266
|
+
readonly exactMatch: "https://colorscope.materialinstruments.com/id/temperature/hot";
|
|
231
267
|
}];
|
|
232
268
|
};
|