@docx-editor.dev/docx-to-pdf 0.0.1 → 2.22.0

package/dist/index.d.cts

@@ -0,0 +1,146 @@
+/// <reference lib="dom" />
+import { OpenFontBackedDocumentForExportOptions, OpenFontBackedDocumentForExportResult, ExportFontResolutionReport, FontBackedExportCapabilities } from '@docx-editor.dev/core/export';
+export { ExportDroppedEmbeddedFont, ExportFontFaceResolution, ExportFontFamilyResolution, ExportFontResolutionReport, ExportResourceError, FontOriginFailure } from '@docx-editor.dev/core/export';
+import { FontOrigin } from '@docx-editor.dev/core/editor';
+export { createFontSource, defineFontResolver } from '@docx-editor.dev/core/editor';
+import { HeadlessDocumentRejection } from '@docx-editor.dev/core/store';
+export { HeadlessDocumentRejection } from '@docx-editor.dev/core/store';
+import { RevisionDisplayMode } from '@docx-editor.dev/core/layout';
+export { FontRequest, FontSubstitution, RevisionDisplayMode } from '@docx-editor.dev/core/layout';
+
+/** A bounded explanation of content the PDF cannot reproduce. @public */
+interface PdfDiagnostic {
+    /** Machine-readable diagnostic identifier. Handle unknown codes by severity. */
+    readonly code: string;
+    /** Human-readable explanation. Do not use this text for program control. */
+    readonly message: string;
+    /** Zero-based page index. Omitted for document-wide diagnostics. */
+    readonly pageIndex?: number;
+    /** One-based page number for display, consistent with Markdown warnings. */
+    readonly pageNumber?: number;
+    /** Failed font source index, when this diagnostic describes a source failure. */
+    readonly originIndex?: number;
+    /** Failed font source name, when the source provided one. */
+    readonly originName?: string;
+    /** Strict export permits only information diagnostics. */
+    readonly severity: 'unsupported' | 'approximation' | 'information';
+}
+/** A font configuration or document-aware resolver. @public */
+type PdfFontOrigin = FontOrigin;
+/** Ordered font configurations or resolvers. Earlier sources take priority. @public */
+type PdfFontsSource = PdfFontOrigin | readonly PdfFontOrigin[];
+/** Node conversion controls. Font substitution follows Core's independent fontPolicy. @public */
+interface PdfExportOptions extends Omit<OpenFontBackedDocumentForExportOptions, 'fonts' | 'measurer' | 'producer' | 'reuseAcrossRevisions'> {
+    /** Revision display mode. Defaults to proposed. */
+    readonly displayMode?: RevisionDisplayMode;
+    /** Apply optional document ligatures during measurement and output. Defaults to true. */
+    readonly documentLigatures?: boolean;
+    /** Sources after embedded fonts and before the built-in generic substitutes. */
+    readonly lastResortFonts?: PdfFontsSource;
+    /** Use installed Word fonts before packaged substitutes. Defaults to true. */
+    readonly useSystemFonts?: boolean;
+    /** Font sources before installed and packaged fonts. */
+    readonly fonts?: PdfFontsSource;
+    /** Font sources after packaged fonts and before embedded fonts. */
+    readonly fallbackFonts?: PdfFontsSource;
+    /** Reject unsupported or approximate content by default. */
+    readonly fidelityPolicy?: 'strict' | 'best-effort';
+    /** Include native PDF comment annotations. Defaults to true. */
+    readonly comments?: boolean;
+    /** Cooperative conversion deadline. Defaults to 60000 milliseconds. */
+    readonly timeoutMs?: number;
+    /** Maximum encoded bytes, from 1 to 67108864. Defaults to 67108864. */
+    readonly maxOutputBytes?: number;
+    /** Maximum output pages, from 1 to 10000. Checked after layout. Defaults to 10000. */
+    readonly maxPages?: number;
+}
+/** Elapsed milliseconds for each conversion phase. @public */
+interface PdfExportTimings {
+    readonly openMs: number;
+    readonly layoutMs: number;
+    readonly paintMs: number;
+    readonly saveMs: number;
+}
+/** Result owns its bytes; mutating them does not affect a session or subsequent export. @public */
+interface PdfExportResult {
+    /** Owned, mutable PDF bytes. Use application/pdf when serving them. */
+    readonly bytes: Uint8Array;
+    /** Physical PDF page count. */
+    readonly pageCount: number;
+    /** Layout revision for this conversion; not a persistent document identifier. */
+    readonly layoutRevision: number;
+    /** Revision display mode applied to the document. */
+    readonly displayMode: RevisionDisplayMode;
+    /** Selected faces, substitutions, and failed font sources. */
+    readonly fontResolution: ExportFontResolutionReport;
+    /** Immutable output limitations and informational notices. */
+    readonly diagnostics: readonly PdfDiagnostic[];
+    /** Wall-clock milliseconds spent opening and resolving fonts, laying out, painting, and saving. */
+    readonly timings: PdfExportTimings;
+}
+/** Requested content could not be represented faithfully. @public */
+declare class PdfFidelityError extends Error {
+    readonly diagnostics: readonly PdfDiagnostic[];
+    readonly code = "fidelityUnsupported";
+    constructor(diagnostics: readonly PdfDiagnostic[]);
+}
+/** Core refused the input package. @public */
+declare class PdfDocumentOpenError extends Error {
+    readonly reason: HeadlessDocumentRejection | 'aborted';
+    readonly detail?: string | undefined;
+    readonly code = "documentOpenFailed";
+    constructor(reason: HeadlessDocumentRejection | 'aborted', detail?: string | undefined);
+}
+/** PDF encoding failed after a document was opened. @public */
+declare class PdfEncodingError extends Error {
+    readonly code: 'encodingFailed' | 'outputTooLarge';
+    constructor(message: string, options?: ErrorOptions);
+}
+/** Encoded output exceeds the configured byte limit. @public */
+declare class PdfOutputLimitError extends PdfEncodingError {
+    readonly limit: number;
+    readonly actual: number;
+    readonly code = "outputTooLarge";
+    constructor(limit: number, actual: number);
+}
+/** Layout exceeds the configured page limit. @public */
+declare class PdfPageLimitError extends RangeError {
+    readonly limit: number;
+    readonly actual: number;
+    readonly code = "pageLimitExceeded";
+    constructor(limit: number, actual: number);
+}
+/** Output controls for a caller-owned PDF session. @public */
+type PdfProjectionOptions = Pick<PdfExportOptions, 'comments' | 'fidelityPolicy' | 'timeoutMs' | 'maxOutputBytes' | 'maxPages' | 'signal' | 'displayMode'>;
+/** Font and layout controls for a reusable immutable-byte session. @public */
+type OpenPdfDocumentForExportOptions = Omit<PdfExportOptions, 'comments' | 'fidelityPolicy' | 'timeoutMs' | 'maxOutputBytes' | 'maxPages'>;
+/** Session that retains the admitted fonts and glyph capabilities needed by PDF output. @public */
+type PdfExportSession = FontBackedExportCapabilities;
+/** Open result with the same success/refusal shape as Markdown sessions. @public */
+type OpenPdfDocumentForExportResult = OpenFontBackedDocumentForExportResult;
+
+/** Convert DOCX bytes. Disposes its session after success or failure. @public */
+declare function exportPdf(source: Uint8Array, options?: PdfExportOptions): Promise<PdfExportResult>;
+/**
+ * Encode a caller-owned font-backed session without reopening the document.
+ * Does not dispose the session. The caller must dispose it after all exports.
+ * Cancellation stops this export; the session's signal controls shared resource work.
+ * @public
+ */
+declare function exportPdfFrom(session: PdfExportSession, options?: PdfProjectionOptions): Promise<PdfExportResult>;
+
+/**
+ * Open a reusable PDF session over immutable DOCX bytes.
+ * Pass the session to exportPdfFrom or Markdown's exportMarkdownFrom.
+ * The caller must dispose the session. Its signal controls the entire session lifetime.
+ * @public
+ */
+declare function openDocumentForExport(source: Uint8Array, options?: OpenPdfDocumentForExportOptions): Promise<OpenPdfDocumentForExportResult>;
+
+/** Content exceeds a processing budget. @public */
+declare class PdfWorkLimitError extends Error {
+    readonly code = "workLimitExceeded";
+    constructor();
+}
+
+export { type OpenPdfDocumentForExportOptions, type OpenPdfDocumentForExportResult, type PdfDiagnostic, PdfDocumentOpenError, PdfEncodingError, type PdfExportOptions, type PdfExportResult, type PdfExportSession, type PdfExportTimings, PdfFidelityError, type PdfFontOrigin, type PdfFontsSource, PdfOutputLimitError, PdfPageLimitError, type PdfProjectionOptions, PdfWorkLimitError, exportPdf, exportPdfFrom, openDocumentForExport };

package/dist/index.d.ts

@@ -0,0 +1,146 @@
+/// <reference lib="dom" />
+import { OpenFontBackedDocumentForExportOptions, OpenFontBackedDocumentForExportResult, ExportFontResolutionReport, FontBackedExportCapabilities } from '@docx-editor.dev/core/export';
+export { ExportDroppedEmbeddedFont, ExportFontFaceResolution, ExportFontFamilyResolution, ExportFontResolutionReport, ExportResourceError, FontOriginFailure } from '@docx-editor.dev/core/export';
+import { FontOrigin } from '@docx-editor.dev/core/editor';
+export { createFontSource, defineFontResolver } from '@docx-editor.dev/core/editor';
+import { HeadlessDocumentRejection } from '@docx-editor.dev/core/store';
+export { HeadlessDocumentRejection } from '@docx-editor.dev/core/store';
+import { RevisionDisplayMode } from '@docx-editor.dev/core/layout';
+export { FontRequest, FontSubstitution, RevisionDisplayMode } from '@docx-editor.dev/core/layout';
+
+/** A bounded explanation of content the PDF cannot reproduce. @public */
+interface PdfDiagnostic {
+    /** Machine-readable diagnostic identifier. Handle unknown codes by severity. */
+    readonly code: string;
+    /** Human-readable explanation. Do not use this text for program control. */
+    readonly message: string;
+    /** Zero-based page index. Omitted for document-wide diagnostics. */
+    readonly pageIndex?: number;
+    /** One-based page number for display, consistent with Markdown warnings. */
+    readonly pageNumber?: number;
+    /** Failed font source index, when this diagnostic describes a source failure. */
+    readonly originIndex?: number;
+    /** Failed font source name, when the source provided one. */
+    readonly originName?: string;
+    /** Strict export permits only information diagnostics. */
+    readonly severity: 'unsupported' | 'approximation' | 'information';
+}
+/** A font configuration or document-aware resolver. @public */
+type PdfFontOrigin = FontOrigin;
+/** Ordered font configurations or resolvers. Earlier sources take priority. @public */
+type PdfFontsSource = PdfFontOrigin | readonly PdfFontOrigin[];
+/** Node conversion controls. Font substitution follows Core's independent fontPolicy. @public */
+interface PdfExportOptions extends Omit<OpenFontBackedDocumentForExportOptions, 'fonts' | 'measurer' | 'producer' | 'reuseAcrossRevisions'> {
+    /** Revision display mode. Defaults to proposed. */
+    readonly displayMode?: RevisionDisplayMode;
+    /** Apply optional document ligatures during measurement and output. Defaults to true. */
+    readonly documentLigatures?: boolean;
+    /** Sources after embedded fonts and before the built-in generic substitutes. */
+    readonly lastResortFonts?: PdfFontsSource;
+    /** Use installed Word fonts before packaged substitutes. Defaults to true. */
+    readonly useSystemFonts?: boolean;
+    /** Font sources before installed and packaged fonts. */
+    readonly fonts?: PdfFontsSource;
+    /** Font sources after packaged fonts and before embedded fonts. */
+    readonly fallbackFonts?: PdfFontsSource;
+    /** Reject unsupported or approximate content by default. */
+    readonly fidelityPolicy?: 'strict' | 'best-effort';
+    /** Include native PDF comment annotations. Defaults to true. */
+    readonly comments?: boolean;
+    /** Cooperative conversion deadline. Defaults to 60000 milliseconds. */
+    readonly timeoutMs?: number;
+    /** Maximum encoded bytes, from 1 to 67108864. Defaults to 67108864. */
+    readonly maxOutputBytes?: number;
+    /** Maximum output pages, from 1 to 10000. Checked after layout. Defaults to 10000. */
+    readonly maxPages?: number;
+}
+/** Elapsed milliseconds for each conversion phase. @public */
+interface PdfExportTimings {
+    readonly openMs: number;
+    readonly layoutMs: number;
+    readonly paintMs: number;
+    readonly saveMs: number;
+}
+/** Result owns its bytes; mutating them does not affect a session or subsequent export. @public */
+interface PdfExportResult {
+    /** Owned, mutable PDF bytes. Use application/pdf when serving them. */
+    readonly bytes: Uint8Array;
+    /** Physical PDF page count. */
+    readonly pageCount: number;
+    /** Layout revision for this conversion; not a persistent document identifier. */
+    readonly layoutRevision: number;
+    /** Revision display mode applied to the document. */
+    readonly displayMode: RevisionDisplayMode;
+    /** Selected faces, substitutions, and failed font sources. */
+    readonly fontResolution: ExportFontResolutionReport;
+    /** Immutable output limitations and informational notices. */
+    readonly diagnostics: readonly PdfDiagnostic[];
+    /** Wall-clock milliseconds spent opening and resolving fonts, laying out, painting, and saving. */
+    readonly timings: PdfExportTimings;
+}
+/** Requested content could not be represented faithfully. @public */
+declare class PdfFidelityError extends Error {
+    readonly diagnostics: readonly PdfDiagnostic[];
+    readonly code = "fidelityUnsupported";
+    constructor(diagnostics: readonly PdfDiagnostic[]);
+}
+/** Core refused the input package. @public */
+declare class PdfDocumentOpenError extends Error {
+    readonly reason: HeadlessDocumentRejection | 'aborted';
+    readonly detail?: string | undefined;
+    readonly code = "documentOpenFailed";
+    constructor(reason: HeadlessDocumentRejection | 'aborted', detail?: string | undefined);
+}
+/** PDF encoding failed after a document was opened. @public */
+declare class PdfEncodingError extends Error {
+    readonly code: 'encodingFailed' | 'outputTooLarge';
+    constructor(message: string, options?: ErrorOptions);
+}
+/** Encoded output exceeds the configured byte limit. @public */
+declare class PdfOutputLimitError extends PdfEncodingError {
+    readonly limit: number;
+    readonly actual: number;
+    readonly code = "outputTooLarge";
+    constructor(limit: number, actual: number);
+}
+/** Layout exceeds the configured page limit. @public */
+declare class PdfPageLimitError extends RangeError {
+    readonly limit: number;
+    readonly actual: number;
+    readonly code = "pageLimitExceeded";
+    constructor(limit: number, actual: number);
+}
+/** Output controls for a caller-owned PDF session. @public */
+type PdfProjectionOptions = Pick<PdfExportOptions, 'comments' | 'fidelityPolicy' | 'timeoutMs' | 'maxOutputBytes' | 'maxPages' | 'signal' | 'displayMode'>;
+/** Font and layout controls for a reusable immutable-byte session. @public */
+type OpenPdfDocumentForExportOptions = Omit<PdfExportOptions, 'comments' | 'fidelityPolicy' | 'timeoutMs' | 'maxOutputBytes' | 'maxPages'>;
+/** Session that retains the admitted fonts and glyph capabilities needed by PDF output. @public */
+type PdfExportSession = FontBackedExportCapabilities;
+/** Open result with the same success/refusal shape as Markdown sessions. @public */
+type OpenPdfDocumentForExportResult = OpenFontBackedDocumentForExportResult;
+
+/** Convert DOCX bytes. Disposes its session after success or failure. @public */
+declare function exportPdf(source: Uint8Array, options?: PdfExportOptions): Promise<PdfExportResult>;
+/**
+ * Encode a caller-owned font-backed session without reopening the document.
+ * Does not dispose the session. The caller must dispose it after all exports.
+ * Cancellation stops this export; the session's signal controls shared resource work.
+ * @public
+ */
+declare function exportPdfFrom(session: PdfExportSession, options?: PdfProjectionOptions): Promise<PdfExportResult>;
+
+/**
+ * Open a reusable PDF session over immutable DOCX bytes.
+ * Pass the session to exportPdfFrom or Markdown's exportMarkdownFrom.
+ * The caller must dispose the session. Its signal controls the entire session lifetime.
+ * @public
+ */
+declare function openDocumentForExport(source: Uint8Array, options?: OpenPdfDocumentForExportOptions): Promise<OpenPdfDocumentForExportResult>;
+
+/** Content exceeds a processing budget. @public */
+declare class PdfWorkLimitError extends Error {
+    readonly code = "workLimitExceeded";
+    constructor();
+}
+
+export { type OpenPdfDocumentForExportOptions, type OpenPdfDocumentForExportResult, type PdfDiagnostic, PdfDocumentOpenError, PdfEncodingError, type PdfExportOptions, type PdfExportResult, type PdfExportSession, type PdfExportTimings, PdfFidelityError, type PdfFontOrigin, type PdfFontsSource, PdfOutputLimitError, PdfPageLimitError, type PdfProjectionOptions, PdfWorkLimitError, exportPdf, exportPdfFrom, openDocumentForExport };