@verdocs/web-sdk 1.1.0 → 1.2.0

package/dist/docs.json

@@ -1,344 +1,11 @@
 {
-  "timestamp": "2022-02-09T04:26:54",
+  "timestamp": "2022-02-18T06:01:40",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.12.1",
     "typescriptVersion": "4.3.5"
   },
   "components": [
-    {
-      "filePath": "./src/components/elements/search-box/search-box.tsx",
-      "encapsulation": "none",
-      "tag": "search-box",
-      "docs": "Displays a customizable input box for search queries.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "placeholder",
-          "type": "string",
-          "mutable": false,
-          "attr": "placeholder",
-          "reflectToAttr": false,
-          "docs": "The placeholder to display in the input field.",
-          "docsTags": [],
-          "default": "'search documents, templates, people...'",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "query",
-          "type": "string",
-          "mutable": false,
-          "attr": "query",
-          "reflectToAttr": false,
-          "docs": "The text search string entered by the user.",
-          "docsTags": [],
-          "default": "''",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        },
-        {
-          "name": "type",
-          "type": "\"all\" | \"document\" | \"organization\" | \"template\"",
-          "mutable": false,
-          "attr": "type",
-          "reflectToAttr": false,
-          "docs": "If set to a value other than 'all', a removeable filter indicator will be displayed.",
-          "docsTags": [],
-          "default": "'all'",
-          "values": [
-            {
-              "value": "all",
-              "type": "string"
-            },
-            {
-              "value": "document",
-              "type": "string"
-            },
-            {
-              "value": "organization",
-              "type": "string"
-            },
-            {
-              "value": "template",
-              "type": "string"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [],
-      "events": [
-        {
-          "event": "queryChanged",
-          "detail": "string",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the user changes the query string.",
-          "docsTags": []
-        },
-        {
-          "event": "searchClicked",
-          "detail": "ISearchEvent",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the user changes the type.",
-          "docsTags": []
-        },
-        {
-          "event": "typeChanged",
-          "detail": "\"all\" | \"document\" | \"organization\" | \"template\"",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the user changes the type.",
-          "docsTags": []
-        }
-      ],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [
-        "verdocs-search"
-      ],
-      "dependencies": [],
-      "dependencyGraph": {
-        "verdocs-search": [
-          "search-box"
-        ]
-      }
-    },
-    {
-      "filePath": "./src/components/elements/search-quick-functions/search-quick-functions.tsx",
-      "encapsulation": "none",
-      "tag": "search-quick-functions",
-      "docs": "Display quick-function buttons for creating templates and documents.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
-      "docsTags": [],
-      "usage": {},
-      "props": [],
-      "methods": [],
-      "events": [
-        {
-          "event": "createDocument",
-          "detail": "any",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when an entry is clicked.",
-          "docsTags": []
-        },
-        {
-          "event": "createTemplate",
-          "detail": "any",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when an entry is clicked.",
-          "docsTags": []
-        }
-      ],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [
-        "verdocs-search"
-      ],
-      "dependencies": [],
-      "dependencyGraph": {
-        "verdocs-search": [
-          "search-quick-functions"
-        ]
-      }
-    },
-    {
-      "filePath": "./src/components/elements/search-recent/search-recent.tsx",
-      "encapsulation": "none",
-      "tag": "search-recent",
-      "docs": "Display a list of recent searches. Note that only some types of searches are automatically saved in the\nuser's history (those that contain a unique `q` query string from the next-most-recent search.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "limit",
-          "type": "number",
-          "mutable": false,
-          "attr": "limit",
-          "reflectToAttr": false,
-          "docs": "If set, limits the number of entries that will be shown. Note that there is a server-imposed limit of 20 entries\nthat cannot currently be increased (only reduced).",
-          "docsTags": [],
-          "default": "10",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [],
-      "events": [
-        {
-          "event": "entrySelected",
-          "detail": "IRecentSearch",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when an entry is clicked.",
-          "docsTags": []
-        }
-      ],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [
-        "verdocs-search"
-      ],
-      "dependencies": [],
-      "dependencyGraph": {
-        "verdocs-search": [
-          "search-recent"
-        ]
-      }
-    },
-    {
-      "filePath": "./src/components/elements/search-saved/search-saved.tsx",
-      "encapsulation": "none",
-      "tag": "search-saved",
-      "docs": "Display a list of saved searches. Note that only some types of searches are automatically saved in the\nuser's history (those that contain a unique `q` query string from the next-most-recent search.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "limit",
-          "type": "number",
-          "mutable": false,
-          "attr": "limit",
-          "reflectToAttr": false,
-          "docs": "If set, limits the number of entries that will be shown. Note that there is a server-imposed limit of 20 entries\nthat cannot currently be increased (only reduced).",
-          "docsTags": [],
-          "default": "10",
-          "values": [
-            {
-              "type": "number"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [],
-      "events": [
-        {
-          "event": "entrySelected",
-          "detail": "ISavedSearch",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when an entry is clicked.",
-          "docsTags": []
-        }
-      ],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [
-        "verdocs-search"
-      ],
-      "dependencies": [],
-      "dependencyGraph": {
-        "verdocs-search": [
-          "search-saved"
-        ]
-      }
-    },
-    {
-      "filePath": "./src/components/elements/search-starred/search-starred.tsx",
-      "encapsulation": "none",
-      "tag": "search-starred",
-      "docs": "Display a list of starred items.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
-      "docsTags": [],
-      "usage": {},
-      "props": [
-        {
-          "name": "options",
-          "type": "any",
-          "mutable": false,
-          "attr": "options",
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "any"
-            }
-          ],
-          "optional": false,
-          "required": false
-        }
-      ],
-      "methods": [],
-      "events": [
-        {
-          "event": "entrySelected",
-          "detail": "IRecentSearch",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when an entry is clicked.",
-          "docsTags": []
-        }
-      ],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [
-        "verdocs-search"
-      ],
-      "dependencies": [],
-      "dependencyGraph": {
-        "verdocs-search": [
-          "search-starred"
-        ]
-      }
-    },
-    {
-      "filePath": "./src/components/elements/search-tabs/search-tabs.tsx",
-      "encapsulation": "none",
-      "tag": "search-tabs",
-      "docs": "",
-      "docsTags": [],
-      "usage": {},
-      "props": [],
-      "methods": [],
-      "events": [],
-      "listeners": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {}
-    },
     {
       "filePath": "./src/components/embeds/verdocs-auth/verdocs-auth.tsx",
       "encapsulation": "none",
@@ -2435,6 +2102,43 @@
       "dependencies": [],
       "dependencyGraph": {}
     },
+    {
+      "filePath": "./src/components/elements/verdocs-quick-functions/verdocs-quick-functions.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-quick-functions",
+      "docs": "Display quick-function buttons for creating templates and documents.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [
+        {
+          "event": "createDocument",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when an entry is clicked.",
+          "docsTags": []
+        },
+        {
+          "event": "createTemplate",
+          "detail": "any",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when an entry is clicked.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "./src/components/embeds/verdocs-search/verdocs-search.tsx",
       "encapsulation": "none",
@@ -2451,22 +2155,228 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "search-box",
-        "search-recent",
-        "search-starred",
-        "search-saved",
-        "search-quick-functions"
+        "verdocs-search-box",
+        "verdocs-search-activity"
+      ],
+      "dependencyGraph": {
+        "verdocs-search": [
+          "verdocs-search-box",
+          "verdocs-search-activity"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/elements/verdocs-search-activity/verdocs-search-activity.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-search-activity",
+      "docs": "Display a list of starred items.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "options",
+          "type": "any",
+          "mutable": false,
+          "attr": "options",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "any"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "type",
+          "type": "\"recent\" | \"saved\" | \"starred\"",
+          "mutable": false,
+          "attr": "type",
+          "reflectToAttr": false,
+          "docs": "",
+          "docsTags": [],
+          "default": "'recent'",
+          "values": [
+            {
+              "value": "recent",
+              "type": "string"
+            },
+            {
+              "value": "saved",
+              "type": "string"
+            },
+            {
+              "value": "starred",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "entrySelected",
+          "detail": "IRecentSearch",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when an entry is clicked.",
+          "docsTags": []
+        }
+      ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-search"
+      ],
+      "dependencies": [],
+      "dependencyGraph": {
+        "verdocs-search": [
+          "verdocs-search-activity"
+        ]
+      }
+    },
+    {
+      "filePath": "./src/components/elements/verdocs-search-box/verdocs-search-box.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-search-box",
+      "docs": "Displays a customizable input box for search queries.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed.",
+      "docsTags": [],
+      "usage": {},
+      "props": [
+        {
+          "name": "placeholder",
+          "type": "string",
+          "mutable": false,
+          "attr": "placeholder",
+          "reflectToAttr": false,
+          "docs": "The placeholder to display in the input field.",
+          "docsTags": [],
+          "default": "'search documents, templates, people...'",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "query",
+          "type": "string",
+          "mutable": false,
+          "attr": "query",
+          "reflectToAttr": false,
+          "docs": "The text search string entered by the user.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
+        {
+          "name": "type",
+          "type": "\"all\" | \"document\" | \"organization\" | \"template\"",
+          "mutable": false,
+          "attr": "type",
+          "reflectToAttr": false,
+          "docs": "If set to a value other than 'all', a removeable filter indicator will be displayed.",
+          "docsTags": [],
+          "default": "'all'",
+          "values": [
+            {
+              "value": "all",
+              "type": "string"
+            },
+            {
+              "value": "document",
+              "type": "string"
+            },
+            {
+              "value": "organization",
+              "type": "string"
+            },
+            {
+              "value": "template",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        }
+      ],
+      "methods": [],
+      "events": [
+        {
+          "event": "queryChanged",
+          "detail": "string",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user changes the query string.",
+          "docsTags": []
+        },
+        {
+          "event": "searchClicked",
+          "detail": "ISearchEvent",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user changes the type.",
+          "docsTags": []
+        },
+        {
+          "event": "typeChanged",
+          "detail": "\"all\" | \"document\" | \"organization\" | \"template\"",
+          "bubbles": true,
+          "cancelable": true,
+          "composed": true,
+          "docs": "Event fired when the user changes the type.",
+          "docsTags": []
+        }
       ],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [
+        "verdocs-search"
+      ],
+      "dependencies": [],
       "dependencyGraph": {
         "verdocs-search": [
-          "search-box",
-          "search-recent",
-          "search-starred",
-          "search-saved",
-          "search-quick-functions"
+          "verdocs-search-box"
         ]
       }
     },
+    {
+      "filePath": "./src/components/elements/verdocs-search-tabs/verdocs-search-tabs.tsx",
+      "encapsulation": "none",
+      "tag": "verdocs-search-tabs",
+      "docs": "",
+      "docsTags": [],
+      "usage": {},
+      "props": [],
+      "methods": [],
+      "events": [],
+      "listeners": [],
+      "styles": [],
+      "slots": [],
+      "parts": [],
+      "dependents": [],
+      "dependencies": [],
+      "dependencyGraph": {}
+    },
     {
       "filePath": "./src/components/embeds/verdocs-sign/verdocs-sign.tsx",
       "encapsulation": "none",

package/dist/esm/Auth-16761ea6.js

@@ -0,0 +1,64 @@
+import { g as getEndpoint, d as decodeAccessTokenBody } from './Token-b82a8ea3.js';
+
+/**
+ * Authenticate to Verdocs via user/password authentication
+ *
+ * ```typescript
+ * import {Auth} from '@verdocs/js-sdk/Auth';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * const {accessToken} = await Auth.authenticateUser({ username: 'test@test.com', password: 'PASSWORD' });
+ * Transport.setAuthToken(accessToken);
+ * ```
+ */
+var authenticateUser = function (params) {
+    return getEndpoint()
+        .api.post('/authentication/login', params)
+        .then(function (r) { return r.data; });
+};
+var clearSession = function (source, persist) {
+    getEndpoint().setAuthorization(null);
+    if (persist) {
+        localStorage.removeItem(source);
+    }
+    return null;
+};
+/**
+ * Parses and sets the active session, optionally persisting (brower-only, persists to localStorage).
+ */
+var setSession = function (source, token, persist) {
+    if (persist === void 0) { persist = false; }
+    if (token === null) {
+        return clearSession(source, persist);
+    }
+    var session = decodeAccessTokenBody(token || '');
+    if (session === null || (session.exp && session.exp * 1000 < new Date().getTime())) {
+        return clearSession(source, persist);
+    }
+    if (persist) {
+        localStorage.setItem(source, token);
+    }
+    getEndpoint().setAuthorization(token);
+    return session;
+};
+/**
+ * Load a session from localStorage
+ */
+var loadSession = function (source) {
+    var token = localStorage.getItem(source);
+    if (!token) {
+        return null;
+    }
+    var session = decodeAccessTokenBody(token);
+    if (!session) {
+        return null;
+    }
+    if (session.exp && session.exp * 1000 < new Date().getTime()) {
+        localStorage.removeItem(source);
+        return null;
+    }
+    getEndpoint().setAuthorization(token);
+    return session;
+};
+
+export { authenticateUser as a, loadSession as l, setSession as s };