@verdocs/web-sdk 2.3.88 → 4.0.6

package/dist/types/components/embeds/verdocs-sign/utils.d.ts

@@ -1,7 +1,7 @@
-import { IEnvelopeField } from '@verdocs/js-sdk/Envelopes/Types';
+import { IEnvelopeField } from '@verdocs/js-sdk';
 export declare function getInputStyle(field: IEnvelopeField, mode: any, browserType: string): {
-  height: string;
-  width: string;
-  background: string;
+    height: string;
+    width: string;
+    background: string;
 };
 export declare function getLetterSpacing(browserType: string): -0.0018 | -0.23594210526315787 | -0.0019;

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

@@ -1,6 +1,7 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { IEnvelopeField, IEnvelope, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { IEnvelope, IEnvelopeField } from '@verdocs/js-sdk';
+import { IRecipient } from '@verdocs/js-sdk';
 import { SDKError } from '../../../utils/errors';
 /**
  * Display an envelope signing experience. This will display the envelope's attached
@@ -20,83 +21,83 @@ import { SDKError } from '../../../utils/errors';
  * the signed attachments.)
  */
 export declare class VerdocsSign {
-  endpoint: VerdocsEndpoint;
-  /**
-   * The ID of the envelope to sign.
-   */
-  envelopeId: string | null;
-  /**
-   * The ID of the role that will be signing e.g. 'Recipient 1'
-   */
-  roleId: string | null;
-  /**
-   * The invite code for the signer.
-   */
-  inviteCode: string | null;
-  /**
-   * If set, (recommended), the host application should create a <DIV> element with a unique ID. When this
-   * component renders, the header will be removed from its default location and placed in the target element.
-   * This allows the parent application to more easily control its placement and scroll effects (e.g. "fixed").
-   *
-   * The movement of the header to the target container is not dynamic - it is performed only on the initial
-   * render. Host applications should not conditionally render this container. If the header's visibility must
-   * be externally controlled, use CSS display options to hide/show it instead.
-   */
-  headerTargetId: string | null;
-  /**
-   * 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>;
-  /**
-   * Event fired when the envelope is updated in any way.
-   */
-  envelopeLoaded: EventEmitter<{
-    endpoint: VerdocsEndpoint;
-    envelope: IEnvelope;
-  }>;
-  /**
-   * Event fired when the envelope is updated in any way. May be used for tasks such as cache invalidation or reporting to other systems.
-   */
-  envelopeUpdated: EventEmitter<{
     endpoint: VerdocsEndpoint;
-    envelope: IEnvelope;
-    event: string;
-  }>;
-  envelope: IEnvelope | null;
-  roleNames: string[];
-  sortedRecipients: IRecipient[];
-  recipient: IRecipient | null;
-  signerToken: any;
-  hasSignature: boolean;
-  nextButtonLabel: string;
-  nextSubmits: boolean;
-  errorMessage: string;
-  focusedField: string;
-  submitting: boolean;
-  isDone: boolean;
-  showDone: boolean;
-  showLoadError: boolean;
-  finishLater: boolean;
-  showFinishLater: boolean;
-  agreed: boolean;
-  documentsSingularPlural: string;
-  recipientIndex: number;
-  componentWillLoad(): void;
-  componentWillRender(): Promise<void>;
-  componentDidRender(): void;
-  handleClickAgree(): void;
-  handleOptionSelected(e: any): Promise<void>;
-  updateRecipientFieldValue(fieldName: string, updateResult: any): void;
-  saveFieldChange(fieldName: string, fields: Record<string, any>): void;
-  handleFieldChange(field: IEnvelopeField, e: any): Promise<void>;
-  isFieldFilled(field: IEnvelopeField): boolean;
-  isFieldValid(field: IEnvelopeField): boolean;
-  getSortedFillableFields(): IEnvelopeField[];
-  handleNext(): Promise<void>;
-  getRecipientFields(): IEnvelopeField[];
-  checkRecipientFields(): void;
-  attachFieldAttributes(pageInfo: any, field: any, el: any): void;
-  handlePageRendered(e: any): void;
-  render(): any;
+    /**
+     * The ID of the envelope to sign.
+     */
+    envelopeId: string | null;
+    /**
+     * The ID of the role that will be signing e.g. 'Recipient 1'
+     */
+    roleId: string | null;
+    /**
+     * The invite code for the signer.
+     */
+    inviteCode: string | null;
+    /**
+     * If set, (recommended), the host application should create a <DIV> element with a unique ID. When this
+     * component renders, the header will be removed from its default location and placed in the target element.
+     * This allows the parent application to more easily control its placement and scroll effects (e.g. "fixed").
+     *
+     * The movement of the header to the target container is not dynamic - it is performed only on the initial
+     * render. Host applications should not conditionally render this container. If the header's visibility must
+     * be externally controlled, use CSS display options to hide/show it instead.
+     */
+    headerTargetId: string | null;
+    /**
+     * 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>;
+    /**
+     * Event fired when the envelope is updated in any way.
+     */
+    envelopeLoaded: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        envelope: IEnvelope;
+    }>;
+    /**
+     * Event fired when the envelope is updated in any way. May be used for tasks such as cache invalidation or reporting to other systems.
+     */
+    envelopeUpdated: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        envelope: IEnvelope;
+        event: string;
+    }>;
+    envelope: IEnvelope | null;
+    roleNames: string[];
+    sortedRecipients: IRecipient[];
+    recipient: IRecipient | null;
+    signerToken: any;
+    hasSignature: boolean;
+    nextButtonLabel: string;
+    nextSubmits: boolean;
+    errorMessage: string;
+    focusedField: string;
+    submitting: boolean;
+    isDone: boolean;
+    showDone: boolean;
+    showLoadError: boolean;
+    finishLater: boolean;
+    showFinishLater: boolean;
+    agreed: boolean;
+    documentsSingularPlural: string;
+    recipientIndex: number;
+    componentWillLoad(): void;
+    componentWillRender(): Promise<void>;
+    componentDidRender(): void;
+    handleClickAgree(): void;
+    handleOptionSelected(e: any): Promise<void>;
+    updateRecipientFieldValue(fieldName: string, updateResult: any): void;
+    saveFieldChange(fieldName: string, fields: Record<string, any>): void;
+    handleFieldChange(field: IEnvelopeField, e: any): Promise<void>;
+    isFieldFilled(field: IEnvelopeField): boolean;
+    isFieldValid(field: IEnvelopeField): boolean;
+    getSortedFillableFields(): IEnvelopeField[];
+    handleNext(): Promise<void>;
+    getRecipientFields(): IEnvelopeField[];
+    checkRecipientFields(): void;
+    attachFieldAttributes(pageInfo: any, field: any, el: any): void;
+    handlePageRendered(e: any): void;
+    render(): any;
 }

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

@@ -1,67 +1,66 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IEnvelope } from '@verdocs/js-sdk/Envelopes/Types';
+import { IEnvelope, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
  * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
  */
 export declare class VerdocsView {
-  component: HTMLElement;
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored.
-   */
-  envelopeId: string;
-  /**
-   * If set, (recommended), the host application should create a <DIV> element with a unique ID. When this
-   * component renders, the header will be removed from its default location and placed in the target element.
-   * This allows the parent application to more easily control its placement and scroll effects (e.g. "fixed").
-   *
-   * The movement of the header to the target container is not dynamic - it is performed only on the initial
-   * render. Host applications should not conditionally render this container. If the header's visibility must
-   * be externally controlled, use CSS display options to hide/show it instead.
-   */
-  headerTargetId: string | null;
-  /**
-   * 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>;
-  /**
-   * Event fired when the envelope is updated in any way. May be used for tasks such as cache invalidation or reporting to other systems.
-   */
-  envelopeUpdated: EventEmitter<{
+    component: HTMLElement;
+    /**
+     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+     */
     endpoint: VerdocsEndpoint;
-    envelope: IEnvelope;
-    event: string;
-  }>;
-  /**
-   * Event fired when the user clicks Send Another to proceed. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  another: EventEmitter;
-  /**
-   * Event fired when the user clicks Send Another to proceed. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  view: EventEmitter;
-  /**
-   * Event fired when the user clicks Done to proceed. It is up to the host application
-   * to redirect the user to the appropriate next workflow step.
-   */
-  next: EventEmitter;
-  canceling: boolean;
-  envelope: IEnvelope | null;
-  roleNames: string[];
-  showCancelDone: boolean;
-  componentWillLoad(): void;
-  componentWillRender(): Promise<void>;
-  componentDidRender(): void;
-  reloadEnvelope(): Promise<void>;
-  handlePageRendered(e: any): void;
-  handleOptionSelected(e: any): Promise<void>;
-  render(): any;
+    /**
+     * The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored.
+     */
+    envelopeId: string;
+    /**
+     * If set, (recommended), the host application should create a <DIV> element with a unique ID. When this
+     * component renders, the header will be removed from its default location and placed in the target element.
+     * This allows the parent application to more easily control its placement and scroll effects (e.g. "fixed").
+     *
+     * The movement of the header to the target container is not dynamic - it is performed only on the initial
+     * render. Host applications should not conditionally render this container. If the header's visibility must
+     * be externally controlled, use CSS display options to hide/show it instead.
+     */
+    headerTargetId: string | null;
+    /**
+     * 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>;
+    /**
+     * Event fired when the envelope is updated in any way. May be used for tasks such as cache invalidation or reporting to other systems.
+     */
+    envelopeUpdated: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        envelope: IEnvelope;
+        event: string;
+    }>;
+    /**
+     * Event fired when the user clicks Send Another to proceed. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    another: EventEmitter;
+    /**
+     * Event fired when the user clicks Send Another to proceed. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    view: EventEmitter;
+    /**
+     * Event fired when the user clicks Done to proceed. It is up to the host application
+     * to redirect the user to the appropriate next workflow step.
+     */
+    next: EventEmitter;
+    canceling: boolean;
+    envelope: IEnvelope | null;
+    roleNames: string[];
+    showCancelDone: boolean;
+    componentWillLoad(): void;
+    componentWillRender(): Promise<void>;
+    componentDidRender(): void;
+    reloadEnvelope(): Promise<void>;
+    handlePageRendered(e: any): void;
+    handleOptionSelected(e: any): Promise<void>;
+    render(): any;
 }

package/dist/types/components/envelopes/verdocs-activity-box/verdocs-activity-box.d.ts

@@ -1,5 +1,4 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IActivityEntry } from '@verdocs/js-sdk/Envelopes/Types';
+import { IActivityEntry, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
@@ -8,55 +7,55 @@ import { SDKError } from '../../../utils/errors';
  * them appear more visually balanced.
  */
 export declare class VerdocsActivityBox {
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The number of items to display.
-   */
-  items: number;
-  /**
-   * The filtered view to display. "completed" will show envelopes that have been submitted. "action" will
-   * show envelopes where the user is a recipient and the envelope is not completed. "waiting" will show
-   * only envelopes where the user is the sender and the envelope is not completed.
-   */
-  view?: 'completed' | 'action' | 'waiting';
-  /**
-   * The title to display on the box ("title" is a reserved word). This is optional, and if not set, the title
-   * will be derived from the view. Set this to an empty string to hide the header.
-   */
-  header?: string | undefined;
-  /**
-   * 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>;
-  /**
-   * Event fired when the user clicks an activity entry. Typically the host application will use this to navigate
-   * to the envelope detail view.
-   */
-  viewEnvelope: EventEmitter<{
+    /**
+     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+     */
     endpoint: VerdocsEndpoint;
-    entry: IActivityEntry;
-  }>;
-  /**
-   * Event fired when the user clicks View All in the title bar. The current view will be included in the event
-   * details to help the host application navigate the user to the appropriate screen for the request. Note that
-   * the verdocs-envelopes-list control uses the same "view" parameter, so host applications can typically pass
-   * this value through directly. This button is not visible if the header is hidden.
-   */
-  viewAll: EventEmitter<{
-    endpoint: VerdocsEndpoint;
-    view: string;
-  }>;
-  title: string;
-  count: number;
-  loading: boolean;
-  entries: IActivityEntry[];
-  componentWillLoad(): Promise<void>;
-  handleItemsUpdated(): Promise<void>;
-  handleViewUpdated(): Promise<void>;
-  loadActivity(): Promise<void>;
-  render(): any;
+    /**
+     * The number of items to display.
+     */
+    items: number;
+    /**
+     * The filtered view to display. "completed" will show envelopes that have been submitted. "action" will
+     * show envelopes where the user is a recipient and the envelope is not completed. "waiting" will show
+     * only envelopes where the user is the sender and the envelope is not completed.
+     */
+    view?: 'completed' | 'action' | 'waiting';
+    /**
+     * The title to display on the box ("title" is a reserved word). This is optional, and if not set, the title
+     * will be derived from the view. Set this to an empty string to hide the header.
+     */
+    header?: string | undefined;
+    /**
+     * 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>;
+    /**
+     * Event fired when the user clicks an activity entry. Typically the host application will use this to navigate
+     * to the envelope detail view.
+     */
+    viewEnvelope: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        entry: IActivityEntry;
+    }>;
+    /**
+     * Event fired when the user clicks View All in the title bar. The current view will be included in the event
+     * details to help the host application navigate the user to the appropriate screen for the request. Note that
+     * the verdocs-envelopes-list control uses the same "view" parameter, so host applications can typically pass
+     * this value through directly. This button is not visible if the header is hidden.
+     */
+    viewAll: EventEmitter<{
+        endpoint: VerdocsEndpoint;
+        view: string;
+    }>;
+    title: string;
+    count: number;
+    loading: boolean;
+    entries: IActivityEntry[];
+    componentWillLoad(): Promise<void>;
+    handleItemsUpdated(): Promise<void>;
+    handleViewUpdated(): Promise<void>;
+    loadActivity(): Promise<void>;
+    render(): any;
 }

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

@@ -1,31 +1,30 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IRole } from '@verdocs/js-sdk/Templates/Types';
+import { IRole, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
 export interface IContactSearchEvent {
-  query: string;
+    query: string;
 }
 export interface IContactSelectEvent {
-  full_name: string;
-  email: string;
-  phone: string;
-  message: string;
-  delegator: boolean;
+    full_name: string;
+    email: string;
+    phone: string;
+    message: string;
+    delegator: boolean;
 }
 export interface IEmailContact {
-  id?: any;
-  avatar?: string;
-  name: string;
-  email: string;
-  phone?: string;
-  [key: string]: any;
+    id?: any;
+    avatar?: string;
+    name: string;
+    email: string;
+    phone?: string;
+    [key: string]: any;
 }
 export interface IPhoneContact {
-  id?: any;
-  avatar?: string;
-  name: string;
-  email?: string;
-  phone: string;
-  [key: string]: any;
+    id?: any;
+    avatar?: string;
+    name: string;
+    email?: string;
+    phone: string;
+    [key: string]: any;
 }
 /**
  * Displays a contact picker suitable for filling out Recipient objects when sending Documents.
@@ -37,49 +36,49 @@ export interface IPhoneContact {
  * to always display the user's own contact record.
  */
 export declare class VerdocsContactPicker {
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
-  endpoint: VerdocsEndpoint;
-  /**
-   * The role that this contact will be assigned to.
-   */
-  templateRole: IRole | null;
-  /**
-   * If set, suggestions will be displayed in a drop-down list to the user. It is recommended that the number
-   * of suggestions be limited to the 5 best matching records.
-   */
-  contactSuggestions: (IEmailContact | IPhoneContact)[];
-  /**
-   * Event fired when the user enters text in the search field. The calling application may use this to update
-   * the `contactSuggestions` property.
-   */
-  searchContacts: EventEmitter<IContactSearchEvent>;
-  /**
-   * Event fired when the step is cancelled. This is called exit to avoid conflicts with the JS-reserved "cancel" event name.
-   */
-  exit: EventEmitter;
-  /**
-   * Event fired when the user changes the type.
-   */
-  next: EventEmitter<IContactSelectEvent>;
-  name: string;
-  email: string;
-  phone: string;
-  message: string;
-  showSuggestions: boolean;
-  showMessage: boolean;
-  delegator: boolean;
-  nameFieldId: string;
-  emailFieldId: string;
-  phoneFieldId: string;
-  componentWillLoad(): void;
-  handleNameChange(e: any): void;
-  handleEmailChange(e: any): void;
-  handlePhoneChange(e: any): void;
-  handleMessageChange(e: any): void;
-  handleCancel(e: any): void;
-  handleSubmit(e: any): void;
-  handleSelectSuggestion(e: any, suggestion: IEmailContact | IPhoneContact): void;
-  render(): any;
+    /**
+     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+     */
+    endpoint: VerdocsEndpoint;
+    /**
+     * The role that this contact will be assigned to.
+     */
+    templateRole: IRole | null;
+    /**
+     * If set, suggestions will be displayed in a drop-down list to the user. It is recommended that the number
+     * of suggestions be limited to the 5 best matching records.
+     */
+    contactSuggestions: (IEmailContact | IPhoneContact)[];
+    /**
+     * Event fired when the user enters text in the search field. The calling application may use this to update
+     * the `contactSuggestions` property.
+     */
+    searchContacts: EventEmitter<IContactSearchEvent>;
+    /**
+     * Event fired when the step is cancelled. This is called exit to avoid conflicts with the JS-reserved "cancel" event name.
+     */
+    exit: EventEmitter;
+    /**
+     * Event fired when the user changes the type.
+     */
+    next: EventEmitter<IContactSelectEvent>;
+    name: string;
+    email: string;
+    phone: string;
+    message: string;
+    showSuggestions: boolean;
+    showMessage: boolean;
+    delegator: boolean;
+    nameFieldId: string;
+    emailFieldId: string;
+    phoneFieldId: string;
+    componentWillLoad(): void;
+    handleNameChange(e: any): void;
+    handleEmailChange(e: any): void;
+    handlePhoneChange(e: any): void;
+    handleMessageChange(e: any): void;
+    handleCancel(e: any): void;
+    handleSubmit(e: any): void;
+    handleSelectSuggestion(e: any, suggestion: IEmailContact | IPhoneContact): void;
+    render(): any;
 }