@embedpdf/engine-core 3.0.0-next.0

package/dist/subtype-BvAzLCGC.js

@@ -0,0 +1,196 @@
+//#region src/errors/EngineErrorCode.ts
+const EngineErrorCode = {
+	Unknown: "Unknown",
+	InvalidArg: "InvalidArg",
+	DocNotOpen: "DocNotOpen",
+	DocOpenFailed: "DocOpenFailed",
+	DocPasswordRequired: "DocPasswordRequired",
+	DocPasswordIncorrect: "DocPasswordIncorrect",
+	Aborted: "Aborted",
+	Network: "Network",
+	Unauthenticated: "Unauthenticated",
+	Forbidden: "Forbidden",
+	NotFound: "NotFound",
+	WireFormat: "WireFormat",
+	RuntimeUnavailable: "RuntimeUnavailable",
+	/**
+	* Annotation/page reference could not be resolved. Surfaced when:
+	*   - `AnnotationRef.kind === 'objectNumber'` but the document has no
+	*     annotation with that indirect object number on the addressed page
+	*   - `AnnotationRef.kind === 'nm'` but no annotation on the page has
+	*     that `/NM`
+	*   - `AnnotationRef.kind === 'index'` but the supplied `RevisionToken`
+	*     does not match the current per-page generation
+	*   - `AnnotationRef.kind === 'index'` but `index` is out of range for
+	*     the page's current annotation count
+	*/
+	InvalidReference: "InvalidReference",
+	/**
+	* A weak-annotation structural edit (delete/move) was attempted while the
+	* caller does not have sole active edit presence for that page. This is a
+	* collaboration guard for index-addressed annotations; stable pages and
+	* non-shifting annotation updates do not use it.
+	*/
+	WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
+	/**
+	* A layer write lost its optimistic-concurrency check: the layer's
+	* durable version advanced (another writer — typically another server
+	* replica — committed) between the operation's prepare and its commit,
+	* and the server exhausted its rebase-and-retry budget. Retryable: the
+	* operation was NOT applied; re-issue it against the new state.
+	*/
+	LayerVersionConflict: "LayerVersionConflict",
+	/**
+	* The requested operation is typed but not yet wired in this engine
+	* version. The wire shape stays valid; clients can detect this with
+	* `EngineError.is(err, EngineErrorCode.NotImplemented)` and degrade
+	* gracefully.
+	*/
+	NotImplemented: "NotImplemented",
+	/**
+	* The PDF was loadable enough for PDFium to parse, but violates a
+	* structural invariant the engine relies on. Surfaced for the rare
+	* spec-violating PDF that ships a direct (non-indirect) page
+	* dictionary in the /Pages tree — see `EPDFPage_GetObjectNumber`
+	* returning `0`. PDFium creation paths (`FPDFPage_New`,
+	* `EPDFPage_CreateAnnot`) always produce indirect objects, so this
+	* error code is intentionally not used for engine-produced state;
+	* it specifically signals "this input file is broken in a way we
+	* cannot work around without compromising stable identity".
+	*
+	* Distinct from `DocOpenFailed` (PDFium refused to load the bytes
+	* at all) and `NotFound` (a well-formed page/annotation/etc. simply
+	* doesn't exist).
+	*/
+	MalformedPdf: "MalformedPdf"
+};
+//#endregion
+//#region src/annotation/subtype.ts
+/**
+* Closed-world string catalog of annotation subtypes the v3 wire format knows
+* about. The TypeScript discriminated union `AnnotationDTO` is keyed on this
+* literal type. PDFium's integer subtype code is mapped onto these strings
+* by the reader registry.
+*
+* `unsupported` is the forward-compat fallback for any PDF subtype that
+* the engine has not implemented a reader for yet. Unknown subtypes never
+* silently disappear from the wire — they round-trip as
+* `{ subtype: 'unsupported', rawSubtypeCode }`.
+*/
+const ANNOTATION_SUBTYPES = [
+	"text",
+	"link",
+	"free-text",
+	"line",
+	"square",
+	"circle",
+	"polygon",
+	"polyline",
+	"highlight",
+	"underline",
+	"squiggly",
+	"strikeout",
+	"stamp",
+	"caret",
+	"ink",
+	"popup",
+	"file-attachment",
+	"redact",
+	"widget",
+	"unsupported"
+];
+/**
+* PDFium subtype codes from `FPDFAnnot_GetSubtype`. Mirrors
+* `FPDF_ANNOTATION_SUBTYPE` in `public/fpdf_annot.h`. We keep this here
+* (rather than importing from @embedpdf/engine-runtime) so the engine-core
+* package has zero PDFium dependency.
+*/
+const PdfAnnotationSubtypeCode = {
+	UNKNOWN: 0,
+	TEXT: 1,
+	LINK: 2,
+	FREETEXT: 3,
+	LINE: 4,
+	SQUARE: 5,
+	CIRCLE: 6,
+	POLYGON: 7,
+	POLYLINE: 8,
+	HIGHLIGHT: 9,
+	UNDERLINE: 10,
+	SQUIGGLY: 11,
+	STRIKEOUT: 12,
+	STAMP: 13,
+	CARET: 14,
+	INK: 15,
+	POPUP: 16,
+	FILEATTACHMENT: 17,
+	SOUND: 18,
+	MOVIE: 19,
+	WIDGET: 20,
+	SCREEN: 21,
+	PRINTERMARK: 22,
+	TRAPNET: 23,
+	WATERMARK: 24,
+	THREED: 25,
+	RICHMEDIA: 26,
+	XFAWIDGET: 27,
+	REDACT: 28
+};
+/**
+* Map from PDFium codes to wire-stable string subtypes. Codes the engine
+* recognises as a v3 subtype (or maps to 'unsupported' if not yet wired).
+*/
+const PDF_CODE_TO_SUBTYPE = Object.freeze({
+	[PdfAnnotationSubtypeCode.TEXT]: "text",
+	[PdfAnnotationSubtypeCode.LINK]: "link",
+	[PdfAnnotationSubtypeCode.FREETEXT]: "free-text",
+	[PdfAnnotationSubtypeCode.LINE]: "line",
+	[PdfAnnotationSubtypeCode.SQUARE]: "square",
+	[PdfAnnotationSubtypeCode.CIRCLE]: "circle",
+	[PdfAnnotationSubtypeCode.POLYGON]: "polygon",
+	[PdfAnnotationSubtypeCode.POLYLINE]: "polyline",
+	[PdfAnnotationSubtypeCode.HIGHLIGHT]: "highlight",
+	[PdfAnnotationSubtypeCode.UNDERLINE]: "underline",
+	[PdfAnnotationSubtypeCode.SQUIGGLY]: "squiggly",
+	[PdfAnnotationSubtypeCode.STRIKEOUT]: "strikeout",
+	[PdfAnnotationSubtypeCode.STAMP]: "stamp",
+	[PdfAnnotationSubtypeCode.CARET]: "caret",
+	[PdfAnnotationSubtypeCode.INK]: "ink",
+	[PdfAnnotationSubtypeCode.POPUP]: "popup",
+	[PdfAnnotationSubtypeCode.FILEATTACHMENT]: "file-attachment",
+	[PdfAnnotationSubtypeCode.WIDGET]: "widget",
+	[PdfAnnotationSubtypeCode.REDACT]: "redact"
+});
+/**
+* Reverse map for write paths that need to turn a wire subtype back into the
+* PDFium integer code without importing the zod-backed annotation registry.
+*/
+const PDF_SUBTYPE_TO_CODE = Object.freeze({
+	text: PdfAnnotationSubtypeCode.TEXT,
+	link: PdfAnnotationSubtypeCode.LINK,
+	"free-text": PdfAnnotationSubtypeCode.FREETEXT,
+	line: PdfAnnotationSubtypeCode.LINE,
+	square: PdfAnnotationSubtypeCode.SQUARE,
+	circle: PdfAnnotationSubtypeCode.CIRCLE,
+	polygon: PdfAnnotationSubtypeCode.POLYGON,
+	polyline: PdfAnnotationSubtypeCode.POLYLINE,
+	highlight: PdfAnnotationSubtypeCode.HIGHLIGHT,
+	underline: PdfAnnotationSubtypeCode.UNDERLINE,
+	squiggly: PdfAnnotationSubtypeCode.SQUIGGLY,
+	strikeout: PdfAnnotationSubtypeCode.STRIKEOUT,
+	stamp: PdfAnnotationSubtypeCode.STAMP,
+	caret: PdfAnnotationSubtypeCode.CARET,
+	ink: PdfAnnotationSubtypeCode.INK,
+	popup: PdfAnnotationSubtypeCode.POPUP,
+	"file-attachment": PdfAnnotationSubtypeCode.FILEATTACHMENT,
+	redact: PdfAnnotationSubtypeCode.REDACT,
+	widget: PdfAnnotationSubtypeCode.WIDGET,
+	unsupported: PdfAnnotationSubtypeCode.UNKNOWN
+});
+function subtypeFromCode(code) {
+	return PDF_CODE_TO_SUBTYPE[code] ?? "unsupported";
+}
+//#endregion
+export { subtypeFromCode as a, PdfAnnotationSubtypeCode as i, PDF_CODE_TO_SUBTYPE as n, EngineErrorCode as o, PDF_SUBTYPE_TO_CODE as r, ANNOTATION_SUBTYPES as t };
+
+//# sourceMappingURL=subtype-BvAzLCGC.js.map

package/dist/subtype-BvAzLCGC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subtype-BvAzLCGC.js","names":[],"sources":["../src/errors/EngineErrorCode.ts","../src/annotation/subtype.ts"],"sourcesContent":["export const EngineErrorCode = {\n  Unknown: 'Unknown',\n  InvalidArg: 'InvalidArg',\n  DocNotOpen: 'DocNotOpen',\n  DocOpenFailed: 'DocOpenFailed',\n  DocPasswordRequired: 'DocPasswordRequired',\n  DocPasswordIncorrect: 'DocPasswordIncorrect',\n  Aborted: 'Aborted',\n  Network: 'Network',\n  Unauthenticated: 'Unauthenticated',\n  Forbidden: 'Forbidden',\n  NotFound: 'NotFound',\n  WireFormat: 'WireFormat',\n  RuntimeUnavailable: 'RuntimeUnavailable',\n  /**\n   * Annotation/page reference could not be resolved. Surfaced when:\n   *   - `AnnotationRef.kind === 'objectNumber'` but the document has no\n   *     annotation with that indirect object number on the addressed page\n   *   - `AnnotationRef.kind === 'nm'` but no annotation on the page has\n   *     that `/NM`\n   *   - `AnnotationRef.kind === 'index'` but the supplied `RevisionToken`\n   *     does not match the current per-page generation\n   *   - `AnnotationRef.kind === 'index'` but `index` is out of range for\n   *     the page's current annotation count\n   */\n  InvalidReference: 'InvalidReference',\n  /**\n   * A weak-annotation structural edit (delete/move) was attempted while the\n   * caller does not have sole active edit presence for that page. This is a\n   * collaboration guard for index-addressed annotations; stable pages and\n   * non-shifting annotation updates do not use it.\n   */\n  WeakAnnotationSessionConflict: 'WeakAnnotationSessionConflict',\n  /**\n   * A layer write lost its optimistic-concurrency check: the layer's\n   * durable version advanced (another writer — typically another server\n   * replica — committed) between the operation's prepare and its commit,\n   * and the server exhausted its rebase-and-retry budget. Retryable: the\n   * operation was NOT applied; re-issue it against the new state.\n   */\n  LayerVersionConflict: 'LayerVersionConflict',\n  /**\n   * The requested operation is typed but not yet wired in this engine\n   * version. The wire shape stays valid; clients can detect this with\n   * `EngineError.is(err, EngineErrorCode.NotImplemented)` and degrade\n   * gracefully.\n   */\n  NotImplemented: 'NotImplemented',\n  /**\n   * The PDF was loadable enough for PDFium to parse, but violates a\n   * structural invariant the engine relies on. Surfaced for the rare\n   * spec-violating PDF that ships a direct (non-indirect) page\n   * dictionary in the /Pages tree — see `EPDFPage_GetObjectNumber`\n   * returning `0`. PDFium creation paths (`FPDFPage_New`,\n   * `EPDFPage_CreateAnnot`) always produce indirect objects, so this\n   * error code is intentionally not used for engine-produced state;\n   * it specifically signals \"this input file is broken in a way we\n   * cannot work around without compromising stable identity\".\n   *\n   * Distinct from `DocOpenFailed` (PDFium refused to load the bytes\n   * at all) and `NotFound` (a well-formed page/annotation/etc. simply\n   * doesn't exist).\n   */\n  MalformedPdf: 'MalformedPdf',\n} as const;\n\nexport type EngineErrorCode = (typeof EngineErrorCode)[keyof typeof EngineErrorCode];\n","/**\n * Closed-world string catalog of annotation subtypes the v3 wire format knows\n * about. The TypeScript discriminated union `AnnotationDTO` is keyed on this\n * literal type. PDFium's integer subtype code is mapped onto these strings\n * by the reader registry.\n *\n * `unsupported` is the forward-compat fallback for any PDF subtype that\n * the engine has not implemented a reader for yet. Unknown subtypes never\n * silently disappear from the wire — they round-trip as\n * `{ subtype: 'unsupported', rawSubtypeCode }`.\n */\nexport const ANNOTATION_SUBTYPES = [\n  'text',\n  'link',\n  'free-text',\n  'line',\n  'square',\n  'circle',\n  'polygon',\n  'polyline',\n  'highlight',\n  'underline',\n  'squiggly',\n  'strikeout',\n  'stamp',\n  'caret',\n  'ink',\n  'popup',\n  'file-attachment',\n  'redact',\n  'widget',\n  'unsupported',\n] as const;\n\nexport type AnnotationSubtype = (typeof ANNOTATION_SUBTYPES)[number];\n\n/**\n * PDFium subtype codes from `FPDFAnnot_GetSubtype`. Mirrors\n * `FPDF_ANNOTATION_SUBTYPE` in `public/fpdf_annot.h`. We keep this here\n * (rather than importing from @embedpdf/engine-runtime) so the engine-core\n * package has zero PDFium dependency.\n */\nexport const PdfAnnotationSubtypeCode = {\n  UNKNOWN: 0,\n  TEXT: 1,\n  LINK: 2,\n  FREETEXT: 3,\n  LINE: 4,\n  SQUARE: 5,\n  CIRCLE: 6,\n  POLYGON: 7,\n  POLYLINE: 8,\n  HIGHLIGHT: 9,\n  UNDERLINE: 10,\n  SQUIGGLY: 11,\n  STRIKEOUT: 12,\n  STAMP: 13,\n  CARET: 14,\n  INK: 15,\n  POPUP: 16,\n  FILEATTACHMENT: 17,\n  SOUND: 18,\n  MOVIE: 19,\n  WIDGET: 20,\n  SCREEN: 21,\n  PRINTERMARK: 22,\n  TRAPNET: 23,\n  WATERMARK: 24,\n  THREED: 25,\n  RICHMEDIA: 26,\n  XFAWIDGET: 27,\n  REDACT: 28,\n} as const;\n\nexport type PdfAnnotationSubtypeCode =\n  (typeof PdfAnnotationSubtypeCode)[keyof typeof PdfAnnotationSubtypeCode];\n\n/**\n * Map from PDFium codes to wire-stable string subtypes. Codes the engine\n * recognises as a v3 subtype (or maps to 'unsupported' if not yet wired).\n */\nexport const PDF_CODE_TO_SUBTYPE: Readonly<Record<number, AnnotationSubtype>> = Object.freeze({\n  [PdfAnnotationSubtypeCode.TEXT]: 'text',\n  [PdfAnnotationSubtypeCode.LINK]: 'link',\n  [PdfAnnotationSubtypeCode.FREETEXT]: 'free-text',\n  [PdfAnnotationSubtypeCode.LINE]: 'line',\n  [PdfAnnotationSubtypeCode.SQUARE]: 'square',\n  [PdfAnnotationSubtypeCode.CIRCLE]: 'circle',\n  [PdfAnnotationSubtypeCode.POLYGON]: 'polygon',\n  [PdfAnnotationSubtypeCode.POLYLINE]: 'polyline',\n  [PdfAnnotationSubtypeCode.HIGHLIGHT]: 'highlight',\n  [PdfAnnotationSubtypeCode.UNDERLINE]: 'underline',\n  [PdfAnnotationSubtypeCode.SQUIGGLY]: 'squiggly',\n  [PdfAnnotationSubtypeCode.STRIKEOUT]: 'strikeout',\n  [PdfAnnotationSubtypeCode.STAMP]: 'stamp',\n  [PdfAnnotationSubtypeCode.CARET]: 'caret',\n  [PdfAnnotationSubtypeCode.INK]: 'ink',\n  [PdfAnnotationSubtypeCode.POPUP]: 'popup',\n  [PdfAnnotationSubtypeCode.FILEATTACHMENT]: 'file-attachment',\n  [PdfAnnotationSubtypeCode.WIDGET]: 'widget',\n  [PdfAnnotationSubtypeCode.REDACT]: 'redact',\n});\n\n/**\n * Reverse map for write paths that need to turn a wire subtype back into the\n * PDFium integer code without importing the zod-backed annotation registry.\n */\nexport const PDF_SUBTYPE_TO_CODE: Readonly<Record<AnnotationSubtype, PdfAnnotationSubtypeCode>> =\n  Object.freeze({\n    text: PdfAnnotationSubtypeCode.TEXT,\n    link: PdfAnnotationSubtypeCode.LINK,\n    'free-text': PdfAnnotationSubtypeCode.FREETEXT,\n    line: PdfAnnotationSubtypeCode.LINE,\n    square: PdfAnnotationSubtypeCode.SQUARE,\n    circle: PdfAnnotationSubtypeCode.CIRCLE,\n    polygon: PdfAnnotationSubtypeCode.POLYGON,\n    polyline: PdfAnnotationSubtypeCode.POLYLINE,\n    highlight: PdfAnnotationSubtypeCode.HIGHLIGHT,\n    underline: PdfAnnotationSubtypeCode.UNDERLINE,\n    squiggly: PdfAnnotationSubtypeCode.SQUIGGLY,\n    strikeout: PdfAnnotationSubtypeCode.STRIKEOUT,\n    stamp: PdfAnnotationSubtypeCode.STAMP,\n    caret: PdfAnnotationSubtypeCode.CARET,\n    ink: PdfAnnotationSubtypeCode.INK,\n    popup: PdfAnnotationSubtypeCode.POPUP,\n    'file-attachment': PdfAnnotationSubtypeCode.FILEATTACHMENT,\n    redact: PdfAnnotationSubtypeCode.REDACT,\n    widget: PdfAnnotationSubtypeCode.WIDGET,\n    unsupported: PdfAnnotationSubtypeCode.UNKNOWN,\n  });\n\nexport function subtypeFromCode(code: number): AnnotationSubtype {\n  return PDF_CODE_TO_SUBTYPE[code] ?? 'unsupported';\n}\n"],"mappings":";AAAA,MAAa,kBAAkB;CAC7B,SAAS;CACT,YAAY;CACZ,YAAY;CACZ,eAAe;CACf,qBAAqB;CACrB,sBAAsB;CACtB,SAAS;CACT,SAAS;CACT,iBAAiB;CACjB,WAAW;CACX,UAAU;CACV,YAAY;CACZ,oBAAoB;;;;;;;;;;;;CAYpB,kBAAkB;;;;;;;CAOlB,+BAA+B;;;;;;;;CAQ/B,sBAAsB;;;;;;;CAOtB,gBAAgB;;;;;;;;;;;;;;;;CAgBhB,cAAc;AAChB;;;;;;;;;;;;;;ACrDA,MAAa,sBAAsB;CACjC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;;;;;;AAUA,MAAa,2BAA2B;CACtC,SAAS;CACT,MAAM;CACN,MAAM;CACN,UAAU;CACV,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,UAAU;CACV,WAAW;CACX,WAAW;CACX,UAAU;CACV,WAAW;CACX,OAAO;CACP,OAAO;CACP,KAAK;CACL,OAAO;CACP,gBAAgB;CAChB,OAAO;CACP,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,aAAa;CACb,SAAS;CACT,WAAW;CACX,QAAQ;CACR,WAAW;CACX,WAAW;CACX,QAAQ;AACV;;;;;AASA,MAAa,sBAAmE,OAAO,OAAO;EAC3F,yBAAyB,OAAO;EAChC,yBAAyB,OAAO;EAChC,yBAAyB,WAAW;EACpC,yBAAyB,OAAO;EAChC,yBAAyB,SAAS;EAClC,yBAAyB,SAAS;EAClC,yBAAyB,UAAU;EACnC,yBAAyB,WAAW;EACpC,yBAAyB,YAAY;EACrC,yBAAyB,YAAY;EACrC,yBAAyB,WAAW;EACpC,yBAAyB,YAAY;EACrC,yBAAyB,QAAQ;EACjC,yBAAyB,QAAQ;EACjC,yBAAyB,MAAM;EAC/B,yBAAyB,QAAQ;EACjC,yBAAyB,iBAAiB;EAC1C,yBAAyB,SAAS;EAClC,yBAAyB,SAAS;AACrC,CAAC;;;;;AAMD,MAAa,sBACX,OAAO,OAAO;CACZ,MAAM,yBAAyB;CAC/B,MAAM,yBAAyB;CAC/B,aAAa,yBAAyB;CACtC,MAAM,yBAAyB;CAC/B,QAAQ,yBAAyB;CACjC,QAAQ,yBAAyB;CACjC,SAAS,yBAAyB;CAClC,UAAU,yBAAyB;CACnC,WAAW,yBAAyB;CACpC,WAAW,yBAAyB;CACpC,UAAU,yBAAyB;CACnC,WAAW,yBAAyB;CACpC,OAAO,yBAAyB;CAChC,OAAO,yBAAyB;CAChC,KAAK,yBAAyB;CAC9B,OAAO,yBAAyB;CAChC,mBAAmB,yBAAyB;CAC5C,QAAQ,yBAAyB;CACjC,QAAQ,yBAAyB;CACjC,aAAa,yBAAyB;AACxC,CAAC;AAEH,SAAgB,gBAAgB,MAAiC;CAC/D,OAAO,oBAAoB,SAAS;AACtC"}

package/dist/subtype-qejjVr6h.cjs

@@ -0,0 +1,231 @@
+//#region src/errors/EngineErrorCode.ts
+const EngineErrorCode = {
+	Unknown: "Unknown",
+	InvalidArg: "InvalidArg",
+	DocNotOpen: "DocNotOpen",
+	DocOpenFailed: "DocOpenFailed",
+	DocPasswordRequired: "DocPasswordRequired",
+	DocPasswordIncorrect: "DocPasswordIncorrect",
+	Aborted: "Aborted",
+	Network: "Network",
+	Unauthenticated: "Unauthenticated",
+	Forbidden: "Forbidden",
+	NotFound: "NotFound",
+	WireFormat: "WireFormat",
+	RuntimeUnavailable: "RuntimeUnavailable",
+	/**
+	* Annotation/page reference could not be resolved. Surfaced when:
+	*   - `AnnotationRef.kind === 'objectNumber'` but the document has no
+	*     annotation with that indirect object number on the addressed page
+	*   - `AnnotationRef.kind === 'nm'` but no annotation on the page has
+	*     that `/NM`
+	*   - `AnnotationRef.kind === 'index'` but the supplied `RevisionToken`
+	*     does not match the current per-page generation
+	*   - `AnnotationRef.kind === 'index'` but `index` is out of range for
+	*     the page's current annotation count
+	*/
+	InvalidReference: "InvalidReference",
+	/**
+	* A weak-annotation structural edit (delete/move) was attempted while the
+	* caller does not have sole active edit presence for that page. This is a
+	* collaboration guard for index-addressed annotations; stable pages and
+	* non-shifting annotation updates do not use it.
+	*/
+	WeakAnnotationSessionConflict: "WeakAnnotationSessionConflict",
+	/**
+	* A layer write lost its optimistic-concurrency check: the layer's
+	* durable version advanced (another writer — typically another server
+	* replica — committed) between the operation's prepare and its commit,
+	* and the server exhausted its rebase-and-retry budget. Retryable: the
+	* operation was NOT applied; re-issue it against the new state.
+	*/
+	LayerVersionConflict: "LayerVersionConflict",
+	/**
+	* The requested operation is typed but not yet wired in this engine
+	* version. The wire shape stays valid; clients can detect this with
+	* `EngineError.is(err, EngineErrorCode.NotImplemented)` and degrade
+	* gracefully.
+	*/
+	NotImplemented: "NotImplemented",
+	/**
+	* The PDF was loadable enough for PDFium to parse, but violates a
+	* structural invariant the engine relies on. Surfaced for the rare
+	* spec-violating PDF that ships a direct (non-indirect) page
+	* dictionary in the /Pages tree — see `EPDFPage_GetObjectNumber`
+	* returning `0`. PDFium creation paths (`FPDFPage_New`,
+	* `EPDFPage_CreateAnnot`) always produce indirect objects, so this
+	* error code is intentionally not used for engine-produced state;
+	* it specifically signals "this input file is broken in a way we
+	* cannot work around without compromising stable identity".
+	*
+	* Distinct from `DocOpenFailed` (PDFium refused to load the bytes
+	* at all) and `NotFound` (a well-formed page/annotation/etc. simply
+	* doesn't exist).
+	*/
+	MalformedPdf: "MalformedPdf"
+};
+//#endregion
+//#region src/annotation/subtype.ts
+/**
+* Closed-world string catalog of annotation subtypes the v3 wire format knows
+* about. The TypeScript discriminated union `AnnotationDTO` is keyed on this
+* literal type. PDFium's integer subtype code is mapped onto these strings
+* by the reader registry.
+*
+* `unsupported` is the forward-compat fallback for any PDF subtype that
+* the engine has not implemented a reader for yet. Unknown subtypes never
+* silently disappear from the wire — they round-trip as
+* `{ subtype: 'unsupported', rawSubtypeCode }`.
+*/
+const ANNOTATION_SUBTYPES = [
+	"text",
+	"link",
+	"free-text",
+	"line",
+	"square",
+	"circle",
+	"polygon",
+	"polyline",
+	"highlight",
+	"underline",
+	"squiggly",
+	"strikeout",
+	"stamp",
+	"caret",
+	"ink",
+	"popup",
+	"file-attachment",
+	"redact",
+	"widget",
+	"unsupported"
+];
+/**
+* PDFium subtype codes from `FPDFAnnot_GetSubtype`. Mirrors
+* `FPDF_ANNOTATION_SUBTYPE` in `public/fpdf_annot.h`. We keep this here
+* (rather than importing from @embedpdf/engine-runtime) so the engine-core
+* package has zero PDFium dependency.
+*/
+const PdfAnnotationSubtypeCode = {
+	UNKNOWN: 0,
+	TEXT: 1,
+	LINK: 2,
+	FREETEXT: 3,
+	LINE: 4,
+	SQUARE: 5,
+	CIRCLE: 6,
+	POLYGON: 7,
+	POLYLINE: 8,
+	HIGHLIGHT: 9,
+	UNDERLINE: 10,
+	SQUIGGLY: 11,
+	STRIKEOUT: 12,
+	STAMP: 13,
+	CARET: 14,
+	INK: 15,
+	POPUP: 16,
+	FILEATTACHMENT: 17,
+	SOUND: 18,
+	MOVIE: 19,
+	WIDGET: 20,
+	SCREEN: 21,
+	PRINTERMARK: 22,
+	TRAPNET: 23,
+	WATERMARK: 24,
+	THREED: 25,
+	RICHMEDIA: 26,
+	XFAWIDGET: 27,
+	REDACT: 28
+};
+/**
+* Map from PDFium codes to wire-stable string subtypes. Codes the engine
+* recognises as a v3 subtype (or maps to 'unsupported' if not yet wired).
+*/
+const PDF_CODE_TO_SUBTYPE = Object.freeze({
+	[PdfAnnotationSubtypeCode.TEXT]: "text",
+	[PdfAnnotationSubtypeCode.LINK]: "link",
+	[PdfAnnotationSubtypeCode.FREETEXT]: "free-text",
+	[PdfAnnotationSubtypeCode.LINE]: "line",
+	[PdfAnnotationSubtypeCode.SQUARE]: "square",
+	[PdfAnnotationSubtypeCode.CIRCLE]: "circle",
+	[PdfAnnotationSubtypeCode.POLYGON]: "polygon",
+	[PdfAnnotationSubtypeCode.POLYLINE]: "polyline",
+	[PdfAnnotationSubtypeCode.HIGHLIGHT]: "highlight",
+	[PdfAnnotationSubtypeCode.UNDERLINE]: "underline",
+	[PdfAnnotationSubtypeCode.SQUIGGLY]: "squiggly",
+	[PdfAnnotationSubtypeCode.STRIKEOUT]: "strikeout",
+	[PdfAnnotationSubtypeCode.STAMP]: "stamp",
+	[PdfAnnotationSubtypeCode.CARET]: "caret",
+	[PdfAnnotationSubtypeCode.INK]: "ink",
+	[PdfAnnotationSubtypeCode.POPUP]: "popup",
+	[PdfAnnotationSubtypeCode.FILEATTACHMENT]: "file-attachment",
+	[PdfAnnotationSubtypeCode.WIDGET]: "widget",
+	[PdfAnnotationSubtypeCode.REDACT]: "redact"
+});
+/**
+* Reverse map for write paths that need to turn a wire subtype back into the
+* PDFium integer code without importing the zod-backed annotation registry.
+*/
+const PDF_SUBTYPE_TO_CODE = Object.freeze({
+	text: PdfAnnotationSubtypeCode.TEXT,
+	link: PdfAnnotationSubtypeCode.LINK,
+	"free-text": PdfAnnotationSubtypeCode.FREETEXT,
+	line: PdfAnnotationSubtypeCode.LINE,
+	square: PdfAnnotationSubtypeCode.SQUARE,
+	circle: PdfAnnotationSubtypeCode.CIRCLE,
+	polygon: PdfAnnotationSubtypeCode.POLYGON,
+	polyline: PdfAnnotationSubtypeCode.POLYLINE,
+	highlight: PdfAnnotationSubtypeCode.HIGHLIGHT,
+	underline: PdfAnnotationSubtypeCode.UNDERLINE,
+	squiggly: PdfAnnotationSubtypeCode.SQUIGGLY,
+	strikeout: PdfAnnotationSubtypeCode.STRIKEOUT,
+	stamp: PdfAnnotationSubtypeCode.STAMP,
+	caret: PdfAnnotationSubtypeCode.CARET,
+	ink: PdfAnnotationSubtypeCode.INK,
+	popup: PdfAnnotationSubtypeCode.POPUP,
+	"file-attachment": PdfAnnotationSubtypeCode.FILEATTACHMENT,
+	redact: PdfAnnotationSubtypeCode.REDACT,
+	widget: PdfAnnotationSubtypeCode.WIDGET,
+	unsupported: PdfAnnotationSubtypeCode.UNKNOWN
+});
+function subtypeFromCode(code) {
+	return PDF_CODE_TO_SUBTYPE[code] ?? "unsupported";
+}
+//#endregion
+Object.defineProperty(exports, "ANNOTATION_SUBTYPES", {
+	enumerable: true,
+	get: function() {
+		return ANNOTATION_SUBTYPES;
+	}
+});
+Object.defineProperty(exports, "EngineErrorCode", {
+	enumerable: true,
+	get: function() {
+		return EngineErrorCode;
+	}
+});
+Object.defineProperty(exports, "PDF_CODE_TO_SUBTYPE", {
+	enumerable: true,
+	get: function() {
+		return PDF_CODE_TO_SUBTYPE;
+	}
+});
+Object.defineProperty(exports, "PDF_SUBTYPE_TO_CODE", {
+	enumerable: true,
+	get: function() {
+		return PDF_SUBTYPE_TO_CODE;
+	}
+});
+Object.defineProperty(exports, "PdfAnnotationSubtypeCode", {
+	enumerable: true,
+	get: function() {
+		return PdfAnnotationSubtypeCode;
+	}
+});
+Object.defineProperty(exports, "subtypeFromCode", {
+	enumerable: true,
+	get: function() {
+		return subtypeFromCode;
+	}
+});
+
+//# sourceMappingURL=subtype-qejjVr6h.cjs.map

package/dist/subtype-qejjVr6h.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"subtype-qejjVr6h.cjs","names":[],"sources":["../src/errors/EngineErrorCode.ts","../src/annotation/subtype.ts"],"sourcesContent":["export const EngineErrorCode = {\n  Unknown: 'Unknown',\n  InvalidArg: 'InvalidArg',\n  DocNotOpen: 'DocNotOpen',\n  DocOpenFailed: 'DocOpenFailed',\n  DocPasswordRequired: 'DocPasswordRequired',\n  DocPasswordIncorrect: 'DocPasswordIncorrect',\n  Aborted: 'Aborted',\n  Network: 'Network',\n  Unauthenticated: 'Unauthenticated',\n  Forbidden: 'Forbidden',\n  NotFound: 'NotFound',\n  WireFormat: 'WireFormat',\n  RuntimeUnavailable: 'RuntimeUnavailable',\n  /**\n   * Annotation/page reference could not be resolved. Surfaced when:\n   *   - `AnnotationRef.kind === 'objectNumber'` but the document has no\n   *     annotation with that indirect object number on the addressed page\n   *   - `AnnotationRef.kind === 'nm'` but no annotation on the page has\n   *     that `/NM`\n   *   - `AnnotationRef.kind === 'index'` but the supplied `RevisionToken`\n   *     does not match the current per-page generation\n   *   - `AnnotationRef.kind === 'index'` but `index` is out of range for\n   *     the page's current annotation count\n   */\n  InvalidReference: 'InvalidReference',\n  /**\n   * A weak-annotation structural edit (delete/move) was attempted while the\n   * caller does not have sole active edit presence for that page. This is a\n   * collaboration guard for index-addressed annotations; stable pages and\n   * non-shifting annotation updates do not use it.\n   */\n  WeakAnnotationSessionConflict: 'WeakAnnotationSessionConflict',\n  /**\n   * A layer write lost its optimistic-concurrency check: the layer's\n   * durable version advanced (another writer — typically another server\n   * replica — committed) between the operation's prepare and its commit,\n   * and the server exhausted its rebase-and-retry budget. Retryable: the\n   * operation was NOT applied; re-issue it against the new state.\n   */\n  LayerVersionConflict: 'LayerVersionConflict',\n  /**\n   * The requested operation is typed but not yet wired in this engine\n   * version. The wire shape stays valid; clients can detect this with\n   * `EngineError.is(err, EngineErrorCode.NotImplemented)` and degrade\n   * gracefully.\n   */\n  NotImplemented: 'NotImplemented',\n  /**\n   * The PDF was loadable enough for PDFium to parse, but violates a\n   * structural invariant the engine relies on. Surfaced for the rare\n   * spec-violating PDF that ships a direct (non-indirect) page\n   * dictionary in the /Pages tree — see `EPDFPage_GetObjectNumber`\n   * returning `0`. PDFium creation paths (`FPDFPage_New`,\n   * `EPDFPage_CreateAnnot`) always produce indirect objects, so this\n   * error code is intentionally not used for engine-produced state;\n   * it specifically signals \"this input file is broken in a way we\n   * cannot work around without compromising stable identity\".\n   *\n   * Distinct from `DocOpenFailed` (PDFium refused to load the bytes\n   * at all) and `NotFound` (a well-formed page/annotation/etc. simply\n   * doesn't exist).\n   */\n  MalformedPdf: 'MalformedPdf',\n} as const;\n\nexport type EngineErrorCode = (typeof EngineErrorCode)[keyof typeof EngineErrorCode];\n","/**\n * Closed-world string catalog of annotation subtypes the v3 wire format knows\n * about. The TypeScript discriminated union `AnnotationDTO` is keyed on this\n * literal type. PDFium's integer subtype code is mapped onto these strings\n * by the reader registry.\n *\n * `unsupported` is the forward-compat fallback for any PDF subtype that\n * the engine has not implemented a reader for yet. Unknown subtypes never\n * silently disappear from the wire — they round-trip as\n * `{ subtype: 'unsupported', rawSubtypeCode }`.\n */\nexport const ANNOTATION_SUBTYPES = [\n  'text',\n  'link',\n  'free-text',\n  'line',\n  'square',\n  'circle',\n  'polygon',\n  'polyline',\n  'highlight',\n  'underline',\n  'squiggly',\n  'strikeout',\n  'stamp',\n  'caret',\n  'ink',\n  'popup',\n  'file-attachment',\n  'redact',\n  'widget',\n  'unsupported',\n] as const;\n\nexport type AnnotationSubtype = (typeof ANNOTATION_SUBTYPES)[number];\n\n/**\n * PDFium subtype codes from `FPDFAnnot_GetSubtype`. Mirrors\n * `FPDF_ANNOTATION_SUBTYPE` in `public/fpdf_annot.h`. We keep this here\n * (rather than importing from @embedpdf/engine-runtime) so the engine-core\n * package has zero PDFium dependency.\n */\nexport const PdfAnnotationSubtypeCode = {\n  UNKNOWN: 0,\n  TEXT: 1,\n  LINK: 2,\n  FREETEXT: 3,\n  LINE: 4,\n  SQUARE: 5,\n  CIRCLE: 6,\n  POLYGON: 7,\n  POLYLINE: 8,\n  HIGHLIGHT: 9,\n  UNDERLINE: 10,\n  SQUIGGLY: 11,\n  STRIKEOUT: 12,\n  STAMP: 13,\n  CARET: 14,\n  INK: 15,\n  POPUP: 16,\n  FILEATTACHMENT: 17,\n  SOUND: 18,\n  MOVIE: 19,\n  WIDGET: 20,\n  SCREEN: 21,\n  PRINTERMARK: 22,\n  TRAPNET: 23,\n  WATERMARK: 24,\n  THREED: 25,\n  RICHMEDIA: 26,\n  XFAWIDGET: 27,\n  REDACT: 28,\n} as const;\n\nexport type PdfAnnotationSubtypeCode =\n  (typeof PdfAnnotationSubtypeCode)[keyof typeof PdfAnnotationSubtypeCode];\n\n/**\n * Map from PDFium codes to wire-stable string subtypes. Codes the engine\n * recognises as a v3 subtype (or maps to 'unsupported' if not yet wired).\n */\nexport const PDF_CODE_TO_SUBTYPE: Readonly<Record<number, AnnotationSubtype>> = Object.freeze({\n  [PdfAnnotationSubtypeCode.TEXT]: 'text',\n  [PdfAnnotationSubtypeCode.LINK]: 'link',\n  [PdfAnnotationSubtypeCode.FREETEXT]: 'free-text',\n  [PdfAnnotationSubtypeCode.LINE]: 'line',\n  [PdfAnnotationSubtypeCode.SQUARE]: 'square',\n  [PdfAnnotationSubtypeCode.CIRCLE]: 'circle',\n  [PdfAnnotationSubtypeCode.POLYGON]: 'polygon',\n  [PdfAnnotationSubtypeCode.POLYLINE]: 'polyline',\n  [PdfAnnotationSubtypeCode.HIGHLIGHT]: 'highlight',\n  [PdfAnnotationSubtypeCode.UNDERLINE]: 'underline',\n  [PdfAnnotationSubtypeCode.SQUIGGLY]: 'squiggly',\n  [PdfAnnotationSubtypeCode.STRIKEOUT]: 'strikeout',\n  [PdfAnnotationSubtypeCode.STAMP]: 'stamp',\n  [PdfAnnotationSubtypeCode.CARET]: 'caret',\n  [PdfAnnotationSubtypeCode.INK]: 'ink',\n  [PdfAnnotationSubtypeCode.POPUP]: 'popup',\n  [PdfAnnotationSubtypeCode.FILEATTACHMENT]: 'file-attachment',\n  [PdfAnnotationSubtypeCode.WIDGET]: 'widget',\n  [PdfAnnotationSubtypeCode.REDACT]: 'redact',\n});\n\n/**\n * Reverse map for write paths that need to turn a wire subtype back into the\n * PDFium integer code without importing the zod-backed annotation registry.\n */\nexport const PDF_SUBTYPE_TO_CODE: Readonly<Record<AnnotationSubtype, PdfAnnotationSubtypeCode>> =\n  Object.freeze({\n    text: PdfAnnotationSubtypeCode.TEXT,\n    link: PdfAnnotationSubtypeCode.LINK,\n    'free-text': PdfAnnotationSubtypeCode.FREETEXT,\n    line: PdfAnnotationSubtypeCode.LINE,\n    square: PdfAnnotationSubtypeCode.SQUARE,\n    circle: PdfAnnotationSubtypeCode.CIRCLE,\n    polygon: PdfAnnotationSubtypeCode.POLYGON,\n    polyline: PdfAnnotationSubtypeCode.POLYLINE,\n    highlight: PdfAnnotationSubtypeCode.HIGHLIGHT,\n    underline: PdfAnnotationSubtypeCode.UNDERLINE,\n    squiggly: PdfAnnotationSubtypeCode.SQUIGGLY,\n    strikeout: PdfAnnotationSubtypeCode.STRIKEOUT,\n    stamp: PdfAnnotationSubtypeCode.STAMP,\n    caret: PdfAnnotationSubtypeCode.CARET,\n    ink: PdfAnnotationSubtypeCode.INK,\n    popup: PdfAnnotationSubtypeCode.POPUP,\n    'file-attachment': PdfAnnotationSubtypeCode.FILEATTACHMENT,\n    redact: PdfAnnotationSubtypeCode.REDACT,\n    widget: PdfAnnotationSubtypeCode.WIDGET,\n    unsupported: PdfAnnotationSubtypeCode.UNKNOWN,\n  });\n\nexport function subtypeFromCode(code: number): AnnotationSubtype {\n  return PDF_CODE_TO_SUBTYPE[code] ?? 'unsupported';\n}\n"],"mappings":";AAAA,MAAa,kBAAkB;CAC7B,SAAS;CACT,YAAY;CACZ,YAAY;CACZ,eAAe;CACf,qBAAqB;CACrB,sBAAsB;CACtB,SAAS;CACT,SAAS;CACT,iBAAiB;CACjB,WAAW;CACX,UAAU;CACV,YAAY;CACZ,oBAAoB;;;;;;;;;;;;CAYpB,kBAAkB;;;;;;;CAOlB,+BAA+B;;;;;;;;CAQ/B,sBAAsB;;;;;;;CAOtB,gBAAgB;;;;;;;;;;;;;;;;CAgBhB,cAAc;AAChB;;;;;;;;;;;;;;ACrDA,MAAa,sBAAsB;CACjC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;;;;;;AAUA,MAAa,2BAA2B;CACtC,SAAS;CACT,MAAM;CACN,MAAM;CACN,UAAU;CACV,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,UAAU;CACV,WAAW;CACX,WAAW;CACX,UAAU;CACV,WAAW;CACX,OAAO;CACP,OAAO;CACP,KAAK;CACL,OAAO;CACP,gBAAgB;CAChB,OAAO;CACP,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,aAAa;CACb,SAAS;CACT,WAAW;CACX,QAAQ;CACR,WAAW;CACX,WAAW;CACX,QAAQ;AACV;;;;;AASA,MAAa,sBAAmE,OAAO,OAAO;EAC3F,yBAAyB,OAAO;EAChC,yBAAyB,OAAO;EAChC,yBAAyB,WAAW;EACpC,yBAAyB,OAAO;EAChC,yBAAyB,SAAS;EAClC,yBAAyB,SAAS;EAClC,yBAAyB,UAAU;EACnC,yBAAyB,WAAW;EACpC,yBAAyB,YAAY;EACrC,yBAAyB,YAAY;EACrC,yBAAyB,WAAW;EACpC,yBAAyB,YAAY;EACrC,yBAAyB,QAAQ;EACjC,yBAAyB,QAAQ;EACjC,yBAAyB,MAAM;EAC/B,yBAAyB,QAAQ;EACjC,yBAAyB,iBAAiB;EAC1C,yBAAyB,SAAS;EAClC,yBAAyB,SAAS;AACrC,CAAC;;;;;AAMD,MAAa,sBACX,OAAO,OAAO;CACZ,MAAM,yBAAyB;CAC/B,MAAM,yBAAyB;CAC/B,aAAa,yBAAyB;CACtC,MAAM,yBAAyB;CAC/B,QAAQ,yBAAyB;CACjC,QAAQ,yBAAyB;CACjC,SAAS,yBAAyB;CAClC,UAAU,yBAAyB;CACnC,WAAW,yBAAyB;CACpC,WAAW,yBAAyB;CACpC,UAAU,yBAAyB;CACnC,WAAW,yBAAyB;CACpC,OAAO,yBAAyB;CAChC,OAAO,yBAAyB;CAChC,KAAK,yBAAyB;CAC9B,OAAO,yBAAyB;CAChC,mBAAmB,yBAAyB;CAC5C,QAAQ,yBAAyB;CACjC,QAAQ,yBAAyB;CACjC,aAAa,yBAAyB;AACxC,CAAC;AAEH,SAAgB,gBAAgB,MAAiC;CAC/D,OAAO,oBAAoB,SAAS;AACtC"}