glossarist 0.2.2 → 0.3.1

package/README.md

@@ -308,8 +308,10 @@ import 'glossarist/validators'; // validation framework
 
 ```
 Public API (index.js)
-├── Domain models     → Concept, LocalizedConcept, Designation (Expression, Symbol, ...),
-│                       Citation, ConceptSource, RelatedConcept, DetailedDefinition, NonVerbRep
+├── Domain models     → Concept, LocalizedConcept, Designation (Expression, Abbreviation, Symbol,
+│                       LetterSymbol, GraphicalSymbol), GrammarInfo, Pronunciation, Locality,
+│                       Citation, ConceptSource, RelatedConcept, ConceptReference, ConceptDate,
+│                       DetailedDefinition, NonVerbRep
 ├── Parsing           → ConceptParser (canonical + managed format detection)
 ├── Serialization     → ConceptSerializer (canonical + managed YAML output)
 ├── I/O               → loadGcr, readConcepts, createGcr, writeConcepts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glossarist",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "JavaScript SDK for Glossarist GCR packages — read, write, validate, and manage terminology concepts",
   "type": "module",
   "main": "src/index.js",

package/src/concept-parser.js

@@ -1,5 +1,7 @@
 import yaml from 'js-yaml';
 import { Concept } from './models/concept.js';
+import { ConceptRef } from './models/concept-ref.js';
+import { RelatedConcept } from './models/related-concept.js';
 import { InvalidInputError, YamlParseError } from './errors.js';
 
 const STRUCTURAL_KEYS = new Set(['termid', 'term']);
@@ -70,11 +72,34 @@ export class ConceptParser {
       id: String(mc.data.identifier),
       term: null,
       localizations,
+      related: _normalizeRelated(mc.related ?? mc.data?.related),
       domains: mc.data.domains,
       groups: mc.data.groups,
+      dates: mc.dates ?? mc.data?.dates,
+      sources: mc.sources ?? mc.data?.sources,
+      status: mc.status,
+      schemaVersion: mc.schema_version,
       raw: mc,
     });
   }
 }
 
+function _normalizeRelated(arr) {
+  if (!arr || !Array.isArray(arr)) return [];
+  return arr.map(r => {
+    if (r instanceof RelatedConcept) return r;
+    const data = { ...r };
+    if (data.ref) {
+      if (typeof data.ref !== 'object' || data.ref === null) {
+        throw new InvalidInputError(
+          `RelatedConcept.ref must be an object { source, id }, got: ${typeof data.ref}`,
+          'object',
+        );
+      }
+      data.ref = new ConceptRef(data.ref);
+    }
+    return new RelatedConcept(data);
+  });
+}
+
 export const conceptParser = new ConceptParser();

package/src/concept-reader.d.ts

@@ -1,4 +1,4 @@
-import type { Concept } from './models/index';
+import type { Concept, Register } from './models/index';
 
 /** Read all concept YAML files from a directory. */
 export function readConcepts(dir: string): Concept[];
@@ -10,4 +10,4 @@ export function readConcept(dir: string, id: string): Concept | null;
 export function listConceptIds(dir: string, prefix?: string): string[];
 
 /** Read register.yaml from a dataset directory (if present). */
-export function readRegister(dir: string): Record<string, unknown> | null;
+export function readRegister(dir: string): Register | null;

package/src/concept-reader.js

@@ -4,6 +4,7 @@ import yaml from 'js-yaml';
 import { conceptParser } from './concept-parser.js';
 import { naturalSort } from './sort.js';
 import { InvalidInputError } from './errors.js';
+import { Register } from './models/register.js';
 
 function assertDir(dir, fnName) {
   if (typeof dir !== 'string' || dir.trim() === '') {
@@ -91,5 +92,6 @@ export function readRegister(dir) {
   assertDir(dir, 'readRegister');
   const p = path.join(dir, 'register.yaml');
   if (!fs.existsSync(p)) return null;
-  return yaml.load(fs.readFileSync(p, 'utf8'));
+  const raw = yaml.load(fs.readFileSync(p, 'utf8'));
+  return Register.fromJSON(raw);
 }

package/src/concept-serializer.js

@@ -43,6 +43,18 @@ export class ConceptSerializer {
       mainDoc.data.domains = concept.domains.map(d => d.toJSON());
     }
 
+    if (concept.relatedConcepts.length > 0) {
+      mainDoc.related = concept.relatedConcepts.map(rc => rc.toJSON());
+    }
+    if (concept.sources.length > 0) {
+      mainDoc.sources = concept.sources.map(s => s.toJSON());
+    }
+    if (concept.dates.length > 0) {
+      mainDoc.dates = concept.dates.map(d => d.toJSON());
+    }
+    if (concept.status) mainDoc.status = concept.status;
+    if (concept.schemaVersion) mainDoc.schema_version = concept.schemaVersion;
+
     const parts = [
       '---\n' + yaml.dump(mainDoc, DUMP_OPTS),
       ...langDocs.map(d => '---\n' + yaml.dump(d, DUMP_OPTS)),

package/src/gcr-reader.js

@@ -26,7 +26,7 @@ const BASE64_RE = /^[A-Za-z0-9+/]{100,}={0,2}$/;
 /**
  * @typedef {Object} Source
  * @property {string} type - e.g. 'authoritative', 'adapted'
- * @property {{ ref: string }} [origin] - reference to the source standard
+ * @property {{ ref: { source: string, id?: string, version?: string } }} [origin] - reference to the source standard
  */
 
 /**

package/src/index.d.ts

@@ -3,7 +3,7 @@ export {
   GlossaristModel,
   Concept, LocalizedConcept,
   Designation, Expression, Abbreviation, Symbol, GraphicalSymbol,
-  Citation, ConceptSource, RelatedConcept, ConceptDate,
+  Citation, ConceptRef, ConceptSource, RelatedConcept, ConceptDate,
   DetailedDefinition, NonVerbRep,
   GcrMetadata, GcrStatistics,
   RELATIONSHIP_TYPES, DATE_TYPES,

package/src/index.js

@@ -28,9 +28,11 @@ export {
 
 export {
   GlossaristModel,
+  Register, Section,
+  REGISTER_STATUSES, ORDERING_METHODS,
   Concept, LocalizedConcept,
   Designation, Expression, Abbreviation, Symbol, GraphicalSymbol,
-  Citation, ConceptSource, RelatedConcept, ConceptReference, ConceptDate,
+  Citation, ConceptRef, ConceptSource, RelatedConcept, ConceptReference, ConceptDate,
   DetailedDefinition, NonVerbRep,
   GcrMetadata, GcrStatistics,
   RELATIONSHIP_TYPES, DATE_TYPES,

package/src/models/citation.js

@@ -1,45 +1,35 @@
 import { GlossaristModel } from './base.js';
+import { Locality } from './locality.js';
 
 export class Citation extends GlossaristModel {
-  constructor(data) {
+  constructor(data = {}) {
     super();
-    if (typeof data === 'string') {
-      this.source = data;
-      this.ref = null;
-      this.id = null;
-      this.version = null;
-      this.clause = null;
-      this.link = null;
-    } else {
-      const d = data ?? {};
-      this.source = d.source ?? null;
-      this.ref = d.ref ?? null;
-      this.id = d.id ?? null;
-      this.version = d.version ?? null;
-      this.clause = d.clause ?? null;
-      this.link = d.link ?? null;
-    }
-  }
-
-  get isStructured() {
-    return typeof this.source === 'object' && this.source !== null;
+    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;
-    if (typeof this.source === 'string') return this.source;
-    if (typeof this.source === 'object' && this.source !== null) return this.source.ref ?? '';
+    if (this.ref) return this.ref.toString();
     return '';
   }
 
   toJSON() {
     const obj = {};
-    if (this.source != null) obj.source = this.source;
-    if (this.ref != null) obj.ref = this.ref;
-    if (this.id != null) obj.id = this.id;
-    if (this.version != null) obj.version = this.version;
-    if (this.clause != null) obj.clause = this.clause;
+    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;
   }
 
@@ -47,3 +37,32 @@ export class Citation extends GlossaristModel {
     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/concept-date.js

@@ -1,7 +1,7 @@
 import { GlossaristModel } from './base.js';
 
 export const DATE_TYPES = Object.freeze([
-  'accepted', 'amended', 'published', 'withdrawn', 'created',
+  'accepted', 'amended', 'retired',
 ]);
 
 export class ConceptDate extends GlossaristModel {

package/src/models/concept-ref.js

@@ -0,0 +1,25 @@
+import { GlossaristModel } from './base.js';
+
+export class ConceptRef extends GlossaristModel {
+  constructor(data = {}) {
+    super();
+    this.source = data.source ?? null;
+    this.id = data.id ?? null;
+  }
+
+  toString() {
+    if (this.source && this.id) return `${this.source} ${this.id}`;
+    return this.source ?? this.id ?? '';
+  }
+
+  toJSON() {
+    const obj = {};
+    if (this.source != null) obj.source = this.source;
+    if (this.id != null) obj.id = this.id;
+    return obj;
+  }
+
+  static fromJSON(data) {
+    return new ConceptRef(data);
+  }
+}

package/src/models/concept.js

@@ -10,14 +10,17 @@ export class Concept extends GlossaristModel {
     super();
     this.id = String(data.id ?? data.termid ?? '');
     this.term = data.term ?? null;
+    this.uri = data.uri ?? null;
     this._rawLocalizations = data.localizations ?? {};
     this._cache = {};
 
-    this.relatedConcepts = _mapInstances(data.relatedConcepts ?? data.related_concepts ?? [], RelatedConcept);
+    this.relatedConcepts = _mapInstances(data.relatedConcepts ?? data.related ?? data.related_concepts ?? [], RelatedConcept);
     this.domains = _normalizeDomains(data.domains, data.groups);
+    this.tags = Array.isArray(data.tags) ? [...data.tags] : [];
     this.dates = _mapInstances(data.dates ?? [], ConceptDate);
     this.sources = _mapInstances(data.sources ?? [], ConceptSource);
     this.status = data.status ?? null;
+    this.schemaVersion = data.schemaVersion ?? data.schema_version ?? '3';
     this.raw = data.raw ?? null;
   }
 
@@ -68,6 +71,7 @@ export class Concept extends GlossaristModel {
   toJSON() {
     const obj = { id: this.id };
     if (this.term != null) obj.term = this.term;
+    if (this.uri != null) obj.uri = this.uri;
 
     if (Object.keys(this._rawLocalizations).length > 0) {
       obj.localizations = {};
@@ -84,11 +88,14 @@ export class Concept extends GlossaristModel {
     }
 
     if (this.relatedConcepts.length > 0) {
-      obj.relatedConcepts = this.relatedConcepts.map(rc => rc.toJSON());
+      obj.related = this.relatedConcepts.map(rc => rc.toJSON());
     }
     if (this.domains.length > 0) {
       obj.domains = this.domains.map(d => d.toJSON());
     }
+    if (this.tags.length > 0) {
+      obj.tags = [...this.tags];
+    }
     if (this.dates.length > 0) {
       obj.dates = this.dates.map(d => d.toJSON());
     }
@@ -96,6 +103,7 @@ export class Concept extends GlossaristModel {
       obj.sources = this.sources.map(s => s.toJSON());
     }
     if (this.status != null) obj.status = this.status;
+    obj.schema_version = this.schemaVersion;
     return obj;
   }
 

package/src/models/designation.js

@@ -1,4 +1,8 @@
 import { GlossaristModel } from './base.js';
+import { ConceptSource } from './concept-source.js';
+import { Pronunciation } from './pronunciation.js';
+import { GrammarInfo } from './grammar-info.js';
+import { RelatedConcept } from './related-concept.js';
 
 export class Designation extends GlossaristModel {
   static _registry = new Map();
@@ -18,11 +22,41 @@ export class Designation extends GlossaristModel {
     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 RelatedConcept ? r : new RelatedConcept(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;
   }
 
@@ -34,18 +68,16 @@ export class Designation extends GlossaristModel {
 export class Expression extends Designation {
   constructor(data = {}) {
     super(data);
-    this.gender = data.gender ?? null;
-    this.plurality = data.plurality ?? null;
-    this.partOfSpeech = data.part_of_speech ?? null;
-    this.geographicalArea = data.geographical_area ?? null;
+    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.gender != null) obj.gender = this.gender;
-    if (this.plurality != null) obj.plurality = this.plurality;
-    if (this.partOfSpeech != null) obj.part_of_speech = this.partOfSpeech;
-    if (this.geographicalArea != null) obj.geographical_area = this.geographicalArea;
+    if (this.prefix != null) obj.prefix = this.prefix;
+    if (this.grammarInfo.length > 0) obj.grammar_info = this.grammarInfo.map(g => g.toJSON());
     return obj;
   }
 
@@ -54,37 +86,60 @@ export class Expression extends Designation {
 
 Designation.register('expression', Expression);
 
-export class Abbreviation extends Designation {
+export class Abbreviation extends Expression {
+  constructor(data = {}) {
+    super(data);
+    this.acronym = data.acronym ?? false;
+    this.initialism = data.initialism ?? false;
+    this.truncation = data.truncation ?? false;
+  }
+
+  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 {
+  static fromJSON(data) { return new Symbol(data); }
+}
+
+Designation.register('symbol', Symbol);
+
+export class LetterSymbol extends Symbol {
   constructor(data = {}) {
     super(data);
-    this.international = data.international ?? null;
+    this.text = data.text ?? null;
   }
 
   toJSON() {
     const obj = super.toJSON();
-    if (this.international != null) obj.international = this.international;
+    if (this.text != null) obj.text = this.text;
     return obj;
   }
 
-  static fromJSON(data) { return new Symbol(data); }
+  static fromJSON(data) { return new LetterSymbol(data); }
 }
 
-Designation.register('symbol', Symbol);
+Designation.register('letter_symbol', LetterSymbol);
 
-export class GraphicalSymbol extends Designation {
+export class GraphicalSymbol extends Symbol {
   constructor(data = {}) {
     super(data);
+    this.text = data.text ?? null;
     this.image = data.image ?? null;
   }
 
   toJSON() {
     const obj = super.toJSON();
+    if (this.text != null) obj.text = this.text;
     if (this.image != null) obj.image = this.image;
     return obj;
   }

package/src/models/grammar-info.js

@@ -0,0 +1,40 @@
+import { GlossaristModel } from './base.js';
+
+export const GRAMMAR_GENDERS = Object.freeze(['m', 'f', 'n', 'c']);
+export const GRAMMAR_NUMBERS = Object.freeze(['singular', 'dual', 'plural']);
+export const GRAMMAR_PARTS_OF_SPEECH = Object.freeze([
+  'noun', 'verb', 'adj', 'adverb', 'preposition', 'participle',
+]);
+
+export class GrammarInfo extends GlossaristModel {
+  constructor(data = {}) {
+    super();
+    this.gender = data.gender ?? null;
+    this.number = data.number ?? null;
+    this.partOfSpeech = data.part_of_speech ?? data.partOfSpeech ?? null;
+    this.noun = data.noun ?? false;
+    this.verb = data.verb ?? false;
+    this.adj = data.adj ?? false;
+    this.adverb = data.adverb ?? false;
+    this.preposition = data.preposition ?? false;
+    this.participle = data.participle ?? false;
+  }
+
+  toJSON() {
+    const obj = {};
+    if (this.gender != null) obj.gender = this.gender;
+    if (this.number != null) obj.number = this.number;
+    if (this.partOfSpeech != null) obj.part_of_speech = this.partOfSpeech;
+    if (this.noun) obj.noun = true;
+    if (this.verb) obj.verb = true;
+    if (this.adj) obj.adj = true;
+    if (this.adverb) obj.adverb = true;
+    if (this.preposition) obj.preposition = true;
+    if (this.participle) obj.participle = true;
+    return obj;
+  }
+
+  static fromJSON(data) {
+    return new GrammarInfo(data);
+  }
+}