legalesign-document-viewer 0.1.1 → 0.1.2

package/dist/types/components/interfaces/IToolboxField.d.ts

@@ -1,6 +1,8 @@
 interface IToolboxField {
     label: string;
-    type: string;
+    elementType: string;
     defaultHeight: number;
     defaultWidth: number;
+    formElementType: string;
+    validation: number;
 }

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

@@ -0,0 +1,15 @@
+import { LSMutateEvent } from '../../../types/LSMutateEvent';
+import { LSApiRole } from '../../../types/LSApiRole';
+import { LSApiElement } from '../../../types/LSApiElement';
+export declare class LsDocumentAdapter {
+    handleEvent: (event: LSMutateEvent, accessToken: string) => Promise<"invalid" | {
+        result: object;
+        obj: LSApiRole | LSApiElement;
+    }>;
+    /**
+     * Run a general query or mutation against the GraphQL API.
+     *
+     *  @returns a promise of a graphQL request
+     */
+    execute(accessToken: string, graphQLQuery: string, _graphQLVariables?: object): Promise<object>;
+}

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

@@ -0,0 +1,4 @@
+declare const createElement: (element: any) => string;
+declare const updateElement: (element: any) => string;
+declare const deleteElement: (obj: any) => string;
+export { createElement, updateElement, deleteElement };

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

@@ -0,0 +1,11 @@
+export declare const Parameters: {
+    endpoints: {
+        graphQL: string;
+        wssHost: string;
+        wssRealTime: string;
+    };
+    buckets: {
+        region: string;
+        clearing: string;
+    };
+};

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

@@ -0,0 +1,5 @@
+declare const createRole: (role: any) => string;
+declare const deleteRole: (role: any) => string;
+declare const updateRole: (role: any) => string;
+declare const swapRoles: (roleId1: any, roleId2: any) => string;
+export { createRole, updateRole, deleteRole, swapRoles };

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

@@ -0,0 +1,3 @@
+declare const updateTemplate: (template: any) => string;
+declare const getTemplate: (id: string) => string;
+export { updateTemplate, getTemplate };

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

@@ -1,2 +1 @@
-import { RoleColor } from "../../types/RoleColor";
-export declare const defaultRolePalette: RoleColor[];
+export declare const defaultRolePalette: string[];

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

@@ -3,7 +3,7 @@ export declare const findIn: (fields: NodeListOf<HTMLLsEditorFieldElement>, sele
 export declare function addField(frame: HTMLElement, data: any): HTMLLsEditorFieldElement;
 export declare function moveField(item: HTMLLsEditorFieldElement, data: any): void;
 export declare const transformCoordinates: (sourceField: LSApiElement, inputFieldWidth: number, inputFieldHeight: number, viewerWidth: number, viewerHeight: number, left: number, top: number, fontName: string, fontSize: number, zoom: number) => LSApiElement;
-export declare const findDimensions: (frameContainer: HTMLDivElement, sourceField: HTMLLsEditorFieldElement, pageHeight: number, pageWidth: number) => {
+export declare const findDimensions: (frameContainer: HTMLDivElement, sourceField: HTMLLsEditorFieldElement, pageHeight: number, pageWidth: number, zoom: number) => {
     top: number;
     left: number;
     height: number;

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

@@ -15,6 +15,7 @@ export declare function oob(obj: LSApiElement): boolean;
 export declare function alter(diffFn: any): void;
 export declare function resetDataItems(): void;
 export declare function debounce(func: any, timeout?: number): (...args: any[]) => void;
+export declare function matchData(data: any): void;
 export declare function getApiType(obj: any): "document" | "unknown" | "invalid" | "element" | "role" | "template";
 export declare const validationTypes: any;
 export declare function getInputType(validation: number): ValidationType;

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

@@ -3,7 +3,6 @@ import { LSApiElement } from '../../types/LSApiElement';
 import 'pdfjs-dist/web/pdf_viewer';
 import { LSApiTemplate } from '../../types/LSApiTemplate';
 import { LSMutateEvent } from '../../types/LSMutateEvent';
-import { RoleColor } from '../../types/RoleColor';
 /**
  * The Legalesign page viewer converted to stencil. To use pass the standard
  * Template information from GraphQL (see Readme).
@@ -16,6 +15,7 @@ export declare class LsDocumentViewer {
     private pdfDocument;
     private pageNumPending;
     private canvas;
+    private adapter;
     private ctx;
     pageDimensions: {
         height: number;
@@ -33,26 +33,38 @@ export declare class LsDocumentViewer {
      * {LSApiTemplate}
      */
     template: string;
+    /**
+     * The access token of the account your want the widget to use, you should normally
+     * acquire this with a server side call using that accounts login credentials.
+     * {string}
+     */
+    token: string;
+    /**
+     * The id of the template you want to load (if using the internal data adapter).
+     * {string}
+     */
+    templateid: string;
     zoom: number;
     pageNum: number;
+    signer: number;
     _template: LSApiTemplate;
     selected: HTMLLsEditorFieldElement[];
     /**
-   * An ease of use property that will arrange document-viewer appropraitely.
-   * {'preview' | 'editor' | 'custom'}
-   */
+     * An ease of use property that will arrange document-viewer appropraitely.
+     * {'preview' | 'editor' | 'custom'}
+     */
     mode: 'preview' | 'editor' | 'custom';
     modeHandler(_newMode: any, _oldMode: any): void;
     tableViewHandler(_newMode: any, _oldMode: any): void;
     /**
-    * Determines / sets which of the far left 'managers' is active.
-    * {'document' | 'toolbox' | 'participant' }
-    */
+     * Determines / sets which of the far left 'managers' is active.
+     * {'document' | 'toolbox' | 'participant' }
+     */
     manager: 'document' | 'toolbox' | 'participant';
     /**
-    * Shows the table view of fields rather than the preview.
-    * {boolean}
-    */
+     * Shows the table view of fields rather than the preview.
+     * {boolean}
+     */
     displayTable?: boolean;
     /**
      * Whether the left hand toolbox is displayed.
@@ -70,45 +82,51 @@ export declare class LsDocumentViewer {
      */
     showstatusbar?: boolean;
     /**
-   * Whether the page previewvertical ribbon will be shown
-   * {boolean}
-   */
+     * Whether the page previewvertical ribbon will be shown
+     * {boolean}
+     */
     showpagepreview?: boolean;
     /**
-  * Whether the right panel (which can be default field properties or custom panel) is
-  * displayed.
-  * {boolean}
-  */
+     * Whether the right panel (which can be default field properties or custom panel) is
+     * displayed.
+     * {boolean}
+     */
     showrightpanel?: boolean;
     /**
-  * Whether the right panel (which can be default field properties or custom panel) is
-  * displayed.
-  * {boolean}
-  */
+     * Whether or not the fields list is expanded.
+     * {boolean}
+     */
+    expandfields?: boolean;
+    /**
+     * Whether the right panel (which can be default field properties or custom panel) is
+     * displayed.
+     * {boolean}
+     */
     readonly?: boolean;
     /**
-  * Whether the table view of the fields on this template is available to the user.
-  * {boolean}
-  */
+     * Whether the table view of the fields on this template is available to the user.
+     * {boolean}
+     */
     showtableview?: boolean;
     /**
-   * If supplied ONLY items in this | ("or") delimited list will be shown. i.e. "signature|intials"
-   * {boolean}
-   */
+     * If supplied ONLY items in this | ("or") delimited list will be shown. i.e. "signature|intials"
+     * {boolean}
+     */
     toolboxFilter?: string;
     /**
-   * Allows you to change the colours used for each role in the template.
-   * {SignerColor[]}
-   */
-    roleColors?: RoleColor[];
-    parseTemplate(newValue: string): void;
+     * Allows you to change the colours used for each role in the template.
+     * {SignerColor[]}
+     */
+    roleColors?: string[];
     pageRendered: EventEmitter<number>;
     pageChange: EventEmitter<number>;
     selectFields: EventEmitter<LSApiElement[]>;
     mutate: EventEmitter<LSMutateEvent[]>;
     update: EventEmitter<LSMutateEvent[]>;
+    mutateHandler(event: CustomEvent<LSMutateEvent[]>): void;
     updateHandler(event: CustomEvent<LSMutateEvent[]>): void;
     selectFieldsHandler(event: CustomEvent<LSApiElement[]>): void;
+    roleHandler(event: CustomEvent<number>): void;
     /**
      * Page forward
      * {MouseEvent} e
@@ -120,10 +138,15 @@ export declare class LsDocumentViewer {
      */
     pagePrev(): Promise<void>;
     /**
-   * Page and field resize on zoom change
-   *
-   */
+     * Page and field resize on zoom change
+     *
+     */
     setZoom(z: number): Promise<void>;
+    /**
+     * Decorate the template data object with useful transformations.
+     * {string} json of template
+     */
+    parseTemplate(newValue: string): void;
     /**
      * Render the page based on pageNumber
      * {number} pageNumber
@@ -133,8 +156,9 @@ export declare class LsDocumentViewer {
     private loadAndRender;
     prepareElement(newElement: LSApiElement): LSApiElement;
     syncChange(update: LSMutateEvent): void;
-    componentDidLoad(): void;
+    initViewer(): void;
     showPageFields(page: number): void;
+    load(): Promise<void>;
     componentWillLoad(): void;
     render(): any;
 }

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

@@ -2,3 +2,4 @@ export declare function mouseDown(e: any): void;
 export declare function mouseMove(event: any): void;
 export declare function mouseUp(event: any): void;
 export declare function mouseClick(e: any): void;
+export declare function mouseDrop(event: any): void;

package/dist/types/components/ls-editor-field/ls-editor-field.d.ts

@@ -1,10 +1,10 @@
-import { LSApiElement, RoleColor } from '../../components';
+import { LSApiElement } from '../../components';
 export declare class LsEditorField {
     component: HTMLElement;
     dataItem: LSApiElement;
     selected: boolean;
     readonly: boolean;
-    palette: RoleColor[];
+    palette: string[];
     type: 'text' | 'signature' | 'date' | 'regex' | 'file' | 'number' | 'autodate';
     page: {
         height: number;
@@ -22,5 +22,6 @@ export declare class LsEditorField {
     watchSelectedHandler(_newValue: boolean, _oldValue: boolean): void;
     onInputChange(e: any): void;
     componentDidLoad(): void;
+    participantColor: (index: number) => string;
     render(): any;
 }

package/dist/types/components/ls-feature-column/ls-feature-column.d.ts

@@ -1,9 +1,9 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 export declare class LsFeatureColoumn {
     /**
-    * Determines / sets which of the far left 'managers' is active.
-    * {'document' | 'toolbox' | 'participant' }
-    */
+     * Determines / sets which of the far left 'managers' is active.
+     * {'document' | 'toolbox' | 'participant' }
+     */
     manager: 'document' | 'toolbox' | 'participant';
     manage: EventEmitter<'document' | 'toolbox' | 'participant'>;
     render(): any;

package/dist/types/components/ls-field-placement/ls-field-placement.d.ts

@@ -0,0 +1,11 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { LSApiElement, LSMutateEvent } from '../../components';
+export declare class LsFieldPlacement {
+    dataItem: LSApiElement | LSApiElement[];
+    mutate: EventEmitter<LSMutateEvent[]>;
+    update: EventEmitter<LSMutateEvent[]>;
+    isSingle(dt: LSApiElement | LSApiElement[]): dt is LSApiElement;
+    isMultiple(dt: LSApiElement | LSApiElement[]): dt is LSApiElement[];
+    alter(diff: object): void;
+    render(): any;
+}

package/dist/types/components/ls-field-properties-signature/ls-field-properties-signature.d.ts

@@ -1,5 +1,6 @@
 import { LSApiElement } from '../../components';
 export declare class LsFieldPropertiesSignature {
     dataItem: LSApiElement;
+    fieldSet: 'content' | 'placement' | 'dimensions';
     render(): any;
 }

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

@@ -5,9 +5,9 @@ import { LSApiRole } from '../../types/LSApiRole';
 import { LSMutateEvent } from '../../types/LSMutateEvent';
 export declare class LsParticipantManager {
     /**
-   * The base template information (as JSON).
-   * {LSDocumentViewer}
-   */
+     * The base template information (as JSON).
+     * {LSDocumentViewer}
+     */
     editor: LsDocumentViewer;
     /**
      * The base template information (as JSON).
@@ -20,5 +20,6 @@ export declare class LsParticipantManager {
     deleteHandler(role: LSApiRole): void;
     swapHandler(role1: any, role2: any): void;
     createHandler(): void;
+    participantColor: (index: number) => string;
     render(): any;
 }

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

@@ -1,3 +1,31 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { LSApiRole } from '../../types/LSApiRole';
+import { LSApiElement, LSMutateEvent } from '../../components';
 export declare class LsParticipantSelect {
+    dataItem: LSApiElement[];
+    /**
+     * The currently selected role.
+     * {number}
+     */
+    selectedRole: {
+        signerIndex: number;
+        name: string;
+    };
+    /**
+     * The current template roles.
+     * {LSApiRole}
+     */
+    roles?: LSApiRole[];
+    isOpen: boolean;
+    mutate: EventEmitter<LSMutateEvent[]>;
+    update: EventEmitter<LSMutateEvent[]>;
+    alter(diff: object): void;
+    toggleDropdown: () => void;
+    roleChange: EventEmitter<number>;
+    selectRole(role: {
+        signerIndex: number;
+        name: string;
+    }): void;
+    participantColor: (index: number) => string;
     render(): any;
 }

package/dist/types/components/ls-statusbar/ls-statusbar.d.ts

@@ -2,14 +2,14 @@ import { LsDocumentViewer } from '../ls-document-viewer/ls-document-viewer';
 export declare class LsStatusbar {
     component: HTMLElement;
     /**
-  * The zoom or scale level 100 === 100%.
-  * {number}
-  */
+     * The zoom or scale level 100 === 100%.
+     * {number}
+     */
     zoom: number;
     /**
-  * The parent editor control.
-  * {LsDocumentViewer}
-  */
+     * The parent editor control.
+     * {LsDocumentViewer}
+     */
     editor: LsDocumentViewer;
     setZoom(value: number): void;
     handleZoomInput(): void;

package/dist/types/components/ls-toggle/ls-toggle.d.ts

@@ -0,0 +1,3 @@
+export declare class LsToggle {
+    render(): any;
+}

package/dist/types/components/ls-toolbar/ls-toolbar.d.ts

@@ -1,9 +1,10 @@
-import { LSApiElement, LSApiTemplate, LsDocumentViewer } from '../../components';
+import { EventEmitter } from '../../stencil-public-runtime';
+import { LSApiElement, LSApiTemplate, LsDocumentViewer, LSMutateEvent } from '../../components';
 export declare class LsToolbar {
     /**
-   * The selected items information (as JSON).
-   * {LSApiElement[]}
-   */
+     * The selected items information (as JSON).
+     * {LSApiElement[]}
+     */
     dataItem: LSApiElement[];
     /**
      * The base template information (as JSON).
@@ -11,9 +12,12 @@ export declare class LsToolbar {
      */
     template: LSApiTemplate;
     /**
-   * The base template information (as JSON).
-   * {LSDocumentViewer}
-   */
+     * The base template information (as JSON).
+     * {LSDocumentViewer}
+     */
     editor: LsDocumentViewer;
+    mutate: EventEmitter<LSMutateEvent[]>;
+    update: EventEmitter<LSMutateEvent[]>;
+    alter(diff: object): void;
     render(): any;
 }

package/dist/types/components/ls-toolbox-field/ls-toolbox-field.d.ts

@@ -1,3 +1,4 @@
+import { Icon } from '../../types/Icon';
 export declare class LsToolboxField {
     /**
      * The field type of this toolbox item, e.g. 'signature'. Note these should always be lowercase.
@@ -6,9 +7,13 @@ export declare class LsToolboxField {
     elementType: string;
     validation: number;
     /**
-    * The text to display for this field type.
+     * The text to display for this field type.
      */
     label: string;
+    /**
+     * The icon to display for this field type.
+     */
+    icon: Icon;
     /**
      * The starting height of this control type in pixels.
      */