glossarist 0.3.0 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glossarist",
-  "version": "0.3.0",
+  "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-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/index.js

@@ -28,6 +28,8 @@ export {
 
 export {
   GlossaristModel,
+  Register, Section,
+  REGISTER_STATUSES, ORDERING_METHODS,
   Concept, LocalizedConcept,
   Designation, Expression, Abbreviation, Symbol, GraphicalSymbol,
   Citation, ConceptRef, ConceptSource, RelatedConcept, ConceptReference, ConceptDate,

package/src/models/concept.js

@@ -16,6 +16,7 @@ export class Concept extends GlossaristModel {
 
     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;
@@ -92,6 +93,9 @@ export class Concept extends GlossaristModel {
     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());
     }

package/src/models/index.d.ts

@@ -1,3 +1,42 @@
+export const ORDERING_METHODS: readonly string[];
+export class Section extends GlossaristModel {
+  readonly id: string | null;
+  readonly names: Record<string, string>;
+  readonly ordering: string | null;
+  readonly children: Section[];
+  name(lang: string): string | null;
+  descendantById(id: string): Section | null;
+  static fromJSON(data: Record<string, unknown>): Section;
+}
+
+export const REGISTER_STATUSES: readonly string[];
+export class Register extends GlossaristModel {
+  readonly schemaVersion: string;
+  readonly id: string | null;
+  readonly ref: string | null;
+  readonly refAliases: string[];
+  readonly year: number | null;
+  readonly urn: string | null;
+  readonly urnAliases: string[];
+  readonly status: string | null;
+  readonly supersedes: string | null;
+  readonly owner: string | null;
+  readonly sourceRepo: string | null;
+  readonly tags: string[];
+  readonly languages: string[];
+  readonly languageOrder: string[];
+  readonly ordering: string | null;
+  readonly logo: { path?: string; alt?: string } | null;
+  readonly description: Record<string, string>;
+  readonly about: Record<string, string>;
+  readonly provenance: Record<string, unknown>[];
+  readonly contributors: Record<string, unknown>[];
+  readonly sections: Section[];
+  sectionById(id: string): Section | null;
+  sectionName(sectionId: string, lang: string): string | null;
+  static fromJSON(data: Record<string, unknown>): Register;
+}
+
 export class GlossaristModel {
   toJSON(): Record<string, unknown>;
   static fromJSON(data: Record<string, unknown>): GlossaristModel;
@@ -15,6 +54,7 @@ export class Concept extends GlossaristModel {
   readonly raw: Record<string, unknown> | null;
   readonly relatedConcepts: RelatedConcept[];
   readonly domains: ConceptReference[];
+  readonly tags: string[];
   readonly dates: ConceptDate[];
   readonly sources: ConceptSource[];
   readonly status: string | null;

package/src/models/index.js

@@ -1,3 +1,5 @@
+export { Register, REGISTER_STATUSES } from './register.js';
+export { Section, ORDERING_METHODS } from './section.js';
 export { GlossaristModel } from './base.js';
 export { Concept } from './concept.js';
 export { LocalizedConcept } from './localized-concept.js';

package/src/models/register.js

@@ -0,0 +1,110 @@
+import { GlossaristModel } from './base.js';
+import { Section } from './section.js';
+
+export const REGISTER_STATUSES = Object.freeze([
+  'current',
+  'superseded',
+  'withdrawn',
+  'draft',
+]);
+
+export class Register extends GlossaristModel {
+  constructor(data = {}) {
+    super();
+    this.schemaVersion = data.schema_version ?? data.schemaVersion ?? '3';
+    this.id = data.id ?? null;
+    this.ref = data.ref ?? null;
+    this.refAliases = data.refAliases ?? data.ref_aliases ?? [];
+    this.year = data.year ?? null;
+    this.urn = data.urn ?? null;
+    this.urnAliases = data.urnAliases ?? data.urn_aliases ?? [];
+    this.status = data.status ?? null;
+    this.supersedes = data.supersedes ?? null;
+    this.owner = data.owner ?? null;
+    this.sourceRepo = data.sourceRepo ?? data.source_repo ?? null;
+    this.tags = data.tags ?? [];
+    this.languages = data.languages ?? [];
+    this.languageOrder = data.languageOrder ?? data.language_order ?? [];
+    this.ordering = data.ordering ?? null;
+    this.logo = data.logo ?? null;
+    this.description = data.description ?? {};
+    this.about = data.about ?? {};
+    this.provenance = data.provenance ?? [];
+    this.contributors = data.contributors ?? [];
+    this.sections = (data.sections ?? []).map(s =>
+      s instanceof Section ? s : new Section(s)
+    );
+    this._raw = this._extractRaw(data);
+  }
+
+  _extractRaw(data) {
+    const known = new Set([
+      'schema_version', 'schemaVersion',
+      'id', 'ref', 'refAliases', 'ref_aliases',
+      'year', 'urn', 'urnAliases', 'urn_aliases',
+      'status', 'supersedes', 'owner',
+      'sourceRepo', 'source_repo', 'tags',
+      'languages', 'languageOrder', 'language_order',
+      'ordering', 'logo', 'description', 'about',
+      'provenance', 'contributors', 'sections',
+    ]);
+    const extra = {};
+    for (const [k, v] of Object.entries(data)) {
+      if (!known.has(k)) extra[k] = v;
+    }
+    return extra;
+  }
+
+  sectionById(id) {
+    for (const section of this.sections) {
+      if (section.id === id) return section;
+      const found = section.descendantById(id);
+      if (found) return found;
+    }
+    return null;
+  }
+
+  sectionName(sectionId, lang) {
+    const section = this.sectionById(sectionId);
+    return section ? section.name(lang) : null;
+  }
+
+  toJSON() {
+    const obj = { ...this._raw, schema_version: this.schemaVersion };
+    if (this.id != null) obj.id = this.id;
+    if (this.ref != null) obj.ref = this.ref;
+    if (this.refAliases.length > 0) obj.refAliases = [...this.refAliases];
+    if (this.year != null) obj.year = this.year;
+    if (this.urn != null) obj.urn = this.urn;
+    if (this.urnAliases.length > 0) obj.urnAliases = [...this.urnAliases];
+    if (this.status != null) obj.status = this.status;
+    if (this.supersedes != null) obj.supersedes = this.supersedes;
+    if (this.owner != null) obj.owner = this.owner;
+    if (this.sourceRepo != null) obj.sourceRepo = this.sourceRepo;
+    if (this.tags.length > 0) obj.tags = [...this.tags];
+    if (this.languages.length > 0) obj.languages = [...this.languages];
+    if (this.languageOrder.length > 0) obj.languageOrder = [...this.languageOrder];
+    if (this.ordering != null) obj.ordering = this.ordering;
+    if (this.logo != null) obj.logo = { ...this.logo };
+    if (Object.keys(this.description).length > 0) obj.description = { ...this.description };
+    if (Object.keys(this.about).length > 0) obj.about = { ...this.about };
+    if (this.provenance.length > 0) obj.provenance = this.provenance.map(p => ({ ...p }));
+    if (this.contributors.length > 0) obj.contributors = this.contributors.map(c => ({ ...c }));
+    if (this.sections.length > 0) obj.sections = this.sections.map(s => s.toJSON());
+    return obj;
+  }
+
+  static fromJSON(data) {
+    const instance = new Register(data);
+    const snakeToCamel = k => k.replace(/_([a-z])/g, (_, c) => c.toUpperCase());
+    return new Proxy(instance, {
+      get(target, prop) {
+        if (prop in target) return target[prop];
+        if (prop in target._raw) return target._raw[prop];
+        const camel = snakeToCamel(prop);
+        if (camel in target) return target[camel];
+        return undefined;
+      },
+    });
+  }
+}

package/src/models/section.js

@@ -0,0 +1,44 @@
+import { GlossaristModel } from './base.js';
+
+export const ORDERING_METHODS = Object.freeze([
+  'systematic',
+  'mixed',
+  'alphabetical',
+]);
+
+export class Section extends GlossaristModel {
+  constructor(data = {}) {
+    super();
+    this.id = data.id ?? null;
+    this.names = data.names ?? {};
+    this.ordering = data.ordering ?? null;
+    this.children = (data.children ?? []).map(c =>
+      c instanceof Section ? c : new Section(c)
+    );
+  }
+
+  name(lang) {
+    return this.names[lang] ?? this.names.eng ?? null;
+  }
+
+  descendantById(id) {
+    for (const child of this.children) {
+      if (child.id === id) return child;
+      const found = child.descendantById(id);
+      if (found) return found;
+    }
+    return null;
+  }
+
+  toJSON() {
+    const obj = { 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 fromJSON(data) {
+    return new Section(data);
+  }
+}