@verdocs/web-sdk 1.10.0 → 1.10.1

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-02-02T14:35:45",
+  "timestamp": "2023-02-03T16:08:47",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -169,38 +169,18 @@
       "dependencies": [
         "verdocs-component-error",
         "verdocs-template-create",
-        "verdocs-template-properties",
-        "verdocs-template-recipients",
         "verdocs-template-fields"
       ],
       "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",
-          "verdocs-button"
-        ],
-        "verdocs-template-recipients": [
-          "verdocs-button",
-          "verdocs-template-sender-dialog"
-        ],
-        "verdocs-template-sender-dialog": [
-          "verdocs-radio-button",
-          "verdocs-help-icon",
-          "verdocs-button"
-        ],
         "verdocs-template-fields": [
           "verdocs-component-error",
           "verdocs-loader",
@@ -386,9 +366,12 @@
         "verdocs-sign",
         "verdocs-signature-dialog",
         "verdocs-template-create",
+        "verdocs-template-name",
         "verdocs-template-properties",
         "verdocs-template-recipients",
+        "verdocs-template-reminders",
         "verdocs-template-sender-dialog",
+        "verdocs-template-visibility",
         "verdocs-upload-dialog"
       ],
       "dependencies": [],
@@ -420,15 +403,24 @@
         "verdocs-template-create": [
           "verdocs-button"
         ],
+        "verdocs-template-name": [
+          "verdocs-button"
+        ],
         "verdocs-template-properties": [
           "verdocs-button"
         ],
         "verdocs-template-recipients": [
           "verdocs-button"
         ],
+        "verdocs-template-reminders": [
+          "verdocs-button"
+        ],
         "verdocs-template-sender-dialog": [
           "verdocs-button"
         ],
+        "verdocs-template-visibility": [
+          "verdocs-button"
+        ],
         "verdocs-upload-dialog": [
           "verdocs-button"
         ]
@@ -620,7 +612,9 @@
       "parts": [],
       "dependents": [
         "verdocs-sign",
-        "verdocs-template-properties"
+        "verdocs-template-properties",
+        "verdocs-template-reminders",
+        "verdocs-template-visibility"
       ],
       "dependencies": [],
       "dependencyGraph": {
@@ -629,6 +623,12 @@
         ],
         "verdocs-template-properties": [
           "verdocs-checkbox"
+        ],
+        "verdocs-template-reminders": [
+          "verdocs-checkbox"
+        ],
+        "verdocs-template-visibility": [
+          "verdocs-checkbox"
         ]
       }
     },
@@ -668,7 +668,9 @@
         "verdocs-build",
         "verdocs-template-create",
         "verdocs-template-fields",
-        "verdocs-template-properties"
+        "verdocs-template-properties",
+        "verdocs-template-reminders",
+        "verdocs-template-visibility"
       ],
       "dependencies": [],
       "dependencyGraph": {
@@ -683,6 +685,12 @@
         ],
         "verdocs-template-properties": [
           "verdocs-component-error"
+        ],
+        "verdocs-template-reminders": [
+          "verdocs-component-error"
+        ],
+        "verdocs-template-visibility": [
+          "verdocs-component-error"
         ]
       }
     },
@@ -1056,7 +1064,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-attachment/verdocs-field-attachment.tsx",
+      "filePath": "./src/components/fields/verdocs-field-attachment/verdocs-field-attachment.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-attachment",
       "docs": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox.",
@@ -1149,7 +1157,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-checkbox/verdocs-field-checkbox.tsx",
+      "filePath": "./src/components/fields/verdocs-field-checkbox/verdocs-field-checkbox.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-checkbox",
       "docs": "Displays a checkbox.",
@@ -1255,7 +1263,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-date/verdocs-field-date.tsx",
+      "filePath": "./src/components/fields/verdocs-field-date/verdocs-field-date.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-date",
       "docs": "Displays a date field. When tapped or clicked, the input element will display a date picker component.",
@@ -1410,7 +1418,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-dropdown/verdocs-field-dropdown.tsx",
+      "filePath": "./src/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-dropdown",
       "docs": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox.",
@@ -1504,7 +1512,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-initial/verdocs-field-initial.tsx",
+      "filePath": "./src/components/fields/verdocs-field-initial/verdocs-field-initial.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-initial",
       "docs": "Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder\nbutton will be shown. Clicking the button will show a dialog to adopt an initial.",
@@ -1709,7 +1717,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-payment/verdocs-field-payment.tsx",
+      "filePath": "./src/components/fields/verdocs-field-payment/verdocs-field-payment.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-payment",
       "docs": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox.",
@@ -2008,7 +2016,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-radio-button-group/verdocs-field-radio-button.tsx",
+      "filePath": "./src/components/fields/verdocs-field-radio-button-group/verdocs-field-radio-button.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-radio-button",
       "docs": "Displays a radio button.",
@@ -2114,7 +2122,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-signature/verdocs-field-signature.tsx",
+      "filePath": "./src/components/fields/verdocs-field-signature/verdocs-field-signature.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-signature",
       "docs": "Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder\nbutton will be shown. Clicking the button will show a dialog to adopt a signature.",
@@ -2301,7 +2309,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-textarea/verdocs-field-textarea.tsx",
+      "filePath": "./src/components/fields/verdocs-field-textarea/verdocs-field-textarea.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-textarea",
       "docs": "Display a multi-line text input field.",
@@ -2446,7 +2454,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-textbox/verdocs-field-textbox.tsx",
+      "filePath": "./src/components/fields/verdocs-field-textbox/verdocs-field-textbox.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-textbox",
       "docs": "Display a text input field.",
@@ -2601,7 +2609,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-field-timestamp/verdocs-field-timestamp.tsx",
+      "filePath": "./src/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.tsx",
       "encapsulation": "none",
       "tag": "verdocs-field-timestamp",
       "docs": "Display a timestamp field.",
@@ -3113,6 +3121,7 @@
         "verdocs-preview",
         "verdocs-sign",
         "verdocs-template-fields",
+        "verdocs-template-name",
         "verdocs-view"
       ],
       "dependencies": [],
@@ -3126,6 +3135,9 @@
         "verdocs-template-fields": [
           "verdocs-loader"
         ],
+        "verdocs-template-name": [
+          "verdocs-loader"
+        ],
         "verdocs-view": [
           "verdocs-loader"
         ]
@@ -3218,7 +3230,8 @@
       "parts": [],
       "dependents": [
         "verdocs-auth",
-        "verdocs-sign"
+        "verdocs-sign",
+        "verdocs-template-reminders"
       ],
       "dependencies": [
         "verdocs-button"
@@ -3232,6 +3245,9 @@
         ],
         "verdocs-sign": [
           "verdocs-ok-dialog"
+        ],
+        "verdocs-template-reminders": [
+          "verdocs-ok-dialog"
         ]
       }
     },
@@ -4375,7 +4391,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/elements/verdocs-template-create/verdocs-template-create.tsx",
+      "filePath": "./src/components/templates/verdocs-template-create/verdocs-template-create.tsx",
       "encapsulation": "none",
       "tag": "verdocs-template-create",
       "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.",
@@ -4451,7 +4467,7 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-template-fields/verdocs-template-fields.tsx",
+      "filePath": "./src/components/templates/verdocs-template-fields/verdocs-template-fields.tsx",
       "encapsulation": "none",
       "tag": "verdocs-template-fields",
       "docs": "Displays a builder experience for laying out fields in a template. Note that this experience requires a large display area to\npresent all of the required controls, so it is primarily intended to be used in desktop environments.",
@@ -4551,7 +4567,88 @@
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-template-properties/verdocs-template-properties.tsx",
+      "filePath": "./src/components/templates/verdocs-template-name/verdocs-template-name.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-template-name",
+      "docs": "Displays an edit form that allows the user to rename a template. Note that an active session and valid template ID must be supplied.",
+      "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": "templateId",
+          "type": "string",
+          "mutable": false,
+          "attr": "template-id",
+          "reflectToAttr": false,
+          "docs": "The template ID to edit.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "close",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user cancels the dialog.",
+          "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": [],
+      "dependencies": [
+        "verdocs-loader",
+        "verdocs-text-input",
+        "verdocs-button"
+      ],
+      "dependencyGraph": {
+        "verdocs-template-name": [
+          "verdocs-loader",
+          "verdocs-text-input",
+          "verdocs-button"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/templates/verdocs-template-properties/verdocs-template-properties.tsx",
       "encapsulation": "none",
       "tag": "verdocs-template-properties",
       "docs": "Displays a collection of settings boxes that allow a user to configure a template's behavior.",
@@ -4626,9 +4723,7 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "verdocs-build"
-      ],
+      "dependents": [],
       "dependencies": [
         "verdocs-component-error",
         "verdocs-text-input",
@@ -4643,14 +4738,11 @@
           "verdocs-checkbox",
           "verdocs-radio-button",
           "verdocs-button"
-        ],
-        "verdocs-build": [
-          "verdocs-template-properties"
         ]
       }
     },
     {
-      "filePath": "./src/components/elements/verdocs-template-recipients/verdocs-template-recipients.tsx",
+      "filePath": "./src/components/templates/verdocs-template-recipients/verdocs-template-recipients.tsx",
       "encapsulation": "none",
       "tag": "verdocs-template-recipients",
       "docs": "Displays a contact picker suitable for filling out Recipient objects when sending Documents.\n\nThis picker can also be integrated with a backend to provide contact list / suggestion / address-book style behavior. As the\nuser interacts with the component, the text entered in the name field is sent back to the parent via the `searchContacts` event.\nThe parent can use that text as a query string to call a backend to obtain appropriate contacts to show. This list may also be\nhard-coded ahead of time to provide the user with smart suggestions on initial display, such as \"Recently Used\" contacts, or\nto always display the user's own contact record.",
@@ -4658,24 +4750,89 @@
       "usage": {},
       "props": [
         {
-          "name": "contactSuggestions",
-          "type": "(IEmailContact | IPhoneContact)[]",
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
           "mutable": false,
           "reflectToAttr": false,
-          "docs": "If set, suggestions will be displayed in a drop-down list to the user. It is recommended that the number\nof suggestions be limited to the 5 best matching records.",
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
           "docsTags": [],
-          "default": "[]",
+          "default": "VerdocsEndpoint.getDefault()",
           "values": [
             {
-              "type": "(IEmailContact"
-            },
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "templateId",
+          "type": "string",
+          "mutable": false,
+          "attr": "template-id",
+          "reflectToAttr": false,
+          "docs": "The template ID to edit.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
             {
-              "type": "IPhoneContact)[]"
+              "type": "string"
             }
           ],
           "optional": false,
           "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "cancel",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user cancels the dialog.",
+          "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": [],
+      "dependencies": [
+        "verdocs-button",
+        "verdocs-template-sender-dialog"
+      ],
+      "dependencyGraph": {
+        "verdocs-template-recipients": [
+          "verdocs-button",
+          "verdocs-template-sender-dialog"
+        ],
+        "verdocs-template-sender-dialog": [
+          "verdocs-radio-button",
+          "verdocs-help-icon",
+          "verdocs-button"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/templates/verdocs-template-reminders/verdocs-template-reminders.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-template-reminders",
+      "docs": "Displays a collection of settings boxes that allow a user to configure a template's behavior.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
         {
           "name": "endpoint",
           "type": "VerdocsEndpoint",
@@ -4693,16 +4850,17 @@
           "required": false
         },
         {
-          "name": "templateRole",
-          "type": "IRole",
+          "name": "templateId",
+          "type": "string",
           "mutable": false,
+          "attr": "template-id",
           "reflectToAttr": false,
-          "docs": "The role that this contact will be assigned to.",
+          "docs": "The template ID to edit.",
           "docsTags": [],
-          "default": "null",
+          "default": "''",
           "values": [
             {
-              "type": "IRole"
+              "type": "string"
             }
           ],
           "optional": false,
@@ -4712,7 +4870,7 @@
       "methods": [],
       "events": [
         {
-          "event": "cancel",
+          "event": "close",
           "detail": "any",
           "bubbles": true,
           "cancelable": true,
@@ -4721,21 +4879,12 @@
           "docsTags": []
         },
         {
-          "event": "next",
-          "detail": "IContactSelectEvent",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the user selects a contact.",
-          "docsTags": []
-        },
-        {
-          "event": "searchContacts",
-          "detail": "IContactSearchEvent",
+          "event": "sdkError",
+          "detail": "SDKError",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Event fired when the user enters text in the search field. The calling application may use this to update\nthe `contactSuggestions` property.",
+          "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": []
         }
       ],
@@ -4743,25 +4892,24 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "verdocs-build"
-      ],
+      "dependents": [],
       "dependencies": [
+        "verdocs-component-error",
+        "verdocs-checkbox",
+        "verdocs-text-input",
         "verdocs-button",
-        "verdocs-template-sender-dialog"
+        "verdocs-ok-dialog"
       ],
       "dependencyGraph": {
-        "verdocs-template-recipients": [
+        "verdocs-template-reminders": [
+          "verdocs-component-error",
+          "verdocs-checkbox",
+          "verdocs-text-input",
           "verdocs-button",
-          "verdocs-template-sender-dialog"
+          "verdocs-ok-dialog"
         ],
-        "verdocs-template-sender-dialog": [
-          "verdocs-radio-button",
-          "verdocs-help-icon",
+        "verdocs-ok-dialog": [
           "verdocs-button"
-        ],
-        "verdocs-build": [
-          "verdocs-template-recipients"
         ]
       }
     },
@@ -4881,6 +5029,87 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/templates/verdocs-template-visibillity/verdocs-template-visibility.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-template-visibility",
+      "docs": "Displays a collection of settings boxes that allow a user to configure a template's behavior.",
+      "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": "templateId",
+          "type": "string",
+          "mutable": false,
+          "attr": "template-id",
+          "reflectToAttr": false,
+          "docs": "The template ID to edit.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "close",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user cancels the dialog.",
+          "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": [],
+      "dependencies": [
+        "verdocs-component-error",
+        "verdocs-checkbox",
+        "verdocs-button"
+      ],
+      "dependencyGraph": {
+        "verdocs-template-visibility": [
+          "verdocs-component-error",
+          "verdocs-checkbox",
+          "verdocs-button"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/controls/verdocs-text-input/verdocs-text-input.tsx",
       "encapsulation": "none",
@@ -5033,7 +5262,9 @@
         "verdocs-field-timestamp",
         "verdocs-initial-dialog",
         "verdocs-signature-dialog",
-        "verdocs-template-properties"
+        "verdocs-template-name",
+        "verdocs-template-properties",
+        "verdocs-template-reminders"
       ],
       "dependencies": [],
       "dependencyGraph": {
@@ -5064,8 +5295,14 @@
         "verdocs-signature-dialog": [
           "verdocs-text-input"
         ],
+        "verdocs-template-name": [
+          "verdocs-text-input"
+        ],
         "verdocs-template-properties": [
           "verdocs-text-input"
+        ],
+        "verdocs-template-reminders": [
+          "verdocs-text-input"
         ]
       }
     },