@verdocs/web-sdk 1.9.6 → 1.9.9

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-12-20T14:26:26",
+  "timestamp": "2022-12-24T01:05:19",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -231,7 +231,13 @@
           "verdocs-button"
         ],
         "verdocs-view": [
-          "verdocs-loader",
+          "verdocs-view-template-document",
+          "verdocs-view-envelope-document"
+        ],
+        "verdocs-view-template-document": [
+          "verdocs-document-page"
+        ],
+        "verdocs-view-envelope-document": [
           "verdocs-document-page"
         ]
       }
@@ -534,7 +540,7 @@
       "filePath": "./src/components/controls/verdocs-checkbox/verdocs-checkbox.tsx",
       "encapsulation": "none",
       "tag": "verdocs-checkbox",
-      "docs": "Displays a radio button. Note that this is different from the `verdocs-field-radio-button` component, which is designed\nto be used in signing experiences and contains settings that connect to template fields. This is just a simple radio\nbutton for UI displays e.g. dialogs and .",
+      "docs": "Displays a check box. Note that this is different from the `verdocs-field-checkbox` component, which is designed\nto be used in signing experiences and contains settings that connect to template fields. This is just a simple check box\nfor UI displays e.g. dialog boxes.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -748,7 +754,7 @@
       "filePath": "./src/components/elements/verdocs-document-page/verdocs-document-page.tsx",
       "encapsulation": "none",
       "tag": "verdocs-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.",
+      "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": [
@@ -791,7 +797,7 @@
           "mutable": false,
           "attr": "page-number",
           "reflectToAttr": false,
-          "docs": "The page number being rendered. Not used internally but included in callbacks/events beacuse page numbers\nare used everywhere in document handling.",
+          "docs": "The page number being rendered. Not used internally, but included in callbacks/events beacuse page numbers\nare used everywhere in document handling. (Reminder: page numbers are 1-based.)",
           "docsTags": [],
           "default": "1",
           "values": [
@@ -808,7 +814,7 @@
           "mutable": false,
           "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.",
+          "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": [
@@ -825,7 +831,7 @@
           "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.",
+          "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": [
@@ -854,11 +860,15 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-view"
+        "verdocs-view-envelope-document",
+        "verdocs-view-template-document"
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "verdocs-view": [
+        "verdocs-view-envelope-document": [
+          "verdocs-document-page"
+        ],
+        "verdocs-view-template-document": [
           "verdocs-document-page"
         ]
       }
@@ -3129,8 +3139,7 @@
       "dependents": [
         "verdocs-preview",
         "verdocs-sign",
-        "verdocs-template-fields",
-        "verdocs-view"
+        "verdocs-template-fields"
       ],
       "dependencies": [],
       "dependencyGraph": {
@@ -3142,9 +3151,6 @@
         ],
         "verdocs-template-fields": [
           "verdocs-loader"
-        ],
-        "verdocs-view": [
-          "verdocs-loader"
         ]
       }
     },
@@ -3260,7 +3266,7 @@
       "filePath": "./src/components/controls/verdocs-organization-card/verdocs-organization-card.tsx",
       "encapsulation": "none",
       "tag": "verdocs-organization-card",
-      "docs": "Display a pop-up describing the company that was hovered over",
+      "docs": "Display a small summary card describing an organization",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -3359,7 +3365,13 @@
           "verdocs-view"
         ],
         "verdocs-view": [
-          "verdocs-loader",
+          "verdocs-view-template-document",
+          "verdocs-view-envelope-document"
+        ],
+        "verdocs-view-template-document": [
+          "verdocs-document-page"
+        ],
+        "verdocs-view-envelope-document": [
           "verdocs-document-page"
         ]
       }
@@ -4071,33 +4083,33 @@
       "usage": {},
       "props": [
         {
-          "name": "documentId",
-          "type": "string",
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
           "mutable": false,
-          "attr": "document-id",
           "reflectToAttr": false,
-          "docs": "The ID of the document to sign.",
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
           "docsTags": [],
-          "default": "null",
+          "default": "VerdocsEndpoint.getDefault()",
           "values": [
             {
-              "type": "string"
+              "type": "VerdocsEndpoint"
             }
           ],
           "optional": false,
           "required": false
         },
         {
-          "name": "endpoint",
-          "type": "VerdocsEndpoint",
+          "name": "envelopeId",
+          "type": "string",
           "mutable": false,
+          "attr": "envelope-id",
           "reflectToAttr": false,
-          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
+          "docs": "The ID of the envelope to sign.",
           "docsTags": [],
-          "default": "VerdocsEndpoint.getDefault()",
+          "default": "null",
           "values": [
             {
-              "type": "VerdocsEndpoint"
+              "type": "string"
             }
           ],
           "optional": false,
@@ -4173,7 +4185,13 @@
           "verdocs-loader"
         ],
         "verdocs-view": [
-          "verdocs-loader",
+          "verdocs-view-template-document",
+          "verdocs-view-envelope-document"
+        ],
+        "verdocs-view-template-document": [
+          "verdocs-document-page"
+        ],
+        "verdocs-view-envelope-document": [
           "verdocs-document-page"
         ]
       }
@@ -4272,15 +4290,15 @@
       "usage": {},
       "props": [
         {
-          "name": "document",
-          "type": "IDocument",
+          "name": "envelope",
+          "type": "IEnvelope",
           "mutable": false,
           "reflectToAttr": false,
           "docs": "The document to display status for. Ignored if `status` is set directly.",
           "docsTags": [],
           "values": [
             {
-              "type": "IDocument"
+              "type": "IEnvelope"
             }
           ],
           "optional": true,
@@ -4605,7 +4623,13 @@
           "verdocs-button"
         ],
         "verdocs-view": [
-          "verdocs-loader",
+          "verdocs-view-template-document",
+          "verdocs-view-envelope-document"
+        ],
+        "verdocs-view-template-document": [
+          "verdocs-document-page"
+        ],
+        "verdocs-view-envelope-document": [
           "verdocs-document-page"
         ],
         "verdocs-build": [
@@ -4677,7 +4701,7 @@
         },
         {
           "event": "settingsUpdated",
-          "detail": "any",
+          "detail": "{ name: string; sendReminders: boolean; firstReminderDays: number; reminderDays: number; }",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
@@ -5458,7 +5482,7 @@
       "filePath": "./src/components/embeds/verdocs-view/verdocs-view.tsx",
       "encapsulation": "none",
       "tag": "verdocs-view",
-      "docs": "",
+      "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.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -5478,6 +5502,23 @@
           "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
+        },
         {
           "name": "pageLayers",
           "type": "IPageLayer[]",
@@ -5525,13 +5566,14 @@
           "required": false
         },
         {
-          "name": "source",
+          "name": "templateId",
           "type": "string",
           "mutable": false,
-          "attr": "source",
+          "attr": "template-id",
           "reflectToAttr": false,
-          "docs": "Src of the PDF to load and render",
+          "docs": "The template ID to render. Set ONE OF templateId or envelopeId.",
           "docsTags": [],
+          "default": "''",
           "values": [
             {
               "type": "string"
@@ -5539,6 +5581,367 @@
           ],
           "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",
+          "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-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",
@@ -5620,27 +6023,17 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-preview",
-        "verdocs-sign",
-        "verdocs-template-fields"
+        "verdocs-view"
       ],
       "dependencies": [
-        "verdocs-loader",
         "verdocs-document-page"
       ],
       "dependencyGraph": {
-        "verdocs-view": [
-          "verdocs-loader",
+        "verdocs-view-template-document": [
           "verdocs-document-page"
         ],
-        "verdocs-preview": [
-          "verdocs-view"
-        ],
-        "verdocs-sign": [
-          "verdocs-view"
-        ],
-        "verdocs-template-fields": [
-          "verdocs-view"
+        "verdocs-view": [
+          "verdocs-view-template-document"
         ]
       }
     }