@volter/twin-telegram 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,53 @@
+# @volter/twin-telegram
+
+The Telegram Bot API twin (Protocol 3). Its surface is the Bot API page written as OpenAPI (`spec/`, provenance in
+`spec/SOURCE.md`); what it serves and why is its manifest, its decision table (`journeys/decisions.json`) and its
+semantics.
+
+## What it serves, and for whom
+
+The calls the demand's applications make (`journeys/demand.json`): Volter Harness's Telegram channel (the Chat SDK's
+`@chat-adapter/telegram`, polling) and Postiz's Telegram provider (`node-telegram-bot-api`).
+
+- A bot reads itself (`getMe`), removes its webhook (`deleteWebhook`) and polls for its updates (`getUpdates`: offset,
+  limit, allowed_updates, and a timeout that holds the request until an update arrives, a long poll).
+- It shows it is typing (`sendChatAction`), sends text (`sendMessage`: plain, HTML, MarkdownV2 or the legacy Markdown,
+  parsed as the Bot API server parses them; a reply), a photo, a video, a document (`sendPhoto`, `sendVideo`,
+  `sendDocument`: uploaded, or a file_id sent again; Volter Harness's board sends a done card's files this way, the
+  notice a MarkdownV2 caption) and an album (`sendMediaGroup`), and deletes a message (`deleteMessage`, by the page's
+  rules).
+- It reads a chat (`getChat`), a member (`getChatMember`) and a file (`getFile`), and downloads the file
+  (`GET /file/bot<token>/<file_path>`).
+- A chat's access is checked as the Bot API server checks it (a private chat only once the person started the bot; a
+  group, a supergroup or a channel only while the bot is in it; a channel post only by an administrator that may post).
+- What a bot is sent follows privacy mode: in a group where it is a plain member, the service messages, commands meant
+  for it, a general command after its own last post and replies to it (not a plain mention); everything when it is an
+  administrator; every post in a channel it is in.
+
+Every request names its bot by the token in its path; a token BotFather did not issue, or one it has replaced, is
+refused before the method is routed. Every other method of the page answers `404 Not Found: method not found`.
+
+## Doors
+
+What people do in the Telegram app and in BotFather, which no Bot API method does (`/_twin/`):
+
+- `POST /_twin/people`: a Telegram account.
+- `POST /_twin/bots`: BotFather's /newbot, the bot and its token (the World's credential door: `TELEGRAM_BOT_TOKEN`,
+  `TELEGRAM_TOKEN`, `TELEGRAM_BOT_USERNAME`, `TELEGRAM_BOT_NAME`); `POST /_twin/bots/{username}/token`: /token, a new
+  token that revokes the one before.
+- `POST /_twin/chats`: a group, supergroup or channel made (with a photo, members, administrators).
+- `POST /_twin/chats/{chat_id}/members`: a member added, promoted or removed.
+- `POST /_twin/messages`: a person writing in a chat, or to a bot in private.
+
+The World points the Chat SDK adapter at the twin with `TELEGRAM_API_BASE_URL`; node-telegram-bot-api reaches it by its
+host, `api.telegram.org`.
+
+## Left out
+
+- Webhooks (`setWebhook`, `getWebhookInfo`): no application of the demand sets one, so getUpdates never meets one.
+- Editing messages, reactions, inline keyboards and callback queries, stickers, payments, inline mode, games, business
+  and passport methods, forum topics, and every other method of the page.
+- A medium sent by an HTTP URL, which Telegram downloads: a World lets the twin reach nothing outside it, so it answers
+  as Telegram does for a URL it could not get (Postiz sends URLs only with its opt-in Cloudflare storage).
+- A photo's other sizes (the twin keeps the one it was given), thumbnails, and a video's frames beyond its header.
+- The 3-second hold the server puts on a repeated short poll, and a second poller's conflict.

package/dist/generated/pack-facts.json

@@ -0,0 +1,53 @@
+{
+  "//": "GENERATED by scripts/pack-facts.ts — current pack descriptors and explicit world-runtime server backings; no prior-artifact entries are retained.",
+  "packs": {
+    "telegram": {
+      "adoption": {
+        "sdks": [
+          "@chat-adapter/telegram",
+          "node-telegram-bot-api",
+          "telegraf"
+        ],
+        "envStems": [
+          "TELEGRAM"
+        ]
+      },
+      "hosts": [
+        {
+          "host": "api.telegram.org"
+        }
+      ],
+      "archetype": "crud",
+      "protocol": {
+        "declared": "3",
+        "major": 3,
+        "standing": "current"
+      },
+      "transport": "web-api",
+      "resources": [
+        "user",
+        "chat",
+        "chat_member",
+        "message",
+        "update",
+        "file"
+      ],
+      "endpointEnv": {
+        "name": "TELEGRAM_API_BASE_URL",
+        "note": "the Chat SDK's Telegram adapter reads it as its API base (@chat-adapter/telegram 4.39.0, dist/index.js:1039); node-telegram-bot-api takes a baseApiUrl option only, and reaches the twin by its host"
+      },
+      "credentialDoor": {
+        "path": "/_twin/bots",
+        "body": {},
+        "fill": {
+          "TELEGRAM_BOT_TOKEN": "token",
+          "TELEGRAM_TOKEN": "token",
+          "TELEGRAM_BOT_USERNAME": "username",
+          "TELEGRAM_BOT_NAME": "username"
+        }
+      },
+      "serveExport": "createTelegramTwinServer"
+    }
+  },
+  "undeclared": []
+}

package/dist/journeys/coverage.json

@@ -0,0 +1,138 @@
+{
+  "vendor": "telegram",
+  "missing": 1,
+  "stale": [],
+  "code": {
+    "lines": 1171,
+    "run": 1155,
+    "recorded": 15,
+    "missing": 1
+  },
+  "state": {
+    "declared": 4,
+    "reached": 4,
+    "recorded": 0,
+    "missing": [],
+    "undeclared": []
+  },
+  "files": [
+    {
+      "file": "semantics/doors.ts",
+      "lines": {
+        "found": 201,
+        "hit": 198
+      },
+      "missing": []
+    },
+    {
+      "file": "semantics/states.ts",
+      "lines": {
+        "found": 18,
+        "hit": 18
+      },
+      "missing": []
+    },
+    {
+      "file": "semantics/getting-updates.ts",
+      "lines": {
+        "found": 33,
+        "hit": 33
+      },
+      "missing": []
+    },
+    {
+      "file": "semantics/available-methods.ts",
+      "lines": {
+        "found": 159,
+        "hit": 159
+      },
+      "missing": []
+    },
+    {
+      "file": "semantics/shared.ts",
+      "lines": {
+        "found": 239,
+        "hit": 236
+      },
+      "missing": [
+        {
+          "from": 237,
+          "to": 237,
+          "fn": "formatted"
+        }
+      ]
+    },
+    {
+      "file": "semantics/updating-messages.ts",
+      "lines": {
+        "found": 25,
+        "hit": 25
+      },
+      "missing": []
+    },
+    {
+      "file": "semantics/around.ts",
+      "lines": {
+        "found": 18,
+        "hit": 18
+      },
+      "missing": []
+    },
+    {
+      "file": "semantics/index.ts",
+      "lines": {
+        "found": 19,
+        "hit": 19
+      },
+      "missing": []
+    },
+    {
+      "file": "manifest.ts",
+      "lines": {
+        "found": 63,
+        "hit": 63
+      },
+      "missing": []
+    },
+    {
+      "file": "index.ts",
+      "lines": {
+        "found": 7,
+        "hit": 7
+      },
+      "missing": []
+    },
+    {
+      "file": "engine/text.ts",
+      "lines": {
+        "found": 317,
+        "hit": 317
+      },
+      "missing": []
+    },
+    {
+      "file": "engine/media.ts",
+      "lines": {
+        "found": 45,
+        "hit": 45
+      },
+      "missing": []
+    },
+    {
+      "file": "server.ts",
+      "lines": {
+        "found": 13,
+        "hit": 3
+      },
+      "missing": []
+    },
+    {
+      "file": "fetch.ts",
+      "lines": {
+        "found": 14,
+        "hit": 14
+      },
+      "missing": []
+    }
+  ]
+}