PIGS-74_Typescript_Workflow_Examples#6
Merged
isadoraPGoNitro merged 22 commits intomainfrom Jan 7, 2026
Merged
Conversation
…roperties still missing)
…er and standardize documentation commands
…enum fot format validation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive TypeScript implementations of all existing Python sample scripts for the Nitro Platform API, providing feature parity across both language SDKs. The implementation follows clean, object-oriented architecture with OAuth2 authentication, type safety, and modern ES module patterns.
Key Changes:
- Complete TypeScript SDK implementation with Platform API and Sign API clients
- All 8 Python sample scripts ported to TypeScript with identical functionality
- Full project configuration including TypeScript setup, dependencies, and documentation
Reviewed changes
Copilot reviewed 20 out of 21 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| samples/typescript/tsconfig.json | TypeScript compiler configuration with ES2022 target and strict mode |
| samples/typescript/package.json | Project dependencies and npm scripts for all sample workflows |
| samples/typescript/README.md | Comprehensive documentation covering setup, usage, and API architecture |
| samples/typescript/.env.example | Environment variable template for API credentials |
| samples/typescript/.gitignore | Git ignore rules for Node.js projects |
| samples/typescript/src/api/base-client.ts | Base OAuth2 client with token management and connection pooling |
| samples/typescript/src/api/platform-api.ts | Platform API client for document operations (conversion, extraction, transformation) |
| samples/typescript/src/api/sign-api.ts | Sign API client for eSignature envelope management |
| samples/typescript/src/helpers/document-helpers.ts | File validation and pattern matching utilities |
| samples/typescript/src/helpers/sign-helpers.ts | Sign workflow orchestration helpers for employee onboarding |
| samples/typescript/src/scripts/quickstart.ts | Authentication and connection testing script |
| samples/typescript/src/scripts/convert-cli.ts | Single document format conversion |
| samples/typescript/src/scripts/batch-process.ts | Batch document conversion with pattern matching |
| samples/typescript/src/scripts/extract-data.ts | Form and table data extraction from PDFs |
| samples/typescript/src/scripts/smart-redact-pii.ts | AI-powered PII detection and redaction |
| samples/typescript/src/scripts/redact-by-keyword.ts | Keyword-based text redaction |
| samples/typescript/src/scripts/bulk-password-protect.ts | Bulk PDF password protection |
| samples/typescript/src/scripts/prepare-pdf-for-distribution.ts | Document preparation workflow (convert, compress, strip metadata) |
| samples/typescript/src/scripts/employee-policy-onboarding.ts | Complete HR onboarding workflow with Sign API |
| samples/python/README.md | Updated Python documentation with detailed testing examples |
Files not reviewed (1)
- samples/typescript/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Looks good to me. Do we plan to cover the async flows as they are the trickier ones to implement? |
Contributor
Author
|
conor-mac-aoidh
approved these changes
Jan 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added complete TypeScript implementation of all Python sample scripts