@verdocs/js-sdk 1.1.15 → 1.2.1

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

@@ -0,0 +1,41 @@
+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/HTTP/Transport.js

@@ -11,7 +11,7 @@ import { VerdocsEndpoint } from './VerdocsEndpoint';
 // Also see globalThis for comments about why we're doing this in the first place.
 var ENDPOINT_KEY = Symbol.for('verdocs-api-endpoint');
 if (!globalThis[ENDPOINT_KEY]) {
-    globalThis[ENDPOINT_KEY] = new VerdocsEndpoint({ baseURL: 'https://api.verdocs.com/' });
+    globalThis[ENDPOINT_KEY] = new VerdocsEndpoint();
 }
 var globalEndpoint = globalThis[ENDPOINT_KEY];
 var activeEndpoint = globalEndpoint;

package/HTTP/VerdocsEndpoint.d.ts

@@ -1,94 +1,106 @@
+import { AxiosInstance } from 'axios';
 /**
- * A VerdocsEndpoint is a specific connection and authorization session for calling the Verdocs APIs. Where the global
- * Transport is generally used to simpliy standard-user operations, Endpoints can be used for isolated session tasks.
+ * VerdocsEndpoint is a class wrapper for a specific connection and authorization context for calling the Verdocs APIs.
+ * Endpoints can be used for isolated session tasks.
  * For instance, ephemeral signing sessions may be created independently of a caller's status as an authenticated user.
  * In that case, an Endpoint can be created and authenticated, used for calls related to signing operations, then
  * discarded once signing is complete.
  *
- * @module
+ * Note that endpoint configuration functions return the instance, so they can be chained, e.g.
+ *
+ * ```typescript
+ * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+ *
+ * const endpoint = new VerdocsEndpoint();
+ * endpoint
+ *     .logRequests(true)
+ *     .setClientID('1234)
+ *     .setTimeout(5000);
+ * ```
  */
-import { AxiosInstance } from 'axios';
 export declare class VerdocsEndpoint {
+    /**
+     * Reference to the axios instance wrapped by this endpoint. This is exposed as a convenience to developers, but
+     * developers should generally use the convenience functions such as `setTimeout` to configure the connection.
+     * Although there are currently no plans to change from Axios to another XHR library, the less this property is
+     * directly accessed the easier future migrations will be.
+     */
     api: AxiosInstance;
-    requestLoggerId: number | null;
+    private requestLoggerId;
     /**
-     * Create a new Endpoint to call Verdocs services.
+     * Create a new VerdocsEndpoint to call Verdocs platform services.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+     * const endpoint = new VerdocsEndpoint();
      * ```
      */
-    constructor({ baseURL, timeout }?: {
-        baseURL?: string;
-        timeout?: number;
-    });
+    constructor();
     /**
      * Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setTimeout(3000);
      * ```
      */
-    setTimeout(timeout: number): void;
+    setTimeout(timeout: number): VerdocsEndpoint;
     /**
      * Set the Client ID for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setClientID('1234);
      * ```
      */
-    setClientID(clientID: string): void;
+    setClientID(clientID: string): VerdocsEndpoint;
     /**
      * Set the auth token that will be used for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setAuthorization(accessToken);
      * ```
      */
-    setAuthorization(accessToken: string | null): void;
+    setAuthorization(accessToken: string | null): VerdocsEndpoint;
     /**
      * Set the auth token used for signing sessions. Separating user from signing auth allows the same endpoint to be
      * used for multiple operations, although it is recommended that a separate endpoint be created for each operation.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setSigningAuthorization(accessToken);
      * ```
      */
-    setSigningAuthorization(accessToken: string | null): void;
+    setSigningAuthorization(accessToken: string | null): VerdocsEndpoint;
     /**
      * Set the base URL for API calls. May also be set via the constructor.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setBaseURL('https://api.verdocs.com');
      * ```
      */
-    setBaseURL(url: string): void;
+    setBaseURL(url: string): VerdocsEndpoint;
     /**
      * Enable or disable request logging. This may expose sensitive data in the console log, so it should only be used for debugging.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.logRequests(true);
      * ```
      */
-    logRequests(enable: boolean): void;
+    logRequests(enable: boolean): VerdocsEndpoint;
 }

package/HTTP/VerdocsEndpoint.js

@@ -1,119 +1,129 @@
+import axios from 'axios';
+var requestLogger = function (r) {
+    // tslint:disable-next-line
+    console.debug("[JS-SDK] ".concat(r.method.toUpperCase(), " ").concat(r.baseURL).concat(r.url), r.data ? JSON.stringify(r.data) : '');
+    return r;
+};
 /**
- * A VerdocsEndpoint is a specific connection and authorization session for calling the Verdocs APIs. Where the global
- * Transport is generally used to simpliy standard-user operations, Endpoints can be used for isolated session tasks.
+ * VerdocsEndpoint is a class wrapper for a specific connection and authorization context for calling the Verdocs APIs.
+ * Endpoints can be used for isolated session tasks.
  * For instance, ephemeral signing sessions may be created independently of a caller's status as an authenticated user.
  * In that case, an Endpoint can be created and authenticated, used for calls related to signing operations, then
  * discarded once signing is complete.
  *
- * @module
+ * Note that endpoint configuration functions return the instance, so they can be chained, e.g.
+ *
+ * ```typescript
+ * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+ *
+ * const endpoint = new VerdocsEndpoint();
+ * endpoint
+ *     .logRequests(true)
+ *     .setClientID('1234)
+ *     .setTimeout(5000);
+ * ```
  */
-import axios from 'axios';
-var requestLogger = function (r) {
-    // tslint:disable-next-line
-    console.log("[JS-SDK] ".concat(r.method.toUpperCase(), " ").concat(r.baseURL).concat(r.url), r.data ? JSON.stringify(r.data) : '');
-    return r;
-};
 var VerdocsEndpoint = /** @class */ (function () {
     /**
-     * Create a new Endpoint to call Verdocs services.
+     * Create a new VerdocsEndpoint to call Verdocs platform services.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
+     * const endpoint = new VerdocsEndpoint();
      * ```
      */
-    function VerdocsEndpoint(_a) {
-        var _b = _a === void 0 ? {} : _a, baseURL = _b.baseURL, timeout = _b.timeout;
+    function VerdocsEndpoint() {
         this.requestLoggerId = null;
-        this.api = axios.create({
-            baseURL: baseURL || 'https://api.verdocs.com',
-            timeout: timeout || 6000,
-        });
+        this.api = axios.create({ baseURL: 'https://api.verdocs.com', timeout: 3000 });
     }
     /**
      * Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setTimeout(3000);
      * ```
      */
     VerdocsEndpoint.prototype.setTimeout = function (timeout) {
         this.api.defaults.timeout = timeout;
+        return this;
     };
     /**
      * Set the Client ID for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setClientID('1234);
      * ```
      */
     VerdocsEndpoint.prototype.setClientID = function (clientID) {
-        this.api.defaults.headers['X-Client-ID'] = clientID;
+        this.api.defaults.headers.common['X-Client-ID'] = clientID;
+        return this;
     };
     /**
      * Set the auth token that will be used for Verdocs API calls.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setAuthorization(accessToken);
      * ```
      */
     VerdocsEndpoint.prototype.setAuthorization = function (accessToken) {
         if (accessToken) {
-            this.api.defaults.headers.Authorization = "Bearer ".concat(accessToken);
+            this.api.defaults.headers.common.Authorization = "Bearer ".concat(accessToken);
         }
         else {
-            delete this.api.defaults.headers.Authorization;
+            delete this.api.defaults.headers.common.Authorization;
         }
+        return this;
     };
     /**
      * Set the auth token used for signing sessions. Separating user from signing auth allows the same endpoint to be
      * used for multiple operations, although it is recommended that a separate endpoint be created for each operation.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setSigningAuthorization(accessToken);
      * ```
      */
     VerdocsEndpoint.prototype.setSigningAuthorization = function (accessToken) {
         if (accessToken) {
-            this.api.defaults.headers.signer = "Bearer ".concat(accessToken);
+            this.api.defaults.headers.common.signer = "Bearer ".concat(accessToken);
         }
         else {
-            delete this.api.defaults.headers.signer;
+            delete this.api.defaults.headers.common.signer;
         }
+        return this;
     };
     /**
      * Set the base URL for API calls. May also be set via the constructor.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.setBaseURL('https://api.verdocs.com');
      * ```
      */
     VerdocsEndpoint.prototype.setBaseURL = function (url) {
         this.api.defaults.baseURL = url;
+        return this;
     };
     /**
      * Enable or disable request logging. This may expose sensitive data in the console log, so it should only be used for debugging.
      *
      * ```typescript
-     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
      *
-     * const endpoint = new Endpoint();
+     * const endpoint = new VerdocsEndpoint();
      * endpoint.logRequests(true);
      * ```
      */
@@ -124,6 +134,7 @@ var VerdocsEndpoint = /** @class */ (function () {
         else if (!enable && this.requestLoggerId !== null) {
             this.api.interceptors.request.eject(this.requestLoggerId);
         }
+        return this;
     };
     return VerdocsEndpoint;
 }());

package/Templates/Fields.d.ts

@@ -1,4 +1,13 @@
 import { ITemplateField } from './Types';
+/**
+ * Add a field to a template.
+ */
 export declare const createField: (templateId: string, params: ITemplateField) => Promise<ITemplateField>;
+/**
+ * Update a template field.
+ */
 export declare const editField: (templateId: string, fieldName: string, params: ITemplateField) => Promise<ITemplateField>;
+/**
+ * REmove a field from a template.
+ */
 export declare const deleteField: (templateId: string, fieldName: string) => Promise<any>;

package/Templates/Fields.js

@@ -1,14 +1,23 @@
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Add a field to a template.
+ */
 export var createField = function (templateId, params) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/pages/"), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Update a template field.
+ */
 export var editField = function (templateId, fieldName, params) {
     return getEndpoint()
         .api.put("/templates/".concat(templateId, "/pages/").concat(fieldName), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * REmove a field from a template.
+ */
 export var deleteField = function (templateId, fieldName) {
     return getEndpoint()
         .api.delete("/templates/".concat(templateId, "/pages/").concat(fieldName))

package/Templates/Pages.d.ts

@@ -1,5 +1,17 @@
 import { IPage } from './Types';
+/**
+ * Add a page to a template
+ */
 export declare const createPage: (templateId: string, params: IPage) => Promise<IPage>;
+/**
+ * Update a template page.
+ */
 export declare const editPage: (templateId: string, sequence: string) => Promise<any>;
+/**
+ * Get a page from a template.
+ */
 export declare const getPage: (templateId: string, sequence: string) => Promise<any>;
+/**
+ * Delete a page from a template
+ */
 export declare const deletePage: (templateId: string, sequence: string) => Promise<any>;

package/Templates/Pages.js

@@ -1,19 +1,31 @@
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Add a page to a template
+ */
 export var createPage = function (templateId, params) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/pages/"), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Update a template page.
+ */
 export var editPage = function (templateId, sequence) {
     return getEndpoint()
         .api.put("/templates/".concat(templateId, "/pages/").concat(sequence))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get a page from a template.
+ */
 export var getPage = function (templateId, sequence) {
     return getEndpoint()
         .api.get("/templates/".concat(templateId, "/pages/").concat(sequence))
         .then(function (r) { return r.data; });
 };
+/**
+ * Delete a page from a template
+ */
 export var deletePage = function (templateId, sequence) {
     return getEndpoint()
         .api.delete("/templates/".concat(templateId, "/pages/").concat(sequence))

package/Templates/Roles.d.ts

@@ -1,3 +1,10 @@
+/**
+ * A "role" is an individual participant in a signing flow, such as a signer or CC contact. Roles are identified by
+ * their names, which must be unique (e.g. 'Recipient 1'). Template fields are assigned to roles for signing operations,
+ * so you may have 'Recipient 1 Signature 1' and so forth.
+ *
+ * @module
+ */
 import { ITemplateField, IRole } from './Types';
 export declare const createRole: (templateId: string, params: IRole) => Promise<IRole>;
 export declare const getRoles: (templateId: string) => Promise<IRole[]>;

package/Templates/Roles.js

@@ -1,3 +1,10 @@
+/**
+ * A "role" is an individual participant in a signing flow, such as a signer or CC contact. Roles are identified by
+ * their names, which must be unique (e.g. 'Recipient 1'). Template fields are assigned to roles for signing operations,
+ * so you may have 'Recipient 1 Signature 1' and so forth.
+ *
+ * @module
+ */
 import { getEndpoint } from '../HTTP/Transport';
 export var createRole = function (templateId, params) {
     return getEndpoint()

package/Templates/Templates.d.ts

@@ -1,5 +1,10 @@
 import { ITemplate, ITemplatesSearchResult, ITemplatesSummary } from './Types';
-export declare const getTemplates: () => Promise<any[]>;
+export interface IGetTemplatesParams {
+    is_starred?: boolean;
+    is_creator?: boolean;
+    is_organization?: boolean;
+}
+export declare const getTemplates: (params?: IGetTemplatesParams | undefined) => Promise<any[]>;
 export declare const getTemplate: (templateId: string) => Promise<any>;
 export declare const createTemplate: (params: any) => Promise<ITemplate>;
 export declare const editTemplate: (templateId: string, params: any) => Promise<ITemplate>;

package/Templates/Templates.js

@@ -35,9 +35,9 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import { getEndpoint } from '../HTTP/Transport';
-export var getTemplates = function () {
+export var getTemplates = function (params) {
     return getEndpoint()
-        .api.get('/templates/')
+        .api.get('/templates/', { params: params })
         .then(function (r) { return r.data; });
 };
 export var getTemplate = function (templateId) {

package/Utils/Files.d.ts

@@ -0,0 +1,12 @@
+export interface FileWithData {
+    lastModified: number;
+    size: number;
+    type: string;
+    name: string;
+    data: string;
+}
+/**
+ * Given a File, extract the file's content as a base64 encoded data URL. The response will have a prefix that
+ * includes the MIME type of the file, e.g. "data:image/jpeg;base64,iVBORw0K......"
+ */
+export declare const fileToDataUrl: (file: File) => Promise<FileWithData>;

package/Utils/Files.js

@@ -0,0 +1,25 @@
+/**
+ * Given a File, extract the file's content as a base64 encoded data URL. The response will have a prefix that
+ * includes the MIME type of the file, e.g. "data:image/jpeg;base64,iVBORw0K......"
+ */
+export var fileToDataUrl = function (file) {
+    return new Promise(function (resolve, reject) {
+        var reader = new FileReader();
+        reader.onload = function () {
+            return resolve({
+                lastModified: file.lastModified,
+                size: file.size,
+                type: file.type,
+                name: file.name,
+                data: reader.result,
+            });
+        };
+        reader.onerror = reject;
+        if (file) {
+            reader.readAsDataURL(file);
+        }
+        else {
+            reject(new Error('Invalid file'));
+        }
+    });
+};

package/Utils/index.d.ts

@@ -1,5 +1,6 @@
 export * as Colors from './Colors';
 export * as DateTime from './DateTime';
 export * as Fields from './Fields';
+export * as Files from './Files';
 export * as Locales from './Locales';
 export * as Token from './Token';

package/Utils/index.js

@@ -1,5 +1,6 @@
 export * as Colors from './Colors';
 export * as DateTime from './DateTime';
 export * as Fields from './Fields';
+export * as Files from './Files';
 export * as Locales from './Locales';
 export * as Token from './Token';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.1.15",
+  "version": "1.2.1",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -29,13 +29,14 @@
     "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 --plugin none --out docs-html",
     "Xdocs-html": "typedoc --tsconfig ./tsconfig-typedoc.json --plugin ./typedoc-theme.tsx --out docs-html",
-    "docs": "rm -rf ../partner-portal/site/static/js-sdk/* && npm run docs-md && npm run docs-html && cp -aR docs-html/* ../partner-portal/site/static/js-sdk/",
+    "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 Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts docs docs-html"
@@ -44,7 +45,7 @@
     "access": "public"
   },
   "dependencies": {
-    "axios": "^0.21.1"
+    "axios": "^0.25.0"
   },
   "peerDependencies": {
     "typescript": "4.2.x || 4.3.x || 4.4.x || 4.5.x"

package/tsconfig-typedoc.json

@@ -20,6 +20,7 @@
     "out": "docs",
     "includeVersion": true,
     "gitRevision": "main",
-    "hideGenerator": true
+    "hideGenerator": true,
+    "excludePrivate": true
   }
 }