glossarist 0.4.50 → 0.4.51

package/src/models/dataset-color.ts

@@ -1,88 +0,0 @@
-// Per-dataset color spec, light/dark variants.
-//
-// A DatasetColor may be:
-//   - a single hex string (legacy, applied to both modes)
-//   - an explicit { light, dark } pair
-//
-// Round-trips through Register.toJSON unchanged so the data lives in
-// the GCR package. Consumers call resolveColor(mode) to pick the
-// right hex for the current UI mode.
-
-export type ColorMode = 'light' | 'dark';
-
-export type DatasetColorSpec = string;
-
-export interface DatasetColorPair {
-  light?: string;
-  dark?: string;
-}
-
-export type DatasetColor = DatasetColorSpec | DatasetColorPair;
-
-export const COLOR_MODES: ReadonlyArray<ColorMode> = Object.freeze([
-  'light',
-  'dark',
-]);
-
-/**
- * Returns the right hex for the given mode. Falls back to the single
- * hex when the spec is a string. Returns null when the spec is null
- * or when the requested mode is missing from a pair.
- */
-export function resolveColor(
-  color: DatasetColor | null | undefined,
-  mode: ColorMode,
-): string | null {
-  if (color == null) return null;
-  if (typeof color === 'string') return color;
-  if (typeof color === 'object') {
-    if (!mode) return color.light ?? color.dark ?? null;
-    return color[mode] ?? null;
-  }
-  return null;
-}
-
-/**
- * True when the spec declares an explicit {light, dark} object.
- */
-export function isColorPair(
-  color: DatasetColor | null | undefined,
-): color is DatasetColorPair {
-  return color != null && typeof color === 'object';
-}
-
-/**
- * Validates a color spec. A valid spec is either:
- *   - a string matching /^#[0-9a-fA-F]{3,8}$/
- *   - an object with `light` and `dark` string fields, each matching
- *     the same pattern
- *
- * Returns null when valid, or an error message describing the issue.
- */
-export function validateColor(
-  color: DatasetColor | null | undefined,
-): string | null {
-  if (color == null) return null;
-  if (typeof color === 'string') return hexError(color);
-  if (typeof color === 'object') {
-    if (color.light == null && color.dark == null) {
-      return 'color pair must have at least one of `light` or `dark`';
-    }
-    if (color.light != null) {
-      const e = hexError(color.light);
-      if (e) return `color.light: ${e}`;
-    }
-    if (color.dark != null) {
-      const e = hexError(color.dark);
-      if (e) return `color.dark: ${e}`;
-    }
-    return null;
-  }
-  return `unexpected color type ${typeof color}`;
-}
-
-const HEX_RE = /^#[0-9a-fA-F]{3,8}$/;
-function hexError(s: unknown): string | null {
-  if (typeof s !== 'string') return `expected string, got ${typeof s}`;
-  return HEX_RE.test(s) ? null : `not a valid hex color: ${JSON.stringify(s)}`;
-}

package/src/models/designation-relationship.ts

@@ -1,39 +0,0 @@
-import { GlossaristModel } from './base.js';
-
-export const DESIGNATION_RELATIONSHIP_TYPES: ReadonlyArray<string> = Object.freeze([
-  // TBX (ISO 30042) / ISO 12620 term-level relationships
-  'abbreviated_form_for', 'short_form_for',
-]);
-
-export type DesignationRelationshipType = string;
-
-export interface DesignationRelationshipJson {
-  type?: DesignationRelationshipType | null;
-  content?: string | null;
-  target?: string | null;
-}
-
-export class DesignationRelationship extends GlossaristModel {
-  readonly type: DesignationRelationshipType | null;
-  readonly content: string | null;
-  readonly target: string | null;
-
-  constructor(data: DesignationRelationshipJson = {}) {
-    super();
-    this.type = data.type ?? null;
-    this.content = data.content ?? null;
-    this.target = data.target ?? null;
-  }
-
-  override toJSON(): DesignationRelationshipJson {
-    const obj: DesignationRelationshipJson = {};
-    if (this.type != null) obj.type = this.type;
-    if (this.content != null) obj.content = this.content;
-    if (this.target != null) obj.target = this.target;
-    return obj;
-  }
-
-  static override fromJSON(data: DesignationRelationshipJson): DesignationRelationship {
-    return new DesignationRelationship(data);
-  }
-}

package/src/models/designation.ts

@@ -1,297 +0,0 @@
-import { RegistrableModel } from './registrable.js';
-import { ConceptSource } from './concept-source.js';
-import type { ConceptSourceJson } from './concept-source.js';
-import { Pronunciation } from './pronunciation.js';
-import type { PronunciationJson } from './pronunciation.js';
-import { GrammarInfo } from './grammar-info.js';
-import type { GrammarInfoJson } from './grammar-info.js';
-import { RelatedConcept } from './related-concept.js';
-import type { RelatedConceptJson } from './related-concept.js';
-import {
-  DesignationRelationship,
-  DESIGNATION_RELATIONSHIP_TYPES,
-} from './designation-relationship.js';
-import type { DesignationRelationshipJson } from './designation-relationship.js';
-
-export type DesignationType =
-  | 'expression'
-  | 'abbreviation'
-  | 'symbol'
-  | 'letter_symbol'
-  | 'graphical symbol'
-  | 'graphical_symbol'
-  | string;
-
-export type NormativeStatus = 'preferred' | 'deprecated' | 'admitted' | 'deprecated_' | string | null;
-
-const SKOS_LABEL_BY_NORMATIVE_STATUS: Readonly<Record<string, string>> = Object.freeze({
-  preferred: 'prefLabel',
-  deprecated: 'hiddenLabel',
-  admitted: 'altLabel',
-  deprecated_: 'altLabel',
-});
-
-export interface DesignationJson {
-  type?: DesignationType;
-  designation?: string;
-  normative_status?: NormativeStatus;
-  normativeStatus?: NormativeStatus;
-  absent?: boolean | null;
-  field_of_application?: string | null;
-  fieldOfApplication?: string | null;
-  usage_info?: string | null;
-  usageInfo?: string | null;
-  geographical_area?: string | null;
-  geographicalArea?: string | null;
-  language?: string | null;
-  script?: string | null;
-  system?: string | null;
-  international?: boolean | null;
-  term_type?: string | null;
-  termType?: string | null;
-  pronunciation?: ReadonlyArray<PronunciationJson | Pronunciation>;
-  sources?: ReadonlyArray<ConceptSourceJson | ConceptSource>;
-  related?: ReadonlyArray<DesignationRelationshipJson | DesignationRelationship | RelatedConceptJson | RelatedConcept>;
-  prefix?: string | null;
-  grammar_info?: ReadonlyArray<GrammarInfoJson | GrammarInfo>;
-  acronym?: boolean;
-  initialism?: boolean;
-  truncation?: boolean;
-  text?: string | null;
-  image?: string | null;
-}
-
-export class Designation extends RegistrableModel {
-  readonly designation: string;
-  readonly type: DesignationType;
-  readonly normativeStatus: NormativeStatus;
-  readonly absent: boolean | null;
-  readonly fieldOfApplication: string | null;
-  readonly usageInfo: string | null;
-  readonly geographicalArea: string | null;
-  readonly language: string | null;
-  readonly script: string | null;
-  readonly system: string | null;
-  readonly international: boolean | null;
-  readonly termType: string | null;
-  readonly pronunciations: ReadonlyArray<Pronunciation>;
-  readonly sources: ReadonlyArray<ConceptSource>;
-  readonly related: ReadonlyArray<DesignationRelationship | RelatedConcept>;
-
-  constructor(data: DesignationJson = {}) {
-    super();
-    this.designation = data.designation ?? '';
-    this.type = data.type ?? 'expression';
-    this.normativeStatus = data.normative_status ?? data.normativeStatus ?? null;
-    this.absent = data.absent ?? null;
-    this.fieldOfApplication = data.field_of_application ?? data.fieldOfApplication ?? null;
-    this.usageInfo = data.usage_info ?? data.usageInfo ?? null;
-    this.geographicalArea = data.geographical_area ?? data.geographicalArea ?? null;
-    this.language = data.language ?? null;
-    this.script = data.script ?? null;
-    this.system = data.system ?? null;
-    this.international = data.international ?? null;
-    this.termType = data.term_type ?? data.termType ?? null;
-    this.pronunciations = (data.pronunciation ?? []).map((p) =>
-      p instanceof Pronunciation ? p : new Pronunciation(p as PronunciationJson),
-    );
-    this.sources = (data.sources ?? []).map((s) =>
-      s instanceof ConceptSource ? s : new ConceptSource(s as ConceptSourceJson),
-    );
-    this.related = (data.related ?? []).map((r) => {
-      if (r instanceof DesignationRelationship || r instanceof RelatedConcept) return r;
-      const hash = r as { type?: string };
-      if (hash?.type && DESIGNATION_RELATIONSHIP_TYPES.includes(hash.type)) {
-        return DesignationRelationship.fromJSON(hash as DesignationRelationshipJson);
-      }
-      return RelatedConcept.fromJSON(hash as RelatedConceptJson);
-    });
-  }
-
-  override toJSON(): DesignationJson {
-    const obj: DesignationJson = { type: this.type, designation: this.designation };
-    if (this.normativeStatus != null) obj.normative_status = this.normativeStatus;
-    if (this.absent != null) obj.absent = this.absent;
-    if (this.fieldOfApplication != null) obj.field_of_application = this.fieldOfApplication;
-    if (this.usageInfo != null) obj.usage_info = this.usageInfo;
-    if (this.geographicalArea != null) obj.geographical_area = this.geographicalArea;
-    if (this.language != null) obj.language = this.language;
-    if (this.script != null) obj.script = this.script;
-    if (this.system != null) obj.system = this.system;
-    if (this.international != null) obj.international = this.international;
-    if (this.termType != null) obj.term_type = this.termType;
-    if (this.pronunciations.length > 0) {
-      obj.pronunciation = this.pronunciations.map((p) => p.toJSON());
-    }
-    if (this.sources.length > 0) {
-      obj.sources = this.sources.map((s) => s.toJSON());
-    }
-    if (this.related.length > 0) {
-      obj.related = this.related.map((r) => r.toJSON() as never);
-    }
-    return obj;
-  }
-
-  /** RDF class local-name for this designation subtype. */
-  rdfClass(): string {
-    return 'Expression';
-  }
-
-  /** SKOS label predicate URI appropriate for this designation's normative status. */
-  skosLabelPredicate(skosNs: string): string {
-    return `${skosNs}${this._skosLabelLocalName()}`;
-  }
-
-  /** SKOS-XL label predicate URI. */
-  skosxlLabelPredicate(skosxlNs: string): string {
-    return `${skosxlNs}${this._skosLabelLocalName()}`;
-  }
-
-  protected _skosLabelLocalName(): string {
-    const statusVal = this.normativeStatus == null ? '' : String(this.normativeStatus);
-    const status = statusVal
-      .split(/[/#]/)
-      .pop() ?? '';
-    return SKOS_LABEL_BY_NORMATIVE_STATUS[status] ?? 'altLabel';
-  }
-
-  static identityOf(value: { type?: string; designation?: string } | null | undefined): string {
-    const v = value ?? {};
-    const type = v.type ?? 'expression';
-    const text = String(v.designation ?? '').toLowerCase().trim();
-    return `${type}|${text}`;
-  }
-
-  override identity(): string {
-    return Designation.identityOf(this);
-  }
-
-  static override fromJSON(data: DesignationJson): Designation {
-    return Designation.fromData(data);
-  }
-}
-
-export class Expression extends Designation {
-  readonly prefix: string | null;
-  readonly grammarInfo: ReadonlyArray<GrammarInfo>;
-
-  constructor(data: DesignationJson = {}) {
-    super(data);
-    this.prefix = data.prefix ?? null;
-    this.grammarInfo = (data.grammar_info ?? []).map((g) =>
-      g instanceof GrammarInfo ? g : new GrammarInfo(g as GrammarInfoJson),
-    );
-  }
-
-  override toJSON(): DesignationJson {
-    const obj = super.toJSON();
-    if (this.prefix != null) obj.prefix = this.prefix;
-    if (this.grammarInfo.length > 0) {
-      obj.grammar_info = this.grammarInfo.map((g) => g.toJSON());
-    }
-    return obj;
-  }
-
-  static override fromJSON(data: DesignationJson): Expression {
-    return new Expression(data);
-  }
-}
-
-Designation.register('expression', Expression);
-
-export class Abbreviation extends Expression {
-  readonly acronym: boolean;
-  readonly initialism: boolean;
-  readonly truncation: boolean;
-
-  constructor(data: DesignationJson = {}) {
-    super(data);
-    this.acronym = data.acronym ?? false;
-    this.initialism = data.initialism ?? false;
-    this.truncation = data.truncation ?? false;
-  }
-
-  override rdfClass(): string {
-    return 'Abbreviation';
-  }
-
-  override toJSON(): DesignationJson {
-    const obj = super.toJSON();
-    if (this.acronym) obj.acronym = true;
-    if (this.initialism) obj.initialism = true;
-    if (this.truncation) obj.truncation = true;
-    return obj;
-  }
-
-  static override fromJSON(data: DesignationJson): Abbreviation {
-    return new Abbreviation(data);
-  }
-}
-
-Designation.register('abbreviation', Abbreviation);
-
-export class Symbol extends Designation {
-  override rdfClass(): string {
-    return 'Symbol';
-  }
-
-  static override fromJSON(data: DesignationJson): Symbol {
-    return new Symbol(data);
-  }
-}
-
-Designation.register('symbol', Symbol);
-
-export class LetterSymbol extends Symbol {
-  readonly text: string | null;
-
-  constructor(data: DesignationJson = {}) {
-    super(data);
-    this.text = data.text ?? null;
-  }
-
-  override rdfClass(): string {
-    return 'LetterSymbol';
-  }
-
-  override toJSON(): DesignationJson {
-    const obj = super.toJSON();
-    if (this.text != null) obj.text = this.text;
-    return obj;
-  }
-
-  static override fromJSON(data: DesignationJson): LetterSymbol {
-    return new LetterSymbol(data);
-  }
-}
-
-Designation.register('letter_symbol', LetterSymbol);
-
-export class GraphicalSymbol extends Symbol {
-  readonly text: string | null;
-  readonly image: string | null;
-
-  constructor(data: DesignationJson = {}) {
-    super(data);
-    this.text = data.text ?? null;
-    this.image = data.image ?? null;
-  }
-
-  override rdfClass(): string {
-    return 'GraphicalSymbol';
-  }
-
-  override toJSON(): DesignationJson {
-    const obj = super.toJSON();
-    if (this.text != null) obj.text = this.text;
-    if (this.image != null) obj.image = this.image;
-    return obj;
-  }
-
-  static override fromJSON(data: DesignationJson): GraphicalSymbol {
-    return new GraphicalSymbol(data);
-  }
-}
-
-Designation.register('graphical symbol', GraphicalSymbol);
-Designation.register('graphical_symbol', GraphicalSymbol);

package/src/models/detailed-definition.ts

@@ -1,92 +0,0 @@
-import { GlossaristModel } from './base.js';
-import { Citation } from './citation.js';
-import { canonicalJson } from '../diff/canonical-json.js';
-
-export interface DetailedDefinitionJson {
-  content?: string;
-  sources?: ReadonlyArray<unknown>;
-  examples?: ReadonlyArray<unknown>;
-}
-
-export interface WalkTextEntry {
-  text: string;
-  source: string;
-}
-
-export class DetailedDefinition extends GlossaristModel {
-  readonly content: string;
-  private readonly _rawSources: ReadonlyArray<unknown>;
-  private readonly _rawExamples: ReadonlyArray<unknown>;
-  private _sources: ReadonlyArray<Citation> | null = null;
-  private _examples: ReadonlyArray<DetailedDefinition> | null = null;
-
-  constructor(data: DetailedDefinitionJson = {}) {
-    super();
-    this.content = data.content ?? '';
-    this._rawSources = data.sources ?? [];
-    this._rawExamples = data.examples ?? [];
-  }
-
-  get sources(): ReadonlyArray<Citation> {
-    return this._lazy<Citation>(
-      '_sources',
-      '_rawSources',
-      (s) => (s instanceof Citation ? s : new Citation(s as never)),
-    );
-  }
-
-  get examples(): ReadonlyArray<DetailedDefinition> {
-    return this._lazy<DetailedDefinition>(
-      '_examples',
-      '_rawExamples',
-      (e) =>
-        e instanceof DetailedDefinition
-          ? e
-          : new DetailedDefinition(e as DetailedDefinitionJson),
-    );
-  }
-
-  override toJSON(): DetailedDefinitionJson {
-    const obj: DetailedDefinitionJson = { content: this.content };
-    this._serialize(obj as Record<string, unknown>, 'sources', '_sources', '_rawSources');
-    this._serialize(obj as Record<string, unknown>, 'examples', '_examples', '_rawExamples');
-    return obj;
-  }
-
-  /**
-   * Yield this definition's content and the content of every nested
-   * example (recursively). Each item carries `{ text, source }` where
-   * `source` is `<path>.content` rooted at the `path` argument.
-   */
-  *walkTexts(path: string): Generator<WalkTextEntry> {
-    if (typeof this.content === 'string' && this.content.length > 0) {
-      yield { text: this.content, source: `${path}.content` };
-    }
-    const examples = this.examples;
-    for (let i = 0; i < examples.length; i++) {
-      const example = examples[i];
-      if (example) {
-        yield* example.walkTexts(`${path}.examples[${i}]`);
-      }
-    }
-  }
-
-  static identityOf(
-    value: { toJSON?: () => unknown } | unknown | null,
-  ): string {
-    if (value == null) return '';
-    if (typeof value === 'object' && value !== null && 'toJSON' in value &&
-        typeof (value as { toJSON: unknown }).toJSON === 'function') {
-      return canonicalJson((value as { toJSON: () => unknown }).toJSON());
-    }
-    return canonicalJson(value);
-  }
-
-  override identity(): string {
-    return DetailedDefinition.identityOf(this);
-  }
-
-  static override fromJSON(data: DetailedDefinitionJson): DetailedDefinition {
-    return new DetailedDefinition(data);
-  }
-}

package/src/models/enum.ts

@@ -1,60 +0,0 @@
-// Enum factory — produces a frozen KEY/VALUES bundle, a frozen values
-// array, and an isValid predicate from a single `makeEnum` call.
-//
-// Adding a new enum means one line:
-//
-//   export const COLOR = makeEnum('COLOR', { RED: 'red', BLUE: 'blue' });
-//
-// The factory returns an object that exposes both the per-value
-// constants (COLOR.RED, COLOR.BLUE) and the VALUES list + isValid
-// predicate. The bundle is itself frozen.
-
-/**
- * Output of {@link makeEnum}. Captures both the original key→value
- * pairs (so `MY_ENUM.MY_KEY` is the literal string value) and the
- * helper properties (`name`, `VALUES`, `isValid`).
- */
-export type EnumBundle<TValues extends Readonly<Record<string, string>>> = {
-  readonly name: string;
-  readonly VALUES: ReadonlyArray<TValues[keyof TValues]>;
-  readonly isValid: (value: unknown) => value is TValues[keyof TValues];
-} & { readonly [K in keyof TValues]: TValues[K] };
-
-/**
- * Build a frozen enum bundle.
- *
- * @param name Human-readable name used in error messages.
- * @param values Object whose keys are the constant names and whose
- *   string values are the wire representations.
- */
-export function makeEnum<const TValues extends Readonly<Record<string, string>>>(
-  name: string,
-  values: TValues,
-): EnumBundle<TValues> {
-  if (typeof name !== 'string') {
-    throw new Error(`makeEnum: name must be a string, got ${typeof name}`);
-  }
-  if (typeof values !== 'object' || values === null) {
-    throw new Error(`makeEnum: values must be an object, got ${typeof values}`);
-  }
-  for (const [k, v] of Object.entries(values)) {
-    if (typeof v !== 'string') {
-      throw new Error(
-        `makeEnum(${name}): value for ${k} must be a string, got ${typeof v}`,
-      );
-    }
-  }
-
-  const frozen = Object.freeze({ ...values });
-  const valuesArr = Object.freeze(Object.values(frozen)) as ReadonlyArray<
-    TValues[keyof TValues]
-  >;
-  const isValid = (v: unknown): v is TValues[keyof TValues] =>
-    typeof v === 'string' && (valuesArr as readonly string[]).includes(v);
-
-  return Object.assign(Object.create(null) as object, frozen, {
-    name,
-    VALUES: valuesArr,
-    isValid,
-  }) as EnumBundle<TValues>;
-}

package/src/models/equivalence-degree.ts

@@ -1,34 +0,0 @@
-// EquivalenceDegree — ISO 704:2022 §7.7.3 cross-language equivalence.
-//
-//   full        — equivalent intension across languages (default)
-//   partial     — overlapping but not identical intension
-//   none        — no corresponding concept in this language
-//   directional — monodirectional equivalence (see equivalence_note)
-
-export type EquivalenceDegree =
-  | 'full'
-  | 'partial'
-  | 'none'
-  | 'directional';
-
-export const EQUIVALENCE_DEGREE: Readonly<Record<Uppercase<EquivalenceDegree>, EquivalenceDegree>> = Object.freeze({
-  FULL: 'full',
-  PARTIAL: 'partial',
-  NONE: 'none',
-  DIRECTIONAL: 'directional',
-});
-
-export const EQUIVALENCE_DEGREE_VALUES: ReadonlyArray<EquivalenceDegree> =
-  Object.freeze(Object.values(EQUIVALENCE_DEGREE));
-
-export const DEFAULT_EQUIVALENCE_DEGREE: EquivalenceDegree =
-  EQUIVALENCE_DEGREE.FULL;
-
-export function isValidEquivalenceDegree(value: unknown): value is EquivalenceDegree {
-  return (
-    typeof value === 'string' &&
-    (EQUIVALENCE_DEGREE_VALUES as readonly string[]).includes(value)
-  );
-}
-
-export default EQUIVALENCE_DEGREE;