@verdocs/js-sdk 1.0.25 → 1.0.26

package/HTTP/Endpoint.d.ts

@@ -0,0 +1,70 @@
+/**
+ * An Endpoint 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. 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
+ */
+import { AxiosInstance } from 'axios';
+export declare class Endpoint {
+    baseURL: string;
+    endpoint: AxiosInstance;
+    requestLoggerId: number | null;
+    /**
+     * Create a new Endpoint to call Verdocs services.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+     * ```
+     */
+    constructor({ baseURL }: {
+        baseURL?: string;
+    });
+    /**
+     * 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';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setTimeout(3000);
+     * ```
+     */
+    setTimeout(timeout: number): void;
+    /**
+     * Set the Client ID for Verdocs API calls.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setClientID('1234);
+     * ```
+     */
+    setClientID(clientID: string): void;
+    /**
+     * Set the auth token that will be used for Verdocs API calls.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setAuthorization(accessToken);
+     * ```
+     */
+    setAuthorization(accessToken: string | null): void;
+    /**
+     * 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';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.logRequests(true);
+     * ```
+     */
+    logRequests(enable: boolean): void;
+}

package/HTTP/Endpoint.js

@@ -0,0 +1,98 @@
+/**
+ * An Endpoint 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. 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
+ */
+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 Endpoint = /** @class */ (function () {
+    /**
+     * Create a new Endpoint to call Verdocs services.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+     * ```
+     */
+    function Endpoint(_a) {
+        var baseURL = _a.baseURL;
+        this.requestLoggerId = null;
+        this.baseURL = baseURL || 'https://api.verdocs.com/';
+        this.endpoint = axios.create({
+            baseURL: this.baseURL,
+            timeout: 6000,
+        });
+    }
+    /**
+     * 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';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setTimeout(3000);
+     * ```
+     */
+    Endpoint.prototype.setTimeout = function (timeout) {
+        this.endpoint.defaults.timeout = timeout;
+    };
+    /**
+     * Set the Client ID for Verdocs API calls.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setClientID('1234);
+     * ```
+     */
+    Endpoint.prototype.setClientID = function (clientID) {
+        this.endpoint.defaults.headers['X-Client-ID'] = clientID;
+    };
+    /**
+     * Set the auth token that will be used for Verdocs API calls.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setAuthorization(accessToken);
+     * ```
+     */
+    Endpoint.prototype.setAuthorization = function (accessToken) {
+        if (accessToken) {
+            this.endpoint.defaults.headers.Authorization = "Bearer ".concat(accessToken);
+        }
+        else {
+            delete this.endpoint.defaults.headers.Authorization;
+        }
+    };
+    /**
+     * 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';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.logRequests(true);
+     * ```
+     */
+    Endpoint.prototype.logRequests = function (enable) {
+        if (enable && this.requestLoggerId === null) {
+            this.requestLoggerId = this.endpoint.interceptors.request.use(requestLogger);
+        }
+        else if (!enable && this.requestLoggerId !== null) {
+            this.endpoint.interceptors.request.eject(this.requestLoggerId);
+        }
+    };
+    return Endpoint;
+}());
+export { Endpoint };

package/HTTP/Transport.d.ts

@@ -1,6 +1,7 @@
 /**
- * The Transport Endpoint is a global singleton used to call Verdocs APIs. There can only be one Endpoint per application, and
- * its configuration settings are shared for all callers.
+ * The Transport is a global singleton used to call Verdocs APIs. There can only be one Transport per application, and
+ * its configuration settings are shared for all callers. This is a simplified form of the Endpoint class where most
+ * tasks such as general session-token-management are handled automatically for the caller.
  *
  * @module
  */

package/HTTP/Transport.js

@@ -1,6 +1,7 @@
 /**
- * The Transport Endpoint is a global singleton used to call Verdocs APIs. There can only be one Endpoint per application, and
- * its configuration settings are shared for all callers.
+ * The Transport is a global singleton used to call Verdocs APIs. There can only be one Transport per application, and
+ * its configuration settings are shared for all callers. This is a simplified form of the Endpoint class where most
+ * tasks such as general session-token-management are handled automatically for the caller.
  *
  * @module
  */

package/HTTP/index.d.ts

@@ -1,2 +1,3 @@
+export { Endpoint } from './Endpoint';
 export * as Transport from './Transport';
 export * as Types from './Types';

package/HTTP/index.js

@@ -1,2 +1,3 @@
+export { Endpoint } from './Endpoint';
 export * as Transport from './Transport';
 export * as Types from './Types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",