@verdocs/web-sdk 1.7.3 → 1.7.6

package/dist/collection/components/elements/verdocs-search-box/verdocs-search-box.js

@@ -1,5 +1,5 @@
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { Component, h, Event, Prop } from '@stencil/core';
+import { Component, h, Event, Prop, Method } from '@stencil/core';
 import SearchIcon from './search.svg';
 import CloseIcon from './close.svg';
 /**
@@ -26,6 +26,18 @@ export class VerdocsSearchBox {
      * The text search string entered by the user.
      */
     this.query = '';
+    /**
+     * If set, the input field will attempt to "grab" focus after being rendered.
+     */
+    this.grabsFocus = false;
+  }
+  async focusField() {
+    this.inputEl.focus();
+  }
+  componentDidRender() {
+    if (this.grabsFocus) {
+      this.inputEl.focus();
+    }
   }
   handleSearch(e) {
     this.searchClicked.emit({ type: this.type, query: this.query });
@@ -49,7 +61,7 @@ export class VerdocsSearchBox {
         this.type,
         "s ",
         h("button", { class: "remove", innerHTML: CloseIcon, onClick: () => this.handleClearFilter() }))),
-      h("input", { type: "text", placeholder: this.placeholder, value: this.query, onInput: e => this.handleChange(e), onKeyUp: e => this.handleKeyUp(e) }),
+      h("input", { type: "text", value: this.query, placeholder: this.placeholder, onInput: e => this.handleChange(e), onKeyUp: e => this.handleKeyUp(e), ref: el => (this.inputEl = el) }),
       h("button", { onClick: e => this.handleSearch(e), class: "search" },
         h("span", { innerHTML: SearchIcon }),
         "Search")));
@@ -140,6 +152,24 @@ export class VerdocsSearchBox {
       "attribute": "query",
       "reflect": false,
       "defaultValue": "''"
+    },
+    "grabsFocus": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "If set, the input field will attempt to \"grab\" focus after being rendered."
+      },
+      "attribute": "grabs-focus",
+      "reflect": false,
+      "defaultValue": "false"
     }
   }; }
   static get events() { return [{
@@ -196,5 +226,23 @@ export class VerdocsSearchBox {
         "references": {}
       }
     }]; }
+  static get methods() { return {
+    "focusField": {
+      "complexType": {
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<void>"
+      },
+      "docs": {
+        "text": "",
+        "tags": []
+      }
+    }
+  }; }
 }
 //# sourceMappingURL=verdocs-search-box.js.map

package/dist/collection/components/elements/verdocs-search-box/verdocs-search-box.js.map

@@ -1 +1 @@
-{"version":3,"file":"verdocs-search-box.js","sourceRoot":"","sources":["../../../../src/components/elements/verdocs-search-box/verdocs-search-box.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAgB,IAAI,EAAC,MAAM,eAAe,CAAC;AACtE,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,SAAS,MAAM,aAAa,CAAC;AASpC;;;;;GAKG;AAMH,MAAM,OAAO,gBAAgB;EAL7B;IAME;;OAEG;IACK,aAAQ,GAAoB,eAAe,CAAC,UAAU,EAAE,CAAC;IAEjE;;OAEG;IACK,gBAAW,GAAG,wCAAwC,CAAC;IAE/D;;OAEG;IACK,SAAI,GAAiB,KAAK,CAAC;IAEnC;;OAEG;IACK,UAAK,GAAG,EAAE,CAAC;GAqDpB;EApCC,YAAY,CAAC,CAAC;IACZ,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,cAAc,EAAE,CAAC;IACnB,OAAO,KAAK,CAAC;EACf,CAAC;EAED,YAAY,CAAC,CAAC;IACZ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;EACzC,CAAC;EAED,iBAAiB;IACf,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;EAC/B,CAAC;EAED,WAAW,CAAC,CAAC;IACX,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,EAAE;MACrB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAC,CAAC,CAAC;KAC/D;EACH,CAAC;EAED,MAAM;IACJ,OAAO,CACL,YAAM,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;MACtC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,CACjD,YAAM,KAAK,EAAC,MAAM;QACf,IAAI,CAAC,IAAI;;QAAG,cAAQ,KAAK,EAAC,QAAQ,EAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAI,CAChG,CACR;MACD,aAAO,IAAI,EAAC,MAAM,EAAC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAI;MAC9I,cAAQ,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAC,QAAQ;QACxD,YAAM,SAAS,EAAE,UAAU,GAAI;iBAExB,CACJ,CACR,CAAC;EACJ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACF","sourcesContent":["import {VerdocsEndpoint} from '@verdocs/js-sdk';\nimport {Component, h, Event, EventEmitter, Prop} from '@stencil/core';\nimport SearchIcon from './search.svg';\nimport CloseIcon from './close.svg';\n\nexport type TContentType = 'all' | 'document' | 'template' | 'organization';\n\nexport interface ISearchEvent {\n  query: string;\n  type: TContentType;\n}\n\n/**\n * Displays a customizable input box for search queries.\n *\n * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\n * embed. This Element will reuse the same session produced by logging in via that Embed.\n */\n@Component({\n  tag: 'verdocs-search-box',\n  styleUrl: 'verdocs-search-box.scss',\n  shadow: false,\n})\nexport class VerdocsSearchBox {\n  /**\n   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.\n   */\n  @Prop() endpoint: VerdocsEndpoint = VerdocsEndpoint.getDefault();\n\n  /**\n   * The placeholder to display in the input field.\n   */\n  @Prop() placeholder = 'search documents, templates, people...';\n\n  /**\n   * If set to a value other than 'all', a removeable filter indicator will be displayed.\n   */\n  @Prop() type: TContentType = 'all';\n\n  /**\n   * The text search string entered by the user.\n   */\n  @Prop() query = '';\n\n  /**\n   * Event fired when the user changes the type.\n   */\n  @Event({composed: true}) searchClicked: EventEmitter<ISearchEvent>;\n\n  /**\n   * Event fired when the user changes the type.\n   */\n  @Event({composed: true}) typeChanged: EventEmitter<TContentType>;\n\n  /**\n   * Event fired when the user changes the query string.\n   */\n  @Event({composed: true}) queryChanged: EventEmitter<string>;\n\n  handleSearch(e) {\n    this.searchClicked.emit({type: this.type, query: this.query});\n    e.preventDefault();\n    return false;\n  }\n\n  handleChange(e) {\n    this.queryChanged.emit(e.target.value);\n  }\n\n  handleClearFilter() {\n    this.typeChanged.emit('all');\n  }\n\n  handleKeyUp(e) {\n    if (e.key === 'Enter') {\n      this.searchClicked.emit({type: this.type, query: this.query});\n    }\n  }\n\n  render() {\n    return (\n      <form onSubmit={e => this.handleSearch(e)}>\n        {this.type !== undefined && this.type !== 'all' && (\n          <span class=\"type\">\n            {this.type}s <button class=\"remove\" innerHTML={CloseIcon} onClick={() => this.handleClearFilter()} />\n          </span>\n        )}\n        <input type=\"text\" placeholder={this.placeholder} value={this.query} onInput={e => this.handleChange(e)} onKeyUp={e => this.handleKeyUp(e)} />\n        <button onClick={e => this.handleSearch(e)} class=\"search\">\n          <span innerHTML={SearchIcon} />\n          Search\n        </button>\n      </form>\n    );\n  }\n}\n"]}
+{"version":3,"file":"verdocs-search-box.js","sourceRoot":"","sources":["../../../../src/components/elements/verdocs-search-box/verdocs-search-box.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAC,SAAS,EAAE,CAAC,EAAE,KAAK,EAAgB,IAAI,EAAE,MAAM,EAAC,MAAM,eAAe,CAAC;AAC9E,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,SAAS,MAAM,aAAa,CAAC;AASpC;;;;;GAKG;AAMH,MAAM,OAAO,gBAAgB;EAL7B;IAQE;;OAEG;IACK,aAAQ,GAAoB,eAAe,CAAC,UAAU,EAAE,CAAC;IAEjE;;OAEG;IACK,gBAAW,GAAG,wCAAwC,CAAC;IAE/D;;OAEG;IACK,SAAI,GAAiB,KAAK,CAAC;IAEnC;;OAEG;IACK,UAAK,GAAG,EAAE,CAAC;IAEnB;;OAEG;IACK,eAAU,GAAG,KAAK,CAAC;GAsE5B;EArDW,KAAK,CAAC,UAAU;IACxB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;EACvB,CAAC;EAED,kBAAkB;IAChB,IAAI,IAAI,CAAC,UAAU,EAAE;MACnB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;KACtB;EACH,CAAC;EAED,YAAY,CAAC,CAAC;IACZ,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,cAAc,EAAE,CAAC;IACnB,OAAO,KAAK,CAAC;EACf,CAAC;EAED,YAAY,CAAC,CAAC;IACZ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;EACzC,CAAC;EAED,iBAAiB;IACf,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;EAC/B,CAAC;EAED,WAAW,CAAC,CAAC;IACX,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,EAAE;MACrB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAC,CAAC,CAAC;KAC/D;EACH,CAAC;EAED,MAAM;IACJ,OAAO,CACL,YAAM,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;MACtC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,CACjD,YAAM,KAAK,EAAC,MAAM;QACf,IAAI,CAAC,IAAI;;QAAG,cAAQ,KAAK,EAAC,QAAQ,EAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,GAAI,CAChG,CACR;MACD,aACE,IAAI,EAAC,MAAM,EACX,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,WAAW,EAAE,IAAI,CAAC,WAAW,EAC7B,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAClC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EACjC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,GAC9B;MACF,cAAQ,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAC,QAAQ;QACxD,YAAM,SAAS,EAAE,UAAU,GAAI;iBAExB,CACJ,CACR,CAAC;EACJ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACF","sourcesContent":["import {VerdocsEndpoint} from '@verdocs/js-sdk';\nimport {Component, h, Event, EventEmitter, Prop, Method} from '@stencil/core';\nimport SearchIcon from './search.svg';\nimport CloseIcon from './close.svg';\n\nexport type TContentType = 'all' | 'document' | 'template' | 'organization';\n\nexport interface ISearchEvent {\n  query: string;\n  type: TContentType;\n}\n\n/**\n * Displays a customizable input box for search queries.\n *\n * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\n * embed. This Element will reuse the same session produced by logging in via that Embed.\n */\n@Component({\n  tag: 'verdocs-search-box',\n  styleUrl: 'verdocs-search-box.scss',\n  shadow: false,\n})\nexport class VerdocsSearchBox {\n  private inputEl: HTMLInputElement;\n\n  /**\n   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.\n   */\n  @Prop() endpoint: VerdocsEndpoint = VerdocsEndpoint.getDefault();\n\n  /**\n   * The placeholder to display in the input field.\n   */\n  @Prop() placeholder = 'search documents, templates, people...';\n\n  /**\n   * If set to a value other than 'all', a removeable filter indicator will be displayed.\n   */\n  @Prop() type: TContentType = 'all';\n\n  /**\n   * The text search string entered by the user.\n   */\n  @Prop() query = '';\n\n  /**\n   * If set, the input field will attempt to \"grab\" focus after being rendered.\n   */\n  @Prop() grabsFocus = false;\n\n  /**\n   * Event fired when the user changes the type.\n   */\n  @Event({composed: true}) searchClicked: EventEmitter<ISearchEvent>;\n\n  /**\n   * Event fired when the user changes the type.\n   */\n  @Event({composed: true}) typeChanged: EventEmitter<TContentType>;\n\n  /**\n   * Event fired when the user changes the query string.\n   */\n  @Event({composed: true}) queryChanged: EventEmitter<string>;\n\n  @Method() async focusField() {\n    this.inputEl.focus();\n  }\n\n  componentDidRender() {\n    if (this.grabsFocus) {\n      this.inputEl.focus();\n    }\n  }\n\n  handleSearch(e) {\n    this.searchClicked.emit({type: this.type, query: this.query});\n    e.preventDefault();\n    return false;\n  }\n\n  handleChange(e) {\n    this.queryChanged.emit(e.target.value);\n  }\n\n  handleClearFilter() {\n    this.typeChanged.emit('all');\n  }\n\n  handleKeyUp(e) {\n    if (e.key === 'Enter') {\n      this.searchClicked.emit({type: this.type, query: this.query});\n    }\n  }\n\n  render() {\n    return (\n      <form onSubmit={e => this.handleSearch(e)}>\n        {this.type !== undefined && this.type !== 'all' && (\n          <span class=\"type\">\n            {this.type}s <button class=\"remove\" innerHTML={CloseIcon} onClick={() => this.handleClearFilter()} />\n          </span>\n        )}\n        <input\n          type=\"text\"\n          value={this.query}\n          placeholder={this.placeholder}\n          onInput={e => this.handleChange(e)}\n          onKeyUp={e => this.handleKeyUp(e)}\n          ref={el => (this.inputEl = el)}\n        />\n        <button onClick={e => this.handleSearch(e)} class=\"search\">\n          <span innerHTML={SearchIcon} />\n          Search\n        </button>\n      </form>\n    );\n  }\n}\n"]}

package/dist/components/VerdocsEndpoint.js

@@ -171,6 +171,36 @@ var getDocument = function (endpoint, documentId) { return __awaiter$1(void 0, v
                 .then(function (r) { return r.data; })];
     });
 }); };
+/**
+ * Cancel a Document.
+ */
+var cancelDocument = function (endpoint, documentId) { return __awaiter$1(void 0, void 0, void 0, function () {
+    return __generator$1(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .put("/documents/".concat(documentId), { action: 'cancel' })
+                .then(function (r) { return r.data; })];
+    });
+}); };
+/**
+ * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
+ */
+var recipientHasAction = function (recipient) { return !['submitted', 'canceled', 'declined'].includes(recipient.status); };
+/**
+ * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
+ */
+var getRecipientsWithActions = function (document) { return ((document === null || document === void 0 ? void 0 : document.recipients) || []).filter(recipientHasAction); };
+/**
+ * Returns true if the recipient can act.
+ */
+var recipientCanAct = function (recipient, recipientsWithActions) { var _a; return recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence); };
+/**
+ * Returns true if the user can act.
+ */
+var userCanAct = function (email, recipientsWithActions) {
+    var _a;
+    var recipient = recipientsWithActions.find(function (r) { return r.email === email; });
+    return recipient && recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence);
+};
 /**
  * Get (binary download) a file attached to a Document.
  */
@@ -212,6 +242,11 @@ const Documents$1 = /*#__PURE__*/Object.freeze({
     getSigningSession: getSigningSession,
     getDocumentRecipients: getDocumentRecipients,
     getDocument: getDocument,
+    cancelDocument: cancelDocument,
+    recipientHasAction: recipientHasAction,
+    getRecipientsWithActions: getRecipientsWithActions,
+    recipientCanAct: recipientCanAct,
+    userCanAct: userCanAct,
     getDocumentFile: getDocumentFile,
     updateDocumentField: updateDocumentField,
     updateDocumentFieldSignature: updateDocumentFieldSignature
@@ -274,10 +309,15 @@ var updateRecipientStatus = function (endpoint, documentId, roleName, action, pa
                 .then(function (r) { return r.data; })];
     });
 }); };
+var getSignerToken = function (endpoint, documentId, roleName) {
+    return endpoint.api //
+        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"));
+};
 
 const Recipients = /*#__PURE__*/Object.freeze({
     __proto__: null,
-    updateRecipientStatus: updateRecipientStatus
+    updateRecipientStatus: updateRecipientStatus,
+    getSignerToken: getSignerToken
 });
 
 /**