@verdocs/web-sdk 4.2.65 → 4.2.67

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 +6 -10
  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 +31 -13
  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 +8 -11
  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/esm/index-3476681c.js +6 -6
  54. package/dist/esm/loader.js +1 -1
  55. package/dist/esm/verdocs-envelope-document-page.entry.js +1 -1
  56. package/dist/esm/verdocs-envelope-recipient-link_2.entry.js +1 -1
  57. package/dist/esm/verdocs-envelope-sidebar.entry.js +2 -2
  58. package/dist/esm/verdocs-envelopes-list.entry.js +6 -6
  59. package/dist/esm/verdocs-preview_10.entry.js +1 -5
  60. package/dist/{components/verdocs-quick-functions2.js → esm/verdocs-quick-functions.entry.js} +7 -23
  61. package/dist/esm/verdocs-radio-button_3.entry.js +9 -9
  62. package/dist/{components/verdocs-search-box2.js → esm/verdocs-search-box.entry.js} +7 -28
  63. package/dist/esm/verdocs-sign.entry.js +7 -11
  64. package/dist/esm/verdocs-status-indicator.entry.js +2 -2
  65. package/dist/esm/verdocs-template-card.entry.js +1 -1
  66. package/dist/esm/verdocs-template-document-page_2.entry.js +1 -1
  67. package/dist/esm/verdocs-template-star.entry.js +1 -1
  68. package/dist/esm/verdocs-template-tags.entry.js +1 -1
  69. package/dist/esm/verdocs-web-sdk.js +1 -1
  70. package/dist/esm-es5/index-3476681c.js +1 -1
  71. package/dist/esm-es5/loader.js +1 -1
  72. package/dist/esm-es5/verdocs-envelope-document-page.entry.js +1 -1
  73. package/dist/esm-es5/verdocs-envelope-recipient-link_2.entry.js +1 -1
  74. package/dist/esm-es5/verdocs-envelope-sidebar.entry.js +1 -1
  75. package/dist/esm-es5/verdocs-envelopes-list.entry.js +1 -1
  76. package/dist/esm-es5/verdocs-preview_10.entry.js +1 -1
  77. package/dist/esm-es5/verdocs-quick-functions.entry.js +1 -0
  78. package/dist/esm-es5/verdocs-radio-button_3.entry.js +1 -1
  79. package/dist/esm-es5/verdocs-search-box.entry.js +1 -0
  80. package/dist/esm-es5/verdocs-sign.entry.js +1 -1
  81. package/dist/esm-es5/verdocs-status-indicator.entry.js +1 -1
  82. package/dist/esm-es5/verdocs-template-card.entry.js +1 -1
  83. package/dist/esm-es5/verdocs-template-document-page_2.entry.js +1 -1
  84. package/dist/esm-es5/verdocs-template-star.entry.js +1 -1
  85. package/dist/esm-es5/verdocs-template-tags.entry.js +1 -1
  86. package/dist/esm-es5/verdocs-web-sdk.js +1 -1
  87. package/dist/types/components/embeds/verdocs-auth/verdocs-auth.d.ts +17 -7
  88. package/dist/types/components/embeds/verdocs-build/verdocs-build.d.ts +32 -2
  89. package/dist/types/components/embeds/verdocs-preview/verdocs-preview.d.ts +5 -2
  90. package/dist/types/components/embeds/verdocs-send/verdocs-send.d.ts +8 -7
  91. package/dist/types/components/embeds/verdocs-sign/verdocs-sign.d.ts +4 -1
  92. package/dist/types/components/embeds/verdocs-view/verdocs-view.d.ts +9 -1
  93. package/dist/types/components.d.ts +264 -89
  94. package/dist/verdocs-web-sdk/p-03a228e4.system.js +1 -1
  95. package/dist/verdocs-web-sdk/{p-52d9d12b.entry.js → p-0b858d95.entry.js} +1 -1
  96. package/dist/verdocs-web-sdk/p-113251b7.entry.js +1 -0
  97. package/dist/verdocs-web-sdk/{p-e8b96519.system.entry.js → p-1d2a24d8.system.entry.js} +1 -1
  98. package/dist/verdocs-web-sdk/p-27b3f4b4.entry.js +1 -0
  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-672a4df3.system.entry.js +1 -0
  107. package/dist/verdocs-web-sdk/p-6bab3791.system.entry.js +1 -0
  108. package/dist/verdocs-web-sdk/{p-d7b00716.entry.js → p-6e03c475.entry.js} +1 -1
  109. package/dist/verdocs-web-sdk/{p-05ec94da.entry.js → p-74b45256.entry.js} +1 -1
  110. package/dist/verdocs-web-sdk/p-7861d427.entry.js +1 -0
  111. package/dist/verdocs-web-sdk/{p-6bd283bf.system.entry.js → p-7f4c7fef.system.entry.js} +1 -1
  112. package/dist/verdocs-web-sdk/{p-5352f042.system.entry.js → p-8e1fcab5.system.entry.js} +1 -1
  113. package/dist/verdocs-web-sdk/p-97a3efcf.entry.js +1 -0
  114. package/dist/verdocs-web-sdk/{p-18ef3307.system.entry.js → p-9ba77c1d.system.entry.js} +1 -1
  115. package/dist/verdocs-web-sdk/p-a3b75156.system.entry.js +1 -0
  116. package/dist/verdocs-web-sdk/{p-86126812.system.entry.js → p-a63081ed.system.entry.js} +1 -1
  117. package/dist/verdocs-web-sdk/{p-530f073d.entry.js → p-ace6d1f2.entry.js} +1 -1
  118. package/dist/verdocs-web-sdk/p-b4e722fc.entry.js +1 -0
  119. package/dist/verdocs-web-sdk/{p-09174e70.entry.js → p-b9139237.entry.js} +1 -1
  120. package/dist/verdocs-web-sdk/p-bfd72d8d.system.entry.js +1 -0
  121. package/dist/verdocs-web-sdk/{p-002b8ba2.entry.js → p-e27ffcbb.entry.js} +1 -1
  122. package/dist/verdocs-web-sdk/{p-f00e5323.entry.js → p-e2f2f11a.entry.js} +1 -1
  123. package/dist/verdocs-web-sdk/verdocs-web-sdk.esm.js +1 -1
  124. package/package.json +2 -2
  125. package/dist/cjs/verdocs-search.cjs.entry.js +0 -22
  126. package/dist/collection/components/embeds/verdocs-search/verdocs-search.css +0 -34
  127. package/dist/collection/components/embeds/verdocs-search/verdocs-search.js +0 -47
  128. package/dist/components/verdocs-search.d.ts +0 -11
  129. package/dist/components/verdocs-search.js +0 -49
  130. package/dist/custom-elements.json +0 -2030
  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 {
@@ -1283,6 +1317,10 @@ export namespace Components {
1283
1317
  * the signed attachments.)
1284
1318
  */
1285
1319
  interface VerdocsSign {
1320
+ /**
1321
+ * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
1322
+ */
1323
+ "endpoint": VerdocsEndpoint;
1286
1324
  /**
1287
1325
  * The ID of the envelope to sign.
1288
1326
  */
@@ -1783,7 +1821,14 @@ export namespace Components {
1783
1821
  interface VerdocsUploadDialog {
1784
1822
  }
1785
1823
  /**
1786
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
1824
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
1825
+ * displayed in order.
1826
+ * ```ts
1827
+ * <verdocs-view
1828
+ * envelopeId={envelopeId}
1829
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
1830
+ * />
1831
+ * ```
1787
1832
  */
1788
1833
  interface VerdocsView {
1789
1834
  /**
@@ -2018,15 +2063,24 @@ declare global {
2018
2063
  "sdkError": SDKError;
2019
2064
  }
2020
2065
  /**
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.
2066
+ * Display an authentication dialog that allows the user to login or sign up. If the user is
2067
+ * already authenticated with a valid session, this component will hide itself and fire the
2068
+ * success callback immediately. It is up to the host application to render the next appropriate
2069
+ * view for the application.
2024
2070
  * 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.
2071
+ * allows you to subscribe to notifications from client apps without calling the lower-level JS SDK.
2072
+ * This embed is responsive / mobile-friendly, but the calling application should provide at
2073
+ * least a 300px wide container to allow sufficient space for the required forms.
2028
2074
  * ```ts
2029
- * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
2075
+ * interface IAuthStatus {
2076
+ * authenticated: boolean;
2077
+ * session: TSession;
2078
+ * profile: IProfile | null;
2079
+ * }
2080
+ * <verdocs-auth
2081
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }
2082
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
2083
+ * />
2030
2084
  * ```
2031
2085
  */
2032
2086
  interface HTMLVerdocsAuthElement extends Components.VerdocsAuth, HTMLStencilElement {
@@ -2052,9 +2106,35 @@ declare global {
2052
2106
  "rolesUpdated": {endpoint: VerdocsEndpoint; templateId: string; event: 'added' | 'deleted' | 'updated'; roles: IRole[]};
2053
2107
  }
2054
2108
  /**
2055
- * Display a template building experience.
2109
+ * Display a template building experience. Several event callbacks provide status updates to the
2110
+ * parent application to support interface updates.
2056
2111
  * ```ts
2057
- * <verdocs-build templateId={templateId} />
2112
+ * type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview'
2113
+ * interface IEnvelopeSent {
2114
+ * name: string;
2115
+ * template_id: string
2116
+ * recipients: ICreateEnvelopeRecipient[];
2117
+ * }
2118
+ * interface ITemplateEvent {
2119
+ * event: string
2120
+ * template: ITemplate;
2121
+ * }
2122
+ * interface IRolesEvent {
2123
+ * event: string
2124
+ * templateId: string;
2125
+ * roles: ITemplateRole[];
2126
+ * }
2127
+ * <verdocs-build
2128
+ * templateId={templateId}
2129
+ * step="preview"
2130
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }}
2131
+ * onStepChanged={({ detail }: { detail: TVerdocsBuildStep }) => { console.log('Step changed', detail) }}
2132
+ * onSend={({ detail }: { detail: IEnvelopeSent }) => { console.log('Step changed', detail) }}
2133
+ * onTemplateUpdated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template updated', detail) }}
2134
+ * onTemplateCreated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template created', detail) }}
2135
+ * onRolesUpdated={({ detail }) => { console.log('Roles updated', detail) }}
2136
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }}
2137
+ * />
2058
2138
  * ```
2059
2139
  */
2060
2140
  interface HTMLVerdocsBuildElement extends Components.VerdocsBuild, HTMLStencilElement {
@@ -2782,7 +2862,10 @@ declare global {
2782
2862
  * documents with signing fields overlaid on each page. Fields will be color-coded
2783
2863
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
2784
2864
  * ```ts
2785
- * <verdocs-preview templateId={templateId} />
2865
+ * <verdocs-preview
2866
+ * templateId={templateId}
2867
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
2868
+ * />
2786
2869
  * ```
2787
2870
  */
2788
2871
  interface HTMLVerdocsPreviewElement extends Components.VerdocsPreview, HTMLStencilElement {
@@ -2879,12 +2962,6 @@ declare global {
2879
2962
  prototype: HTMLVerdocsRadioButtonElement;
2880
2963
  new (): HTMLVerdocsRadioButtonElement;
2881
2964
  };
2882
- interface HTMLVerdocsSearchElement extends Components.VerdocsSearch, HTMLStencilElement {
2883
- }
2884
- var HTMLVerdocsSearchElement: {
2885
- prototype: HTMLVerdocsSearchElement;
2886
- new (): HTMLVerdocsSearchElement;
2887
- };
2888
2965
  interface HTMLVerdocsSearchBoxElementEventMap {
2889
2966
  "searchClicked": ISearchEvent;
2890
2967
  "typeChanged": TContentType;
@@ -2938,17 +3015,19 @@ declare global {
2938
3015
  "searchContacts": IContactSearchEvent1;
2939
3016
  }
2940
3017
  /**
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.
3018
+ * Display a form to send a template to one or more recipients in an envelope for signing.
2946
3019
  * Host applications should ensure the template is "sendable" before displaying this component.
2947
3020
  * To be sendable, a template must have at least one document attached, at least one participant
2948
3021
  * defined, and at least one field assigned to every "signer" participant. This component will
2949
3022
  * hide itself if the template is not sendable.
2950
3023
  * ```ts
2951
- * <verdocs-send templateId={templateId} />
3024
+ * <verdocs-send
3025
+ * templateId={templateId}
3026
+ * onSend={({ detail }) => { console.log('Sent!', detail) }
3027
+ * onSendingEnvelope={()) => { console.log('Sending... Show a spinner...') }
3028
+ * onExit={(e) => { console.log('Send cancelled.', detail) }
3029
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
3030
+ * />
2952
3031
  * ```
2953
3032
  */
2954
3033
  interface HTMLVerdocsSendElement extends Components.VerdocsSend, HTMLStencilElement {
@@ -3524,7 +3603,14 @@ declare global {
3524
3603
  "next": any;
3525
3604
  }
3526
3605
  /**
3527
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
3606
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
3607
+ * displayed in order.
3608
+ * ```ts
3609
+ * <verdocs-view
3610
+ * envelopeId={envelopeId}
3611
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
3612
+ * />
3613
+ * ```
3528
3614
  */
3529
3615
  interface HTMLVerdocsViewElement extends Components.VerdocsView, HTMLStencilElement {
3530
3616
  addEventListener<K extends keyof HTMLVerdocsViewElementEventMap>(type: K, listener: (this: HTMLVerdocsViewElement, ev: VerdocsViewCustomEvent<HTMLVerdocsViewElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3580,7 +3666,6 @@ declare global {
3580
3666
  "verdocs-quick-filter": HTMLVerdocsQuickFilterElement;
3581
3667
  "verdocs-quick-functions": HTMLVerdocsQuickFunctionsElement;
3582
3668
  "verdocs-radio-button": HTMLVerdocsRadioButtonElement;
3583
- "verdocs-search": HTMLVerdocsSearchElement;
3584
3669
  "verdocs-search-box": HTMLVerdocsSearchBoxElement;
3585
3670
  "verdocs-search-tabs": HTMLVerdocsSearchTabsElement;
3586
3671
  "verdocs-select-input": HTMLVerdocsSelectInputElement;
@@ -3617,15 +3702,24 @@ declare global {
3617
3702
  }
3618
3703
  declare namespace LocalJSX {
3619
3704
  /**
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.
3705
+ * Display an authentication dialog that allows the user to login or sign up. If the user is
3706
+ * already authenticated with a valid session, this component will hide itself and fire the
3707
+ * success callback immediately. It is up to the host application to render the next appropriate
3708
+ * view for the application.
3623
3709
  * 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.
3710
+ * allows you to subscribe to notifications from client apps without calling the lower-level JS SDK.
3711
+ * This embed is responsive / mobile-friendly, but the calling application should provide at
3712
+ * least a 300px wide container to allow sufficient space for the required forms.
3627
3713
  * ```ts
3628
- * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
3714
+ * interface IAuthStatus {
3715
+ * authenticated: boolean;
3716
+ * session: TSession;
3717
+ * profile: IProfile | null;
3718
+ * }
3719
+ * <verdocs-auth
3720
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }
3721
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
3722
+ * />
3629
3723
  * ```
3630
3724
  */
3631
3725
  interface VerdocsAuth {
@@ -3651,9 +3745,35 @@ declare namespace LocalJSX {
3651
3745
  "visible"?: boolean;
3652
3746
  }
3653
3747
  /**
3654
- * Display a template building experience.
3748
+ * Display a template building experience. Several event callbacks provide status updates to the
3749
+ * parent application to support interface updates.
3655
3750
  * ```ts
3656
- * <verdocs-build templateId={templateId} />
3751
+ * type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview'
3752
+ * interface IEnvelopeSent {
3753
+ * name: string;
3754
+ * template_id: string
3755
+ * recipients: ICreateEnvelopeRecipient[];
3756
+ * }
3757
+ * interface ITemplateEvent {
3758
+ * event: string
3759
+ * template: ITemplate;
3760
+ * }
3761
+ * interface IRolesEvent {
3762
+ * event: string
3763
+ * templateId: string;
3764
+ * roles: ITemplateRole[];
3765
+ * }
3766
+ * <verdocs-build
3767
+ * templateId={templateId}
3768
+ * step="preview"
3769
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }}
3770
+ * onStepChanged={({ detail }: { detail: TVerdocsBuildStep }) => { console.log('Step changed', detail) }}
3771
+ * onSend={({ detail }: { detail: IEnvelopeSent }) => { console.log('Step changed', detail) }}
3772
+ * onTemplateUpdated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template updated', detail) }}
3773
+ * onTemplateCreated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template created', detail) }}
3774
+ * onRolesUpdated={({ detail }) => { console.log('Roles updated', detail) }}
3775
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }}
3776
+ * />
3657
3777
  * ```
3658
3778
  */
3659
3779
  interface VerdocsBuild {
@@ -4905,7 +5025,10 @@ declare namespace LocalJSX {
4905
5025
  * documents with signing fields overlaid on each page. Fields will be color-coded
4906
5026
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
4907
5027
  * ```ts
4908
- * <verdocs-preview templateId={templateId} />
5028
+ * <verdocs-preview
5029
+ * templateId={templateId}
5030
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
5031
+ * />
4909
5032
  * ```
4910
5033
  */
4911
5034
  interface VerdocsPreview {
@@ -5014,12 +5137,6 @@ declare namespace LocalJSX {
5014
5137
  */
5015
5138
  "value"?: string;
5016
5139
  }
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
5140
  /**
5024
5141
  * Displays a customizable input box for search queries.
5025
5142
  * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
@@ -5089,17 +5206,19 @@ declare namespace LocalJSX {
5089
5206
  "value"?: string;
5090
5207
  }
5091
5208
  /**
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.
5209
+ * Display a form to send a template to one or more recipients in an envelope for signing.
5097
5210
  * Host applications should ensure the template is "sendable" before displaying this component.
5098
5211
  * To be sendable, a template must have at least one document attached, at least one participant
5099
5212
  * defined, and at least one field assigned to every "signer" participant. This component will
5100
5213
  * hide itself if the template is not sendable.
5101
5214
  * ```ts
5102
- * <verdocs-send templateId={templateId} />
5215
+ * <verdocs-send
5216
+ * templateId={templateId}
5217
+ * onSend={({ detail }) => { console.log('Sent!', detail) }
5218
+ * onSendingEnvelope={()) => { console.log('Sending... Show a spinner...') }
5219
+ * onExit={(e) => { console.log('Send cancelled.', detail) }
5220
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
5221
+ * />
5103
5222
  * ```
5104
5223
  */
5105
5224
  interface VerdocsSend {
@@ -5152,6 +5271,10 @@ declare namespace LocalJSX {
5152
5271
  * the signed attachments.)
5153
5272
  */
5154
5273
  interface VerdocsSign {
5274
+ /**
5275
+ * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
5276
+ */
5277
+ "endpoint"?: VerdocsEndpoint;
5155
5278
  /**
5156
5279
  * The ID of the envelope to sign.
5157
5280
  */
@@ -5885,7 +6008,14 @@ declare namespace LocalJSX {
5885
6008
  "onNext"?: (event: VerdocsUploadDialogCustomEvent<IFileWithData[]>) => void;
5886
6009
  }
5887
6010
  /**
5888
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
6011
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
6012
+ * displayed in order.
6013
+ * ```ts
6014
+ * <verdocs-view
6015
+ * envelopeId={envelopeId}
6016
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6017
+ * />
6018
+ * ```
5889
6019
  */
5890
6020
  interface VerdocsView {
5891
6021
  /**
@@ -5961,7 +6091,6 @@ declare namespace LocalJSX {
5961
6091
  "verdocs-quick-filter": VerdocsQuickFilter;
5962
6092
  "verdocs-quick-functions": VerdocsQuickFunctions;
5963
6093
  "verdocs-radio-button": VerdocsRadioButton;
5964
- "verdocs-search": VerdocsSearch;
5965
6094
  "verdocs-search-box": VerdocsSearchBox;
5966
6095
  "verdocs-search-tabs": VerdocsSearchTabs;
5967
6096
  "verdocs-select-input": VerdocsSelectInput;
@@ -6001,22 +6130,57 @@ declare module "@stencil/core" {
6001
6130
  export namespace JSX {
6002
6131
  interface IntrinsicElements {
6003
6132
  /**
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.
6133
+ * Display an authentication dialog that allows the user to login or sign up. If the user is
6134
+ * already authenticated with a valid session, this component will hide itself and fire the
6135
+ * success callback immediately. It is up to the host application to render the next appropriate
6136
+ * view for the application.
6007
6137
  * 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.
6138
+ * allows you to subscribe to notifications from client apps without calling the lower-level JS SDK.
6139
+ * This embed is responsive / mobile-friendly, but the calling application should provide at
6140
+ * least a 300px wide container to allow sufficient space for the required forms.
6011
6141
  * ```ts
6012
- * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
6142
+ * interface IAuthStatus {
6143
+ * authenticated: boolean;
6144
+ * session: TSession;
6145
+ * profile: IProfile | null;
6146
+ * }
6147
+ * <verdocs-auth
6148
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }
6149
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6150
+ * />
6013
6151
  * ```
6014
6152
  */
6015
6153
  "verdocs-auth": LocalJSX.VerdocsAuth & JSXBase.HTMLAttributes<HTMLVerdocsAuthElement>;
6016
6154
  /**
6017
- * Display a template building experience.
6155
+ * Display a template building experience. Several event callbacks provide status updates to the
6156
+ * parent application to support interface updates.
6018
6157
  * ```ts
6019
- * <verdocs-build templateId={templateId} />
6158
+ * type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview'
6159
+ * interface IEnvelopeSent {
6160
+ * name: string;
6161
+ * template_id: string
6162
+ * recipients: ICreateEnvelopeRecipient[];
6163
+ * }
6164
+ * interface ITemplateEvent {
6165
+ * event: string
6166
+ * template: ITemplate;
6167
+ * }
6168
+ * interface IRolesEvent {
6169
+ * event: string
6170
+ * templateId: string;
6171
+ * roles: ITemplateRole[];
6172
+ * }
6173
+ * <verdocs-build
6174
+ * templateId={templateId}
6175
+ * step="preview"
6176
+ * onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }}
6177
+ * onStepChanged={({ detail }: { detail: TVerdocsBuildStep }) => { console.log('Step changed', detail) }}
6178
+ * onSend={({ detail }: { detail: IEnvelopeSent }) => { console.log('Step changed', detail) }}
6179
+ * onTemplateUpdated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template updated', detail) }}
6180
+ * onTemplateCreated={({ detail }: { detail: ITemplateEvent }) => { console.log('Template created', detail) }}
6181
+ * onRolesUpdated={({ detail }) => { console.log('Roles updated', detail) }}
6182
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }}
6183
+ * />
6020
6184
  * ```
6021
6185
  */
6022
6186
  "verdocs-build": LocalJSX.VerdocsBuild & JSXBase.HTMLAttributes<HTMLVerdocsBuildElement>;
@@ -6253,7 +6417,10 @@ declare module "@stencil/core" {
6253
6417
  * documents with signing fields overlaid on each page. Fields will be color-coded
6254
6418
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6255
6419
  * ```ts
6256
- * <verdocs-preview templateId={templateId} />
6420
+ * <verdocs-preview
6421
+ * templateId={templateId}
6422
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6423
+ * />
6257
6424
  * ```
6258
6425
  */
6259
6426
  "verdocs-preview": LocalJSX.VerdocsPreview & JSXBase.HTMLAttributes<HTMLVerdocsPreviewElement>;
@@ -6294,7 +6461,6 @@ declare module "@stencil/core" {
6294
6461
  * ```
6295
6462
  */
6296
6463
  "verdocs-radio-button": LocalJSX.VerdocsRadioButton & JSXBase.HTMLAttributes<HTMLVerdocsRadioButtonElement>;
6297
- "verdocs-search": LocalJSX.VerdocsSearch & JSXBase.HTMLAttributes<HTMLVerdocsSearchElement>;
6298
6464
  /**
6299
6465
  * Displays a customizable input box for search queries.
6300
6466
  * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
@@ -6313,17 +6479,19 @@ declare module "@stencil/core" {
6313
6479
  */
6314
6480
  "verdocs-select-input": LocalJSX.VerdocsSelectInput & JSXBase.HTMLAttributes<HTMLVerdocsSelectInputElement>;
6315
6481
  /**
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.
6482
+ * Display a form to send a template to one or more recipients in an envelope for signing.
6321
6483
  * Host applications should ensure the template is "sendable" before displaying this component.
6322
6484
  * To be sendable, a template must have at least one document attached, at least one participant
6323
6485
  * defined, and at least one field assigned to every "signer" participant. This component will
6324
6486
  * hide itself if the template is not sendable.
6325
6487
  * ```ts
6326
- * <verdocs-send templateId={templateId} />
6488
+ * <verdocs-send
6489
+ * templateId={templateId}
6490
+ * onSend={({ detail }) => { console.log('Sent!', detail) }
6491
+ * onSendingEnvelope={()) => { console.log('Sending... Show a spinner...') }
6492
+ * onExit={(e) => { console.log('Send cancelled.', detail) }
6493
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6494
+ * />
6327
6495
  * ```
6328
6496
  */
6329
6497
  "verdocs-send": LocalJSX.VerdocsSend & JSXBase.HTMLAttributes<HTMLVerdocsSendElement>;
@@ -6485,7 +6653,14 @@ declare module "@stencil/core" {
6485
6653
  */
6486
6654
  "verdocs-upload-dialog": LocalJSX.VerdocsUploadDialog & JSXBase.HTMLAttributes<HTMLVerdocsUploadDialogElement>;
6487
6655
  /**
6488
- * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
6656
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are
6657
+ * displayed in order.
6658
+ * ```ts
6659
+ * <verdocs-view
6660
+ * envelopeId={envelopeId}
6661
+ * onSdkError={({ detail }) => { console.log('SDK error', detail) }
6662
+ * />
6663
+ * ```
6489
6664
  */
6490
6665
  "verdocs-view": LocalJSX.VerdocsView & JSXBase.HTMLAttributes<HTMLVerdocsViewElement>;
6491
6666
  }