@prose-reader/core 1.222.0 → 1.224.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.
Files changed (54) hide show
  1. package/dist/cfi/generate.d.ts +4 -15
  2. package/dist/cfi/resolve.d.ts +7 -2
  3. package/dist/context/BridgeEvent.d.ts +7 -7
  4. package/dist/context/Context.d.ts +6 -6
  5. package/dist/createReaderWithEnhancer.d.ts +80 -79
  6. package/dist/enhancers/html/enhancer.d.ts +4 -2
  7. package/dist/enhancers/html/links.d.ts +2 -1
  8. package/dist/enhancers/html/renderer/HtmlRenderer.d.ts +6 -5
  9. package/dist/enhancers/layout/layoutEnhancer.d.ts +4 -4
  10. package/dist/enhancers/media/ImageRenderer.d.ts +6 -5
  11. package/dist/enhancers/navigation/links.d.ts +2 -1
  12. package/dist/enhancers/navigation/state.d.ts +2 -1
  13. package/dist/enhancers/pagination/ResourcesLocator.d.ts +3 -2
  14. package/dist/enhancers/pagination/chapters.d.ts +2 -1
  15. package/dist/enhancers/pagination/enhancer.d.ts +1 -0
  16. package/dist/enhancers/pagination/index.d.ts +3 -0
  17. package/dist/enhancers/pagination/progression.d.ts +2 -1
  18. package/dist/enhancers/selection/trackSpineItemSelection.d.ts +2 -1
  19. package/dist/hooks/HookManager.d.ts +3 -2
  20. package/dist/hooks/index.d.ts +2 -0
  21. package/dist/index.d.ts +15 -6
  22. package/dist/index.js +1431 -1349
  23. package/dist/index.js.map +1 -1
  24. package/dist/index.umd.cjs +33 -33
  25. package/dist/index.umd.cjs.map +1 -1
  26. package/dist/navigation/InternalNavigator.d.ts +3 -3
  27. package/dist/navigation/Locker.d.ts +2 -2
  28. package/dist/navigation/Navigator.d.ts +24 -21
  29. package/dist/navigation/UserScrollNavigation.d.ts +2 -2
  30. package/dist/navigation/consolidation/consolidateWithPagination.d.ts +4 -3
  31. package/dist/navigation/resolvers/NavigationResolver.d.ts +3 -3
  32. package/dist/navigation/resolvers/getAdjustedPositionWithSafeEdge.d.ts +3 -3
  33. package/dist/navigation/resolvers/getNavigationFromSpineItemPosition.d.ts +2 -1
  34. package/dist/navigation/restoration/restoreNavigationForControlledPageTurnMode.d.ts +3 -3
  35. package/dist/navigation/restoration/restorePosition.d.ts +3 -3
  36. package/dist/pagination/index.d.ts +1 -0
  37. package/dist/reader.d.ts +36 -37
  38. package/dist/spine/Pages.d.ts +42 -0
  39. package/dist/spine/Spine.d.ts +20 -1
  40. package/dist/spine/SpineItemsManager.d.ts +2 -2
  41. package/dist/spine/locator/SpineLocator.d.ts +0 -7
  42. package/dist/spine/locator/getSpineItemFromPosition.d.ts +2 -1
  43. package/dist/spine/locator/getSpinePositionFromSpineItemPageIndex.d.ts +2 -1
  44. package/dist/spine/types.d.ts +3 -22
  45. package/dist/spineItem/locationResolver.d.ts +0 -7
  46. package/dist/spineItem/renderer/DefaultRenderer.d.ts +6 -5
  47. package/dist/spineItem/types.d.ts +23 -0
  48. package/dist/utils/DestroyableClass.d.ts +2 -1
  49. package/dist/utils/dom.d.ts +4 -2
  50. package/package.json +4 -4
  51. package/dist/enhancers/layout/layoutInfo.d.ts +0 -25
  52. package/dist/enhancers/navigation/report.d.ts +0 -1
  53. package/dist/report.d.ts +0 -8
  54. package/dist/spineItem/layout/getSpineItemPagesPosition.d.ts +0 -11
@@ -1,3 +1,23 @@
1
+ export declare class LayoutEntry {
2
+ readonly left: number;
3
+ readonly right: number;
4
+ readonly top: number;
5
+ readonly bottom: number;
6
+ readonly width: number;
7
+ readonly height: number;
8
+ readonly x: number;
9
+ readonly y: number;
10
+ constructor(layout: {
11
+ left: number;
12
+ right: number;
13
+ top: number;
14
+ bottom: number;
15
+ width: number;
16
+ height: number;
17
+ x: number;
18
+ y: number;
19
+ });
20
+ }
1
21
  export declare class SpineItemPosition {
2
22
  readonly x: number;
3
23
  readonly y: number;
@@ -7,3 +27,6 @@ export declare class SpineItemPosition {
7
27
  y: number;
8
28
  });
9
29
  }
30
+ export declare class SpineItemPageLayout extends LayoutEntry {
31
+ readonly __symbol = "SpineItemPageLayout";
32
+ }
@@ -1,6 +1,7 @@
1
+ import { Observable } from 'rxjs';
1
2
  export declare class DestroyableClass {
2
3
  protected isDestroyed: boolean;
3
4
  private destroySubject;
4
- protected destroy$: import('rxjs').Observable<void>;
5
+ protected destroy$: Observable<void>;
5
6
  destroy(): void;
6
7
  }
@@ -1,11 +1,10 @@
1
- export declare const isHtmlElement: (element?: unknown) => element is HTMLElement;
2
1
  type ViewPort = {
3
2
  left: number;
4
3
  right: number;
5
4
  top: number;
6
5
  bottom: number;
7
6
  };
8
- export declare const getFirstVisibleNodeForViewport: (documentOrElement: Document | Element, viewport: ViewPort) => {
7
+ export declare const getFirstVisibleNodeForPositionRelativeTo: (documentOrElement: Document | Element, viewport: ViewPort) => {
9
8
  node: Node;
10
9
  offset: number;
11
10
  } | undefined;
@@ -16,5 +15,8 @@ export declare const isTouchEvent: (event: Event) => event is TouchEvent;
16
15
  export declare const noopElement: () => HTMLDivElement;
17
16
  export declare const getElementsWithAssets: (_document: Document | null | undefined) => Element[];
18
17
  export declare const revokeDocumentBlobs: (_document: Document | null | undefined) => void;
18
+ export declare function hasShape<T>(obj: unknown, requiredProps: (keyof T)[], optionalMethods?: (keyof T)[]): obj is T;
19
+ export declare function isHtmlElement(element: unknown): element is HTMLElement;
19
20
  export declare function isHtmlTagElement<K extends keyof HTMLElementTagNameMap>(element: unknown, tagName: K): element is HTMLElementTagNameMap[K];
21
+ export declare function isHtmlRange(element: unknown): element is Range;
20
22
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prose-reader/core",
3
- "version": "1.222.0",
3
+ "version": "1.224.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.222.0",
27
- "@prose-reader/shared": "^1.222.0"
26
+ "@prose-reader/cfi": "^1.224.0",
27
+ "@prose-reader/shared": "^1.224.0"
28
28
  },
29
29
  "peerDependencies": {
30
30
  "rxjs": "*"
@@ -39,5 +39,5 @@
39
39
  }
40
40
  }
41
41
  },
42
- "gitHead": "fec4160259adf7bef78577a863f6bc837c4a471e"
42
+ "gitHead": "cee0d20f1ec04bd7b5d287778cdfca32a541caac"
43
43
  }
@@ -1,25 +0,0 @@
1
- import { Reader } from '../../reader';
2
- import { SpineItemPageSpineLayout, SpinePosition } from '../../spine/types';
3
- export type PageLayoutInformation = {
4
- absolutePageIndex: number;
5
- itemIndex: number;
6
- absolutePosition: SpineItemPageSpineLayout;
7
- };
8
- export type LayoutInfo = {
9
- pages: PageLayoutInformation[];
10
- };
11
- export declare const spinePositionToSpineItemSpineLayout: ({ position, pageSize, }: {
12
- position: SpinePosition;
13
- pageSize: {
14
- height: number;
15
- width: number;
16
- };
17
- }) => SpineItemPageSpineLayout;
18
- export declare const createLayoutInfo: (reader: Reader) => {
19
- layout$: import('rxjs').Observable<{
20
- pages: PageLayoutInformation[];
21
- }>;
22
- info$: import('rxjs').Observable<{
23
- pages: PageLayoutInformation[];
24
- }>;
25
- };
@@ -1 +0,0 @@
1
- export declare const navigationReport: any;
package/dist/report.d.ts DELETED
@@ -1,8 +0,0 @@
1
- export declare const Report: {
2
- namespace: (_namespace: string, enabled?: boolean) => any;
3
- debug: any;
4
- info: any;
5
- log: any;
6
- warn: any;
7
- error: any;
8
- };
@@ -1,11 +0,0 @@
1
- import { Context } from '../../context/Context';
2
- import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
3
- export declare const getSpineItemPagesPosition: ({ context, isUsingVerticalWriting, settings, itemLayout, }: {
4
- itemLayout: {
5
- width: number;
6
- height: number;
7
- };
8
- isUsingVerticalWriting: boolean;
9
- settings: ReaderSettingsManager;
10
- context: Context;
11
- }) => import('../types').SpineItemPosition[];