@ygracs/xepg-lib-js 0.0.26-b → 0.0.30

package/lib/xepg-channel.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @deprecated
+ */
+export type setInfoParam = string;
+export const setInfoParam: setInfoParam;
+/**
+ * A channel info descriptor
+ */
+export type IXEpgChnInfoDesc = {
+    /**
+     * - channel ID
+     */
+    chnid: string;
+    /**
+     * - channel name
+     */
+    chname: string;
+    /**
+     * - channel 'Group ID'
+     */
+    chngid?: string;
+    /**
+     * - EPG-source URL
+     */
+    srcurl?: string;
+};
+export const IXEpgChnInfoDesc: IXEpgChnInfoDesc;
+/**
+ * An XEPG-element options set (base)
+ */
+export type OPT_epgelsett_bs = {
+    /**
+     * - parser options
+     */
+    parseOptions?: InstanceType<typeof TXmlContentParseOptions>;
+};
+/**
+ * An XEPG-element options set (base)
+ */
+export type XEpgElementConfigBase = {
+    /**
+     * - parser options
+     */
+    parseOptions: InstanceType<typeof TXmlContentParseOptions>;
+};
+
+/**
+ * This class implements an interface of a channel element
+ * @since 0.0.22
+ */
+export class TXEpgChannelContainer {
+    /**
+     * Creates an instance of the channel element
+     */
+    constructor(obj: INode, opt?: OPT_epgelsett_bs);
+    /**
+     * Contains a channel ID
+     */
+    get id(): string;
+    /**
+     * Contains a channel name
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Contains a channel Group ID
+     */
+    get gid(): string;
+    set gid(value: string);
+    /**
+     * Contains a channel source URL
+     */
+    get url(): string;
+    set url(value: string);
+    /**
+     * Tries to set a channel ID
+     */
+    setID(value: string): boolean;
+    /**
+     * Returns a channel info
+     */
+    getInfo(): IXEpgChnInfoDesc;
+    /**
+     * Sets a channel info
+     */
+    setInfo(obj: setInfoParam | IXEpgChnInfoDesc): void;
+    #private;
+}
+
+import { TXmlContentParseOptions } from "@ygracs/xobj-lib-js";
+import type { INode } from "@ygracs/xobj-lib-js";

package/lib/xepg-channel.js

@@ -0,0 +1,308 @@
+// [v0.3.152-20260612]
+
+// === module init block ===
+
+const {
+  isObject, isPlainObject,
+} = require('@ygracs/bsfoc-lib-js');
+
+const xObj = require('@ygracs/xobj-lib-js');
+const {
+  insertXObjElement,
+  writeXObjParam,
+  //TXmlContentParseOptions,
+  //DEF_XML_PARSE_OPTIONS: XML_DEF_PARSE_OPTIONS,
+} = xObj;
+// keep the next line for a type checking work properly :(
+const { TXmlContentParseOptions } = require('@ygracs/xobj-lib-js/lib/xObj-defs');
+// keep the next line for a type checking work properly :(
+const { INode } = require('@ygracs/xobj-lib-js/lib/xObj-lib');
+
+const {
+  //readAsTagName,
+  //readAsAttrName,
+  //valueToElementID,
+  _getXmlChildElementParam,
+} = require('./xml-base');
+
+const {
+  XEPG_CONSTANTS, XEPG_DEF_TNAMES,
+  defParseOptionsSettings,
+} = require('./xepg-defs');
+
+// === module inner block ===
+
+const {
+  XEPG_DEF_DOCUMENT_SCHEMA,
+} = XEPG_CONSTANTS;
+
+const {
+  XEPG_CHNID_ETAG_NAME,
+  XEPG_CHNNAME_ETAG_NAME,
+  XEPG_CHNGID_ETAG_NAME,
+  XEPG_CHNURL_ETAG_NAME,
+} = XEPG_DEF_TNAMES;
+
+/**
+ * An XEPG-element options set (base)
+ * @typedef {Object} OPT_epgelsett_bs
+ * @property {TXmlContentParseOptions} [parseOptions] - parser options
+ */
+
+/**
+ * An XEPG-element options set (base)
+ * @typedef {Object} XEpgElementConfigBase
+ * @property {TXmlContentParseOptions} parseOptions - parser options
+ */
+
+/**
+ * Evaluates an XML-node base settings
+ * @function __evalXMLBaseNodeSettings
+ * @param {any} value - element settings to evaluate
+ * @returns {XEpgElementConfigBase}
+ * @inner
+ */
+function __evalXMLBaseNodeSettings(value) {
+  /** @type {OPT_epgelsett_bs} */
+  let settings = isPlainObject(value) ? value : {};
+  if (settings instanceof Map) settings = Object.fromEntries(settings);
+  let {
+    parseOptions,
+  } = settings;
+  if (!(parseOptions instanceof TXmlContentParseOptions)) {
+    settings.parseOptions = new TXmlContentParseOptions(parseOptions);
+  };
+  // @ts-expect-error
+  return settings;
+};
+
+// === module main block ===
+
+/**
+ * @typedef {string} setInfoParam
+ * @deprecated
+ * @todo \[since v0.0.30] deprecated and will be removed
+ */
+/**
+ * A virtual constant meant for support jsdoc notation:
+ * @type {setInfoParam}
+ */
+module.exports.setInfoParam = '';
+
+/**
+ * A channel info descriptor
+ * @typedef {Object} IXEpgChnInfoDesc
+ * @property {string} chnid - channel ID
+ * @property {string} chname - channel name
+ * @property {string} [chngid] - channel 'Group ID'
+ * @property {string} [srcurl] - EPG-source URL
+ */
+/**
+ * A virtual constant meant for support jsdoc notation:
+ * @type {IXEpgChnInfoDesc}
+ */
+module.exports.IXEpgChnInfoDesc = { chnid: '', chname: '' };
+
+
+/**
+ * @since 0.0.22
+ * @classdesc This class implements an interface of a channel element
+ */
+class TXEpgChannelContainer {
+  /** @type {INode} */
+  #_host;
+  /** @type {OPT_epgelsett_bs} */
+  #_options;
+  /** @type {TXmlContentParseOptions} */
+  #_parseOptions;
+  /** @type {string} */
+  #_xepgSchema;
+
+  /**
+   * Creates an instance of the channel element
+   * @param {INode} obj - host object
+   * @param {OPT_epgelsett_bs} [opt] - options
+   */
+  constructor(obj, opt) {
+    // load content
+    const _host = isPlainObject(obj) ? obj : {};
+    // load options
+    const _options = __evalXMLBaseNodeSettings(opt);
+    let {
+      parseOptions,
+    } = _options;
+    // set document schema version
+    this.#_xepgSchema = XEPG_DEF_DOCUMENT_SCHEMA;
+    // save options
+    this.#_options = _options;
+    // save parser options
+    this.#_parseOptions = parseOptions;
+    // save content source
+    this.#_host = _host;
+  }
+
+  /**
+   * Contains a channel ID
+   * @type {string}
+   * @readonly
+   */
+  get id() {
+    return _getXmlChildElementParam(this.#_host, XEPG_CHNID_ETAG_NAME).trim();
+  }
+
+  /**
+   * Contains a channel name
+   * @type {string}
+   */
+  get name() {
+    return _getXmlChildElementParam(this.#_host, XEPG_CHNNAME_ETAG_NAME).trim();
+  }
+
+  set name(value) {
+    if (typeof value === 'string' && this.id !== '') {
+      const item = insertXObjElement(
+        this.#_host,
+        XEPG_CHNNAME_ETAG_NAME,
+        { force: true },
+      );
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptionsSettings.textKey);
+      };
+    };
+  }
+
+  /**
+   * Contains a channel Group ID
+   * @type {string}
+   */
+  get gid() {
+    return _getXmlChildElementParam(this.#_host, XEPG_CHNGID_ETAG_NAME).trim();
+  }
+
+  set gid(value) {
+    if (typeof value === 'string' && this.id !== '') {
+      const item = insertXObjElement(
+        this.#_host,
+        XEPG_CHNGID_ETAG_NAME,
+        { force: true },
+      );
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptionsSettings.textKey);
+      };
+    };
+  }
+
+  /**
+   * Contains a channel source URL
+   * @type {string}
+   */
+  get url() {
+    return _getXmlChildElementParam(this.#_host, XEPG_CHNURL_ETAG_NAME).trim();
+  }
+
+  set url(value) {
+    if (typeof value === 'string' && this.id !== '') {
+      const item = insertXObjElement(
+        this.#_host,
+        XEPG_CHNURL_ETAG_NAME,
+        { force: true },
+      );
+      if (item) {
+        writeXObjParam(item, value.trim(), defParseOptionsSettings.textKey);
+      };
+    };
+  }
+
+  /**
+   * Tries to set a channel ID
+   * @param {string} value - channel ID
+   * @returns {boolean}
+   */
+  setID(value) {
+    let isSucceed = false;
+    if (typeof value === 'string') {
+      const chnid = value.trim();
+      const item = insertXObjElement(
+        this.#_host,
+        XEPG_CHNID_ETAG_NAME,
+        { force: true },
+      );
+      if (item) {
+        isSucceed = writeXObjParam(item, chnid, defParseOptionsSettings.textKey);
+      };
+    };
+    return isSucceed;
+  }
+
+  /**
+   * Returns a channel info
+   * @returns {IXEpgChnInfoDesc}
+   */
+  getInfo() {
+    const {
+      id: chnid,
+      name: chname,
+      gid: chngid,
+      url: srcurl,
+    } = this;
+    /** @type {IXEpgChnInfoDesc} */
+    return {
+      chnid,
+      chname,
+      chngid,
+      srcurl,
+    };
+  }
+
+  /**
+   * Sets a channel info
+   * @param {setInfoParam|IXEpgChnInfoDesc} obj - channel info descriptor
+   * @returns {void}
+   * @todo [since v0.0.30] deprecate use of `obj`-param as string
+   */
+  setInfo(obj) {
+    let chnid = '';
+    let chname = '';
+    let chngid = '';
+    let srcurl = '';
+    if (isObject(obj)) {
+      ({ chnid } = obj);
+      if (typeof chnid === 'string') {
+        ({ chname, chngid, srcurl } = obj);
+      } else {
+        // // TODO: [?] deprecate
+        chnid = _getXmlChildElementParam(obj, XEPG_CHNID_ETAG_NAME).trim();
+        chname = _getXmlChildElementParam(obj, XEPG_CHNNAME_ETAG_NAME).trim();
+        chngid = _getXmlChildElementParam(obj, XEPG_CHNGID_ETAG_NAME).trim();
+        srcurl = _getXmlChildElementParam(obj, XEPG_CHNURL_ETAG_NAME).trim();
+      };
+    } else if (typeof obj === 'string') {
+      chnid = obj;
+    } else {
+      return;
+    };
+    chnid = typeof chnid === 'string' ? chnid.trim() : '';
+    if (chnid === '') {
+      chname = '';
+      chngid = '';
+      srcurl = '';
+    } else {
+      chname = typeof chname === 'string' ? chname.trim() : '';
+      chngid = typeof chngid === 'string' ? chngid.trim() : '';
+      srcurl = typeof srcurl === 'string' ? srcurl.trim() : '';
+    };
+    let item = null;
+    const _host = this.#_host;
+    const text_key = defParseOptionsSettings.textKey;
+    item = insertXObjElement(_host, XEPG_CHNID_ETAG_NAME, { force: true });
+    if (item) writeXObjParam(item, chnid, text_key);
+    item = insertXObjElement(_host, XEPG_CHNNAME_ETAG_NAME, { force: true });
+    if (item) writeXObjParam(item, chname, text_key);
+    item = insertXObjElement(_host, XEPG_CHNGID_ETAG_NAME, { force: true });
+    if (item) writeXObjParam(item, chngid, text_key);
+    item = insertXObjElement(_host, XEPG_CHNURL_ETAG_NAME, { force: true });
+    if (item) writeXObjParam(item, srcurl, text_key);
+  }
+
+}
+module.exports.TXEpgChannelContainer = TXEpgChannelContainer;

package/lib/xepg-defs.d.ts

@@ -0,0 +1,67 @@
+export namespace XEPG_CONSTANTS {
+    export { ALLOWED_XEPG_DOCUMENT_SCHEMA };
+    export { XEPG_DEF_NS_NAME };
+    export { XEPG_DEF_NS_PATH };
+    export { XEPG_XML_DOC_VERSION };
+    export { XEPG_DEF_ENCODING_VALUE };
+    export { XEPG_DEF_DOCUMENT_TYPE };
+    export { XEPG_DEF_DOCUMENT_SCHEMA };
+    export { XEPG_DEF_PROVIDER_NAME };
+    export { XEPG_DEF_PROVIDER_VER };
+}
+export namespace XEPG_DEF_TNAMES {
+    export { XEPG_ROOT_ETAG_NAME };
+    export { XEPG_HEADER_ETAG_NAME };
+    export { XEPG_BODY_ETAG_NAME };
+    export { XEPG_SCHED_ETAG_NAME };
+    export { XEPG_PRVINFO_ETAG_NAME };
+    export { XEPG_DTSINFO_ETAG_NAME };
+    export { XEPG_DOCDTO_ETAG_NAME };
+    export { XEPG_DOCDTE_ETAG_NAME };
+    export { XEPG_DOCTZ_ETAG_NAME };
+    export { XEPG_DOCSCH_ETAG_NAME };
+    export { XEPG_DOCTYP_ETAG_NAME };
+    export { XEPG_CHNID_ETAG_NAME };
+    export { XEPG_CHNNAME_ETAG_NAME };
+    export { XEPG_CHNGID_ETAG_NAME };
+    export { XEPG_CHNURL_ETAG_NAME };
+    export { XEPG_SCHEDTIME_ETAG_NAME };
+    export { XEPG_SCHEDTITL_ETAG_NAME };
+    export { XEPG_SCHEDCAT_ETAG_NAME };
+    export { XEPG_SCHEDPMARK_ETAG_NAME };
+    export { XEPG_SCHEDDESC_ETAG_NAME };
+}
+export const defParseOptionsSettings: import("@ygracs/xobj-lib-js").OPT_parserOptions;
+/**
+ * A list of a document schema version supported by a library
+ */
+declare const ALLOWED_XEPG_DOCUMENT_SCHEMA: string[];
+declare const XEPG_DEF_NS_NAME: "tvp";
+declare const XEPG_DEF_NS_PATH: "urn:e-doc:epg-doc:xepg";
+declare const XEPG_XML_DOC_VERSION: "1.0";
+declare const XEPG_DEF_ENCODING_VALUE: "UTF-8";
+declare const XEPG_DEF_DOCUMENT_TYPE: "xepg";
+declare const XEPG_DEF_DOCUMENT_SCHEMA: string;
+declare const XEPG_DEF_PROVIDER_NAME: "xepg-lib-js";
+declare const XEPG_DEF_PROVIDER_VER: "0.0.30";
+declare const XEPG_ROOT_ETAG_NAME: "epgdoc";
+declare const XEPG_HEADER_ETAG_NAME: "tvp:info";
+declare const XEPG_BODY_ETAG_NAME: "tvp:list";
+declare const XEPG_SCHED_ETAG_NAME: "tvp:item";
+declare const XEPG_PRVINFO_ETAG_NAME: "tvp:provider";
+declare const XEPG_DTSINFO_ETAG_NAME: "tvp:dtstype";
+declare const XEPG_DOCDTO_ETAG_NAME: "tvp:time";
+declare const XEPG_DOCDTE_ETAG_NAME: "tvp:expire";
+declare const XEPG_DOCTZ_ETAG_NAME: "tvp:timezone";
+declare const XEPG_DOCSCH_ETAG_NAME: "tvp:schema";
+declare const XEPG_DOCTYP_ETAG_NAME: "tvp:doctype";
+declare const XEPG_CHNID_ETAG_NAME: "tvp:chnid";
+declare const XEPG_CHNNAME_ETAG_NAME: "tvp:chname";
+declare const XEPG_CHNGID_ETAG_NAME: "tvp:chngid";
+declare const XEPG_CHNURL_ETAG_NAME: "tvp:srcurl";
+declare const XEPG_SCHEDTIME_ETAG_NAME: "tvp:time";
+declare const XEPG_SCHEDTITL_ETAG_NAME: "tvp:title";
+declare const XEPG_SCHEDCAT_ETAG_NAME: "tvp:cat";
+declare const XEPG_SCHEDPMARK_ETAG_NAME: "tvp:pcmark";
+declare const XEPG_SCHEDDESC_ETAG_NAME: "tvp:desc";
+export {};

package/lib/xepg-defs.js

@@ -0,0 +1,88 @@
+// [v0.3.149-20260612]
+
+const {
+  TXmlContentParseOptions,
+} = require('@ygracs/xobj-lib-js');
+
+// === module init block ===
+
+// === module inner block ===
+
+// === module main block ===
+
+/**
+ * A list of a document schema version supported by a library
+ */
+const ALLOWED_XEPG_DOCUMENT_SCHEMA = [ '0.2' ];
+
+const XEPG_DEF_NS_NAME = 'tvp';
+const XEPG_DEF_NS_PATH = 'urn:e-doc:epg-doc:xepg';
+const XEPG_XML_DOC_VERSION = '1.0';
+const XEPG_DEF_ENCODING_VALUE = 'UTF-8';
+const XEPG_DEF_DOCUMENT_TYPE = 'xepg';
+const XEPG_DEF_DOCUMENT_SCHEMA = ALLOWED_XEPG_DOCUMENT_SCHEMA[0];
+const XEPG_DEF_PROVIDER_NAME = 'xepg-lib-js';
+const XEPG_DEF_PROVIDER_VER = '0.0.30';
+
+const XEPG_CONSTANTS = {
+  ALLOWED_XEPG_DOCUMENT_SCHEMA,
+  XEPG_DEF_NS_NAME,
+  XEPG_DEF_NS_PATH,
+  XEPG_XML_DOC_VERSION,
+  XEPG_DEF_ENCODING_VALUE,
+  XEPG_DEF_DOCUMENT_TYPE,
+  XEPG_DEF_DOCUMENT_SCHEMA,
+  XEPG_DEF_PROVIDER_NAME,
+  XEPG_DEF_PROVIDER_VER,
+};
+module.exports.XEPG_CONSTANTS = XEPG_CONSTANTS;
+
+const XEPG_ROOT_ETAG_NAME = 'epgdoc';
+const XEPG_HEADER_ETAG_NAME = `${XEPG_DEF_NS_NAME}:info`;
+const XEPG_BODY_ETAG_NAME = `${XEPG_DEF_NS_NAME}:list`;
+const XEPG_SCHED_ETAG_NAME = `${XEPG_DEF_NS_NAME}:item`;
+const XEPG_PRVINFO_ETAG_NAME = `${XEPG_DEF_NS_NAME}:provider`;
+const XEPG_DTSINFO_ETAG_NAME = `${XEPG_DEF_NS_NAME}:dtstype`;
+const XEPG_DOCDTO_ETAG_NAME = `${XEPG_DEF_NS_NAME}:time`;
+const XEPG_DOCDTE_ETAG_NAME = `${XEPG_DEF_NS_NAME}:expire`;
+const XEPG_DOCTZ_ETAG_NAME = `${XEPG_DEF_NS_NAME}:timezone`;
+const XEPG_DOCSCH_ETAG_NAME = `${XEPG_DEF_NS_NAME}:schema`;
+const XEPG_DOCTYP_ETAG_NAME = `${XEPG_DEF_NS_NAME}:doctype`;
+const XEPG_CHNID_ETAG_NAME = `${XEPG_DEF_NS_NAME}:chnid`;
+const XEPG_CHNNAME_ETAG_NAME = `${XEPG_DEF_NS_NAME}:chname`;
+const XEPG_CHNGID_ETAG_NAME = `${XEPG_DEF_NS_NAME}:chngid`;
+const XEPG_CHNURL_ETAG_NAME = `${XEPG_DEF_NS_NAME}:srcurl`;
+const XEPG_SCHEDTIME_ETAG_NAME = `${XEPG_DEF_NS_NAME}:time`;
+const XEPG_SCHEDTITL_ETAG_NAME = `${XEPG_DEF_NS_NAME}:title`;
+const XEPG_SCHEDCAT_ETAG_NAME = `${XEPG_DEF_NS_NAME}:cat`;
+const XEPG_SCHEDPMARK_ETAG_NAME = `${XEPG_DEF_NS_NAME}:pcmark`;
+const XEPG_SCHEDDESC_ETAG_NAME = `${XEPG_DEF_NS_NAME}:desc`;
+
+const XEPG_DEF_TNAMES = {
+  XEPG_ROOT_ETAG_NAME,
+  XEPG_HEADER_ETAG_NAME,
+  XEPG_BODY_ETAG_NAME,
+  XEPG_SCHED_ETAG_NAME,
+  XEPG_PRVINFO_ETAG_NAME,
+  XEPG_DTSINFO_ETAG_NAME,
+  XEPG_DOCDTO_ETAG_NAME,
+  XEPG_DOCDTE_ETAG_NAME,
+  XEPG_DOCTZ_ETAG_NAME,
+  XEPG_DOCSCH_ETAG_NAME,
+  XEPG_DOCTYP_ETAG_NAME,
+  XEPG_CHNID_ETAG_NAME,
+  XEPG_CHNNAME_ETAG_NAME,
+  XEPG_CHNGID_ETAG_NAME,
+  XEPG_CHNURL_ETAG_NAME,
+  XEPG_SCHEDTIME_ETAG_NAME,
+  XEPG_SCHEDTITL_ETAG_NAME,
+  XEPG_SCHEDCAT_ETAG_NAME,
+  XEPG_SCHEDPMARK_ETAG_NAME,
+  XEPG_SCHEDDESC_ETAG_NAME,
+};
+module.exports.XEPG_DEF_TNAMES = XEPG_DEF_TNAMES;
+
+const defParseOptions = new TXmlContentParseOptions();
+const defParseOptionsSettings = defParseOptions.settings;
+//console.log('CHECK: defParseOptions => '+JSON.stringify(defParseOptions, null, 2));
+module.exports.defParseOptionsSettings = defParseOptionsSettings;