@verdocs/js-sdk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Verdocs, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# Verdocs JS SDK
+
+> Verdocs SDK for Javascript / Typescript
+
+This SDK provides convenience wrappers for both Browser-based and NodeJS applications with strong typing and documentation to help
+you get started quickly developing for the Verdocs platform.
+
+## Usage
+
+We will shortly be adding code samples, tutorials, and guides. Until then, please refer to the
+[API Documentation](https://github.com/Verdocs/js-sdk/tree/main/doc-md). Note that 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, e.g.:
+
+```typescript
+import {Auth} from '@verdocs/js-sdk/Auth';
+import {Endpoint} from '@verdocs/js-sdk/HTTP';
+
+const {accessToken} = await Auth.authenticateUser({username: 'MY_USERNAME', password: 'MY_PASSWORD'});
+Endpoint.setAuthToken(accessToken);
+```
+
+## HTTP Transport
+
+The underlying transport uses `axios`, a cross-environment (NodeJS vs. Browser) HTTP transport layer. When this SDK is included in a
+project, an `Endpoint` 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 {Endpoint} from '@verdocs/js-sdk/Auth/HTTP/Transport';
+
+Endpoint.defaults.timeout = 5000;
+```
+
+## Contributing
+
+Although we at Verdocs actively maintain this SDK, 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/dist/Api/Auth.d.ts

@@ -0,0 +1,71 @@
+export declare type IPermission = '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';
+export declare type IRole = 'owner' | 'basic_user' | 'member';
+export declare type IPlan = 'env:essential' | 'org:standard';
+export interface IProfile {
+    id: string;
+    user_id: string;
+    organization_id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone: string | null;
+    current: boolean;
+    organization: {
+        id: string;
+        name: string;
+        address: string | null;
+        phone: string | null;
+        business_name: string | null;
+        is_business: boolean;
+        address2: string | null;
+        contact_email: string | null;
+        timezone: string | null;
+        envelope_responsible: boolean;
+    };
+    permissions?: IPermission[];
+    roles?: IRole[];
+    plans?: IPlan[];
+}
+export interface IActiveSession {
+    sub: string;
+    email: string;
+    email_verified: boolean;
+    iat: number;
+    exp: number;
+    permissions: IPermission[];
+    roles: IRole[];
+    plans: IPlan[];
+    profile: IProfile;
+    profile_id: string;
+    organization_id: string;
+}
+export interface AuthenticateRequest {
+    username: string;
+    password: string;
+}
+export interface AuthenticateResponse {
+    idToken: string;
+    accessToken: string;
+    refreshToken: string;
+}
+/**
+ * Authenticate to Verdocs via user/password authentication
+ *
+ * ```typescript
+ * import {Auth, Endpoint} from '@verdocs/js-sdk';
+ *
+ * const {accessToken} = await Auth.authenticate({ username: 'test@test.com', password: 'PASSWORD' });
+ * Endpoint.setAuthToken(accessToken);
+ * ```
+ */
+export declare const authenticate: (request: AuthenticateRequest) => Promise<AuthenticateResponse>;
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Auth} from '@verdocs/js-sdk';
+ *
+ * const profiles = await Auth.getProfiles()
+ * ```
+ */
+export declare const getProfiles: () => Promise<IProfile[]>;

package/dist/Api/Auth.js

@@ -0,0 +1,24 @@
+import { Endpoint } from './Endpoint';
+/**
+ * Authenticate to Verdocs via user/password authentication
+ *
+ * ```typescript
+ * import {Auth, Endpoint} from '@verdocs/js-sdk';
+ *
+ * const {accessToken} = await Auth.authenticate({ username: 'test@test.com', password: 'PASSWORD' });
+ * Endpoint.setAuthToken(accessToken);
+ * ```
+ */
+export var authenticate = function (request) {
+    return Endpoint.post('/authentication/login', request).then(function (r) { return r.data; });
+};
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Auth} from '@verdocs/js-sdk';
+ *
+ * const profiles = await Auth.getProfiles()
+ * ```
+ */
+export var getProfiles = function () { return Endpoint.post('/profiles').then(function (r) { return r.data; }); };

package/dist/Api/Documents.d.ts

@@ -0,0 +1,124 @@
+export declare type IDocumentStatus = 'complete' | 'pending' | 'progress';
+export declare type IRecipientStatus = 'invited' | 'opened' | 'signed' | 'submitted';
+export declare type IRecipientType = 'signer' | 'cc';
+export interface IDocumentsSearchResultEntry {
+    id: string;
+    canceled_at: string;
+    created_at: string;
+    name: string;
+    profile_id: string;
+    status: IDocumentStatus;
+    next_recipient: {
+        claimed: boolean;
+        email: string;
+        name: string;
+        profile_id: string;
+        status: IRecipientStatus;
+        type: IRecipientType;
+    };
+    template_id: string;
+    total_count: number;
+    updated_at: string;
+}
+export interface IDocumentsSearchResult {
+    page: number;
+    total: number;
+    result: IDocumentsSearchResultEntry[];
+}
+export interface IDocumentsSummary {
+    action_required: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    completed: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    waiting_others: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+}
+export interface IRecipient {
+    agreed: boolean;
+    claimed: boolean;
+    created_at: string;
+    delegated_to: string | null;
+    delegator: boolean;
+    email: string;
+    envelope_id: string;
+    full_name: string;
+    in_app_access_key: string;
+    key_used_to_conclude: string;
+    message: string | null;
+    phone: string;
+    profile_id: string;
+    role_name: string;
+    sequence: number;
+    status: IRecipientStatus;
+    type: IRecipientType;
+    updated_at: string;
+}
+export interface IDocument {
+    id: string;
+    created_at: string;
+    canceled_at: string;
+    envelope_document_id: string;
+    certificate_document_id: string | null;
+    histories: IHistory[];
+    recipients: IRecipient[];
+    name: string;
+    no_contact: boolean;
+    profile_id: string;
+    reminder_id: string | null;
+    status: IDocumentStatus;
+    template_id: string;
+    updated_at: string;
+}
+export interface IActivityEntry {
+    id: string;
+    name: string;
+    canceled_at: string;
+    created_at: string;
+    updated_at: string;
+    profile_id: string;
+    status: IDocumentStatus;
+    template_id: string;
+    recipient: {
+        claimed: boolean;
+        email: string;
+        name: string;
+        profile_id: string;
+        status: IRecipientStatus;
+        type: IRecipientType;
+    };
+}
+export interface IHistory {
+    created_at: string;
+    envelope_id: string;
+    event: IHistoryEvent;
+    event_detail: IEventDetail;
+    id: string;
+    role_name: string;
+}
+export interface IDocumentSearchOptions {
+    rows?: number;
+    page?: number;
+    sort_by?: 'updated_at' | 'created_at';
+    ascending?: boolean;
+    is_owner?: boolean;
+    is_recipient?: boolean;
+    envelope_status: IDocumentStatus[];
+    recipient_status: IDocumentStatus[];
+}
+export declare type IHistoryEvent = 'recipient:invited' | 'recipient:opened' | 'recipient:agreed' | 'recipient:signed' | 'recipient:submitted';
+export declare type IEventDetail = 'in_app' | 'mail' | 'signer' | '';
+export declare const getSummary: (page: number) => Promise<IDocumentsSummary>;
+export declare const search: (params: any) => Promise<IDocumentsSearchResult>;
+export declare const Documents: {
+    getSummary: (page: number) => Promise<IDocumentsSummary>;
+    search: (params: any) => Promise<IDocumentsSearchResult>;
+};

package/dist/Api/Documents.js

@@ -0,0 +1,47 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { Endpoint } from './Endpoint';
+export var getSummary = function (page) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post('/documents/summary', { page: page }).then(function (r) { return r.data; })];
+}); }); };
+export var search = function (params) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post('/documents/search', params).then(function (r) { return r.data; })];
+}); }); };
+export var Documents = {
+    getSummary: getSummary,
+    search: search,
+};

package/dist/Api/Endpoint.d.ts

@@ -0,0 +1,2 @@
+export declare const Endpoint: import("axios").AxiosInstance;
+export declare const setAuthToken: (accessToken: string | null) => void;

package/dist/Api/Endpoint.js

@@ -0,0 +1,9 @@
+import axios from 'axios';
+export var Endpoint = axios.create({
+    baseURL: 'https://stage-api.verdocs.com/',
+    timeout: 3000,
+    headers: { 'X-Client-ID': '1234' },
+});
+export var setAuthToken = function (accessToken) {
+    Endpoint.defaults.headers.Authorization = "Bearer " + accessToken;
+};

package/dist/Api/Notifications.d.ts

@@ -0,0 +1 @@
+export declare const getNotifications: () => Promise<any>;

package/dist/Api/Notifications.js

@@ -0,0 +1,40 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        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; })];
+}); }); };

package/dist/Api/Templates.d.ts

@@ -0,0 +1,33 @@
+export interface ITemplateSummaryEntry {
+    id: string;
+    name: string;
+    sender: string;
+    counter: number;
+    description: string | null;
+    created_at: string;
+    updated_at: string;
+    is_personal: boolean;
+    is_public: boolean;
+    profile_id: string;
+    organization_id: string;
+    last_used_at: string | null;
+    document_name: string | null;
+    star_counter: number;
+    tag_name: string | null;
+    is_starred: boolean;
+}
+export interface ITemplatesSummary {
+    page: number;
+    total: number;
+    result: ITemplateSummaryEntry[];
+}
+export declare const getTemplates: () => Promise<any>;
+export declare const searchTemplates: () => Promise<any>;
+export declare const getSummary: (page: number) => Promise<ITemplatesSummary>;
+export declare const toggleStar: (templateId: string) => Promise<ITemplateSummaryEntry>;
+export declare const Templates: {
+    getSummary: (page: number) => Promise<ITemplatesSummary>;
+    getTemplates: () => Promise<any>;
+    searchTemplates: () => Promise<any>;
+    toggleStar: (templateId: string) => Promise<ITemplateSummaryEntry>;
+};

package/dist/Api/Templates.js

@@ -0,0 +1,55 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { Endpoint } from './Endpoint';
+export var getTemplates = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.get('/templates').then(function (r) { return r.data; })];
+}); }); };
+export var searchTemplates = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post('/templates/search').then(function (r) { return r.data; })];
+}); }); };
+export var getSummary = function (page) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post('/templates/summary', { page: page }).then(function (r) { return r.data; })];
+}); }); };
+export var toggleStar = function (templateId) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post("/templates/" + templateId + "/stars/toggle").then(function (r) { return r.data; })];
+}); }); };
+export var Templates = {
+    getSummary: getSummary,
+    getTemplates: getTemplates,
+    searchTemplates: searchTemplates,
+    toggleStar: toggleStar,
+};