@prose-reader/core 1.232.0 → 1.234.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,6 +3,7 @@ import { Context } from '../context/Context';
3
3
  import { ReaderSettingsManager } from '../settings/ReaderSettingsManager';
4
4
  import { Spine } from '../spine/Spine';
5
5
  import { DestroyableClass } from '../utils/DestroyableClass';
6
+ import { Viewport } from '../viewport/Viewport';
6
7
  import { Locker } from './Locker';
7
8
  import { ScrollNavigationController } from './controllers/ScrollNavigationController';
8
9
  import { UserNavigationEntry } from './types';
@@ -14,5 +15,5 @@ export declare class UserScrollNavigation extends DestroyableClass {
14
15
  protected locker: Locker;
15
16
  protected navigationSubject: Subject<UserNavigationEntry>;
16
17
  navigation$: Observable<UserNavigationEntry>;
17
- constructor(settings: ReaderSettingsManager, context: Context, spine: Spine, scrollNavigationController: ScrollNavigationController, locker: Locker);
18
+ constructor(settings: ReaderSettingsManager, context: Context, spine: Spine, scrollNavigationController: ScrollNavigationController, locker: Locker, viewport: Viewport);
18
19
  }
@@ -1,8 +1,8 @@
1
- import { SpinePosition } from '../spine/types';
1
+ import { SpinePosition, UnsafeSpinePosition } from '../spine/types';
2
2
  import { SpineItemPosition } from '../spineItem/types';
3
3
  export type DeprecatedViewportPosition = SpinePosition;
4
4
  export type UserNavigationEntry = {
5
- position?: DeprecatedViewportPosition | SpinePosition;
5
+ position?: DeprecatedViewportPosition | SpinePosition | UnsafeSpinePosition;
6
6
  spineItem?: number | string;
7
7
  url?: string | URL;
8
8
  cfi?: string;
package/dist/reader.d.ts CHANGED
@@ -26,27 +26,26 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
26
26
  cfi: {
27
27
  generateCfiFromRange: (range: Range, item: Manifest[`spineItems`][number]) => string;
28
28
  parseCfi: (cfi: string) => {
29
+ isCfiRange: boolean;
29
30
  cleanedCfi: string;
30
- itemIndex?: number;
31
- offset?: number;
31
+ itemIndex: number;
32
+ offset: number;
32
33
  };
33
34
  generateCfiForSpineItemPage: (params: {
34
35
  pageIndex: number;
35
36
  spineItem: SpineItem;
36
37
  }) => string;
37
- resolveCfi: (params: Omit<Parameters<typeof resolveCfi>[0], "spineItemsManager">) => {
38
- node: Node | null | undefined;
39
- isRange: boolean;
40
- range: Range | null | undefined;
41
- offset: number | undefined;
42
- spineItem: SpineItem;
43
- } | {
44
- spineItem: SpineItem;
45
- node?: undefined;
46
- isRange?: undefined;
47
- range?: undefined;
48
- offset?: undefined;
49
- } | undefined;
38
+ resolveCfi: (params: Omit<Parameters<typeof resolveCfi>[0], "spineItemsManager">) => Omit<{
39
+ isCfiRange: boolean;
40
+ cleanedCfi: string;
41
+ itemIndex: number;
42
+ offset: number;
43
+ }, "offset"> & {
44
+ offset?: number | undefined;
45
+ node: Node | null;
46
+ range?: Range | null;
47
+ spineItem?: SpineItem;
48
+ };
50
49
  };
51
50
  navigation: {
52
51
  destroy: () => void;
@@ -40,5 +40,7 @@ export declare class Pages extends ReactiveEntity<State> {
40
40
  readonly layout$: Observable<State>;
41
41
  constructor(spineLayout: SpineLayout, spineItemsManager: SpineItemsManager, spineItemLocator: SpineItemLocator, context: Context, locator: SpineLocator, viewport: Viewport);
42
42
  fromSpineItemPageIndex: (spineItem: SpineItem, pageIndex: number) => PageEntry | undefined;
43
+ fromAbsolutePageIndex: (absolutePageIndex: number) => PageEntry | undefined;
44
+ observeFromAbsolutePageIndex: (absolutePageIndex: number) => Observable<PageEntry | undefined>;
43
45
  }
44
46
  export {};
@@ -9,7 +9,6 @@ import { SpineItemsManager } from '../SpineItemsManager';
9
9
  import { SpineLayout } from '../SpineLayout';
10
10
  import { SpinePosition, UnsafeSpinePosition } from '../types';
11
11
  import { getAbsolutePageIndexFromPageIndex } from './getAbsolutePageIndexFromPageIndex';
12
- import { getSpineInfoFromAbsolutePageIndex } from './getSpineInfoFromAbsolutePageIndex';
13
12
  import { getVisibleSpineItemsFromPosition } from './getVisibleSpineItemsFromPosition';
14
13
  import { UnsafeSpineItemPagePosition } from '../..';
15
14
  export type SpineLocator = ReturnType<typeof createSpineLocator>;
@@ -26,12 +25,6 @@ export declare const createSpineLocator: ({ spineItemsManager, context, spineIte
26
25
  spineItem: SpineItem;
27
26
  }) => SpinePosition;
28
27
  _getAbsolutePageIndexFromPageIndex: (params: Omit<Parameters<typeof getAbsolutePageIndexFromPageIndex>[0], "context" | "settings" | "spineLayout" | "spineItemsManager">) => number | undefined;
29
- getSpineInfoFromAbsolutePageIndex: (params: Omit<Parameters<typeof getSpineInfoFromAbsolutePageIndex>[0], "context" | "settings" | "spineLayout" | "spineItemsManager">) => {
30
- spineItem: SpineItem;
31
- pageIndex: number;
32
- itemIndex: number;
33
- currentAbsolutePage: number;
34
- } | undefined;
35
28
  getSpineItemPagePositionFromSpinePosition: (spinePosition: UnsafeSpinePosition | SpinePosition) => {
36
29
  spineItem: SpineItem;
37
30
  spineItemPageIndex: number;
@@ -15,6 +15,7 @@ export declare class AbstractSpinePosition {
15
15
  }
16
16
  export declare class SpinePosition extends AbstractSpinePosition {
17
17
  readonly __symbol = "SpinePosition";
18
+ static from(position: UnsafeSpinePosition | SpinePosition): SpinePosition;
18
19
  }
19
20
  export declare class UnsafeSpinePosition extends AbstractSpinePosition {
20
21
  readonly __symbol = "UnsafeSpinePosition";
@@ -13,4 +13,4 @@ export declare const getFrameViewportInfo: (frame: HTMLIFrameElement | undefined
13
13
  height?: undefined;
14
14
  };
15
15
  export declare const waitForFrameLoad: (stream: Observable<HTMLIFrameElement>) => Observable<HTMLIFrameElement>;
16
- export declare const waitForFrameReady: (stream: Observable<HTMLIFrameElement>) => Observable<HTMLIFrameElement>;
16
+ export declare const waitForFrameReady: (stream: Observable<HTMLIFrameElement>) => Observable<HTMLIFrameElement | undefined>;
@@ -16,6 +16,7 @@ export declare class Viewport extends ReactiveEntity<State> {
16
16
  height: number;
17
17
  };
18
18
  get absoluteViewport(): AbsoluteViewport;
19
+ get scaleFactor(): number;
19
20
  get relativeViewport(): RelativeViewport;
20
21
  }
21
22
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prose-reader/core",
3
- "version": "1.232.0",
3
+ "version": "1.234.0",
4
4
  "type": "module",
5
5
  "main": "./dist/index.umd.cjs",
6
6
  "module": "./dist/index.js",
@@ -23,8 +23,8 @@
23
23
  "tsc": "tsc"
24
24
  },
25
25
  "dependencies": {
26
- "@prose-reader/cfi": "^1.232.0",
27
- "@prose-reader/shared": "^1.232.0"
26
+ "@prose-reader/cfi": "^1.234.0",
27
+ "@prose-reader/shared": "^1.234.0"
28
28
  },
29
29
  "peerDependencies": {
30
30
  "rxjs": "*"
@@ -39,5 +39,5 @@
39
39
  }
40
40
  }
41
41
  },
42
- "gitHead": "64eb1464d647ef75ef70c03dd36955ac5a2e2bcd"
42
+ "gitHead": "1ffe3e51b948cf69c3c6f212ddf7439c7c8a4ee7"
43
43
  }
@@ -1,7 +0,0 @@
1
- import { SpinePosition } from '../../spine/types';
2
- import { DeprecatedViewportPosition } from '../types';
3
- export declare const getScaledDownPosition: ({ position: { x, y }, spineElement, element, }: {
4
- position: DeprecatedViewportPosition;
5
- spineElement: HTMLElement;
6
- element: HTMLElement;
7
- }) => SpinePosition;
@@ -1,17 +0,0 @@
1
- import { Context } from '../../context/Context';
2
- import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
3
- import { SpineItem } from '../../spineItem/SpineItem';
4
- import { SpineItemsManager } from '../SpineItemsManager';
5
- import { SpineLayout } from '../SpineLayout';
6
- export declare const getSpineInfoFromAbsolutePageIndex: ({ absolutePageIndex, spineItemsManager, }: {
7
- absolutePageIndex: number;
8
- spineLayout: SpineLayout;
9
- spineItemsManager: SpineItemsManager;
10
- context: Context;
11
- settings: ReaderSettingsManager;
12
- }) => {
13
- spineItem: SpineItem;
14
- pageIndex: number;
15
- itemIndex: number;
16
- currentAbsolutePage: number;
17
- } | undefined;