@embedpdf/engine-core 3.0.0-next.10 → 3.0.0-next.12

package/dist/{schemas-D1pxEv3t.cjs → schemas-RChsAMWw.cjs}

@@ -44,34 +44,139 @@ const PdfRotationSchema = zod.z.union([
 	zod.z.literal(270)
 ]);
 //#endregion
-//#region src/dto/PdfAction.schema.ts
-const PdfActionTypeSchema = zod.z.enum([
-	"unknown",
-	"goto",
-	"goto-remote",
-	"goto-embedded",
-	"launch",
-	"thread",
-	"uri",
-	"sound",
-	"movie",
-	"hide",
-	"named",
-	"submit-form",
-	"reset-form",
-	"import-data",
-	"javascript",
-	"set-ocg-state",
-	"rendition",
-	"transition",
-	"goto-3d-view"
+//#region src/dto/PdfDestination.schema.ts
+const pageObjectNumber = zod.z.number().int().positive();
+/** Spec-nullable axis value: absent and `null` both mean "retain current". */
+const axis = zod.z.number().nullable().optional();
+/**
+* Runtime schema for {@link PdfDestination}. Lives beside its DTO in `dto/`
+* so every destination-shaped surface (link targets, action-node payloads,
+* the document `openDestination`) shares one schema without an import cycle
+* through the annotation tree.
+*/
+const PdfDestinationSchema = zod.z.discriminatedUnion("kind", [
+	zod.z.object({
+		kind: zod.z.literal("xyz"),
+		pageObjectNumber,
+		left: axis,
+		top: axis,
+		zoom: axis
+	}),
+	zod.z.object({
+		kind: zod.z.literal("fit"),
+		pageObjectNumber
+	}),
+	zod.z.object({
+		kind: zod.z.literal("fitH"),
+		pageObjectNumber,
+		top: axis
+	}),
+	zod.z.object({
+		kind: zod.z.literal("fitV"),
+		pageObjectNumber,
+		left: axis
+	}),
+	zod.z.object({
+		kind: zod.z.literal("fitR"),
+		pageObjectNumber,
+		left: zod.z.number(),
+		bottom: zod.z.number(),
+		right: zod.z.number(),
+		top: zod.z.number()
+	}),
+	zod.z.object({
+		kind: zod.z.literal("fitB"),
+		pageObjectNumber
+	}),
+	zod.z.object({
+		kind: zod.z.literal("fitBH"),
+		pageObjectNumber,
+		top: axis
+	}),
+	zod.z.object({
+		kind: zod.z.literal("fitBV"),
+		pageObjectNumber,
+		left: axis
+	})
 ]);
-const PdfActionNodeSchema = zod.z.lazy(() => zod.z.object({
-	type: PdfActionTypeSchema,
+//#endregion
+//#region src/dto/PdfAction.schema.ts
+const PdfActionTargetRefSchema = zod.z.discriminatedUnion("kind", [zod.z.object({
+	kind: zod.z.literal("name"),
+	name: zod.z.string()
+}), zod.z.object({
+	kind: zod.z.literal("objectNumber"),
+	objectNumber: zod.z.number().int().positive()
+})]);
+/** Fields every node arm repeats — zod 3's discriminatedUnion needs plain
+*  object options, so the recursion (`next`) lives inline per arm and the
+*  whole union sits behind one `z.lazy`. */
+const nodeCommon = {
 	subtype: zod.z.string(),
-	script: zod.z.string().optional(),
-	next: zod.z.array(PdfActionNodeSchema)
-}));
+	next: zod.z.array(zod.z.lazy(() => PdfActionNodeSchema))
+};
+const arm = (type, shape = {}) => zod.z.object({
+	type: zod.z.literal(type),
+	...nodeCommon,
+	...shape
+});
+const SubmitFormFlagsSchema = zod.z.object({
+	raw: zod.z.number().int().nonnegative(),
+	exclude: zod.z.boolean(),
+	includeNoValueFields: zod.z.boolean(),
+	format: zod.z.enum([
+		"fdf",
+		"html",
+		"xfdf",
+		"pdf"
+	]),
+	method: zod.z.enum(["post", "get"]),
+	submitCoordinates: zod.z.boolean(),
+	includeAppendSaves: zod.z.boolean(),
+	includeAnnotations: zod.z.boolean(),
+	canonicalFormat: zod.z.boolean(),
+	exclNonUserAnnots: zod.z.boolean(),
+	exclFKey: zod.z.boolean(),
+	embedForm: zod.z.boolean()
+});
+const PDF_ACTION_NODE_ARMS = [
+	arm("javascript", { script: zod.z.string() }),
+	arm("goto", { destination: PdfDestinationSchema }),
+	arm("uri", {
+		uri: zod.z.string(),
+		isMap: zod.z.boolean()
+	}),
+	arm("named", { name: zod.z.string() }),
+	arm("hide", {
+		targets: zod.z.array(PdfActionTargetRefSchema),
+		hide: zod.z.boolean()
+	}),
+	arm("reset-form", {
+		fields: zod.z.array(PdfActionTargetRefSchema).nullable(),
+		exclude: zod.z.boolean()
+	}),
+	arm("goto-remote", { filePath: zod.z.string() }),
+	arm("goto-embedded", { filePath: zod.z.string() }),
+	arm("launch", { filePath: zod.z.string() }),
+	arm("rendition", { script: zod.z.string().optional() }),
+	arm("submit-form", { payload: zod.z.object({
+		url: zod.z.string(),
+		fields: zod.z.array(PdfActionTargetRefSchema).nullable(),
+		flags: SubmitFormFlagsSchema,
+		charSet: zod.z.string().optional()
+	}).optional() }),
+	arm("thread"),
+	arm("sound"),
+	arm("movie"),
+	arm("import-data"),
+	arm("set-ocg-state"),
+	arm("transition"),
+	arm("goto-3d-view"),
+	arm("unknown")
+];
+const PdfActionNodeSchema = zod.z.lazy(() => zod.z.discriminatedUnion("type", [...PDF_ACTION_NODE_ARMS]));
+/** The `/S` vocabulary, derived from the union arms so it cannot drift. */
+const PdfActionTypeSchema = zod.z.enum(PDF_ACTION_NODE_ARMS.map((option) => option.shape.type.value));
 const PdfActionTreeSchema = zod.z.object({
 	root: PdfActionNodeSchema.nullable(),
 	incomplete: zod.z.boolean(),
@@ -79,7 +184,8 @@ const PdfActionTreeSchema = zod.z.object({
 	warnings: zod.z.array(zod.z.enum([
 		"cycle-dropped",
 		"malformed-next",
-		"incomplete"
+		"incomplete",
+		"payload-dropped"
 	]))
 });
 const PdfFieldActionsSchema = zod.z.object({
@@ -111,12 +217,34 @@ const DocumentActionsSnapshotSchema = zod.z.object({
 		action: PdfActionTreeSchema
 	})),
 	openAction: PdfActionTreeSchema.nullable(),
+	openDestination: PdfDestinationSchema.nullable().default(null),
 	willClose: PdfActionTreeSchema.optional(),
 	willSave: PdfActionTreeSchema.optional(),
 	didSave: PdfActionTreeSchema.optional(),
 	willPrint: PdfActionTreeSchema.optional(),
 	didPrint: PdfActionTreeSchema.optional()
+}).superRefine((snapshot, context) => {
+	if (snapshot.openAction !== null && (snapshot.openDestination ?? null) !== null) context.addIssue({
+		code: zod.z.ZodIssueCode.custom,
+		message: "openAction and openDestination are mutually exclusive",
+		path: ["openDestination"]
+	});
 });
+/**
+* Stable public component names for generators that project the action wire
+* model into OpenAPI or another schema format. Keep reusable boundaries here;
+* individual action arms remain owned by `PdfActionNodeSchema`.
+*/
+const PdfActionWireComponents = {
+	PdfActionTargetRef: PdfActionTargetRefSchema,
+	PdfDestination: PdfDestinationSchema,
+	PdfActionNode: PdfActionNodeSchema,
+	PdfActionTree: PdfActionTreeSchema,
+	PdfFieldActions: PdfFieldActionsSchema,
+	PdfPageActions: PdfPageActionsSchema,
+	PdfAnnotationActions: PdfAnnotationActionsSchema,
+	DocumentActionsSnapshot: DocumentActionsSnapshotSchema
+};
 //#endregion
 //#region src/annotation/base.schema.ts
 /** @deprecated Use `PdfPointSchema` from `../geometry/schemas`. */
@@ -725,58 +853,6 @@ const LineKind = {
 };
 //#endregion
 //#region src/annotation/kinds/link/schema.ts
-const pageObjectNumber = zod.z.number().int().positive();
-/** Spec-nullable axis value: absent and `null` both mean "retain current". */
-const axis = zod.z.number().nullable().optional();
-/**
-* Runtime schema for {@link PdfDestination}. Lives with the link kind (its
-* first wire consumer); the outline/bookmark port reuses it from here.
-*/
-const PdfDestinationSchema = zod.z.discriminatedUnion("kind", [
-	zod.z.object({
-		kind: zod.z.literal("xyz"),
-		pageObjectNumber,
-		left: axis,
-		top: axis,
-		zoom: axis
-	}),
-	zod.z.object({
-		kind: zod.z.literal("fit"),
-		pageObjectNumber
-	}),
-	zod.z.object({
-		kind: zod.z.literal("fitH"),
-		pageObjectNumber,
-		top: axis
-	}),
-	zod.z.object({
-		kind: zod.z.literal("fitV"),
-		pageObjectNumber,
-		left: axis
-	}),
-	zod.z.object({
-		kind: zod.z.literal("fitR"),
-		pageObjectNumber,
-		left: zod.z.number(),
-		bottom: zod.z.number(),
-		right: zod.z.number(),
-		top: zod.z.number()
-	}),
-	zod.z.object({
-		kind: zod.z.literal("fitB"),
-		pageObjectNumber
-	}),
-	zod.z.object({
-		kind: zod.z.literal("fitBH"),
-		pageObjectNumber,
-		top: axis
-	}),
-	zod.z.object({
-		kind: zod.z.literal("fitBV"),
-		pageObjectNumber,
-		left: axis
-	})
-]);
 const GotoTargetSchema = zod.z.object({
 	kind: zod.z.literal("goto"),
 	destination: PdfDestinationSchema
@@ -1050,7 +1126,7 @@ const StampWireDraftSchema = zod.z.object({
 	...AnnotationDraftBaseShape,
 	rect: PdfRectSchema,
 	source: ResourceRefSchema,
-	name: zod.z.string().optional(),
+	name: zod.z.string().min(1).optional(),
 	fit: StampFitSchema.optional(),
 	rotation: zod.z.number().nullable().optional(),
 	unrotatedRect: PdfRectSchema.nullable().optional(),
@@ -1060,7 +1136,7 @@ const StampWirePatchSchema = zod.z.object({
 	...AnnotationPatchBaseShape,
 	rect: PdfRectSchema.optional(),
 	source: ResourceRefSchema.optional(),
-	name: zod.z.string().optional(),
+	name: zod.z.string().min(1).nullable().optional(),
 	fit: StampFitSchema.optional(),
 	rotation: zod.z.number().nullable().optional(),
 	unrotatedRect: PdfRectSchema.nullable().optional(),
@@ -2415,6 +2491,23 @@ const PageFlattenResultSchema = zod.z.object({
 	})),
 	meta: MutationMetaSchema.nullable()
 });
+/** See `AnnotationFlattenResult`. */
+const AnnotationFlattenResultSchema = zod.z.object({
+	pageObjectNumber: zod.z.number().int().positive(),
+	usage: zod.z.enum(["display", "print"]),
+	results: zod.z.array(zod.z.object({
+		ref: AnnotationRefSchema,
+		status: zod.z.enum(["applied", "skipped"])
+	})),
+	meta: MutationMetaSchema.nullable()
+});
+/** `annotations.flatten` input — see `AnnotationFlattenInput`. */
+const AnnotationFlattenInputSchema = zod.z.object({
+	refs: zod.z.array(AnnotationRefSchema).min(1),
+	usage: zod.z.enum(["display", "print"])
+});
+/** `annotations.exportAppearance` input — see `AnnotationAppearanceExportInput`. */
+const AnnotationAppearanceExportInputSchema = zod.z.object({ refs: zod.z.array(AnnotationRefSchema).min(1) });
 const PageFlattenInputSchema = zod.z.object({
 	pageObjectNumbers: zod.z.array(zod.z.number().int().positive()),
 	usage: zod.z.enum(["display", "print"])
@@ -2447,10 +2540,34 @@ const RedactionApplyResultSchema = zod.z.object({
 * `pageObjectNumber` everywhere except the per-element `index`, which is
 * display order and intentionally not an identity. Carries geometry only.
 */
+/** See `NamedPageEntry`: decoded key + what it resolves to. */
+const NamedPageEntrySchema = zod.z.object({
+	name: zod.z.string(),
+	target: zod.z.discriminatedUnion("kind", [
+		zod.z.object({
+			kind: zod.z.literal("page"),
+			pageObjectNumber: zod.z.number().int().positive()
+		}),
+		zod.z.object({
+			kind: zod.z.literal("template"),
+			objectNumber: zod.z.number().int().positive()
+		}),
+		zod.z.object({ kind: zod.z.literal("dangling") })
+	])
+});
 const PageListSnapshotSchema = zod.z.object({
 	pageCount: zod.z.number().int().nonnegative(),
-	pages: zod.z.array(PageLayoutSchema)
+	pages: zod.z.array(PageLayoutSchema),
+	namedPages: zod.z.array(NamedPageEntrySchema).optional()
+});
+/** `pages.setName` input — see `PageNameInput`. */
+const PageNameInputSchema = zod.z.object({
+	name: zod.z.string().min(1),
+	pageObjectNumber: zod.z.number().int().positive(),
+	replace: zod.z.string().min(1).optional()
 });
+/** `pages.removeName` input — see `PageRemoveNameInput`. */
+const PageRemoveNameInputSchema = zod.z.object({ name: zod.z.string().min(1) });
 /**
 * Page reorder input. Pages are always addressed by `pageObjectNumber`;
 * `destIndex` is the insertion point in the post-removal index space.
@@ -2477,6 +2594,11 @@ const PageMoveResultSchema = zod.z.object({
 	layout: PageListSnapshotSchema,
 	cache: PageStructureCacheSchema.nullable()
 });
+/** Named-page mutation result — layout-shaped, see `PageNameResult`. */
+const PageNameResultSchema = zod.z.object({
+	layout: PageListSnapshotSchema,
+	cache: PageStructureCacheSchema.nullable()
+});
 /**
 * Page rotate input. ABSOLUTE rotation (idempotent — see `PageRotateInput`),
 * one value applied to every listed page.
@@ -2588,6 +2710,12 @@ Object.defineProperty(exports, "AccessResponseSchema", {
 		return AccessResponseSchema;
 	}
 });
+Object.defineProperty(exports, "AnnotationAppearanceExportInputSchema", {
+	enumerable: true,
+	get: function() {
+		return AnnotationAppearanceExportInputSchema;
+	}
+});
 Object.defineProperty(exports, "AnnotationAppearanceManifestSchema", {
 	enumerable: true,
 	get: function() {
@@ -2654,6 +2782,18 @@ Object.defineProperty(exports, "AnnotationFlagsSchema", {
 		return AnnotationFlagsSchema;
 	}
 });
+Object.defineProperty(exports, "AnnotationFlattenInputSchema", {
+	enumerable: true,
+	get: function() {
+		return AnnotationFlattenInputSchema;
+	}
+});
+Object.defineProperty(exports, "AnnotationFlattenResultSchema", {
+	enumerable: true,
+	get: function() {
+		return AnnotationFlattenResultSchema;
+	}
+});
 Object.defineProperty(exports, "AnnotationListMutationMetaSchema", {
 	enumerable: true,
 	get: function() {
@@ -3176,6 +3316,12 @@ Object.defineProperty(exports, "MutationMetaSchema", {
 		return MutationMetaSchema;
 	}
 });
+Object.defineProperty(exports, "NamedPageEntrySchema", {
+	enumerable: true,
+	get: function() {
+		return NamedPageEntrySchema;
+	}
+});
 Object.defineProperty(exports, "NoteIconSchema", {
 	enumerable: true,
 	get: function() {
@@ -3272,12 +3418,30 @@ Object.defineProperty(exports, "PageMoveResultSchema", {
 		return PageMoveResultSchema;
 	}
 });
+Object.defineProperty(exports, "PageNameInputSchema", {
+	enumerable: true,
+	get: function() {
+		return PageNameInputSchema;
+	}
+});
+Object.defineProperty(exports, "PageNameResultSchema", {
+	enumerable: true,
+	get: function() {
+		return PageNameResultSchema;
+	}
+});
 Object.defineProperty(exports, "PageNetworkRenderFormatSchema", {
 	enumerable: true,
 	get: function() {
 		return PageNetworkRenderFormatSchema;
 	}
 });
+Object.defineProperty(exports, "PageRemoveNameInputSchema", {
+	enumerable: true,
+	get: function() {
+		return PageRemoveNameInputSchema;
+	}
+});
 Object.defineProperty(exports, "PageRenderAnnotatedQuerySchema", {
 	enumerable: true,
 	get: function() {
@@ -3326,6 +3490,12 @@ Object.defineProperty(exports, "PdfActionNodeSchema", {
 		return PdfActionNodeSchema;
 	}
 });
+Object.defineProperty(exports, "PdfActionTargetRefSchema", {
+	enumerable: true,
+	get: function() {
+		return PdfActionTargetRefSchema;
+	}
+});
 Object.defineProperty(exports, "PdfActionTreeSchema", {
 	enumerable: true,
 	get: function() {
@@ -3338,6 +3508,12 @@ Object.defineProperty(exports, "PdfActionTypeSchema", {
 		return PdfActionTypeSchema;
 	}
 });
+Object.defineProperty(exports, "PdfActionWireComponents", {
+	enumerable: true,
+	get: function() {
+		return PdfActionWireComponents;
+	}
+});
 Object.defineProperty(exports, "PdfAnnotationActionsSchema", {
 	enumerable: true,
 	get: function() {
@@ -3711,4 +3887,4 @@ Object.defineProperty(exports, "WireAttachmentFileSchema", {
 	}
 });
 
-//# sourceMappingURL=schemas-D1pxEv3t.cjs.map
+//# sourceMappingURL=schemas-RChsAMWw.cjs.map