@ygracs/xepg-lib-js 0.0.21 → 0.0.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/xepg-lib-js",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "description": "A library for handling an EPG-sources based on an XEPG-format",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -8,29 +8,22 @@
     "type": "git",
     "url": "git+https://gitlab.com/ygracs/xepg-lib-js.git"
   },
+  "keywords": [
+    "xml",
+    "EPG"
+  ],
   "main": "./index.js",
   "files": [
-    "doc/xepgdoc-lib.md",
-    "doc/xepgdoc-spec.md",
     "doc/xepgdoc-spec-draft.dtd",
-    "doc/xepgdoc-example.xepg",
+    "doc/*.xepg",
+    "doc/*.md",
     "lib/xepgdoc-lib.js",
     "lib/dts-helper.js",
-    "lib/file-helper.js",
     "index.js",
     "CHANGELOG.md"
   ],
   "scripts": {
     "test": "cross-env TZ='Etc/UTC' jest",
-    "test-xepg": "TZ='Etc/UTC' jest ./test",
-    "test-xepg:sl": "jest TXEpgSchedulesList",
-    "test-xepg:hc": "TZ='Etc/UTC' jest TXEpgHeader",
-    "test-xepg:pc": "jest TXEpgProvider",
-    "test-xepg:dts": "jest TXEpgDTS",
-    "test-xepg:cp": "jest TXEpgContentProvider",
-    "win:test": "set TZ='Etc/UTC' && jest",
-    "win:test-xepg": "set TZ='Etc/UTC' && jest ./test",
-    "win:test-xepg:hc": "set TZ='Etc/UTC' && jest TXEpgHeader",
     "build-doc-md": "jsdoc2md",
     "build-doc-html": "jsdoc"
   },
@@ -39,10 +32,11 @@
     "#test-dir/*": "./__test__/*"
   },
   "dependencies": {
-    "@ygracs/bsfoc-lib-js": "^0.2.2",
-    "@ygracs/dtf-lib-js": "^0.0.27",
-    "@ygracs/xml-js6": "^0.0.4-b",
-    "@ygracs/xobj-lib-js": "^0.2.1"
+    "@cntwg/file-helper": "^0.0.1",
+    "@ygracs/bsfoc-lib-js": "^0.2.3",
+    "@ygracs/dtf-lib-js": "^0.0.28",
+    "@ygracs/xml-js6": "^0.0.5-b",
+    "@ygracs/xobj-lib-js": "^0.2.2"
   },
   "devDependencies": {
     "cross-env": "^7.0.3",

package/lib/file-helper.js

@@ -1,278 +0,0 @@
-// [v0.1.030-20241029]
-
-// === module init block ===
-
-const fs = require('fs');
-const fse = require('fs').promises;
-
-const {
-  isPlainObject,
-} = require('@ygracs/bsfoc-lib-js');
-
-// === module extra block (helper functions) ===
-
-/**
- * @typedef {Object} fsoDescr
- * @property {boolean} isERR - flag
- * @property {number|undefined} errCode - error code
- * @property {string} errEvent - event ID
- * @property {string} errMsg - event message
- * @property {string} source - path to file
- * @property {any} content - file content
- * @description A fs ops description.
- */
-
-/**
- * @typedef {Object} VCOR_evalerrfs
- * @property {boolean} isSucceed - ops flag
- * @property {fsoDescr} descr - description
- * @description A result of an error check ops.
- */
-
-/**
- * @function checkFsError
- * @param {fsoDescr} descr
- * @param {Error} err
- * @returns {VCOR_evalerrfs}
- * @inner
- * @description Checks an error code of a fs ops and sets descr info if succeed
- */
-function checkFsError(descr, err) {
-  let isSucceed = false;
-  if (isPlainObject(err) && isPlainObject(descr)) {
-    switch (err.code) {
-      case 'ENOENT':
-      case 'EISDIR':
-      case 'ENOTDIR':
-      case 'EPERM': {
-        descr.errCode = err.errno;
-        descr.errEvent = err.code;
-        descr.errMsg = `ERR_FILE_${err.code}`;
-        isSucceed = true;
-        break;
-      }
-      default: {}
-    };
-    if (isSucceed) descr.isERR = true;
-  };
-  return { isSucceed, descr };
-};
-
-// === module main block ===
-
-/***
- * (* constant definitions *)
- */
-
-/***
- * (* function definitions *)
- */
-
-/**
- * @function loadFileSync
- * @param {string} src - a path to some file
- * @returns {fsoDescr}
- * @inner
- * @description Loads file by a given path
- */
-function loadFileSync(src) {
-  /** @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';
-    };
-  } else {
-    const srcPath = src.trim();
-    if (srcPath !== '') {
-      data.source = srcPath;
-      try {
-        data.content = fs.readFileSync(srcPath, 'utf8');
-      } catch (err) {
-        const { isSucceed } = checkFsError(data, err);
-        if (!isSucceed) {
-          // // TODO: [?] consider check others
-          //console.log(`TEST_ERR-MSG:loadFileSync: ${err}`);
-          //throw err;
-        };
-      };
-    };
-  };
-  return data;
-};
-
-/**
- * @function loadFile
- * @param {string} src - a path to some file
- * @returns {Promise<fsoDescr, Error>}
- * @async
- * @inner
- * @description Loads file by a given path
- */
-function loadFile(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: loadFile() => Error => '+err);
-          //console.log('CHECK: loadFile() => Error => '+err.code);
-          reject(err);
-        };
-      });
-    };
-  });
-};
-
-/**
- * @function saveToFileSync
- * @param {string} src - a path to some file
- * @param {string} content - some file content
- * @param {any} [opt] - <reserved>
- * @returns {fsoDescr}
- * @inner
- * @description Saves a content to a file
- */
-function saveToFileSync(src, content = '', opt) {
-  /** @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';
-  } else if (typeof content === 'string') {
-    const srcPath = src.trim();
-    if (srcPath === '') {
-      data.isERR = true;
-      data.errEvent = 'ERR_NOSRC';
-      data.errMsg = 'No "source" path given';
-    } else {
-      data.source = srcPath;
-      try {
-        fs.writeFileSync(srcPath, content, 'utf8');
-      } catch (err) {
-        const { isSucceed } = checkFsError(data, err);
-        if (!isSucceed) {
-          // // TODO: [?] consider check others
-          //console.log(`TEST_ERR-MSG:saveToFileSync: ${err}`);
-          //throw err;
-        };
-      };
-    };
-  } else {
-    data.isERR = true;
-    data.errEvent = 'ERR_INVARG';
-    data.errMsg = 'The "content" argument must be a string';
-  };
-  return data;
-};
-
-/**
- * @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);
-    };
-  });
-};
-
-/***
- * (* class definitions *)
- */
-
-// === module exports block ===
-
-module.exports.checkFsError = checkFsError;
-module.exports.loadFile = loadFile;
-module.exports.loadFileSync = loadFileSync;
-module.exports.saveToFile = saveToFile;
-module.exports.saveToFileSync = saveToFileSync;