@verdocs/js-sdk 1.1.9 → 1.1.13

package/Documents/Documents.d.ts

@@ -1,5 +1,5 @@
 import { ISigningSession, ISigningSessionRequest } from './Types';
-import { ISetting } from '../Templates/Types';
+import { IFieldSetting } 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';
@@ -81,8 +81,8 @@ export interface IDocumentField {
     recipient_role: string;
     type: string;
     required: boolean;
-    settings?: ISetting;
-    setting?: ISetting;
+    settings?: IFieldSetting;
+    setting?: IFieldSetting;
     validator: string | null;
     prepared?: boolean;
 }
@@ -176,3 +176,5 @@ export declare const getSigningSession: (params: ISigningSessionRequest) => Prom
 export declare const getDocumentRecipients: (documentId: string) => Promise<IRecipient[]>;
 export declare const getDocument: (documentId: string) => Promise<IDocument>;
 export declare const getDocumentFile: (documentId: string, envelopeDocumentId: string) => Promise<string>;
+export declare const updateDocumentField: (documentId: string, fieldName: string, value: any) => Promise<IFieldSetting>;
+export declare const updateDocumentFieldSignature: (documentId: string, fieldName: string, signatureId: string) => Promise<IFieldSetting>;

package/Documents/Documents.js

@@ -108,3 +108,17 @@ export var getDocumentFile = function (documentId, envelopeDocumentId) { return
                 .then(function (r) { return Buffer.from(r.data, 'binary').toString('base64'); })];
     });
 }); };
+export var updateDocumentField = function (documentId, fieldName, value) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .api.put("/documents/".concat(documentId, "/fields/").concat(fieldName), value)
+                .then(function (r) { return r.data; })];
+    });
+}); };
+export var updateDocumentFieldSignature = function (documentId, fieldName, signatureId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .api.put("/documents/".concat(documentId, "/fields/").concat(fieldName, "/signature/").concat(signatureId))
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/Documents/Initials.d.ts

@@ -0,0 +1,14 @@
+export interface IInitials {
+    id?: string;
+    profile_id: string;
+    url: string;
+    created_at?: Date;
+    updated_at?: Date;
+}
+/**
+ * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
+ * an initials block to be used for all initials fields in the document. Thus, this is typically called one time to
+ * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
+ * to be "stamped" by the user.
+ */
+export declare const createInitials: (name: string, initials: string | Blob) => Promise<IInitials>;

package/Documents/Initials.js

@@ -0,0 +1,14 @@
+import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
+ * an initials block to be used for all initials fields in the document. Thus, this is typically called one time to
+ * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
+ * to be "stamped" by the user.
+ */
+export var createInitials = function (name, initials) {
+    var data = new FormData();
+    data.append('initial', initials, name);
+    return getEndpoint()
+        .api.post("/initials", data)
+        .then(function (r) { return r.data; });
+};

package/Documents/Signatures.d.ts

@@ -1,11 +1,18 @@
 export interface ISignature {
-    id?: string;
+    id: string;
     profile_id: string;
     url: string;
-    created_at?: Date;
-    updated_at?: Date;
+    deleted: boolean;
+    created_at: string;
+    updated_at: string;
 }
-export declare const createSignature: (params: any) => Promise<ISignature>;
+/**
+ * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
+ * a signature block to be used for all signature fields in the document. Thus, this is typically called one time to
+ * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
+ * to be "stamped" by the user.
+ */
+export declare const createSignature: (name: string, signature: string | Blob) => Promise<ISignature>;
 export declare const getSignatures: () => Promise<ISignature[]>;
 export declare const getSignature: (signatureId: string) => Promise<any>;
 export declare const deleteSignature: (signatureId: string) => Promise<any>;

package/Documents/Signatures.js

@@ -1,7 +1,15 @@
 import { getEndpoint } from '../HTTP/Transport';
-export var createSignature = function (params) {
+/**
+ * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
+ * a signature block to be used for all signature fields in the document. Thus, this is typically called one time to
+ * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
+ * to be "stamped" by the user.
+ */
+export var createSignature = function (name, signature) {
+    var data = new FormData();
+    data.append('signature', signature, name);
     return getEndpoint()
-        .api.post('/signatures', params)
+        .api.post("/signatures", data)
         .then(function (r) { return r.data; });
 };
 export var getSignatures = function () {

package/Documents/index.d.ts

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

package/Documents/index.js

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

package/HTTP/VerdocsEndpoint.d.ts

@@ -57,6 +57,18 @@ export declare class VerdocsEndpoint {
      * ```
      */
     setAuthorization(accessToken: string | null): void;
+    /**
+     * Set the auth token used for signing sessions. Separating user from signing auth allows the same endpoint to be
+     * used for multiple operations, although it is recommended that a separate endpoint be created for each operation.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setSigningAuthorization(accessToken);
+     * ```
+     */
+    setSigningAuthorization(accessToken: string | null): void;
     /**
      * Set the base URL for API calls. May also be set via the constructor.
      *

package/HTTP/VerdocsEndpoint.js

@@ -75,6 +75,25 @@ var VerdocsEndpoint = /** @class */ (function () {
             delete this.api.defaults.headers.Authorization;
         }
     };
+    /**
+     * Set the auth token used for signing sessions. Separating user from signing auth allows the same endpoint to be
+     * used for multiple operations, although it is recommended that a separate endpoint be created for each operation.
+     *
+     * ```typescript
+     * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+     *
+     * const endpoint = new Endpoint();
+     * endpoint.setSigningAuthorization(accessToken);
+     * ```
+     */
+    VerdocsEndpoint.prototype.setSigningAuthorization = function (accessToken) {
+        if (accessToken) {
+            this.api.defaults.headers.signer = "Bearer ".concat(accessToken);
+        }
+        else {
+            delete this.api.defaults.headers.signer;
+        }
+    };
     /**
      * Set the base URL for API calls. May also be set via the constructor.
      *

package/Organizations/Types.d.ts

@@ -5,12 +5,12 @@ export interface IOrganization {
     /** The organization's name. */
     name: string;
     address: string | null;
+    address2: string | null;
     phone: string | null;
-    /** If the organization is a business, its name. Note that a business name can be different from an organization name. */
-    business_name: string | null;
     /** If true, the organization is a business */
     is_business: boolean;
-    address2: string | null;
+    /** If the organization is a business, its name. Note that a business name can be different from an organization name. */
+    business_name: string | null;
     contact_email: string | null;
     timezone: string | null;
     envelope_responsible: boolean;

package/Templates/Types.d.ts

@@ -1,3 +1,4 @@
+import { IOrganization } from '../Organizations/Types';
 export interface ITemplate {
     template_document?: ITemplateAsset;
     pages?: IPage[];
@@ -18,6 +19,7 @@ export interface ITemplate {
     is_public?: boolean;
     sender?: TTemplateSender;
     description?: string;
+    organization?: IOrganization;
 }
 export interface ITemplateSummaryEntry {
     id: string;
@@ -151,20 +153,28 @@ export interface ITemplateField {
     template_id: string;
     type: string;
     required: boolean;
-    setting?: ISetting;
+    setting?: IFieldSetting;
     page_sequence: number;
     validator?: string;
     label?: string;
 }
-export interface ISetting {
-    x?: number;
-    y?: number;
+export interface IFieldSetting {
+    x: number;
+    y: number;
     width?: number;
     height?: number;
-    result?: string;
+    result?: any;
     type?: string;
-    options?: any[];
     value?: string;
+    leading?: number;
+    alignment?: number;
+    upperCase?: boolean;
+    options?: any[];
+    base64?: string;
+    hash?: string;
+    ip_address?: string;
+    signature_id?: string;
+    signed_at?: string;
     [key: string]: any;
 }
 export interface IPage {

package/Utils/Fields.d.ts

@@ -1,12 +1,5 @@
-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;

package/Utils/Fields.js

@@ -1,39 +1,3 @@
-export function getHeight(field) {
-    var settings = field.settings || field.setting || {};
-    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 settings.height || 0;
-}
-export function getWidth(field) {
-    var settings = field.settings || field.setting || {};
-    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 (settings === null || settings === void 0 ? void 0 : settings.width) || 64;
-    }
-    return (settings === null || settings === void 0 ? void 0 : settings.width) || 0;
-}
 export function getRTop(y, fieldHeight, iTextHeight, yRatio) {
     return iTextHeight - (y + fieldHeight) * yRatio;
 }
@@ -43,44 +7,6 @@ export function getRLeft(x, ratio) {
 export function getRValue(y, ratio) {
     return y * ratio;
 }
-export function getStyle(field) {
-    var settings = field.settings || field.setting || {};
-    var height = getHeight(field);
-    var style = {
-        left: ((settings === null || settings === void 0 ? void 0 : settings.x) || 0) + 'px',
-        bottom: ((settings === null || settings === void 0 ? void 0 : settings.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 = ((settings === null || settings === void 0 ? void 0 : settings.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) {
@@ -93,83 +19,6 @@ export function blobToBase64(image) {
         fileReader.readAsDataURL(image);
     });
 }
-export function getInputStyle(field, mode, browserType) {
-    var settings = field.settings || field.setting || {};
-    var fontSize = (settings === null || settings === void 0 ? void 0 : settings.font_size) || 11;
-    var style = {
-        height: '100%',
-        width: '100%',
-        background: 'none',
-    };
-    if (settings.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 (settings.color) {
-        style.color = settings.color;
-    }
-    if (settings.upperCase) {
-        style.textTransform = 'uppercase';
-    }
-    if (settings.leading) {
-        style.lineHeight = "".concat(rescale(1, settings.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.1.9",
+  "version": "1.1.13",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",