@verdocs/web-sdk 1.9.6 → 1.9.10

package/dist/types/components/elements/verdocs-view-envelope-document/verdocs-view-envelope-document.d.ts

@@ -0,0 +1,79 @@
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { IEnvelopeDocument } 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 a single document attached to an envelope. Note that envelopes always require authentication to access them. If you are viewing
+ * this component in Storybook, visit Embeds > Auth first to log in, then paste a valid envelopeId and documentId in the properties
+ * below from your account to view that envelope. If you want to see an anonymous-access use case, this component is functionally similar
+ * to ViewTemplateDocument, which is pre-configured to display a public template.
+ */
+export declare class VerdocsViewEnvelopeDocument {
+  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
+   */
+  envelopeId: string;
+  /**
+   * The document ID to render
+   */
+  documentId: 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>;
+  envelopeDocument: IEnvelopeDocument | null;
+  domPages: Record<number, IDocumentPageInfo>;
+  sourcePageMetrics: Record<number, {
+    width: number;
+    height: number;
+  }>;
+  componentWillLoad(): void;
+  componentDidLoad(): Promise<void>;
+  renderPage(pageNumber: number): Promise<void>;
+  handlePageRendered(e: any): Promise<void>;
+  render(): any;
+}

package/dist/types/components/elements/verdocs-view-envelope-document/verdocs-view-envelope-document.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 ViewEnvelopeDocument: ({ envelopeId, documentId }: {
+  envelopeId: any;
+  documentId: any;
+}) => import("lit-html").TemplateResult<1>;

package/dist/types/components/elements/verdocs-view-template-document/verdocs-view-template-document.d.ts

@@ -0,0 +1,77 @@
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { IDocumentPageInfo, IPageLayer } from '../../../utils/Types';
+import { ITemplateDocument } from '@verdocs/js-sdk/Templates/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 a single document attached to a template. Note that if you are accessing a template that is not public, you must be authenticated.
+ * You can authenticate within this Storybook via the Embeds > Auth control.
+ */
+export declare class VerdocsViewTemplateDocument {
+  component: HTMLElement;
+  /**
+   * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
+   */
+  endpoint: VerdocsEndpoint;
+  /**
+   * The template ID to render
+   */
+  templateId: string;
+  /**
+   * The document ID to render within the template
+   */
+  documentId: 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>;
+  templateDocument: ITemplateDocument | null;
+  domPages: Record<number, IDocumentPageInfo>;
+  sourcePageMetrics: Record<number, {
+    width: number;
+    height: number;
+  }>;
+  componentWillLoad(): void;
+  componentDidLoad(): Promise<void>;
+  renderPage(pageNumber: number): Promise<void>;
+  handlePageRendered(e: any): Promise<void>;
+  render(): any;
+}

package/dist/types/components/elements/verdocs-view-template-document/verdocs-view-template-document.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 ViewTemplateDocument: ({ templateId, documentId }: {
+  templateId: any;
+  documentId: any;
+}) => import("lit-html").TemplateResult<1>;

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

@@ -1,5 +1,6 @@
+import { VerdocsEndpoint } from '@verdocs/js-sdk';
+import { TSession } from '@verdocs/js-sdk/Sessions/Types';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { VerdocsEndpoint, TSession } from '@verdocs/js-sdk';
 import { SDKError } from '../../../utils/errors';
 export interface IAuthStatus {
   authenticated: boolean;

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

@@ -1,4 +1,4 @@
-import { IDocumentField } from '@verdocs/js-sdk/Documents/Types';
+import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 export declare function getInputStyle(field: IDocumentField, mode: any, browserType: string): {
   height: string;
   width: string;

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

@@ -1,6 +1,6 @@
-import { EventEmitter } from '../../../stencil-public-runtime';
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
 import { ITemplate, ITemplateField } from '@verdocs/js-sdk/Templates/Types';
+import { EventEmitter } from '../../../stencil-public-runtime';
 import { SDKError } from '../../../utils/errors';
 /**
  * Display a template building experience.
@@ -23,7 +23,7 @@ export declare class VerdocsBuild {
   pdfUrl: any;
   template: ITemplate | null;
   fields: ITemplateField[];
-  componentDidLoad(): Promise<void>;
+  componentWillLoad(): Promise<void>;
   handleCancel(e: any): void;
   handleTemplateCreated(e: any): void;
   handlePropertiesUpdated(e: any): void;

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

@@ -1,4 +1,4 @@
-import { IDocumentField } from '@verdocs/js-sdk/Documents/Types';
+import { IDocumentField } from '@verdocs/js-sdk/Envelopes/Types';
 export declare function getInputStyle(field: IDocumentField, mode: any, browserType: string): {
   height: string;
   width: string;

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

@@ -1,6 +1,6 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { VerdocsEndpoint } from '@verdocs/js-sdk';
-import { IDocument, IDocumentField, IRecipient } from '@verdocs/js-sdk/Documents/Types';
+import { IEnvelope, IDocumentField, IRecipient } from '@verdocs/js-sdk/Envelopes/Types';
 import { IDocumentPageInfo } from '../../../utils/Types';
 import { SDKError } from '../../../utils/errors';
 /**
@@ -14,9 +14,9 @@ export declare class VerdocsSign {
    */
   endpoint: VerdocsEndpoint;
   /**
-   * The ID of the document to sign.
+   * The ID of the envelope to sign.
    */
-  documentId: string | null;
+  envelopeId: string | null;
   /**
    * The name of the role that will be signing.
    */
@@ -34,7 +34,7 @@ export declare class VerdocsSign {
   signerToken: any;
   pdfUrl: any;
   recipientIndex: number;
-  document: IDocument | null;
+  envelope: IEnvelope | null;
   fields: IDocumentField[];
   hasSignature: boolean;
   nextButtonLabel: string;

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

@@ -1,8 +1,8 @@
 import { Meta } from '@storybook/web-components';
 declare const _default: Meta<import("@storybook/web-components").Args>;
 export default _default;
-export declare const Sign: ({ documentId, roleId, inviteCode }: {
-  documentId: any;
+export declare const Sign: ({ envelopeId, roleId, inviteCode }: {
+  envelopeId: any;
   roleId: any;
   inviteCode: any;
 }) => import("lit-html").TemplateResult<1>;

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

@@ -1,8 +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 { EventEmitter } from '../../../stencil-public-runtime';
 import { IDocumentPageInfo, IPageLayer } from '../../../utils/Types';
 import { SDKError } from '../../../utils/errors';
-import { ITemplate } from '@verdocs/js-sdk/Templates/Types';
 export interface ISourcePageMetrics {
   width: number;
   height: number;
@@ -12,6 +13,11 @@ export interface IPageRenderEvent {
   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.
+ */
 export declare class VerdocsView {
   component: HTMLElement;
   /**
@@ -19,9 +25,13 @@ export declare class VerdocsView {
    */
   endpoint: VerdocsEndpoint;
   /**
-   * The template ID to render
+   * 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
    */
@@ -30,13 +40,6 @@ export declare class VerdocsView {
    * Layers will be passed through to the individual pages inside this component.
    */
   pageLayers: IPageLayer[];
-  /**
-   * Src of the PDF to load and render
-   */
-  source: string;
-  /**
-   * Listen for changes to src
-   */
   /**
    * Fired when a page has been rendered
    */
@@ -62,19 +65,9 @@ export declare class VerdocsView {
    * terminate the process, and the calling application should correct the condition and re-render the component.
    */
   sdkError: EventEmitter<SDKError>;
-  loadProgress: number;
-  template: ITemplate | null;
-  pageNumbers: number[];
-  pageUris: Record<number, string>;
-  numPages: number;
-  domPages: Record<number, IDocumentPageInfo>;
-  sourcePageMetrics: Record<number, {
-    width: number;
-    height: number;
-  }>;
+  template?: ITemplate;
+  envelope?: IEnvelope;
   componentWillLoad(): void;
   componentDidLoad(): Promise<void>;
-  renderPage(pageNumber: number): Promise<void>;
-  handlePageRendered(e: any): Promise<void>;
   render(): any;
 }

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

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