@eightyfourthousand/data-access 2026.4.0 → 2026.4.2

package/src/lib/types/annotation/annotation.ts

@@ -1,244 +0,0 @@
-import { ExtendedTranslationLanguage } from '../language';
-import {
-  AnnotationBase,
-  AnnotationDTO,
-  annotationTypeFromDTO,
-  annotationTypeToDTO,
-} from './annotation-type';
-
-export type AbbreviationAnnotation = AnnotationBase & {
-  type: 'abbreviation';
-  abbreviation: string;
-};
-
-export type AudioAnnotation = AnnotationBase & {
-  type: 'audio';
-  src: string;
-  mediaType: string;
-};
-
-export type BlockquoteAnnotation = AnnotationBase & {
-  type: 'blockquote';
-};
-
-export type CodeAnnotation = AnnotationBase & {
-  type: 'code';
-};
-
-export type DeprecatedAnnotation = AnnotationBase & {
-  type: 'deprecated';
-};
-
-export type EndNoteLinkAnnotation = AnnotationBase & {
-  type: 'endNoteLink';
-  endNote: string;
-  label?: string;
-};
-
-export type GlossaryInstanceAnnotation = AnnotationBase & {
-  type: 'glossaryInstance';
-  glossary: string;
-  authority: string;
-};
-
-export type HasAbbreviationAnnotation = AnnotationBase & {
-  type: 'hasAbbreviation';
-  abbreviation: string;
-};
-
-export type HeadingClass =
-  | 'section-label'
-  | 'section-title'
-  | 'supplementary'
-  | 'table-label';
-
-export type HeadingAnnotation = AnnotationBase & {
-  type: 'heading';
-  level: number;
-  class?: HeadingClass;
-};
-
-export type ImageAnnotation = AnnotationBase & {
-  type: 'image';
-  src: string;
-};
-
-export type IndentAnnotation = AnnotationBase & {
-  type: 'indent';
-};
-
-export type InlineTitleAnnotation = AnnotationBase & {
-  type: 'inlineTitle';
-  lang: ExtendedTranslationLanguage;
-};
-
-export type InternalLinkAnnotation = AnnotationBase & {
-  type: 'internalLink';
-  linkType: string;
-  href?: string;
-  label?: string;
-  entity?: string;
-  isPending?: boolean;
-  isSameWork?: boolean;
-  subtype?: string;
-  linkToh?: string;
-};
-
-export type LeadingSpaceAnnotation = AnnotationBase & {
-  type: 'leadingSpace';
-};
-
-export type LineGroupAnnotation = AnnotationBase & {
-  type: 'lineGroup';
-};
-
-export type LineAnnotation = AnnotationBase & {
-  type: 'line';
-};
-
-export type LinkAnnotation = AnnotationBase & {
-  type: 'link';
-  href: string;
-  text: string;
-};
-
-export type ListItemAnnotation = AnnotationBase & {
-  type: 'listItem';
-};
-
-export type ListAnnotation = AnnotationBase & {
-  type: 'list';
-  spacing?: string;
-  nesting?: number;
-  itemStyle?: string;
-};
-
-export type MantraAnnotation = AnnotationBase & {
-  type: 'mantra';
-  lang: ExtendedTranslationLanguage;
-};
-
-export type MentionAnnotation = AnnotationBase & {
-  type: 'mention';
-  entity: string;
-  linkType: string;
-  text?: string;
-  displayText?: string;
-  isSameWork?: boolean;
-  subtype?: string;
-  linkToh?: string;
-};
-
-export type ParagraphAnnotation = AnnotationBase & {
-  type: 'paragraph';
-};
-
-export type QuoteAnnotation = AnnotationBase & {
-  type: 'quote';
-  quote?: string;
-};
-
-export type QuotedAnnotation = AnnotationBase & {
-  type: 'quoted';
-  quote?: string;
-};
-
-export type ReferenceAnnotation = AnnotationBase & {
-  type: 'reference';
-};
-
-export type SpanAnnotation = AnnotationBase & {
-  type: 'span';
-  textStyle?: string;
-  lang?: ExtendedTranslationLanguage;
-};
-
-export type TableAnnotation = AnnotationBase & {
-  type: 'table';
-};
-
-export type TableBodyDataAnnotation = AnnotationBase & {
-  type: 'tableBodyData';
-};
-
-export type TableBodyHeaderAnnotation = AnnotationBase & {
-  type: 'tableBodyHeader';
-};
-
-export type TableBodyRowAnnotation = AnnotationBase & {
-  type: 'tableBodyRow';
-};
-
-export type TrailerAnnotation = AnnotationBase & {
-  type: 'trailer';
-};
-
-export type UnknownAnnotation = AnnotationBase & {
-  type: 'unknown';
-};
-
-export type Annotation =
-  | AbbreviationAnnotation
-  | AudioAnnotation
-  | BlockquoteAnnotation
-  | CodeAnnotation
-  | DeprecatedAnnotation
-  | EndNoteLinkAnnotation
-  | GlossaryInstanceAnnotation
-  | HasAbbreviationAnnotation
-  | HeadingAnnotation
-  | ImageAnnotation
-  | IndentAnnotation
-  | InlineTitleAnnotation
-  | InternalLinkAnnotation
-  | LeadingSpaceAnnotation
-  | LineAnnotation
-  | LineGroupAnnotation
-  | LinkAnnotation
-  | ListAnnotation
-  | ListItemAnnotation
-  | MantraAnnotation
-  | MentionAnnotation
-  | ParagraphAnnotation
-  | QuoteAnnotation
-  | QuotedAnnotation
-  | ReferenceAnnotation
-  | SpanAnnotation
-  | TableAnnotation
-  | TableBodyDataAnnotation
-  | TableBodyHeaderAnnotation
-  | TableBodyRowAnnotation
-  | TrailerAnnotation
-  | UnknownAnnotation;
-
-export type Annotations = Annotation[];
-
-export type AnnotationTransformer = (dto: AnnotationDTO) => Annotation;
-
-export const baseAnnotationFromDTO = (dto: AnnotationDTO): AnnotationBase => {
-  const passageUuid = dto.passage_uuid || dto.passageUuid || '';
-
-  return {
-    uuid: dto.uuid,
-    start: dto.start,
-    end: dto.end,
-    type: annotationTypeFromDTO(dto.type),
-    toh: dto.toh,
-    passageUuid,
-    validated: true,
-  };
-};
-
-export type AnnotationExporter = (annotation: Annotation) => AnnotationDTO;
-
-export const baseAnnotationToDto = (
-  annotation: AnnotationBase,
-): AnnotationDTO => ({
-  end: annotation.end,
-  start: annotation.start,
-  type: annotationTypeToDTO(annotation.type),
-  uuid: annotation.uuid,
-  passage_uuid: annotation.passageUuid,
-  toh: annotation.toh,
-  content: [],
-});

package/src/lib/types/annotation/audio.ts

@@ -1,33 +0,0 @@
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type AudioAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-import { AnnotationDTO, AnnotationDTOContent } from './annotation-type';
-
-export const transformer: AnnotationTransformer = (dto): AudioAnnotation => {
-  const baseAnnotation = baseAnnotationFromDTO(dto);
-  const audio = baseAnnotation as AudioAnnotation;
-  dto.content.forEach((content) => {
-    if (content.src) {
-      audio.src = content.src as string;
-    }
-    if (content['media-type']) {
-      audio.mediaType = content['media-type'] as string;
-    }
-  });
-
-  return audio;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { src, mediaType } = annotation as AudioAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-  dto.content.push({
-    src,
-    'media-type': mediaType,
-  } as AnnotationDTOContent);
-  return dto;
-};

package/src/lib/types/annotation/blockquote.ts

@@ -1,18 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type BlockquoteAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): BlockquoteAnnotation => {
-  return baseAnnotationFromDTO(dto) as BlockquoteAnnotation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  return baseAnnotationToDto(annotation);
-};

package/src/lib/types/annotation/code.ts

@@ -1,16 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type CodeAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (dto): CodeAnnotation => {
-  return baseAnnotationFromDTO(dto) as CodeAnnotation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  return baseAnnotationToDto(annotation);
-};

package/src/lib/types/annotation/deprecated.ts

@@ -1,18 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type DeprecatedAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): DeprecatedAnnotation => {
-  return baseAnnotationFromDTO(dto) as DeprecatedAnnotation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  return baseAnnotationToDto(annotation);
-};

package/src/lib/types/annotation/end-note-link.ts

@@ -1,35 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type EndNoteLinkAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): EndNoteLinkAnnotation => {
-  const baseAnnotation = baseAnnotationFromDTO(dto);
-  const endNote = baseAnnotation as EndNoteLinkAnnotation;
-  dto.content.forEach((content) => {
-    if (content.uuid) {
-      endNote.endNote = content.uuid as string;
-    }
-
-    if (content.label) {
-      endNote.label = content.label as string;
-    }
-  });
-
-  return endNote;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { endNote: uuid } = annotation as EndNoteLinkAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-  dto.content.push({
-    uuid,
-  });
-  return dto;
-};

package/src/lib/types/annotation/glossary-instance.ts

@@ -1,34 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type GlossaryInstanceAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): GlossaryInstanceAnnotation => {
-  const baseAnnotation = baseAnnotationFromDTO(dto);
-  const glossaryInstance = baseAnnotation as GlossaryInstanceAnnotation;
-  dto.content.forEach((content) => {
-    if (content.uuid) {
-      glossaryInstance.glossary = content.uuid as string;
-    }
-
-    if (content.authority) {
-      glossaryInstance.authority = content.authority as string
-    }
-  });
-  return glossaryInstance;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { glossary: uuid } = annotation as GlossaryInstanceAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-  dto.content.push({
-    uuid,
-  });
-  return dto;
-};

package/src/lib/types/annotation/has-abbreviation.ts

@@ -1,30 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type HasAbbreviationAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): HasAbbreviationAnnotation => {
-  const baseAnnotation = baseAnnotationFromDTO(dto);
-  const hasAbbreviation = baseAnnotation as HasAbbreviationAnnotation;
-  dto.content.forEach((content) => {
-    if (content.uuid) {
-      hasAbbreviation.abbreviation = content.uuid as string;
-    }
-  });
-  return hasAbbreviation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { abbreviation: uuid } = annotation as HasAbbreviationAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-  dto.content.push({
-    uuid,
-  });
-  return dto;
-};

package/src/lib/types/annotation/heading.ts

@@ -1,37 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type HeadingAnnotation,
-  HeadingClass,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (dto): HeadingAnnotation => {
-  const heading = baseAnnotationFromDTO(dto) as HeadingAnnotation;
-  dto.content.forEach((content) => {
-    if (content['heading-level']) {
-      const headerStr = content['heading-level'] as string;
-      const levelStr = headerStr.replace('h', '');
-      const level = parseInt(levelStr, 10);
-      heading.level = level;
-    }
-
-    if (content['heading-type']) {
-      heading.class = content['heading-type'] as HeadingClass;
-    }
-  });
-
-  return heading;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { level, class: headingClass } = annotation as HeadingAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-  dto.content.push({
-    'heading-level': `h${level}`,
-    ...(headingClass ? { 'heading-type': headingClass } : {}),
-  });
-  return dto;
-};

package/src/lib/types/annotation/image.ts

@@ -1,29 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type ImageAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (dto): ImageAnnotation => {
-  const baseAnnotation = baseAnnotationFromDTO(dto);
-  const image = baseAnnotation as ImageAnnotation;
-  dto.content.forEach((content) => {
-    if (content.src) {
-      image.src = content.src as string;
-    }
-  });
-
-  return image;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { src } = annotation as ImageAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-  dto.content.push({
-    src,
-  });
-  return dto;
-};

package/src/lib/types/annotation/indent.ts

@@ -1,16 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type IndentAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (dto): IndentAnnotation => {
-  return baseAnnotationFromDTO(dto) as IndentAnnotation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  return baseAnnotationToDto(annotation);
-};

package/src/lib/types/annotation/inline-title.ts

@@ -1,34 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type InlineTitleAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-import { TranslationLanguage } from '../language';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): InlineTitleAnnotation => {
-  const inlineTitle = baseAnnotationFromDTO(dto) as InlineTitleAnnotation;
-  dto.content.forEach((content) => {
-    if (content.lang) {
-      inlineTitle.lang = content.lang as TranslationLanguage;
-    }
-  });
-
-  return inlineTitle;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { lang } = annotation as InlineTitleAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-
-  if (lang) {
-    dto.content.push({
-      lang,
-    });
-  }
-  return dto;
-};

package/src/lib/types/annotation/internal-link.ts

@@ -1,86 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type InternalLinkAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): InternalLinkAnnotation => {
-  const internalLink = baseAnnotationFromDTO(dto) as InternalLinkAnnotation;
-  dto.content.forEach((content) => {
-    if (content.href) {
-      internalLink.href = content.href as string;
-    }
-
-    if (content['link-type']) {
-      internalLink.isPending = true;
-    }
-
-    if (content.type) {
-      internalLink.linkType = content['type'] as string;
-    }
-
-    if (content.label) {
-      internalLink.label = content.label as string;
-    }
-
-    if (content.uuid) {
-      internalLink.entity = content.uuid as string;
-    }
-
-    if (content.same_work !== undefined) {
-      internalLink.isSameWork = !!content.same_work;
-    }
-
-    if (content.subtype) {
-      internalLink.subtype = content.subtype as string;
-    }
-
-    if (content.toh) {
-      internalLink.linkToh = content.toh as string;
-    }
-  });
-
-  return internalLink;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  const { entity, linkType, href, label, isPending } =
-    annotation as InternalLinkAnnotation;
-  const dto = baseAnnotationToDto(annotation);
-  dto.content = [
-    {
-      href,
-    },
-  ];
-
-  if (isPending) {
-    dto.content.push({
-      'link-type': 'pending',
-    });
-  }
-
-  if (label) {
-    dto.content.push({
-      label,
-    });
-  }
-
-  if (entity) {
-    dto.content.push({
-      uuid: entity,
-    });
-  }
-
-  if (linkType) {
-    dto.content.push({
-      type: linkType,
-    });
-  }
-
-  return dto;
-};

package/src/lib/types/annotation/leading-space.ts

@@ -1,18 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type LeadingSpaceAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): LeadingSpaceAnnotation => {
-  return baseAnnotationFromDTO(dto) as LeadingSpaceAnnotation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  return baseAnnotationToDto(annotation);
-};

package/src/lib/types/annotation/line-group.ts

@@ -1,18 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type LineGroupAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (
-  dto,
-): LineGroupAnnotation => {
-  return baseAnnotationFromDTO(dto) as LineGroupAnnotation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  return baseAnnotationToDto(annotation);
-};

package/src/lib/types/annotation/line.ts

@@ -1,16 +0,0 @@
-import type { AnnotationDTO } from './annotation-type';
-import {
-  type AnnotationExporter,
-  type AnnotationTransformer,
-  type LineAnnotation,
-  baseAnnotationFromDTO,
-  baseAnnotationToDto,
-} from './annotation';
-
-export const transformer: AnnotationTransformer = (dto): LineAnnotation => {
-  return baseAnnotationFromDTO(dto) as LineAnnotation;
-};
-
-export const exporter: AnnotationExporter = (annotation): AnnotationDTO => {
-  return baseAnnotationToDto(annotation);
-};