Merge branch 'release/3.38.0'

Author: dotcypress

.mailmap

@@ -0,0 +1 @@
+Wojciech Pawlik <[email protected]>

.npmrc

@@ -0,0 +1 @@
+package-lock=false

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "insertPragma": true,
+  "requirePragma": true,
+  "semi": false,
+  "singleQuote": true
+}

context.js

@@ -330,6 +330,11 @@ class TelegrafContext {
     return this.telegram.kickChatMember(this.chat.id, ...args)
   }
 
+  unbanChatMember (...args) {
+    this.assert(this.chat, 'unbanChatMember')
+    return this.telegram.unbanChatMember(this.chat.id, ...args)
+  }
+
   restrictChatMember (...args) {
     this.assert(this.chat, 'restrictChatMember')
     return this.telegram.restrictChatMember(this.chat.id, ...args)

docs/README.md

@@ -8,7 +8,7 @@ These accounts serve as an interface for code running somewhere on your server.
 
 #### Features
 
-- Full [Telegram Bot API 4.7](https://core.telegram.org/bots/api) support
+- Full [Telegram Bot API 4.8](https://core.telegram.org/bots/api) support
 - [Telegram Payment Platform](https://telegram.org/blog/payments)
 - [HTML5 Games](https://core.telegram.org/bots/api#games)
 - [Inline mode](https://core.telegram.org/bots/api#inline-mode)
@@ -33,7 +33,7 @@ $ yarn add telegraf
 #### Example
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 
 const bot = new Telegraf(process.env.BOT_TOKEN)
 bot.start((ctx) => ctx.reply('Welcome'))
@@ -44,7 +44,7 @@ bot.launch()
 ```
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 
 const bot = new Telegraf(process.env.BOT_TOKEN)
 bot.command('oldschool', (ctx) => ctx.reply('Hello'))
@@ -281,6 +281,7 @@ Context shortcuts for **message** update:
 | `stopPoll`                | [`telegram.stopPoll`](#stoppoll) |
 | `unpinChatMessage`        | [`telegram.unpinChatMessage`](#unpinchatmessage) |
 | `uploadStickerFile`       | [`telegram.uploadStickerFile`](#uploadstickerfile) |
+| `unbanChatMember`         | [`telegram.unbanChatMember`](#unbanchatmember) |
 
 Context shortcuts for **callback_query** update:
 
@@ -332,6 +333,7 @@ Context shortcuts for **callback_query** update:
 | `stopPoll`                | [`telegram.stopPoll`](#stoppoll) |
 | `unpinChatMessage`        | [`telegram.unpinChatMessage`](#unpinchatmessage) |
 | `uploadStickerFile`       | [`telegram.uploadStickerFile`](#uploadstickerfile) |
+| `unbanChatMember`         | [`telegram.unbanChatMember`](#unbanchatmember) |
 
 Context shortcuts for **inline_query** update:
 
@@ -552,7 +554,7 @@ require('https')
 Express.js example integration
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 const express = require('express')
 const expressApp = express()
 
@@ -572,7 +574,7 @@ expressApp.listen(3000, () => {
 Fastify example integration
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 const fastifyApp = require('fastify')()
 
 const bot = new Telegraf(process.env.BOT_TOKEN)
@@ -591,7 +593,7 @@ fastifyApp.listen(3000, () => {
 Koa.js example integration
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 const Koa = require('koa')
 const koaBody = require('koa-body')
 
@@ -660,7 +662,7 @@ bot.on('message', (ctx) => {
 To enable Telegram Passport support you can use [`telegram-passport`](https://www.npmjs.com/package/telegram-passport) package:
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 const TelegramPassport = require('telegram-passport')
 
 const bot = new Telegraf(process.env.BOT_TOKEN)
@@ -742,7 +744,7 @@ $ telegraf -t "bot token" bot.js
 Telegraf API reference
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 ```
 
 ##### Constructor
@@ -2153,7 +2155,7 @@ Telegram markup helper, [see examples](https://github.com/telegraf/telegraf/tree
 Simple scene-based control flow middleware.
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 const session = require('telegraf/session')
 const Stage = require('telegraf/stage')
 const Scene = require('telegraf/scenes/base')

markup.js

@@ -164,15 +164,91 @@ class Markup {
   }
 
   static formatHTML (text = '', entities = []) {
-    const chars = ['', ...text.split(''), ''].map(escapeHTMLChar)
-    entities.forEach(entity => {
-      const tag = getHTMLTag(entity)
-      const openPos = entity.offset
-      const closePos = entity.offset + entity.length + 1
-      chars[openPos] += tag.open
-      chars[closePos] = tag.close + chars[closePos]
-    })
-    return chars.join('')
+    const chars = [...text]
+    const available = [...entities]
+    const opened = []
+    const result = []
+    for (let offset = 0; offset < chars.length; offset++) {
+      while (true) {
+        const index = available.findIndex((entity) => entity.offset === offset)
+        if (index === -1) {
+          break
+        }
+        const entity = available[index]
+        switch (entity.type) {
+          case 'bold':
+            result.push('<b>')
+            break
+          case 'italic':
+            result.push('<i>')
+            break
+          case 'code':
+            result.push('<code>')
+            break
+          case 'pre':
+            if (entity.language) {
+              result.push(`<pre><code class="language-${entity.language}">`)
+            } else {
+              result.push('<pre>')
+            }
+            break
+          case 'strikethrough':
+            result.push('<s>')
+            break
+          case 'underline':
+            result.push('<u>')
+            break
+          case 'text_mention':
+            result.push(`<a href="tg://user?id=${entity.user.id}">`)
+            break
+          case 'text_link':
+            result.push(`<a href="${entity.url}">`)
+            break
+        }
+        opened.unshift(entity)
+        available.splice(index, 1)
+      }
+
+      result.push(chars[offset])
+
+      while (true) {
+        const index = opened.findIndex((entity) => entity.offset + entity.length - 1 === offset)
+        if (index === -1) {
+          break
+        }
+        const entity = opened[index]
+        switch (entity.type) {
+          case 'bold':
+            result.push('</b>')
+            break
+          case 'italic':
+            result.push('</i>')
+            break
+          case 'code':
+            result.push('</code>')
+            break
+          case 'pre':
+            if (entity.language) {
+              result.push('</code></pre>')
+            } else {
+              result.push('</pre>')
+            }
+            break
+          case 'strikethrough':
+            result.push('</s>')
+            break
+          case 'underline':
+            result.push('</u>')
+            break
+          case 'text_mention':
+          case 'text_link':
+            result.push('</a>')
+            break
+        }
+        opened.splice(index, 1)
+      }
+    }
+    return result.join('')
   }
 }
 
@@ -203,40 +279,4 @@ function buildKeyboard (buttons, options) {
   return result
 }
 
-function escapeHTMLChar (c) {
-  switch (c) {
-    case '&': return '&amp;'
-    case '"': return '&quot;'
-    case '\'': return '&#39;'
-    case '<': return '&lt;'
-    default : return c
-  }
-}
-
-function tag (name, params) {
-  return {
-    open: params
-      ? `<${name} ${Object.entries(params).map(([key, value]) => `${key}="${value.replace(/[<&"]/g, escapeHTMLChar)}"`).join(' ')}>`
-      : `<${name}>`,
-    close: `</${name}>`
-  }
-}
-
-const HTMLTags = new Map([
-  ['bold', tag('b')],
-  ['italic', tag('i')],
-  ['code', tag('code')],
-  ['pre', tag('pre')],
-  ['strikethrough', tag('s')],
-  ['underline', tag('u')],
-  ['text_link', ({ url }) => tag('a', { href: url })],
-  ['text_mention', ({ user }) => tag('a', { href: `tg://user?id=${user.id}` })]
-])
-
-function getHTMLTag (entity) {
-  const tag = HTMLTags.get(entity.type || 'unknown')
-  if (!tag) return { open: '', close: '' }
-  return typeof tag === 'function' ? tag(entity) : tag
-}
-
 module.exports = Markup

package.json

@@ -1,6 +1,6 @@
 {
   "name": "telegraf",
-  "version": "3.37.0",
+  "version": "3.38.0",
   "description": "Modern Telegram Bot Framework",
   "license": "MIT",
   "author": "Vitaly Domnikov <[email protected]>",
@@ -53,6 +53,7 @@
     "eslint-plugin-promise": "^4.0.0",
     "eslint-plugin-standard": "^4.0.0",
     "husky": "^4.2.0",
+    "prettier": "^2.0.5",
     "typescript": "^3.0.1"
   },
   "keywords": [

readme.md

@@ -1,5 +1,5 @@
 ![Telegraf](docs/header.png)
-[![Bot API Version](https://img.shields.io/badge/Bot%20API-v4.7-f36caf.svg?style=flat-square)](https://core.telegram.org/bots/api)
+[![Bot API Version](https://img.shields.io/badge/Bot%20API-v4.8-f36caf.svg?style=flat-square)](https://core.telegram.org/bots/api)
 [![NPM Version](https://img.shields.io/npm/v/telegraf.svg?style=flat-square)](https://www.npmjs.com/package/telegraf)
 [![node](https://img.shields.io/node/v/telegraf.svg?style=flat-square)](https://www.npmjs.com/package/telegraf)
 [![Build Status](https://img.shields.io/travis/telegraf/telegraf.svg?branch=master&style=flat-square)](https://travis-ci.org/telegraf/telegraf)
@@ -14,7 +14,7 @@ These accounts serve as an interface for code running somewhere on your server.
 
 ### Features
 
-- Full [Telegram Bot API 4.7](https://core.telegram.org/bots/api) support
+- Full [Telegram Bot API 4.8](https://core.telegram.org/bots/api) support
 - [Telegram Payment Platform](https://telegram.org/blog/payments)
 - [HTML5 Games](https://core.telegram.org/bots/api#games)
 - [Inline mode](https://core.telegram.org/bots/api#inline-mode)
@@ -41,7 +41,7 @@ $ yarn add telegraf
 ### Examples
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 
 const bot = new Telegraf(process.env.BOT_TOKEN)
 bot.start((ctx) => ctx.reply('Welcome!'))
@@ -52,7 +52,7 @@ bot.launch()
 ```
 
 ```js
-const Telegraf = require('telegraf')
+const { Telegraf } = require('telegraf')
 
 const bot = new Telegraf(process.env.BOT_TOKEN)
 bot.command('oldschool', (ctx) => ctx.reply('Hello'))

telegraf.js

@@ -213,6 +213,7 @@ module.exports = Object.assign(Telegraf, {
   Extra,
   Markup,
   Router,
+  Telegraf,
   Telegram,
   Stage,
   BaseScene,

test/markup.js

@@ -221,3 +221,34 @@ test('should generate nested multi markup', (t) => {
   ])
   t.deepEqual(markup, '<s>strike<b>bold<u>under</u></b></s>')
 })
+
+test.only('should generate nested multi markup 2', (t) => {
+  const markup = Markup.formatHTML('×11 22 333×      ×С123456×                   ×1 22 333×', [
+    {
+      offset: 1,
+      length: 9,
+      type: 'bold'
+    },
+    {
+      offset: 1,
+      length: 9,
+      type: 'italic'
+    },
+    {
+      offset: 12,
+      length: 7,
+      type: 'italic'
+    },
+    {
+      offset: 19,
+      length: 36,
+      type: 'italic'
+    },
+    {
+      offset: 19,
+      length: 8,
+      type: 'bold'
+    }
+  ])
+  t.deepEqual(markup, '×<b><i>11 22 333</i></b>× <i>     ×С</i><i><b>123456× </b>                  ×1 22 333×</i>')
+})