@verdocs/web-sdk 1.9.10 → 1.9.14

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-12-30T20:38:56",
+  "timestamp": "2023-01-03T03:13:14",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -218,7 +218,7 @@
           "verdocs-loader",
           "verdocs-toolbar-icon",
           "verdocs-field-signature",
-          "verdocs-view"
+          "verdocs-document-page"
         ],
         "verdocs-field-signature": [
           "verdocs-signature-dialog",
@@ -229,16 +229,6 @@
         "verdocs-signature-dialog": [
           "verdocs-text-input",
           "verdocs-button"
-        ],
-        "verdocs-view": [
-          "verdocs-view-template-document",
-          "verdocs-view-envelope-document"
-        ],
-        "verdocs-view-template-document": [
-          "verdocs-document-page"
-        ],
-        "verdocs-view-envelope-document": [
-          "verdocs-document-page"
         ]
       }
     },
@@ -840,15 +830,23 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-view-envelope-document",
-        "verdocs-view-template-document"
+        "verdocs-preview",
+        "verdocs-sign",
+        "verdocs-template-fields",
+        "verdocs-view"
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "verdocs-view-envelope-document": [
+        "verdocs-preview": [
           "verdocs-document-page"
         ],
-        "verdocs-view-template-document": [
+        "verdocs-sign": [
+          "verdocs-document-page"
+        ],
+        "verdocs-template-fields": [
+          "verdocs-document-page"
+        ],
+        "verdocs-view": [
           "verdocs-document-page"
         ]
       }
@@ -3012,18 +3010,18 @@
       "parts": [],
       "dependents": [
         "verdocs-preview",
-        "verdocs-sign",
-        "verdocs-template-fields"
+        "verdocs-template-fields",
+        "verdocs-view"
       ],
       "dependencies": [],
       "dependencyGraph": {
         "verdocs-preview": [
           "verdocs-loader"
         ],
-        "verdocs-sign": [
+        "verdocs-template-fields": [
           "verdocs-loader"
         ],
-        "verdocs-template-fields": [
+        "verdocs-view": [
           "verdocs-loader"
         ]
       }
@@ -3166,7 +3164,7 @@
       "filePath": "./src/components/embeds/verdocs-preview/verdocs-preview.tsx",
       "encapsulation": "none",
       "tag": "verdocs-preview",
-      "docs": "Display a template preview experience.",
+      "docs": "Display a template preview experience. This will display the template's attached\ndocuments with signing fields overlaid on each page. Fields will be color-coded\nby recipient, and will be read-only (cannot be filled, moved, or altered).",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -3223,21 +3221,11 @@
       "dependents": [],
       "dependencies": [
         "verdocs-loader",
-        "verdocs-view"
+        "verdocs-document-page"
       ],
       "dependencyGraph": {
         "verdocs-preview": [
           "verdocs-loader",
-          "verdocs-view"
-        ],
-        "verdocs-view": [
-          "verdocs-view-template-document",
-          "verdocs-view-envelope-document"
-        ],
-        "verdocs-view-template-document": [
-          "verdocs-document-page"
-        ],
-        "verdocs-view-envelope-document": [
           "verdocs-document-page"
         ]
       }
@@ -3924,26 +3912,10 @@
       "filePath": "./src/components/embeds/verdocs-sign/verdocs-sign.tsx",
       "encapsulation": "none",
       "tag": "verdocs-sign",
-      "docs": "Display a document signing experience.\n\n***NOTE: This sample document will reset every 10 minutes...***",
+      "docs": "Display an envelope signing experience. This will display the envelope's attached\ndocuments with signing fields overlaid on each page.\n\nThe component will attempt to initiate a signing session and load the specified\nenvelope. If successful, the recipient's fields will be enabled and the user will\nbe able to sign the envelope's attached documents. If not, an `sdkError` will be\nthrown and the component will be blank/empty. To provide the best user experience,\napplications should capture and handle this error to provide the user with\ninstructions/options for next steps based on the application's design and workflow.\n\nUnlike other components, this will always create its own endpoint to manage the\nsession session. This endpoint will be included in event callbacks for the\nconvenience of host applications that may wish to make server calls using the\nsigner's credentials once signing is complete (e.g. to obtain copies of\nthe signed attachments.)",
       "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",
@@ -3984,7 +3956,7 @@
           "mutable": false,
           "attr": "role-id",
           "reflectToAttr": false,
-          "docs": "The name of the role that will be signing.",
+          "docs": "The ID of the role that will be signing e.g. 'Recipient 1'",
           "docsTags": [],
           "default": "null",
           "values": [
@@ -3998,6 +3970,15 @@
       ],
       "methods": [],
       "events": [
+        {
+          "event": "fieldUpdated",
+          "detail": "{ endpoint: VerdocsEndpoint; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when any field is updated. Note that the current active endpoint is\nprovided as a parameter as a convenience for callers when this coimponent",
+          "docsTags": []
+        },
         {
           "event": "sdkError",
           "detail": "SDKError",
@@ -4018,8 +3999,7 @@
         "verdocs-field-radio-button",
         "verdocs-dropdown",
         "verdocs-button",
-        "verdocs-view",
-        "verdocs-loader"
+        "verdocs-document-page"
       ],
       "dependencyGraph": {
         "verdocs-sign": [
@@ -4027,17 +4007,6 @@
           "verdocs-field-radio-button",
           "verdocs-dropdown",
           "verdocs-button",
-          "verdocs-view",
-          "verdocs-loader"
-        ],
-        "verdocs-view": [
-          "verdocs-view-template-document",
-          "verdocs-view-envelope-document"
-        ],
-        "verdocs-view-template-document": [
-          "verdocs-document-page"
-        ],
-        "verdocs-view-envelope-document": [
           "verdocs-document-page"
         ]
       }
@@ -4432,14 +4401,14 @@
         "verdocs-loader",
         "verdocs-toolbar-icon",
         "verdocs-field-signature",
-        "verdocs-view"
+        "verdocs-document-page"
       ],
       "dependencyGraph": {
         "verdocs-template-fields": [
           "verdocs-loader",
           "verdocs-toolbar-icon",
           "verdocs-field-signature",
-          "verdocs-view"
+          "verdocs-document-page"
         ],
         "verdocs-field-signature": [
           "verdocs-signature-dialog",
@@ -4451,16 +4420,6 @@
           "verdocs-text-input",
           "verdocs-button"
         ],
-        "verdocs-view": [
-          "verdocs-view-template-document",
-          "verdocs-view-envelope-document"
-        ],
-        "verdocs-view-template-document": [
-          "verdocs-document-page"
-        ],
-        "verdocs-view-envelope-document": [
-          "verdocs-document-page"
-        ],
         "verdocs-build": [
           "verdocs-template-fields"
         ]
@@ -5257,7 +5216,7 @@
       "filePath": "./src/components/embeds/verdocs-view/verdocs-view.tsx",
       "encapsulation": "none",
       "tag": "verdocs-view",
-      "docs": "View all of the documents attached to a template or envelope. All documents are displayed, in order. This embed wraps\nverdocs-view-envelope-document or verdocs-view-template-document, as appropriate, and those controls may be used if\nfine-grained control over which documents are displayed (or their order) is required.",
+      "docs": "Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -5293,315 +5252,10 @@
           ],
           "optional": false,
           "required": false
-        },
-        {
-          "name": "pageLayers",
-          "type": "IPageLayer[]",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "Layers will be passed through to the individual pages inside this component.",
-          "docsTags": [],
-          "default": "[\n    {name: 'page', type: 'canvas'},\n    {name: 'controls', type: 'div'},\n  ]",
-          "values": [
-            {
-              "type": "IPageLayer[]"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "rotation",
-          "type": "0 | 180 | 270 | 90",
-          "mutable": false,
-          "attr": "rotation",
-          "reflectToAttr": false,
-          "docs": "Rotate the PDF in degrees",
-          "docsTags": [],
-          "default": "0",
-          "values": [
-            {
-              "value": "0",
-              "type": "number"
-            },
-            {
-              "value": "180",
-              "type": "number"
-            },
-            {
-              "value": "270",
-              "type": "number"
-            },
-            {
-              "value": "90",
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "templateId",
-          "type": "string",
-          "mutable": false,
-          "attr": "template-id",
-          "reflectToAttr": false,
-          "docs": "The template ID to render. Set ONE OF templateId or envelopeId.",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [],
-      "events": [
-        {
-          "event": "pageChange",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been changed",
-          "docsTags": []
-        },
-        {
-          "event": "pageInit",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been initialized",
-          "docsTags": []
-        },
-        {
-          "event": "pageLoaded",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been changed",
-          "docsTags": []
-        },
-        {
-          "event": "pageRendered",
-          "detail": "IPageRenderEvent",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been rendered",
-          "docsTags": []
-        },
-        {
-          "event": "scaleChange",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been scaled",
-          "docsTags": []
-        },
-        {
-          "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": [
-        "verdocs-preview",
-        "verdocs-sign",
-        "verdocs-template-fields"
-      ],
-      "dependencies": [
-        "verdocs-view-template-document",
-        "verdocs-view-envelope-document"
-      ],
-      "dependencyGraph": {
-        "verdocs-view": [
-          "verdocs-view-template-document",
-          "verdocs-view-envelope-document"
-        ],
-        "verdocs-view-template-document": [
-          "verdocs-document-page"
-        ],
-        "verdocs-view-envelope-document": [
-          "verdocs-document-page"
-        ],
-        "verdocs-preview": [
-          "verdocs-view"
-        ],
-        "verdocs-sign": [
-          "verdocs-view"
-        ],
-        "verdocs-template-fields": [
-          "verdocs-view"
-        ]
-      }
-    },
-    {
-      "filePath": "./src/components/elements/verdocs-view-envelope-document/verdocs-view-envelope-document.tsx",
-      "encapsulation": "none",
-      "tag": "verdocs-view-envelope-document",
-      "docs": "View a single document attached to an envelope. Note that envelopes always require authentication to access them. If you are viewing\nthis component in Storybook, visit Embeds > Auth first to log in, then paste a valid envelopeId and documentId in the properties\nbelow from your account to view that envelope. If you want to see an anonymous-access use case, this component is functionally similar\nto ViewTemplateDocument, which is pre-configured to display a public template.",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "documentId",
-          "type": "string",
-          "mutable": false,
-          "attr": "document-id",
-          "reflectToAttr": false,
-          "docs": "The document ID to render",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "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",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "pageLayers",
-          "type": "IPageLayer[]",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "Layers will be passed through to the individual pages inside this component.",
-          "docsTags": [],
-          "default": "[\n    {name: 'page', type: 'canvas'},\n    {name: 'controls', type: 'div'},\n  ]",
-          "values": [
-            {
-              "type": "IPageLayer[]"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "rotation",
-          "type": "0 | 180 | 270 | 90",
-          "mutable": false,
-          "attr": "rotation",
-          "reflectToAttr": false,
-          "docs": "Rotate the PDF in degrees",
-          "docsTags": [],
-          "default": "0",
-          "values": [
-            {
-              "value": "0",
-              "type": "number"
-            },
-            {
-              "value": "180",
-              "type": "number"
-            },
-            {
-              "value": "270",
-              "type": "number"
-            },
-            {
-              "value": "90",
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
         }
       ],
       "methods": [],
       "events": [
-        {
-          "event": "pageChange",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been changed",
-          "docsTags": []
-        },
-        {
-          "event": "pageInit",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been initialized",
-          "docsTags": []
-        },
-        {
-          "event": "pageLoaded",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been changed",
-          "docsTags": []
-        },
-        {
-          "event": "pageRendered",
-          "detail": "IPageRenderEvent",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been rendered",
-          "docsTags": []
-        },
-        {
-          "event": "scaleChange",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been scaled",
-          "docsTags": []
-        },
         {
           "event": "sdkError",
           "detail": "SDKError",
@@ -5616,199 +5270,15 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "verdocs-view"
-      ],
+      "dependents": [],
       "dependencies": [
+        "verdocs-loader",
         "verdocs-document-page"
       ],
       "dependencyGraph": {
-        "verdocs-view-envelope-document": [
-          "verdocs-document-page"
-        ],
         "verdocs-view": [
-          "verdocs-view-envelope-document"
-        ]
-      }
-    },
-    {
-      "filePath": "./src/components/elements/verdocs-view-template-document/verdocs-view-template-document.tsx",
-      "encapsulation": "none",
-      "tag": "verdocs-view-template-document",
-      "docs": "View a single document attached to a template. Note that if you are accessing a template that is not public, you must be authenticated.\nYou can authenticate within this Storybook via the Embeds > Auth control.",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "documentId",
-          "type": "string",
-          "mutable": false,
-          "attr": "document-id",
-          "reflectToAttr": false,
-          "docs": "The document ID to render within the template",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "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": "pageLayers",
-          "type": "IPageLayer[]",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "Layers will be passed through to the individual pages inside this component.",
-          "docsTags": [],
-          "default": "[\n    {name: 'page', type: 'canvas'},\n    {name: 'controls', type: 'div'},\n  ]",
-          "values": [
-            {
-              "type": "IPageLayer[]"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "rotation",
-          "type": "0 | 180 | 270 | 90",
-          "mutable": false,
-          "attr": "rotation",
-          "reflectToAttr": false,
-          "docs": "Rotate the PDF in degrees",
-          "docsTags": [],
-          "default": "0",
-          "values": [
-            {
-              "value": "0",
-              "type": "number"
-            },
-            {
-              "value": "180",
-              "type": "number"
-            },
-            {
-              "value": "270",
-              "type": "number"
-            },
-            {
-              "value": "90",
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "templateId",
-          "type": "string",
-          "mutable": false,
-          "attr": "template-id",
-          "reflectToAttr": false,
-          "docs": "The template ID to render",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [],
-      "events": [
-        {
-          "event": "pageChange",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been changed",
-          "docsTags": []
-        },
-        {
-          "event": "pageInit",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been initialized",
-          "docsTags": []
-        },
-        {
-          "event": "pageLoaded",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been changed",
-          "docsTags": []
-        },
-        {
-          "event": "pageRendered",
-          "detail": "IPageRenderEvent",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been rendered",
-          "docsTags": []
-        },
-        {
-          "event": "scaleChange",
-          "detail": "number",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Fired when a page has been scaled",
-          "docsTags": []
-        },
-        {
-          "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": [
-        "verdocs-view"
-      ],
-      "dependencies": [
-        "verdocs-document-page"
-      ],
-      "dependencyGraph": {
-        "verdocs-view-template-document": [
+          "verdocs-loader",
           "verdocs-document-page"
-        ],
-        "verdocs-view": [
-          "verdocs-view-template-document"
         ]
       }
     }