@verdocs/web-sdk 1.9.38 → 1.10.0

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-01-31T16:52:38",
+  "timestamp": "2023-02-02T14:35:45",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -167,6 +167,7 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
+        "verdocs-component-error",
         "verdocs-template-create",
         "verdocs-template-properties",
         "verdocs-template-recipients",
@@ -174,15 +175,18 @@
       ],
       "dependencyGraph": {
         "verdocs-build": [
+          "verdocs-component-error",
           "verdocs-template-create",
           "verdocs-template-properties",
           "verdocs-template-recipients",
           "verdocs-template-fields"
         ],
         "verdocs-template-create": [
+          "verdocs-component-error",
           "verdocs-button"
         ],
         "verdocs-template-properties": [
+          "verdocs-component-error",
           "verdocs-text-input",
           "verdocs-checkbox",
           "verdocs-radio-button",
@@ -198,20 +202,13 @@
           "verdocs-button"
         ],
         "verdocs-template-fields": [
+          "verdocs-component-error",
           "verdocs-loader",
-          "verdocs-toolbar-icon",
-          "verdocs-field-signature",
-          "verdocs-document-page"
-        ],
-        "verdocs-field-signature": [
-          "verdocs-signature-dialog",
-          "verdocs-button-panel",
-          "verdocs-select-input",
-          "verdocs-text-input"
+          "verdocs-document-page",
+          "verdocs-floating-menu"
         ],
-        "verdocs-signature-dialog": [
-          "verdocs-text-input",
-          "verdocs-button"
+        "verdocs-floating-menu": [
+          "verdocs-toolbar-icon"
         ]
       }
     },
@@ -635,6 +632,60 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/elements/verdocs-component-error/verdocs-component-error.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-component-error",
+      "docs": "Render a simple error message.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "message",
+          "type": "string",
+          "mutable": false,
+          "attr": "message",
+          "reflectToAttr": false,
+          "docs": "The message to display.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-build",
+        "verdocs-template-create",
+        "verdocs-template-fields",
+        "verdocs-template-properties"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-build": [
+          "verdocs-component-error"
+        ],
+        "verdocs-template-create": [
+          "verdocs-component-error"
+        ],
+        "verdocs-template-fields": [
+          "verdocs-component-error"
+        ],
+        "verdocs-template-properties": [
+          "verdocs-component-error"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/elements/verdocs-contact-picker/verdocs-contact-picker.tsx",
       "encapsulation": "none",
@@ -919,11 +970,15 @@
       "slots": [],
       "parts": [],
       "dependents": [
+        "verdocs-envelope-sidebar",
         "verdocs-sign",
         "verdocs-view"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "verdocs-envelope-sidebar": [
+          "verdocs-dropdown"
+        ],
         "verdocs-sign": [
           "verdocs-dropdown"
         ],
@@ -932,6 +987,74 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/elements/verdocs-envelope-sidebar/verdocs-envelope-sidebar.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-envelope-sidebar",
+      "docs": "Displays a file upload mechanism suitable for the first step of creating a template.\nThis is typically the first step in a template creation workflow.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
+          "docsTags": [],
+          "default": "VerdocsEndpoint.getDefault()",
+          "values": [
+            {
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "envelopeId",
+          "type": "string",
+          "mutable": false,
+          "attr": "envelope-id",
+          "reflectToAttr": false,
+          "docs": "The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "sdkError",
+          "detail": "SDKError",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired if an error occurs. The event details will contain information about the error. Most errors will\nterminate the process, and the calling application should correct the condition and re-render the component.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [
+        "verdocs-dropdown"
+      ],
+      "dependencyGraph": {
+        "verdocs-envelope-sidebar": [
+          "verdocs-dropdown"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/elements/verdocs-field-attachment/verdocs-field-attachment.tsx",
       "encapsulation": "none",
@@ -2157,9 +2280,7 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "verdocs-template-fields"
-      ],
+      "dependents": [],
       "dependencies": [
         "verdocs-signature-dialog",
         "verdocs-button-panel",
@@ -2176,9 +2297,6 @@
         "verdocs-signature-dialog": [
           "verdocs-text-input",
           "verdocs-button"
-        ],
-        "verdocs-template-fields": [
-          "verdocs-field-signature"
         ]
       }
     },
@@ -2627,6 +2745,62 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/controls/verdocs-floating-menu/verdocs-floating-menu.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-floating-menu",
+      "docs": "Floating Action Button style menu. For proper placement, this should be added to the DOM inside a container that is set to\n`overflow-y: scroll;`. The component will detect that placement and position itself in the bottom-right corner on top of the\ncontainer. It will be absolutely positioned so it will be unaffected by scrolling the container.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "options",
+          "type": "IOption[]",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The role that this contact will be assigned to.",
+          "docsTags": [],
+          "default": "[]",
+          "values": [
+            {
+              "type": "IOption[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "optionSelected",
+          "detail": "IOption",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when a menu option is clicked.\nWeb Component events need to be \"composed\" to cross the Shadow DOM and be received by parent frameworks.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-template-fields"
+      ],
+      "dependencies": [
+        "verdocs-toolbar-icon"
+      ],
+      "dependencyGraph": {
+        "verdocs-floating-menu": [
+          "verdocs-toolbar-icon"
+        ],
+        "verdocs-template-fields": [
+          "verdocs-floating-menu"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/controls/verdocs-help-icon/verdocs-help-icon.tsx",
       "encapsulation": "none",
@@ -4263,10 +4437,12 @@
         "verdocs-build"
       ],
       "dependencies": [
+        "verdocs-component-error",
         "verdocs-button"
       ],
       "dependencyGraph": {
         "verdocs-template-create": [
+          "verdocs-component-error",
           "verdocs-button"
         ],
         "verdocs-build": [
@@ -4354,27 +4530,20 @@
         "verdocs-build"
       ],
       "dependencies": [
+        "verdocs-component-error",
         "verdocs-loader",
-        "verdocs-toolbar-icon",
-        "verdocs-field-signature",
-        "verdocs-document-page"
+        "verdocs-document-page",
+        "verdocs-floating-menu"
       ],
       "dependencyGraph": {
         "verdocs-template-fields": [
+          "verdocs-component-error",
           "verdocs-loader",
-          "verdocs-toolbar-icon",
-          "verdocs-field-signature",
-          "verdocs-document-page"
-        ],
-        "verdocs-field-signature": [
-          "verdocs-signature-dialog",
-          "verdocs-button-panel",
-          "verdocs-select-input",
-          "verdocs-text-input"
+          "verdocs-document-page",
+          "verdocs-floating-menu"
         ],
-        "verdocs-signature-dialog": [
-          "verdocs-text-input",
-          "verdocs-button"
+        "verdocs-floating-menu": [
+          "verdocs-toolbar-icon"
         ],
         "verdocs-build": [
           "verdocs-template-fields"
@@ -4461,6 +4630,7 @@
         "verdocs-build"
       ],
       "dependencies": [
+        "verdocs-component-error",
         "verdocs-text-input",
         "verdocs-checkbox",
         "verdocs-radio-button",
@@ -4468,6 +4638,7 @@
       ],
       "dependencyGraph": {
         "verdocs-template-properties": [
+          "verdocs-component-error",
           "verdocs-text-input",
           "verdocs-checkbox",
           "verdocs-radio-button",
@@ -5086,6 +5257,80 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "placement",
+          "type": "\"auto\" | \"auto-end\" | \"auto-start\" | \"bottom\" | \"bottom-end\" | \"bottom-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\"",
+          "mutable": false,
+          "attr": "placement",
+          "reflectToAttr": false,
+          "docs": "Override the Popper \"placement\" setting",
+          "docsTags": [],
+          "default": "'bottom'",
+          "values": [
+            {
+              "value": "auto",
+              "type": "string"
+            },
+            {
+              "value": "auto-end",
+              "type": "string"
+            },
+            {
+              "value": "auto-start",
+              "type": "string"
+            },
+            {
+              "value": "bottom",
+              "type": "string"
+            },
+            {
+              "value": "bottom-end",
+              "type": "string"
+            },
+            {
+              "value": "bottom-start",
+              "type": "string"
+            },
+            {
+              "value": "left",
+              "type": "string"
+            },
+            {
+              "value": "left-end",
+              "type": "string"
+            },
+            {
+              "value": "left-start",
+              "type": "string"
+            },
+            {
+              "value": "right",
+              "type": "string"
+            },
+            {
+              "value": "right-end",
+              "type": "string"
+            },
+            {
+              "value": "right-start",
+              "type": "string"
+            },
+            {
+              "value": "top",
+              "type": "string"
+            },
+            {
+              "value": "top-end",
+              "type": "string"
+            },
+            {
+              "value": "top-start",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "text",
           "type": "string",
@@ -5111,11 +5356,11 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-template-fields"
+        "verdocs-floating-menu"
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "verdocs-template-fields": [
+        "verdocs-floating-menu": [
           "verdocs-toolbar-icon"
         ]
       }

package/dist/esm/Envelopes-130fd6ea.js

@@ -0,0 +1,111 @@
+import { d as decodeAccessTokenBody } from './Token-54690789.js';
+
+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 };
+    }
+};
+/**
+ * Get a signing session for an Envelope.
+ */
+var getSigningSession = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/envelopes/".concat(params.envelopeId, "/recipients/").concat(encodeURIComponent(params.roleId), "/invitation/").concat(params.inviteCode))
+                .then(function (r) {
+                var _a;
+                // Avoiding a jsonwebtoken dependency here - we don't actually need the whole library
+                var signerToken = ((_a = r.headers) === null || _a === void 0 ? void 0 : _a.signer_token) || '';
+                var session = decodeAccessTokenBody(signerToken);
+                endpoint.setToken(signerToken);
+                return { recipient: r.data, session: session, signerToken: signerToken };
+            })];
+    });
+}); };
+/**
+ * Get all metadata for an Envelope.
+ */
+var getEnvelope = function (endpoint, envelopeId, ssr) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/envelopes/".concat(envelopeId) + (ssr ? '?ssr=true' : ''))
+                .then(function (r) { return r.data; })];
+    });
+}); };
+/**
+ * Get (binary download) a file attached to an Envelope. It is important to use this method
+ * rather than a direct A HREF or similar link to set the authorization headers for the
+ * request.
+ */
+var getEnvelopeFile = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?file=true"), { responseType: 'blob' })
+                .then(function (r) { return r.data; })];
+    });
+}); };
+/**
+ * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
+ */
+var updateEnvelopeField = function (endpoint, envelopeId, fieldName, value) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName), value)
+                .then(function (r) { return r.data; })];
+    });
+}); };
+/**
+ * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
+ * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
+ */
+var updateEnvelopeFieldSignature = function (endpoint, envelopeId, fieldName, signatureId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName, "/signature/").concat(signatureId))
+                .then(function (r) { return r.data; })];
+    });
+}); };
+/**
+ * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
+ * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
+ */
+var updateEnvelopeFieldInitials = function (endpoint, envelopeId, fieldName, initialId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName, "/initial/").concat(initialId))
+                .then(function (r) { return r.data; })];
+    });
+}); };
+
+export { getEnvelopeFile as a, getSigningSession as b, updateEnvelopeFieldSignature as c, updateEnvelopeFieldInitials as d, getEnvelope as g, updateEnvelopeField as u };

package/dist/esm/{Envelopes-779de57c.js → Envelopes-6982dfc6.js}

@@ -1,4 +1,4 @@
-import { h as getEnvelope } from './utils-06d58b15.js';
+import { g as getEnvelope } from './Envelopes-130fd6ea.js';
 import { c as createStore } from './index-fd7b8a34.js';
 import { g as getTemplate } from './Templates-0638b1e4.js';