glossarist 0.4.38 → 0.4.40

package/src/models/{relation-colors.js → relation-colors.ts}

@@ -6,10 +6,27 @@
 
 import { categoryOf, categoryDefinition } from './relation-categories.js';
 
-// One { light, dark } pair per category. Keeping these in glossarist-js
-// lets the defaults ship with the library; consumers only need to
-// customize when they want to deviate.
-export const RELATION_COLOR_DEFAULTS = Object.freeze({
+export interface ColorPair {
+  light: string;
+  dark: string;
+}
+
+export interface RelationColorPalette {
+  byCategory: Readonly<Record<string, ColorPair>>;
+  byType: Readonly<Record<string, ColorPair>>;
+}
+
+export interface ResolveRelationColorOptions {
+  overrides?: Partial<RelationColorPalette>;
+  mode?: 'light' | 'dark';
+}
+
+/**
+ * One { light, dark } pair per category. Keeping these in glossarist-js
+ * lets the defaults ship with the library; consumers only need to
+ * customize when they want to deviate.
+ */
+export const RELATION_COLOR_DEFAULTS: RelationColorPalette = Object.freeze({
   byCategory: Object.freeze({
     lifecycle:      { light: '#B43A2E', dark: '#F87171' },
     hierarchical:   { light: '#1F6FEB', dark: '#6EA8FE' },
@@ -19,39 +36,32 @@ export const RELATION_COLOR_DEFAULTS = Object.freeze({
     lexical:        { light: '#D97706', dark: '#FBBF24' },
     mapping:        { light: '#2563EB', dark: '#93BBFD' },
     definitional:   { light: '#65A30D', dark: '#A3E635' },
-  }),
-
-  // Per-type overrides. Use the same { light, dark } shape. Keys are
-  // relationship-type local names. Empty by default — consumers may
-  // populate this through `overrides.byType` at call time.
-  byType: Object.freeze({}),
+  }) as Readonly<Record<string, ColorPair>>,
+  byType: Object.freeze({}) as Readonly<Record<string, ColorPair>>,
 });
 
 /**
- * Resolves the color for a relationship type.
- *
- * Resolution order:
+ * Resolves the color for a relationship type. Resolution order:
  *   1. overrides.byType[type]
  *   2. RELATION_COLOR_DEFAULTS.byType[type]
  *   3. overrides.byCategory[category]
  *   4. RELATION_COLOR_DEFAULTS.byCategory[category]
  *   5. null (uncategorized or unrecognized type)
- *
- * @param {string} type - relationship type local name
- * @param {{ overrides?: { byType?: object, byCategory?: object }, mode?: 'light'|'dark' }} [options]
- * @returns {string | null}
  */
-export function resolveRelationColor(type, options = {}) {
+export function resolveRelationColor(
+  type: string,
+  options: ResolveRelationColorOptions = {},
+): string | null {
   const mode = options.mode ?? 'light';
   const overrides = options.overrides ?? {};
-
   const typeOverride = overrides.byType?.[type] ?? RELATION_COLOR_DEFAULTS.byType[type];
   if (typeOverride) return pickMode(typeOverride, mode);
 
   const category = categoryOf(type);
   if (!category) return null;
 
-  const categoryOverride = overrides.byCategory?.[category] ?? RELATION_COLOR_DEFAULTS.byCategory[category];
+  const categoryOverride =
+    overrides.byCategory?.[category] ?? RELATION_COLOR_DEFAULTS.byCategory[category];
   if (!categoryOverride) return null;
 
   return pickMode(categoryOverride, mode);
@@ -61,16 +71,19 @@ export function resolveRelationColor(type, options = {}) {
  * Returns the { light, dark } pair for a category, merging overrides
  * over defaults. Useful for UIs that want to render a legend.
  */
-export function categoryColorPair(categoryKey, overrides = {}) {
+export function categoryColorPair(
+  categoryKey: string,
+  overrides: { byCategory?: Record<string, Partial<ColorPair>> } = {},
+): ColorPair | null {
   const def = categoryDefinition(categoryKey);
   if (!def) return null;
   const fromOverride = overrides.byCategory?.[categoryKey];
   const fromDefault = RELATION_COLOR_DEFAULTS.byCategory[categoryKey];
   if (!fromDefault && !fromOverride) return null;
-  return { ...(fromDefault ?? {}), ...(fromOverride ?? {}) };
+  return { ...(fromDefault ?? { light: '', dark: '' }), ...(fromOverride ?? {}) } as ColorPair;
 }
 
-function pickMode(pair, mode) {
+function pickMode(pair: ColorPair | string | null, mode: 'light' | 'dark'): string | null {
   if (pair == null) return null;
   if (typeof pair === 'string') return pair;
   return pair[mode] ?? pair.light ?? pair.dark ?? null;

package/src/models/section.ts

@@ -0,0 +1,61 @@
+import { GlossaristModel } from './base.js';
+import type { LocalizedString } from './generic-member.js';
+
+export const ORDERING_METHODS: ReadonlyArray<string> = Object.freeze([
+  'systematic',
+  'mixed',
+  'alphabetical',
+]);
+
+export type OrderingMethod = string;
+
+export interface SectionJson {
+  id?: string | null;
+  names?: LocalizedString;
+  ordering?: OrderingMethod | null;
+  children?: ReadonlyArray<SectionJson | Section>;
+}
+
+export class Section extends GlossaristModel {
+  readonly id: string | null;
+  readonly names: LocalizedString;
+  readonly ordering: OrderingMethod | null;
+  readonly children: ReadonlyArray<Section>;
+
+  constructor(data: SectionJson = {}) {
+    super();
+    this.id = data.id ?? null;
+    this.names = (data.names as LocalizedString) ?? {};
+    this.ordering = data.ordering ?? null;
+    this.children = (data.children ?? []).map((c) =>
+      c instanceof Section ? c : new Section(c as SectionJson),
+    );
+  }
+
+  name(lang: string): string | null {
+    return this.names[lang] ?? this.names['eng'] ?? null;
+  }
+
+  descendantById(id: string): Section | null {
+    for (const child of this.children) {
+      if (child.id === id) return child;
+      const found = child.descendantById(id);
+      if (found) return found;
+    }
+    return null;
+  }
+
+  override toJSON(): SectionJson {
+    const obj: SectionJson = { id: this.id };
+    if (Object.keys(this.names).length > 0) obj.names = { ...this.names };
+    if (this.ordering != null) obj.ordering = this.ordering;
+    if (this.children.length > 0) {
+      obj.children = this.children.map((c) => c.toJSON());
+    }
+    return obj;
+  }
+
+  static override fromJSON(data: SectionJson): Section {
+    return new Section(data);
+  }
+}

package/src/models/shared-non-verbal-entity.ts

@@ -0,0 +1,36 @@
+import { NonVerbalEntity } from './non-verbal-entity.js';
+import type { NonVerbalEntityJson } from './non-verbal-entity.js';
+
+export interface SharedNonVerbalEntityJson extends NonVerbalEntityJson {
+  id?: string | null;
+  identifier?: string | null;
+}
+
+export class SharedNonVerbalEntity extends NonVerbalEntity {
+  readonly id: string | null;
+  readonly identifier: string | null;
+
+  constructor(data: SharedNonVerbalEntityJson = {}) {
+    super(data);
+    this.id = data.id ?? null;
+    this.identifier = data.identifier ?? null;
+  }
+
+  override findById(targetId: string): this | null {
+    return this.id === targetId ? this : null;
+  }
+  override allIds(): string[] {
+    return this.id != null ? [this.id] : [];
+  }
+
+  override toJSON(): SharedNonVerbalEntityJson {
+    const obj = super.toJSON() as SharedNonVerbalEntityJson;
+    if (this.id != null) obj.id = this.id;
+    if (this.identifier != null) obj.identifier = this.identifier;
+    return obj;
+  }
+
+  static override fromJSON(data: SharedNonVerbalEntityJson): SharedNonVerbalEntity {
+    return SharedNonVerbalEntity.fromData(data);
+  }
+}

package/src/models/table.ts

@@ -0,0 +1,36 @@
+import { SharedNonVerbalEntity } from './shared-non-verbal-entity.js';
+import type { SharedNonVerbalEntityJson } from './shared-non-verbal-entity.js';
+import { NonVerbalEntity } from './non-verbal-entity.js';
+
+export interface TableJson extends SharedNonVerbalEntityJson {
+  content?: string | null;
+  format?: string | null;
+}
+
+export class Table extends SharedNonVerbalEntity {
+  readonly content: string | null;
+  readonly format: string | null;
+
+  constructor(data: TableJson = {}) {
+    super(data);
+    this.content = data.content ?? null;
+    this.format = data.format ?? null;
+  }
+
+  override rdfClass(): string {
+    return 'Table';
+  }
+
+  override toJSON(): TableJson {
+    const obj = super.toJSON() as TableJson;
+    if (this.content != null) obj.content = this.content;
+    if (this.format != null) obj.format = this.format;
+    return obj;
+  }
+
+  static override fromJSON(data: TableJson): Table {
+    return new Table(data);
+  }
+}
+
+NonVerbalEntity.register('table', Table);

package/src/models/citation.js

@@ -1,68 +0,0 @@
-import { GlossaristModel } from './base.js';
-import { Locality } from './locality.js';
-
-export class Citation extends GlossaristModel {
-  constructor(data = {}) {
-    super();
-    const d = data ?? {};
-
-    this.ref = d.ref
-      ? (d.ref instanceof Citation.Ref ? d.ref : new Citation.Ref(d.ref))
-      : null;
-
-    this.locality = d.locality
-      ? (d.locality instanceof Locality ? d.locality : new Locality(d.locality))
-      : null;
-    this.link = d.link ?? null;
-    this.original = d.original ?? null;
-    this.customLocality = d.custom_locality ?? d.customLocality ?? null;
-  }
-
-  toString() {
-    if (this.ref) return this.ref.toString();
-    return '';
-  }
-
-  toJSON() {
-    const obj = {};
-    if (this.ref != null) obj.ref = this.ref.toJSON();
-    if (this.locality != null) obj.locality = this.locality.toJSON();
-    if (this.link != null) obj.link = this.link;
-    if (this.original != null) obj.original = this.original;
-    if (this.customLocality != null) obj.custom_locality = this.customLocality;
-    return obj;
-  }
-
-  static fromJSON(data) {
-    return new Citation(data);
-  }
-}
-
-Citation.Ref = class Ref extends GlossaristModel {
-  constructor(data = {}) {
-    super();
-    const d = data ?? {};
-    this.source = d.source ?? null;
-    this.id = d.id ?? null;
-    this.version = d.version ?? null;
-  }
-
-  toString() {
-    const parts = [];
-    if (this.source) parts.push(this.source);
-    if (this.id) parts.push(this.id);
-    return parts.join(' ');
-  }
-
-  toJSON() {
-    const obj = {};
-    if (this.source != null) obj.source = this.source;
-    if (this.id != null) obj.id = this.id;
-    if (this.version != null) obj.version = this.version;
-    return obj;
-  }
-
-  static fromJSON(data) {
-    return new Citation.Ref(data);
-  }
-};

package/src/models/designation-relationship.js

@@ -1,27 +0,0 @@
-import { GlossaristModel } from './base.js';
-
-export const DESIGNATION_RELATIONSHIP_TYPES = Object.freeze([
-  // TBX (ISO 30042) / ISO 12620 term-level relationships
-  'abbreviated_form_for', 'short_form_for',
-]);
-
-export class DesignationRelationship extends GlossaristModel {
-  constructor(data = {}) {
-    super();
-    this.type = data.type ?? null;
-    this.content = data.content ?? null;
-    this.target = data.target ?? null;
-  }
-
-  toJSON() {
-    const obj = {};
-    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 fromJSON(data) {
-    return new DesignationRelationship(data);
-  }
-}

package/src/models/designation.js

@@ -1,213 +0,0 @@
-import { RegistrableModel } from './registrable.js';
-import { ConceptSource } from './concept-source.js';
-import { Pronunciation } from './pronunciation.js';
-import { GrammarInfo } from './grammar-info.js';
-import { RelatedConcept } from './related-concept.js';
-import { DesignationRelationship, DESIGNATION_RELATIONSHIP_TYPES } from './designation-relationship.js';
-
-// Maps a normative-status local-name to the matching SKOS/SKOS-XL label
-// predicate local-name. Lives on the model so a new status requires a
-// single edit here, not edits in every emitter.
-const SKOS_LABEL_BY_NORMATIVE_STATUS = Object.freeze({
-  preferred: 'prefLabel',
-  deprecated: 'hiddenLabel',
-  admitted: 'altLabel',
-  deprecated_: 'altLabel',
-});
-
-export class Designation extends RegistrableModel {
-  constructor(data = {}) {
-    super();
-    this.designation = data.designation ?? '';
-    this.type = data.type ?? 'expression';
-    this.normativeStatus = data.normative_status ?? null;
-    this.absent = data.absent ?? null;
-    this.fieldOfApplication = data.field_of_application ?? null;
-    this.usageInfo = data.usage_info ?? null;
-    this.geographicalArea = data.geographical_area ?? 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 ?? null;
-    this.pronunciations = (data.pronunciation ?? []).map(
-      p => p instanceof Pronunciation ? p : new Pronunciation(p)
-    );
-    this.sources = (data.sources ?? []).map(
-      s => s instanceof ConceptSource ? s : new ConceptSource(s)
-    );
-    this.related = (data.related ?? []).map(
-      r => (r instanceof DesignationRelationship || r instanceof RelatedConcept)
-        ? r
-        : DESIGNATION_RELATIONSHIP_TYPES.includes(r.type)
-          ? DesignationRelationship.fromJSON(r)
-          : RelatedConcept.fromJSON(r)
-    );
-  }
-
-  toJSON() {
-    const obj = { 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());
-    return obj;
-  }
-
-  // RDF class local-name for this designation subtype. Override in
-  // subclasses that map to a different ontology class.
-  rdfClass() {
-    return 'Expression';
-  }
-
-  // SKOS label predicate URI (skos:prefLabel / skos:altLabel / skos:hiddenLabel)
-  // appropriate for this designation's normative status. Falls back to
-  // skos:altLabel for unknown statuses.
-  skosLabelPredicate(skosNs) {
-    const label = this._skosLabelLocalName();
-    return `${skosNs}${label}`;
-  }
-
-  // SKOS-XL label predicate URI (skosxl:prefLabel / etc.).
-  skosxlLabelPredicate(skosxlNs) {
-    const label = this._skosLabelLocalName();
-    return `${skosxlNs}${label}`;
-  }
-
-  _skosLabelLocalName() {
-    const status = String(this.normativeStatus ?? '')
-      .split(/[/#]/)
-      .pop()
-      .trim();
-    return SKOS_LABEL_BY_NORMATIVE_STATUS[status] ?? 'altLabel';
-  }
-
-  // Static identity works on a model instance OR its plain JSON form.
-  // The diff layer uses this so that patch-side identity (computed on
-  // plain JSON from toJSON) matches diff-side identity (computed on
-  // model instances).
-  static identityOf(value) {
-    const v = value ?? {};
-    const type = v.type ?? 'expression';
-    const text = String(v.designation ?? '').toLowerCase().trim();
-    return `${type}|${text}`;
-  }
-
-  identity() {
-    return Designation.identityOf(this);
-  }
-
-  static fromJSON(data) {
-    return Designation.fromData(data);
-  }
-}
-
-export class Expression extends Designation {
-  constructor(data = {}) {
-    super(data);
-    this.prefix = data.prefix ?? null;
-    this.grammarInfo = (data.grammar_info ?? []).map(
-      g => g instanceof GrammarInfo ? g : new GrammarInfo(g)
-    );
-  }
-
-  toJSON() {
-    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 fromJSON(data) { return new Expression(data); }
-}
-
-Designation.register('expression', Expression);
-
-export class Abbreviation extends Expression {
-  constructor(data = {}) {
-    super(data);
-    this.acronym = data.acronym ?? false;
-    this.initialism = data.initialism ?? false;
-    this.truncation = data.truncation ?? false;
-  }
-
-  rdfClass() {
-    return 'Abbreviation';
-  }
-
-  toJSON() {
-    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 fromJSON(data) { return new Abbreviation(data); }
-}
-
-Designation.register('abbreviation', Abbreviation);
-
-export class Symbol extends Designation {
-  rdfClass() {
-    return 'Symbol';
-  }
-
-  static fromJSON(data) { return new Symbol(data); }
-}
-
-Designation.register('symbol', Symbol);
-
-export class LetterSymbol extends Symbol {
-  constructor(data = {}) {
-    super(data);
-    this.text = data.text ?? null;
-  }
-
-  rdfClass() {
-    return 'LetterSymbol';
-  }
-
-  toJSON() {
-    const obj = super.toJSON();
-    if (this.text != null) obj.text = this.text;
-    return obj;
-  }
-
-  static fromJSON(data) { return new LetterSymbol(data); }
-}
-
-Designation.register('letter_symbol', LetterSymbol);
-
-export class GraphicalSymbol extends Symbol {
-  constructor(data = {}) {
-    super(data);
-    this.text = data.text ?? null;
-    this.image = data.image ?? null;
-  }
-
-  rdfClass() {
-    return 'GraphicalSymbol';
-  }
-
-  toJSON() {
-    const obj = super.toJSON();
-    if (this.text != null) obj.text = this.text;
-    if (this.image != null) obj.image = this.image;
-    return obj;
-  }
-
-  static fromJSON(data) { return new GraphicalSymbol(data); }
-}
-
-Designation.register('graphical symbol', GraphicalSymbol);
-Designation.register('graphical_symbol', GraphicalSymbol);

package/src/models/figure.js

@@ -1,75 +0,0 @@
-import { SharedNonVerbalEntity } from './shared-non-verbal-entity.js';
-import { NonVerbalEntity } from './non-verbal-entity.js';
-
-export class FigureImage {
-  constructor(data = {}) {
-    this.src = data.src ?? null;
-    this.format = data.format ?? null;
-    this.role = data.role ?? null;
-    this.width = data.width ?? null;
-    this.height = data.height ?? null;
-    this.scale = data.scale ?? null;
-  }
-
-  toJSON() {
-    const obj = {};
-    if (this.src != null) obj.src = this.src;
-    if (this.format != null) obj.format = this.format;
-    if (this.role != null) obj.role = this.role;
-    if (this.width != null) obj.width = this.width;
-    if (this.height != null) obj.height = this.height;
-    if (this.scale != null) obj.scale = this.scale;
-    return obj;
-  }
-
-  static fromJSON(data) { return new FigureImage(data); }
-}
-
-export class Figure extends SharedNonVerbalEntity {
-  constructor(data = {}) {
-    super(data);
-    this._rawImages = data.images ?? [];
-    this._rawSubfigures = data.subfigures ?? [];
-    this._images = null;
-    this._subfigures = null;
-  }
-
-  rdfClass() {
-    return 'Figure';
-  }
-
-  get images() {
-    return this._lazy('_images', '_rawImages',
-      i => i instanceof FigureImage ? i : new FigureImage(i));
-  }
-
-  get subfigures() {
-    return this._lazy('_subfigures', '_rawSubfigures',
-      s => s instanceof Figure ? s : new Figure(s));
-  }
-
-  findById(targetId) {
-    if (this.id === targetId) return this;
-    for (const sub of this.subfigures) {
-      const found = sub.findById(targetId);
-      if (found) return found;
-    }
-    return null;
-  }
-
-  allIds() {
-    const ids = this.id != null ? [this.id] : [];
-    return [...ids, ...this.subfigures.flatMap(s => s.allIds())];
-  }
-
-  toJSON() {
-    const obj = super.toJSON();
-    this._serialize(obj, 'images', '_images', '_rawImages');
-    this._serialize(obj, 'subfigures', '_subfigures', '_rawSubfigures');
-    return obj;
-  }
-
-  static fromJSON(data) { return new Figure(data); }
-}
-
-NonVerbalEntity.register('figure', Figure);

package/src/models/formula.js

@@ -1,25 +0,0 @@
-import { SharedNonVerbalEntity } from './shared-non-verbal-entity.js';
-import { NonVerbalEntity } from './non-verbal-entity.js';
-
-export class Formula extends SharedNonVerbalEntity {
-  constructor(data = {}) {
-    super(data);
-    this.expression = data.expression ?? null;
-    this.notation = data.notation ?? null;
-  }
-
-  rdfClass() {
-    return 'Formula';
-  }
-
-  toJSON() {
-    const obj = super.toJSON();
-    if (this.expression != null) obj.expression = this.expression;
-    if (this.notation != null) obj.notation = this.notation;
-    return obj;
-  }
-
-  static fromJSON(data) { return new Formula(data); }
-}
-
-NonVerbalEntity.register('formula', Formula);