@verdocs/js-sdk 1.1.5 → 1.1.9

package/Documents/Documents.d.ts

@@ -1,4 +1,5 @@
 import { ISigningSession, ISigningSessionRequest } from './Types';
+import { ISetting } from '../Templates/Types';
 export declare type TDocumentStatus = 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled';
 export declare type TRecipientStatus = 'invited' | 'opened' | 'signed' | 'submitted' | 'canceled' | 'pending' | 'declined';
 export declare type TRecipientType = 'signer' | 'cc' | 'approver';
@@ -63,6 +64,28 @@ export interface IRecipient {
     type: TRecipientType;
     updated_at: string;
 }
+export interface IDocumentAsset {
+    created_at: string;
+    id: string;
+    mime: string;
+    name: string;
+    page_numbers: number;
+    updated_at: string;
+    url: string;
+}
+export interface IDocumentField {
+    envelope_id: string;
+    label: string | null;
+    name: string;
+    page: number;
+    recipient_role: string;
+    type: string;
+    required: boolean;
+    settings?: ISetting;
+    setting?: ISetting;
+    validator: string | null;
+    prepared?: boolean;
+}
 export interface IDocument {
     id: string;
     created_at: string;
@@ -79,6 +102,9 @@ export interface IDocument {
     template_id: string;
     updated_at: string;
     organization_id: string | null;
+    certificate?: IDocumentAsset | null;
+    document?: IDocumentAsset | null;
+    fields?: IDocumentField[];
 }
 export interface IActivityEntry {
     id: string;

package/Documents/Documents.js

@@ -102,7 +102,9 @@ export var getDocument = function (documentId) { return __awaiter(void 0, void 0
 export var getDocumentFile = function (documentId, envelopeDocumentId) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, getEndpoint()
-                .api.get("/documents/".concat(documentId, "/envelope_documents/").concat(envelopeDocumentId, "?file=true"))
-                .then(function (r) { return r.data; })];
+                .api.get("/documents/".concat(documentId, "/envelope_documents/").concat(envelopeDocumentId, "?file=true"), {
+                responseType: 'arraybuffer',
+            })
+                .then(function (r) { return Buffer.from(r.data, 'binary').toString('base64'); })];
     });
 }); };

package/Documents/Recipients.d.ts

@@ -0,0 +1,7 @@
+import { IRecipient } from './Documents';
+export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
+export interface IUpdateRecipientParams {
+    new_full_name?: string;
+    agreed?: boolean;
+}
+export declare const updateRecipientStatus: (documentId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams | undefined) => Promise<IRecipient>;

package/Documents/Recipients.js

@@ -0,0 +1,55 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 { getEndpoint } from '../HTTP/Transport';
+export var updateRecipientStatus = function (documentId, roleName, action, params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .api.put("/documents/".concat(documentId, "/recipients/").concat(roleName), __assign({ role_name: roleName, action: action }, (params || {})))
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/Documents/index.d.ts

@@ -1,4 +1,5 @@
 export * as Documents from './Documents';
+export * as Recipients from './Recipients';
 export * as Stars from './Stars';
 export * as Signatures from './Signatures';
 export * as Types from './Types';

package/Documents/index.js

@@ -1,4 +1,5 @@
 export * as Documents from './Documents';
+export * as Recipients from './Recipients';
 export * as Stars from './Stars';
 export * as Signatures from './Signatures';
 export * as Types from './Types';

package/Templates/Documents.d.ts

@@ -1,4 +1,4 @@
-import { IDocument } from './Types';
+import { ITemplateAsset } from './Types';
 /**
  * Get all the Documents associated to a particular Template.
  *
@@ -18,7 +18,7 @@ export declare const getDocuments: (templateId: string) => Promise<any>;
  * await Documents.createDocument(templateID, params);
  * ```
  */
-export declare const createDocument: (templateId: string, params: any) => Promise<IDocument>;
+export declare const createDocument: (templateId: string, params: any) => Promise<ITemplateAsset>;
 /**
  * Get a specific Document.
  *
@@ -28,7 +28,7 @@ export declare const createDocument: (templateId: string, params: any) => Promis
  * await Documents.getDocument(templateID, documentID);
  * ```
  */
-export declare const getDocument: (templateId: string, documentId: string) => Promise<IDocument>;
+export declare const getDocument: (templateId: string, documentId: string) => Promise<ITemplateAsset>;
 /**
  * Delete a specific Document.
  *

package/Templates/Fields.d.ts

@@ -1,4 +1,4 @@
-import { IField } from './Types';
-export declare const createField: (templateId: string, params: IField) => Promise<IField>;
-export declare const editField: (templateId: string, fieldName: string, params: IField) => Promise<IField>;
+import { ITemplateField } from './Types';
+export declare const createField: (templateId: string, params: ITemplateField) => Promise<ITemplateField>;
+export declare const editField: (templateId: string, fieldName: string, params: ITemplateField) => Promise<ITemplateField>;
 export declare const deleteField: (templateId: string, fieldName: string) => Promise<any>;

package/Templates/Roles.d.ts

@@ -1,8 +1,8 @@
-import { IField, IRole } from './Types';
+import { ITemplateField, IRole } from './Types';
 export declare const createRole: (templateId: string, params: IRole) => Promise<IRole>;
 export declare const getRoles: (templateId: string) => Promise<IRole[]>;
 export declare const getRole: (templateId: string, roleName: string) => Promise<IRole>;
 export declare const editRole: (templateId: string, roleName: string, params: IRole) => Promise<IRole>;
 export declare const deleteRole: (templateId: string, roleName: string) => Promise<any>;
-export declare const getRoleFields: (templateId: string, roleName: string) => Promise<IField[]>;
+export declare const getRoleFields: (templateId: string, roleName: string) => Promise<ITemplateField[]>;
 export declare const deleteSequence: (templateId: string) => Promise<IRole[]>;

package/Templates/Types.d.ts

@@ -1,5 +1,5 @@
 export interface ITemplate {
-    template_document?: IDocument;
+    template_document?: ITemplateAsset;
     pages?: IPage[];
     roles?: IRole[];
     counter?: number;
@@ -49,6 +49,24 @@ export declare enum TemplatePermissions {
     TEMPLATE_MEMBER_DELETE = "template:member:delete",
     TEMPLATE_MEMBER_VISIBILITY = "template:member:visibility"
 }
+export declare enum TemplateSenderTypes {
+    CREATOR = "creator",
+    ORGANIZATION_MEMBER = "organization_member",
+    ORGANIZATION_MEMBER_AS_CREATOR = "organization_member_as_creator",
+    EVERYONE = "everyone",
+    EVERYONE_AS_CREATOR = "everyone_as_creator"
+}
+export declare enum TemplateActions {
+    CREATE_PERSONAL = "create_personal",
+    CREATE_ORG = "create_org",
+    CREATE_PUBLIC = "create_public",
+    READ = "read",
+    WRITE = "write",
+    DELETE = "delete",
+    CHANGE_VISIBILITY_PERSONAL = "change_visibility_personal",
+    CHANGE_VISIBILITY_ORG = "change_visibility_org",
+    CHANGE_VISIBILITY_PUBLIC = "change_visibility_public"
+}
 export interface ITemplateSearchParams {
     id?: string;
     name?: string;
@@ -110,12 +128,13 @@ export interface IRole {
     email?: string;
     type: string;
     sequence: number;
-    fields?: IField[];
+    fields?: ITemplateField[];
     delegator?: boolean;
     message?: string;
     phone?: string;
+    rgba?: string;
 }
-export interface IDocument {
+export interface ITemplateAsset {
     url: string;
     name: string;
     page_numbers: number;
@@ -126,7 +145,7 @@ export interface IDocument {
     mime: string;
     thumbnail_url: string;
 }
-export interface IField {
+export interface ITemplateField {
     name: string;
     role_name: string;
     template_id: string;
@@ -146,15 +165,16 @@ export interface ISetting {
     type?: string;
     options?: any[];
     value?: string;
+    [key: string]: any;
 }
 export interface IPage {
     template_id: string;
     document_id: string;
-    template_document?: IDocument;
+    template_document?: ITemplateAsset;
     sequence: number;
     page_number: number;
     thumbnail_url: string;
-    fields?: IField[];
+    fields?: ITemplateField[];
 }
 export interface IReminder {
     id?: string;

package/Templates/Types.js

@@ -10,6 +10,26 @@ export var TemplatePermissions;
     TemplatePermissions["TEMPLATE_MEMBER_DELETE"] = "template:member:delete";
     TemplatePermissions["TEMPLATE_MEMBER_VISIBILITY"] = "template:member:visibility";
 })(TemplatePermissions || (TemplatePermissions = {}));
+export var TemplateSenderTypes;
+(function (TemplateSenderTypes) {
+    TemplateSenderTypes["CREATOR"] = "creator";
+    TemplateSenderTypes["ORGANIZATION_MEMBER"] = "organization_member";
+    TemplateSenderTypes["ORGANIZATION_MEMBER_AS_CREATOR"] = "organization_member_as_creator";
+    TemplateSenderTypes["EVERYONE"] = "everyone";
+    TemplateSenderTypes["EVERYONE_AS_CREATOR"] = "everyone_as_creator";
+})(TemplateSenderTypes || (TemplateSenderTypes = {}));
+export var TemplateActions;
+(function (TemplateActions) {
+    TemplateActions["CREATE_PERSONAL"] = "create_personal";
+    TemplateActions["CREATE_ORG"] = "create_org";
+    TemplateActions["CREATE_PUBLIC"] = "create_public";
+    TemplateActions["READ"] = "read";
+    TemplateActions["WRITE"] = "write";
+    TemplateActions["DELETE"] = "delete";
+    TemplateActions["CHANGE_VISIBILITY_PERSONAL"] = "change_visibility_personal";
+    TemplateActions["CHANGE_VISIBILITY_ORG"] = "change_visibility_org";
+    TemplateActions["CHANGE_VISIBILITY_PUBLIC"] = "change_visibility_public";
+})(TemplateActions || (TemplateActions = {}));
 export var SortOptions;
 (function (SortOptions) {
     SortOptions["CREATED_AT"] = "created_at";

package/Templates/Validators.d.ts

@@ -1,6 +1,11 @@
+import { IRole, ITag } from './Types';
 export interface IValidator {
     name: string;
     regex: string;
 }
 export declare const getValidators: () => Promise<IValidator[]>;
 export declare const getValidator: (validatorName: string) => Promise<IValidator>;
+export declare const isValidEmail: (value: string) => boolean;
+export declare const isValidPhone: (value: string) => boolean;
+export declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
+export declare const isValidTag: (value: string, tags: ITag[]) => boolean;

package/Templates/Validators.js

@@ -1,3 +1,4 @@
+import { simpleE164Validator } from '../Utils/Locales';
 import { getEndpoint } from '../HTTP/Transport';
 export var getValidators = function () {
     return getEndpoint()
@@ -9,3 +10,11 @@ export var getValidator = function (validatorName) {
         .api.get("/validators/".concat(validatorName))
         .then(function (r) { return r.data; });
 };
+var EmailRegEx = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+export var isValidEmail = function (value) { return EmailRegEx.test(value); };
+export var isValidPhone = function (value) { return simpleE164Validator(value); };
+export var isValidRoleName = function (value, roles) { return roles.findIndex(function (role) { return role.name === value; }) !== -1; };
+var TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
+export var isValidTag = function (value, tags) {
+    return TagRegEx.test(value) || tags.findIndex(function (tag) { return tag.tag_name === value; }) !== -1;
+};

package/Utils/Colors.d.ts

@@ -0,0 +1,18 @@
+import { IRole } from '../Templates/Types';
+/**
+ * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
+ */
+export declare function getRGB(rgba: string): string;
+/**
+ * Given a signer role index, return the color code for that signer.
+ */
+export declare function getRGBA(roleIndex: number): "rgba(255, 193, 7, 0.4)" | "rgba(134, 134, 134, 0.3)" | "rgba(156, 39, 176, .4)" | "rgba(33, 150, 243, .4)" | "rgba(220, 231, 117, 0.3)" | "rgba(121, 134, 203, 0.3)" | "rgba(77, 182, 172, 0.3)" | "rgba(255, 202, 165, 0.3)" | "rgba(2, 247, 190, 0.3)" | "rgba(255, 138, 101, 0.3)" | "rgba(82, 255, 79, 0.3)" | "rgba(229, 115, 155, 0.3)";
+/**
+ * Given a role name, return a color code for it. This works by computing a hash code so the specific color returned
+ * is not specified explicitly, but will be the same for every call with the same input value.
+ */
+export declare function nameToRGBA(str: string): string | undefined;
+/**
+ * Helper function to obtain a color code given a role name given various possible inputs.
+ */
+export declare function getRoleColor(name: string, roles: IRole[], index?: number): string | undefined;

package/Utils/Colors.js

@@ -0,0 +1,102 @@
+/**
+ * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
+ */
+export function getRGB(rgba) {
+    var rgbNumbers = rgba.replace('rgba(', '').replace(')', '').split(',');
+    var rgbObject = {
+        red: +rgbNumbers[0],
+        green: +rgbNumbers[1],
+        blue: +rgbNumbers[2],
+        alpha: +rgbNumbers[3],
+    };
+    var alpha = 1 - rgbObject.alpha;
+    var red = Math.round((rgbObject.alpha * (rgbObject.red / 255) + alpha) * 255);
+    var green = Math.round((rgbObject.alpha * (rgbObject.green / 255) + alpha) * 255);
+    var blue = Math.round((rgbObject.alpha * (rgbObject.blue / 255) + alpha) * 255);
+    return '#' + rgbToHex(red) + rgbToHex(green) + rgbToHex(blue);
+}
+/**
+ * Given an RGB string value, returns the hex equivalent.
+ */
+function rgbToHex(rgb) {
+    var hex = rgb.toString(16);
+    if (hex.length < 2) {
+        return '0' + hex;
+    }
+    return hex;
+}
+/**
+ * Given a signer role index, return the color code for that signer.
+ */
+export function getRGBA(roleIndex) {
+    switch (roleIndex % 10) {
+        case 0:
+            return roleIndex === 0 ? 'rgba(255, 193, 7, 0.4)' : 'rgba(134, 134, 134, 0.3)'; // #FFE69C
+        case 1:
+            return 'rgba(156, 39, 176, .4)'; // '#E3C3E9'
+        case 2:
+            return 'rgba(33, 150, 243, .4)'; // '#C1E1FB'
+        case 3:
+            return 'rgba(220, 231, 117, 0.3)';
+        case 4:
+            return 'rgba(121, 134, 203, 0.3)';
+        case 5:
+            return 'rgba(77, 182, 172, 0.3)';
+        case 6:
+            return 'rgba(255, 202, 165, 0.3)';
+        case 7:
+            return 'rgba(2, 247, 190, 0.3)';
+        case 8:
+            return 'rgba(255, 138, 101, 0.3)';
+        case 9:
+            return 'rgba(82, 255, 79, 0.3)';
+        default:
+            return 'rgba(229, 115, 155, 0.3)';
+    }
+}
+/**
+ * Given a role name, return a color code for it. This works by computing a hash code so the specific color returned
+ * is not specified explicitly, but will be the same for every call with the same input value.
+ */
+export function nameToRGBA(str) {
+    if (!!str) {
+        var validNum = parseInt(str.slice(-1), 10);
+        if (!isNaN(validNum)) {
+            str += (validNum * 99).toString();
+        }
+        var hash = 0;
+        for (var i = 0; i < str.length; i++) {
+            hash = str.charCodeAt(i) + ((hash << 5) - hash);
+        }
+        hash = Math.round(hash / 1.3);
+        var c = (hash & 0x00ffff08).toString(16).toUpperCase();
+        var hex = '#' + '00000'.substring(0, 6 - c.length) + c;
+        var result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
+        var color = {
+            r: parseInt(result[1], 16),
+            g: parseInt(result[2], 16),
+            b: parseInt(result[3], 16),
+        };
+        return "rgba(".concat(color.r, ", ").concat(color.g, ", ").concat(color.b, ", 0.2)");
+    }
+}
+/**
+ * Helper function to obtain a color code given a role name given various possible inputs.
+ */
+export function getRoleColor(name, roles, index) {
+    if (index) {
+        return getRGBA(index);
+    }
+    else if (roles && roles.length > 0) {
+        var roleIndex = roles.findIndex(function (role) { return role.name === name; });
+        if (roleIndex > -1) {
+            return roles[roleIndex].rgba || getRGBA(roleIndex);
+        }
+        else {
+            return nameToRGBA(name);
+        }
+    }
+    else {
+        return nameToRGBA(name);
+    }
+}

package/Utils/DateTime.d.ts

@@ -1 +1,6 @@
 export declare const formatShortTimeAgo: (val: any) => string;
+export interface ITimePeriod {
+    start_time: string;
+    end_time: string;
+}
+export declare function timePeriod(type: string): ITimePeriod | null;

package/Utils/DateTime.js

@@ -39,3 +39,41 @@ export var formatShortTimeAgo = function (val) {
     }
     return "".concat(timeDiff, "S");
 };
+export function timePeriod(type) {
+    var endDate = new Date().getTime();
+    var today = new Date();
+    var month = today.getMonth();
+    var year = today.getFullYear();
+    var startDate = null;
+    switch (type) {
+        case '30d':
+            startDate = endDate - 60 * 60 * 24 * 30 * 1000;
+            break;
+        case '60d':
+            startDate = endDate - 60 * 60 * 24 * 60 * 1000;
+            break;
+        case '6m':
+            startDate = endDate - 60 * 60 * 24 * 30 * 6 * 1000;
+            break;
+        case 'this_month':
+            startDate = new Date(year, month, 1).getTime();
+            break;
+        case 'last_month':
+            startDate = new Date(year, month - 1, 1).getTime();
+            endDate = new Date(year, month, 0).getTime();
+            break;
+        case 'this_year':
+            startDate = new Date(year, 0, 1);
+            break;
+        case 'all_time':
+        default:
+            return null;
+    }
+    if (startDate === null && endDate === null) {
+        return null;
+    }
+    return {
+        start_time: new Date(startDate).toISOString(),
+        end_time: new Date(endDate).toISOString(),
+    };
+}

package/Utils/Fields.d.ts

@@ -0,0 +1,12 @@
+import { IDocumentField } from '../Documents/Documents';
+export declare function getHeight(field: IDocumentField): number;
+export declare function getWidth(field: IDocumentField): number;
+export declare function getRTop(y: number, fieldHeight: number, iTextHeight: number, yRatio: number): number;
+export declare function getRLeft(x: number, ratio: number): number;
+export declare function getRValue(y: number, ratio: number): number;
+export declare function getStyle(field: IDocumentField): Record<string, string>;
+export declare function blobToBase64(image: Blob): Promise<unknown>;
+export declare function getInputStyle(field: IDocumentField, mode: string, browserType: string): Record<string, string>;
+export declare function getCheckboxLabelStyle(required: boolean): Record<string, any>;
+export declare function getLetterSpacing(browserType: string): -0.0018 | -0.23594210526315787 | -0.0019;
+export declare function rescale(r: number, n: number): number;