@papyrus-sdk/types 0.1.1 → 0.1.2

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Papyrus Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/index.d.mts CHANGED
@@ -62,8 +62,22 @@ interface Annotation {
62
62
  interface OutlineItem {
63
63
  title: string;
64
64
  pageIndex: number;
65
+ dest?: PageDestination;
65
66
  children?: OutlineItem[];
66
67
  }
68
+ type PageDestination = string | {
69
+ kind: 'pageIndex';
70
+ value: number;
71
+ } | {
72
+ kind: 'pageNumber';
73
+ value: number;
74
+ } | {
75
+ kind: 'named';
76
+ value: string;
77
+ } | {
78
+ kind: 'href';
79
+ value: string;
80
+ };
67
81
  interface PapyrusConfig {
68
82
  initialPage?: number;
69
83
  initialZoom?: number;
@@ -148,9 +162,9 @@ interface DocumentEngine {
148
162
  height: number;
149
163
  }): Promise<TextSelection | null>;
150
164
  getOutline(): Promise<OutlineItem[]>;
151
- getPageIndex(dest: any): Promise<number | null>;
165
+ getPageIndex(dest: PageDestination): Promise<number | null>;
152
166
  getRenderTargetType?(): RenderTargetType;
153
167
  destroy(): void;
154
168
  }
155
169
 
156
- export { type Annotation, type DocumentEngine, type DocumentLoadInput, type DocumentLoadRequest, type DocumentSource, type DocumentType, type EventPayloads, type FileLike, type Locale, type OutlineItem, type PageTheme, type PapyrusConfig, type PapyrusEventListener, PapyrusEventType, type RenderTargetType, type SearchResult, type TextItem, type TextSelection, type UITheme, type ViewMode };
170
+ export { type Annotation, type DocumentEngine, type DocumentLoadInput, type DocumentLoadRequest, type DocumentSource, type DocumentType, type EventPayloads, type FileLike, type Locale, type OutlineItem, type PageDestination, type PageTheme, type PapyrusConfig, type PapyrusEventListener, PapyrusEventType, type RenderTargetType, type SearchResult, type TextItem, type TextSelection, type UITheme, type ViewMode };
package/dist/index.d.ts CHANGED
@@ -62,8 +62,22 @@ interface Annotation {
62
62
  interface OutlineItem {
63
63
  title: string;
64
64
  pageIndex: number;
65
+ dest?: PageDestination;
65
66
  children?: OutlineItem[];
66
67
  }
68
+ type PageDestination = string | {
69
+ kind: 'pageIndex';
70
+ value: number;
71
+ } | {
72
+ kind: 'pageNumber';
73
+ value: number;
74
+ } | {
75
+ kind: 'named';
76
+ value: string;
77
+ } | {
78
+ kind: 'href';
79
+ value: string;
80
+ };
67
81
  interface PapyrusConfig {
68
82
  initialPage?: number;
69
83
  initialZoom?: number;
@@ -148,9 +162,9 @@ interface DocumentEngine {
148
162
  height: number;
149
163
  }): Promise<TextSelection | null>;
150
164
  getOutline(): Promise<OutlineItem[]>;
151
- getPageIndex(dest: any): Promise<number | null>;
165
+ getPageIndex(dest: PageDestination): Promise<number | null>;
152
166
  getRenderTargetType?(): RenderTargetType;
153
167
  destroy(): void;
154
168
  }
155
169
 
156
- export { type Annotation, type DocumentEngine, type DocumentLoadInput, type DocumentLoadRequest, type DocumentSource, type DocumentType, type EventPayloads, type FileLike, type Locale, type OutlineItem, type PageTheme, type PapyrusConfig, type PapyrusEventListener, PapyrusEventType, type RenderTargetType, type SearchResult, type TextItem, type TextSelection, type UITheme, type ViewMode };
170
+ export { type Annotation, type DocumentEngine, type DocumentLoadInput, type DocumentLoadRequest, type DocumentSource, type DocumentType, type EventPayloads, type FileLike, type Locale, type OutlineItem, type PageDestination, type PageTheme, type PapyrusConfig, type PapyrusEventListener, PapyrusEventType, type RenderTargetType, type SearchResult, type TextItem, type TextSelection, type UITheme, type ViewMode };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../index.ts"],"sourcesContent":["\r\nexport type ViewMode = 'single' | 'double' | 'continuous';\r\nexport type UITheme = 'light' | 'dark';\r\nexport type PageTheme = 'normal' | 'sepia' | 'dark' | 'high-contrast';\r\nexport type Locale = 'en' | 'pt-BR';\r\nexport type RenderTargetType = 'canvas' | 'element' | 'webview';\n\r\nexport interface FileLike {\r\n arrayBuffer(): Promise<ArrayBuffer>;\r\n}\r\n\r\nexport type DocumentSource =\n | ArrayBuffer\n | Uint8Array\n | string\n | { uri: string }\n | { data: ArrayBuffer | Uint8Array }\n | FileLike;\n\nexport type DocumentType = 'pdf' | 'epub' | 'text';\n\nexport interface DocumentLoadRequest {\n type: DocumentType;\n source: DocumentSource;\n}\n\nexport type DocumentLoadInput = DocumentSource | DocumentLoadRequest;\n\r\nexport interface TextItem {\r\n str: string;\r\n dir: string;\r\n width: number;\r\n height: number;\r\n transform: number[];\r\n fontName: string;\r\n}\r\n\r\nexport interface SearchResult {\r\n pageIndex: number;\r\n text: string;\r\n matchIndex: number;\r\n rects?: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface TextSelection {\r\n text: string;\r\n rects: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface Annotation {\r\n id: string;\r\n type: 'highlight' | 'text' | 'strikeout' | 'comment';\r\n pageIndex: number;\r\n content?: string;\r\n rect: { x: number; y: number; width: number; height: number };\r\n color: string;\r\n createdAt: number;\r\n}\r\n\r\nexport interface OutlineItem {\r\n title: string;\r\n pageIndex: number;\r\n children?: OutlineItem[];\r\n}\r\n\r\nexport interface PapyrusConfig {\r\n initialPage?: number;\r\n initialZoom?: number;\r\n initialRotation?: number;\r\n initialViewMode?: ViewMode;\r\n initialUITheme?: UITheme;\r\n initialPageTheme?: PageTheme;\r\n initialAccentColor?: string;\r\n initialLocale?: Locale;\r\n initialAnnotations?: Annotation[];\r\n sidebarLeftOpen?: boolean;\r\n sidebarRightOpen?: boolean;\r\n}\r\n\r\nexport enum PapyrusEventType {\r\n DOCUMENT_LOADED = 'DOCUMENT_LOADED',\r\n PAGE_CHANGED = 'PAGE_CHANGED',\r\n ZOOM_CHANGED = 'ZOOM_CHANGED',\r\n ANNOTATION_CREATED = 'ANNOTATION_CREATED',\r\n ANNOTATION_DELETED = 'ANNOTATION_DELETED',\r\n SEARCH_TRIGGERED = 'SEARCH_TRIGGERED',\r\n TEXT_SELECTED = 'TEXT_SELECTED',\r\n}\r\n\r\nexport interface EventPayloads {\r\n [PapyrusEventType.DOCUMENT_LOADED]: { pageCount: number };\r\n [PapyrusEventType.PAGE_CHANGED]: { pageNumber: number };\r\n [PapyrusEventType.ZOOM_CHANGED]: { zoom: number };\r\n [PapyrusEventType.ANNOTATION_CREATED]: { annotation: Annotation };\r\n [PapyrusEventType.ANNOTATION_DELETED]: { annotationId: string };\r\n [PapyrusEventType.SEARCH_TRIGGERED]: { query: string };\r\n [PapyrusEventType.TEXT_SELECTED]: { text: string, pageIndex: number };\r\n}\r\n\r\nexport type PapyrusEventListener<T extends PapyrusEventType> = (payload: EventPayloads[T]) => void;\r\n\r\n/**\r\n * Interface agnóstica do Motor.\r\n * A UI interage apenas com estes métodos.\r\n */\r\nexport interface DocumentEngine {\n load(source: DocumentSource): Promise<void>;\n load(request: DocumentLoadRequest): Promise<void>;\n getPageCount(): number;\r\n getCurrentPage(): number;\r\n goToPage(page: number): void;\r\n setZoom(zoom: number): void;\r\n getZoom(): number;\r\n rotate(direction: 'clockwise' | 'counterclockwise'): void;\r\n getRotation(): number;\r\n \r\n /** \r\n * Renderiza o conteúdo visual da página.\r\n * target: HTMLCanvasElement no Web ou NativeHandle no RN.\r\n */\r\n renderPage(pageIndex: number, target: any, scale: number): Promise<void>;\r\n \r\n /** \r\n * Renderiza a camada de texto para seleção.\r\n * container: HTMLElement no Web ou GhostView no RN.\r\n */\r\n renderTextLayer(pageIndex: number, container: any, scale: number): Promise<void>;\r\n \r\n getTextContent(pageIndex: number): Promise<TextItem[]>;\r\n getPageDimensions(pageIndex: number): Promise<{ width: number, height: number }>;\r\n searchText?(query: string): Promise<SearchResult[]>;\r\n selectText?(pageIndex: number, rect: { x: number; y: number; width: number; height: number }): Promise<TextSelection | null>;\r\n getOutline(): Promise<OutlineItem[]>;\r\n getPageIndex(dest: any): Promise<number | null>;\r\n getRenderTargetType?(): RenderTargetType;\r\n destroy(): void;\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AA+EO,IAAK,mBAAL,kBAAKA,sBAAL;AACL,EAAAA,kBAAA,qBAAkB;AAClB,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,sBAAmB;AACnB,EAAAA,kBAAA,mBAAgB;AAPN,SAAAA;AAAA,GAAA;","names":["PapyrusEventType"]}
1
+ {"version":3,"sources":["../index.ts"],"sourcesContent":["\r\nexport type ViewMode = 'single' | 'double' | 'continuous';\r\nexport type UITheme = 'light' | 'dark';\r\nexport type PageTheme = 'normal' | 'sepia' | 'dark' | 'high-contrast';\r\nexport type Locale = 'en' | 'pt-BR';\r\nexport type RenderTargetType = 'canvas' | 'element' | 'webview';\r\n\r\nexport interface FileLike {\r\n arrayBuffer(): Promise<ArrayBuffer>;\r\n}\r\n\r\nexport type DocumentSource =\r\n | ArrayBuffer\r\n | Uint8Array\r\n | string\r\n | { uri: string }\r\n | { data: ArrayBuffer | Uint8Array }\r\n | FileLike;\r\n\r\nexport type DocumentType = 'pdf' | 'epub' | 'text';\r\n\r\nexport interface DocumentLoadRequest {\r\n type: DocumentType;\r\n source: DocumentSource;\r\n}\r\n\r\nexport type DocumentLoadInput = DocumentSource | DocumentLoadRequest;\r\n\r\nexport interface TextItem {\r\n str: string;\r\n dir: string;\r\n width: number;\r\n height: number;\r\n transform: number[];\r\n fontName: string;\r\n}\r\n\r\nexport interface SearchResult {\r\n pageIndex: number;\r\n text: string;\r\n matchIndex: number;\r\n rects?: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface TextSelection {\r\n text: string;\r\n rects: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface Annotation {\r\n id: string;\r\n type: 'highlight' | 'text' | 'strikeout' | 'comment';\r\n pageIndex: number;\r\n content?: string;\r\n rect: { x: number; y: number; width: number; height: number };\r\n color: string;\r\n createdAt: number;\r\n}\r\n\r\nexport interface OutlineItem {\r\n title: string;\r\n pageIndex: number;\r\n dest?: PageDestination;\r\n children?: OutlineItem[];\r\n}\r\n\r\nexport type PageDestination =\r\n | string\r\n | { kind: 'pageIndex'; value: number }\r\n | { kind: 'pageNumber'; value: number }\r\n | { kind: 'named'; value: string }\r\n | { kind: 'href'; value: string };\r\n\r\nexport interface PapyrusConfig {\r\n initialPage?: number;\r\n initialZoom?: number;\r\n initialRotation?: number;\r\n initialViewMode?: ViewMode;\r\n initialUITheme?: UITheme;\r\n initialPageTheme?: PageTheme;\r\n initialAccentColor?: string;\r\n initialLocale?: Locale;\r\n initialAnnotations?: Annotation[];\r\n sidebarLeftOpen?: boolean;\r\n sidebarRightOpen?: boolean;\r\n}\r\n\r\nexport enum PapyrusEventType {\r\n DOCUMENT_LOADED = 'DOCUMENT_LOADED',\r\n PAGE_CHANGED = 'PAGE_CHANGED',\r\n ZOOM_CHANGED = 'ZOOM_CHANGED',\r\n ANNOTATION_CREATED = 'ANNOTATION_CREATED',\r\n ANNOTATION_DELETED = 'ANNOTATION_DELETED',\r\n SEARCH_TRIGGERED = 'SEARCH_TRIGGERED',\r\n TEXT_SELECTED = 'TEXT_SELECTED',\r\n}\r\n\r\nexport interface EventPayloads {\r\n [PapyrusEventType.DOCUMENT_LOADED]: { pageCount: number };\r\n [PapyrusEventType.PAGE_CHANGED]: { pageNumber: number };\r\n [PapyrusEventType.ZOOM_CHANGED]: { zoom: number };\r\n [PapyrusEventType.ANNOTATION_CREATED]: { annotation: Annotation };\r\n [PapyrusEventType.ANNOTATION_DELETED]: { annotationId: string };\r\n [PapyrusEventType.SEARCH_TRIGGERED]: { query: string };\r\n [PapyrusEventType.TEXT_SELECTED]: { text: string, pageIndex: number };\r\n}\r\n\r\nexport type PapyrusEventListener<T extends PapyrusEventType> = (payload: EventPayloads[T]) => void;\r\n\r\n/**\r\n * Interface agnóstica do Motor.\r\n * A UI interage apenas com estes métodos.\r\n */\r\nexport interface DocumentEngine {\r\n load(source: DocumentSource): Promise<void>;\r\n load(request: DocumentLoadRequest): Promise<void>;\r\n getPageCount(): number;\r\n getCurrentPage(): number;\r\n goToPage(page: number): void;\r\n setZoom(zoom: number): void;\r\n getZoom(): number;\r\n rotate(direction: 'clockwise' | 'counterclockwise'): void;\r\n getRotation(): number;\r\n \r\n /** \r\n * Renderiza o conteúdo visual da página.\r\n * target: HTMLCanvasElement no Web ou NativeHandle no RN.\r\n */\r\n renderPage(pageIndex: number, target: any, scale: number): Promise<void>;\r\n \r\n /** \r\n * Renderiza a camada de texto para seleção.\r\n * container: HTMLElement no Web ou GhostView no RN.\r\n */\r\n renderTextLayer(pageIndex: number, container: any, scale: number): Promise<void>;\r\n \r\n getTextContent(pageIndex: number): Promise<TextItem[]>;\r\n getPageDimensions(pageIndex: number): Promise<{ width: number, height: number }>;\r\n searchText?(query: string): Promise<SearchResult[]>;\r\n selectText?(pageIndex: number, rect: { x: number; y: number; width: number; height: number }): Promise<TextSelection | null>;\r\n getOutline(): Promise<OutlineItem[]>;\r\n getPageIndex(dest: PageDestination): Promise<number | null>;\r\n getRenderTargetType?(): RenderTargetType;\r\n destroy(): void;\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAuFO,IAAK,mBAAL,kBAAKA,sBAAL;AACL,EAAAA,kBAAA,qBAAkB;AAClB,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,sBAAmB;AACnB,EAAAA,kBAAA,mBAAgB;AAPN,SAAAA;AAAA,GAAA;","names":["PapyrusEventType"]}
@@ -1 +1 @@
1
- {"version":3,"sources":["../index.ts"],"sourcesContent":["\r\nexport type ViewMode = 'single' | 'double' | 'continuous';\r\nexport type UITheme = 'light' | 'dark';\r\nexport type PageTheme = 'normal' | 'sepia' | 'dark' | 'high-contrast';\r\nexport type Locale = 'en' | 'pt-BR';\r\nexport type RenderTargetType = 'canvas' | 'element' | 'webview';\n\r\nexport interface FileLike {\r\n arrayBuffer(): Promise<ArrayBuffer>;\r\n}\r\n\r\nexport type DocumentSource =\n | ArrayBuffer\n | Uint8Array\n | string\n | { uri: string }\n | { data: ArrayBuffer | Uint8Array }\n | FileLike;\n\nexport type DocumentType = 'pdf' | 'epub' | 'text';\n\nexport interface DocumentLoadRequest {\n type: DocumentType;\n source: DocumentSource;\n}\n\nexport type DocumentLoadInput = DocumentSource | DocumentLoadRequest;\n\r\nexport interface TextItem {\r\n str: string;\r\n dir: string;\r\n width: number;\r\n height: number;\r\n transform: number[];\r\n fontName: string;\r\n}\r\n\r\nexport interface SearchResult {\r\n pageIndex: number;\r\n text: string;\r\n matchIndex: number;\r\n rects?: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface TextSelection {\r\n text: string;\r\n rects: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface Annotation {\r\n id: string;\r\n type: 'highlight' | 'text' | 'strikeout' | 'comment';\r\n pageIndex: number;\r\n content?: string;\r\n rect: { x: number; y: number; width: number; height: number };\r\n color: string;\r\n createdAt: number;\r\n}\r\n\r\nexport interface OutlineItem {\r\n title: string;\r\n pageIndex: number;\r\n children?: OutlineItem[];\r\n}\r\n\r\nexport interface PapyrusConfig {\r\n initialPage?: number;\r\n initialZoom?: number;\r\n initialRotation?: number;\r\n initialViewMode?: ViewMode;\r\n initialUITheme?: UITheme;\r\n initialPageTheme?: PageTheme;\r\n initialAccentColor?: string;\r\n initialLocale?: Locale;\r\n initialAnnotations?: Annotation[];\r\n sidebarLeftOpen?: boolean;\r\n sidebarRightOpen?: boolean;\r\n}\r\n\r\nexport enum PapyrusEventType {\r\n DOCUMENT_LOADED = 'DOCUMENT_LOADED',\r\n PAGE_CHANGED = 'PAGE_CHANGED',\r\n ZOOM_CHANGED = 'ZOOM_CHANGED',\r\n ANNOTATION_CREATED = 'ANNOTATION_CREATED',\r\n ANNOTATION_DELETED = 'ANNOTATION_DELETED',\r\n SEARCH_TRIGGERED = 'SEARCH_TRIGGERED',\r\n TEXT_SELECTED = 'TEXT_SELECTED',\r\n}\r\n\r\nexport interface EventPayloads {\r\n [PapyrusEventType.DOCUMENT_LOADED]: { pageCount: number };\r\n [PapyrusEventType.PAGE_CHANGED]: { pageNumber: number };\r\n [PapyrusEventType.ZOOM_CHANGED]: { zoom: number };\r\n [PapyrusEventType.ANNOTATION_CREATED]: { annotation: Annotation };\r\n [PapyrusEventType.ANNOTATION_DELETED]: { annotationId: string };\r\n [PapyrusEventType.SEARCH_TRIGGERED]: { query: string };\r\n [PapyrusEventType.TEXT_SELECTED]: { text: string, pageIndex: number };\r\n}\r\n\r\nexport type PapyrusEventListener<T extends PapyrusEventType> = (payload: EventPayloads[T]) => void;\r\n\r\n/**\r\n * Interface agnóstica do Motor.\r\n * A UI interage apenas com estes métodos.\r\n */\r\nexport interface DocumentEngine {\n load(source: DocumentSource): Promise<void>;\n load(request: DocumentLoadRequest): Promise<void>;\n getPageCount(): number;\r\n getCurrentPage(): number;\r\n goToPage(page: number): void;\r\n setZoom(zoom: number): void;\r\n getZoom(): number;\r\n rotate(direction: 'clockwise' | 'counterclockwise'): void;\r\n getRotation(): number;\r\n \r\n /** \r\n * Renderiza o conteúdo visual da página.\r\n * target: HTMLCanvasElement no Web ou NativeHandle no RN.\r\n */\r\n renderPage(pageIndex: number, target: any, scale: number): Promise<void>;\r\n \r\n /** \r\n * Renderiza a camada de texto para seleção.\r\n * container: HTMLElement no Web ou GhostView no RN.\r\n */\r\n renderTextLayer(pageIndex: number, container: any, scale: number): Promise<void>;\r\n \r\n getTextContent(pageIndex: number): Promise<TextItem[]>;\r\n getPageDimensions(pageIndex: number): Promise<{ width: number, height: number }>;\r\n searchText?(query: string): Promise<SearchResult[]>;\r\n selectText?(pageIndex: number, rect: { x: number; y: number; width: number; height: number }): Promise<TextSelection | null>;\r\n getOutline(): Promise<OutlineItem[]>;\r\n getPageIndex(dest: any): Promise<number | null>;\r\n getRenderTargetType?(): RenderTargetType;\r\n destroy(): void;\r\n}\r\n"],"mappings":";AA+EO,IAAK,mBAAL,kBAAKA,sBAAL;AACL,EAAAA,kBAAA,qBAAkB;AAClB,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,sBAAmB;AACnB,EAAAA,kBAAA,mBAAgB;AAPN,SAAAA;AAAA,GAAA;","names":["PapyrusEventType"]}
1
+ {"version":3,"sources":["../index.ts"],"sourcesContent":["\r\nexport type ViewMode = 'single' | 'double' | 'continuous';\r\nexport type UITheme = 'light' | 'dark';\r\nexport type PageTheme = 'normal' | 'sepia' | 'dark' | 'high-contrast';\r\nexport type Locale = 'en' | 'pt-BR';\r\nexport type RenderTargetType = 'canvas' | 'element' | 'webview';\r\n\r\nexport interface FileLike {\r\n arrayBuffer(): Promise<ArrayBuffer>;\r\n}\r\n\r\nexport type DocumentSource =\r\n | ArrayBuffer\r\n | Uint8Array\r\n | string\r\n | { uri: string }\r\n | { data: ArrayBuffer | Uint8Array }\r\n | FileLike;\r\n\r\nexport type DocumentType = 'pdf' | 'epub' | 'text';\r\n\r\nexport interface DocumentLoadRequest {\r\n type: DocumentType;\r\n source: DocumentSource;\r\n}\r\n\r\nexport type DocumentLoadInput = DocumentSource | DocumentLoadRequest;\r\n\r\nexport interface TextItem {\r\n str: string;\r\n dir: string;\r\n width: number;\r\n height: number;\r\n transform: number[];\r\n fontName: string;\r\n}\r\n\r\nexport interface SearchResult {\r\n pageIndex: number;\r\n text: string;\r\n matchIndex: number;\r\n rects?: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface TextSelection {\r\n text: string;\r\n rects: { x: number; y: number; width: number; height: number }[];\r\n}\r\n\r\nexport interface Annotation {\r\n id: string;\r\n type: 'highlight' | 'text' | 'strikeout' | 'comment';\r\n pageIndex: number;\r\n content?: string;\r\n rect: { x: number; y: number; width: number; height: number };\r\n color: string;\r\n createdAt: number;\r\n}\r\n\r\nexport interface OutlineItem {\r\n title: string;\r\n pageIndex: number;\r\n dest?: PageDestination;\r\n children?: OutlineItem[];\r\n}\r\n\r\nexport type PageDestination =\r\n | string\r\n | { kind: 'pageIndex'; value: number }\r\n | { kind: 'pageNumber'; value: number }\r\n | { kind: 'named'; value: string }\r\n | { kind: 'href'; value: string };\r\n\r\nexport interface PapyrusConfig {\r\n initialPage?: number;\r\n initialZoom?: number;\r\n initialRotation?: number;\r\n initialViewMode?: ViewMode;\r\n initialUITheme?: UITheme;\r\n initialPageTheme?: PageTheme;\r\n initialAccentColor?: string;\r\n initialLocale?: Locale;\r\n initialAnnotations?: Annotation[];\r\n sidebarLeftOpen?: boolean;\r\n sidebarRightOpen?: boolean;\r\n}\r\n\r\nexport enum PapyrusEventType {\r\n DOCUMENT_LOADED = 'DOCUMENT_LOADED',\r\n PAGE_CHANGED = 'PAGE_CHANGED',\r\n ZOOM_CHANGED = 'ZOOM_CHANGED',\r\n ANNOTATION_CREATED = 'ANNOTATION_CREATED',\r\n ANNOTATION_DELETED = 'ANNOTATION_DELETED',\r\n SEARCH_TRIGGERED = 'SEARCH_TRIGGERED',\r\n TEXT_SELECTED = 'TEXT_SELECTED',\r\n}\r\n\r\nexport interface EventPayloads {\r\n [PapyrusEventType.DOCUMENT_LOADED]: { pageCount: number };\r\n [PapyrusEventType.PAGE_CHANGED]: { pageNumber: number };\r\n [PapyrusEventType.ZOOM_CHANGED]: { zoom: number };\r\n [PapyrusEventType.ANNOTATION_CREATED]: { annotation: Annotation };\r\n [PapyrusEventType.ANNOTATION_DELETED]: { annotationId: string };\r\n [PapyrusEventType.SEARCH_TRIGGERED]: { query: string };\r\n [PapyrusEventType.TEXT_SELECTED]: { text: string, pageIndex: number };\r\n}\r\n\r\nexport type PapyrusEventListener<T extends PapyrusEventType> = (payload: EventPayloads[T]) => void;\r\n\r\n/**\r\n * Interface agnóstica do Motor.\r\n * A UI interage apenas com estes métodos.\r\n */\r\nexport interface DocumentEngine {\r\n load(source: DocumentSource): Promise<void>;\r\n load(request: DocumentLoadRequest): Promise<void>;\r\n getPageCount(): number;\r\n getCurrentPage(): number;\r\n goToPage(page: number): void;\r\n setZoom(zoom: number): void;\r\n getZoom(): number;\r\n rotate(direction: 'clockwise' | 'counterclockwise'): void;\r\n getRotation(): number;\r\n \r\n /** \r\n * Renderiza o conteúdo visual da página.\r\n * target: HTMLCanvasElement no Web ou NativeHandle no RN.\r\n */\r\n renderPage(pageIndex: number, target: any, scale: number): Promise<void>;\r\n \r\n /** \r\n * Renderiza a camada de texto para seleção.\r\n * container: HTMLElement no Web ou GhostView no RN.\r\n */\r\n renderTextLayer(pageIndex: number, container: any, scale: number): Promise<void>;\r\n \r\n getTextContent(pageIndex: number): Promise<TextItem[]>;\r\n getPageDimensions(pageIndex: number): Promise<{ width: number, height: number }>;\r\n searchText?(query: string): Promise<SearchResult[]>;\r\n selectText?(pageIndex: number, rect: { x: number; y: number; width: number; height: number }): Promise<TextSelection | null>;\r\n getOutline(): Promise<OutlineItem[]>;\r\n getPageIndex(dest: PageDestination): Promise<number | null>;\r\n getRenderTargetType?(): RenderTargetType;\r\n destroy(): void;\r\n}\r\n"],"mappings":";AAuFO,IAAK,mBAAL,kBAAKA,sBAAL;AACL,EAAAA,kBAAA,qBAAkB;AAClB,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,kBAAe;AACf,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,wBAAqB;AACrB,EAAAA,kBAAA,sBAAmB;AACnB,EAAAA,kBAAA,mBAAgB;AAPN,SAAAA;AAAA,GAAA;","names":["PapyrusEventType"]}
package/package.json CHANGED
@@ -1,23 +1,23 @@
1
- {
2
- "name": "@papyrus-sdk/types",
3
- "version": "0.1.1",
4
- "main": "dist/index.js",
5
- "module": "dist/index.mjs",
6
- "types": "dist/index.d.ts",
7
- "exports": {
8
- ".": {
9
- "types": "./dist/index.d.ts",
10
- "import": "./dist/index.mjs",
11
- "require": "./dist/index.js"
12
- }
13
- },
14
- "files": [
15
- "dist"
16
- ],
17
- "publishConfig": {
18
- "access": "public"
19
- },
20
- "scripts": {
21
- "build": "tsup index.ts --dts --format cjs,esm --out-dir dist --clean --sourcemap"
22
- }
23
- }
1
+ {
2
+ "name": "@papyrus-sdk/types",
3
+ "version": "0.1.2",
4
+ "main": "dist/index.js",
5
+ "module": "dist/index.mjs",
6
+ "types": "dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./dist/index.d.ts",
10
+ "import": "./dist/index.mjs",
11
+ "require": "./dist/index.js"
12
+ }
13
+ },
14
+ "files": [
15
+ "dist"
16
+ ],
17
+ "publishConfig": {
18
+ "access": "public"
19
+ },
20
+ "scripts": {
21
+ "build": "tsup index.ts --dts --format cjs,esm --out-dir dist --clean --sourcemap"
22
+ }
23
+ }