@embedpdf/engine-core 3.0.0-next.13 → 3.0.0-next.15

package/dist/LocalDocumentHandle-D02FMm-Z.cjs

@@ -0,0 +1,53 @@
+//#region src/engine/localEngineBrand.ts
+/**
+* Marks what the local engine makes (its engine, documents and pages), so
+* `isLocalEngine()` and `isLocalDocument()` can tell them apart from another
+* engine's. `Symbol.for`, so two copies of this package agree.
+*/
+const LOCAL_ENGINE_BRAND = Symbol.for("@embedpdf/engine/local");
+/** Whether `value` carries the local engine's mark. */
+function hasLocalEngineBrand(value) {
+	return typeof value === "object" && value !== null && value[LOCAL_ENGINE_BRAND] === true;
+}
+//#endregion
+//#region src/engine/LocalPageHandle.ts
+/** Whether `page` is a page of a local engine's document, with its raw pixels and `/PieceInfo`. */
+function isLocalPage(page) {
+	return hasLocalEngineBrand(page);
+}
+//#endregion
+//#region src/engine/LocalDocumentHandle.ts
+/**
+* Whether `doc` is a local engine's document, with its fonts, `/PieceInfo`,
+* layers, raw pixels and files.
+*/
+function isLocalDocument(doc) {
+	return hasLocalEngineBrand(doc);
+}
+//#endregion
+Object.defineProperty(exports, "LOCAL_ENGINE_BRAND", {
+	enumerable: true,
+	get: function() {
+		return LOCAL_ENGINE_BRAND;
+	}
+});
+Object.defineProperty(exports, "hasLocalEngineBrand", {
+	enumerable: true,
+	get: function() {
+		return hasLocalEngineBrand;
+	}
+});
+Object.defineProperty(exports, "isLocalDocument", {
+	enumerable: true,
+	get: function() {
+		return isLocalDocument;
+	}
+});
+Object.defineProperty(exports, "isLocalPage", {
+	enumerable: true,
+	get: function() {
+		return isLocalPage;
+	}
+});
+
+//# sourceMappingURL=LocalDocumentHandle-D02FMm-Z.cjs.map

package/dist/LocalDocumentHandle-D02FMm-Z.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalDocumentHandle-D02FMm-Z.cjs","names":[],"sources":["../src/engine/localEngineBrand.ts","../src/engine/LocalPageHandle.ts","../src/engine/LocalDocumentHandle.ts"],"sourcesContent":["/**\n * Marks what the local engine makes (its engine, documents and pages), so\n * `isLocalEngine()` and `isLocalDocument()` can tell them apart from another\n * engine's. `Symbol.for`, so two copies of this package agree.\n */\nexport const LOCAL_ENGINE_BRAND: unique symbol = Symbol.for('@embedpdf/engine/local');\n\n/** Whether `value` carries the local engine's mark. */\nexport function hasLocalEngineBrand(value: unknown): boolean {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    (value as { [LOCAL_ENGINE_BRAND]?: unknown })[LOCAL_ENGINE_BRAND] === true\n  );\n}\n","import { hasLocalEngineBrand } from './localEngineBrand';\nimport type { LocalPageAnnotationsService } from './PageAnnotationsService';\nimport type { LocalPageFormsService } from './PageFormsService';\nimport type { PageHandle } from './PageHandle';\nimport type { LocalPageRenderService } from './PageRenderService';\nimport type { PieceInfoService } from './PieceInfoService';\n\n/**\n * A page of a document the local engine opened (`LocalDocumentHandle.page()`):\n * the shared {@link PageHandle}, its raw pixels and its `/PieceInfo`.\n */\nexport interface LocalPageHandle extends PageHandle {\n  readonly annotations: LocalPageAnnotationsService;\n  readonly forms: LocalPageFormsService;\n  readonly render: LocalPageRenderService;\n  /**\n   * Page-level `/PieceInfo` private application data (ISO 32000 §14.5), such\n   * as a stamp page's name and subject.\n   */\n  readonly pieceInfo: PieceInfoService;\n}\n\n/** Whether `page` is a page of a local engine's document, with its raw pixels and `/PieceInfo`. */\nexport function isLocalPage(page: PageHandle): page is LocalPageHandle {\n  return hasLocalEngineBrand(page);\n}\n","import type { DocumentFontSettings } from './DocumentFontSettings';\nimport type { DocumentHandle } from './DocumentHandle';\nimport { hasLocalEngineBrand } from './localEngineBrand';\nimport type { LocalPageHandle } from './LocalPageHandle';\nimport type { PieceInfoService } from './PieceInfoService';\nimport type { DownloadOptions } from '../dto/PdfSaveMode';\nimport type { PageRef } from '../identity/PageRef';\nimport { AbortablePromise } from '../promise/AbortablePromise';\nimport type { CallFacts } from '../scheduling/facts';\nimport type { BaseVersionInfo } from '../signature/types';\n\n/**\n * A document the local engine opened: the shared {@link DocumentHandle} and\n * what only an engine running PDFium itself can do. Code that takes any\n * document checks with {@link isLocalDocument}.\n */\nexport interface LocalDocumentHandle extends DocumentHandle {\n  /** Font embedding and text layout settings of this document (session state). */\n  readonly fonts: DocumentFontSettings;\n  /**\n   * Catalog-level `/PieceInfo` private application data (ISO 32000 §14.5),\n   * such as a stamp library's display name. Per-page piece data lives on\n   * `page(ref).pieceInfo`.\n   */\n  readonly pieceInfo: PieceInfoService;\n  page(ref: PageRef): LocalPageHandle;\n  with(facts: CallFacts): LocalDocumentHandle;\n  /**\n   * Node only: write the document to a local file without moving its bytes\n   * through JS. An untouched session (no unsaved edits, incremental mode) is\n   * streamed out verbatim; for a signed document, exactly as sealed.\n   */\n  downloadToFile(path: string, options?: DownloadOptions): AbortablePromise<void>;\n  /**\n   * The saved version this session is on: SHA-256 and length of the loaded\n   * bytes (for a layer session, of its base). Changes only when a signature\n   * completes.\n   */\n  version(): AbortablePromise<BaseVersionInfo>;\n  /**\n   * Export just this document's layer as a self-contained artifact (the small\n   * overlay diff over the unchanged base), which `open()` takes back with\n   * `{ kind: 'artifact', bytes }`.\n   */\n  downloadLayer(): AbortablePromise<Uint8Array>;\n}\n\n/**\n * Whether `doc` is a local engine's document, with its fonts, `/PieceInfo`,\n * layers, raw pixels and files.\n */\nexport function isLocalDocument(doc: DocumentHandle): doc is LocalDocumentHandle {\n  return hasLocalEngineBrand(doc);\n}\n"],"mappings":";;;;;;AAKA,MAAa,qBAAoC,OAAO,IAAI,wBAAwB;;AAGpF,SAAgB,oBAAoB,OAAyB;CAC3D,OACE,OAAO,UAAU,YACjB,UAAU,QACT,MAA6C,wBAAwB;AAE1E;;;;ACSA,SAAgB,YAAY,MAA2C;CACrE,OAAO,oBAAoB,IAAI;AACjC;;;;;;;AC0BA,SAAgB,gBAAgB,KAAiD;CAC/E,OAAO,oBAAoB,GAAG;AAChC"}

package/dist/LocalDocumentHandle-DAPdaOt_.js

@@ -0,0 +1,30 @@
+//#region src/engine/localEngineBrand.ts
+/**
+* Marks what the local engine makes (its engine, documents and pages), so
+* `isLocalEngine()` and `isLocalDocument()` can tell them apart from another
+* engine's. `Symbol.for`, so two copies of this package agree.
+*/
+const LOCAL_ENGINE_BRAND = Symbol.for("@embedpdf/engine/local");
+/** Whether `value` carries the local engine's mark. */
+function hasLocalEngineBrand(value) {
+	return typeof value === "object" && value !== null && value[LOCAL_ENGINE_BRAND] === true;
+}
+//#endregion
+//#region src/engine/LocalPageHandle.ts
+/** Whether `page` is a page of a local engine's document, with its raw pixels and `/PieceInfo`. */
+function isLocalPage(page) {
+	return hasLocalEngineBrand(page);
+}
+//#endregion
+//#region src/engine/LocalDocumentHandle.ts
+/**
+* Whether `doc` is a local engine's document, with its fonts, `/PieceInfo`,
+* layers, raw pixels and files.
+*/
+function isLocalDocument(doc) {
+	return hasLocalEngineBrand(doc);
+}
+//#endregion
+export { hasLocalEngineBrand as i, isLocalPage as n, LOCAL_ENGINE_BRAND as r, isLocalDocument as t };
+
+//# sourceMappingURL=LocalDocumentHandle-DAPdaOt_.js.map

package/dist/LocalDocumentHandle-DAPdaOt_.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalDocumentHandle-DAPdaOt_.js","names":[],"sources":["../src/engine/localEngineBrand.ts","../src/engine/LocalPageHandle.ts","../src/engine/LocalDocumentHandle.ts"],"sourcesContent":["/**\n * Marks what the local engine makes (its engine, documents and pages), so\n * `isLocalEngine()` and `isLocalDocument()` can tell them apart from another\n * engine's. `Symbol.for`, so two copies of this package agree.\n */\nexport const LOCAL_ENGINE_BRAND: unique symbol = Symbol.for('@embedpdf/engine/local');\n\n/** Whether `value` carries the local engine's mark. */\nexport function hasLocalEngineBrand(value: unknown): boolean {\n  return (\n    typeof value === 'object' &&\n    value !== null &&\n    (value as { [LOCAL_ENGINE_BRAND]?: unknown })[LOCAL_ENGINE_BRAND] === true\n  );\n}\n","import { hasLocalEngineBrand } from './localEngineBrand';\nimport type { LocalPageAnnotationsService } from './PageAnnotationsService';\nimport type { LocalPageFormsService } from './PageFormsService';\nimport type { PageHandle } from './PageHandle';\nimport type { LocalPageRenderService } from './PageRenderService';\nimport type { PieceInfoService } from './PieceInfoService';\n\n/**\n * A page of a document the local engine opened (`LocalDocumentHandle.page()`):\n * the shared {@link PageHandle}, its raw pixels and its `/PieceInfo`.\n */\nexport interface LocalPageHandle extends PageHandle {\n  readonly annotations: LocalPageAnnotationsService;\n  readonly forms: LocalPageFormsService;\n  readonly render: LocalPageRenderService;\n  /**\n   * Page-level `/PieceInfo` private application data (ISO 32000 §14.5), such\n   * as a stamp page's name and subject.\n   */\n  readonly pieceInfo: PieceInfoService;\n}\n\n/** Whether `page` is a page of a local engine's document, with its raw pixels and `/PieceInfo`. */\nexport function isLocalPage(page: PageHandle): page is LocalPageHandle {\n  return hasLocalEngineBrand(page);\n}\n","import type { DocumentFontSettings } from './DocumentFontSettings';\nimport type { DocumentHandle } from './DocumentHandle';\nimport { hasLocalEngineBrand } from './localEngineBrand';\nimport type { LocalPageHandle } from './LocalPageHandle';\nimport type { PieceInfoService } from './PieceInfoService';\nimport type { DownloadOptions } from '../dto/PdfSaveMode';\nimport type { PageRef } from '../identity/PageRef';\nimport { AbortablePromise } from '../promise/AbortablePromise';\nimport type { CallFacts } from '../scheduling/facts';\nimport type { BaseVersionInfo } from '../signature/types';\n\n/**\n * A document the local engine opened: the shared {@link DocumentHandle} and\n * what only an engine running PDFium itself can do. Code that takes any\n * document checks with {@link isLocalDocument}.\n */\nexport interface LocalDocumentHandle extends DocumentHandle {\n  /** Font embedding and text layout settings of this document (session state). */\n  readonly fonts: DocumentFontSettings;\n  /**\n   * Catalog-level `/PieceInfo` private application data (ISO 32000 §14.5),\n   * such as a stamp library's display name. Per-page piece data lives on\n   * `page(ref).pieceInfo`.\n   */\n  readonly pieceInfo: PieceInfoService;\n  page(ref: PageRef): LocalPageHandle;\n  with(facts: CallFacts): LocalDocumentHandle;\n  /**\n   * Node only: write the document to a local file without moving its bytes\n   * through JS. An untouched session (no unsaved edits, incremental mode) is\n   * streamed out verbatim; for a signed document, exactly as sealed.\n   */\n  downloadToFile(path: string, options?: DownloadOptions): AbortablePromise<void>;\n  /**\n   * The saved version this session is on: SHA-256 and length of the loaded\n   * bytes (for a layer session, of its base). Changes only when a signature\n   * completes.\n   */\n  version(): AbortablePromise<BaseVersionInfo>;\n  /**\n   * Export just this document's layer as a self-contained artifact (the small\n   * overlay diff over the unchanged base), which `open()` takes back with\n   * `{ kind: 'artifact', bytes }`.\n   */\n  downloadLayer(): AbortablePromise<Uint8Array>;\n}\n\n/**\n * Whether `doc` is a local engine's document, with its fonts, `/PieceInfo`,\n * layers, raw pixels and files.\n */\nexport function isLocalDocument(doc: DocumentHandle): doc is LocalDocumentHandle {\n  return hasLocalEngineBrand(doc);\n}\n"],"mappings":";;;;;;AAKA,MAAa,qBAAoC,OAAO,IAAI,wBAAwB;;AAGpF,SAAgB,oBAAoB,OAAyB;CAC3D,OACE,OAAO,UAAU,YACjB,UAAU,QACT,MAA6C,wBAAwB;AAE1E;;;;ACSA,SAAgB,YAAY,MAA2C;CACrE,OAAO,oBAAoB,IAAI;AACjC;;;;;;;AC0BA,SAAgB,gBAAgB,KAAiD;CAC/E,OAAO,oBAAoB,GAAG;AAChC"}