pdfdancer-client-typescript 1.0.2 → 1.0.4

package/src/models.ts

@@ -1,18 +1,18 @@
 /**
  * Model classes for the PDFDancer TypeScript client.
- * Closely mirrors the Python model classes with TypeScript conventions.
  */
 
-/**
- * Object type enumeration matching the Python ObjectType.
- */
 export enum ObjectType {
     IMAGE = "IMAGE",
     FORM_X_OBJECT = "FORM_X_OBJECT",
     PATH = "PATH",
     PARAGRAPH = "PARAGRAPH",
     TEXT_LINE = "TEXT_LINE",
-    PAGE = "PAGE"
+    PAGE = "PAGE",
+    FORM_FIELD = "FORM_FIELD",
+    TEXT_FIELD = "TEXT_FIELD",
+    CHECK_BOX = "CHECK_BOX",
+    RADIO_BUTTON = "RADIO_BUTTON"
 }
 
 /**
@@ -43,7 +43,6 @@ export interface Point {
 
 /**
  * Represents a bounding rectangle with position and dimensions.
- * Matches the Python BoundingRect class.
  */
 export class BoundingRect {
     constructor(
@@ -80,9 +79,10 @@ class PositioningError extends Error {
 
 /**
  * Represents spatial positioning and location information for PDF objects.
- * Closely mirrors the Python Position class with TypeScript conventions.
  */
 export class Position {
+    public name?: string;
+
     constructor(
         public pageIndex?: number,
         public shape?: ShapeType,
@@ -110,6 +110,15 @@ export class Position {
         return Position.atPage(pageIndex).withTextStarts(text);
     }
 
+    /**
+     * Creates a position specification for finding objects by name.
+     */
+    static byName(name: string): Position {
+        const position = new Position();
+        position.name = name;
+        return position;
+    }
+
     /**
      * Sets the position to a specific point location.
      */
@@ -189,9 +198,11 @@ export class Position {
 
 /**
  * Lightweight reference to a PDF object providing identity and type information.
- * Mirrors the Python ObjectRef class exactly.
  */
 export class ObjectRef {
+    public name?: string;
+    public value?: string | null;
+
     constructor(
         public internalId: string,
         public position: Position,
@@ -224,6 +235,22 @@ export class ObjectRef {
     }
 }
 
+/**
+ * Represents a form field reference with name and value properties.
+ * Extends ObjectRef to include form-specific properties.
+ */
+export class FormFieldRef extends ObjectRef {
+    constructor(
+        internalId: string,
+        position: Position,
+        type: ObjectType,
+        public name?: string,
+        public value?: string | null
+    ) {
+        super(internalId, position, type);
+    }
+}
+
 /**
  * Represents an RGB color with optional alpha channel, values from 0-255.
  */
@@ -234,7 +261,6 @@ export class Color {
         public b: number,
         public a: number = 255 // Alpha channel, default fully opaque
     ) {
-        // Validation similar to Python client
         for (const component of [this.r, this.g, this.b, this.a]) {
             if (component < 0 || component > 255) {
                 throw new Error(`Color component must be between 0 and 255, got ${component}`);
@@ -259,7 +285,6 @@ export class Font {
 
 /**
  * Represents an image object in a PDF document.
- * Matches the Python Image class structure.
  */
 export class Image {
     constructor(
@@ -282,7 +307,6 @@ export class Image {
 
 /**
  * Represents a paragraph of text in a PDF document.
- * Structure mirrors the Python Paragraph class.
  */
 export class Paragraph {
     constructor(
@@ -477,11 +501,31 @@ export class ModifyTextRequest {
     }
 }
 
+export class ChangeFormFieldRequest {
+    constructor(
+        public formFieldRef: FormFieldRef,
+        public newValue: string
+    ) {
+    }
+
+    toDict(): Record<string, any> {
+        return {
+            ref: {
+                internalId: this.formFieldRef.internalId,
+                position: positionToDict(this.formFieldRef.position),
+                type: this.formFieldRef.type
+            },
+            value: this.newValue
+        };
+    }
+}
+
 // Helper function to convert Position to dictionary for JSON serialization
 function positionToDict(position: Position): Record<string, any> {
     const result: Record<string, any> = {
         pageIndex: position.pageIndex,
-        textStartsWith: position.textStartsWith
+        textStartsWith: position.textStartsWith,
+        name: position.name
     };
 
     if (position.shape) {

package/src/paragraph-builder.ts

@@ -1,6 +1,5 @@
 /**
  * ParagraphBuilder for the PDFDancer TypeScript client.
- * Closely mirrors the Python ParagraphBuilder class with TypeScript conventions.
  */
 
 import { ValidationException } from './exceptions';
@@ -9,7 +8,6 @@ import type { ClientV1 } from './client-v1';
 
 /**
  * Builder class for constructing Paragraph objects with fluent interface.
- * Mirrors the Python ParagraphBuilder class exactly.
  */
 export class ParagraphBuilder {
   private _paragraph: Paragraph;
@@ -173,4 +171,4 @@ export class ParagraphBuilder {
 
     return lines;
   }
-}
+}