pdfdancer-client-typescript 1.0.4 → 1.0.6

package/dist/pdfdancer_v1.d.ts

@@ -0,0 +1,202 @@
+/**
+ * PDFDancer TypeScript Client V1
+ *
+ * A TypeScript client that provides session-based PDF manipulation operations with strict validation.
+ */
+import { Font, ObjectType, Position } from './models';
+import { ParagraphBuilder } from './paragraph-builder';
+import { FormFieldObject, FormXObject, ImageObject, ParagraphObject, PathObject, TextLineObject } from "./types";
+import { ImageBuilder } from "./image-builder";
+declare class PageClient {
+    private _pageIndex;
+    private _client;
+    type: ObjectType;
+    position: Position;
+    internalId: string;
+    private _internals;
+    constructor(client: PDFDancer, pageIndex: number);
+    selectPathsAt(x: number, y: number): Promise<PathObject[]>;
+    selectImages(): Promise<ImageObject[]>;
+    selectImagesAt(x: number, y: number): Promise<ImageObject[]>;
+    delete(): Promise<boolean>;
+    private ref;
+    selectForms(): Promise<FormXObject[]>;
+    selectFormsAt(x: number, y: number): Promise<FormXObject[]>;
+    selectFormFields(): Promise<FormFieldObject[]>;
+    selectFormFieldsAt(x: number, y: number): Promise<FormFieldObject[]>;
+    selectFormFieldsByName(fieldName: string): Promise<FormFieldObject[]>;
+    selectParagraphs(): Promise<ParagraphObject[]>;
+    selectParagraphsStartingWith(text: string): Promise<ParagraphObject[]>;
+    selectParagraphsMatching(pattern: string): Promise<ParagraphObject[]>;
+    selectParagraphsAt(x: number, y: number): Promise<ParagraphObject[]>;
+    selectTextLinesStartingWith(text: string): Promise<TextLineObject[]>;
+    /**
+     * Creates a new ParagraphBuilder for fluent paragraph construction.
+     */
+    newParagraph(): ParagraphBuilder;
+    selectTextLines(): Promise<TextLineObject[]>;
+    selectTextLinesMatching(pattern: string): Promise<TextLineObject[]>;
+    selectTextLinesAt(x: number, y: number): Promise<TextLineObject[]>;
+}
+/**
+ * REST API client for interacting with the PDFDancer PDF manipulation service.
+ * This client provides a convenient TypeScript interface for performing PDF operations
+ * including session management, object searching, manipulation, and retrieval.
+ * Handles authentication, session lifecycle, and HTTP communication transparently.
+ *
+ */
+export declare class PDFDancer {
+    private _token;
+    private _baseUrl;
+    private _readTimeout;
+    private _pdfBytes;
+    private _sessionId;
+    /**
+     * Creates a new client with PDF data.
+     * This constructor initializes the client, uploads the PDF data to open
+     * a new session, and prepares the client for PDF manipulation operations.
+     */
+    private constructor();
+    /**
+     * Initialize the client by creating a session.
+     * Must be called after constructor before using the client.
+     */
+    private init;
+    static open(pdfData: Uint8Array, token?: string, baseUrl?: string, timeout?: number): Promise<PDFDancer>;
+    /**
+     * Process PDF data from various input types with strict validation.
+     */
+    private _processPdfData;
+    /**
+     * Extract meaningful error messages from API response.
+     * Parses JSON error responses with _embedded.errors structure.
+     */
+    private _extractErrorMessage;
+    /**
+     * Creates a new PDF processing session by uploading the PDF data.
+     */
+    private _createSession;
+    /**
+     * Make HTTP request with session headers and error handling.
+     */
+    private _makeRequest;
+    /**
+     * Searches for PDF objects matching the specified criteria.
+     * This method provides flexible search capabilities across all PDF content,
+     * allowing filtering by object type and position constraints.
+     */
+    private find;
+    /**
+     * Searches for paragraph objects at the specified position.
+     */
+    private findParagraphs;
+    /**
+     * Searches for image objects at the specified position.
+     */
+    private _findImages;
+    selectImages(): Promise<ImageObject[]>;
+    /**
+     * Searches for form X objects at the specified position.
+     */
+    private findFormXObjects;
+    /**
+     * Searches for vector path objects at the specified position.
+     */
+    private findPaths;
+    selectPaths(): Promise<PathObject[]>;
+    selectForms(): Promise<FormXObject[]>;
+    selectFormFields(): Promise<FormFieldObject[]>;
+    selectFieldsByName(fieldName: string): Promise<FormFieldObject[]>;
+    /**
+     * Searches for text line objects at the specified position.
+     */
+    private findTextLines;
+    /**
+     * Searches for form fields at the specified position.
+     * Returns FormFieldRef objects with name and value properties.
+     */
+    private findFormFields;
+    /**
+     * Retrieves references to all pages in the PDF document.
+     */
+    private getPages;
+    /**
+     * Retrieves a reference to a specific page by its page index.
+     */
+    private _getPage;
+    /**
+     * Deletes a page from the PDF document.
+     */
+    private deletePage;
+    /**
+     * Deletes the specified PDF object from the document.
+     */
+    private delete;
+    /**
+     * Moves a PDF object to a new position within the document.
+     */
+    private move;
+    /**
+     * Changes the value of a form field.
+     */
+    private changeFormField;
+    /**
+     * Adds an image to the PDF document.
+     */
+    private addImage;
+    /**
+     * Adds a paragraph to the PDF document.
+     */
+    private addParagraph;
+    /**
+     * Internal method to add any PDF object.
+     */
+    private _addObject;
+    /**
+     * Modifies a paragraph object or its text content.
+     */
+    private modifyParagraph;
+    /**
+     * Modifies a text line object.
+     */
+    private modifyTextLine;
+    /**
+     * Finds available fonts matching the specified name and size.
+     */
+    findFonts(fontName: string, fontSize: number): Promise<Font[]>;
+    /**
+     * Registers a custom font for use in PDF operations.
+     */
+    registerFont(ttfFile: Uint8Array | File): Promise<string>;
+    /**
+     * Downloads the current state of the PDF document with all modifications applied.
+     */
+    getPdfFile(): Promise<Uint8Array>;
+    /**
+     * Saves the current PDF to a file (browser environment).
+     * Downloads the PDF in the browser.
+     */
+    save(filename: string): Promise<void>;
+    /**
+     * Parse JSON object data into ObjectRef instance.
+     */
+    private _parseObjectRef;
+    private _parseFormFieldRef;
+    /**
+     * Parse JSON position data into Position instance.
+     */
+    private _parsePosition;
+    private toPathObjects;
+    private toFormXObjects;
+    private toImageObjects;
+    newImage(): ImageBuilder;
+    page(pageIndex: number): PageClient;
+    pages(): Promise<PageClient[]>;
+    private toFormFields;
+    selectParagraphs(): Promise<ParagraphObject[]>;
+    private toParagraphObjects;
+    private toTextLineObjects;
+    selectLines(): Promise<TextLineObject[]>;
+}
+export {};
+//# sourceMappingURL=pdfdancer_v1.d.ts.map

package/dist/pdfdancer_v1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdfdancer_v1.d.ts","sourceRoot":"","sources":["../src/pdfdancer_v1.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH,OAAO,EAMH,IAAI,EAOJ,UAAU,EAEV,QAAQ,EAGX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,UAAU,EAAE,cAAc,EAAC,MAAM,SAAS,CAAC;AAC/G,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAiC7C,cAAM,UAAU;IAEZ,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAY;IAC3B,IAAI,EAAE,UAAU,CAAmB;IACnC,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,UAAU,CAAqB;gBAE3B,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM;IAS1C,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAIlC,YAAY;IAIZ,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAInC,MAAM;IAIZ,OAAO,CAAC,GAAG;IAKL,WAAW;IAIX,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAIlC,gBAAgB;IAIhB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAKvC,sBAAsB,CAAC,SAAS,EAAE,MAAM;IAMxC,gBAAgB;IAIhB,4BAA4B,CAAC,IAAI,EAAE,MAAM;IAMzC,wBAAwB,CAAC,OAAO,EAAE,MAAM;IAMxC,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAIvC,2BAA2B,CAAC,IAAI,EAAE,MAAM;IAM9C;;OAEG;IACH,YAAY,IAAI,gBAAgB;IAI1B,eAAe;IAKf,uBAAuB,CAAC,OAAO,EAAE,MAAM;IAOvC,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;CAG/C;AAGD;;;;;;GAMG;AACH,qBAAa,SAAS;IAClB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,UAAU,CAAU;IAE5B;;;;OAIG;IACH,OAAO;IAkBP;;;OAGG;YACW,IAAI;WAKL,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAgB9G;;OAEG;IACH,OAAO,CAAC,eAAe;IA+BvB;;;OAGG;YACW,oBAAoB;IAuClC;;OAEG;YACW,cAAc;IA0C5B;;OAEG;YACW,YAAY;IA2D1B;;;;OAIG;YACW,IAAI;IAQlB;;OAEG;YACW,cAAc;IAI5B;;OAEG;YACW,WAAW;IAInB,YAAY,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAI5C;;OAEG;YACW,gBAAgB;IAI9B;;OAEG;YACW,SAAS;IAIjB,WAAW;IAIX,WAAW;IAIX,gBAAgB;IAIhB,kBAAkB,CAAC,SAAS,EAAE,MAAM;IAI1C;;OAEG;YACW,aAAa;IAI3B;;;OAGG;YACW,cAAc;IAU5B;;OAEG;YACW,QAAQ;IAMtB;;OAEG;YACW,QAAQ;IAgBtB;;OAEG;YACW,UAAU;IAYxB;;OAEG;YACW,MAAM;IAUpB;;OAEG;YACW,IAAI;IAalB;;OAEG;YACW,eAAe;IAY7B;;OAEG;YACW,QAAQ;IAgBtB;;OAEG;YACW,YAAY;IAiB1B;;OAEG;YACW,UAAU;IAQxB;;OAEG;YACW,eAAe;IAqB7B;;OAEG;YACW,cAAc;IAe5B;;OAEG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAepE;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;IAyD/D;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC;IAKvC;;;OAGG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB3C;;OAEG;IACH,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,kBAAkB;IAe1B;;OAEG;IACH,OAAO,CAAC,cAAc;IA4BtB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,cAAc;IAItB,QAAQ;IAIR,IAAI,CAAC,SAAS,EAAE,MAAM;IAOhB,KAAK;IAKX,OAAO,CAAC,YAAY;IAId,gBAAgB;IAItB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,iBAAiB;IAInB,WAAW;CAGpB"}