fhdp-fh-starter 4.10.301 → 4.10.401

package/FhApplication.ts

@@ -1,367 +1,367 @@
-import "reflect-metadata";
-import {
-    ApplicationLock,
-    Connector,
-    CustomActions,
-    FH,
-    FhContainer,
-    FhModule,
-    FormsHandler,
-    I18n,
-    ServiceManagerUtil,
-    SocketHandler,
-    Util
-} from "fh-forms-handler";
-import {BasicControls} from "fh-basic-controls";
-import {ChartsControls} from "fh-charts-controls";
-import {FhDPControls} from "fhdp-controls";
-import {DynamicRelocatorExclusionRule, DynamicRelocatorExtensionRule, getCookie, FHDPExtender} from 'fhdp-extenders';
-
-export interface LiferayConfig {
-    /** Defines if liferay is enabled or not */
-    enabled: boolean;
-    /** Local websocket addres For debug */
-    localPumaWsURL: string;
-    /** Remote websocket address */
-    fhBaseUrl: string;
-    /** Remote context path */
-    fhContextPath: string;
-}
-
-export interface ExtenderConfig {
-    extendFHML?: boolean;
-    mobileMaxWidth?: number;
-    enableMobileNavbar?: boolean;
-    enableErrorBelowField?: boolean;
-    enableDynamicFooterPosition?: boolean;
-    enableCurrentMenuElementHighlight?: boolean;
-    currentMenuElementHighlighBottomBorderStyle?: string;
-    enableFHMLinTooltips?: boolean;
-    enableSessionCounterRules?: boolean;
-    enableCookieAlert?: boolean;
-    additionalRules?: Array<DynamicRelocatorExclusionRule | DynamicRelocatorExtensionRule>;
-}
-
-export interface FhApplicationConfig {
-    /** Defines registration of standard modules (FormsHandler and BasicControls) */
-    registerStandardModules?: boolean;
-    /** Defines registration of Charts module */
-    registerChartsControls?: boolean;
-    /** Defines registration of FHDP controls module*/
-    registerFHDPControls?: boolean;
-    /** Defines registration of additional modules*/
-    additionalModules?: ({ new(): FhModule})[];
-    /** Defines translations for connection lost message Default contains messages for polish and english languages */
-    connectionLostTranslations?: {[key: string]: string};
-    /** Defines config for liferay If empty it will act as normal application */
-    liferay?: LiferayConfig;
-    /** Defines config for FHDPExtender If empty it will act as normal fh app without extensions */
-    extensionsConfig?: ExtenderConfig
-}
-
-type ConnectorType = (target: string, reconnectCallback: () => void, openCallback: () => void) => Connector;
-
-class FhApplication {
-    /** Instance of FhApplication */
-    private static __instance: FhApplication;
-
-    /** Current config */
-    private __config: FhApplicationConfig;
-
-    /** Instance of Liferay config */
-    private __liferay?: LiferayConfig;
-
-    /** Instance of connector */
-    private __connector?: Connector;
-
-    /**
-     * Private and used internally
-     * @param config main configuration
-     */
-    private constructor(config: FhApplicationConfig) {
-        this.__config = config;
-        if (config.registerStandardModules) {
-            this.registerModule(FormsHandler);
-            this.registerModule(BasicControls);
-        }
-        if (config.registerChartsControls) {
-            this.registerModule(ChartsControls);
-        }
-        if (config.registerFHDPControls) {
-            this.registerModule(FhDPControls);
-        }
-        if (config.additionalModules) {
-            config.additionalModules.forEach(mod => {
-                this.registerModule(mod);
-            })
-        }
-        if (config.liferay && config.liferay.enabled) {
-            this.__liferay = config.liferay;
-        }
-
-
-    }
-
-    /**
-     * At first use must be called with `config` param, to properly init instance
-     * Later uses can be without param, and it will return same instance as one inited at begin
-     * @param config main configuration
-     */
-    static getInstance(config?: FhApplicationConfig) {
-        if (!FhApplication.__instance && config) {
-            FhApplication.__instance = new FhApplication(config);
-        } else if (!FhApplication.__instance && !config) {
-            console.error('Init instance first with config');
-        }
-        return FhApplication.__instance;
-    }
-
-    /**
-     * Getter for connection lost translations
-     */
-    private get currentConnectionLostTranslation(): string {
-        let i18n = FhContainer.get<I18n>('I18n');
-        return i18n.translateString('connectionLostRetry', undefined, i18n.selectedLanguage);
-    }
-
-    private isJSON(data:string) {
-        try {
-            return JSON.parse(data);
-        } catch (e) {
-            return false;
-        }
-    }
-
-    /**
-     * Getter for connector;
-     * @returns Connector
-     */
-    getConnector(): Connector {
-        return this.__connector;
-    }
-
-    /**
-     * Registers new module Its alternative function to config node `additionalModules`
-     * @param module an module that will be registered in fh app
-     */
-    registerModule(module: { new(): FhModule}) {
-        new module().init();
-    }
-
-    /**
-     * Registers callback for backend calls
-     * @param name callback name (key)
-     * @param callback actual callback function
-     */
-    registerCallback(name: string, callback: (...args) => void) {
-        let customActions = FhContainer.get<CustomActions>('CustomActions');
-
-        if (customActions == null) {
-            return new Error('CustomActions is not registered.');
-        }
-
-        customActions.callbacks[name] = callback;
-    }
-
-    /**
-     * Function for initialise extenders
-     */
-    private initExtenders() {
-        const i18n = FhContainer.get<I18n>('I18n');
-        new FHDPExtender({
-            i18n,
-            ...this.__config.extensionsConfig
-        });
-    }
-
-    /**
-     * Adds translation string
-     */
-    public addTranslation(lang, key, translation) {
-        let i18n = FhContainer.get<I18n>('I18n');
-        i18n.registerStrings(
-            lang,
-            {
-                [key]: translation
-            },
-            true
-        );
-    }
-
-    /**
-     * get translation string
-     */
-    public translate(key, args) {
-        let i18n = FhContainer.get<I18n>('I18n');
-        return i18n.translateString(key, args, i18n.selectedLanguage);
-    }
-
-    /**
-     * Initialise translations for connection lost
-     */
-    private initConnectionLostTranslations() {
-        let i18n = FhContainer.get<I18n>('I18n');
-        i18n.registerStrings(
-            'pl',
-            {
-                connectionLostRetry: 'Połączenie z serwerem zostało przerwane. Ponawiam próbę połączenia...'
-            },
-            true
-        );
-        i18n.registerStrings(
-            'en',
-            {
-                connectionLostRetry: 'Connection with server is broken. Trying to reconnect...'
-            },
-            true
-        );
-        if (this.__config.connectionLostTranslations) {
-            Object.keys(this.__config.connectionLostTranslations).forEach(iso => {
-                i18n.registerStrings(
-                    iso,
-                    {
-                        connectionLostRetry: this.__config.connectionLostTranslations[iso]
-                    },
-                    true
-                );
-            })
-        }
-    }
-
-    /**
-     * Main init function
-     * @param context app context for sockets Default 'socketForms'
-     */
-    init(context: string = 'socketForms') {
-        let util = FhContainer.get<Util>('Util');
-        let i18n = FhContainer.get<I18n>('I18n');
-        if (this.__config.extensionsConfig) {
-            this.initExtenders();
-        }
-        this.initConnectionLostTranslations();
-
-        let contextPath: string;
-        if (this.__liferay) {
-            if (this.__liferay.fhBaseUrl != null) {
-                contextPath = `${this.__liferay.fhBaseUrl.replace('http:/', 'ws:/').replace('https:/', 'wss:/')}${this.__liferay.fhContextPath}/socketForms`;
-            } else {
-                contextPath = this.__liferay.localPumaWsURL;
-            }
-        } else {
-            contextPath = util.getPath(context);
-        }
-
-        this.__connector = FhContainer.get<ConnectorType>("Connector")(
-            contextPath, () => {
-                FhContainer.get<ApplicationLock>('ApplicationLock')
-                    .createInfoDialog(this.currentConnectionLostTranslation);
-            }, () => {
-                FhContainer.get<ApplicationLock>('ApplicationLock')
-                    .closeInfoDialog();
-            }
-        );
-
-        if (this.__liferay && (window as any).Liferay) {
-            this.__connector.incomingMessageCallback = function (data) {
-                const isJSON = (data:any) => {
-                    try {
-                        return JSON.parse(data);
-                    } catch (e) {
-                        return false;
-                    }
-                }
-                const json = isJSON(data);
-                console.log('incomingMessageCallback');
-                if ((window as any).Liferay.Session && (!json || json.eventType !== 'onTimer')) {
-                    (window as any).Liferay.Session.extend();
-                }
-            };
-            this.__connector.outcomingMessageCallback = function (data) {
-                const isJSON = (data:any) => {
-                    try {
-                        return JSON.parse(data);
-                    } catch (e) {
-                        return false;
-                    }
-                }
-                const json = isJSON(data);
-                console.log('outcomingMessageCallback');
-                if ((window as any).Liferay.Session && (!json || json.eventType !== 'onTimer')) {
-                    (window as any).Liferay.Session.extend();
-                }
-                // after init discard any query parameters from url to prevent repeated actions (e.g. redirect from external page with action in parameter)
-                if (json && json.command == 'Init') {
-                    history.replaceState(history.state, document.title, location.origin + location.pathname);
-                    if (parent) {
-                        parent.history.replaceState(parent.history.state, parent.document.title, parent.location.origin + parent.location.pathname);
-                    }
-                }
-            };
-        }
-
-        FhContainer.rebind<Connector>("Connector").toConstantValue(this.__connector);
-        FhContainer.get<SocketHandler>('SocketHandler').addConnector(this.__connector);
-
-        try {
-            const cookie = getCookie();
-            if(cookie && cookie['GUEST_LANGUAGE_ID']) {
-                i18n.selectLanguage(cookie['GUEST_LANGUAGE_ID']);
-                console.log("LANGUAGE SELECTED ON START(GUEST_LANGUAGE_ID): ", cookie['GUEST_LANGUAGE_ID'])
-            } else if (cookie && cookie['USERLANG']) {
-                i18n.selectLanguage(cookie['USERLANG']);
-                console.log("LANGUAGE SELECTED ON START: ", cookie['USERLANG'])
-            }
-        } catch (e) {
-            console.warn(e);
-        }
-        if (this.__liferay) {
-            FhContainer.get<FH>('FH').initExternal(this.__liferay.localPumaWsURL);
-        } else {
-            FhContainer.get<FH>('FH').init();
-        }
-        this.registerCallback('callUcAction', (actionName) => {
-            FhContainer.get<ServiceManagerUtil>('ServiceManagerUtil').callAction('callUcAction', actionName);
-        });
-    }
-
-    /**
-     * Edits classlist of element provided by id
-     * @param id Id of DOM element
-     * @param remove class name that should be removed from element
-     * @param add class name that should be added in element
-     */
-    createCallbackById(id: string, remove?: string, add?: string) {
-        const element = document.getElementById(id);
-        if(!!element) {
-            if(!!remove) {
-                element.classList.remove(remove);
-            }
-            if(!!add) {
-                element.classList.add(add);
-            }
-        }
-    }
-
-    /**
-     * Edits classlist of element wrapper provided by id
-     * @param id Id of DOM element
-     * @param remove class name that should be removed from element wrapper
-     * @param add class name that should be added in element wrapper
-     */
-    createCallbackByWrapper(id: string, remove?: string, add?: string) {
-        const element = document.getElementById(id);
-        if(!!element) {
-            const wrapper = (element.parentNode as HTMLElement);
-            if(!!wrapper) {
-                if(!!remove) {
-                    wrapper.classList.remove(remove);
-                }
-                if(!!add) {
-                    wrapper.classList.add(add);
-                }
-            }
-        }
-    }
-}
-
-export {FhApplication};
+import "reflect-metadata";
+import {
+    ApplicationLock,
+    Connector,
+    CustomActions,
+    FH,
+    FhContainer,
+    FhModule,
+    FormsHandler,
+    I18n,
+    ServiceManagerUtil,
+    SocketHandler,
+    Util
+} from "fh-forms-handler";
+import {BasicControls} from "fh-basic-controls";
+import {ChartsControls} from "fh-charts-controls";
+import {FhDPControls} from "fhdp-controls";
+import {DynamicRelocatorExclusionRule, DynamicRelocatorExtensionRule, getCookie, FHDPExtender} from 'fhdp-extenders';
+
+export interface LiferayConfig {
+    /** Defines if liferay is enabled or not */
+    enabled: boolean;
+    /** Local websocket addres For debug */
+    localPumaWsURL: string;
+    /** Remote websocket address */
+    fhBaseUrl: string;
+    /** Remote context path */
+    fhContextPath: string;
+}
+
+export interface ExtenderConfig {
+    extendFHML?: boolean;
+    mobileMaxWidth?: number;
+    enableMobileNavbar?: boolean;
+    enableErrorBelowField?: boolean;
+    enableDynamicFooterPosition?: boolean;
+    enableCurrentMenuElementHighlight?: boolean;
+    currentMenuElementHighlighBottomBorderStyle?: string;
+    enableFHMLinTooltips?: boolean;
+    enableSessionCounterRules?: boolean;
+    enableCookieAlert?: boolean;
+    additionalRules?: Array<DynamicRelocatorExclusionRule | DynamicRelocatorExtensionRule>;
+}
+
+export interface FhApplicationConfig {
+    /** Defines registration of standard modules (FormsHandler and BasicControls) */
+    registerStandardModules?: boolean;
+    /** Defines registration of Charts module */
+    registerChartsControls?: boolean;
+    /** Defines registration of FHDP controls module*/
+    registerFHDPControls?: boolean;
+    /** Defines registration of additional modules*/
+    additionalModules?: ({ new(): FhModule})[];
+    /** Defines translations for connection lost message Default contains messages for polish and english languages */
+    connectionLostTranslations?: {[key: string]: string};
+    /** Defines config for liferay If empty it will act as normal application */
+    liferay?: LiferayConfig;
+    /** Defines config for FHDPExtender If empty it will act as normal fh app without extensions */
+    extensionsConfig?: ExtenderConfig
+}
+
+type ConnectorType = (target: string, reconnectCallback: () => void, openCallback: () => void) => Connector;
+
+class FhApplication {
+    /** Instance of FhApplication */
+    private static __instance: FhApplication;
+
+    /** Current config */
+    private __config: FhApplicationConfig;
+
+    /** Instance of Liferay config */
+    private __liferay?: LiferayConfig;
+
+    /** Instance of connector */
+    private __connector?: Connector;
+
+    /**
+     * Private and used internally
+     * @param config main configuration
+     */
+    private constructor(config: FhApplicationConfig) {
+        this.__config = config;
+        if (config.registerStandardModules) {
+            this.registerModule(FormsHandler);
+            this.registerModule(BasicControls);
+        }
+        if (config.registerChartsControls) {
+            this.registerModule(ChartsControls);
+        }
+        if (config.registerFHDPControls) {
+            this.registerModule(FhDPControls);
+        }
+        if (config.additionalModules) {
+            config.additionalModules.forEach(mod => {
+                this.registerModule(mod);
+            })
+        }
+        if (config.liferay && config.liferay.enabled) {
+            this.__liferay = config.liferay;
+        }
+
+
+    }
+
+    /**
+     * At first use must be called with `config` param, to properly init instance
+     * Later uses can be without param, and it will return same instance as one inited at begin
+     * @param config main configuration
+     */
+    static getInstance(config?: FhApplicationConfig) {
+        if (!FhApplication.__instance && config) {
+            FhApplication.__instance = new FhApplication(config);
+        } else if (!FhApplication.__instance && !config) {
+            console.error('Init instance first with config');
+        }
+        return FhApplication.__instance;
+    }
+
+    /**
+     * Getter for connection lost translations
+     */
+    private get currentConnectionLostTranslation(): string {
+        let i18n = FhContainer.get<I18n>('I18n');
+        return i18n.translateString('connectionLostRetry', undefined, i18n.selectedLanguage);
+    }
+
+    private isJSON(data:string) {
+        try {
+            return JSON.parse(data);
+        } catch (e) {
+            return false;
+        }
+    }
+
+    /**
+     * Getter for connector;
+     * @returns Connector
+     */
+    getConnector(): Connector {
+        return this.__connector;
+    }
+
+    /**
+     * Registers new module Its alternative function to config node `additionalModules`
+     * @param module an module that will be registered in fh app
+     */
+    registerModule(module: { new(): FhModule}) {
+        new module().init();
+    }
+
+    /**
+     * Registers callback for backend calls
+     * @param name callback name (key)
+     * @param callback actual callback function
+     */
+    registerCallback(name: string, callback: (...args) => void) {
+        let customActions = FhContainer.get<CustomActions>('CustomActions');
+
+        if (customActions == null) {
+            return new Error('CustomActions is not registered.');
+        }
+
+        customActions.callbacks[name] = callback;
+    }
+
+    /**
+     * Function for initialise extenders
+     */
+    private initExtenders() {
+        const i18n = FhContainer.get<I18n>('I18n');
+        new FHDPExtender({
+            i18n,
+            ...this.__config.extensionsConfig
+        });
+    }
+
+    /**
+     * Adds translation string
+     */
+    public addTranslation(lang, key, translation) {
+        let i18n = FhContainer.get<I18n>('I18n');
+        i18n.registerStrings(
+            lang,
+            {
+                [key]: translation
+            },
+            true
+        );
+    }
+
+    /**
+     * get translation string
+     */
+    public translate(key, args) {
+        let i18n = FhContainer.get<I18n>('I18n');
+        return i18n.translateString(key, args, i18n.selectedLanguage);
+    }
+
+    /**
+     * Initialise translations for connection lost
+     */
+    private initConnectionLostTranslations() {
+        let i18n = FhContainer.get<I18n>('I18n');
+        i18n.registerStrings(
+            'pl',
+            {
+                connectionLostRetry: 'Połączenie z serwerem zostało przerwane. Ponawiam próbę połączenia...'
+            },
+            true
+        );
+        i18n.registerStrings(
+            'en',
+            {
+                connectionLostRetry: 'Connection with server is broken. Trying to reconnect...'
+            },
+            true
+        );
+        if (this.__config.connectionLostTranslations) {
+            Object.keys(this.__config.connectionLostTranslations).forEach(iso => {
+                i18n.registerStrings(
+                    iso,
+                    {
+                        connectionLostRetry: this.__config.connectionLostTranslations[iso]
+                    },
+                    true
+                );
+            })
+        }
+    }
+
+    /**
+     * Main init function
+     * @param context app context for sockets Default 'socketForms'
+     */
+    init(context: string = 'socketForms') {
+        let util = FhContainer.get<Util>('Util');
+        let i18n = FhContainer.get<I18n>('I18n');
+        if (this.__config.extensionsConfig) {
+            this.initExtenders();
+        }
+        this.initConnectionLostTranslations();
+
+        let contextPath: string;
+        if (this.__liferay) {
+            if (this.__liferay.fhBaseUrl != null) {
+                contextPath = `${this.__liferay.fhBaseUrl.replace('http:/', 'ws:/').replace('https:/', 'wss:/')}${this.__liferay.fhContextPath}/socketForms`;
+            } else {
+                contextPath = this.__liferay.localPumaWsURL;
+            }
+        } else {
+            contextPath = util.getPath(context);
+        }
+
+        this.__connector = FhContainer.get<ConnectorType>("Connector")(
+            contextPath, () => {
+                FhContainer.get<ApplicationLock>('ApplicationLock')
+                    .createInfoDialog(this.currentConnectionLostTranslation);
+            }, () => {
+                FhContainer.get<ApplicationLock>('ApplicationLock')
+                    .closeInfoDialog();
+            }
+        );
+
+        if (this.__liferay && (window as any).Liferay) {
+            this.__connector.incomingMessageCallback = function (data) {
+                const isJSON = (data:any) => {
+                    try {
+                        return JSON.parse(data);
+                    } catch (e) {
+                        return false;
+                    }
+                }
+                const json = isJSON(data);
+                console.log('incomingMessageCallback');
+                if ((window as any).Liferay.Session && (!json || json.eventType !== 'onTimer')) {
+                    (window as any).Liferay.Session.extend();
+                }
+            };
+            this.__connector.outcomingMessageCallback = function (data) {
+                const isJSON = (data:any) => {
+                    try {
+                        return JSON.parse(data);
+                    } catch (e) {
+                        return false;
+                    }
+                }
+                const json = isJSON(data);
+                console.log('outcomingMessageCallback');
+                if ((window as any).Liferay.Session && (!json || json.eventType !== 'onTimer')) {
+                    (window as any).Liferay.Session.extend();
+                }
+                // after init discard any query parameters from url to prevent repeated actions (e.g. redirect from external page with action in parameter)
+                if (json && json.command == 'Init') {
+                    history.replaceState(history.state, document.title, location.origin + location.pathname);
+                    if (parent) {
+                        parent.history.replaceState(parent.history.state, parent.document.title, parent.location.origin + parent.location.pathname);
+                    }
+                }
+            };
+        }
+
+        FhContainer.rebind<Connector>("Connector").toConstantValue(this.__connector);
+        FhContainer.get<SocketHandler>('SocketHandler').addConnector(this.__connector);
+
+        try {
+            const cookie = getCookie();
+            if(cookie && cookie['GUEST_LANGUAGE_ID']) {
+                i18n.selectLanguage(cookie['GUEST_LANGUAGE_ID']);
+                console.log("LANGUAGE SELECTED ON START(GUEST_LANGUAGE_ID): ", cookie['GUEST_LANGUAGE_ID'])
+            } else if (cookie && cookie['USERLANG']) {
+                i18n.selectLanguage(cookie['USERLANG']);
+                console.log("LANGUAGE SELECTED ON START: ", cookie['USERLANG'])
+            }
+        } catch (e) {
+            console.warn(e);
+        }
+        if (this.__liferay) {
+            FhContainer.get<FH>('FH').initExternal(this.__liferay.localPumaWsURL);
+        } else {
+            FhContainer.get<FH>('FH').init();
+        }
+        this.registerCallback('callUcAction', (actionName) => {
+            FhContainer.get<ServiceManagerUtil>('ServiceManagerUtil').callAction('callUcAction', actionName);
+        });
+    }
+
+    /**
+     * Edits classlist of element provided by id
+     * @param id Id of DOM element
+     * @param remove class name that should be removed from element
+     * @param add class name that should be added in element
+     */
+    createCallbackById(id: string, remove?: string, add?: string) {
+        const element = document.getElementById(id);
+        if(!!element) {
+            if(!!remove) {
+                element.classList.remove(remove);
+            }
+            if(!!add) {
+                element.classList.add(add);
+            }
+        }
+    }
+
+    /**
+     * Edits classlist of element wrapper provided by id
+     * @param id Id of DOM element
+     * @param remove class name that should be removed from element wrapper
+     * @param add class name that should be added in element wrapper
+     */
+    createCallbackByWrapper(id: string, remove?: string, add?: string) {
+        const element = document.getElementById(id);
+        if(!!element) {
+            const wrapper = (element.parentNode as HTMLElement);
+            if(!!wrapper) {
+                if(!!remove) {
+                    wrapper.classList.remove(remove);
+                }
+                if(!!add) {
+                    wrapper.classList.add(add);
+                }
+            }
+        }
+    }
+}
+
+export {FhApplication};

package/Module.ts

@@ -1,5 +1,5 @@
-import {FhApplication} from './FhApplication';
-
-export {
-  FhApplication
+import {FhApplication} from './FhApplication';
+
+export {
+  FhApplication
 }

package/README.md

@@ -1,67 +1,67 @@
-# QuickStart!
-
-## Example use:
-
-```
-const fhInstance = FhApplication.getInstance({
-            registerStandardModules: true,
-            registerChartsControls: true,
-            registerFhDPControls: true,
-            extensionsConfig: {
-                extendFHML: true
-            }
-});
-
-fhInstance.init();
-```
-
-## Example use in portlet:
-
-```
-const localPumaWsURL = 'ws://localhost:8090/socketForms';
-const fhInstance = FhApplication.getInstance({
-            registerStandardModules: true,
-            registerChartsControls: true,
-            registerFhDPControls: true,
-            extensionsConfig: {
-                extendFHML: true
-            },
-            liferay: {
-              enabled: true,
-              fhBaseUrl,
-              fhContextPath,
-              localPumaWsURL,
-              Liferay
-            }
-});
-
-fhInstance.init();
-```
-
-Values `fhBaseUrl`, `fhContextPath` and `Liferay` should be provided from template jsp file, and defined at the top as:
-
-```
-declare const Liferay: any;
-declare const fhBaseUrl: string;
-declare const fhContextPath: string;
-```
-
-## Additional info
-
-1. Type `extensionsConfig` is provided by library `fhdp-extenders`.
-2. This package contains the latest versions of fh components, fhdp-components and fdhp-extenders, if you're including this package you don't have need to including them.
-
-## Versions table:
-
-| fhdp-fh-starter version | lib name          | included version |
-|:------------------------:|:------------------|:----------------:|
-| v.18.0.0 - v.18.0.11     | fh-basic-controls | 4.6.25-test2     |
-|                          | fh-charts-controls| 4.6.25           |
-|                          | fh-designer       | 4.6.25           |
-|                          | fh-forms-handler  | 4.6.25           |
-|                          | fh-maps-controls  | 4.6.25           |
-|                          | fh-printer-agent  | 4.6.25           |
-|                          | fh-sensors        | 4.6.25           |
-|                          | fhdp-controls     | 18.1.3           |
-|                          | fhdp-extenders    | 18.0.4           |
-|--------------------------|-------------------|------------------|
+# QuickStart!
+
+## Example use:
+
+```
+const fhInstance = FhApplication.getInstance({
+            registerStandardModules: true,
+            registerChartsControls: true,
+            registerFhDPControls: true,
+            extensionsConfig: {
+                extendFHML: true
+            }
+});
+
+fhInstance.init();
+```
+
+## Example use in portlet:
+
+```
+const localPumaWsURL = 'ws://localhost:8090/socketForms';
+const fhInstance = FhApplication.getInstance({
+            registerStandardModules: true,
+            registerChartsControls: true,
+            registerFhDPControls: true,
+            extensionsConfig: {
+                extendFHML: true
+            },
+            liferay: {
+              enabled: true,
+              fhBaseUrl,
+              fhContextPath,
+              localPumaWsURL,
+              Liferay
+            }
+});
+
+fhInstance.init();
+```
+
+Values `fhBaseUrl`, `fhContextPath` and `Liferay` should be provided from template jsp file, and defined at the top as:
+
+```
+declare const Liferay: any;
+declare const fhBaseUrl: string;
+declare const fhContextPath: string;
+```
+
+## Additional info
+
+1. Type `extensionsConfig` is provided by library `fhdp-extenders`.
+2. This package contains the latest versions of fh components, fhdp-components and fdhp-extenders, if you're including this package you don't have need to including them.
+
+## Versions table:
+
+| fhdp-fh-starter version | lib name          | included version |
+|:------------------------:|:------------------|:----------------:|
+| v.18.0.0 - v.18.0.11     | fh-basic-controls | 4.6.25-test2     |
+|                          | fh-charts-controls| 4.6.25           |
+|                          | fh-designer       | 4.6.25           |
+|                          | fh-forms-handler  | 4.6.25           |
+|                          | fh-maps-controls  | 4.6.25           |
+|                          | fh-printer-agent  | 4.6.25           |
+|                          | fh-sensors        | 4.6.25           |
+|                          | fhdp-controls     | 18.1.3           |
+|                          | fhdp-extenders    | 18.0.4           |
+|--------------------------|-------------------|------------------|

package/cached-package.json

@@ -1 +1 @@
-{"name":"fhdp-fh-starter","version":"4.10.301","author":{"name":"Jakub Kosecki","email":"j.kosecki@doittechnology.pl"},"description":"Configurable starter for asseco/fh","main":"dist/Module.js","types":"dist/Module.d.ts","scripts":{"prepublish":"node prepublish","postpublish":"node postpublish","build":"tsc","docgen":"npx typedoc ./FhApplication.ts","prepare":"yarn build","test":"echo \"Error: no test specified\" && exit 1"},"devDependencies":{"@types/bootstrap":"4.3.1","@types/jquery":"3.3.31","@types/node":"14.14.36","typedoc":"^0.20.20","typescript":"3.9"},"dependencies":{"fh-basic-controls":"4.10.301","fh-charts-controls":"4.10.301","fh-forms-handler":"4.10.301","fhdp-controls":"4.10.301","fhdp-extenders":"4.10.301"}}
+{"name":"fhdp-fh-starter","version":"4.10.401","author":{"name":"Jakub Kosecki","email":"j.kosecki@doittechnology.pl"},"description":"Configurable starter for asseco/fh","main":"dist/Module.js","types":"dist/Module.d.ts","scripts":{"prepublish":"node prepublish","postpublish":"node postpublish","build":"tsc","docgen":"npx typedoc ./FhApplication.ts","prepare":"yarn build","test":"echo \"Error: no test specified\" && exit 1"},"devDependencies":{"@types/bootstrap":"4.3.1","@types/jquery":"3.3.31","@types/node":"14.14.36","typedoc":"^0.20.20","typescript":"3.9"},"dependencies":{"fh-basic-controls":"4.10.401","fh-charts-controls":"4.10.401","fh-forms-handler":"4.10.401","fhdp-controls":"4.10.401","fhdp-extenders":"4.10.401"}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fhdp-fh-starter",
-  "version": "4.10.301",
+  "version": "4.10.401",
   "author": {
     "name": "Jakub Kosecki",
     "email": "j.kosecki@doittechnology.pl"
@@ -24,10 +24,10 @@
     "typescript": "3.9"
   },
   "dependencies": {
-    "fh-basic-controls": "4.10.301",
-    "fh-charts-controls": "4.10.301",
-    "fh-forms-handler": "4.10.301",
-    "fhdp-controls": "4.10.301",
-    "fhdp-extenders": "4.10.301"
+    "fh-basic-controls": "4.10.401",
+    "fh-charts-controls": "4.10.401",
+    "fh-forms-handler": "4.10.401",
+    "fhdp-controls": "4.10.401",
+    "fhdp-extenders": "4.10.401"
   }
 }

package/postpublish.js

@@ -1,15 +1,15 @@
-const fs = require('fs');
-const path = require('path');
-const ORIG_PKG_PATH = path.resolve(__dirname, 'package.json');
-const CACHED_PKG_PATH = path.resolve(__dirname, 'cached-package.json');
-const pkgData = JSON.stringify(require(CACHED_PKG_PATH), null, 2) + '\n';
-
-fs.writeFile(ORIG_PKG_PATH, pkgData, function (err) {
-    if (err) throw err;
-});
-
-pkgData.main = 'Module.ts';
-
-fs.unlink(CACHED_PKG_PATH, function (err) {
-    if (err) throw err;
-});
+const fs = require('fs');
+const path = require('path');
+const ORIG_PKG_PATH = path.resolve(__dirname, 'package.json');
+const CACHED_PKG_PATH = path.resolve(__dirname, 'cached-package.json');
+const pkgData = JSON.stringify(require(CACHED_PKG_PATH), null, 2) + '\n';
+
+fs.writeFile(ORIG_PKG_PATH, pkgData, function (err) {
+    if (err) throw err;
+});
+
+pkgData.main = 'Module.ts';
+
+fs.unlink(CACHED_PKG_PATH, function (err) {
+    if (err) throw err;
+});

package/prepublish.js

@@ -1,15 +1,15 @@
-const fs = require('fs');
-const path = require('path');
-const ORIG_PKG_PATH = path.resolve(__dirname, 'package.json');
-const CACHED_PKG_PATH = path.resolve(__dirname, 'cached-package.json');
-const pkgData = require(ORIG_PKG_PATH);
-
-fs.writeFile(CACHED_PKG_PATH, JSON.stringify(pkgData), function (err) {
-    if (err) throw err;
-});
-
-pkgData.main = 'dist/Module.js';
-
-fs.writeFile(ORIG_PKG_PATH, JSON.stringify(pkgData, null, 2), function (err) {
-    if (err) throw err;
-});
+const fs = require('fs');
+const path = require('path');
+const ORIG_PKG_PATH = path.resolve(__dirname, 'package.json');
+const CACHED_PKG_PATH = path.resolve(__dirname, 'cached-package.json');
+const pkgData = require(ORIG_PKG_PATH);
+
+fs.writeFile(CACHED_PKG_PATH, JSON.stringify(pkgData), function (err) {
+    if (err) throw err;
+});
+
+pkgData.main = 'dist/Module.js';
+
+fs.writeFile(ORIG_PKG_PATH, JSON.stringify(pkgData, null, 2), function (err) {
+    if (err) throw err;
+});

package/tsconfig.json

@@ -1,18 +1,18 @@
-{
-  "compilerOptions": {
-    "jsx": "react",
-    "sourceMap": true,
-    "target": "es5",
-    "outDir": "dist",
-    "lib": ["es6", "dom"],
-    "types": ["reflect-metadata", "jquery", "jqueryui", "bootstrap", "node"],
-    "module": "commonjs",
-    "baseUrl": "types",
-    "moduleResolution": "node",
-    "declaration": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "resolveJsonModule": true,
-  },
-  "exclude": ["node_modules", "target", "dist"]
-}
+{
+  "compilerOptions": {
+    "jsx": "react",
+    "sourceMap": true,
+    "target": "es5",
+    "outDir": "dist",
+    "lib": ["es6", "dom"],
+    "types": ["reflect-metadata", "jquery", "jqueryui", "bootstrap", "node"],
+    "module": "commonjs",
+    "baseUrl": "types",
+    "moduleResolution": "node",
+    "declaration": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "resolveJsonModule": true,
+  },
+  "exclude": ["node_modules", "target", "dist"]
+}