@j2inn/fin5-ui-utils 8.1.1-beta.6 → 8.1.1

package/dist/fin5Top/fin5Top.js

@@ -1,62 +1,62 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Fin5AppNames = exports.isWindowTopFin5 = exports.fin5Top = exports.getFin5top = void 0;
-class Fin5TopRetriever {
-    static _fin5Top;
-    static get fin5Top() {
-        return this.getFin5top();
-    }
-    static getFin5top = (notifyFailure) => {
-        if (this._fin5Top === undefined) {
-            this._fin5Top = isWindowTopFin5(notifyFailure)
-                ? window.top // Cast to unknown to obscure properties from Window to simplify usage.
-                : null;
-        }
-        return this._fin5Top;
-    };
-}
-exports.getFin5top = Fin5TopRetriever.getFin5top;
-exports.fin5Top = Fin5TopRetriever.fin5Top;
-function isWindowTopFin5(notifyFailure) {
-    try {
-        window?.top?.origin;
-        if (window.top.finstack) {
-            return true;
-        }
-    }
-    catch { }
-    notifyFailure?.();
-    return false;
-}
-exports.isWindowTopFin5 = isWindowTopFin5;
-var Fin5AppNames;
-(function (Fin5AppNames) {
-    Fin5AppNames["EQUIP"] = "equip";
-    Fin5AppNames["GRAPHICS"] = "graphics";
-    Fin5AppNames["POINTS"] = "points";
-    Fin5AppNames["ALARMS"] = "alarms";
-    Fin5AppNames["NOTES"] = "notes";
-    Fin5AppNames["SUMMARY"] = "summary";
-    Fin5AppNames["SUMMARY_TOPICS"] = "summaryList";
-    Fin5AppNames["TOOLS"] = "tools";
-    Fin5AppNames["SCHEDULES"] = "schedules";
-    Fin5AppNames["SCHEDULE_LIST"] = "scheduleList";
-    Fin5AppNames["HISTORIAN"] = "trends";
-    Fin5AppNames["TREND_LIST"] = "trendList";
-    Fin5AppNames["CHARTS"] = "charts";
-    Fin5AppNames["CHART_LIST"] = "chartList";
-    Fin5AppNames["SEARCH"] = "search";
-    Fin5AppNames["LOGOUT"] = "logout";
-    Fin5AppNames["GENERIC"] = "generic";
-    Fin5AppNames["REPORTS"] = "reports";
-    Fin5AppNames["FLOOR"] = "floor";
-    Fin5AppNames["BUILDER"] = "builder";
-    Fin5AppNames["FILES"] = "files";
-    Fin5AppNames["HOME"] = "home";
-    Fin5AppNames["DASHBOARD"] = "dashboard";
-    Fin5AppNames["SETTINGS"] = "settings";
-})(Fin5AppNames = exports.Fin5AppNames || (exports.Fin5AppNames = {}));
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fin5AppNames = exports.isWindowTopFin5 = exports.fin5Top = exports.getFin5top = void 0;
+class Fin5TopRetriever {
+    static _fin5Top;
+    static get fin5Top() {
+        return this.getFin5top();
+    }
+    static getFin5top = (notifyFailure) => {
+        if (this._fin5Top === undefined) {
+            this._fin5Top = isWindowTopFin5(notifyFailure)
+                ? window.top // Cast to unknown to obscure properties from Window to simplify usage.
+                : null;
+        }
+        return this._fin5Top;
+    };
+}
+exports.getFin5top = Fin5TopRetriever.getFin5top;
+exports.fin5Top = Fin5TopRetriever.fin5Top;
+function isWindowTopFin5(notifyFailure) {
+    try {
+        window?.top?.origin;
+        if (window.top.finstack) {
+            return true;
+        }
+    }
+    catch { }
+    notifyFailure?.();
+    return false;
+}
+exports.isWindowTopFin5 = isWindowTopFin5;
+var Fin5AppNames;
+(function (Fin5AppNames) {
+    Fin5AppNames["EQUIP"] = "equip";
+    Fin5AppNames["GRAPHICS"] = "graphics";
+    Fin5AppNames["POINTS"] = "points";
+    Fin5AppNames["ALARMS"] = "alarms";
+    Fin5AppNames["NOTES"] = "notes";
+    Fin5AppNames["SUMMARY"] = "summary";
+    Fin5AppNames["SUMMARY_TOPICS"] = "summaryList";
+    Fin5AppNames["TOOLS"] = "tools";
+    Fin5AppNames["SCHEDULES"] = "schedules";
+    Fin5AppNames["SCHEDULE_LIST"] = "scheduleList";
+    Fin5AppNames["HISTORIAN"] = "trends";
+    Fin5AppNames["TREND_LIST"] = "trendList";
+    Fin5AppNames["CHARTS"] = "charts";
+    Fin5AppNames["CHART_LIST"] = "chartList";
+    Fin5AppNames["SEARCH"] = "search";
+    Fin5AppNames["LOGOUT"] = "logout";
+    Fin5AppNames["GENERIC"] = "generic";
+    Fin5AppNames["REPORTS"] = "reports";
+    Fin5AppNames["FLOOR"] = "floor";
+    Fin5AppNames["BUILDER"] = "builder";
+    Fin5AppNames["FILES"] = "files";
+    Fin5AppNames["HOME"] = "home";
+    Fin5AppNames["DASHBOARD"] = "dashboard";
+    Fin5AppNames["SETTINGS"] = "settings";
+})(Fin5AppNames = exports.Fin5AppNames || (exports.Fin5AppNames = {}));
 //# sourceMappingURL=fin5Top.js.map

package/dist/fin5Top/finEdge2Cloud.d.ts

@@ -1,6 +1,6 @@
-/**
- * Get the URI to register the FIN instance to Edge2Cloud.
- * The URI can be used to provide a link, or to create the registration QR code.
- * @returns the URI as a string
- */
-export declare const getEdge2CloudRegistrationUri: () => Promise<string>;
+/**
+ * Get the URI to register the FIN instance to Edge2Cloud.
+ * The URI can be used to provide a link, or to create the registration QR code.
+ * @returns the URI as a string
+ */
+export declare const getEdge2CloudRegistrationUri: () => Promise<string>;

package/dist/fin5Top/finEdge2Cloud.js

@@ -1,16 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEdge2CloudRegistrationUri = void 0;
-const haystack_nclient_1 = require("haystack-nclient");
-/**
- * Get the URI to register the FIN instance to Edge2Cloud.
- * The URI can be used to provide a link, or to create the registration QR code.
- * @returns the URI as a string
- */
-const getEdge2CloudRegistrationUri = async () => {
-    const response = await (0, haystack_nclient_1.finCsrfFetch)('/finEdge2Cloud/devreg');
-    const json = await response.json();
-    return json.uri;
-};
-exports.getEdge2CloudRegistrationUri = getEdge2CloudRegistrationUri;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEdge2CloudRegistrationUri = void 0;
+const haystack_nclient_1 = require("haystack-nclient");
+/**
+ * Get the URI to register the FIN instance to Edge2Cloud.
+ * The URI can be used to provide a link, or to create the registration QR code.
+ * @returns the URI as a string
+ */
+const getEdge2CloudRegistrationUri = async () => {
+    const response = await (0, haystack_nclient_1.finCsrfFetch)('/finEdge2Cloud/devreg');
+    const json = await response.json();
+    return json.uri;
+};
+exports.getEdge2CloudRegistrationUri = getEdge2CloudRegistrationUri;
 //# sourceMappingURL=finEdge2Cloud.js.map

package/dist/fin5Top/getFin5BinUrl.d.ts

@@ -1,2 +1,2 @@
-import { HRef } from 'haystack-core';
-export declare const getFin5BinUrl: (id: HRef, projectName?: string | undefined) => string;
+import { HRef } from 'haystack-core';
+export declare const getFin5BinUrl: (id: HRef, projectName?: string | undefined) => string;

package/dist/fin5Top/getFin5BinUrl.js

@@ -1,10 +1,10 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFin5BinUrl = void 0;
-const fin5Top_1 = require("./fin5Top");
-const getFin5BinUrl = (id, projectName = fin5Top_1.fin5Top?.finstack?.projectName) => `/finGetFile/${projectName}?fileRef=${id?.toAxon()}`;
-exports.getFin5BinUrl = getFin5BinUrl;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFin5BinUrl = void 0;
+const fin5Top_1 = require("./fin5Top");
+const getFin5BinUrl = (id, projectName = fin5Top_1.fin5Top?.finstack?.projectName) => `/finGetFile/${projectName}?fileRef=${id?.toAxon()}`;
+exports.getFin5BinUrl = getFin5BinUrl;
 //# sourceMappingURL=getFin5BinUrl.js.map

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>];