@verdocs/js-sdk 3.10.30 → 4.0.1

package/Utils/Primitives.d.ts

@@ -1,18 +0,0 @@
-import { IProfile } from '../Users/Types';
-/**
- * Create an array containing a sequence of integers, e.g. [START, START+1, START+2, ...] This is frequently useful
- * in rendering operations when there is no source array to .map() across.
- */
-export declare const integerSequence: (start: number, count: number) => number[];
-/**
- * Format a profile's full name
- */
-export declare const formatFullName: (profile?: IProfile) => string;
-/**
- * Format a profile's initials
- */
-export declare const formatInitials: (profile?: IProfile) => string;
-/**
- * Generate suggested initials for a full name, e.g. "John Doe" will yield "JD".
- */
-export declare const fullNameToInitials: (name: string) => string;

package/Utils/Primitives.js

@@ -1,31 +0,0 @@
-import { capitalize } from './Strings';
-/**
- * Create an array containing a sequence of integers, e.g. [START, START+1, START+2, ...] This is frequently useful
- * in rendering operations when there is no source array to .map() across.
- */
-export var integerSequence = function (start, count) {
-    return Array(count)
-        .fill(1)
-        .map(function (_, index) { return index + start; });
-};
-/**
- * Format a profile's full name
- */
-export var formatFullName = function (profile) {
-    return profile ? "".concat(capitalize(profile.first_name), " ").concat(capitalize(profile.last_name)) : 'Invalid User';
-};
-/**
- * Format a profile's initials
- */
-export var formatInitials = function (profile) {
-    return profile ? "".concat(capitalize(profile.first_name).charAt(0), " ").concat(capitalize(profile.last_name).charAt(0)) : '--';
-};
-/**
- * Generate suggested initials for a full name, e.g. "John Doe" will yield "JD".
- */
-export var fullNameToInitials = function (name) {
-    return name
-        .split(' ')
-        .map(function (word) { return word[0]; })
-        .join('');
-};

package/Utils/Strings.d.ts

@@ -1,9 +0,0 @@
-/**
- * Capitalize the first letter of a string.
- */
-export declare const capitalize: (str: string) => string;
-/**
- * Convert a phone-number-like string to E164 format.
- * @see https://46elks.com/kb/e164
- */
-export declare const convertToE164: (input: string) => string;

package/Utils/Strings.js

@@ -1,28 +0,0 @@
-/**
- * Capitalize the first letter of a string.
- */
-export var capitalize = function (str) { return str.charAt(0).toUpperCase() + str.slice(1); };
-/**
- * Convert a phone-number-like string to E164 format.
- * @see https://46elks.com/kb/e164
- */
-export var convertToE164 = function (input) {
-    // "(212) 555-1212" => +12125551212
-    // "+46766861004" => "+46766861004"
-    // "212-555-1212" => +12125551212
-    // "212.555.1212" => +12125551212
-    // "212 555 1212" => +12125551212
-    var temp = (input || '').trim();
-    // If we are already prefixed, assume the user did it deliberately and attempt to use what they entered. We also short-circuit blanks.
-    if (!temp || temp.startsWith('+')) {
-        return temp;
-    }
-    // Remove any spaces, parenthesis or other punctuation.
-    temp = temp.replace(/[^0-9]/g, '');
-    // If the number begins with a zero, remove the leading zero. Do not combine this with the previous step because it needs to be removed
-    // whether it's the actual first character e.g. `0(5)` or just the first digit e.g. `(05`.
-    temp = temp.replace(/^0/g, '');
-    // Prepend the country code and +. We're assuming US in this case given the target demographic. Users in other countries would/should be
-    // already entering a prefix so they'd shortcut out of this routine via the + prefix check.
-    return "+1".concat(temp);
-};

package/Utils/Token.d.ts

@@ -1,19 +0,0 @@
-import { TSession } from '../Sessions/Types';
-/**
- * Simplified, Node/Browser-safe alternative to atob() for base64 decoding.
- * Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js
- */
-export declare const AtoB: (str: string) => string;
-/**
- * Decode the body of a JWT. This helper may allow front-end applications to avoid a dependency on `jsonwebtoken` in
- * many cases. Note that this should only be used for true JWTs. Opaque tokens will cause this to throw.
- */
-export declare const decodeJWTBody: (token: string) => any;
-/**
- * Decode the body of an Verdocs access token. Note that raw tokens contain namespaced fields, e.g.
- * `https://verdocs.com/profile_id`. To make these tokens easier to use in front-end code, this name-spacing
- * will be removed. Note that user and signing sessions have different access token formats. The calling
- * application should distinguish between the two based on the context of the authenticated session, or by
- * the presence of the `document_id` field, which will only be present for signing sessions.
- */
-export declare const decodeAccessTokenBody: (token: string) => TSession;

package/Utils/Token.js

@@ -1,67 +0,0 @@
-/* tslint:disable:no-bitwise */
-var b64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
-// Regular expression to check formal correctness of base64 encoded strings
-var b64re = /^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/;
-/**
- * Simplified, Node/Browser-safe alternative to atob() for base64 decoding.
- * Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js
- */
-export var AtoB = function (str) {
-    // atob can work with strings with whitespaces, even inside the encoded part,
-    // but only \t, \n, \f, \r and ' ', which can be stripped.
-    str = String(str).replace(/[\t\n\f\r ]+/g, '');
-    if (!b64re.test(str))
-        throw new TypeError("Failed to execute 'atob' on 'Window': The string to be decoded is not correctly encoded.");
-    // Adding the padding if missing, for semplicity
-    str += '=='.slice(2 - (str.length & 3));
-    var bitmap;
-    var result = '';
-    var r1;
-    var r2;
-    var i = 0;
-    for (; i < str.length;) {
-        bitmap =
-            (b64.indexOf(str.charAt(i++)) << 18) |
-                (b64.indexOf(str.charAt(i++)) << 12) |
-                ((r1 = b64.indexOf(str.charAt(i++))) << 6) |
-                (r2 = b64.indexOf(str.charAt(i++)));
-        result +=
-            r1 === 64
-                ? String.fromCharCode((bitmap >> 16) & 255)
-                : r2 === 64
-                    ? String.fromCharCode((bitmap >> 16) & 255, (bitmap >> 8) & 255)
-                    : String.fromCharCode((bitmap >> 16) & 255, (bitmap >> 8) & 255, bitmap & 255);
-    }
-    return result;
-};
-/**
- * Decode the body of a JWT. This helper may allow front-end applications to avoid a dependency on `jsonwebtoken` in
- * many cases. Note that this should only be used for true JWTs. Opaque tokens will cause this to throw.
- */
-export var decodeJWTBody = function (token) { return JSON.parse(AtoB((token || '').split('.')[1] || '')); };
-/**
- * Decode the body of an Verdocs access token. Note that raw tokens contain namespaced fields, e.g.
- * `https://verdocs.com/profile_id`. To make these tokens easier to use in front-end code, this name-spacing
- * will be removed. Note that user and signing sessions have different access token formats. The calling
- * application should distinguish between the two based on the context of the authenticated session, or by
- * the presence of the `document_id` field, which will only be present for signing sessions.
- */
-export var decodeAccessTokenBody = function (token) {
-    var decoded;
-    try {
-        decoded = decodeJWTBody(token);
-        if (decoded === null) {
-            return null;
-        }
-    }
-    catch (e) {
-        return null;
-    }
-    Object.keys(decoded).forEach(function (key) {
-        if (typeof key === 'string' && key.startsWith('https://verdocs.com/')) {
-            decoded[key.replace('https://verdocs.com/', '')] = decoded[key];
-            delete decoded[key];
-        }
-    });
-    return decoded;
-};

package/Utils/globalThis.d.ts

@@ -1,2 +0,0 @@
-declare const _exports: any;
-export = _exports;

package/Utils/globalThis.js

@@ -1,52 +0,0 @@
-"use strict";
-// This file provides a polyfill for managing globals in both NodeJS and browser environments. This is
-// an anti-pattern we'd hoped to avoid, but we have several projects dependending on one common library
-// (this js-sdk) and we want that library to provide a common endpoint to all callers (so authentication
-// tokens only need to be tracked in one place). The trouble is, one of those libraries is based on
-// StencilJS and is compiling its modules into Web Components. Because of how module resolution works,
-// when those Components load js-sdk they get a separate instance. Without messy options like having to
-// pass raw data from the caller to each Component, or pass around references to a common Endpoint, they
-// have no way to access authenticated sessions unless we make the Endpoint a true global.
-//
-// @credit https://github.com/medikoo/es5-ext/blob/master/global.js
-// @credit https://mathiasbynens.be/notes/globalthis
-var naiveFallback = function () {
-    if (typeof self === 'object' && self)
-        return self;
-    if (typeof window === 'object' && window)
-        return window;
-    throw new Error('Unable to resolve global `this`');
-};
-module.exports = (function () {
-    if (this)
-        return this;
-    // Unexpected strict mode (may happen if e.g. bundled into ESM module)
-    // Fallback to standard globalThis if available
-    if (typeof globalThis === 'object' && globalThis)
-        return globalThis;
-    // Thanks @mathiasbynens -> https://mathiasbynens.be/notes/globalthis
-    // In all ES5+ engines global object inherits from Object.prototype
-    // (if you approached one that doesn't please report)
-    try {
-        Object.defineProperty(Object.prototype, '__global__', {
-            get: function () {
-                return this;
-            },
-            configurable: true,
-        });
-    }
-    catch (error) {
-        // Unfortunate case of updates to Object.prototype being restricted
-        // via preventExtensions, seal or freeze
-        return naiveFallback();
-    }
-    try {
-        // Safari case (window.__global__ works, but __global__ does not)
-        if (!__global__)
-            return naiveFallback();
-        return __global__;
-    }
-    finally {
-        delete Object.prototype.__global__;
-    }
-})();

package/Utils/index.d.ts

@@ -1,8 +0,0 @@
-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 Primitives from './Primitives';
-export * as Strings from './Strings';
-export * as Token from './Token';

package/Utils/index.js

@@ -1,8 +0,0 @@
-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 Primitives from './Primitives';
-export * as Strings from './Strings';
-export * as Token from './Token';

package/VerdocsEndpoint.d.ts

@@ -1,199 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { TSession, TSessionType } from './Sessions/Types';
-export type TEnvironment = 'verdocs' | 'verdocs-stage';
-export type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
-export interface VerdocsEndpointOptions {
-    baseURL?: string;
-    timeout?: number;
-    environment?: TEnvironment;
-    sessionType?: TSessionType;
-    clientID?: string;
-}
-/**
- * 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);
- * ```
- */
-export declare class VerdocsEndpoint {
-    private environment;
-    private sessionType;
-    private baseURL;
-    private clientID;
-    private timeout;
-    private token;
-    private nextListenerId;
-    private sessionListeners;
-    private requestLoggerId;
-    /**
-     * 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.
-     */
-    session: TSession;
-    api: AxiosInstance;
-    /**
-     * Create a new VerdocsEndpoint to call Verdocs platform services.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     * const endpoint = new VerdocsEndpoint();
-     * ```
-     */
-    constructor(options?: VerdocsEndpointOptions);
-    setDefault(): void;
-    static getDefault(): VerdocsEndpoint;
-    /**
-     * Get the current environment.
-     */
-    getEnvironment(): TEnvironment;
-    /**
-     * Get the current session type.
-     */
-    getSessionType(): TSessionType;
-    /**
-     * Get the current base URL. This should rarely be anything other than 'https://api.verdocs.com'.
-     */
-    getBaseURL(): string;
-    /**
-     * Get the current client ID, if set.
-     */
-    getClientID(): string;
-    /**
-     * Get the current timeout.
-     */
-    getTimeout(): number;
-    /**
-     * Get the current session, if any.
-     */
-    getSession(): TSession;
-    /**
-     * 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');
-     * ```
-     */
-    setEnvironment(environment: TEnvironment): VerdocsEndpoint;
-    /**
-     * 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');
-     * ```
-     */
-    setSessionType(sessionType: TSessionType): VerdocsEndpoint;
-    /**
-     * 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');
-     * ```
-     */
-    setBaseURL(url: string): VerdocsEndpoint;
-    /**
-     * Set the Client ID for Verdocs API calls.
-     *
-     * ```typescript
-     * import {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.setClientID('1234);
-     * ```
-     */
-    setClientID(clientID: string): VerdocsEndpoint;
-    /**
-     * 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);
-     * ```
-     */
-    setTimeout(timeout: number): 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 {VerdocsEndpoint} from '@verdocs/js-sdk/HTTP';
-     *
-     * const endpoint = new VerdocsEndpoint();
-     * endpoint.logRequests(true);
-     * ```
-     */
-    logRequests(enable: boolean): VerdocsEndpoint;
-    /**
-     * 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);
-     * ```
-     */
-    setToken(token: string | null): VerdocsEndpoint;
-    /**
-     * 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.
-     */
-    getToken(): string | null;
-    private sessionStorageKey;
-    /**
-     * Clear the active session.
-     */
-    clearSession(): this;
-    /**
-     * Clear the active signing session.
-     */
-    clearSignerSession(): this;
-    private notifySessionListeners;
-    /**
-     * Subscribe to session state change events.
-     */
-    onSessionChanged(listener: TSessionChangedListener): () => void;
-    /**
-     * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
-     * or component starts.
-     */
-    loadSession(): VerdocsEndpoint;
-}