@verdocs/web-sdk 4.2.65 → 4.2.66

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/dist/cjs/index-d2999878.js +6 -6
  2. package/dist/cjs/loader.cjs.js +1 -1
  3. package/dist/cjs/verdocs-envelope-document-page.cjs.entry.js +1 -1
  4. package/dist/cjs/verdocs-envelope-recipient-link_2.cjs.entry.js +1 -1
  5. package/dist/cjs/verdocs-envelope-sidebar.cjs.entry.js +1 -1
  6. package/dist/cjs/verdocs-envelopes-list.cjs.entry.js +6 -6
  7. package/dist/cjs/verdocs-preview_10.cjs.entry.js +1 -5
  8. package/dist/cjs/verdocs-quick-functions.cjs.entry.js +32 -0
  9. package/dist/cjs/verdocs-radio-button_3.cjs.entry.js +9 -9
  10. package/dist/cjs/{verdocs-quick-functions_2.cjs.entry.js → verdocs-search-box.cjs.entry.js} +0 -25
  11. package/dist/cjs/verdocs-sign.cjs.entry.js +1 -8
  12. package/dist/cjs/verdocs-status-indicator.cjs.entry.js +2 -2
  13. package/dist/cjs/verdocs-template-card.cjs.entry.js +1 -1
  14. package/dist/cjs/verdocs-template-document-page_2.cjs.entry.js +1 -1
  15. package/dist/cjs/verdocs-template-star.cjs.entry.js +1 -1
  16. package/dist/cjs/verdocs-template-tags.cjs.entry.js +1 -1
  17. package/dist/cjs/verdocs-web-sdk.cjs.js +1 -1
  18. package/dist/collection/collection-manifest.json +0 -1
  19. package/dist/collection/components/embeds/verdocs-auth/verdocs-auth.js +17 -7
  20. package/dist/collection/components/embeds/verdocs-build/verdocs-build.js +32 -2
  21. package/dist/collection/components/embeds/verdocs-preview/verdocs-preview.js +5 -4
  22. package/dist/collection/components/embeds/verdocs-send/verdocs-send.js +8 -7
  23. package/dist/collection/components/embeds/verdocs-sign/verdocs-sign.js +4 -11
  24. package/dist/collection/components/embeds/verdocs-view/verdocs-view.js +9 -1
  25. package/dist/collection/components/envelopes/verdocs-envelope-document-page/verdocs-envelope-document-page.js +1 -1
  26. package/dist/collection/components/envelopes/verdocs-envelope-recipient-link/verdocs-envelope-recipient-link.css +4 -0
  27. package/dist/collection/components/envelopes/verdocs-envelope-sidebar/verdocs-envelope-sidebar.js +2 -2
  28. package/dist/collection/components/envelopes/verdocs-envelopes-list/verdocs-envelopes-list.js +6 -6
  29. package/dist/collection/components/envelopes/verdocs-status-indicator/verdocs-status-indicator.js +2 -2
  30. package/dist/collection/components/templates/verdocs-template-card/verdocs-template-card.js +1 -1
  31. package/dist/collection/components/templates/verdocs-template-document-page/verdocs-template-document-page.js +1 -1
  32. package/dist/collection/components/templates/verdocs-template-role-properties/verdocs-template-role-properties.js +8 -8
  33. package/dist/collection/components/templates/verdocs-template-roles/verdocs-template-roles.js +1 -5
  34. package/dist/collection/components/templates/verdocs-template-sender/verdocs-template-sender.js +1 -1
  35. package/dist/collection/components/templates/verdocs-template-star/verdocs-template-star.js +1 -1
  36. package/dist/collection/components/templates/verdocs-template-tags/verdocs-template-tags.js +1 -1
  37. package/dist/components/index.js +0 -2
  38. package/dist/components/verdocs-envelope-document-page2.js +1 -1
  39. package/dist/components/verdocs-envelope-recipient-link2.js +1 -1
  40. package/dist/components/verdocs-envelope-sidebar.js +2 -2
  41. package/dist/components/verdocs-envelopes-list.js +6 -6
  42. package/dist/components/verdocs-quick-functions.js +42 -1
  43. package/dist/components/verdocs-search-box.js +70 -1
  44. package/dist/components/verdocs-sign.js +2 -9
  45. package/dist/components/verdocs-status-indicator2.js +2 -2
  46. package/dist/components/verdocs-template-card.js +1 -1
  47. package/dist/components/verdocs-template-document-page2.js +1 -1
  48. package/dist/components/verdocs-template-role-properties2.js +8 -8
  49. package/dist/components/verdocs-template-roles2.js +1 -5
  50. package/dist/components/verdocs-template-sender2.js +1 -1
  51. package/dist/components/verdocs-template-star2.js +1 -1
  52. package/dist/components/verdocs-template-tags.js +1 -1
  53. package/dist/custom-elements.json +5 -13
  54. package/dist/esm/index-3476681c.js +6 -6
  55. package/dist/esm/loader.js +1 -1
  56. package/dist/esm/verdocs-envelope-document-page.entry.js +1 -1
  57. package/dist/esm/verdocs-envelope-recipient-link_2.entry.js +1 -1
  58. package/dist/esm/verdocs-envelope-sidebar.entry.js +2 -2
  59. package/dist/esm/verdocs-envelopes-list.entry.js +6 -6
  60. package/dist/esm/verdocs-preview_10.entry.js +1 -5
  61. package/dist/{components/verdocs-quick-functions2.js → esm/verdocs-quick-functions.entry.js} +7 -23
  62. package/dist/esm/verdocs-radio-button_3.entry.js +9 -9
  63. package/dist/{components/verdocs-search-box2.js → esm/verdocs-search-box.entry.js} +7 -28
  64. package/dist/esm/verdocs-sign.entry.js +2 -9
  65. package/dist/esm/verdocs-status-indicator.entry.js +2 -2
  66. package/dist/esm/verdocs-template-card.entry.js +1 -1
  67. package/dist/esm/verdocs-template-document-page_2.entry.js +1 -1
  68. package/dist/esm/verdocs-template-star.entry.js +1 -1
  69. package/dist/esm/verdocs-template-tags.entry.js +1 -1
  70. package/dist/esm/verdocs-web-sdk.js +1 -1
  71. package/dist/esm-es5/index-3476681c.js +1 -1
  72. package/dist/esm-es5/loader.js +1 -1
  73. package/dist/esm-es5/verdocs-envelope-document-page.entry.js +1 -1
  74. package/dist/esm-es5/verdocs-envelope-recipient-link_2.entry.js +1 -1
  75. package/dist/esm-es5/verdocs-envelope-sidebar.entry.js +1 -1
  76. package/dist/esm-es5/verdocs-envelopes-list.entry.js +1 -1
  77. package/dist/esm-es5/verdocs-preview_10.entry.js +1 -1
  78. package/dist/esm-es5/verdocs-quick-functions.entry.js +1 -0
  79. package/dist/esm-es5/verdocs-radio-button_3.entry.js +1 -1
  80. package/dist/esm-es5/verdocs-search-box.entry.js +1 -0
  81. package/dist/esm-es5/verdocs-sign.entry.js +1 -1
  82. package/dist/esm-es5/verdocs-status-indicator.entry.js +1 -1
  83. package/dist/esm-es5/verdocs-template-card.entry.js +1 -1
  84. package/dist/esm-es5/verdocs-template-document-page_2.entry.js +1 -1
  85. package/dist/esm-es5/verdocs-template-star.entry.js +1 -1
  86. package/dist/esm-es5/verdocs-template-tags.entry.js +1 -1
  87. package/dist/esm-es5/verdocs-web-sdk.js +1 -1
  88. package/dist/types/components/embeds/verdocs-auth/verdocs-auth.d.ts +17 -7
  89. package/dist/types/components/embeds/verdocs-build/verdocs-build.d.ts +32 -2
  90. package/dist/types/components/embeds/verdocs-preview/verdocs-preview.d.ts +5 -2
  91. package/dist/types/components/embeds/verdocs-send/verdocs-send.d.ts +8 -7
  92. package/dist/types/components/embeds/verdocs-sign/verdocs-sign.d.ts +1 -1
  93. package/dist/types/components/embeds/verdocs-view/verdocs-view.d.ts +9 -1
  94. package/dist/types/components.d.ts +256 -89
  95. package/dist/verdocs-web-sdk/p-03a228e4.system.js +1 -1
  96. package/dist/verdocs-web-sdk/{p-52d9d12b.entry.js → p-0b858d95.entry.js} +1 -1
  97. package/dist/verdocs-web-sdk/p-113251b7.entry.js +1 -0
  98. package/dist/verdocs-web-sdk/{p-e8b96519.system.entry.js → p-1d2a24d8.system.entry.js} +1 -1
  99. package/dist/verdocs-web-sdk/{p-49899f3c.system.entry.js → p-2b801312.system.entry.js} +1 -1
  100. package/dist/verdocs-web-sdk/p-33675f2e.system.entry.js +1 -0
  101. package/dist/verdocs-web-sdk/{p-18a58a00.entry.js → p-47047ad0.entry.js} +1 -1
  102. package/dist/verdocs-web-sdk/{p-ba259b92.system.entry.js → p-4817a358.system.entry.js} +1 -1
  103. package/dist/verdocs-web-sdk/{p-7995e412.system.entry.js → p-48afd9e8.system.entry.js} +1 -1
  104. package/dist/verdocs-web-sdk/{p-fba124de.system.entry.js → p-4acd87ad.system.entry.js} +1 -1
  105. package/dist/verdocs-web-sdk/{p-721bc4db.entry.js → p-4dd7f091.entry.js} +1 -1
  106. package/dist/verdocs-web-sdk/p-5e0d3109.entry.js +1 -0
  107. package/dist/verdocs-web-sdk/p-672a4df3.system.entry.js +1 -0
  108. package/dist/verdocs-web-sdk/p-6bab3791.system.entry.js +1 -0
  109. package/dist/verdocs-web-sdk/{p-d7b00716.entry.js → p-6e03c475.entry.js} +1 -1
  110. package/dist/verdocs-web-sdk/{p-05ec94da.entry.js → p-74b45256.entry.js} +1 -1
  111. package/dist/verdocs-web-sdk/p-7861d427.entry.js +1 -0
  112. package/dist/verdocs-web-sdk/{p-6bd283bf.system.entry.js → p-7f4c7fef.system.entry.js} +1 -1
  113. package/dist/verdocs-web-sdk/{p-5352f042.system.entry.js → p-8e1fcab5.system.entry.js} +1 -1
  114. package/dist/verdocs-web-sdk/p-97a3efcf.entry.js +1 -0
  115. package/dist/verdocs-web-sdk/{p-18ef3307.system.entry.js → p-9ba77c1d.system.entry.js} +1 -1
  116. package/dist/verdocs-web-sdk/p-a3b75156.system.entry.js +1 -0
  117. package/dist/verdocs-web-sdk/{p-86126812.system.entry.js → p-a63081ed.system.entry.js} +1 -1
  118. package/dist/verdocs-web-sdk/{p-530f073d.entry.js → p-ace6d1f2.entry.js} +1 -1
  119. package/dist/verdocs-web-sdk/p-b4e722fc.entry.js +1 -0
  120. package/dist/verdocs-web-sdk/{p-09174e70.entry.js → p-b9139237.entry.js} +1 -1
  121. package/dist/verdocs-web-sdk/p-c249c422.system.entry.js +1 -0
  122. package/dist/verdocs-web-sdk/{p-002b8ba2.entry.js → p-e27ffcbb.entry.js} +1 -1
  123. package/dist/verdocs-web-sdk/{p-f00e5323.entry.js → p-e2f2f11a.entry.js} +1 -1
  124. package/dist/verdocs-web-sdk/verdocs-web-sdk.esm.js +1 -1
  125. package/package.json +2 -2
  126. package/dist/cjs/verdocs-search.cjs.entry.js +0 -22
  127. package/dist/collection/components/embeds/verdocs-search/verdocs-search.css +0 -34
  128. package/dist/collection/components/embeds/verdocs-search/verdocs-search.js +0 -47
  129. package/dist/components/verdocs-search.d.ts +0 -11
  130. package/dist/components/verdocs-search.js +0 -49
  131. package/dist/esm/verdocs-quick-functions_2.entry.js +0 -75
  132. package/dist/esm/verdocs-search.entry.js +0 -18
  133. package/dist/esm-es5/verdocs-quick-functions_2.entry.js +0 -1
  134. package/dist/esm-es5/verdocs-search.entry.js +0 -1
  135. package/dist/types/components/embeds/verdocs-search/verdocs-search.d.ts +0 -8
  136. package/dist/verdocs-web-sdk/p-15cd7156.entry.js +0 -1
  137. package/dist/verdocs-web-sdk/p-47dde2b1.system.entry.js +0 -1
  138. package/dist/verdocs-web-sdk/p-4bc07959.entry.js +0 -1
  139. package/dist/verdocs-web-sdk/p-519db979.entry.js +0 -1
  140. package/dist/verdocs-web-sdk/p-6058c628.entry.js +0 -1
  141. package/dist/verdocs-web-sdk/p-756f658c.system.entry.js +0 -1
  142. package/dist/verdocs-web-sdk/p-c5ad35e4.entry.js +0 -1
  143. package/dist/verdocs-web-sdk/p-dbc572d5.system.entry.js +0 -1
  144. package/dist/verdocs-web-sdk/p-dc335d28.system.entry.js +0 -1
  145. package/dist/verdocs-web-sdk/p-f2c8fd36.system.entry.js +0 -1
@@ -41,15 +41,24 @@ export { IToggleIconButtons } from "./components/controls/verdocs-toggle/verdocs
41
41
  export { Placement } from "@popperjs/core/lib/enums";
42
42
  export namespace Components {
43
43
  /**
44
- * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
45
- * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
46
- * host application to render the next appropriate view for the application.
44
+ * Display an authentication dialog that allows the user to login or sign up. If the user is
45
+ * already authenticated with a valid session, this component will hide itself and fire the
46
+ * success callback immediately. It is up to the host application to render the next appropriate
47
+ * view for the application.
47
48
  * To simplify UI development, a visibility flag can force this component to never display. This
48
- * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
49
- * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
50
- * container to allow sufficient space for the required forms.
49
+ * allows you to subscribe to notifications from client apps without calling the lower-level JS SDK.
50
+ * This embed is responsive / mobile-friendly, but the calling application should provide at
51
+ * least a 300px wide container to allow sufficient space for the required forms.
51
52
  * ```ts
52
- * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
53
+ * interface IAuthStatus {
54
+ * authenticated: boolean;
55
+ * session: TSession;
56
+ * profile: IProfile | null;
57
+ * }
58
+ * <verdocs-auth
59
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }
60
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
61
+ * />
53
62
  * ```
54
63
  */
55
64
  interface VerdocsAuth {
@@ -67,9 +76,35 @@ export namespace Components {
67
76
  "visible": boolean;
68
77
  }
69
78
  /**
70
- * Display a template building experience.
79
+ * Display a template building experience. Several event callbacks provide status updates to the
80
+ * parent application to support interface updates.
71
81
  * ```ts
72
- * <verdocs-build templateId={templateId} />
82
+ * type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview'
83
+ * interface IEnvelopeSent {
84
+ * name: string;
85
+ * template_id: string
86
+ * recipients: ICreateEnvelopeRecipient[];
87
+ * }
88
+ * interface ITemplateEvent {
89
+ * event: string
90
+ * template: ITemplate;
91
+ * }
92
+ * interface IRolesEvent {
93
+ * event: string
94
+ * templateId: string;
95
+ * roles: ITemplateRole[];
96
+ * }
97
+ * <verdocs-build
98
+ * templateId={templateId}
99
+ * step="preview"
100
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }}
101
+ * onStepChanged={({ detail }: { detail: TVerdocsBuildStep }) => { console.log('Step changed', detail) }}
102
+ * onSend={({ detail }: { detail: IEnvelopeSent }) => { console.log('Step changed', detail) }}
103
+ * onTemplateUpdated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template updated', detail) }}
104
+ * onTemplateCreated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template created', detail) }}
105
+ * onRolesUpdated={({ detail }) => { console.log('Roles updated', detail) }}
106
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }}
107
+ * />
73
108
  * ```
74
109
  */
75
110
  interface VerdocsBuild {
@@ -1082,7 +1117,10 @@ export namespace Components {
1082
1117
  * documents with signing fields overlaid on each page. Fields will be color-coded
1083
1118
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
1084
1119
  * ```ts
1085
- * <verdocs-preview templateId={templateId} />
1120
+ * <verdocs-preview
1121
+ * templateId={templateId}
1122
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
1123
+ * />
1086
1124
  * ```
1087
1125
  */
1088
1126
  interface VerdocsPreview {
@@ -1175,12 +1213,6 @@ export namespace Components {
1175
1213
  */
1176
1214
  "value": string;
1177
1215
  }
1178
- interface VerdocsSearch {
1179
- /**
1180
- * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
1181
- */
1182
- "endpoint": VerdocsEndpoint;
1183
- }
1184
1216
  /**
1185
1217
  * Displays a customizable input box for search queries.
1186
1218
  * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
@@ -1239,17 +1271,19 @@ export namespace Components {
1239
1271
  "value": string;
1240
1272
  }
1241
1273
  /**
1242
- * Display a form to send a template to one or more recipients in an envelope for signing. Note
1243
- * that because most applications have custom workflow requirements to trigger after sending an
1244
- * Envelope, this component does not actually perform that operation. Parent applications should
1245
- * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
1246
- * `createEnvelope()` call in JS-SDK.
1274
+ * Display a form to send a template to one or more recipients in an envelope for signing.
1247
1275
  * Host applications should ensure the template is "sendable" before displaying this component.
1248
1276
  * To be sendable, a template must have at least one document attached, at least one participant
1249
1277
  * defined, and at least one field assigned to every "signer" participant. This component will
1250
1278
  * hide itself if the template is not sendable.
1251
1279
  * ```ts
1252
- * <verdocs-send templateId={templateId} />
1280
+ * <verdocs-send
1281
+ * templateId={templateId}
1282
+ * onSend={({ detail }) => { console.log('Sent!', detail) }
1283
+ * onSendingEnvelope={()) => { console.log('Sending... Show a spinner...') }
1284
+ * onExit={(e) => { console.log('Send cancelled.', detail) }
1285
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
1286
+ * />
1253
1287
  * ```
1254
1288
  */
1255
1289
  interface VerdocsSend {
@@ -1783,7 +1817,14 @@ export namespace Components {
1783
1817
  interface VerdocsUploadDialog {
1784
1818
  }
1785
1819
  /**
1786
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
1820
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
1821
+ * displayed in order.
1822
+ * ```ts
1823
+ * <verdocs-view
1824
+ * envelopeId={envelopeId}
1825
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
1826
+ * />
1827
+ * ```
1787
1828
  */
1788
1829
  interface VerdocsView {
1789
1830
  /**
@@ -2018,15 +2059,24 @@ declare global {
2018
2059
  "sdkError": SDKError;
2019
2060
  }
2020
2061
  /**
2021
- * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
2022
- * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
2023
- * host application to render the next appropriate view for the application.
2062
+ * Display an authentication dialog that allows the user to login or sign up. If the user is
2063
+ * already authenticated with a valid session, this component will hide itself and fire the
2064
+ * success callback immediately. It is up to the host application to render the next appropriate
2065
+ * view for the application.
2024
2066
  * To simplify UI development, a visibility flag can force this component to never display. This
2025
- * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
2026
- * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
2027
- * container to allow sufficient space for the required forms.
2067
+ * allows you to subscribe to notifications from client apps without calling the lower-level JS SDK.
2068
+ * This embed is responsive / mobile-friendly, but the calling application should provide at
2069
+ * least a 300px wide container to allow sufficient space for the required forms.
2028
2070
  * ```ts
2029
- * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
2071
+ * interface IAuthStatus {
2072
+ * authenticated: boolean;
2073
+ * session: TSession;
2074
+ * profile: IProfile | null;
2075
+ * }
2076
+ * <verdocs-auth
2077
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }
2078
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
2079
+ * />
2030
2080
  * ```
2031
2081
  */
2032
2082
  interface HTMLVerdocsAuthElement extends Components.VerdocsAuth, HTMLStencilElement {
@@ -2052,9 +2102,35 @@ declare global {
2052
2102
  "rolesUpdated": {endpoint: VerdocsEndpoint; templateId: string; event: 'added' | 'deleted' | 'updated'; roles: IRole[]};
2053
2103
  }
2054
2104
  /**
2055
- * Display a template building experience.
2105
+ * Display a template building experience. Several event callbacks provide status updates to the
2106
+ * parent application to support interface updates.
2056
2107
  * ```ts
2057
- * <verdocs-build templateId={templateId} />
2108
+ * type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview'
2109
+ * interface IEnvelopeSent {
2110
+ * name: string;
2111
+ * template_id: string
2112
+ * recipients: ICreateEnvelopeRecipient[];
2113
+ * }
2114
+ * interface ITemplateEvent {
2115
+ * event: string
2116
+ * template: ITemplate;
2117
+ * }
2118
+ * interface IRolesEvent {
2119
+ * event: string
2120
+ * templateId: string;
2121
+ * roles: ITemplateRole[];
2122
+ * }
2123
+ * <verdocs-build
2124
+ * templateId={templateId}
2125
+ * step="preview"
2126
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }}
2127
+ * onStepChanged={({ detail }: { detail: TVerdocsBuildStep }) => { console.log('Step changed', detail) }}
2128
+ * onSend={({ detail }: { detail: IEnvelopeSent }) => { console.log('Step changed', detail) }}
2129
+ * onTemplateUpdated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template updated', detail) }}
2130
+ * onTemplateCreated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template created', detail) }}
2131
+ * onRolesUpdated={({ detail }) => { console.log('Roles updated', detail) }}
2132
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }}
2133
+ * />
2058
2134
  * ```
2059
2135
  */
2060
2136
  interface HTMLVerdocsBuildElement extends Components.VerdocsBuild, HTMLStencilElement {
@@ -2782,7 +2858,10 @@ declare global {
2782
2858
  * documents with signing fields overlaid on each page. Fields will be color-coded
2783
2859
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
2784
2860
  * ```ts
2785
- * <verdocs-preview templateId={templateId} />
2861
+ * <verdocs-preview
2862
+ * templateId={templateId}
2863
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
2864
+ * />
2786
2865
  * ```
2787
2866
  */
2788
2867
  interface HTMLVerdocsPreviewElement extends Components.VerdocsPreview, HTMLStencilElement {
@@ -2879,12 +2958,6 @@ declare global {
2879
2958
  prototype: HTMLVerdocsRadioButtonElement;
2880
2959
  new (): HTMLVerdocsRadioButtonElement;
2881
2960
  };
2882
- interface HTMLVerdocsSearchElement extends Components.VerdocsSearch, HTMLStencilElement {
2883
- }
2884
- var HTMLVerdocsSearchElement: {
2885
- prototype: HTMLVerdocsSearchElement;
2886
- new (): HTMLVerdocsSearchElement;
2887
- };
2888
2961
  interface HTMLVerdocsSearchBoxElementEventMap {
2889
2962
  "searchClicked": ISearchEvent;
2890
2963
  "typeChanged": TContentType;
@@ -2938,17 +3011,19 @@ declare global {
2938
3011
  "searchContacts": IContactSearchEvent1;
2939
3012
  }
2940
3013
  /**
2941
- * Display a form to send a template to one or more recipients in an envelope for signing. Note
2942
- * that because most applications have custom workflow requirements to trigger after sending an
2943
- * Envelope, this component does not actually perform that operation. Parent applications should
2944
- * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
2945
- * `createEnvelope()` call in JS-SDK.
3014
+ * Display a form to send a template to one or more recipients in an envelope for signing.
2946
3015
  * Host applications should ensure the template is "sendable" before displaying this component.
2947
3016
  * To be sendable, a template must have at least one document attached, at least one participant
2948
3017
  * defined, and at least one field assigned to every "signer" participant. This component will
2949
3018
  * hide itself if the template is not sendable.
2950
3019
  * ```ts
2951
- * <verdocs-send templateId={templateId} />
3020
+ * <verdocs-send
3021
+ * templateId={templateId}
3022
+ * onSend={({ detail }) => { console.log('Sent!', detail) }
3023
+ * onSendingEnvelope={()) => { console.log('Sending... Show a spinner...') }
3024
+ * onExit={(e) => { console.log('Send cancelled.', detail) }
3025
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
3026
+ * />
2952
3027
  * ```
2953
3028
  */
2954
3029
  interface HTMLVerdocsSendElement extends Components.VerdocsSend, HTMLStencilElement {
@@ -3524,7 +3599,14 @@ declare global {
3524
3599
  "next": any;
3525
3600
  }
3526
3601
  /**
3527
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
3602
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
3603
+ * displayed in order.
3604
+ * ```ts
3605
+ * <verdocs-view
3606
+ * envelopeId={envelopeId}
3607
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
3608
+ * />
3609
+ * ```
3528
3610
  */
3529
3611
  interface HTMLVerdocsViewElement extends Components.VerdocsView, HTMLStencilElement {
3530
3612
  addEventListener<K extends keyof HTMLVerdocsViewElementEventMap>(type: K, listener: (this: HTMLVerdocsViewElement, ev: VerdocsViewCustomEvent<HTMLVerdocsViewElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3580,7 +3662,6 @@ declare global {
3580
3662
  "verdocs-quick-filter": HTMLVerdocsQuickFilterElement;
3581
3663
  "verdocs-quick-functions": HTMLVerdocsQuickFunctionsElement;
3582
3664
  "verdocs-radio-button": HTMLVerdocsRadioButtonElement;
3583
- "verdocs-search": HTMLVerdocsSearchElement;
3584
3665
  "verdocs-search-box": HTMLVerdocsSearchBoxElement;
3585
3666
  "verdocs-search-tabs": HTMLVerdocsSearchTabsElement;
3586
3667
  "verdocs-select-input": HTMLVerdocsSelectInputElement;
@@ -3617,15 +3698,24 @@ declare global {
3617
3698
  }
3618
3699
  declare namespace LocalJSX {
3619
3700
  /**
3620
- * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
3621
- * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
3622
- * host application to render the next appropriate view for the application.
3701
+ * Display an authentication dialog that allows the user to login or sign up. If the user is
3702
+ * already authenticated with a valid session, this component will hide itself and fire the
3703
+ * success callback immediately. It is up to the host application to render the next appropriate
3704
+ * view for the application.
3623
3705
  * To simplify UI development, a visibility flag can force this component to never display. This
3624
- * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
3625
- * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
3626
- * container to allow sufficient space for the required forms.
3706
+ * allows you to subscribe to notifications from client apps without calling the lower-level JS SDK.
3707
+ * This embed is responsive / mobile-friendly, but the calling application should provide at
3708
+ * least a 300px wide container to allow sufficient space for the required forms.
3627
3709
  * ```ts
3628
- * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
3710
+ * interface IAuthStatus {
3711
+ * authenticated: boolean;
3712
+ * session: TSession;
3713
+ * profile: IProfile | null;
3714
+ * }
3715
+ * <verdocs-auth
3716
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }
3717
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
3718
+ * />
3629
3719
  * ```
3630
3720
  */
3631
3721
  interface VerdocsAuth {
@@ -3651,9 +3741,35 @@ declare namespace LocalJSX {
3651
3741
  "visible"?: boolean;
3652
3742
  }
3653
3743
  /**
3654
- * Display a template building experience.
3744
+ * Display a template building experience. Several event callbacks provide status updates to the
3745
+ * parent application to support interface updates.
3655
3746
  * ```ts
3656
- * <verdocs-build templateId={templateId} />
3747
+ * type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview'
3748
+ * interface IEnvelopeSent {
3749
+ * name: string;
3750
+ * template_id: string
3751
+ * recipients: ICreateEnvelopeRecipient[];
3752
+ * }
3753
+ * interface ITemplateEvent {
3754
+ * event: string
3755
+ * template: ITemplate;
3756
+ * }
3757
+ * interface IRolesEvent {
3758
+ * event: string
3759
+ * templateId: string;
3760
+ * roles: ITemplateRole[];
3761
+ * }
3762
+ * <verdocs-build
3763
+ * templateId={templateId}
3764
+ * step="preview"
3765
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }}
3766
+ * onStepChanged={({ detail }: { detail: TVerdocsBuildStep }) => { console.log('Step changed', detail) }}
3767
+ * onSend={({ detail }: { detail: IEnvelopeSent }) => { console.log('Step changed', detail) }}
3768
+ * onTemplateUpdated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template updated', detail) }}
3769
+ * onTemplateCreated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template created', detail) }}
3770
+ * onRolesUpdated={({ detail }) => { console.log('Roles updated', detail) }}
3771
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }}
3772
+ * />
3657
3773
  * ```
3658
3774
  */
3659
3775
  interface VerdocsBuild {
@@ -4905,7 +5021,10 @@ declare namespace LocalJSX {
4905
5021
  * documents with signing fields overlaid on each page. Fields will be color-coded
4906
5022
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
4907
5023
  * ```ts
4908
- * <verdocs-preview templateId={templateId} />
5024
+ * <verdocs-preview
5025
+ * templateId={templateId}
5026
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
5027
+ * />
4909
5028
  * ```
4910
5029
  */
4911
5030
  interface VerdocsPreview {
@@ -5014,12 +5133,6 @@ declare namespace LocalJSX {
5014
5133
  */
5015
5134
  "value"?: string;
5016
5135
  }
5017
- interface VerdocsSearch {
5018
- /**
5019
- * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
5020
- */
5021
- "endpoint"?: VerdocsEndpoint;
5022
- }
5023
5136
  /**
5024
5137
  * Displays a customizable input box for search queries.
5025
5138
  * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
@@ -5089,17 +5202,19 @@ declare namespace LocalJSX {
5089
5202
  "value"?: string;
5090
5203
  }
5091
5204
  /**
5092
- * Display a form to send a template to one or more recipients in an envelope for signing. Note
5093
- * that because most applications have custom workflow requirements to trigger after sending an
5094
- * Envelope, this component does not actually perform that operation. Parent applications should
5095
- * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
5096
- * `createEnvelope()` call in JS-SDK.
5205
+ * Display a form to send a template to one or more recipients in an envelope for signing.
5097
5206
  * Host applications should ensure the template is "sendable" before displaying this component.
5098
5207
  * To be sendable, a template must have at least one document attached, at least one participant
5099
5208
  * defined, and at least one field assigned to every "signer" participant. This component will
5100
5209
  * hide itself if the template is not sendable.
5101
5210
  * ```ts
5102
- * <verdocs-send templateId={templateId} />
5211
+ * <verdocs-send
5212
+ * templateId={templateId}
5213
+ * onSend={({ detail }) => { console.log('Sent!', detail) }
5214
+ * onSendingEnvelope={()) => { console.log('Sending... Show a spinner...') }
5215
+ * onExit={(e) => { console.log('Send cancelled.', detail) }
5216
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
5217
+ * />
5103
5218
  * ```
5104
5219
  */
5105
5220
  interface VerdocsSend {
@@ -5885,7 +6000,14 @@ declare namespace LocalJSX {
5885
6000
  "onNext"?: (event: VerdocsUploadDialogCustomEvent<IFileWithData[]>) => void;
5886
6001
  }
5887
6002
  /**
5888
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
6003
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
6004
+ * displayed in order.
6005
+ * ```ts
6006
+ * <verdocs-view
6007
+ * envelopeId={envelopeId}
6008
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6009
+ * />
6010
+ * ```
5889
6011
  */
5890
6012
  interface VerdocsView {
5891
6013
  /**
@@ -5961,7 +6083,6 @@ declare namespace LocalJSX {
5961
6083
  "verdocs-quick-filter": VerdocsQuickFilter;
5962
6084
  "verdocs-quick-functions": VerdocsQuickFunctions;
5963
6085
  "verdocs-radio-button": VerdocsRadioButton;
5964
- "verdocs-search": VerdocsSearch;
5965
6086
  "verdocs-search-box": VerdocsSearchBox;
5966
6087
  "verdocs-search-tabs": VerdocsSearchTabs;
5967
6088
  "verdocs-select-input": VerdocsSelectInput;
@@ -6001,22 +6122,57 @@ declare module "@stencil/core" {
6001
6122
  export namespace JSX {
6002
6123
  interface IntrinsicElements {
6003
6124
  /**
6004
- * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
6005
- * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
6006
- * host application to render the next appropriate view for the application.
6125
+ * Display an authentication dialog that allows the user to login or sign up. If the user is
6126
+ * already authenticated with a valid session, this component will hide itself and fire the
6127
+ * success callback immediately. It is up to the host application to render the next appropriate
6128
+ * view for the application.
6007
6129
  * To simplify UI development, a visibility flag can force this component to never display. This
6008
- * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
6009
- * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
6010
- * container to allow sufficient space for the required forms.
6130
+ * allows you to subscribe to notifications from client apps without calling the lower-level JS SDK.
6131
+ * This embed is responsive / mobile-friendly, but the calling application should provide at
6132
+ * least a 300px wide container to allow sufficient space for the required forms.
6011
6133
  * ```ts
6012
- * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
6134
+ * interface IAuthStatus {
6135
+ * authenticated: boolean;
6136
+ * session: TSession;
6137
+ * profile: IProfile | null;
6138
+ * }
6139
+ * <verdocs-auth
6140
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }
6141
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6142
+ * />
6013
6143
  * ```
6014
6144
  */
6015
6145
  "verdocs-auth": LocalJSX.VerdocsAuth & JSXBase.HTMLAttributes<HTMLVerdocsAuthElement>;
6016
6146
  /**
6017
- * Display a template building experience.
6147
+ * Display a template building experience. Several event callbacks provide status updates to the
6148
+ * parent application to support interface updates.
6018
6149
  * ```ts
6019
- * <verdocs-build templateId={templateId} />
6150
+ * type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview'
6151
+ * interface IEnvelopeSent {
6152
+ * name: string;
6153
+ * template_id: string
6154
+ * recipients: ICreateEnvelopeRecipient[];
6155
+ * }
6156
+ * interface ITemplateEvent {
6157
+ * event: string
6158
+ * template: ITemplate;
6159
+ * }
6160
+ * interface IRolesEvent {
6161
+ * event: string
6162
+ * templateId: string;
6163
+ * roles: ITemplateRole[];
6164
+ * }
6165
+ * <verdocs-build
6166
+ * templateId={templateId}
6167
+ * step="preview"
6168
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }}
6169
+ * onStepChanged={({ detail }: { detail: TVerdocsBuildStep }) => { console.log('Step changed', detail) }}
6170
+ * onSend={({ detail }: { detail: IEnvelopeSent }) => { console.log('Step changed', detail) }}
6171
+ * onTemplateUpdated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template updated', detail) }}
6172
+ * onTemplateCreated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template created', detail) }}
6173
+ * onRolesUpdated={({ detail }) => { console.log('Roles updated', detail) }}
6174
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }}
6175
+ * />
6020
6176
  * ```
6021
6177
  */
6022
6178
  "verdocs-build": LocalJSX.VerdocsBuild & JSXBase.HTMLAttributes<HTMLVerdocsBuildElement>;
@@ -6253,7 +6409,10 @@ declare module "@stencil/core" {
6253
6409
  * documents with signing fields overlaid on each page. Fields will be color-coded
6254
6410
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6255
6411
  * ```ts
6256
- * <verdocs-preview templateId={templateId} />
6412
+ * <verdocs-preview
6413
+ * templateId={templateId}
6414
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6415
+ * />
6257
6416
  * ```
6258
6417
  */
6259
6418
  "verdocs-preview": LocalJSX.VerdocsPreview & JSXBase.HTMLAttributes<HTMLVerdocsPreviewElement>;
@@ -6294,7 +6453,6 @@ declare module "@stencil/core" {
6294
6453
  * ```
6295
6454
  */
6296
6455
  "verdocs-radio-button": LocalJSX.VerdocsRadioButton & JSXBase.HTMLAttributes<HTMLVerdocsRadioButtonElement>;
6297
- "verdocs-search": LocalJSX.VerdocsSearch & JSXBase.HTMLAttributes<HTMLVerdocsSearchElement>;
6298
6456
  /**
6299
6457
  * Displays a customizable input box for search queries.
6300
6458
  * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
@@ -6313,17 +6471,19 @@ declare module "@stencil/core" {
6313
6471
  */
6314
6472
  "verdocs-select-input": LocalJSX.VerdocsSelectInput & JSXBase.HTMLAttributes<HTMLVerdocsSelectInputElement>;
6315
6473
  /**
6316
- * Display a form to send a template to one or more recipients in an envelope for signing. Note
6317
- * that because most applications have custom workflow requirements to trigger after sending an
6318
- * Envelope, this component does not actually perform that operation. Parent applications should
6319
- * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
6320
- * `createEnvelope()` call in JS-SDK.
6474
+ * Display a form to send a template to one or more recipients in an envelope for signing.
6321
6475
  * Host applications should ensure the template is "sendable" before displaying this component.
6322
6476
  * To be sendable, a template must have at least one document attached, at least one participant
6323
6477
  * defined, and at least one field assigned to every "signer" participant. This component will
6324
6478
  * hide itself if the template is not sendable.
6325
6479
  * ```ts
6326
- * <verdocs-send templateId={templateId} />
6480
+ * <verdocs-send
6481
+ * templateId={templateId}
6482
+ * onSend={({ detail }) => { console.log('Sent!', detail) }
6483
+ * onSendingEnvelope={()) => { console.log('Sending... Show a spinner...') }
6484
+ * onExit={(e) => { console.log('Send cancelled.', detail) }
6485
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6486
+ * />
6327
6487
  * ```
6328
6488
  */
6329
6489
  "verdocs-send": LocalJSX.VerdocsSend & JSXBase.HTMLAttributes<HTMLVerdocsSendElement>;
@@ -6485,7 +6645,14 @@ declare module "@stencil/core" {
6485
6645
  */
6486
6646
  "verdocs-upload-dialog": LocalJSX.VerdocsUploadDialog & JSXBase.HTMLAttributes<HTMLVerdocsUploadDialogElement>;
6487
6647
  /**
6488
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
6648
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
6649
+ * displayed in order.
6650
+ * ```ts
6651
+ * <verdocs-view
6652
+ * envelopeId={envelopeId}
6653
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6654
+ * />
6655
+ * ```
6489
6656
  */
6490
6657
  "verdocs-view": LocalJSX.VerdocsView & JSXBase.HTMLAttributes<HTMLVerdocsViewElement>;
6491
6658
  }