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

package/README.md

@@ -1,5 +1,5 @@
-# What is fin5-ui-utils? #
-A set of useful client-side utilities useful for creating UI applications on top of the FIN 5 framework.
-
-### How do I get set up? ###
-To install this package run `npm i @j2inn/fin5-ui-utils`
+# What is fin5-ui-utils? #
+A set of useful client-side utilities useful for creating UI applications on top of the FIN 5 framework.
+
+### How do I get set up? ###
+To install this package run `npm i @j2inn/fin5-ui-utils`

package/dist/fantomProps/createFin5Props/index.d.ts

@@ -1,12 +1,12 @@
-/**
- * Create the FIN5 language prop files from the locale JSON files.
- *
- * This function assumes the app directory has a sub-directory named `locale` that contains
- * the language files in a JSON format (i.e. `en.json`). It also assumes there's a `lib` directory
- * containing the defs for the app. This is used to look up the app name that's used to prefix the
- * entries in the properties file.
- *
- * @param appDir The directory that contains the application.
- * @param propsDir The directory the properties file will output too.
- */
-export default function createFin5Props(appDir: string, propsDir: string): Promise<void>;
+/**
+ * Create the FIN5 language prop files from the locale JSON files.
+ *
+ * This function assumes the app directory has a sub-directory named `locale` that contains
+ * the language files in a JSON format (i.e. `en.json`). It also assumes there's a `lib` directory
+ * containing the defs for the app. This is used to look up the app name that's used to prefix the
+ * entries in the properties file.
+ *
+ * @param appDir The directory that contains the application.
+ * @param propsDir The directory the properties file will output too.
+ */
+export default function createFin5Props(appDir: string, propsDir: string): Promise<void>;

package/dist/fantomProps/createFin5Props/index.js

@@ -1,147 +1,147 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const js_yaml_1 = __importDefault(require("js-yaml"));
-const util_1 = require("util");
-const haystack_core_1 = require("haystack-core");
-const readFile = (0, util_1.promisify)(fs_1.default.readFile);
-const writeFile = (0, util_1.promisify)(fs_1.default.writeFile);
-const exists = (0, util_1.promisify)(fs_1.default.exists);
-const mkdir = (0, util_1.promisify)(fs_1.default.mkdir);
-const readdir = (0, util_1.promisify)(fs_1.default.readdir);
-const unlink = (0, util_1.promisify)(fs_1.default.unlink);
-/**
- * The FIN locale path where all the JSON files reside.
- */
-const LOCALE_PATH = 'locale';
-/**
- * The application defs YAML file path.
- */
-const APP_DEF_YAML = 'lib/app.hayson.yaml';
-/**
- * Return the app name.
- *
- * @param baseDir The base directory to run from.
- * @returns The name of the app.
- */
-async function getAppName(baseDir) {
-    const buffer = await readFile(path_1.default.join(baseDir, APP_DEF_YAML));
-    // Find the name of the app to prefix all the keys with.
-    const appHayson = js_yaml_1.default.loadAll(buffer.toString('utf8'))?.[0];
-    const value = (0, haystack_core_1.makeValue)(appHayson);
-    return haystack_core_1.HNamespace.getFeatureName(value.get('def')?.value ?? '');
-}
-/**
- * Return the language from the file path.
- *
- * @param path The file path.
- * @return The language.
- */
-function getLanguageFromFile(path) {
-    return /^([^.]+)/.exec(path)?.[1] ?? '';
-}
-/**
- * Build a tree of nodes.
- *
- * @param parent The parent to add the nodes too.
- * @param obj The object to example.
- * @param leads An array of leaf nodes to build up.
- */
-function buildNode(parent, obj, leafs) {
-    for (const key of Object.keys(obj)) {
-        const child = { name: key, parent };
-        const value = obj[key];
-        if (typeof value === 'string') {
-            child.value = value;
-            leafs.push(child);
-        }
-        else {
-            buildNode(child, value, leafs);
-        }
-    }
-}
-/**
- * Create properties from the object.
- *
- * @param appName The application name.
- * @param obj The object.
- * @returns The properties.
- */
-function createProps(appName, obj) {
-    // Build a tree node of nodes for the JSON object. Record all the leafs.
-    const leafs = [];
-    buildNode({ name: appName }, obj, leafs);
-    let props = '';
-    // For each leaf, walk all the parents to build up a list of names.
-    // Reverse the list of names to create the entry.
-    for (const node of leafs) {
-        const pathNames = [];
-        let n = node;
-        while (n) {
-            if (n.name) {
-                pathNames.push(n.name);
-            }
-            n = n.parent;
-        }
-        if (pathNames.length) {
-            props += `${pathNames.reverse().join('.')}=${node.value}\n`;
-        }
-    }
-    return props;
-}
-/**
- * Clean the properties directory of any properties files.
- *
- * @param dir The directory to check.
- */
-async function cleanPropsDir(dir) {
-    for (const file of await readdir(dir)) {
-        if (file.toLowerCase().endsWith('.props')) {
-            await unlink(path_1.default.join(dir, file));
-        }
-    }
-}
-/**
- * Create the directory.
- *
- * @param dir The directory to create.
- */
-async function createDir(dir) {
-    if (!(await exists(dir))) {
-        await mkdir(dir, { recursive: true });
-    }
-}
-/**
- * Create the FIN5 language prop files from the locale JSON files.
- *
- * This function assumes the app directory has a sub-directory named `locale` that contains
- * the language files in a JSON format (i.e. `en.json`). It also assumes there's a `lib` directory
- * containing the defs for the app. This is used to look up the app name that's used to prefix the
- * entries in the properties file.
- *
- * @param appDir The directory that contains the application.
- * @param propsDir The directory the properties file will output too.
- */
-async function createFin5Props(appDir, propsDir) {
-    const appName = await getAppName(appDir);
-    await createDir(propsDir);
-    await cleanPropsDir(propsDir);
-    // For each language file, create a properties file.
-    for (const file of await readdir(path_1.default.join(appDir, LOCALE_PATH))) {
-        const filePath = path_1.default.join(appDir, LOCALE_PATH, file);
-        const obj = JSON.parse((await readFile(filePath)).toString('utf8'));
-        const props = createProps(appName, obj);
-        const language = getLanguageFromFile(file);
-        const propFilePath = path_1.default.join(propsDir, `${language}.props`);
-        await writeFile(propFilePath, props);
-    }
-}
-exports.default = createFin5Props;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const util_1 = require("util");
+const haystack_core_1 = require("haystack-core");
+const readFile = (0, util_1.promisify)(fs_1.default.readFile);
+const writeFile = (0, util_1.promisify)(fs_1.default.writeFile);
+const exists = (0, util_1.promisify)(fs_1.default.exists);
+const mkdir = (0, util_1.promisify)(fs_1.default.mkdir);
+const readdir = (0, util_1.promisify)(fs_1.default.readdir);
+const unlink = (0, util_1.promisify)(fs_1.default.unlink);
+/**
+ * The FIN locale path where all the JSON files reside.
+ */
+const LOCALE_PATH = 'locale';
+/**
+ * The application defs YAML file path.
+ */
+const APP_DEF_YAML = 'lib/app.hayson.yaml';
+/**
+ * Return the app name.
+ *
+ * @param baseDir The base directory to run from.
+ * @returns The name of the app.
+ */
+async function getAppName(baseDir) {
+    const buffer = await readFile(path_1.default.join(baseDir, APP_DEF_YAML));
+    // Find the name of the app to prefix all the keys with.
+    const appHayson = js_yaml_1.default.loadAll(buffer.toString('utf8'))?.[0];
+    const value = (0, haystack_core_1.makeValue)(appHayson);
+    return haystack_core_1.HNamespace.getFeatureName(value.get('def')?.value ?? '');
+}
+/**
+ * Return the language from the file path.
+ *
+ * @param path The file path.
+ * @return The language.
+ */
+function getLanguageFromFile(path) {
+    return /^([^.]+)/.exec(path)?.[1] ?? '';
+}
+/**
+ * Build a tree of nodes.
+ *
+ * @param parent The parent to add the nodes too.
+ * @param obj The object to example.
+ * @param leads An array of leaf nodes to build up.
+ */
+function buildNode(parent, obj, leafs) {
+    for (const key of Object.keys(obj)) {
+        const child = { name: key, parent };
+        const value = obj[key];
+        if (typeof value === 'string') {
+            child.value = value;
+            leafs.push(child);
+        }
+        else {
+            buildNode(child, value, leafs);
+        }
+    }
+}
+/**
+ * Create properties from the object.
+ *
+ * @param appName The application name.
+ * @param obj The object.
+ * @returns The properties.
+ */
+function createProps(appName, obj) {
+    // Build a tree node of nodes for the JSON object. Record all the leafs.
+    const leafs = [];
+    buildNode({ name: appName }, obj, leafs);
+    let props = '';
+    // For each leaf, walk all the parents to build up a list of names.
+    // Reverse the list of names to create the entry.
+    for (const node of leafs) {
+        const pathNames = [];
+        let n = node;
+        while (n) {
+            if (n.name) {
+                pathNames.push(n.name);
+            }
+            n = n.parent;
+        }
+        if (pathNames.length) {
+            props += `${pathNames.reverse().join('.')}=${node.value}\n`;
+        }
+    }
+    return props;
+}
+/**
+ * Clean the properties directory of any properties files.
+ *
+ * @param dir The directory to check.
+ */
+async function cleanPropsDir(dir) {
+    for (const file of await readdir(dir)) {
+        if (file.toLowerCase().endsWith('.props')) {
+            await unlink(path_1.default.join(dir, file));
+        }
+    }
+}
+/**
+ * Create the directory.
+ *
+ * @param dir The directory to create.
+ */
+async function createDir(dir) {
+    if (!(await exists(dir))) {
+        await mkdir(dir, { recursive: true });
+    }
+}
+/**
+ * Create the FIN5 language prop files from the locale JSON files.
+ *
+ * This function assumes the app directory has a sub-directory named `locale` that contains
+ * the language files in a JSON format (i.e. `en.json`). It also assumes there's a `lib` directory
+ * containing the defs for the app. This is used to look up the app name that's used to prefix the
+ * entries in the properties file.
+ *
+ * @param appDir The directory that contains the application.
+ * @param propsDir The directory the properties file will output too.
+ */
+async function createFin5Props(appDir, propsDir) {
+    const appName = await getAppName(appDir);
+    await createDir(propsDir);
+    await cleanPropsDir(propsDir);
+    // For each language file, create a properties file.
+    for (const file of await readdir(path_1.default.join(appDir, LOCALE_PATH))) {
+        const filePath = path_1.default.join(appDir, LOCALE_PATH, file);
+        const obj = JSON.parse((await readFile(filePath)).toString('utf8'));
+        const props = createProps(appName, obj);
+        const language = getLanguageFromFile(file);
+        const propFilePath = path_1.default.join(propsDir, `${language}.props`);
+        await writeFile(propFilePath, props);
+    }
+}
+exports.default = createFin5Props;
 //# sourceMappingURL=index.js.map

package/dist/fantomProps/createFin5Props/runCreateFin5Props.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};

package/dist/fantomProps/createFin5Props/runCreateFin5Props.js

@@ -1,21 +1,21 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = __importDefault(require("."));
-const path_1 = __importDefault(require("path"));
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-/**
- * Run the creation of the FIN5 properties as a script.
- */
-const srcDir = process.argv[2] ? path_1.default.resolve(process.argv[2]) : path_1.default.resolve();
-const outDir = process.argv[3]
-    ? path_1.default.resolve(process.argv[3])
-    : path_1.default.resolve('fin5/locale');
-console.log(`Creating FIN5 property language files from '${srcDir}' to '${outDir}'...`);
-(0, _1.default)(srcDir, outDir).then(() => console.log('Successfully completed property file creation'), (error) => console.error('Failed to create property file', error));
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = __importDefault(require("."));
+const path_1 = __importDefault(require("path"));
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+/**
+ * Run the creation of the FIN5 properties as a script.
+ */
+const srcDir = process.argv[2] ? path_1.default.resolve(process.argv[2]) : path_1.default.resolve();
+const outDir = process.argv[3]
+    ? path_1.default.resolve(process.argv[3])
+    : path_1.default.resolve('fin5/locale');
+console.log(`Creating FIN5 property language files from '${srcDir}' to '${outDir}'...`);
+(0, _1.default)(srcDir, outDir).then(() => console.log('Successfully completed property file creation'), (error) => console.error('Failed to create property file', error));
 //# sourceMappingURL=runCreateFin5Props.js.map

package/dist/fantomProps/fantomPropsToObject.d.ts

@@ -1,8 +1,8 @@
-export interface Props {
-    [key: string]: string;
-}
-/**
- * Convert the given fantom props as string to JS object (@see https://fantom.org/doc/sys/InStream#readProps)
- */
-export default function fantomPropsToObject(props: string): Props;
-export declare function parseFantomProps(readChar: () => number, unreadChar: (char: number) => void): Props;
+export interface Props {
+    [key: string]: string;
+}
+/**
+ * Convert the given fantom props as string to JS object (@see https://fantom.org/doc/sys/InStream#readProps)
+ */
+export default function fantomPropsToObject(props: string): Props;
+export declare function parseFantomProps(readChar: () => number, unreadChar: (char: number) => void): Props;