@xbibzlibrary/telebibz 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -1
- package/CODE_OF_CONDUCT.md +37 -0
- package/CONTRIBUTING.md +54 -0
- package/CONTRIBUTION_RULES.md +41 -0
- package/GOVERNANCE.md +47 -0
- package/NOTICE.md +7 -0
- package/README.id.md +172 -0
- package/README.md +65 -33
- package/README.zh-CN.md +172 -0
- package/RELEASE_AUTOMATION.md +66 -0
- package/RELEASE_POLICY.md +2 -2
- package/SECURITY.md +36 -4
- package/SUPPORT.md +30 -0
- package/assets/readme-preview.html +75 -0
- package/assets/telebibz-readme-preview.png +0 -0
- package/dist/src/api/index.d.ts +1 -0
- package/dist/src/api/index.d.ts.map +1 -1
- package/dist/src/api/index.js +1 -0
- package/dist/src/api/index.js.map +1 -1
- package/dist/src/api/telegram-types/LICENSE +21 -0
- package/dist/src/api/telegram-types/api.d.ts +22 -0
- package/dist/src/api/telegram-types/checklist.d.ts +72 -0
- package/dist/src/api/telegram-types/inline.d.ts +692 -0
- package/dist/src/api/telegram-types/langs.d.ts +193 -0
- package/dist/src/api/telegram-types/manage.d.ts +1144 -0
- package/dist/src/api/telegram-types/markup.d.ts +268 -0
- package/dist/src/api/telegram-types/message.d.ts +1537 -0
- package/dist/src/api/telegram-types/methods.d.ts +2870 -0
- package/dist/src/api/telegram-types/mod.d.ts +14 -0
- package/dist/src/api/telegram-types/passport.d.ts +163 -0
- package/dist/src/api/telegram-types/payment.d.ts +570 -0
- package/dist/src/api/telegram-types/rich.d.ts +1010 -0
- package/dist/src/api/telegram-types/settings.d.ts +120 -0
- package/dist/src/api/telegram-types/story.d.ts +89 -0
- package/dist/src/api/telegram-types/update.d.ts +84 -0
- package/dist/src/api/telegram.d.ts +7 -0
- package/dist/src/api/telegram.d.ts.map +1 -0
- package/dist/src/api/telegram.js +2 -0
- package/dist/src/api/telegram.js.map +1 -0
- package/dist/src/approval/approval.d.ts +8 -0
- package/dist/src/approval/approval.d.ts.map +1 -1
- package/dist/src/approval/approval.js +9 -0
- package/dist/src/approval/approval.js.map +1 -1
- package/dist/src/cache/cache.d.ts +6 -5
- package/dist/src/cache/cache.d.ts.map +1 -1
- package/dist/src/cache/cache.js +7 -3
- package/dist/src/cache/cache.js.map +1 -1
- package/dist/src/context/context.d.ts.map +1 -1
- package/dist/src/context/context.js +26 -3
- package/dist/src/context/context.js.map +1 -1
- package/dist/src/core/bot.d.ts +6 -4
- package/dist/src/core/bot.d.ts.map +1 -1
- package/dist/src/core/bot.js +48 -7
- package/dist/src/core/bot.js.map +1 -1
- package/dist/src/core/events.d.ts +4 -0
- package/dist/src/core/events.d.ts.map +1 -1
- package/dist/src/core/events.js.map +1 -1
- package/dist/src/index.d.ts +1 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +1 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/queue/queue.d.ts +25 -0
- package/dist/src/queue/queue.d.ts.map +1 -1
- package/dist/src/queue/queue.js +175 -51
- package/dist/src/queue/queue.js.map +1 -1
- package/dist/src/router/router.d.ts +8 -1
- package/dist/src/router/router.d.ts.map +1 -1
- package/dist/src/router/router.js +75 -17
- package/dist/src/router/router.js.map +1 -1
- package/dist/src/state/conversation.d.ts +6 -0
- package/dist/src/state/conversation.d.ts.map +1 -1
- package/dist/src/state/conversation.js +79 -11
- package/dist/src/state/conversation.js.map +1 -1
- package/dist/src/state/menu.d.ts +53 -5
- package/dist/src/state/menu.d.ts.map +1 -1
- package/dist/src/state/menu.js +116 -17
- package/dist/src/state/menu.js.map +1 -1
- package/dist/src/storage/storage.d.ts +115 -12
- package/dist/src/storage/storage.d.ts.map +1 -1
- package/dist/src/storage/storage.js +130 -4
- package/dist/src/storage/storage.js.map +1 -1
- package/dist/src/telegram-features.d.ts +33 -0
- package/dist/src/telegram-features.d.ts.map +1 -0
- package/dist/src/telegram-features.js +69 -0
- package/dist/src/telegram-features.js.map +1 -0
- package/dist/src/testing.d.ts +1 -0
- package/dist/src/testing.d.ts.map +1 -1
- package/dist/src/testing.js +16 -0
- package/dist/src/testing.js.map +1 -1
- package/dist-cjs/src/api/index.js +1 -0
- package/dist-cjs/src/api/telegram-types/LICENSE +21 -0
- package/dist-cjs/src/api/telegram-types/api.d.ts +22 -0
- package/dist-cjs/src/api/telegram-types/checklist.d.ts +72 -0
- package/dist-cjs/src/api/telegram-types/inline.d.ts +692 -0
- package/dist-cjs/src/api/telegram-types/langs.d.ts +193 -0
- package/dist-cjs/src/api/telegram-types/manage.d.ts +1144 -0
- package/dist-cjs/src/api/telegram-types/markup.d.ts +268 -0
- package/dist-cjs/src/api/telegram-types/message.d.ts +1537 -0
- package/dist-cjs/src/api/telegram-types/methods.d.ts +2870 -0
- package/dist-cjs/src/api/telegram-types/mod.d.ts +14 -0
- package/dist-cjs/src/api/telegram-types/passport.d.ts +163 -0
- package/dist-cjs/src/api/telegram-types/payment.d.ts +570 -0
- package/dist-cjs/src/api/telegram-types/rich.d.ts +1010 -0
- package/dist-cjs/src/api/telegram-types/settings.d.ts +120 -0
- package/dist-cjs/src/api/telegram-types/story.d.ts +89 -0
- package/dist-cjs/src/api/telegram-types/update.d.ts +84 -0
- package/dist-cjs/src/api/telegram.js +2 -0
- package/dist-cjs/src/approval/approval.js +11 -1
- package/dist-cjs/src/cache/cache.js +7 -3
- package/dist-cjs/src/context/context.js +26 -3
- package/dist-cjs/src/core/bot.js +48 -7
- package/dist-cjs/src/index.js +1 -0
- package/dist-cjs/src/queue/queue.js +177 -51
- package/dist-cjs/src/router/router.js +75 -17
- package/dist-cjs/src/state/conversation.js +79 -11
- package/dist-cjs/src/state/menu.js +118 -18
- package/dist-cjs/src/storage/storage.js +135 -5
- package/dist-cjs/src/telegram-features.js +74 -0
- package/dist-cjs/src/testing.js +17 -0
- package/docs/API.id.md +1800 -0
- package/docs/API.md +1799 -0
- package/docs/API.zh-CN.md +1794 -0
- package/docs/README.md +36 -17
- package/package.json +20 -3
package/docs/README.md
CHANGED
|
@@ -1,21 +1,40 @@
|
|
|
1
|
-
#
|
|
1
|
+
# telebibz Documentation
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The default documentation language is **English**. Translated README and API references are available below.
|
|
4
|
+
|
|
5
|
+
| Language | README | Complete API reference |
|
|
6
|
+
|---|---|---|
|
|
7
|
+
| English (default) | [`README.md`](../README.md) | [`API.md`](API.md) |
|
|
8
|
+
| Bahasa Indonesia | [`README.id.md`](../README.id.md) | [`API.id.md`](API.id.md) |
|
|
9
|
+
| 简体中文 | [`README.zh-CN.md`](../README.zh-CN.md) | [`API.zh-CN.md`](API.zh-CN.md) |
|
|
10
|
+
|
|
11
|
+

|
|
12
|
+
|
|
13
|
+
The API references are organized by lifecycle: bot startup and shutdown, API client and transport, update routing, middleware and context, state/session, interaction UI, background work, deployment, testing, and migration boundaries.
|
|
4
14
|
|
|
5
15
|
| Area | Status |
|
|
6
16
|
|---|---|
|
|
7
|
-
| Getting started |
|
|
8
|
-
|
|
|
9
|
-
|
|
|
10
|
-
|
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
17
|
+
| Getting started | Available in all three README files |
|
|
18
|
+
| Complete API reference | Available in English, Indonesian, and Simplified Chinese |
|
|
19
|
+
| Bot lifecycle, polling, webhook | Core implementation, per-update error isolation, reconnect backoff, and tests available |
|
|
20
|
+
| API client and generated method list | Available; full vendored Telegram declarations are exposed through `TelegramTypes` |
|
|
21
|
+
| Router, middleware, context | Available and tested; first-match is default, all-match is explicit |
|
|
22
|
+
| Keyboard, callback, menus, pagination | Keyboard/callback core, permission menus, MenuController, and pagination available |
|
|
23
|
+
| Sessions, conversations, wizards, forms | Storage-backed session/conversation primitives and forms available; scene orchestration remains application-owned |
|
|
24
|
+
| Storage, cache, queue, scheduler | Memory, JSON file, Redis, SQL, Mongo driver adapters, cache, queue, and full five-field cron available |
|
|
25
|
+
| Plugins, services, observability | Lifecycle/plugin/service hooks available |
|
|
26
|
+
| Mini Apps, payments, business features | Web App signature validation and PaymentsClient wrappers available; UI is application-owned |
|
|
27
|
+
| Testing and security | Unit, integration, type-level, gated E2E, CI, and security policy available |
|
|
28
|
+
| Deployment and migration | Release automation is documented in `RELEASE_AUTOMATION.md` |
|
|
29
|
+
| Governance and community | `CODE_OF_CONDUCT.md`, `GOVERNANCE.md`, `CONTRIBUTING.md`, and `CONTRIBUTION_RULES.md` |
|
|
30
|
+
| Security and support | `SECURITY.md` and `SUPPORT.md` |
|
|
31
|
+
| Third-party notices | `NOTICE.md` and `LICENSE` |
|
|
32
|
+
| GitHub contribution templates | Bug, feature, documentation, question/support, security notice, and pull request templates under `.github/` |
|
|
33
|
+
|
|
34
|
+
## GitHub templates
|
|
35
|
+
|
|
36
|
+
Issue forms are available for bug reports, feature requests, documentation problems, and support questions. A security notice template redirects reporters to the private process in `SECURITY.md`; vulnerabilities must not be disclosed in public issues. Pull requests use `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md` to require tests, documentation, compatibility, and security checks.
|
|
37
|
+
|
|
38
|
+
## Documentation principle
|
|
39
|
+
|
|
40
|
+
The documentation describes only capabilities that are implemented and tested in the current package. Telegram-native API access, Mini App/Web App behavior, external persistence, and distributed adapters are described separately so the documentation does not promise features that are not included.
|
package/package.json
CHANGED
|
@@ -1,21 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xbibzlibrary/telebibz",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Production-grade, strongly typed Telegram Bot API SDK and framework for Node.js and TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"publishConfig": {
|
|
8
8
|
"access": "public",
|
|
9
|
-
"provenance":
|
|
9
|
+
"provenance": false
|
|
10
10
|
},
|
|
11
11
|
"license": "MIT",
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "https://github.com/XbibzOfficial777/telebibz.git"
|
|
15
|
+
},
|
|
16
|
+
"homepage": "https://github.com/XbibzOfficial777/telebibz#readme",
|
|
17
|
+
"bugs": {
|
|
18
|
+
"url": "https://github.com/XbibzOfficial777/telebibz/issues"
|
|
19
|
+
},
|
|
12
20
|
"engines": {
|
|
13
21
|
"node": ">=20"
|
|
14
22
|
},
|
|
15
23
|
"scripts": {
|
|
16
24
|
"generate": "node scripts/generate-api.mjs",
|
|
17
25
|
"update:telegram": "node scripts/fetch-telegram-api.mjs && npm run generate",
|
|
18
|
-
"build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && node scripts/create-cjs-package.mjs",
|
|
26
|
+
"build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && node scripts/create-cjs-package.mjs && node scripts/copy-telegram-types.mjs",
|
|
19
27
|
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
20
28
|
"lint": "tsc -p tsconfig.json --noEmit && eslint scripts/*.mjs bin/*.mjs --no-error-on-unmatched-pattern",
|
|
21
29
|
"test": "vitest run",
|
|
@@ -62,11 +70,20 @@
|
|
|
62
70
|
"dist-cjs",
|
|
63
71
|
"bin",
|
|
64
72
|
"README.md",
|
|
73
|
+
"README.id.md",
|
|
74
|
+
"README.zh-CN.md",
|
|
65
75
|
"LICENSE",
|
|
66
76
|
"CHANGELOG.md",
|
|
67
77
|
"SECURITY.md",
|
|
78
|
+
"CODE_OF_CONDUCT.md",
|
|
79
|
+
"CONTRIBUTING.md",
|
|
80
|
+
"CONTRIBUTION_RULES.md",
|
|
81
|
+
"GOVERNANCE.md",
|
|
82
|
+
"SUPPORT.md",
|
|
83
|
+
"NOTICE.md",
|
|
68
84
|
"APPROVAL_FEATURE.md",
|
|
69
85
|
"RELEASE_POLICY.md",
|
|
86
|
+
"RELEASE_AUTOMATION.md",
|
|
70
87
|
"assets",
|
|
71
88
|
"docs"
|
|
72
89
|
],
|