@cloudpdf/engine 3.0.0-next.0 → 3.0.0-next.2

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { AbortError, AbortablePromise, AbortablePromise as AbortablePromise$1, AnnotationAppearanceImageOptions, AnnotationAppearanceImagesResult, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationDraft, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationPatch, AnnotationRef, AnnotationUpdateResult, AttachmentContent, AttachmentsCache, DocumentAccessInfo, DocumentActionsService, DocumentAnnotationsService, DocumentAnnotationsService as DocumentAnnotationsService$1, DocumentAttachmentsService, DocumentCapabilities, DocumentEventStream, DocumentFormsService, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentIdentity, DocumentMetadata, DocumentPagesService, DocumentPagesService as DocumentPagesService$1, DocumentRedactionService, DocumentRenderService, DocumentSearchService, DocumentSecurityService, DocumentSecurityService as DocumentSecurityService$1, DocumentSecurityState, DocumentUnlockInput, DocumentUnlockResult, Engine, Engine as Engine$1, EngineError, EngineErrorCode, EngineFactory, MetadataCache, MetadataPatch, MetadataService, MetadataService as MetadataService$1, MetadataUpdateResult, MutationMeta, OpenInput, OpenInput as OpenInput$1, OpenOptions, OpenOptions as OpenOptions$1, PageAnnotationsService, PageAnnotationsService as PageAnnotationsService$1, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryService, PageGeometryService as PageGeometryService$1, PageGeometrySnapshot, PageHandle, PageHandle as PageHandle$1, PageImageHandle, PageImageOptions, PageListSnapshot, PageMoveResult, PageObjectNumber, PageRaster, PageRenderOptions, PageRenderService, PageRenderService as PageRenderService$1, PageRotateResult, PageRotation, PageStructureCache, PageTextService, PageTextService as PageTextService$1, PageTextSnapshot, PdfSaveMode, PdfSaveMode as PdfSaveMode$1, SearchRequest, SearchSlice, TokenSource, WeakAnnotationEditSession } from "@embedpdf/engine-core/runtime";
+import { AbortError, AbortablePromise, AbortablePromise as AbortablePromise$1, AnnotationAppearanceImageOptions, AnnotationAppearanceImagesResult, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationDraft, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationPatch, AnnotationRef, AnnotationUpdateResult, AttachmentContent, AttachmentsCache, DocumentAccessInfo, DocumentActionsService, DocumentAnnotationsService, DocumentAnnotationsService as DocumentAnnotationsService$1, DocumentAttachmentsService, DocumentCapabilities, DocumentEventStream, DocumentFormsService, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentIdentity, DocumentMetadata, DocumentPagesService, DocumentPagesService as DocumentPagesService$1, DocumentRedactionService, DocumentRenderService, DocumentSearchService, DocumentSecurityService, DocumentSecurityService as DocumentSecurityService$1, DocumentSecurityState, DocumentUnlockInput, DocumentUnlockResult, Engine, Engine as Engine$1, EngineError, EngineErrorCode, EngineFactory, MetadataCache, MetadataPatch, MetadataService, MetadataService as MetadataService$1, MetadataUpdateResult, MutationMeta, OpenInput, OpenInput as OpenInput$1, OpenOptions, OpenOptions as OpenOptions$1, PageAnnotationsService, PageAnnotationsService as PageAnnotationsService$1, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryService, PageGeometryService as PageGeometryService$1, PageGeometrySnapshot, PageHandle, PageHandle as PageHandle$1, PageImageHandle, PageImageOptions, PageListSnapshot, PageMoveResult, PageObjectNumber, PageRaster, PageRenderOptions, PageRenderService, PageRenderService as PageRenderService$1, PageRotateResult, PageRotation, PageStructureCache, PageTextService, PageTextService as PageTextService$1, PageTextSnapshot, PdfSaveMode, PdfSaveMode as PdfSaveMode$1, SearchRequest, SearchSlice, TokenSource, TokenSource as TokenSource$1, WeakAnnotationEditSession } from "@embedpdf/engine-core/runtime";
 import { CdnAccessInfoForApply, DocumentHead, DocumentManifest, LayerScopePlane } from "@embedpdf/engine-core/wire";
 import { SessionEventPublisher } from "@embedpdf/engine-services";
 //#region src/transport/HttpClient.d.ts
@@ -572,6 +572,55 @@ interface UnverifiedClaims {
 }
 declare function decodeUnverifiedClaims(token: string): UnverifiedClaims;
 //#endregion
+//#region src/share.d.ts
+/**
+ * Share-session exchange: the client half of the no-backend embed flow.
+ *
+ * A share token (`shr_…`) is a REFERENCE to a stored grant on the
+ * server, not a credential — `exchangeShareToken` trades it for an
+ * ordinary short-lived doc JWT, and `shareSessionSource` wraps that in
+ * a self-renewing {@link TokenSource}. Because the engine's transport
+ * invokes its token source on every request (and SSE reconnects call
+ * it again), renewal is nothing more than "exchange again when the
+ * cached session is nearly out" — no timers, no listeners.
+ *
+ * The endpoint requires a browser `Origin` header (the server checks
+ * it against the grant's allowlist). Browsers attach it automatically;
+ * non-browser callers (tests, SSR) must supply a `fetch` that does.
+ */
+interface ShareSession {
+  /** Doc-scoped session JWT carrying the grant's capabilities. */
+  token: string;
+  docId: string;
+  layerName: string;
+  /** Unix seconds when `token` expires. */
+  expiresAt: number;
+}
+interface ShareExchangeOptions {
+  /** Passphrase for protected grants (`SharePasswordRequired` otherwise). */
+  password?: string;
+  fetch?: typeof globalThis.fetch;
+}
+/**
+ * Thrown on a non-OK exchange. `code` is the server's wire code:
+ * `SharePasswordRequired` (prompt and retry with a password),
+ * `OriginNotAllowed` / `OriginRequired`, `ShareExpired`, `NotFound`
+ * (unknown or revoked — indistinguishable by design), or
+ * `TooManyRequests`.
+ */
+declare class ShareExchangeError extends Error {
+  readonly code: string;
+  readonly status: number;
+  constructor(code: string, message: string, status: number);
+}
+declare function exchangeShareToken(baseUrl: string, shareToken: string, opts?: ShareExchangeOptions): Promise<ShareSession>;
+/**
+ * A caching, self-renewing {@link TokenSource} over the exchange.
+ * Concurrent callers share one in-flight exchange; a failed exchange
+ * clears it so the next request retries rather than caching the error.
+ */
+declare function shareSessionSource(baseUrl: string, shareToken: string, opts?: ShareExchangeOptions): TokenSource$1;
+//#endregion
 //#region src/index.d.ts
 declare function createCloudEngine(opts: CloudEngineOptions): CloudEngine;
 /**
@@ -596,5 +645,5 @@ declare function createCloudEngine(opts: CloudEngineOptions): CloudEngine;
  */
 declare function cloudEngine(opts: CloudEngineOptions): CloudEngine;
 //#endregion
-export { AbortError, AbortablePromise, CloudDocumentAnnotationsService, CloudDocumentHandle, CloudDocumentPagesService, CloudEngine, type CloudEngineOptions, CloudMetadataService, CloudPageAnnotationsService, CloudPageGeometryService, CloudPageHandle, CloudPageRenderService, type DocumentAccessInfo, type DocumentAnnotationsService, type DocumentCapabilities, type DocumentHandle, type DocumentIdentity, type DocumentPagesService, type DocumentSecurityService, type DocumentSecurityState, type DocumentUnlockInput, type DocumentUnlockResult, type Engine, EngineError, EngineErrorCode, type EngineFactory, HttpClient, type HttpClientOptions, type MetadataService, type OpenInput, type OpenOptions, type PageAnnotationsService, type PageGeometryService, type PageHandle, type PageRenderService, type PageTextService, type PdfSaveMode, type TokenSource, type UnverifiedClaims, cloudEngine, createCloudEngine, decodeUnverifiedClaims };
+export { AbortError, AbortablePromise, CloudDocumentAnnotationsService, CloudDocumentHandle, CloudDocumentPagesService, CloudEngine, type CloudEngineOptions, CloudMetadataService, CloudPageAnnotationsService, CloudPageGeometryService, CloudPageHandle, CloudPageRenderService, type DocumentAccessInfo, type DocumentAnnotationsService, type DocumentCapabilities, type DocumentHandle, type DocumentIdentity, type DocumentPagesService, type DocumentSecurityService, type DocumentSecurityState, type DocumentUnlockInput, type DocumentUnlockResult, type Engine, EngineError, EngineErrorCode, type EngineFactory, HttpClient, type HttpClientOptions, type MetadataService, type OpenInput, type OpenOptions, type PageAnnotationsService, type PageGeometryService, type PageHandle, type PageRenderService, type PageTextService, type PdfSaveMode, ShareExchangeError, type ShareExchangeOptions, type ShareSession, type TokenSource, type UnverifiedClaims, cloudEngine, createCloudEngine, decodeUnverifiedClaims, exchangeShareToken, shareSessionSource };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AbortError, AbortablePromise, AbortablePromise as AbortablePromise$1, AnnotationAppearanceImageOptions, AnnotationAppearanceImagesResult, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationDraft, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationPatch, AnnotationRef, AnnotationUpdateResult, AttachmentContent, AttachmentsCache, DocumentAccessInfo, DocumentActionsService, DocumentAnnotationsService, DocumentAnnotationsService as DocumentAnnotationsService$1, DocumentAttachmentsService, DocumentCapabilities, DocumentEventStream, DocumentFormsService, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentIdentity, DocumentMetadata, DocumentPagesService, DocumentPagesService as DocumentPagesService$1, DocumentRedactionService, DocumentRenderService, DocumentSearchService, DocumentSecurityService, DocumentSecurityService as DocumentSecurityService$1, DocumentSecurityState, DocumentUnlockInput, DocumentUnlockResult, Engine, Engine as Engine$1, EngineError, EngineErrorCode, EngineFactory, MetadataCache, MetadataPatch, MetadataService, MetadataService as MetadataService$1, MetadataUpdateResult, MutationMeta, OpenInput, OpenInput as OpenInput$1, OpenOptions, OpenOptions as OpenOptions$1, PageAnnotationsService, PageAnnotationsService as PageAnnotationsService$1, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryService, PageGeometryService as PageGeometryService$1, PageGeometrySnapshot, PageHandle, PageHandle as PageHandle$1, PageImageHandle, PageImageOptions, PageListSnapshot, PageMoveResult, PageObjectNumber, PageRaster, PageRenderOptions, PageRenderService, PageRenderService as PageRenderService$1, PageRotateResult, PageRotation, PageStructureCache, PageTextService, PageTextService as PageTextService$1, PageTextSnapshot, PdfSaveMode, PdfSaveMode as PdfSaveMode$1, SearchRequest, SearchSlice, TokenSource, WeakAnnotationEditSession } from "@embedpdf/engine-core/runtime";
+import { AbortError, AbortablePromise, AbortablePromise as AbortablePromise$1, AnnotationAppearanceImageOptions, AnnotationAppearanceImagesResult, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationDraft, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationPatch, AnnotationRef, AnnotationUpdateResult, AttachmentContent, AttachmentsCache, DocumentAccessInfo, DocumentActionsService, DocumentAnnotationsService, DocumentAnnotationsService as DocumentAnnotationsService$1, DocumentAttachmentsService, DocumentCapabilities, DocumentEventStream, DocumentFormsService, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentIdentity, DocumentMetadata, DocumentPagesService, DocumentPagesService as DocumentPagesService$1, DocumentRedactionService, DocumentRenderService, DocumentSearchService, DocumentSecurityService, DocumentSecurityService as DocumentSecurityService$1, DocumentSecurityState, DocumentUnlockInput, DocumentUnlockResult, Engine, Engine as Engine$1, EngineError, EngineErrorCode, EngineFactory, MetadataCache, MetadataPatch, MetadataService, MetadataService as MetadataService$1, MetadataUpdateResult, MutationMeta, OpenInput, OpenInput as OpenInput$1, OpenOptions, OpenOptions as OpenOptions$1, PageAnnotationsService, PageAnnotationsService as PageAnnotationsService$1, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryService, PageGeometryService as PageGeometryService$1, PageGeometrySnapshot, PageHandle, PageHandle as PageHandle$1, PageImageHandle, PageImageOptions, PageListSnapshot, PageMoveResult, PageObjectNumber, PageRaster, PageRenderOptions, PageRenderService, PageRenderService as PageRenderService$1, PageRotateResult, PageRotation, PageStructureCache, PageTextService, PageTextService as PageTextService$1, PageTextSnapshot, PdfSaveMode, PdfSaveMode as PdfSaveMode$1, SearchRequest, SearchSlice, TokenSource, TokenSource as TokenSource$1, WeakAnnotationEditSession } from "@embedpdf/engine-core/runtime";
 import { CdnAccessInfoForApply, DocumentHead, DocumentManifest, LayerScopePlane } from "@embedpdf/engine-core/wire";
 import { SessionEventPublisher } from "@embedpdf/engine-services";
 //#region src/transport/HttpClient.d.ts
@@ -572,6 +572,55 @@ interface UnverifiedClaims {
 }
 declare function decodeUnverifiedClaims(token: string): UnverifiedClaims;
 //#endregion
+//#region src/share.d.ts
+/**
+ * Share-session exchange: the client half of the no-backend embed flow.
+ *
+ * A share token (`shr_…`) is a REFERENCE to a stored grant on the
+ * server, not a credential — `exchangeShareToken` trades it for an
+ * ordinary short-lived doc JWT, and `shareSessionSource` wraps that in
+ * a self-renewing {@link TokenSource}. Because the engine's transport
+ * invokes its token source on every request (and SSE reconnects call
+ * it again), renewal is nothing more than "exchange again when the
+ * cached session is nearly out" — no timers, no listeners.
+ *
+ * The endpoint requires a browser `Origin` header (the server checks
+ * it against the grant's allowlist). Browsers attach it automatically;
+ * non-browser callers (tests, SSR) must supply a `fetch` that does.
+ */
+interface ShareSession {
+  /** Doc-scoped session JWT carrying the grant's capabilities. */
+  token: string;
+  docId: string;
+  layerName: string;
+  /** Unix seconds when `token` expires. */
+  expiresAt: number;
+}
+interface ShareExchangeOptions {
+  /** Passphrase for protected grants (`SharePasswordRequired` otherwise). */
+  password?: string;
+  fetch?: typeof globalThis.fetch;
+}
+/**
+ * Thrown on a non-OK exchange. `code` is the server's wire code:
+ * `SharePasswordRequired` (prompt and retry with a password),
+ * `OriginNotAllowed` / `OriginRequired`, `ShareExpired`, `NotFound`
+ * (unknown or revoked — indistinguishable by design), or
+ * `TooManyRequests`.
+ */
+declare class ShareExchangeError extends Error {
+  readonly code: string;
+  readonly status: number;
+  constructor(code: string, message: string, status: number);
+}
+declare function exchangeShareToken(baseUrl: string, shareToken: string, opts?: ShareExchangeOptions): Promise<ShareSession>;
+/**
+ * A caching, self-renewing {@link TokenSource} over the exchange.
+ * Concurrent callers share one in-flight exchange; a failed exchange
+ * clears it so the next request retries rather than caching the error.
+ */
+declare function shareSessionSource(baseUrl: string, shareToken: string, opts?: ShareExchangeOptions): TokenSource$1;
+//#endregion
 //#region src/index.d.ts
 declare function createCloudEngine(opts: CloudEngineOptions): CloudEngine;
 /**
@@ -596,5 +645,5 @@ declare function createCloudEngine(opts: CloudEngineOptions): CloudEngine;
  */
 declare function cloudEngine(opts: CloudEngineOptions): CloudEngine;
 //#endregion
-export { AbortError, AbortablePromise, CloudDocumentAnnotationsService, CloudDocumentHandle, CloudDocumentPagesService, CloudEngine, type CloudEngineOptions, CloudMetadataService, CloudPageAnnotationsService, CloudPageGeometryService, CloudPageHandle, CloudPageRenderService, type DocumentAccessInfo, type DocumentAnnotationsService, type DocumentCapabilities, type DocumentHandle, type DocumentIdentity, type DocumentPagesService, type DocumentSecurityService, type DocumentSecurityState, type DocumentUnlockInput, type DocumentUnlockResult, type Engine, EngineError, EngineErrorCode, type EngineFactory, HttpClient, type HttpClientOptions, type MetadataService, type OpenInput, type OpenOptions, type PageAnnotationsService, type PageGeometryService, type PageHandle, type PageRenderService, type PageTextService, type PdfSaveMode, type TokenSource, type UnverifiedClaims, cloudEngine, createCloudEngine, decodeUnverifiedClaims };
+export { AbortError, AbortablePromise, CloudDocumentAnnotationsService, CloudDocumentHandle, CloudDocumentPagesService, CloudEngine, type CloudEngineOptions, CloudMetadataService, CloudPageAnnotationsService, CloudPageGeometryService, CloudPageHandle, CloudPageRenderService, type DocumentAccessInfo, type DocumentAnnotationsService, type DocumentCapabilities, type DocumentHandle, type DocumentIdentity, type DocumentPagesService, type DocumentSecurityService, type DocumentSecurityState, type DocumentUnlockInput, type DocumentUnlockResult, type Engine, EngineError, EngineErrorCode, type EngineFactory, HttpClient, type HttpClientOptions, type MetadataService, type OpenInput, type OpenOptions, type PageAnnotationsService, type PageGeometryService, type PageHandle, type PageRenderService, type PageTextService, type PdfSaveMode, ShareExchangeError, type ShareExchangeOptions, type ShareSession, type TokenSource, type UnverifiedClaims, cloudEngine, createCloudEngine, decodeUnverifiedClaims, exchangeShareToken, shareSessionSource };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -2443,6 +2443,65 @@ async function settleLinked(pending, signal) {
 	}
 }
 //#endregion
+//#region src/share.ts
+/**
+* Thrown on a non-OK exchange. `code` is the server's wire code:
+* `SharePasswordRequired` (prompt and retry with a password),
+* `OriginNotAllowed` / `OriginRequired`, `ShareExpired`, `NotFound`
+* (unknown or revoked — indistinguishable by design), or
+* `TooManyRequests`.
+*/
+var ShareExchangeError = class extends Error {
+	constructor(code, message, status) {
+		super(message);
+		this.code = code;
+		this.status = status;
+		this.name = "ShareExchangeError";
+	}
+};
+async function exchangeShareToken(baseUrl, shareToken, opts = {}) {
+	const res = await (opts.fetch ?? globalThis.fetch)(`${baseUrl.replace(/\/$/, "")}/v1/share-sessions`, {
+		method: "POST",
+		headers: { "content-type": "application/json" },
+		body: JSON.stringify({
+			shareToken,
+			...opts.password !== void 0 ? { password: opts.password } : {}
+		})
+	});
+	if (!res.ok) {
+		let code = "Unknown";
+		let message = `share exchange failed with status ${res.status}`;
+		try {
+			const payload = await res.json();
+			if (payload.error?.code) code = payload.error.code;
+			if (payload.error?.message) message = payload.error.message;
+		} catch {}
+		throw new ShareExchangeError(code, message, res.status);
+	}
+	return await res.json();
+}
+/** Renew this many seconds before `expiresAt` so in-flight requests never race expiry. */
+const RENEW_MARGIN_SECONDS = 60;
+/**
+* A caching, self-renewing {@link TokenSource} over the exchange.
+* Concurrent callers share one in-flight exchange; a failed exchange
+* clears it so the next request retries rather than caching the error.
+*/
+function shareSessionSource(baseUrl, shareToken, opts = {}) {
+	let session = null;
+	let inflight = null;
+	return async () => {
+		if (session && session.expiresAt - Date.now() / 1e3 > RENEW_MARGIN_SECONDS) return session.token;
+		inflight ?? (inflight = exchangeShareToken(baseUrl, shareToken, opts).then((next) => {
+			session = next;
+			return next.token;
+		}).finally(() => {
+			inflight = null;
+		}));
+		return inflight;
+	};
+}
+//#endregion
 //#region src/index.ts
 function createCloudEngine(opts) {
 	return CloudEngine.fromOptions(opts);
@@ -2471,6 +2530,6 @@ function cloudEngine(opts) {
 	return CloudEngine.fromOptions(opts);
 }
 //#endregion
-export { AbortError, AbortablePromise, CloudDocumentAnnotationsService, CloudDocumentHandle, CloudDocumentPagesService, CloudEngine, CloudMetadataService, CloudPageAnnotationsService, CloudPageGeometryService, CloudPageHandle, CloudPageRenderService, EngineError, EngineErrorCode, HttpClient, cloudEngine, createCloudEngine, decodeUnverifiedClaims };
+export { AbortError, AbortablePromise, CloudDocumentAnnotationsService, CloudDocumentHandle, CloudDocumentPagesService, CloudEngine, CloudMetadataService, CloudPageAnnotationsService, CloudPageGeometryService, CloudPageHandle, CloudPageRenderService, EngineError, EngineErrorCode, HttpClient, ShareExchangeError, cloudEngine, createCloudEngine, decodeUnverifiedClaims, exchangeShareToken, shareSessionSource };
 
 //# sourceMappingURL=index.js.map