@verdocs/js-sdk 3.10.30 → 4.0.0

package/dist/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@verdocs/js-sdk",
+  "version": "4.0.0",
+  "private": false,
+  "homepage": "https://github.com/Verdocs/js-sdk",
+  "description": "Isomorphic JS SDK providing types and API wrappers for the Verdocs platform",
+  "keywords": [
+    "pdf",
+    "document",
+    "signing",
+    "Verdocs",
+    "embed"
+  ],
+  "author": "Verdocs, LLC",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "source": "./src/index.ts",
+  "browser": "dist/browser.js",
+  "files": [
+    "dist/*",
+    "node.js",
+    "browser.js",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Verdocs/js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Verdocs/js-sdk/issues"
+  },
+  "scripts": {
+    "buildX": "npm run clean && npm run docs && tsc && npm run lint",
+    "build": "rollup -c --sourcemap --bundleConfigAsCjs",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run lint",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags",
+    "postpublish": "npm run clean",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jestconfig.json",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json",
+    "docs-md": "typedoc --tsconfig ./tsconfig-typedoc.json",
+    "docs-html": "typedoc --tsconfig ./tsconfig-typedoc.json --out docs-html",
+    "Xdocs-html": "typedoc --tsconfig ./tsconfig-typedoc.json --plugin none --out docs-html",
+    "docs": "npm run docs-md && npm run docs-html",
+    "clear-docs": "aws --profile=verdocs cloudfront create-invalidation --distribution-id E29UFGU4KEH1GQ --paths \"/*\"",
+    "deploy-docs": "npm run docs && aws --profile=verdocs s3 sync --acl public-read --delete docs-html s3://verdocs-developers-js-sdk/ && yarn clear-docs",
+    "clean": "rm -rf Envelopes Sessions HTTP Organizations Search Templates Users Utils index.js index.d.ts VerdocsEndpoint.* docs docs-html",
+    "push": "npm run build && npm publish"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "axios": "^1.7.2"
+  },
+  "peerDependencies": {
+    "typescript": "^5.4.5"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/jest": "^29.5.12",
+    "axios-mock-adapter": "^1.22.0",
+    "esbuild": "^0.21.5",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "prettier": "^3.3.2",
+    "rollup": "^4.18.0",
+    "rollup-plugin-clear": "^2.0.7",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-ts": "^3.4.5",
+    "ts-jest": "^29.1.4",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.3",
+    "typescript": "^5.4.5"
+  }
+}

package/dist/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "lib": ["es2017", "es7", "es6", "dom"],
+    "declaration": true,
+    "allowJs": true,
+    "strict": true,
+    "noEmit": false,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "strictNullChecks": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "**/__tests__/*"]
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.10.30",
+  "version": "4.0.0",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
-  "description": "Verdocs JS SDK",
+  "description": "Isomorphic JS SDK providing types and API wrappers for the Verdocs platform",
   "keywords": [
     "pdf",
     "document",
@@ -13,8 +13,17 @@
   ],
   "author": "Verdocs, LLC",
   "license": "MIT",
-  "main": "index.js",
-  "types": "index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "source": "./src/index.ts",
+  "browser": "dist/browser.js",
+  "files": [
+    "dist/*",
+    "node.js",
+    "browser.js",
+    "README.md"
+  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/Verdocs/js-sdk.git"
@@ -23,7 +32,8 @@
     "url": "https://github.com/Verdocs/js-sdk/issues"
   },
   "scripts": {
-    "build": "npm run clean && npm run docs && tsc && npm run lint",
+    "buildX": "npm run clean && npm run docs && tsc && npm run lint",
+    "build": "rollup -c --sourcemap --bundleConfigAsCjs",
     "prepare": "npm run build",
     "prepublishOnly": "npm run lint",
     "preversion": "npm run lint",
@@ -46,23 +56,30 @@
     "access": "public"
   },
   "dependencies": {
-    "axios": "^1.6.7"
+    "axios": "^1.7.2"
   },
   "peerDependencies": {
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
+    "@rollup/plugin-commonjs": "^26.0.1",
+    "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
     "axios-mock-adapter": "^1.22.0",
+    "esbuild": "^0.21.5",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
+    "prettier": "^3.3.2",
+    "rollup": "^4.18.0",
+    "rollup-plugin-clear": "^2.0.7",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-ts": "^3.4.5",
+    "ts-jest": "^29.1.4",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.25.11",
-    "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.3",
+    "typescript": "^5.4.5"
   }
 }

package/.github/workflows/generate-docs.yml

@@ -1,41 +0,0 @@
-name: Generate Docs
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - "src/**"
-      - "README.md"
-      - "package.json"
-      - "tsconfig-typedoc.json"
-      - ".github/workflows/generate-docs.yml"
-
-defaults:
-  run:
-    shell: bash
-
-# We only want to run one job at a time in this group
-concurrency:
-  group: api-sdk-docs
-  cancel-in-progress: true
-
-jobs:
-  deploy:
-    name: Deploy Docs
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@v2
-
-      - name: Install and Build 🔧
-        run: |
-          npm ci
-          npm run build
-
-      - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4.2.3
-        with:
-          branch: gh-pages
-          folder: docs-html
-          clean: true

package/Envelopes/Envelopes.d.ts

@@ -1,242 +0,0 @@
-import { IEnvelope, IEnvelopesSummary, IRecipient, IEnvelopeDocument, IEnvelopeFieldSettings } from './Types';
-import { ICreateEnvelopeRole, IEnvelopesSearchResult, ISigningSessionRequest } from './Types';
-import { TEnvelopeUpdateResult, TEnvelopeStatus, TRecipientStatus } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-import { ISigningSession } from '../Sessions/Types';
-export interface ICreateEnvelopeRequest {
-    template_id: string;
-    roles: ICreateEnvelopeRole[];
-    name: string;
-    environment?: string;
-    prepared_fields?: {
-        name: string;
-        value: string;
-    }[];
-}
-/**
- * Create an envelope
- *
- * ```typescript
- * import {Envelopes, ICreateEnvelopeRole, ICreateEnvelopeRequest} from '@verdocs/js-sdk/Envelopes';
- *
- * const role1: ICreateEnvelopeRole = {
- *   type: 'signer',
- *   name: 'Seller',
- *   full_name: 'Paige Turner',
- *   email: 'paige.turner@nomail.com',
- *   phone: '',
- *   sequence: 1,
- *   delegator: false,
- *   message: '',
- * };
- *
- * const role2: ICreateEnvelopeRole = {
- *   type: 'signer',
- *   name: 'Buyer',
- *   full_name: 'Will Power',
- *   email: 'will.power@nomail.com',
- *   phone: '',
- *   sequence: 2,
- *   delegator: false,
- *   message: '',
- * };
- *
- * const request: ICreateEnvelopeRequest = {template_id: 'd2338742-f3a1-465b-8592-806587413cc1', name: 'Bill of Sale', roles: [role1, role2]};
- * const {id, recipients} = await Envelopes.createEnvelope(VerdocsEndpoint.getDefault(), request);
- * ```
- */
-export declare const createEnvelope: (endpoint: VerdocsEndpoint, request: ICreateEnvelopeRequest) => Promise<IEnvelope>;
-/**
- * Get a summary of currently active envelopes.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {action_required, completed, waiting_on_others} = await Envelopes.getSummary(VerdocsEndpoint.getDefault());
- * ```
- */
-export declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Promise<IEnvelopesSummary>;
-export interface IEnvelopeSearchParams {
-    /** The envelope must have been created via the specified template ID. */
-    template_id?: string;
-    /** The envelope must match one of the specified statuses. */
-    envelope_status?: TEnvelopeStatus[];
-    /** At least one of the recipients must match one of the specified statuses. */
-    recipient_status?: TRecipientStatus[];
-    /** The envelope's name (inherited from the template) must match the specified string. */
-    envelope_name?: string;
-    /** At least one of the envelope's recipients must match the specified name. */
-    recipient_name?: string;
-    /** At least one of the envelope's recipients must match the specified email address. */
-    recipient_email?: string;
-    /** Match against envelope_name, recipient_name, or recipient_email all at once. */
-    name?: string;
-    /** At least one of the envelope's recipients must match the specified ID. */
-    recipient_id?: string;
-    /** The date-range in which the envelope was created. Values should be specified in ISO8601 "UTC" format. */
-    created_at?: {
-        start_time: string;
-        end_time: string;
-    };
-    /**
-     * The date-range in which the envelope was last updated. Values should be specified in ISO8601 "UTC" format.
-     * Note that any operations that alter the envelope are considered "updates", including status changes (cancellation),
-     * recipient actions (opening/signing), etc.
-     */
-    updated_at?: {
-        start_time: string;
-        end_time: string;
-    };
-    /** The date-range in which the envelope was canceled. Values should be specified in ISO8601 "UTC" format. */
-    canceled_at?: {
-        start_time: string;
-        end_time: string;
-    };
-    /** Perform a "contains" search where any of the attached documents' fields contains the specified value. */
-    text_field_value?: string;
-    /** Set to true to retrieve only summary records (IEnvelopeSummary). */
-    summary?: boolean;
-    /** Set to true to retrieve only those envelopes owned by the caller. */
-    is_owner?: boolean;
-    /** Set to true to retrieve only those envelopes in which the caller is one of the recipients. */
-    is_recipient?: boolean;
-    /** Whether the recipient has "claimed" the envelope. */
-    recipient_claimed?: boolean;
-    /** @deprecated. Use `limit`. */
-    row?: number;
-    /** The maximum number of records to return. Should be used in place of `row`. */
-    limit?: number;
-    /** The page number to return. Page numbers are 0-based. */
-    page?: number;
-    /** The field to sort the results by. */
-    sort_by?: 'created_at' | 'updated_at' | 'envelope_name' | 'canceled_at' | 'envelope_status';
-    /** Whether to sort in ascending (default) or descending order. */
-    ascending?: boolean;
-}
-/**
- * Search for envelopes matching various criteria.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-export declare const searchEnvelopes: (endpoint: VerdocsEndpoint, params: IEnvelopeSearchParams) => Promise<IEnvelopesSearchResult>;
-export interface ISigningSessionResult {
-    recipient: IRecipient;
-    session: ISigningSession;
-    signerToken: string;
-}
-/**
- * Get a signing session for an Envelope.
- */
-export declare const getSigningSession: (endpoint: VerdocsEndpoint, params: ISigningSessionRequest) => Promise<ISigningSessionResult>;
-/**
- * Get the list of recipients for an Envelope.
- */
-export declare const getEnvelopeRecipients: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IRecipient[]>;
-/**
- * Get all metadata for an Envelope.
- */
-export declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IEnvelope>;
-/**
- * Get an Envelope Document
- */
-export declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<IEnvelopeDocument>;
-/**
- * Get a pre-signed download link for an Envelope Document. This link expires quickly, so it should
- * be accessed immediately and never shared. Content-Disposition will be set to "download".
- */
-export declare const getDocumentDownloadLink: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
-/**
- * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
- * be accessed immediately and never shared. Content-Disposition will be set to "inline".
- */
-export declare const getDocumentPreviewLink: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
-/**
- * Cancel an Envelope.
- */
-export declare const cancelEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<TEnvelopeUpdateResult>;
-/**
- * Get (binary download) a file attached to an Envelope. It is important to use this method
- * rather than a direct A HREF or similar link to set the authorization headers for the
- * request.
- */
-export declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<any>;
-/**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
- */
-export declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, value: any) => Promise<IEnvelopeFieldSettings>;
-/**
- * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
- * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
- */
-export declare const updateEnvelopeFieldSignature: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, signatureId: string) => Promise<IEnvelopeFieldSettings>;
-/**
- * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
- * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
- */
-export declare const updateEnvelopeFieldInitials: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, initialId: string) => Promise<IEnvelopeFieldSettings>;
-/**
- * Upload an attachment.
- */
-export declare const uploadEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, file: File, onUploadProgress?: ((percent: number, loadedBytes: number, totalBytes: number) => void) | undefined) => Promise<IEnvelopeFieldSettings>;
-/**
- * Delete an attachment.
- */
-export declare const deleteEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, file: File, onUploadProgress?: ((percent: number, loadedBytes: number, totalBytes: number) => void) | undefined) => Promise<IEnvelopeFieldSettings>;
-/**
- * Get the attached file for an attachment field (if any)
- */
-export declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<any>;
-/**
- * Get all of the envelopes that were sent using a given template.
- * NOTE: This endpoint will be retired soon. Its response is not paginated and it is typically used only to retrieve
- * "submitted data" for a template. A new endpoint will be introduced to provide this function more directly.
- * @deprecated
- */
-export declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IEnvelope[]>;
-/**
- * Get a display URI for a given page in a file attached to an envelope document. These pages are rendered server-side
- * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
- * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
- */
-export declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: 'original' | 'filled' | 'certificate') => Promise<string>;
-/**
- * Wrapper for `getEnvelope()` that limits queries to one every 2 seconds per template ID.
- * This is intended for use in component hierarchies that all rely on the same template
- * to avoid unnecessary repeat server calls.
- */
-export declare const throttledGetEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => IEnvelope | Promise<IEnvelope>;
-export interface ITimeRange {
-    start: string;
-    end: string;
-}
-export interface IListEnvelopesParams {
-    view?: 'inbox' | 'sent' | 'action' | 'waiting' | 'completed';
-    q?: string;
-    status?: string[];
-    created_at?: ITimeRange;
-    is_owner?: boolean;
-    sort_by?: 'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status';
-    template_id?: string;
-    ascending?: boolean;
-    rows?: number;
-    page?: number;
-}
-/**a
- * Lists all envelopes accessible by the caller, with optional filters.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {totals, envelopes} = await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' });
- * ```
- */
-export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<{
-    total: number;
-    rows: number;
-    page: number;
-    envelopes: IEnvelope[];
-}>;