@verdocs/web-sdk 1.9.10 → 1.9.15

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

@@ -1,5 +1,5 @@
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
-import { IDocumentField, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
+import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
 /**
  * Display a text input field.
@@ -10,10 +10,6 @@ export declare class VerdocsFieldTextbox {
    * The document or template field to display.
    */
   field: IDocumentField | ITemplateField | null;
-  /**
-   * The recipient completing the form, if known.
-   */
-  recipient?: IRecipient;
   /**
    * If set, overrides the field's settings object. Primarily used to support "preview" modes where all fields are disabled.
    */
@@ -31,34 +27,11 @@ export declare class VerdocsFieldTextbox {
    * 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 if the field is configurable when the recipient has changed.
    */
   recipientChanged: EventEmitter<string>;
-  focused: boolean;
   focusField(): Promise<void>;
-  handleBlur(): void;
-  handleFocus(): void;
-  handleChange(e: any): void;
-  handleInput(e: any): void;
   handleChangeRecipient(e: any): void;
   render(): any;
 }

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

@@ -1,7 +1,8 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const Textbox: ({ field, disabled }: {
+export declare const Textbox: ({ field, disabled, input }: {
   field: any;
   disabled: any;
+  input: any;
 }) => import("lit-html").TemplateResult<1>;

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

@@ -1,6 +1,5 @@
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
-import { IDocumentField, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
-import { EventEmitter } from '../../../stencil-public-runtime';
+import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 /**
  * Display a timestamp field.
  */
@@ -10,10 +9,6 @@ export declare class VerdocsFieldTimestamp {
    * The document or template field to display.
    */
   field: IDocumentField | ITemplateField | null;
-  /**
-   * The recipient completing the form, if known.
-   */
-  recipient?: IRecipient;
   /**
    * If set, overrides the field's settings object. Primarily used to support "preview" modes where all fields are disabled.
    */
@@ -31,33 +26,6 @@ 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 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.
-   */
-  settingsPress: EventEmitter;
-  focused: boolean;
   focusField(): Promise<void>;
-  handleBlur(): void;
-  handleFocus(): void;
-  handleChange(e: any): void;
-  handleInput(e: any): void;
   render(): any;
 }

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

@@ -3,7 +3,9 @@ import { EventEmitter } from '../../../stencil-public-runtime';
 import { ITemplateField } from '@verdocs/js-sdk/Templates/Types';
 import { SDKError } from '../../../utils/errors';
 /**
- * Display a template preview experience.
+ * Display a template preview experience. This will display the template's attached
+ * documents with signing fields overlaid on each page. Fields will be color-coded
+ * by recipient, and will be read-only (cannot be filled, moved, or altered).
  */
 export declare class VerdocsPreview {
   /**

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

@@ -1,24 +1,32 @@
-import { EventEmitter } from '../../../stencil-public-runtime';
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IEnvelope, IDocumentField, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
-import { IDocumentPageInfo } from '../../../utils/Types';
+import { IDocumentField, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
- * Display a document signing experience.
+ * Display an envelope signing experience. This will display the envelope's attached
+ * documents with signing fields overlaid on each page.
+ *
+ * The component will attempt to initiate a signing session and load the specified
+ * envelope. If successful, the recipient's fields will be enabled and the user will
+ * be able to sign the envelope's attached documents. If not, an `sdkError` will be
+ * thrown and the component will be blank/empty. To provide the best user experience,
+ * applications should capture and handle this error to provide the user with
+ * instructions/options for next steps based on the application's design and workflow.
  *
- * ***NOTE: This sample document will reset every 10 minutes...***
+ * Unlike other components, this will always create its own endpoint to manage the
+ * session session. This endpoint will be included in event callbacks for the
+ * convenience of host applications that may wish to make server calls using the
+ * signer's credentials once signing is complete (e.g. to obtain copies of
+ * the signed attachments.)
  */
 export declare class VerdocsSign {
-  /**
-   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
-   */
   endpoint: VerdocsEndpoint;
   /**
    * The ID of the envelope to sign.
    */
   envelopeId: string | null;
   /**
-   * The name of the role that will be signing.
+   * The ID of the role that will be signing e.g. 'Recipient 1'
    */
   roleId: string | null;
   /**
@@ -30,25 +38,30 @@ export declare class VerdocsSign {
    * terminate the process, and the calling application should correct the condition and re-render the component.
    */
   sdkError: EventEmitter<SDKError>;
+  /**
+   * Event fired when any field is updated. Note that the current active endpoint is
+   * provided as a parameter as a convenience for callers when this coimponent
+   */
+  fieldUpdated: EventEmitter<{
+    endpoint: VerdocsEndpoint;
+  }>;
   recipient: IRecipient | null;
   signerToken: any;
-  pdfUrl: any;
-  recipientIndex: number;
-  envelope: IEnvelope | null;
-  fields: IDocumentField[];
   hasSignature: boolean;
   nextButtonLabel: string;
   focusedField: string;
+  finishLater: boolean;
+  showFinishLater: boolean;
+  recipientIndex: number;
+  fields: IDocumentField[];
+  componentWillLoad(): void;
   componentDidLoad(): Promise<void>;
   handleClickAgree(): void;
   savePDF(): Promise<void>;
   handleOptionSelected(e: any): Promise<void>;
   handleFieldChange(field: IDocumentField, e: any, optionId?: string): Promise<void>;
-  renderCheckboxGroupOption(page: IDocumentPageInfo, field: IDocumentField, option: any): any;
-  renderRadioGroupOption(page: IDocumentPageInfo, field: IDocumentField, option: any): any;
   isFieldValid(field: IDocumentField): boolean;
   handleNext(): void;
-  renderField(field: IDocumentField, docPage: IDocumentPageInfo): void;
   handlePageRendered(e: any): void;
   render(): any;
 }

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

@@ -1,22 +1,9 @@
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IEnvelope } from '@verdocs/js-sdk/Envelopes/Types';
-import { ITemplate } from '@verdocs/js-sdk/Templates/Types';
+import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { IDocumentPageInfo, IPageLayer } from '../../../utils/Types';
 import { SDKError } from '../../../utils/errors';
-export interface ISourcePageMetrics {
-  width: number;
-  height: number;
-}
-export interface IPageRenderEvent {
-  renderedPage: IDocumentPageInfo;
-  sourcePageMetrics: ISourcePageMetrics;
-  pages: Record<number, IDocumentPageInfo>;
-}
 /**
- * View all of the documents attached to a template or envelope. All documents are displayed, in order. This embed wraps
- * verdocs-view-envelope-document or verdocs-view-template-document, as appropriate, and those controls may be used if
- * fine-grained control over which documents are displayed (or their order) is required.
+ * Render the documents attached to an envelope in read-only (view) mode. All documents are displayed in order.
  */
 export declare class VerdocsView {
   component: HTMLElement;
@@ -24,50 +11,18 @@ export declare class VerdocsView {
    * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
    */
   endpoint: VerdocsEndpoint;
-  /**
-   * The template ID to render. Set ONE OF templateId or envelopeId.
-   */
-  templateId: string;
   /**
    * The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored.
    */
   envelopeId: string;
-  /**
-   * Rotate the PDF in degrees
-   */
-  rotation: 0 | 90 | 180 | 270;
-  /**
-   * Layers will be passed through to the individual pages inside this component.
-   */
-  pageLayers: IPageLayer[];
-  /**
-   * Fired when a page has been rendered
-   */
-  pageRendered: EventEmitter<IPageRenderEvent>;
-  /**
-   * Fired when a page has been changed
-   */
-  pageLoaded: EventEmitter<number>;
-  /**
-   * Fired when a page has been changed
-   */
-  pageChange: EventEmitter<number>;
-  /**
-   * Fired when a page has been initialized
-   */
-  pageInit: EventEmitter<number>;
-  /**
-   * Fired when a page has been scaled
-   */
-  scaleChange: EventEmitter<number>;
   /**
    * 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>;
-  template?: ITemplate;
-  envelope?: IEnvelope;
   componentWillLoad(): void;
   componentDidLoad(): Promise<void>;
+  handleFieldChange(field: IDocumentField, e: any, optionId?: string): Promise<void>;
+  handlePageRendered(e: any): void;
   render(): any;
 }

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

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