@verdocs/web-sdk 1.9.9 → 1.9.10

package/dist/types/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.stories.d.ts

@@ -1,7 +1,7 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const KBADialog: ({ helptitle, helptext, label, placeholder, mode, step, steps, choices, open, closed }: {
+export declare const KBADialog: ({ helptitle, helptext, label, placeholder, mode, step, steps, choices, onNext, onCancel }: {
   helptitle: any;
   helptext: any;
   label: any;
@@ -10,6 +10,6 @@ export declare const KBADialog: ({ helptitle, helptext, label, placeholder, mode
   step: any;
   steps: any;
   choices: any;
-  open: any;
-  closed: any;
+  onNext: any;
+  onCancel: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/dialogs/verdocs-ok-dialog/verdocs-ok-dialog.d.ts

@@ -13,20 +13,21 @@ export declare class VerdocsOkDialog {
    * The message content to display.
    */
   message: string;
-  /**
-   * Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.
-   */
-  open: boolean;
   /**
    * If set, a cancel button will also be displayed. Note that the dialog is always cancelable by clicking the background
    * overlay to dismiss it.
    */
-  cancel: boolean;
+  showCancel: boolean;
+  /**
+   * Event fired when the user clicks the OK button.
+   */
+  next: EventEmitter;
   /**
-   * Event fired when the dialog is closed. The event data will contain the closure reason.
+   * Event fired when the user clicks the background overlay or Cancel button.
    */
-  closed: EventEmitter<'cancel' | 'ok'>;
-  handleClose(reason: 'cancel' | 'ok'): void;
+  cancel: EventEmitter;
+  handleOk(): void;
+  handleCancel(): void;
   handleDismiss(e: any): void;
   render(): any;
 }

package/dist/types/components/dialogs/verdocs-ok-dialog/verdocs-ok-dialog.stories.d.ts

@@ -1,10 +1,10 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const OkDialog: ({ heading, message, open, cancel, closed }: {
+export declare const OkDialog: ({ heading, message, showCancel, onNext, onCancel }: {
   heading: any;
   message: any;
-  open: any;
-  cancel: any;
-  closed: any;
+  showCancel: any;
+  onNext: any;
+  onCancel: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/dialogs/verdocs-signature-dialog/verdocs-signature-dialog.d.ts

@@ -10,15 +10,12 @@ export declare class VerdocsSignatureDialog {
    */
   name: string;
   /**
-   * Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.
+   * Fired when the user completes the dialog and clicks Adopt. The event detail will contain a base64-encoded string
+   * representation of the signature adopted.
    */
-  open: boolean;
+  next: EventEmitter<string>;
   /**
-   * Event fired when a signature is adopted.
-   */
-  adopt: EventEmitter<string>;
-  /**
-   * Event fired when the step is cancelled.
+   * Fired if the user cancels the dialog.
    */
   cancel: EventEmitter;
   fontLoaded: boolean;

package/dist/types/components/dialogs/verdocs-signature-dialog/verdocs-signature-dialog.stories.d.ts

@@ -1,8 +1,8 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const SignatureDialog: ({ name, open, closed }: {
+export declare const SignatureDialog: ({ name, onCancel, onNext }: {
   name: any;
-  open: any;
-  closed: any;
+  onCancel: any;
+  onNext: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/dialogs/verdocs-template-sender-dialog/verdocs-template-sender-dialog.d.ts

@@ -8,20 +8,14 @@ export declare class VerdocsTemplateSenderDialog {
    * Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.
    */
   value: TemplateSenderTypes;
-  /**
-   * Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.
-   */
-  open: boolean;
   /**
    * Event fired when the dialog is closed. The event data will contain the closure reason.
    */
   cancel: EventEmitter;
   /**
-   * Event fired when the dialog is closed. The event data will contain the closure reason.
+   * Event fired when the dialog is closed. The event data will contain the selected value.
    */
-  done: EventEmitter<{
-    sender: TemplateSenderTypes;
-  }>;
+  next: EventEmitter<TemplateSenderTypes>;
   newValue: TemplateSenderTypes;
   componentWillLoad(): void;
   handleCancel(): void;

package/dist/types/components/dialogs/verdocs-template-sender-dialog/verdocs-template-sender-dialog.stories.d.ts

@@ -1,8 +1,8 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const TemplateSenderDialog: ({ message, open, closed }: {
-  message: any;
-  open: any;
-  closed: any;
+export declare const TemplateSenderDialog: ({ value, onCancel, onNext }: {
+  value: any;
+  onCancel: any;
+  onNext: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/dialogs/verdocs-upload-dialog/verdocs-upload-dialog.d.ts

@@ -1,22 +1,20 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { FileWithData } from '@verdocs/js-sdk/Utils/Files';
 /**
- * Display a file upload experience.
+ * Display a file upload tool. Note that the file is not actually transmitted, so it may be used by
+ * callers with a variety of workflows. Instead, data about the chosen file will be passed to the
+ * caller via the onNext event handler.
  */
 export declare class VerdocsUploadDialog {
   private fileInput?;
   /**
-   * Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.
-   */
-  open: boolean;
-  /**
-   * Event fired when the dialog is closed. The event data will contain the closure reason.
+   * Event fired when the dialog is cancelled.
    */
   cancel: EventEmitter;
   /**
-   * Event fired when the dialog is closed. The event data will contain the closure reason.
+   * Event fired when the dialog is closed. The event data will contain the file selected.
    */
-  done: EventEmitter<FileWithData[]>;
+  next: EventEmitter<FileWithData[]>;
   draggingOver: boolean;
   decodedFiles: FileWithData[];
   handleCancel(): void;
@@ -27,6 +25,6 @@ export declare class VerdocsUploadDialog {
   handleDrop(e: any): Promise<void>;
   handleRemoveAttachment(index: number): void;
   handleSelectFile(): void;
-  handleFileChange(e: any): Promise<void>;
+  handleFileChange(): Promise<void>;
   render(): any;
 }

package/dist/types/components/elements/verdocs-contact-picker/verdocs-contact-picker.d.ts

@@ -62,7 +62,7 @@ export declare class VerdocsContactPicker {
   /**
    * Event fired when the user changes the type.
    */
-  contactSelected: EventEmitter<IContactSelectEvent>;
+  next: EventEmitter<IContactSelectEvent>;
   name: string;
   email: string;
   phone: string;

package/dist/types/components/elements/verdocs-contact-picker/verdocs-contact-picker.stories.d.ts

@@ -1,10 +1,10 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const ContactPicker: ({ templateRole, contactSuggestions, searchContacts, cancel, contactSelected }: {
+export declare const ContactPicker: ({ templateRole, contactSuggestions, searchContacts, onCancel, onNext }: {
   templateRole: any;
   contactSuggestions: any;
   searchContacts: any;
-  cancel: any;
-  contactSelected: any;
+  onCancel: any;
+  onNext: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/elements/verdocs-field-attachment/verdocs-field-attachment.d.ts

@@ -1,4 +1,3 @@
-import { EventEmitter } from '../../../stencil-public-runtime';
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 import { IDocumentField, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
 /**
@@ -18,12 +17,6 @@ export declare class VerdocsFieldAttachment {
    * If set, overrides the field's settings object. Primarily used to support "preview" modes where all fields are disabled.
    */
   disabled?: boolean;
-  /**
-   * Event fired when the input field value changes. Note that this will only be fired on blur, tab-out, ENTER key press, etc.
-   * It is generally the best event to subscribe to than `input` for most cases EXCEPT autocomplete fields that need to see every
-   * keypress.
-   */
-  fieldChange: EventEmitter<string>;
   focusField(): Promise<void>;
   private dialog?;
   handleShow(): void;

package/dist/types/components/elements/verdocs-field-checkbox-group/verdocs-field-checkbox.d.ts

@@ -1,9 +1,7 @@
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 import { IDocumentField, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
-import { EventEmitter } from '../../../stencil-public-runtime';
 /**
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
- * input types like text and checkbox.
+ * Displays a checkbox.
  */
 export declare class VerdocsFieldCheckbox {
   /**
@@ -22,15 +20,5 @@ export declare class VerdocsFieldCheckbox {
    * If set, overrides the field's settings object. Primarily used to support "preview" modes where all fields are disabled.
    */
   disabled?: boolean;
-  /**
-   * Event fired when the input field value changes. Note that this will only be fired on blur, tab-out, ENTER key press, etc.
-   * It is generally the best event to subscribe to than `input` for most cases EXCEPT autocomplete fields that need to see every
-   * keypress.
-   */
-  fieldChange: EventEmitter<{
-    option: number;
-    value: boolean;
-  }>;
-  handleChange(e: any): void;
   render(): any;
 }

package/dist/types/components/elements/verdocs-field-date/verdocs-field-date.d.ts

@@ -31,24 +31,6 @@ export declare class VerdocsFieldDate {
    * If set, the field will be colored using this index value to select the background color.
    */
   roleindex?: number;
-  /**
-   * Event fired when the input field loses focus.
-   */
-  fieldFocus: EventEmitter<boolean>;
-  /**
-   * Event fired when the input field gains focus.
-   */
-  fieldBlur: EventEmitter<boolean>;
-  /**
-   * Event fired when the input field value changes. Note that this will only be fired on blur, tab-out, ENTER key press, etc.
-   * It is generally the best event to subscribe to than `input` for most cases EXCEPT autocomplete fields that need to see every
-   * keypress.
-   */
-  fieldChange: EventEmitter<string>;
-  /**
-   * Event fired on every character entered into / deleted from the field.
-   */
-  fieldInput: EventEmitter<string>;
   /**
    * Event fired on every character entered into / deleted from the field.
    */
@@ -59,7 +41,5 @@ export declare class VerdocsFieldDate {
   componentDidLoad(): void;
   handleBlur(): void;
   handleFocus(): void;
-  handleChange(e: any): void;
-  handleInput(e: any): void;
   render(): any;
 }

package/dist/types/components/elements/verdocs-template-create/verdocs-template-create.d.ts

@@ -1,9 +1,10 @@
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { ITemplate } from '@verdocs/js-sdk/Templates/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
-import { ITemplate, ITemplateDocument } from '@verdocs/js-sdk/Templates/Types';
 /**
  * Displays a file upload mechanism suitable for the first step of creating a template.
+ * This is typically the first step in a template creation workflow.
  */
 export declare class VerdocsTemplateCreate {
   /**
@@ -17,10 +18,7 @@ export declare class VerdocsTemplateCreate {
   /**
    * Event fired when the user changes the type.
    */
-  templateCreated: EventEmitter<{
-    template: ITemplate;
-    template_document: ITemplateDocument;
-  }>;
+  next: EventEmitter<ITemplate>;
   /**
    * Event fired if an error occurs. The event details will contain information about the error. Most errors will
    * terminate the process, and the calling application should correct the condition and re-render the component.

package/dist/types/components/elements/verdocs-template-fields/verdocs-template-fields.d.ts

@@ -1,5 +1,5 @@
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
+import { ITemplate, ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
@@ -20,7 +20,7 @@ export declare class VerdocsTemplateFields {
   /**
    * Event fired when the user completes the step.
    */
-  settingsUpdated: EventEmitter;
+  next: EventEmitter<ITemplate>;
   /**
    * Event fired when the user cancels the dialog.
    */

package/dist/types/components/elements/verdocs-template-fields/verdocs-template-fields.stories.d.ts

@@ -1,8 +1,8 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const TemplateFields: ({ templateId, cancel, save }: {
+export declare const TemplateFields: ({ templateId, onCancel, onNext }: {
   templateId: any;
-  cancel: any;
-  save: any;
+  onCancel: any;
+  onNext: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/elements/verdocs-template-properties/verdocs-template-properties.d.ts

@@ -21,7 +21,7 @@ export declare class VerdocsTemplateProperties {
   /**
    * Event fired when the user completes the step.
    */
-  settingsUpdated: EventEmitter<{
+  next: EventEmitter<{
     name: string;
     sendReminders: boolean;
     firstReminderDays: number;
@@ -39,7 +39,6 @@ export declare class VerdocsTemplateProperties {
   firstReminderDays: string;
   reminderDays: string;
   componentWillLoad(): Promise<void>;
-  handleMessageChange(e: any): void;
   handleCancel(e: any): void;
   handleSubmit(e: any): void;
   render(): any;

package/dist/types/components/elements/verdocs-template-properties/verdocs-template-properties.stories.d.ts

@@ -1,8 +1,8 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const TemplateProperties: ({ cancel, settingsUpdated, templateId }: {
-  cancel: any;
-  settingsUpdated: any;
+export declare const TemplateProperties: ({ onCancel, onNext, templateId }: {
+  onCancel: any;
+  onNext: any;
   templateId: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/elements/verdocs-template-recipients/verdocs-template-recipients.d.ts

@@ -63,13 +63,9 @@ export declare class VerdocsTemplateRecipients {
    */
   cancel: EventEmitter;
   /**
-   * Event fired when the user completes the step.
+   * Event fired when the user selects a contact.
    */
-  settingsUpdated: EventEmitter;
-  /**
-   * Event fired when the user changes the type.
-   */
-  contactSelected: EventEmitter<IContactSelectEvent>;
+  next: EventEmitter<IContactSelectEvent>;
   name: string;
   email: string;
   phone: string;

package/dist/types/components/embeds/verdocs-build/verdocs-build.d.ts

@@ -1,6 +1,6 @@
-import { EventEmitter } from '../../../stencil-public-runtime';
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
 import { ITemplate, ITemplateField } from '@verdocs/js-sdk/Templates/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
  * Display a template building experience.
@@ -23,7 +23,7 @@ export declare class VerdocsBuild {
   pdfUrl: any;
   template: ITemplate | null;
   fields: ITemplateField[];
-  componentDidLoad(): Promise<void>;
+  componentWillLoad(): Promise<void>;
   handleCancel(e: any): void;
   handleTemplateCreated(e: any): void;
   handlePropertiesUpdated(e: any): void;