Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4.9.0: Support for API 6.1 + 6.2 #1671

Merged
merged 26 commits into from Aug 26, 2022
Merged

4.9.0: Support for API 6.1 + 6.2 #1671

merged 26 commits into from Aug 26, 2022

Conversation

MKRhere
Copy link
Member

@MKRhere MKRhere commented Aug 15, 2022

This PR implements API 6.1 and 6.2 support. And a bunch of other things. With @\Knorpelsenf temporarily unavailable, I'm using a typegram fork for API 6.2.

Examples from docs/examples have been modernised, updated to TS & ESM, and moved to https://github.com/feathers-studio/telegraf-docs where I'm working on a ground-up rewrite of Telegraf docs. The current website generated by typedoc will stay until new docs are ready.

Release notes with full list of changes here: https://github.com/telegraf/telegraf/blob/feat-api-6.2/release-notes/4.9.0.md

Install with npm install telegraf@canary to test these changes!

hypernova7 and others added 5 commits July 27, 2022 19:12
✨ New

  * Added `createInvoiceLink` method
  * Added `secretToken` option for webhook config
  * Improve `cb` option for webhook config, for better integration with http frameworks, like: fastify, express, etc.
  * Added an auto-filter that only handles webhook requests that match the `X-Telegram-Bot-Api-Secret-Token` header when `secretToken` is set
    Note: You can add a manual filter using `cb` option

    Basic example:
    bot.launch({
      webhook: {
        port: +process.env.PORT,
        domain: 'yourdomain.com',
        secretToken: 'my_secret_token',
        cb: webhookHandler => {
          return (req, res) => {
            if (req.headers['x-telegram-bot-api-secret-token'] === 'my_secret_token') {
              webhookHabdler(req, res)
              return res.end()
            }
          }
        }
      }
    })

    Example using Express:
    bot.launch({
      webhook: {
        port: +process.env.PORT,
        domain: 'yourdomain.com',
        secretToken: 'my_secret_token',
        cb: webhookHandler => {
          return app.use((req, res) => {
            if (req.headers['x-telegram-bot-api-secret-token'] === 'my_secret_token') {
              webhookHabdler(req, res)
              return res.end()
            }
          })
        }
      }
    })
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
* simplify launch()
* setWebhook->createWebhook
* common behaviour b/w launch and createWebhook

Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Bind to `{ hookPath, secretToken }` so custom impls don't need to double wrap

Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
wojpawlik and others added 2 commits August 18, 2022 16:16
One clousure and one private method less
Remove `Telegraf::handleUpdates`
New features:
* Written in TypeScript
* Supports ESM modules
* Call API methods from the CLI using --method (-m) and --data (-D)

Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
@MKRhere MKRhere marked this pull request as ready for review August 24, 2022 12:57
@MKRhere MKRhere changed the title Support for API 6.1 + 6.2 4.9.0: Support for API 6.1 + 6.2 Aug 24, 2022
Also: newReplies from telegraf/future to enable actual replies
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Copy link
Member

@wojpawlik wojpawlik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Contact @dotcypress to transfer the docs repo to Telegraf org

.gitignore Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
Signed-off-by: Muthu Kumar <muthukumar@thefeathers.in>
@MKRhere MKRhere merged commit 0a114c6 into v4 Aug 26, 2022
@MKRhere MKRhere deleted the feat-api-6.2 branch August 26, 2022 06:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants