Telegram message transformer

Introduction

Telegram transformer is a library that makes it simple for you to transform telegram message to any markup.

Getting started

Installation

1$ npm install telegram-transformer

or

1$ yarn add telegram-transformer

Example

1import formatText, { htmlFormatters } from 'telegram-transformer';
2import { MessageEntity } from 'typegram';
3
4const text =
5  'Hello @username #awesome_hashtag $USD /start@jobs_bot https://telegram.org do-not-reply@telegram.org +1-212-555-0123 bold text italic text underlined text strikethrough text spoiler message monowidth string monowidth block text_link';
6const entities: MessageEntity[] = [
7  { offset: 6, length: 9, type: 'mention' },
8  { offset: 16, length: 16, type: 'hashtag' },
9  { offset: 25, length: 7, type: 'bold' },
10  { offset: 33, length: 4, type: 'cashtag' },
11  { offset: 38, length: 15, type: 'bot_command' },
12  { offset: 54, length: 20, type: 'url' },
13  { offset: 75, length: 25, type: 'email' },
14  { offset: 101, length: 15, type: 'phone_number' },
15  { offset: 117, length: 9, type: 'bold' },
16  { offset: 127, length: 11, type: 'italic' },
17  { offset: 139, length: 5, type: 'underline' },
18  { offset: 144, length: 10, type: 'underline' },
19  { offset: 144, length: 5, type: 'bold' },
20  { offset: 155, length: 18, type: 'strikethrough' },
21  { offset: 174, length: 15, type: 'spoiler' },
22  {
23    offset: 223,
24    length: 9,
25    type: 'text_link',
26    url: 'https://telegram.org/',
27  },
28];
29
30const formatted = formatText(text, entities, { formatters: htmlFormatters });
31
32console.log(formatted);
33
34/*
35{
36  text: "Hello <a href='https://t.me/username'>@username</a> <a href='#awesome_hashtag'>#awesome_<strong>hashtag</strong></a> $USD /start@jobs_bot <a href='https://telegram.org'>https://telegram.org</a> <a href='mailto:do-not-reply@telegram.org'>do-not-reply@telegram.org</a> <a href='tel:+1-212-555-0123'>+1-212-555-0123</a> <strong>bold text</strong> <i>italic text</i> <u>under</u><u><strong>lined</strong> text</u> <strike>strikethrough text</strike> <span class='spoiler-hover'>spoiler message</span> monowidth string monowidth block <a href='https://telegram.org/'>text_link</a>",
37  entities: [
38    { offset: 6, length: 45, type: 'mention' },
39    { offset: 16, length: 16, type: 'hashtag' },
40    { offset: 88, length: 24, type: 'bold' },
41    { offset: 117, length: 4, type: 'cashtag' },
42    { offset: 122, length: 15, type: 'bot_command' },
43    { offset: 138, length: 55, type: 'url' },
44    { offset: 194, length: 72, type: 'email' },
45    { offset: 267, length: 49, type: 'phone_number' },
46    { offset: 317, length: 26, type: 'bold' },
47    { offset: 344, length: 18, type: 'italic' },
48    { offset: 363, length: 12, type: 'underline' },
49    { offset: 144, length: 10, type: 'underline' },
50    { offset: 378, length: 22, type: 'bold' },
51    { offset: 410, length: 35, type: 'strikethrough' },
52    { offset: 446, length: 50, type: 'spoiler' },
53    {
54      offset: 530,
55      length: 45,
56      type: 'text_link',
57      url: 'https://telegram.org/'
58    }
59  ]
60}
61*/

Custom transformer

1import formatText, { htmlFormatters } from 'telegram-transformer';
2import { MessageEntity } from 'typegram';
3
4const text = 'Hello @username #awesome_hashtag';
5const entities: MessageEntity[] = [
6  { offset: 6, length: 9, type: 'mention' },
7  { offset: 16, length: 16, type: 'hashtag' },
8];
9
10const formatters = {
11  mention: (entityText: string, entity: MessageEntity, text: string) => ({
12    before: '<awesome-mention>',
13    after: '</awesome-mention>',
14    text: entityText,
15  }),
16  hashtag: (entityText: string, entity: MessageEntity, text: string) => ({
17    before: '<span class="hashtag">',
18    after: '</span>',
19    text: entityText,
20  }),
21};
22
23const formatted = formatText(text, entities, { formatters });
24
25console.log(formatted);
26
27/*
28{
29  text: 'Hello <awesome-mention>@username</awesome-mention> <span class="hashtag">#awesome_hashtag</span>',
30  entities: [
31    { offset: 6, length: 44, type: 'mention' },
32    { offset: 51, length: 45, type: 'hashtag' }
33  ]
34}
35*/