@poe-platform/safe-bash 0.1.817 → 0.1.818

package/dist/pdf-ast/render/postscript.d.ts

@@ -0,0 +1,6 @@
+import type { PdfRawTextIndex } from '../extract/raw-text-index.js';
+/** Preserve the existing text-only Cairo PostScript representation. The caller
+ * owns the index and document header/trailer; no line string is collected. */
+export declare function encodePostscriptPageChunks(index: Pick<PdfRawTextIndex, 'blocks'>, pageNumber: number, options?: {
+    readonly signal?: AbortSignal;
+}): AsyncGenerator<Uint8Array, void, void>;

package/dist/pdf-ast/render/raster.d.ts

@@ -1,5 +1,9 @@
+import type { PdfRetainedPage } from "../retained-document.js";
+import { type PdfRetainedPixelOptions } from "./retained-page-pixels.js";
+import type { PdfIndexStorage } from "../cos/object-index.js";
+import type { PdfRetainedPngOptions } from "./retained-png.js";
 import { type ParsedCosDocument } from "../cos/parser.js";
-import type { PdfDisplayList, PdfPaintOperation, PdfRgbColor } from "../ast.js";
+import type { PdfDisplayList, PdfPaintOperation, PdfRgbColor, PdfSoftMask } from "../ast.js";
 export interface RgbaBitmap {
     readonly width: number;
     readonly height: number;
@@ -84,3 +88,19 @@ export interface PdfSvgPathPaintOptions {
 export declare function encodeSvgPathPaintChunks(original: Extract<PdfPaintOperation, {
     kind: "path" | "glyph";
 }>, pageHeight: number, options?: PdfSvgPathPaintOptions): AsyncGenerator<Uint8Array, void, void>;
+export interface PdfSvgSoftMaskOptions extends Omit<PdfRetainedPngOptions, "alpha"> {
+    readonly scale?: number;
+    readonly tileSize?: number;
+    /** Tile and range-driver scratch; nested compositor surfaces have separate ownership. */
+    readonly maxPixelWorkingBytes?: number;
+}
+/** Encode an SVG mask image without a page-sized resident surface. Retain mask
+ * operations in caller backing, rasterize bounded windows, and translate linear
+ * PNG reads to the staged tile layout. The caller owns input operation storage. */
+export declare function encodeSvgSoftMaskChunks(mask: PdfSoftMask, page: Pick<PdfDisplayList, "width" | "height" | "origin">, storage: PdfIndexStorage, options?: PdfSvgSoftMaskOptions): AsyncGenerator<Uint8Array, void, void>;
+export interface PdfRetainedSvgOptions extends Omit<PdfRetainedPixelOptions, "imageStorage" | "pathStorage">, Omit<PdfSvgPathPaintOptions, "scale"> {
+    readonly maxOperations?: number;
+}
+/** Full retained SVG composition. Geometry, clips, group captures, masks and
+ * image pixels remain caller-backed; only the current paint is resident. */
+export declare function renderRetainedPageToSvg(page: PdfRetainedPage, storage: PdfIndexStorage, options?: PdfRetainedSvgOptions): AsyncGenerator<Uint8Array, void, void>;

package/dist/pdf-ast/retained-document.d.ts

@@ -1,80 +1,21 @@
+import type { PdfMutableObjectStore } from "./cos/mutable-object-store.js";
+import type { PdfIndexStorage } from "./cos/object-index.js";
+import { type PdfRetainedAttachment } from "./extract/retained-attachments.js";
+import { type PdfFontSelection, type PdfRetainedFont } from "./extract/retained-fonts.js";
 import { type PdfRetainedFormFieldDetails } from "./extract/retained-form-field-details.js";
-import type { ValueArrayStorage } from "./cos/value-parser.js";
-import { type PdfRetainedPageLabel } from "./extract/retained-page-labels.js";
 import { type PdfRetainedFormField } from "./extract/retained-form-fields.js";
-import { type OpenStoredPdfOptions } from "./cos/stored-object-reader.js";
-import type { PdfMutableObjectStore } from "./cos/mutable-object-store.js";
-import { PdfRawTextIndex, type PdfRawTextIndexOptions } from "./extract/raw-text-index.js";
-import { type PdfRawTextOptions } from "./extract/raw-text-stream.js";
-import { type PdfRetainedPageEvaluationOptions } from "./content/retained-page.js";
-import { type PdfRetainedStructureItem, type PdfStructureSelection } from "./extract/retained-structure.js";
-import { type PdfRetainedDestination, type PdfRetainedUrl, type PdfUrlSelection } from "./extract/retained-links.js";
+import { type PdfImageSelection, type PdfRetainedImage } from "./extract/retained-images.js";
 import { type PdfRetainedJavaScript } from "./extract/retained-javascript.js";
-import { type PdfRetainedImage, type PdfImageSelection } from "./extract/retained-images.js";
-import { type PdfRetainedFont, type PdfFontSelection } from "./extract/retained-fonts.js";
-import { type PdfRetainedAttachment } from "./extract/retained-attachments.js";
-import { type ByteSpan, type PdfCosDict, type PdfCosNode, type PdfCosRef, type PdfRect, type PdfStoredItems } from "./ast.js";
-import { type OpenPdfObjectReaderOptions, type PdfOpenedObjectReader } from "./cos/object-reader.js";
-import type { PdfIndexStorage } from "./cos/object-index.js";
+import { type PdfRetainedDestination, type PdfRetainedUrl, type PdfUrlSelection } from "./extract/retained-links.js";
+import { type PdfRetainedPageLabel } from "./extract/retained-page-labels.js";
+import { type PdfRetainedStructureItem, type PdfStructureSelection } from "./extract/retained-structure.js";
+import { PdfRetainedReader, type PdfRetainedDocumentOptions, type PdfStoredDocumentOptions } from "./retained-reader.js";
 import type { PdfFileSource } from "./source.js";
-export interface PdfRetainedDocumentOptions extends OpenPdfObjectReaderOptions {
-    readonly maxPages?: number;
-    readonly maxPageTreeDepth?: number;
-    /** Aggregate live visited-index staging for each page walk. */
-    readonly maxTraversalStagingBytes?: number;
-}
-export type PdfStoredDocumentOptions = PdfRetainedDocumentOptions & OpenStoredPdfOptions & {
-    /** Replay caller-backed logical pages when edits change the catalog tree. */
-    readonly pageReferences?: () => Iterable<PdfCosRef> | AsyncIterable<PdfCosRef>;
-};
-export interface PdfRetainedValue {
-    readonly value: PdfCosNode;
-    readonly reference?: PdfCosRef;
-    /** Encoded stream span in its reader's backing; stored spans are payload-relative. */
-    readonly stream?: ByteSpan;
-}
-export interface PdfRetainedPageAttributes {
-    readonly mediaBox: PdfRect;
-    readonly cropBox: PdfRect;
-    readonly bleedBox: PdfRect;
-    readonly trimBox: PdfRect;
-    readonly artBox: PdfRect;
-    readonly rotation: 0 | 90 | 180 | 270;
-    readonly resources: PdfCosDict;
-}
-/** Read-oriented retained document owner. Pages and payloads are visited on
- * demand; only a bounded traversal path and external duplicate indexes persist.
- * The caller owns source and values/pages it elects to retain. */
-export declare class PdfRetainedDocument {
-    private readonly opened;
-    private readonly storage;
-    private readonly options;
-    private readonly controller;
-    private readonly pageReferences?;
-    readonly objects: PdfOpenedObjectReader["reader"];
-    readonly crossReference: PdfOpenedObjectReader["crossReference"];
-    readonly encryption: PdfOpenedObjectReader["encryption"];
-    readonly depthLimit: number;
-    private readonly walks;
-    private closing;
-    private constructor();
+export { PdfRetainedPage, PdfRetainedReader, type PdfRetainedDocumentOptions, type PdfRetainedPageAttributes, type PdfRetainedValue, type PdfStoredDocumentOptions } from "./retained-reader.js";
+/** Retained document reader with document-wide extraction conveniences. */
+export declare class PdfRetainedDocument extends PdfRetainedReader {
     static open(source: PdfFileSource, storage: PdfIndexStorage, options?: PdfRetainedDocumentOptions): Promise<PdfRetainedDocument>;
-    /** Read an editable caller-backed graph without normalizing it through a PDF
-     * save. The caller retains ownership of the store and its object identities. */
     static openStore(store: PdfMutableObjectStore, storage: PdfIndexStorage, options: PdfStoredDocumentOptions): Promise<PdfRetainedDocument>;
-    private assertOpen;
-    /** Resolve a bounded reference chain, retaining the final stream's identity. */
-    lookup(node: PdfCosNode | undefined, arrays?: ValueArrayStorage, arrayPathPrefix?: readonly string[], storeRootDictionary?: boolean, rootArrayStorage?: ValueArrayStorage["arrayStorage"]): Promise<PdfRetainedValue | undefined>;
-    /** Visit page dictionaries in inheritance order using caller-backed cycle state. */
-    pageAncestors(first: PdfCosDict): AsyncGenerator<PdfCosDict, void, void>;
-    /** Read one caller-backed array record with document cancellation and ownership. */
-    readArrayItem(items: PdfStoredItems, position: number): Promise<import("./ast.js").PdfCosArray>;
-    info(): Promise<Readonly<Record<string, string>>>;
-    /** Resolve the one-based numbering used by annotation destinations. */
-    annotationPageNumber(reference: PdfCosRef): Promise<number | undefined>;
-    /** Resolve a named annotation destination with caller-backed path state. */
-    annotationNamedDestination(node: PdfCosNode | undefined, name: string): Promise<PdfCosNode | undefined>;
-    pages(): AsyncGenerator<PdfRetainedPage, void, void>;
     structure(selection?: PdfStructureSelection): AsyncGenerator<PdfRetainedStructureItem, void, void>;
     destinations(): AsyncGenerator<PdfRetainedDestination, void, void>;
     urls(selection?: PdfUrlSelection): AsyncGenerator<PdfRetainedUrl, void, void>;
@@ -83,7 +24,10 @@ export declare class PdfRetainedDocument {
         title: string;
         pageIndex: number;
     }, void, void>;
-    outlineDetails(): AsyncGenerator<{
+    outlineDetails(options?: {
+        readonly includeUntitled?: boolean;
+        readonly includeNameTitles?: boolean;
+    }): AsyncGenerator<{
         title: string;
         pageIndex: number;
         level: number;
@@ -94,27 +38,4 @@ export declare class PdfRetainedDocument {
     attachments(): AsyncGenerator<PdfRetainedAttachment, void, void>;
     fonts(selection?: PdfFontSelection): AsyncGenerator<PdfRetainedFont, void, void>;
     images(selection?: PdfImageSelection): AsyncGenerator<PdfRetainedImage, void, void>;
-    close(): Promise<void>;
-}
-export declare class PdfRetainedPage {
-    private readonly document;
-    readonly index: number;
-    readonly dict: PdfCosDict;
-    readonly reference?: PdfCosRef | undefined;
-    constructor(document: PdfRetainedDocument, index: number, dict: PdfCosDict, reference?: PdfCosRef | undefined);
-    attributes(): Promise<PdfRetainedPageAttributes>;
-    /** Pull complete page paint operations, including annotation appearances and
-     * widget fallback text. The caller owns results it retains. */
-    evaluateSteps(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions): AsyncGenerator<import("./index.js").PdfEvaluationOperation, void, void>;
-    /** Stream UTF-8 raw-mode page text; share staging with content and resource
-     * evaluation so a staged line cannot exceed the enclosing scratch allowance. */
-    streamRawText(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions & PdfRawTextOptions): AsyncGenerator<Uint8Array, void, void>;
-    /** Index raw-order text geometry and strings on caller storage. The caller
-     * closes the returned index after consuming its block/line/word iterators. */
-    indexRawText(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions & PdfRawTextIndexOptions): Promise<PdfRawTextIndex>;
-    /** Pull one annotation at a time. Destination page lookup uses the document's
-     * caller-backed traversal index, without retaining a document-wide page map. */
-    annotations(): AsyncGenerator<import("./ast.js").PdfLinkAnnotation, void, void>;
-    /** Preserve the buffered page API's newline after each content-array stream. */
-    streamContents(): AsyncGenerator<Uint8Array, void, void>;
 }

package/dist/pdf-ast/retained-reader.d.ts

@@ -0,0 +1,109 @@
+import type { ExtractTextOptions } from "./extract/text.js";
+import { type ByteSpan, type PdfCosDict, type PdfCosNode, type PdfCosRef, type PdfRect, type PdfStoredItems } from "./ast.js";
+import { type PdfRetainedPageEvaluationOptions } from "./content/retained-page.js";
+import type { PdfMutableObjectStore } from "./cos/mutable-object-store.js";
+import type { PdfIndexStorage } from "./cos/object-index.js";
+import { type OpenPdfObjectReaderOptions, type PdfOpenedObjectReader } from "./cos/object-reader.js";
+import { type OpenStoredPdfOptions } from "./cos/stored-object-reader.js";
+import type { ValueArrayStorage } from "./cos/value-parser.js";
+import { type PdfLogicalTextOptions } from "./extract/logical-text-stream.js";
+import { PdfRawTextIndex, type PdfRawTextIndexOptions } from "./extract/raw-text-index.js";
+import { type PdfRawTextOptions } from "./extract/raw-text-stream.js";
+import type { PdfFileSource } from "./source.js";
+export interface PdfRetainedDocumentOptions extends OpenPdfObjectReaderOptions {
+    readonly maxPages?: number;
+    readonly maxPageTreeDepth?: number;
+    /** Aggregate live visited-index staging for each page walk. */
+    readonly maxTraversalStagingBytes?: number;
+}
+export type PdfStoredDocumentOptions = PdfRetainedDocumentOptions & OpenStoredPdfOptions & {
+    /** Replay caller-backed logical pages when edits change the catalog tree. */
+    readonly pageReferences?: () => Iterable<PdfCosRef> | AsyncIterable<PdfCosRef>;
+};
+export interface PdfRetainedValue {
+    readonly value: PdfCosNode;
+    readonly reference?: PdfCosRef;
+    /** Encoded stream span in its reader's backing; stored spans are payload-relative. */
+    readonly stream?: ByteSpan;
+}
+export interface PdfRetainedPageAttributes {
+    readonly mediaBox: PdfRect;
+    readonly cropBox: PdfRect;
+    readonly bleedBox: PdfRect;
+    readonly trimBox: PdfRect;
+    readonly artBox: PdfRect;
+    readonly rotation: 0 | 90 | 180 | 270;
+    readonly resources: PdfCosDict;
+}
+/** Read-oriented retained document owner. Pages and payloads are visited on
+ * demand; only a bounded traversal path and external duplicate indexes persist.
+ * The caller owns source and values/pages it elects to retain. */
+export declare class PdfRetainedReader {
+    readonly objects: PdfOpenedObjectReader["reader"];
+    readonly crossReference: PdfOpenedObjectReader["crossReference"];
+    readonly encryption: PdfOpenedObjectReader["encryption"];
+    readonly depthLimit: number;
+    protected readonly walks: Set<AsyncGenerator<unknown, void, void>>;
+    private closing;
+    private readonly opened;
+    protected readonly storage: PdfIndexStorage;
+    protected readonly options: PdfRetainedDocumentOptions;
+    private readonly controller;
+    private readonly pageReferences;
+    protected constructor(state: PdfRetainedReaderState);
+    static open(source: PdfFileSource, storage: PdfIndexStorage, options?: PdfRetainedDocumentOptions): Promise<PdfRetainedReader>;
+    protected assertOpen(): void;
+    /** Resolve a bounded reference chain, retaining the final stream's identity. */
+    lookup(node: PdfCosNode | undefined, arrays?: ValueArrayStorage, arrayPathPrefix?: readonly string[], storeRootDictionary?: boolean, rootArrayStorage?: ValueArrayStorage["arrayStorage"]): Promise<PdfRetainedValue | undefined>;
+    /** Visit page dictionaries in inheritance order using caller-backed cycle state. */
+    pageAncestors(first: PdfCosDict): AsyncGenerator<PdfCosDict, void, void>;
+    /** Read one caller-backed array record with document cancellation and ownership. */
+    readArrayItem(items: PdfStoredItems, position: number): Promise<import("./ast.js").PdfCosArray>;
+    info(): Promise<Readonly<Record<string, string>>>;
+    /** Resolve the one-based numbering used by annotation destinations. */
+    annotationPageNumber(reference: PdfCosRef): Promise<number | undefined>;
+    /** Resolve a named annotation destination with caller-backed path state. */
+    annotationNamedDestination(node: PdfCosNode | undefined, name: string): Promise<PdfCosNode | undefined>;
+    pages(): AsyncGenerator<PdfRetainedPage, void, void>;
+    close(): Promise<void>;
+}
+export declare class PdfRetainedPage {
+    private readonly document;
+    readonly index: number;
+    readonly dict: PdfCosDict;
+    readonly reference?: PdfCosRef | undefined;
+    constructor(document: PdfRetainedReader, index: number, dict: PdfCosDict, reference?: PdfCosRef | undefined);
+    attributes(): Promise<PdfRetainedPageAttributes>;
+    /** Pull complete page paint operations, including annotation appearances and
+     * widget fallback text. The caller owns results it retains. */
+    evaluateSteps(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions): AsyncGenerator<import("./index.js").PdfEvaluationOperation, void, void>;
+    /** Stream UTF-8 raw-mode page text; share staging with content and resource
+     * evaluation so a staged line cannot exceed the enclosing scratch allowance. */
+    streamRawText(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions & PdfRawTextOptions): AsyncGenerator<Uint8Array, void, void>;
+    /** Stream physical layout in bounded UTF-8 chunks, preserving pitch and rows. */
+    streamLayoutText(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions & PdfRawTextIndexOptions & Pick<ExtractTextOptions, "fixedPitch" | "lineSpacing"> & {
+        readonly crop?: PdfRect;
+    }): AsyncGenerator<Uint8Array, void, void>;
+    /** Stream logical reading order from a caller-backed text index. */
+    streamLogicalText(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions & PdfRawTextIndexOptions & PdfLogicalTextOptions): AsyncGenerator<Uint8Array, void, void>;
+    /** Preserve the original raw-order entry point. */
+    indexRawText(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions & PdfRawTextIndexOptions): Promise<PdfRawTextIndex>;
+    /** Index ordered text geometry and strings on caller storage. The caller
+     * closes the returned index after consuming its block/line/word iterators. */
+    indexText(storage: PdfIndexStorage, options?: PdfRetainedPageEvaluationOptions & PdfRawTextIndexOptions): Promise<PdfRawTextIndex>;
+    /** Pull one annotation at a time. Destination page lookup uses the document's
+     * caller-backed traversal index, without retaining a document-wide page map. */
+    annotations(): AsyncGenerator<import("./ast.js").PdfLinkAnnotation, void, void>;
+    /** Preserve the buffered page API's newline after each content-array stream. */
+    streamContents(): AsyncGenerator<Uint8Array, void, void>;
+}
+interface PdfRetainedReaderState {
+    readonly opened: PdfOpenedObjectReader;
+    readonly storage: PdfIndexStorage;
+    readonly options: PdfRetainedDocumentOptions;
+    readonly controller: AbortController;
+    readonly pageReferences?: PdfStoredDocumentOptions["pageReferences"];
+}
+export declare function openRetainedSource(source: PdfFileSource, storage: PdfIndexStorage, options?: PdfRetainedDocumentOptions): Promise<PdfRetainedReaderState>;
+export declare function openRetainedStore(store: PdfMutableObjectStore, storage: PdfIndexStorage, options: PdfStoredDocumentOptions): Promise<PdfRetainedReaderState>;
+export {};