@verdocs/web-sdk 1.10.1 → 1.10.4

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

@@ -1,3 +1,4 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 /**
@@ -24,5 +25,22 @@ export declare class VerdocsFieldCheckbox {
    * If set, the field will be colored using this index value to select the background color.
    */
   roleindex?: number;
+  /**
+   * If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be
+   * changed, so it should typically only be enabled in the Builder.
+   */
+  editable?: boolean;
+  /**
+   * If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields.
+   */
+  moveable?: boolean;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

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

@@ -35,8 +35,16 @@ export declare class VerdocsFieldDate {
    * Event fired on every character entered into / deleted from the field.
    */
   settingsPress: EventEmitter;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
   containerId: string;
   focusField(): Promise<void>;
   componentDidLoad(): void;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.d.ts

@@ -25,7 +25,15 @@ export declare class VerdocsFieldDropdown {
    * keypress.
    */
   fieldChange: EventEmitter<string>;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
   focusField(): Promise<void>;
   handleChange(e: any): void;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-initial/verdocs-field-initial.d.ts

@@ -49,6 +49,12 @@ export declare class VerdocsFieldInitial {
    * keypress.
    */
   fieldChange: EventEmitter<string>;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
   /**
    * Event fired on every character entered into / deleted from the field.
    */
@@ -59,5 +65,7 @@ export declare class VerdocsFieldInitial {
   hideDialog(): void;
   handleAdopt(e: any): void;
   handleShow(): void;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-payment/verdocs-field-payment.d.ts

@@ -57,6 +57,14 @@ export declare class VerdocsFieldPayment {
   fontSize: number;
   averageFontWidth: number;
   requiredFields: any[];
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
   componentWillLoad(): void;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-radio-button-group/verdocs-field-radio-button.d.ts

@@ -1,3 +1,4 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 /**
@@ -24,5 +25,22 @@ export declare class VerdocsFieldRadioButton {
    * If set, the field will be colored using this index value to select the background color.
    */
   roleindex?: number;
+  /**
+   * If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be
+   * changed, so it should typically only be enabled in the Builder.
+   */
+  editable?: boolean;
+  /**
+   * If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields.
+   */
+  moveable?: boolean;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-signature/verdocs-field-signature.d.ts

@@ -43,11 +43,19 @@ export declare class VerdocsFieldSignature {
    * Event fired on every character entered into / deleted from the field.
    */
   settingsPress: EventEmitter;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
   focusField(): Promise<void>;
   tempSignature: string;
   private dialog?;
   hideDialog(): void;
   handleAdopt(e: any): void;
   handleShow(): void;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-textarea/verdocs-field-textarea.d.ts

@@ -1,3 +1,4 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 /**
@@ -31,5 +32,13 @@ export declare class VerdocsFieldTextarea {
    */
   roleindex?: number;
   focusField(): Promise<void>;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-textbox/verdocs-field-textbox.d.ts

@@ -32,10 +32,13 @@ export declare class VerdocsFieldTextbox {
    */
   roleindex?: number;
   /**
-   * Event fired if the field is configurable when the recipient has changed.
+   * Event fired when the field's settings are changed.
    */
-  recipientChanged: EventEmitter<string>;
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
   focusField(): Promise<void>;
-  handleChangeRecipient(e: any): void;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.d.ts

@@ -1,5 +1,6 @@
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
 /**
  * Display a timestamp field.
  */
@@ -30,6 +31,14 @@ export declare class VerdocsFieldTimestamp {
    * If set, the field will be colored using this index value to select the background color.
    */
   roleindex?: number;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
   focusField(): Promise<void>;
+  showSettingsPanel(): Promise<void>;
+  hideSettingsPanel(): Promise<void>;
   render(): any;
 }

package/dist/types/components/templates/verdocs-template-attachments/verdocs-template-attachments.d.ts

@@ -0,0 +1,29 @@
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { SDKError } from '../../../utils/errors';
+/**
+ * Displays an edit form that allows the user to view, add, or remove a template's attachments.
+ * Note that an active session and valid template ID must be supplied.
+ */
+export declare class VerdocsTemplateAttachments {
+  /**
+   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+   */
+  endpoint: VerdocsEndpoint;
+  /**
+   * The template ID to edit.
+   */
+  templateId: string;
+  /**
+   * Event fired when the user cancels the dialog.
+   */
+  close: EventEmitter;
+  /**
+   * 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.
+   */
+  sdkError: EventEmitter<SDKError>;
+  loading: boolean;
+  componentWillLoad(): Promise<void>;
+  render(): any;
+}

package/dist/types/components/templates/verdocs-template-attachments/verdocs-template-attachments.stories.d.ts

@@ -0,0 +1,7 @@
+import { Meta } from '@storybook/web-components';
+declare const _default: Meta<import("@storybook/web-components").Args>;
+export default _default;
+export declare const Attachments: ({ onClose, templateId }: {
+  onClose: any;
+  templateId: any;
+}) => import("lit-html").TemplateResult<1>;

package/dist/types/components/templates/verdocs-template-create/verdocs-template-create.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 TemplateCreate: ({ templateRole, contactSuggestions, searchContacts, cancel, contactSelected }: {
+export declare const Create: ({ templateRole, contactSuggestions, searchContacts, cancel, contactSelected }: {
   templateRole: any;
   contactSuggestions: any;
   searchContacts: any;

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

@@ -0,0 +1,58 @@
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { TDocumentFieldType } from '@verdocs/js-sdk/Envelopes/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { SDKError } from '../../../utils/errors';
+/**
+ * Displays an edit form that allows the user to adjust a field's settings.
+ */
+export declare class VerdocsTemplateFieldProperties {
+  el: any;
+  /**
+   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+   */
+  endpoint: VerdocsEndpoint;
+  /**
+   * The template ID to edit.
+   */
+  templateId: string;
+  /**
+   * The field to configure.
+   */
+  fieldName: string;
+  /**
+   * Event fired when the user cancels the dialog.
+   */
+  close: EventEmitter;
+  /**
+   * Event fired when the user deletes the role. The parent should update its UI to reflect the removal. When this event is emitted,
+   * the role will have already been deleted server-side.
+   */
+  delete: EventEmitter<{
+    templateId: string;
+    roleName: string;
+  }>;
+  /**
+   * Event fired when the field's settings are changed.
+   */
+  settingsChanged: EventEmitter<{
+    fieldName: string;
+  }>;
+  /**
+   * 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.
+   */
+  sdkError: EventEmitter<SDKError>;
+  dirty: boolean;
+  loading: boolean;
+  type: TDocumentFieldType;
+  name: string;
+  roleName: string;
+  required: boolean;
+  placeholder: string;
+  defaultValue: string;
+  componentWillLoad(): Promise<void>;
+  handleCancel(e: any): void;
+  handleSave(e: any): void;
+  handleDelete(e: any): Promise<void>;
+  render(): any;
+}

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

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

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

@@ -3,6 +3,7 @@ import { IPage, ITemplate, ITemplateField } from '@verdocs/js-sdk/Templates/Type
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { IDocumentPageInfo } from '../../../utils/Types';
 import { SDKError } from '../../../utils/errors';
+import { TDocumentFieldType } from '@verdocs/js-sdk/Envelopes/Types';
 /**
  * Displays a builder experience for laying out fields in a template. Note that this experience requires a large display area to
  * present all of the required controls, so it is primarily intended to be used in desktop environments.
@@ -29,7 +30,7 @@ export declare class VerdocsTemplateFields {
    * terminate the process, and the calling application should correct the condition and re-render the component.
    */
   sdkError: EventEmitter<SDKError>;
-  placing: any;
+  placing: TDocumentFieldType | null;
   selectedRoleName: string;
   pageHeights: Record<number, number>;
   componentWillLoad(): Promise<void>;

package/dist/types/components/templates/verdocs-template-fields/verdocs-template-fields.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 TemplateFields: ({ templateId, onCancel, onNext }: {
+export declare const Fields: ({ templateId, onCancel, onNext }: {
   templateId: any;
   onCancel: any;
   onNext: any;

package/dist/types/components/templates/verdocs-template-name/verdocs-template-name.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 TemplateName: ({ onClose, templateId }: {
+export declare const Name: ({ onClose, templateId }: {
   onClose: any;
   templateId: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/templates/verdocs-template-properties/verdocs-template-properties.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 TemplateProperties: ({ onCancel, onNext, templateId }: {
+export declare const Properties: ({ onCancel, onNext, templateId }: {
   onCancel: any;
   onNext: any;
   templateId: any;

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

@@ -1,20 +1,11 @@
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IRole } from '@verdocs/js-sdk/Templates/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
-declare type TAnnotatedRole = IRole & {
-  order: number;
-};
 /**
- * Displays a contact picker suitable for filling out Recipient objects when sending Documents.
- *
- * This picker can also be integrated with a backend to provide contact list / suggestion / address-book style behavior. As the
- * user interacts with the component, the text entered in the name field is sent back to the parent via the `searchContacts` event.
- * The parent can use that text as a query string to call a backend to obtain appropriate contacts to show. This list may also be
- * hard-coded ahead of time to provide the user with smart suggestions on initial display, such as "Recently Used" contacts, or
- * to always display the user's own contact record.
+ * Displays an edit form that allows the user to adjust a template's recipients and workflow.
  */
 export declare class VerdocsTemplateRecipients {
+  el: HTMLElement;
   /**
    * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
    */
@@ -28,20 +19,22 @@ export declare class VerdocsTemplateRecipients {
    */
   cancel: EventEmitter;
   sequences: number[];
-  rolesAtSequence: Record<number, TAnnotatedRole[]>;
   /**
    * 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.
    */
   sdkError: EventEmitter<SDKError>;
+  showingRoleDialog: string | null;
   showingSenderDialog: boolean;
   sender: any;
-  orderedRoles: TAnnotatedRole[];
+  forceRerender: number;
   componentWillLoad(): Promise<void>;
   componentDidRender(): void;
-  computeRolesBySequence(): void;
   handleCancel(e: any): void;
   handleSubmit(e: any): void;
+  sortTemplateRoles(): void;
+  extractSequenceNumbers(): void;
+  renumberTemplateRoles(): void;
+  handleAddRole(e: any, sequence: number): void;
   render(): any;
 }
-export {};

package/dist/types/components/templates/verdocs-template-recipients/verdocs-template-recipients.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 TemplateRecipients: ({ templateId, cancel }: {
+export declare const Recipients: ({ templateId, cancel }: {
   templateId: any;
   cancel: any;
 }) => import("lit-html").TemplateResult<1>;

package/dist/types/components/templates/verdocs-template-reminders/verdocs-template-reminders.d.ts

@@ -2,7 +2,7 @@ import { VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
- * Displays a collection of settings boxes that allow a user to configure a template's behavior.
+ * Displays an edit form that allows the user to adjust a template's reminders.
  */
 export declare class VerdocsTemplateReminders {
   /**

package/dist/types/components/templates/verdocs-template-reminders/verdocs-template-reminders.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 TemplateReminders: ({ onClose, templateId }: {
+export declare const Reminders: ({ onClose, templateId }: {
   onClose: any;
   templateId: any;
 }) => import("lit-html").TemplateResult<1>;

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

@@ -0,0 +1,56 @@
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { TRecipientType } from '@verdocs/js-sdk/Envelopes/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { TTemplateSender } from '@verdocs/js-sdk/Templates/Types';
+import { SDKError } from '../../../utils/errors';
+/**
+ * Display an edit form that allows the user to adjust a role's setitngs.
+ */
+export declare class VerdocsTemplateRoleProperties {
+  /**
+   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+   */
+  endpoint: VerdocsEndpoint;
+  /**
+   * The template ID to edit.
+   */
+  templateId: string;
+  /**
+   * The role name to edit.
+   */
+  roleName: string;
+  /**
+   * Event fired when the user cancels the dialog.
+   */
+  close: EventEmitter;
+  /**
+   * Event fired when the user deletes the role. The parent should update its UI to reflect the removal. When this event is emitted,
+   * the role will have already been deleted server-side.
+   */
+  delete: EventEmitter<{
+    templateId: string;
+    roleName: string;
+  }>;
+  /**
+   * 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.
+   */
+  sdkError: EventEmitter<SDKError>;
+  /**
+   * Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.
+   */
+  sender: TTemplateSender;
+  dirty: boolean;
+  saving: boolean;
+  name: string;
+  type: TRecipientType;
+  fullName: string;
+  email: string;
+  phone: string;
+  allowDelegation: boolean;
+  componentWillLoad(): Promise<void>;
+  handleCancel(e: any): void;
+  handleSave(e: any): Promise<void>;
+  handleDelete(e: any): Promise<void>;
+  render(): any;
+}

package/dist/types/components/{dialogs/verdocs-template-sender-dialog/verdocs-template-sender-dialog.stories.d.ts → templates/verdocs-template-role-properties/verdocs-template-role-properties.stories.d.ts}

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

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

@@ -0,0 +1,36 @@
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { TemplateSenderTypes, TTemplateSender } from '@verdocs/js-sdk/Templates/Types';
+import { SDKError } from '../../../utils/errors';
+/**
+ * Display a dialog that allows a template sender to be selected.
+ */
+export declare class VerdocsTemplateSender {
+  /**
+   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+   */
+  endpoint: VerdocsEndpoint;
+  /**
+   * The template ID to edit.
+   */
+  templateId: string;
+  /**
+   * Event fired when the user cancels the dialog.
+   */
+  close: EventEmitter;
+  /**
+   * 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.
+   */
+  sdkError: EventEmitter<SDKError>;
+  /**
+   * Whether the dialog is currently being displayed. This allows it to be added to the DOM before being displayed.
+   */
+  sender: TTemplateSender;
+  saving: boolean;
+  componentWillLoad(): Promise<void>;
+  handleClose(): void;
+  handleDismiss(e: any): void;
+  handleSelectSetting(value: TemplateSenderTypes): Promise<void>;
+  render(): any;
+}

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

@@ -0,0 +1,7 @@
+import { Meta } from '@storybook/web-components';
+declare const _default: Meta<import("@storybook/web-components").Args>;
+export default _default;
+export declare const Sender: ({ value, onClose }: {
+  value: any;
+  onClose: any;
+}) => import("lit-html").TemplateResult<1>;

package/dist/types/components/templates/verdocs-template-visibillity/verdocs-template-visibility.d.ts

@@ -2,7 +2,7 @@ import { VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
- * Displays a collection of settings boxes that allow a user to configure a template's behavior.
+ * Displays an edit form that allows the user to adjust a template's visibility.
  */
 export declare class VerdocsTemplateVisibility {
   /**

package/dist/types/components/templates/verdocs-template-visibillity/verdocs-template-visibility.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 TemplateVisibility: ({ onClose, templateId }: {
+export declare const Visibility: ({ onClose, templateId }: {
   onClose: any;
   templateId: any;
 }) => import("lit-html").TemplateResult<1>;