@verdocs/web-sdk 1.11.2 → 1.11.4

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-02-20T17:17:18",
+  "timestamp": "2023-02-21T17:56:45",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -188,11 +188,8 @@
         "verdocs-template-fields": [
           "verdocs-component-error",
           "verdocs-loader",
-          "verdocs-document-page",
-          "verdocs-floating-menu"
-        ],
-        "verdocs-floating-menu": [
-          "verdocs-toolbar-icon"
+          "verdocs-toolbar-icon",
+          "verdocs-template-document-page"
         ]
       }
     },
@@ -993,22 +990,14 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-preview",
         "verdocs-sign",
-        "verdocs-template-fields",
         "verdocs-view"
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "verdocs-preview": [
-          "verdocs-document-page"
-        ],
         "verdocs-sign": [
           "verdocs-document-page"
         ],
-        "verdocs-template-fields": [
-          "verdocs-document-page"
-        ],
         "verdocs-view": [
           "verdocs-document-page"
         ]
@@ -1430,6 +1419,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "settingsChanged",
           "detail": "{ fieldName: string; }",
@@ -1616,6 +1614,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "settingsChanged",
           "detail": "{ fieldName: string; }",
@@ -1760,6 +1767,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "fieldChange",
           "detail": "string",
@@ -1971,6 +1987,15 @@
           "docs": "Event emitted when the user cancels the process.",
           "docsTags": []
         },
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "fieldChange",
           "detail": "string",
@@ -2327,6 +2352,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "initialComplete",
           "detail": "string",
@@ -2518,6 +2552,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "settingsChanged",
           "detail": "{ fieldName: string; }",
@@ -2721,6 +2764,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "fieldChange",
           "detail": "string",
@@ -2931,6 +2983,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "settingsChanged",
           "detail": "{ fieldName: string; }",
@@ -3117,6 +3178,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "settingsChanged",
           "detail": "{ fieldName: string; }",
@@ -3303,6 +3373,15 @@
         }
       ],
       "events": [
+        {
+          "event": "deleted",
+          "detail": "{ fieldName: string; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the field is deleted.",
+          "docsTags": []
+        },
         {
           "event": "settingsChanged",
           "detail": "{ fieldName: string; }",
@@ -3381,18 +3460,13 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "verdocs-template-fields"
-      ],
+      "dependents": [],
       "dependencies": [
         "verdocs-toolbar-icon"
       ],
       "dependencyGraph": {
         "verdocs-floating-menu": [
           "verdocs-toolbar-icon"
-        ],
-        "verdocs-template-fields": [
-          "verdocs-floating-menu"
         ]
       }
     },
@@ -3726,6 +3800,7 @@
         "verdocs-template-create",
         "verdocs-template-fields",
         "verdocs-template-name",
+        "verdocs-template-recipients",
         "verdocs-view"
       ],
       "dependencies": [],
@@ -3748,6 +3823,9 @@
         "verdocs-template-name": [
           "verdocs-loader"
         ],
+        "verdocs-template-recipients": [
+          "verdocs-loader"
+        ],
         "verdocs-view": [
           "verdocs-loader"
         ]
@@ -3956,12 +4034,12 @@
       "dependents": [],
       "dependencies": [
         "verdocs-loader",
-        "verdocs-document-page"
+        "verdocs-template-document-page"
       ],
       "dependencyGraph": {
         "verdocs-preview": [
           "verdocs-loader",
-          "verdocs-document-page"
+          "verdocs-template-document-page"
         ]
       }
     },
@@ -5156,6 +5234,162 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/elements/verdocs-template-document-page/verdocs-template-document-page.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-template-document-page",
+      "docs": "Represents one document page. This is primarily a layout container used to coordinate positions of\npage-related layers such as the page itself, signature fields, etc. It is not intended to be used\non its own as an individual component.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "documentId",
+          "type": "string",
+          "mutable": false,
+          "attr": "document-id",
+          "reflectToAttr": false,
+          "docs": "The ID of the document to display.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The endpoint to load from.",
+          "docsTags": [],
+          "default": "VerdocsEndpoint.getDefault()",
+          "values": [
+            {
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "layers",
+          "type": "IPageLayer[]",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The layers that will be rendered. The DOM structure will be a DIV container with one child DIV for each layer.\nThe parent DIV will have a unique ID, and each child DIV will have that ID with the layer name appended, e.g.\nif `pages` was ['page', 'fields'] the structure will be:\n\n```\n    <div id=\"verdocs-document-page-ker2fr1p9\">\n      <div id=\"verdocs-document-page-ker2fr1p9-page\"></div>\n      <div id=\"verdocs-document-page-ker2fr1p9-fields\"></div>\n    </div>\n```",
+          "docsTags": [],
+          "default": "[{name: 'page', type: 'canvas'}]",
+          "values": [
+            {
+              "type": "IPageLayer[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "pageNumber",
+          "type": "number",
+          "mutable": false,
+          "attr": "page-number",
+          "reflectToAttr": false,
+          "docs": "The page number being rendered. (Reminder: page numbers are 1-based.)",
+          "docsTags": [],
+          "default": "1",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "templateId",
+          "type": "string",
+          "mutable": false,
+          "attr": "template-id",
+          "reflectToAttr": false,
+          "docs": "The ID of the template the document is for.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "virtualHeight",
+          "type": "number",
+          "mutable": true,
+          "attr": "virtual-height",
+          "reflectToAttr": false,
+          "docs": "The \"virtual\" height of the page canvas.  Defaults to 792 which at 72dpi is 11\" tall. This is used to compute\nthe aspect ratio of the final rendered element when scaling up/down.",
+          "docsTags": [],
+          "default": "792",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "virtualWidth",
+          "type": "number",
+          "mutable": false,
+          "attr": "virtual-width",
+          "reflectToAttr": false,
+          "docs": "The \"virtual\" width of the page canvas. Defaults to 612 which at 72dpi is 8.5\" wide. This is used to compute\nthe aspect ratio of the final rendered element when scaling up/down.",
+          "docsTags": [],
+          "default": "612",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "pageRendered",
+          "detail": "IDocumentPageInfo",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Fired when a page has been rendered. This is also fired when the page is resized.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-preview",
+        "verdocs-template-fields"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-preview": [
+          "verdocs-template-document-page"
+        ],
+        "verdocs-template-fields": [
+          "verdocs-template-document-page"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/templates/verdocs-template-field-properties/verdocs-template-field-properties.tsx",
       "encapsulation": "none",
@@ -5354,6 +5588,23 @@
           ],
           "optional": false,
           "required": false
+        },
+        {
+          "name": "toolbarTargetId",
+          "type": "string",
+          "mutable": false,
+          "attr": "toolbar-target-id",
+          "reflectToAttr": false,
+          "docs": "If set, (recommended), the host application should create a <DIV> element with a unique ID. When this\ncomponent renders, the toolbar will be removed from its default location and placed in the target element.\nThis allows the parent application to more easily control its placement and scroll effects.",
+          "docsTags": [],
+          "default": "null",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [],
@@ -5405,18 +5656,15 @@
       "dependencies": [
         "verdocs-component-error",
         "verdocs-loader",
-        "verdocs-document-page",
-        "verdocs-floating-menu"
+        "verdocs-toolbar-icon",
+        "verdocs-template-document-page"
       ],
       "dependencyGraph": {
         "verdocs-template-fields": [
           "verdocs-component-error",
           "verdocs-loader",
-          "verdocs-document-page",
-          "verdocs-floating-menu"
-        ],
-        "verdocs-floating-menu": [
-          "verdocs-toolbar-icon"
+          "verdocs-toolbar-icon",
+          "verdocs-template-document-page"
         ],
         "verdocs-build": [
           "verdocs-template-fields"
@@ -5694,6 +5942,7 @@
       "dependents": [],
       "dependencies": [
         "verdocs-component-error",
+        "verdocs-loader",
         "verdocs-button",
         "verdocs-template-role-properties",
         "verdocs-template-sender"
@@ -5701,6 +5950,7 @@
       "dependencyGraph": {
         "verdocs-template-recipients": [
           "verdocs-component-error",
+          "verdocs-loader",
           "verdocs-button",
           "verdocs-template-role-properties",
           "verdocs-template-sender"
@@ -6690,12 +6940,16 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-floating-menu"
+        "verdocs-floating-menu",
+        "verdocs-template-fields"
       ],
       "dependencies": [],
       "dependencyGraph": {
         "verdocs-floating-menu": [
           "verdocs-toolbar-icon"
+        ],
+        "verdocs-template-fields": [
+          "verdocs-toolbar-icon"
         ]
       }
     },

package/dist/esm/{Roles-2488d047.js → Roles-6eb459df.js}

@@ -7,7 +7,7 @@
  */
 var createRole = function (endpoint, templateId, params) {
     return endpoint.api //
-        .post("/templates/".concat(templateId, "/roles/"), params)
+        .post("/templates/".concat(templateId, "/roles"), params)
         .then(function (r) { return r.data; });
 };
 var updateRole = function (endpoint, templateId, roleName, params) {

package/dist/esm/TemplateDocuments-1214b04d.js

@@ -0,0 +1,75 @@
+/**
+ * A TemplateDocument represents a PDF or other attachment in a Template.
+ *
+ * @module
+ */
+var __awaiter = (undefined && undefined.__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 = (undefined && undefined.__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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+/**
+ * Create a Document for a particular Template.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
+ * ```
+ */
+var createTemplateDocument = function (endpoint, templateId, file, onUploadProgress) {
+    var formData = new FormData();
+    formData.append('document', file, file.name);
+    return endpoint.api //
+        .post("/templates/".concat(templateId, "/documents"), formData, {
+        timeout: 60000,
+        onUploadProgress: function (event) {
+            var total = event.total || 1;
+            var loaded = event.loaded || 0;
+            onUploadProgress === null || onUploadProgress === void 0 ? void 0 : onUploadProgress(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then(function (r) { return r.data; });
+};
+/**
+ * Get a display URI for a given page in a file attached to a template document. These pages are rendered server-side
+ * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are
+ * intended for DISPLAY ONLY, and do not contain any encoded metadata from participants. The original asset may be
+ * obtained by calling `getTemplateDocumentFile()` or similar.
+ */
+var getTemplateDocumentPageDisplayUri = function (endpoint, templateId, documentId, page) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, endpoint.api.get("/templates/".concat(templateId, "/documents/").concat(documentId, "/pages/").concat(page, "/image")).then(function (r) { return r.data; })];
+}); }); };
+
+export { createTemplateDocument as c, getTemplateDocumentPageDisplayUri as g };

package/dist/esm/{Templates-a7530314.js → Templates-e288e682.js}

@@ -1,5 +1,5 @@
 import { g as getTemplate } from './Templates-8e4ab976.js';
-import { s as state } from './templateStore-fd4beaae.js';
+import { s as state } from './templateStore-a7a5149a.js';
 
 const pendingNotifications = [];
 const loadTemplate = async (endpoint, templateId, forceReload = false) => {
@@ -23,7 +23,7 @@ const loadTemplate = async (endpoint, templateId, forceReload = false) => {
   state.template = null;
   try {
     console.log(`[TEMPLATES] Loading template ${templateId}`);
-    const template = await getTemplate(endpoint, templateId, true);
+    const template = await getTemplate(endpoint, templateId);
     if (!template) {
       console.log('[TEMPLATES] Unable to load template');
       return;

package/dist/esm/{VerdocsEndpoint-7f17b088.js → VerdocsEndpoint-d50a8d28.js}

@@ -1251,7 +1251,7 @@ const transitionalDefaults = {
 
 const URLSearchParams$1 = typeof URLSearchParams !== 'undefined' ? URLSearchParams : AxiosURLSearchParams;
 
-const FormData$1 = FormData;
+const FormData$1 = typeof FormData !== 'undefined' ? FormData : null;
 
 /**
  * Determine if we're running in a standard browser environment
@@ -1647,11 +1647,15 @@ function isValidHeaderName(str) {
   return /^[-_a-zA-Z]+$/.test(str.trim());
 }
 
-function matchHeaderValue(context, value, header, filter) {
+function matchHeaderValue(context, value, header, filter, isHeaderNameFilter) {
   if (utils.isFunction(filter)) {
     return filter.call(this, value, header);
   }
 
+  if (isHeaderNameFilter) {
+    value = header;
+  }
+
   if (!utils.isString(value)) return;
 
   if (utils.isString(filter)) {
@@ -1795,7 +1799,7 @@ class AxiosHeaders {
 
     while (i--) {
       const key = keys[i];
-      if(!matcher || matchHeaderValue(this, this[key], key, matcher)) {
+      if(!matcher || matchHeaderValue(this, this[key], key, matcher, true)) {
         delete this[key];
         deleted = true;
       }
@@ -2643,7 +2647,7 @@ function mergeConfig(config1, config2) {
   return config;
 }
 
-const VERSION = "1.3.1";
+const VERSION = "1.3.3";
 
 const validators$1 = {};