@verdocs/web-sdk 1.4.2 → 1.5.0

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2022-07-28T14:20:39",
+  "timestamp": "2022-07-29T16:47:59",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.17.1",
@@ -10,7 +10,7 @@
       "filePath": "./src/components/embeds/verdocs-auth/verdocs-auth.tsx",
       "encapsulation": "none",
       "tag": "verdocs-auth",
-      "docs": "Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that\noccur during the process (especially successful completion). The success callback will be fired immediately if the\nuser is already authenticated with a valid session, so this component may not always display visibly. To simplify\nsome types of authentication flows, a visibility flag can force this component to never display.\n\nThis embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide\ncontainer to allow sufficient space for the required forms.\n\nAs noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after\nthe widget is rendered and the user's status has been checked. It may be fired again as the user completes (or\ncancels) authentication steps.\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.\n\n```typescript\ninterface IAuthStatus {\n  // If true, the user is authenticated with a valid session\n  authenticated: boolean;\n\n  // Details for the user's session\n  session: IActiveSession | null;\n}\n```",
+      "docs": "Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that\noccur during the process (especially successful completion). The success callback will be fired immediately if the\nuser is already authenticated with a valid session, so this component may not always display visibly.\n\nTo simplify some types of authentication flows, a visibility flag can force this component to never display. This\nallows you to susbcribe to notifications from the\n\nThis embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide\ncontainer to allow sufficient space for the required forms.\n\nAs noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after\nthe widget is rendered and the user's status has been checked. It may be fired again as the user completes (or\ncancels) authentication steps.\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.\n\n```typescript\ninterface IAuthStatus {\n  // If true, the user is authenticated with a valid session\n  authenticated: boolean;\n\n  // Details for the user's session\n  session: IActiveSession | null;\n}\n```",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -31,6 +31,22 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
+          "docsTags": [],
+          "default": "VerdocsEndpoint.getDefault()",
+          "values": [
+            {
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "logo",
           "type": "string",
@@ -2325,7 +2341,24 @@
       "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": [],
+      "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
+        }
+      ],
       "methods": [],
       "events": [
         {
@@ -2362,7 +2395,24 @@
       "docs": "",
       "docsTags": [],
       "usage": {},
-      "props": [],
+      "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
+        }
+      ],
       "methods": [],
       "events": [],
       "listeners": [],
@@ -2389,6 +2439,22 @@
       "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": "options",
           "type": "any",
@@ -2466,6 +2532,22 @@
       "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": "placeholder",
           "type": "string",
@@ -2618,6 +2700,22 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "endpoint",
+          "type": "VerdocsEndpoint",
+          "mutable": false,
+          "reflectToAttr": false,
+          "docs": "The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.",
+          "docsTags": [],
+          "default": "VerdocsEndpoint.getDefault()",
+          "values": [
+            {
+              "type": "VerdocsEndpoint"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "invitecode",
           "type": "string",
@@ -3326,6 +3424,22 @@
       "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": "rotation",
           "type": "0 | 180 | 270 | 90",