@verdocs/web-sdk 1.15.0 → 1.15.1

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-06-07T21:48:16",
+  "timestamp": "2023-06-09T04:29:19",
   "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"
         ]
@@ -1754,14 +1754,14 @@
           "required": false
         },
         {
-          "name": "items",
+          "name": "maxItems",
           "type": "number",
           "mutable": false,
-          "attr": "items",
+          "attr": "max-items",
           "reflectToAttr": false,
-          "docs": "The number of items to display.",
+          "docs": "The max number of items to display.",
           "docsTags": [],
-          "default": "5",
+          "default": "40",
           "values": [
             {
               "type": "number"
@@ -1771,12 +1771,12 @@
           "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 +1790,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 +1824,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 +1862,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.",
@@ -1943,21 +1943,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 +5210,6 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-envelopes-list",
         "verdocs-preview",
         "verdocs-sign",
         "verdocs-template-attachments",
@@ -5214,13 +5217,11 @@
         "verdocs-template-fields",
         "verdocs-template-name",
         "verdocs-template-roles",
+        "verdocs-templates-list",
         "verdocs-view"
       ],
       "dependencies": [],
       "dependencyGraph": {
-        "verdocs-envelopes-list": [
-          "verdocs-loader"
-        ],
         "verdocs-preview": [
           "verdocs-loader"
         ],
@@ -5242,6 +5243,9 @@
         "verdocs-template-roles": [
           "verdocs-loader"
         ],
+        "verdocs-templates-list": [
+          "verdocs-loader"
+        ],
         "verdocs-view": [
           "verdocs-loader"
         ]
@@ -5401,6 +5405,92 @@
       "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"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-envelopes-list": [
+          "verdocs-pagination"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/embeds/verdocs-preview/verdocs-preview.tsx",
       "encapsulation": "none",
@@ -5551,6 +5641,108 @@
         ]
       }
     },
+    {
+      "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"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-envelopes-list": [
+          "verdocs-quick-filter"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/elements/verdocs-quick-functions/verdocs-quick-functions.tsx",
       "encapsulation": "none",
@@ -6447,6 +6639,70 @@
         ]
       }
     },
+    {
+      "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"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-envelopes-list": [
+          "verdocs-spinner"
+        ]
+      }
+    },
     {
       "filePath": "./src/components/envelopes/verdocs-status-indicator/verdocs-status-indicator.tsx",
       "encapsulation": "none",
@@ -7966,7 +8222,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 +8243,31 @@
           "required": false
         },
         {
-          "name": "header",
-          "type": "string",
+          "name": "items",
+          "type": "number",
           "mutable": false,
-          "attr": "header",
+          "attr": "items",
           "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.",
+          "docs": "The number of items to display.",
           "docsTags": [],
-          "default": "undefined",
+          "default": "5",
           "values": [
             {
-              "type": "string"
+              "type": "number"
             }
           ],
-          "optional": true,
+          "optional": false,
           "required": false
         },
         {
-          "name": "items",
+          "name": "page",
           "type": "number",
           "mutable": false,
-          "attr": "items",
-          "reflectToAttr": false,
-          "docs": "The number of items to display.",
+          "attr": "page",
+          "reflectToAttr": true,
+          "docs": "The first page nymbver to display (0-based)",
           "docsTags": [],
-          "default": "5",
+          "default": "0",
           "values": [
             {
               "type": "number"
@@ -8022,11 +8278,11 @@
         },
         {
           "name": "view",
-          "type": "\"action\" | \"completed\" | \"waiting\"",
+          "type": "\"action\" | \"all\" | \"completed\" | \"inbox\" | \"sent\" | \"waiting\"",
           "mutable": false,
           "attr": "view",
-          "reflectToAttr": false,
-          "docs": "",
+          "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.",
           "docsTags": [],
           "default": "undefined",
           "values": [
@@ -8034,10 +8290,22 @@
               "value": "action",
               "type": "string"
             },
+            {
+              "value": "all",
+              "type": "string"
+            },
             {
               "value": "completed",
               "type": "string"
             },
+            {
+              "value": "inbox",
+              "type": "string"
+            },
+            {
+              "value": "sent",
+              "type": "string"
+            },
             {
               "value": "waiting",
               "type": "string"
@@ -8049,6 +8317,15 @@
       ],
       "methods": [],
       "events": [
+        {
+          "event": "finishLater",
+          "detail": "{ endpoint: VerdocsEndpoint; template: ITemplate; }",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user clicks to finish signing later. Typically the host application should redirect\nthe user to another page.",
+          "docsTags": []
+        },
         {
           "event": "sdkError",
           "detail": "SDKError",
@@ -8069,7 +8346,7 @@
         },
         {
           "event": "viewEnvelope",
-          "detail": "{ endpoint: VerdocsEndpoint; envelope: IEnvelope; }",
+          "detail": "{ endpoint: VerdocsEndpoint; template: ITemplate; }",
           "bubbles": true,
           "cancelable": true,
           "composed": true,
@@ -8083,11 +8360,18 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "verdocs-button"
+        "verdocs-loader",
+        "verdocs-text-input",
+        "verdocs-dropdown"
       ],
       "dependencyGraph": {
         "verdocs-templates-list": [
-          "verdocs-button"
+          "verdocs-loader",
+          "verdocs-text-input",
+          "verdocs-dropdown"
+        ],
+        "verdocs-text-input": [
+          "verdocs-help-icon"
         ]
       }
     },
@@ -8258,7 +8542,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 +8575,9 @@
         ],
         "verdocs-template-role-properties": [
           "verdocs-text-input"
+        ],
+        "verdocs-templates-list": [
+          "verdocs-text-input"
         ]
       }
     },

package/dist/esm/{TemplateStore-852097c3.js → TemplateStore-c15956ae.js}

@@ -1,6 +1,6 @@
 import { c as createStore } from './index-29123f30.js';
-import { g as getTemplate } from './Templates-67172396.js';
-import { T as TemplateSenderTypes } from './VerdocsEndpoint-5b92f115.js';
+import { g as getTemplate } from './Templates-3760f311.js';
+import { T as TemplateSenderTypes } from './VerdocsEndpoint-45286fc7.js';
 
 const createTemplateStore = (templateId) => {
   const now = new Date().toISOString();

package/dist/esm/{Templates-67172396.js → Templates-3760f311.js}

@@ -4,6 +4,42 @@
  *
  * @module
  */
+var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (undefined && undefined.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 /**
  * Get all templates accessible by the caller, with optional filters.
  *
@@ -95,5 +131,24 @@ var updateTemplate = function (endpoint, templateId, params) {
         .put("/templates/".concat(templateId), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Get a summary of template data, typically used to populate admin panel dashboard pages.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
+ * ```
+ */
+var getSummary = function (endpoint, params) {
+    if (params === void 0) { params = {}; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, endpoint.api //
+                    .post('/templates/summary', params)
+                    .then(function (r) { return r.data; })];
+        });
+    });
+};
 
-export { getTemplates as a, createTemplate as c, getTemplate as g, updateTemplate as u };
+export { getSummary as a, getTemplates as b, createTemplate as c, getTemplate as g, updateTemplate as u };