@verdocs/web-sdk 6.12.1 → 6.13.0

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

@@ -1,8 +1,23 @@
+import type { IBrand, IOrganization } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
+import type { ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeRecipientFromTemplate, IEnvelope, IRecipient, ITemplate } from '@verdocs/js-sdk';
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import type { ICreateEnvelopeRecipientFromTemplate, IEnvelope, IRecipient, ITemplate } from '@verdocs/js-sdk';
 import { IContactSearchEvent } from '../../envelopes/verdocs-contact-picker/verdocs-contact-picker';
 import { SDKError } from '../../../utils/errors';
+type TSendView = 'main' | 'recipient' | 'brand' | 'expires' | 'notifications';
+export interface ISendEventDetail extends ICreateEnvelopeFromTemplateRequest {
+    name: string;
+    template_id: string;
+    recipients: ICreateEnvelopeRecipientFromTemplate[];
+    template: ITemplate;
+}
+export interface ISentEventDetail extends ICreateEnvelopeFromTemplateRequest {
+    name: string;
+    template_id: string;
+    recipients: ICreateEnvelopeRecipientFromTemplate[];
+    envelope_id: string;
+    envelope: IEnvelope;
+}
 /**
  * Display a form to send a template to one or more recipients in an envelope for signing.
  * Host applications should ensure the template is "sendable" before displaying this component.
@@ -22,6 +37,7 @@ import { SDKError } from '../../../utils/errors';
  */
 export declare class VerdocsSend {
     private templateListenerId;
+    el: HTMLElement;
     /**
      * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
      */
@@ -42,25 +58,18 @@ export declare class VerdocsSend {
      * the embed is shown in a non-wizard flow with its own navigation for the user to exit.
      */
     showCancel: boolean;
+    /**
+     * Preselect a brand by key, overriding the organization default.
+     */
+    brandKey: string;
     /**
      * The user is sending an envelope the form and clicked send.
      */
-    beforeSend: EventEmitter<{
-        recipients: ICreateEnvelopeRecipientFromTemplate[];
-        name: string;
-        template_id: string;
-        template: ITemplate;
-    }>;
+    beforeSend: EventEmitter<ISendEventDetail>;
     /**
      * The user completed the form and clicked send.
      */
-    send: EventEmitter<{
-        recipients: ICreateEnvelopeRecipientFromTemplate[];
-        name: string;
-        template_id: string;
-        envelope_id: string;
-        envelope: IEnvelope;
-    }>;
+    send: EventEmitter<ISentEventDetail>;
     /**
      * Event fired when the step is cancelled. This is called exit to avoid conflicts with the JS-reserved "cancel" event name.
      */
@@ -75,15 +84,35 @@ export declare class VerdocsSend {
      * the `contactSuggestions` property.
      */
     searchContacts: EventEmitter<IContactSearchEvent>;
+    private swipeStart;
+    private swallowNextClick;
+    private loadedOrganizationId;
     containerId: string;
-    showPickerForId: string;
-    sessionContacts: any[];
+    view: TSendView;
+    editingRoleId: string;
+    sessionContacts: {
+        id: string;
+        first_name: string;
+        last_name: string;
+        email: string;
+        phone: string;
+    }[];
     sending: boolean;
+    brands: IBrand[];
+    organization: IOrganization | null;
+    expiresInDays: string;
+    noContact: boolean;
     rolesCompleted: Record<string, Partial<IRecipient>>;
     loading: boolean;
     template: ITemplate | null;
     disconnectedCallback(): void;
+    componentDidLoad(): void;
+    componentDidRender(): void;
     listenToTemplate(): Promise<void>;
+    loadBrands(): void;
+    handleExpiryInput(e: any): void;
+    effectiveExpiryDays(): number;
+    expiresAt(): Date;
     unlistenToTemplate(): void;
     reset(): Promise<void>;
     onTemplateIdChanged(newTemplateId: string): void;
@@ -91,10 +120,28 @@ export declare class VerdocsSend {
     recomputeRolesCompleted(): void;
     getSequenceNumbers(): number[];
     getRolesAtLevel(level: number): Partial<IRecipient>[];
-    getLevelIcon(level: 'start' | 'end' | 'sequence'): any;
+    getRoleById(id: string): Partial<IRecipient> | null;
+    getRecipientOptionLabels(recipient: Partial<IRecipient> | undefined): string[];
+    getDefaultBrand(): IBrand | null;
+    getDefaultBrandLabel(): string;
+    getSelectedBrandLabel(): string;
+    showView(view: TSendView): void;
     handleSelectContact(e: any, role: Partial<IRecipient>): void;
     handleClickRole(e: any, role: Partial<IRecipient>): void;
     handleSend(e: any): void;
     handleCancel(e: any): void;
+    handleSwipeStart(e: PointerEvent): void;
+    handleSwipeEnd(e: PointerEvent): void;
+    renderDetailHeader(title: any): any;
+    renderDetailBody(content: any): any;
+    renderDoneButton(): any;
+    renderRecipientView(): any;
+    renderBrandSwatch(brand: IBrand | null, fallbackInitial: string): any;
+    renderBrandOption(key: string, label: string, sub: string, swatch: any): any;
+    renderBrandView(): any;
+    renderExpiresView(): any;
+    renderNotificationsView(): any;
+    renderDetail(): any;
     render(): any;
 }
+export {};

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

@@ -1,5 +1,6 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { IEntitlement, IProfile, IRecipient, TEntitlement, TRecipientAuthMethod, VerdocsEndpoint } from '@verdocs/js-sdk';
+type TSigningOption = 'none' | 'delegator' | 'name_locked';
 export interface IContactSearchEvent {
     query: string;
 }
@@ -35,6 +36,9 @@ export type TPickerContact = Partial<IProfile>;
  * ```
  */
 export declare class VerdocsContactPicker {
+    el: HTMLElement;
+    private namesRowEl;
+    private suggestionsEl;
     /**
      * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
      */
@@ -48,6 +52,10 @@ export declare class VerdocsContactPicker {
      * of suggestions be limited to the 5 best matching records.
      */
     contactSuggestions: TPickerContact[];
+    /**
+     * Whether to show a Cancel button beside Done.
+     */
+    showCancel: boolean;
     /**
      * Event fired when the user enters text in the search field. The calling application may use this to update
      * the `contactSuggestions` property.
@@ -81,10 +89,19 @@ export declare class VerdocsContactPicker {
     activeEntitlements: Partial<Record<TEntitlement, IEntitlement>>;
     authMethodsLoading: boolean;
     componentWillLoad(): Promise<void>;
+    componentDidRender(): void;
+    handleDocumentClick(e: MouseEvent): void;
     handleFirstNameChange(e: any): void;
     handleLastNameChange(e: any): void;
     handleCancel(e: any): void;
     handleSubmit(e: any): void;
     handleSelectSuggestion(e: any, suggestion: TPickerContact): void;
+    toggleAuthMethod(method: TRecipientAuthMethod): void;
+    setSigningOption(option: TSigningOption): void;
+    renderPill(label: string, selected: boolean, onClick: () => void, opts?: {
+        locked?: boolean;
+        title?: string;
+    }): any;
     render(): any;
 }
+export {};

package/dist/types/components.d.ts

@@ -16,6 +16,7 @@ import { ISelectedFile } from "./components/fields/verdocs-field-attachment/verd
 import { IMultiSelectOption } from "./components/controls/verdocs-multiselect/verdocs-multiselect";
 import { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
 import { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
+import { ISendEventDetail, ISentEventDetail } from "./components/embeds/verdocs-send/verdocs-send";
 import { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
 import { IColumn } from "./components/controls/verdocs-table/verdocs-table";
 import { ITab } from "./components/controls/verdocs-tabs/verdocs-tabs";
@@ -34,6 +35,7 @@ export { ISelectedFile } from "./components/fields/verdocs-field-attachment/verd
 export { IMultiSelectOption } from "./components/controls/verdocs-multiselect/verdocs-multiselect";
 export { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
 export { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
+export { ISendEventDetail, ISentEventDetail } from "./components/embeds/verdocs-send/verdocs-send";
 export { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
 export { IColumn } from "./components/controls/verdocs-table/verdocs-table";
 export { ITab } from "./components/controls/verdocs-tabs/verdocs-tabs";
@@ -284,6 +286,11 @@ export namespace Components {
           * @default VerdocsEndpoint.getDefault()
          */
         "endpoint": VerdocsEndpoint;
+        /**
+          * Whether to show a Cancel button beside Done.
+          * @default true
+         */
+        "showCancel": boolean;
         /**
           * The role that this contact will be assigned to.
           * @default null
@@ -1902,6 +1909,11 @@ export namespace Components {
      * ```
      */
     interface VerdocsSend {
+        /**
+          * Preselect a brand by key, overriding the organization default.
+          * @default ''
+         */
+        "brandKey": string;
         /**
           * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
           * @default DefaultEndpoint
@@ -4042,8 +4054,8 @@ declare global {
         new (): HTMLVerdocsSelectInputElement;
     };
     interface HTMLVerdocsSendElementEventMap {
-        "beforeSend": {recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; template: ITemplate};
-        "send": {recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; envelope_id: string; envelope: IEnvelope};
+        "beforeSend": ISendEventDetail;
+        "send": ISentEventDetail;
         "exit": any;
         "sdkError": SDKError;
         "searchContacts": IContactSearchEvent1;
@@ -5064,6 +5076,11 @@ declare namespace LocalJSX {
           * Event fired when the user enters text in the search field. The calling application may use this to update the `contactSuggestions` property.
          */
         "onSearchContacts"?: (event: VerdocsContactPickerCustomEvent<IContactSearchEvent>) => void;
+        /**
+          * Whether to show a Cancel button beside Done.
+          * @default true
+         */
+        "showCancel"?: boolean;
         /**
           * The role that this contact will be assigned to.
           * @default null
@@ -6987,6 +7004,11 @@ declare namespace LocalJSX {
      * ```
      */
     interface VerdocsSend {
+        /**
+          * Preselect a brand by key, overriding the organization default.
+          * @default ''
+         */
+        "brandKey"?: string;
         /**
           * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
           * @default DefaultEndpoint
@@ -7000,7 +7022,7 @@ declare namespace LocalJSX {
         /**
           * The user is sending an envelope the form and clicked send.
          */
-        "onBeforeSend"?: (event: VerdocsSendCustomEvent<{recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; template: ITemplate}>) => void;
+        "onBeforeSend"?: (event: VerdocsSendCustomEvent<ISendEventDetail>) => void;
         /**
           * Event fired when the step is cancelled. This is called exit to avoid conflicts with the JS-reserved "cancel" event name.
          */
@@ -7016,7 +7038,7 @@ declare namespace LocalJSX {
         /**
           * The user completed the form and clicked send.
          */
-        "onSend"?: (event: VerdocsSendCustomEvent<{recipients: ICreateEnvelopeRecipientFromTemplate[]; name: string; template_id: string; envelope_id: string; envelope: IEnvelope}>) => void;
+        "onSend"?: (event: VerdocsSendCustomEvent<ISentEventDetail>) => void;
         /**
           * Whether to show the cancel button. It may be useful to disable this in environments where the embed is shown in a non-wizard flow with its own navigation for the user to exit.
           * @default true
@@ -8005,6 +8027,9 @@ declare namespace LocalJSX {
     interface VerdocsComponentErrorAttributes {
         "message": string;
     }
+    interface VerdocsContactPickerAttributes {
+        "showCancel": boolean;
+    }
     interface VerdocsDateInputAttributes {
         "value": string;
         "label": string;
@@ -8304,6 +8329,7 @@ declare namespace LocalJSX {
         "templateId": string | null;
         "environment": string;
         "showCancel": boolean;
+        "brandKey": string;
     }
     interface VerdocsSignAttributes {
         "envelopeId": string | null;
@@ -8432,7 +8458,7 @@ declare namespace LocalJSX {
         "verdocs-button-panel": Omit<VerdocsButtonPanel, keyof VerdocsButtonPanelAttributes> & { [K in keyof VerdocsButtonPanel & keyof VerdocsButtonPanelAttributes]?: VerdocsButtonPanel[K] } & { [K in keyof VerdocsButtonPanel & keyof VerdocsButtonPanelAttributes as `attr:${K}`]?: VerdocsButtonPanelAttributes[K] } & { [K in keyof VerdocsButtonPanel & keyof VerdocsButtonPanelAttributes as `prop:${K}`]?: VerdocsButtonPanel[K] };
         "verdocs-checkbox": Omit<VerdocsCheckbox, keyof VerdocsCheckboxAttributes> & { [K in keyof VerdocsCheckbox & keyof VerdocsCheckboxAttributes]?: VerdocsCheckbox[K] } & { [K in keyof VerdocsCheckbox & keyof VerdocsCheckboxAttributes as `attr:${K}`]?: VerdocsCheckboxAttributes[K] } & { [K in keyof VerdocsCheckbox & keyof VerdocsCheckboxAttributes as `prop:${K}`]?: VerdocsCheckbox[K] };
         "verdocs-component-error": Omit<VerdocsComponentError, keyof VerdocsComponentErrorAttributes> & { [K in keyof VerdocsComponentError & keyof VerdocsComponentErrorAttributes]?: VerdocsComponentError[K] } & { [K in keyof VerdocsComponentError & keyof VerdocsComponentErrorAttributes as `attr:${K}`]?: VerdocsComponentErrorAttributes[K] } & { [K in keyof VerdocsComponentError & keyof VerdocsComponentErrorAttributes as `prop:${K}`]?: VerdocsComponentError[K] };
-        "verdocs-contact-picker": VerdocsContactPicker;
+        "verdocs-contact-picker": Omit<VerdocsContactPicker, keyof VerdocsContactPickerAttributes> & { [K in keyof VerdocsContactPicker & keyof VerdocsContactPickerAttributes]?: VerdocsContactPicker[K] } & { [K in keyof VerdocsContactPicker & keyof VerdocsContactPickerAttributes as `attr:${K}`]?: VerdocsContactPickerAttributes[K] } & { [K in keyof VerdocsContactPicker & keyof VerdocsContactPickerAttributes as `prop:${K}`]?: VerdocsContactPicker[K] };
         "verdocs-date-input": Omit<VerdocsDateInput, keyof VerdocsDateInputAttributes> & { [K in keyof VerdocsDateInput & keyof VerdocsDateInputAttributes]?: VerdocsDateInput[K] } & { [K in keyof VerdocsDateInput & keyof VerdocsDateInputAttributes as `attr:${K}`]?: VerdocsDateInputAttributes[K] } & { [K in keyof VerdocsDateInput & keyof VerdocsDateInputAttributes as `prop:${K}`]?: VerdocsDateInput[K] };
         "verdocs-delegate-dialog": VerdocsDelegateDialog;
         "verdocs-dialog": Omit<VerdocsDialog, keyof VerdocsDialogAttributes> & { [K in keyof VerdocsDialog & keyof VerdocsDialogAttributes]?: VerdocsDialog[K] } & { [K in keyof VerdocsDialog & keyof VerdocsDialogAttributes as `attr:${K}`]?: VerdocsDialogAttributes[K] } & { [K in keyof VerdocsDialog & keyof VerdocsDialogAttributes as `prop:${K}`]?: VerdocsDialog[K] };

package/dist/types/utils/Environment.d.ts

@@ -3,3 +3,4 @@ export declare const BETA_ORIGINS: string[];
 export declare const IS_BETA: boolean;
 export declare const API_URL: string;
 export declare const DefaultEndpoint: VerdocsEndpoint;
+export declare const getWebAppUrl: (endpoint?: VerdocsEndpoint) => "https://beta.verdocs.com" | "https://app.verdocs.com";

package/dist/types/utils/ScrollFade.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Toggle `scrollable` and `at-end` on the wrapper of a scrolling body so a CSS fade can show
+ * only while there is more content below the fold.
+ */
+export declare function updateScrollFade(body: HTMLElement | null | undefined): void;