@ygracs/xepg-lib-js 0.0.20 → 0.0.22

package/doc/xepgdoc-spec-draft.dtd

@@ -0,0 +1,65 @@
+<!-- DTD for TV-listings
+     ======================
+     * [rev.0.2.002-20241016]
+     * [schema 0.2]         -->
+
+<!ELEMENT epgdoc (tvp:info, tvp:list)>
+<!ATTLIST epgdoc xmlns:tvp CDATA #REQUIRED >
+
+<!ELEMENT tvp:info (tvp:provider,
+                    (tvp:channel?|(tvp:chnid, tvp:chngid?, tvp:chname)),
+                    tvp:srcurl?,
+                    tvp:time?, tvp:expire?, tvp:timezone, tvp:dtstype)>
+
+<!ELEMENT tvp:provider (name, version?, tvp:schema, tvp:doctype)>
+
+<!ELEMENT name (#PCDATA)>
+<!ATTLIST name lang CDATA #IMPLIED >
+
+<!ELEMENT version (#PCDATA)>
+
+<!ELEMENT tvp:schema (#PCDATA)>
+
+<!ELEMENT tvp:doctype (#PCDATA)>
+
+<!-- NOTE: tag <tvp:channel> reserved for schema 0.3+ -->
+<!ELEMENT tvp:channel (tvp:chnid, tvp:chngid?, tvp:chname*)>
+
+<!ELEMENT tvp:chnid (#PCDATA)>
+
+<!ELEMENT tvp:chngid (#PCDATA)>
+
+<!ELEMENT tvp:chname (#PCDATA)>
+<!ATTLIST tvp:chname lang CDATA #IMPLIED >
+
+<!ELEMENT tvp:srcurl (#PCDATA)>
+
+<!ELEMENT tvp:time (#PCDATA)>
+
+<!ELEMENT tvp:expire (#PCDATA)>
+
+<!ELEMENT tvp:timezone (#PCDATA)>
+
+<!ELEMENT tvp:dtstype (value, name)>
+
+<!ELEMENT value (#PCDATA)>
+
+<!ELEMENT tvp:list ((tvp:item|tvp:schedule)*)>
+
+<!ELEMENT tvp:item (tvp:time, tvp:title+, tvp:pcmark?, tvp:cat*, tvp:desc*)>
+
+<!ELEMENT tvp:title (#PCDATA)>
+<!ATTLIST tvp:chname lang CDATA #IMPLIED >
+
+<!ELEMENT tvp:pcmark (#PCDATA)>
+
+<!ELEMENT tvp:cat (#PCDATA)>
+<!ATTLIST tvp:cat lang CDATA #IMPLIED >
+
+<!ELEMENT tvp:desc (#PCDATA)>
+<!ATTLIST tvp:desc lang CDATA #IMPLIED >
+
+<!-- NOTE: tag <tvp:channel> reserved for schema 0.3+ -->
+<!ELEMENT tvp:schedule (tvp:title+, tvp:pcmark?, tvp:cat*, tvp:desc*)>
+<!ATTLIST tvp:schedule start CDATA #REQUIRED
+                       stop CDATA #IMPLIED >

package/index.js

@@ -1,8 +1,8 @@
-// [v0.0.008-20230326]
+// [v0.0.010-20250228]
 
 // === module init block ===
 
-const xepg_doc = require('./lib/xepgdoc-lib.js');
+const xepgdoc = require('./lib/xepgdoc-lib.js');
 
 const xObj = require('@ygracs/xobj-lib-js');
 
@@ -13,11 +13,15 @@ const xObj = require('@ygracs/xobj-lib-js');
 // === module exports block ===
 
 /**/// v1 branch
-exports.TXEpgContentProvider = xepg_doc.TXEpgContentProvider;
-exports.TXEpgSchedulesList = xepg_doc.TXEpgSchedulesList;
-exports.TXepgDTSProvider = xepg_doc.TXepgDTSProvider;
-exports.TXEpgProviderContainer = xepg_doc.TXEpgProviderContainer;
-exports.TXEpgHeaderContainer = xepg_doc.TXEpgHeaderContainer;
+module.exports.TXEpgContentProvider = xepgdoc.TXEpgContentProvider;
+module.exports.TXEpgScheduleItem = xepgdoc.TXEpgScheduleItem;
+module.exports.TXEpgSchedulesList = xepgdoc.TXEpgSchedulesList;
+module.exports.TXEpgDTSProvider = xepgdoc.TXEpgDTSProvider;
+module.exports.TXEpgProviderContainer = xepgdoc.TXEpgProviderContainer;
+module.exports.TXEpgHeaderContainer = xepgdoc.TXEpgHeaderContainer;
 
 // re-export stuff from `@ygracs/xobj-lib-js` module
-exports.TXmlContentParseOptions = xObj.TXmlContentParseOptions;
+module.exports.TXmlContentParseOptions = xObj.TXmlContentParseOptions;
+
+/**/// will deprecate
+module.exports.TXepgDTSProvider = xepgdoc.TXepgDTSProvider;

package/lib/dts-helper.js

@@ -1,10 +1,9 @@
-// [v0.1.045-20240829]
+// [v0.1.047-20250225]
 
 // === module init block ===
 
 const {
-  valueToIndex, readAsString, readAsNumberEx,
-  isDateObject,
+  valueToIndex,
 } = require('@ygracs/bsfoc-lib-js');
 
 const {
@@ -32,22 +31,22 @@ const def_dts_param = [
 
 /**
  * @function chkDTSysID
- * @param {(number|string)} value
+ * @param {(number|string)} value - value to verify
  * @returns {boolean}
  * @description Checs if a given value is a valid dtstype ID
  */
-function chkDTSysID(value){
+function chkDTSysID(value) {
   const _value = valueToIndex(value);
   return _value !== -1 && def_dts_param[_value] ? true : false;
 };
 
 /**
  * @function getDTSysName
- * @param {(number|string)} value
+ * @param {(number|string)} value - DTS-type identifier
  * @returns {string}
  * @description Returns a dtstype name by a given dtstype ID
  */
-function getDTSysName(value){
+function getDTSysName(value) {
   let result = 'undefined';
   if (chkDTSysID(value)) {
     result = def_dts_param[Number(value)];
@@ -56,19 +55,19 @@ function getDTSysName(value){
 };
 
 /**
- * @typedef DTSysDescr
- * @type {object}
+ * @typedef {Object} DTSysDescr
  * @property {number} index - dtstype ID
  * @property {string} name - dtstype name
+ * @description A DTS-type descriptor
  */
 
 /**
  * @function getDTSysDescr
- * @param {(number|string)} value
+ * @param {(number|string)} value - DTS-type identifier
  * @returns {DTSysDescr}
  * @description Returns a dtstype description for a given dtstype ID
  */
-function getDTSysDescr(value){
+function getDTSysDescr(value) {
   let index = valueToIndex(value);
   let name = 'undefined';
   if (index !== -1) {
@@ -86,13 +85,14 @@ function getDTSysDescr(value){
 
 /**
  * @function convStringToDTValue
- * @param {string} value
- * @param {(number|string)} [dts_id=0]
- * @param {(number|string)} [tz]
+ * @param {string} value - some value
+ * @param {(number|string)} [dts_id=0] - DTS-type identifier
+ * @param {(number|string)} [tz] - <*reserved*>
  * @returns {number}
  * @description Tries to convert a given string to timestamp
+ * @todo check TZ
  */
-function convStringToDTValue(value, dts_id = 0, tz){
+function convStringToDTValue(value, dts_id = 0, tz) {
   const dtstype = getDTSysName(dts_id);
   let result = 0;
   if (dtstype !== 'undefined') {
@@ -151,20 +151,17 @@ function convStringToDTValue(value, dts_id = 0, tz){
 
 /**
  * @function convDTValueToString
- * @param {(number|string|Date)} value
- * @param {(number|string)} dts_id
- * @param {(number|string)} tz
+ * @param {(number|string|Date)} value - some value
+ * @param {(number|string)} [dts_id=0] - DTS-type identifier
+ * @param {(number|string)} [tz] - <*reserved*>
  * @returns {string}
  * @description Tries to convert a given value to its string representation
+ * @todo check TZ
  */
-function convDTValueToString(value, dts_id, tz){
+function convDTValueToString(value, dts_id, tz) {
+  let { isSucceed, value: dtValue } = tryDTValue(value);
+  let dt_val = isSucceed ? dtValue.getTime() : new Date(0);
   let result = '';
-  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)) {
@@ -208,9 +205,7 @@ function convDTValueToString(value, dts_id, tz){
       //console.log('convDTValueToString => result:['+result+']');
       break;
     }
-    default: {
-      break;
-    }
+    default: {}
   };
   return result;
 };