whatever2telegram

Allows forwarding whatever you want to a Telegram handle (chat, group or channel).

Every module is built in a way that its job is just to fetch data, without caring of sending the actual messages, excluding previous data or data formatting.

The list of elements are configured in the ./data/config.js file

Top-level options are:

env: environment string
sentryDsn: DNS used for Sentry error reporting
telegram:
- token: token of your bot
- polling: enable polling to fetch data
doNotDisturb:
- min: hour of the day (24h) before which modules are not called
- max: hour of the day (24h) after which modules are not called

Example configuration:

module.exports = {
  env: "prod",
  sentryDsn: "",
  telegram: {
    token: "",
  },
  doNotDisturb: {
    min: 7,
    max: 23,
  },
  modules: [
    {
      description: "MyRSS",
      chatIds: ["@MyRSS"],
      name: "rss",
      args: {
        url: "https://yourwebsite.com/rss",
      },
      fetchInterval: 60 * 10,
    },
    {
      description: "MyJSON",
      chatIds: ["@MyJSON"],
      name: "json",
      args: {
        url: "http://myjson.com",
      },
      mapper: data => data.result.filter(e => e.location === "Stockholm").map(e => ({ ...e, hash: e.event_id })),
      formatters: [
        e => ({
          message: "<b>${e.title} at ${e.date}<b>",
          photo: e.event_image,
          url: `https:${e.url}`,
        }),
      ],
      fetchInterval: 60,
    },
  ],
};

Modules

A module is an encapsulated piece of logic to grab data from a source.

Available options to every module:

chatIds: array of Telegram chat ids
fetchInterval: how often (in seconds) data should be fetched
name: name of the module
args: arguments to pass to the modules
description: unique identifier for this configuration
formatters[]?: list of formatters to apply in sequence

`mapper`

The mapper attribute is a JS function to invoke to parse the response and return an array of elements.

This function can filter and only returns attributes of your element that you want to diff against previous runs, to understand to process the element or not.

If the mapper returns an hash attribute, the check against the attributes will be skipped and hash will be used instead.

`facebook_page`

Facebook page posts.

pageId: Facebook page-id
accessToken: Extended access token

`json`

URL endpoint with JSON data formatting.

url: URL to fetch
headers?: HTTP headers

`rss`

URL endpoint with RSS data formatting.

url: URL to fetch

`visual`

URL endpoint and checks a visual diff of a specific DOM element

url: URL to fetch
element_selector?: DOM selector that will be visuall diffed
click_selector?: DOM selector to click before taking screenshot

Formatters

A formatter is a function that receives your output before being sent to be able to manipulate it.

You can define a formatter with:

a string (the name of formatter)
an object like { "name": "__NAME__", "options": {} }
a custom JS function

Available formatters:

`translate`

Translate the input message.

mode: replace, append or prepend, default: replace
toLanguage: language to translate to, default: en

kopiro / whatever2telegram