DocuSeal JS
https://github.com/docusealco/docuseal-js- Category
- Developer Tools
- Rank
- No. 990Tools index
Previous survey · No. 977 ·
- Pricing
- Open Source
- Type
- TOOL
- Builder
- docusealco
- GitHub
- 7 stars
- Date
About
TypeScript and JavaScript library for the DocuSeal Document Signing API.
What it does
DocuSeal JS gives Node applications a typed client for creating and managing signature workflows. It handles templates, submissions, submitters, and signed document retrieval. Requests can start from existing templates or one-off PDF, DOCX, and HTML content, with configurable cloud, EU cloud, or on-premises endpoints.
Why it's ranked here
The case is strong for teams already using DocuSeal. The package covers the central signing lifecycle, ships TypeScript declarations, supports both major Node module systems, and exposes deployment configuration. Its narrow scope is also clear: this is a direct service client, not a broader document automation framework.
What's good
The client supports template-based requests plus one-off PDF, DOCX, and HTML documents. Typed request and response shapes cover fields, signer roles, delivery order, expiration, messages, and document merging. It also exposes explicit error objects, configurable timeouts, custom user agents, and endpoint selection for regional or self-hosted deployments.
Tradeoffs
The transport buffers each response before parsing JSON and offers no visible streaming, retry, cancellation, or pagination automation. Errors preserve the status and response body only inside a formatted message. The package targets Node 14 or newer and uses Node networking modules, so browser use is not supported by the shown implementation.
How to use it well
Use it in a Node backend that already treats DocuSeal as the signing system. Keep API keys server-side, select the endpoint for your deployment, and use the generated types when assembling templates, documents, and signer data. It does not provide a signing interface, document editor, storage layer, or vendor-neutral workflow abstraction.
Technical notes+
package.json publishes @docuseal/api with MIT licensing, no declared runtime dependencies, TypeScript declarations, and separate import and require entry points. src/index.ts exports a default client, DocusealApi, and DocusealApiError, while src/index.cjs.ts builds the CommonJS export shape. src/api.ts maps typed methods to template, submission, submitter, and document endpoints. src/http.ts uses node:http and node:https, sends X-Auth-Token authentication and JSON bodies, buffers responses, parses successful JSON, and rejects non-2xx responses with DocusealApiError. src/types.ts is generated from the remote OpenAPI definition through generate-types.js; types/api.d.ts, types/http.d.ts, types/index.d.ts, and types/types.d.ts expose the compiled declaration surface.
Observed
- License
- MIT
- Primary language
- TypeScript
- Install surface
- npm or Yarn package @docuseal/api
- Interface
- Node library wrapping the DocuSeal HTTP API
- Module packaging
- Separate ES module and CommonJS entry points with TypeScript declarations
- Platform requirement
- Node 14 or newer
- Deployment support
- Global cloud, EU cloud, and configurable on-premises API endpoints
- Runtime dependencies
- No runtime dependencies declared in package.json
Read from README.md, package.json, src/index.ts, src/api.ts, src/http.ts, src/types.ts, src/version.ts, src/index.cjs.ts, generate-types.js, types/api.d.ts, types/http.d.ts, types/index.d.ts, types/types.d.ts, types/version.d.ts, LICENSE.txt.
What it can do
Send documents for electronic signature
Document file and recipient information → Signing request with tracking ID
Create document templates with signature fields
Document file and field specifications → Reusable document template
Track document signing status
Document or submission ID → Current status and completion details
Retrieve signed documents
Completed submission ID → Signed document file with certificates
Manage document submissions
Submission parameters and recipient data → Submission object with URLs and metadata
Configure signing workflows
Template ID and signer configuration → Automated signing process
Tags
Tech Stack
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.