@verdocs/js-sdk 1.0.8 → 1.0.12

package/{Api → dist/Users}/Notifications.js

@@ -34,7 +34,11 @@ 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 { Endpoint } from './Endpoint';
-export var getNotifications = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, Endpoint.get('/notifications').then(function (r) { return r.data; })];
-}); }); };
+import { getEndpoint } from '../HTTP/Transport';
+export var getNotifications = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .get('/notifications')
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/{Users → dist/Users}/Profiles.js

@@ -1,4 +1,4 @@
-import { Endpoint } from '../HTTP/Transport';
+import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
@@ -8,7 +8,11 @@ import { Endpoint } from '../HTTP/Transport';
  * const profiles = await Profiles.getProfiles()
  * ```
  */
-export var getProfiles = function () { return Endpoint.get('/profiles').then(function (r) { return r.data; }); };
+export var getProfiles = function () {
+    return getEndpoint()
+        .get('/profiles')
+        .then(function (r) { return r.data; });
+};
 /**
  * Get a list of system roles.
  *
@@ -18,7 +22,11 @@ export var getProfiles = function () { return Endpoint.get('/profiles').then(fun
  * const roles = await Profiles.getRoles();
  * ```
  */
-export var getRoles = function () { return Endpoint.get('/roles').then(function (r) { return r.data; }); };
+export var getRoles = function () {
+    return getEndpoint()
+        .get('/roles')
+        .then(function (r) { return r.data; });
+};
 /**
  * Get a list of system roles.
  *
@@ -28,7 +36,11 @@ export var getRoles = function () { return Endpoint.get('/roles').then(function
  * const permissions = await Profiles.getPermissions();
  * ```
  */
-export var getPermissions = function () { return Endpoint.get('/permissions').then(function (r) { return r.data; }); };
+export var getPermissions = function () {
+    return getEndpoint()
+        .get('/permissions')
+        .then(function (r) { return r.data; });
+};
 /**
  * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
  *
@@ -39,7 +51,9 @@ export var getPermissions = function () { return Endpoint.get('/permissions').th
  * ```
  */
 export var createProfile = function (params) {
-    return Endpoint.post('/profiles', params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post('/profiles', params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Get a profile. The caller must have admin access to the given profile.
@@ -51,7 +65,11 @@ export var createProfile = function (params) {
  * const profile = await Profiles.getProfile('PROFILEID');
  * ```
  */
-export var getProfile = function (profileId) { return Endpoint.get("/profiles/" + profileId).then(function (r) { return r.data; }); };
+export var getProfile = function (profileId) {
+    return getEndpoint()
+        .get("/profiles/" + profileId)
+        .then(function (r) { return r.data; });
+};
 /**
  * Get a profile's permissions. The caller must have admin access to the given profile.
  *
@@ -62,7 +80,9 @@ export var getProfile = function (profileId) { return Endpoint.get("/profiles/"
  * ```
  */
 export var getProfilePermissions = function (profileId) {
-    return Endpoint.get("/profiles/" + profileId + "/permissions").then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/profiles/" + profileId + "/permissions")
+        .then(function (r) { return r.data; });
 };
 /**
  * Get a profile's groups.
@@ -74,7 +94,9 @@ export var getProfilePermissions = function (profileId) {
  * ```
  */
 export var getProfileGroups = function (profileId) {
-    return Endpoint.get("/profiles/" + profileId + "/groups").then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/profiles/" + profileId + "/groups")
+        .then(function (r) { return r.data; });
 };
 /**
  * Switch the caller's "current" profile. The current profile is used for permissions checking and profile_id field settings
@@ -87,7 +109,9 @@ export var getProfileGroups = function (profileId) {
  * ```
  */
 export var switchProfile = function (profileId) {
-    return Endpoint.post("/profiles/" + profileId + "/switch").then(function (r) { return r.data; });
+    return getEndpoint()
+        .post("/profiles/" + profileId + "/switch")
+        .then(function (r) { return r.data; });
 };
 /**
  * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
@@ -100,7 +124,9 @@ export var switchProfile = function (profileId) {
  * ```
  */
 export var updateProfile = function (profileId, params) {
-    return Endpoint.put("/profiles/" + profileId, params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .put("/profiles/" + profileId, params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
@@ -111,4 +137,8 @@ export var updateProfile = function (profileId, params) {
  * await Profiles.deleteProfile('PROFILEID');
  * ```
  */
-export var deleteProfile = function (profileId) { return Endpoint.delete("/profiles/" + profileId).then(function (r) { return r.data; }); };
+export var deleteProfile = function (profileId) {
+    return getEndpoint()
+        .delete("/profiles/" + profileId)
+        .then(function (r) { return r.data; });
+};

package/{Users → dist/Users}/Types.d.ts

@@ -31,6 +31,19 @@ export interface IProfile {
     /** The plans assigned to the profilel _NOTE: Only present in the "current" profile._ */
     groups?: IGroup[];
 }
+export interface IActiveSession {
+    sub: string;
+    email: string;
+    email_verified: boolean;
+    iat: number;
+    exp: number;
+    permissions: IPermission[];
+    roles: IRole[];
+    profile: IProfile;
+    profile_id: string;
+    organization_id: string;
+    plans?: TPlan[];
+}
 export interface IRole {
     /** Unique identifier for the role. */
     id: string;

package/dist/Validators.js

@@ -0,0 +1,11 @@
+import { getEndpoint } from './HTTP/Transport';
+export var getValidators = function () {
+    return getEndpoint()
+        .get('/validators')
+        .then(function (r) { return r.data; });
+};
+export var getValidator = function (validatorName) {
+    return getEndpoint()
+        .get("/validators/" + validatorName)
+        .then(function (r) { return r.data; });
+};

package/dist/Whitelabel.js

@@ -0,0 +1,11 @@
+import { getEndpoint } from './HTTP/Transport';
+export var createWhitelabel = function () {
+    return getEndpoint()
+        .post('/whitelabel')
+        .then(function (r) { return r.data; });
+};
+export var getWhitelabel = function () {
+    return getEndpoint()
+        .get('/whitelabel')
+        .then(function (r) { return r.data; });
+};

package/dist/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@verdocs/js-sdk",
+  "version": "1.0.12",
+  "private": false,
+  "homepage": "https://github.com/Verdocs/js-sdk",
+  "description": "Verdocs JS SDK",
+  "keywords": [
+    "pdf",
+    "document",
+    "signing",
+    "Verdocs",
+    "embed"
+  ],
+  "author": "Verdocs, LLC",
+  "license": "MIT",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Verdocs/js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Verdocs/js-sdk/issues"
+  },
+  "scripts": {
+    "build": "rm -rf dist/* && tsc && cp README.md package.json .npmignore dist",
+    "Xprepare": "npm run build",
+    "XprepublishOnly": "npm test && npm run lint",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags",
+    "test": "jest --config jestconfig.json",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json",
+    "docs-md": "typedoc && git add --all docs",
+    "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/",
+    "pub": "npm version patch && npm run build && npm run docs"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "axios": "^0.21.1"
+  },
+  "peerDependencies": {
+    "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.1",
+    "jest": "^27.2.1",
+    "jest-mock-axios": "^4.4.0",
+    "prettier": "^2.4.1",
+    "ts-jest": "^27.0.3",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
+    "typedoc": "^0.22.4",
+    "typedoc-plugin-markdown": "^3.11.0",
+    "typescript": "^4.3.5"
+  }
+}

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/README.md

@@ -0,0 +1,70 @@
+@verdocs/js-sdk - v1.0.12 / [Exports](modules.md)
+
+# Verdocs JS SDK
+
+> Verdocs SDK for Javascript / Typescript
+
+This SDK provides convenience wrappers for both Browser-based and NodeJS applications to call the Verdocs API, with strong typing and
+documentation to help you get started quickly developing for the Verdocs platform.
+
+## Getting Started
+
+First add this module to your project:
+
+    npm install --save @verdocs/js-sdk
+
+or:
+
+    yarn add @verdocs/js-sdk
+
+This package is namespaced into packages that organize API calls into functional groups. A top-level `export *` is provided for simplicity,
+but to enable Tree Shaking to do its job, it is recommended that you only import the package required for a given task. For example, to
+perform a simple authentication request:
+
+```typescript
+import {Auth} from '@verdocs/js-sdk/Auth';
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+const {accessToken} = await Auth.authenticateUser({username: 'MY_USERNAME', password: 'MY_PASSWORD'});
+Transport.setAuthToken(accessToken);
+```
+
+Once you are authenticated, you can use the rest of the controls and embeds within an app. For instance, to provide a simple PDF
+viewer for a document stored within Verdocs:
+
+## Documentation
+
+Verdocs functions are organized into high-level modules that represent the main objects within the platform:
+
+- Documents - An individual document to be signed. Documents are created from templates.
+- HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
+- 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.
+
+Please see the [API Docs](https://github.com/Verdocs/js-sdk/tree/main/docs) for details on the functions provided by each module.
+
+## Contributing
+
+To avoid the presence of the `dist/` distribution directory appearing in package imports, when this project is built, this `README.md`
+and other support files are copied there. Be sure to run `npm version patch` from THIS directory, but the publish command from within
+the `dist` folder.
+
+## HTTP Transport
+
+The underlying transport uses `axios`, a cross-environment (NodeJS vs. Browser) HTTP transport layer. When this SDK is included in a
+project, a `Transport` singleton Axios Instance will be created to support the API calls to Verdocs servers. This endpoint's operation
+may be configured by importing it. Please see the [Axios Documentation](https://github.com/axios/axios) for more information on the
+options available. For example, to override the default API call timeout of 3s:
+
+```typescript
+import {Transport} from '@verdocs/js-sdk/Auth/HTTP';
+
+Transport.setTimeout(5000);
+```
+
+## Contributing
+
+This repository is actively maintained and supported by [Verdocs](https://verdocs.com/). We welcome community contributions and
+suggestions! Please file a pull request with any change requests and we will review them as soon as possible.

package/docs/enums/Templates.Types.SortOptions.md

@@ -0,0 +1,76 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / SortOptions
+
+# Enumeration: SortOptions
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).SortOptions
+
+## Table of contents
+
+### Enumeration members
+
+- [COUNTER](Templates.Types.SortOptions.md#counter)
+- [CREATED_AT](Templates.Types.SortOptions.md#created_at)
+- [LAST_USED_AT](Templates.Types.SortOptions.md#last_used_at)
+- [NAME](Templates.Types.SortOptions.md#name)
+- [STAR_COUNTER](Templates.Types.SortOptions.md#star_counter)
+- [UPDATED_AT](Templates.Types.SortOptions.md#updated_at)
+
+## Enumeration members
+
+### COUNTER
+
+• **COUNTER** = `"counter"`
+
+#### Defined in
+
+[Templates/Types.ts:107](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L107)
+
+___
+
+### CREATED\_AT
+
+• **CREATED\_AT** = `"created_at"`
+
+#### Defined in
+
+[Templates/Types.ts:103](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L103)
+
+___
+
+### LAST\_USED\_AT
+
+• **LAST\_USED\_AT** = `"last_used_at"`
+
+#### Defined in
+
+[Templates/Types.ts:106](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L106)
+
+___
+
+### NAME
+
+• **NAME** = `"name"`
+
+#### Defined in
+
+[Templates/Types.ts:105](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L105)
+
+___
+
+### STAR\_COUNTER
+
+• **STAR\_COUNTER** = `"star_counter"`
+
+#### Defined in
+
+[Templates/Types.ts:108](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L108)
+
+___
+
+### UPDATED\_AT
+
+• **UPDATED\_AT** = `"updated_at"`
+
+#### Defined in
+
+[Templates/Types.ts:104](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L104)

package/docs/enums/Templates.Types.Template.md

@@ -0,0 +1,153 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / Template
+
+# Enumeration: Template
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).Template
+
+## Table of contents
+
+### Enumeration members
+
+- [COUNTER](Templates.Types.Template.md#counter)
+- [CREATED_AT](Templates.Types.Template.md#created_at)
+- [DESCRIPTION](Templates.Types.Template.md#description)
+- [ID](Templates.Types.Template.md#id)
+- [IS_PERSONAL](Templates.Types.Template.md#is_personal)
+- [IS_PUBLIC](Templates.Types.Template.md#is_public)
+- [NAME](Templates.Types.Template.md#name)
+- [ORGANIZATION_ID](Templates.Types.Template.md#organization_id)
+- [PROFILE_ID](Templates.Types.Template.md#profile_id)
+- [REMINDER_ID](Templates.Types.Template.md#reminder_id)
+- [SENDER](Templates.Types.Template.md#sender)
+- [TOKEN](Templates.Types.Template.md#token)
+- [UPDATED_AT](Templates.Types.Template.md#updated_at)
+
+## Enumeration members
+
+### COUNTER
+
+• **COUNTER** = `"counter"`
+
+#### Defined in
+
+[Templates/Types.ts:45](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L45)
+
+___
+
+### CREATED\_AT
+
+• **CREATED\_AT** = `"created_at"`
+
+#### Defined in
+
+[Templates/Types.ts:46](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L46)
+
+___
+
+### DESCRIPTION
+
+• **DESCRIPTION** = `"description"`
+
+#### Defined in
+
+[Templates/Types.ts:54](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L54)
+
+___
+
+### ID
+
+• **ID** = `"id"`
+
+#### Defined in
+
+[Templates/Types.ts:42](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L42)
+
+___
+
+### IS\_PERSONAL
+
+• **IS\_PERSONAL** = `"is_personal"`
+
+#### Defined in
+
+[Templates/Types.ts:51](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L51)
+
+___
+
+### IS\_PUBLIC
+
+• **IS\_PUBLIC** = `"is_public"`
+
+#### Defined in
+
+[Templates/Types.ts:52](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L52)
+
+___
+
+### NAME
+
+• **NAME** = `"name"`
+
+#### Defined in
+
+[Templates/Types.ts:44](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L44)
+
+___
+
+### ORGANIZATION\_ID
+
+• **ORGANIZATION\_ID** = `"organization_id"`
+
+#### Defined in
+
+[Templates/Types.ts:50](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L50)
+
+___
+
+### PROFILE\_ID
+
+• **PROFILE\_ID** = `"profile_id"`
+
+#### Defined in
+
+[Templates/Types.ts:43](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L43)
+
+___
+
+### REMINDER\_ID
+
+• **REMINDER\_ID** = `"reminder_id"`
+
+#### Defined in
+
+[Templates/Types.ts:49](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L49)
+
+___
+
+### SENDER
+
+• **SENDER** = `"sender"`
+
+#### Defined in
+
+[Templates/Types.ts:53](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L53)
+
+___
+
+### TOKEN
+
+• **TOKEN** = `"token"`
+
+#### Defined in
+
+[Templates/Types.ts:48](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L48)
+
+___
+
+### UPDATED\_AT
+
+• **UPDATED\_AT** = `"updated_at"`
+
+#### Defined in
+
+[Templates/Types.ts:47](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L47)