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

package/dist/wire.cjs

@@ -1,6 +1,6 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_resolver = require("./resolver-DAZWVoJL.cjs");
-const require_schemas = require("./schemas-B_1VyFsm.cjs");
+const require_schemas = require("./schemas-D1pxEv3t.cjs");
 //#region src/wire/token.ts
 const DEFAULT_MAX_TOKEN_LENGTH = 256;
 const FIELD_NAME_RE = /^[A-Za-z][A-Za-z0-9]*(?:\.[A-Za-z][A-Za-z0-9]*)*$/;
@@ -76,6 +76,9 @@ const ContentTokenSchema = { fields: ["contentVersion"] };
 const LayoutTokenSchema = { fields: ["layoutVersion"] };
 const MetadataTokenSchema = { fields: ["metadataVersion"] };
 const AnnotationTokenSchema = { fields: ["annotationVersion"] };
+/** Doc-level bulk annotations listing pin (plural, vs the per-page
+*  `annotationVersion` token above). */
+const AnnotationsAllTokenSchema = { fields: ["annotationsVersion"] };
 const ActionsTokenSchema = { fields: ["actionsVersion"] };
 const AttachmentsTokenSchema = { fields: ["attachmentsVersion"] };
 const DownloadTokenSchema = {
@@ -128,6 +131,7 @@ const RenderTokenSchema = {
 const SearchTokenSchema = {
 	fields: [
 		"epoch",
+		"format",
 		"matchCase",
 		"matchDiacritics",
 		"maxMatches",
@@ -170,6 +174,8 @@ const encodeMetadataToken = (metadataVersion) => encodeToken(MetadataTokenSchema
 const decodeMetadataToken = (raw) => decodePositiveInteger(decodeToken(MetadataTokenSchema, raw).metadataVersion, "metadataVersion");
 const encodeAnnotationToken = (annotationVersion) => encodeToken(AnnotationTokenSchema, { annotationVersion });
 const decodeAnnotationToken = (raw) => decodePositiveInteger(decodeToken(AnnotationTokenSchema, raw).annotationVersion, "annotationVersion");
+const encodeAnnotationsAllToken = (annotationsVersion) => encodeToken(AnnotationsAllTokenSchema, { annotationsVersion });
+const decodeAnnotationsAllToken = (raw) => decodePositiveInteger(decodeToken(AnnotationsAllTokenSchema, raw).annotationsVersion, "annotationsVersion");
 const encodeActionsToken = (actionsVersion) => encodeToken(ActionsTokenSchema, { actionsVersion });
 const decodeActionsToken = (raw) => decodePositiveInteger(decodeToken(ActionsTokenSchema, raw).actionsVersion, "actionsVersion");
 const encodeAttachmentsToken = (attachmentsVersion) => encodeToken(AttachmentsTokenSchema, { attachmentsVersion });
@@ -209,10 +215,20 @@ const decodeRenderToken = (raw) => decodeToken(RenderTokenSchema, raw);
 const encodeAnnotationAppearancesRenderToken = (input) => encodeToken(AnnotationAppearancesRenderTokenSchema, input);
 /** Decode an annotation-appearance render token to a flat field map. */
 const decodeAnnotationAppearancesRenderToken = (raw) => decodeToken(AnnotationAppearancesRenderTokenSchema, raw);
+/**
+* The search RESULT representation this client speaks — part of the token
+* (and therefore the versioned URL), so a response-shape change can never
+* serve a stale CDN body to a newer client: new tokens are new cache keys,
+* and old tokens fail decode on new servers. Deliberately ALWAYS encoded —
+* an exception to the omit-defaults rule, because its entire job is to
+* change the token bytes when the format changes.
+*/
+const SEARCH_RESULT_FORMAT = "segments1";
 const encodeSearchToken = (input) => {
 	const q = input.query;
 	return encodeToken(SearchTokenSchema, {
 		epoch: input.epoch,
+		format: SEARCH_RESULT_FORMAT,
 		q: encodeTokenText(q.text),
 		regex: q.regex ? true : void 0,
 		matchCase: q.matchCase ? true : void 0,
@@ -228,6 +244,7 @@ const decodeSearchToken = (raw) => {
 	const t = decodeToken(SearchTokenSchema, raw);
 	if (t.epoch === void 0) throw new Error("search token is missing \"epoch\"");
 	if (t.q === void 0) throw new Error("search token is missing \"q\"");
+	if (t.format !== "segments1") throw new Error(`search token has unsupported result format "${t.format ?? "legacy"}" (expected "${SEARCH_RESULT_FORMAT}")`);
 	const query = {
 		text: decodeTokenText(t.q),
 		...t.regex === "true" ? { regex: true } : {},
@@ -342,8 +359,21 @@ function decodePdfSaveMode(raw) {
 */
 const DEFAULT_LAYER_NAME = "default";
 const wirePaths = {
-	/** POST: grant document access/caching credentials for the current bearer. */
-	access: "/v1/access",
+	/**
+	* POST: grant access/caching credentials for the current bearer on
+	* the document + layer namespace the path names (cross-checked
+	* against the token like every layer route — the grant is
+	* layer-scoped in substance: CDN coverage, scopes, and the client's
+	* binding all carry the layer). Path-addressed so the affinity tier —
+	* the `X-CloudPDF-Doc` header derivation AND the chart's uri-mode
+	* regex — pins the session bootstrap to the document's pod from the
+	* very first request. Default-layer callers spell `layers/default/`,
+	* same as every other layer route.
+	*/
+	access: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/access`,
+	/** Deprecated alias (docId in the BODY) — served for one prerelease
+	*  cycle so pre-rename clients keep working; remove after. */
+	accessLegacy: "/v1/access",
 	/**
 	* GET: open the document referenced by the doc-scoped JWT and
 	* return its `DocumentHead`. The server materialises the base
@@ -480,6 +510,8 @@ const wirePaths = {
 	* object served from the base worker session.
 	*/
 	docPageAnnotations: (docId, pageObjectNumber, annotationVersion) => `/v1/docs/${encodeURIComponent(docId)}/annotations/pages/${pageObjectNumber}/items@${encodeAnnotationToken(annotationVersion)}`,
+	/** Immutable BASE whole-document annotation listing (bulk hydration). */
+	docAnnotationsAll: (docId, annotationsVersion) => `/v1/docs/${encodeURIComponent(docId)}/annotations/items@${encodeAnnotationsAllToken(annotationsVersion)}`,
 	/** Immutable BASE appearance batch (twin of
 	*  `layerPageAnnotationAppearances` — same `annotations` plane gate). */
 	docPageAnnotationAppearances: (docId, pageObjectNumber, token) => `/v1/docs/${encodeURIComponent(docId)}/annotations/pages/${pageObjectNumber}/appearances@${encodeAnnotationAppearancesRenderToken(token)}`,
@@ -490,6 +522,8 @@ const wirePaths = {
 	* collection name — see file-level docstring.
 	*/
 	layerPageAnnotations: (docId, layerName, pageObjectNumber, annotationVersion) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/annotations/pages/${pageObjectNumber}/items@${encodeAnnotationToken(annotationVersion)}`,
+	/** Immutable LAYER whole-document annotation listing (bulk hydration). */
+	layerAnnotationsAll: (docId, layerName, annotationsVersion) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/annotations/items@${encodeAnnotationsAllToken(annotationsVersion)}`,
 	layerPageAnnotationsCurrent: (docId, layerName, pageObjectNumber) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/annotations/pages/${pageObjectNumber}/items`,
 	/**
 	* GET: batch-rendered annotation appearance bitmaps for a single page as a
@@ -568,6 +602,20 @@ const wirePaths = {
 	layerPagesRotate: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/pages/rotate`,
 	layerPagesDelete: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/pages/delete`,
 	layerPagesFlatten: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/pages/flatten`,
+	/**
+	* POST (multipart mutation envelope): copy every page of the `source`
+	* resource part (a standalone PDF) in at the body's `destIndex`.
+	*/
+	layerPagesInsert: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/pages/insert`,
+	/** POST (plain JSON): create blank pages — pages.insert minus the bytes. */
+	layerPagesInsertBlank: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/pages/insert-blank`,
+	/**
+	* POST (plain JSON → `application/pdf` bytes): export the listed pages,
+	* in caller order, as a standalone PDF. A READ over the current layer
+	* state (gated like /download), so it is a POST only for its body —
+	* nothing mutates and no event is published.
+	*/
+	layerPagesExtract: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/pages/extract`,
 	layerRedactionsApply: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/redactions/apply`,
 	layerEvents: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/events`,
 	layerDownload: (docId, layerName) => `/v1/docs/${encodeURIComponent(docId)}/layers/${encodeURIComponent(layerName)}/download`,
@@ -587,6 +635,38 @@ const wirePaths = {
 	*/
 	docWarm: "/v1/warm"
 };
+/**
+* Fastify-style templates for the PLAIN (unversioned) doc-plane routes —
+* the backend-callable subset that the `@cloudpdf/contract` contract
+* documents. The immutable `@{version}` variants above remain viewer
+* protocol and are deliberately absent. These templates are the single
+* statement of those paths: the contract package imports them, and the
+* server's route table is pinned to them by the doc-plane registry
+* conformance test.
+*/
+const wireTemplates = {
+	docHead: "/v1/docs/:docId/head",
+	layerManifest: "/v1/docs/:docId/layers/:layerName/manifest",
+	layerMetadata: "/v1/docs/:docId/layers/:layerName/metadata",
+	layerRenderPage: "/v1/docs/:docId/layers/:layerName/render/pages/:pon/data",
+	layerTextPage: "/v1/docs/:docId/layers/:layerName/text/pages/:pon/data",
+	layerAnnotationItemsAll: "/v1/docs/:docId/layers/:layerName/annotations/items",
+	layerAnnotationItems: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items",
+	layerAnnotationItem: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/:annotKey",
+	layerForm: "/v1/docs/:docId/layers/:layerName/form",
+	layerFormFieldValue: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/value",
+	layerFormFieldReset: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/reset",
+	layerFormData: "/v1/docs/:docId/layers/:layerName/form/data",
+	layerPagesMove: "/v1/docs/:docId/layers/:layerName/pages/move",
+	layerPagesRotate: "/v1/docs/:docId/layers/:layerName/pages/rotate",
+	layerPagesDelete: "/v1/docs/:docId/layers/:layerName/pages/delete",
+	layerPagesFlatten: "/v1/docs/:docId/layers/:layerName/pages/flatten",
+	layerPagesInsert: "/v1/docs/:docId/layers/:layerName/pages/insert",
+	layerPagesInsertBlank: "/v1/docs/:docId/layers/:layerName/pages/insert-blank",
+	layerPagesExtract: "/v1/docs/:docId/layers/:layerName/pages/extract",
+	layerRedactionsApply: "/v1/docs/:docId/layers/:layerName/redactions/apply",
+	layerDownload: "/v1/docs/:docId/layers/:layerName/download"
+};
 //#endregion
 //#region src/wire/resources.ts
 /**
@@ -674,6 +754,19 @@ const DOC_RESOURCES = {
 		routeKind: "versioned-read",
 		cdnCacheable: true
 	},
+	"annotations-all": {
+		id: "annotations-all",
+		pathPattern: "/v1/docs/{docId}/annotations/items@*",
+		resolvePathPattern: (docId) => `/v1/docs/${docId}/annotations/items@*`,
+		pathPrefix: "/v1/docs/{docId}/annotations/items@",
+		resolvePathPrefix: (docId) => `/v1/docs/${docId}/annotations/items@`,
+		requirement: {
+			kind: "single",
+			capability: "doc.annotate.read"
+		},
+		routeKind: "versioned-read",
+		cdnCacheable: true
+	},
 	layout: {
 		id: "layout",
 		pathPattern: "/v1/docs/{docId}/layout@*",
@@ -921,6 +1014,19 @@ const DOC_RESOURCES = {
 		routeKind: "versioned-read",
 		cdnCacheable: true
 	},
+	"layer-annotations-all": {
+		id: "layer-annotations-all",
+		pathPattern: "/v1/docs/{docId}/layers/{layerName}/annotations/items@*",
+		resolvePathPattern: (docId, layerName = "default") => `/v1/docs/${docId}/layers/${layerName}/annotations/items@*`,
+		pathPrefix: "/v1/docs/{docId}/layers/{layerName}/annotations/items@",
+		resolvePathPrefix: (docId, layerName = "default") => `/v1/docs/${docId}/layers/${layerName}/annotations/items@`,
+		requirement: {
+			kind: "single",
+			capability: "doc.annotate.read"
+		},
+		routeKind: "versioned-read",
+		cdnCacheable: true
+	},
 	"download-current": {
 		id: "download-current",
 		pathPattern: "/v1/docs/{docId}/layers/{layerName}/download",
@@ -1004,6 +1110,7 @@ const RESOURCE_PLANES = {
 	"page-geometry": ["content"],
 	"page-render-annotated": ["content", "annotations"],
 	"page-annotations": ["annotations"],
+	"annotations-all": ["annotations"],
 	layout: ["layout"],
 	metadata: ["metadata"],
 	actions: ["actions"],
@@ -1391,9 +1498,13 @@ exports.OpenDocumentResponseSchema = require_schemas.OpenDocumentResponseSchema;
 exports.PageBoxesSchema = require_schemas.PageBoxesSchema;
 exports.PageDeleteInputSchema = require_schemas.PageDeleteInputSchema;
 exports.PageDeleteResultSchema = require_schemas.PageDeleteResultSchema;
+exports.PageExtractInputSchema = require_schemas.PageExtractInputSchema;
 exports.PageFlattenInputSchema = require_schemas.PageFlattenInputSchema;
 exports.PageFlattenResultSchema = require_schemas.PageFlattenResultSchema;
 exports.PageGeometrySnapshotSchema = require_schemas.PageGeometrySnapshotSchema;
+exports.PageInsertBlankInputSchema = require_schemas.PageInsertBlankInputSchema;
+exports.PageInsertInputSchema = require_schemas.PageInsertInputSchema;
+exports.PageInsertResultSchema = require_schemas.PageInsertResultSchema;
 exports.PageLayoutSchema = require_schemas.PageLayoutSchema;
 exports.PageListSnapshotSchema = require_schemas.PageListSnapshotSchema;
 exports.PageMoveInputSchema = require_schemas.PageMoveInputSchema;
@@ -1436,6 +1547,7 @@ exports.RefetchReasonSchema = require_schemas.RefetchReasonSchema;
 exports.RenderTokenSchema = RenderTokenSchema;
 exports.ResourceRefSchema = require_schemas.ResourceRefSchema;
 exports.RevisionTokenSchema = require_schemas.RevisionTokenSchema;
+exports.SEARCH_RESULT_FORMAT = SEARCH_RESULT_FORMAT;
 exports.SearchMatchSchema = require_schemas.SearchMatchSchema;
 exports.SearchModeSchema = require_schemas.SearchModeSchema;
 exports.SearchQuerySchema = require_schemas.SearchQuerySchema;
@@ -1482,6 +1594,7 @@ exports.checkResourceAccess = checkResourceAccess;
 exports.decodeActionsToken = decodeActionsToken;
 exports.decodeAnnotationAppearancesRenderToken = decodeAnnotationAppearancesRenderToken;
 exports.decodeAnnotationToken = decodeAnnotationToken;
+exports.decodeAnnotationsAllToken = decodeAnnotationsAllToken;
 exports.decodeAttachmentsToken = decodeAttachmentsToken;
 exports.decodeContentToken = decodeContentToken;
 exports.decodeDocToken = decodeDocToken;
@@ -1495,6 +1608,7 @@ exports.decodeTokenText = decodeTokenText;
 exports.encodeActionsToken = encodeActionsToken;
 exports.encodeAnnotationAppearancesRenderToken = encodeAnnotationAppearancesRenderToken;
 exports.encodeAnnotationToken = encodeAnnotationToken;
+exports.encodeAnnotationsAllToken = encodeAnnotationsAllToken;
 exports.encodeAttachmentsToken = encodeAttachmentsToken;
 exports.encodeContentToken = encodeContentToken;
 exports.encodeDocToken = encodeDocToken;
@@ -1512,5 +1626,6 @@ exports.renderImageOptionsToWire = renderImageOptionsToWire;
 exports.resolveResourceIdForPath = resolveResourceIdForPath;
 exports.unflatten = unflatten;
 exports.wirePaths = wirePaths;
+exports.wireTemplates = wireTemplates;
 
 //# sourceMappingURL=wire.cjs.map