@verdocs/web-sdk 4.2.158 → 5.0.0

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

@@ -1,8 +1,6 @@
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
 import { ITemplateField } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { TTemplateRoleStore } from '../../../utils/TemplateRoleStore';
-import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
 /**
  * Display a multi-line text input field. Reminder: the "position" of the field is specified
  * as the BOTTOM-LEFT corner.
@@ -17,9 +15,13 @@ export declare class VerdocsFieldTextarea {
      */
     endpoint: VerdocsEndpoint;
     /**
-     * The template the field is for/from. Only required in Builder mode, to support the Field Properties dialog.
+     * Fields may be attached to templates or envelopes, but only template fields may be edited.
      */
-    templateid: string;
+    source: 'template' | 'envelope';
+    /**
+     * The source template or envelope ID the field is found in.
+     */
+    sourceid: string;
     /**
      * The name of the field to display.
      */
@@ -71,9 +73,6 @@ export declare class VerdocsFieldTextarea {
     showSettingsPanel(): Promise<void>;
     hideSettingsPanel(): Promise<void>;
     focused?: boolean;
-    fieldStore: TTemplateFieldStore;
-    roleStore: TTemplateRoleStore;
-    componentWillLoad(): Promise<void>;
     componentDidRender(): void;
     handleResizeStart(e: any): void;
     handleResize(e: any): void;

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

@@ -1,7 +1,5 @@
-import { ITemplateField, VerdocsEndpoint } from '@verdocs/js-sdk';
+import { ITemplateField } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
-import { TTemplateRoleStore } from '../../../utils/TemplateRoleStore';
 /**
  * Display a simple 1-line text input field.
  */
@@ -9,15 +7,13 @@ export declare class VerdocsFieldTextbox {
     el: HTMLElement;
     private inputEl;
     /**
-     * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-     * This component self-manages its resize (width) behavior when in edit-template mode, and uses
-     * this endpoint to save changes.
+     * Fields may be attached to templates or envelopes, but only template fields may be edited.
      */
-    endpoint: VerdocsEndpoint;
+    source: 'template' | 'envelope';
     /**
-     * The template the field is for/from. Only required in Builder mode, to support the Field Properties dialog.
+     * The source template or envelope ID the field is found in.
      */
-    templateid: string;
+    sourceid: string;
     /**
      * The name of the field to display.
      */
@@ -73,9 +69,6 @@ export declare class VerdocsFieldTextbox {
     focusField(): Promise<void>;
     showSettingsPanel(): Promise<void>;
     hideSettingsPanel(): Promise<void>;
-    fieldStore: TTemplateFieldStore;
-    roleStore: TTemplateRoleStore;
-    componentWillLoad(): Promise<void>;
     componentDidRender(): void;
     handleResizeStart(e: any): void;
     handleResize(e: any): void;

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

@@ -1,7 +1,5 @@
 import { ITemplateField } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { TTemplateRoleStore } from '../../../utils/TemplateRoleStore';
-import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
 /**
  * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
  * filled when the signer submits the document.
@@ -9,9 +7,13 @@ import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
 export declare class VerdocsFieldTimestamp {
     private el;
     /**
-     * The template the field is for/from. Only required in Builder mode, to support the Field Properties dialog.
+     * Fields may be attached to templates or envelopes, but only template fields may be edited.
      */
-    templateid: string;
+    source: 'template' | 'envelope';
+    /**
+     * The source template or envelope ID the field is found in.
+     */
+    sourceid: string;
     /**
      * The name of the field to display.
      */
@@ -62,8 +64,5 @@ export declare class VerdocsFieldTimestamp {
     focusField(): Promise<void>;
     showSettingsPanel(): Promise<void>;
     hideSettingsPanel(): Promise<void>;
-    fieldStore: TTemplateFieldStore;
-    roleStore: TTemplateRoleStore;
-    componentWillLoad(): Promise<void>;
     render(): any;
 }

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

@@ -1,12 +1,12 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { ITemplate, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { TTemplateStore } from '../../../utils/TemplateStore';
 import { SDKError } from '../../../utils/errors';
 export type TVerdocsBuildStep = 'attachments' | 'roles' | 'settings' | 'fields' | 'preview';
 /**
  * Display a set of tabs for the template builder.
  */
 export declare class VerdocsTemplateBuildTabs {
+    private templateListenerId;
     /**
      * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
      */
@@ -30,11 +30,14 @@ export declare class VerdocsTemplateBuildTabs {
      * Event fired when the user selects a different step.
      */
     stepChanged: EventEmitter<TVerdocsBuildStep>;
-    templateStore: TTemplateStore | null;
+    loading: boolean;
+    template: ITemplate | null;
+    disconnectedCallback(): void;
+    listenToTemplate(): Promise<void>;
+    unlistenToTemplate(): void;
     onTemplateIdChanged(newTemplateId: string): void;
     onStepChanged(newStep: TVerdocsBuildStep): void;
     componentWillLoad(): Promise<void>;
-    loadTemplate(templateId: string): Promise<void>;
     setStep(e: any): void;
     copyTemplateId(): void;
     render(): any;

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

@@ -1,6 +1,5 @@
-import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { type ITemplate, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
 import { IDocumentPageInfo, IPageLayer } from '../../../utils/Types';
 /**
  * Represents one document page. This is primarily a layout container used to coordinate positions of
@@ -8,8 +7,9 @@ import { IDocumentPageInfo, IPageLayer } from '../../../utils/Types';
  * on its own as an individual component.
  */
 export declare class VerdocsTemplateDocumentPage {
-    container: HTMLElement;
+    private templateListenerId;
     private resizeObserver;
+    container: HTMLElement;
     /**
      * The endpoint to load from.
      */
@@ -75,11 +75,14 @@ export declare class VerdocsTemplateDocumentPage {
     pageDisplayUri: string;
     xScale: number;
     yScale: number;
-    fieldStore: TTemplateFieldStore | null;
+    loading: boolean;
+    template: ITemplate | null;
     componentWillLoad(): Promise<void>;
     componentDidLoad(): void;
     componentDidUpdate(): void;
     disconnectedCallback(): void;
+    listenToTemplate(): Promise<void>;
+    unlistenToTemplate(): void;
     notifyRenderedSize(): void;
     render(): any;
 }

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

@@ -1,13 +1,11 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { ITemplateField, TFieldType, VerdocsEndpoint } from '@verdocs/js-sdk';
-import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
-import { TTemplateRoleStore } from '../../../utils/TemplateRoleStore';
-import { TTemplateStore } from '../../../utils/TemplateStore';
+import { type ITemplate, ITemplateField, TFieldType, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { SDKError } from '../../../utils/errors';
 /**
  * Displays an edit form that allows the user to adjust a field's settings.
  */
 export declare class VerdocsTemplateFieldProperties {
+    private templateListenerId;
     el: any;
     /**
      * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
@@ -50,7 +48,6 @@ export declare class VerdocsTemplateFieldProperties {
      */
     sdkError: EventEmitter<SDKError>;
     dirty: boolean;
-    loading: boolean;
     label: string;
     type: TFieldType;
     name: string;
@@ -62,9 +59,11 @@ export declare class VerdocsTemplateFieldProperties {
     placeholder: string;
     defaultValue: string;
     showingHelp: boolean;
-    templateStore: TTemplateStore | null;
-    fieldStore: TTemplateFieldStore | null;
-    roleStore: TTemplateRoleStore | null;
+    loading: boolean;
+    template: ITemplate | null;
+    disconnectedCallback(): void;
+    listenToTemplate(): Promise<void>;
+    unlistenToTemplate(): void;
     componentWillLoad(): Promise<void>;
     resetForm(): void;
     handleCancel(e: any): void;

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

@@ -1,8 +1,5 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { ITemplate, ITemplateField, TFieldType, VerdocsEndpoint } from '@verdocs/js-sdk';
-import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
-import { TTemplateRoleStore } from '../../../utils/TemplateRoleStore';
-import { TTemplateStore } from '../../../utils/TemplateStore';
 import { IDocumentPageInfo } from '../../../utils/Types';
 import { SDKError } from '../../../utils/errors';
 /**
@@ -10,6 +7,7 @@ import { SDKError } from '../../../utils/errors';
  * present all of the required controls, so it is primarily intended to be used in desktop environments.
  */
 export declare class VerdocsTemplateFields {
+    private templateListenerId;
     /**
      * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
      */
@@ -51,16 +49,16 @@ export declare class VerdocsTemplateFields {
     showMustSelectRole: boolean;
     selectedRoleName: string;
     loading: boolean;
+    template: ITemplate | null;
     pageHeights: Record<number, number>;
-    templateStore: TTemplateStore | null;
-    fieldStore: TTemplateFieldStore | null;
-    roleStore: TTemplateRoleStore | null;
-    onTemplateIdChanged(newTemplateId: string): void;
+    onTemplateIdChanged(): void;
     handleKeyDown(ev: KeyboardEvent): void;
     componentWillLoad(): Promise<void>;
     componentDidRender(): void;
     componentWillUpdate(): void;
-    loadTemplate(templateId: string): Promise<void>;
+    disconnectedCallback(): void;
+    listenToTemplate(): Promise<void>;
+    unlistenToTemplate(): void;
     attachFieldAttributes(pageInfo: IDocumentPageInfo, field: ITemplateField, el: HTMLInputElement): void;
     cachedPageInfo: Record<number, IDocumentPageInfo>;
     handlePageRendered(e: any): void;

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

@@ -1,13 +1,11 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { TRecipientType, VerdocsEndpoint } from '@verdocs/js-sdk';
-import { TTemplateRoleStore } from '../../../utils/TemplateRoleStore';
-import { TTemplateFieldStore } from '../../../utils/TemplateFieldStore';
-import { TTemplateStore } from '../../../utils/TemplateStore';
+import { ITemplate, TRecipientType, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { SDKError } from '../../../utils/errors';
 /**
  * Display an edit form that allows the user to adjust a role's setitngs.
  */
 export declare class VerdocsTemplateRoleProperties {
+    private templateListenerId;
     /**
      * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
      */
@@ -46,10 +44,12 @@ export declare class VerdocsTemplateRoleProperties {
     email: string;
     phone: string;
     delegator: boolean;
-    templateStore: TTemplateStore | null;
-    fieldStore: TTemplateFieldStore | null;
-    roleStore: TTemplateRoleStore | null;
+    loading: boolean;
+    template: ITemplate | null;
     componentWillLoad(): Promise<void>;
+    disconnectedCallback(): void;
+    listenToTemplate(): Promise<void>;
+    unlistenToTemplate(): void;
     handleCancel(e: any): void;
     handleSave(e: any): Promise<void>;
     handleDelete(e: any): Promise<void>;

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

@@ -1,12 +1,11 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { IRole, VerdocsEndpoint } from '@verdocs/js-sdk';
-import { TTemplateRoleStore } from '../../../utils/TemplateRoleStore';
-import { TTemplateStore } from '../../../utils/TemplateStore';
+import { IRole, ITemplate, VerdocsEndpoint } from '@verdocs/js-sdk';
 import { SDKError } from '../../../utils/errors';
 /**
  * Displays an edit form that allows the user to adjust a template's roles and workflow.
  */
 export declare class VerdocsTemplateRoles {
+    private templateListenerId;
     el: HTMLElement;
     /**
      * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
@@ -41,8 +40,10 @@ export declare class VerdocsTemplateRoles {
     showingRoleDialog: string | null;
     sender: any;
     loading: boolean;
-    templateStore: TTemplateStore | null;
-    roleStore: TTemplateRoleStore | null;
+    template: ITemplate | null;
+    disconnectedCallback(): void;
+    listenToTemplate(): Promise<void>;
+    unlistenToTemplate(): void;
     componentWillLoad(): Promise<void>;
     componentDidRender(): void;
     handleCancel(): void;
@@ -51,7 +52,7 @@ export declare class VerdocsTemplateRoles {
     getSequenceNumbers(): any[];
     getRoleNames(): string[];
     getRolesAtSequence(sequence: number): IRole[];
-    renumberTemplateRoles(): Promise<any[]>;
+    renumberTemplateRoles(): Promise<true | void>;
     getNextRoleName(): string;
     callCreateRole(name: string, sequence: number, order: number): void;
     handleAddRole(e: any, sequence: number): void;