telegram-transformer 1.1.1 → 1.3.0

package/README.md

@@ -1,7 +1,12 @@
 <header>
-
+<div align="center">
 <h1 align="center">Telegram message transformer</h1>
 
+<a href="https://www.npmjs.com/package/telegram-transformer">
+  <img src="https://img.shields.io/npm/v/telegram-transformer.svg" alt="Latest Release">
+</a>
+
+</div>
 </header>
 
 ## Introduction
@@ -29,7 +34,7 @@ import formatText, { htmlFormatters } from 'telegram-transformer';
 import { MessageEntity } from 'typegram';
 
 const text =
-  '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';
+  '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 custom_emoji text_mention';
 const entities: MessageEntity[] = [
   { offset: 6, length: 9, type: 'mention' },
   { offset: 16, length: 16, type: 'hashtag' },
@@ -52,6 +57,22 @@ const entities: MessageEntity[] = [
     type: 'text_link',
     url: 'https://telegram.org/',
   },
+  {
+    offset: 233,
+    length: 12,
+    type: 'custom_emoji',
+    custom_emoji_id: '12345',
+  },
+  {
+    offset: 246,
+    length: 12,
+    type: 'text_mention',
+    user: {
+      id: 9876543210,
+      is_bot: false,
+      first_name: 'First Name',
+    },
+  },
 ];
 
 const formatted = formatText(text, entities, { formatters: htmlFormatters });
@@ -60,9 +81,9 @@ console.log(formatted);
 
 /*
 {
-  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>",
+  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> <span>custom_emoji | <b>EMOJI ID:12345</b></span> <span>text_mention: First Name | <b>ID:9876543210</b></span>",
   entities: [
-    { offset: 6, length: 45, type: 'mention' },
+{ offset: 6, length: 45, type: 'mention' },
     { offset: 16, length: 16, type: 'hashtag' },
     { offset: 88, length: 24, type: 'bold' },
     { offset: 117, length: 4, type: 'cashtag' },
@@ -82,8 +103,64 @@ console.log(formatted);
       length: 45,
       type: 'text_link',
       url: 'https://telegram.org/'
+    },
+    {
+      offset: 576,
+      length: 25,
+      type: 'custom_emoji',
+      custom_emoji_id: '12345'
+    },
+    {
+      offset: 626,
+      length: 25,
+      type: 'text_mention',
+      user: {
+        id: 9876543210,
+        is_bot: false,
+        first_name: 'First Name',
+      }
     }
   ]
 }
 */
 ```
+
+### Custom transformer
+
+```js
+import formatText, { htmlFormatters } from 'telegram-transformer';
+import { MessageEntity } from 'typegram';
+
+const text = 'Hello @username #awesome_hashtag';
+const entities: MessageEntity[] = [
+  { offset: 6, length: 9, type: 'mention' },
+  { offset: 16, length: 16, type: 'hashtag' },
+];
+
+const formatters = {
+  mention: (entityText: string, entity: MessageEntity, text: string) => ({
+    before: '<awesome-mention>',
+    after: '</awesome-mention>',
+    text: entityText,
+  }),
+  hashtag: (entityText: string, entity: MessageEntity, text: string) => ({
+    before: '<span class="hashtag">',
+    after: '</span>',
+    text: entityText,
+  }),
+};
+
+const formatted = formatText(text, entities, { formatters });
+
+console.log(formatted);
+
+/*
+{
+  text: 'Hello <awesome-mention>@username</awesome-mention> <span class="hashtag">#awesome_hashtag</span>',
+  entities: [
+    { offset: 6, length: 44, type: 'mention' },
+    { offset: 51, length: 45, type: 'hashtag' }
+  ]
+}
+*/
+```

package/lib/format.d.ts

@@ -1,4 +1,4 @@
-import { MessageEntity } from 'typegram';
+import type { MessageEntity } from 'typegram';
 import { Options } from './types';
 export declare const format: (text: string, entities?: MessageEntity[], options?: Options) => {
     text: string;

package/lib/format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,eAAO,MAAM,MAAM,SACX,MAAM,aACF,aAAa,EAAE,YAChB,OAAO;;;CAyEjB,CAAC"}
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG9C,OAAO,EAAe,OAAO,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,MAAM,SACX,MAAM,aACF,aAAa,EAAE,YAChB,OAAO;;;CA2EjB,CAAC"}

package/lib/format.js

@@ -23,7 +23,8 @@ const format = (text, entities = [], options = constants_1.DEFAULT_OPTIONS) => {
     let prevLengthChange = 0;
     for (let i = 0; i < newEntities.length; i++) {
         const entity = { ...newEntities[i] };
-        const formatter = formatters[entity.type] || formatters_1.defaultFormatter;
+        const formatter = (formatters[entity.type] ||
+            formatters_1.defaultFormatter);
         const isNotInRange = entity.offset < startFrom;
         newEntities[i] = entity;
         entity.offset -= startFrom;
@@ -49,8 +50,9 @@ const format = (text, entities = [], options = constants_1.DEFAULT_OPTIONS) => {
         prevOffsetChange = offsetChange;
         prevLengthChange = formatted.before.length + formatted.after.length;
         offsetChange += formatted.before.length;
-        afterOffsetChange += formatted.after.length;
-        newText = `${beforeEntity}${formatted.text}${afterEntity}`;
+        afterOffsetChange +=
+            formatted.after.length + (formatted.text.length - entityText.length);
+        newText = `${beforeEntity}${formatted.before}${formatted.text}${formatted.after}${afterEntity}`;
         if (i === entities.length - 1) {
             entity.offset += prevOffsetChange;
             entity.length += prevLengthChange;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "telegram-transformer",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "Telegram message transformer",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -23,13 +23,13 @@
     "url": "git+ssh://git@github.com/ivanodintsov/telegram-transformer.git"
   },
   "bugs": {
-    "url": "https://github.com/ivanodintsov/telegraf/telegram-transformer"
+    "url": "https://github.com/ivanodintsov/telegram-transformer"
   },
   "files": [
     "lib/**/*"
   ],
   "dependencies": {
-    "typegram": "^4.1.1"
+    "typegram": "^5.2.0"
   },
   "devDependencies": {
     "@types/jest": "^29.2.4",

package/lib/constants.d.ts

@@ -1,3 +0,0 @@
-import { Options } from './types';
-export declare const DEFAULT_OPTIONS: Required<Options>;
-//# sourceMappingURL=constants.d.ts.map

package/lib/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,OAAO,CAG7C,CAAC"}

package/lib/constants.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_OPTIONS = void 0;
-const formatters_1 = require("./formatters");
-exports.DEFAULT_OPTIONS = {
-    formatters: formatters_1.formatters,
-    startFrom: 0,
-};

package/lib/formatters.d.ts

@@ -1,5 +0,0 @@
-import { FormatterFn, FormattersDict } from './types';
-export declare const defaultFormatter: FormatterFn;
-export declare const formatters: FormattersDict;
-export declare const htmlFormatters: FormattersDict;
-//# sourceMappingURL=formatters.d.ts.map

package/lib/formatters.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"formatters.d.ts","sourceRoot":"","sources":["../src/formatters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEtD,eAAO,MAAM,gBAAgB,EAAE,WAS9B,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,cAgBxB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,cAsH5B,CAAC"}

package/lib/formatters.js

@@ -1,137 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.htmlFormatters = exports.formatters = exports.defaultFormatter = void 0;
-const defaultFormatter = (entityText, entity, text) => {
-    const before = '';
-    const after = '';
-    return {
-        before,
-        after,
-        text: `${before}${entityText}${after}`,
-    };
-};
-exports.defaultFormatter = defaultFormatter;
-exports.formatters = {
-    mention: exports.defaultFormatter,
-    hashtag: exports.defaultFormatter,
-    cashtag: exports.defaultFormatter,
-    bot_command: exports.defaultFormatter,
-    url: exports.defaultFormatter,
-    email: exports.defaultFormatter,
-    phone_number: exports.defaultFormatter,
-    bold: exports.defaultFormatter,
-    italic: exports.defaultFormatter,
-    underline: exports.defaultFormatter,
-    strikethrough: exports.defaultFormatter,
-    spoiler: exports.defaultFormatter,
-    code: exports.defaultFormatter,
-    pre: exports.defaultFormatter,
-    text_link: exports.defaultFormatter,
-};
-exports.htmlFormatters = {
-    ...exports.formatters,
-    mention: (entityText, entity, text) => {
-        const before = `<a href='https://t.me/${entityText.substring(1)}'>`;
-        const after = '</a>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    hashtag: (entityText, entity, text) => {
-        const before = `<a href='${entityText}'>`;
-        const after = '</a>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    url: (entityText, entity, text) => {
-        const url = entityText.startsWith('http')
-            ? entityText
-            : `http://${entityText}`;
-        const before = `<a href='${url}'>`;
-        const after = '</a>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    email: (entityText, entity, text) => {
-        const before = `<a href='mailto:${entityText}'>`;
-        const after = '</a>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    phone_number: (entityText, entity, text) => {
-        const before = `<a href='tel:${entityText}'>`;
-        const after = '</a>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    spoiler: (entityText, entity, text) => {
-        const before = `<span class='spoiler-hover'>`;
-        const after = '</span>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    text_link: (entityText, entity, text) => {
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        const before = `<a href='${entity.url}'>`;
-        const after = '</a>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    bold: (entityText, entity, text) => {
-        const before = `<strong>`;
-        const after = '</strong>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    italic: (entityText, entity, text) => {
-        const before = `<i>`;
-        const after = '</i>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    underline: (entityText, entity, text) => {
-        const before = `<u>`;
-        const after = '</u>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-    strikethrough: (entityText, entity, text) => {
-        const before = `<strike>`;
-        const after = '</strike>';
-        return {
-            before,
-            after,
-            text: `${before}${entityText}${after}`,
-        };
-    },
-};

package/lib/types.d.ts

@@ -1,12 +0,0 @@
-import { MessageEntity } from 'typegram';
-export type FormatterFn = (entityText: string, entity: MessageEntity, text: string) => {
-    text: string;
-    before: string;
-    after: string;
-};
-export type FormattersDict = Record<string, FormatterFn>;
-export type Options = {
-    formatters?: FormattersDict;
-    startFrom?: number;
-};
-//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,MAAM,WAAW,GAAG,CACxB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,aAAa,EACrB,IAAI,EAAE,MAAM,KACT;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAErD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAEzD,MAAM,MAAM,OAAO,GAAG;IAAE,UAAU,CAAC,EAAE,cAAc,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/lib/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });