glossarist 0.4.49 → 0.4.51

package/src/models/index.d.ts

@@ -1,586 +0,0 @@
-export const ORDERING_METHODS: readonly string[];
-
-// Dataset color spec (light/dark variants)
-export type DatasetColorSpec = string;
-export interface DatasetColorPair {
-  light: string;
-  dark: string;
-}
-export type DatasetColor = DatasetColorSpec | DatasetColorPair;
-export const COLOR_MODES: readonly ['light', 'dark'];
-export function resolveColor(color: DatasetColor | null | undefined, mode: 'light' | 'dark'): string | null;
-export function isColorPair(color: unknown): color is DatasetColorPair;
-export function validateColor(color: unknown): string | null;
-
-// Relation categories + color registry
-export interface RelationCategoryDef {
-  readonly label: string;
-  readonly description: string;
-  readonly types: readonly string[];
-}
-export const RELATION_CATEGORIES: Readonly<Record<string, RelationCategoryDef>>;
-export function categoryOf(type: string): string | null;
-export function categoryDefinition(categoryKey: string): RelationCategoryDef | null;
-export function uncategorizedTypes(): string[];
-export function duplicatedTypes(): Array<{ type: string; count: number }>;
-
-export interface RelationColorPair {
-  light: string;
-  dark: string;
-}
-export const RELATION_COLOR_DEFAULTS: Readonly<{
-  byCategory: Readonly<Record<string, RelationColorPair>>;
-  byType: Readonly<Record<string, RelationColorPair>>;
-}>;
-export function resolveRelationColor(
-  type: string,
-  options?: {
-    overrides?: { byType?: Record<string, RelationColorPair | string>; byCategory?: Record<string, RelationColorPair | string> };
-    mode?: 'light' | 'dark';
-  },
-): string | null;
-export function categoryColorPair(
-  categoryKey: string,
-  overrides?: { byCategory?: Record<string, RelationColorPair | string> },
-): RelationColorPair | null;
-
-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 name: string | Record<string, 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;
-  displayName(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;
-  equals(other: GlossaristModel): boolean;
-  clone(): 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 partitiveHyperedges: PartitiveHyperedge[];
-  readonly domains: ConceptReference[];
-  readonly tags: string[];
-  readonly dates: ConceptDate[];
-  readonly sources: ConceptSource[];
-  readonly status: string | null;
-  readonly schemaVersion: string | null;
-
-  localization(lang: string): LocalizedConcept | undefined;
-  primaryDesignation(lang: string): string | null;
-  definition(lang: string): string | null;
-  setLocalization(lang: string, lc: LocalizedConcept | Record<string, unknown>): this;
-  hasLocalization(lang: string): boolean;
-  walkTexts(): Iterable<{ text: string; source: string }>;
-  static fromJSON(data: Record<string, unknown>): Concept;
-}
-
-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: DetailedDefinition[];
-  readonly annotations: DetailedDefinition[];
-  readonly examples: DetailedDefinition[];
-  readonly sources: ConceptSource[];
-  readonly dates: ConceptDate[];
-  readonly nonVerbalRep: NonVerbRep[];
-  readonly related: RelatedConcept[];
-  readonly primaryDesignation: string | null;
-  readonly primaryDefinition: string | null;
-  walkTexts(basePath: string): Iterable<{ text: string; source: string }>;
-  static fromJSON(data: Record<string, unknown>): LocalizedConcept;
-}
-
-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 | DesignationRelationship)[];
-  rdfClass(): string;
-  skosLabelPredicate(skosNs: string): string;
-  skosxlLabelPredicate(skosxlNs: string): string;
-  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 number: string | null;
-  readonly partOfSpeech: string | null;
-  readonly noun: boolean;
-  readonly verb: boolean;
-  readonly adj: boolean;
-  readonly adverb: boolean;
-  readonly preposition: boolean;
-  readonly participle: boolean;
-}
-
-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 Locality extends GlossaristModel {
-  readonly type: string | null;
-  readonly referenceFrom: string | null;
-  readonly referenceTo: string | null;
-}
-
-export class Citation extends GlossaristModel {
-  readonly ref: Citation.Ref | null;
-  readonly locality: Locality | null;
-  readonly link: string | null;
-  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;
-  readonly text: string | null;
-  toString(): string;
-  static fromJSON(data: Record<string, unknown>): ConceptRef;
-}
-
-export class ConceptSource extends GlossaristModel {
-  readonly status: string | null;
-  readonly type: string | null;
-  readonly origin: Citation | null;
-  readonly modification: string | null;
-  readonly sourcedFrom: Citation[];
-  /** @deprecated use sourcedFrom */
-  readonly sourced_from: Citation[];
-}
-
-export const RELATIONSHIP_TYPES: readonly string[];
-export class RelatedConcept extends GlossaristModel {
-  readonly type: string;
-  readonly content: string | null;
-  readonly ref: ConceptRef | null;
-}
-
-export interface LocalizedContent {
-  readonly [language: string]: string;
-}
-
-export const PARTITIVE_ENUMERATION: Readonly<{
-  readonly CLOSED: 'closed';
-  readonly OPEN: 'open';
-}>;
-export const PARTITIVE_ENUMERATION_VALUES: readonly ['closed', 'open'];
-export function isValidPartitiveEnumeration(value: unknown): value is 'closed' | 'open';
-
-export const PLURALITY_MARKER: Readonly<{
-  readonly DOUBLE: 'double';
-  readonly DASHED: 'dashed';
-}>;
-export const PLURALITY_MARKER_VALUES: readonly ['double', 'dashed'];
-export function isValidPluralityMarker(value: unknown): value is 'double' | 'dashed';
-
-export function makeEnum<T extends string>(
-  name: string,
-  values: Record<string, T>,
-): Readonly<Record<string, T>> & {
-  readonly name: string;
-  readonly VALUES: readonly T[];
-  readonly isValid: (value: unknown) => value is T;
-};
-
-export interface HyperedgeColorPair {
-  readonly light: string;
-  readonly dark: string;
-  readonly pattern: 'dashed' | 'double' | null;
-}
-
-export function resolveHyperedgeColor(
-  hyperedge: { enumeration?: string; markers?: string[] } | null,
-  options?: {
-    category?: string;
-    overrides?: { byCategory?: Record<string, unknown> };
-  },
-): HyperedgeColorPair | null;
-
-export class PartitiveHyperedge extends GlossaristModel {
-  readonly comprehensive: ConceptRef;
-  readonly parts: ConceptRef[];
-  readonly enumeration: 'closed' | 'open';
-  readonly markers: ('double' | 'dashed')[];
-  readonly content: LocalizedContent | null;
-
-  readonly isMarked: boolean;
-  readonly contentString: string | null;
-
-  hasMarker(value: string): boolean;
-  hasEnumeration(value: string): boolean;
-  identity(): string;
-  toJSON(): Record<string, unknown>;
-  static fromJSON(data: Record<string, unknown>): PartitiveHyperedge;
-}
-
-// v2 PartitiveHyperedge + GenericHyperedge (MECE per-member model).
-// These supersede the v1 PartitiveHyperedge model above. New code
-// should use v2 exclusively; the v1 model is kept for backward-compat
-// input.
-export class HyperedgeMember extends GlossaristModel {
-  readonly ref: ConceptRef;
-  readonly presence: 'required' | 'optional';
-  readonly count: 'exactly_one' | 'at_least_one' | 'multiple';
-  readonly is_delimiting: boolean;
-  required(): boolean;
-  optional(): boolean;
-  delimiting(): boolean;
-  identity(): string;
-  toJSON(): Record<string, unknown>;
-  static fromJSON(data: Record<string, unknown>): HyperedgeMember;
-  static identityOf(value: unknown): string;
-}
-
-export class PartitiveMember extends HyperedgeMember {}
-
-export class GenericMember extends HyperedgeMember {}
-
-export class AbstractHyperedge extends GlossaristModel {
-  readonly comprehensive: ConceptRef;
-  readonly members: HyperedgeMember[];
-  readonly completeness: 'complete' | 'partial';
-  readonly criterion: Record<string, string> | null;
-  readonly sources: ConceptSource[];
-  readonly notes: Record<string, string> | null;
-  readonly status: string | null;
-  readonly isComplete: boolean;
-  readonly isPartial: boolean;
-  readonly isCoordinate: boolean;
-  toJSON(): Record<string, unknown>;
-  static fromJSON(data: Record<string, unknown>): AbstractHyperedge;
-  static identityOf(value: unknown): string;
-}
-
-export class PartitiveHyperedge extends AbstractHyperedge {
-  /** @deprecated use {@link members} — kept for v1/v2 wire compat. */
-  readonly partitives: HyperedgeMember[];
-  static fromJSON(data: Record<string, unknown>): PartitiveHyperedge;
-  static identityOf(value: unknown): string;
-}
-
-export class GenericHyperedge extends AbstractHyperedge {
-  static fromJSON(data: Record<string, unknown>): GenericHyperedge;
-  static identityOf(value: unknown): string;
-}
-
-export type DefinitionType = 'intensional' | 'extensional' | 'partitive' | 'translated';
-export const DEFINITION_TYPE: Readonly<Record<string, DefinitionType>>;
-export const DEFAULT_DEFINITION_TYPE: DefinitionType;
-export const DEFINITION_TYPE_VALUES: readonly DefinitionType[];
-
-export const RELATION_TYPE_TO_CLASS: Readonly<Record<string, typeof AbstractHyperedge>>;
-export class RelationLoadError extends Error {
-  readonly path: string;
-  constructor(path: string, message: string);
-}
-export const RelationLoader: {
-  loadAll(relationsDir: string): Map<string, AbstractHyperedge[]>;
-  loadOne(path: string): AbstractHyperedge | null;
-};
-
-export const DESIGNATION_RELATIONSHIP_TYPES: readonly string[];
-export class DesignationRelationship extends GlossaristModel {
-  readonly type: string | null;
-  readonly content: string | null;
-  readonly target: string | null;
-  static fromJSON(data: Record<string, unknown>): DesignationRelationship;
-}
-
-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[];
-export class ConceptDate extends GlossaristModel {
-  readonly date: string | null;
-  readonly type: string | null;
-  readonly parsedDate: Date | null;
-}
-
-export class DetailedDefinition extends GlossaristModel {
-  readonly content: string;
-  readonly sources: ConceptSource[];
-  readonly examples: DetailedDefinition[];
-  walkTexts(path: string): Iterable<{ text: string; source: string }>;
-  static fromJSON(data: Record<string, unknown>): DetailedDefinition;
-}
-
-export class RegistrableModel extends GlossaristModel {
-  static register(type: string, cls: typeof RegistrableModel): void;
-  static fromData(data: Record<string, unknown>): RegistrableModel;
-}
-
-export class FigureImage extends GlossaristModel {
-  constructor(data?: Record<string, unknown>);
-  readonly src: string | null;
-  readonly format: string | null;
-  readonly role: string | null;
-  readonly width: number | null;
-  readonly height: number | null;
-  readonly scale: number | null;
-  static fromJSON(data: Record<string, unknown>): FigureImage;
-}
-
-export class NonVerbalEntity extends RegistrableModel {
-  constructor(data?: Record<string, unknown>);
-  readonly caption: Record<string, string> | null;
-  readonly description: Record<string, string> | null;
-  readonly alt: Record<string, string> | null;
-  readonly sources: ConceptSource[];
-  findById(targetId: string): NonVerbalEntity | null;
-  allIds(): string[];
-  static fromJSON(data: Record<string, unknown>): NonVerbalEntity;
-}
-
-export class SharedNonVerbalEntity extends NonVerbalEntity {
-  constructor(data?: Record<string, unknown>);
-  readonly id: string | null;
-  readonly identifier: string | null;
-  findById(targetId: string): SharedNonVerbalEntity | null;
-  allIds(): string[];
-  static fromJSON(data: Record<string, unknown>): SharedNonVerbalEntity;
-}
-
-export class Figure extends SharedNonVerbalEntity {
-  constructor(data?: Record<string, unknown>);
-  readonly images: FigureImage[];
-  readonly subfigures: Figure[];
-  findById(targetId: string): Figure | null;
-  allIds(): string[];
-  static fromJSON(data: Record<string, unknown>): Figure;
-}
-
-export class Table extends SharedNonVerbalEntity {
-  constructor(data?: Record<string, unknown>);
-  readonly content: Record<string, unknown> | null;
-  readonly format: string | null;
-  static fromJSON(data: Record<string, unknown>): Table;
-}
-
-export class Formula extends SharedNonVerbalEntity {
-  constructor(data?: Record<string, unknown>);
-  readonly expression: Record<string, string> | null;
-  readonly notation: string | null;
-  static fromJSON(data: Record<string, unknown>): Formula;
-}
-
-export const NON_VERBAL_TYPES: readonly string[];
-
-export class NonVerbRep extends NonVerbalEntity {
-  readonly type: string | null;
-  readonly images: FigureImage[];
-  static fromJSON(data: Record<string, unknown>): NonVerbRep;
-}
-
-export class NonVerbalReference extends RegistrableModel {
-  constructor(data?: Record<string, unknown>);
-  readonly entityId: string | null;
-  readonly display: string | null;
-  readonly dedupKey: readonly [string, string | null];
-  static fromJSON(data: Record<string, unknown> | string): NonVerbalReference;
-  static register(type: string, cls: typeof NonVerbalReference): void;
-}
-
-export class FigureReference extends NonVerbalReference {
-  static fromJSON(data: Record<string, unknown> | string): FigureReference;
-}
-
-export class TableReference extends NonVerbalReference {
-  static fromJSON(data: Record<string, unknown> | string): TableReference;
-}
-
-export class FormulaReference extends NonVerbalReference {
-  static fromJSON(data: Record<string, unknown> | string): FormulaReference;
-}
-
-export class BibliographyEntry extends GlossaristModel {
-  constructor(data?: Record<string, unknown>);
-  readonly id: string | null;
-  readonly reference: string | null;
-  readonly title: string | null;
-  readonly link: string | null;
-  readonly type: string | null;
-  static fromJSON(data: Record<string, unknown>): BibliographyEntry;
-}
-
-export class BibliographyData extends GlossaristModel {
-  constructor(data?: Record<string, unknown>);
-  readonly entries: BibliographyEntry[];
-  find(id: string): BibliographyEntry | null;
-  readonly keys: string[];
-  toYAML(): string;
-  toJSON(): { bibliography: BibliographyEntry[] };
-  static fromYAML(yamlString: string): BibliographyData;
-  static fromJSON(data: Record<string, unknown>): BibliographyData;
-}
-
-export function fetchLocalizedString(
-  hash: Record<string, string> | null,
-  lang: string,
-  fallback?: string | null,
-): string | null;
-
-export function localizedStringIsEmpty(hash: Record<string, string> | null): boolean;
-
-export function localizedStringIsPresent(hash: Record<string, string> | null): boolean;
-
-export class GcrStatistics extends GlossaristModel {
-  readonly totalConcepts: number;
-  readonly conceptsWithDefinitions: number;
-  readonly conceptsByStatus: Record<string, number>;
-  readonly total_concepts: number;
-  readonly concepts_with_definitions: number;
-  readonly concepts_by_status: Record<string, number>;
-  static fromConcepts(concepts: Concept[]): GcrStatistics;
-  static fromJSON(data: Record<string, unknown>): GcrStatistics;
-}
-
-export class GcrMetadata extends GlossaristModel {
-  readonly shortname: string | null;
-  readonly version: string | null;
-  readonly title: string | null;
-  readonly description: string | null;
-  readonly owner: string | null;
-  readonly tags: string[];
-  readonly conceptCount: number;
-  readonly languages: string[];
-  readonly createdAt: string | null;
-  readonly glossaristVersion: string | null;
-  readonly schemaVersion: string;
-  readonly homepage: string | null;
-  readonly repository: string | null;
-  readonly license: string | null;
-  readonly uriPrefix: string | null;
-  readonly conceptUriTemplate: string | null;
-  readonly compiledFormats: string[];
-  readonly statistics: GcrStatistics | null;
-  readonly concept_count: number;
-  readonly created_at: string | null;
-  readonly glossarist_version: string | null;
-  readonly schema_version: string;
-  readonly compiled_formats: string[];
-  static fromYaml(yamlString: string): GcrMetadata;
-  static fromJSON(data: Record<string, unknown>): GcrMetadata;
-}

package/src/models/locality.ts

@@ -1,34 +0,0 @@
-import { GlossaristModel } from './base.js';
-
-export interface LocalityJson {
-  type?: string | null;
-  reference_from?: string | null;
-  referenceFrom?: string | null;
-  reference_to?: string | null;
-  referenceTo?: string | null;
-}
-
-export class Locality extends GlossaristModel {
-  readonly type: string | null;
-  readonly referenceFrom: string | null;
-  readonly referenceTo: string | null;
-
-  constructor(data: LocalityJson = {}) {
-    super();
-    this.type = data.type ?? null;
-    this.referenceFrom = data.reference_from ?? data.referenceFrom ?? null;
-    this.referenceTo = data.reference_to ?? data.referenceTo ?? null;
-  }
-
-  override toJSON(): LocalityJson {
-    const obj: LocalityJson = {};
-    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 override fromJSON(data: LocalityJson): Locality {
-    return new Locality(data);
-  }
-}