@verdocs/js-sdk 3.10.29 → 4.0.0

package/VerdocsEndpoint.js

@@ -1,319 +0,0 @@
-import axios from 'axios';
-import { decodeAccessTokenBody } from './Utils/Token';
-import globalThis from './Utils/globalThis';
-// @credit https://derickbailey.com/2016/03/09/creating-a-true-singleton-in-node-js-with-es6-symbols/
-// Also see globalThis for comments about why we're doing this in the first place.
-var ENDPOINT_KEY = Symbol.for('verdocs-default-endpoint');
-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;
-};
-/**
- * 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.
- *
- * 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
- *     .setSessionType('signing')
- *     .logRequests(true)
- *     .setClientID('1234)
- *     .setTimeout(30000);
- * ```
- */
-var VerdocsEndpoint = /** @class */ (function () {
-    /**
-     * Create a new VerdocsEndpoint to call Verdocs platform services.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     * const endpoint = new VerdocsEndpoint();
-     * ```
-     */
-    function VerdocsEndpoint(options) {
-        this.environment = 'verdocs';
-        this.sessionType = 'user';
-        this.baseURL = (window.location.origin === 'https://beta.verdocs.com' || window.location.origin === 'https://stage.verdocs.com'
-            ? 'https://stage-api.verdocs.com'
-            : 'https://api.verdocs.com');
-        this.clientID = 'not-set';
-        this.timeout = 60000;
-        this.token = null;
-        this.nextListenerId = 0;
-        this.sessionListeners = new Map();
-        this.requestLoggerId = null;
-        /**
-         * The current user session, or null if not authenticated. May be either a User or Signing session. If set, the
-         * presence of the `document_id` field can be used to differentiate the types. Only signing sessions are associated
-         * with Envelopes.
-         */
-        this.session = null;
-        this.baseURL = (options === null || options === void 0 ? void 0 : options.baseURL) || this.baseURL;
-        this.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || this.timeout;
-        this.environment = (options === null || options === void 0 ? void 0 : options.environment) || this.environment;
-        this.sessionType = (options === null || options === void 0 ? void 0 : options.sessionType) || this.sessionType;
-        this.clientID = (options === null || options === void 0 ? void 0 : options.clientID) || this.clientID;
-        this.api = axios.create({ baseURL: this.baseURL, timeout: this.timeout });
-    }
-    VerdocsEndpoint.prototype.setDefault = function () {
-        globalThis[ENDPOINT_KEY] = this;
-    };
-    VerdocsEndpoint.getDefault = function () {
-        if (!globalThis[ENDPOINT_KEY]) {
-            globalThis[ENDPOINT_KEY] = new VerdocsEndpoint();
-            window.console.debug('[JS_SDK] Created default endpoint', globalThis[ENDPOINT_KEY].baseURL);
-        }
-        return globalThis[ENDPOINT_KEY];
-    };
-    /**
-     * Get the current environment.
-     */
-    VerdocsEndpoint.prototype.getEnvironment = function () {
-        return this.environment;
-    };
-    /**
-     * Get the current session type.
-     */
-    VerdocsEndpoint.prototype.getSessionType = function () {
-        return this.sessionType;
-    };
-    /**
-     * Get the current base URL. This should rarely be anything other than 'https://api.verdocs.com'.
-     */
-    VerdocsEndpoint.prototype.getBaseURL = function () {
-        return this.baseURL;
-    };
-    /**
-     * Get the current client ID, if set.
-     */
-    VerdocsEndpoint.prototype.getClientID = function () {
-        return this.clientID;
-    };
-    /**
-     * Get the current timeout.
-     */
-    VerdocsEndpoint.prototype.getTimeout = function () {
-        return this.timeout;
-    };
-    /**
-     * Get the current session, if any.
-     */
-    VerdocsEndpoint.prototype.getSession = function () {
-        return this.session;
-    };
-    /**
-     * Set the operating environment. This should rarely be anything other than 'verdocs'.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.setEnvironment('verdocs-stage');
-     * ```
-     */
-    VerdocsEndpoint.prototype.setEnvironment = function (environment) {
-        this.environment = environment;
-        return this;
-    };
-    /**
-     * Set the session type. In general this should be done immediately when the endpoint is created. Changing the
-     * session type may be done at any time, but may have unintended consequences if the endpoint is shared between
-     * multiple widgets.
-     *
-     * Changing the session type will clear/reload the action session. This may trigger notifications to session state
-     * observers. Apps that use observers to trigger UI updates such as logging the user out should be prepared to
-     * handle this event.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.setEnvironment('verdocs-stage');
-     * ```
-     */
-    VerdocsEndpoint.prototype.setSessionType = function (sessionType) {
-        this.sessionType = sessionType;
-        return this;
-    };
-    /**
-     * Set the base URL for API calls. Should be called only upon direction from Verdocs Customer Solutions Engineering.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.setBaseURL('https://api.verdocs.com');
-     * ```
-     */
-    VerdocsEndpoint.prototype.setBaseURL = function (url) {
-        this.baseURL = url;
-        this.api.defaults.baseURL = url;
-        return this;
-    };
-    /**
-     * Set the Client ID for Verdocs API calls.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.setClientID('1234);
-     * ```
-     */
-    VerdocsEndpoint.prototype.setClientID = function (clientID) {
-        this.clientID = clientID;
-        this.api.defaults.headers.common['X-Client-ID'] = clientID;
-        return this;
-    };
-    /**
-     * Set the timeout for API calls in milliseconds. 5000-20000ms is recommended for most purposes. 15000ms is the default.
-     * Note that some calls may involve rendering operations that require some time to complete, so very short timeouts
-     * are not recommended.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.setTimeout(3000);
-     * ```
-     */
-    VerdocsEndpoint.prototype.setTimeout = function (timeout) {
-        this.timeout = timeout;
-        this.api.defaults.timeout = timeout;
-        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 {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.logRequests(true);
-     * ```
-     */
-    VerdocsEndpoint.prototype.logRequests = function (enable) {
-        if (enable && this.requestLoggerId === null) {
-            this.requestLoggerId = this.api.interceptors.request.use(requestLogger);
-        }
-        else if (!enable && this.requestLoggerId !== null) {
-            this.api.interceptors.request.eject(this.requestLoggerId);
-        }
-        return this;
-    };
-    /**
-     * Set the authorization token that will be used for Verdocs API calls. This will also set the session metadata
-     * and notify any listeners of the new data.
-     *
-     * If this Endpoint will be used for non-default purposes (e.g. signing, or in an alternate environment) those
-     * settings should be made before calling this. Sessions are persisted to localStorage, and the environment and
-     * type become part of the storage key.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.setToken(accessToken);
-     * ```
-     */
-    VerdocsEndpoint.prototype.setToken = function (token) {
-        if (!token) {
-            return this.clearSession();
-        }
-        var session = decodeAccessTokenBody(token);
-        if (session === null || (session.exp && session.exp * 1000 < new Date().getTime())) {
-            window.console.warn('[JS_SDK] Ignoring attempt to use expired session token');
-            return this.clearSession();
-        }
-        this.token = token;
-        this.session = session;
-        if (this.sessionType === 'user') {
-            this.api.defaults.headers.common.Authorization = "Bearer ".concat(token);
-        }
-        else {
-            this.api.defaults.headers.common.signer = "Bearer ".concat(token);
-        }
-        localStorage.setItem(this.sessionStorageKey(), token);
-        this.notifySessionListeners();
-        return this;
-    };
-    /**
-     * Retrieves the current session token, if any. Tokens should rarely be used for direct actions, but this is
-     * required by the `<VerdocsView>` and other components to authorize requests to raw PDF files.
-     */
-    VerdocsEndpoint.prototype.getToken = function () {
-        return this.token;
-    };
-    VerdocsEndpoint.prototype.sessionStorageKey = function () {
-        return "verdocs-session-".concat(this.getSessionType(), "-").concat(this.getEnvironment());
-    };
-    /**
-     * Clear the active session.
-     */
-    VerdocsEndpoint.prototype.clearSession = function () {
-        localStorage.removeItem(this.sessionStorageKey());
-        delete this.api.defaults.headers.common.Authorization;
-        delete this.api.defaults.headers.common.signer;
-        this.session = null;
-        this.token = null;
-        this.notifySessionListeners();
-        return this;
-    };
-    /**
-     * Clear the active signing session.
-     */
-    VerdocsEndpoint.prototype.clearSignerSession = function () {
-        localStorage.removeItem(this.sessionStorageKey());
-        delete this.api.defaults.headers.common.Authorization;
-        this.session = null;
-        this.token = null;
-        this.notifySessionListeners();
-        return this;
-    };
-    VerdocsEndpoint.prototype.notifySessionListeners = function () {
-        var _this = this;
-        this.sessionListeners.forEach(function (listener) {
-            try {
-                listener(_this, _this.session);
-            }
-            catch (e) {
-                // NOOP
-            }
-        });
-    };
-    /**
-     * Subscribe to session state change events.
-     */
-    VerdocsEndpoint.prototype.onSessionChanged = function (listener) {
-        var _this = this;
-        // There's no value in randomizing this, a simple counter is fine
-        this.nextListenerId++;
-        var listenerSymbol = Symbol.for('' + this.nextListenerId);
-        this.sessionListeners.set(listenerSymbol, listener);
-        return function () {
-            _this.sessionListeners.delete(listenerSymbol);
-        };
-    };
-    /**
-     * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
-     * or component starts.
-     */
-    VerdocsEndpoint.prototype.loadSession = function () {
-        var token = localStorage.getItem(this.sessionStorageKey());
-        if (!token) {
-            return this.clearSession();
-        }
-        return this.setToken(token);
-    };
-    return VerdocsEndpoint;
-}());
-export { VerdocsEndpoint };

package/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * Verdocs functions are organized into high-level modules that represent the main objects within Verdocs:
- *
- * - Envelopes - An individual document to be signed. Documents are created from templates.
- * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
- * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
- * - Users - All operations related to authentication and user-related operations.
- * - Utils - General support functions used by the other modules and exported for convenience.
- *
- * @module
- */
-export * as Envelopes from './Envelopes';
-export * as Organizations from './Organizations';
-export * as Sessions from './Sessions';
-export * as Templates from './Templates';
-export * as Users from './Users';
-export * as Utils from './Utils';
-export * from './VerdocsEndpoint';

package/index.js

@@ -1,18 +0,0 @@
-/**
- * Verdocs functions are organized into high-level modules that represent the main objects within Verdocs:
- *
- * - Envelopes - An individual document to be signed. Documents are created from templates.
- * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
- * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
- * - Users - All operations related to authentication and user-related operations.
- * - Utils - General support functions used by the other modules and exported for convenience.
- *
- * @module
- */
-export * as Envelopes from './Envelopes';
-export * as Organizations from './Organizations';
-export * as Sessions from './Sessions';
-export * as Templates from './Templates';
-export * as Users from './Users';
-export * as Utils from './Utils';
-export * from './VerdocsEndpoint';

package/tsconfig-typedoc.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "module": "esnext",
-    "lib": ["es2017", "es7", "es6", "dom"],
-    "declaration": true,
-    "allowJs": true,
-    "outDir": "./",
-    "strict": true,
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-    "jsx": "react",
-    "jsxFactory": "JSX.createElement",
-    "jsxFragmentFactory": "JSX.Fragment"
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "dist", "**/__tests__/*"],
-  "typedocOptions": {
-    "entryPoints": ["src/index.ts"],
-    "out": "docs",
-    "includeVersion": true,
-    "gitRevision": "main",
-    "hideGenerator": true,
-    "excludePrivate": true
-  }
-}