legalesign-document-viewer 0.2.18 → 0.3.0

package/dist/types/components/ls-document-options/ls-document-options.d.ts

@@ -11,6 +11,6 @@ export declare class LsDocumentOptions {
     selectedHandler(newSelected: any, _oldSelected: any): void;
     mutate: EventEmitter<LSMutateEvent[]>;
     update: EventEmitter<LSMutateEvent[]>;
-    alter(template: object): void;
+    alter(changedDetails: object): void;
     render(): any;
 }

package/dist/types/components/ls-document-viewer/ls-document-viewer.d.ts

@@ -41,10 +41,10 @@ export declare class LsDocumentViewer {
      */
     token: string;
     /**
-   * This will override the default production user pool.
-   * Almost exclusively used for internal development.
-   * {string}
-   */
+     * This will override the default production user pool.
+     * Almost exclusively used for internal development.
+     * {string}
+     */
     userpool: string;
     /**
      * This will override the default production graphql endpoint.
@@ -69,7 +69,7 @@ export declare class LsDocumentViewer {
      * An ease of use property that will arrange document-viewer appropraitely.
      * {'preview' | 'editor' | 'custom'}
      */
-    mode: 'preview' | 'editor' | 'custom';
+    mode: 'preview' | 'editor' | 'compose';
     modeHandler(_newMode: any, _oldMode: any): void;
     tableViewHandler(_newMode: any, _oldMode: any): void;
     /**
@@ -152,6 +152,11 @@ export declare class LsDocumentViewer {
      *
      */
     setZoom(z: number): Promise<void>;
+    /**
+     * Ensure broken or misplaced fields are put onto the page.
+     * {number} position
+     */
+    clip(legacyPosition: number, failback?: number): number;
     /**
      * Decorate the template data object with useful transformations.
      * {string} json of template

package/dist/types/components/ls-participant-card/ls-participant-card.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from '../../stencil-public-runtime';
-import { LSApiRole } from '../../types/LSApiRole';
+import { LSApiRole, LSApiRoleType } from '../../types/LSApiRole';
 import { LSApiTemplate } from '../../types/LSApiTemplate';
 import { LSMutateEvent } from '../../types/LSMutateEvent';
 export declare class LsParticipantCard {
@@ -17,5 +17,9 @@ export declare class LsParticipantCard {
     deleteHandler(role: LSApiRole): void;
     swapHandler(role1: any, role2: any): void;
     modeHandler(_editable: any): void;
+    addParticipant: EventEmitter<{
+        type: LSApiRoleType;
+        parent?: string | null;
+    }>;
     render(): any;
 }

package/dist/types/components/ls-participant-manager/ls-participant-manager.d.ts

@@ -25,5 +25,9 @@ export declare class LsParticipantManager {
     deleteHandler(role: LSApiRole): void;
     swapHandler(role1: any, role2: any): void;
     handleOpened(event: any): void;
+    handleOpenNewWitness(event: CustomEvent<{
+        type: LSApiRoleType;
+        parent?: string | null;
+    }>): void;
     render(): any;
 }

package/dist/types/components/ls-participant-select/ls-participant-select.d.ts

@@ -1,8 +1,6 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import { LSApiRole, LSApiRoleType } from '../../types/LSApiRole';
-import { LSApiElement } from '../../components';
 export declare class LsParticipantSelect {
-    dataItem: LSApiElement[];
     /**
    * The id of the currently selected role.
    * {string}
@@ -16,7 +14,9 @@ export declare class LsParticipantSelect {
         signerIndex: number;
         name: string;
         roleType?: string;
+        default: boolean;
     };
+    handleRoleLoad(): void;
     /**
      * The current template roles.
      * {LSApiRole}

package/dist/types/components.d.ts

@@ -56,9 +56,9 @@ export namespace Components {
         "manager": 'document' | 'toolbox' | 'participant';
         /**
           * An ease of use property that will arrange document-viewer appropraitely. {'preview' | 'editor' | 'custom'}
-          * @default 'custom'
+          * @default 'editor'
          */
-        "mode": 'preview' | 'editor' | 'custom';
+        "mode": 'preview' | 'editor' | 'compose';
         /**
           * Page forward {MouseEvent} e
          */
@@ -339,7 +339,6 @@ export namespace Components {
         "template": LSApiTemplate;
     }
     interface LsParticipantSelect {
-        "dataItem": LSApiElement1[];
         /**
           * The current template roles. {LSApiRole}
           * @default []
@@ -954,6 +953,7 @@ declare global {
         "mutate": LSMutateEvent[];
         "update": LSMutateEvent[];
         "opened": LSApiRole;
+        "addParticipant": { type: LSApiRoleType; parent?: string | null };
     }
     interface HTMLLsParticipantCardElement extends Components.LsParticipantCard, HTMLStencilElement {
         addEventListener<K extends keyof HTMLLsParticipantCardElementEventMap>(type: K, listener: (this: HTMLLsParticipantCardElement, ev: LsParticipantCardCustomEvent<HTMLLsParticipantCardElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -972,7 +972,7 @@ declare global {
     interface HTMLLsParticipantManagerElementEventMap {
         "mutate": LSMutateEvent[];
         "update": LSMutateEvent[];
-        "addParticipant": {type: LSApiRoleType, parent?: string | null};
+        "addParticipant": { type: LSApiRoleType; parent?: string | null };
     }
     interface HTMLLsParticipantManagerElement extends Components.LsParticipantManager, HTMLStencilElement {
         addEventListener<K extends keyof HTMLLsParticipantManagerElementEventMap>(type: K, listener: (this: HTMLLsParticipantManagerElement, ev: LsParticipantManagerCustomEvent<HTMLLsParticipantManagerElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -1185,9 +1185,9 @@ declare namespace LocalJSX {
         "manager"?: 'document' | 'toolbox' | 'participant';
         /**
           * An ease of use property that will arrange document-viewer appropraitely. {'preview' | 'editor' | 'custom'}
-          * @default 'custom'
+          * @default 'editor'
          */
-        "mode"?: 'preview' | 'editor' | 'custom';
+        "mode"?: 'preview' | 'editor' | 'compose';
         "onMutate"?: (event: LsDocumentViewerCustomEvent<LSMutateEvent[]>) => void;
         "onPageChange"?: (event: LsDocumentViewerCustomEvent<number>) => void;
         "onPageRendered"?: (event: LsDocumentViewerCustomEvent<number>) => void;
@@ -1469,6 +1469,7 @@ declare namespace LocalJSX {
          */
         "editable"?: boolean;
         "index"?: number;
+        "onAddParticipant"?: (event: LsParticipantCardCustomEvent<{ type: LSApiRoleType; parent?: string | null }>) => void;
         "onMutate"?: (event: LsParticipantCardCustomEvent<LSMutateEvent[]>) => void;
         "onOpened"?: (event: LsParticipantCardCustomEvent<LSApiRole>) => void;
         "onUpdate"?: (event: LsParticipantCardCustomEvent<LSMutateEvent[]>) => void;
@@ -1480,7 +1481,7 @@ declare namespace LocalJSX {
           * The base editor. {LSDocumentViewer}
          */
         "editor"?: LsDocumentViewer;
-        "onAddParticipant"?: (event: LsParticipantManagerCustomEvent<{type: LSApiRoleType, parent?: string | null}>) => void;
+        "onAddParticipant"?: (event: LsParticipantManagerCustomEvent<{ type: LSApiRoleType; parent?: string | null }>) => void;
         "onMutate"?: (event: LsParticipantManagerCustomEvent<LSMutateEvent[]>) => void;
         "onUpdate"?: (event: LsParticipantManagerCustomEvent<LSMutateEvent[]>) => void;
         /**
@@ -1489,7 +1490,6 @@ declare namespace LocalJSX {
         "template"?: LSApiTemplate;
     }
     interface LsParticipantSelect {
-        "dataItem"?: LSApiElement1[];
         "onAddParticipant"?: (event: LsParticipantSelectCustomEvent<{type: LSApiRoleType, parent?: string | null}>) => void;
         "onRoleChange"?: (event: LsParticipantSelectCustomEvent<number>) => void;
         /**

package/package.json

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

package/readme.md

@@ -2,78 +2,43 @@
 This component allows you to edit, preview or customize a Legalesign template in order to
 send a document for signing. It is purely HTML and javascript and platform agnostic.
 
-## Linking the Viewer to Data 
-In order to use it you'll need to provide three functions:
-
-load(): this gets the template information from your backend or a call to the Legalesign GraphQL API 
-(see the recommended data below).
-
-mutate(): you'll need to provide a function that saves alterations to the template or fields. Again
-this can be calls to the GraphQL API on your platform.
-
-## Add Custom Panels
-
-TODO
-
-## Recommended data
-
-Here is the data that should be passed into your component.
-
-```graphql
-query GetTemplate {
-          template(id: "${id}") {
-            id
-            title
-            fileName
-            pageDimensions
-            pageCount
-            modified
-            link
-            valid
-            locked
-            autoArchive
-            archived
-            tags
-            created
-            createdBy
-            lastSent
-            fixSignatureScale
-            roles{
-              id
-              signerIndex
-            }
-            elementConnection {
-              templateElements {
-                align
-                ax
-                ay
-                bx
-                by
-                elementType
-                formElementType
-                fieldOrder
-                fontName
-                fontSize
-                helpText
-                hideBorder
-                id
-                label
-                labelExtra
-                logicAction
-                logicGroup
-                mapTo
-                options
-                optional
-                page
-                role
-                signer
-                substantive
-                validation
-                value
-              }
-              totalCount
-            }
-          }
-        }
- ```
+## Useful attributes
 
+#### token
+
+Most important of all is providing a security token so that the editor knows who you are
+and that you have access to the template.
+
+#### templateid
+
+This is the api ID of the template that you want to present to the user.
+
+
+#### Filter toolbox
+
+This allows you to choose which field types are available to your users.
+
+
+## Editor Widget Modes
+
+The most important setting is the mode in which you want to use the widget.
+
+### Editor Mode
+This setting provdes all the features that a user might need when creating and editing
+a template in Console. You can allow them to use all the features and restrict some
+features from being shown.
+
+### Compose Mode
+
+Commonly with integrated Legalesign clients, the template and signers have already been generated
+by the client system. Usually this means that all recipient fields have been blended into the 
+document, however what is required is the signature box for each party. Compose mode lets your
+users quickly complete this task.
+
+Compose automatically alters the normal editor in the following ways:
+
+- Detect recipients pre-generated.
+- Hide the Sender from the dropdown
+- Hide document options
+- Move required fields to left box and show by default
+- Make participants read only