@build-qube/papyra 0.5.0 → 0.7.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.
@@ -0,0 +1,160 @@
1
+ import type { Sheet as NativeSheet, Workbook as NativeWorkbook } from '@build-qube/papyra-native';
2
+ import { CellWindow, type MergedRange } from './cells.js';
3
+ import { type CellStyle, type SheetLayout } from './styles.js';
4
+ import type { PdfSource } from './types.js';
5
+ /**
6
+ * The container a workbook was read from.
7
+ *
8
+ * Macro-enabled and template variants read as their base format: an `.xlsm` is
9
+ * `'xlsx'` here, because to a reader that is what it is.
10
+ */
11
+ export type WorkbookFormat = 'xlsx' | 'xlsb' | 'xls' | 'ods' | 'csv' | 'tsv';
12
+ /** How to read a workbook. Everything is sniffed when left out. */
13
+ export interface WorkbookOptions {
14
+ /**
15
+ * Skip sniffing. Only needed to read a file as TSV that was not named `.tsv` —
16
+ * the binary formats identify themselves, and text is sniffed for its delimiter.
17
+ * `'xlsm'` is accepted and reads as `'xlsx'`.
18
+ */
19
+ format?: WorkbookFormat | 'xlsm';
20
+ /** CSV and TSV only: the delimiter, a single ASCII character such as `';'`. */
21
+ delimiter?: string;
22
+ /**
23
+ * CSV and TSV only: a WHATWG encoding label, e.g. `'windows-1252'` or
24
+ * `'shift_jis'`. Without one, a byte-order mark decides, then valid UTF-8, then a
25
+ * statistical guess.
26
+ */
27
+ encoding?: string;
28
+ /**
29
+ * Cells to hold per sheet before truncating it to its first whole rows. Defaults
30
+ * to 8 million — about 400 MB, which a browser tab survives. A sheet that hits it
31
+ * reports {@link Sheet.truncated}.
32
+ */
33
+ maxCells?: number;
34
+ }
35
+ /** Whether a sheet shows in the application's tab bar. */
36
+ export type SheetVisibility = 'visible' | 'hidden' | 'veryHidden';
37
+ /** What a sheet holds. Only worksheets have cells worth showing. */
38
+ export type SheetKind = 'worksheet' | 'chartsheet' | 'dialog' | 'macro' | 'vba';
39
+ /** A sheet's entry in the workbook, known without reading its cells. */
40
+ export interface SheetInfo {
41
+ /** The name on the sheet's tab. CSV and TSV have one sheet, named `Sheet1`. */
42
+ name: string;
43
+ /** What the sheet holds. */
44
+ kind: SheetKind;
45
+ /**
46
+ * `'hidden'` sheets can be unhidden by the user; `'veryHidden'` ones only by a
47
+ * macro. A viewer usually lists the first and omits the second.
48
+ */
49
+ visibility: SheetVisibility;
50
+ }
51
+ /** Rows and columns to read, half-open like `Array.prototype.slice`. */
52
+ export interface WindowRange {
53
+ /** First row, 0-based. */
54
+ rowStart: number;
55
+ /** One past the last row. Clamped to the sheet. */
56
+ rowEnd: number;
57
+ /** First column. Defaults to 0. */
58
+ colStart?: number;
59
+ /** One past the last column. Defaults to every column. */
60
+ colEnd?: number;
61
+ }
62
+ /**
63
+ * What a {@link Sheet} reads: papyra's own addon, or another host holding the file —
64
+ * a Tauri app's, through `@build-qube/papyra-tauri`. `window` stays synchronous, so a
65
+ * remote host answers it from cells it already fetched.
66
+ */
67
+ export type SheetSource = Pick<NativeSheet, 'name' | 'rows' | 'cols' | 'truncated' | 'merges' | 'styles' | 'layout' | 'window'>;
68
+ /** What a {@link Workbook} reads, in the addon's shapes. See {@link SheetSource}. */
69
+ export interface WorkbookSource extends Pick<NativeWorkbook, 'format' | 'sheets' | 'encoding' | 'delimiter'> {
70
+ /** Parse one sheet. */
71
+ sheet(index: number): Promise<SheetSource>;
72
+ /** Free the workbook where it is held. Absent where the garbage collector does. */
73
+ close?(): Promise<void>;
74
+ }
75
+ /**
76
+ * `openWorkbook` over any {@link WorkbookSource}: the bytes, the `.tsv` rule and the
77
+ * typed errors, whoever does the parsing.
78
+ *
79
+ * @internal For papyra's own `openWorkbook` and other hosts'.
80
+ */
81
+ export declare function openWorkbookWith(load: (bytes: Uint8Array, options: WorkbookOptions) => Promise<WorkbookSource>, source: PdfSource, options?: WorkbookOptions): Promise<Workbook>;
82
+ /** An opened spreadsheet. Get one from `openWorkbook`. */
83
+ export declare class Workbook {
84
+ #private;
85
+ /** The container actually read. */
86
+ readonly format: WorkbookFormat;
87
+ /** Every sheet in tab order, hidden ones included. */
88
+ readonly sheets: readonly SheetInfo[];
89
+ /**
90
+ * CSV and TSV only: the encoding the text was decoded from, e.g.
91
+ * `'windows-1252'`. Worth showing when it was guessed — a wrong guess reads as
92
+ * mojibake, and {@link WorkbookOptions.encoding} is the fix.
93
+ */
94
+ readonly encoding: string | undefined;
95
+ /** CSV and TSV only: the delimiter, given or sniffed. */
96
+ readonly delimiter: string | undefined;
97
+ /** @internal — construct via `openWorkbook`. */
98
+ constructor(native: WorkbookSource);
99
+ /**
100
+ * Read one sheet, by index or by name.
101
+ *
102
+ * The first call parses the sheet, off the JS thread; later calls for the same
103
+ * sheet share that result.
104
+ */
105
+ sheet(which: number | string): Promise<Sheet>;
106
+ /**
107
+ * Free the workbook. A no-op for papyra's own, which the garbage collector frees; a
108
+ * host holding it — a Tauri app's — frees it now, and would otherwise keep it until
109
+ * the page reloads. Sheets already read keep their cells.
110
+ */
111
+ close(): Promise<void>;
112
+ }
113
+ /**
114
+ * One sheet, parsed and held in Rust. Read it a window at a time.
115
+ *
116
+ * Coordinates are the sheet's own and 0-based: row 0 is the row Excel labels 1, and
117
+ * a sheet whose data starts at F10 still reports ten rows and six columns, so a grid
118
+ * draws the data where its author put it.
119
+ */
120
+ export declare class Sheet {
121
+ #private;
122
+ /** The name on the sheet's tab. */
123
+ readonly name: string;
124
+ /** One past the last row holding a value or covered by a merge. */
125
+ readonly rows: number;
126
+ /**
127
+ * The sheet held more cells than {@link WorkbookOptions.maxCells}, and this is
128
+ * its first whole rows. Worth saying on screen: the rest of the file is not here.
129
+ */
130
+ readonly truncated: boolean;
131
+ /** One past the last column holding a value or covered by a merge. */
132
+ readonly cols: number;
133
+ /**
134
+ * Merged regions. The value lives in each one's top-left cell; the others are
135
+ * empty. Always empty for `.xlsb` and `.ods`, which calamine does not read
136
+ * merges from.
137
+ */
138
+ readonly merges: readonly MergedRange[];
139
+ /**
140
+ * The styles {@link CellWindow.style} indexes into, with the default at 0.
141
+ * xlsx only: empty for every other format, whose cells all read as style 0.
142
+ */
143
+ readonly styles: readonly CellStyle[];
144
+ /**
145
+ * Column widths and row heights as the author set them. xlsx only; for anything
146
+ * else a grid sizes columns itself.
147
+ */
148
+ readonly layout: SheetLayout | undefined;
149
+ /** @internal — construct via {@link Workbook.sheet}. */
150
+ constructor(native: SheetSource);
151
+ /**
152
+ * Read a rectangle of cells, clamped to the sheet.
153
+ *
154
+ * Synchronous, because the sheet is already parsed and the cost is the size of
155
+ * the window. Ask for what is on screen plus some overscan, not the whole sheet:
156
+ * a screenful is a few thousand cells and well under a millisecond.
157
+ */
158
+ window(range: WindowRange): CellWindow;
159
+ }
160
+ //# sourceMappingURL=sheets.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sheets.d.ts","sourceRoot":"","sources":["../src/sheets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,KAAK,IAAI,WAAW,EACpB,QAAQ,IAAI,cAAc,EAC3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,KAAK,WAAW,EAAkB,MAAM,YAAY,CAAC;AAG1E,OAAO,EACL,KAAK,SAAS,EACd,KAAK,WAAW,EAGjB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAE7E,mEAAmE;AACnE,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IACjC,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,0DAA0D;AAC1D,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAC;AAElE,oEAAoE;AACpE,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,CAAC;AAEhF,wEAAwE;AACxE,MAAM,WAAW,SAAS;IACxB,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAC;CAC7B;AAED,wEAAwE;AACxE,MAAM,WAAW,WAAW;IAC1B,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,IAAI,CAC5B,WAAW,EACT,MAAM,GACN,MAAM,GACN,MAAM,GACN,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,CACX,CAAC;AAEF,qFAAqF;AACrF,MAAM,WAAW,cACf,SAAQ,IAAI,CAAC,cAAc,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAC;IAC5E,uBAAuB;IACvB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3C,mFAAmF;IACnF,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,CACJ,KAAK,EAAE,UAAU,EACjB,OAAO,EAAE,eAAe,KACrB,OAAO,CAAC,cAAc,CAAC,EAC5B,MAAM,EAAE,SAAS,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,QAAQ,CAAC,CAQnB;AAgBD,0DAA0D;AAC1D,qBAAa,QAAQ;;IACnB,mCAAmC;IACnC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,sDAAsD;IACtD,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAIvC,gDAAgD;IAChD,YAAY,MAAM,EAAE,cAAc,EAUjC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAkB5C;IAED;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAE3B;CACF;AAED;;;;;;GAMG;AACH,qBAAa,KAAK;;IAChB,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mEAAmE;IACnE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,sEAAsE;IACtE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,WAAW,EAAE,CAAC;IACxC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IACtC;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC;IAGzC,wDAAwD;IACxD,YAAY,MAAM,EAAE,WAAW,EAS9B;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,CAWrC;CACF"}
package/dist/sheets.js ADDED
@@ -0,0 +1,153 @@
1
+ import { CellWindow, toMergedRanges } from './cells.js';
2
+ import { rethrowLoadError } from './errors.js';
3
+ import { toBytes } from './source.js';
4
+ import { toCellStyle, toSheetLayout, } from './styles.js';
5
+ /**
6
+ * `openWorkbook` over any {@link WorkbookSource}: the bytes, the `.tsv` rule and the
7
+ * typed errors, whoever does the parsing.
8
+ *
9
+ * @internal For papyra's own `openWorkbook` and other hosts'.
10
+ */
11
+ export async function openWorkbookWith(load, source, options = {}) {
12
+ const bytes = await toBytes(source);
13
+ const format = options.format ?? formatFromName(source);
14
+ try {
15
+ return new Workbook(await load(bytes, { ...options, format }));
16
+ }
17
+ catch (error) {
18
+ rethrowLoadError(error);
19
+ }
20
+ }
21
+ /**
22
+ * A `File` named `.tsv` is TSV whatever its contents sniff as.
23
+ *
24
+ * Only that one extension is trusted. The binary formats announce themselves in
25
+ * their first bytes, and a `.xls` downloaded from a web app is as often an HTML
26
+ * table or a CSV as it is BIFF — believing the name would refuse a readable file.
27
+ */
28
+ function formatFromName(source) {
29
+ const name = source.name;
30
+ return typeof name === 'string' && /\.(tsv|tab)$/i.test(name)
31
+ ? 'tsv'
32
+ : undefined;
33
+ }
34
+ /** An opened spreadsheet. Get one from `openWorkbook`. */
35
+ export class Workbook {
36
+ /** The container actually read. */
37
+ format;
38
+ /** Every sheet in tab order, hidden ones included. */
39
+ sheets;
40
+ /**
41
+ * CSV and TSV only: the encoding the text was decoded from, e.g.
42
+ * `'windows-1252'`. Worth showing when it was guessed — a wrong guess reads as
43
+ * mojibake, and {@link WorkbookOptions.encoding} is the fix.
44
+ */
45
+ encoding;
46
+ /** CSV and TSV only: the delimiter, given or sniffed. */
47
+ delimiter;
48
+ #native;
49
+ #sheets = new Map();
50
+ /** @internal — construct via `openWorkbook`. */
51
+ constructor(native) {
52
+ this.#native = native;
53
+ this.format = native.format;
54
+ this.sheets = native.sheets.map((s) => ({
55
+ name: s.name,
56
+ kind: s.kind,
57
+ visibility: s.visibility,
58
+ }));
59
+ this.encoding = native.encoding ?? undefined;
60
+ this.delimiter = native.delimiter ?? undefined;
61
+ }
62
+ /**
63
+ * Read one sheet, by index or by name.
64
+ *
65
+ * The first call parses the sheet, off the JS thread; later calls for the same
66
+ * sheet share that result.
67
+ */
68
+ sheet(which) {
69
+ const index = typeof which === 'number'
70
+ ? which
71
+ : this.sheets.findIndex((s) => s.name === which);
72
+ if (!Number.isInteger(index) || index < 0 || index >= this.sheets.length) {
73
+ return Promise.reject(new RangeError(`papyra: no sheet ${JSON.stringify(which)}`));
74
+ }
75
+ let sheet = this.#sheets.get(index);
76
+ if (!sheet) {
77
+ sheet = this.#native.sheet(index).then((native) => new Sheet(native));
78
+ // A failed read is not cached, so a retry gets a fresh attempt.
79
+ sheet.catch(() => this.#sheets.delete(index));
80
+ this.#sheets.set(index, sheet);
81
+ }
82
+ return sheet;
83
+ }
84
+ /**
85
+ * Free the workbook. A no-op for papyra's own, which the garbage collector frees; a
86
+ * host holding it — a Tauri app's — frees it now, and would otherwise keep it until
87
+ * the page reloads. Sheets already read keep their cells.
88
+ */
89
+ async close() {
90
+ await this.#native.close?.();
91
+ }
92
+ }
93
+ /**
94
+ * One sheet, parsed and held in Rust. Read it a window at a time.
95
+ *
96
+ * Coordinates are the sheet's own and 0-based: row 0 is the row Excel labels 1, and
97
+ * a sheet whose data starts at F10 still reports ten rows and six columns, so a grid
98
+ * draws the data where its author put it.
99
+ */
100
+ export class Sheet {
101
+ /** The name on the sheet's tab. */
102
+ name;
103
+ /** One past the last row holding a value or covered by a merge. */
104
+ rows;
105
+ /**
106
+ * The sheet held more cells than {@link WorkbookOptions.maxCells}, and this is
107
+ * its first whole rows. Worth saying on screen: the rest of the file is not here.
108
+ */
109
+ truncated;
110
+ /** One past the last column holding a value or covered by a merge. */
111
+ cols;
112
+ /**
113
+ * Merged regions. The value lives in each one's top-left cell; the others are
114
+ * empty. Always empty for `.xlsb` and `.ods`, which calamine does not read
115
+ * merges from.
116
+ */
117
+ merges;
118
+ /**
119
+ * The styles {@link CellWindow.style} indexes into, with the default at 0.
120
+ * xlsx only: empty for every other format, whose cells all read as style 0.
121
+ */
122
+ styles;
123
+ /**
124
+ * Column widths and row heights as the author set them. xlsx only; for anything
125
+ * else a grid sizes columns itself.
126
+ */
127
+ layout;
128
+ #native;
129
+ /** @internal — construct via {@link Workbook.sheet}. */
130
+ constructor(native) {
131
+ this.#native = native;
132
+ this.name = native.name;
133
+ this.rows = native.rows;
134
+ this.truncated = native.truncated;
135
+ this.cols = native.cols;
136
+ this.merges = toMergedRanges(native.merges);
137
+ this.styles = native.styles.map(toCellStyle);
138
+ this.layout = native.layout ? toSheetLayout(native.layout) : undefined;
139
+ }
140
+ /**
141
+ * Read a rectangle of cells, clamped to the sheet.
142
+ *
143
+ * Synchronous, because the sheet is already parsed and the cost is the size of
144
+ * the window. Ask for what is on screen plus some overscan, not the whole sheet:
145
+ * a screenful is a few thousand cells and well under a millisecond.
146
+ */
147
+ window(range) {
148
+ // The bindings take u32s, which a negative overscan would wrap rather than clamp.
149
+ const at = (n) => Math.max(0, Math.floor(n));
150
+ return new CellWindow(this.#native.window(at(range.rowStart), at(range.rowEnd), at(range.colStart ?? 0), at(range.colEnd ?? this.cols)));
151
+ }
152
+ }
153
+ //# sourceMappingURL=sheets.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sheets.js","sourceRoot":"","sources":["../src/sheets.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAoB,cAAc,EAAE,MAAM,YAAY,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAGL,WAAW,EACX,aAAa,GACd,MAAM,aAAa,CAAC;AA4FrB;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,IAG4B,EAC5B,MAAiB,EACjB,OAAO,GAAoB,EAAE;IAE7B,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IACxD,IAAI,CAAC;QACH,OAAO,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACjE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,MAAiB;IACvC,MAAM,IAAI,GAAI,MAA6B,CAAC,IAAI,CAAC;IACjD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3D,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,0DAA0D;AAC1D,MAAM,OAAO,QAAQ;IACnB,mCAAmC;IAC1B,MAAM,CAAiB;IAChC,sDAAsD;IAC7C,MAAM,CAAuB;IACtC;;;;OAIG;IACM,QAAQ,CAAqB;IACtC,yDAAyD;IAChD,SAAS,CAAqB;IAC9B,OAAO,CAAiB;IACxB,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAC;IAErD,gDAAgD;IAChD,YAAY,MAAsB;QAChC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAwB,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACtC,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,IAAI,EAAE,CAAC,CAAC,IAAiB;YACzB,UAAU,EAAE,CAAC,CAAC,UAA6B;SAC5C,CAAC,CAAC,CAAC;QACJ,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,SAAS,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,SAAS,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAsB;QAC1B,MAAM,KAAK,GACT,OAAO,KAAK,KAAK,QAAQ;YACvB,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACzE,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,UAAU,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAC5D,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YACtE,gEAAgE;YAChE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,KAAK;IAChB,mCAAmC;IAC1B,IAAI,CAAS;IACtB,mEAAmE;IAC1D,IAAI,CAAS;IACtB;;;OAGG;IACM,SAAS,CAAU;IAC5B,sEAAsE;IAC7D,IAAI,CAAS;IACtB;;;;OAIG;IACM,MAAM,CAAyB;IACxC;;;OAGG;IACM,MAAM,CAAuB;IACtC;;;OAGG;IACM,MAAM,CAA0B;IAChC,OAAO,CAAc;IAE9B,wDAAwD;IACxD,YAAY,MAAmB;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAkB;QACvB,kFAAkF;QAClF,MAAM,EAAE,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,OAAO,CAAC,MAAM,CACjB,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAClB,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAChB,EAAE,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC,EACvB,EAAE,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,CAC9B,CACF,CAAC;IACJ,CAAC;CACF"}
@@ -0,0 +1,97 @@
1
+ import type { TiffRenderOptions as NativeTiffRenderOptions, TiffPageInfo } from '@build-qube/papyra-native';
2
+ import type { PageBitmap, RenderedPage } from './types.js';
3
+ /**
4
+ * How a TIFF page's pixels are stored.
5
+ *
6
+ * The three `ccitt-*` values are fax coding — `ccitt-g4` is what nearly every scanned
7
+ * drawing uses. `old-jpeg` is listed so a page can say what it is, but cannot be
8
+ * rendered.
9
+ */
10
+ export type TiffCompression = 'none' | 'ccitt-rle' | 'ccitt-g3' | 'ccitt-g4' | 'lzw' | 'old-jpeg' | 'jpeg' | 'deflate' | 'packbits' | 'other';
11
+ /** One page of a TIFF, as it is shown: the file's `Orientation` is already applied. */
12
+ export interface TiffPage {
13
+ /** Width in pixels, at full resolution. */
14
+ readonly width: number;
15
+ /** Height in pixels, at full resolution. */
16
+ readonly height: number;
17
+ /**
18
+ * Resolution in dots per inch, when the file states one. Fax pages are typically
19
+ * 204 by 196, so the two can differ.
20
+ */
21
+ readonly dpi: {
22
+ /** Horizontal dots per inch. */
23
+ readonly x: number;
24
+ /** Vertical dots per inch. */
25
+ readonly y: number;
26
+ } | undefined;
27
+ /** How the pixels are stored. */
28
+ readonly compression: TiffCompression;
29
+ /** Bits per sample: 1 for a bilevel scan, 8 for most others. */
30
+ readonly bitsPerSample: number;
31
+ /** Samples per pixel: 1 for grey, 3 for RGB, 4 with alpha or for CMYK. */
32
+ readonly samplesPerPixel: number;
33
+ /** TIFF `Orientation`, 1–8. 1 is upright; 6 and 8 are a quarter turn. */
34
+ readonly orientation: number;
35
+ }
36
+ /**
37
+ * Size limits for {@link TiffImage.renderPage}. The page keeps its aspect ratio and
38
+ * is never enlarged.
39
+ */
40
+ export interface TiffRenderOptions {
41
+ /** The most pixels the result may have. Defaults to {@link TIFF_MAX_PIXELS}. */
42
+ maxPixels?: number;
43
+ /** The widest the result may be, in pixels. */
44
+ maxWidth?: number;
45
+ }
46
+ /**
47
+ * The default {@link TiffRenderOptions.maxPixels}: 4096 × 4096.
48
+ *
49
+ * It is iOS Safari's canvas limit, and 64 MB of RGBA. A 300-dpi E-size sheet comes out
50
+ * at about 100 dpi under it — readable, with hairlines in grey.
51
+ */
52
+ export declare const TIFF_MAX_PIXELS: number;
53
+ /**
54
+ * What a {@link TiffImage} reads: papyra's own addon, or another host holding the
55
+ * file — a Tauri app's, through `@build-qube/papyra-tauri`.
56
+ */
57
+ export interface TiffSource<P extends PageBitmap = RenderedPage> {
58
+ /** Every page, in the addon's shape. */
59
+ readonly pages: readonly TiffPageInfo[];
60
+ /** Decode one page at no more than the given size. */
61
+ renderPage(index: number, options?: NativeTiffRenderOptions): Promise<P>;
62
+ /** Free the file where it is held. Absent where the garbage collector does. */
63
+ close?(): Promise<void>;
64
+ }
65
+ /**
66
+ * An opened TIFF. Get one from `openTiff`.
67
+ *
68
+ * `P` is what a page decodes to: RGBA from papyra's own addon, and an `ImageBitmap`
69
+ * too from a host that sends pages as PNG.
70
+ */
71
+ export declare class TiffImage<P extends PageBitmap = RenderedPage> {
72
+ #private;
73
+ /**
74
+ * Every page, in file order. A reduced-resolution copy of a page — a thumbnail, a
75
+ * pyramid level — is not a page and is left out.
76
+ */
77
+ readonly pages: readonly TiffPage[];
78
+ /** @internal — construct via `openTiff`. */
79
+ constructor(native: TiffSource<P>);
80
+ /** How many pages there are. */
81
+ get pageCount(): number;
82
+ /**
83
+ * Decode one page to RGBA, upright, at no more than `options` allows.
84
+ *
85
+ * Paint the result with `paintToCanvas`, or encode it with `encode`, exactly as a
86
+ * rendered PDF page. Each call decodes the page again; keep the result if it will
87
+ * be shown again.
88
+ */
89
+ renderPage(index: number, options?: TiffRenderOptions): Promise<P>;
90
+ /**
91
+ * Free the file. A no-op for papyra's own, which the garbage collector frees; a
92
+ * host holding it — a Tauri app's — frees it now, and would otherwise keep it until
93
+ * the page reloads.
94
+ */
95
+ close(): Promise<void>;
96
+ }
97
+ //# sourceMappingURL=tiff-image.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tiff-image.d.ts","sourceRoot":"","sources":["../src/tiff-image.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,IAAI,uBAAuB,EAC5C,YAAY,EACb,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE3D;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,WAAW,GACX,UAAU,GACV,UAAU,GACV,KAAK,GACL,UAAU,GACV,MAAM,GACN,SAAS,GACT,UAAU,GACV,OAAO,CAAC;AAEZ,uFAAuF;AACvF,MAAM,WAAW,QAAQ;IACvB,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,4CAA4C;IAC5C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,GAAG,EACR;QACE,gCAAgC;QAChC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;QACnB,8BAA8B;QAC9B,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;KACpB,GACD,SAAS,CAAC;IACd,iCAAiC;IACjC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IACtC,gEAAgE;IAChE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,0EAA0E;IAC1E,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,yEAAyE;IACzE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,QAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,YAAY;IAC7D,wCAAwC;IACxC,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAC;IACxC,sDAAsD;IACtD,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzE,+EAA+E;IAC/E,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;;;GAKG;AACH,qBAAa,SAAS,CAAC,CAAC,SAAS,UAAU,GAAG,YAAY;;IACxD;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IAGpC,4CAA4C;IAC5C,YAAY,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,EAWhC;IAED,gCAAgC;IAChC,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC,CAarE;IAED;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAE3B;CACF"}
@@ -0,0 +1,65 @@
1
+ /**
2
+ * The default {@link TiffRenderOptions.maxPixels}: 4096 × 4096.
3
+ *
4
+ * It is iOS Safari's canvas limit, and 64 MB of RGBA. A 300-dpi E-size sheet comes out
5
+ * at about 100 dpi under it — readable, with hairlines in grey.
6
+ */
7
+ export const TIFF_MAX_PIXELS = 4096 * 4096;
8
+ /**
9
+ * An opened TIFF. Get one from `openTiff`.
10
+ *
11
+ * `P` is what a page decodes to: RGBA from papyra's own addon, and an `ImageBitmap`
12
+ * too from a host that sends pages as PNG.
13
+ */
14
+ export class TiffImage {
15
+ /**
16
+ * Every page, in file order. A reduced-resolution copy of a page — a thumbnail, a
17
+ * pyramid level — is not a page and is left out.
18
+ */
19
+ pages;
20
+ #native;
21
+ /** @internal — construct via `openTiff`. */
22
+ constructor(native) {
23
+ this.#native = native;
24
+ this.pages = native.pages.map((p) => ({
25
+ width: p.width,
26
+ height: p.height,
27
+ dpi: p.xDpi != null ? { x: p.xDpi, y: p.yDpi ?? p.xDpi } : undefined,
28
+ compression: p.compression,
29
+ bitsPerSample: p.bitsPerSample,
30
+ samplesPerPixel: p.samplesPerPixel,
31
+ orientation: p.orientation,
32
+ }));
33
+ }
34
+ /** How many pages there are. */
35
+ get pageCount() {
36
+ return this.pages.length;
37
+ }
38
+ /**
39
+ * Decode one page to RGBA, upright, at no more than `options` allows.
40
+ *
41
+ * Paint the result with `paintToCanvas`, or encode it with `encode`, exactly as a
42
+ * rendered PDF page. Each call decodes the page again; keep the result if it will
43
+ * be shown again.
44
+ */
45
+ renderPage(index, options = {}) {
46
+ if (!Number.isInteger(index) || index < 0 || index >= this.pages.length) {
47
+ return Promise.reject(new RangeError(`papyra: no TIFF page ${JSON.stringify(index)}`));
48
+ }
49
+ return this.#native.renderPage(index, {
50
+ maxPixels: options.maxPixels,
51
+ maxWidth: options.maxWidth === undefined
52
+ ? undefined
53
+ : Math.max(1, Math.floor(options.maxWidth)),
54
+ });
55
+ }
56
+ /**
57
+ * Free the file. A no-op for papyra's own, which the garbage collector frees; a
58
+ * host holding it — a Tauri app's — frees it now, and would otherwise keep it until
59
+ * the page reloads.
60
+ */
61
+ async close() {
62
+ await this.#native.close?.();
63
+ }
64
+ }
65
+ //# sourceMappingURL=tiff-image.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tiff-image.js","sourceRoot":"","sources":["../src/tiff-image.ts"],"names":[],"mappings":"AAgEA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,GAAG,IAAI,CAAC;AAe3C;;;;;GAKG;AACH,MAAM,OAAO,SAAS;IACpB;;;OAGG;IACM,KAAK,CAAsB;IAC3B,OAAO,CAAgB;IAEhC,4CAA4C;IAC5C,YAAY,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACpC,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,GAAG,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;YACpE,WAAW,EAAE,CAAC,CAAC,WAA8B;YAC7C,aAAa,EAAE,CAAC,CAAC,aAAa;YAC9B,eAAe,EAAE,CAAC,CAAC,eAAe;YAClC,WAAW,EAAE,CAAC,CAAC,WAAW;SAC3B,CAAC,CAAC,CAAC;IACN,CAAC;IAED,gCAAgC;IAChC,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,KAAa,EAAE,OAAO,GAAsB,EAAE;QACvD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACxE,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,UAAU,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAChE,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE;YACpC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,QAAQ,EACN,OAAO,CAAC,QAAQ,KAAK,SAAS;gBAC5B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;IAC/B,CAAC;CACF"}
package/dist/tiff.d.ts CHANGED
@@ -1,55 +1,5 @@
1
- import { type TiffImage as NativeTiffImage } from '@build-qube/papyra-native';
2
- import type { PdfSource, RenderedPage } from './types.js';
3
- /**
4
- * How a TIFF page's pixels are stored.
5
- *
6
- * The three `ccitt-*` values are fax coding — `ccitt-g4` is what nearly every scanned
7
- * drawing uses. `old-jpeg` is listed so a page can say what it is, but cannot be
8
- * rendered.
9
- */
10
- export type TiffCompression = 'none' | 'ccitt-rle' | 'ccitt-g3' | 'ccitt-g4' | 'lzw' | 'old-jpeg' | 'jpeg' | 'deflate' | 'packbits' | 'other';
11
- /** One page of a TIFF, as it is shown: the file's `Orientation` is already applied. */
12
- export interface TiffPage {
13
- /** Width in pixels, at full resolution. */
14
- readonly width: number;
15
- /** Height in pixels, at full resolution. */
16
- readonly height: number;
17
- /**
18
- * Resolution in dots per inch, when the file states one. Fax pages are typically
19
- * 204 by 196, so the two can differ.
20
- */
21
- readonly dpi: {
22
- /** Horizontal dots per inch. */
23
- readonly x: number;
24
- /** Vertical dots per inch. */
25
- readonly y: number;
26
- } | undefined;
27
- /** How the pixels are stored. */
28
- readonly compression: TiffCompression;
29
- /** Bits per sample: 1 for a bilevel scan, 8 for most others. */
30
- readonly bitsPerSample: number;
31
- /** Samples per pixel: 1 for grey, 3 for RGB, 4 with alpha or for CMYK. */
32
- readonly samplesPerPixel: number;
33
- /** TIFF `Orientation`, 1–8. 1 is upright; 6 and 8 are a quarter turn. */
34
- readonly orientation: number;
35
- }
36
- /**
37
- * Size limits for {@link TiffImage.renderPage}. The page keeps its aspect ratio and
38
- * is never enlarged.
39
- */
40
- export interface TiffRenderOptions {
41
- /** The most pixels the result may have. Defaults to {@link TIFF_MAX_PIXELS}. */
42
- maxPixels?: number;
43
- /** The widest the result may be, in pixels. */
44
- maxWidth?: number;
45
- }
46
- /**
47
- * The default {@link TiffRenderOptions.maxPixels}: 4096 × 4096.
48
- *
49
- * It is iOS Safari's canvas limit, and 64 MB of RGBA. A 300-dpi E-size sheet comes out
50
- * at about 100 dpi under it — readable, with hairlines in grey.
51
- */
52
- export declare const TIFF_MAX_PIXELS: number;
1
+ import { TiffImage } from './tiff-image.js';
2
+ import type { PdfSource } from './types.js';
53
3
  /**
54
4
  * Open a TIFF: single or multi-page, classic or BigTIFF.
55
5
  *
@@ -71,25 +21,4 @@ export declare const TIFF_MAX_PIXELS: number;
71
21
  * ```
72
22
  */
73
23
  export declare function openTiff(source: PdfSource): Promise<TiffImage>;
74
- /** An opened TIFF. Get one from {@link openTiff}. */
75
- export declare class TiffImage {
76
- #private;
77
- /**
78
- * Every page, in file order. A reduced-resolution copy of a page — a thumbnail, a
79
- * pyramid level — is not a page and is left out.
80
- */
81
- readonly pages: readonly TiffPage[];
82
- /** @internal — construct via {@link openTiff}. */
83
- constructor(native: NativeTiffImage);
84
- /** How many pages there are. */
85
- get pageCount(): number;
86
- /**
87
- * Decode one page to RGBA, upright, at no more than `options` allows.
88
- *
89
- * Paint the result with `paintToCanvas`, or encode it with `encode`, exactly as a
90
- * rendered PDF page. Each call decodes the page again; keep the result if it will
91
- * be shown again.
92
- */
93
- renderPage(index: number, options?: TiffRenderOptions): Promise<RenderedPage>;
94
- }
95
24
  //# sourceMappingURL=tiff.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"tiff.d.ts","sourceRoot":"","sources":["../src/tiff.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,SAAS,IAAI,eAAe,EAClC,MAAM,2BAA2B,CAAC;AAEnC,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1D;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,WAAW,GACX,UAAU,GACV,UAAU,GACV,KAAK,GACL,UAAU,GACV,MAAM,GACN,SAAS,GACT,UAAU,GACV,OAAO,CAAC;AAEZ,uFAAuF;AACvF,MAAM,WAAW,QAAQ;IACvB,2CAA2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,4CAA4C;IAC5C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,GAAG,EACR;QACE,gCAAgC;QAChC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;QACnB,8BAA8B;QAC9B,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;KACpB,GACD,SAAS,CAAC;IACd,iCAAiC;IACjC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC;IACtC,gEAAgE;IAChE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,0EAA0E;IAC1E,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,yEAAyE;IACzE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,QAAc,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAGpE;AAED,qDAAqD;AACrD,qBAAa,SAAS;;IACpB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IAGpC,kDAAkD;IAClD,YAAY,MAAM,EAAE,eAAe,EAWlC;IAED,gCAAgC;IAChC,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;;;OAMG;IACH,UAAU,CACR,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,YAAY,CAAC,CAavB;CACF"}
1
+ {"version":3,"file":"tiff.d.ts","sourceRoot":"","sources":["../src/tiff.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAmB,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAIpE"}
package/dist/tiff.js CHANGED
@@ -1,12 +1,6 @@
1
- import { loadTiff, } from '@build-qube/papyra-native';
1
+ import { loadTiff } from '@build-qube/papyra-native';
2
2
  import { toBytes } from './source.js';
3
- /**
4
- * The default {@link TiffRenderOptions.maxPixels}: 4096 × 4096.
5
- *
6
- * It is iOS Safari's canvas limit, and 64 MB of RGBA. A 300-dpi E-size sheet comes out
7
- * at about 100 dpi under it — readable, with hairlines in grey.
8
- */
9
- export const TIFF_MAX_PIXELS = 4096 * 4096;
3
+ import { TiffImage } from './tiff-image.js';
10
4
  /**
11
5
  * Open a TIFF: single or multi-page, classic or BigTIFF.
12
6
  *
@@ -29,50 +23,7 @@ export const TIFF_MAX_PIXELS = 4096 * 4096;
29
23
  */
30
24
  export async function openTiff(source) {
31
25
  const bytes = await toBytes(source);
32
- return new TiffImage(await loadTiff(bytes));
33
- }
34
- /** An opened TIFF. Get one from {@link openTiff}. */
35
- export class TiffImage {
36
- /**
37
- * Every page, in file order. A reduced-resolution copy of a page — a thumbnail, a
38
- * pyramid level — is not a page and is left out.
39
- */
40
- pages;
41
- #native;
42
- /** @internal — construct via {@link openTiff}. */
43
- constructor(native) {
44
- this.#native = native;
45
- this.pages = native.pages.map((p) => ({
46
- width: p.width,
47
- height: p.height,
48
- dpi: p.xDpi != null ? { x: p.xDpi, y: p.yDpi ?? p.xDpi } : undefined,
49
- compression: p.compression,
50
- bitsPerSample: p.bitsPerSample,
51
- samplesPerPixel: p.samplesPerPixel,
52
- orientation: p.orientation,
53
- }));
54
- }
55
- /** How many pages there are. */
56
- get pageCount() {
57
- return this.pages.length;
58
- }
59
- /**
60
- * Decode one page to RGBA, upright, at no more than `options` allows.
61
- *
62
- * Paint the result with `paintToCanvas`, or encode it with `encode`, exactly as a
63
- * rendered PDF page. Each call decodes the page again; keep the result if it will
64
- * be shown again.
65
- */
66
- renderPage(index, options = {}) {
67
- if (!Number.isInteger(index) || index < 0 || index >= this.pages.length) {
68
- return Promise.reject(new RangeError(`papyra: no TIFF page ${JSON.stringify(index)}`));
69
- }
70
- return this.#native.renderPage(index, {
71
- maxPixels: options.maxPixels,
72
- maxWidth: options.maxWidth === undefined
73
- ? undefined
74
- : Math.max(1, Math.floor(options.maxWidth)),
75
- });
76
- }
26
+ // The addon's `RenderedPage` is papyra's, typed by napi as a looser object.
27
+ return new TiffImage((await loadTiff(bytes)));
77
28
  }
78
29
  //# sourceMappingURL=tiff.js.map