epg-grabber 0.43.0 → 0.44.0

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { n as name, v as version, d as description, p as parseNumber, L as Logger, l as loadJs, a as parseProxy, E as EPGGrabber, g as getUTCDate } from './index-_okTrZbD.js';
+import { n as name, v as version, d as description, p as parseNumber, L as Logger, l as loadJs, a as parseProxy, E as EPGGrabber, g as getUTCDate } from './index-DQUOgwl_.js';
 import { Template, Collection } from '@freearhey/core';
 import { Command, Option } from 'commander';
 import { SocksProxyAgent } from 'socks-proxy-agent';

package/dist/{index-_okTrZbD.js → index-DQUOgwl_.js}

@@ -14,19 +14,17 @@ import xmlJs from 'xml-js';
 import fs from 'fs-extra';
 
 dayjs.extend(utc);
-function parseProxy(proxy) {
-  const parsed = new URL(proxy);
-  const result = {
-    protocol: parsed.protocol.replace(":", "") || null,
+function parseProxy(string) {
+  const parsed = new URL(string);
+  const proxy = {
+    protocol: parsed.protocol.replace(":", ""),
     host: parsed.hostname,
-    port: parsed.port ? parseInt(parsed.port) : null
+    port: parsed.port ? parseInt(parsed.port) : 8080
   };
   if (parsed.username || parsed.password) {
-    result.auth = {};
-    if (parsed.username) result.auth.username = parsed.username;
-    if (parsed.password) result.auth.password = parsed.password;
+    proxy.auth = { username: parsed.username, password: parsed.password };
   }
-  return result;
+  return proxy;
 }
 async function loadJs(filepath) {
   const absPath = path.resolve(filepath);
@@ -47,9 +45,9 @@ function isObject(value) {
 function isPromise(promise) {
   return promise instanceof Promise;
 }
-function getUTCDate(date = null) {
-  if (typeof date === "string") return dayjs.utc(date).startOf("d");
-  return dayjs.utc().startOf("d");
+function getUTCDate(date) {
+  if (dayjs.isDayjs(date) && date.isUTC()) return date;
+  return dayjs.utc(date).startOf("d");
 }
 function getAbsPath(filepath, rootDir) {
   if (path.isAbsolute(filepath)) return filepath;
@@ -103,7 +101,7 @@ function toArray(value) {
 }
 
 var name = "epg-grabber";
-var version = "0.43.0";
+var version = "0.44.0";
 var description = "Node.js CLI tool for grabbing EPG from different sites";
 var homepage = "https://github.com/freearhey/epg-grabber";
 
@@ -1008,7 +1006,50 @@ class EPGGrabber {
 }
 class EPGGrabberMock extends EPGGrabber {
   async grab(channel, date, config, callback) {
-    return [];
+    if (!callback) callback = () => {
+    };
+    if (typeof config === "function") {
+      callback = config;
+      config = void 0;
+    }
+    if (!(channel instanceof Channel)) {
+      throw new Error('The first argument must be the "Channel" class');
+    }
+    const utcDate = getUTCDate(date);
+    try {
+      const configObject = config || this.globalConfig;
+      if (!configObject) throw new Error("Site config is missing");
+      const siteConfig = new SiteConfig(configObject);
+      siteConfig.update(this.globalConfig);
+      this.logger.debug(`Config (local): ${JSON.stringify(siteConfig, null, 2)}`);
+      siteConfig.validate();
+      const requestContext = { channel, date: utcDate, siteConfig };
+      await Client.buildRequest(requestContext, { logger: this.logger });
+      const response = { cached: false };
+      if (!siteConfig.parser) {
+        throw new Error("Could not find parser() in the config file");
+      }
+      const parserContext = {
+        ...response,
+        channel,
+        date: utcDate,
+        config: siteConfig
+      };
+      let parsedPrograms = siteConfig.parser(parserContext);
+      if (isPromise(parsedPrograms)) {
+        parsedPrograms = await parsedPrograms;
+      }
+      const programs = await EPGGrabber.parseParserResults(
+        parsedPrograms,
+        channel
+      );
+      callback({ channel, date: utcDate, programs }, null);
+      return programs;
+    } catch (error) {
+      this.logger.debug(`Error: ${JSON.stringify(error, null, 2)}`);
+      callback({ channel, date: utcDate, programs: [] }, error);
+      return [];
+    }
   }
 }
 

package/dist/index.d.ts

@@ -207,6 +207,11 @@ interface GrabCallbackContext {
   date: Dayjs
 }
 
+type XMLElement =
+  | string
+  | number
+  | { name: string; attrs?: Record<string, string>; children?: XMLElement[] }
+
 type index_d_AudioObject = AudioObject;
 type index_d_ChannelData = ChannelData;
 type index_d_ClientRequestConfig = ClientRequestConfig;
@@ -234,8 +239,9 @@ type index_d_SubtitlesObject = SubtitlesObject;
 type index_d_TextObject = TextObject;
 type index_d_UrlObject = UrlObject;
 type index_d_VideoObject = VideoObject;
+type index_d_XMLElement = XMLElement;
 declare namespace index_d {
-  export type { index_d_AudioObject as AudioObject, index_d_ChannelData as ChannelData, index_d_ClientRequestConfig as ClientRequestConfig, index_d_ClientResponse as ClientResponse, index_d_DateObject as DateObject, index_d_EpisodeNumberObject as EpisodeNumberObject, index_d_GrabCallback as GrabCallback, index_d_GrabCallbackContext as GrabCallbackContext, index_d_IconObject as IconObject, index_d_ImageObject as ImageObject, index_d_LenghtObject as LenghtObject, index_d_PersonObject as PersonObject, index_d_PreviouslyShownObject as PreviouslyShownObject, index_d_ProgramData as ProgramData, index_d_RatingObject as RatingObject, index_d_ReviewObject as ReviewObject, index_d_SiteConfigObject as SiteConfigObject, index_d_SiteConfigOptions as SiteConfigOptions, index_d_SiteConfigParserContext as SiteConfigParserContext, index_d_SiteConfigParserResult as SiteConfigParserResult, index_d_SiteConfigRequestConfig as SiteConfigRequestConfig, index_d_SiteConfigRequestConfigData as SiteConfigRequestConfigData, index_d_SiteConfigRequestContext as SiteConfigRequestContext, index_d_SubtitlesObject as SubtitlesObject, index_d_TextObject as TextObject, index_d_UrlObject as UrlObject, index_d_VideoObject as VideoObject };
+  export type { index_d_AudioObject as AudioObject, index_d_ChannelData as ChannelData, index_d_ClientRequestConfig as ClientRequestConfig, index_d_ClientResponse as ClientResponse, index_d_DateObject as DateObject, index_d_EpisodeNumberObject as EpisodeNumberObject, index_d_GrabCallback as GrabCallback, index_d_GrabCallbackContext as GrabCallbackContext, index_d_IconObject as IconObject, index_d_ImageObject as ImageObject, index_d_LenghtObject as LenghtObject, index_d_PersonObject as PersonObject, index_d_PreviouslyShownObject as PreviouslyShownObject, index_d_ProgramData as ProgramData, index_d_RatingObject as RatingObject, index_d_ReviewObject as ReviewObject, index_d_SiteConfigObject as SiteConfigObject, index_d_SiteConfigOptions as SiteConfigOptions, index_d_SiteConfigParserContext as SiteConfigParserContext, index_d_SiteConfigParserResult as SiteConfigParserResult, index_d_SiteConfigRequestConfig as SiteConfigRequestConfig, index_d_SiteConfigRequestConfigData as SiteConfigRequestConfigData, index_d_SiteConfigRequestContext as SiteConfigRequestContext, index_d_SubtitlesObject as SubtitlesObject, index_d_TextObject as TextObject, index_d_UrlObject as UrlObject, index_d_VideoObject as VideoObject, index_d_XMLElement as XMLElement };
 }
 
 declare class Program {
@@ -303,7 +309,7 @@ interface SiteConfigObject {
   debug?: boolean
   output?: string
   channels?: string | string[]
-  request?: Omit<CacheRequestConfig, 'headers' | 'data'> & SiteConfigRequestConfig
+  request?: SiteConfigRequestConfig
   logo?: ((context: SiteConfigRequestContext) => string | Promise<string>) | string
 }
 
@@ -317,7 +323,7 @@ type SiteConfigRequestConfigData =
   | Record<string, unknown>
   | null
 
-interface SiteConfigRequestConfig {
+type SiteConfigRequestConfig = Omit<CacheRequestConfig, 'headers' | 'data'> & {
   data?:
     | ((
         context: SiteConfigRequestContext

package/dist/index.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-export { C as Channel, E as EPGGrabber, b as EPGGrabberMock, P as Program } from './index-_okTrZbD.js';
+export { C as Channel, E as EPGGrabber, b as EPGGrabberMock, P as Program } from './index-DQUOgwl_.js';
 import '@freearhey/core';
 import 'xml-js';
 import 'fs-extra';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.43.0",
+  "version": "0.44.0",
   "description": "Node.js CLI tool for grabbing EPG from different sites",
   "homepage": "https://github.com/freearhey/epg-grabber",
   "preferGlobal": true,
@@ -16,6 +16,7 @@
   "scripts": {
     "cli": "tsx ./src/cli.ts",
     "build": "pkgroll --clean-dist",
+    "dev": "pkgroll --watch",
     "lint": "npx eslint ./src/**/*.ts ./tests/**/*.ts",
     "test": "npx vitest run"
   },

package/src/core/utils.ts

@@ -1,27 +1,26 @@
-import { ProxyParserResult, XMLElement } from '../types/utils'
+import { XMLElement } from '../types/utils'
 import dayjs, { Dayjs } from 'dayjs'
 import utc from 'dayjs/plugin/utc.js'
 import { URL } from 'node:url'
 import path from 'node:path'
+import { AxiosProxyConfig } from 'axios'
 
 dayjs.extend(utc)
 
-export function parseProxy(proxy: string): ProxyParserResult {
-  const parsed = new URL(proxy)
+export function parseProxy(string: string): AxiosProxyConfig {
+  const parsed = new URL(string)
 
-  const result: ProxyParserResult = {
-    protocol: parsed.protocol.replace(':', '') || null,
+  const proxy: AxiosProxyConfig = {
+    protocol: parsed.protocol.replace(':', ''),
     host: parsed.hostname,
-    port: parsed.port ? parseInt(parsed.port) : null
+    port: parsed.port ? parseInt(parsed.port) : 8080
   }
 
   if (parsed.username || parsed.password) {
-    result.auth = {}
-    if (parsed.username) result.auth.username = parsed.username
-    if (parsed.password) result.auth.password = parsed.password
+    proxy.auth = { username: parsed.username, password: parsed.password }
   }
 
-  return result
+  return proxy
 }
 
 export async function loadJs(filepath: string) {
@@ -50,10 +49,10 @@ export function isPromise(promise: unknown): boolean {
   return promise instanceof Promise
 }
 
-export function getUTCDate(date: string | number | Date | Dayjs | null = null) {
-  if (typeof date === 'string') return dayjs.utc(date).startOf('d')
+export function getUTCDate(date?: string | number | Date | Dayjs | null) {
+  if (dayjs.isDayjs(date) && date.isUTC()) return date
 
-  return dayjs.utc().startOf('d')
+  return dayjs.utc(date).startOf('d')
 }
 
 export function getAbsPath(filepath: string, rootDir: string) {

package/src/index.ts

@@ -216,6 +216,66 @@ export class EPGGrabberMock extends EPGGrabber {
     config?: SiteConfigObject | GrabCallback,
     callback?: GrabCallback
   ): Promise<Program[]> {
-    return []
+    if (!callback) callback = () => {}
+    if (typeof config === 'function') {
+      callback = config
+      config = undefined
+    }
+
+    if (!(channel instanceof Channel)) {
+      throw new Error('The first argument must be the "Channel" class')
+    }
+
+    const utcDate = getUTCDate(date)
+
+    try {
+      const configObject = config || this.globalConfig
+      if (!configObject) throw new Error('Site config is missing')
+
+      const siteConfig = new SiteConfig(configObject)
+
+      siteConfig.update(this.globalConfig)
+
+      this.logger.debug(`Config (local): ${JSON.stringify(siteConfig, null, 2)}`)
+
+      siteConfig.validate()
+
+      const requestContext = { channel, date: utcDate, siteConfig }
+
+      await Client.buildRequest(requestContext, { logger: this.logger })
+
+      const response = { cached: false }
+
+      if (!siteConfig.parser) {
+        throw new Error('Could not find parser() in the config file')
+      }
+
+      const parserContext = {
+        ...response,
+        channel,
+        date: utcDate,
+        config: siteConfig
+      }
+      let parsedPrograms = siteConfig.parser(parserContext)
+
+      if (isPromise(parsedPrograms)) {
+        parsedPrograms = await parsedPrograms
+      }
+
+      const programs = await EPGGrabber.parseParserResults(
+        parsedPrograms as SiteConfigParserResult[],
+        channel
+      )
+
+      callback({ channel, date: utcDate, programs }, null)
+
+      return programs
+    } catch (error: unknown) {
+      this.logger.debug(`Error: ${JSON.stringify(error, null, 2)}`)
+
+      callback({ channel, date: utcDate, programs: [] }, error as Error)
+
+      return []
+    }
   }
 }

package/src/types/index.d.ts

@@ -3,3 +3,4 @@ export * from 'client'
 export * from 'grab'
 export * from 'program'
 export * from 'siteConfig'
+export * from 'utils'

package/src/types/siteConfig.d.ts

@@ -25,7 +25,7 @@ export interface SiteConfigObject {
   debug?: boolean
   output?: string
   channels?: string | string[]
-  request?: Omit<CacheRequestConfig, 'headers' | 'data'> & SiteConfigRequestConfig
+  request?: SiteConfigRequestConfig
   logo?: ((context: SiteConfigRequestContext) => string | Promise<string>) | string
 }
 
@@ -39,7 +39,7 @@ export type SiteConfigRequestConfigData =
   | Record<string, unknown>
   | null
 
-export interface SiteConfigRequestConfig {
+export type SiteConfigRequestConfig = Omit<CacheRequestConfig, 'headers' | 'data'> & {
   data?:
     | ((
         context: SiteConfigRequestContext

package/src/types/utils.d.ts

@@ -1,13 +1,3 @@
-export interface ProxyParserResult {
-  protocol: string | null
-  host: string
-  port: number | null
-  auth?: {
-    username?: string
-    password?: string
-  }
-}
-
 export type XMLElement =
   | string
   | number

package/tests/core/utils.test.ts

@@ -1,5 +1,6 @@
-import { escapeString, parseProxy, sleep } from '../../src/core/utils'
+import { escapeString, getUTCDate, parseProxy, sleep } from '../../src/core/utils'
 import { it, expect, describe, test, vi } from 'vitest'
+import dayjs from 'dayjs'
 
 describe('sleep()', () => {
   it('can be skiped during test', async () => {
@@ -32,3 +33,10 @@ test('parseProxy()', () => {
     protocol: 'socks'
   })
 })
+
+describe('getUTCDate()', () => {
+  it('return original value if it is already UTC date', () => {
+    const date = dayjs.utc('2022-10-20')
+    expect(getUTCDate(date).toJSON()).toBe('2022-10-20T00:00:00.000Z')
+  })
+})