legalesign-document-viewer 0.3.8 → 0.4.0

package/dist/types/components.d.ts

@@ -12,6 +12,7 @@ import { Icon as Icon1, LSApiElement as LSApiElement1, LSApiTemplate as LSApiTem
 import { LsDocumentViewer } from "./components/ls-document-viewer/ls-document-viewer";
 import { Icon } from "./types/Icon";
 import { LSApiRole, LSApiRoleType } from "./types/LSApiRole";
+import { LSApiRecipient } from "./types/LSApiRecipient";
 import { ValidationError } from "./types/ValidationError";
 export { LSApiTemplate } from "./types/LSApiTemplate";
 export { LSMutateEvent } from "./types/LSMutateEvent";
@@ -20,6 +21,7 @@ export { Icon as Icon1, LSApiElement as LSApiElement1, LSApiTemplate as LSApiTem
 export { LsDocumentViewer } from "./components/ls-document-viewer/ls-document-viewer";
 export { Icon } from "./types/Icon";
 export { LSApiRole, LSApiRoleType } from "./types/LSApiRole";
+export { LSApiRecipient } from "./types/LSApiRecipient";
 export { ValidationError } from "./types/ValidationError";
 export namespace Components {
     interface LsComposeManager {
@@ -40,6 +42,7 @@ export namespace Components {
      * Alex Weinle
      */
     interface LsDocumentViewer {
+        "_recipients": any[];
         /**
           * Shows the table view of fields rather than the preview. {boolean}
           * @default false
@@ -49,22 +52,17 @@ export namespace Components {
           * This will override the default production graphql endpoint. Almost exclusively used for internal development. {string}
          */
         "endpoint": string;
-        /**
-          * Whether or not the fields list is expanded. {boolean}
-          * @default false
-         */
-        "expandfields"?: boolean;
         /**
           * Allows the selection of fields in the toolbox to be limited to a | (pipe) delimited list. {string}
           * @default null
          */
-        "filterToolbox"?: string;
+        "filtertoolbox"?: string;
         "groupInfo": any;
         /**
           * Determines / sets which of the far left 'managers' is active. {'document' | 'toolbox' | 'participant' }
           * @default 'toolbox'
          */
-        "manager": 'document' | 'toolbox' | 'participant';
+        "manager": 'document' | 'toolbox' | 'participant' | 'recipient' | 'validation';
         /**
           * An ease of use property that will arrange document-viewer appropraitely. {'preview' | 'editor' | 'custom'}
           * @default 'editor'
@@ -91,6 +89,10 @@ export namespace Components {
           * @default false
          */
         "readonly"?: boolean;
+        /**
+          * A JSON string containing the recipient details. Only used in COMPOSE mode. {string}
+         */
+        "recipients": string;
         /**
           * Page and field resize on zoom change
          */
@@ -110,19 +112,10 @@ export namespace Components {
           * @default false
          */
         "showtableview"?: boolean;
-        /**
-          * Whether the top toolbar is displayed. {boolean}
-          * @default false
-         */
-        "showtoolbar"?: boolean;
         /**
           * @default 0
          */
         "signer": number;
-        /**
-          * A JSON string containing the signer details. Only used in COMPOSE mode. {string}
-         */
-        "signers": string;
         /**
           * The initial template data, including the link for background PDF. See README and example for correct GraphQL query and data structure. {LSApiTemplate}
          */
@@ -155,6 +148,10 @@ export namespace Components {
     }
     interface LsEditorField {
         "dataItem": LSApiElement1;
+        /**
+          * @default null
+         */
+        "fixedAspect": number | null;
         "page": { height: number; width: number };
         "readonly": boolean;
         /**
@@ -174,7 +171,7 @@ export namespace Components {
           * Determines / sets which of the far left 'managers' is active. {'document' | 'toolbox' | 'participant' }
           * @default 'toolbox'
          */
-        "manager": 'document' | 'toolbox' | 'participant';
+        "manager": 'document' | 'toolbox' | 'participant'| 'recipient' | 'validation';
         /**
           * The mode that document viewer is being used in. {'preview' | 'editor' | 'custom'}
           * @default 'editor'
@@ -308,6 +305,10 @@ export namespace Components {
         "expanded": boolean;
     }
     interface LsIcon {
+        /**
+          * @default "#000000"
+         */
+        "color"?: string;
         "customStyle"?: { [key: string]: string };
         "name"?: Icon;
         /**
@@ -409,6 +410,25 @@ export namespace Components {
         "name"?: string;
         "radioId": string;
     }
+    interface LsRecipientCard {
+        "activeRecipient": number;
+        /**
+          * Allows the selection of fields in the toolbox to be limited to a | (pipe) delimited list. {string}
+          * @default null
+         */
+        "filtertoolbox"?: string;
+        /**
+          * The initial template data, including the link for background PDF. See README and example for correct GraphQL query and data structure. {LSApiTemplate}
+         */
+        "recipient": LSApiRecipient;
+        "template": LSApiTemplate1;
+        /**
+          * @default []
+         */
+        "validationErrors": ValidationError[];
+    }
+    interface LsRecipientManager {
+    }
     interface LsSelectInput {
         "aria"?: string;
         "buttonClick"?: any;
@@ -502,6 +522,10 @@ export namespace Components {
          */
         "defaultWidth": number;
         "elementType": string;
+        /**
+          * @default null
+         */
+        "fixedAspect": number | null;
         /**
           * The field type of this toolbox item, e.g. 'signature'. Note these should always be lowercase.
          */
@@ -518,6 +542,10 @@ export namespace Components {
           * The text to display for this field type.
          */
         "label": string;
+        /**
+          * @default false
+         */
+        "redDot": boolean;
         /**
           * The signer color of the element
           * @default 0
@@ -546,6 +574,12 @@ export namespace Components {
         "tooltipText": string;
         "tooltipTitle": string;
     }
+    interface LsValidationManager {
+        /**
+          * The template information (as JSON). {LSApiTemplate}
+         */
+        "validationErrors": ValidationError[];
+    }
     interface LsValidationTag {
         /**
           * @default false
@@ -559,6 +593,10 @@ export namespace Components {
           * @default 'Invalid'
          */
         "status": string;
+        /**
+          * @default 'default'
+         */
+        "type": 'compose' | 'default';
         /**
           * @default []
          */
@@ -637,6 +675,10 @@ export interface LsParticipantSelectCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLLsParticipantSelectElement;
 }
+export interface LsRecipientCardCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLLsRecipientCardElement;
+}
 export interface LsTextInputCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLLsTextInputElement;
@@ -729,7 +771,7 @@ declare global {
         new (): HTMLLsEditorTableElement;
     };
     interface HTMLLsFeatureColumnElementEventMap {
-        "manage": 'document' | 'toolbox' | 'participant';
+        "manage": 'document' | 'toolbox' | 'participant' | 'recipient' | 'validation';
     }
     interface HTMLLsFeatureColumnElement extends Components.LsFeatureColumn, HTMLStencilElement {
         addEventListener<K extends keyof HTMLLsFeatureColumnElementEventMap>(type: K, listener: (this: HTMLLsFeatureColumnElement, ev: LsFeatureColumnCustomEvent<HTMLLsFeatureColumnElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1126,6 +1168,29 @@ declare global {
         prototype: HTMLLsRadioInputElement;
         new (): HTMLLsRadioInputElement;
     };
+    interface HTMLLsRecipientCardElementEventMap {
+        "changeSigner": number;
+    }
+    interface HTMLLsRecipientCardElement extends Components.LsRecipientCard, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLLsRecipientCardElementEventMap>(type: K, listener: (this: HTMLLsRecipientCardElement, ev: LsRecipientCardCustomEvent<HTMLLsRecipientCardElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLLsRecipientCardElementEventMap>(type: K, listener: (this: HTMLLsRecipientCardElement, ev: LsRecipientCardCustomEvent<HTMLLsRecipientCardElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLLsRecipientCardElement: {
+        prototype: HTMLLsRecipientCardElement;
+        new (): HTMLLsRecipientCardElement;
+    };
+    interface HTMLLsRecipientManagerElement extends Components.LsRecipientManager, HTMLStencilElement {
+    }
+    var HTMLLsRecipientManagerElement: {
+        prototype: HTMLLsRecipientManagerElement;
+        new (): HTMLLsRecipientManagerElement;
+    };
     interface HTMLLsSelectInputElement extends Components.LsSelectInput, HTMLStencilElement {
     }
     var HTMLLsSelectInputElement: {
@@ -1198,12 +1263,13 @@ declare global {
     };
     interface HTMLLsToolboxFieldElementEventMap {
         "fieldTypeSelected": {
-    label: string
-    elementType: string
-    defaultHeight: number
-    defaultWidth: number
-    formElementType: string
-    validation: number
+    label: string;
+    elementType: string;
+    defaultHeight: number;
+    defaultWidth: number;
+    formElementType: string;
+    validation: number;
+    fixedAspect: number | null;
   };
     }
     interface HTMLLsToolboxFieldElement extends Components.LsToolboxField, HTMLStencilElement {
@@ -1226,6 +1292,12 @@ declare global {
         prototype: HTMLLsTooltipElement;
         new (): HTMLLsTooltipElement;
     };
+    interface HTMLLsValidationManagerElement extends Components.LsValidationManager, HTMLStencilElement {
+    }
+    var HTMLLsValidationManagerElement: {
+        prototype: HTMLLsValidationManagerElement;
+        new (): HTMLLsValidationManagerElement;
+    };
     interface HTMLLsValidationTagElement extends Components.LsValidationTag, HTMLStencilElement {
     }
     var HTMLLsValidationTagElement: {
@@ -1274,6 +1346,8 @@ declare global {
         "ls-participant-select": HTMLLsParticipantSelectElement;
         "ls-props-section": HTMLLsPropsSectionElement;
         "ls-radio-input": HTMLLsRadioInputElement;
+        "ls-recipient-card": HTMLLsRecipientCardElement;
+        "ls-recipient-manager": HTMLLsRecipientManagerElement;
         "ls-select-input": HTMLLsSelectInputElement;
         "ls-statusbar": HTMLLsStatusbarElement;
         "ls-text-input": HTMLLsTextInputElement;
@@ -1282,6 +1356,7 @@ declare global {
         "ls-toolbar": HTMLLsToolbarElement;
         "ls-toolbox-field": HTMLLsToolboxFieldElement;
         "ls-tooltip": HTMLLsTooltipElement;
+        "ls-validation-manager": HTMLLsValidationManagerElement;
         "ls-validation-tag": HTMLLsValidationTagElement;
     }
 }
@@ -1306,6 +1381,7 @@ declare namespace LocalJSX {
      * Alex Weinle
      */
     interface LsDocumentViewer {
+        "_recipients"?: any[];
         /**
           * Shows the table view of fields rather than the preview. {boolean}
           * @default false
@@ -1315,22 +1391,17 @@ declare namespace LocalJSX {
           * This will override the default production graphql endpoint. Almost exclusively used for internal development. {string}
          */
         "endpoint"?: string;
-        /**
-          * Whether or not the fields list is expanded. {boolean}
-          * @default false
-         */
-        "expandfields"?: boolean;
         /**
           * Allows the selection of fields in the toolbox to be limited to a | (pipe) delimited list. {string}
           * @default null
          */
-        "filterToolbox"?: string;
+        "filtertoolbox"?: string;
         "groupInfo"?: any;
         /**
           * Determines / sets which of the far left 'managers' is active. {'document' | 'toolbox' | 'participant' }
           * @default 'toolbox'
          */
-        "manager"?: 'document' | 'toolbox' | 'participant';
+        "manager"?: 'document' | 'toolbox' | 'participant' | 'recipient' | 'validation';
         /**
           * An ease of use property that will arrange document-viewer appropraitely. {'preview' | 'editor' | 'custom'}
           * @default 'editor'
@@ -1354,6 +1425,10 @@ declare namespace LocalJSX {
           * @default false
          */
         "readonly"?: boolean;
+        /**
+          * A JSON string containing the recipient details. Only used in COMPOSE mode. {string}
+         */
+        "recipients"?: string;
         /**
           * Whether the page previewvertical ribbon will be shown {boolean}
           * @default false
@@ -1369,19 +1444,10 @@ declare namespace LocalJSX {
           * @default false
          */
         "showtableview"?: boolean;
-        /**
-          * Whether the top toolbar is displayed. {boolean}
-          * @default false
-         */
-        "showtoolbar"?: boolean;
         /**
           * @default 0
          */
         "signer"?: number;
-        /**
-          * A JSON string containing the signer details. Only used in COMPOSE mode. {string}
-         */
-        "signers"?: string;
         /**
           * The initial template data, including the link for background PDF. See README and example for correct GraphQL query and data structure. {LSApiTemplate}
          */
@@ -1410,6 +1476,10 @@ declare namespace LocalJSX {
     }
     interface LsEditorField {
         "dataItem"?: LSApiElement1;
+        /**
+          * @default null
+         */
+        "fixedAspect"?: number | null;
         "onMutate"?: (event: LsEditorFieldCustomEvent<LSMutateEvent[]>) => void;
         "onUpdate"?: (event: LsEditorFieldCustomEvent<LSMutateEvent[]>) => void;
         "page"?: { height: number; width: number };
@@ -1431,13 +1501,13 @@ declare namespace LocalJSX {
           * Determines / sets which of the far left 'managers' is active. {'document' | 'toolbox' | 'participant' }
           * @default 'toolbox'
          */
-        "manager"?: 'document' | 'toolbox' | 'participant';
+        "manager"?: 'document' | 'toolbox' | 'participant'| 'recipient' | 'validation';
         /**
           * The mode that document viewer is being used in. {'preview' | 'editor' | 'custom'}
           * @default 'editor'
          */
         "mode"?: 'preview' | 'editor' | 'compose';
-        "onManage"?: (event: LsFeatureColumnCustomEvent<'document' | 'toolbox' | 'participant'>) => void;
+        "onManage"?: (event: LsFeatureColumnCustomEvent<'document' | 'toolbox' | 'participant' | 'recipient' | 'validation'>) => void;
     }
     interface LsFieldAlignment {
         "dataItem"?: LSApiElement1[];
@@ -1588,6 +1658,10 @@ declare namespace LocalJSX {
         "expanded"?: boolean;
     }
     interface LsIcon {
+        /**
+          * @default "#000000"
+         */
+        "color"?: string;
         "customStyle"?: { [key: string]: string };
         "name"?: Icon;
         /**
@@ -1698,6 +1772,26 @@ declare namespace LocalJSX {
         "name"?: string;
         "radioId"?: string;
     }
+    interface LsRecipientCard {
+        "activeRecipient"?: number;
+        /**
+          * Allows the selection of fields in the toolbox to be limited to a | (pipe) delimited list. {string}
+          * @default null
+         */
+        "filtertoolbox"?: string;
+        "onChangeSigner"?: (event: LsRecipientCardCustomEvent<number>) => void;
+        /**
+          * The initial template data, including the link for background PDF. See README and example for correct GraphQL query and data structure. {LSApiTemplate}
+         */
+        "recipient"?: LSApiRecipient;
+        "template"?: LSApiTemplate1;
+        /**
+          * @default []
+         */
+        "validationErrors"?: ValidationError[];
+    }
+    interface LsRecipientManager {
+    }
     interface LsSelectInput {
         "aria"?: string;
         "buttonClick"?: any;
@@ -1795,6 +1889,10 @@ declare namespace LocalJSX {
          */
         "defaultWidth"?: number;
         "elementType"?: string;
+        /**
+          * @default null
+         */
+        "fixedAspect"?: number | null;
         /**
           * The field type of this toolbox item, e.g. 'signature'. Note these should always be lowercase.
          */
@@ -1812,13 +1910,18 @@ declare namespace LocalJSX {
          */
         "label"?: string;
         "onFieldTypeSelected"?: (event: LsToolboxFieldCustomEvent<{
-    label: string
-    elementType: string
-    defaultHeight: number
-    defaultWidth: number
-    formElementType: string
-    validation: number
+    label: string;
+    elementType: string;
+    defaultHeight: number;
+    defaultWidth: number;
+    formElementType: string;
+    validation: number;
+    fixedAspect: number | null;
   }>) => void;
+        /**
+          * @default false
+         */
+        "redDot"?: boolean;
         /**
           * The signer color of the element
           * @default 0
@@ -1846,6 +1949,12 @@ declare namespace LocalJSX {
         "tooltipText"?: string;
         "tooltipTitle"?: string;
     }
+    interface LsValidationManager {
+        /**
+          * The template information (as JSON). {LSApiTemplate}
+         */
+        "validationErrors"?: ValidationError[];
+    }
     interface LsValidationTag {
         /**
           * @default false
@@ -1859,6 +1968,10 @@ declare namespace LocalJSX {
           * @default 'Invalid'
          */
         "status"?: string;
+        /**
+          * @default 'default'
+         */
+        "type"?: 'compose' | 'default';
         /**
           * @default []
          */
@@ -1906,6 +2019,8 @@ declare namespace LocalJSX {
         "ls-participant-select": LsParticipantSelect;
         "ls-props-section": LsPropsSection;
         "ls-radio-input": LsRadioInput;
+        "ls-recipient-card": LsRecipientCard;
+        "ls-recipient-manager": LsRecipientManager;
         "ls-select-input": LsSelectInput;
         "ls-statusbar": LsStatusbar;
         "ls-text-input": LsTextInput;
@@ -1914,6 +2029,7 @@ declare namespace LocalJSX {
         "ls-toolbar": LsToolbar;
         "ls-toolbox-field": LsToolboxField;
         "ls-tooltip": LsTooltip;
+        "ls-validation-manager": LsValidationManager;
         "ls-validation-tag": LsValidationTag;
     }
 }
@@ -1967,6 +2083,8 @@ declare module "@stencil/core" {
             "ls-participant-select": LocalJSX.LsParticipantSelect & JSXBase.HTMLAttributes<HTMLLsParticipantSelectElement>;
             "ls-props-section": LocalJSX.LsPropsSection & JSXBase.HTMLAttributes<HTMLLsPropsSectionElement>;
             "ls-radio-input": LocalJSX.LsRadioInput & JSXBase.HTMLAttributes<HTMLLsRadioInputElement>;
+            "ls-recipient-card": LocalJSX.LsRecipientCard & JSXBase.HTMLAttributes<HTMLLsRecipientCardElement>;
+            "ls-recipient-manager": LocalJSX.LsRecipientManager & JSXBase.HTMLAttributes<HTMLLsRecipientManagerElement>;
             "ls-select-input": LocalJSX.LsSelectInput & JSXBase.HTMLAttributes<HTMLLsSelectInputElement>;
             "ls-statusbar": LocalJSX.LsStatusbar & JSXBase.HTMLAttributes<HTMLLsStatusbarElement>;
             "ls-text-input": LocalJSX.LsTextInput & JSXBase.HTMLAttributes<HTMLLsTextInputElement>;
@@ -1975,6 +2093,7 @@ declare module "@stencil/core" {
             "ls-toolbar": LocalJSX.LsToolbar & JSXBase.HTMLAttributes<HTMLLsToolbarElement>;
             "ls-toolbox-field": LocalJSX.LsToolboxField & JSXBase.HTMLAttributes<HTMLLsToolboxFieldElement>;
             "ls-tooltip": LocalJSX.LsTooltip & JSXBase.HTMLAttributes<HTMLLsTooltipElement>;
+            "ls-validation-manager": LocalJSX.LsValidationManager & JSXBase.HTMLAttributes<HTMLLsValidationManagerElement>;
             "ls-validation-tag": LocalJSX.LsValidationTag & JSXBase.HTMLAttributes<HTMLLsValidationTagElement>;
         }
     }

package/dist/types/index.d.ts

@@ -8,4 +8,4 @@
  * to consume components of this package as outlined in the `README.md`.
  */
 export { format } from './utils/utils';
-export type * from './components.d.ts';
+export type * from './components';

package/dist/types/types/LSApiRecipient.d.ts

@@ -0,0 +1,8 @@
+export type LSApiRecipient = {
+    name: string;
+    email: string;
+    firstname: string;
+    lastname: string;
+    signerIndex?: number;
+    roleType?: 'SIGNER' | 'WITNESS' | 'APPROVER' | 'FORM_FILLER';
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "legalesign-document-viewer",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "description": "Legalesign Document Editor/Viewer",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",