glossarist 0.4.49 → 0.4.51

package/src/rdf/index.d.ts

@@ -1,371 +0,0 @@
-// Type declarations for the public RDF layer.
-//
-// Mirrors the runtime exports of src/rdf/index.js. Quads use the RDF/JS
-// Quad interface from @rdfjs/dataset (compatible with n3's DataFactory
-// output). Dataset is the RDF/JS Dataset.Core interface.
-
-import type { Quad, Dataset, Term } from '@rdfjs/dataset';
-import type { Concept } from '../models/index';
-import type { LocalizedConcept } from '../models/index';
-import type { Designation } from '../models/index';
-import type { DetailedDefinition } from '../models/index';
-import type { ConceptSource } from '../models/index';
-import type { NonVerbRep, Figure, Table, Formula } from '../models/index';
-import type { PartitiveHyperedge, PartitiveHyperedge, PartitiveMember } from '../models/index';
-
-export { PRED, PREFIXES } from './predicates';
-export type PredicateMap = typeof PRED;
-export type PrefixMap = typeof PREFIXES;
-
-export type { Quad, Dataset, Term };
-
-export const SKOSXL: {
-  prefLabel: string;
-  altLabel: string;
-  hiddenLabel: string;
-  literalForm: string;
-};
-
-export const WELL_KNOWN: {
-  rdfType: string;
-  rdfValue: string;
-  skosConcept: string;
-  skosxlLabel: string;
-};
-
-export declare function deterministicId(...parts: Array<string | number | null | undefined>): string;
-export declare function deterministicBnode(subject: string, role: string, index: number): string;
-
-export interface ConceptUriOptions {
-  registerId: string;
-  uriBase?: string;
-}
-
-export declare function conceptUri(concept: Concept | { id?: string; termid?: string }, options: ConceptUriOptions): string;
-export declare function conceptToQuads(concept: Concept, options: ConceptUriOptions): Generator<Quad, void, unknown>;
-
-export interface LocalizedConceptEmitOptions {
-  parentUri: string;
-  language: string;
-}
-
-export declare function localizedConceptUri(parentUri: string, language: string): string;
-export declare function localizedConceptToQuads(localizedConcept: LocalizedConcept, options: LocalizedConceptEmitOptions): Generator<Quad, void, unknown>;
-
-export interface DesignationEmitOptions {
-  subjectUri: string;
-  language: string;
-  index: number;
-}
-
-export declare function designationToQuads(designation: Designation, options: DesignationEmitOptions): Generator<Quad, void, unknown>;
-export declare function skosLabelPredicate(designation: Designation): string;
-export declare function skosxlLabelPredicate(designation: Designation): string;
-
-export interface DetailedDefinitionEmitOptions {
-  subjectUri: string;
-  language?: string;
-  index: number;
-  role: 'hasDefinition' | 'hasNote' | 'hasExample' | 'hasAnnotation' | 'hasScopedExample';
-}
-
-export declare function detailedDefinitionToQuads(definition: DetailedDefinition, options: DetailedDefinitionEmitOptions): Generator<Quad, void, unknown>;
-
-export interface ConceptSourceEmitOptions {
-  subjectUri: string;
-  index: number;
-}
-
-export declare function conceptSourceToQuads(source: ConceptSource, options: ConceptSourceEmitOptions): Generator<Quad, void, unknown>;
-
-// ── Hyperedge emitter ─────────────────────────────────────────────────
-
-export interface HyperedgeEmitOptions {
-  parentUri: string;
-  index: number;
-}
-
-export declare function hyperedgeToQuads(
-  hyperedge: PartitiveHyperedge,
-  options: HyperedgeEmitOptions,
-): Generator<Quad, void, unknown>;
-
-export declare function hyperedgeSubjectUri(
-  parentUri: string,
-  hyperedge: PartitiveHyperedge,
-  index: number,
-): string;
-
-// ── PartitiveHyperedge emitter (v2) ────────────────────────────────────
-
-export interface PartitiveRelationEmitOptions {
-  parentUri: string;
-  index: number;
-}
-
-export declare function partitiveRelationToQuads(
-  relation: PartitiveHyperedge,
-  options: PartitiveRelationEmitOptions,
-): Generator<Quad, void, unknown>;
-
-export declare function partitiveRelationSubjectUri(
-  parentUri: string,
-  relation: PartitiveHyperedge,
-  index: number,
-): string;
-
-// ── PartitiveMember emitter (per-member multiplicity + is_delimiting) ──
-
-export interface PartitiveMemberEmitOptions {
-  memberUri: string;
-}
-
-export declare const MULTIPLICITY_NS: string;
-export declare const PRESENCE_NS: string;
-export declare const COUNT_NS: string;
-
-export declare function partitiveMemberToQuads(
-  member: PartitiveMember,
-  options: PartitiveMemberEmitOptions,
-): Generator<Quad, void, unknown>;
-
-// ── Non-verbal representation emitters ─────────────────────────────────
-
-export interface NonVerbalRepEmitOptions {
-  parentUri: string;
-  index: number;
-  language?: string | null;
-}
-
-export declare function nonVerbalRepToQuads(nvr: NonVerbRep, options: NonVerbalRepEmitOptions): Generator<Quad, void, unknown>;
-
-export interface NonVerbalEntityEmitOptions {
-  registerId: string;
-  uriBase?: string;
-}
-
-export type NonVerbalEntity = Figure | Table | Formula;
-
-export declare function nonVerbalEntityUri(entity: NonVerbalEntity, options: NonVerbalEntityEmitOptions): string;
-export declare function nonVerbalEntityToQuads(entity: NonVerbalEntity, options: NonVerbalEntityEmitOptions): Generator<Quad, void, unknown>;
-
-// Vocabulary emitter (SKOS ConceptSchemes for enumeration IRIs)
-export interface VocabTerm {
-  iri: string;
-  label: string;
-}
-export interface VocabScheme {
-  schemeIri: string;
-  label: string;
-  terms: readonly VocabTerm[];
-}
-
-// ── CURIE + bnode helpers ─────────────────────────────────────────────
-export declare const RDF_TYPE: string;
-export declare const RDF_VALUE: string;
-export declare const RDFS_LABEL: string;
-export declare function isAbsoluteIri(s: string): boolean;
-export declare function resolveIri(iri: string, prefixes?: Record<string, string>): string;
-export declare function compactIri(iri: string, prefixes?: Record<string, string>): string;
-export declare function deterministicBnodeId(...parts: Array<string | number | null | undefined>): string;
-
-// ── Sections builder (Quad[] → ClassInstance[] for UI) ────────────────
-export interface PropValue {
-  predicate: string;
-  values: string[];
-  nested?: boolean;
-}
-export interface ClassInstance {
-  classId: string;
-  classLabel: string;
-  label: string;
-  props: PropValue[];
-}
-export interface SectionsBuilderOptions {
-  language?: string;
-}
-export declare function quadSectionsToClassInstances(
-  quads: readonly Quad[],
-  options?: SectionsBuilderOptions,
-): ClassInstance[];
-
-// ── Provenance emitter (subject → prov:wasGeneratedBy + Activity) ─────
-export interface ProvenanceInput {
-  subjectUri: string;
-  serializer: string;
-  serializerVersion: string;
-  generatedAt: string;
-  canonicalUri?: string;
-}
-export declare function provenanceToQuads(input: ProvenanceInput): Generator<Quad, void, unknown>;
-
-export declare function vocabularySchemeToQuads(scheme: VocabScheme): Generator<Quad, void, unknown>;
-export declare function vocabularyToQuads(schemes: readonly VocabScheme[]): Generator<Quad, void, unknown>;
-
-// Dataset emitter (dcat:Dataset + skos:ConceptScheme per register)
-export interface DatasetDistribution {
-  id: string;
-  title: string;
-  mediaType: string;
-  downloadUrl: string;
-  byteSize?: number;
-}
-export interface DatasetSection {
-  collectionIri: string;
-  title: string;
-  memberUris: readonly string[];
-  parentCollectionIri?: string;
-  childCollectionIris?: readonly string[];
-}
-export interface DatasetEmitterInput {
-  datasetIri: string;
-  registerId: string;
-  title: string;
-  description?: string;
-  modified: string;
-  languages: readonly string[];
-  distributions: readonly DatasetDistribution[];
-  topConceptUris: readonly string[];
-  sections: readonly DatasetSection[];
-  sourceRepoUrl?: string;
-  publisherIri?: string;
-  contactIri?: string;
-}
-export declare function datasetToQuads(input: DatasetEmitterInput): Generator<Quad, void, unknown>;
-
-// Group emitter (dcat:DatasetSeries or dcat:Catalog)
-export type DatasetGroupKind = 'lineage' | 'topic' | 'family' | 'collection' | 'default';
-export interface GroupEmitInput {
-  groupId: string;
-  groupIri: string;
-  kind: DatasetGroupKind;
-  title: string;
-  description?: string;
-  memberIris: readonly string[];
-  currentMemberIri?: string;
-  subject?: string;
-  themes?: readonly string[];
-  keywords?: readonly string[];
-  publisher?: string;
-  contact?: string;
-  sourceRepo?: string;
-}
-export declare function groupToQuads(input: GroupEmitInput): Generator<Quad, void, unknown>;
-
-// Bibliography emitter (dcterms:BibliographicResource)
-export interface BibliographyEntry {
-  id: string;
-  reference: string;
-  title?: string;
-  link?: string;
-  type?: string;
-}
-export interface BibliographyInput {
-  registerId: string;
-  entries: readonly BibliographyEntry[];
-  baseUri?: string;
-}
-export declare function bibliographyEntryIri(registerId: string, entryId: string, baseUri?: string): string;
-export declare function bibliographyToQuads(input: BibliographyInput): Generator<Quad, void, unknown>;
-export declare function normalizeBibliographyData(raw: unknown): BibliographyEntry[];
-
-// Build activity emitter (prov:Activity per build run)
-export interface BuildActivityInput {
-  runId: string;
-  startedAt: string;
-  endedAt: string;
-  gitSha?: string;
-  gitBranch?: string;
-  toolId: string;
-  toolVersion: string;
-  datasetRegisters: readonly string[];
-  conceptCount: number;
-  associatedAgentIri?: string;
-  baseUri?: string;
-}
-export declare function buildActivityIri(input: Pick<BuildActivityInput, 'runId'>): string;
-export declare function buildActivityToQuads(input: BuildActivityInput): Generator<Quad, void, unknown>;
-
-// Agents emitter (foaf:Person / prov:Organization)
-export interface Contributor {
-  name: string;
-  role?: string;
-  organization?: string;
-  url?: string;
-  email?: string;
-}
-export interface AgentInput extends Contributor {
-  slug: string;
-  agentIri: string;
-}
-export declare function slugify(input: string): string;
-export declare function agentsFromContributors(contributors: readonly Contributor[], agentBase?: string): AgentInput[];
-export declare function agentsToQuads(agents: readonly AgentInput[], options?: { orgBase?: string }): Generator<Quad, void, unknown>;
-
-// Version emitter (prov:Entity version chain)
-export interface DatasetVersionInput {
-  registerId: string;
-  version: string;
-  versionIri: string;
-  datasetIri: string;
-  generatedAt: string;
-  previousVersionIri?: string;
-  changeSummary?: string;
-  associatedAgentIri?: string;
-}
-export interface VersionHistoryEntry {
-  version: string;
-  generatedAt: string;
-  changeSummary?: string;
-}
-export interface VersionEmitAllInput {
-  registerId: string;
-  datasetIri: string;
-  versions: readonly VersionHistoryEntry[];
-  associatedAgentIri?: string;
-}
-export declare function versionToQuads(input: DatasetVersionInput): Generator<Quad, void, unknown>;
-export declare function versionHistoryToQuads(input: VersionEmitAllInput): Generator<Quad, void, unknown>;
-
-// Image variant emitter (foaf:Image per format/language variant)
-export type ImageFormat = 'svg' | 'png' | 'webp' | 'jpg' | 'gif';
-export interface ImageVariantInput {
-  registerId: string;
-  figureId: string;
-  lang?: string;
-  format: ImageFormat;
-  byteSize?: number;
-  downloadUrl: string;
-}
-export declare function imageVariantIri(input: ImageVariantInput, baseUri?: string): string;
-export declare function imageVariantToQuads(input: ImageVariantInput, baseUri?: string): Generator<Quad, void, unknown>;
-
-export declare function collectQuads(quadsIterable: Iterable<Quad>): Quad[];
-
-export interface WriteTurtleOptions {
-  prefixes?: Record<string, string>;
-}
-
-export declare function writeTurtle(quads: Iterable<Quad>, options?: WriteTurtleOptions): Promise<string>;
-export declare function writeTurtleSync(quads: Iterable<Quad>, options?: WriteTurtleOptions): string;
-export declare function writeNTriples(quads: Iterable<Quad>): Promise<string>;
-
-export interface WriteJsonldOptions {
-  context?: Record<string, string>;
-}
-
-export declare function writeJsonld(quads: Iterable<Quad>, options?: WriteJsonldOptions): Promise<string>;
-export declare function sortQuads(quads: Iterable<Quad>): Quad[];
-
-export interface ValidationReport {
-  conforms: boolean;
-  results: ReadonlyArray<{
-    focusNode?: Term;
-    shape?: Term;
-    path?: Term;
-    message: Term[];
-  }>;
-}
-
-// SHACL validator moved to ./shacl-entry subpath. Importing from
-// 'glossarist/rdf/shacl' in Node-only; 'glossarist/rdf' is browser-safe.