bok-reader 0.5.4 → 0.6.0

package/dist/components/BokReader/BokReader.d.ts

@@ -1,4 +1,5 @@
 import { default as React } from 'react';
+import { Highlight } from '../Book';
 export interface Theme {
     "--bg-color": string;
     "--text-color": string;
@@ -7,11 +8,62 @@ export interface Theme {
     "--page-num-border": string;
     "--color-tint": string;
 }
+export interface BokReaderSyncSnapshot {
+    bookId: string;
+    progress: number;
+    highlights: Highlight[];
+}
+export interface BokReaderSyncState {
+    bookId: string;
+    progress?: number;
+    highlights?: Highlight[];
+    revision?: string | number;
+    forceApply?: boolean;
+}
+type BokReaderSyncEventBase = {
+    mutationId: string;
+    bookId: string;
+    emittedAt: number;
+};
+export type BokReaderSyncEvent = (BokReaderSyncEventBase & {
+    type: "progress.set";
+    progress: number;
+}) | (BokReaderSyncEventBase & {
+    type: "highlight.add";
+    highlight: Highlight;
+}) | (BokReaderSyncEventBase & {
+    type: "highlight.remove";
+    highlightId: string;
+}) | (BokReaderSyncEventBase & {
+    type: "highlight.updateColor";
+    highlightId: string;
+    color: Highlight["color"];
+});
+export type BokReaderSyncConflictEntity = "progress" | "highlights";
+export interface BokReaderSyncConflict {
+    bookId: string;
+    entities: BokReaderSyncConflictEntity[];
+    detectedAt: number;
+    local: BokReaderSyncSnapshot;
+    remote: BokReaderSyncSnapshot;
+    proposedSyncState: BokReaderSyncState;
+}
+export interface BokReaderHandle {
+    getSyncSnapshot: () => BokReaderSyncSnapshot | null;
+    applySyncState: (syncState: BokReaderSyncState, options?: {
+        forceApply?: boolean;
+    }) => boolean;
+    getPendingSyncEvents: () => BokReaderSyncEvent[];
+    acknowledgeSyncEvents: (mutationIds: string | string[]) => void;
+}
 interface BokReaderProps {
     epubDataSource: File | ArrayBuffer | string | null;
     onTitleChange?: (title: string) => void;
     onLoadingChange?: (isLoading: boolean) => void;
     onError?: (errorMsg: string) => void;
+    onSyncEvent?: (event: BokReaderSyncEvent) => void;
+    syncState?: BokReaderSyncState | null;
+    onConflictDetected?: (conflict: BokReaderSyncConflict) => void;
     className?: string;
     style?: React.CSSProperties;
     supportedFonts?: {
@@ -22,5 +74,5 @@ interface BokReaderProps {
         [key: string]: Theme;
     };
 }
-export declare const BokReader: React.FC<BokReaderProps>;
+export declare const BokReader: React.ForwardRefExoticComponent<BokReaderProps & React.RefAttributes<BokReaderHandle>>;
 export default BokReader;

package/dist/components/BokReader/syncUtils.d.ts

@@ -0,0 +1,21 @@
+import { Highlight } from '../Book';
+export interface SyncStateFingerprintInput {
+    bookId: string;
+    progress?: number;
+    highlights?: Highlight[];
+    revision?: string | number;
+    forceApply?: boolean;
+}
+export interface PendingSyncEvent {
+    mutationId: string;
+    emittedAt: number;
+}
+export declare const PROGRESS_EPSILON = 0.0001;
+export declare function clampProgress(progress: number): number;
+export declare function cloneHighlights(highlights: Highlight[]): Highlight[];
+export declare function areHighlightsEqual(left: Highlight[], right: Highlight[]): boolean;
+export declare function getSyncStateFingerprint(syncState: SyncStateFingerprintInput): string;
+export declare function hasProgressConflict(localProgress: number, remoteProgress: number | undefined): boolean;
+export declare function enqueuePendingSyncEvent<TEvent extends PendingSyncEvent>(pendingEvents: Map<string, TEvent>, event: TEvent): void;
+export declare function listPendingSyncEvents<TEvent extends PendingSyncEvent>(pendingEvents: Map<string, TEvent>): TEvent[];
+export declare function acknowledgePendingSyncEvents<TEvent extends PendingSyncEvent>(pendingEvents: Map<string, TEvent>, mutationIds: string | string[]): void;

package/dist/components/Book.d.ts

@@ -2,6 +2,8 @@ import { default as React, Dispatch, SetStateAction } from 'react';
 export interface BookHandle {
     goToPage: (page: number) => void;
     findAndJumpToHref: (href: string) => void;
+    setProgress: (progress: number) => void;
+    getProgress: () => number;
 }
 export type HighlightColor = "yellow" | "red" | "blue" | "purple";
 export type Highlight = {
@@ -25,6 +27,7 @@ interface PageProps {
     containerElementRef: React.RefObject<HTMLDivElement | null>;
     onPageChange?: (page: number) => void;
     onPageCountChange?: (count: number) => void;
+    onProgressChange?: (progress: number) => void;
     highlights: Highlight[];
     onAddHighlight: (highlight: Highlight) => void;
     onRemoveHighlight: (id: string) => void;

package/dist/main.d.ts

@@ -1 +1,2 @@
 export { BokReader } from './components/BokReader/BokReader';
+export type { BokReaderHandle, BokReaderSyncConflict, BokReaderSyncConflictEntity, BokReaderSyncEvent, BokReaderSyncSnapshot, BokReaderSyncState, Theme } from './components/BokReader/BokReader';

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "bok-reader",
     "private": false,
-    "version": "0.5.4",
+    "version": "0.6.0",
     "type": "module",
     "main": "dist/bok.umd.js",
     "module": "dist/bok.es.js",
@@ -13,6 +13,7 @@
         "dev": "vite",
         "build": "rimraf dist && vite build",
         "prepublishOnly": "rimraf dist && vite build",
+        "test": "bun test",
         "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
         "preview": "vite preview"
     },