pulse-ts-sdk 1.0.15 → 1.0.16

package/dist/cjs/api/client/requests/ExtractAsyncRequest.d.ts

@@ -14,11 +14,11 @@ export interface ExtractAsyncRequest {
     extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
-    /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
+    /** Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response. */
     figureProcessing?: ExtractAsyncRequest.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractAsyncRequest.Extensions;
-    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
+    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names. */
     spreadsheet?: ExtractAsyncRequest.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractAsyncRequest.Storage;
@@ -55,12 +55,12 @@ export declare namespace ExtractAsyncRequest {
     };
     type Model = (typeof Model)[keyof typeof Model];
     /**
-     * Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response.
+     * Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response.
      */
     interface FigureProcessing {
-        /** Generate descriptive captions for extracted figures. */
+        /** Generate descriptive captions for extracted visuals. When `true`, applies to both detected charts and non-chart images. Captions appear under `bounding_boxes.Images[].description` and inline in the markdown output where applicable. */
         description?: boolean;
-        /** Embed base64-encoded images inline in figure tags in the output. Increases response size. */
+        /** Return image URLs for extracted visuals. When `true`, applies to both charts and non-chart images. URLs are emitted under `bounding_boxes.Images[].image_url` — typically a Pulse-hosted proxy URL served from `GET /results/{jobId}/images/{filename}`. Spreadsheet charts and embedded images are read directly from the workbook; PDF/image inputs use detected figure regions. */
         showImages?: boolean;
     }
     /**
@@ -109,7 +109,7 @@ export declare namespace ExtractAsyncRequest {
         }
     }
     /**
-     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
+     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names.
      */
     interface Spreadsheet {
         /** Include rows that are hidden in the Excel workbook. */

package/dist/cjs/api/client/requests/ExtractRequest.d.ts

@@ -14,11 +14,11 @@ export interface ExtractRequest {
     extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
-    /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
+    /** Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response. */
     figureProcessing?: ExtractRequest.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractRequest.Extensions;
-    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
+    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names. */
     spreadsheet?: ExtractRequest.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractRequest.Storage;
@@ -55,12 +55,12 @@ export declare namespace ExtractRequest {
     };
     type Model = (typeof Model)[keyof typeof Model];
     /**
-     * Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response.
+     * Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response.
      */
     interface FigureProcessing {
-        /** Generate descriptive captions for extracted figures. */
+        /** Generate descriptive captions for extracted visuals. When `true`, applies to both detected charts and non-chart images. Captions appear under `bounding_boxes.Images[].description` and inline in the markdown output where applicable. */
         description?: boolean;
-        /** Embed base64-encoded images inline in figure tags in the output. Increases response size. */
+        /** Return image URLs for extracted visuals. When `true`, applies to both charts and non-chart images. URLs are emitted under `bounding_boxes.Images[].image_url` — typically a Pulse-hosted proxy URL served from `GET /results/{jobId}/images/{filename}`. Spreadsheet charts and embedded images are read directly from the workbook; PDF/image inputs use detected figure regions. */
         showImages?: boolean;
     }
     /**
@@ -109,7 +109,7 @@ export declare namespace ExtractRequest {
         }
     }
     /**
-     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
+     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names.
      */
     interface Spreadsheet {
         /** Include rows that are hidden in the Excel workbook. */

package/dist/cjs/api/resources/results/client/Client.d.ts

@@ -24,4 +24,32 @@ export declare class ResultsClient {
      */
     getPdf(request: Pulse.GetPdfResultsRequest, requestOptions?: ResultsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
     private __getPdf;
+    /**
+     * Stream a PNG/JPEG visual image referenced by an extraction
+     * response under `bounding_boxes.Images[].image_url`.
+     *
+     * The URL is API-hosted instead of raw S3 — the underlying object
+     * store is intentionally not part of the public contract. The host
+     * in `image_url` mirrors the request origin (e.g. a request to a
+     * beta deployment returns image URLs on that same host).
+     *
+     * **Authentication is required.** Unlike the legacy single-use
+     * `/large_results/{jobId}` route, visual artifacts are
+     * independently-addressable resources — every fetch must present a
+     * valid API key for the owning org. There is no anonymous /
+     * TTL-based fallback. Use the same `x-api-key` header you use for
+     * `/extract`.
+     *
+     * Fetching an image does **not** consume the parent extraction's
+     * result-delivery slot, so one extraction can produce many image
+     * URLs and each can be fetched repeatedly while the artifact is
+     * retained.
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.InternalServerError}
+     */
+    getImage(request: Pulse.GetImageResultsRequest, requestOptions?: ResultsClient.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __getImage;
 }

package/dist/cjs/api/resources/results/client/Client.js

@@ -112,5 +112,82 @@ class ResultsClient {
             return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/results/{jobId}/pdf");
         });
     }
+    /**
+     * Stream a PNG/JPEG visual image referenced by an extraction
+     * response under `bounding_boxes.Images[].image_url`.
+     *
+     * The URL is API-hosted instead of raw S3 — the underlying object
+     * store is intentionally not part of the public contract. The host
+     * in `image_url` mirrors the request origin (e.g. a request to a
+     * beta deployment returns image URLs on that same host).
+     *
+     * **Authentication is required.** Unlike the legacy single-use
+     * `/large_results/{jobId}` route, visual artifacts are
+     * independently-addressable resources — every fetch must present a
+     * valid API key for the owning org. There is no anonymous /
+     * TTL-based fallback. Use the same `x-api-key` header you use for
+     * `/extract`.
+     *
+     * Fetching an image does **not** consume the parent extraction's
+     * result-delivery slot, so one extraction can produce many image
+     * URLs and each can be fetched repeatedly while the artifact is
+     * retained.
+     * @throws {@link Pulse.BadRequestError}
+     * @throws {@link Pulse.UnauthorizedError}
+     * @throws {@link Pulse.ForbiddenError}
+     * @throws {@link Pulse.NotFoundError}
+     * @throws {@link Pulse.InternalServerError}
+     */
+    getImage(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getImage(request, requestOptions));
+    }
+    __getImage(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { jobId, filename } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PulseEnvironment.Default, `results/${core.url.encodePathParam(jobId)}/images/${core.url.encodePathParam(filename)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                responseType: "binary-response",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null
+                    ? requestOptions.timeoutInSeconds * 1000
+                    : ((_d = this._options) === null || _d === void 0 ? void 0 : _d.timeoutInSeconds) != null
+                        ? ((_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) * 1000
+                        : undefined,
+                maxRetries: (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_h = this._options) === null || _h === void 0 ? void 0 : _h.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Pulse.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Pulse.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pulse.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Pulse.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pulse.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PulseError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/results/{jobId}/images/{filename}");
+        });
+    }
 }
 exports.ResultsClient = ResultsClient;

package/dist/cjs/api/resources/results/client/requests/GetImageResultsRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         jobId: "jobId",
+ *         filename: "filename"
+ *     }
+ */
+export interface GetImageResultsRequest {
+    /** Job identifier — same value used in the `image_url` returned from `/extract`. */
+    jobId: string;
+    /** Visual filename — e.g. `excel_image_1_1.png`. Must be the exact `filename` segment from the `image_url`. */
+    filename: string;
+}

package/dist/cjs/api/resources/results/client/requests/GetImageResultsRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/results/client/requests/index.d.ts

@@ -1 +1,2 @@
+export type { GetImageResultsRequest } from "./GetImageResultsRequest.js";
 export type { GetPdfResultsRequest } from "./GetPdfResultsRequest.js";

package/dist/cjs/api/types/BoundingBoxImage.d.ts

@@ -0,0 +1,54 @@
+import type * as Pulse from "../index.js";
+/**
+ * Detected or embedded visual (chart or image) returned under `bounding_boxes.Images`. For PDFs/images, populated when figure detection is enabled. For spreadsheets, populated for embedded charts and images. `image_url` is set when `figure_processing.show_images` is enabled.
+ */
+export interface BoundingBoxImage {
+    /** Stable visual identifier (e.g. `excel_image_1_1`, `fig-3`). Use this to join with the `data-bb-image-id` attribute in the markdown output. */
+    id: string;
+    /** Short caption for the visual (e.g. `Chart: Revenue`). Populated by the spreadsheet parser; PDF figures may leave this empty when no caption is detected. */
+    content?: string;
+    /** Visual class. Drives whether `figure_processing.description` / `figure_processing.show_images` apply to this entry. */
+    visual_type: Pulse.VisualType;
+    /** 1-indexed page or sheet index. */
+    page_number?: number;
+    /** Document coordinate polygon when available. Spreadsheet visuals typically use an empty array and rely on `excel_range` for positioning. */
+    bounding_box?: number[];
+    /** Pulse-hosted URL for the visual image bytes. Present when `figure_processing.show_images` was enabled for this visual_type. Spreadsheet visuals proxy through `GET /results/{jobId}/images/{filename}`; inline figure flows may use a data URI. */
+    image_url?: string;
+    /** Generated visual description. Present when `figure_processing.description` was enabled for this visual_type. */
+    description?: string;
+    /** Visual classification metadata when classification was run. Includes confidence, model name, and any non-fatal classification error. */
+    classification?: BoundingBoxImage.Classification;
+    /** Spreadsheet-only sheet name. */
+    sheet_name?: string;
+    /** Spreadsheet-only parsed sheet index after hidden-sheet filtering. */
+    sheet_index?: number;
+    /** Spreadsheet-only original workbook sheet index. */
+    workbook_sheet_index?: number;
+    /** Spreadsheet-only anchor or covered cell range for the visual. */
+    excel_range?: string;
+    /** Spreadsheet chart class name (e.g. `BarChart`, `LineChart`) when `visual_type` is `chart`. */
+    chart_type?: string;
+    /** Spreadsheet chart title when available. */
+    chart_title?: string;
+    /** Spreadsheet chart source ranges when available, e.g. `["Charts!$B$1:$B$3"]`. */
+    source_ranges?: string[];
+    /** Optional non-fatal rendering error for spreadsheet visuals. When set, the visual entry is still returned but `image_url` may be omitted. */
+    render_error?: string;
+    /** Optional non-fatal description-generation error. */
+    description_error?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace BoundingBoxImage {
+    /**
+     * Visual classification metadata when classification was run. Includes confidence, model name, and any non-fatal classification error.
+     */
+    interface Classification {
+        confidence?: number;
+        model?: string;
+        error?: string;
+        /** Accepts any additional properties */
+        [key: string]: any;
+    }
+}

package/dist/cjs/api/types/BoundingBoxImage.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/BoundingBoxItem.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Common base shape used for `Text`, `Title`, and `Footer` bounding-box entries. Spreadsheet rows may carry additional sheet-scoped fields such as `excel_range` and `sheet_name`; forward-compatible extra properties are accepted.
+ */
+export interface BoundingBoxItem {
+    /** Stable bounding-box identifier (e.g. `txt-1`, `excel_title_0`). Used by extensions like `footnoteReferences` to cross-reference paragraphs. */
+    id?: string;
+    /** Plain-text content of the region. */
+    content?: string;
+    /** 1-indexed page number. For spreadsheets this matches the parsed sheet index after hidden-sheet filtering. */
+    page_number?: number;
+    /** Document coordinate polygon when available. Spreadsheet visuals may use an empty array and `excel_range` instead. */
+    bounding_box?: number[];
+    /** Spreadsheet-only anchor or covered cell range. */
+    excel_range?: string;
+    /** Spreadsheet-only sheet name. */
+    sheet_name?: string;
+    /** Spreadsheet-only parsed sheet index after hidden-sheet filtering. */
+    sheet_index?: number;
+    /** Spreadsheet-only original workbook sheet index. */
+    workbook_sheet_index?: number;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/BoundingBoxItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/BoundingBoxTable.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Detected table region returned under `bounding_boxes.Tables`. Carries a structured `table_info` block plus optional `cell_data`. Kept loose with `additionalProperties: true` to round-trip future fields the server may add (e.g. layout metadata).
+ */
+export interface BoundingBoxTable {
+    table_info?: BoundingBoxTable.TableInfo;
+    /** Table cell payload when available. Shape varies by extraction path; SDK consumers should treat as opaque. */
+    cell_data?: Record<string, unknown>[];
+    /** Accepts any additional properties */
+    [key: string]: any;
+}
+export declare namespace BoundingBoxTable {
+    interface TableInfo {
+        id?: string;
+        dimensions?: number[];
+        excel_range?: string;
+        sheet_name?: string;
+        sheet_index?: number;
+        workbook_sheet_index?: number;
+        section_index?: number;
+        section_type?: string;
+        section_name?: string;
+        table_name?: string;
+        layout_type?: string;
+        is_chart?: boolean;
+        chart_type?: string;
+        chart_title?: string;
+        source_ranges?: string[];
+        location?: Record<string, unknown>;
+        /** Accepts any additional properties */
+        [key: string]: any;
+    }
+}

package/dist/cjs/api/types/BoundingBoxTable.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/BoundingBoxes.d.ts

@@ -0,0 +1,20 @@
+import type * as Pulse from "../index.js";
+/**
+ * Positional bounding-box data for text, titles, headers, footers, images, and tables. Used by the frontend for annotation overlays and by SDK consumers to access detected visuals (charts and images) returned under `Images`. Keys not listed here are accepted for forward compatibility (e.g. `markdown_with_ids`, `defined_names`).
+ */
+export interface BoundingBoxes {
+    /** Detected or embedded visuals. `image_url` is populated when `figure_processing.show_images` was enabled and the entry's `visual_type` matched the requested target. */
+    Images?: Pulse.BoundingBoxImage[];
+    /** Detected tables. Each entry carries a `table_info` block plus optional `cell_data`. */
+    Tables?: Pulse.BoundingBoxTable[];
+    /** Body-text paragraphs and detected text regions. For spreadsheets, includes free-form text outside table regions (titles, captions, instructions). */
+    Text?: Pulse.BoundingBoxItem[];
+    /** Detected title regions. Spreadsheets emit one `Sheet: <name>` title per processed sheet. */
+    Title?: Pulse.BoundingBoxItem[];
+    /** Detected footer regions (e.g. spreadsheet "Totals" rows, PDF page footers). */
+    Footer?: Pulse.BoundingBoxItem[];
+    /** Markdown variant with stable `data-bb-*-id` attributes in figure / table / text tags. Lets clients join rendered HTML back to bounding-box entries by id. */
+    markdown_with_ids?: string;
+    /** Accepts any additional properties */
+    [key: string]: any;
+}

package/dist/cjs/api/types/BoundingBoxes.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ExtractInput.d.ts

@@ -12,11 +12,11 @@ export interface ExtractInput {
     extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
-    /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
+    /** Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response. */
     figureProcessing?: ExtractInput.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractInput.Extensions;
-    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
+    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names. */
     spreadsheet?: ExtractInput.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractInput.Storage;
@@ -53,12 +53,12 @@ export declare namespace ExtractInput {
     };
     type Model = (typeof Model)[keyof typeof Model];
     /**
-     * Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response.
+     * Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response.
      */
     interface FigureProcessing {
-        /** Generate descriptive captions for extracted figures. */
+        /** Generate descriptive captions for extracted visuals. When `true`, applies to both detected charts and non-chart images. Captions appear under `bounding_boxes.Images[].description` and inline in the markdown output where applicable. */
         description?: boolean;
-        /** Embed base64-encoded images inline in figure tags in the output. Increases response size. */
+        /** Return image URLs for extracted visuals. When `true`, applies to both charts and non-chart images. URLs are emitted under `bounding_boxes.Images[].image_url` — typically a Pulse-hosted proxy URL served from `GET /results/{jobId}/images/{filename}`. Spreadsheet charts and embedded images are read directly from the workbook; PDF/image inputs use detected figure regions. */
         showImages?: boolean;
     }
     /**
@@ -107,7 +107,7 @@ export declare namespace ExtractInput {
         }
     }
     /**
-     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
+     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names.
      */
     interface Spreadsheet {
         /** Include rows that are hidden in the Excel workbook. */

package/dist/cjs/api/types/ExtractLargeResultResponse.d.ts

@@ -1,3 +1,4 @@
+import type * as Pulse from "../index.js";
 /**
  * Returned instead of the full extraction result when the document has 70 or more pages.  The `url` field is a single-use download link; fetch it once to retrieve the complete `ExtractResultCore` payload. Subsequent requests to the same URL return 410 Gone.
  */
@@ -10,16 +11,6 @@ export interface ExtractLargeResultResponse {
     extraction_id?: string;
     /** Number of pages in the document. */
     page_count?: number;
-    /** Billing tier and usage information. */
-    plan_info?: ExtractLargeResultResponse.PlanInfo;
-}
-export declare namespace ExtractLargeResultResponse {
-    /**
-     * Billing tier and usage information.
-     */
-    interface PlanInfo {
-        tier?: string;
-        pages_used?: number;
-        note?: string;
-    }
+    /** Billing tier and cumulative usage information. Includes `total_credits_used` (primary billing metric) and `pages_used` (legacy compatibility). */
+    plan_info?: Pulse.PlanInfo;
 }

package/dist/cjs/api/types/ExtractOptions.d.ts

@@ -8,11 +8,11 @@ export interface ExtractOptions {
     extractionConfigId?: string;
     /** Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`. */
     pages?: string;
-    /** Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response. */
+    /** Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response. */
     figureProcessing?: ExtractOptions.FigureProcessing;
     /** Settings that enable additional processing passes or alternate output formats. Each enabled extension produces a corresponding output field under `response.extensions.*`. */
     extensions?: ExtractOptions.Extensions;
-    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names. */
+    /** Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names. */
     spreadsheet?: ExtractOptions.Spreadsheet;
     /** Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created. */
     storage?: ExtractOptions.Storage;
@@ -49,12 +49,12 @@ export declare namespace ExtractOptions {
     };
     type Model = (typeof Model)[keyof typeof Model];
     /**
-     * Settings that control how figures in the document are processed. These affect the markdown output directly (e.g. figure descriptions, chart-to-table conversion, image embedding) and do not produce additional output fields in the response.
+     * Settings that control how figures and embedded visuals are processed. Applies to both PDFs/images (where figures are detected from layout) and spreadsheets (where charts and embedded images are read directly from the workbook). These options affect the markdown output and the `bounding_boxes.Images[]` array; they do not produce additional output fields elsewhere in the response.
      */
     interface FigureProcessing {
-        /** Generate descriptive captions for extracted figures. */
+        /** Generate descriptive captions for extracted visuals. When `true`, applies to both detected charts and non-chart images. Captions appear under `bounding_boxes.Images[].description` and inline in the markdown output where applicable. */
         description?: boolean;
-        /** Embed base64-encoded images inline in figure tags in the output. Increases response size. */
+        /** Return image URLs for extracted visuals. When `true`, applies to both charts and non-chart images. URLs are emitted under `bounding_boxes.Images[].image_url` — typically a Pulse-hosted proxy URL served from `GET /results/{jobId}/images/{filename}`. Spreadsheet charts and embedded images are read directly from the workbook; PDF/image inputs use detected figure regions. */
         showImages?: boolean;
     }
     /**
@@ -103,7 +103,7 @@ export declare namespace ExtractOptions {
         }
     }
     /**
-     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Only applies to `.xlsx` and `.xls` files. Accepts both camelCase and snake_case field names.
+     * Settings for Excel/spreadsheet extraction. Controls handling of hidden rows, columns, and sheets. Applies to `.xlsx`, `.xlsm`, and `.xls` files. Accepts both camelCase and snake_case field names.
      */
     interface Spreadsheet {
         /** Include rows that are hidden in the Excel workbook. */

package/dist/cjs/api/types/ExtractResponse.d.ts

@@ -7,16 +7,16 @@ export interface ExtractResponse {
     markdown?: string;
     /** Output from enabled extensions. Each key corresponds to an extension that was enabled in the request under `extensions.*`. Only keys for enabled extensions are present. */
     extensions?: ExtractResponse.Extensions;
-    /** Positional bounding-box data for text, titles, headers, footers, images, and tables. Used by the frontend for annotation overlays. */
-    bounding_boxes?: Record<string, unknown>;
+    /** Positional bounding-box data for text, titles, headers, footers, images, and tables. `Images` carries chart/image visuals (with `image_url` when `figure_processing.show_images` is enabled), `Tables` the detected tables, and `Text`/`Title`/`Footer` the paragraph/title/footer regions. Additional keys (e.g. `markdown_with_ids`, `defined_names`) round-trip without being typed. */
+    bounding_boxes?: Pulse.BoundingBoxes;
     /** Persisted extraction ID. Present when storage is enabled (default). Use this ID with `/split` and `/schema` endpoints. */
     extraction_id?: string;
     /** URL to view the extraction on the Pulse platform. Present when storage is enabled. */
     extraction_url?: string;
     /** Number of pages processed. */
     page_count?: number;
-    /** Billing tier and usage information. */
-    plan_info?: ExtractResponse.PlanInfo;
+    /** Billing tier and cumulative usage information. Includes `total_credits_used` (primary billing metric) and `pages_used` (legacy compatibility). */
+    plan_info?: Pulse.PlanInfo;
     /** Non-fatal warnings generated during extraction. Includes deprecation notices when legacy input parameters are used, as well as processing warnings (e.g. word-level bounding box limitations). */
     warnings?: string[];
     /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
@@ -117,17 +117,6 @@ export declare namespace ExtractResponse {
             }
         }
     }
-    /**
-     * Billing tier and usage information.
-     */
-    interface PlanInfo {
-        /** Current plan tier name. */
-        tier?: string;
-        /** Cumulative pages used after this extraction. */
-        pages_used?: number;
-        /** Human-readable plan note. */
-        note?: string;
-    }
     /**
      * **Deprecated** — Use `extensions.chunking` instead. Document content split into chunks. Present when the legacy `chunking` input was used.
      */

package/dist/cjs/api/types/ExtractResultCore.d.ts

@@ -1,3 +1,4 @@
+import type * as Pulse from "../index.js";
 /**
  * Core extraction result fields shared by the synchronous `/extract` endpoint and the pipeline extract step.
  */
@@ -6,16 +7,16 @@ export interface ExtractResultCore {
     markdown?: string;
     /** Output from enabled extensions. Each key corresponds to an extension that was enabled in the request under `extensions.*`. Only keys for enabled extensions are present. */
     extensions?: ExtractResultCore.Extensions;
-    /** Positional bounding-box data for text, titles, headers, footers, images, and tables. Used by the frontend for annotation overlays. */
-    bounding_boxes?: Record<string, unknown>;
+    /** Positional bounding-box data for text, titles, headers, footers, images, and tables. `Images` carries chart/image visuals (with `image_url` when `figure_processing.show_images` is enabled), `Tables` the detected tables, and `Text`/`Title`/`Footer` the paragraph/title/footer regions. Additional keys (e.g. `markdown_with_ids`, `defined_names`) round-trip without being typed. */
+    bounding_boxes?: Pulse.BoundingBoxes;
     /** Persisted extraction ID. Present when storage is enabled (default). Use this ID with `/split` and `/schema` endpoints. */
     extraction_id?: string;
     /** URL to view the extraction on the Pulse platform. Present when storage is enabled. */
     extraction_url?: string;
     /** Number of pages processed. */
     page_count?: number;
-    /** Billing tier and usage information. */
-    plan_info?: ExtractResultCore.PlanInfo;
+    /** Billing tier and cumulative usage information. Includes `total_credits_used` (primary billing metric) and `pages_used` (legacy compatibility). */
+    plan_info?: Pulse.PlanInfo;
     /** Non-fatal warnings generated during extraction. Includes deprecation notices when legacy input parameters are used, as well as processing warnings (e.g. word-level bounding box limitations). */
     warnings?: string[];
     /** Number of credits consumed by this request. Only present when the organization has the credit billing system enabled. */
@@ -98,15 +99,4 @@ export declare namespace ExtractResultCore {
             }
         }
     }
-    /**
-     * Billing tier and usage information.
-     */
-    interface PlanInfo {
-        /** Current plan tier name. */
-        tier?: string;
-        /** Cumulative pages used after this extraction. */
-        pages_used?: number;
-        /** Human-readable plan note. */
-        note?: string;
-    }
 }

package/dist/cjs/api/types/FormPlanInfo.d.ts

@@ -1,11 +1,5 @@
+import type * as Pulse from "../index.js";
 /**
- * Cumulative billing snapshot for the calling organization. Sourced from the `pulse-org-stats` aggregate table maintained asynchronously by the org-stats Lambda; the in-flight request's contribution is added on top so every response reflects post-request state.
+ * **Deprecated** — Use `PlanInfo` instead. Retained as an alias so existing SDK type imports continue to compile.
  */
-export interface FormPlanInfo {
-    /** Billing tier, e.g. `"trial"`, `"pulse_ultra_2"`. */
-    tier?: string;
-    /** Total credits consumed by the organization to date, including this request. The primary billing metric going forward. */
-    total_credits_used?: number;
-    /** Total pages processed by the organization to date, including this request. Kept for backward compatibility with clients that haven't migrated to `total_credits_used`. */
-    pages_used?: number;
-}
+export type FormPlanInfo = Pulse.PlanInfo;

package/dist/cjs/api/types/FormResult.d.ts

@@ -20,5 +20,6 @@ export interface FormResult {
     fields_cleared?: number;
     /** Number of credits consumed by **this request**. Detect charges 1 credit per page; fill and clear charge 3 credits per page. */
     credits_used?: number;
-    plan_info?: Pulse.FormPlanInfo;
+    /** Billing tier and cumulative usage information for the calling org, including this form run. */
+    plan_info?: Pulse.PlanInfo;
 }