react-native-simple-epub-reader 0.1.0

package/src/types/index.ts

@@ -0,0 +1,83 @@
+import type {
+  GestureUpdateEvent,
+  PinchGestureHandlerEventPayload,
+} from 'react-native-gesture-handler';
+
+export interface LocationChangeData {
+  totalLocations: number;
+  currentLocation: Location;
+  progress: number;
+  currentSection: Section | null;
+}
+
+export type Location = {
+  atStart?: boolean;
+  atEnd?: boolean;
+  end: {
+    cfi: ePubCfi;
+    displayed: {
+      page: number;
+      total: number;
+    };
+    href: string;
+    index: number;
+    location: number;
+    percentage: number;
+  };
+  start: {
+    cfi: ePubCfi;
+    displayed: {
+      page: number;
+      total: number;
+    };
+    href: string;
+    index: number;
+    location: number;
+    percentage: number;
+  };
+};
+
+export type Section = {
+  id: string;
+  href: string;
+  label: string;
+  parent?: any;
+  subitems: any[];
+};
+
+/**
+ * @example
+ * ````
+ * epubcfi(/6/6!/4/2,/2/2/1:0,/4[q1]/2/14/2/1:14)
+ * ````
+ */
+export type ePubCfi = string;
+
+export enum SourceType {
+  EPUB = 'epub',
+}
+
+export type Theme = {
+  [key: string]: {
+    [key: string]: string;
+  };
+};
+
+export interface GestureHandlerProps {
+  onSwipeLeft?: () => void;
+  onSwipeRight?: () => void;
+  onTap?: () => void;
+  onPinch?: (e: GestureUpdateEvent<PinchGestureHandlerEventPayload>) => void;
+}
+
+export type ReaderProps = {
+  src: string;
+  initialLocation?: string;
+  onLocationChange?: (data: LocationChangeData) => void;
+  onLocationsReady?: (epubKey: string, locations: ePubCfi[]) => void;
+  onFinish?: () => void;
+  onBeginning?: () => void;
+  LoaderComponent?: React.ComponentType;
+} & GestureHandlerProps;
+
+export type Flow = 'paginated' | 'scrolled-doc';

package/src/types/state.types.ts

@@ -0,0 +1,86 @@
+import type { ePubCfi, Flow, Location, Section, Theme } from './index';
+
+export enum Actions {
+  CHANGE_FONT_SIZE = 'CHANGE_FONT_SIZE',
+  SET_AT_START = 'SET_AT_START',
+  SET_AT_END = 'SET_AT_END',
+  SET_KEY = 'SET_KEY',
+  SET_TOTAL_LOCATIONS = 'SET_TOTAL_LOCATIONS',
+  SET_CURRENT_LOCATION = 'SET_CURRENT_LOCATION',
+  SET_META = 'SET_META',
+  SET_PROGRESS = 'SET_PROGRESS',
+  SET_LOCATIONS = 'SET_LOCATIONS',
+  SET_IS_LOADING = 'SET_IS_LOADING',
+  SET_IS_RENDERING = 'SET_IS_RENDERING',
+  SET_SECTION = 'SET_SECTION',
+  SET_TOC = 'SET_TOC',
+  SET_LANDMARKS = 'SET_LANDMARKS',
+  SET_FLOW = 'SET_FLOW',
+  CHANGE_THEME = 'CHANGE_THEME',
+  CHANGE_FONT_FAMILY = 'CHANGE_FONT_FAMILY',
+}
+
+type BookPayload = {
+  [Actions.CHANGE_THEME]: Theme;
+  [Actions.CHANGE_FONT_SIZE]: string;
+  [Actions.SET_AT_START]: boolean;
+  [Actions.SET_AT_END]: boolean;
+  [Actions.SET_KEY]: string;
+  [Actions.SET_TOTAL_LOCATIONS]: number;
+  [Actions.SET_CURRENT_LOCATION]: Location;
+  [Actions.SET_META]: {
+    cover: string | ArrayBuffer | null | undefined;
+    author: string;
+    title: string;
+    description: string;
+    language: string;
+    publisher: string;
+    rights: string;
+  };
+  [Actions.SET_PROGRESS]: number;
+  [Actions.SET_LOCATIONS]: ePubCfi[];
+  [Actions.SET_IS_LOADING]: boolean;
+  [Actions.SET_IS_RENDERING]: boolean;
+  [Actions.SET_SECTION]: Section | null;
+  [Actions.SET_FLOW]: Flow;
+  [Actions.CHANGE_FONT_FAMILY]: string;
+};
+
+type ActionMap<M extends { [index: string]: unknown }> = {
+  [Key in keyof M]: M[Key] extends undefined
+    ? {
+        type: Key;
+      }
+    : {
+        type: Key;
+        payload: M[Key];
+      };
+};
+
+export type BookActions = ActionMap<BookPayload>[keyof ActionMap<BookPayload>];
+
+export type InitialState = {
+  theme: Theme;
+  fontFamily: string;
+  fontSize: string;
+  atStart: boolean;
+  atEnd: boolean;
+  key: string;
+  totalLocations: number;
+  currentLocation: Location | null;
+  meta: {
+    cover: string | ArrayBuffer | null | undefined;
+    author: string;
+    title: string;
+    description: string;
+    language: string;
+    publisher: string;
+    rights: string;
+  };
+  progress: number;
+  locations: ePubCfi[];
+  isLoading: boolean;
+  isRendering: boolean;
+  section: Section | null;
+  flow: Flow;
+};