Skip to main content

SDK Versions

Documentation Version: 6.1 (December 8, 2025)

This documentation is based on the following SDK versions:

Python SDK​

  • Repository: pdfdancer-client-python
  • Version: 0.3.2
  • Commit: 96504f66253180d8ae09fa409c4c07e40f33f5e1
  • Commit Date: December 8, 2025
  • Commit Message: Merge remote-tracking branch 'refs/remotes/origin/main'
  • Documentation Coverage:
    • ✅ Anonymous token support (automatic fallback authentication)
    • ✅ Snapshot API (get_document_snapshot(), get_page_snapshot(), page.get_snapshot())
    • ✅ Vector graphics drawing (new_path(), new_line(), new_bezier(), new_rectangle())
    • ✅ Text line editing (textline.edit().replace(), font, color, move)
    • ✅ Document-level text selection methods (select_paragraphs_starting_with, select_paragraphs_matching, select_text_lines_starting_with, select_text_lines_matching)
    • ✅ Page moving and reordering (move_page(), page.move_to())
    • ✅ Adding new pages to existing documents (new_page())
    • ✅ Select all elements helper (select_elements())
    • ✅ Page size and orientation properties (page.page_size, page.orientation)
    • ✅ Context manager pattern for text editing (recommended approach)
    • ✅ Standard page numbering (page_number instead of page_index)
    • ✅ Redaction API (object.redact(), pdf.redact() for batch redaction)
  • Key Changes Since Last Version (0.3.1 → 0.3.2):
    • Document-level regex text line selection: New select_text_lines_matching(pattern) and select_text_line_matching(pattern) methods at document level

TypeScript SDK​

  • Repository: pdfdancer-client-typescript
  • Version: 2.0.2
  • Commit: 57b67d8d9e252db3db7d3f055c755ec9a872405a
  • Commit Date: December 8, 2025
  • Documentation Coverage:
    • ✅ Anonymous token support (automatic fallback authentication)
    • ✅ Snapshot API (getDocumentSnapshot(), getPageSnapshot(), page.getSnapshot())
    • ✅ Vector graphics drawing (newPath(), newLine(), newBezier(), newRectangle())
    • ✅ Text line editing (textline.edit().replace(), font, color, move)
    • ✅ Document-level text selection methods (selectParagraphsStartingWith, selectParagraphsMatching, selectTextLinesStartingWith, selectTextLinesMatching)
    • ✅ Page moving and reordering (movePage(), page.moveTo())
    • ✅ Select all elements helper (selectElements())
    • ✅ Page size and orientation properties (page.pageSize, page.orientation)
    • ✅ Form field selection naming clarified (document-level: selectFieldsByName(), page-level: selectFormFieldsByName())
    • ✅ Corrected method name: getBytes() (not getPdfFile())
    • ✅ Standard page numbering (pageNumber instead of pageIndex)
    • ✅ Flexible PDF input types (File, ArrayBuffer, filepath string, Uint8Array)
    • ✅ Automatic dotenv loading
    • ✅ Redaction API (object.redact(), pdf.redact() for batch redaction)
  • Key Changes Since Last Version (2.0.1 → 2.0.2):
    • Public batch redaction API: pdf.redact(objects, options) now exposed as public method for efficient multi-object redaction

Java SDK​

  • Repository: pdfdancer-client-java
  • Version: 0.2.2
  • Commit: df394c19717dd1e6de4ac5dd4d7a36d16c4537a9
  • Commit Date: December 8, 2025
  • Commit Message: build: bump version to 0.2.2
  • Documentation Coverage:
    • ✅ Core PDF manipulation (open, create, save)
    • ✅ Text operations (paragraphs, text lines)
    • ✅ Text line editing (textLine.edit().replace(), font, color, move)
    • ✅ Text line selection (selectTextLinesMatching(), selectTextLineMatching())
    • ✅ Image operations (add, select, manipulate)
    • ✅ Form field operations (AcroForms)
    • ✅ Vector graphics (paths, lines, rectangles, Bezier curves)
    • ✅ Page operations (add, delete, move, reorder)
    • ✅ Snapshot API (document and page snapshots, caching)
    • ✅ Session management (SessionService)
    • ✅ Standard PDF fonts constants (StandardFonts enum)
    • ✅ Page size constants (PageSize class with standard sizes)
    • ✅ Position and coordinate system support
    • ✅ Color model support
    • ✅ Maven Central publishing support (automated and manual bundle upload)
    • ✅ OpenAPI specification for REST API integration
    • ✅ Standard page numbering (pageNumber instead of pageIndex)
    • ✅ Redaction API (object.redact().apply(), pdf.redact(objects) for batch redaction)
    • ✅ selectFormFieldByName at document and page level
  • Requirements:
    • Java 11+ required (tested with Java 11, 17, 21, 23, 25)
    • Uses Gradle for build management
    • Jackson for JSON serialization
    • SLF4J for logging
  • Key Features:
    • Package: com.pdfdancer.client.rest
    • Type-safe API: Strong typing with Java generics
    • Builder pattern: Fluent API for constructing PDF elements
    • Standard constants: PageSize and StandardFonts enums for common values
    • Clean API design: Mirrors Python and TypeScript SDKs with Java conventions
    • Default API endpoint: Now uses https://api.pdfdancer.com
    • Maven Central distribution: Published artifacts available for easy dependency management
  • Key Changes Since Last Version (0.2.1 → 0.2.2):
    • Simplified redaction API: Both single-object and batch redaction now use direct method calls
      • Single-object: object.redact(), object.redact(replacement), object.redact(placeholderColor), object.redact(replacement, placeholderColor) - no longer requires .apply()
      • Batch redaction: pdf.redact(objects), pdf.redact(objects, replacement), pdf.redact(objects, replacement, placeholderColor) - no longer requires RedactRequest.builder()

Checking Your Installed Version​

To verify which version of the SDK you have installed:

pip show pdfdancer-client-python

Or in Python code:

import pdfdancer
print(pdfdancer.__version__)

Updating to Latest Version​

pip install --upgrade pdfdancer-client-python

Documentation Update History​

Version 6.1 - December 8, 2025​

Java Redaction API Simplification & TypeScript Version Update

Updated documentation to reflect simplified Java redaction API in v0.2.2 and TypeScript SDK version bump to 2.0.3:

SDK Version Updates:

  • TypeScript SDK: 2.0.2 → 2.0.3 (version bump only, no functional changes)
  • Java SDK: No version change, but documented unreleased API improvements from commit 886ff0b

API Changes (Java SDK):

  1. Simplified Single-Object Redaction
    • Old API (fluent builder): object.redact().withReplacement("[TEXT]").apply()
    • New API (direct call): object.redact("[TEXT]")
    • Also available: object.redact(), object.redact(color), object.redact(replacement, color)
    • No longer requires calling .apply() - returns boolean directly

Documentation Updated:

  • docs/redaction.md - Updated all Java code examples for single-object redaction
  • docs/sdk-versions.md - Updated Java SDK changelog and TypeScript version info

Files Modified:

  • All Java redaction examples now use simplified API: object.redact() instead of object.redact().apply()

Version 6.0 - December 8, 2025​

Simplified Batch Redaction API & Document-Level Text Line Matching

Updated documentation to cover new features in Python SDK v0.3.2, TypeScript SDK v2.0.2, and Java SDK v0.2.2:

API Improvements:

  1. Unified Batch Redaction API (All SDKs)

    • All SDKs now support pdf.redact(objects) for batch redaction with consistent API
    • TypeScript: pdf.redact(objects, options) now public (was internal)
    • Java: Simplified from RedactRequest.builder() pattern to direct pdf.redact(objects, replacement, color) calls
    • Updated batch redaction examples in docs/redaction.md

  2. Python: Document-Level Text Line Pattern Matching

    • New pdf.select_text_lines_matching(pattern) method at document level
    • New pdf.select_text_line_matching(pattern) singular method at document level
    • Previously only available at page level

Documentation Updated:

  • docs/redaction.md - Updated batch redaction examples for TypeScript and Java
  • docs/finding-content.md - Added select_text_lines_at singular method to table
  • docs/sdk-versions.md - Updated version information and changelog

SDK Versions:

  • Python SDK: 0.3.1 → 0.3.2
  • TypeScript SDK: 2.0.1 → 2.0.2
  • Java SDK: 0.2.1 → 0.2.2

Version 5.0 - December 2, 2025​

Redaction Support: Permanently Remove Sensitive Content

Updated documentation to cover redaction features available in Python SDK v0.3.1, TypeScript SDK v2.0.1, and Java SDK v0.2.1:

New Documentation Added:

  1. Redaction Page (docs/redaction.md - NEW FILE)
    • Complete documentation for redaction functionality
    • Single-object redaction: paragraph.redact(), textline.redact(), image.redact(), path.redact(), formfield.redact()
    • Batch redaction: pdf.redact(objects, replacement, placeholder_color)
    • Custom replacement text for text content
    • Custom placeholder colors for images and paths
    • Code examples in Python, TypeScript, and Java

SDK Updates:

  • Python SDK: 0.3.0 → 0.3.1
  • TypeScript SDK: 2.0.0 → 2.0.1
  • Java SDK: 0.2.0 → 0.2.1

Internal Improvements (not user-facing):

  • All SDKs now send X-PDFDancer-Client header with version information
  • Java SDK: Increased default HTTP timeout to 60 seconds
  • Java SDK: Added selectFormFieldByName() at document and page level

Files Modified:

  • docs/redaction.md - NEW FILE (complete redaction API documentation)
  • docs/sdk-versions.md - Version information and changelog updated
  • sidebars.ts - Added redaction page to Forms & Advanced category

Version 4.0 - November 25, 2025​

API V1 Migration: Breaking Changes for Page Indexing

Updated documentation to reflect major breaking changes in all SDKs:

Breaking Changes:

  1. Standard Page Numbering (All SDKs)

    • Page numbers now use standard numbering (page 1 is the first page)
    • page(0) → page(1) for the first page
    • All documentation examples updated

  2. Renamed Properties and Methods

    • Python: page_index → page_number, position.page_index → position.page_number
    • TypeScript: pageIndex → pageNumber, position.pageIndex → position.pageNumber
    • Java: getPageIndex() → getPageNumber(), pageIndex → pageNumber

  3. Removed Features

    • Python: Removed line_spacing() method from TextLineEdit (only supported on paragraphs)

New Features:

  1. TypeScript: Flexible PDF Input Types

    • PDFDancer.open() now accepts File, ArrayBuffer, filepath strings, and Uint8Array

  2. TypeScript: Automatic dotenv Support

    • Environment variables automatically loaded from .env files

Files Modified:

  • All documentation files updated for Standard page numbering
  • docs/sdk-versions.md - Version information updated
  • Code samples across all 20+ documentation files updated

Version 3.0 - October 30, 2025​

Major SDK Update: New Features Documentation

Updated documentation to cover all features available in Python SDK v0.2.21 and TypeScript SDK v1.0.15:

New Documentation Added:

  1. Anonymous Token Support (docs/getting-started.md)

    • Documented automatic anonymous token fallback
    • Positioned as the easiest way for beginners to get started
    • Authentication priority: direct token → PDFDANCER_TOKEN env var → automatic anonymous token
    • Updated "Quick Start" section to show no-token-required examples
    • Added "Using API Tokens (Production)" section for production use cases

  2. Snapshot API (docs/working-with-snapshots.md - NEW FILE)

    • Complete documentation for snapshot functionality
    • Document snapshots: get_document_snapshot() / getDocumentSnapshot()
    • Page snapshots: get_page_snapshot() / getPageSnapshot(), page.get_snapshot() / page.getSnapshot()
    • Filtering by object type
    • Use cases: bulk text extraction, document analysis
    • Performance benefits and caching behavior

  3. Vector Graphics Drawing (docs/working-with-vector-graphics.md)

    • Major expansion from selection-only to full drawing capabilities
    • Drawing lines: new_line() / newLine() with stroke color, width, dash patterns
    • Drawing rectangles: new_rectangle() / newRectangle() with stroke and fill
    • Drawing Bezier curves: new_bezier() / newBezier() for smooth curves
    • Drawing complex paths: new_path() / newPath() with move_to, line_to, curve_to, close_path
    • Complete styling options documentation (stroke, fill, dash patterns)

  4. Text Line Editing (docs/working-with-text.md)

    • New section: "Editing Text Lines"
    • Text line replacement: textline.edit().replace()
    • Font and style changes for text lines
    • Moving text lines to new positions
    • Context manager pattern for text lines (Python)
    • Comparison of text lines vs paragraphs

Files Modified:

  • docs/getting-started.md - Anonymous token support, updated quick start
  • docs/working-with-snapshots.md - NEW FILE (complete snapshot API documentation)
  • docs/working-with-vector-graphics.md - Added 4 major sections for drawing capabilities
  • docs/working-with-text.md - Added text line editing section
  • docs/sdk-versions.md - Updated to Python 0.2.21 and TypeScript 1.0.15

Version 2.0 - October 30, 2025​

Comprehensive SDK Feature Documentation Update

Updated documentation to cover all features available in Python SDK v0.2.16 and TypeScript SDK v1.0.13:

New Documentation Added:

  1. Document-Level Text Selection (docs/finding-content.md)

    • Clarified that text selection methods work at both document and page levels
    • Added examples showing document-level vs page-scoped searches
    • Methods: select_paragraphs_starting_with(), select_paragraphs_matching(), select_text_lines_starting_with(), select_text_lines_matching()

  2. Select All Elements Helper (docs/finding-content.md)

    • New section documenting select_elements() convenience method
    • Returns all content types at once (paragraphs, text lines, images, paths, forms, form fields)
    • Available at both document and page levels

  3. Page Moving and Reordering (docs/working-with-pages.md)

    • New section: "Moving and Reordering Pages"
    • Python: pdf.move_page(from_index, to_index) and page.move_to(target_index)
    • TypeScript: pdf.movePage(pageIndex, targetPageIndex) and page.moveTo(targetPageIndex)

  4. Adding Pages to Existing Documents (docs/working-with-pages.md)

    • New section: "Adding Pages to Existing Documents"
    • Python: pdf.new_page() method
    • TypeScript: pdf.newPage() method

  5. Page Size and Orientation Properties (docs/working-with-pages.md)

    • Enhanced "Getting Page Properties" section
    • Python: page.page_size (or page.size), page.orientation (or page.page_orientation)
    • TypeScript: page.pageSize, page.orientation

  6. Python Context Manager Pattern (docs/working-with-text.md)

    • Promoted from tip box to main example
    • Recommended approach for text editing operations
    • Automatic application of changes with error safety

Bug Fixes:

  1. TypeScript Method Name Correction (docs/working-with-pages.md)

    • Fixed: getPdfFile() → getBytes()

  2. Form Field Selection Naming (docs/working-with-acroforms.md)

    • Clarified naming difference between document-level and page-level methods
    • Document-level: selectFieldsByName()
    • Page-level: selectFormFieldsByName()

Files Modified:

  • docs/finding-content.md - 3 sections updated
  • docs/working-with-pages.md - 2 new sections, 1 section enhanced, 1 bug fix
  • docs/working-with-acroforms.md - 1 section enhanced
  • docs/working-with-text.md - 2 sections enhanced