@prose-reader/core 1.168.0 → 1.170.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.
package/dist/reader.d.ts CHANGED
@@ -1,11 +1,11 @@
1
1
  import { Subject } from 'rxjs';
2
+ import { resolveCfi } from './cfi/lookup/resolveCfi';
2
3
  import { Context, ContextState } from './context/Context';
3
4
  import { HookManager } from './hooks/HookManager';
4
- import { CoreInputSettings } from './settings/types';
5
- import { resolveCfi } from './cfi/lookup/resolveCfi';
6
- import { SpineItemsManager } from './spine/SpineItemsManager';
7
5
  import { SettingsInterface } from './settings/SettingsInterface';
6
+ import { CoreInputSettings } from './settings/types';
8
7
  import { Spine } from './spine/Spine';
8
+ import { SpineItemsManager } from './spine/SpineItemsManager';
9
9
  import { SpineItem } from './spineItem/SpineItem';
10
10
  export type CreateReaderOptions = Partial<CoreInputSettings>;
11
11
  export type CreateReaderParameters = CreateReaderOptions;
@@ -104,6 +104,7 @@ export declare const createReader: (inputSettings: CreateReaderOptions) => {
104
104
  settings: SettingsInterface<NonNullable<CoreInputSettings>, NonNullable<import('./settings/types').CoreOutputSettings | undefined>>;
105
105
  element$: import('rxjs').Observable<HTMLElement>;
106
106
  layout$: import('rxjs').Observable<import('./spine/SpineLayout').LayoutInfo>;
107
+ layoutInfo$: import('rxjs').Observable<import('./spine/SpineLayout').LayoutInfo>;
107
108
  viewportState$: import('rxjs').Observable<"free" | "busy">;
108
109
  viewportFree$: import('rxjs').Observable<"free">;
109
110
  state$: import('rxjs').Observable<"idle" | "ready">;
@@ -1,10 +1,9 @@
1
- import { Observable } from 'rxjs';
2
1
  import { DocumentRenderer } from './DocumentRenderer';
3
2
  export declare class DefaultRenderer extends DocumentRenderer {
4
- onUnload(): Observable<unknown>;
5
- onCreateDocument(): Observable<unknown>;
6
- onLoadDocument(): Observable<unknown>;
7
- onLayout(): Observable<undefined>;
8
- onRenderHeadless(): Observable<never>;
3
+ onUnload(): import('rxjs').Observable<never>;
4
+ onCreateDocument(): import('rxjs').Observable<HTMLDivElement>;
5
+ onLoadDocument(): import('rxjs').Observable<never>;
6
+ onLayout(): import('rxjs').Observable<undefined>;
7
+ onRenderHeadless(): import('rxjs').Observable<never>;
9
8
  getDocumentFrame(): undefined;
10
9
  }
@@ -5,9 +5,6 @@ import { ReaderSettingsManager } from '../../settings/ReaderSettingsManager';
5
5
  import { BehaviorSubject, Observable } from 'rxjs';
6
6
  import { ResourceHandler } from '../resources/ResourceHandler';
7
7
  import { DestroyableClass } from '../../utils/DestroyableClass';
8
- type Layer = {
9
- element: HTMLElement;
10
- };
11
8
  export type DocumentRendererParams = {
12
9
  context: Context;
13
10
  settings: ReaderSettingsManager;
@@ -34,7 +31,7 @@ export declare abstract class DocumentRenderer extends DestroyableClass {
34
31
  protected stateSubject: BehaviorSubject<"loading" | "idle" | "loaded" | "unloading">;
35
32
  protected unload$: Observable<undefined>;
36
33
  protected load$: Observable<undefined>;
37
- layers: Layer[];
34
+ documentContainer: HTMLElement | undefined;
38
35
  constructor(params: {
39
36
  context: Context;
40
37
  settings: ReaderSettingsManager;
@@ -43,6 +40,8 @@ export declare abstract class DocumentRenderer extends DestroyableClass {
43
40
  containerElement: HTMLElement;
44
41
  resourcesHandler: ResourceHandler;
45
42
  });
43
+ protected attach(): void;
44
+ protected detach(): void;
46
45
  get state$(): BehaviorSubject<"loading" | "idle" | "loaded" | "unloading">;
47
46
  get isLoaded$(): Observable<boolean>;
48
47
  load(): void;
@@ -60,7 +59,7 @@ export declare abstract class DocumentRenderer extends DestroyableClass {
60
59
  release: Observable<void>;
61
60
  }): Observable<Document | undefined>;
62
61
  abstract onUnload(): Observable<unknown>;
63
- abstract onCreateDocument(): Observable<unknown>;
62
+ abstract onCreateDocument(): Observable<HTMLElement>;
64
63
  abstract onLoadDocument(): Observable<unknown>;
65
64
  abstract onLayout(params: LayoutParams): Observable<{
66
65
  width: number;
@@ -8,7 +8,7 @@ type ViewPort = {
8
8
  export declare const getFirstVisibleNodeForViewport: ((documentOrElement: Document | Element, viewport: ViewPort) => {
9
9
  node: Node;
10
10
  offset: number;
11
- } | undefined) | ((documentOrElement: Document | Element, viewport: ViewPort) => {
11
+ } | undefined) | ((documentOrElement: Element | Document, viewport: ViewPort) => {
12
12
  node: Node;
13
13
  offset: number;
14
14
  } | undefined);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prose-reader/core",
3
- "version": "1.168.0",
3
+ "version": "1.170.0",
4
4
  "type": "module",
5
5
  "main": "./dist/index.umd.cjs",
6
6
  "module": "./dist/index.js",
@@ -23,7 +23,7 @@
23
23
  "tsc": "tsc"
24
24
  },
25
25
  "dependencies": {
26
- "@prose-reader/shared": "^1.168.0"
26
+ "@prose-reader/shared": "^1.170.0"
27
27
  },
28
28
  "peerDependencies": {
29
29
  "rxjs": "*"
@@ -31,5 +31,5 @@
31
31
  "devDependencies": {
32
32
  "happy-dom": "^16.5.3"
33
33
  },
34
- "gitHead": "9cc518c70d5a30099be7852b84b8a6d9ed0e8f0e"
34
+ "gitHead": "ee936e8fef2d041a009fae9109defe1b18d23a1c"
35
35
  }
@@ -1,16 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { Context } from '../context/Context';
3
- import { Reader } from '../reader';
4
- import { SpineItem } from '../spineItem/SpineItem';
5
- export declare const progressionEnhancer: <InheritOptions, InheritOutput extends Reader>(next: (options: InheritOptions) => InheritOutput) => (options: InheritOptions) => InheritOutput & {
6
- progression: {
7
- getPercentageEstimate: (context: Context, currentSpineIndex: number, numberOfPages: number, pageIndex: number, currentPosition: {
8
- x: number;
9
- y: number;
10
- }, currentItem: SpineItem) => Observable<number>;
11
- getScrollPercentageWithinItem: (context: Context, currentPosition: {
12
- x: number;
13
- y: number;
14
- }, currentItem: SpineItem) => number;
15
- };
16
- };