@verdocs/js-sdk 1.1.8 → 1.1.12

package/Documents/Documents.d.ts

@@ -1,4 +1,5 @@
 import { ISigningSession, ISigningSessionRequest } from './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';
@@ -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?: IFieldSetting;
+    setting?: IFieldSetting;
+    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;
@@ -150,3 +176,4 @@ 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>;

package/Documents/Documents.js

@@ -108,3 +108,10 @@ 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; })];
+    });
+}); };

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

@@ -5,7 +5,13 @@ export interface ISignature {
     created_at?: Date;
     updated_at?: Date;
 }
-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/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;
@@ -128,13 +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;
@@ -145,36 +145,39 @@ export interface IDocument {
     mime: string;
     thumbnail_url: string;
 }
-export interface IField {
+export interface ITemplateField {
     name: string;
     role_name: string;
     template_id: string;
     type: string;
     required: boolean;
-    setting?: ISetting;
+    setting?: IFieldSetting;
     page_sequence: number;
     validator?: string;
     label?: string;
-    prepared?: boolean;
 }
-export interface ISetting {
+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[];
+    [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

@@ -16,7 +16,7 @@ export var TemplateSenderTypes;
     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["EVERYONE_AS_CREATOR"] = "everyone_as_creator";
 })(TemplateSenderTypes || (TemplateSenderTypes = {}));
 export var TemplateActions;
 (function (TemplateActions) {

package/Utils/Fields.d.ts

@@ -1,12 +1,11 @@
-import { IField } from '../Templates/Types';
-export declare function getHeight(field: IField): number;
-export declare function getWidth(field: IField): number;
+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: 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 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,5 +1,5 @@
 export function getHeight(field) {
-    var _a;
+    var settings = field.settings || field.setting || {};
     switch (field.type) {
         case 'signature':
         case 'initial':
@@ -12,10 +12,10 @@ export function getHeight(field) {
         case 'payment':
             return 24;
     }
-    return ((_a = field.setting) === null || _a === void 0 ? void 0 : _a.height) || 0;
+    return settings.height || 0;
 }
 export function getWidth(field) {
-    var _a, _b;
+    var settings = field.settings || field.setting || {};
     switch (field.type) {
         case 'signature':
         case 'initial':
@@ -30,9 +30,9 @@ export function getWidth(field) {
         case 'date':
             return 64;
         case 'dropdown':
-            return ((_a = field.setting) === null || _a === void 0 ? void 0 : _a.width) || 64;
+            return (settings === null || settings === void 0 ? void 0 : settings.width) || 64;
     }
-    return ((_b = field.setting) === null || _b === void 0 ? void 0 : _b.width) || 0;
+    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 +43,6 @@ export function getRLeft(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) {
@@ -94,14 +56,14 @@ export function blobToBase64(image) {
     });
 }
 export function getInputStyle(field, mode, browserType) {
-    var fontSize = 11;
-    var _a = field.setting, setting = _a === void 0 ? {} : _a;
+    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 (setting.font_size ||
+    if (settings.font_size ||
         field.type === 'date' ||
         field.type === 'signature' ||
         field.type === 'initial' ||
@@ -123,14 +85,14 @@ export function getInputStyle(field, mode, browserType) {
     if ((field === null || field === void 0 ? void 0 : field.prepared) === true && mode !== 'prepareview') {
         style.visibility = 'hidden';
     }
-    if (setting.color) {
-        style.color = setting.color;
+    if (settings.color) {
+        style.color = settings.color;
     }
-    if (setting.upperCase) {
+    if (settings.upperCase) {
         style.textTransform = 'uppercase';
     }
-    if (setting.leading > 0) {
-        style.lineHeight = "".concat(rescale(1, setting.leading + 0.5), "px");
+    if (settings.leading) {
+        style.lineHeight = "".concat(rescale(1, settings.leading + 0.5), "px");
     }
     return style;
 }

package/package.json

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