@j2inn/fin5-ui-utils 8.2.0 → 8.3.0

package/dist/fin5Top/openFin5Alarm.d.ts

@@ -1,22 +1,22 @@
-import { TargetRef } from './fin5Top';
-export interface AlarmFilterTypes {
-    alarms: boolean;
-    events: boolean;
-    acks: boolean;
-}
-export interface AlarmFilter {
-    range?: string;
-    priorityThreshold?: string;
-    acked?: boolean;
-    unacked?: boolean;
-    inAlarm?: boolean;
-    notInAlarm?: boolean;
-    search?: string;
-    types?: AlarmFilterTypes;
-}
-export declare type AlarmOptions = {
-    targetRef?: TargetRef;
-    filter: AlarmFilter;
-    historical?: boolean;
-};
-export declare const openFin5AlarmsApp: ({ targetRef, filter, historical, }: AlarmOptions) => Promise<void>;
+import { TargetRef } from './fin5Top';
+export interface AlarmFilterTypes {
+    alarms: boolean;
+    events: boolean;
+    acks: boolean;
+}
+export interface AlarmFilter {
+    range?: string;
+    priorityThreshold?: string;
+    acked?: boolean;
+    unacked?: boolean;
+    inAlarm?: boolean;
+    notInAlarm?: boolean;
+    search?: string;
+    types?: AlarmFilterTypes;
+}
+export declare type AlarmOptions = {
+    targetRef?: TargetRef;
+    filter: AlarmFilter;
+    historical?: boolean;
+};
+export declare const openFin5AlarmsApp: ({ targetRef, filter, historical, }: AlarmOptions) => Promise<void>;

package/dist/fin5Top/openFin5Alarm.js

@@ -1,24 +1,24 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.openFin5AlarmsApp = void 0;
-//////////////////////////////////////////////////////////////////////////
-// Alarms
-//////////////////////////////////////////////////////////////////////////
-const fin5Top_1 = require("./fin5Top");
-const openFin5AlarmsApp = async ({ targetRef, filter, historical = false, }) => {
-    await fin5Top_1.fin5Top?.app.NavigateToApp(fin5Top_1.fin5Top?.app?.APP_NAMES?.ALARMS, targetRef);
-    fin5Top_1.fin5Top?.app.ToggleCollapse(false);
-    let alarmFilters = fin5Top_1.fin5Top?.app?.GetAlarmFilters() ?? {};
-    if (filter) {
-        alarmFilters = {
-            ...alarmFilters,
-            ...filter,
-        };
-    }
-    fin5Top_1.fin5Top?.app?.SetAlarmFilters(alarmFilters, historical);
-};
-exports.openFin5AlarmsApp = openFin5AlarmsApp;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openFin5AlarmsApp = void 0;
+//////////////////////////////////////////////////////////////////////////
+// Alarms
+//////////////////////////////////////////////////////////////////////////
+const fin5Top_1 = require("./fin5Top");
+const openFin5AlarmsApp = async ({ targetRef, filter, historical = false, }) => {
+    await fin5Top_1.fin5Top?.app.NavigateToApp(fin5Top_1.fin5Top?.app?.APP_NAMES?.ALARMS, targetRef);
+    fin5Top_1.fin5Top?.app.ToggleCollapse(false);
+    let alarmFilters = fin5Top_1.fin5Top?.app?.GetAlarmFilters() ?? {};
+    if (filter) {
+        alarmFilters = {
+            ...alarmFilters,
+            ...filter,
+        };
+    }
+    fin5Top_1.fin5Top?.app?.SetAlarmFilters(alarmFilters, historical);
+};
+exports.openFin5AlarmsApp = openFin5AlarmsApp;
 //# sourceMappingURL=openFin5Alarm.js.map

package/dist/fin5Top/openFin5Historian.d.ts

@@ -1,3 +1,3 @@
-export declare type HistorianType = 'point' | 'query' | 'string';
-export declare type HistorianArgs = string | (string | undefined)[];
-export declare const openFin5HistorianApp: (queryType?: HistorianType, args?: HistorianArgs) => Promise<void>;
+export declare type HistorianType = 'point' | 'query' | 'string';
+export declare type HistorianArgs = string | (string | undefined)[];
+export declare const openFin5HistorianApp: (queryType?: HistorianType, args?: HistorianArgs) => Promise<void>;

package/dist/fin5Top/openFin5Historian.js

@@ -1,20 +1,20 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.openFin5HistorianApp = void 0;
-//////////////////////////////////////////////////////////////////////////
-// Historian
-//////////////////////////////////////////////////////////////////////////
-const fin5Top_1 = require("./fin5Top");
-const openFin5HistorianApp = async (queryType, args) => {
-    if (fin5Top_1.fin5Top) {
-        queryType && args
-            ? fin5Top_1.fin5Top.app.OpenHistorianWithOptions(queryType, args)
-            : fin5Top_1.fin5Top.app.NavigateToApp(fin5Top_1.fin5Top.app.APP_NAMES.TREND_LIST);
-        fin5Top_1.fin5Top?.app.ToggleCollapse(false);
-    }
-};
-exports.openFin5HistorianApp = openFin5HistorianApp;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openFin5HistorianApp = void 0;
+//////////////////////////////////////////////////////////////////////////
+// Historian
+//////////////////////////////////////////////////////////////////////////
+const fin5Top_1 = require("./fin5Top");
+const openFin5HistorianApp = async (queryType, args) => {
+    if (fin5Top_1.fin5Top) {
+        queryType && args
+            ? fin5Top_1.fin5Top.app.OpenHistorianWithOptions(queryType, args)
+            : fin5Top_1.fin5Top.app.NavigateToApp(fin5Top_1.fin5Top.app.APP_NAMES.TREND_LIST);
+        fin5Top_1.fin5Top?.app.ToggleCollapse(false);
+    }
+};
+exports.openFin5HistorianApp = openFin5HistorianApp;
 //# sourceMappingURL=openFin5Historian.js.map

package/dist/fin5Top/useFin5AppURLHashParameter.d.ts

@@ -1,18 +1,18 @@
-export declare const IN_IFRAME: boolean;
-export declare const getTopLocation: () => Location;
-export declare const getFin5HashFrameParameters: () => URLSearchParams;
-export declare const fin5SkipHashUpdate: () => Promise<undefined> | undefined;
-export declare const getHashParameters: () => URLSearchParams;
-/**
- * Use a parameter in the hash of a custom app running in FIN 5 as state.
- * @param name parameter name.
- * @param initialState initial state used if the parameter is not defined.
- * @returns the parameter value and a function to update it.
- */
-export declare const useFin5AppURLHashParameter: (name: string, initialState?: string) => [string | undefined, (newValue: string) => Promise<void>];
-/**
- * Use all the parameters in the hash of a custom app running in FIN 5 as state.
- * @param parameters the initial (optional) values for the parameters
- * @returns the URL parameters and a function to patch the parameters.
- */
-export declare const useFin5AppURLHashParameters: (parameters?: URLSearchParams) => [URLSearchParams, (newValues: URLSearchParams) => Promise<void>];
+export declare const IN_IFRAME: boolean;
+export declare const getTopLocation: () => Location;
+export declare const getFin5HashFrameParameters: () => URLSearchParams;
+export declare const fin5SkipHashUpdate: () => Promise<undefined> | undefined;
+export declare const getHashParameters: () => URLSearchParams;
+/**
+ * Use a parameter in the hash of a custom app running in FIN 5 as state.
+ * @param name parameter name.
+ * @param initialState initial state used if the parameter is not defined.
+ * @returns the parameter value and a function to update it.
+ */
+export declare const useFin5AppURLHashParameter: (name: string, initialState?: string) => [string | undefined, (newValue: string) => Promise<void>];
+/**
+ * Use all the parameters in the hash of a custom app running in FIN 5 as state.
+ * @param parameters the initial (optional) values for the parameters
+ * @returns the URL parameters and a function to patch the parameters.
+ */
+export declare const useFin5AppURLHashParameters: (parameters?: URLSearchParams) => [URLSearchParams, (newValues: URLSearchParams) => Promise<void>];

package/dist/fin5Top/useFin5AppURLHashParameter.js

@@ -1,134 +1,134 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFin5AppURLHashParameters = exports.useFin5AppURLHashParameter = exports.getHashParameters = exports.fin5SkipHashUpdate = exports.getFin5HashFrameParameters = exports.getTopLocation = exports.IN_IFRAME = void 0;
-const react_1 = require("react");
-const fin5Top_1 = require("./fin5Top");
-exports.IN_IFRAME = window !== top && (0, fin5Top_1.isWindowTopFin5)();
-const getTop = () => window.top ?? window;
-const getApp = () => getTop()?.app;
-const getTopLocation = () => getTop().location;
-exports.getTopLocation = getTopLocation;
-const getFin5HashFrameParameters = () => new URLSearchParams((0, exports.getTopLocation)().hash.slice(1).split('?')[1]);
-exports.getFin5HashFrameParameters = getFin5HashFrameParameters;
-const getFin5FrameURL = () => (0, exports.getFin5HashFrameParameters)().get('url');
-const getPartialURLHashFragment = (url) => `#${url?.split('#')[1] ?? ''}`;
-const getHash = () => {
-    return exports.IN_IFRAME
-        ? getPartialURLHashFragment(getFin5FrameURL())
-        : window.location.hash;
-};
-const fin5SkipHashUpdate = () => getApp()?.set('skipHashUpdate', true);
-exports.fin5SkipHashUpdate = fin5SkipHashUpdate;
-const setHash = (hash) => {
-    if (exports.IN_IFRAME) {
-        return (0, exports.fin5SkipHashUpdate)()?.then(() => {
-            const frameParameters = (0, exports.getFin5HashFrameParameters)();
-            frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash);
-            (0, exports.getTopLocation)().hash = `#${(0, exports.getTopLocation)().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
-        });
-    }
-    else {
-        window.location.hash = hash;
-        return Promise.resolve();
-    }
-};
-const getHashParameters = () => new URLSearchParams(getHash().slice(1));
-exports.getHashParameters = getHashParameters;
-/**
- * Use a parameter in the hash of a custom app running in FIN 5 as state.
- * @param name parameter name.
- * @param initialState initial state used if the parameter is not defined.
- * @returns the parameter value and a function to update it.
- */
-const useFin5AppURLHashParameter = (name, initialState) => {
-    const [paramValue, setParamValue] = (0, react_1.useState)((0, exports.getHashParameters)()?.get(name) ?? undefined);
-    const setHashParameter = async (value) => {
-        const params = (0, exports.getHashParameters)();
-        if (params.get(name) !== value) {
-            if (value === '' || value == null) {
-                params.delete(name);
-            }
-            else {
-                params?.set(name, value);
-            }
-            await setHash(params?.toString());
-            setParamValue(value);
-        }
-    };
-    (0, react_1.useEffect)(() => {
-        if (!(0, exports.getHashParameters)()?.has(name) && initialState) {
-            setHashParameter(initialState);
-        }
-    }, []);
-    (0, react_1.useEffect)(() => {
-        const onHashChange = () => {
-            setParamValue((0, exports.getHashParameters)()?.get(name) ?? undefined);
-        };
-        if (exports.IN_IFRAME) {
-            getTop().addEventListener('hashchange', onHashChange);
-            return () => {
-                getTop().removeEventListener('hashchange', onHashChange);
-            };
-        }
-        return () => {
-            return;
-        };
-    }, []);
-    return [paramValue, setHashParameter];
-};
-exports.useFin5AppURLHashParameter = useFin5AppURLHashParameter;
-/**
- * Use all the parameters in the hash of a custom app running in FIN 5 as state.
- * @param parameters the initial (optional) values for the parameters
- * @returns the URL parameters and a function to patch the parameters.
- */
-const useFin5AppURLHashParameters = (parameters) => {
-    const [paramValues, setParamValues] = (0, react_1.useState)((0, exports.getHashParameters)());
-    // Patch the parameters: this updates just the URL parameters passed.
-    // If there is a parameter in the hash and not in the function arg, that is left untouched.
-    // To remove a parameter in the hash, set it to null or empty string.
-    const setHashParameters = async (paramsToUpdate) => {
-        const params = (0, exports.getHashParameters)();
-        Array.from(paramsToUpdate.entries()).forEach(([paramKey, newParamValue]) => {
-            if (newParamValue !== params.get(paramKey)) {
-                if (newParamValue == null || newParamValue === '') {
-                    params.delete(paramKey);
-                }
-                else {
-                    params.set(paramKey, newParamValue);
-                }
-            }
-        });
-        await setHash(params.toString());
-        setParamValues(params);
-    };
-    // Initial setup.
-    (0, react_1.useEffect)(() => {
-        const hashParameters = (0, exports.getHashParameters)();
-        if (parameters) {
-            Array.from(parameters.entries()).forEach(([paramKey, paramValue]) => {
-                if (!hashParameters.has(paramKey) &&
-                    paramValue != null &&
-                    paramValue !== '') {
-                    hashParameters.set(paramKey, paramValue);
-                }
-            });
-            setHashParameters(hashParameters);
-        }
-    }, []);
-    (0, react_1.useEffect)(() => {
-        const onHashChange = () => {
-            setParamValues((0, exports.getHashParameters)());
-        };
-        getTop().addEventListener('hashchange', onHashChange);
-        return () => {
-            getTop().removeEventListener('hashchange', onHashChange);
-        };
-    }, []);
-    return [paramValues, setHashParameters];
-};
-exports.useFin5AppURLHashParameters = useFin5AppURLHashParameters;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFin5AppURLHashParameters = exports.useFin5AppURLHashParameter = exports.getHashParameters = exports.fin5SkipHashUpdate = exports.getFin5HashFrameParameters = exports.getTopLocation = exports.IN_IFRAME = void 0;
+const react_1 = require("react");
+const fin5Top_1 = require("./fin5Top");
+exports.IN_IFRAME = window !== top && (0, fin5Top_1.isWindowTopFin5)();
+const getTop = () => window.top ?? window;
+const getApp = () => getTop()?.app;
+const getTopLocation = () => getTop().location;
+exports.getTopLocation = getTopLocation;
+const getFin5HashFrameParameters = () => new URLSearchParams((0, exports.getTopLocation)().hash.slice(1).split('?')[1]);
+exports.getFin5HashFrameParameters = getFin5HashFrameParameters;
+const getFin5FrameURL = () => (0, exports.getFin5HashFrameParameters)().get('url');
+const getPartialURLHashFragment = (url) => `#${url?.split('#')[1] ?? ''}`;
+const getHash = () => {
+    return exports.IN_IFRAME
+        ? getPartialURLHashFragment(getFin5FrameURL())
+        : window.location.hash;
+};
+const fin5SkipHashUpdate = () => getApp()?.set('skipHashUpdate', true);
+exports.fin5SkipHashUpdate = fin5SkipHashUpdate;
+const setHash = (hash) => {
+    if (exports.IN_IFRAME) {
+        return (0, exports.fin5SkipHashUpdate)()?.then(() => {
+            const frameParameters = (0, exports.getFin5HashFrameParameters)();
+            frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash);
+            (0, exports.getTopLocation)().hash = `#${(0, exports.getTopLocation)().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
+        });
+    }
+    else {
+        window.location.hash = hash;
+        return Promise.resolve();
+    }
+};
+const getHashParameters = () => new URLSearchParams(getHash().slice(1));
+exports.getHashParameters = getHashParameters;
+/**
+ * Use a parameter in the hash of a custom app running in FIN 5 as state.
+ * @param name parameter name.
+ * @param initialState initial state used if the parameter is not defined.
+ * @returns the parameter value and a function to update it.
+ */
+const useFin5AppURLHashParameter = (name, initialState) => {
+    const [paramValue, setParamValue] = (0, react_1.useState)((0, exports.getHashParameters)()?.get(name) ?? undefined);
+    const setHashParameter = async (value) => {
+        const params = (0, exports.getHashParameters)();
+        if (params.get(name) !== value) {
+            if (value === '' || value == null) {
+                params.delete(name);
+            }
+            else {
+                params?.set(name, value);
+            }
+            await setHash(params?.toString());
+            setParamValue(value);
+        }
+    };
+    (0, react_1.useEffect)(() => {
+        if (!(0, exports.getHashParameters)()?.has(name) && initialState) {
+            setHashParameter(initialState);
+        }
+    }, []);
+    (0, react_1.useEffect)(() => {
+        const onHashChange = () => {
+            setParamValue((0, exports.getHashParameters)()?.get(name) ?? undefined);
+        };
+        if (exports.IN_IFRAME) {
+            getTop().addEventListener('hashchange', onHashChange);
+            return () => {
+                getTop().removeEventListener('hashchange', onHashChange);
+            };
+        }
+        return () => {
+            return;
+        };
+    }, []);
+    return [paramValue, setHashParameter];
+};
+exports.useFin5AppURLHashParameter = useFin5AppURLHashParameter;
+/**
+ * Use all the parameters in the hash of a custom app running in FIN 5 as state.
+ * @param parameters the initial (optional) values for the parameters
+ * @returns the URL parameters and a function to patch the parameters.
+ */
+const useFin5AppURLHashParameters = (parameters) => {
+    const [paramValues, setParamValues] = (0, react_1.useState)((0, exports.getHashParameters)());
+    // Patch the parameters: this updates just the URL parameters passed.
+    // If there is a parameter in the hash and not in the function arg, that is left untouched.
+    // To remove a parameter in the hash, set it to null or empty string.
+    const setHashParameters = async (paramsToUpdate) => {
+        const params = (0, exports.getHashParameters)();
+        Array.from(paramsToUpdate.entries()).forEach(([paramKey, newParamValue]) => {
+            if (newParamValue !== params.get(paramKey)) {
+                if (newParamValue == null || newParamValue === '') {
+                    params.delete(paramKey);
+                }
+                else {
+                    params.set(paramKey, newParamValue);
+                }
+            }
+        });
+        await setHash(params.toString());
+        setParamValues(params);
+    };
+    // Initial setup.
+    (0, react_1.useEffect)(() => {
+        const hashParameters = (0, exports.getHashParameters)();
+        if (parameters) {
+            Array.from(parameters.entries()).forEach(([paramKey, paramValue]) => {
+                if (!hashParameters.has(paramKey) &&
+                    paramValue != null &&
+                    paramValue !== '') {
+                    hashParameters.set(paramKey, paramValue);
+                }
+            });
+            setHashParameters(hashParameters);
+        }
+    }, []);
+    (0, react_1.useEffect)(() => {
+        const onHashChange = () => {
+            setParamValues((0, exports.getHashParameters)());
+        };
+        getTop().addEventListener('hashchange', onHashChange);
+        return () => {
+            getTop().removeEventListener('hashchange', onHashChange);
+        };
+    }, []);
+    return [paramValues, setHashParameters];
+};
+exports.useFin5AppURLHashParameters = useFin5AppURLHashParameters;
 //# sourceMappingURL=useFin5AppURLHashParameter.js.map

package/dist/index.d.ts

@@ -1,35 +1,35 @@
-export * from './fin5Top/fin5FileUpload';
-export * from './fin5Top/fin5Top';
-export * from './fin5Top/finEdge2Cloud';
-export * from './fin5Top/getFin5BinUrl';
-export * from './fin5Top/openFin5Alarm';
-export * from './fin5Top/openFin5Historian';
-export * from './fin5Top/useFin5AppURLHashParameter';
-export * from './jobs/jobUtils';
-export * from './react/components/ErrorBoundary';
-export * from './react/components/ErrorDisplayer';
-export * from './react/components/Loader';
-export * from './react/components/LoadingSpinner';
-export * from './react/components/graphics/GraphicViewer';
-export * from './react/components/graphics/GraphicsTabViewer';
-export * from './react/components/navigation/BasicLayout';
-export * from './react/components/navigation/MenuPage';
-export * from './react/components/navigation/ReactRouterLayout';
-export * from './react/components/navigation/ReactRouterHeaderSiderLayout';
-export * from './react/components/navigation/customRouting/RouterLayout';
-export * from './react/components/navigation/customRouting/Router';
-export * from './react/components/resolvable/configurationForm/ConfigurationForm';
-export * from './react/components/resolvable/configurationForm/ConfigurationFormEntry';
-export * from './react/components/resolvable/configurationForm/getSectionDefault';
-export * from './react/components/RecordImage';
-export * from './react/components/charts/QRCode';
-export * from './react/components/charts/line-bar/Chart';
-export * from './react/components/charts/line-bar/HGridChart';
-export * from './react/components/charts/pie/PieChart';
-export * from './react/components/charts/pie/SimplePieChart';
-export * from './react/components/makeCustomElement';
-export * from './react/hooks/useFin5BinUrl';
-export * from './react/hooks/useFin5ColorScheme';
-export * from './react/hooks/useScreenSize';
-export * from './react/app/Fin5AppContainer';
-export * from './react/app/Fin5AppRootStore';
+export * from './fin5Top/fin5FileUpload';
+export * from './fin5Top/fin5Top';
+export * from './fin5Top/finEdge2Cloud';
+export * from './fin5Top/getFin5BinUrl';
+export * from './fin5Top/openFin5Alarm';
+export * from './fin5Top/openFin5Historian';
+export * from './fin5Top/useFin5AppURLHashParameter';
+export * from './jobs/jobUtils';
+export * from './react/components/ErrorBoundary';
+export * from './react/components/ErrorDisplayer';
+export * from './react/components/Loader';
+export * from './react/components/LoadingSpinner';
+export * from './react/components/graphics/GraphicViewer';
+export * from './react/components/graphics/GraphicsTabViewer';
+export * from './react/components/navigation/BasicLayout';
+export * from './react/components/navigation/MenuPage';
+export * from './react/components/navigation/ReactRouterLayout';
+export * from './react/components/navigation/ReactRouterHeaderSiderLayout';
+export * from './react/components/navigation/customRouting/RouterLayout';
+export * from './react/components/navigation/customRouting/Router';
+export * from './react/components/resolvable/configurationForm/ConfigurationForm';
+export * from './react/components/resolvable/configurationForm/ConfigurationFormEntry';
+export * from './react/components/resolvable/configurationForm/getSectionDefault';
+export * from './react/components/RecordImage';
+export * from './react/components/charts/QRCode';
+export * from './react/components/charts/line-bar/Chart';
+export * from './react/components/charts/line-bar/HGridChart';
+export * from './react/components/charts/pie/PieChart';
+export * from './react/components/charts/pie/SimplePieChart';
+export * from './react/components/makeCustomElement';
+export * from './react/hooks/useFin5BinUrl';
+export * from './react/hooks/useFin5ColorScheme';
+export * from './react/hooks/useScreenSize';
+export * from './react/app/Fin5AppContainer';
+export * from './react/app/Fin5AppRootStore';