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

package/lib/xepgdoc-lib.d.ts

@@ -0,0 +1,590 @@
+/**
+ * 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>;
+};
+/**
+ * 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;
+};
+/**
+ * A provider info descriptor
+ */
+export type xepgProvInfoDesc = {
+    /**
+     * - provider name
+     */
+    name?: string;
+    /**
+     * - provider version
+     */
+    version?: string;
+    /**
+     * - document schema
+     */
+    schema: string;
+    /**
+     * - document type
+     */
+    doctype: string;
+};
+/**
+ * A channel info descriptor
+ */
+export type xepgChnInfoDesc = {
+    /**
+     * - channel ID
+     */
+    chnid: string;
+    /**
+     * - channel name
+     */
+    chname: string;
+    /**
+     * - channel 'Group ID'
+     */
+    chngid?: string;
+    /**
+     * - EPG-source URL
+     */
+    srcurl?: string;
+};
+
+/**
+ * An options set for `TXEpgContentProvider`-class
+ */
+export type OPT_epgcpsett = {
+    /**
+     * - parser options
+     */
+    parseOptions?: InstanceType<typeof TXmlContentParseOptions>;
+    /**
+     * - <*deprecated*>
+     */
+    autoBindRoot?: boolean;
+};
+/**
+ * An options set for `TXEpgContentProvider`-class
+ */
+export type XEpgContainerConfig = {
+    /**
+     * - parser options
+     */
+    parseOptions: InstanceType<typeof TXmlContentParseOptions>;
+    /**
+     * - <*deprecated*>
+     */
+    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
+ */
+export class TXEpgProviderContainer {
+    /**
+     * Creates an instance of the EPG-provider element
+     */
+    constructor(obj: object, opt?: OPT_epgelsett_bs);
+    /**
+     * Contains a provider name
+     */
+    get name(): string;
+    set name(value: string);
+    /**
+     * Contains a version of a provider
+     */
+    get version(): string;
+    set version(value: string);
+    /**
+     * Contains a version of a document schema
+     */
+    get schema(): string;
+    set schema(value: string);
+    /**
+     * Contains a document type
+     */
+    get doctype(): string;
+    set doctype(value: string);
+    /**
+     * Sets a provider name
+     */
+    setName(value: string): boolean;
+    /**
+     * Returns a provider info item
+     */
+    getInfo(): xepgProvInfoDesc;
+    /**
+     * Sets a provider info
+     * @todo [since v0.0.21] deprecate use of `obj`-param as array
+     */
+    setInfo(obj: string[] | xepgProvInfoDesc): void;
+    /**
+     * Sets an initial instance state
+     */
+    init(opt?: xepgProvInfoDesc | string[]): void;
+    /**
+     * Returns an instance content as a string in an XML-format.
+     * @since v0.0.20
+     */
+    saveToXMLString(): string;
+    /**
+     * Loads a element content from a string.
+     * @since v0.0.24
+     * @throws {Error}
+     * @experimental
+     */
+    loadFromXMLString(xmlString: string): boolean;
+    #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
+ */
+export class TXEpgHeaderContainer {
+    /**
+     * Creates an instance of the EPG-header element
+     */
+    constructor(obj: object, opt?: OPT_epgelsett_bs);
+    /**
+     * Returns a `TXEpgDTSProvider` instance
+     */
+    get dts(): TXEpgDTSProvider;
+    /**
+     * Contains a dtstype ID
+     * @todo [since v0.0.22] becomes readonly
+     */
+    get dtstype(): number;
+    set dtstype(value: number);
+    /**
+     * Contains a TZ-offset
+     * @todo [since v0.0.22] becomes readonly
+     */
+    get curDocTZ(): number;
+    set curDocTZ(value: number);
+    /**
+     * Returns a `TXEpgProviderContainer` instance
+     * @since 0.0.22
+     */
+    get provider(): TXEpgProviderContainer | null;
+    /**
+     * Returns a `TXEpgChannelContainer` instance
+     * @since 0.0.22
+     */
+    get channel(): TXEpgChannelContainer;
+    /**
+     * Returns a document creation date as a timestamp
+     */
+    getDocumentDT(): number;
+    /**
+     * Sets a document creation date to a current system time
+     */
+    setDocumentDT(): void;
+    /**
+     * Returns a document expire date as a timestamp
+     */
+    getDocumentEDT(): number;
+    /**
+     * Sets a document expire date to a given time
+     */
+    setDocumentEDT(value: any): void;
+    /**
+     * Returns a channel info
+     */
+    getChannelInfo(): xepgChnInfoDesc;
+    /**
+     * Returns a provider info
+     */
+    getProviderInfo(): xepgProvInfoDesc | null;
+    /**
+     * Returns an instance content as a string in an XML-format.
+     * @since v0.0.20
+     */
+    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 the container
+ * that manages a content of a XEPG-document
+ */
+export class TXEpgContentProvider {
+    /**
+     * Creates an instance of the XEPG-content provider
+     */
+    constructor(opt?: OPT_epgcpsett);
+    /**
+     * Returns a `TXEpgHeaderContainer` instance
+     * @since 0.0.22
+     */
+    get header(): TXEpgHeaderContainer;
+    /**
+     * Returns a `TXEpgProviderContainer` instance
+     * @since 0.0.22
+     */
+    get provider(): TXEpgProviderContainer | null;
+    /**
+     * Returns a `TXEpgDTSProvider` instance
+     */
+    get dts(): TXEpgDTSProvider | null;
+    /**
+     * Returns a `TXEpgSchedulesList` instance
+     * @since 0.0.24
+     */
+    get schedules(): TXEpgSchedulesList;
+
+    init(): void;
+    /**
+     * Returns a document content as a string in an XML-format.
+     */
+    saveToXMLString(): string;
+    /**
+     * Saves a document content to a file.
+     * @throws {Error}
+     * @async
+     */
+    saveToFile(source: string): Promise<fsoDescr>;
+    /**
+     * Saves a document content to a file.
+     */
+    saveToFileSync(source: string): fsoDescr;
+    /**
+     * Loads a document content from a string.
+     * @since 0.0.18
+     * @throws {Error}
+     */
+    loadFromXMLString(xmlString: string): boolean;
+    /**
+     * Loads a document content from a file.
+     * @throws {Error}
+     * @async
+     */
+    loadFromFile(source: string): Promise<fsoDescr>;
+    /**
+     * Loads a document content from a file.
+     */
+    loadFromFileSync(source: string): fsoDescr;
+    /**
+     * @protected
+     */
+    protected asJSON(): string;
+    #private;
+}
+import { TXmlContentParseOptions } from "@ygracs/xobj-lib-js";
+import { fsoDescr } from "@cntwg/file-helper";