@elumixor/digisigner 1.0.3

package/README.md

@@ -0,0 +1,101 @@
+# @elumixor/digisigner
+
+TypeScript wrapper for the DigiSigner API - a simple and efficient way to add electronic signatures to your documents.
+
+## Installation
+
+```bash
+npm install @elumixor/digisigner
+# or
+bun add @elumixor/digisigner
+# or
+yarn add @elumixor/digisigner
+```
+
+## Usage
+
+```typescript
+import { DigiSigner } from "@elumixor/digisigner";
+
+// Initialize the client
+const signer = new DigiSigner(process.env.DIGISIGNER_API_KEY);
+
+// Upload a document
+const document = await signer.uploadDocument(pdfBuffer, "contract.pdf");
+
+// Send signature request
+const signature = await signer.sendSignatureRequest({
+  documentId: document.document_id,
+  signers: [
+    { email: "john@example.com", name: "John Doe" },
+    { email: "jane@example.com", name: "Jane Smith" },
+  ],
+  fields: [
+    {
+      type: "signature",
+      page: 0,
+      x: 100,
+      y: 100,
+      width: 200,
+      height: 50,
+      signer_id: 0,
+      required: true,
+    },
+  ],
+  subject: "Please sign this document",
+  message: "Please review and sign the attached document.",
+});
+
+console.log(signature.signing_urls); // { "john@example.com": "https://...", "jane@example.com": "https://..." }
+
+// Check signature status
+const status = await signer.getSignatureStatus(signature.signature_request_id);
+console.log(status.status); // "pending", "completed", etc.
+```
+
+## API
+
+### `DigiSigner`
+
+Main client class for interacting with the DigiSigner API.
+
+#### Constructor
+
+```typescript
+new DigiSigner(apiKey: string)
+```
+
+#### Methods
+
+##### `uploadDocument(buffer: Buffer, filename: string): Promise<DigiSignerDocument>`
+
+Upload a PDF document to DigiSigner.
+
+##### `sendSignatureRequest(request: DigiSignerSignatureRequest): Promise<DigiSignerSignature>`
+
+Send a signature request for a document.
+
+##### `getSignatureStatus(signatureRequestId: string): Promise<DigiSignerSignatureStatus>`
+
+Get the status of a signature request.
+
+## Types
+
+All TypeScript types are exported:
+
+- `DigiSignerSigner`
+- `DigiSignerField`
+- `DigiSignerSignatureRequest`
+- `DigiSignerDocument`
+- `DigiSignerSignature`
+- `DigiSignerSignatureStatus`
+
+## Getting an API Key
+
+1. Sign up at [DigiSigner](https://www.digisigner.com/)
+2. Navigate to API Settings
+3. Generate your API key
+
+## License
+
+ISC

package/dist/digi-signer.d.ts

@@ -0,0 +1,10 @@
+import type { DigiSignerDocument, DigiSignerSignature, DigiSignerSignatureRequest, DigiSignerSignatureStatus } from "./types";
+export declare class DigiSigner {
+    private readonly apiKey;
+    constructor(apiKey: string);
+    private request;
+    private createFormData;
+    uploadDocument(buffer: Buffer, filename: string): Promise<DigiSignerDocument>;
+    sendSignatureRequest(request: DigiSignerSignatureRequest): Promise<DigiSignerSignature>;
+    getSignatureStatus(signatureRequestId: string): Promise<DigiSignerSignatureStatus>;
+}

package/dist/digi-signer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { DigiSigner } from "./digi-signer";
+export type { DigiSignerDocument, DigiSignerField, DigiSignerSignature, DigiSignerSignatureRequest, DigiSignerSignatureStatus, DigiSignerSigner, } from "./types";

package/dist/index.js

@@ -0,0 +1,84 @@
+// src/digi-signer.ts
+var DIGISIGNER_API_URL = "https://api.digisigner.com/v1";
+
+class DigiSigner {
+  apiKey;
+  constructor(apiKey) {
+    if (!apiKey)
+      throw new Error("DigiSigner API key is required");
+    this.apiKey = apiKey;
+  }
+  async request(method, endpoint, body) {
+    const response = await fetch(`${DIGISIGNER_API_URL}${endpoint}`, {
+      method,
+      headers: {
+        Authorization: `Token ${this.apiKey}`,
+        "Content-Type": "application/json"
+      },
+      body: body ? JSON.stringify(body) : undefined
+    });
+    if (!response.ok) {
+      const error = await response.text();
+      throw new Error(`DigiSigner API error: ${response.status} ${error}`);
+    }
+    return response.json();
+  }
+  createFormData(buffer, filename) {
+    const formData = new FormData;
+    const uint8Array = new Uint8Array(buffer);
+    const blob = new Blob([uint8Array], { type: "application/pdf" });
+    formData.append("file", blob, filename);
+    return formData;
+  }
+  async uploadDocument(buffer, filename) {
+    const formData = this.createFormData(buffer, filename);
+    const response = await fetch(`${DIGISIGNER_API_URL}/documents`, {
+      method: "POST",
+      headers: {
+        Authorization: `Token ${this.apiKey}`
+      },
+      body: formData
+    });
+    if (!response.ok) {
+      const error = await response.text();
+      throw new Error(`DigiSigner upload error: ${response.status} ${error}`);
+    }
+    return await response.json();
+  }
+  async sendSignatureRequest(request) {
+    const signers = request.signers.map((signer, index) => ({
+      email: signer.email,
+      name: signer.name,
+      role: signer.role ?? `Signer ${index + 1}`,
+      order: index + 1
+    }));
+    const fields = request.fields.map((field) => ({
+      type: field.type,
+      page: field.page,
+      rectangle: {
+        x: field.x,
+        y: field.y,
+        width: field.width,
+        height: field.height
+      },
+      signer: field.signer_id,
+      label: field.label,
+      required: field.required ?? true
+    }));
+    const payload = {
+      document_id: request.documentId,
+      signers,
+      fields,
+      subject: request.subject,
+      message: request.message,
+      send_emails: true
+    };
+    return this.request("POST", "/signature_requests", payload);
+  }
+  async getSignatureStatus(signatureRequestId) {
+    return this.request("GET", `/signature_requests/${signatureRequestId}`);
+  }
+}
+export {
+  DigiSigner
+};

package/dist/types.d.ts

@@ -0,0 +1,36 @@
+export interface DigiSignerSigner {
+    email: string;
+    name?: string;
+    role?: string;
+}
+export interface DigiSignerField {
+    type: "signature" | "text" | "date" | "checkbox";
+    page: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    signer_id: number;
+    label?: string;
+    required?: boolean;
+}
+export interface DigiSignerSignatureRequest {
+    documentId: string;
+    signers: DigiSignerSigner[];
+    fields: DigiSignerField[];
+    subject?: string;
+    message?: string;
+}
+export interface DigiSignerDocument {
+    document_id: string;
+    name: string;
+}
+export interface DigiSignerSignature {
+    signature_request_id: string;
+    signing_urls: Record<string, string>;
+    status: string;
+}
+export interface DigiSignerSignatureStatus {
+    status: string;
+    signed_document_url?: string;
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@elumixor/digisigner",
+  "version": "1.0.3",
+  "description": "TypeScript wrapper for DigiSigner API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/elumixor/digisigner.git"
+  },
+  "files": [
+    "./dist"
+  ],
+  "scripts": {
+    "build": "bun run build:bundle && bun run build:declaration",
+    "build:bundle": "bun build ./src/index.ts --outdir ./dist",
+    "build:declaration": "tsc --project tsconfig.json",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "format": "biome format --write .",
+    "test": "bun test",
+    "release:patch": "npm version patch -m \"Release v%s\" && git push --tags",
+    "release:minor": "npm version minor -m \"Release v%s\" && git push --tags",
+    "release:major": "npm version major -m \"Release v%s\" && git push --tags"
+  },
+  "keywords": [
+    "digisigner",
+    "esignature",
+    "document-signing",
+    "api-wrapper",
+    "typescript"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.10",
+    "@types/bun": "^1.3.1",
+    "typescript": "^5.7.2"
+  }
+}