epg-grabber 0.46.0 → 0.46.2

package/.prettierrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  tabWidth: 2,
+  useTabs: false,
+  endOfLine: "crlf",
+  semi: false,
+  singleQuote: true,
+  printWidth: 100,
+  trailingComma: "none",
+  arrowParens: "avoid",
+};

package/README.md

@@ -8,61 +8,6 @@ Node.js CLI tool for grabbing EPG from different websites.
 npm install -g epg-grabber
 ```
 
-## Quick Start
-
-```sh
-epg-grabber --config=example.com.config.js
-```
-
-#### example.com.config.js
-
-```js
-module.exports = {
-  site: 'example.com',
-  channels: 'example.com.channels.xml',
-  url: function (context) {
-    const { date, channel } = context
-
-    return `https://api.example.com/${date.format('YYYY-MM-DD')}/channel/${channel.site_id}`
-  },
-  parser: function (context) {
-    const programs = JSON.parse(context.content)
-
-    return programs.map(program => {
-      return {
-        title: program.title,
-        start: program.start,
-        stop: program.stop
-      }
-    })
-  }
-}
-```
-
-#### example.com.channels.xml
-
-```xml
-<?xml version="1.0" ?>
-<channels site="example.com">
-  <channel site_id="cnn-23" xmltv_id="CNN.us">CNN</channel>
-</channels>
-```
-
-## Example Output
-
-```xml
-<tv>
-  <channel id="CNN.us">
-    <display-name>CNN</display-name>
-    <url>https://example.com</url>
-  </channel>
-  <programme start="20211116040000 +0000" stop="20211116050000 +0000" channel="CNN.us">
-    <title lang="en">News at 10PM</title>
-  </programme>
-  // ...
-</tv>
-```
-
 ## CLI
 
 ```sh
@@ -86,7 +31,15 @@ Arguments:
 - `--log`: path to log file (optional)
 - `--log-level`: set the log level (default: `info`)
 
-## Site Config
+## How to use?
+
+First, you need to create two files:
+
+<details>
+<summary>example.com.config.js</summary>
+<br>
+
+This file describes what kind of request we need to send to get the guide for a particular channel on a certain date and how to parse the response.
 
 ```js
 module.exports = {
@@ -182,14 +135,14 @@ module.exports = {
 }
 ```
 
-## Request Context Object
+### Request Context Object
 
 Inside `url()`, `logo()`, `request.data()`, `request.headers()` functions in `config.js` you can access a `context` object containing the following data:
 
 - `channel`: The object describing the current channel (xmltv_id, site_id, name, lang)
 - `date`: The 'dayjs' instance with the requested date
 
-## Parser Context Object
+### Parser Context Object
 
 Inside `parser()` function in `config.js` you can access a `context` object containing the following data:
 
@@ -201,7 +154,7 @@ Inside `parser()` function in `config.js` you can access a `context` object cont
 - `request`: The request config
 - `cached`: A boolean to check whether this request was cached or not
 
-## Program Object
+### Program Object
 
 | Property        | Aliases                          | Type                                             | Required |
 | --------------- | -------------------------------- | ------------------------------------------------ | -------- |
@@ -371,7 +324,13 @@ Example:
 }
 ```
 
-## Channels List
+</details>
+
+<details>
+<summary>example.com.channels.xml</summary>
+<br>
+
+This file contains a list of channels available at the source.
 
 ```xml
 <?xml version="1.0" ?>
@@ -395,6 +354,29 @@ You can also specify the language, site, url, logo and LCN (Logical Channel Numb
 >France 24</channel>
 ```
 
+</details>
+
+After that, you just need to run the grabber with path to the config file:
+
+```sh
+epg-grabber --config=path/to/example.com.config.js
+```
+
+And when the download is complete, a ready-to-use guide will appear in the location you specified:
+
+  ```xml
+  <tv>
+    <channel id="CNN.us">
+      <display-name>CNN</display-name>
+      <url>https://example.com</url>
+    </channel>
+    <programme start="20211116040000 +0000" stop="20211116050000 +0000" channel="CNN.us">
+      <title lang="en">News at 10PM</title>
+    </programme>
+    // ...
+  </tv>
+  ```
+
 ## How to use SOCKS proxy?
 
 ```

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 loadJs, a as parseProxy, E as EPGGrabberMock, b as EPGGrabber, c as defaultConfig, i as isObject, g as getAbsPath, e as getUTCDate } from './index-DUJ5SdIU.js';
+import { n as name, v as version, d as description, p as parseNumber, l as loadJs, a as parseProxy, E as EPGGrabberMock, b as EPGGrabber, c as defaultConfig, i as isObject, g as getAbsPath, e as getUTCDate } from './index-Bnw63KMN.js';
 import { Collection, Template } from '@freearhey/core';
 import { Command, Option } from 'commander';
 import { SocksProxyAgent } from 'socks-proxy-agent';

package/dist/{index-DUJ5SdIU.js → index-Bnw63KMN.js}

@@ -102,7 +102,7 @@ function toArray(value) {
 }
 
 var name = "epg-grabber";
-var version = "0.46.0";
+var version = "0.46.1";
 var description = "Node.js CLI tool for grabbing EPG from different sites";
 var homepage = "https://github.com/freearhey/epg-grabber";
 
@@ -731,7 +731,7 @@ class EPGGrabber {
   async loadLogo(channel, date, config = {}) {
     if (!(channel instanceof Channel))
       throw new Error('The first argument must be the "Channel" class');
-    config = merge(defaultConfig, config, this.globalConfig);
+    config = merge({}, defaultConfig, config, this.globalConfig);
     if (typeof config.logo !== "function") return null;
     const requestContext = { channel, date: getUTCDate(date), config };
     const logo = config.logo(requestContext);
@@ -749,7 +749,7 @@ class EPGGrabber {
       config = {};
     }
     const utcDate = getUTCDate(date);
-    config = merge(defaultConfig, config, this.globalConfig);
+    config = merge({}, defaultConfig, config, this.globalConfig);
     if (!config.parser) throw new Error("Could not find parser() in the config file");
     if (!config.site) throw new Error("The required 'site' property is missing");
     if (!config.url) throw new Error("The required 'url' property is missing");
@@ -826,7 +826,7 @@ class EPGGrabberMock extends EPGGrabber {
       config = {};
     }
     const utcDate = getUTCDate(date);
-    config = merge(defaultConfig, config, this.globalConfig);
+    config = merge({}, defaultConfig, config, this.globalConfig);
     if (!config.parser) throw new Error("Could not find parser() in the config file");
     try {
       const requestContext = { channel, date: utcDate, config };

package/dist/index.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-export { C as Channel, b as EPGGrabber, E as EPGGrabberMock, P as Program } from './index-DUJ5SdIU.js';
+export { C as Channel, b as EPGGrabber, E as EPGGrabberMock, P as Program } from './index-Bnw63KMN.js';
 import 'axios-mock-adapter';
 import 'lodash.merge';
 import 'xml-js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.46.0",
+  "version": "0.46.2",
   "description": "Node.js CLI tool for grabbing EPG from different sites",
   "homepage": "https://github.com/freearhey/epg-grabber",
   "preferGlobal": true,
@@ -34,7 +34,7 @@
     "url": "https://github.com/freearhey/epg-grabber.git"
   },
   "engines": {
-    "node": ">=22.12.0"
+    "node": ">=20.20.0"
   },
   "dependencies": {
     "@freearhey/core": "^0.14.0",
@@ -70,5 +70,8 @@
     "typescript": "^5.9.2",
     "typescript-eslint": "^8.44.1",
     "vitest": "^3.2.4"
+  },
+  "overrides": {
+    "esbuild": "0.23.1"
   }
 }

package/src/index.ts

@@ -30,7 +30,7 @@ export class EPGGrabber {
     if (!(channel instanceof Channel))
       throw new Error('The first argument must be the "Channel" class')
 
-    config = merge(defaultConfig, config, this.globalConfig)
+    config = merge({}, defaultConfig, config, this.globalConfig)
 
     if (typeof config.logo !== 'function') return null
 
@@ -59,7 +59,7 @@ export class EPGGrabber {
 
     const utcDate = getUTCDate(date)
 
-    config = merge(defaultConfig, config, this.globalConfig)
+    config = merge({}, defaultConfig, config, this.globalConfig)
 
     if (!config.parser) throw new Error('Could not find parser() in the config file')
     if (!config.site) throw new Error("The required 'site' property is missing")
@@ -175,7 +175,7 @@ export class EPGGrabberMock extends EPGGrabber {
 
     const utcDate = getUTCDate(date)
 
-    config = merge(defaultConfig, config, this.globalConfig)
+    config = merge({}, defaultConfig, config, this.globalConfig)
 
     if (!config.parser) throw new Error('Could not find parser() in the config file')
 

package/tests/cli.test.ts

@@ -57,72 +57,21 @@ it('can load mini config', () => {
     }
   )
 
-  expect(stdout).contains(`{
-  "site": "example.com",
-  "url": "http://example.com/20210319/1tv.json",
-  "channels": [
+  expect(stdout).contains('"site": "example.com"')
+  expect(stdout).contains('"url": "http://example.com/20210319/1tv.json"')
+  expect(stdout).contains(`"channels": [
     "tests/__data__/input/example.channels.xml"
-  ],
-  "request": {
-    "timeout": 1,
-    "httpAgent": {
-      "_events": {},
-      "_eventsCount": 2,
-      "options": {
-        "noDelay": true,
-        "path": null
-      },
-      "requests": {},
-      "sockets": {},
-      "freeSockets": {},
-      "keepAliveMsecs": 1000,
-      "keepAlive": false,
-      "maxSockets": null,
-      "maxFreeSockets": 256,
-      "scheduling": "lifo",
-      "maxTotalSockets": null,
-      "totalSocketCount": 0,
-      "shouldLookup": false,
-      "proxy": {
+  ]`)
+  expect(stdout).contains('"timeout": 1')
+  expect(stdout).contains(`"proxy": {
         "host": "127.0.0.1",
         "port": 1086,
         "type": 5
-      },
-      "timeout": null,
-      "socketOptions": null
-    },
-    "httpsAgent": {
-      "_events": {},
-      "_eventsCount": 2,
-      "options": {
-        "noDelay": true,
-        "path": null
-      },
-      "requests": {},
-      "sockets": {},
-      "freeSockets": {},
-      "keepAliveMsecs": 1000,
-      "keepAlive": false,
-      "maxSockets": null,
-      "maxFreeSockets": 256,
-      "scheduling": "lifo",
-      "maxTotalSockets": null,
-      "totalSocketCount": 0,
-      "shouldLookup": false,
-      "proxy": {
-        "host": "127.0.0.1",
-        "port": 1086,
-        "type": 5
-      },
-      "timeout": null,
-      "socketOptions": null
-    }
-  },
-  "output": "tests/__data__/output/mini.guide.xml",
-  "days": 3,
-  "delay": 0,
-  "debug": true
-}`)
+      }`)
+  expect(stdout).contains('"output": "tests/__data__/output/mini.guide.xml"')
+  expect(stdout).contains('"days": 3')
+  expect(stdout).contains('"delay": 0')
+  expect(stdout).contains('"debug": true')
   expect(stdout).contains("File 'tests/__data__/output/mini.guide.xml' successfully saved")
   expect(content('tests/__data__/output/mini.guide.xml')).toEqual(
     content('tests/__data__/expected/mini.guide.xml')

package/tests/__data__/output/channels_array.guide.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?><tv date="20251028">
-<channel id="3TV.com"><display-name>3 TV</display-name><icon src="http://example.com/logos/1TV.png?x=шеллы&amp;sid=777"/><url>https://example2.com</url></channel>
-<channel id="4TV.com"><display-name>4 TV</display-name><icon src="http://example.com/logos/1TV.png?x=шеллы&amp;sid=777"/><url>https://example2.com</url></channel>
-<channel id="1TV.com"><display-name>1 TV</display-name><icon src="https://example.com/logos/1TV.png"/><url>https://example.com</url></channel>
-<channel id="2TV.com"><display-name>2 TV</display-name><icon src="http://example.com/logos/1TV.png?x=шеллы&amp;sid=777"/><url>https://example.com</url></channel>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="3TV.com"><title>Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="3TV.com"><title>Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="2TV.com"><title>Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="2TV.com"><title>Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="1TV.com"><title lang="fr">Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="1TV.com"><title lang="fr">Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="4TV.com"><title>Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="4TV.com"><title>Program1</title></programme>
-</tv>