@verdocs/js-sdk 1.0.22 → 1.0.27

package/Documents/Signatures.js

@@ -11,11 +11,11 @@ export var getSignatures = function () {
 };
 export var getSignature = function (signatureId) {
     return getEndpoint()
-        .get("/signatures/" + signatureId)
+        .get("/signatures/".concat(signatureId))
         .then(function (r) { return r.data; });
 };
 export var deleteSignature = function (signatureId) {
     return getEndpoint()
-        .delete("/signatures/" + signatureId)
+        .delete("/signatures/".concat(signatureId))
         .then(function (r) { return r.data; });
 };

package/Documents/Stars.js

@@ -36,5 +36,5 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 import { getEndpoint } from '../HTTP/Transport';
 export var toggleStar = function (templateId) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, getEndpoint().post("/templates/" + templateId + "/stars/toggle").then(function (r) { return r.data; })];
+    return [2 /*return*/, getEndpoint().post("/templates/".concat(templateId, "/stars/toggle")).then(function (r) { return r.data; })];
 }); }); };

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
  */
@@ -20,7 +21,7 @@ if (!globalThis[ENDPOINT_KEY]) {
 var endpoint = globalThis[ENDPOINT_KEY];
 var requestLogger = function (r) {
     // tslint:disable-next-line
-    console.log("[JS-SDK] " + r.method.toUpperCase() + " " + r.baseURL + r.url, r.data ? JSON.stringify(r.data) : '');
+    console.log("[JS-SDK] ".concat(r.method.toUpperCase(), " ").concat(r.baseURL).concat(r.url), r.data ? JSON.stringify(r.data) : '');
     return r;
 };
 /**
@@ -34,7 +35,7 @@ var requestLogger = function (r) {
  */
 export var setAuthorization = function (accessToken) {
     if (accessToken) {
-        endpoint.defaults.headers.Authorization = "Bearer " + accessToken;
+        endpoint.defaults.headers.Authorization = "Bearer ".concat(accessToken);
     }
     else {
         delete endpoint.defaults.headers.Authorization;

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/Organizations/ApiKeys.js

@@ -22,7 +22,7 @@ import { getEndpoint } from '../HTTP/Transport';
  */
 export var getKeys = function (organizationId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/api_key")
+        .get("/organizations/".concat(organizationId, "/api_key"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -36,7 +36,7 @@ export var getKeys = function (organizationId) {
  */
 export var createKey = function (organizationId, params) {
     return getEndpoint()
-        .post("/organizations/" + organizationId + "/api_key", params)
+        .post("/organizations/".concat(organizationId, "/api_key"), params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -50,7 +50,7 @@ export var createKey = function (organizationId, params) {
  */
 export var rotateKey = function (organizationId, clientId) {
     return getEndpoint()
-        .put("/organizations/" + organizationId + "/api_key/" + clientId + "/rotate")
+        .put("/organizations/".concat(organizationId, "/api_key/").concat(clientId, "/rotate"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -64,7 +64,7 @@ export var rotateKey = function (organizationId, clientId) {
  */
 export var updateKey = function (organizationId, clientId, params) {
     return getEndpoint()
-        .patch("/organizations/" + organizationId + "/api_key/" + clientId, params)
+        .patch("/organizations/".concat(organizationId, "/api_key/").concat(clientId), params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -78,6 +78,6 @@ export var updateKey = function (organizationId, clientId, params) {
  */
 export var deleteKey = function (organizationId, clientId) {
     return getEndpoint()
-        .delete("/organizations/" + organizationId + "/api_key/" + clientId)
+        .delete("/organizations/".concat(organizationId, "/api_key/").concat(clientId))
         .then(function (r) { return r.data; });
 };

package/Organizations/Groups.js

@@ -19,7 +19,7 @@ import { getEndpoint } from '../HTTP/Transport';
  */
 export var getGroups = function (organizationId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/groups")
+        .get("/organizations/".concat(organizationId, "/groups"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -33,31 +33,31 @@ export var getGroups = function (organizationId) {
  */
 export var getGroup = function (organizationId, groupId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/groups/" + groupId)
+        .get("/organizations/".concat(organizationId, "/groups/").concat(groupId))
         .then(function (r) { return r.data; });
 };
 export var getMembers = function (organizationId, groupId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/groups/" + groupId + "/members")
+        .get("/organizations/".concat(organizationId, "/groups/").concat(groupId, "/members"))
         .then(function (r) { return r.data; });
 };
 export var addMembers = function (organizationId, groupId, params) {
     return getEndpoint()
-        .post("/organizations/" + organizationId + "/groups/" + groupId + "/members", params)
+        .post("/organizations/".concat(organizationId, "/groups/").concat(groupId, "/members"), params)
         .then(function (r) { return r.data; });
 };
 export var deleteMembers = function (organizationId, groupId, params) {
     return getEndpoint()
-        .put("/organizations/" + organizationId + "/groups/" + groupId + "/delete_members", params)
+        .put("/organizations/".concat(organizationId, "/groups/").concat(groupId, "/delete_members"), params)
         .then(function (r) { return r.data; });
 };
 export var addPermission = function (organizationId, groupId, permissionId, params) {
     return getEndpoint()
-        .post("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId, params)
+        .post("/organizations/".concat(organizationId, "/groups/").concat(groupId, "/permissions/").concat(permissionId), params)
         .then(function (r) { return r.data; });
 };
 export var deletePermission = function (organizationId, groupId, permissionId) {
     return getEndpoint()
-        .delete("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId)
+        .delete("/organizations/".concat(organizationId, "/groups/").concat(groupId, "/permissions/").concat(permissionId))
         .then(function (r) { return r.data; });
 };

package/Organizations/Invitations.js

@@ -6,36 +6,36 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var getInvitations = function (organizationId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/invitation")
+        .get("/organizations/".concat(organizationId, "/invitation"))
         .then(function (r) { return r.data; });
 };
 export var createInvitation = function (organizationId, params) {
     return getEndpoint()
-        .post("/organizations/" + organizationId + "/invitation", params)
+        .post("/organizations/".concat(organizationId, "/invitation"), params)
         .then(function (r) { return r.data; });
 };
 export var deleteInvitation = function (organizationId, email) {
     return getEndpoint()
-        .delete("/organizations/" + organizationId + "/invitation/" + email)
+        .delete("/organizations/".concat(organizationId, "/invitation/").concat(email))
         .then(function (r) { return r.data; });
 };
 export var updateInvitation = function (organizationId, email, params) {
     return getEndpoint()
-        .patch("/organizations/" + organizationId + "/invitation/" + email, params)
+        .patch("/organizations/".concat(organizationId, "/invitation/").concat(email), params)
         .then(function (r) { return r.data; });
 };
 export var resendInvitation = function (organizationId, email) {
     return getEndpoint()
-        .post("/organizations/" + organizationId + "/invitation/" + email + "/resend")
+        .post("/organizations/".concat(organizationId, "/invitation/").concat(email, "/resend"))
         .then(function (r) { return r.data; });
 };
 export var claimInvitation = function (organizationId, email, params) {
     return getEndpoint()
-        .put("/organizations/" + organizationId + "/invitation/" + email, params)
+        .put("/organizations/".concat(organizationId, "/invitation/").concat(email), params)
         .then(function (r) { return r.data; });
 };
 export var claimNewUser = function (organizationId, email, token) {
     return getEndpoint()
-        .put("/organizations/" + organizationId + "/invitation/" + email + "/token/" + token + "/new_user")
+        .put("/organizations/".concat(organizationId, "/invitation/").concat(email, "/token/").concat(token, "/new_user"))
         .then(function (r) { return r.data; });
 };

package/Organizations/Members.js

@@ -6,26 +6,26 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var getMembers = function (organizationId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/profiles")
+        .get("/organizations/".concat(organizationId, "/profiles"))
         .then(function (r) { return r.data; });
 };
 export var deleteMember = function (organizationId, profileId) {
     return getEndpoint()
-        .delete("/organizations/" + organizationId + "/profiles/" + profileId)
+        .delete("/organizations/".concat(organizationId, "/profiles/").concat(profileId))
         .then(function (r) { return r.data; });
 };
 export var addMemberRole = function (organizationId, profileId, roleId) {
     return getEndpoint()
-        .post("/organizations/" + organizationId + "/profiles/" + profileId + "/roles/" + roleId)
+        .post("/organizations/".concat(organizationId, "/profiles/").concat(profileId, "/roles/").concat(roleId))
         .then(function (r) { return r.data; });
 };
 export var deleteMemberRole = function (organizationId, profileId, roleId) {
     return getEndpoint()
-        .delete("/organizations/" + organizationId + "/profiles/" + profileId + "/roles/" + roleId)
+        .delete("/organizations/".concat(organizationId, "/profiles/").concat(profileId, "/roles/").concat(roleId))
         .then(function (r) { return r.data; });
 };
 export var getMemberPlans = function (organizationId, profileId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/profiles/" + profileId + "/plans")
+        .get("/organizations/".concat(organizationId, "/profiles/").concat(profileId, "/plans"))
         .then(function (r) { return r.data; });
 };

package/Organizations/Organizations.js

@@ -21,16 +21,16 @@ export var validateOrganization = function () {
 };
 export var deleteOrganization = function (organizationId) {
     return getEndpoint()
-        .delete("/organizations/" + organizationId)
+        .delete("/organizations/".concat(organizationId))
         .then(function (r) { return r.data; });
 };
 export var getOrganization = function (organizationId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId)
+        .get("/organizations/".concat(organizationId))
         .then(function (r) { return r.data; });
 };
 export var updateOrganization = function (organizationId, params) {
     return getEndpoint()
-        .patch("/organizations/" + organizationId, params)
+        .patch("/organizations/".concat(organizationId), params)
         .then(function (r) { return r.data; });
 };

package/Organizations/Webhooks.js

@@ -1,11 +1,11 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var getWebhook = function (organizationId) {
     return getEndpoint()
-        .get("/organizations/" + organizationId + "/webhook")
+        .get("/organizations/".concat(organizationId, "/webhook"))
         .then(function (r) { return r.data; });
 };
 export var updateWebhook = function (organizationId, params) {
     return getEndpoint()
-        .post("/organizations/" + organizationId + "/webhook", params)
+        .post("/organizations/".concat(organizationId, "/webhook"), params)
         .then(function (r) { return r.data; });
 };

package/Search/Types.d.ts

@@ -1,4 +1,4 @@
-import { TDocumentStatus, TRecipientStatus } from '../Documents/Documents';
+import { TDocumentStatus } from '../Documents/Documents';
 import { TTemplateSender } from '../Templates/Types';
 export declare type TMimeType = 'application/pdf' | string;
 /**
@@ -99,14 +99,7 @@ export interface ISearchResult {
     organizations: ISearchResultCollection<IOrganizationHit>;
 }
 export interface ISearchParams {
-    page?: number;
-    limit?: number;
-    q?: string;
-    tags?: string[];
-    type?: 'template' | 'document' | 'organization';
-    shared?: 'private' | 'shared' | 'public';
-    mine?: boolean;
-    status?: TDocumentStatus | TRecipientStatus;
+    q: string;
 }
 export interface IRecentSearch {
     id: string;

package/Templates/Documents.js

@@ -10,7 +10,7 @@ import { getEndpoint } from '../HTTP/Transport';
  */
 export var getDocuments = function (templateId) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/documents/")
+        .get("/templates/".concat(templateId, "/documents/"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -24,7 +24,7 @@ export var getDocuments = function (templateId) {
  */
 export var createDocument = function (templateId, params) {
     return getEndpoint()
-        .post("/templates/" + templateId + "/documents/", params)
+        .post("/templates/".concat(templateId, "/documents/"), params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -38,7 +38,7 @@ export var createDocument = function (templateId, params) {
  */
 export var getDocument = function (templateId, documentId) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/documents/" + documentId)
+        .get("/templates/".concat(templateId, "/documents/").concat(documentId))
         .then(function (r) { return r.data; });
 };
 /**
@@ -52,6 +52,6 @@ export var getDocument = function (templateId, documentId) {
  */
 export var deleteDocument = function (templateId, documentId) {
     return getEndpoint()
-        .delete("/templates/" + templateId + "/documents/" + documentId)
+        .delete("/templates/".concat(templateId, "/documents/").concat(documentId))
         .then(function (r) { return r.data; });
 };

package/Templates/Fields.js

@@ -1,16 +1,16 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var createField = function (templateId, params) {
     return getEndpoint()
-        .post("/templates/" + templateId + "/pages/", params)
+        .post("/templates/".concat(templateId, "/pages/"), params)
         .then(function (r) { return r.data; });
 };
 export var editField = function (templateId, fieldName, params) {
     return getEndpoint()
-        .put("/templates/" + templateId + "/pages/" + fieldName, params)
+        .put("/templates/".concat(templateId, "/pages/").concat(fieldName), params)
         .then(function (r) { return r.data; });
 };
 export var deleteField = function (templateId, fieldName) {
     return getEndpoint()
-        .delete("/templates/" + templateId + "/pages/" + fieldName)
+        .delete("/templates/".concat(templateId, "/pages/").concat(fieldName))
         .then(function (r) { return r.data; });
 };

package/Templates/Pages.js

@@ -1,21 +1,21 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var createPage = function (templateId, params) {
     return getEndpoint()
-        .post("/templates/" + templateId + "/pages/", params)
+        .post("/templates/".concat(templateId, "/pages/"), params)
         .then(function (r) { return r.data; });
 };
 export var editPage = function (templateId, sequence) {
     return getEndpoint()
-        .put("/templates/" + templateId + "/pages/" + sequence)
+        .put("/templates/".concat(templateId, "/pages/").concat(sequence))
         .then(function (r) { return r.data; });
 };
 export var getPage = function (templateId, sequence) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/pages/" + sequence)
+        .get("/templates/".concat(templateId, "/pages/").concat(sequence))
         .then(function (r) { return r.data; });
 };
 export var deletePage = function (templateId, sequence) {
     return getEndpoint()
-        .delete("/templates/" + templateId + "/pages/" + sequence)
+        .delete("/templates/".concat(templateId, "/pages/").concat(sequence))
         .then(function (r) { return r.data; });
 };

package/Templates/Reminders.js

@@ -1,21 +1,21 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var createReminder = function (templateId, params) {
     return getEndpoint()
-        .post("/templates/" + templateId + "/reminder/", params)
+        .post("/templates/".concat(templateId, "/reminder/"), params)
         .then(function (r) { return r.data; });
 };
 export var getReminder = function (templateId, reminderId) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/reminder/" + reminderId)
+        .get("/templates/".concat(templateId, "/reminder/").concat(reminderId))
         .then(function (r) { return r.data; });
 };
 export var editReminder = function (templateId, reminderId) {
     return getEndpoint()
-        .put("/templates/" + templateId + "/reminder/" + reminderId)
+        .put("/templates/".concat(templateId, "/reminder/").concat(reminderId))
         .then(function (r) { return r.data; });
 };
 export var deleteReminder = function (templateId, reminderId) {
     return getEndpoint()
-        .delete("/templates/" + templateId + "/reminder/" + reminderId)
+        .delete("/templates/".concat(templateId, "/reminder/").concat(reminderId))
         .then(function (r) { return r.data; });
 };

package/Templates/Roles.js

@@ -1,36 +1,36 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var createRole = function (templateId, params) {
     return getEndpoint()
-        .post("/templates/" + templateId + "/roles/", params)
+        .post("/templates/".concat(templateId, "/roles/"), params)
         .then(function (r) { return r.data; });
 };
 export var getRoles = function (templateId) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/roles/")
+        .get("/templates/".concat(templateId, "/roles/"))
         .then(function (r) { return r.data; });
 };
 export var getRole = function (templateId, roleName) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/roles/" + roleName)
+        .get("/templates/".concat(templateId, "/roles/").concat(roleName))
         .then(function (r) { return r.data; });
 };
 export var editRole = function (templateId, roleName, params) {
     return getEndpoint()
-        .put("/templates/" + templateId + "/roles/" + roleName, params)
+        .put("/templates/".concat(templateId, "/roles/").concat(roleName), params)
         .then(function (r) { return r.data; });
 };
 export var deleteRole = function (templateId, roleName) {
     return getEndpoint()
-        .delete("/templates/" + templateId + "/roles/" + roleName)
+        .delete("/templates/".concat(templateId, "/roles/").concat(roleName))
         .then(function (r) { return r.data; });
 };
 export var getRoleFields = function (templateId, roleName) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/roles/" + roleName + "/fields")
+        .get("/templates/".concat(templateId, "/roles/").concat(roleName, "/fields"))
         .then(function (r) { return r.data; });
 };
 export var deleteSequence = function (templateId) {
     return getEndpoint()
-        .delete("/templates/" + templateId + "/roles/")
+        .delete("/templates/".concat(templateId, "/roles/"))
         .then(function (r) { return r.data; });
 };

package/Templates/Stars.js

@@ -1,11 +1,11 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var getStars = function (templateId) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/stars/")
+        .get("/templates/".concat(templateId, "/stars/"))
         .then(function (r) { return r.data; });
 };
 export var toggleStar = function (templateId) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/stars/toggle")
+        .get("/templates/".concat(templateId, "/stars/toggle"))
         .then(function (r) { return r.data; });
 };

package/Templates/Tags.js

@@ -1,17 +1,17 @@
 import { getEndpoint } from '../HTTP/Transport';
 export var addTemplateTag = function (templateId, params) {
     return getEndpoint()
-        .post("/templates/" + templateId + "/tags/", params)
+        .post("/templates/".concat(templateId, "/tags/"), params)
         .then(function (r) { return r.data; });
 };
 export var getTemplateTags = function (templateId) {
     return getEndpoint()
-        .get("/templates/" + templateId + "/tags/")
+        .get("/templates/".concat(templateId, "/tags/"))
         .then(function (r) { return r.data; });
 };
 export var deleteTemplateTag = function (templateId, tagName) {
     return getEndpoint()
-        .post("/templates/" + templateId + "/tags/" + tagName)
+        .post("/templates/".concat(templateId, "/tags/").concat(tagName))
         .then(function (r) { return r.data; });
 };
 export var createTag = function (params) {
@@ -21,7 +21,7 @@ export var createTag = function (params) {
 };
 export var getTag = function (tagName) {
     return getEndpoint()
-        .get("/tags/" + tagName)
+        .get("/tags/".concat(tagName))
         .then(function (r) { return r.data; });
 };
 export var getAllTags = function (params) {

package/Templates/Templates.js

@@ -42,7 +42,7 @@ export var getTemplates = function () {
 };
 export var getTemplate = function (templateId) {
     return getEndpoint()
-        .get("/templates/" + templateId)
+        .get("/templates/".concat(templateId))
         .then(function (r) { return r.data; });
 };
 export var createTemplate = function (params) {
@@ -52,7 +52,7 @@ export var createTemplate = function (params) {
 };
 export var editTemplate = function (templateId, params) {
     return getEndpoint()
-        .put("/templates/" + templateId, params)
+        .put("/templates/".concat(templateId), params)
         .then(function (r) { return r.data; });
 };
 /**

package/Templates/Validators.js

@@ -6,6 +6,6 @@ export var getValidators = function () {
 };
 export var getValidator = function (validatorName) {
     return getEndpoint()
-        .get("/validators/" + validatorName)
+        .get("/validators/".concat(validatorName))
         .then(function (r) { return r.data; });
 };

package/Users/Profiles.d.ts

@@ -1,5 +1,4 @@
-import { ICreateProfileRequest, IPermission, IProfile, IRole, ISwitchProfileResponse, IUpdateProfileRequest } from './Types';
-import { IGroup } from '../Organizations/Types';
+import { ICreateProfileRequest, IUpdateProfileRequest } from './Types';
 /**
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
@@ -9,7 +8,7 @@ import { IGroup } from '../Organizations/Types';
  * const profiles = await Profiles.getProfiles()
  * ```
  */
-export declare const getProfiles: () => Promise<IProfile[]>;
+export declare const getProfiles: () => Promise<any>;
 /**
  * Get a list of system roles.
  *
@@ -19,7 +18,7 @@ export declare const getProfiles: () => Promise<IProfile[]>;
  * const roles = await Profiles.getRoles();
  * ```
  */
-export declare const getRoles: () => Promise<IRole[]>;
+export declare const getRoles: () => Promise<any>;
 /**
  * Get a list of system roles.
  *
@@ -29,7 +28,7 @@ export declare const getRoles: () => Promise<IRole[]>;
  * const permissions = await Profiles.getPermissions();
  * ```
  */
-export declare const getPermissions: () => Promise<IPermission[]>;
+export declare const getPermissions: () => Promise<any>;
 /**
  * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
  *
@@ -39,7 +38,7 @@ export declare const getPermissions: () => Promise<IPermission[]>;
  * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
  * ```
  */
-export declare const createProfile: (params: ICreateProfileRequest) => Promise<IProfile>;
+export declare const createProfile: (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
@@ -50,7 +49,7 @@ export declare const createProfile: (params: ICreateProfileRequest) => Promise<I
  * const profile = await Profiles.getProfile('PROFILEID');
  * ```
  */
-export declare const getProfile: (profileId: string) => Promise<IProfile>;
+export declare const getProfile: (profileId: string) => Promise<any>;
 /**
  * Get a profile's permissions. The caller must have admin access to the given profile.
  *
@@ -60,7 +59,7 @@ export declare const getProfile: (profileId: string) => Promise<IProfile>;
  * const permissions = await Profiles.getProfilePermissions('PROFILEID');
  * ```
  */
-export declare const getProfilePermissions: (profileId: string) => Promise<IPermission[]>;
+export declare const getProfilePermissions: (profileId: string) => Promise<any>;
 /**
  * Get a profile's groups.
  *
@@ -70,7 +69,7 @@ export declare const getProfilePermissions: (profileId: string) => Promise<IPerm
  * const groups = await Profiles.getProfileGroups('PROFILEID');
  * ```
  */
-export declare const getProfileGroups: (profileId: string) => Promise<IGroup[]>;
+export declare const getProfileGroups: (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.
@@ -81,7 +80,7 @@ export declare const getProfileGroups: (profileId: string) => Promise<IGroup[]>;
  * const newProfile = await Profiles.switchProfile('PROFILEID');
  * ```
  */
-export declare const switchProfile: (profileId: string) => Promise<ISwitchProfileResponse>;
+export declare const switchProfile: (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.
@@ -92,7 +91,7 @@ export declare const switchProfile: (profileId: string) => Promise<ISwitchProfil
  * const newProfile = await Profiles.updateProfile('PROFILEID');
  * ```
  */
-export declare const updateProfile: (profileId: string, params: IUpdateProfileRequest) => Promise<IProfile>;
+export declare const updateProfile: (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.
  *

package/Users/Profiles.js

@@ -67,7 +67,7 @@ export var createProfile = function (params) {
  */
 export var getProfile = function (profileId) {
     return getEndpoint()
-        .get("/profiles/" + profileId)
+        .get("/profiles/".concat(profileId))
         .then(function (r) { return r.data; });
 };
 /**
@@ -81,7 +81,7 @@ export var getProfile = function (profileId) {
  */
 export var getProfilePermissions = function (profileId) {
     return getEndpoint()
-        .get("/profiles/" + profileId + "/permissions")
+        .get("/profiles/".concat(profileId, "/permissions"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -95,7 +95,7 @@ export var getProfilePermissions = function (profileId) {
  */
 export var getProfileGroups = function (profileId) {
     return getEndpoint()
-        .get("/profiles/" + profileId + "/groups")
+        .get("/profiles/".concat(profileId, "/groups"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -110,7 +110,7 @@ export var getProfileGroups = function (profileId) {
  */
 export var switchProfile = function (profileId) {
     return getEndpoint()
-        .post("/profiles/" + profileId + "/switch")
+        .post("/profiles/".concat(profileId, "/switch"))
         .then(function (r) { return r.data; });
 };
 /**
@@ -125,7 +125,7 @@ export var switchProfile = function (profileId) {
  */
 export var updateProfile = function (profileId, params) {
     return getEndpoint()
-        .put("/profiles/" + profileId, params)
+        .put("/profiles/".concat(profileId), params)
         .then(function (r) { return r.data; });
 };
 /**
@@ -139,6 +139,6 @@ export var updateProfile = function (profileId, params) {
  */
 export var deleteProfile = function (profileId) {
     return getEndpoint()
-        .delete("/profiles/" + profileId)
+        .delete("/profiles/".concat(profileId))
         .then(function (r) { return r.data; });
 };

package/Users/Types.d.ts

@@ -1,7 +1,16 @@
 import { IGroup, IOrganization } from '../Organizations/Types';
 import { TRequestStatus } from '../HTTP/Types';
+/**
+ * An operation within Verdocs the user may perform.
+ */
 export declare type TPermission = 'org:view' | 'member:view' | 'org:update' | 'member:add' | 'member:remove' | 'admin:add' | 'admin:remove' | 'org:delete' | 'org:transfer' | 'owner:add' | 'owner:remove' | 'template:creator:create:personal' | 'template:creator:visibility' | 'template:creator:create:org' | 'template:member:read' | 'template:member:write' | 'template:member:visibility' | 'template:creator:delete' | 'template:member:delete' | 'template:creator:create:public' | 'rform:access' | 'rcommon:access' | 'org:list' | 'org:create';
+/**
+ * Plans provide access to Verdocs product features.
+ */
 export declare type TPlan = 'env:essential' | 'org:standard';
+/**
+ * Roles provide access to groups of permissions.
+ */
 export declare type TRole = 'owner' | 'basic_user' | 'member';
 export interface IProfile {
     /** The unique ID of the profile */
@@ -37,12 +46,13 @@ export interface IActiveSession {
     email_verified: boolean;
     iat: number;
     exp: number;
-    permissions: IPermission[];
-    roles: IRole[];
+    permissions: TPermission[];
+    roles: TRole[];
     profile: IProfile;
     profile_id: string;
     organization_id: string;
     plans?: TPlan[];
+    [key: string]: any;
 }
 export interface IRole {
     /** Unique identifier for the role. */

package/Utils/DateTime.js

@@ -37,5 +37,5 @@ export var formatShortTimeAgo = function (val) {
     if (timeDiff >= MINUTE) {
         return Math.floor(timeDiff / MINUTE) + 'Y';
     }
-    return timeDiff + "S";
+    return "".concat(timeDiff, "S");
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.0.22",
+  "version": "1.0.27",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -23,20 +23,20 @@
     "url": "https://github.com/Verdocs/js-sdk/issues"
   },
   "scripts": {
-    "build": "npm run clean && tsc && npm run lint && npm run docs",
+    "build": "npm run clean && npm run docs && tsc && npm run lint",
     "prepare": "npm run build",
     "prepublishOnly": "npm run lint",
-    "OldprepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags",
     "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",
-    "docs-html": "typedoc --plugin none --out docs-html",
-    "docs": "npm run docs-md && npm run docs-html && cp -aR docs-html/* ../partner-portal/site/static/js-sdk/",
-    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts"
+    "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/",
+    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts docs docs-html"
   },
   "publishConfig": {
     "access": "public"
@@ -45,18 +45,18 @@
     "axios": "^0.21.1"
   },
   "peerDependencies": {
-    "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x"
+    "typescript": "4.2.x || 4.3.x || 4.4.x || 4.5.x"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
     "jest": "^27.3.1",
     "jest-mock-axios": "^4.4.1",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.1",
     "ts-jest": "^27.0.7",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.22.9",
-    "typedoc-plugin-markdown": "^3.11.6",
-    "typescript": "^4.4.4"
+    "typedoc": "^0.22.10",
+    "typedoc-plugin-markdown": "^3.11.9",
+    "typescript": "^4.5.4"
   }
 }

package/tsconfig-typedoc.json

@@ -0,0 +1,25 @@
+{
+  "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
+  }
+}