@xbibzlibrary/telebibz 3.1.2 → 3.1.3

package/test/audit.test.js

@@ -0,0 +1,320 @@
+'use strict';
+
+const assert = require('node:assert/strict');
+const http = require('node:http');
+const os = require('node:os');
+const path = require('node:path');
+const fs = require('node:fs/promises');
+const { Readable } = require('node:stream');
+const { TeleBibz, File } = require('..');
+const { Composer, BotError } = require('../lib/composer');
+const { pollLoop } = require('../lib/runner');
+const { createTransport, ApiError } = require('../lib/net');
+const { makeApi } = require('../lib/api');
+
+const checks = [];
+async function test(name, fn) {
+  await fn();
+  checks.push(name);
+  console.log(`  ✓ audit: ${name}`);
+}
+
+async function main() {
+  await test('errorBoundary benar-benar membungkus handler dan memberi BotError + ctx', async () => {
+    const root = new Composer();
+    let received;
+    root.errorBoundary((err) => { received = err; }, async () => { throw new Error('boom'); });
+    const ctx = { update: {} };
+    await root.run(ctx);
+    assert.ok(received instanceof BotError);
+    assert.equal(received.message, 'boom');
+    assert.equal(received.ctx, ctx);
+  });
+
+  await test('regex global di hears/callback tidak kehilangan match berturut-turut', async () => {
+    const bot = new TeleBibz('123456:TESTTOKEN', { silent: true, transport: async () => true });
+    let textHits = 0;
+    bot.hears(/ping/g, () => { textHits++; });
+    const msg = (text) => ({ message: { text, chat: { id: 1, type: 'private' }, from: { id: 1 } } });
+    await bot.handleUpdate(msg('ping')); await bot.handleUpdate(msg('ping'));
+    assert.equal(textHits, 2);
+    let callbackHits = 0;
+    bot.action(/go/g, () => { callbackHits++; });
+    const cb = () => ({ callback_query: { id: 'q', data: 'go', from: { id: 1 }, message: { message_id: 1, chat: { id: 1 } } } });
+    await bot.handleUpdate(cb()); await bot.handleUpdate(cb());
+    assert.equal(callbackHits, 2);
+    const { matchInlineQuery } = require('../lib/inline-query');
+    const inlineMatcher = matchInlineQuery(/cat/g);
+    assert.equal(inlineMatcher({ inline_query: { query: 'cat' } }), true);
+    assert.equal(inlineMatcher({ inline_query: { query: 'cat' } }), true);
+  });
+
+  await test('Composer route/lazy/fork meneruskan middleware dan fork tidak memblokir', async () => {
+    const c = new Composer();
+    const order = [];
+    c.route((ctx) => ctx.kind, { private: async (_ctx, next) => { order.push('route'); await next(); } });
+    c.lazy(async () => async (_ctx, next) => { order.push('lazy'); await next(); });
+    c.fork(async () => { await new Promise((r) => setTimeout(r, 5)); order.push('fork'); });
+    await c.run({ kind: 'private' });
+    assert.deepEqual(order, ['route', 'lazy']);
+    await new Promise((r) => setTimeout(r, 15));
+    assert.deepEqual(order, ['route', 'lazy', 'fork']);
+  });
+
+  await test('session adapter hasil deserialize ditulis ulang setelah update', async () => {
+    const data = new Map();
+    const storage = {
+      read: async (key) => data.has(key) ? structuredClone(data.get(key)) : undefined,
+      write: async (key, val) => data.set(key, structuredClone(val)),
+      delete: async (key) => data.delete(key),
+    };
+    const bot = new TeleBibz('123456:TESTTOKEN', { silent: true, transport: async () => true, session: { storage } });
+    let observed = [];
+    bot.on(':text', (ctx) => { observed.push(ctx.session.count || 0); ctx.session.count = (ctx.session.count || 0) + 1; });
+    const update = (text) => ({ message: { text, from: { id: 7 }, chat: { id: 7, type: 'private' } } });
+    await bot.handleUpdate(update('first')); await bot.handleUpdate(update('second'));
+    assert.deepEqual(observed, [0, 1]);
+    assert.equal(data.get('7:7').count, 2);
+  });
+
+  await test('guest_message diteruskan ke Context dan answerGuestQuery membentuk payload resmi', async () => {
+    const calls = [];
+    const bot = new TeleBibz('123456:TESTTOKEN', { silent: true, transport: async (m, p) => { calls.push({ m, p }); return true; } });
+    let seen;
+    bot.on('guest_message:text', async (ctx) => {
+      seen = { text: ctx.msg.text, chat: ctx.chat.id, query: ctx.guestQueryId };
+      await ctx.answerGuestQuery({ type: 'article', id: '1', title: 'Balasan', input_message_content: { message_text: 'Hai' } });
+    });
+    await bot.handleUpdate({ guest_message: { guest_query_id: 'guest-1', text: 'halo', chat: { id: 22, type: 'private' }, from: { id: 9 } } });
+    assert.deepEqual(seen, { text: 'halo', chat: 22, query: 'guest-1' });
+    assert.deepEqual(calls[0], { m: 'answerGuestQuery', p: { guest_query_id: 'guest-1', result: { type: 'article', id: '1', title: 'Balasan', input_message_content: { message_text: 'Hai' } } } });
+  });
+
+  await test('business voice reply dan callback reaction membawa konteks yang benar', async () => {
+    const calls = [];
+    const bot = new TeleBibz('123456:TESTTOKEN', { silent: true, transport: async (m, p) => { calls.push({ m, p }); return true; } });
+    bot.on('business_message', (ctx) => ctx.replyWithVoice('voice-id'));
+    await bot.handleUpdate({ business_message: { business_connection_id: 'biz-1', message_id: 8, from: { id: 3 }, chat: { id: 55, type: 'private' } } });
+    bot.action('react', (ctx) => ctx.react('🔥'));
+    await bot.handleUpdate({ callback_query: { id: 'cb', data: 'react', from: { id: 3 }, message: { message_id: 12, chat: { id: 56, type: 'private' } } } });
+    const voice = calls.find((c) => c.m === 'sendVoice');
+    const reaction = calls.find((c) => c.m === 'setMessageReaction');
+    assert.equal(voice.p.business_connection_id, 'biz-1');
+    assert.equal(reaction.p.chat_id, 56);
+    assert.equal(reaction.p.message_id, 12);
+  });
+
+  await test('Bot API 10.3 seluruh tipe Update diminta saat polling default', async () => {
+    let bot;
+    let captured;
+    const transport = async (method, payload) => {
+      if (method === 'getMe') return { id: 1, is_bot: true, username: 'auditbot' };
+      if (method === 'getUpdates') { captured = payload.allowed_updates; bot.stop(); return []; }
+      return true;
+    };
+    bot = new TeleBibz('123456:TESTTOKEN', { silent: true, transport });
+    await bot.launch({ noSignalHandlers: true });
+    await bot.runPromise;
+    for (const field of [
+      'channel_post', 'edited_channel_post', 'deleted_business_messages', 'guest_message',
+      'chat_boost', 'removed_chat_boost', 'stopped_message_generation', 'purchased_paid_media',
+    ]) assert.ok(captured.includes(field), `allowed_updates hilang: ${field}`);
+    assert.equal(new Set(captured).size, captured.length, 'allowed_updates berisi duplikat');
+  });
+
+  await test('poller retry ECONNRESET dan 429 sesuai retry_after tanpa fatal stop', async () => {
+    let calls = 0, stopped = false, fatals = 0;
+    const api = { callApi: async () => {
+      calls++;
+      if (calls === 1) { const e = new Error('socket reset'); e.code = 'ECONNRESET'; e.network = true; throw e; }
+      if (calls === 2) { const e = new Error('Too Many Requests'); e.error_code = 429; e.parameters = { retry_after: 0 }; throw e; }
+      stopped = true; return [];
+    } };
+    await pollLoop({ api, handleUpdate: async () => {}, allowedUpdates: [], dropPending: false, shouldStop: () => stopped, onFatal: () => fatals++ });
+    assert.equal(calls, 3);
+    assert.equal(fatals, 0);
+  });
+
+  await test('throttler tetap menjalankan antrean setelah satu request gagal', async () => {
+    const { throttler } = require('../lib/ratelimit');
+    const calls = [];
+    const run = throttler({ perSecond: 10000 });
+    const prev = async (_method, payload) => { calls.push(payload.id); if (payload.id === 1) throw new Error('one-off'); return payload.id; };
+    const settled = await Promise.allSettled([run(prev, 'a', { id: 1 }), run(prev, 'b', { id: 2 })]);
+    assert.equal(settled[0].status, 'rejected');
+    assert.equal(settled[1].status, 'fulfilled');
+    assert.deepEqual(calls, [1, 2]);
+  });
+
+  await test('transport lokal memvalidasi JSON, multipart attach://, dan ApiError', async () => {
+    const received = [];
+    const server = http.createServer((req, res) => {
+      const chunks = [];
+      req.on('data', (c) => chunks.push(c));
+      req.on('end', () => {
+        const body = Buffer.concat(chunks).toString();
+        received.push({ url: req.url, type: req.headers['content-type'], body });
+        if (req.url.endsWith('/bad')) {
+          res.writeHead(400, { 'content-type': 'application/json' });
+          res.end(JSON.stringify({ ok: false, error_code: 400, description: 'bad payload', parameters: { retry_after: 2 } }));
+        } else {
+          res.writeHead(200, { 'content-type': 'application/json' });
+          res.end(JSON.stringify({ ok: true, result: { accepted: true } }));
+        }
+      });
+    });
+    await new Promise((resolve) => server.listen(0, '127.0.0.1', resolve));
+    const root = `http://127.0.0.1:${server.address().port}`;
+    try {
+      const transport = createTransport('123456:TESTTOKEN', { apiRoot: root });
+      assert.deepEqual(await transport('sendMessage', { chat_id: 1, text: 'hi' }), { accepted: true });
+      assert.match(received[0].type, /application\/json/);
+      assert.deepEqual(JSON.parse(received[0].body), { chat_id: 1, text: 'hi' });
+      await transport('sendMediaGroup', { chat_id: 1, media: [{ type: 'photo', media: new File(Buffer.from('pic'), 'pic.jpg') }] });
+      assert.match(received[1].type, /multipart\/form-data; boundary=/);
+      assert.match(received[1].body, /attach:\/\/file0/);
+      const { rich, InputMediaBuilder } = require('..');
+      await transport('sendRichMessage', {
+        chat_id: 1,
+        rich_message: rich.blocks([rich.photo(InputMediaBuilder.photo(new File(Buffer.from('rich-image'), 'rich.jpg')))]),
+      });
+      assert.match(received[2].body, /attach:\/\/file0/);
+      assert.match(received[2].body, /rich_message/);
+      const bot = new TeleBibz('123456:TESTTOKEN', { silent: true, apiRoot: root });
+      assert.deepEqual(await bot.init(), { accepted: true });
+      assert.ok(received.some((r) => r.url === '/bot123456:TESTTOKEN/getMe'));
+      await assert.rejects(transport('bad', {}), (e) => e instanceof ApiError && e.error_code === 400 && e.method === 'bad' && e.parameters.retry_after === 2);
+    } finally {
+      await new Promise((resolve) => server.close(resolve));
+    }
+  });
+
+  await test('webhook memverifikasi secret token Telegram dan membatasi ukuran request', async () => {
+    const bot = new TeleBibz('123456:TESTTOKEN', { silent: true, transport: async () => true });
+    let hits = 0;
+    bot.on(':text', () => { hits++; });
+    assert.throws(() => bot.webhook({ secretToken: '' }), /secretToken/);
+    const handler = bot.webhook({ secretToken: 'secret-123', maxBodyBytes: 200 });
+    const invoke = async (body, headers = {}, method = 'POST') => {
+      const req = Readable.from([body]); req.headers = headers; req.method = method;
+      let status = 0;
+      const res = { set statusCode(v) { status = v; }, setHeader() {}, end() {} };
+      await handler(req, res); return status;
+    };
+    const update = JSON.stringify({ message: { text: 'secure', from: { id: 1 }, chat: { id: 1, type: 'private' } } });
+    assert.equal(await invoke(update), 401);
+    assert.equal(await invoke(update, { 'x-telegram-bot-api-secret-token': 'secret-123' }), 200);
+    assert.equal(await invoke('x'.repeat(201), { 'x-telegram-bot-api-secret-token': 'secret-123' }), 413);
+    assert.equal(hits, 1);
+  });
+
+  await test('File input Buffer, Uint8Array, path, dan async stream', async () => {
+    const tmp = path.join(os.tmpdir(), `telebibz-${process.pid}.bin`);
+    await fs.writeFile(tmp, 'path-data');
+    try {
+      assert.equal((await new File(Buffer.from('buf')).data()).toString(), 'buf');
+      assert.equal((await new File(new Uint8Array([65, 66])).data()).toString(), 'AB');
+      assert.equal((await new File(tmp).data()).toString(), 'path-data');
+      assert.equal((await new File(Readable.from(['stream-'])).data()).toString(), 'stream-');
+    } finally { await fs.rm(tmp, { force: true }); }
+  });
+
+  await test('downloadFile menghormati apiRoot khusus dan menulis stream dengan benar', async () => {
+    const dest = path.join(os.tmpdir(), `telebibz-download-${process.pid}.txt`);
+    let requestedUrl;
+    const api = makeApi('123456:TESTTOKEN', async (method) => method === 'getFile' ? { file_path: 'files/a.txt' } : true, { apiRoot: 'https://api.example.test' });
+    try {
+      await api.downloadFile('file-id', dest, { adapter: async (config) => {
+        requestedUrl = config.url;
+        return { data: Readable.from(['downloaded']), status: 200, statusText: 'OK', headers: {}, config };
+      } });
+      assert.equal(requestedUrl, 'https://api.example.test/file/bot123456:TESTTOKEN/files/a.txt');
+      assert.equal(await fs.readFile(dest, 'utf8'), 'downloaded');
+    } finally { await fs.rm(dest, { force: true }); }
+  });
+
+  await test('Proxy API current Bot API accepts modern methods via payload object', async () => {
+    const calls = [];
+    const api = makeApi('123456:TESTTOKEN', async (m, p) => { calls.push({ m, p }); return true; });
+    await api.sendRichMessage({ chat_id: 1, rich_message: { blocks: [] }, ephemeral_message_parameters: {} });
+    await api.sendLivePhoto({ chat_id: 1, live_photo: 'live-id', photo: 'photo-id' });
+    await api.sendMessageDraft({ chat_id: 1, draft_id: 1, text: 'partial', can_stop: true });
+    assert.equal(api.then, undefined, 'Proxy jangan berubah menjadi thenable');
+    assert.equal(await api, api, 'await api tidak boleh mengirim request semu');
+    assert.deepEqual(calls.map((c) => c.m), ['sendRichMessage', 'sendLivePhoto', 'sendMessageDraft']);
+    assert.equal(calls[0].p.ephemeral_message_parameters !== undefined, true);
+    assert.equal(calls[2].p.can_stop, true);
+  });
+
+  await test('Rich Message builder mencakup format, nested blocks, style dan validasi eksklusif', () => {
+    const { rich, RichMessageBuilder, inputRichMessage, InputMediaBuilder, InputPaidMediaBuilder } = require('..');
+    const message = rich.blocks([
+      rich.heading('Ringkasan', 2),
+      rich.paragraph(['Halo ', rich.bold('dunia'), ' ', rich.customEmoji('emoji-1', '✨')]),
+      rich.list(['item satu', { blocks: [rich.code('x=1')], has_checkbox: true }]),
+      rich.table([[{ text: 'A', align: 'left', valign: 'middle' }]], { compact: true, striped: true }),
+      rich.details('Info', [rich.paragraph('Isi')], true),
+      rich.buttons([rich.button('OK', { callback_data: 'ok' }, 'success')], 'center'),
+    ]);
+    assert.equal(message.blocks[0].type, 'heading');
+    assert.deepEqual(message.blocks[1].text[1], { type: 'bold', text: 'dunia' });
+    assert.equal(message.blocks[2].items[0].blocks[0].text, 'item satu');
+    assert.equal(message.blocks[3].is_compact, true);
+    assert.equal(message.blocks[4].is_open, true);
+    assert.equal(message.blocks[5].buttons[0].button.callback_data, 'ok');
+    assert.deepEqual(new RichMessageBuilder().add(rich.paragraph('ok')).rtl().build(), { blocks: [{ type: 'paragraph', text: 'ok' }], is_rtl: true });
+    assert.deepEqual(new RichMessageBuilder().markdown('draft').buildDraft(), { markdown: 'draft' });
+    assert.deepEqual(rich.draftBlocks([rich.paragraph('partial'), rich.thinking('working')]), { blocks: [{ type: 'paragraph', text: 'partial' }, { type: 'thinking', text: 'working' }] });
+    assert.throws(() => rich.draftBlocks([rich.photo(InputMediaBuilder.photo(new File(Buffer.from('not allowed'), 'upload.jpg')))]), /tidak mendukung upload/);
+    assert.throws(() => inputRichMessage({ html: 'x', markdown: 'y' }), /tepat satu/);
+    assert.throws(() => rich.heading('bad', 7), /1–6/);
+    assert.throws(() => rich.button('Link', { url: 'https://example.com' }, 'link'), /callback button/);
+    assert.throws(() => rich.buttons([], 'justify'), /align/);
+    assert.deepEqual(InputMediaBuilder.livePhoto('video', 'photo'), { type: 'live_photo', media: 'video', photo: 'photo' });
+    assert.deepEqual(InputPaidMediaBuilder.livePhoto('video', 'photo'), { type: 'live_photo', media: 'video', photo: 'photo' });
+  });
+
+  await test('Context memetakan rich send/edit, live photo, ephemeral dan draft ke payload Bot API', async () => {
+    const { rich } = require('..');
+    const calls = [];
+    const bot = new TeleBibz('123456:TESTTOKEN', { silent: true, transport: async (m, p) => { calls.push({ m, p }); return { message_id: 19 }; } });
+    bot.cmd('features', async (ctx) => {
+      const body = rich.markdown('**Rich**');
+      await ctx.replyWithRichMessage(body, { message_thread_id: 7 });
+      await ctx.replyWithLivePhoto('video-id', 'photo-id', { caption: 'Moment' });
+      await ctx.replyEphemeral('Only you', ctx.from.id, { ephemeral_message_parameters: { callback_query_id: 'q' } });
+      await ctx.sendMessageDraft(3, 'Draft', { can_stop: true });
+      await ctx.sendRichMessageDraft(4, rich.blocks([rich.thinking('Thinking')]), { can_stop: true });
+      await ctx.editRichMessage(body);
+    });
+    await bot.handleUpdate({ message: { message_id: 8, text: '/features', from: { id: 77 }, chat: { id: 77, type: 'private' } } });
+    const payload = (method) => calls.find((c) => c.m === method).p;
+    assert.deepEqual(payload('sendRichMessage').rich_message, rich.markdown('**Rich**'));
+    assert.equal(payload('sendRichMessage').message_thread_id, 7);
+    assert.equal(payload('sendLivePhoto').live_photo, 'video-id');
+    assert.deepEqual(payload('sendMessage').ephemeral_message_parameters, { callback_query_id: 'q', receiver_user_id: 77 });
+    assert.equal(payload('sendMessageDraft').can_stop, true);
+    assert.equal(payload('sendRichMessageDraft').draft_id, 4);
+    assert.equal(payload('editMessageText').rich_message.markdown, '**Rich**');
+  });
+
+  await test('Seluruh 185 nama metode Bot API 10.3 lewat jalur callApi generic', async () => {
+    const { TELEGRAM_API_METHODS } = require('..');
+    const calls = [];
+    const api = makeApi('123456:TESTTOKEN', async (method, payload) => { calls.push([method, payload]); return true; });
+    assert.equal(TELEGRAM_API_METHODS.length, 185);
+    assert.equal(new Set(TELEGRAM_API_METHODS).size, TELEGRAM_API_METHODS.length, 'registry tidak boleh berisi duplikat');
+    const methodTypes = await fs.readFile(path.join(__dirname, '../types/telegram-bot-api/methods.d.ts'), 'utf8');
+    const declaredMethods = [...methodTypes.matchAll(/^ {4}([A-Za-z0-9_]+)\(/gm)].map((match) => match[1]);
+    assert.deepEqual([...TELEGRAM_API_METHODS].sort(), declaredMethods.sort(), 'registry runtime harus sinkron dengan schema method TypeScript vendored');
+    await Promise.all(TELEGRAM_API_METHODS.map((method) => api.callApi(method, {})));
+    assert.deepEqual(calls.map(([method]) => method).sort(), [...TELEGRAM_API_METHODS].sort());
+    for (const method of ['sendRichMessage', 'sendRichMessageDraft', 'editEphemeralMessageText', 'answerGuestQuery', 'setManagedBotAccessSettings']) {
+      assert.ok(TELEGRAM_API_METHODS.includes(method), `${method} belum terdaftar`);
+    }
+  });
+
+  console.log(`\n${checks.length}/${checks.length} audit checks passed`);
+}
+
+main().catch((err) => { console.error(err.stack || err); process.exitCode = 1; });

package/test/types.test.ts

@@ -0,0 +1,40 @@
+import { TeleBibz, rich, type TelegramMethodName, type TelegramMethodPayload, TelegramTypes } from '..';
+
+const bot = new TeleBibz('123456:TESTTOKEN', { silent: true });
+const message = rich.blocks([
+  rich.heading('Typed rich content', 2),
+  rich.paragraph(['Status: ', rich.bold('ready')]),
+  rich.table([[{ text: 'Count', align: 'right', valign: 'middle' }]]),
+]);
+
+bot.api.callApi('sendRichMessage', { chat_id: 42, rich_message: message });
+bot.api.callApi('sendMessageDraft', { chat_id: 42, draft_id: 1, text: 'Draft', can_stop: true });
+bot.api.callApi('sendLivePhoto', { chat_id: 42, live_photo: 'video-id', photo: 'photo-id' });
+
+const method: TelegramMethodName = 'answerGuestQuery';
+const payload: TelegramMethodPayload<'answerGuestQuery'> = {
+  guest_query_id: 'guest-query-id',
+  result: { type: 'article', id: '1', title: 'Answer', input_message_content: { message_text: 'Hello' } },
+};
+void method;
+void payload;
+const draft: TelegramTypes.InputRichMessage<never> = rich.draftMarkdown('**streamed text**');
+const blockDraft = rich.draftBlocks([rich.paragraph('partial'), rich.thinking('working')]);
+bot.on('message', (ctx) => {
+  void ctx.sendRichMessageDraft(2, draft);
+  void ctx.sendRichMessageDraft(4, blockDraft);
+});
+
+// A normal rich message can contain media uploads; drafts have the stricter, no-upload schema.
+// @ts-expect-error regular rich builder type may include uploadable media, so it is not a draft payload.
+void bot.on('message', (ctx) => ctx.sendRichMessageDraft(3, rich.markdown('draft')));
+
+type RichBlock = TelegramTypes.InputRichBlock<string>;
+const block: RichBlock = { type: 'paragraph', text: 'Typed by the vendored Telegram API schema' };
+void block;
+
+// Invalid parameters must remain rejected by method-specific TypeScript typing.
+// @ts-expect-error sendRichMessage requires chat_id and rich_message, not text.
+bot.api.callApi('sendRichMessage', { chat_id: 42, text: 'not a rich message' });
+// @ts-expect-error method name must exist in the official Bot API method schema.
+bot.api.callApi('sendNotARealMethod', {});

package/types/telegram-bot-api/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2024 KnorpelSenf
+
+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/types/telegram-bot-api/api.d.ts

@@ -0,0 +1,22 @@
+export interface ApiError {
+    ok: false;
+    error_code: number;
+    description: string;
+    parameters?: ResponseParameters;
+}
+export interface ApiSuccess<T> {
+    ok: true;
+    result: T;
+}
+/** The response contains an object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals False and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.
+
+- All methods in the Bot API are case-insensitive.
+- All queries must be made using UTF-8. */
+export type ApiResponse<T> = ApiError | ApiSuccess<T>;
+/** Describes why a request was unsuccessful. */
+export interface ResponseParameters {
+    /** The group has been migrated to a supergroup with the specified identifier. */
+    migrate_to_chat_id?: number;
+    /** In case of exceeding flood control, the number of seconds left to wait before the request can be repeated */
+    retry_after?: number;
+}

package/types/telegram-bot-api/checklist.d.ts

@@ -0,0 +1,72 @@
+import type { Chat, User } from "./manage.js";
+import type { Message, MessageEntity, ParseMode } from "./message.js";
+/** Describes a task in a checklist. */
+export interface ChecklistTask {
+    /** Unique identifier of the task */
+    id: number;
+    /** Text of the task */
+    text: string;
+    /** Special entities that appear in the task text */
+    text_entities?: MessageEntity[];
+    /** User that completed the task; omitted if the task wasn't completed by a user */
+    completed_by_user?: User;
+    /** Chat that completed the task; omitted if the task wasn't completed by a chat */
+    completed_by_chat?: Chat;
+    /** Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed */
+    completion_date?: number;
+}
+/** Describes a checklist. */
+export interface Checklist {
+    /** Title of the checklist */
+    title: string;
+    /** Special entities that appear in the checklist title */
+    title_entities?: MessageEntity[];
+    /** List of tasks in the checklist */
+    tasks: ChecklistTask[];
+    /** True, if users other than the creator of the list can add tasks to the list */
+    others_can_add_tasks?: true;
+    /** True, if users other than the creator of the list can mark tasks as done or not done */
+    others_can_mark_tasks_as_done?: true;
+}
+/** Describes a task to add to a checklist. */
+export interface InputChecklistTask {
+    /** Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist */
+    id: number;
+    /** Text of the task; 1-100 characters after entities parsing */
+    text: string;
+    /** Mode for parsing entities in the text. See formatting options for more details. */
+    parse_mode?: ParseMode;
+    /** List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed. */
+    text_entities?: MessageEntity[];
+}
+/** Describes a checklist to create. */
+export interface InputChecklist {
+    /** Title of the checklist; 1-255 characters after entities parsing */
+    title: string;
+    /** Mode for parsing entities in the title. See formatting options for more details. */
+    parse_mode?: ParseMode;
+    /** List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed. */
+    title_entities?: MessageEntity[];
+    /** List of 1-30 tasks in the checklist */
+    tasks: InputChecklistTask[];
+    /** Pass True if other users can add tasks to the checklist */
+    others_can_add_tasks?: boolean;
+    /** Pass True if other users can mark tasks as done or not done in the checklist */
+    others_can_mark_tasks_as_done?: boolean;
+}
+/** Describes a service message about checklist tasks marked as done or not done. */
+export interface ChecklistTasksDone {
+    /** Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. */
+    checklist_message?: Message;
+    /** Identifiers of the tasks that were marked as done */
+    marked_as_done_task_ids?: number[];
+    /** Identifiers of the tasks that were marked as not done */
+    marked_as_not_done_task_ids?: number[];
+}
+/** Describes a service message about tasks added to a checklist. */
+export interface ChecklistTasksAdded {
+    /** Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. */
+    checklist_message?: Message;
+    /** List of tasks added to the checklist */
+    tasks: ChecklistTask[];
+}