@ygracs/chn-alias-list 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+#### *v0.0.4*
+
+Pre-release version.
+
+> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.2.2.
+
 #### *v0.0.1-0.0.3*
 
 Pre-release version.

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024-2024 Yuri Grachev
+Copyright (c) 2024-2025 Yuri Grachev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/lib/file-helper.js

@@ -1,8 +1,9 @@
-// [v0.1.026-20241021]
+// [v0.1.029-20250218]
 
 // === module init block ===
 
 const fs = require('fs');
+const fse = require('fs').promises;
 
 const {
   isPlainObject,
@@ -57,14 +58,24 @@ function checkFsError(descr, err) {
   return { isSucceed, descr };
 };
 
+// === module main block ===
+
+/***
+ * (* constant definitions *)
+ */
+
+/***
+ * (* function definitions *)
+ */
+
 /**
- * @function loadFileSync
+ * @function loadFromFileSync
  * @param {string} src - a path to some file
  * @returns {fsoDescr}
  * @inner
  * @description Loads file by a given path
  */
-function loadFileSync(src) {
+function loadFromFileSync(src) {
   /** @type {fsoDescr} */
   const data = {
     isERR: false,
@@ -90,7 +101,7 @@ function loadFileSync(src) {
         const { isSucceed } = checkFsError(data, err);
         if (!isSucceed) {
           // // TODO: [?] consider check others
-          //console.log(`TEST_ERR-MSG:loadFileSync: ${err}`);
+          //console.log(`TEST_ERR-MSG:loadFromFileSync: ${err}`);
           //throw err;
         };
       };
@@ -99,6 +110,55 @@ function loadFileSync(src) {
   return data;
 };
 
+/**
+ * @function loadFromFile
+ * @param {string} src - a path to some file
+ * @returns {Promise<fsoDescr, Error>}
+ * @async
+ * @inner
+ * @description Loads file by a given path
+ */
+function loadFromFile(src) {
+  /**/// main part that return promise as a result
+  return new Promise((resolve, reject) => {
+    /** @type {fsoDescr} */
+    const data = {
+      isERR: false,
+      errCode: 0,
+      errEvent: '',
+      errMsg: '',
+      source: '',
+      content: '',
+    };
+    if (typeof src !== 'string') {
+      if (src !== undefined) {
+        data.isERR = true;
+        data.errEvent = 'ERR_INVARG';
+        data.errMsg = 'The "source" argument must be a string';
+      };
+      resolve(data);
+    } else {
+      const srcPath = src.trim();
+      if (srcPath === '') resolve(data);
+      data.source = srcPath;
+      fse.readFile(srcPath, 'utf8').then(result => {
+        data.content = result;
+        resolve(data);
+      }).catch(err => {
+        let { isSucceed } = checkFsError(data, err);
+        if (isSucceed) {
+          data.content = '';
+          resolve(data);
+        } else {
+          //console.log('CHECK: loadFromFile() => Error => '+err);
+          //console.log('CHECK: loadFromFile() => Error => '+err.code);
+          reject(err);
+        };
+      });
+    };
+  });
+};
+
 /**
  * @function saveToFileSync
  * @param {string} src - a path to some file
@@ -149,15 +209,61 @@ function saveToFileSync(src, content = '', opt) {
   return data;
 };
 
-// === module main block ===
-
-/***
- * (* constant definitions *)
- */
-
-/***
- * (* function definitions *)
+/**
+ * @function saveToFile
+ * @param {string} src - a path to some file
+ * @param {string} content - some file content
+ * @param {any} [opt] - <reserved>
+ * @returns {Promise<fsoDescr, Error>}
+ * @async
+ * @inner
+ * @description Saves a content to a file
  */
+function saveToFile(src, content = '', opt) {
+  /**/// main part that return promise as a result
+  return new Promise((resolve, reject) => {
+    /** @type {fsoDescr} */
+    const data = {
+      isERR: false,
+      errCode: 0,
+      errEvent: '',
+      errMsg: '',
+      source: '',
+      content: '',
+    };
+    if (typeof src !== 'string') {
+      data.isERR = true;
+      data.errEvent = src === undefined ? 'ERR_NOSRC' : 'ERR_INVARG';
+      data.errMsg = 'The "source" argument must be a string';
+      resolve(data);
+    }  else if (typeof content === 'string') {
+      const srcPath = src.trim();
+      if (srcPath === '') {
+        data.isERR = true;
+        data.errEvent = 'ERR_NOSRC';
+        data.errMsg = 'No "source" path given';
+        resolve(data);
+      } else {
+        data.source = srcPath;
+        fse.writeFile(srcPath, content, 'utf8').then(result => {
+          resolve(data);
+        }).catch(err => {
+          const { isSucceed } = checkFsError(data, err);
+          if (isSucceed) resolve(data);
+          // // TODO: [?] consider check others
+          //console.log('CHECK: TXEpgContentProvider.saveToFile() => Error => '+err);
+          //console.log('CHECK: TXEpgContentProvider.saveToFile() => Error => '+err.code);
+          reject(err);
+        });
+      };
+    } else {
+      data.isERR = true;
+      data.errEvent = 'ERR_INVARG';
+      data.errMsg = 'The "content" argument must be a string';
+      resolve(data);
+    };
+  });
+};
 
 /**
  * @typedef {Object} RVAL_loadjsonff
@@ -166,6 +272,48 @@ function saveToFileSync(src, content = '', opt) {
  * @description A result of `loadJSONFromFileSync`
  */
 
+/**
+ * @function loadJSONFromFile
+ * @param {string} src - a path to some file
+ * @param {any} [opt] - <reserved>
+ * @returns {Promise<RVAL_loadjsonff, Error>}
+ * @async
+ * @inner
+ * @description Loads a JSON-object from a file
+ */
+function loadJSONFromFile(src, opt) {
+  /**/// main part that return promise as a result
+  return new Promise((resolve, reject) => {
+    loadFromFile(src).then(data => {
+      let obj = null;
+      if (!data.isERR) {
+        if (data.content !== '') {
+          try {
+            obj = JSON.parse(data.content);
+            // if succeed clear <data.content>
+            data.content = '';
+          } catch (err) {
+            data.isERR = true;
+            //console.log(`TEST_ERR-CODE: [${err.code}](${err.errno})`);
+            //console.log(`TEST_ERR-MSG: ${err}`);
+            if (err instanceof SyntaxError) {
+              data.errEvent = 'ERR_JSON_BADDATA';
+              data.errMsg = err.message;
+            } else {
+              data.errEvent = 'ERR_JSON_UNKNOWN';
+            };
+          };
+        };
+      };
+      resolve({ descr: data, obj });
+    }).catch(err => {
+      //console.log('CHECK: TXEpgContentProvider.loadFromFile() => Error => '+err);
+      //console.log('CHECK: TXEpgContentProvider.loadFromFile() => Error => '+err.code);
+      reject(err);
+    });
+  });
+};
+
 /**
  * @function loadJSONFromFileSync
  * @param {string} src - a path to some file
@@ -175,7 +323,7 @@ function saveToFileSync(src, content = '', opt) {
  * @description Loads a JSON-object from a file
  */
 function loadJSONFromFileSync(src, opt) {
-  const data = loadFileSync(src);
+  const data = loadFromFileSync(src);
   let obj = null;
   if (!data.isERR) {
     if (data.content !== '') {
@@ -199,6 +347,51 @@ function loadJSONFromFileSync(src, opt) {
   return { descr: data, obj };
 };
 
+/**
+ * @function saveJSONToFile
+ * @param {string} src - a path to some file
+ * @param {object} obj - some content
+ * @param {any} [opt] - <reserved>
+ * @returns {Promise<fsoDescr, Error>}
+ * @throws {Error}
+ * @async
+ * @inner
+ * @description Saves a JSON-object to a file
+ */
+function saveJSONToFile(src, obj, opt) {
+  /**/// main part that return promise as a result
+  return new Promise((resolve, reject) => {
+    /** @type {fsoDescr} */
+    let data = {
+      isERR: false,
+      errCode: 0,
+      errEvent: '',
+      errMsg: '',
+      source: '',
+      content: '',
+    };
+    (new Promise((resolve, reject) => {
+      data.content = JSON.stringify(obj, null, 2);
+      resolve(true);
+    })).then(result => {
+      saveToFile(src, data.content, null).then(data => {
+        resolve(data);
+      }).catch(err => {
+        // // TODO: [?] consider check others
+        //console.log('CHECK: TXEpgContentProvider.saveToFile() => Error => '+err);
+        //console.log('CHECK: TXEpgContentProvider.saveToFile() => Error => '+err.code);
+        reject(err);
+      });
+    }).catch(err => {
+      data.isERR = true;
+      //console.log(`TEST_ERR-CODE: [${err.code}](${err.errno})`);
+      //console.log(`TEST_ERR-MSG: ${err}`);
+      data.errEvent = 'ERR_JSON_UNKNOWN';
+      resolve(data);
+    });
+  });
+};
+
 /**
  * @function saveJSONToFileSync
  * @param {string} src - a path to some file
@@ -239,7 +432,11 @@ function saveJSONToFileSync(src, obj, opt) {
 // === module exports block ===
 
 module.exports.checkFsError = checkFsError;
-module.exports.loadFileSync = loadFileSync;
+module.exports.loadFromFile = loadFromFile;
+module.exports.loadFromFileSync = loadFromFileSync;
+module.exports.saveToFile = saveToFile;
 module.exports.saveToFileSync = saveToFileSync;
+module.exports.loadJSONFromFile = loadJSONFromFile;
 module.exports.loadJSONFromFileSync = loadJSONFromFileSync;
+module.exports.saveJSONToFile = saveJSONToFile;
 module.exports.saveJSONToFileSync = saveJSONToFileSync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/chn-alias-list",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "A small library which provides some helper classes for EPG-tools",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -26,11 +26,11 @@
     "#test-dir/*": "./__test__/*"
   },
   "dependencies": {
-    "@ygracs/bsfoc-lib-js": "^0.2.1"
+    "@ygracs/bsfoc-lib-js": "^0.2.2"
   },
   "devDependencies": {
     "jest": "^29.7.0",
-    "jsdoc-to-markdown": "^9.0.4",
+    "jsdoc-to-markdown": "^9.1.1",
     "minimist": "^1.2.8"
   }
 }