@verdocs/js-sdk 1.2.0 → 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,6 +1,7 @@
+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.
@@ -16,26 +17,25 @@
  *     .setClientID('1234)
  *     .setTimeout(5000);
  * ```
- *
- * @module
  */
-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 {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+     * 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.
      *

package/HTTP/VerdocsEndpoint.js

@@ -1,6 +1,12 @@
+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.
@@ -16,32 +22,19 @@
  *     .setClientID('1234)
  *     .setTimeout(5000);
  * ```
- *
- * @module
  */
-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;
-};
 var VerdocsEndpoint = /** @class */ (function () {
     /**
-     * Create a new Endpoint to call Verdocs services.
+     * Create a new VerdocsEndpoint to call Verdocs platform services.
      *
      * ```typescript
      * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+     * 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.

package/Templates/Roles.d.ts

@@ -1,4 +1,3 @@
-import { ITemplateField, IRole } from './Types';
 /**
  * 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,
@@ -6,6 +5,7 @@ import { ITemplateField, IRole } from './Types';
  *
  * @module
  */
+import { ITemplateField, IRole } from './Types';
 export declare const createRole: (templateId: string, params: IRole) => Promise<IRole>;
 export declare const getRoles: (templateId: string) => Promise<IRole[]>;
 export declare const getRole: (templateId: string, roleName: string) => Promise<IRole>;

package/Templates/Roles.js

@@ -1,4 +1,3 @@
-import { getEndpoint } from '../HTTP/Transport';
 /**
  * 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,
@@ -6,6 +5,7 @@ import { getEndpoint } from '../HTTP/Transport';
  *
  * @module
  */
+import { getEndpoint } from '../HTTP/Transport';
 export var createRole = function (templateId, params) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/roles/"), params)

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.2.0",
+  "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"

package/tsconfig-typedoc.json

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