glossarist 0.4.35 → 0.4.37

package/src/models/sequential-hyperedge.ts

@@ -0,0 +1,70 @@
+// SequentialHyperedge — an ISO 12620 A.6.3 / ISO 704:2022 §5.5.5
+// sequential relation connecting a comprehensive concept to two or
+// more subordinate concepts in an ORDERED sequence (temporal,
+// spatial, causal, developmental).
+//
+// Mirror of PartitiveHyperedge and GenericHyperedge. Member array
+// order IS significant — reversing the array reverses the sequence.
+// Use cases: manufacturing process steps, biological life cycles,
+// software release lifecycles, supply chain stages, geological eras.
+
+import { AbstractHyperedge } from './abstract-hyperedge.js';
+import type { AbstractHyperedgeJson } from './abstract-hyperedge.js';
+import { SequentialMember } from './sequential-member.js';
+import type { SequentialMemberJson } from './sequential-member.js';
+import { HyperedgeRegistry } from './hyperedge-registry.js';
+
+export interface SequentialHyperedgeJson extends AbstractHyperedgeJson {
+  members: ReadonlyArray<SequentialMemberJson | SequentialMember>;
+}
+
+export class SequentialHyperedge extends AbstractHyperedge {
+  // Per-class metadata block — the OCP contract.
+  static wireKey = 'sequential_relations' as const;
+  static typeTag = 'sequential_relation' as const;
+  static rdfType = 'gloss:SequentialRelation' as const;
+  static memberClass = SequentialMember;
+  static v1WireKeys: ReadonlyArray<string> = [];
+  static kindLabel = 'SEQ';
+
+  declare readonly members: ReadonlyArray<SequentialMember>;
+
+  constructor(data: Partial<SequentialHyperedgeJson> = {}) {
+    super({
+      comprehensive: data.comprehensive ?? {},
+      members: data.members ?? [],
+      completeness: data.completeness ?? 'complete',
+      criterion: data.criterion,
+      sources: data.sources,
+      notes: data.notes,
+      status: data.status,
+    });
+    this.members = (Array.isArray(data.members) ? data.members : []).map((m) =>
+      m instanceof SequentialMember ? m : new SequentialMember(m as SequentialMemberJson),
+    );
+  }
+
+  static identityOf(
+    value: {
+      comprehensive?: { source?: string | null; id?: string | null } | null;
+      members?: ReadonlyArray<{ ref?: { source?: string | null; id?: string | null } | null } | null>;
+    } | null | undefined,
+  ): string {
+    const v = value ?? {};
+    const c = v.comprehensive ?? {};
+    // For sequential, member order IS significant — do NOT sort.
+    const memberKeys = (v.members ?? []).map((m) => {
+      const r = m?.ref ?? (m as { source?: string; id?: string } | null) ?? {};
+      return `${r.source ?? ''}:${r.id ?? ''}`;
+    });
+    return `${c.source ?? ''}:${c.id ?? ''}|${memberKeys.join('|')}`;
+  }
+
+  static override fromJSON(data: SequentialHyperedgeJson): SequentialHyperedge {
+    return new SequentialHyperedge(data);
+  }
+}
+
+export default SequentialHyperedge;
+
+HyperedgeRegistry.register(SequentialHyperedge);

package/src/models/{sequential-member.js → sequential-member.ts}

@@ -1,13 +1,16 @@
 // SequentialMember — one member of a SequentialHyperedge. Inherits
 // the MECE shape from HyperedgeMember. Distinct leaf class for type
 // safety. Member array order IS significant for sequential hyperedges.
-//
-// See docs/design/abstract-nary-relation.md (concept-model repo).
 
 import { HyperedgeMember } from './hyperedge-member.js';
+import type { HyperedgeMemberJson } from './hyperedge-member.js';
+
+export type SequentialMemberJson = HyperedgeMemberJson;
 
 export class SequentialMember extends HyperedgeMember {
-  // Inherits all attributes and validations from HyperedgeMember.
+  static override fromJSON(data: SequentialMemberJson): SequentialMember {
+    return new SequentialMember(data);
+  }
 }
 
 export default SequentialMember;

package/src/models/abstract-hyperedge.js

@@ -1,119 +0,0 @@
-// AbstractHyperedge — shared base for directed 1→N hyperedges
-// relations (PartitiveHyperedge, GenericHyperedge, future
-// SequentialRelation, AssociativeRelation).
-//
-// Carries the common shape:
-//   - comprehensive: ConceptRef
-//   - members: 2+ MECE dimensioned concept refs (≥2 per ISO 704)
-//   - completeness: complete | partial
-//   - criterion: localized subdivision criterion (ISO 12620)
-//   - sources / notes / status: administrative metadata
-//
-// Concrete leaves add type-specific fields if needed (currently none).
-// See docs/design/abstract-hyperedge.md (concept-model repo).
-
-import { GlossaristModel } from './base.js';
-import { ConceptRef } from './concept-ref.js';
-import {
-  COMPLETENESS,
-  DEFAULT_COMPLETENESS,
-  isValidCompleteness,
-} from './completeness.js';
-
-export class AbstractHyperedge extends GlossaristModel {
-  constructor(data = {}) {
-    super();
-    this.comprehensive = _ensureComprehensive(data.comprehensive);
-    this.members = _ensureMembers(data.members, this.constructor.name);
-    this.completeness = _resolveCompleteness(data.completeness);
-    this.criterion = _normalizeCriterion(data.criterion);
-    this.sources = Array.isArray(data.sources) ? [...data.sources] : [];
-    this.notes = data.notes ?? null;
-    this.status = data.status ?? null;
-
-    _assertNoSelfLoop(this.comprehensive, this.members);
-  }
-
-  get isComplete() { return this.completeness === COMPLETENESS.COMPLETE; }
-  get isPartial() { return this.completeness === COMPLETENESS.PARTIAL; }
-  get isCoordinate() { return this.members.length >= 2; }
-
-  hasCriterion() { return this.criterion != null; }
-
-  identity() {
-    return this.constructor.identityOf(this);
-  }
-
-  toJSON() {
-    const obj = {
-      comprehensive: this.comprehensive.toJSON(),
-      members: this.members.map(m => m.toJSON()),
-      completeness: this.completeness,
-    };
-    if (this.criterion != null) obj.criterion = { ...this.criterion };
-    if (this.sources.length > 0) obj.sources = [...this.sources];
-    if (this.notes != null) obj.notes = { ...this.notes };
-    if (this.status != null) obj.status = this.status;
-    return obj;
-  }
-}
-
-function _ensureComprehensive(value) {
-  const ref = value instanceof ConceptRef ? value : new ConceptRef(value ?? {});
-  if (!ref.source && !ref.id && !ref.text) {
-    throw new Error(
-      'AbstractHyperedge.comprehensive must be a non-empty ConceptReference ' +
-      '(source, id, or text required)',
-    );
-  }
-  return ref;
-}
-
-function _ensureMembers(values, typeName) {
-  if (!Array.isArray(values)) {
-    throw new Error(
-      `${typeName}.members must be an array (got ${typeof values})`,
-    );
-  }
-  if (values.length < 2) {
-    throw new Error(
-      `${typeName} requires ≥2 partitives (ISO 704); got ${values.length}`,
-    );
-  }
-  return values;
-}
-
-function _resolveCompleteness(value) {
-  const c = value ?? DEFAULT_COMPLETENESS;
-  if (!isValidCompleteness(c)) {
-    throw new Error(
-      `${c === value ? 'completeness' : 'completeness'} has invalid value ${JSON.stringify(value)}`,
-    );
-  }
-  return c;
-}
-
-function _normalizeCriterion(value) {
-  if (value == null) return null;
-  if (typeof value === 'string') {
-    return value.length > 0 ? { default: value } : null;
-  }
-  if (typeof value === 'object') {
-    const entries = Object.entries(value).filter(([, v]) => typeof v === 'string');
-    return entries.length > 0 ? Object.fromEntries(entries) : null;
-  }
-  return null;
-}
-
-function _assertNoSelfLoop(comprehensive, members) {
-  const cKey = `${comprehensive.source ?? ''}:${comprehensive.id ?? ''}`;
-  for (const m of members) {
-    const ref = m.ref;
-    const pKey = `${ref?.source ?? ''}:${ref?.id ?? ''}`;
-    if (pKey === cKey && (ref?.source || ref?.id)) {
-      throw new Error(
-        'Relation.members cannot include the comprehensive (no self-loops)',
-      );
-    }
-  }
-}

package/src/models/base.js

@@ -1,32 +0,0 @@
-export class GlossaristModel {
-  toJSON() {
-    throw new Error(`${this.constructor.name} must implement toJSON()`);
-  }
-
-  static fromJSON() {
-    throw new Error(`${this.name} must implement fromJSON()`);
-  }
-
-  equals(other) {
-    if (!(other instanceof this.constructor)) return false;
-    return JSON.stringify(this.toJSON()) === JSON.stringify(other.toJSON());
-  }
-
-  clone() {
-    return this.constructor.fromJSON(JSON.parse(JSON.stringify(this.toJSON())));
-  }
-
-  _lazy(cacheKey, rawKey, wrapFn) {
-    if (this[cacheKey] === null) {
-      this[cacheKey] = this[rawKey].map(wrapFn);
-    }
-    return this[cacheKey];
-  }
-
-  _serialize(obj, jsonKey, cacheKey, rawKey) {
-    const items = this[cacheKey] ?? (this[rawKey].length > 0 ? this[rawKey] : []);
-    if (items.length > 0) {
-      obj[jsonKey] = items.map(i => (i instanceof GlossaristModel) ? i.toJSON() : i);
-    }
-  }
-}

package/src/models/concept-date.js

@@ -1,36 +0,0 @@
-import { GlossaristModel } from './base.js';
-
-export const DATE_TYPES = Object.freeze([
-  'accepted', 'amended', 'retired',
-]);
-
-export class ConceptDate extends GlossaristModel {
-  constructor(data = {}) {
-    super();
-    this.date = data.date ?? null;
-    this.type = data.type ?? null;
-  }
-
-  get parsedDate() {
-    return this.date ? new Date(this.date) : null;
-  }
-
-  static identityOf(value) {
-    return value?.type ?? '';
-  }
-
-  identity() {
-    return ConceptDate.identityOf(this);
-  }
-
-  toJSON() {
-    const obj = {};
-    if (this.date != null) obj.date = this.date;
-    if (this.type != null) obj.type = this.type;
-    return obj;
-  }
-
-  static fromJSON(data) {
-    return new ConceptDate(data);
-  }
-}

package/src/models/concept-ref.js

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

package/src/models/concept-source.js

@@ -1,52 +0,0 @@
-import { GlossaristModel } from './base.js';
-import { Citation } from './citation.js';
-
-export class ConceptSource extends GlossaristModel {
-  constructor(data = {}) {
-    super();
-    this.id = data.id ?? null;
-    this.status = data.status ?? null;
-    this.type = data.type ?? null;
-    this.origin = data.origin
-      ? (data.origin instanceof Citation ? data.origin : new Citation(data.origin))
-      : null;
-    this.modification = data.modification ?? null;
-    this.sourcedFrom = (data.sourcedFrom ?? data.sourced_from ?? []).map(
-      c => c instanceof Citation ? c : new Citation(c)
-    );
-  }
-
-  // Backward-compat alias for callers using the snake_case JS field name.
-  // Prefer `.sourcedFrom` going forward; the wire name remains
-  // `sourced_from` (see toJSON).
-  get sourced_from() {
-    return this.sourcedFrom;
-  }
-
-  toJSON() {
-    const obj = {};
-    if (this.id != null) obj.id = this.id;
-    if (this.status != null) obj.status = this.status;
-    if (this.type != null) obj.type = this.type;
-    if (this.origin != null) obj.origin = this.origin.toJSON();
-    if (this.modification != null) obj.modification = this.modification;
-    if (this.sourcedFrom.length > 0) {
-      obj.sourced_from = this.sourcedFrom.map(c => c.toJSON());
-    }
-    return obj;
-  }
-
-  static identityOf(value) {
-    const v = value ?? {};
-    const ref = v?.origin?.ref ?? (v?.origin instanceof Citation ? v.origin.ref : null);
-    return `${v.type ?? ''}|${ref?.source ?? ''}|${ref?.id ?? ''}`;
-  }
-
-  identity() {
-    return ConceptSource.identityOf(this);
-  }
-
-  static fromJSON(data) {
-    return new ConceptSource(data);
-  }
-}

package/src/models/concept-system-type.js

@@ -1,26 +0,0 @@
-// ConceptSystemType — ISO 12620 A.7.1 concept system type enum.
-//
-// Permissible instances per ISO 12620:
-//   generic     — species are part of the extension of the genus
-//   partitive   — based on whole-part relations
-//   sequential  — based on spatial and temporal relations
-//   associative — based on thematic or pragmatic relations
-//   mixed       — two or more of the above (the realistic case)
-
-export const CONCEPT_SYSTEM_TYPE = Object.freeze({
-  GENERIC: 'generic',
-  PARTITIVE: 'partitive',
-  SEQUENTIAL: 'sequential',
-  ASSOCIATIVE: 'associative',
-  MIXED: 'mixed',
-});
-
-export const CONCEPT_SYSTEM_TYPE_VALUES = Object.freeze(
-  Object.values(CONCEPT_SYSTEM_TYPE),
-);
-
-export function isValidConceptSystemType(value) {
-  return CONCEPT_SYSTEM_TYPE_VALUES.includes(value);
-}
-
-export default CONCEPT_SYSTEM_TYPE;

package/src/models/concept-system.js

@@ -1,117 +0,0 @@
-// ConceptSystem — first-class concept system entity per ISO 12620 A.7.
-//
-// Promotes the previously-implicit concept system (domains + tags +
-// relation graph) to an explicit first-class entity. Per-file at
-// `concept-systems/<id>.yaml`.
-//
-// See docs/design/concept-systems.md (concept-model repo).
-
-import { GlossaristModel } from './base.js';
-import { ConceptRef } from './concept-ref.js';
-import {
-  CONCEPT_SYSTEM_TYPE,
-  CONCEPT_SYSTEM_TYPE_VALUES,
-  isValidConceptSystemType,
-} from './concept-system-type.js';
-
-export class ConceptSystem extends GlossaristModel {
-  constructor(data = {}) {
-    super();
-    this.id = _ensureNonEmptyString(data.id, 'id');
-    this.name = _ensureName(data.name);
-    this.type = _resolveType(data.type);
-    this.domain = data.domain ?? null;
-    this.purpose = data.purpose ?? null;
-    this.members = _ensureMembers(data.members);
-    this.hyperedges = Array.isArray(data.hyperedges) ? [...data.hyperedges] : [];
-    this.rootConcepts = Array.isArray(data.rootConcepts)
-      ? data.rootConcepts.map(c => c instanceof ConceptRef ? c : new ConceptRef(c))
-      : [];
-    this.sources = Array.isArray(data.sources) ? [...data.sources] : [];
-    this.status = data.status ?? null;
-  }
-
-  get isGeneric()     { return this.type === CONCEPT_SYSTEM_TYPE.GENERIC; }
-  get isPartitive()   { return this.type === CONCEPT_SYSTEM_TYPE.PARTITIVE; }
-  get isSequential()  { return this.type === CONCEPT_SYSTEM_TYPE.SEQUENTIAL; }
-  get isAssociative() { return this.type === CONCEPT_SYSTEM_TYPE.ASSOCIATIVE; }
-  get isMixed()       { return this.type === CONCEPT_SYSTEM_TYPE.MIXED; }
-
-  hasHyperedge(edgeId) {
-    return this.hyperedges.includes(edgeId);
-  }
-
-  hasMember(refOrUri) {
-    const uri = typeof refOrUri === 'string' ? refOrUri : _refUri(refOrUri);
-    return this.members.some(m => _refUri(m) === uri);
-  }
-
-  identity() {
-    return this.id;
-  }
-
-  toJSON() {
-    const obj = {
-      id: this.id,
-      name: { ...this.name },
-      type: this.type,
-      members: this.members.map(m => m.toJSON()),
-    };
-    if (this.domain != null) obj.domain = this.domain;
-    if (this.purpose != null) obj.purpose = { ...this.purpose };
-    if (this.hyperedges.length > 0) obj.hyperedges = [...this.hyperedges];
-    if (this.rootConcepts.length > 0) obj.rootConcepts = this.rootConcepts.map(c => c.toJSON());
-    if (this.sources.length > 0) obj.sources = [...this.sources];
-    if (this.status != null) obj.status = this.status;
-    return obj;
-  }
-
-  static fromJSON(data) {
-    return new ConceptSystem(data);
-  }
-}
-
-function _ensureNonEmptyString(value, fieldName) {
-  if (typeof value !== 'string' || value.length === 0) {
-    throw new Error(`ConceptSystem#${fieldName} must be a non-empty string`);
-  }
-  return value;
-}
-
-function _ensureName(value) {
-  if (value == null) return {};
-  if (typeof value !== 'object' || Array.isArray(value)) {
-    throw new Error('ConceptSystem#name must be a localized object (e.g. { eng: "..." })');
-  }
-  return { ...value };
-}
-
-function _resolveType(value) {
-  if (value == null) {
-    throw new Error(
-      'ConceptSystem#type is required; one of ' +
-      CONCEPT_SYSTEM_TYPE_VALUES.join(', '),
-    );
-  }
-  if (!isValidConceptSystemType(value)) {
-    throw new Error(
-      `ConceptSystem#type ${JSON.stringify(value)} invalid; ` +
-      `must be one of: ${CONCEPT_SYSTEM_TYPE_VALUES.join(', ')}`,
-    );
-  }
-  return value;
-}
-
-function _ensureMembers(values) {
-  if (!Array.isArray(values) || values.length === 0) {
-    throw new Error('ConceptSystem#members must be a non-empty array');
-  }
-  return values.map(v => v instanceof ConceptRef ? v : new ConceptRef(v));
-}
-
-function _refUri(ref) {
-  const r = ref?.ref ?? ref ?? {};
-  return `${r.source ?? ''}:${r.id ?? ''}`;
-}
-
-export default ConceptSystem;

package/src/models/concept-type.js

@@ -1,25 +0,0 @@
-// ConceptType — ISO 704:2022 §5.2-5.3 general vs individual concept.
-//
-//   general    — concept corresponds to a category of objects
-//                (designated by terms or symbols)
-//   individual — concept corresponds to a unique object
-//                (designated by proper names / appellations)
-//
-// Individual concepts occupy the bottom rung of a concept ladder
-// and cannot be subdivided into more specific concepts, but CAN be
-// subdivided into parts via a partitive relation.
-
-export const CONCEPT_TYPE = Object.freeze({
-  GENERAL: 'general',
-  INDIVIDUAL: 'individual',
-});
-
-export const CONCEPT_TYPE_VALUES = Object.freeze(Object.values(CONCEPT_TYPE));
-
-export const DEFAULT_CONCEPT_TYPE = CONCEPT_TYPE.GENERAL;
-
-export function isValidConceptType(value) {
-  return CONCEPT_TYPE_VALUES.includes(value);
-}
-
-export default CONCEPT_TYPE;

package/src/models/enum.js

@@ -1,42 +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:
-//   {
-//     CLOSED: 'closed',           // exposed by destructuring
-//     OPEN:   'open',
-//     VALUES: ['closed', 'open'],  // frozen array
-//     isValid: (v) => boolean,     // predicate
-//   }
-//
-// We attach the bundle via Object.assign on a frozen object so the
-// bundle is itself frozen and exposes both the per-value constants
-// (CLOSED, OPEN, ...) and the VALUES list + isValid predicate.
-
-export function makeEnum(name, values) {
-  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));
-  const isValid = (v) => valuesArr.includes(v);
-
-  return Object.assign(Object.create(null), frozen, {
-    name,
-    VALUES: valuesArr,
-    isValid,
-  });
-}

package/src/models/equivalence-degree.js

@@ -1,25 +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 const EQUIVALENCE_DEGREE = Object.freeze({
-  FULL: 'full',
-  PARTIAL: 'partial',
-  NONE: 'none',
-  DIRECTIONAL: 'directional',
-});
-
-export const EQUIVALENCE_DEGREE_VALUES = Object.freeze(
-  Object.values(EQUIVALENCE_DEGREE),
-);
-
-export const DEFAULT_EQUIVALENCE_DEGREE = EQUIVALENCE_DEGREE.FULL;
-
-export function isValidEquivalenceDegree(value) {
-  return EQUIVALENCE_DEGREE_VALUES.includes(value);
-}
-
-export default EQUIVALENCE_DEGREE;

package/src/models/generic-hyperedge.js

@@ -1,55 +0,0 @@
-// GenericHyperedge — an ISO 704 / ISO 1087-1 / ISO 12620 generic
-// relation connecting a comprehensive concept (the genus) to two
-// or more specific concepts (the species) which together constitute
-// a decomposition by some criterion of subdivision.
-//
-// Mirror of PartitiveHyperedge. Multiple GenericRelations on the same
-// comprehensive distinguished by `criterion` is the OIML pattern
-// (5.1 measurement standard has 6 criterion groups).
-//
-// See docs/design/generic-relation.md (concept-model repo).
-
-import { AbstractHyperedge } from './abstract-hyperedge.js';
-import { GenericMember } from './generic-member.js';
-import { HyperedgeRegistry } from './hyperedge-registry.js';
-
-export class GenericHyperedge extends AbstractHyperedge {
-  // Per-class metadata block — the OCP contract. See PartitiveHyperedge
-  // for field documentation.
-  static wireKey     = 'generic_relations';
-  static typeTag     = 'generic_relation';
-  static rdfType     = 'gloss:GenericRelation';
-  static memberClass = GenericMember;
-  static v1WireKeys  = [];
-  static kindLabel   = 'GEN';
-
-  constructor(data = {}) {
-    super(data);
-    this.members = data?.members == null
-      ? this.members
-      : (Array.isArray(data.members)
-          ? data.members.map(m =>
-              m instanceof GenericMember ? m : new GenericMember(m))
-          : this.members);
-  }
-
-  static identityOf(value) {
-    const v = value ?? {};
-    const c = v.comprehensive ?? {};
-    const memberKeys = Array.isArray(v.members)
-      ? v.members.map(m => {
-          const r = m?.ref ?? m ?? {};
-          return `${r.source ?? ''}:${r.id ?? ''}`;
-        }).sort()
-      : [];
-    return `${c.source ?? ''}:${c.id ?? ''}|${memberKeys.join('|')}`;
-  }
-
-  static fromJSON(data) {
-    return new GenericHyperedge(data);
-  }
-}
-
-export default GenericHyperedge;
-
-HyperedgeRegistry.register(GenericHyperedge);