@eightyfourthousand/data-access 2026.3.0

package/src/lib/types/passage.ts

@@ -0,0 +1,220 @@
+import { Alignment, AlignmentDTO, alignmentsFromDTO } from './alignment';
+import {
+  Annotations,
+  AnnotationsDTO,
+  annotationsFromDTO,
+  annotationsToDTO,
+} from './annotation';
+import { TohokuCatalogEntry } from './toh';
+
+export const BODY_ITEM_TYPES = [
+  'abbreviations',
+  'abbreviationsHeader',
+  'acknowledgment',
+  'acknowledgmentHeader',
+  'appendix',
+  'appendixHeader',
+  'colophon',
+  'colophonHeader',
+  'endnotes',
+  'endnotesHeader',
+  'homage',
+  'homageHeader',
+  'introduction',
+  'introductionHeader',
+  'prelude',
+  'preludeHeader',
+  'prologue',
+  'prologueHeader',
+  'summary',
+  'summaryHeader',
+  'translation',
+  'translationHeader',
+];
+
+export type BodyItemType = (typeof BODY_ITEM_TYPES)[number] | 'unknown';
+
+export const FRONT_MATTER: BodyItemType[] = [
+  'acknowledgment',
+  'summary',
+  'introduction',
+];
+export const FRONT_MATTER_FILTER = `(${FRONT_MATTER.join('|')})`;
+export const BODY_MATTER: BodyItemType[] = [
+  'prelude',
+  'prologue',
+  'translation',
+  'appendix',
+  'colophon',
+  'homage',
+];
+export const BODY_MATTER_FILTER = `(${BODY_MATTER.join('|')})`;
+export const BACK_MATTER: BodyItemType[] = ['abbreviations', 'endnotes'];
+export const BACK_MATTER_FILTER = `(${BACK_MATTER.join('|')})`;
+export const COMPARE_MODE = BODY_MATTER;
+export const COMPARE_MODE_FILTER = `(${COMPARE_MODE.join('|')})`;
+
+export const PANEL_FILTERS = [
+  FRONT_MATTER_FILTER,
+  BODY_MATTER_FILTER,
+  BACK_MATTER_FILTER,
+  COMPARE_MODE_FILTER,
+] as const;
+
+export type PanelFilter = (typeof PANEL_FILTERS)[number];
+
+export type Passage = {
+  alignments?: Alignment[];
+  annotations: Annotations;
+  content: string;
+  label: string;
+  sort: number;
+  type: BodyItemType;
+  uuid: string;
+  workUuid: string;
+  xmlId?: string;
+  parent?: string;
+  toh?: TohokuCatalogEntry;
+  references?: Passages;
+};
+
+export type Passages = Passage[];
+
+export type PassageRowDTO = {
+  content: string;
+  label: string;
+  sort: number;
+  type: BodyItemType;
+  uuid: string;
+  work_uuid: string;
+  xmlId?: string;
+  parent?: string;
+  toh?: TohokuCatalogEntry;
+};
+
+export type PassageDTO = PassageRowDTO & {
+  alignments?: AlignmentDTO[];
+  annotations?: AnnotationsDTO | null;
+};
+
+export type PaginationDirection = 'forward' | 'backward';
+
+export type PassagesPageDTO = {
+  passages: PassageDTO[];
+  nextCursor?: string;
+  hasMore: boolean;
+};
+
+export type PassagesPageAroundDTO = {
+  passages: PassageDTO[];
+  prevCursor?: string;
+  nextCursor?: string;
+  hasMoreBefore: boolean;
+  hasMoreAfter: boolean;
+};
+
+export type PassagesPage = {
+  passages: Passage[];
+  prevCursor?: string;
+  nextCursor?: string;
+  hasMoreAfter: boolean;
+  hasMoreBefore: boolean;
+};
+
+export const passageFromDTO = (
+  dto: PassageDTO,
+  annotations: Annotations = [],
+  alignments: Alignment[] = [],
+): Passage => {
+  return {
+    content: dto.content,
+    label: dto.label,
+    sort: dto.sort,
+    type: dto.type,
+    uuid: dto.uuid,
+    workUuid: dto.work_uuid,
+    xmlId: dto.xmlId,
+    parent: dto.parent,
+    toh: dto.toh,
+    alignments,
+    annotations,
+  };
+};
+
+export const passagesFromDTO = (dto: PassageDTO[]): Passage[] => {
+  return dto.map((p) =>
+    passageFromDTO(
+      p,
+      annotationsFromDTO(p.annotations || [], p.content.length),
+      alignmentsFromDTO(p.alignments || []),
+    ),
+  );
+};
+
+export const passageToRowDTO = (passage: Passage): PassageRowDTO => {
+  const dto: PassageRowDTO = {
+    content: passage.content,
+    label: passage.label,
+    sort: passage.sort,
+    type: passage.type,
+    uuid: passage.uuid,
+    work_uuid: passage.workUuid,
+  };
+
+  // NOTE: only include xmlId and parent if they exist, otherwise an upsert
+  // will set them to null in the database.
+  if (passage.xmlId) {
+    dto.xmlId = passage.xmlId;
+  }
+
+  if (passage.parent) {
+    dto.parent = passage.parent;
+  }
+
+  if (passage.toh) {
+    dto.toh = passage.toh;
+  }
+
+  return dto;
+};
+
+export const passageToDTO = (passage: Passage): PassageDTO => {
+  // NOTE: ignore alignments
+  return {
+    ...passageToRowDTO(passage),
+    annotations: annotationsToDTO(passage.annotations) || [],
+  };
+};
+
+export const passagesToDTO = (passages: Passage[]): PassageDTO[] => {
+  return passages.map(passageToDTO);
+};
+
+export const passagesToRowDTO = (passages: Passage[]): PassageRowDTO[] => {
+  return passages.map(passageToRowDTO);
+};
+
+export const passagesPageFromDTO = (
+  direction: PaginationDirection,
+  dto: PassagesPageDTO,
+): PassagesPage => {
+  return {
+    passages: passagesFromDTO(dto.passages),
+    nextCursor: direction === 'forward' ? dto.nextCursor : undefined,
+    prevCursor: direction === 'backward' ? dto.nextCursor : undefined,
+    hasMoreAfter: direction === 'forward' && dto.hasMore,
+    hasMoreBefore: direction === 'backward' && dto.hasMore,
+  };
+};
+
+export const passagesPageAroundFromDTO = (
+  dto: PassagesPageAroundDTO,
+): PassagesPage => {
+  return {
+    passages: passagesFromDTO(dto.passages),
+    nextCursor: dto.nextCursor,
+    prevCursor: dto.prevCursor,
+    hasMoreAfter: dto.hasMoreAfter,
+    hasMoreBefore: dto.hasMoreBefore,
+  };
+};

package/src/lib/types/project.ts

@@ -0,0 +1,200 @@
+import { SemVer } from './semver';
+
+export const PROJECT_STAGE_LABELS = [
+  '1',
+  '1.a',
+  '2',
+  '2.a',
+  '2.b',
+  '2.c',
+  '2.d',
+  '2.e',
+  '2.f',
+  '2.g',
+  '2.h',
+  '3',
+  '4',
+  '0',
+];
+
+export const STAGE_DESCRIPTIONS: Record<ProjectStageLabel, string> = {
+  '1': 'Published and in app',
+  '1.a': 'Published',
+  '2': 'Marked up and awaiting final proofing',
+  '2.a': 'Markup in progress',
+  '2.b': 'Awaiting markup',
+  '2.c': "Awaiting editor's OK form markup",
+  '2.d': 'Copy editing complete',
+  '2.e': 'Copy editing in progress',
+  '2.f': 'Review complete',
+  '2.g': 'In editorial review',
+  '2.h': 'Awaiting editorial review',
+  '3': 'In translation',
+  '4': 'Application pending',
+  '0': 'Not started',
+};
+
+export const STAGE_COLORS: Record<ProjectStageLabel, string> = {
+  '1': 'emerald',
+  '1.a': 'emerald',
+  '2': 'ochre',
+  '2.a': 'ochre',
+  '2.b': 'ochre',
+  '2.c': 'ochre',
+  '2.d': 'ochre',
+  '2.e': 'ochre',
+  '2.f': 'ochre',
+  '2.g': 'ochre',
+  '2.h': 'ochre',
+  '3': 'navy',
+  '4': 'brick',
+  '0': 'muted text-muted-foreground',
+};
+
+export const CANON_TYPES = ['kangyur', 'tengyur'];
+
+export type ProjectStageLabel = (typeof PROJECT_STAGE_LABELS)[number];
+
+export type CanonType = (typeof CANON_TYPES)[number];
+
+export type ProjectStage = {
+  label: ProjectStageLabel;
+  description: string;
+  date: Date;
+  targetDate?: Date;
+  color: string;
+};
+
+export type ProjectViewDTO = {
+  uuid: string;
+  toh: string;
+  title: string;
+  translator: string;
+  stage: ProjectStageLabel;
+  stage_date: string;
+  pages: number;
+  type?: string;
+};
+
+export type ProjectTableDTO = {
+  uuid: string;
+  notes: string;
+  contractDate: string;
+  contractId: string;
+  workUuid: string;
+  pages: number;
+  publicationDate: string;
+  version: string;
+  stage: ProjectStageLabel;
+  restriction: boolean;
+  title: string;
+  toh: string;
+  mainTranslator: string;
+  translationGroup: string;
+};
+
+export type Project = {
+  uuid: string;
+  toh: string;
+  title: string;
+  translator?: string;
+  translationGroup?: string;
+  stage: ProjectStage;
+  pages: number;
+  notes?: string;
+  contractDate?: Date;
+  contractId?: string;
+  workUuid?: string;
+  version?: SemVer;
+  canons?: string;
+};
+
+export type ProjectStageDetailsDTO = {
+  uuid: string;
+  stage: ProjectStageLabel;
+  stageDate: string;
+  targetDate?: string;
+};
+
+export type ProjectStageDetail = {
+  uuid: string;
+  stage: ProjectStage;
+  targetDate?: Date;
+};
+
+export type ProjectStageDetails = ProjectStageDetail[];
+
+export type ProjectAssetDTO = {
+  uuid: string;
+  projectUuid: string;
+  stageUuid?: string;
+  filename: string;
+  url: string;
+  note?: string;
+};
+
+export type ProjectAsset = ProjectAssetDTO;
+
+export function projectStageDetailFromDTO(
+  dto: ProjectStageDetailsDTO,
+): ProjectStageDetail {
+  return {
+    uuid: dto.uuid,
+    stage: {
+      label: dto.stage,
+      description: STAGE_DESCRIPTIONS[dto.stage] || '',
+      date: new Date(dto.stageDate),
+      targetDate: dto.targetDate ? new Date(dto.targetDate) : undefined,
+      color: STAGE_COLORS[dto.stage] || 'grey',
+    },
+  };
+}
+
+export function projectStageDetailsFromDTO(
+  dto?: ProjectStageDetailsDTO[],
+): ProjectStageDetails {
+  return dto?.map(projectStageDetailFromDTO) || [];
+}
+
+export function projectFromViewDTO(dto: ProjectViewDTO): Project {
+  return {
+    uuid: dto.uuid,
+    toh: dto.toh,
+    title: dto.title,
+    translator: dto.translator,
+    stage: {
+      label: dto.stage,
+      description: STAGE_DESCRIPTIONS[dto.stage] || '',
+      date: new Date(dto.stage_date),
+      color: STAGE_COLORS[dto.stage] || 'grey',
+    },
+    pages: dto.pages,
+    canons: dto.type,
+  };
+}
+
+export function projectFromTableDTO(dto: ProjectTableDTO): Project {
+  const stage = dto.stage;
+  const contractDate = dto.contractDate
+    ? new Date(dto.contractDate)
+    : undefined;
+  return {
+    uuid: dto.uuid,
+    toh: dto.toh,
+    title: dto.title,
+    stage: {
+      label: stage,
+      description: STAGE_DESCRIPTIONS[stage] || '',
+      date: new Date(dto.publicationDate),
+      color: STAGE_COLORS[stage] || 'grey',
+    },
+    pages: dto.pages,
+    notes: dto.notes,
+    contractId: dto.contractId,
+    contractDate,
+    workUuid: dto.workUuid,
+    version: dto.version as SemVer,
+    translator: dto.mainTranslator,
+    translationGroup: dto.translationGroup,
+  };
+}

package/src/lib/types/semver.ts

@@ -0,0 +1 @@
+export type SemVer = `${number}.${number}.${number}`;

package/src/lib/types/title.ts

@@ -0,0 +1,47 @@
+import { ExtendedTranslationLanguage } from './language';
+
+export const TITLE_TYPES = [
+  'toh',
+  'mainTitle',
+  'mainTitleOutsideCatalogueSection',
+  'longTitle',
+  'otherTitle',
+  'shortcode',
+] as const;
+
+export const BO_TITLE_PREFIX = '༄༅།\u00a0\u00a0།' as const;
+
+export type TitleType = (typeof TITLE_TYPES)[number];
+
+export type TitleTypeDTO = `eft:${TitleType}`;
+
+export type Title = {
+  uuid: string;
+  title: string;
+  language: ExtendedTranslationLanguage;
+  type: TitleType;
+};
+
+export type Titles = Title[];
+
+export type TitleDTO = {
+  uuid: string;
+  title: string;
+  language: ExtendedTranslationLanguage;
+  type: TitleTypeDTO;
+};
+
+export type TitlesDTO = TitleDTO[];
+
+export const titleFromDTO = (dto: TitleDTO): Title => {
+  return {
+    uuid: dto.uuid,
+    title: dto.title,
+    language: dto.language,
+    type: (dto.type?.replace('eft:', '') as TitleType) || 'mainTitle',
+  };
+};
+
+export const titlesFromDTO = (dto?: TitlesDTO): Titles => {
+  return dto?.map(titleFromDTO) || [];
+};

package/src/lib/types/toh.ts

@@ -0,0 +1 @@
+export type TohokuCatalogEntry = `toh${number}`;

package/src/lib/types/translation.ts

@@ -0,0 +1,15 @@
+import { BibliographyEntries } from './bibliography';
+import { GlossaryTermInstances } from './glossary';
+import { BodyItemType, Passages } from './passage';
+import { Titles } from './title';
+import { Work } from './work';
+
+export type TranslationNodeClass = 'translation' | 'annotation';
+
+export type Translation = {
+  metadata: Work;
+  titles: Titles;
+  passages: Partial<Record<BodyItemType, Passages>>;
+  glossary: GlossaryTermInstances;
+  bibliography: BibliographyEntries;
+};

package/src/lib/types/user.ts

@@ -0,0 +1,15 @@
+export type UserRole = 'reader' | 'scholar' | 'translator' | 'editor' | 'admin';
+export type UserClaims = {
+  role: UserRole;
+};
+
+export const USER_PERMISIONS = [
+  'projects.read',
+  'projects.edit',
+  'projects.admin',
+  'editor.read',
+  'editor.edit',
+  'editor.admin',
+];
+
+export type UserPermission = (typeof USER_PERMISIONS)[number];

package/src/lib/types/work.ts

@@ -0,0 +1,38 @@
+import { TohokuCatalogEntry } from './toh';
+import { SemVer } from './semver';
+
+export type Work = {
+  uuid: string;
+  title: string;
+  description?: string;
+  toh: TohokuCatalogEntry[];
+  publicationDate?: Date;
+  publicationVersion: SemVer;
+  pages: number;
+  restriction: boolean;
+  section: string;
+};
+
+export type WorkDTO = {
+  uuid: string;
+  title?: string;
+  description?: string;
+  tohs: { toh: TohokuCatalogEntry }[];
+  publicationDate: string;
+  publicationVersion: string;
+  pages: number;
+  restriction: boolean;
+  breadcrumb?: string;
+};
+
+export const workFromDTO = (dto: WorkDTO) => ({
+  uuid: dto.uuid,
+  title: dto.title || '<Untitled>',
+  description: dto.description || '',
+  toh: dto.tohs.map((t) => t.toh) as TohokuCatalogEntry[],
+  publicationDate: dto.publicationDate ? new Date(dto.publicationDate) : undefined,
+  publicationVersion: (dto.publicationVersion || '0.0.0') as SemVer,
+  pages: dto.pages || 0,
+  restriction: dto.restriction,
+  section: dto.breadcrumb?.split('>').at(-2)?.trim() || '',
+});

package/src/lib/use-bookmark.ts

@@ -0,0 +1,45 @@
+'use client';
+
+import { useCallback, useSyncExternalStore } from 'react';
+import { addBookmark, isBookmarked, removeBookmark } from './local-storage';
+
+type BookmarkOptions = {
+  type: string;
+  subType?: string;
+  tab: string;
+};
+
+const listeners = new Set<() => void>();
+
+function subscribe(callback: () => void) {
+  listeners.add(callback);
+  return () => listeners.delete(callback);
+}
+
+function emitChange() {
+  listeners.forEach((l) => l());
+}
+
+export function useBookmark(uuid: string, options?: BookmarkOptions) {
+  const bookmarked = useSyncExternalStore(
+    subscribe,
+    () => isBookmarked(uuid),
+    () => false,
+  );
+
+  const toggle = useCallback(() => {
+    if (isBookmarked(uuid)) {
+      removeBookmark(uuid);
+    } else {
+      addBookmark({
+        uuid,
+        type: options?.type ?? '',
+        subType: options?.subType,
+        tab: options?.tab ?? '',
+      });
+    }
+    emitChange();
+  }, [uuid, options?.type, options?.subType, options?.tab]);
+
+  return { isBookmarked: bookmarked, toggle };
+}

package/src/ssr.ts

@@ -0,0 +1,5 @@
+export * from './lib/auth';
+export * from './lib/client-ssr';
+export * from './lib/feedback';
+export * from './lib/lookup-entity';
+export * from './lib/proxy';

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "allowJs": false,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "strict": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../tsconfig.base.json"
+}

package/tsconfig.lib.json

@@ -0,0 +1,26 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": [
+      "node",
+      "@nx/react/typings/cssmodule.d.ts",
+      "@nx/react/typings/image.d.ts",
+      "next",
+      "@nx/next/typings/image.d.ts"
+    ]
+  },
+  "exclude": [
+    "jest.config.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.js",
+    "src/**/*.test.js",
+    "src/**/*.spec.jsx",
+    "src/**/*.test.jsx"
+  ],
+  "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,22 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "moduleResolution": "node10",
+    "jsx": "react-jsx",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
+  ]
+}