telegram-transformer 1.0.0 → 1.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ivan Odyntsov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,89 @@
+<header>
+
+<h1 align="center">Telegram message transformer</h1>
+
+</header>
+
+## Introduction
+
+Telegram transformer is a library that makes it simple for you to transform telegram message to any markup.
+
+## Getting started
+
+### Installation
+
+```shellscript
+$ npm install telegram-transformer
+```
+
+or
+
+```shellscript
+$ yarn add telegram-transformer
+```
+
+### Example
+
+```js
+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';
+const entities: MessageEntity[] = [
+  { offset: 6, length: 9, type: 'mention' },
+  { offset: 16, length: 16, type: 'hashtag' },
+  { offset: 25, length: 7, type: 'bold' },
+  { offset: 33, length: 4, type: 'cashtag' },
+  { offset: 38, length: 15, type: 'bot_command' },
+  { offset: 54, length: 20, type: 'url' },
+  { offset: 75, length: 25, type: 'email' },
+  { offset: 101, length: 15, type: 'phone_number' },
+  { offset: 117, length: 9, type: 'bold' },
+  { offset: 127, length: 11, type: 'italic' },
+  { offset: 139, length: 5, type: 'underline' },
+  { offset: 144, length: 10, type: 'underline' },
+  { offset: 144, length: 5, type: 'bold' },
+  { offset: 155, length: 18, type: 'strikethrough' },
+  { offset: 174, length: 15, type: 'spoiler' },
+  {
+    offset: 223,
+    length: 9,
+    type: 'text_link',
+    url: 'https://telegram.org/',
+  },
+];
+
+const formatted = formatText(text, entities, { formatters: htmlFormatters });
+
+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>",
+  entities: [
+    { offset: 6, length: 45, type: 'mention' },
+    { offset: 16, length: 16, type: 'hashtag' },
+    { offset: 88, length: 24, type: 'bold' },
+    { offset: 117, length: 4, type: 'cashtag' },
+    { offset: 122, length: 15, type: 'bot_command' },
+    { offset: 138, length: 55, type: 'url' },
+    { offset: 194, length: 72, type: 'email' },
+    { offset: 267, length: 49, type: 'phone_number' },
+    { offset: 317, length: 26, type: 'bold' },
+    { offset: 344, length: 18, type: 'italic' },
+    { offset: 363, length: 12, type: 'underline' },
+    { offset: 144, length: 10, type: 'underline' },
+    { offset: 378, length: 22, type: 'bold' },
+    { offset: 410, length: 35, type: 'strikethrough' },
+    { offset: 446, length: 50, type: 'spoiler' },
+    {
+      offset: 530,
+      length: 45,
+      type: 'text_link',
+      url: 'https://telegram.org/'
+    }
+  ]
+}
+*/
+```

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;;;CA8DjB,CAAC"}
+{"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"}

package/lib/format.js

@@ -17,8 +17,10 @@ const format = (text, entities = [], options = constants_1.DEFAULT_OPTIONS) => {
     };
     const startFrom = options.startFrom || constants_1.DEFAULT_OPTIONS.startFrom;
     let newText = text;
+    let offsetChange = 0;
+    let afterOffsetChange = 0;
     let prevOffsetChange = 0;
-    let prevAfterChange = 0;
+    let prevLengthChange = 0;
     for (let i = 0; i < newEntities.length; i++) {
         const entity = { ...newEntities[i] };
         const formatter = formatters[entity.type] || formatters_1.defaultFormatter;
@@ -28,23 +30,31 @@ const format = (text, entities = [], options = constants_1.DEFAULT_OPTIONS) => {
         if (isNotInRange) {
             continue;
         }
-        let newOffset = entity.offset + prevOffsetChange;
+        let newOffset = entity.offset + offsetChange;
         let newOffsetWithLength = newOffset + entity.length;
         const prevEntity = newEntities[i - 1];
-        if (prevEntity && newOffset >= prevEntity.offset + prevEntity.length) {
-            prevOffsetChange += prevAfterChange;
-            prevAfterChange = 0;
+        if (prevEntity &&
+            newOffset >= (prevEntity === null || prevEntity === void 0 ? void 0 : prevEntity.offset) + offsetChange + (prevEntity === null || prevEntity === void 0 ? void 0 : prevEntity.length)) {
+            prevEntity.offset += prevOffsetChange;
+            prevEntity.length += prevLengthChange;
+            offsetChange += afterOffsetChange;
+            afterOffsetChange = 0;
+            newOffset = entity.offset + offsetChange;
+            newOffsetWithLength = newOffset + entity.length;
         }
-        newOffset = entity.offset + prevOffsetChange;
-        newOffsetWithLength = newOffset + entity.length;
         const beforeEntity = newText.substring(0, newOffset);
         const entityText = newText.substring(newOffset, newOffsetWithLength);
         const afterEntity = newText.substring(newOffsetWithLength, newText.length);
         const formatted = formatter(entityText, entity, text);
-        prevOffsetChange += formatted.before.length;
-        prevAfterChange += formatted.after.length;
-        entity.offset = newOffset;
+        prevOffsetChange = offsetChange;
+        prevLengthChange = formatted.before.length + formatted.after.length;
+        offsetChange += formatted.before.length;
+        afterOffsetChange += formatted.after.length;
         newText = `${beforeEntity}${formatted.text}${afterEntity}`;
+        if (i === entities.length - 1) {
+            entity.offset += prevOffsetChange;
+            entity.length += prevLengthChange;
+        }
     }
     return {
         text: newText,

package/lib/formatters.d.ts

@@ -1,4 +1,5 @@
 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 +1 @@
-{"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"}
+{"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,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatters = exports.defaultFormatter = void 0;
+exports.htmlFormatters = exports.formatters = exports.defaultFormatter = void 0;
 const defaultFormatter = (entityText, entity, text) => {
     const before = '';
     const after = '';
@@ -28,3 +28,110 @@ exports.formatters = {
     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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "telegram-transformer",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Telegram message transformer",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",