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

package/dist/fantomProps/readFantomPropsFile.js

@@ -1,66 +1,66 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = __importStar(require("fs"));
-const fantomPropsToObject_1 = require("./fantomPropsToObject");
-/**
- * Synchronously read the given Fantom props file to JS object (@see https://fantom.org/doc/sys/InStream#readProps)
- */
-function readFantomPropsFile(path) {
-    return new Promise((resolve, reject) => {
-        fs.readFile(path, (err, fileBuffer) => {
-            if (err) {
-                return reject(err);
-            }
-            let bufferIndex = 0;
-            const bufferLength = fileBuffer.length;
-            const unreadBuffer = []; // Stack to handle unreadChar operations
-            const readChar = () => {
-                if (unreadBuffer.length > 0) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    return unreadBuffer.pop();
-                }
-                if (bufferIndex < bufferLength) {
-                    return fileBuffer[bufferIndex++];
-                }
-                return -1;
-            };
-            const unreadChar = (char) => {
-                unreadBuffer.push(char);
-            };
-            try {
-                resolve((0, fantomPropsToObject_1.parseFantomProps)(readChar, unreadChar));
-            }
-            catch (error) {
-                reject(error);
-            }
-        });
-    });
-}
-exports.default = readFantomPropsFile;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const fantomPropsToObject_1 = require("./fantomPropsToObject");
+/**
+ * Synchronously read the given Fantom props file to JS object (@see https://fantom.org/doc/sys/InStream#readProps)
+ */
+function readFantomPropsFile(path) {
+    return new Promise((resolve, reject) => {
+        fs.readFile(path, (err, fileBuffer) => {
+            if (err) {
+                return reject(err);
+            }
+            let bufferIndex = 0;
+            const bufferLength = fileBuffer.length;
+            const unreadBuffer = []; // Stack to handle unreadChar operations
+            const readChar = () => {
+                if (unreadBuffer.length > 0) {
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    return unreadBuffer.pop();
+                }
+                if (bufferIndex < bufferLength) {
+                    return fileBuffer[bufferIndex++];
+                }
+                return -1;
+            };
+            const unreadChar = (char) => {
+                unreadBuffer.push(char);
+            };
+            try {
+                resolve((0, fantomPropsToObject_1.parseFantomProps)(readChar, unreadChar));
+            }
+            catch (error) {
+                reject(error);
+            }
+        });
+    });
+}
+exports.default = readFantomPropsFile;
 //# sourceMappingURL=readFantomPropsFile.js.map

package/dist/fin5Top/fin5FileUpload.d.ts

@@ -1,24 +1,24 @@
-import { HDict } from 'haystack-core';
-/**
- * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
- * @param projectName The name of the project where the files will be uploaded
- * @param file The File to upload
- * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
- * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
- * @returns the file record as an HDict
- * @example
- * <input type='file' onChange={async (e) => {
- * 		const file = e.target.files?.[0]
- * 		if (file) {
- * 			const params = new URLSearchParams()
- * 			params.set('myMarker', 'true')
- * 			params.set('myStrTag', 'abc')
- * 			const rec = await fin5FileUpload(
- * 				'myprojectname',
- * 				file,
- * 				params
- * 			)
- * 		}
- * }} />
- */
-export declare const fin5FileUpload: (projectName: string, file: File, additionalTags?: URLSearchParams) => Promise<HDict>;
+import { HDict } from 'haystack-core';
+/**
+ * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
+ * @param projectName The name of the project where the files will be uploaded
+ * @param file The File to upload
+ * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
+ * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
+ * @returns the file record as an HDict
+ * @example
+ * <input type='file' onChange={async (e) => {
+ * 		const file = e.target.files?.[0]
+ * 		if (file) {
+ * 			const params = new URLSearchParams()
+ * 			params.set('myMarker', 'true')
+ * 			params.set('myStrTag', 'abc')
+ * 			const rec = await fin5FileUpload(
+ * 				'myprojectname',
+ * 				file,
+ * 				params
+ * 			)
+ * 		}
+ * }} />
+ */
+export declare const fin5FileUpload: (projectName: string, file: File, additionalTags?: URLSearchParams) => Promise<HDict>;

package/dist/fin5Top/fin5FileUpload.js

@@ -1,52 +1,52 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fin5FileUpload = void 0;
-const haystack_core_1 = require("haystack-core");
-const haystack_nclient_1 = require("haystack-nclient");
-/**
- * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
- * @param projectName The name of the project where the files will be uploaded
- * @param file The File to upload
- * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
- * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
- * @returns the file record as an HDict
- * @example
- * <input type='file' onChange={async (e) => {
- * 		const file = e.target.files?.[0]
- * 		if (file) {
- * 			const params = new URLSearchParams()
- * 			params.set('myMarker', 'true')
- * 			params.set('myStrTag', 'abc')
- * 			const rec = await fin5FileUpload(
- * 				'myprojectname',
- * 				file,
- * 				params
- * 			)
- * 		}
- * }} />
- */
-const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
-    if (!additionalTags.has('dis')) {
-        additionalTags.set('dis', file.name);
-    }
-    // URL base (http://localhost) will be ignored, it's just needed to build the URL
-    const url = new URL(`/api/${projectName}/ext/finstack/fileUpload`, 'http://localhost');
-    additionalTags.forEach((value, name) => url.searchParams.set(name, value));
-    const content = await file.arrayBuffer();
-    const response = await (0, haystack_nclient_1.finCsrfFetch)(`${url.pathname}${url.search}`, {
-        method: 'POST',
-        headers: {
-            'Content-Type': 'application/octet-stream',
-        },
-        body: new Uint8Array(content),
-    });
-    const zincReader = new haystack_core_1.ZincReader(await response.text());
-    const grid = zincReader.readValue();
-    const dict = grid.first;
-    if (!dict) {
-        throw new Error('Unexpected response, no record found');
-    }
-    return dict;
-};
-exports.fin5FileUpload = fin5FileUpload;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fin5FileUpload = void 0;
+const haystack_core_1 = require("haystack-core");
+const haystack_nclient_1 = require("haystack-nclient");
+/**
+ * Upload a File to FIN5, using the FINStack /fileUpload API. Files can then be viewed using Folio menu.
+ * @param projectName The name of the project where the files will be uploaded
+ * @param file The File to upload
+ * @param additionalTags Any additional tag that needs to be added to the file record. The tags should be
+ * provided as URL search parameters. To add a marker tag, set the value of the param to `'true'`.
+ * @returns the file record as an HDict
+ * @example
+ * <input type='file' onChange={async (e) => {
+ * 		const file = e.target.files?.[0]
+ * 		if (file) {
+ * 			const params = new URLSearchParams()
+ * 			params.set('myMarker', 'true')
+ * 			params.set('myStrTag', 'abc')
+ * 			const rec = await fin5FileUpload(
+ * 				'myprojectname',
+ * 				file,
+ * 				params
+ * 			)
+ * 		}
+ * }} />
+ */
+const fin5FileUpload = async (projectName, file, additionalTags = new URLSearchParams()) => {
+    if (!additionalTags.has('dis')) {
+        additionalTags.set('dis', file.name);
+    }
+    // URL base (http://localhost) will be ignored, it's just needed to build the URL
+    const url = new URL(`/api/${projectName}/ext/finstack/fileUpload`, 'http://localhost');
+    additionalTags.forEach((value, name) => url.searchParams.set(name, value));
+    const content = await file.arrayBuffer();
+    const response = await (0, haystack_nclient_1.finCsrfFetch)(`${url.pathname}${url.search}`, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/octet-stream',
+        },
+        body: new Uint8Array(content),
+    });
+    const zincReader = new haystack_core_1.ZincReader(await response.text());
+    const grid = zincReader.readValue();
+    const dict = grid.first;
+    if (!dict) {
+        throw new Error('Unexpected response, no record found');
+    }
+    return dict;
+};
+exports.fin5FileUpload = fin5FileUpload;
 //# sourceMappingURL=fin5FileUpload.js.map

package/dist/fin5Top/fin5Top.d.ts

@@ -1,124 +1,165 @@
-import { AlarmFilter } from './openFin5Alarm';
-import { HistorianArgs, HistorianType } from './openFin5Historian';
-export declare const getFin5top: (notifyFailure?: () => void) => Fin5Top | null;
-export declare const fin5Top: Fin5Top | null;
-export declare function isWindowTopFin5(notifyFailure?: () => void): boolean;
-export interface Fin5Top extends Window {
-    app: Fin5App;
-    languageManager: LanguageManager;
-    finstack?: {
-        projectName?: string;
-        device?: {
-            currentUser?: {
-                toObj: () => unknown;
-            };
-        };
-    };
-}
-export interface Fin5App {
-    /**
-     * Toggles FIN right side menu.
-     * The forceTo parameter can be used to enforce a specific status instead of a toggling behaviour,
-     * where: true -> menu closed, false -> menu open
-     */
-    ToggleCollapse: (forceTo: boolean) => void;
-    /**
-     * Returns current target record id.
-     */
-    TargetRef: () => TargetRef;
-    /**
-     * Updates the current target record id.
-     * Navigates the current app to the specified
-     * <code>targetRef</code>. Target Ref is the id of any equip/site etc..
-     */
-    NavigateToTargetRef: (targetRef: TargetRef, maintainView: boolean) => void;
-    /**
-     * Navigates to a particular application (trends, notes .. etc) under a specific target.
-     * @param {Fin5AppNames} appName name of the application
-     * @param {TargetRef} targetRef id of the target. Is the id of the equip/site.. etc to where the app should navigate
-     * @param {boolean} skipRef is the flag indicating where to ignore the target ref if not mentioned. If this flag is true and the target ref is not provided, then the navigation will be made to the root target ref and will not be obtained from where the app already is
-     */
-    NavigateToApp: (appName: Fin5AppNames, targetRef?: TargetRef, skipRef?: boolean, params?: string[]) => Promise<void>;
-    /**
-     * Method to open a url on the application LHS. The LHS here is the <code>iframe</code> where all
-     * the graphics etc are opened.
-     *
-     * @method LoadApplication
-     * @param {string} url - Is the url which is to be loaded
-     * @param {string} title - Specifies the title to be displayed on the iframe object
-     * @param {string} targetId - Specifies the id of the equip (etc) to which the main navigation update.
-     * @param {object} settings - extra settings that can be passed in when calling hte func
-     * @param {boolean} settings.collapse - flag indicating the collapse state of the RHS app panel
-     */
-    LoadApplication: (url: string, title?: string, targetRef?: TargetRef, settings?: {
-        collapse?: boolean;
-    }) => Promise<void>;
-    /**
-     * As the name suggests, this method logs out the user and resets the current session.
-     */
-    Logout: () => void;
-    /**
-     *	Get the currently active color scheme.
-     */
-    GetColorScheme: () => ColorScheme;
-    /**
-     * Get the filters object from the alarms application.
-     */
-    GetAlarmFilters: () => AlarmFilter;
-    /**
-     * Sets the filter settings for the alarms.
-     * @param {AlarmFilter} filters Is the object that defines the filter properties.
-     * @param {boolean} historical Flag indicating if the filter properties need to be applied to the historical alarms.
-     */
-    SetAlarmFilters: (filters: AlarmFilter, historical?: boolean) => void;
-    /**
-     * Navigates to the historian app and loads the graphs as per the passed arguments. The graph will be drawn for the passed "point" ids or for a "query" id or for a "string" query
-     * @param {HistorianType} type is the type of graph arg. Available args are:
-     *	- point : the args will have point ids in an array
-     *	- query : the arg will be the id of a saved chart query
-     *	- string : the arg will be a query string
-     * @param {HistorianArgs} args is the array/string for point ids, the query id or the raw query string
-     */
-    OpenHistorianWithOptions: (type: HistorianType, args: HistorianArgs) => void;
-    findComponent: (name: string) => Fin5AppComponent;
-    /**
-     * @see https://ractive.js.org/api/#ractiveobserve
-     */
-    observe: (keypath: string, callback: (newValue: unknown, oldValue: unknown, keypath: string) => void) => {
-        cancel: () => void;
-    };
-    set: (name: string, value: unknown) => Promise<undefined>;
-    get: (name: string) => Promise<unknown>;
-    APP_NAMES: typeof Fin5AppNames;
-}
-export declare enum Fin5AppNames {
-    EQUIP = "equip",
-    GRAPHICS = "graphics",
-    POINTS = "points",
-    ALARMS = "alarms",
-    NOTES = "notes",
-    SUMMARY = "summary",
-    SUMMARY_TOPICS = "summaryList",
-    TOOLS = "tools",
-    SCHEDULES = "schedules",
-    SCHEDULE_LIST = "scheduleList",
-    HISTORIAN = "trends",
-    TREND_LIST = "trendList",
-    SEARCH = "search",
-    LOGOUT = "logout",
-    GENERIC = "generic",
-    REPORTS = "reports"
-}
-interface LanguageManager {
-    currentLang: string;
-}
-interface Fin5AppComponent {
-    set: (value: unknown) => Promise<undefined>;
-}
-export type TargetRef = string | null | undefined;
-export interface ColorScheme {
-    primary: string;
-    bodyBackground: string;
-    sidebarBackground: string;
-}
-export {};
+import { AlarmFilter } from './openFin5Alarm';
+import { HistorianArgs, HistorianType } from './openFin5Historian';
+export declare const getFin5top: (notifyFailure?: () => void) => Fin5Top | null;
+export declare const fin5Top: Fin5Top | null;
+export declare function isWindowTopFin5(notifyFailure?: () => void): boolean;
+export interface Fin5Top extends Window {
+    app: Fin5App;
+    languageManager: LanguageManager;
+    finstack?: {
+        projectName?: string;
+        device?: {
+            currentUser?: {
+                toObj: () => unknown;
+            };
+        };
+    };
+}
+export interface Fin5App {
+    /**
+     * Toggles FIN right side menu.
+     * The forceTo parameter can be used to enforce a specific status instead of a toggling behaviour,
+     * where: true -> menu closed, false -> menu open
+     */
+    ToggleCollapse: (forceTo: boolean) => void;
+    /**
+     * Returns current target record id.
+     */
+    TargetRef: () => TargetRef;
+    /**
+     * Updates the current target record id.
+     * Navigates the current app to the specified
+     * <code>targetRef</code>. Target Ref is the id of any equip/site etc..
+     */
+    NavigateToTargetRef: (targetRef: TargetRef, maintainView: boolean) => void;
+    /**
+     * Navigates to a particular application (trends, notes .. etc) under a specific target.
+     * @param {Fin5AppNames} appName name of the application
+     * @param {TargetRef} targetRef id of the target. Is the id of the equip/site.. etc to where the app should navigate
+     * @param {boolean} skipRef is the flag indicating where to ignore the target ref if not mentioned. If this flag is true and the target ref is not provided, then the navigation will be made to the root target ref and will not be obtained from where the app already is
+     */
+    NavigateToApp: (appName: Fin5AppNames, targetRef?: TargetRef, skipRef?: boolean, params?: string[]) => Promise<void>;
+    /**
+     * Method to open a url on the application LHS. The LHS here is the <code>iframe</code> where all
+     * the graphics etc are opened.
+     *
+     * @method LoadApplication
+     * @param {string} url - Is the url which is to be loaded
+     * @param {string} title - Specifies the title to be displayed on the iframe object
+     * @param {string} targetId - Specifies the id of the equip (etc) to which the main navigation update.
+     * @param {object} settings - extra settings that can be passed in when calling hte func
+     * @param {boolean} settings.collapse - flag indicating the collapse state of the RHS app panel
+     */
+    LoadApplication: (url: string, title?: string, targetRef?: TargetRef, settings?: {
+        collapse?: boolean;
+    }) => Promise<void>;
+    /**
+     * As the name suggests, this method logs out the user and resets the current session.
+     */
+    Logout: () => void;
+    /**
+     *	Get the currently active color scheme.
+     */
+    GetColorScheme: () => ColorScheme;
+    /**
+     * Get the filters object from the alarms application.
+     */
+    GetAlarmFilters: () => AlarmFilter;
+    /**
+     * Sets the filter settings for the alarms.
+     * @param {AlarmFilter} filters Is the object that defines the filter properties.
+     * @param {boolean} historical Flag indicating if the filter properties need to be applied to the historical alarms.
+     */
+    SetAlarmFilters: (filters: AlarmFilter, historical?: boolean) => void;
+    /**
+     * Navigates to the historian app and loads the graphs as per the passed arguments. The graph will be drawn for the passed "point" ids or for a "query" id or for a "string" query
+     * @param {HistorianType} type is the type of graph arg. Available args are:
+     *	- point : the args will have point ids in an array
+     *	- query : the arg will be the id of a saved chart query
+     *	- string : the arg will be a query string
+     * @param {HistorianArgs} args is the array/string for point ids, the query id or the raw query string
+     */
+    OpenHistorianWithOptions: (type: HistorianType, args: HistorianArgs) => void;
+    /**
+     * Removes the remove-content-popup from the screen identified by the id.
+     * If the id is not specified, then removes the last popup added remote popup object.
+     * @param {string} [id] - is the id/identifier of the popup. The <code>id</code> of the HTML element should give you the id
+     */
+    RemoveRemotePopup: (id?: string) => void;
+    /**
+     * Open the Alarms application with the specified targetRef.
+     * @since FIN 5.2.0
+     * @param {TargetRef} [targetRef] - id of the target to be shown in the alarms app. If not provided, it will open with the current target ref.
+     */
+    OpenAlarms: (targetRef?: TargetRef) => Promise<void>;
+    /**
+     * Open the Schedules application with the specified targetRef and params
+     * @since FIN 5.2.0
+     * @param {TargetRef} [targetRef] - id of the target to be shown in the schedules app. If not provided, it will open with the current target ref.
+     * @param {ScheduleParams} [params] - additional parameters for the schedules app (id, appId, message).
+     */
+    OpenSchedules: (targetRef?: TargetRef, params?: SchedulesParams) => Promise<void>;
+    /**
+     * Navigates to the Charts App and loads the appropriate chart
+     * based on the chart id parameter. Removes any previous charts
+     * URL params.
+     * @since FIN 5.2.0
+     * @param {string} chartId - the id of the chart to be opened. If not provided, it will open the charts app without any chart loaded.
+     * @param {TargetRef} targetRef - id of the target to be shown in the charts app. If not provided, it will open with the current target ref.
+     */
+    OpenCharts: (chartId?: string, targetRef?: TargetRef) => Promise<void>;
+    findComponent: (name: string) => Fin5AppComponent;
+    /**
+     * @see https://ractive.js.org/api/#ractiveobserve
+     */
+    observe: (keypath: string, callback: (newValue: unknown, oldValue: unknown, keypath: string) => void) => {
+        cancel: () => void;
+    };
+    set: (name: string, value: unknown) => Promise<undefined>;
+    get: (name: string) => Promise<unknown>;
+    APP_NAMES: typeof Fin5AppNames;
+}
+export declare enum Fin5AppNames {
+    EQUIP = "equip",
+    GRAPHICS = "graphics",
+    POINTS = "points",
+    ALARMS = "alarms",
+    NOTES = "notes",
+    SUMMARY = "summary",
+    SUMMARY_TOPICS = "summaryList",
+    TOOLS = "tools",
+    SCHEDULES = "schedules",
+    SCHEDULE_LIST = "scheduleList",
+    HISTORIAN = "trends",
+    TREND_LIST = "trendList",
+    CHARTS = "charts",
+    CHART_LIST = "chartList",
+    SEARCH = "search",
+    LOGOUT = "logout",
+    GENERIC = "generic",
+    REPORTS = "reports",
+    FLOOR = "floor",
+    BUILDER = "builder",
+    FILES = "files",
+    HOME = "home",
+    DASHBOARD = "dashboard",
+    SETTINGS = "settings"
+}
+interface LanguageManager {
+    currentLang: string;
+}
+interface Fin5AppComponent {
+    set: (value: unknown) => Promise<undefined>;
+}
+export declare type TargetRef = string | null | undefined;
+export interface SchedulesParams {
+    id?: string;
+    appId?: string;
+    message?: string;
+}
+export interface ColorScheme {
+    primary: string;
+    bodyBackground: string;
+    sidebarBackground: string;
+}
+export {};