glossarist 0.2.1 → 0.3.0

package/src/models/index.d.ts

@@ -8,14 +8,17 @@ export class GlossaristModel {
 export class Concept extends GlossaristModel {
   readonly id: string;
   readonly term: string | null;
+  readonly uri: string | null;
   readonly termid: string;
   readonly languages: string[];
   readonly localizations: Record<string, any>;
   readonly raw: Record<string, unknown> | null;
   readonly relatedConcepts: RelatedConcept[];
+  readonly domains: ConceptReference[];
   readonly dates: ConceptDate[];
   readonly sources: ConceptSource[];
   readonly status: string | null;
+  readonly schemaVersion: string | null;
 
   localization(lang: string): LocalizedConcept | undefined;
   primaryDesignation(lang: string): string | null;
@@ -27,13 +30,29 @@ export class Concept extends GlossaristModel {
 
 export class LocalizedConcept extends GlossaristModel {
   readonly languageCode: string | null;
+  readonly script: string | null;
+  readonly system: string | null;
+  readonly entryStatus: string | null;
+  readonly classification: string | null;
+  readonly reviewType: string | null;
+  readonly domain: string | null;
+  readonly release: string | null;
+  readonly lineageSourceSimilarity: number | null;
+  readonly reviewDate: string | null;
+  readonly reviewDecisionDate: string | null;
+  readonly reviewDecisionEvent: string | null;
+  readonly reviewStatus: string | null;
+  readonly reviewDecision: string | null;
+  readonly reviewDecisionNotes: string | null;
   readonly terms: Designation[];
   readonly definitions: DetailedDefinition[];
   readonly definition: DetailedDefinition[];
-  readonly notes: { content: string }[];
-  readonly examples: { content: string }[];
+  readonly notes: DetailedDefinition[];
+  readonly examples: DetailedDefinition[];
   readonly sources: ConceptSource[];
-  readonly entryStatus: string | null;
+  readonly dates: ConceptDate[];
+  readonly nonVerbalRep: NonVerbRep[];
+  readonly related: RelatedConcept[];
   readonly primaryDesignation: string | null;
   readonly primaryDefinition: string | null;
   static fromJSON(data: Record<string, unknown>): LocalizedConcept;
@@ -43,35 +62,100 @@ export class Designation extends GlossaristModel {
   readonly designation: string;
   readonly type: string;
   readonly normativeStatus: string | null;
+  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: Pronunciation[];
+  readonly sources: ConceptSource[];
+  readonly related: RelatedConcept[];
   static register(type: string, cls: typeof Designation): void;
   static fromData(data: Record<string, unknown>): Designation;
   static fromJSON(data: Record<string, unknown>): Designation;
 }
 
 export class Expression extends Designation {
+  readonly prefix: string | null;
+  readonly grammarInfo: GrammarInfo[];
+}
+
+export class Abbreviation extends Expression {
+  readonly acronym: boolean;
+  readonly initialism: boolean;
+  readonly truncation: boolean;
+}
+
+export class Symbol extends Designation {}
+
+export class LetterSymbol extends Symbol {
+  readonly text: string | null;
+}
+
+export class GraphicalSymbol extends Symbol {
+  readonly text: string | null;
+  readonly image: string | null;
+}
+
+export const GRAMMAR_GENDERS: readonly string[];
+export const GRAMMAR_NUMBERS: readonly string[];
+export const GRAMMAR_PARTS_OF_SPEECH: readonly string[];
+
+export class GrammarInfo extends GlossaristModel {
   readonly gender: string | null;
-  readonly plurality: string | null;
+  readonly number: string | null;
   readonly partOfSpeech: string | null;
-  readonly geographicalArea: string | null;
+  readonly noun: boolean;
+  readonly verb: boolean;
+  readonly adj: boolean;
+  readonly adverb: boolean;
+  readonly preposition: boolean;
+  readonly participle: boolean;
 }
 
-export class Abbreviation extends Designation {}
-export class Symbol extends Designation {
-  readonly international: string | null;
+export class Pronunciation extends GlossaristModel {
+  readonly content: string | null;
+  readonly language: string | null;
+  readonly script: string | null;
+  readonly country: string | null;
+  readonly system: string | null;
 }
-export class GraphicalSymbol extends Designation {
-  readonly image: string | null;
+
+export class Locality extends GlossaristModel {
+  readonly type: string | null;
+  readonly referenceFrom: string | null;
+  readonly referenceTo: string | null;
 }
 
 export class Citation extends GlossaristModel {
-  readonly source: string | Record<string, unknown> | null;
-  readonly ref: string | null;
-  readonly id: string | null;
-  readonly version: string | null;
-  readonly clause: string | null;
+  readonly ref: Citation.Ref | null;
+  readonly locality: Locality | null;
   readonly link: string | null;
-  readonly isStructured: boolean;
+  readonly original: string | null;
+  readonly customLocality: unknown;
+  toString(): string;
+  static fromJSON(data: Record<string, unknown>): Citation;
+}
+
+export namespace Citation {
+  class Ref extends GlossaristModel {
+    readonly source: string | null;
+    readonly id: string | null;
+    readonly version: string | null;
+    toString(): string;
+    static fromJSON(data: Record<string, unknown>): Ref;
+  }
+}
+
+export class ConceptRef extends GlossaristModel {
+  readonly source: string | null;
+  readonly id: string | null;
   toString(): string;
+  static fromJSON(data: Record<string, unknown>): ConceptRef;
 }
 
 export class ConceptSource extends GlossaristModel {
@@ -85,7 +169,18 @@ export const RELATIONSHIP_TYPES: readonly string[];
 export class RelatedConcept extends GlossaristModel {
   readonly type: string;
   readonly content: string | null;
-  readonly ref: Citation | null;
+  readonly ref: ConceptRef | null;
+}
+
+export class ConceptReference extends GlossaristModel {
+  readonly conceptId: string | null;
+  readonly refType: string | null;
+  readonly source: string | null;
+  readonly urn: string | null;
+  readonly isLocal: boolean;
+  readonly isExternal: boolean;
+  static domain(conceptId: string): ConceptReference;
+  static fromJSON(data: Record<string, unknown>): ConceptReference;
 }
 
 export const DATE_TYPES: readonly string[];
@@ -97,14 +192,14 @@ export class ConceptDate extends GlossaristModel {
 
 export class DetailedDefinition extends GlossaristModel {
   readonly content: string;
-  readonly sources: Citation[];
+  readonly sources: ConceptSource[];
 }
 
 export class NonVerbRep extends GlossaristModel {
-  readonly image: string | null;
-  readonly table: string | null;
-  readonly formula: string | null;
-  readonly sources: Citation[];
+  readonly type: string | null;
+  readonly ref: string | null;
+  readonly text: string | null;
+  readonly sources: ConceptSource[];
 }
 
 export class GcrStatistics extends GlossaristModel {

package/src/models/index.js

@@ -1,12 +1,17 @@
 export { GlossaristModel } from './base.js';
 export { Concept } from './concept.js';
 export { LocalizedConcept } from './localized-concept.js';
-export { Designation, Expression, Abbreviation, Symbol, GraphicalSymbol } from './designation.js';
+export { Designation, Expression, Abbreviation, Symbol, LetterSymbol, GraphicalSymbol } from './designation.js';
 export { Citation } from './citation.js';
+export { ConceptRef } from './concept-ref.js';
 export { ConceptSource } from './concept-source.js';
 export { RelatedConcept, RELATIONSHIP_TYPES } from './related-concept.js';
+export { ConceptReference } from './concept-reference.js';
 export { ConceptDate, DATE_TYPES } from './concept-date.js';
 export { DetailedDefinition } from './detailed-definition.js';
 export { NonVerbRep } from './non-verb-rep.js';
+export { Pronunciation } from './pronunciation.js';
+export { GrammarInfo, GRAMMAR_GENDERS, GRAMMAR_NUMBERS, GRAMMAR_PARTS_OF_SPEECH } from './grammar-info.js';
+export { Locality } from './locality.js';
 export { GcrMetadata } from './gcr-metadata.js';
-export { GcrStatistics } from './gcr-statistics.js';;
+export { GcrStatistics } from './gcr-statistics.js';

package/src/models/locality.js

@@ -0,0 +1,22 @@
+import { GlossaristModel } from './base.js';
+
+export class Locality extends GlossaristModel {
+  constructor(data = {}) {
+    super();
+    this.type = data.type ?? null;
+    this.referenceFrom = data.reference_from ?? data.referenceFrom ?? null;
+    this.referenceTo = data.reference_to ?? data.referenceTo ?? null;
+  }
+
+  toJSON() {
+    const obj = {};
+    if (this.type != null) obj.type = this.type;
+    if (this.referenceFrom != null) obj.reference_from = this.referenceFrom;
+    if (this.referenceTo != null) obj.reference_to = this.referenceTo;
+    return obj;
+  }
+
+  static fromJSON(data) {
+    return new Locality(data);
+  }
+}

package/src/models/localized-concept.js

@@ -2,23 +2,47 @@ import { GlossaristModel } from './base.js';
 import { Designation } from './designation.js';
 import { DetailedDefinition } from './detailed-definition.js';
 import { ConceptSource } from './concept-source.js';
+import { ConceptDate } from './concept-date.js';
+import { NonVerbRep } from './non-verb-rep.js';
+import { RelatedConcept } from './related-concept.js';
 
 export class LocalizedConcept extends GlossaristModel {
   constructor(data = {}) {
     super();
     this.languageCode = data.language_code ?? data.languageCode ?? null;
+    this.script = data.script ?? null;
+    this.system = data.system ?? null;
+    this.entryStatus = data.entry_status ?? data.entryStatus ?? null;
+    this.classification = data.classification ?? null;
+    this.reviewType = data.review_type ?? data.reviewType ?? null;
+    this.domain = data.domain ?? null;
+    this.release = data.release ?? null;
+    this.lineageSourceSimilarity = data.lineage_source_similarity ?? data.lineageSourceSimilarity ?? null;
+
+    this.reviewDate = data.review_date ?? data.reviewDate ?? null;
+    this.reviewDecisionDate = data.review_decision_date ?? data.reviewDecisionDate ?? null;
+    this.reviewDecisionEvent = data.review_decision_event ?? data.reviewDecisionEvent ?? null;
+    this.reviewStatus = data.review_status ?? data.reviewStatus ?? null;
+    this.reviewDecision = data.review_decision ?? data.reviewDecision ?? null;
+    this.reviewDecisionNotes = data.review_decision_notes ?? data.reviewDecisionNotes ?? null;
+
     this._rawTerms = data.terms ?? [];
     this._rawDefinition = data.definition ?? [];
     this._rawSources = data.sources ?? [];
-    this.notes = data.notes ?? [];
-    this.examples = data.examples ?? [];
-    this.entryStatus = data.entry_status ?? data.entryStatus ?? null;
-    this.reviewType = data.review_type ?? data.reviewType ?? null;
-    this.classification = data.classification ?? null;
+    this._rawNotes = data.notes ?? [];
+    this._rawExamples = data.examples ?? [];
+    this._rawDates = data.dates ?? [];
+    this._rawNonVerbal = data.non_verbal_rep ?? data.non_verb ?? [];
+    this._rawRelated = data.related ?? [];
 
     this._terms = null;
     this._definitions = null;
     this._sources = null;
+    this._notes = null;
+    this._examples = null;
+    this._dates = null;
+    this._nonVerbal = null;
+    this._related = null;
   }
 
   get terms() {
@@ -50,6 +74,51 @@ export class LocalizedConcept extends GlossaristModel {
     return this._sources;
   }
 
+  get notes() {
+    if (this._notes === null) {
+      this._notes = this._rawNotes.map(
+        n => n instanceof DetailedDefinition ? n : new DetailedDefinition(n)
+      );
+    }
+    return this._notes;
+  }
+
+  get examples() {
+    if (this._examples === null) {
+      this._examples = this._rawExamples.map(
+        e => e instanceof DetailedDefinition ? e : new DetailedDefinition(e)
+      );
+    }
+    return this._examples;
+  }
+
+  get dates() {
+    if (this._dates === null) {
+      this._dates = this._rawDates.map(
+        d => d instanceof ConceptDate ? d : new ConceptDate(d)
+      );
+    }
+    return this._dates;
+  }
+
+  get nonVerbalRep() {
+    if (this._nonVerbal === null) {
+      this._nonVerbal = this._rawNonVerbal.map(
+        n => n instanceof NonVerbRep ? n : new NonVerbRep(n)
+      );
+    }
+    return this._nonVerbal;
+  }
+
+  get related() {
+    if (this._related === null) {
+      this._related = this._rawRelated.map(
+        r => r instanceof RelatedConcept ? r : new RelatedConcept(r)
+      );
+    }
+    return this._related;
+  }
+
   get primaryDesignation() {
     return this.terms[0]?.designation ?? null;
   }
@@ -61,6 +130,21 @@ export class LocalizedConcept extends GlossaristModel {
   toJSON() {
     const obj = {};
     if (this.languageCode) obj.language_code = this.languageCode;
+    if (this.script) obj.script = this.script;
+    if (this.system) obj.system = this.system;
+    if (this.entryStatus) obj.entry_status = this.entryStatus;
+    if (this.classification) obj.classification = this.classification;
+    if (this.reviewType) obj.review_type = this.reviewType;
+    if (this.domain) obj.domain = this.domain;
+    if (this.release) obj.release = this.release;
+    if (this.lineageSourceSimilarity != null) obj.lineage_source_similarity = this.lineageSourceSimilarity;
+
+    if (this.reviewDate) obj.review_date = this.reviewDate;
+    if (this.reviewDecisionDate) obj.review_decision_date = this.reviewDecisionDate;
+    if (this.reviewDecisionEvent) obj.review_decision_event = this.reviewDecisionEvent;
+    if (this.reviewStatus) obj.review_status = this.reviewStatus;
+    if (this.reviewDecision) obj.review_decision = this.reviewDecision;
+    if (this.reviewDecisionNotes) obj.review_decision_notes = this.reviewDecisionNotes;
 
     const terms = this._terms ?? this._rawTerms;
     if (terms.length > 0) {
@@ -72,17 +156,36 @@ export class LocalizedConcept extends GlossaristModel {
       obj.definition = defs.map(d => (typeof d.toJSON === 'function') ? d.toJSON() : d);
     }
 
-    if (this.notes.length > 0) obj.notes = this.notes;
-    if (this.examples.length > 0) obj.examples = this.examples;
+    const notes = this._notes ?? (this._rawNotes.length > 0 ? this._rawNotes : []);
+    if (notes.length > 0) {
+      obj.notes = notes.map(n => (typeof n.toJSON === 'function') ? n.toJSON() : n);
+    }
+
+    const examples = this._examples ?? (this._rawExamples.length > 0 ? this._rawExamples : []);
+    if (examples.length > 0) {
+      obj.examples = examples.map(e => (typeof e.toJSON === 'function') ? e.toJSON() : e);
+    }
 
     const sources = this._sources ?? (this._rawSources.length > 0 ? this._rawSources : []);
     if (sources.length > 0) {
       obj.sources = sources.map(s => (typeof s.toJSON === 'function') ? s.toJSON() : s);
     }
 
-    if (this.entryStatus != null) obj.entry_status = this.entryStatus;
-    if (this.reviewType != null) obj.review_type = this.reviewType;
-    if (this.classification != null) obj.classification = this.classification;
+    const dates = this._dates ?? (this._rawDates.length > 0 ? this._rawDates : []);
+    if (dates.length > 0) {
+      obj.dates = dates.map(d => (typeof d.toJSON === 'function') ? d.toJSON() : d);
+    }
+
+    const nonVerbal = this._nonVerbal ?? (this._rawNonVerbal.length > 0 ? this._rawNonVerbal : []);
+    if (nonVerbal.length > 0) {
+      obj.non_verbal_rep = nonVerbal.map(n => (typeof n.toJSON === 'function') ? n.toJSON() : n);
+    }
+
+    const related = this._related ?? (this._rawRelated.length > 0 ? this._rawRelated : []);
+    if (related.length > 0) {
+      obj.related = related.map(r => (typeof r.toJSON === 'function') ? r.toJSON() : r);
+    }
+
     return obj;
   }
 

package/src/models/non-verb-rep.js

@@ -1,22 +1,22 @@
 import { GlossaristModel } from './base.js';
-import { Citation } from './citation.js';
+import { ConceptSource } from './concept-source.js';
 
 export class NonVerbRep extends GlossaristModel {
   constructor(data = {}) {
     super();
-    this.image = data.image ?? null;
-    this.table = data.table ?? null;
-    this.formula = data.formula ?? null;
+    this.type = data.type ?? null;
+    this.ref = data.ref ?? null;
+    this.text = data.text ?? null;
     this.sources = (data.sources ?? []).map(
-      s => s instanceof Citation ? s : new Citation(s)
+      s => s instanceof ConceptSource ? s : new ConceptSource(s)
     );
   }
 
   toJSON() {
     const obj = {};
-    if (this.image != null) obj.image = this.image;
-    if (this.table != null) obj.table = this.table;
-    if (this.formula != null) obj.formula = this.formula;
+    if (this.type != null) obj.type = this.type;
+    if (this.ref != null) obj.ref = this.ref;
+    if (this.text != null) obj.text = this.text;
     if (this.sources.length > 0) obj.sources = this.sources.map(s => s.toJSON());
     return obj;
   }

package/src/models/pronunciation.js

@@ -0,0 +1,26 @@
+import { GlossaristModel } from './base.js';
+
+export class Pronunciation extends GlossaristModel {
+  constructor(data = {}) {
+    super();
+    this.content = data.content ?? null;
+    this.language = data.language ?? null;
+    this.script = data.script ?? null;
+    this.system = data.system ?? null;
+    this.country = data.country ?? null;
+  }
+
+  toJSON() {
+    const obj = {};
+    if (this.content != null) obj.content = this.content;
+    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.country != null) obj.country = this.country;
+    return obj;
+  }
+
+  static fromJSON(data) {
+    return new Pronunciation(data);
+  }
+}

package/src/models/related-concept.js

@@ -1,19 +1,38 @@
 import { GlossaristModel } from './base.js';
-import { Citation } from './citation.js';
+import { ConceptRef } from './concept-ref.js';
 
 export const RELATIONSHIP_TYPES = Object.freeze([
-  'supersedes', 'superseded_by', 'extends', 'extended_by',
-  'narrower', 'broader', 'equivalent', 'compare', 'contrast',
-  'derived', 'deprecated', 'related',
+  // Lifecycle (ISO 10241-1)
+  'deprecates', 'supersedes', 'superseded_by',
+  // Hierarchical (SKOS)
+  'broader', 'narrower',
+  // ISO 25964 generic
+  'broader_generic', 'narrower_generic',
+  // ISO 25964 partitive
+  'broader_partitive', 'narrower_partitive',
+  // ISO 25964 instantial
+  'broader_instantial', 'narrower_instantial',
+  // SKOS mapping
+  'equivalent', 'close_match', 'broad_match', 'narrow_match', 'related_match',
+  // Associative (ISO 10241-1 / ISO 25964)
+  'see', 'related_concept', 'related_concept_broader', 'related_concept_narrower',
+  // Comparative (ISO 10241-1)
+  'compare', 'contrast',
+  // Spatiotemporal (ISO 25964 / TBX)
+  'sequentially_related_concept', 'spatially_related_concept', 'temporally_related_concept',
+  // Lexical (ISO 12620 / TBX)
+  'homograph', 'false_friend',
+  // Designation-level
+  'abbreviated_form_for', 'short_form_for',
 ]);
 
 export class RelatedConcept extends GlossaristModel {
   constructor(data = {}) {
     super();
-    this.type = data.type ?? 'related';
+    this.type = data.type ?? 'see';
     this.content = data.content ?? null;
     this.ref = data.ref
-      ? (data.ref instanceof Citation ? data.ref : new Citation(data.ref))
+      ? (data.ref instanceof ConceptRef ? data.ref : new ConceptRef(data.ref))
       : null;
   }
 

package/src/reference-resolver.js

@@ -1,3 +1,5 @@
+import { ConceptRef } from './models/concept-ref.js';
+
 export class Reference {
   constructor(type, target, relationship, source) {
     this.type = type;
@@ -7,12 +9,20 @@ export class Reference {
   }
 }
 
+function refTarget(rc) {
+  if (rc.content) return rc.content;
+  if (rc.ref instanceof ConceptRef) {
+    return rc.ref.id ?? rc.ref.source ?? '';
+  }
+  return '';
+}
+
 export class ReferenceResolver {
   extractReferences(concept) {
     const refs = [];
 
     for (const rc of concept.relatedConcepts) {
-      const target = rc.content ?? rc.ref?.toString() ?? '';
+      const target = refTarget(rc);
       if (target) {
         refs.push(new Reference('concept', target, rc.type, 'relatedConcepts'));
       }

package/src/validators/index.js

@@ -4,15 +4,40 @@ export { ValidationResult } from './validation-result.js';
 export { ConceptValidator, LanguageCodeRule, DesignationTypeRule, EntryStatusRule } from './concept-validator.js';
 export { RegisterValidator } from './register-validator.js';
 export { GcrValidator } from './gcr-validator.js';
+export {
+  RefShapeRule,
+  LocalityCompletenessRule,
+  LocalizationConsistencyRule,
+  SchemaVersionRule,
+  DomainRefRule,
+  UuidFormatRule,
+  SourceUrnFormatRule,
+} from './v3-rules.js';
 
 import { ConceptValidator, LanguageCodeRule, DesignationTypeRule, EntryStatusRule } from './concept-validator.js';
 import { RegisterValidator } from './register-validator.js';
 import { GcrValidator } from './gcr-validator.js';
+import {
+  RefShapeRule,
+  LocalityCompletenessRule,
+  LocalizationConsistencyRule,
+  SchemaVersionRule,
+  DomainRefRule,
+  UuidFormatRule,
+  SourceUrnFormatRule,
+} from './v3-rules.js';
 
 const _default = new ConceptValidator()
   .addRule(new LanguageCodeRule())
   .addRule(new DesignationTypeRule())
-  .addRule(new EntryStatusRule());
+  .addRule(new EntryStatusRule())
+  .addRule(new RefShapeRule())
+  .addRule(new LocalityCompletenessRule())
+  .addRule(new LocalizationConsistencyRule())
+  .addRule(new SchemaVersionRule())
+  .addRule(new DomainRefRule())
+  .addRule(new UuidFormatRule())
+  .addRule(new SourceUrnFormatRule());
 
 export function validateConcept(concept) {
   return _default.validate(concept);