@embedpdf/plugin-page-edit 3.0.0-next.14 → 3.0.0-next.16

package/dist/contract-B4DeVaKv.cjs

@@ -0,0 +1,25 @@
+//#region src/token.ts
+/** The package token, created once here and re-exported by `contract.ts`. */
+const PageEditToken = (0, require("@embedpdf/core").createCapabilityToken)("page-edit", {
+	hint: `add pageEditPlugin() from '@embedpdf/plugin-page-edit' to your plugins list`,
+	promises: {
+		rotateBy: true,
+		setRotation: true,
+		reorder: true,
+		delete: true,
+		insertBlank: true,
+		insertFromBytes: true,
+		insertFromDocument: true,
+		duplicate: true,
+		extract: true
+	}
+});
+//#endregion
+Object.defineProperty(exports, "PageEditToken", {
+	enumerable: true,
+	get: function() {
+		return PageEditToken;
+	}
+});
+
+//# sourceMappingURL=contract-B4DeVaKv.cjs.map

package/dist/contract-B4DeVaKv.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-B4DeVaKv.cjs","names":[],"sources":["../src/token.ts"],"sourcesContent":["/** The package token, created once here and re-exported by `contract.ts`. */\nimport { createCapabilityToken } from '@embedpdf/core';\n\nimport type { PageEditCapability } from './contract';\n\nexport const PageEditToken = createCapabilityToken<PageEditCapability>('page-edit', {\n  hint: `add pageEditPlugin() from '@embedpdf/plugin-page-edit' to your plugins list`,\n  // Without a document, an adapter's stand-in rejects these with `not-ready`, as the\n  // capability would; the type asks for every member that returns a promise.\n  promises: {\n    rotateBy: true,\n    setRotation: true,\n    reorder: true,\n    delete: true,\n    insertBlank: true,\n    insertFromBytes: true,\n    insertFromDocument: true,\n    duplicate: true,\n    extract: true,\n  },\n});\n"],"mappings":";;AAKA,MAAa,iBAAA,2BAAA,CAAA,CAAA,sBAAA,CAA0D,aAAa;CAClF,MAAM;CAGN,UAAU;EACR,UAAU;EACV,aAAa;EACb,SAAS;EACT,QAAQ;EACR,aAAa;EACb,iBAAiB;EACjB,oBAAoB;EACpB,WAAW;EACX,SAAS;CACX;AACF,CAAC"}

package/dist/contract-CYWYR5Pd.js

@@ -0,0 +1,21 @@
+import { createCapabilityToken } from "@embedpdf/core";
+//#region src/token.ts
+/** The package token, created once here and re-exported by `contract.ts`. */
+const PageEditToken = createCapabilityToken("page-edit", {
+	hint: `add pageEditPlugin() from '@embedpdf/plugin-page-edit' to your plugins list`,
+	promises: {
+		rotateBy: true,
+		setRotation: true,
+		reorder: true,
+		delete: true,
+		insertBlank: true,
+		insertFromBytes: true,
+		insertFromDocument: true,
+		duplicate: true,
+		extract: true
+	}
+});
+//#endregion
+export { PageEditToken as t };
+
+//# sourceMappingURL=contract-CYWYR5Pd.js.map

package/dist/contract-CYWYR5Pd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-CYWYR5Pd.js","names":[],"sources":["../src/token.ts"],"sourcesContent":["/** The package token, created once here and re-exported by `contract.ts`. */\nimport { createCapabilityToken } from '@embedpdf/core';\n\nimport type { PageEditCapability } from './contract';\n\nexport const PageEditToken = createCapabilityToken<PageEditCapability>('page-edit', {\n  hint: `add pageEditPlugin() from '@embedpdf/plugin-page-edit' to your plugins list`,\n  // Without a document, an adapter's stand-in rejects these with `not-ready`, as the\n  // capability would; the type asks for every member that returns a promise.\n  promises: {\n    rotateBy: true,\n    setRotation: true,\n    reorder: true,\n    delete: true,\n    insertBlank: true,\n    insertFromBytes: true,\n    insertFromDocument: true,\n    duplicate: true,\n    extract: true,\n  },\n});\n"],"mappings":";;;AAKA,MAAa,gBAAgB,sBAA0C,aAAa;CAClF,MAAM;CAGN,UAAU;EACR,UAAU;EACV,aAAa;EACb,SAAS;EACT,QAAQ;EACR,aAAa;EACb,iBAAiB;EACjB,oBAAoB;EACpB,WAAW;EACX,SAAS;CACX;AACF,CAAC"}

package/dist/contract-IN8rk5LG.d.cts

@@ -0,0 +1,91 @@
+import { OperationOptions, PagePosition, PagePosition as PagePosition$1, PageRef, PdfRotation, PdfRotation as PdfRotation$1, PdfSize, PdfSize as PdfSize$1 } from "@embedpdf/core";
+//#region src/token.d.ts
+declare const PageEditToken: import("@embedpdf/core").CapabilityToken<PageEditCapability>;
+//#endregion
+//#region src/contract.d.ts
+/** What an insert resolves: the new pages, in the order they were inserted. */
+interface PageEditInsertResult {
+  readonly pages: readonly PageRef[];
+}
+/** Options of `insertBlank()`. */
+interface PageInsertBlankOptions extends OperationOptions {
+  /** Where the new pages go. Default `'end'`. */
+  readonly position?: PagePosition;
+  /** The page size, in points. Default: the size of the page the new pages go next to. */
+  readonly size?: PdfSize;
+  /** How many blank pages. Default 1. */
+  readonly count?: number;
+}
+/** Options of `insertFromBytes()`. */
+interface PageInsertFromBytesOptions extends OperationOptions {
+  /** Only the source PDF's pages at these indexes, in this order. Default: every page. */
+  readonly pageIndexes?: readonly number[];
+  /** Where the new pages go. Default `'end'`. */
+  readonly position?: PagePosition;
+}
+/** Options of the verbs that copy pages in: `insertFromDocument()` and `duplicate()`. */
+interface PagePositionOptions extends OperationOptions {
+  readonly position?: PagePosition;
+}
+/**
+ * Every edit is one change: one step of the history, so undo brings the
+ * pages back as they were, a deleted page with its annotations under its old
+ * ref. It shows once the engine answers. Edits apply in the order they were
+ * called, except that the verbs that copy pages first (`duplicate()`,
+ * `insertFromDocument()`, `insertFromBytes()` with `pageIndexes`) take their
+ * place once the copy is made.
+ *
+ * Every verb rejects `permission-denied` (with `error.permission`) when the
+ * session may not do it, `not-found` for a page the document doesn't have and
+ * `invalid-input` for no pages; a refusal changes nothing. An edit the engine
+ * refuses rejects with the engine's reason. When the `signal` fires the verb
+ * rejects `operation-cancelled`: before its change is made nothing changes,
+ * after it the change still applies.
+ */
+interface PageEditCapability {
+  /** Whether rotating, reordering, deleting and inserting pages is allowed (`doc.pages.assemble`). */
+  canEdit(): boolean;
+  /**
+   * Whether copying pages out is allowed (`doc.download`): `extract()`,
+   * `duplicate()` and `insertFromDocument()` need it.
+   */
+  canExtract(): boolean;
+  /** The selected pages, in the order they were selected; pages the document no longer has drop out. */
+  getSelected(): readonly PageRef[];
+  /** Make these pages the selection; `[]` clears it. Pages the document doesn't have are left out. */
+  select(pages: readonly (PageRef | number)[]): void;
+  /**
+   * Turn each page by a quarter or half turn from its rotation, the one it
+   * has once the edits on their way apply: two quick quarter turns are a
+   * half turn.
+   */
+  rotateBy(pages: readonly (PageRef | number)[], delta: 90 | -90 | 180, options?: OperationOptions): Promise<void>;
+  /** Give every page the same rotation. */
+  setRotation(pages: readonly (PageRef | number)[], rotation: PdfRotation, options?: OperationOptions): Promise<void>;
+  /** Move pages to `position`; several pages keep their order and land together. */
+  reorder(pages: readonly (PageRef | number)[], position: PagePosition, options?: OperationOptions): Promise<void>;
+  /** Delete pages. Deleting every page is refused (`invalid-input`): a document keeps one. */
+  delete(pages: readonly (PageRef | number)[], options?: OperationOptions): Promise<void>;
+  /** Insert blank pages, one unless `count` says more. */
+  insertBlank(options?: PageInsertBlankOptions): Promise<PageEditInsertResult>;
+  /** Insert the pages of another PDF, or only the ones at `pageIndexes`. */
+  insertFromBytes(bytes: Uint8Array | ArrayBuffer, options?: PageInsertFromBytesOptions): Promise<PageEditInsertResult>;
+  /**
+   * Insert copies of pages from another document open in the viewer. Needs
+   * `doc.download` on that document and `doc.pages.assemble` on this one.
+   */
+  insertFromDocument(documentId: string, pages: readonly (PageRef | number)[], options?: PagePositionOptions): Promise<PageEditInsertResult>;
+  /**
+   * Copy pages as they show, with the edits on their way, right after the
+   * last of them unless `position` says otherwise.
+   */
+  duplicate(pages: readonly (PageRef | number)[], options?: PagePositionOptions): Promise<PageEditInsertResult>;
+  /**
+   * Copy pages into a new PDF, as they show with the edits on their way, and
+   * resolve its bytes. This document doesn't change.
+   */
+  extract(pages: readonly (PageRef | number)[], options?: OperationOptions): Promise<Uint8Array>;
+}
+//#endregion
+export { PagePosition$1 as a, PdfSize$1 as c, PageInsertFromBytesOptions as i, PageEditToken as l, PageEditInsertResult as n, PagePositionOptions as o, PageInsertBlankOptions as r, PdfRotation$1 as s, PageEditCapability as t };
+//# sourceMappingURL=contract-IN8rk5LG.d.cts.map

package/dist/contract-IN8rk5LG.d.ts

@@ -0,0 +1,91 @@
+import { OperationOptions, PagePosition, PagePosition as PagePosition$1, PageRef, PdfRotation, PdfRotation as PdfRotation$1, PdfSize, PdfSize as PdfSize$1 } from "@embedpdf/core";
+//#region src/token.d.ts
+declare const PageEditToken: import("@embedpdf/core").CapabilityToken<PageEditCapability>;
+//#endregion
+//#region src/contract.d.ts
+/** What an insert resolves: the new pages, in the order they were inserted. */
+interface PageEditInsertResult {
+  readonly pages: readonly PageRef[];
+}
+/** Options of `insertBlank()`. */
+interface PageInsertBlankOptions extends OperationOptions {
+  /** Where the new pages go. Default `'end'`. */
+  readonly position?: PagePosition;
+  /** The page size, in points. Default: the size of the page the new pages go next to. */
+  readonly size?: PdfSize;
+  /** How many blank pages. Default 1. */
+  readonly count?: number;
+}
+/** Options of `insertFromBytes()`. */
+interface PageInsertFromBytesOptions extends OperationOptions {
+  /** Only the source PDF's pages at these indexes, in this order. Default: every page. */
+  readonly pageIndexes?: readonly number[];
+  /** Where the new pages go. Default `'end'`. */
+  readonly position?: PagePosition;
+}
+/** Options of the verbs that copy pages in: `insertFromDocument()` and `duplicate()`. */
+interface PagePositionOptions extends OperationOptions {
+  readonly position?: PagePosition;
+}
+/**
+ * Every edit is one change: one step of the history, so undo brings the
+ * pages back as they were, a deleted page with its annotations under its old
+ * ref. It shows once the engine answers. Edits apply in the order they were
+ * called, except that the verbs that copy pages first (`duplicate()`,
+ * `insertFromDocument()`, `insertFromBytes()` with `pageIndexes`) take their
+ * place once the copy is made.
+ *
+ * Every verb rejects `permission-denied` (with `error.permission`) when the
+ * session may not do it, `not-found` for a page the document doesn't have and
+ * `invalid-input` for no pages; a refusal changes nothing. An edit the engine
+ * refuses rejects with the engine's reason. When the `signal` fires the verb
+ * rejects `operation-cancelled`: before its change is made nothing changes,
+ * after it the change still applies.
+ */
+interface PageEditCapability {
+  /** Whether rotating, reordering, deleting and inserting pages is allowed (`doc.pages.assemble`). */
+  canEdit(): boolean;
+  /**
+   * Whether copying pages out is allowed (`doc.download`): `extract()`,
+   * `duplicate()` and `insertFromDocument()` need it.
+   */
+  canExtract(): boolean;
+  /** The selected pages, in the order they were selected; pages the document no longer has drop out. */
+  getSelected(): readonly PageRef[];
+  /** Make these pages the selection; `[]` clears it. Pages the document doesn't have are left out. */
+  select(pages: readonly (PageRef | number)[]): void;
+  /**
+   * Turn each page by a quarter or half turn from its rotation, the one it
+   * has once the edits on their way apply: two quick quarter turns are a
+   * half turn.
+   */
+  rotateBy(pages: readonly (PageRef | number)[], delta: 90 | -90 | 180, options?: OperationOptions): Promise<void>;
+  /** Give every page the same rotation. */
+  setRotation(pages: readonly (PageRef | number)[], rotation: PdfRotation, options?: OperationOptions): Promise<void>;
+  /** Move pages to `position`; several pages keep their order and land together. */
+  reorder(pages: readonly (PageRef | number)[], position: PagePosition, options?: OperationOptions): Promise<void>;
+  /** Delete pages. Deleting every page is refused (`invalid-input`): a document keeps one. */
+  delete(pages: readonly (PageRef | number)[], options?: OperationOptions): Promise<void>;
+  /** Insert blank pages, one unless `count` says more. */
+  insertBlank(options?: PageInsertBlankOptions): Promise<PageEditInsertResult>;
+  /** Insert the pages of another PDF, or only the ones at `pageIndexes`. */
+  insertFromBytes(bytes: Uint8Array | ArrayBuffer, options?: PageInsertFromBytesOptions): Promise<PageEditInsertResult>;
+  /**
+   * Insert copies of pages from another document open in the viewer. Needs
+   * `doc.download` on that document and `doc.pages.assemble` on this one.
+   */
+  insertFromDocument(documentId: string, pages: readonly (PageRef | number)[], options?: PagePositionOptions): Promise<PageEditInsertResult>;
+  /**
+   * Copy pages as they show, with the edits on their way, right after the
+   * last of them unless `position` says otherwise.
+   */
+  duplicate(pages: readonly (PageRef | number)[], options?: PagePositionOptions): Promise<PageEditInsertResult>;
+  /**
+   * Copy pages into a new PDF, as they show with the edits on their way, and
+   * resolve its bytes. This document doesn't change.
+   */
+  extract(pages: readonly (PageRef | number)[], options?: OperationOptions): Promise<Uint8Array>;
+}
+//#endregion
+export { PagePosition$1 as a, PdfSize$1 as c, PageInsertFromBytesOptions as i, PageEditToken as l, PageEditInsertResult as n, PagePositionOptions as o, PageInsertBlankOptions as r, PdfRotation$1 as s, PageEditCapability as t };
+//# sourceMappingURL=contract-IN8rk5LG.d.ts.map

package/dist/contract.cjs

@@ -1,3 +1,3 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_contract = require("./contract-UeGRCn-t.cjs");
+const require_contract = require("./contract-B4DeVaKv.cjs");
 exports.PageEditToken = require_contract.PageEditToken;

package/dist/contract.d.cts

@@ -1,2 +1,2 @@
-import { n as PageEditToken, t as PageEditCapability } from "./contract-BnXi11KD.cjs";
-export { type PageEditCapability, PageEditToken };
+import { a as PagePosition, c as PdfSize, i as PageInsertFromBytesOptions, l as PageEditToken, n as PageEditInsertResult, o as PagePositionOptions, r as PageInsertBlankOptions, s as PdfRotation, t as PageEditCapability } from "./contract-IN8rk5LG.cjs";
+export { PageEditCapability, PageEditInsertResult, PageEditToken, PageInsertBlankOptions, PageInsertFromBytesOptions, type PagePosition, PagePositionOptions, type PdfRotation, type PdfSize };

package/dist/contract.d.ts

@@ -1,2 +1,2 @@
-import { n as PageEditToken, t as PageEditCapability } from "./contract-BnXi11KD.js";
-export { type PageEditCapability, PageEditToken };
+import { a as PagePosition, c as PdfSize, i as PageInsertFromBytesOptions, l as PageEditToken, n as PageEditInsertResult, o as PagePositionOptions, r as PageInsertBlankOptions, s as PdfRotation, t as PageEditCapability } from "./contract-IN8rk5LG.js";
+export { PageEditCapability, PageEditInsertResult, PageEditToken, PageInsertBlankOptions, PageInsertFromBytesOptions, type PagePosition, PagePositionOptions, type PdfRotation, type PdfSize };

package/dist/contract.js

@@ -1,2 +1,2 @@
-import { t as PageEditToken } from "./contract-BsNelyd8.js";
+import { t as PageEditToken } from "./contract-CYWYR5Pd.js";
 export { PageEditToken };