@instruments/taxonomy 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,13 +1,90 @@
-import { T as Term } from './match-BDI6Evro.js';
-export { A as AlternativeReason, a as AlternativesMatch, b as BundleMatch, c as BundleMember, B as BundleMemberInput, d as BundleRole, C as CanonicalAlternatives, e as CanonicalBundle, D as DEFAULT_BUNDLE_ROLE, E as ExternalMapping, f as ExternalScheme, M as MATCH_TEST_VECTORS, g as MATCH_WEIGHTS, h as MatchStrength, i as MatchTestCandidate, j as MatchTestVector, P as PeriodSpan, R as RelationPredicate, k as RelationRole, S as SearchedWithout, l as SourceBasis, m as StyleKind, n as TermProvenance, o as TermRelation, p as TermStatus, q as TermUsage, U as UsageBand, r as UsageWithheld, s as defineAlternatives, t as defineBundle, u as matchAlternatives, v as matchBundle } from './match-BDI6Evro.js';
+import { R as RelationPredicate, T as Term, M as MatchStrength } from './match-CWzTEuL-.js';
+export { A as AlternativeReason, b as AlternativesMatch, c as BundleMatch, d as BundleMember, a as BundleMemberInput, B as BundleRole, e as BundleSearch, f as CandidateAnnotations, C as CanonicalAlternatives, g as CanonicalBundle, D as DEFAULT_BUNDLE_ROLE, E as ExternalMapping, h as ExternalScheme, i as MATCH_TEST_VECTORS, j as MATCH_WEIGHTS, k as MatchTestCandidate, l as MatchTestVector, m as MatchTier, P as PeriodSpan, n as RankedCandidate, o as RelationRole, S as SearchOptions, p as SearchedWithout, q as SourceBasis, r as StyleKind, s as TermProvenance, t as TermRelation, u as TermStatus, v as TermUsage, U as UsageBand, w as UsageWithheld, x as defineAlternatives, y as defineBundle, z as matchAlternatives, F as matchBundle, G as searchBundle } from './match-CWzTEuL-.js';
+export { C as CrosswalkMapping, a as ambiguousMapping, b as approximateMapping, c as constitutiveMapping, d as declinedMapping, r as resolvedMapping } from './mapping-pvHk5VjC.js';
 export { AmbiguousAssertionMeaning, AmbiguousCanonicalisation, AssertionAuthority, AssertionMeaning, AssertionPolarity, AssertionProvenance, AssertionRole, AssertionScope, CanonicalisationInput, CanonicalisationVerdict, DeclinedCanonicalisation, PORTABLE_ASSERTION_TEST_VECTORS, PortableAssertionTestVector, PortableTasteAssertion, ProjectContextAssertion, RequirementAssertion, RequirementConstraint, RequirementOperator, ResolvedAssertionMeaning, ResolvedCanonicalisation, TASTE_ASSERTION_CONTRACT_VERSION, TAXONOMY_SNAPSHOT_VERSION, TasteAssertion, UnresolvedAssertionMeaning, UnresolvedCanonicalisation, assertionMeaningFrom } from './taste.js';
 
+/** The relation predicates, at runtime. TypeScript cannot enumerate a union, so this is by hand. */
+declare const RELATION_PREDICATES: readonly ["blend-of", "evokes", "influenced-by", "part-of", "reads-as", "related-to", "serves", "suitable-for", "typically-in"];
+/** Where a canonical term lives, and what it is called in the one spelling that counts. */
+interface TermLocation {
+    axisId: string;
+    facetId: string;
+    termId: string;
+    /** `<axis>.<term>`, or `<axis>.<facet>.<term>` on a faceted axis. ADR 0001's target form. */
+    qualifiedId: string;
+    term: Term;
+}
+/** A parsed assertion: an optional relation predicate wrapping a term reference. */
+interface ParsedAssertion {
+    predicate?: RelationPredicate;
+    /** The term reference, verbatim and unfolded. */
+    target: string;
+}
+interface ResolvedAssertion extends ParsedAssertion {
+    location: TermLocation;
+    /** The spelling the matcher compares on: `predicate(qualifiedId)` or a bare `qualifiedId`. */
+    canonical: string;
+    /** True when the named term is deprecated. Resolves anyway; a published id must keep resolving. */
+    deprecated: boolean;
+    /** The term that replaced it, when deprecated. */
+    supersededBy?: string;
+}
+/**
+ * Split `evokes(place.region.nordic)` into its predicate and target. A bare term reference parses
+ * to a target and no predicate. An unrecognised predicate does NOT parse: `foo(bar)` is not an
+ * assertion with an exotic predicate, it is a string nobody has defined.
+ */
+declare const parseAssertion: (assertion: string) => ParsedAssertion | undefined;
+/** Every canonical term, with the qualified id that names it. */
+declare const TERM_LOCATIONS: readonly TermLocation[];
+/** Every accepted spelling of every term, folded. Exported so a consumer can size the vocabulary. */
+declare const ASSERTION_KEYS: ReadonlySet<string>;
+/** Resolve any published spelling of a term to the one location it names. */
+declare const resolveTerm: (reference: string) => TermLocation | undefined;
+/**
+ * Resolve a whole assertion, predicate included. Returns undefined when the predicate is not one
+ * `term.ts` defines, or when the target names no canonical term.
+ */
+declare const resolveAssertion: (assertion: string) => ResolvedAssertion | undefined;
+/**
+ * The spelling the matcher compares on.
+ *
+ * An assertion this package cannot resolve folds to ITSELF rather than to nothing. That is the
+ * difference between a matcher and a gate: a consumer's private tag must still match its own
+ * counterpart on the other side, and only the canon's own artefacts are held to resolving.
+ */
+declare const canonicalAssertion: (assertion: string) => string;
+/** True when this package can resolve the assertion to a canonical term. */
+declare const isCanonicalAssertion: (assertion: string) => boolean;
+/** The assertions this package cannot resolve, in input order. The failure message IS the work item. */
+declare const unknownAssertions: (assertions: Iterable<string>) => readonly string[];
+/** Assertions naming a term that still resolves but has been superseded, with its successor. */
+declare const deprecatedAssertions: (assertions: Iterable<string>) => readonly {
+    assertion: string;
+    supersededBy: string;
+}[];
+
+/**
+ * The SKOS property each strength renders to.
+ *
+ * `skos:relatedMatch`, not `skos:related`: the target sits in another scheme, and SKOS reserves the
+ * unqualified property for associations inside one scheme.
+ */
+declare const SKOS_MATCH_PREDICATE: Readonly<Record<MatchStrength, string>>;
+/** The strengths, at runtime. TypeScript cannot enumerate a union, so this is by hand. */
+declare const MATCH_STRENGTHS: readonly ["broad", "close", "exact", "narrow", "related"];
+/**
+ * True when the row asserts the two concepts are interchangeable. The only strength a consumer may
+ * treat as an identity; everything else is an approximation it has been told about.
+ */
+declare const isInterchangeable: (strength: MatchStrength) => boolean;
+
 declare const ELEMENT_TERMS: readonly Term[];
 
 /** How a product or material is made; never a claim about its style or visible motif. */
 declare const CONSTRUCTION_TERMS: readonly Term[];
 
-/** The deliberately produced state of the exposed surface, not its material or motif. */
+/** Kept for consumers importing the axis as one list; prefer the facets. */
 declare const FINISH_TERMS: readonly Term[];
 
 /** The supplied physical unit or delivery shape, independent of material and installation pattern. */
@@ -18,7 +95,7 @@ declare const MATERIAL_TERMS: readonly Term[];
 
 declare const MOOD_TERMS: readonly Term[];
 
-/** Visible surface organisation or motif, independent of the substance carrying it. */
+/** Kept for consumers importing the axis as one list; prefer the facets. */
 declare const PATTERN_TERMS: readonly Term[];
 
 /** What kind of purchasable or specifiable thing the record describes, independent of substance. */
@@ -214,10 +291,10 @@ declare const isMaterialFamily: (value: string) => value is MaterialFamily;
 declare const SECTORS: readonly ["hospitality", "healthcare", "workplace", "residential", "retail", "education", "civic", "mixed_use", "transportation", "other"];
 type Sector = (typeof SECTORS)[number];
 declare const isSector: (value: string) => value is Sector;
-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", "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"];
+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"];
 type Application = (typeof APPLICATIONS)[number];
 declare const isApplication: (value: string) => value is Application;
 declare const APPLICATION_PARENTS: Readonly<Partial<Record<Application, Application>>>;
 declare const applicationTopLevelOf: (application: Application) => Application;
 
-export { APPLICATIONS, APPLICATION_PARENTS, APPLICATION_TERMS, AXES, AXIS_IDS, type Anchors$1 as Anchors, type Application, type Axis, type AxisFacet, type AxisId, CONSTRUCTION_TERMS, ELEMENT_TERMS, FINISH_TERMS, FORMAT_TERMS, MARKET_NEUTRAL_SPACES, MATERIAL_FAMILIES, MATERIAL_FAMILY_TERMS, MATERIAL_TERMS, MOOD_ANCHORS, MOOD_TERMS, type MaterialFamily, PALETTE_CHARACTER_TERMS, PALETTE_FACETS, PALETTE_HUE_TERMS, PALETTE_TEMPERATURE_TERMS, PATTERN_TERMS, PERIOD_ANCHORS, PERIOD_TERMS, PLACE_ANCHORS, PLACE_FACETS, PLACE_LANDSCAPE_TERMS, PLACE_REGION_TERMS, PRODUCT_CATEGORY_TERMS, PROVENANCE, type PaletteFacet, type PlaceFacet, REQUIREMENT_TERMS, SECTORS, SECTOR_TERMS, SPACE_ANCHORS, SPACE_SECTORS, SPACE_TERMS, STYLE_ANCHORS, STYLE_TERMS, type Sector, type SpaceSector, type StyleId, TYPOLOGY_TERMS, type TaxonomyTerm, Term, anchorsFor, applicationTopLevelOf, axisById, axisTerms, isApplication, isMaterialFamily, isSector, marketsServed, moodAnchorsFor, periodAnchorsFor, periodAt, periodsAt, placeAnchorsFor, spaceAnchorsFor };
+export { APPLICATIONS, APPLICATION_PARENTS, APPLICATION_TERMS, ASSERTION_KEYS, AXES, AXIS_IDS, type Anchors$1 as Anchors, type Application, type Axis, type AxisFacet, type AxisId, CONSTRUCTION_TERMS, ELEMENT_TERMS, FINISH_TERMS, FORMAT_TERMS, MARKET_NEUTRAL_SPACES, MATCH_STRENGTHS, MATERIAL_FAMILIES, MATERIAL_FAMILY_TERMS, MATERIAL_TERMS, MOOD_ANCHORS, MOOD_TERMS, MatchStrength, type MaterialFamily, PALETTE_CHARACTER_TERMS, PALETTE_FACETS, PALETTE_HUE_TERMS, PALETTE_TEMPERATURE_TERMS, PATTERN_TERMS, PERIOD_ANCHORS, PERIOD_TERMS, PLACE_ANCHORS, PLACE_FACETS, PLACE_LANDSCAPE_TERMS, PLACE_REGION_TERMS, PRODUCT_CATEGORY_TERMS, PROVENANCE, type PaletteFacet, type ParsedAssertion, type PlaceFacet, RELATION_PREDICATES, REQUIREMENT_TERMS, RelationPredicate, type ResolvedAssertion, SECTORS, SECTOR_TERMS, SKOS_MATCH_PREDICATE, SPACE_ANCHORS, SPACE_SECTORS, SPACE_TERMS, STYLE_ANCHORS, STYLE_TERMS, type Sector, type SpaceSector, type StyleId, TERM_LOCATIONS, TYPOLOGY_TERMS, type TaxonomyTerm, Term, type TermLocation, anchorsFor, applicationTopLevelOf, axisById, axisTerms, canonicalAssertion, deprecatedAssertions, isApplication, isCanonicalAssertion, isInterchangeable, isMaterialFamily, isSector, marketsServed, moodAnchorsFor, parseAssertion, periodAnchorsFor, periodAt, periodsAt, placeAnchorsFor, resolveAssertion, resolveTerm, spaceAnchorsFor, unknownAssertions };