forked from akai/readest
76b239f382
Add bidirectional annotation/highlight sync between KOReader and Readest: - Add xpointer0/xpointer1 fields to BookNote and DBBookNote types for KOReader XPointer positions alongside Readest's CFI format - Extend transform layer to pass through xpointer fields to/from DB - Convert CFI→XPointer on push and XPointer→CFI on pull in useNotesSync, discarding notes that fail conversion - Support KOReader's text()[K].N indexed text node format in xcfi.ts for paragraphs with inline elements (e.g. <a> page anchors) - Generate KOReader-compatible XPointers: text().N for single text nodes, text()[K].N only when multiple direct text nodes exist - Skip cfi-inert elements (injected by Readest at runtime) in XPointer path building and resolution - Map highlight colors between KOReader and Readest color systems - Implement KOReader plugin annotation push/pull with deterministic IDs, auto-sync on document open/close, and UIManager refresh on pull - Refactor koplugin into focused modules: syncauth, syncconfig, syncannotations, selfupdate Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
220 lines
4.8 KiB
TypeScript
220 lines
4.8 KiB
TypeScript
import {
|
|
Book,
|
|
BookConfig,
|
|
BookFormat,
|
|
BookNote,
|
|
BookNoteType,
|
|
HighlightColor,
|
|
HighlightStyle,
|
|
ReadingStatus,
|
|
} from '@/types/book';
|
|
import { DBBookConfig, DBBook, DBBookNote } from '@/types/records';
|
|
import { sanitizeString } from './sanitize';
|
|
|
|
export const transformBookConfigToDB = (bookConfig: unknown, userId: string): DBBookConfig => {
|
|
const {
|
|
bookHash,
|
|
metaHash,
|
|
progress,
|
|
location,
|
|
xpointer,
|
|
searchConfig,
|
|
viewSettings,
|
|
updatedAt,
|
|
} = bookConfig as BookConfig;
|
|
|
|
return {
|
|
user_id: userId,
|
|
book_hash: bookHash!,
|
|
meta_hash: metaHash,
|
|
location: location,
|
|
xpointer: xpointer,
|
|
progress: progress && JSON.stringify(progress),
|
|
search_config: searchConfig && JSON.stringify(searchConfig),
|
|
view_settings: viewSettings && JSON.stringify(viewSettings),
|
|
updated_at: new Date(updatedAt ?? Date.now()).toISOString(),
|
|
};
|
|
};
|
|
|
|
export const transformBookConfigFromDB = (dbBookConfig: DBBookConfig): BookConfig => {
|
|
const {
|
|
book_hash,
|
|
meta_hash,
|
|
progress,
|
|
location,
|
|
xpointer,
|
|
search_config,
|
|
view_settings,
|
|
updated_at,
|
|
} = dbBookConfig;
|
|
return {
|
|
bookHash: book_hash,
|
|
metaHash: meta_hash,
|
|
location,
|
|
xpointer,
|
|
progress: progress && JSON.parse(progress),
|
|
searchConfig: search_config && JSON.parse(search_config),
|
|
viewSettings: view_settings && JSON.parse(view_settings),
|
|
updatedAt: new Date(updated_at!).getTime(),
|
|
} as BookConfig;
|
|
};
|
|
|
|
export const transformBookToDB = (book: unknown, userId: string): DBBook => {
|
|
const {
|
|
hash,
|
|
metaHash,
|
|
format,
|
|
title,
|
|
sourceTitle,
|
|
author,
|
|
groupId,
|
|
groupName,
|
|
tags,
|
|
progress,
|
|
readingStatus,
|
|
metadata,
|
|
createdAt,
|
|
updatedAt,
|
|
deletedAt,
|
|
uploadedAt,
|
|
} = book as Book;
|
|
|
|
return {
|
|
user_id: userId,
|
|
book_hash: hash,
|
|
meta_hash: metaHash,
|
|
format,
|
|
title: sanitizeString(title)!,
|
|
author: sanitizeString(author)!,
|
|
group_id: groupId,
|
|
group_name: sanitizeString(groupName),
|
|
tags: tags,
|
|
progress: progress,
|
|
reading_status: readingStatus,
|
|
source_title: sanitizeString(sourceTitle),
|
|
metadata: metadata ? sanitizeString(JSON.stringify(metadata)) : null,
|
|
created_at: new Date(createdAt ?? Date.now()).toISOString(),
|
|
updated_at: new Date(updatedAt ?? Date.now()).toISOString(),
|
|
deleted_at: deletedAt ? new Date(deletedAt).toISOString() : null,
|
|
uploaded_at: uploadedAt ? new Date(uploadedAt).toISOString() : null,
|
|
};
|
|
};
|
|
|
|
export const transformBookFromDB = (dbBook: DBBook): Book => {
|
|
const {
|
|
book_hash,
|
|
meta_hash,
|
|
format,
|
|
title,
|
|
author,
|
|
group_id,
|
|
group_name,
|
|
tags,
|
|
progress,
|
|
reading_status,
|
|
source_title,
|
|
metadata,
|
|
created_at,
|
|
updated_at,
|
|
deleted_at,
|
|
uploaded_at,
|
|
} = dbBook;
|
|
|
|
return {
|
|
hash: book_hash,
|
|
metaHash: meta_hash,
|
|
format: format as BookFormat,
|
|
title,
|
|
author,
|
|
groupId: group_id,
|
|
groupName: group_name,
|
|
tags: tags,
|
|
progress: progress,
|
|
readingStatus: reading_status as ReadingStatus,
|
|
sourceTitle: source_title,
|
|
metadata: metadata ? JSON.parse(metadata) : null,
|
|
createdAt: new Date(created_at!).getTime(),
|
|
updatedAt: new Date(updated_at!).getTime(),
|
|
deletedAt: deleted_at ? new Date(deleted_at).getTime() : null,
|
|
uploadedAt: uploaded_at ? new Date(uploaded_at).getTime() : null,
|
|
};
|
|
};
|
|
|
|
export const transformBookNoteToDB = (bookNote: unknown, userId: string): DBBookNote => {
|
|
const {
|
|
bookHash,
|
|
metaHash,
|
|
id,
|
|
type,
|
|
cfi,
|
|
xpointer0,
|
|
xpointer1,
|
|
page,
|
|
text,
|
|
style,
|
|
color,
|
|
note,
|
|
createdAt,
|
|
updatedAt,
|
|
deletedAt,
|
|
} = bookNote as BookNote;
|
|
|
|
return {
|
|
user_id: userId,
|
|
book_hash: bookHash!,
|
|
meta_hash: metaHash,
|
|
id,
|
|
type,
|
|
cfi,
|
|
xpointer0,
|
|
xpointer1,
|
|
page,
|
|
text: sanitizeString(text),
|
|
style,
|
|
color,
|
|
note,
|
|
created_at: new Date(createdAt ?? Date.now()).toISOString(),
|
|
updated_at: new Date(updatedAt ?? Date.now()).toISOString(),
|
|
// note that only null deleted_at is updated to the database, undefined is not
|
|
deleted_at: deletedAt ? new Date(deletedAt).toISOString() : null,
|
|
};
|
|
};
|
|
|
|
export const transformBookNoteFromDB = (dbBookNote: DBBookNote): BookNote => {
|
|
const {
|
|
book_hash,
|
|
meta_hash,
|
|
id,
|
|
type,
|
|
cfi,
|
|
xpointer0,
|
|
xpointer1,
|
|
page,
|
|
text,
|
|
style,
|
|
color,
|
|
note,
|
|
created_at,
|
|
updated_at,
|
|
deleted_at,
|
|
} = dbBookNote;
|
|
|
|
return {
|
|
bookHash: book_hash,
|
|
metaHash: meta_hash,
|
|
id,
|
|
type: type as BookNoteType,
|
|
cfi: cfi ?? '',
|
|
xpointer0,
|
|
xpointer1,
|
|
page,
|
|
text,
|
|
style: style as HighlightStyle,
|
|
color: color as HighlightColor,
|
|
note,
|
|
createdAt: new Date(created_at!).getTime(),
|
|
updatedAt: new Date(updated_at!).getTime(),
|
|
deletedAt: deleted_at ? new Date(deleted_at).getTime() : null,
|
|
};
|
|
};
|