@verdocs/web-sdk 1.0.25 → 1.1.0

package/dist/custom-elements.json

@@ -0,0 +1,727 @@
+{
+  "version": 1.1,
+  "tags": [
+    {
+      "name": "search-box",
+      "description": {
+        "kind": "markdown",
+        "value": "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."
+      },
+      "attributes": [
+        {
+          "name": "placeholder",
+          "description": "The placeholder to display in the input field."
+        },
+        {
+          "name": "query",
+          "description": "The text search string entered by the user."
+        },
+        {
+          "name": "type",
+          "description": "If set to a value other than 'all', a removeable filter indicator will be displayed.",
+          "values": [
+            {
+              "name": "all"
+            },
+            {
+              "name": "document"
+            },
+            {
+              "name": "organization"
+            },
+            {
+              "name": "template"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "search-quick-functions",
+      "description": {
+        "kind": "markdown",
+        "value": "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."
+      },
+      "attributes": []
+    },
+    {
+      "name": "search-recent",
+      "description": {
+        "kind": "markdown",
+        "value": "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."
+      },
+      "attributes": [
+        {
+          "name": "limit",
+          "description": "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)."
+        }
+      ]
+    },
+    {
+      "name": "search-saved",
+      "description": {
+        "kind": "markdown",
+        "value": "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."
+      },
+      "attributes": [
+        {
+          "name": "limit",
+          "description": "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)."
+        }
+      ]
+    },
+    {
+      "name": "search-starred",
+      "description": {
+        "kind": "markdown",
+        "value": "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."
+      },
+      "attributes": [
+        {
+          "name": "options",
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "search-tabs",
+      "description": {
+        "kind": "markdown",
+        "value": ""
+      },
+      "attributes": []
+    },
+    {
+      "name": "verdocs-auth",
+      "description": {
+        "kind": "markdown",
+        "value": "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```"
+      },
+      "attributes": [
+        {
+          "name": "debug",
+          "description": "If the user is authenticated, this embed will normally render invisibly. If debug is set true, a summary\nif the user's session details will be displayed instead. This may be useful while debugging authentication\nflows in new applications."
+        },
+        {
+          "name": "logo",
+          "description": "By default, a Verdocs logo will be displayed above the login/signup forms. This may be used to\noverride its source. (Alternatively, you may simply hide it via CSS overrides.) Logos should be\nin SVG format for best results."
+        },
+        {
+          "name": "visible",
+          "description": "Normally, if the user has a valid session, this embed will be invisible, otherwise it will display\nlogin / signup forms. If this is set to false, this embed will be invisible in both cases. Apps may\nuse this to verify if a user has a valid session without needing a separate call to Verdocs JS SDK."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-button",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a simple button. Three variants are supported. Standard and Outline buttons look like traditional form buttons and are\nideal candidates for 'Ok' and 'Cancel' options in most cases. Text buttons are intended to be used inline in content blocks or\nfor more subtle button options. (Auth uses text buttons for the Forgot Password and Sign Up options.)"
+      },
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Whether the button should be disabled."
+        },
+        {
+          "name": "label",
+          "description": "The label for the  button."
+        },
+        {
+          "name": "type",
+          "description": "The type of the button.",
+          "values": [
+            {
+              "name": "button"
+            },
+            {
+              "name": "reset"
+            },
+            {
+              "name": "submit"
+            }
+          ]
+        },
+        {
+          "name": "variant",
+          "description": "The display variant of the button.",
+          "values": [
+            {
+              "name": "outline"
+            },
+            {
+              "name": "standard"
+            },
+            {
+              "name": "text"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "verdocs-document-status",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays an icon and message describing a document's completion status."
+      },
+      "attributes": [
+        {
+          "name": "status",
+          "description": "The status to display",
+          "values": [
+            {
+              "name": "canceled"
+            },
+            {
+              "name": "complete"
+            },
+            {
+              "name": "declined"
+            },
+            {
+              "name": "in progress"
+            },
+            {
+              "name": "pending"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "verdocs-dropdown",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden\nwhen the button is pressed again, or an option is selected.\n\n```typescript\ninterface IMenuOption {\n  // The label to display on the menu option.\n  label: string;\n  // Optional icon to display next to the option's label. Specify icons as SVG strings.\n  icon?: string;\n  // If true, the option will be shown disabled (dimmed and not clickable).\n  disabled?: boolean;\n  // Optional additional fields such as IDs or other data. When a menu option is clicked/tapped, the associated\n  // IMenuOptionwill be passed to the event handler. This data may be used to help identify the option selected.\n  [key: string]: any;\n}\n```"
+      },
+      "attributes": [
+        {
+          "name": "open",
+          "description": "If set, the component will be open by default. This is primarily intended to be used for testing."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-attachment",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox."
+      },
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Sets the disabled attribute of the input element."
+        },
+        {
+          "name": "order",
+          "description": "Sets the tabIndex of the input element."
+        },
+        {
+          "name": "required",
+          "description": "If true, the field will be marked required."
+        },
+        {
+          "name": "value",
+          "description": "Sets the value of the input element."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-checkbox",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox."
+      },
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Sets the disabled attribute of the input element."
+        },
+        {
+          "name": "order",
+          "description": "Sets the tabIndex of the input element."
+        },
+        {
+          "name": "required",
+          "description": "If true, the field will be marked required."
+        },
+        {
+          "name": "value",
+          "description": "Sets the value of the input element."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-date",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a date field. When tapped or clicked, the input element will display a date picker component."
+      },
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Sets the disabled attribute of the input element."
+        },
+        {
+          "name": "order",
+          "description": "Sets the tabIndex of the input element."
+        },
+        {
+          "name": "placeholder",
+          "description": "A placeholder to assist the user in completing the field."
+        },
+        {
+          "name": "required",
+          "description": "If true, the field will be marked required."
+        },
+        {
+          "name": "value",
+          "description": "Sets the value of the input element."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-dropdown",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox."
+      },
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Sets the disabled attribute of the input element."
+        },
+        {
+          "name": "order",
+          "description": "Sets the tabIndex of the input element."
+        },
+        {
+          "name": "required",
+          "description": "If true, the field will be marked required."
+        },
+        {
+          "name": "value",
+          "description": "The currently selected value."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-initial",
+      "description": {
+        "kind": "markdown",
+        "value": "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."
+      },
+      "attributes": [
+        {
+          "name": "full-name",
+          "description": "The user's full name."
+        },
+        {
+          "name": "required",
+          "description": "Whether the field is required."
+        },
+        {
+          "name": "value",
+          "description": "The base64 signature value."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-payment",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox."
+      },
+      "attributes": [
+        {
+          "name": "current-initial",
+          "description": ""
+        },
+        {
+          "name": "current-initial-id",
+          "description": ""
+        },
+        {
+          "name": "current-signature",
+          "description": ""
+        },
+        {
+          "name": "current-signature-id",
+          "description": ""
+        },
+        {
+          "name": "field-id",
+          "description": ""
+        },
+        {
+          "name": "focused",
+          "description": ""
+        },
+        {
+          "name": "page-num",
+          "description": ""
+        },
+        {
+          "name": "recipients",
+          "description": ""
+        },
+        {
+          "name": "role-name",
+          "description": ""
+        },
+        {
+          "name": "selected-role-name",
+          "description": ""
+        },
+        {
+          "name": "signed",
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-radio-button",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a radio button."
+      },
+      "attributes": [
+        {
+          "name": "checked",
+          "description": "Sets the value of the input element."
+        },
+        {
+          "name": "disabled",
+          "description": "Sets the disabled attribute of the input element."
+        },
+        {
+          "name": "name",
+          "description": "Sets the name of the input element."
+        },
+        {
+          "name": "order",
+          "description": "Sets the tabIndex of the input element."
+        },
+        {
+          "name": "required",
+          "description": "If true, the field will be marked required."
+        },
+        {
+          "name": "value",
+          "description": "Sets the value of the input element."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-signature",
+      "description": {
+        "kind": "markdown",
+        "value": "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."
+      },
+      "attributes": [
+        {
+          "name": "full-name",
+          "description": "The user's full name."
+        },
+        {
+          "name": "required",
+          "description": "Whether the field is required."
+        },
+        {
+          "name": "value",
+          "description": "The base64 signature value."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-textarea",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a multi-line text input field."
+      },
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Sets the disabled attribute of the input element."
+        },
+        {
+          "name": "order",
+          "description": "Sets the tabIndex of the input element."
+        },
+        {
+          "name": "placeholder",
+          "description": "A placeholder to assist the user in completing the field."
+        },
+        {
+          "name": "required",
+          "description": "If true, the field will be marked required."
+        },
+        {
+          "name": "value",
+          "description": "Sets the value of the input element."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-field-textbox",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a text input field."
+      },
+      "attributes": [
+        {
+          "name": "disabled",
+          "description": "Sets the disabled attribute of the input element."
+        },
+        {
+          "name": "order",
+          "description": "Sets the tabIndex of the input element."
+        },
+        {
+          "name": "placeholder",
+          "description": "A placeholder to assist the user in completing the field."
+        },
+        {
+          "name": "required",
+          "description": "If true, the field will be marked required."
+        },
+        {
+          "name": "value",
+          "description": "Sets the value of the input element."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-initial-dialog",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a dialog that allows the user to specify an initials image, either by using a signature-font-generated image\nbased on their full name, or by hand-drawing their initials with a mouse or tablet."
+      },
+      "attributes": [
+        {
+          "name": "fullname",
+          "description": "Initial signature text"
+        },
+        {
+          "name": "open",
+          "description": "Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-loader",
+      "description": {
+        "kind": "markdown",
+        "value": ""
+      },
+      "attributes": []
+    },
+    {
+      "name": "verdocs-ok-dialog",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a simple text dialog box with an Ok button. This adds a partially-transparent overlay and screen-centered dialog\nbox with a message and optional header/title. An OK button is shown that will dismiss the message.\nIt can also be dismissed by clicking the background overlay."
+      },
+      "attributes": [
+        {
+          "name": "cancel",
+          "description": "If set, a cancel button will also be displayed. Note that the dialog is always cancelable by clicking the background\noverlay to dismiss it."
+        },
+        {
+          "name": "heading",
+          "description": "The title of the dialog. \"title\" is a reserved word, so we use heading."
+        },
+        {
+          "name": "message",
+          "description": "The message content to display."
+        },
+        {
+          "name": "open",
+          "description": "Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-organization-card",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a pop-up describing the company that was hovered over"
+      },
+      "attributes": []
+    },
+    {
+      "name": "verdocs-search",
+      "description": {
+        "kind": "markdown",
+        "value": ""
+      },
+      "attributes": []
+    },
+    {
+      "name": "verdocs-sign",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a document signing experience."
+      },
+      "attributes": [
+        {
+          "name": "documentid",
+          "description": "If `source` is set to `verdocs-sign`, this should be set to a valid invitation code to activate a\nsigning session."
+        },
+        {
+          "name": "invitecode",
+          "description": "If `source` is set to `verdocs-sign`, this should be set to a valid invitation code to activate a\nsigning session."
+        },
+        {
+          "name": "roleid",
+          "description": "If `source` is set to `verdocs-sign`, this should be set to a valid invitation code to activate a\nsigning session."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-signature-dialog",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a dialog that allows the user to specify a signature image, either by using a signature-font-generated image\nbased on their full name, or by hand-drawing their signature with a mouse or tablet."
+      },
+      "attributes": [
+        {
+          "name": "fullname",
+          "description": "Initial signature text"
+        },
+        {
+          "name": "open",
+          "description": "Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-template-card",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a summary of a template"
+      },
+      "attributes": []
+    },
+    {
+      "name": "verdocs-template-tags",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a message listing a template's tags."
+      },
+      "attributes": []
+    },
+    {
+      "name": "verdocs-text-input",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a text input field. This is just a standard HTML input field with minimal markup to fit the\nvisual styles of the other components. Bear in mind Stencil does not currently support emitting events\nwith the same names as native DOM events, so rather than `input` or `blur` we have `tinput`, `tblur`,\netc. We used a temporary prefix here to mark this as a temporary API, because we hope this will change\nin a future Stencil release. See https://github.com/ionic-team/stencil/issues/2822."
+      },
+      "attributes": [
+        {
+          "name": "autocomplete",
+          "description": "If desired, the autocomplete attribute to set."
+        },
+        {
+          "name": "disabled",
+          "description": "Should the field be disabled?"
+        },
+        {
+          "name": "label",
+          "description": "The label for the field."
+        },
+        {
+          "name": "placeholder",
+          "description": "The placeholder for the field."
+        },
+        {
+          "name": "type",
+          "description": "The type of field to render. Only text-type fields are allowed here for the current styling. Additional types\n(e.g. a date picker) will be supported by other controls in the future.",
+          "values": [
+            {
+              "name": "email"
+            },
+            {
+              "name": "number"
+            },
+            {
+              "name": "password"
+            },
+            {
+              "name": "search"
+            },
+            {
+              "name": "tel"
+            },
+            {
+              "name": "text"
+            },
+            {
+              "name": "url"
+            }
+          ]
+        },
+        {
+          "name": "value",
+          "description": "The value for the input field."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-toggle",
+      "description": {
+        "kind": "markdown",
+        "value": "Displays a label and a set of buttons, also allowing a default selection of a button\n\n```typescript\n\n```"
+      },
+      "attributes": [
+        {
+          "name": "theme",
+          "description": "The \"theme\" to be used",
+          "values": [
+            {
+              "name": "dark"
+            },
+            {
+              "name": "light"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "verdocs-upload-dialog",
+      "description": {
+        "kind": "markdown",
+        "value": "Display a text input field. This adds a partially-transparent overlay and screen-centered dialog\nbox with a message and optional header/title. An OK button is shown that will dismiss the message.\nIt can also be dismissed by clicking the background overlay."
+      },
+      "attributes": [
+        {
+          "name": "open",
+          "description": "Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed."
+        }
+      ]
+    },
+    {
+      "name": "verdocs-view",
+      "description": {
+        "kind": "markdown",
+        "value": ""
+      },
+      "attributes": [
+        {
+          "name": "rotation",
+          "description": "Rotate the PDF in degrees"
+        },
+        {
+          "name": "source",
+          "description": "Src of the PDF to load and render"
+        },
+        {
+          "name": "token",
+          "description": "Access token to use. This component is a wrapper for PDF.js which does not use a VerdocsEndpoint, so the token must be supplied\ndirectly."
+        }
+      ]
+    }
+  ]
+}