@ygracs/xepg-lib-js 0.0.15 → 0.0.17

package/CHANGELOG.md

@@ -0,0 +1,144 @@
+#### *v0.0.17*
+
+Pre-release version.
+
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.3;
+> - updated dependency on `@ygracs/dtf-lib-js` module to v0.0.22;
+> - updated dependency on `@ygracs/xobj-lib-js` module to v0.0.14-rc4;
+> - some fixes in `dts-helper.js` lib-module.
+
+#### *v0.0.16*
+
+Pre-release version.
+
+> - updated dependency on `@ygracs/xobj-lib-js` module to v0.0.14-rc3;
+> - updated dependency on `@ygracs/dtf-lib-js` module to v0.0.21;
+> - added `getDTSysDescr` function into `dts-helper.js` lib-module;
+> - some fixes in `dts-helper.js` lib-module;
+> - some fixes in `xepgdoc-lib.js` module.
+
+#### *v0.0.15*
+
+Pre-release version.
+
+> - `xepgdoc-spec.md` updated;
+> - `xepgdoc-lib.md` updated;
+> - removed property `SchedulesQty` for `TXEpgSchedulesList` class;
+> - some changes upon a class constructor options (deprecated settings which sets the rules of an element tag naming).
+
+#### *v0.0.14*
+
+Pre-release version.
+
+> - added dependency on `@ygracs/dtf-lib-js` module;
+> - `$module/lib/dts-helper.js` updated;
+> - `$module/lib/xepgdoc-lib.js` updated;
+> - `$module/lib/dtFunc.js` removed.
+
+#### *v0.0.13*
+
+Pre-release version.
+
+> - updated `dtFunc.js` lib-module to v0.1.019-20220903;
+> - updated dependency on `@ygracs/xobj-lib-js` module to v0.0.13;
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.2.
+
+#### *v0.0.12*
+
+Pre-release version.
+
+> - switch dependency from `@cntwg/xml-lib-js` module to `@ygracs/xobj-lib-js` module;
+> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.1.1.
+
+#### *v0.0.11*
+
+Pre-release version.
+
+> - `xepgdoc-lib.md` updated;
+> - some fixes in `dts-helper.js` lib-module;
+> - some fixes in `dtFunc.js` lib-module;
+> - some fixes in `xepgdoc-lib.js` module;
+> - add property `schedQty` to `TXEpgSchedulesList` class;
+> - add property `dts` to `TXEpgHeaderContainer` class;
+> - add property `dts` to `TXEpgContentContainer` class;
+> - add `TXepgDTSProvider` class;
+> - deprecate property `SchedulesQty` of `TXEpgSchedulesList` class.
+
+#### *v0.0.10*
+
+Pre-release version.
+
+> - some fixes in `xepgdoc-lib.js` module.
+
+#### *v0.0.9*
+
+Pre-release version.
+
+> - `xepgdoc-lib.md` updated;
+> - `xepgdoc-spec.md` updated;
+> - some fixes in `xepgdoc-lib.js` module;
+> - some fixes in `dtFunc.js` module;
+> - `$module/lib/dts-helper.js` added;
+> - move module `xepgdoc-lib-v2.js` to its own project;
+> - updated dependency on `@cntwg/xml-lib-js` module to v0.0.13;
+> - updated dependency on `@ygracs/xml-js6` module to v0.0.3b.
+
+#### *v0.0.8*
+
+Pre-release version.
+
+> - updated dependency on `@cntwg/xml-lib-js` module to v0.0.10;
+> - switch dependency from `@cntwg/bsfoc-lib-js` module to `@ygracs/bsfoc-lib-js` module.
+
+#### *v0.0.7*
+
+Pre-release version.
+
+> - updated dependency on `@cntwg/bsfoc-lib-js` module to v0.0.11;
+> - updated dependency on `@cntwg/xml-lib-js` module to v0.0.9.
+
+#### *v0.0.6*
+
+Pre-release version.
+
+> - some fixes in `xepgdoc-lib.js` module.
+
+#### *v0.0.5*
+
+Pre-release version.
+
+> - updated dependency on `@cntwg/bsfoc-lib-js` module to v0.0.8;
+> - updated dependency on `@cntwg/xml-lib-js` module to v0.0.8;
+> - add method `loadFromFileSync` to `TXEpgContentProvider` (v1);
+> - add method `saveToFileSync` to `TXEpgContentProvider` (v1);
+> - some fixes in `xepgdoc-lib.js` module;
+> - `$module/lib/xepgdoc-lib-v2.js` added;
+> - `xepgdoc-lib-v2.md` added;
+> - `xepgdoc-spec.md` added.
+
+#### *v0.0.4*
+
+Pre-release version.
+
+> - removed class `TXEpgContentBodyContainer` from `xepgdoc-lib.js` module;
+> - merdged class `TXEpgContentContainer` into `TXEpgContentProvider`;
+> - `xepgdoc-lib.md` added.
+
+#### *v0.0.3*
+
+Pre-release version.
+
+> - updated dependency on `@cntwg/xml-lib-js` module to v0.0.7;
+> - renamed class `TXEpgScheduleContainer` to `TXEpgSchedulesList`;
+> - `xepgdoc-lib.md` added;
+> - MIT-license applied.
+
+#### *v0.0.2*
+
+Pre-release version.
+
+> - fixed some errors in `xepgdoc-lib.js` module.
+
+#### *v0.0.1*
+
+Pre-release version.

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright (c) 2019-2022 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:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2019-2023 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/index.js

@@ -1,4 +1,4 @@
-// [v0.0.007-20220908]
+// [v0.0.008-20230326]
 
 // === module init block ===
 

package/lib/dts-helper.js

@@ -1,9 +1,10 @@
-// [v0.1.040-20221126]
+// [v0.1.043-20230711]
 
 // === module init block ===
 
 const {
   valueToIndex, readAsString, readAsNumberEx,
+  isDateObject,
 } = require('@ygracs/bsfoc-lib-js');
 
 const {
@@ -33,49 +34,71 @@ function getDTSysName(value){
   return result;
 };
 
+function getDTSysDescr(value){
+  let index = valueToIndex(value);
+  let name = 'undefined';
+  if (index !== -1) {
+    let result = def_dts_param[index];
+    if (result) name = result;
+  } else if (typeof value === 'string') {
+    let result = value.trim();
+    if (result !== '') {
+      index = def_dts_param.indexOf(result);
+      if (index !== -1) name = result;
+    };
+  };
+  return { index, name };
+};
+
 function convStringToDTValue(value, dts_id, tz){
   let result = 0;
   let dtstype = valueToIndex(dts_id);
   let dt_str = typeof value === 'string' ? value : '';
   if (chkDTSysID(dtstype)) {
     switch (getDTSysName(dtstype)) {
-      case 'default':
+      case 'default': {
         // TODO: check TZ
         //console.log('convStringToDTValue => dtstype:[default]');
         result = (new Date(dt_str)).getTime();
         //console.log('convStringToDTValue => value:['+value+']');
         //console.log('convStringToDTValue => result:['+result+']');
         break;
-      case 'iso8601':
+      }
+      case 'iso8601': {
         // TODO: check TZ
         //console.log('convStringToDTValue => dtstype:[iso8601]');
         result = (new Date(dt_str)).getTime();
         //console.log('convStringToDTValue => value:['+value+']');
         //console.log('convStringToDTValue => result:['+result+']');
         break;
-      case 'xmltv':
+      }
+      case 'xmltv': {
         // TODO: check TZ
         //console.log('convStringToDTValue => dtstype:[xmltv]');
         result = (new Date(convXMLTVToDTValue(dt_str))).getTime();
         //console.log('convStringToDTValue => value:['+value+']');
         //console.log('convStringToDTValue => result:['+result+']');
         break;
-      case 'timestamp':
+      }
+      case 'timestamp': {
         // TODO: check TZ
         //console.log('convStringToDTValue => dtstype:[timestamp]');
         result = Number(dt_str);
         //console.log('convStringToDTValue => value:['+value+']');
         //console.log('convStringToDTValue => result:['+result+']');
         break;
-      case 'utc':
+      }
+      case 'utc': {
         // TODO: check TZ
         //console.log('convStringToDTValue => dtstype:[utc]');
         result = (new Date(Date.UTC(dt_str))).getTime();
         //console.log('convStringToDTValue => value:['+value+']');
         //console.log('convStringToDTValue => result:['+result+']');
         break;
-      default:
+      }
+      default: {
         break;
+      }
     };
     if (Number.isNaN(result)) result = 0;
   };
@@ -84,12 +107,16 @@ function convStringToDTValue(value, dts_id, tz){
 
 function convDTValueToString(value, dts_id, tz){
   let result = '';
-  let dtstype = valueToIndex(dts_id);
-  let dt_val = (new Date(readAsNumberEx(value, 0))).getTime();
+  let dt_val = (
+    isDateObject(value)
+    ? value
+    : (new Date(readAsNumberEx(value, 0)))
+  ).getTime();
   if (Number.isNaN(dt_val)) dt_val = new Date(0);
+  let dtstype = valueToIndex(dts_id);
   if (!chkDTSysID(dtstype)) dtstype = 0;
   switch (getDTSysName(dtstype)) {
-    case 'default':
+    case 'default': {
       // TODO: check TZ
       //console.log('convDTValueToString => dtstype:[default]');
       result = convDTValueToDateString(dt_val, {
@@ -98,17 +125,20 @@ function convDTValueToString(value, dts_id, tz){
       //console.log('convDTValueToString => value:['+value+']');
       //console.log('convDTValueToString => result:['+result+']');
       break;
-    case 'iso8601':
+    }
+    case 'iso8601': {
       // TODO: check TZ
       //console.log('convDTValueToString => dtstype:[iso8601]');
       result = convDTValueToISO8601(dt_val, {
-        use_bs_format: false,
+        //use_bs_format: false,
+        useBaseFormat: false,
         src_in_utc: false,
       });
       //console.log('convDTValueToString => value:['+value+']');
       //console.log('convDTValueToString => result:['+result+']');
       break;
-    case 'xmltv':
+    }
+    case 'xmltv': {
       // TODO: check TZ
       //console.log('convDTValueToString => dtstype:[xmltv]');
       result = convDTValueToXMLTV(dt_val, {
@@ -117,15 +147,18 @@ function convDTValueToString(value, dts_id, tz){
       //console.log('convDTValueToString => value:['+value+']');
       //console.log('convDTValueToString => result:['+result+']');
       break;
-    case 'timestamp':
+    }
+    case 'timestamp': {
       // TODO: check TZ
       //console.log('convDTValueToString => dtstype:[timestamp]');
       result = dt_val.toString();
       //console.log('convDTValueToString => value:['+value+']');
       //console.log('convDTValueToString => result:['+result+']');
       break;
-    default:
+    }
+    default: {
       break;
+    }
   };
   return result;
 };
@@ -137,5 +170,6 @@ function convDTValueToString(value, dts_id, tz){
 exports.chkDTSysID = chkDTSysID;
 exports.checkDTSysID = chkDTSysID;
 exports.getDTSysName = getDTSysName;
+exports.getDTSysDescr = getDTSysDescr;
 exports.convStringToDTValue = convStringToDTValue;
 exports.convDTValueToString = convDTValueToString;

package/lib/xepgdoc-lib.js

@@ -1,4 +1,4 @@
-// [v0.1.050-20221206]
+// [v0.1.054-20230326]
 
 // === module init block ===
 
@@ -18,7 +18,7 @@ const {
 } = require('@ygracs/dtf-lib-js');
 
 const {
-  chkDTSysID, getDTSysName,
+  chkDTSysID, getDTSysName, getDTSysDescr,
   convStringToDTValue, convDTValueToString,
 } = require('./dts-helper.js');
 
@@ -277,7 +277,11 @@ class TXEpgProviderContainer {
   set version(value){
     if (this.name !== '') {
       const _value = typeof value === 'string' ? value.trim() : '';
-      const item = insertXObjElement(this.#_content, 'version', true);
+      const item = insertXObjElement(
+        this.#_content,
+        'version',
+        { force: true },
+      );
       if (item) writeXObjParam(item, _value);
     };
   }
@@ -288,7 +292,11 @@ class TXEpgProviderContainer {
 
   set schema(value){
     const _value = typeof value === 'string' ? value.trim() : '';
-    const item = insertXObjElement(this.#_content, XEPG_DOCSCH_ETAG_NAME, true);
+    const item = insertXObjElement(
+      this.#_content,
+      XEPG_DOCSCH_ETAG_NAME,
+      { force: true },
+    );
     if (item) writeXObjParam(item, _value);
   }
 
@@ -298,13 +306,17 @@ class TXEpgProviderContainer {
 
   set doctype(value){
     const _value = typeof value === 'string' ? value.trim() : '';
-    const item = insertXObjElement(this.#_content, XEPG_DOCTYP_ETAG_NAME, true);
+    const item = insertXObjElement(
+      this.#_content,
+      XEPG_DOCTYP_ETAG_NAME,
+      { force: true },
+    );
     if (item) writeXObjParam(item, _value);
   }
 
   setName(value){
     let isSUCCEED = false;
-    let item = insertXObjElement(this.#_content, 'name', true);
+    let item = insertXObjElement(this.#_content, 'name', { force: true });
     if (item) {
       const name = typeof value === 'string' ? value.trim() : '';
       isSUCCEED = writeXObjParam(item, name);
@@ -413,14 +425,22 @@ class TXepgDTSProvider {
   }
 
   set dtstype(value){
-    if (chkDTSysID(value)) {
-      const item = getXObjElement(this.#_content, XEPG_DTSINFO_ETAG_NAME);
+    let { index, name } = getDTSysDescr(value);
+    if (index !== -1) {
+      const item = insertXObjElement(
+        this.#_content,
+        XEPG_DTSINFO_ETAG_NAME,
+        { force: true },
+      );
       if (item) {
-        let name = getDTSysName(value);
-        let curItem = insertXObjElement(item, 'value', true);
-        if (curItem) writeXObjParam(curItem, valueToIndex(value));
-        curItem = insertXObjElement(item, 'name', true);
-        if (curItem) writeXObjParam(curItem, name);
+        let curItem = insertXObjElement(item, 'value', { force: true });
+        if (
+          curItem
+          && writeXObjParam(curItem, index)
+          && (curItem = insertXObjElement(item, 'name', { force: true }))
+        ) {
+          writeXObjParam(curItem, name);
+        };
       };
     };
   }
@@ -432,8 +452,15 @@ class TXepgDTSProvider {
   }
 
   set curDocTZ(value){
-    let item = insertXObjElement(this.#_content, XEPG_DOCTZ_ETAG_NAME, true);
-    if (item) writeXObjParam(item, convValueToTZString(value));
+    let _value = convValueToTZString(value);
+    if (_value !== '') {
+      let item = insertXObjElement(
+        this.#_content,
+        XEPG_DOCTZ_ETAG_NAME,
+        { force: true },
+      );
+      if (item) writeXObjParam(item, _value);
+    };
   }
 
 };
@@ -516,9 +543,12 @@ class TXEpgHeaderContainer {
   }
 
   setDocumentDT(){
-    let dt_val = Date.now();
-    let dt_str = convDTValueToString(dt_val, this.dtstype, this.curDocTZ);
-    let item = insertXObjElement(this.#_content, XEPG_DOCDTO_ETAG_NAME, true);
+    let dt_str = convDTValueToString(Date.now(), this.dtstype, this.curDocTZ);
+    let item = insertXObjElement(
+      this.#_content,
+      XEPG_DOCDTO_ETAG_NAME,
+      { force: true },
+    );
     if (item) writeXObjParam(item, dt_str);
   }
 
@@ -534,7 +564,11 @@ class TXEpgHeaderContainer {
   setDocumentEDT(value){
     // TODO: check if value is a DateTime-string
     let dt_str = convDTValueToString(value, this.dtstype, this.curDocTZ);
-    let item = insertXObjElement(this.#_content, XEPG_DOCDTE_ETAG_NAME, true);
+    let item = insertXObjElement(
+      this.#_content,
+      XEPG_DOCDTE_ETAG_NAME,
+      { force: true },
+    );
     if (item) writeXObjParam(item, dt_str);
   }
 
@@ -583,13 +617,13 @@ class TXEpgHeaderContainer {
     };
     let item = null;
     const _content = this.#_content;
-    item = insertXObjElement(_content, XEPG_CHNID_ETAG_NAME, true);
+    item = insertXObjElement(_content, XEPG_CHNID_ETAG_NAME, { force: true });
     if (item) writeXObjParam(item, chnid);
-    item = insertXObjElement(_content, XEPG_CHNNAME_ETAG_NAME, true);
+    item = insertXObjElement(_content, XEPG_CHNNAME_ETAG_NAME, { force: true });
     if (item) writeXObjParam(item, chname);
-    item = insertXObjElement(_content, XEPG_CHNGID_ETAG_NAME, true);
+    item = insertXObjElement(_content, XEPG_CHNGID_ETAG_NAME, { force: true });
     if (item) writeXObjParam(item, chngid);
-    item = insertXObjElement(_content, XEPG_CHNURL_ETAG_NAME, true);
+    item = insertXObjElement(_content, XEPG_CHNURL_ETAG_NAME, { force: true });
     if (item) writeXObjParam(item, srcurl);
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/xepg-lib-js",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "A library for handling an EPG-sources based on an XEPG-format",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -15,24 +15,33 @@
     "doc/xepgdoc-example.xepg",
     "lib/xepgdoc-lib.js",
     "lib/dts-helper.js",
-    "index.js"
+    "index.js",
+    "CHANGELOG.md"
   ],
   "scripts": {
-    "test": "jest",
-    "test-xepg": "jest ./test",
+    "test": "cross-env TZ='Etc/UTC' jest",
+    "test-xepg": "TZ='Etc/UTC' jest ./test",
     "test-xepg:sl": "jest TXEpgSchedulesList",
-    "test-xepg:hc": "jest TXEpgHeader",
+    "test-xepg:hc": "TZ='Etc/UTC' jest TXEpgHeader",
     "test-xepg:pc": "jest TXEpgProvider",
     "test-xepg:dts": "jest TXEpgDTS",
-    "test-xepg:cp": "jest TXEpgContentProvider"
+    "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"
+  },
+  "imports": {
+    "#lib/*": "./lib/*"
   },
   "dependencies": {
-    "@ygracs/bsfoc-lib-js": "^0.1.2",
-    "@ygracs/dtf-lib-js": "^0.0.20",
+    "@ygracs/bsfoc-lib-js": "^0.1.3",
+    "@ygracs/dtf-lib-js": "^0.0.22",
     "@ygracs/xml-js6": "^0.0.3-b",
-    "@ygracs/xobj-lib-js": "^0.0.13"
+    "@ygracs/xobj-lib-js": "^0.0.14-rc4"
   },
   "devDependencies": {
-    "jest": "^29.3.1"
+    "cross-env": "^7.0.3",
+    "jest": "^29.6.1",
+    "minimist": "^1.2.8"
   }
 }