docling-serve-client 0.4.0 → 0.6.0

package/dist/options.d.ts

@@ -1,4 +1,4 @@
-import type { CallOptions, ClientOptions, DoclingOptions, DocumentImageMode, Job, MarkdownJobOutput, Result } from './types.js';
+import type { CallOptions, ClientOptions, DoclingOptions, DocumentImageMode, JobRef, MarkdownJobOutput, Result } from './types.js';
 /** Factory-only option keys; they fall back to the server default when omitted. */
 type FactoryOnly = Exclude<keyof ClientOptions, keyof DoclingOptions>;
 /** docling options with every per-call default filled in. */
@@ -11,9 +11,16 @@ export type ResolvedConfig = {
     fetch: typeof fetch;
     /** Time limit per request in ms; unset means no limit. */
     timeoutMs?: number;
+    /** Delay between job helper status polls in ms; defaults to `DEFAULT_POLL_MS`. */
+    pollMs: number;
     /** Factory defaults merged over `DEFAULT_OPTIONS`. */
     defaults: ResolvedOptions;
 };
+/** Validated poll settings for job helpers. */
+export type PollCall = {
+    pollMs: number;
+    signal?: AbortSignal;
+};
 /** Validated md call: server options, image handling and signal. */
 export type MarkdownCall = {
     options: ResolvedOptions;
@@ -36,18 +43,43 @@ export declare const DEFAULT_OPTIONS: Readonly<ResolvedOptions>;
  * @throws `TypeError` on invalid configuration.
  */
 export declare function resolveConfig(config: unknown): ResolvedConfig;
-/** Validates md call options over factory defaults; throws TypeError on invalid options. */
+/**
+ * Merges and validates md call options against factory defaults.
+ * @throws `TypeError` on invalid options.
+ */
 export declare function resolveMarkdownCall(defaults: Readonly<ResolvedOptions>, options: unknown): MarkdownCall;
-/** Validates document call options over factory defaults; throws TypeError on invalid options. */
+/**
+ * Merges and validates document call options against factory defaults.
+ * @throws `TypeError` on invalid options.
+ */
 export declare function resolveDocumentCall(defaults: Readonly<ResolvedOptions>, options: unknown): DocumentCall;
-/** Validates `check` call options (signal only); throws TypeError on invalid options. */
+/**
+ * Merges md call options and poll settings; `pollMs` defaults to factory `pollMs`.
+ * @throws `TypeError` on invalid options.
+ */
+export declare function resolveRunMarkdownCall(defaults: Readonly<ResolvedOptions>, defaultPollMs: number, options: unknown): MarkdownCall & PollCall;
+/**
+ * Merges document call options and poll settings; `pollMs` defaults to factory `pollMs`.
+ * @throws `TypeError` on invalid options.
+ */
+export declare function resolveRunDocumentCall(defaults: Readonly<ResolvedOptions>, defaultPollMs: number, options: unknown): DocumentCall & PollCall;
+/**
+ * Checks signal-only call options (`check`, `capabilities`).
+ * @throws `TypeError` on invalid options.
+ */
 export declare function resolveCheckOptions(options: unknown): CallOptions;
+/**
+ * Checks `waitForJob` options; `pollMs` defaults to factory `pollMs`.
+ * @throws `TypeError` on invalid options.
+ */
+export declare function resolvePollOptions(defaultPollMs: number, options: unknown): PollCall;
 /**
  * **Checks a job object against the shape `submitMarkdown()` and `submitDocument()` return**.
  *
  * - never throws: a malformed job is `invalid_input`
+ * - `settings` and other extra keys are ignored and not returned
  */
-export declare function validateJob(job: unknown): Result<Job>;
+export declare function validateJob(job: unknown): Result<JobRef>;
 /** Task id `check` accepts: word characters and `-` only, so it cannot leave the URL path segment. */
 export declare function isJobId(value: unknown): value is string;
 export {};

package/dist/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACR,WAAW,EACX,aAAa,EAEb,cAAc,EACd,iBAAiB,EAGjB,GAAG,EAEH,iBAAiB,EAEjB,MAAM,EACT,MAAM,YAAY,CAAC;AAMpB,mFAAmF;AACnF,KAAK,WAAW,GAAG,OAAO,CAAC,MAAM,aAAa,EAAE,MAAM,cAAc,CAAC,CAAC;AAEtE,6DAA6D;AAC7D,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;AAE1F,sCAAsC;AACtC,MAAM,MAAM,cAAc,GAAG;IACzB,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,QAAQ,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,YAAY,GAAG;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF,0FAA0F;AAC1F,MAAM,MAAM,YAAY,GAAG;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC;AAkBF,wDAAwD;AACxD,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,eAAe,CASpD,CAAC;AAgFH;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,cAAc,CAmB7D;AAED,4FAA4F;AAC5F,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,YAAY,CASvG;AAED,kGAAkG;AAClG,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,YAAY,CAQvG;AAED,yFAAyF;AACzF,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAEjE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAmBrD;AAED,sGAAsG;AACtG,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEvD"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACR,WAAW,EACX,aAAa,EAEb,cAAc,EACd,iBAAiB,EAGjB,MAAM,EAEN,iBAAiB,EAGjB,MAAM,EACT,MAAM,YAAY,CAAC;AAMpB,mFAAmF;AACnF,KAAK,WAAW,GAAG,OAAO,CAAC,MAAM,aAAa,EAAE,MAAM,cAAc,CAAC,CAAC;AAEtE,6DAA6D;AAC7D,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;AAE1F,sCAAsC;AACtC,MAAM,MAAM,cAAc,GAAG;IACzB,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kFAAkF;IAClF,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,QAAQ,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,+CAA+C;AAC/C,MAAM,MAAM,QAAQ,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,YAAY,GAAG;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF,0FAA0F;AAC1F,MAAM,MAAM,YAAY,GAAG;IACvB,OAAO,EAAE,eAAe,CAAC;IACzB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC;AAkBF,wDAAwD;AACxD,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,eAAe,CAUpD,CAAC;AA0GH;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,cAAc,CA2B7D;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,YAAY,CAEvG;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,YAAY,CAEvG;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAClC,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EACnC,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO,GACjB,YAAY,GAAG,QAAQ,CAMzB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAClC,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC,EACnC,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO,GACjB,YAAY,GAAG,QAAQ,CAMzB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAEjE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,QAAQ,CAGpF;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAmBxD;AAED,sGAAsG;AACtG,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEvD"}

package/dist/types.d.ts

@@ -88,12 +88,19 @@ export type ServerVersions = Record<string, string>;
  * - anything else is `invalid_input`
  */
 export type ConvertInput = Uint8Array;
-/** @deprecated Use `ConvertInput`; images are accepted as well. */
+/** Deprecated: use `ConvertInput`; images are accepted as well. */
 export type PdfInput = ConvertInput;
 /** Supported conversion pipeline backend. */
 export type Pipeline = 'standard' | 'vlm';
 /** PDF text extraction backend used by docling. */
 export type PdfBackend = 'docling_parse' | 'pypdfium2';
+/**
+ * **OCR engine preset sent as `ocr_preset`**.
+ *
+ * - known engines autocomplete; any other non-empty preset id is accepted and sent as is
+ * - installed engines: `stages.ocr.presets` of `client.capabilities()`
+ */
+export type OcrEngine = 'auto' | 'rapidocr' | 'easyocr' | 'tesseract' | 'tesserocr' | 'ocrmac' | (string & {});
 /** docling conversion options; set as factory defaults and/or per call. */
 export type DoclingOptions = {
     /** Nests headings by bookmarks, numbering, and font style; without it every heading has level 1. Default `true`. */
@@ -117,9 +124,12 @@ export type DoclingOptions = {
     /**
      * **OCRs whole PDF pages and drops their text layer**: for PDFs with broken text. Default `false`.
      *
+     * - enables OCR even with `ocr: false` (docling skips full-page OCR when `do_ocr=false`)
      * - ignored for image input: it has no text layer, and full-page OCR there merges words (`stepsand`)
      */
     forceOcr?: boolean;
+    /** OCR engine preset (`ocr_preset`); an engine the server lacks fails the conversion. Default `'auto'`. */
+    ocrEngine?: OcrEngine;
 };
 /** docling options of the factory: every per-call option plus the factory-only ones, applied to every call. */
 export type ClientOptions = DoclingOptions & {
@@ -135,6 +145,16 @@ export type CallOptions = {
     /** Abort signal to cancel the HTTP request. */
     signal?: AbortSignal;
 };
+/**
+ * **Options for job helpers (`runMarkdown`, `runDocument`, `waitForJob`)**.
+ *
+ * - `signal` covers entire call: submit, status polls, and waits
+ * - rejected by `convert*`, `submit*`, and `check`
+ */
+export type PollOptions = CallOptions & {
+    /** Delay between status polls in ms (integer `1..2147483647`). Default: factory `pollMs` (`10`). */
+    pollMs?: number;
+};
 /**
  * **Images in the md**.
  *
@@ -266,6 +286,50 @@ export type ConvertedDocument = {
     /** Server versions that produced the output; `null` if the server omitted them. */
     versions: ServerVersions | null;
 };
+/**
+ * **Conversion settings exactly as sent in the multipart request**.
+ *
+ * - every key is the camelCase name of a docling-serve form field (`ocrPreset` = `ocr_preset`)
+ * - `null`: field not sent (md-only fields of json output, unused presets, unset factory options)
+ * - `ocrLang`: empty means not sent, i.e. engine default
+ * - server-side configuration not covered by request fields (e.g. layout model) is not included
+ */
+export type DoclingSettings = {
+    fromFormats: 'pdf' | 'image';
+    toFormats: 'md' | 'json';
+    imageExportMode: 'embedded' | 'placeholder';
+    includeImages: boolean;
+    includePageImages: boolean;
+    imagesScale: number;
+    mdCompactTables: boolean | null;
+    mdPageBreakPlaceholder: string | null;
+    doOcr: boolean;
+    forceOcr: boolean;
+    ocrPreset: string;
+    ocrLang: string[];
+    pdfBackend: PdfBackend;
+    pipeline: Pipeline;
+    vlmPipelinePreset: string | null;
+    doTableStructure: boolean;
+    tableMode: 'accurate';
+    tableStructurePreset: string;
+    tableCellMatching: boolean;
+    doPdfHeadingHierarchy: boolean;
+    doFormulaEnrichment: boolean;
+    doCodeEnrichment: boolean;
+    codeFormulaPreset: string | null;
+    doChartExtraction: boolean;
+    chartExtractionPreset: string | null;
+    doPictureClassification: boolean;
+    doPictureDescription: boolean;
+    pageRange: [from: number, to: number] | null;
+    documentTimeout: number | null;
+    abortOnError: boolean;
+};
+/** Result of `convert*` and `run*` plus the settings sent with the conversion. */
+export type WithSettings<T> = T & {
+    settings: DoclingSettings;
+};
 /** Image handling of a md job, applied when `check()` picks up the result. */
 export type MarkdownJobOutput = {
     images: 'extract';
@@ -279,15 +343,21 @@ export type MarkdownJob = {
     /** Server-side task id. */
     id: string;
     output: MarkdownJobOutput;
+    /** Settings sent with the submission; `check()` neither needs nor returns them. */
+    settings: DoclingSettings;
 };
 /** Handle of a document conversion, returned by `submitDocument()`; plain JSON, safe to store. */
 export type DocumentJob = {
     kind: 'document';
     /** Server-side task id. */
     id: string;
+    /** Settings sent with the submission; `check()` neither needs nor returns them. */
+    settings: DoclingSettings;
 };
-/** Any job handle accepted by `check()`. */
+/** Any job handle returned by `submit*()`. */
 export type Job = MarkdownJob | DocumentJob;
+/** Job handle accepted by `check()`; `settings` may be dropped when storing the job. */
+export type JobRef = Omit<MarkdownJob, 'settings'> | Omit<DocumentJob, 'settings'>;
 /** State of an async job; `done` carries the conversion result. */
 export type JobState<T> = 
 /** Pending in server queue; `position` is 1-based when reported by server. */
@@ -303,43 +373,125 @@ export type JobState<T> =
  | ({
     status: 'done';
 } & T);
+/** Model or engine preset a pipeline stage offers; `id` is the value of the stage's form field. */
+export type CapabilityPreset = {
+    id: string;
+    name: string;
+    description: string | null;
+    /** Origin, e.g. `'docling'` or `'default'` (server default alias). */
+    source: string;
+};
+/** Pipeline stage (OCR, table structure, VLM, ...) with its form field and installed presets. */
+export type CapabilityStage = {
+    /** Form field selecting the preset, e.g. `'ocr_preset'`. */
+    option: string;
+    customConfigOption: string | null;
+    /** Preset used when the field is not sent. */
+    default: string;
+    presets: CapabilityPreset[];
+};
+/** Server limits; `null` means unlimited or not reported. */
+export type CapabilityLimits = {
+    maxDocumentTimeout: number | null;
+    maxImagesScale: number | null;
+    maxSourcesPerRequest: number | null;
+    maxNumPages: number | null;
+    maxFileSize: number | null;
+};
+/**
+ * **What the docling-serve instance offers (`GET /v1/capabilities`)**.
+ *
+ * - snake_case keys of the server payload converted to camelCase; `stages` keys stay as sent (e.g. `table_structure`)
+ * - missing or mistyped fields become empty lists, `''`, `null` or `false`
+ * - diagnostics only: conversions never query it
+ */
+export type ServerCapabilities = {
+    versions: ServerVersions;
+    stages: Record<string, CapabilityStage>;
+    sources: string[];
+    targets: {
+        allowed: string[];
+        default: string;
+    };
+    outputFormats: string[];
+    imageExportModes: string[];
+    limits: CapabilityLimits;
+    features: {
+        apiKeyRequired: boolean;
+        artifactStorage: boolean;
+        websocket: boolean;
+    };
+};
 /** Configuration passed to `createDoclingClient`. */
 export type DoclingConfig = {
-    /** docling-serve base URL, e.g. `'http://127.0.0.1:5001'`; trailing `/` are removed. */
+    /** docling-serve base URL, e.g. `'http://127.0.0.1:5001'`; trailing `/` removed; no query, fragment, or credentials. */
     baseUrl: string;
     /** Sent as `X-Api-Key` header. */
     apiKey?: string;
-    /** Limit per request in ms (not `/version`); on expiry the call resolves with `aborted`. */
+    /** Time limit per request in ms (integer `1..2147483647`, excludes `/version`); resolves to `aborted` on expiry. */
     timeoutMs?: number;
+    /** Delay between job helper status polls in ms (integer `1..2147483647`). Default `10`. */
+    pollMs?: number;
     /** Custom fetch implementation for mocking or custom dispatchers. */
     fetch?: typeof fetch;
     /** Defaults for every call; call options override them key by key, except the factory-only ones. */
     options?: ClientOptions;
 };
 /**
- * **docling-serve client**.
+ * **docling-serve client**: every call returns a Promise.
  *
- * - `convert*`: one synchronous request
- * - `submit*` + `check`: async job; the caller stores the job and polls
+ * - single request (`convert*`): one HTTP request to sync endpoint; answers on `DOCLING_SERVE_SYNC_POLL_INTERVAL`
+ *   ticks (default 2 s) and returns 504 after `DOCLING_SERVE_MAX_SYNC_WAIT`
+ * - job (`submit*` + `check`): async endpoints; caller stores job and polls
+ * - job helper (`run*`, `waitForJob`): submits or takes a job and polls every `pollMs` until done
  */
 export type DoclingClient = {
     /** PDF or image to docling's md; images as placeholders, removed or extracted. */
-    convertMarkdown(input: ConvertInput, options?: MarkdownOptions): Promise<Result<ConvertedMarkdown>>;
+    convertMarkdown(input: ConvertInput, options?: MarkdownOptions): Promise<Result<WithSettings<ConvertedMarkdown>>>;
     /** PDF or image to docling's DoclingDocument. */
-    convertDocument(input: ConvertInput, options?: DocumentOptions): Promise<Result<ConvertedDocument>>;
-    /** Starts an async md conversion. */
+    convertDocument(input: ConvertInput, options?: DocumentOptions): Promise<Result<WithSettings<ConvertedDocument>>>;
+    /** Starts an async md conversion; the job carries the sent settings. */
     submitMarkdown(input: ConvertInput, options?: MarkdownOptions): Promise<Result<MarkdownJob>>;
-    /** Starts an async document conversion. */
+    /** Starts an async document conversion; the job carries the sent settings. */
     submitDocument(input: ConvertInput, options?: DocumentOptions): Promise<Result<DocumentJob>>;
     /**
      * **Polls a job; fetches its result once done**.
      *
-     * - docling-serve deletes a result `DOCLING_SERVE_RESULT_REMOVAL_DELAY` seconds (default 300) after its first
-     *   fetch: a `check` whose result download failed can be repeated within that time, later it returns
-     *   `not_found`; persist `done` data, or start docling-serve with `DOCLING_SERVE_SINGLE_USE_RESULTS=false`
+     * - docling-serve deletes the task `DOCLING_SERVE_RESULT_REMOVAL_DELAY` seconds (default 300) after first
+     *   result fetch: a `check` whose result download failed can be repeated within that window, later returning
+     *   `not_found` (`Unknown job id`); persist `done` data, or set `DOCLING_SERVE_SINGLE_USE_RESULTS=false`
+     * - `done` carries no settings (stored on the job)
+     */
+    check(job: Omit<MarkdownJob, 'settings'>, options?: CallOptions): Promise<Result<JobState<ConvertedMarkdown>>>;
+    check(job: Omit<DocumentJob, 'settings'>, options?: CallOptions): Promise<Result<JobState<ConvertedDocument>>>;
+    check(job: JobRef, options?: CallOptions): Promise<Result<JobState<ConvertedMarkdown | ConvertedDocument>>>;
+    /**
+     * **Submits an md job and polls every `pollMs` until done**: same result as `convertMarkdown`.
+     *
+     * - `signal` covers submit, status polls, and waits; `timeoutMs` limits each HTTP request
+     * - first error ends call; job never returned (use `submitMarkdown` + `waitForJob` to keep it)
+     * - aborting does not cancel the server-side job
+     */
+    runMarkdown(input: ConvertInput, options?: MarkdownOptions & PollOptions): Promise<Result<WithSettings<ConvertedMarkdown>>>;
+    /**
+     * **Submits a document job and polls every `pollMs` until done**: same result as `convertDocument`.
+     *
+     * - `signal` covers submit, status polls, and waits; `timeoutMs` limits each HTTP request
+     * - first error ends call; job never returned (use `submitDocument` + `waitForJob` to keep it)
+     * - aborting does not cancel the server-side job
+     */
+    runDocument(input: ConvertInput, options?: DocumentOptions & PollOptions): Promise<Result<WithSettings<ConvertedDocument>>>;
+    /**
+     * **Polls an existing job every `pollMs` until done**.
+     *
+     * - first status poll runs immediately; already-finished jobs cost one `check`
+     * - resolves to `check`'s `done` data without `status`; first error ends call
+     * - repeatable after a failed result download within `DOCLING_SERVE_RESULT_REMOVAL_DELAY` (default 300 s)
      */
-    check(job: MarkdownJob, options?: CallOptions): Promise<Result<JobState<ConvertedMarkdown>>>;
-    check(job: DocumentJob, options?: CallOptions): Promise<Result<JobState<ConvertedDocument>>>;
-    check(job: Job, options?: CallOptions): Promise<Result<JobState<ConvertedMarkdown | ConvertedDocument>>>;
+    waitForJob(job: Omit<MarkdownJob, 'settings'>, options?: PollOptions): Promise<Result<ConvertedMarkdown>>;
+    waitForJob(job: Omit<DocumentJob, 'settings'>, options?: PollOptions): Promise<Result<ConvertedDocument>>;
+    waitForJob(job: JobRef, options?: PollOptions): Promise<Result<ConvertedMarkdown | ConvertedDocument>>;
+    /** Installed presets, limits and features of the server; on demand only, never used by conversions. */
+    capabilities(options?: CallOptions): Promise<Result<ServerCapabilities>>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAMrD,iFAAiF;AACjF,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B,4GAA4G;AAC5G,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,CAAC;AAEnF,mCAAmC;AACnC,KAAK,SAAS,GAAG;IACb,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAChC,CACM,+EAA+E,CACjF;IAAE,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAA;CAAE;AACjD,uGAAuG;GACrG;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,OAAO,EAAE,iBAAiB,CAAA;CAAE,CAC9D,CAAC;AAEN;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF,kFAAkF;AAClF,MAAM,MAAM,WAAW,GAAG;IACtB,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,iEAAiE;IACjE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,oEAAoE;IACpE,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,aAAa,GAAG;IACxB,2DAA2D;IAC3D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,sEAAsE;IACtE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,8EAA8E;IAC9E,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,kFAAkF;AAClF,MAAM,MAAM,WAAW,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAMpD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AAEtC,mEAAmE;AACnE,MAAM,MAAM,QAAQ,GAAG,YAAY,CAAC;AAEpC,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAC;AAE1C,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,WAAW,CAAC;AAEvD,2EAA2E;AAC3E,MAAM,MAAM,cAAc,GAAG;IACzB,oHAAoH;IACpH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gIAAgI;IAChI,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,2EAA2E;IAC3E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0FAA0F;IAC1F,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kFAAkF;IAClF,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,sGAAsG;IACtG,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,+GAA+G;AAC/G,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IACzC,6GAA6G;IAC7G,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,mFAAmF;IACnF,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACvC,gGAAgG;IAChG,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,WAAW,GAAG;IACtB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;AAEnE,sDAAsD;AACtD,MAAM,MAAM,YAAY,GAAG;IACvB,qGAAqG;IACrG,MAAM,EAAE,MAAM,CAAC;IACf,2GAA2G;IAC3G,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,eAAe,GAAG,cAAc,GACxC,WAAW,GAAG;IACV,+BAA+B;IAC/B,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,gEAAgE;IAChE,YAAY,CAAC,EAAE,YAAY,CAAC;CAC/B,CAAC;AAEN;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,aAAa,CAAC;AAE3D,yDAAyD;AACzD,MAAM,MAAM,eAAe,GAAG,cAAc,GACxC,WAAW,GAAG;IACV,4BAA4B;IAC5B,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,yGAAyG;IACzG,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAMN,oCAAoC;AACpC,MAAM,MAAM,SAAS,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG;IACzB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,UAAU,CAAC;IAClB,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,qFAAqF;AACrF,MAAM,MAAM,YAAY,GAAG;IACvB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,mFAAmF;AACnF,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,aAAa,CAAA;CAAE,CAAC;AAExF,wEAAwE;AACxE,MAAM,MAAM,YAAY,GAAG;IACvB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACL,qEAAqE;QACrE,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;CACL,CAAC;AAEF,iIAAiI;AACjI,MAAM,MAAM,gBAAgB,GAAG;IAC3B,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACL,wBAAwB;QACxB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;CACL,CAAC;AAEF,kCAAkC;AAClC,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,YAAY,CAAC;AAE3D,wCAAwC;AACxC,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,gBAAgB,CAAC;AAE/D,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,mFAAmF;IACnF,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,QAAQ,EAAE,eAAe,CAAC;IAC1B,kEAAkE;IAClE,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,mFAAmF;IACnF,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;CACnC,CAAC;AAMF,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GACvB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;CAAE,GAC3D;IAAE,MAAM,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,CAAC;AAEzC,4FAA4F;AAC5F,MAAM,MAAM,WAAW,GAAG;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,kGAAkG;AAClG,MAAM,MAAM,WAAW,GAAG;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,4CAA4C;AAC5C,MAAM,MAAM,GAAG,GAAG,WAAW,GAAG,WAAW,CAAC;AAE5C,mEAAmE;AACnE,MAAM,MAAM,QAAQ,CAAC,CAAC;AAClB,8EAA8E;AAC5E;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE;AAC/C,qCAAqC;GACnC;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE;AACvB,gDAAgD;GAC9C,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC,CAAC,CAAC;AAM/B,qDAAqD;AACrD,MAAM,MAAM,aAAa,GAAG;IACxB,wFAAwF;IACxF,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qEAAqE;IACrE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,oGAAoG;IACpG,OAAO,CAAC,EAAE,aAAa,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,kFAAkF;IAClF,eAAe,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpG,iDAAiD;IACjD,eAAe,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpG,qCAAqC;IACrC,cAAc,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7F,2CAA2C;IAC3C,cAAc,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7F;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC7F,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC7F,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAC5G,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAMrD,iFAAiF;AACjF,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B,4GAA4G;AAC5G,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,CAAC;AAEnF,mCAAmC;AACnC,KAAK,SAAS,GAAG;IACb,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;CACpC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAChC,CACM,+EAA+E,CACjF;IAAE,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAA;CAAE;AACjD,uGAAuG;GACrG;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,OAAO,EAAE,iBAAiB,CAAA;CAAE,CAC9D,CAAC;AAEN;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF,kFAAkF;AAClF,MAAM,MAAM,WAAW,GAAG;IACtB,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,iEAAiE;IACjE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,oEAAoE;IACpE,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;CAC7B,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,aAAa,GAAG;IACxB,2DAA2D;IAC3D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,sEAAsE;IACtE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,8EAA8E;IAC9E,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,kFAAkF;AAClF,MAAM,MAAM,WAAW,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAIpD;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC;AAEtC,mEAAmE;AACnE,MAAM,MAAM,QAAQ,GAAG,YAAY,CAAC;AAEpC,6CAA6C;AAC7C,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,KAAK,CAAC;AAE1C,mDAAmD;AACnD,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,WAAW,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAE/G,2EAA2E;AAC3E,MAAM,MAAM,cAAc,GAAG;IACzB,oHAAoH;IACpH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gIAAgI;IAChI,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,2EAA2E;IAC3E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0FAA0F;IAC1F,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kFAAkF;IAClF,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,sGAAsG;IACtG,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2GAA2G;IAC3G,SAAS,CAAC,EAAE,SAAS,CAAC;CACzB,CAAC;AAEF,+GAA+G;AAC/G,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IACzC,6GAA6G;IAC7G,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,mFAAmF;IACnF,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACvC,gGAAgG;IAChG,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,WAAW,GAAG;IACtB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG;IACpC,oGAAoG;IACpG,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;AAEnE,sDAAsD;AACtD,MAAM,MAAM,YAAY,GAAG;IACvB,qGAAqG;IACrG,MAAM,EAAE,MAAM,CAAC;IACf,2GAA2G;IAC3G,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,eAAe,GAAG,cAAc,GACxC,WAAW,GAAG;IACV,+BAA+B;IAC/B,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,gEAAgE;IAChE,YAAY,CAAC,EAAE,YAAY,CAAC;CAC/B,CAAC;AAEN;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,aAAa,CAAC;AAE3D,yDAAyD;AACzD,MAAM,MAAM,eAAe,GAAG,cAAc,GACxC,WAAW,GAAG;IACV,4BAA4B;IAC5B,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,yGAAyG;IACzG,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAIN,oCAAoC;AACpC,MAAM,MAAM,SAAS,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG;IACzB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,UAAU,CAAC;IAClB,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,qFAAqF;AACrF,MAAM,MAAM,YAAY,GAAG;IACvB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,mFAAmF;AACnF,MAAM,MAAM,aAAa,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,aAAa,CAAA;CAAE,CAAC;AAExF,wEAAwE;AACxE,MAAM,MAAM,YAAY,GAAG;IACvB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACL,qEAAqE;QACrE,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;CACL,CAAC;AAEF,iIAAiI;AACjI,MAAM,MAAM,gBAAgB,GAAG;IAC3B,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACL,wBAAwB;QACxB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;CACL,CAAC;AAEF,kCAAkC;AAClC,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,YAAY,CAAC;AAE3D,wCAAwC;AACxC,MAAM,MAAM,eAAe,GAAG,aAAa,GAAG,gBAAgB,CAAC;AAE/D,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,mFAAmF;IACnF,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,QAAQ,EAAE,eAAe,CAAC;IAC1B,kEAAkE;IAClE,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,mFAAmF;IACnF,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B,WAAW,EAAE,KAAK,GAAG,OAAO,CAAC;IAC7B,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IACzB,eAAe,EAAE,UAAU,GAAG,aAAa,CAAC;IAC5C,aAAa,EAAE,OAAO,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,SAAS,EAAE,UAAU,CAAC;IACtB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,uBAAuB,EAAE,OAAO,CAAC;IACjC,oBAAoB,EAAE,OAAO,CAAC;IAC9B,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAC7C,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,YAAY,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,kFAAkF;AAClF,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG;IAC9B,QAAQ,EAAE,eAAe,CAAC;CAC7B,CAAC;AAIF,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GACvB;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;CAAE,GAC3D;IAAE,MAAM,EAAE,MAAM,GAAG,aAAa,CAAA;CAAE,CAAC;AAEzC,4FAA4F;AAC5F,MAAM,MAAM,WAAW,GAAG;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,iBAAiB,CAAC;IAC1B,mFAAmF;IACnF,QAAQ,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,kGAAkG;AAClG,MAAM,MAAM,WAAW,GAAG;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,2BAA2B;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,mFAAmF;IACnF,QAAQ,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,GAAG,GAAG,WAAW,GAAG,WAAW,CAAC;AAE5C,wFAAwF;AACxF,MAAM,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;AAEnF,mEAAmE;AACnE,MAAM,MAAM,QAAQ,CAAC,CAAC;AAClB,8EAA8E;AAC5E;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE;AAC/C,qCAAqC;GACnC;IAAE,MAAM,EAAE,SAAS,CAAA;CAAE;AACvB,gDAAgD;GAC9C,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC,CAAC,CAAC;AAI/B,mGAAmG;AACnG,MAAM,MAAM,gBAAgB,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,iGAAiG;AACjG,MAAM,MAAM,eAAe,GAAG;IAC1B,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC/B,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,gBAAgB,GAAG;IAC3B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B,QAAQ,EAAE,cAAc,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACxC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE;QACL,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,MAAM,EAAE,gBAAgB,CAAC;IACzB,QAAQ,EAAE;QACN,cAAc,EAAE,OAAO,CAAC;QACxB,eAAe,EAAE,OAAO,CAAC;QACzB,SAAS,EAAE,OAAO,CAAC;KACtB,CAAC;CACL,CAAC;AAIF,qDAAqD;AACrD,MAAM,MAAM,aAAa,GAAG;IACxB,wHAAwH;IACxH,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oHAAoH;IACpH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,oGAAoG;IACpG,OAAO,CAAC,EAAE,aAAa,CAAC;CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,kFAAkF;IAClF,eAAe,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAClH,iDAAiD;IACjD,eAAe,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAClH,wEAAwE;IACxE,cAAc,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7F,8EAA8E;IAC9E,cAAc,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7F;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC/G,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC/G,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC5G;;;;;;OAMG;IACH,WAAW,CACP,KAAK,EAAE,YAAY,EACnB,OAAO,CAAC,EAAE,eAAe,GAAG,WAAW,GACxC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IACpD;;;;;;OAMG;IACH,WAAW,CACP,KAAK,EAAE,YAAY,EACnB,OAAO,CAAC,EAAE,eAAe,GAAG,WAAW,GACxC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IACpD;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC1G,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC1G,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,GAAG,iBAAiB,CAAC,CAAC,CAAC;IACvG,uGAAuG;IACvG,YAAY,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;CAC5E,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docling-serve-client",
-  "version": "0.4.0",
-  "description": "Typed docling-serve client: PDF to docling Markdown or DoclingDocument JSON, sync and async. In-memory, zero-dependency, never throws.",
+  "version": "0.6.0",
+  "description": "Typed docling-serve client: PDF to docling Markdown or DoclingDocument JSON, as single request, job or polling job helper. In-memory, zero-dependency, never throws.",
   "keywords": [
     "pdf",
     "markdown",
@@ -66,9 +66,9 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
-    "@biomejs/biome": "2.5.14",
-    "@types/bun": "^1.4.0",
-    "@types/node": "^22.12.0",
+    "@biomejs/biome": "2.5.15",
+    "@types/bun": "^1.4.3",
+    "@types/node": "^22.20.5",
     "bun-test-runner": "latest",
     "smartin": "latest",
     "typescript": "^7.0.2"

package/src/capabilities.ts

@@ -0,0 +1,109 @@
+// Copyright 2026 Martin Winkler
+// SPDX-License-Identifier: Apache-2.0
+
+import { ERR, fail, ok } from './core/result.js';
+import { isPlainObject } from './core/validate.js';
+import type { CapabilityLimits, CapabilityPreset, CapabilityStage, Result, ServerCapabilities } from './types.js';
+
+// -------------------------------------------------------------------
+// --- 1. Types
+// -------------------------------------------------------------------
+
+/** Loosely read JSON object; every field is checked before use. */
+type JsonObject = Record<string, unknown>;
+
+// -------------------------------------------------------------------
+// --- 2. Exported Functions
+// -------------------------------------------------------------------
+
+/**
+ * **Maps the `GET /v1/capabilities` payload to camelCase `ServerCapabilities`**.
+ *
+ * - lenient per field: missing or mistyped values become `[]`, `''`, `null` or `false`, so new server fields or
+ *   removed ones never fail the call
+ * - non-object body: `invalid_response`
+ */
+export function readCapabilities(body: unknown): Result<ServerCapabilities> {
+    if (!isPlainObject(body)) {
+        return fail(ERR.INVALID_RESPONSE('Capabilities response is not a JSON object'));
+    }
+    const targets = objectOf(body.targets);
+    const features = objectOf(body.features);
+    return ok({
+        versions: Object.fromEntries(
+            Object.entries(objectOf(body.versions)).filter(
+                (entry): entry is [string, string] => typeof entry[1] === 'string',
+            ),
+        ),
+        stages: Object.fromEntries(
+            Object.entries(objectOf(body.stages)).map(([name, stage]) => [name, readStage(objectOf(stage))]),
+        ),
+        sources: stringsOf(body.sources),
+        targets: { allowed: stringsOf(targets.allowed), default: stringOf(targets.default) },
+        outputFormats: stringsOf(body.output_formats),
+        imageExportModes: stringsOf(body.image_export_modes),
+        limits: readLimits(objectOf(body.limits)),
+        features: {
+            apiKeyRequired: features.api_key_required === true,
+            artifactStorage: features.artifact_storage === true,
+            websocket: features.websocket === true,
+        },
+    });
+}
+
+// -------------------------------------------------------------------
+// --- 3. Private Functions
+// -------------------------------------------------------------------
+
+/** Pipeline stage; presets without a string `id` are dropped. */
+function readStage(stage: JsonObject): CapabilityStage {
+    const presets: CapabilityPreset[] = [];
+    for (const item of Array.isArray(stage.presets) ? stage.presets : []) {
+        const preset = objectOf(item);
+        if (typeof preset.id === 'string') {
+            presets.push({
+                id: preset.id,
+                name: stringOf(preset.name),
+                description: typeof preset.description === 'string' ? preset.description : null,
+                source: stringOf(preset.source),
+            });
+        }
+    }
+    return {
+        option: stringOf(stage.option),
+        customConfigOption: typeof stage.custom_config_option === 'string' ? stage.custom_config_option : null,
+        default: stringOf(stage.default),
+        presets,
+    };
+}
+
+/** Server limits; non-numbers become `null`. */
+function readLimits(limits: JsonObject): CapabilityLimits {
+    return {
+        maxDocumentTimeout: numberOf(limits.max_document_timeout),
+        maxImagesScale: numberOf(limits.max_images_scale),
+        maxSourcesPerRequest: numberOf(limits.max_sources_per_request),
+        maxNumPages: numberOf(limits.max_num_pages),
+        maxFileSize: numberOf(limits.max_file_size),
+    };
+}
+
+/** Plain object, or `{}` for anything else. */
+function objectOf(value: unknown): JsonObject {
+    return isPlainObject(value) ? value : {};
+}
+
+/** String entries of an array; `[]` for a non-array. */
+function stringsOf(value: unknown): string[] {
+    return Array.isArray(value) ? value.filter((item): item is string => typeof item === 'string') : [];
+}
+
+/** String, or `''` for anything else. */
+function stringOf(value: unknown): string {
+    return typeof value === 'string' ? value : '';
+}
+
+/** Finite number, or `null` for anything else. */
+function numberOf(value: unknown): number | null {
+    return typeof value === 'number' && Number.isFinite(value) ? value : null;
+}