@ygracs/xepg-lib-js 0.0.27-b → 0.0.31

package/lib/xepgdoc-lib.d.ts

@@ -1,74 +1,13 @@
 /**
- * An XEPG-element options set (base)
- */
-export type OPT_epgelsett_bs = {
-    /**
-     * - parser options
-     */
-    parseOptions?: InstanceType<typeof TXmlContentParseOptions>;
-};
-/**
- * An XEPG-element options set (base)
+ * A list of fields in order: `name`, `version`, `schema`, `doctype`
+ * @deprecated
  */
-export type XEpgElementConfigBase = {
-    /**
-     * - parser options
-     */
-    parseOptions: InstanceType<typeof TXmlContentParseOptions>;
-};
-/**
- * A schedule info descriptor
- */
-export type xepgShedInfoDesc = {
-    /**
-     * - a schedule start time
-     */
-    time: number;
-    /**
-     * - schedule title
-     */
-    title: string;
-    /**
-     * - schedule category
-     */
-    cat?: string;
-    /**
-     * - schedule rating
-     */
-    pcmark?: number;
-    /**
-     * - schedule description
-     */
-    descr?: string;
-};
-/**
- * An extra options set
- */
-export type OPT_extra = {
-    /**
-     * - 'DTS'-settings
-     */
-    dts_src?: object;
-    /**
-     * - 'TZ'-settings
-     */
-    tz_src?: object;
-};
-/**
- * An XEPG-element options set (extend)
- */
-export type OPT_epgelsett_ex = {
-    /**
-     * - parser options
-     */
-    parseOptions?: InstanceType<typeof TXmlContentParseOptions>;
-    dts_src?: object;
-    tz_src?: object;
-};
+export type arrProviderInfo = [ name: string, version: string, schema: string, doctype: string ];
+export const arrProviderInfo: arrProviderInfo;
 /**
  * A provider info descriptor
  */
-export type xepgProvInfoDesc = {
+export type IXEpgProvInfoDesc = {
     /**
      * - provider name
      */
@@ -86,26 +25,24 @@ export type xepgProvInfoDesc = {
      */
     doctype: string;
 };
+export const IXEpgProvInfoDesc: IXEpgProvInfoDesc;
 /**
- * A channel info descriptor
+ * An XEPG-element options set (base)
  */
-export type xepgChnInfoDesc = {
-    /**
-     * - channel ID
-     */
-    chnid: string;
-    /**
-     * - channel name
-     */
-    chname: string;
+export type OPT_epgelsett_bs = {
     /**
-     * - channel 'Group ID'
+     * - parser options
      */
-    chngid?: string;
+    parseOptions?: InstanceType<typeof TXmlContentParseOptions>;
+};
+/**
+ * An XEPG-element options set (base)
+ */
+export type XEpgElementConfigBase = {
     /**
-     * - EPG-source URL
+     * - parser options
      */
-    srcurl?: string;
+    parseOptions: InstanceType<typeof TXmlContentParseOptions>;
 };
 
 /**
@@ -135,215 +72,6 @@ export type XEpgContainerConfig = {
     autoBindRoot?: boolean | undefined;
 };
 
-/**
- * This class implements an instance of an element
- * that manages content of a document declaration
- * @since v0.0.2x
- */
-export class TXmlContentDeclaration {
-    /**
-     * Creates an instance of the element
-     * @throws {TypeError}
-     */
-    constructor(obj: object, opt?: OPT_epgelsett_bs);
-    /**
-     * Contains a version of an XML
-     */
-    get version(): string;
-    set version(value: string);
-    /**
-     * Contains a document character set
-     */
-    get encoding(): string;
-    set encoding(value: string);
-    /**
-     * Initializes an instance content.
-     */
-    init(): void;
-    #private;
-}
-export const XEPG_DEF_PROVIDER_NAME: "xepg-lib-js";
-export const XEPG_DEF_PROVIDER_VER: "0.0.21";
-export const XEPG_DEF_DOCUMENT_TYPE: "xepg";
-export const XEPG_DEF_DOCUMENT_SCHEMA: string;
-/**
- * This class implements an interface of a DTS-provider element
- */
-export class TXEpgDTSProvider {
-    /**
-     * Creates an instance of the DTS-provider element
-     */
-    constructor(obj: object, opt?: OPT_epgelsett_bs);
-    /**
-     * Contains a dtstype ID
-     */
-    get dtstype(): number;
-    set dtstype(value: number);
-    /**
-     * Contains a TZ-offset
-     */
-    get curDocTZ(): number;
-    set curDocTZ(value: number);
-    /**
-     * Tries to set a `DTS`-type
-     * @since 0.0.22
-     */
-    setType(value: any): boolean;
-    #private;
-}
-
-/**
- * This class implements an interface of a EPG-schedule element
- * @since 0.0.22
- */
-export class TXEpgScheduleItem {
-    /**
-     * Creates an instance of the EPG-schedule element
-     */
-    constructor(obj: object, opt?: OPT_epgelsett_ex, extra?: OPT_extra);
-    /**
-     * Contains a dtstype ID
-     */
-    get dtstype(): number;
-    /**
-     * Contains a TZ-offset
-     */
-    get curDocTZ(): number;
-    /**
-     * Contains a schedule start time as a timestamp
-     */
-    get time(): number;
-    /**
-     * Contains a schedule title
-     */
-    get title(): string;
-    /**
-     * Contains a schedule category
-     */
-    get category(): string;
-    /**
-     * Contains a schedule rating value (aka pcmark)
-     */
-    get rating(): number;
-    /**
-     * Contains a schedule description
-     */
-    get descr(): string;
-    /**
-     * Returns a schedule info item descriptor
-     */
-    getInfo(): xepgShedInfoDesc;
-    /**
-     * Sets a schedule start time.
-     */
-    setTime(value: number | string | Date): boolean;
-    /**
-     * Sets a schedule title.
-     */
-    setTitle(value: string): boolean;
-    /**
-     * Sets a schedule title.
-     */
-    setCategory(value: string): boolean;
-    /**
-     * Sets a schedule rating value.
-     */
-    setRating(value: number | string): boolean;
-    /**
-     * Sets a schedule description.
-     */
-    setDescr(value: string): boolean;
-    /**
-     * Returns an instance content as a string in an XML-format.
-     */
-    saveToXMLString(): string;
-    /**
-     * Loads an element content from a string.
-     * @since v0.0.24
-     * @throws {Error}
-     * @experimental
-     */
-    loadFromXMLString(xmlString: string): boolean;
-    #private;
-}
-
-/**
- * This class implements an interface of a EPG-schedules list
- */
-export class TXEpgSchedulesList {
-    /**
-     * Creates an instance of the schedules list
-     */
-    constructor(obj: any[], opt?: OPT_epgelsett_ex, extra?: OPT_extra);
-    /**
-     * Contains a quantity of a schedules
-     * @deprecated
-     * @todo \[since `v0.0.24`] deprecated. Use `TXEpgSchedulesList.count`
-     */
-    get schedQty(): number;
-    /**
-     * Contains a quantity of a schedules
-     * @since v0.0.24
-     */
-    get count(): number;
-    /**
-     * Contains a dtstype ID
-     */
-    get dtstype(): number;
-    /**
-     * Contains a TZ-offset
-     */
-    get curDocTZ(): number;
-    /**
-     * Indicates whether an instance has none member
-     * @since v0.0.24
-     */
-    isEmpty(): boolean;
-    /**
-     * Indicates whether an instance has any member
-     * @since v0.0.24
-     */
-    isNotEmpty(): boolean;
-    /**
-     * Checks whether a given value is a valid index and it fits the index range
-     * of an instance
-     * @since 0.0.20
-     */
-    chkIndex(value: number | string): boolean;
-    /**
-     * Returns a schedule element addressed by a given index
-     * @since 0.0.22
-     */
-    schedule(index: number | string): TXEpgScheduleItem | null;
-    /**
-     * Returns a schedule info item for instance element addressed
-     * by a given index
-     */
-    getScheduleInfo(index: number | string): xepgShedInfoDesc | null;
-    /**
-     * Returns a schedule info for instance members
-     */
-    getAllSchedulesInfo(): xepgShedInfoDesc[];
-    /**
-     * @protected
-     */
-    protected asJSON(): string;
-    [Symbol.iterator](): {
-        next: () => {
-            done: boolean;
-            value: TXEpgScheduleItem | null;
-        } | {
-            done: boolean;
-            value: undefined;
-        };
-        return(): {
-            done: boolean;
-            value: undefined;
-        };
-    };
-    #private;
-}
-
 /**
  * This class implements an interface of a EPG-provider element
  */
@@ -351,7 +79,7 @@ export class TXEpgProviderContainer {
     /**
      * Creates an instance of the EPG-provider element
      */
-    constructor(obj: object, opt?: OPT_epgelsett_bs);
+    constructor(obj: INode, opt?: OPT_epgelsett_bs);
     /**
      * Contains a provider name
      */
@@ -379,16 +107,16 @@ export class TXEpgProviderContainer {
     /**
      * Returns a provider info item
      */
-    getInfo(): xepgProvInfoDesc;
+    getInfo(): IXEpgProvInfoDesc;
     /**
      * Sets a provider info
      * @todo [since v0.0.21] deprecate use of `obj`-param as array
      */
-    setInfo(obj: string[] | xepgProvInfoDesc): void;
+    setInfo(obj: arrProviderInfo | IXEpgProvInfoDesc): void;
     /**
      * Sets an initial instance state
      */
-    init(opt?: xepgProvInfoDesc | string[]): void;
+    init(data?: arrProviderInfo | IXEpgProvInfoDesc): void;
     /**
      * Returns an instance content as a string in an XML-format.
      * @since v0.0.20
@@ -404,49 +132,6 @@ export class TXEpgProviderContainer {
     #private;
 }
 
-/**
- * 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: object, 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(): xepgChnInfoDesc;
-    /**
-     * Sets a channel info
-     */
-    setInfo(obj: string | xepgChnInfoDesc): void;
-    #private;
-}
-
 /**
  * This class implements an interface of a EPG-header element
  */
@@ -454,7 +139,7 @@ export class TXEpgHeaderContainer {
     /**
      * Creates an instance of the EPG-header element
      */
-    constructor(obj: object, opt?: OPT_epgelsett_bs);
+    constructor(obj: INode, opt?: OPT_epgelsett_bs);
     /**
      * Returns a `TXEpgDTSProvider` instance
      */
@@ -500,11 +185,11 @@ export class TXEpgHeaderContainer {
     /**
      * Returns a channel info
      */
-    getChannelInfo(): xepgChnInfoDesc;
+    getChannelInfo(): IXEpgChnInfoDesc;
     /**
      * Returns a provider info
      */
-    getProviderInfo(): xepgProvInfoDesc | null;
+    getProviderInfo(): IXEpgProvInfoDesc | null;
     /**
      * Returns an instance content as a string in an XML-format.
      * @since v0.0.20
@@ -520,6 +205,34 @@ export class TXEpgHeaderContainer {
     #private;
 }
 
+/**
+ * This class implements an instance of an element
+ * that manages content of a document declaration
+ * @since v0.0.30
+ */
+export class TXmlContentDeclaration {
+    /**
+     * Creates an instance of the element
+     * @throws {TypeError}
+     */
+    constructor(obj: INode, opt?: OPT_epgelsett_bs);
+    /**
+     * Contains a version of an XML
+     */
+    get version(): string;
+    set version(value: string);
+    /**
+     * Contains a document character set
+     */
+    get encoding(): string;
+    set encoding(value: string);
+    /**
+     * Initializes an instance content.
+     */
+    init(): void;
+    #private;
+}
+
 /**
  * This class implements an interface of the container
  * that manages a content of a XEPG-document
@@ -586,5 +299,40 @@ export class TXEpgContentProvider {
     protected asJSON(): string;
     #private;
 }
+
+export const XEPG_DEF_PROVIDER_NAME: "xepg-lib-js";
+export const XEPG_DEF_PROVIDER_VER: "0.0.25";
+export const XEPG_DEF_DOCUMENT_TYPE: "xepg";
+export const XEPG_DEF_DOCUMENT_SCHEMA: string;
+/**
+ * This class implements an interface of a DTS-provider element
+ */
+export class TXEpgDTSProvider {
+    /**
+     * Creates an instance of the DTS-provider element
+     */
+    constructor(obj: INode, opt?: OPT_epgelsett_bs);
+    /**
+     * Contains a dtstype ID
+     */
+    get dtstype(): number;
+    set dtstype(value: number);
+    /**
+     * Contains a TZ-offset
+     */
+    get curDocTZ(): number;
+    set curDocTZ(value: number);
+    /**
+     * Tries to set a `DTS`-type
+     * @since 0.0.22
+     */
+    setType(value: number | string): boolean;
+    #private;
+}
+
 import { TXmlContentParseOptions } from "@ygracs/xobj-lib-js";
+import type { INode } from "@ygracs/xobj-lib-js";
+import { TXEpgChannelContainer } from "./xepg-channel";
+import { IXEpgChnInfoDesc } from "./xepg-channel";
+import { TXEpgSchedulesList } from "./xepg-sched";
 import { fsoDescr } from "@cntwg/file-helper";