@cloudpdf/engine 3.0.0-next.11 → 3.0.0-next.13

package/dist/index.cjs

@@ -435,6 +435,24 @@ var CloudDocumentFormsService = class {
 			return this.absorbMutation(result, "form.fieldUpdated");
 		});
 	}
+	setSignatureAppearance(ref, appearance) {
+		const rejected = this.rejectIfClosed();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const bytes = new ArrayBuffer(appearance.pdf.byteLength);
+			new Uint8Array(bytes).set(appearance.pdf);
+			const form = buildMutationForm({
+				resource: "r0",
+				pageIndex: appearance.pageIndex ?? 0
+			}, { r0: {
+				bytes,
+				mimeType: "application/pdf",
+				name: "appearance.pdf"
+			} });
+			const result = await this.http.postMultipartJson(_embedpdf_engine_core_wire.wirePaths.layerFormFieldSignatureAppearance(this.docId, this.layerName, (0, _embedpdf_engine_core_runtime.encodeFieldRefKey)(ref)), form, (raw) => _embedpdf_engine_core_wire.FormFieldUpdateResultSchema.parse(raw), signal);
+			return this.absorbMutation(result, "form.fieldUpdated");
+		});
+	}
 	deleteField(ref) {
 		const rejected = this.rejectIfClosed();
 		if (rejected) return rejected;
@@ -560,6 +578,31 @@ var CloudDocumentPagesService = class {
 			return result;
 		});
 	}
+	setName(input) {
+		return this.runNameMutation(_embedpdf_engine_core_wire.wirePaths.layerPagesNames(this.docId, this.layerName), input, input.name, input.pageObjectNumber);
+	}
+	removeName(input) {
+		return this.runNameMutation(_embedpdf_engine_core_wire.wirePaths.layerPagesNamesDelete(this.docId, this.layerName), input, input.name, null);
+	}
+	/**
+	* Named pages are LAYOUT: both verbs share the page-move patch exactly —
+	* docVersion + layoutVersion advance, no per-page pin changes, so the
+	* cached manifest is patched in place and the fresh layout is published.
+	*/
+	runNameMutation(path, body, name, pageObjectNumber) {
+		if (this.isClosed()) return _embedpdf_engine_core_runtime.AbortablePromise.rejectReason(new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.DocNotOpen, `document ${this.docId} is closed`));
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const result = await this.http.postJson(path, body, (raw) => _embedpdf_engine_core_wire.PageNameResultSchema.parse(raw), signal);
+			if (result.cache) this.manifest.applyPageStructure(result.cache);
+			this.publisher.publishLocal({
+				type: "pages.named",
+				name,
+				pageObjectNumber,
+				...result
+			});
+			return result;
+		});
+	}
 	rotate(pageObjectNumbers, rotation) {
 		if (this.isClosed()) return _embedpdf_engine_core_runtime.AbortablePromise.rejectReason(new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.DocNotOpen, `document ${this.docId} is closed`));
 		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
@@ -990,6 +1033,176 @@ function identityFromClaims(claims) {
 	return Object.keys(out).length > 0 ? out : null;
 }
 //#endregion
+//#region src/document/CloudDocumentSignaturesService.ts
+/**
+* Cloud-side digital signatures. Two kinds of read, two kinds of URL:
+*
+*   - The LAYER view (`list`, and `analyze` of the working copy) is pinned
+*     by the manifest's `docVersion`, like every other layer read: a
+*     signature is a layer state change, the immutable URL moves with it.
+*   - Signed BYTES (`contents`, `digest`, `revisionBytes`, and `analyze`
+*     of history) belong to a base VERSION and are content-addressed by
+*     the manifest's `baseSha`: immutable forever, shared by every layer
+*     and every caller.
+*
+* Signing is the server's two-phase protocol over the same wire shapes
+* the local engine uses. `prepare` and `complete` change the manifest in
+* ways no delta carries (a publish moves `baseSha` itself), so both
+* refresh it before returning.
+*/
+var CloudDocumentSignaturesService = class {
+	constructor(http, docId, layerName, isClosed, manifest, publisher) {
+		this.http = http;
+		this.docId = docId;
+		this.layerName = layerName;
+		this.isClosed = isClosed;
+		this.manifest = manifest;
+		this.publisher = publisher;
+	}
+	list() {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => this.http.getJsonWithRefresh(async (s) => {
+			const manifest = await this.manifest.get(s);
+			return _embedpdf_engine_core_wire.wirePaths.layerSignatures(this.docId, this.layerName, manifest.docVersion);
+		}, (raw) => _embedpdf_engine_core_wire.SignatureSnapshotSchema.parse(raw), async (s) => {
+			await this.manifest.refresh(s);
+		}, signal));
+	}
+	contents(field) {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const manifest = await this.manifest.get(signal);
+			const name = await this.fieldName(field, signal);
+			return this.http.getBytes(_embedpdf_engine_core_wire.wirePaths.docVersionSignatureContents(this.docId, manifest.baseSha, name), signal);
+		});
+	}
+	digest(field, algorithm) {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const manifest = await this.manifest.get(signal);
+			const name = await this.fieldName(field, signal);
+			return this.http.getBytes(_embedpdf_engine_core_wire.wirePaths.docVersionSignatureDigest(this.docId, manifest.baseSha, name, algorithm), signal);
+		});
+	}
+	revisionBytes(revisionIndex) {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const manifest = await this.manifest.get(signal);
+			return this.http.getBytes(_embedpdf_engine_core_wire.wirePaths.docVersionRevision(this.docId, manifest.baseSha, revisionIndex), signal);
+		});
+	}
+	/**
+	* `until: 'working-copy'` (or unset while the layer holds edits) judges
+	* the layer's pending edits against the base at the layer URL; anything
+	* else is history of the base version and resolves at the version URL.
+	*/
+	analyze(input) {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const manifest = await this.manifest.get(signal);
+			if (input.until === "working-copy" || input.until === void 0 && manifest.working) return this.http.getJsonWithRefresh(async (s) => {
+				const current = await this.manifest.get(s);
+				return _embedpdf_engine_core_wire.wirePaths.layerSignaturesAnalysis(this.docId, this.layerName, {
+					docVersion: current.docVersion,
+					since: input.since,
+					...input.exploratoryLevel !== void 0 ? { exploratoryLevel: input.exploratoryLevel } : {},
+					...input.detail !== void 0 ? { detail: input.detail } : {}
+				});
+			}, (raw) => _embedpdf_engine_core_wire.ChangeAnalysisSchema.parse(raw), async (s) => {
+				await this.manifest.refresh(s);
+			}, signal);
+			return this.http.getJson(_embedpdf_engine_core_wire.wirePaths.docVersionAnalysis(this.docId, manifest.baseSha, {
+				since: input.since,
+				...typeof input.until === "object" ? { until: input.until.revisionIndex } : {},
+				...input.exploratoryLevel !== void 0 ? { exploratoryLevel: input.exploratoryLevel } : {},
+				...input.detail !== void 0 ? { detail: input.detail } : {}
+			}), (raw) => _embedpdf_engine_core_wire.ChangeAnalysisSchema.parse(raw), signal);
+		});
+	}
+	prepare(input) {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const { appearance, ...rest } = input;
+			const form = buildMutationForm({
+				...rest,
+				...appearance ? { appearance: {
+					resource: "appearance",
+					...appearance.pageIndex !== void 0 ? { pageIndex: appearance.pageIndex } : {}
+				} } : {}
+			}, appearance ? { appearance: {
+				bytes: appearance.pdf.slice().buffer,
+				mimeType: "application/pdf",
+				name: "appearance.pdf"
+			} } : {});
+			const prepared = await this.http.postMultipartJson(_embedpdf_engine_core_wire.wirePaths.layerSignaturesPrepare(this.docId, this.layerName), form, (raw) => (0, _embedpdf_engine_core_wire.decodePrepared)(_embedpdf_engine_core_wire.SignaturePreparedWireSchema.parse(raw)), signal);
+			await this.manifest.refresh(signal);
+			this.publisher.publishLocal({
+				type: "signature.prepared",
+				signingId: prepared.signingId,
+				field: input.field
+			});
+			return prepared;
+		});
+	}
+	complete(input) {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const result = await this.http.postJson(_embedpdf_engine_core_wire.wirePaths.layerSignatureComplete(this.docId, this.layerName, input.signingId), {
+				cms: (0, _embedpdf_engine_core_wire.toBase64)(input.cms),
+				expectedVersion: input.expectedVersion
+			}, (raw) => _embedpdf_engine_core_wire.SignatureCompleteResultSchema.parse(raw), signal);
+			await this.manifest.refresh(signal);
+			if (result.status === "completed") {
+				this.publisher.publishLocal({
+					type: "signature.completed",
+					signingId: input.signingId,
+					...result
+				});
+				this.publisher.publishLocal({
+					type: "document.versioned",
+					version: result.version
+				});
+			}
+			return result;
+		});
+	}
+	abort(signingId) {
+		const rejected = this.closedRejection();
+		if (rejected) return rejected;
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const result = await this.http.deleteJson(_embedpdf_engine_core_wire.wirePaths.layerSignatureAbort(this.docId, this.layerName, signingId), (raw) => _embedpdf_engine_core_wire.SignatureAbortResultSchema.parse(raw), signal);
+			if (result.status === "aborted") this.publisher.publishLocal({
+				type: "signature.aborted",
+				signingId
+			});
+			return result;
+		});
+	}
+	/** Version routes address a field by its fully qualified name; an object-number ref is resolved through the snapshot. */
+	async fieldName(field, signal) {
+		if (field.kind === "fqn") return field.name;
+		const match = (await this.http.getJsonWithRefresh(async (s) => {
+			const manifest = await this.manifest.get(s);
+			return _embedpdf_engine_core_wire.wirePaths.layerSignatures(this.docId, this.layerName, manifest.docVersion);
+		}, (raw) => _embedpdf_engine_core_wire.SignatureSnapshotSchema.parse(raw), async (s) => {
+			await this.manifest.refresh(s);
+		}, signal)).signatures.find((s) => s.field.kind === "objectNumber" && s.field.fieldObjectNumber === field.fieldObjectNumber);
+		if (!match) throw new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.NotFound, `no signature field #${field.fieldObjectNumber}`);
+		return match.fieldName;
+	}
+	closedRejection() {
+		if (!this.isClosed()) return null;
+		return _embedpdf_engine_core_runtime.AbortablePromise.rejectReason(new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.DocNotOpen, `document ${this.docId} is closed`));
+	}
+};
+//#endregion
 //#region src/document/CloudMetadataService.ts
 var CloudMetadataService = class {
 	constructor(http, docId, layerName, isClosed, manifest, publisher) {
@@ -1185,6 +1398,29 @@ var CloudPageAnnotationsService = class {
 			return this.absorbMutation(result, "annotation.moved");
 		});
 	}
+	flatten(refs, usage = "display") {
+		if (this.isClosed()) return _embedpdf_engine_core_runtime.AbortablePromise.rejectReason(new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.DocNotOpen, `document ${this.docId} is closed`));
+		for (const r of refs) if (r.pageObjectNumber !== this.pageObjectNumber) return _embedpdf_engine_core_runtime.AbortablePromise.rejectReason(new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.InvalidArg, `flatten ref points at page ${r.pageObjectNumber}; service is bound to page ${this.pageObjectNumber}`));
+		const path = _embedpdf_engine_core_wire.wirePaths.layerPageAnnotationsFlatten(this.docId, this.layerName, this.pageObjectNumber);
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => {
+			const result = await this.http.postJson(path, {
+				refs,
+				usage
+			}, (raw) => _embedpdf_engine_core_wire.AnnotationFlattenResultSchema.parse(raw), signal);
+			if (result.meta === null) return result;
+			this.manifest.apply(result.meta, ["content", "annotations"]);
+			this.publisher.publishLocal({
+				type: "annotations.flattened",
+				...result
+			});
+			return result;
+		});
+	}
+	exportAppearance(refs) {
+		if (this.isClosed()) return _embedpdf_engine_core_runtime.AbortablePromise.rejectReason(new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.DocNotOpen, `document ${this.docId} is closed`));
+		for (const r of refs) if (r.pageObjectNumber !== this.pageObjectNumber) return _embedpdf_engine_core_runtime.AbortablePromise.rejectReason(new _embedpdf_engine_core_runtime.EngineError(_embedpdf_engine_core_runtime.EngineErrorCode.InvalidArg, `exportAppearance ref points at page ${r.pageObjectNumber}; service is bound to page ${this.pageObjectNumber}`));
+		return _embedpdf_engine_core_runtime.AbortablePromise.run(async (signal) => this.http.postJsonBytes(_embedpdf_engine_core_wire.wirePaths.layerPageAnnotationsAppearance(this.docId, this.layerName, this.pageObjectNumber), { refs }, signal));
+	}
 	/**
 	* Patch the cached manifest, then publish the mutation to the document's
 	* event stream (in that order — listeners reading the manifest in their
@@ -1514,7 +1750,8 @@ function auditRowToEvent(row, mySessionId) {
 			origin,
 			...row.payload
 		};
-		case "form.updateField": return {
+		case "form.updateField":
+		case "form.setSignatureAppearance": return {
 			type: "form.fieldUpdated",
 			origin,
 			...row.payload
@@ -1654,6 +1891,7 @@ var CloudDocumentHandle = class {
 		_defineProperty(this, "annotations", void 0);
 		_defineProperty(this, "actions", void 0);
 		_defineProperty(this, "attachments", void 0);
+		_defineProperty(this, "signatures", void 0);
 		_defineProperty(this, "forms", void 0);
 		_defineProperty(this, "search", void 0);
 		_defineProperty(this, "pages", void 0);
@@ -1723,6 +1961,7 @@ var CloudDocumentHandle = class {
 		this.annotations = new CloudDocumentAnnotationsService(http, id, layerName, () => this.closed, this.manifestAccessor);
 		this.actions = new CloudDocumentActionsService(http, id, layerName, () => this.closed, this.manifestAccessor);
 		this.attachments = new CloudDocumentAttachmentsService(http, id, layerName, () => this.closed, this.manifestAccessor, this.publisher);
+		this.signatures = new CloudDocumentSignaturesService(http, id, layerName, () => this.closed, this.manifestAccessor, this.publisher);
 		this.forms = new CloudDocumentFormsService(http, id, layerName, () => this.closed, this.manifestAccessor, this.publisher);
 		this.search = new CloudDocumentSearchService(http, id, layerName, () => this.closed, this.manifestAccessor);
 		this.pages = new CloudDocumentPagesService(http, id, layerName, () => this.closed, this.manifestAccessor, this.publisher);
@@ -1825,6 +2064,8 @@ var CloudDocumentHandle = class {
 			...this.manifestCache,
 			docVersion: delta?.docVersion ?? this.manifestCache.docVersion,
 			...delta?.annotationsVersion !== void 0 ? { annotationsVersion: delta.annotationsVersion } : {},
+			...delta?.layerVersion !== void 0 ? { layerVersion: delta.layerVersion } : {},
+			...delta?.working !== void 0 ? { working: delta.working } : {},
 			pages: Array.from(byPageObjectNumber.values()).sort((a, b) => a.state.pageObjectNumber - b.state.pageObjectNumber)
 		};
 	}