@verdocs/js-sdk 1.1.7 → 1.1.8

package/Documents/Recipients.d.ts

@@ -1,6 +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<string>;
+export declare const updateRecipientStatus: (documentId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams | undefined) => Promise<IRecipient>;

package/Templates/Types.d.ts

@@ -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;
@@ -114,6 +132,7 @@ export interface IRole {
     delegator?: boolean;
     message?: string;
     phone?: string;
+    rgba?: string;
 }
 export interface IDocument {
     url: string;
@@ -136,6 +155,7 @@ export interface IField {
     page_sequence: number;
     validator?: string;
     label?: string;
+    prepared?: boolean;
 }
 export interface ISetting {
     x?: number;

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"; // Creator would be sender of envelope no matter who creates the envelope
+})(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 { IField } from '../Templates/Types';
+export declare function getHeight(field: IField): number;
+export declare function getWidth(field: IField): 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: IField): Record<string, string>;
+export declare function blobToBase64(image: Blob): Promise<unknown>;
+export declare function getInputStyle(field: IField, 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;

package/Utils/Fields.js

@@ -0,0 +1,175 @@
+export function getHeight(field) {
+    var _a;
+    switch (field.type) {
+        case 'signature':
+        case 'initial':
+            return 36;
+        case 'checkbox':
+        case 'checkbox_group':
+        case 'radio_button_group':
+            return 13.5;
+        case 'attachment':
+        case 'payment':
+            return 24;
+    }
+    return ((_a = field.setting) === null || _a === void 0 ? void 0 : _a.height) || 0;
+}
+export function getWidth(field) {
+    var _a, _b;
+    switch (field.type) {
+        case 'signature':
+        case 'initial':
+            return 82.63636363636;
+        case 'checkbox':
+        case 'checkbox_group':
+        case 'radio_button_group':
+            return 13.5;
+        case 'attachment':
+        case 'payment':
+            return 24;
+        case 'date':
+            return 64;
+        case 'dropdown':
+            return ((_a = field.setting) === null || _a === void 0 ? void 0 : _a.width) || 64;
+    }
+    return ((_b = field.setting) === null || _b === void 0 ? void 0 : _b.width) || 0;
+}
+export function getRTop(y, fieldHeight, iTextHeight, yRatio) {
+    return iTextHeight - (y + fieldHeight) * yRatio;
+}
+export function getRLeft(x, ratio) {
+    return x * ratio;
+}
+export function getRValue(y, ratio) {
+    return y * ratio;
+}
+export function getStyle(field) {
+    var _a, _b, _c;
+    var height = getHeight(field);
+    var style = {
+        left: (((_a = field.setting) === null || _a === void 0 ? void 0 : _a.x) || 0) + 'px',
+        bottom: (((_b = field.setting) === null || _b === void 0 ? void 0 : _b.y) || 0) + 'px',
+        height: '100%',
+        width: '100%',
+    };
+    switch (field.type) {
+        case 'textbox':
+        case 'date':
+        case 'timestamp':
+        case 'placeholder':
+        case 'dropdown':
+            style.maxHeight = height + 'px';
+            style.maxWidth = (((_c = field.setting) === null || _c === void 0 ? void 0 : _c.width) || 0) + 'px';
+            break;
+        case 'checkbox':
+        case 'checkbox_group':
+        case 'radio_button_group':
+            style.maxHeight = 13.5 + 'px';
+            style.maxWidth = 13.5 + 'px';
+            break;
+        case 'attachment':
+        case 'payment':
+            style.maxHeight = 24 + 'px';
+            style.maxWidth = 24 + 'px';
+            break;
+        case 'signature':
+        case 'initial':
+            style.maxHeight = 36 + 'px';
+            style.maxWidth = 82.63636363636 + 'px';
+            style['line-height'] = 36 + 'px';
+            break;
+    }
+    return style;
+}
+export function blobToBase64(image) {
+    var fileReader = new FileReader();
+    return new Promise(function (resolve, reject) {
+        fileReader.onerror = function () {
+            reject(new DOMException('Problem reading blob.'));
+        };
+        fileReader.onload = function () {
+            resolve(fileReader.result);
+        };
+        fileReader.readAsDataURL(image);
+    });
+}
+export function getInputStyle(field, mode, browserType) {
+    var fontSize = 11;
+    var _a = field.setting, setting = _a === void 0 ? {} : _a;
+    var style = {
+        height: '100%',
+        width: '100%',
+        background: 'none',
+    };
+    if (setting.font_size ||
+        field.type === 'date' ||
+        field.type === 'signature' ||
+        field.type === 'initial' ||
+        field.type === 'timestamp') {
+        style.fontSize = fontSize + 'px';
+        style.letterSpacing = '.3px !important';
+    }
+    if (field.type === 'dropdown') {
+        style.fontSize = '10.8px';
+        delete style.background;
+    }
+    if (field.type === 'textbox') {
+        style.fontSize = fontSize + 'px';
+        style.letterSpacing = getLetterSpacing(browserType) + 'px';
+    }
+    if (field.required) {
+        style.border = '1px solid #cc0000';
+    }
+    if ((field === null || field === void 0 ? void 0 : field.prepared) === true && mode !== 'prepareview') {
+        style.visibility = 'hidden';
+    }
+    if (setting.color) {
+        style.color = setting.color;
+    }
+    if (setting.upperCase) {
+        style.textTransform = 'uppercase';
+    }
+    if (setting.leading > 0) {
+        style.lineHeight = "".concat(rescale(1, setting.leading + 0.5), "px");
+    }
+    return style;
+}
+export function getCheckboxLabelStyle(required) {
+    var labelStyle = {
+        position: 'absolute',
+        top: 0,
+        left: 0,
+        cursor: 'pointer',
+        height: "13.5px",
+        width: "13.5px",
+        backgroundColor: 'transparent',
+        border: '1px solid #777',
+    };
+    if (required) {
+        labelStyle.boxShadow = '0 0 0 1px #cc0000';
+    }
+    return labelStyle;
+}
+export function getLetterSpacing(browserType) {
+    switch (browserType) {
+        case 'opera':
+            return -0.0018;
+        case 'firefox':
+            return -0.23594210526315787;
+        case 'ie':
+            return -0.0019;
+        case 'edge':
+            return -0.0019;
+        case 'chrome':
+            return -0.0018;
+        case 'safari':
+            return -0.0018;
+        case 'blink':
+            return -0.0018;
+        default:
+            return -0.0018;
+    }
+}
+export function rescale(r, n) {
+    return r * n;
+}

package/Utils/Locales.d.ts

@@ -0,0 +1,18 @@
+export interface ICountry {
+    code: string;
+    name: string;
+    value: string;
+}
+export declare const Countries: ICountry[];
+export declare function getCountryByCode(code: string): ICountry | null;
+export declare function isFrenchGuiana(code: string): boolean;
+export declare function isGuadeloupe(code: string): boolean;
+export declare function isMartinique(code: string): boolean;
+export declare function isMayotte(code: string): boolean;
+export declare function getPlusOneCountry(code: string): ICountry | null;
+export declare function isCanada(code: string): boolean;
+export declare function isAmericanSamoa(code: string): boolean;
+export declare function isDominicanRepublic(code: string): boolean;
+export declare function isPuertoRico(code: string): boolean;
+export declare function getMatchingCountry(code: string, substrings: number): number;
+export declare function simpleE164Validator(code: string): boolean;