@verdocs/web-sdk 1.15.0 → 1.15.2

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-06-07T21:48:16",
+  "timestamp": "2023-06-09T15:15:29",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -687,7 +687,6 @@
         "verdocs-template-roles",
         "verdocs-template-sender",
         "verdocs-template-visibility",
-        "verdocs-templates-list",
         "verdocs-upload-dialog"
       ],
       "dependencies": [],
@@ -758,9 +757,6 @@
         "verdocs-template-visibility": [
           "verdocs-button"
         ],
-        "verdocs-templates-list": [
-          "verdocs-button"
-        ],
         "verdocs-upload-dialog": [
           "verdocs-button"
         ]
@@ -1256,6 +1252,7 @@
         "verdocs-envelope-sidebar",
         "verdocs-envelopes-list",
         "verdocs-sign",
+        "verdocs-templates-list",
         "verdocs-view"
       ],
       "dependencies": [],
@@ -1269,6 +1266,9 @@
         "verdocs-sign": [
           "verdocs-dropdown"
         ],
+        "verdocs-templates-list": [
+          "verdocs-dropdown"
+        ],
         "verdocs-view": [
           "verdocs-dropdown"
         ]
@@ -1737,6 +1737,23 @@
       "docsTags": [],
       "usage": {},
       "props": [
+        {
+          "name": "containing",
+          "type": "string",
+          "mutable": true,
+          "attr": "containing",
+          "reflectToAttr": true,
+          "docs": "If set, filter envelopes by the specified \"containing\" value.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "endpoint",
           "type": "VerdocsEndpoint",
@@ -1754,29 +1771,29 @@
           "required": false
         },
         {
-          "name": "items",
-          "type": "number",
-          "mutable": false,
-          "attr": "items",
-          "reflectToAttr": false,
-          "docs": "The number of items to display.",
+          "name": "name",
+          "type": "string",
+          "mutable": true,
+          "attr": "name",
+          "reflectToAttr": true,
+          "docs": "If set, filter envelopes by the specified name.",
           "docsTags": [],
-          "default": "5",
+          "default": "''",
           "values": [
             {
-              "type": "number"
+              "type": "string"
             }
           ],
           "optional": false,
           "required": false
         },
         {
-          "name": "page",
+          "name": "selectedPage",
           "type": "number",
-          "mutable": false,
-          "attr": "page",
+          "mutable": true,
+          "attr": "selected-page",
           "reflectToAttr": true,
-          "docs": "The first page nymbver to display (0-based)",
+          "docs": "The initial page number to select. Pagination is internally controlled but may be overriden by the\nhost applicaiton.",
           "docsTags": [],
           "default": "0",
           "values": [
@@ -1790,7 +1807,7 @@
         {
           "name": "sortBy",
           "type": "\"canceled_at\" | \"created_at\" | \"envelope_name\" | \"envelope_status\" | \"updated_at\"",
-          "mutable": false,
+          "mutable": true,
           "attr": "sort-by",
           "reflectToAttr": true,
           "docs": "The sort field to use",
@@ -1824,7 +1841,7 @@
         {
           "name": "status",
           "type": "\"all\" | \"canceled\" | \"complete\" | \"declined\" | \"in progress\" | \"pending\"",
-          "mutable": false,
+          "mutable": true,
           "attr": "status",
           "reflectToAttr": true,
           "docs": "The status value to filter by",
@@ -1862,7 +1879,7 @@
         {
           "name": "view",
           "type": "\"action\" | \"all\" | \"completed\" | \"inbox\" | \"sent\" | \"waiting\"",
-          "mutable": false,
+          "mutable": true,
           "attr": "view",
           "reflectToAttr": true,
           "docs": "The filtered view to display. \"completed\" will show envelopes that have been submitted. \"action\" will\nshow envelopes where the user is a recipient and the envelope is not completed. \"waiting\" will show\nonly envelopes where the user is the sender and the envelope is not completed.",
@@ -1918,15 +1935,6 @@
           "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": []
         },
-        {
-          "event": "viewAll",
-          "detail": "{ endpoint: VerdocsEndpoint; view: string; }",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the user clicks View All in the title bar. The current view will be included in the event\ndetails to help the host application navigate the user to the appropriate screen for the request. Note that\nthe verdocs-envelopes-list control uses the same \"view\" parameter, so host applications can typically pass\nthis value through directly. This button is not visible if the header is hidden.",
-          "docsTags": []
-        },
         {
           "event": "viewEnvelope",
           "detail": "{ endpoint: VerdocsEndpoint; envelope: IEnvelope; }",
@@ -1943,21 +1951,25 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "verdocs-loader",
         "verdocs-text-input",
+        "verdocs-quick-filter",
+        "verdocs-spinner",
         "verdocs-button",
         "verdocs-checkbox",
         "verdocs-status-indicator",
-        "verdocs-dropdown"
+        "verdocs-dropdown",
+        "verdocs-pagination"
       ],
       "dependencyGraph": {
         "verdocs-envelopes-list": [
-          "verdocs-loader",
           "verdocs-text-input",
+          "verdocs-quick-filter",
+          "verdocs-spinner",
           "verdocs-button",
           "verdocs-checkbox",
           "verdocs-status-indicator",
-          "verdocs-dropdown"
+          "verdocs-dropdown",
+          "verdocs-pagination"
         ],
         "verdocs-text-input": [
           "verdocs-help-icon"
@@ -5206,7 +5218,6 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-envelopes-list",
         "verdocs-preview",
         "verdocs-sign",
         "verdocs-template-attachments",
@@ -5218,9 +5229,6 @@
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "verdocs-envelopes-list": [
-          "verdocs-loader"
-        ],
         "verdocs-preview": [
           "verdocs-loader"
         ],
@@ -5338,6 +5346,7 @@
         "verdocs-template-attachments",
         "verdocs-template-fields",
         "verdocs-template-reminders",
+        "verdocs-templates-list",
         "verdocs-view"
       ],
       "dependencies": [
@@ -5362,6 +5371,9 @@
         "verdocs-template-reminders": [
           "verdocs-ok-dialog"
         ],
+        "verdocs-templates-list": [
+          "verdocs-ok-dialog"
+        ],
         "verdocs-view": [
           "verdocs-ok-dialog"
         ]
@@ -5401,6 +5413,96 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/controls/verdocs-pagination/verdocs-pagination.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-pagination",
+      "docs": "Display a drop-down menu of quick filter options.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "itemCount",
+          "type": "number",
+          "mutable": false,
+          "attr": "item-count",
+          "reflectToAttr": false,
+          "docs": "The total number of items.",
+          "docsTags": [],
+          "default": "1",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "perPage",
+          "type": "number",
+          "mutable": false,
+          "attr": "per-page",
+          "reflectToAttr": false,
+          "docs": "The number of displayed per page.",
+          "docsTags": [],
+          "default": "10",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "selectedPage",
+          "type": "number",
+          "mutable": true,
+          "attr": "selected-page",
+          "reflectToAttr": true,
+          "docs": "The currently selected page.",
+          "docsTags": [],
+          "default": "0",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "selectPage",
+          "detail": "{ selectedPage: number; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the selected page changes. The new page number is included in the event.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-envelopes-list",
+        "verdocs-templates-list"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-envelopes-list": [
+          "verdocs-pagination"
+        ],
+        "verdocs-templates-list": [
+          "verdocs-pagination"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/embeds/verdocs-preview/verdocs-preview.tsx",
       "encapsulation": "none",
@@ -5551,6 +5653,112 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/controls/verdocs-quick-filter/verdocs-quick-filter.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-quick-filter",
+      "docs": "Display a drop-down menu of quick filter options.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "label",
+          "type": "string",
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "'Filter'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "options",
+          "type": "IFilterOption[]",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The menu options to display.",
+          "docsTags": [],
+          "default": "[]",
+          "values": [
+            {
+              "type": "IFilterOption[]"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "placeholder",
+          "type": "string",
+          "mutable": false,
+          "attr": "placeholder",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "'Select...'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "value",
+          "type": "string",
+          "mutable": true,
+          "attr": "value",
+          "reflectToAttr": true,
+          "docs": "",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "optionSelected",
+          "detail": "IFilterOption",
+          "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-envelopes-list",
+        "verdocs-templates-list"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-envelopes-list": [
+          "verdocs-quick-filter"
+        ],
+        "verdocs-templates-list": [
+          "verdocs-quick-filter"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/elements/verdocs-quick-functions/verdocs-quick-functions.tsx",
       "encapsulation": "none",
@@ -6447,6 +6655,74 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/controls/verdocs-spinner/verdocs-spinner.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-spinner",
+      "docs": "Display a small loading spinner.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "mode",
+          "type": "\"dark\" | \"light\"",
+          "mutable": false,
+          "attr": "mode",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "'light'",
+          "values": [
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "size",
+          "type": "number",
+          "mutable": false,
+          "attr": "size",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "32",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-envelopes-list",
+        "verdocs-templates-list"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-envelopes-list": [
+          "verdocs-spinner"
+        ],
+        "verdocs-templates-list": [
+          "verdocs-spinner"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/envelopes/verdocs-status-indicator/verdocs-status-indicator.tsx",
       "encapsulation": "none",
@@ -7847,6 +8123,81 @@
         ]
       }
     },
+    {
+      "filePath": "./src/components/templates/verdocs-template-star/verdocs-template-star.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-template-star",
+      "docs": "Displays a clickable star that allows users to mark frequently-used templates.",
+      "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": "template",
+          "type": "ITemplateSummaryEntry",
+          "mutable": true,
+          "reflectToAttr": false,
+          "docs": "The template to display the star for.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "ITemplateSummaryEntry"
+            }
+          ],
+          "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": []
+        },
+        {
+          "event": "starChange",
+          "detail": "{ templateId: string; starred: boolean; count: number; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user toggles the star on or off. The event detail will contain\nthe new \"starred\" status and count.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-templates-list"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-templates-list": [
+          "verdocs-template-star"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/templates/verdocs-template-tags/verdocs-template-tags.tsx",
       "encapsulation": "none",
@@ -7966,7 +8317,7 @@
       "filePath": "./src/components/templates/verdocs-templates-list/verdocs-templates-list.tsx",
       "encapsulation": "none",
       "tag": "verdocs-templates-list",
-      "docs": "Displays a box showing summaries of envelopes matching specified conditions. Activity Boxes show a fixed number\nof items because they are meant to be laid out horizontally (if the user's screen is large enough) and this helps\nthem appear more visually balanced.",
+      "docs": "Displays a list of envelopes matching specified conditions.",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -7987,31 +8338,31 @@
           "required": false
         },
         {
-          "name": "header",
+          "name": "name",
           "type": "string",
-          "mutable": false,
-          "attr": "header",
-          "reflectToAttr": false,
-          "docs": "The title to display on the box (\"title\" is a reserved word). This is optional, and if not set, the title\nwill be derived from the view. Set this to an empty string to hide the header.",
+          "mutable": true,
+          "attr": "name",
+          "reflectToAttr": true,
+          "docs": "If set, filter templates by the specified name.",
           "docsTags": [],
-          "default": "undefined",
+          "default": "''",
           "values": [
             {
               "type": "string"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
-          "name": "items",
+          "name": "selectedPage",
           "type": "number",
-          "mutable": false,
-          "attr": "items",
-          "reflectToAttr": false,
-          "docs": "The number of items to display.",
+          "mutable": true,
+          "attr": "selected-page",
+          "reflectToAttr": true,
+          "docs": "The initial page number to select. Pagination is internally controlled but may be overriden by the\nhost applicaiton.",
           "docsTags": [],
-          "default": "5",
+          "default": "0",
           "values": [
             {
               "type": "number"
@@ -8021,34 +8372,111 @@
           "required": false
         },
         {
-          "name": "view",
-          "type": "\"action\" | \"completed\" | \"waiting\"",
-          "mutable": false,
-          "attr": "view",
-          "reflectToAttr": false,
-          "docs": "",
+          "name": "sharing",
+          "type": "\"all\" | \"personal\" | \"public\" | \"shared\"",
+          "mutable": true,
+          "attr": "sharing",
+          "reflectToAttr": true,
+          "docs": "The sharing settings to filter by.",
           "docsTags": [],
-          "default": "undefined",
+          "default": "'all'",
           "values": [
             {
-              "value": "action",
+              "value": "all",
               "type": "string"
             },
             {
-              "value": "completed",
+              "value": "personal",
               "type": "string"
             },
             {
-              "value": "waiting",
+              "value": "public",
+              "type": "string"
+            },
+            {
+              "value": "shared",
               "type": "string"
             }
           ],
           "optional": true,
           "required": false
+        },
+        {
+          "name": "sort",
+          "type": "\"counter\" | \"created_at\" | \"last_used_at\" | \"name\" | \"star_counter\" | \"updated_at\"",
+          "mutable": true,
+          "attr": "sort",
+          "reflectToAttr": true,
+          "docs": "The sort order to display.",
+          "docsTags": [],
+          "default": "'updated_at'",
+          "values": [
+            {
+              "value": "counter",
+              "type": "string"
+            },
+            {
+              "value": "created_at",
+              "type": "string"
+            },
+            {
+              "value": "last_used_at",
+              "type": "string"
+            },
+            {
+              "value": "name",
+              "type": "string"
+            },
+            {
+              "value": "star_counter",
+              "type": "string"
+            },
+            {
+              "value": "updated_at",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "starred",
+          "type": "\"all\" | \"starred\" | \"unstarred\"",
+          "mutable": true,
+          "attr": "starred",
+          "reflectToAttr": true,
+          "docs": "The starred settings to filter by.",
+          "docsTags": [],
+          "default": "'all'",
+          "values": [
+            {
+              "value": "all",
+              "type": "string"
+            },
+            {
+              "value": "starred",
+              "type": "string"
+            },
+            {
+              "value": "unstarred",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
         }
       ],
       "methods": [],
       "events": [
+        {
+          "event": "editTemplate",
+          "detail": "{ endpoint: VerdocsEndpoint; template: ITemplate; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user chooses the Edit option from the dropdown menu.",
+          "docsTags": []
+        },
         {
           "event": "sdkError",
           "detail": "SDKError",
@@ -8059,21 +8487,21 @@
           "docsTags": []
         },
         {
-          "event": "viewAll",
-          "detail": "{ endpoint: VerdocsEndpoint; view: string; }",
+          "event": "templateDeleted",
+          "detail": "{ endpoint: VerdocsEndpoint; template: ITemplate; }",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Event fired when the user clicks View All in the title bar. The current view will be included in the event\ndetails to help the host application navigate the user to the appropriate screen for the request. Note that\nthe verdocs-envelopes-list control uses the same \"view\" parameter, so host applications can typically pass\nthis value through directly. This button is not visible if the header is hidden.",
+          "docs": "Event fired when the user chooses the Delete option from the dropdown menu. When this is fired, the template\nwill already have been deleted. The host application should remove it from the list or refresh the list.",
           "docsTags": []
         },
         {
-          "event": "viewEnvelope",
-          "detail": "{ endpoint: VerdocsEndpoint; envelope: IEnvelope; }",
+          "event": "viewTemplate",
+          "detail": "{ endpoint: VerdocsEndpoint; template: ITemplate; }",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
-          "docs": "Event fired when the user clicks an activity entry. Typically the host application will use this to navigate\nto the envelope detail view.",
+          "docs": "Event fired when the user clicks a template to view it. Typically the host application will use this to navigate\nto the template preview. This is also fired when the user selects \"Preview/Send\" fropm the dropdown menu.",
           "docsTags": []
         }
       ],
@@ -8083,10 +8511,28 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "verdocs-button"
+        "verdocs-text-input",
+        "verdocs-quick-filter",
+        "verdocs-spinner",
+        "verdocs-template-star",
+        "verdocs-dropdown",
+        "verdocs-pagination",
+        "verdocs-ok-dialog"
       ],
       "dependencyGraph": {
         "verdocs-templates-list": [
+          "verdocs-text-input",
+          "verdocs-quick-filter",
+          "verdocs-spinner",
+          "verdocs-template-star",
+          "verdocs-dropdown",
+          "verdocs-pagination",
+          "verdocs-ok-dialog"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
+        ],
+        "verdocs-ok-dialog": [
           "verdocs-button"
         ]
       }
@@ -8258,7 +8704,8 @@
         "verdocs-template-field-properties",
         "verdocs-template-name",
         "verdocs-template-reminders",
-        "verdocs-template-role-properties"
+        "verdocs-template-role-properties",
+        "verdocs-templates-list"
       ],
       "dependencies": [
         "verdocs-help-icon"
@@ -8290,6 +8737,9 @@
         ],
         "verdocs-template-role-properties": [
           "verdocs-text-input"
+        ],
+        "verdocs-templates-list": [
+          "verdocs-text-input"
         ]
       }
     },