@verdocs/js-sdk 1.4.0 → 2.0.1

package/Users/Auth.js

@@ -1,5 +1,3 @@
-import { getEndpoint } from '../HTTP/Transport';
-import { decodeAccessTokenBody } from '../Utils/Token';
 /**
  * Authenticate to Verdocs via user/password authentication
  *
@@ -11,9 +9,9 @@ import { decodeAccessTokenBody } from '../Utils/Token';
  * Transport.setAuthToken(accessToken);
  * ```
  */
-export var authenticateUser = function (params) {
-    return getEndpoint()
-        .api.post('/authentication/login', params)
+export var authenticateUser = function (endpoint, params) {
+    return endpoint.api //
+        .post('/authentication/login', params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -31,9 +29,9 @@ export var authenticateUser = function (params) {
  * Transport.setAuthToken(accessToken);
  * ```
  */
-export var authenticateApp = function (params) {
-    return getEndpoint()
-        .api.post('/authentication/login_client', {}, { headers: params })
+export var authenticateApp = function (endpoint, params) {
+    return endpoint.api //
+        .post('/authentication/login_client', {}, { headers: params })
         .then(function (r) { return r.data; });
 };
 /**
@@ -50,9 +48,9 @@ export var authenticateApp = function (params) {
  * }
  * ```
  */
-export var validateToken = function (params) {
-    return getEndpoint()
-        .api.post('/token/isValid', params)
+export var validateToken = function (endpoint, params) {
+    return endpoint.api //
+        .post('/token/isValid', params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -66,9 +64,9 @@ export var validateToken = function (params) {
  * Transport.setAuthToken(accessToken);
  * ```
  */
-export var refreshTokens = function () {
-    return getEndpoint()
-        .api.get('/token')
+export var refreshTokens = function (endpoint) {
+    return endpoint.api //
+        .get('/token')
         .then(function (r) { return r.data; });
 };
 /**
@@ -83,9 +81,9 @@ export var refreshTokens = function () {
  * }
  * ```
  */
-export var updatePassword = function (params) {
-    return getEndpoint()
-        .api.put('/user/update_password', params)
+export var updatePassword = function (endpoint, params) {
+    return endpoint.api //
+        .put('/user/update_password', params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -97,86 +95,8 @@ export var updatePassword = function (params) {
  * const {profiles} = await Auth.updateEmail({ email: newEmail });
  * ```
  */
-export var updateEmail = function (params) {
-    return getEndpoint()
-        .api.put('/user/update_email', params)
+export var updateEmail = function (endpoint, params) {
+    return endpoint.api //
+        .put('/user/update_email', params)
         .then(function (r) { return r.data; });
 };
-var clearSession = function (source, persist) {
-    getEndpoint().setAuthorization(null);
-    if (persist) {
-        localStorage.removeItem(source);
-    }
-    notifySessionListeners(source, null);
-    return null;
-};
-/**
- * Parses and sets the active session, optionally persisting (brower-only, persists to localStorage).
- */
-export var setSession = function (source, token, persist) {
-    if (persist === void 0) { persist = false; }
-    if (token === null) {
-        return clearSession(source, persist);
-    }
-    var session = decodeAccessTokenBody(token || '');
-    if (session === null || (session.exp && session.exp * 1000 < new Date().getTime())) {
-        return clearSession(source, persist);
-    }
-    if (persist) {
-        localStorage.setItem(source, token);
-    }
-    getEndpoint().setAuthorization(token);
-    notifySessionListeners(source, session);
-    return session;
-};
-/**
- * Load a session from localStorage
- */
-export var loadSession = function (source) {
-    var token = localStorage.getItem(source);
-    if (!token) {
-        return null;
-    }
-    var session = decodeAccessTokenBody(token);
-    if (!session) {
-        return null;
-    }
-    if (session.exp && session.exp * 1000 < new Date().getTime()) {
-        localStorage.removeItem(source);
-        return null;
-    }
-    getEndpoint().setAuthorization(token);
-    notifySessionListeners(source, session);
-    return session;
-};
-/**
- * End the active session.
- */
-export var endSession = function (source, persist) {
-    if (persist === void 0) { persist = false; }
-    return clearSession(source, persist);
-};
-var sessionChangedListeners = new Map();
-var nextListenerId = 1;
-/**
- * Subscribe to session state change events.
- */
-export var onSessionChanged = function (listener) {
-    // There's no value in randomizing this so we don't
-    var listenerId = ++nextListenerId;
-    var listenerSymbol = Symbol.for('' + listenerId);
-    sessionChangedListeners.set(listenerSymbol, listener);
-    return function () {
-        sessionChangedListeners.delete(listenerSymbol);
-    };
-};
-var notifySessionListeners = function (source, session) {
-    sessionChangedListeners.forEach(function (listener) {
-        try {
-            listener(source, session);
-        }
-        catch (e) {
-            // NOOP
-        }
-    });
-};

package/Users/Billing.d.ts

@@ -1 +1 @@
-export {};
+export declare const billingPlaceholder: {};

package/Users/Billing.js

@@ -1,2 +1,2 @@
-export {};
 // TODO
+export var billingPlaceholder = {};

package/Users/Notifications.d.ts

@@ -1 +1,2 @@
-export declare const getNotifications: () => Promise<any>;
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
+export declare const getNotifications: (endpoint: VerdocsEndpoint) => Promise<any>;

package/Users/Notifications.js

@@ -34,11 +34,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { getEndpoint } from '../HTTP/Transport';
-export var getNotifications = function () { return __awaiter(void 0, void 0, void 0, function () {
+export var getNotifications = function (endpoint) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
-        return [2 /*return*/, getEndpoint()
-                .api.get('/notifications')
+        return [2 /*return*/, endpoint.api //
+                .get('/notifications')
                 .then(function (r) { return r.data; })];
     });
 }); };

package/Users/Profiles.d.ts

@@ -1,4 +1,5 @@
 import { ICreateProfileRequest, IUpdateProfileRequest } from './Types';
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
 /**
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
@@ -8,7 +9,7 @@ import { ICreateProfileRequest, IUpdateProfileRequest } from './Types';
  * const profiles = await Profiles.getProfiles()
  * ```
  */
-export declare const getProfiles: () => Promise<any>;
+export declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<any>;
 /**
  * Get a list of system roles.
  *
@@ -18,7 +19,7 @@ export declare const getProfiles: () => Promise<any>;
  * const roles = await Profiles.getRoles();
  * ```
  */
-export declare const getRoles: () => Promise<any>;
+export declare const getRoles: (endpoint: VerdocsEndpoint) => Promise<any>;
 /**
  * Get a list of system roles.
  *
@@ -28,7 +29,7 @@ export declare const getRoles: () => Promise<any>;
  * const permissions = await Profiles.getPermissions();
  * ```
  */
-export declare const getPermissions: () => Promise<any>;
+export declare const getPermissions: (endpoint: VerdocsEndpoint) => Promise<any>;
 /**
  * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
  *
@@ -38,7 +39,7 @@ export declare const getPermissions: () => Promise<any>;
  * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
  * ```
  */
-export declare const createProfile: (params: ICreateProfileRequest) => Promise<any>;
+export declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateProfileRequest) => Promise<any>;
 /**
  * Get a profile. The caller must have admin access to the given profile.
  * TODO: Add a "public" profile endpoint for public pages
@@ -49,7 +50,7 @@ export declare const createProfile: (params: ICreateProfileRequest) => Promise<a
  * const profile = await Profiles.getProfile('PROFILEID');
  * ```
  */
-export declare const getProfile: (profileId: string) => Promise<any>;
+export declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
 /**
  * Get a profile's permissions. The caller must have admin access to the given profile.
  *
@@ -59,7 +60,7 @@ export declare const getProfile: (profileId: string) => Promise<any>;
  * const permissions = await Profiles.getProfilePermissions('PROFILEID');
  * ```
  */
-export declare const getProfilePermissions: (profileId: string) => Promise<any>;
+export declare const getProfilePermissions: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
 /**
  * Get a profile's groups.
  *
@@ -69,7 +70,7 @@ export declare const getProfilePermissions: (profileId: string) => Promise<any>;
  * const groups = await Profiles.getProfileGroups('PROFILEID');
  * ```
  */
-export declare const getProfileGroups: (profileId: string) => Promise<any>;
+export declare const getProfileGroups: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
 /**
  * Switch the caller's "current" profile. The current profile is used for permissions checking and profile_id field settings
  * for most operations in Verdocs. It is important to select the appropropriate profile before calling other API functions.
@@ -80,7 +81,7 @@ export declare const getProfileGroups: (profileId: string) => Promise<any>;
  * const newProfile = await Profiles.switchProfile('PROFILEID');
  * ```
  */
-export declare const switchProfile: (profileId: string) => Promise<any>;
+export declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
 /**
  * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
  * "current" profile for the caller.
@@ -91,7 +92,7 @@ export declare const switchProfile: (profileId: string) => Promise<any>;
  * const newProfile = await Profiles.updateProfile('PROFILEID');
  * ```
  */
-export declare const updateProfile: (profileId: string, params: IUpdateProfileRequest) => Promise<any>;
+export declare const updateProfile: (endpoint: VerdocsEndpoint, profileId: string, params: IUpdateProfileRequest) => Promise<any>;
 /**
  * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
  *
@@ -101,4 +102,4 @@ export declare const updateProfile: (profileId: string, params: IUpdateProfileRe
  * await Profiles.deleteProfile('PROFILEID');
  * ```
  */
-export declare const deleteProfile: (profileId: string) => Promise<any>;
+export declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;

package/Users/Profiles.js

@@ -1,4 +1,3 @@
-import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
@@ -8,9 +7,9 @@ import { getEndpoint } from '../HTTP/Transport';
  * const profiles = await Profiles.getProfiles()
  * ```
  */
-export var getProfiles = function () {
-    return getEndpoint()
-        .api.get('/profiles')
+export var getProfiles = function (endpoint) {
+    return endpoint.api //
+        .get('/profiles')
         .then(function (r) { return r.data; });
 };
 /**
@@ -22,9 +21,9 @@ export var getProfiles = function () {
  * const roles = await Profiles.getRoles();
  * ```
  */
-export var getRoles = function () {
-    return getEndpoint()
-        .api.get('/roles')
+export var getRoles = function (endpoint) {
+    return endpoint.api //
+        .get('/roles')
         .then(function (r) { return r.data; });
 };
 /**
@@ -36,9 +35,9 @@ export var getRoles = function () {
  * const permissions = await Profiles.getPermissions();
  * ```
  */
-export var getPermissions = function () {
-    return getEndpoint()
-        .api.get('/permissions')
+export var getPermissions = function (endpoint) {
+    return endpoint.api //
+        .get('/permissions')
         .then(function (r) { return r.data; });
 };
 /**
@@ -50,9 +49,9 @@ export var getPermissions = function () {
  * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
  * ```
  */
-export var createProfile = function (params) {
-    return getEndpoint()
-        .api.post('/profiles', params)
+export var createProfile = function (endpoint, params) {
+    return endpoint.api //
+        .post('/profiles', params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -65,9 +64,9 @@ export var createProfile = function (params) {
  * const profile = await Profiles.getProfile('PROFILEID');
  * ```
  */
-export var getProfile = function (profileId) {
-    return getEndpoint()
-        .api.get("/profiles/".concat(profileId))
+export var getProfile = function (endpoint, profileId) {
+    return endpoint.api //
+        .get("/profiles/".concat(profileId))
         .then(function (r) { return r.data; });
 };
 /**
@@ -79,9 +78,9 @@ export var getProfile = function (profileId) {
  * const permissions = await Profiles.getProfilePermissions('PROFILEID');
  * ```
  */
-export var getProfilePermissions = function (profileId) {
-    return getEndpoint()
-        .api.get("/profiles/".concat(profileId, "/permissions"))
+export var getProfilePermissions = function (endpoint, profileId) {
+    return endpoint.api //
+        .get("/profiles/".concat(profileId, "/permissions"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -93,9 +92,9 @@ export var getProfilePermissions = function (profileId) {
  * const groups = await Profiles.getProfileGroups('PROFILEID');
  * ```
  */
-export var getProfileGroups = function (profileId) {
-    return getEndpoint()
-        .api.get("/profiles/".concat(profileId, "/groups"))
+export var getProfileGroups = function (endpoint, profileId) {
+    return endpoint.api //
+        .get("/profiles/".concat(profileId, "/groups"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -108,9 +107,9 @@ export var getProfileGroups = function (profileId) {
  * const newProfile = await Profiles.switchProfile('PROFILEID');
  * ```
  */
-export var switchProfile = function (profileId) {
-    return getEndpoint()
-        .api.post("/profiles/".concat(profileId, "/switch"))
+export var switchProfile = function (endpoint, profileId) {
+    return endpoint.api //
+        .post("/profiles/".concat(profileId, "/switch"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -123,9 +122,9 @@ export var switchProfile = function (profileId) {
  * const newProfile = await Profiles.updateProfile('PROFILEID');
  * ```
  */
-export var updateProfile = function (profileId, params) {
-    return getEndpoint()
-        .api.put("/profiles/".concat(profileId), params)
+export var updateProfile = function (endpoint, profileId, params) {
+    return endpoint.api //
+        .put("/profiles/".concat(profileId), params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -137,8 +136,8 @@ export var updateProfile = function (profileId, params) {
  * await Profiles.deleteProfile('PROFILEID');
  * ```
  */
-export var deleteProfile = function (profileId) {
-    return getEndpoint()
-        .api.delete("/profiles/".concat(profileId))
+export var deleteProfile = function (endpoint, profileId) {
+    return endpoint.api //
+        .delete("/profiles/".concat(profileId))
         .then(function (r) { return r.data; });
 };

package/Users/Types.d.ts

@@ -1,5 +1,5 @@
 import { IGroup, IOrganization } from '../Organizations/Types';
-import { TRequestStatus } from '../HTTP/Types';
+export declare type TRequestStatus = 'OK' | 'ERROR';
 /**
  * An operation within Verdocs the user may perform.
  */

package/Utils/Token.d.ts

@@ -9,7 +9,7 @@ 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 decodeTokenBody: (token: string) => any;
+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

package/Utils/Token.js

@@ -38,7 +38,7 @@ export var AtoB = function (str) {
  * 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 decodeTokenBody = function (token) { return JSON.parse(AtoB((token || '').split('.')[1] || '')); };
+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
@@ -49,7 +49,7 @@ export var decodeTokenBody = function (token) { return JSON.parse(AtoB((token ||
 export var decodeAccessTokenBody = function (token) {
     var decoded;
     try {
-        decoded = decodeTokenBody(token);
+        decoded = decodeJWTBody(token);
         if (decoded === null) {
             return null;
         }

package/VerdocsEndpoint.d.ts

@@ -0,0 +1,193 @@
+import { AxiosInstance } from 'axios';
+import { ISigningSession } from './Documents/Types';
+import { IActiveSession } from './Users/Types';
+import * as Documents from './Documents';
+export declare type TEnvironment = 'verdocs' | 'verdocs-stage';
+export declare type TSessionType = 'user' | 'signing';
+export declare type TSession = IActiveSession | ISigningSession | null;
+export declare type SessionChangedListener = (endpoint: VerdocsEndpoint, session: IActiveSession | ISigningSession | null) => 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(5000);
+ * ```
+ */
+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 Documents.
+     */
+    session: TSession;
+    api: AxiosInstance;
+    Documents: typeof Documents;
+    /**
+     * 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(): any;
+    /**
+     * 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. 2000-4000ms is recommended for most purposes. 3000ms is the default.
+     *
+     * ```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;
+    private sessionStorageKey;
+    /**
+     * Clear the active session.
+     */
+    clearSession(): this;
+    private notifySessionListeners;
+    /**
+     * Subscribe to session state change events.
+     */
+    onSessionChanged(listener: SessionChangedListener): () => void;
+    /**
+     * Load a persisted session from localStorage. Typically called once after the endpoint is configured when the app
+     * or component starts.
+     */
+    loadSession(): VerdocsEndpoint;
+}