├── .editorconfig ├── .eslintignore ├── .eslintrc ├── .github ├── FUNDING.yml └── workflows │ ├── builid.yml │ └── release.yml ├── .gitignore ├── .npmrc ├── LICENSE ├── README.md ├── esbuild.config.mjs ├── jest.config.js ├── manifest.json ├── package.json ├── pnpm-lock.yaml ├── src ├── bot.ts ├── io.ts ├── main.ts ├── settings.ts ├── type.ts └── utils │ ├── diary.ts │ ├── download.ts │ ├── file.ts │ ├── markdown.ts │ └── template.ts ├── styles.css ├── test ├── buildData.spec.ts ├── buildPathData.spec.ts ├── generatePath.spec.ts └── msgs.ts ├── tsconfig.json ├── version-bump.mjs └── versions.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # top-most EditorConfig file 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | end_of_line = lf 7 | insert_final_newline = true 8 | indent_style = tab 9 | indent_size = 4 10 | tab_width = 4 11 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | 3 | main.js 4 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "parser": "@typescript-eslint/parser", 4 | "env": { "node": true }, 5 | "plugins": [ 6 | "@typescript-eslint" 7 | ], 8 | "extends": [ 9 | "eslint:recommended", 10 | "plugin:@typescript-eslint/eslint-recommended", 11 | "plugin:@typescript-eslint/recommended" 12 | ], 13 | "parserOptions": { 14 | "sourceType": "module" 15 | }, 16 | "rules": { 17 | "no-unused-vars": "off", 18 | "@typescript-eslint/no-unused-vars": ["error", { "args": "none" }], 19 | "@typescript-eslint/ban-ts-comment": "off", 20 | "no-prototype-builtins": "off", 21 | "@typescript-eslint/no-empty-function": "off" 22 | } 23 | } -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: icealtria 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 12 | polar: # Replace with a single Polar username 13 | buy_me_a_coffee: # Replace with a single Buy Me a Coffee username 14 | thanks_dev: # Replace with a single thanks.dev username 15 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 16 | -------------------------------------------------------------------------------- /.github/workflows/builid.yml: -------------------------------------------------------------------------------- 1 | name: build plugin and send to telegram 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | workflow_dispatch: 8 | 9 | jobs: 10 | build: 11 | 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - uses: actions/checkout@v4 16 | 17 | - name: Install Node.js 18 | uses: actions/setup-node@v4 19 | with: 20 | node-version: 20 21 | 22 | - uses: pnpm/action-setup@v4 23 | with: 24 | version: 10 25 | run_install: true 26 | 27 | - name: Build 28 | run: pnpm build 29 | 30 | - name: send tg message 31 | uses: appleboy/telegram-action@master 32 | with: 33 | to: ${{ secrets.TELEGRAM_TO }} 34 | token: ${{ secrets.TELEGRAM_TOKEN }} 35 | message: | 36 | Commit ${{ github.sha }} 37 | document: main.js 38 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: release plugin 2 | 3 | on: 4 | push: 5 | tags: 6 | - "*.*.*" 7 | workflow_dispatch: 8 | 9 | jobs: 10 | build: 11 | 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - uses: actions/checkout@v4 16 | 17 | - name: Install Node.js 18 | uses: actions/setup-node@v4 19 | with: 20 | node-version: 20 21 | 22 | - uses: pnpm/action-setup@v4 23 | with: 24 | version: 10 25 | run_install: true 26 | 27 | - name: Build 28 | run: pnpm build 29 | 30 | - name: Create release 31 | uses: softprops/action-gh-release@v2 32 | if: startsWith(github.ref, 'refs/tags/') 33 | with: 34 | draft: true 35 | files: | 36 | main.js 37 | manifest.json 38 | styles.css 39 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # vscode 2 | .vscode 3 | 4 | # Intellij 5 | *.iml 6 | .idea 7 | 8 | # npm 9 | node_modules 10 | 11 | # Don't include the compiled main.js file in the repo. 12 | # They should be uploaded to GitHub releases instead. 13 | main.js 14 | 15 | # Exclude sourcemaps 16 | *.map 17 | 18 | # obsidian 19 | data.json 20 | 21 | # Exclude macOS Finder (System Explorer) View States 22 | .DS_Store 23 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | tag-version-prefix="" -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Telegram Inbox 2 | 3 | This plugin can receive messages from Telegram bots and add them to Obsidian's daily note. 4 | 5 | ## Usage 6 | 1. Create a bot using [@BotFather](https://telegram.me/BotFather). 7 | 2. Copy the bot token provided by [@BotFather](https://telegram.me/BotFather). 8 | 3. Paste the token into the `Bot Token` field in the plugin settings. 9 | 4. Add your username or telegram id to `Allowed Users`. You can get your id from [@Get_UIDbot](https://t.me/Get_UIDbot) 10 | 5. Click the `Restart` button. 11 | 12 | > When the plugin is not running, messages will be stored on the Telegram server for 24 hours at most. [source](https://core.telegram.org/bots/api#getting-updates) 13 | 14 | ## Manually install the plugin 15 | Requires Node.js environment. 16 | 17 | ### Build 18 | - Clone this repo. `git clone https://github.com/icealtria/telegram-inbox` 19 | - Run `pnpm i` or another package manager to install dependencies. 20 | - Run `pnpm build` to build the plugin. 21 | 22 | ### Install 23 | - Copy over `main.js`, `manifest.json`, `styles.css` to your vault `VaultFolder/.obsidian/plugins/telegram-inbox/`. 24 | 25 | ## Bug Reporting 26 | If you encounter any issues: 27 | 1. Press `Ctrl + Shift + I` (Windows/Linux) or `Cmd + Option + I` (macOS) to open the developer console 28 | 2. Look for any error messages in the console 29 | 3. When reporting bugs, please include: 30 | - Console error messages 31 | - Steps to reproduce the issue 32 | - Your operating system and Obsidian version 33 | -------------------------------------------------------------------------------- /esbuild.config.mjs: -------------------------------------------------------------------------------- 1 | import esbuild from "esbuild"; 2 | import process from "process"; 3 | import builtins from "builtin-modules"; 4 | 5 | const banner = 6 | `/* 7 | THIS IS A GENERATED/BUNDLED FILE BY ESBUILD 8 | if you want to view the source, please visit the github repository of this plugin 9 | */ 10 | `; 11 | 12 | const prod = (process.argv[2] === "production"); 13 | 14 | const context = await esbuild.context({ 15 | banner: { 16 | js: banner, 17 | }, 18 | entryPoints: ["src/main.ts"], 19 | bundle: true, 20 | external: [ 21 | "obsidian", 22 | "electron", 23 | "@codemirror/autocomplete", 24 | "@codemirror/collab", 25 | "@codemirror/commands", 26 | "@codemirror/language", 27 | "@codemirror/lint", 28 | "@codemirror/search", 29 | "@codemirror/state", 30 | "@codemirror/view", 31 | "@lezer/common", 32 | "@lezer/highlight", 33 | "@lezer/lr", 34 | ...builtins], 35 | format: "cjs", 36 | target: "es2018", 37 | logLevel: "info", 38 | sourcemap: prod ? false : "inline", 39 | treeShaking: true, 40 | outfile: "main.js", 41 | }); 42 | 43 | if (prod) { 44 | await context.rebuild(); 45 | process.exit(0); 46 | } else { 47 | await context.watch(); 48 | } -------------------------------------------------------------------------------- /jest.config.js: -------------------------------------------------------------------------------- 1 | /** @type {import('ts-jest').JestConfigWithTsJest} */ 2 | module.exports = { 3 | preset: 'ts-jest', 4 | testEnvironment: 'node', 5 | }; -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "telegram-inbox", 3 | "name": "Telegram Inbox", 4 | "version": "1.5.0", 5 | "minAppVersion": "1.5.11", 6 | "description": "Receive messages from Telegram bot and add them to daily note.", 7 | "author": "icealtria", 8 | "authorUrl": "https://github.com/icealtria", 9 | "isDesktopOnly": false, 10 | "fundingUrl": "https://ko-fi.com/icealtria" 11 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "telegram-inbox", 3 | "version": "1.5.0", 4 | "description": "Receive messages from Telegram bot and add them to daily note.", 5 | "main": "main.js", 6 | "scripts": { 7 | "dev": "node esbuild.config.mjs", 8 | "build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production", 9 | "version": "node version-bump.mjs && git add manifest.json versions.json", 10 | "test": "jest" 11 | }, 12 | "keywords": [], 13 | "author": "", 14 | "license": "GPL-3.0-only", 15 | "devDependencies": { 16 | "@jest/globals": "^29.7.0", 17 | "@types/jest": "^29.5.14", 18 | "@types/mustache": "^4.2.6", 19 | "@types/node": "^16.18.126", 20 | "@typescript-eslint/eslint-plugin": "5.29.0", 21 | "@typescript-eslint/parser": "5.29.0", 22 | "builtin-modules": "3.3.0", 23 | "esbuild": "0.17.3", 24 | "jest": "^29.7.0", 25 | "moment": "^2.30.1", 26 | "obsidian": "^1.8.7", 27 | "ts-jest": "^29.3.4", 28 | "tslib": "2.4.0", 29 | "typescript": "4.7.4" 30 | }, 31 | "dependencies": { 32 | "@telegraf/entity": "^0.5.0", 33 | "async-mutex": "^0.5.0", 34 | "grammy": "^1.36.3", 35 | "mustache": "4.1.0", 36 | "obsidian-daily-notes-interface": "^0.9.4" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/bot.ts: -------------------------------------------------------------------------------- 1 | import { Bot, Composer, type Context } from "grammy"; 2 | import { type Vault, moment } from "obsidian"; 3 | import { insertMessage, insertMessageAtTop } from "./io"; 4 | import type { TGInboxSettings } from "./settings"; 5 | import { downloadAndSaveFile } from "./utils/download"; 6 | import type { File, Message } from "grammy/types"; 7 | import { generateContentFromTemplate } from "./utils/template"; 8 | import { getExt, getFileUrl, getSavePath } from "./utils/file"; 9 | import { Mutex } from "async-mutex"; 10 | import { MessageUpdate } from "./type"; 11 | 12 | export class TelegramBot { 13 | bot: Bot; 14 | vault: Vault; 15 | allowedUsers: string[]; 16 | settings: TGInboxSettings; 17 | update_id: number; 18 | mutex = new Mutex(); 19 | 20 | constructor(vault: Vault, settings: TGInboxSettings) { 21 | 22 | const restrictToAllowedUsers = this.createRestrictToAllowedUsersMiddleware(settings); 23 | const recordUpdateId = this.createRecordUpdateIdMiddleware(); 24 | 25 | this.bot = new Bot(settings.token); 26 | 27 | if (settings.disable_auto_reception) { 28 | this.bot.init(); 29 | } 30 | 31 | this.bot.use(restrictToAllowedUsers); 32 | this.bot.use(recordUpdateId); 33 | this.vault = vault; 34 | this.settings = settings; 35 | 36 | this.setupCommands(); 37 | 38 | this.setupMessageHandlers(settings); 39 | 40 | this.bot.catch((err) => { 41 | console.error("An error occurred in the Telegram bot:", err); 42 | }); 43 | } 44 | 45 | start() { 46 | this.bot.start(); 47 | } 48 | 49 | async getUpdates() { 50 | const offset = this.update_id ? this.update_id + 1 : 1; 51 | const updates = await this.bot.api.getUpdates({ offset }); 52 | updates.map(async (update) => await this.bot.handleUpdate(update)); 53 | if (updates.length > 0) { 54 | this.bot.api.getUpdates({ offset: this.update_id + 1, limit: 1 }); 55 | } 56 | } 57 | 58 | private createRestrictToAllowedUsersMiddleware(settings: TGInboxSettings): Composer { 59 | return new Composer().use(async (ctx: Context, next) => { 60 | if (!ctx.chat || (ctx.chat.type !== 'private' && ctx.chat.type !== 'channel' && ctx.chat.type !== 'supergroup')) { 61 | console.log('Unauthorized chat type:', ctx.chat?.type, ctx.chat?.id); 62 | return; 63 | } 64 | const userId = ctx.chat?.id; 65 | const username = ctx.chat?.username; 66 | if ( 67 | (username && settings.allow_users.includes(username)) || 68 | (userId && settings.allow_users.includes(userId.toString())) 69 | ) { 70 | await next(); 71 | } else { 72 | console.log(`Unauthorized access attempt: User ${username || userId} tried to access the bot at ${new Date().toISOString()}`); 73 | } 74 | }); 75 | } 76 | 77 | createRecordUpdateIdMiddleware(): Composer { 78 | return new Composer().use(async (ctx: Context, next) => { 79 | const updateId = ctx.update?.update_id; 80 | if (updateId) { 81 | this.update_id = updateId; 82 | } 83 | await next(); 84 | }); 85 | } 86 | 87 | private setupCommands() { 88 | this.bot.command("start", (ctx) => { 89 | ctx.reply( 90 | "Hello! Send me a message to add it to your Obsidian daily note.\n\n/task followed by the description will add it as a task item." 91 | ); 92 | }); 93 | 94 | this.bot.command("task", async (ctx) => { 95 | const task = `- [ ] ${ctx.match}`; 96 | this.insertMessageToVault(task); 97 | ctx.react("❤"); 98 | }); 99 | } 100 | 101 | private setupMessageHandlers(settings: TGInboxSettings) { 102 | this.bot.on(["message:text", "channel_post:text"], async (ctx) => { 103 | const content = generateContentFromTemplate(ctx.msg, settings) 104 | await this.insertMessageToVault(content, { msg: ctx.msg }) 105 | .then(async _ => { 106 | try { 107 | await ctx.react("❤"); 108 | } catch (reactionErr) { 109 | console.error("Failed to set reaction"); 110 | } 111 | }) 112 | .catch((err) => { 113 | console.error(`Failed to insert text message to vault. Error: ${err.message}`, err); 114 | ctx.reply(`Failed to insert text message to vault. Error: ${err.message}`, err); 115 | }); 116 | }); 117 | 118 | this.bot.on(["message:media", "channel_post:media"], async (ctx) => { 119 | let content = generateContentFromTemplate(ctx.msg, settings); 120 | 121 | if (settings.download_media) { 122 | const file = await ctx.getFile(); 123 | const filename_ext = this.generateFilename(ctx.msg, file); 124 | const url = getFileUrl(file, this.bot.token); 125 | 126 | console.debug(`Attempting to download media: ${filename_ext} from ${url}`); 127 | const downloadResult = await downloadAndSaveFile(url, filename_ext, settings.download_dir); 128 | 129 | if (downloadResult) { 130 | content = `![[${filename_ext}]]\n${content}`; 131 | } else { 132 | console.error(`Failed to download media. File: ${filename_ext}, URL: ${url}`); 133 | ctx.reply(`Failed to download media. File: ${filename_ext}, URL: ${url}`); 134 | } 135 | } 136 | 137 | if (!settings.download_media && content.length === 0) { 138 | console.debug("No content to insert. Skipping."); 139 | return; 140 | } 141 | 142 | await this.insertMessageToVault(content, { msg: ctx.msg }) 143 | .then(async _ => { 144 | try { 145 | await ctx.react("❤"); 146 | } catch (reactionErr) { 147 | console.error("Failed to set reaction"); 148 | } 149 | }) 150 | .catch((err) => { 151 | console.error(`Failed to insert media message to vault. Error: ${err.message}`, err); 152 | ctx.reply(`Failed to insert media message to vault. Error: ${err.message}`, err); 153 | }); 154 | }); 155 | } 156 | 157 | private generateFilename(msg: Message, file: File): string { 158 | const message_id = msg.message_id; 159 | const dateStr = moment(msg.date * 1000).format("YYYYMMDD"); 160 | const extension = getExt(file.file_path || ""); 161 | return `${dateStr}-${message_id}.${extension}`; 162 | } 163 | 164 | private async insertMessageToVault(content: string, options?: { msg: MessageUpdate }): Promise { 165 | const release = await this.mutex.acquire(); 166 | try { 167 | const savedPath = options?.msg 168 | ? await getSavePath(this.vault, this.settings, options.msg) 169 | : await getSavePath(this.vault, this.settings); 170 | 171 | if (this.settings.reverse_order) { 172 | await insertMessageAtTop(this.vault, content, savedPath); 173 | } else { 174 | await insertMessage(this.vault, content, savedPath); 175 | } 176 | } catch (error) { 177 | console.error(`Error inserting message to vault: ${error}`); 178 | throw error; 179 | } finally { 180 | release(); 181 | } 182 | } 183 | } 184 | -------------------------------------------------------------------------------- /src/io.ts: -------------------------------------------------------------------------------- 1 | import { getTodayDiary } from "./utils/diary"; 2 | import type { TFile, Vault } from "obsidian"; 3 | 4 | export async function insertAfterMarker( 5 | vault: Vault, 6 | message: string, 7 | marker: string 8 | ) { 9 | const todayDiary = await getTodayDiary(); 10 | let fileContent = await vault.read(todayDiary); 11 | const lines = fileContent.split("\n"); 12 | let inboxIndex = lines.findIndex((line) => line.trim() === marker); 13 | if (inboxIndex === -1) { 14 | inboxIndex = lines.length; 15 | lines.push(marker); 16 | } 17 | lines.splice(inboxIndex + 1, 0, message); 18 | fileContent = lines.join("\n"); 19 | vault.modify(todayDiary, fileContent); 20 | } 21 | 22 | export async function insertMessage(vault: Vault, message: string, tFile: TFile) { 23 | try { 24 | await vault.process(tFile, (data) => { 25 | const updatedContent = data.trim() === "" 26 | ? message 27 | : data.endsWith("\n") 28 | ? `${data}${message}` 29 | : `${data}\n${message}`; 30 | return updatedContent; 31 | }); 32 | } catch (error) { 33 | throw new Error(`Error inserting message. ${error}`); 34 | } 35 | } 36 | 37 | export async function insertMessageAtTop(vault: Vault, message: string, tFile: TFile) { 38 | try { 39 | await vault.process(tFile, (data) => { 40 | const frontmatterMatch = data.match(/^---\n([\s\S]*?\n)---(\n|$)/); 41 | 42 | if (frontmatterMatch) { 43 | const frontmatter = frontmatterMatch[0]; 44 | const contentAfterFrontmatter = data.slice(frontmatter.length); 45 | return `${frontmatter}${message}\n${contentAfterFrontmatter}`; 46 | } else { 47 | return `${message}\n${data}`; 48 | } 49 | }); 50 | } catch (error) { 51 | throw new Error(`Error inserting message. ${error}`); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { Notice, Plugin } from "obsidian"; 2 | import { TelegramBot } from "./bot"; 3 | import type { TGInboxSettings } from "./settings"; 4 | import { TGInboxSettingTab } from "./settings"; 5 | 6 | const DEFAULT_SETTINGS: TGInboxSettings = { 7 | token: "", 8 | marker: "#inbox", 9 | allow_users: [], 10 | download_dir: "/assets", 11 | download_media: false, 12 | markdown_escaper: false, 13 | message_template: "{{{text}}}", 14 | is_custom_file: false, 15 | custom_file_path: "Telegram-Inbox.md", 16 | disable_auto_reception: false, 17 | reverse_order: false, 18 | remove_formatting: false, 19 | }; 20 | 21 | export default class TGInbox extends Plugin { 22 | settings: TGInboxSettings; 23 | bot: TelegramBot | null; 24 | botInfo: { 25 | username: string; 26 | isConnected: boolean; 27 | }; 28 | 29 | async onload() { 30 | this.addSettingTab(new TGInboxSettingTab(this.app, this)); 31 | 32 | this.addCommands(); 33 | 34 | await this.loadSettings(); 35 | 36 | if (this.settings.disable_auto_reception) { 37 | this.addRibbonIcon('send', 'Telegram Inbox: Get Updates', () => { 38 | this.bot?.getUpdates(); 39 | }); 40 | } 41 | 42 | this.launchBot(); 43 | } 44 | 45 | addCommands() { 46 | this.addCommand({ 47 | id: "tg-inbox-getupdates", 48 | name: "Get Updates", 49 | callback: () => this.bot?.getUpdates(), 50 | }); 51 | 52 | this.addCommand({ 53 | id: "tg-inbox-start", 54 | name: "Start Telegram Bot", 55 | callback: () => this.startBot(), 56 | }); 57 | 58 | this.addCommand({ 59 | id: "tg-inbox-stop", 60 | name: "Stop Telegram Bot", 61 | callback: () => this.stopBot(), 62 | }); 63 | } 64 | 65 | async getBotInfo() { 66 | if (this.bot) { 67 | return this.bot.bot.api.getMe(); 68 | } 69 | return null; 70 | } 71 | 72 | async onunload() { 73 | this.stopBot(); 74 | console.log("telegram inbox unloaded"); 75 | } 76 | 77 | async loadSettings() { 78 | this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()); 79 | } 80 | 81 | async saveSettings() { 82 | await this.saveData(this.settings); 83 | } 84 | 85 | async launchBot() { 86 | try { 87 | if (!this.settings.token) { 88 | new Notice("Telegram bot token not set"); 89 | return; 90 | } 91 | await this.stopBot(); 92 | this.bot = new TelegramBot(this.app.vault, this.settings); 93 | if (!this.settings.disable_auto_reception) { 94 | this.startBot(); 95 | } 96 | } catch (error) { 97 | console.error("Error launching bot:", error); 98 | new Notice("Error launching bot"); 99 | this.bot = null; 100 | } 101 | } 102 | 103 | async startBot() { 104 | new Notice("Telegram bot starting"); 105 | if (this.bot) { 106 | this.bot.start(); 107 | } 108 | } 109 | 110 | async stopBot() { 111 | try { 112 | if (this.bot) { 113 | await this.bot.bot.stop(); 114 | console.log("bot stopped"); 115 | new Notice("Telegram bot stopped"); 116 | } 117 | } catch (error) { 118 | console.error("Error stopping bot:", error); 119 | } 120 | } 121 | } 122 | -------------------------------------------------------------------------------- /src/settings.ts: -------------------------------------------------------------------------------- 1 | import { type App, PluginSettingTab, Setting } from "obsidian"; 2 | import type TGInbox from "./main"; 3 | import * as Mustache from 'mustache'; 4 | 5 | export interface TGInboxSettings { 6 | token: string; 7 | marker: string; 8 | allow_users: string[]; 9 | download_dir: string; 10 | download_media: boolean; 11 | message_template: string; 12 | markdown_escaper: boolean; 13 | is_custom_file: boolean; 14 | custom_file_path: string; 15 | disable_auto_reception: boolean; 16 | reverse_order: boolean; 17 | remove_formatting: boolean; 18 | } 19 | 20 | export class TGInboxSettingTab extends PluginSettingTab { 21 | plugin: TGInbox; 22 | statusEl: HTMLDivElement; 23 | updateId: number; 24 | 25 | constructor(app: App, plugin: TGInbox) { 26 | super(app, plugin); 27 | this.plugin = plugin; 28 | } 29 | 30 | display(): void { 31 | const { containerEl } = this; 32 | 33 | containerEl.empty(); 34 | 35 | const botSettingsTitle = containerEl.createDiv({ 36 | cls: "bot-settings-title", 37 | }); 38 | 39 | new Setting(botSettingsTitle).setName('Bot').setHeading(); 40 | 41 | this.statusEl = botSettingsTitle.createDiv({ 42 | cls: "tg-inbox-status", 43 | }); 44 | 45 | this.updateStatus(); 46 | 47 | this.updateId = window.setInterval(async () => { 48 | await this.updateStatus(); 49 | }, 5000); 50 | 51 | new Setting(containerEl) 52 | .setName("Bot token") 53 | .setDesc("Get your bot token from @BotFather") 54 | .addText((text) => 55 | text 56 | .setPlaceholder("Enter your bot token") 57 | .setValue(this.plugin.settings.token) 58 | .onChange(async (value) => { 59 | this.plugin.settings.token = value; 60 | await this.plugin.saveSettings(); 61 | }) 62 | ) 63 | .addButton((button) => { 64 | button.setButtonText("Restart").onClick(async () => { 65 | this.plugin.launchBot(); 66 | this.statusEl.setText("Restarting..."); 67 | }); 68 | }); 69 | 70 | new Setting(containerEl) 71 | .setName("Allowed users") 72 | .setDesc( 73 | "List of usernames or IDs of users whose messages will be received. Separate multiple entries with commas." 74 | ) 75 | .addText((text) => 76 | text 77 | .setPlaceholder("Enter Telegram usernames or id") 78 | .setValue(this.plugin.settings.allow_users.join(",")) 79 | .onChange(async (value) => { 80 | this.plugin.settings.allow_users = value.split(","); 81 | await this.plugin.saveSettings(); 82 | }) 83 | ); 84 | 85 | new Setting(containerEl).setName("Message formatting").setHeading(); 86 | 87 | 88 | new Setting(containerEl) 89 | .setName("Download media") 90 | .setDesc("Toggle to download media files along with messages.") 91 | .addToggle((toggle) => 92 | toggle 93 | .setValue(this.plugin.settings.download_media) 94 | .onChange(async (value) => { 95 | this.plugin.settings.download_media = value; 96 | await this.plugin.saveSettings(); 97 | this.display(); 98 | }) 99 | ); 100 | 101 | if (this.plugin.settings.download_media) { 102 | new Setting(containerEl) 103 | .setName("Download directory") 104 | .setDesc("Specify the directory for downloading media files") 105 | .addText((text) => 106 | text 107 | .setPlaceholder("Enter download directory") 108 | .setValue(this.plugin.settings.download_dir) 109 | .onChange(async (value) => { 110 | this.plugin.settings.download_dir = value; 111 | await this.plugin.saveSettings(); 112 | }) 113 | ); 114 | } 115 | 116 | const message_template_desc = document.createDocumentFragment(); 117 | message_template_desc.append("Customize the message template. "); 118 | const message_template_wiki = document.createElement("a") 119 | message_template_wiki.href = "https://github.com/icealtria/obsidian-telegram-inbox/wiki/Message-template" 120 | message_template_wiki.text = "Learn more"; 121 | message_template_desc.append(message_template_wiki) 122 | 123 | 124 | new Setting(containerEl) 125 | .setName("Message template") 126 | .setDesc(message_template_desc) 127 | .addTextArea((textArea) => { 128 | textArea.inputEl.rows = 3; 129 | textArea.setValue(this.plugin.settings.message_template) 130 | .onChange(async (value) => { 131 | this.plugin.settings.message_template = value; 132 | await this.plugin.saveSettings(); 133 | }) 134 | } 135 | ) 136 | .addButton((button) => { 137 | button.setButtonText("Validate").onClick( 138 | () => { 139 | try { 140 | Mustache.parse(this.plugin.settings.message_template); 141 | templateValidStatus.setText("✅ Template format is correct. This is to ensure that the program does not crash, doesn't mean the fields are correct."); 142 | } 143 | catch (err) { 144 | console.error("Error parsing message template:", err); 145 | templateValidStatus.setText(`❌ Error parsing template: ${err.message}`); 146 | } 147 | } 148 | ) 149 | }); 150 | 151 | const templateValidStatus = containerEl.createDiv(); 152 | 153 | new Setting(containerEl).setName("Advanced").setHeading(); 154 | 155 | new Setting(containerEl) 156 | .setName("Reverse order") 157 | .setDesc("Reverse the order of messages. This is useful if you want to see the latest messages first.") 158 | .addToggle((toggle) => { 159 | toggle.setValue(this.plugin.settings.reverse_order) 160 | .onChange(async (value) => { 161 | this.plugin.settings.reverse_order = value; 162 | await this.plugin.saveSettings(); 163 | }); 164 | }) 165 | 166 | new Setting(containerEl) 167 | .setName("Disable automatically receiving on Startup") 168 | .setDesc("If it is disabled, you will need to manually run a command to start bot or get updates.") 169 | .addToggle((toggle) => { 170 | toggle.setValue(this.plugin.settings.disable_auto_reception) 171 | .onChange(async (value) => { 172 | this.plugin.settings.disable_auto_reception = value; 173 | await this.plugin.saveSettings(); 174 | }); 175 | }) 176 | 177 | new Setting(containerEl) 178 | .setName("Remove text formatting") 179 | .setDesc(createFragment((fragment) => { 180 | fragment.append( 181 | "Remove text formatting like ", 182 | createEl("b", { text: "bold" }), ", ", 183 | createEl("i", { text: "italic" }), ", ", 184 | createEl("s", { text: "strikethrough" }), " etc." 185 | ); 186 | })) 187 | .addToggle((toggle) => { 188 | toggle.setValue(this.plugin.settings.remove_formatting) 189 | .onChange(async (value) => { 190 | this.plugin.settings.remove_formatting = value; 191 | await this.plugin.saveSettings(); 192 | }); 193 | }) 194 | 195 | new Setting(containerEl) 196 | .setName("Markdown escaper") 197 | .setDesc("Use Markdown escaper for text. For example: '[link](https://example.com)' will display as '[link](https://example.com)' instead of a link.") 198 | .addToggle((toggle) => { 199 | toggle.setValue(this.plugin.settings.markdown_escaper) 200 | .onChange(async (value) => { 201 | this.plugin.settings.markdown_escaper = value; 202 | await this.plugin.saveSettings(); 203 | }); 204 | }); 205 | 206 | 207 | new Setting(containerEl) 208 | .setName("Save to custom path") 209 | .setDesc("Toggle to save messages to a custom path.") 210 | .addToggle((toggle) => { 211 | toggle.setValue(this.plugin.settings.is_custom_file) 212 | .onChange(async (value) => { 213 | this.plugin.settings.is_custom_file = value; 214 | await this.plugin.saveSettings(); 215 | this.display(); 216 | }); 217 | }) 218 | 219 | const custom_path_desc = document.createDocumentFragment(); 220 | custom_path_desc.append("Specify the path for saving messages. "); 221 | const custom_path_wiki = document.createElement("a") 222 | custom_path_wiki.href = "https://github.com/icealtria/obsidian-telegram-inbox/wiki/Custom-path" 223 | custom_path_wiki.text = "Learn more"; 224 | custom_path_desc.append(custom_path_wiki) 225 | 226 | 227 | if (this.plugin.settings.is_custom_file) { 228 | new Setting(containerEl) 229 | .setName("Custom path") 230 | .setDesc(custom_path_desc) 231 | .addText((text) => { 232 | text.setPlaceholder("Default: Telegram-Inbox.md") 233 | .setValue(this.plugin.settings.custom_file_path) 234 | .onChange((value) => { 235 | this.plugin.settings.custom_file_path = value; 236 | this.plugin.saveSettings(); 237 | }) 238 | }) 239 | } 240 | 241 | 242 | } 243 | 244 | hide() { 245 | window.clearInterval(this.updateId); 246 | } 247 | async updateStatus() { 248 | try { 249 | const me = await this.plugin.getBotInfo(); 250 | if (me) { 251 | this.statusEl.setText(`✅ Bot connected as @${me.username}`); 252 | } else { 253 | this.statusEl.setText("❌ Bot not connected"); 254 | } 255 | } catch { 256 | this.statusEl.setText("❌ Bot not connected"); 257 | } 258 | } 259 | } 260 | -------------------------------------------------------------------------------- /src/type.ts: -------------------------------------------------------------------------------- 1 | import type { Message, Update } from "grammy/types"; 2 | 3 | export type MessageUpdate = MsgChannel | MsgNonChannel 4 | 5 | export type MsgChannel = Message & Update.Channel 6 | 7 | export type MsgNonChannel = Message & Update.NonChannel -------------------------------------------------------------------------------- /src/utils/diary.ts: -------------------------------------------------------------------------------- 1 | import { moment } from "obsidian"; 2 | import { 3 | createDailyNote, 4 | getAllDailyNotes, 5 | getDailyNote, 6 | } from "obsidian-daily-notes-interface"; 7 | 8 | 9 | async function createDiary() { 10 | const date = moment(); 11 | return await createDailyNote(date); 12 | } 13 | 14 | export async function getTodayDiary() { 15 | try { 16 | const date = moment(); 17 | const dailyNotes = getAllDailyNotes(); 18 | let dailyNote = getDailyNote(date, dailyNotes); 19 | 20 | if (!dailyNote) { 21 | console.log('Daily note not found, creating new one'); 22 | dailyNote = await createDiary(); 23 | } 24 | 25 | return dailyNote; 26 | } catch (error) { 27 | console.error(`Error retrieving or creating today's diary: ${error}`); 28 | throw error; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/utils/download.ts: -------------------------------------------------------------------------------- 1 | import { normalizePath, requestUrl } from "obsidian"; 2 | 3 | function downloadAsArrayBuffer(url: string): Promise { 4 | return requestUrl(url).arrayBuffer; 5 | } 6 | 7 | 8 | export async function downloadAndSaveFile(url: string, filename_ext: string, download_dir: string): Promise { 9 | try { 10 | const fileArrayBuffer = await downloadAsArrayBuffer(url); 11 | this.app.vault.createBinary( 12 | normalizePath(`${download_dir}/${filename_ext}`), 13 | fileArrayBuffer 14 | ); 15 | return true; 16 | } catch (error) { 17 | console.error("Error downloading file:", error); 18 | return false; 19 | } 20 | } -------------------------------------------------------------------------------- /src/utils/file.ts: -------------------------------------------------------------------------------- 1 | import type { File } from "grammy/types"; 2 | import type { TGInboxSettings } from "src/settings"; 3 | import { getTodayDiary } from "./diary"; 4 | import { type TFile, normalizePath, type Vault } from "obsidian"; 5 | import { generatePath } from "./template"; 6 | import type { MessageUpdate } from "src/type"; 7 | 8 | export function getExt(path: string) { 9 | return path.split(".").pop(); 10 | } 11 | 12 | export function getFileUrl(file: File, token: string) { 13 | const TG_API = "https://api.telegram.org/file/bot"; 14 | return `${TG_API}${token}/${file.file_path}`; 15 | } 16 | 17 | 18 | export async function getSavePath( 19 | vault: Vault, 20 | settings: TGInboxSettings, 21 | msg?: MessageUpdate 22 | ): Promise { 23 | try { 24 | if (settings.is_custom_file && msg && settings.custom_file_path) { 25 | let normalizedPath = settings.custom_file_path 26 | ? normalizePath(generatePath(msg, settings)) 27 | : normalizePath('Telegram-Inbox.md'); 28 | 29 | if (!normalizedPath.endsWith('.md')) { 30 | normalizedPath += '.md'; 31 | } 32 | 33 | const file = vault.getFileByPath(normalizedPath); 34 | 35 | if (!file) { 36 | console.debug(`File not found. Creating new file at: ${normalizedPath}`); 37 | return await createTargetFile(vault, normalizedPath); 38 | } 39 | return file; 40 | } 41 | return getTodayDiary(); 42 | } catch (error) { 43 | console.error(`Error in getSavedPath: ${error}`); 44 | throw error; 45 | } 46 | } 47 | 48 | async function createTargetFile(vault: Vault, filePath: string): Promise { 49 | try { 50 | console.debug(`Creating target file: ${filePath}`); 51 | const dirPath = getDirPath(filePath); 52 | if (dirPath) { 53 | console.debug(`Directory path extracted: ${dirPath}`); 54 | await ensureDirExists(vault, dirPath); 55 | } 56 | const file = await vault.create(filePath, ''); 57 | console.log(`File created: ${filePath}`); 58 | return file; 59 | } catch (error) { 60 | console.error(`Error creating target file: ${error}`); 61 | throw error; 62 | } 63 | } 64 | 65 | async function ensureDirExists(vault: Vault, dirPath: string): Promise { 66 | try { 67 | const dir = vault.getAbstractFileByPath(dirPath); 68 | if (!dir) { 69 | await vault.createFolder(dirPath); 70 | console.log(`Folder created: ${dirPath}`); 71 | } else { 72 | console.log(`Folder already exists: ${dirPath}`); 73 | } 74 | } catch (error) { 75 | console.error(`Error ensuring directory exists: ${error}`); 76 | throw error; 77 | } 78 | } 79 | 80 | function getDirPath(filePath: string): string { 81 | const lastSlashIndex = filePath.lastIndexOf('/'); 82 | if (lastSlashIndex === -1) return ''; 83 | return filePath.substring(0, lastSlashIndex); 84 | } -------------------------------------------------------------------------------- /src/utils/markdown.ts: -------------------------------------------------------------------------------- 1 | import { escapers, serialiseWith } from "@telegraf/entity"; 2 | import type { Serialiser, Node, Message } from "@telegraf/entity/types/types"; 3 | import type { TGInboxSettings } from "src/settings"; 4 | import type { MessageUpdate, MsgChannel, MsgNonChannel } from "src/type"; 5 | 6 | 7 | const markdownSerialiser: Serialiser = (match: string, node?: Node) => { 8 | switch (node?.type) { 9 | case "bold": 10 | return `**${match}**`; 11 | case "italic": 12 | return `*${match}*`; 13 | case "underline": 14 | return `${match}`; 15 | case "strikethrough": 16 | return `~~${match}~~`; 17 | case "code": 18 | return `\`${match}\``; 19 | case "pre": 20 | if (node.language) return "```" + node.language + "\n" + match + "\n```"; 21 | return "```\n" + match + "\n```"; 22 | case "spoiler": 23 | return `==${match}==`; 24 | case "url": 25 | return match; 26 | case "text_link": 27 | return `[${match}](${node.url})`; 28 | case "text_mention": 29 | return `[${match}](tg://user?id=${node.user.id})`; 30 | case "blockquote": 31 | return `${match 32 | .split("\n") 33 | .map((line) => `>${line}`) 34 | .join("\n")}`; 35 | case "mention": 36 | case "custom_emoji": 37 | case "hashtag": 38 | case "cashtag": 39 | case "bot_command": 40 | case "phone_number": 41 | case "email": 42 | default: 43 | return match; 44 | } 45 | }; 46 | 47 | export function toMarkdownV2(msg: MsgNonChannel | MsgChannel, settings: TGInboxSettings): string { 48 | if (settings.remove_formatting) return msg.text ?? ""; 49 | const selectedEscaper = settings.markdown_escaper ? escapers.MarkdownV2 : escapers.HTML; 50 | return serialiseWith(markdownSerialiser, selectedEscaper)(msg as Message); 51 | } -------------------------------------------------------------------------------- /src/utils/template.ts: -------------------------------------------------------------------------------- 1 | import { toMarkdownV2 } from "./markdown"; 2 | import type { User } from "grammy/types"; 3 | import type { MessageUpdate, MsgChannel, MsgNonChannel } from '../type'; 4 | // import * as moment from "moment"; 5 | import { moment } from "obsidian"; 6 | import * as Mustache from 'mustache'; 7 | import type { TGInboxSettings } from "src/settings"; 8 | 9 | export interface MessageData { 10 | message_id: number; 11 | origin_name?: string; 12 | origin_username?: string; 13 | text: string; 14 | date: string; 15 | time: string; 16 | name: string; 17 | username?: string; 18 | user_id: number; 19 | origin_link?: string; 20 | } 21 | 22 | export interface PathData { 23 | date: string; 24 | first_name: string; 25 | name: string; 26 | time: string; 27 | user_id: number; 28 | origin_name: string; 29 | } 30 | 31 | 32 | export function generateContentFromTemplate(msg: MessageUpdate, setting: TGInboxSettings): string { 33 | const data = buildMsgData(msg, setting); 34 | return Mustache.render(setting.message_template, data); 35 | } 36 | 37 | export function buildMsgData(msg: MessageUpdate, setting: TGInboxSettings): MessageData { 38 | const forwardOrigin = getForwardOrigin(msg); 39 | 40 | const data: MessageData = { 41 | message_id: msg.message_id, 42 | text: toMarkdownV2(msg, setting), 43 | date: moment(msg.date * 1000).format("YYYY-MM-DD"), 44 | time: moment(msg.date * 1000).format("HH:mm"), 45 | name: getSenderName(msg), 46 | username: msg.chat.username, 47 | user_id: msg.from ? msg.from.id : msg.chat.id, 48 | ...forwardOrigin 49 | }; 50 | 51 | return data; 52 | } 53 | 54 | export function generatePath(msg: MessageUpdate, setting: TGInboxSettings) { 55 | const data = rereplaceSpecialChar(buildPathData(msg)); 56 | const path = Mustache.render(setting.custom_file_path, data); 57 | return path; 58 | } 59 | 60 | function rereplaceSpecialChar(data: PathData) { 61 | const regex = /[/\\[\]#^|:?*"<>]/g; 62 | 63 | data.first_name = data.first_name.replace(regex, "~"); 64 | data.name = data.name.replace(regex, "~"); 65 | data.origin_name = data.origin_name.replace(regex, "~"); 66 | 67 | return data; 68 | } 69 | 70 | export function buildPathData(msg: MessageUpdate) { 71 | const data: PathData = { 72 | date: moment(msg.date * 1000).format("YYYY-MM-DD"), 73 | first_name: msg.from ? msg.from.first_name : msg.chat.title!, 74 | name: getSenderName(msg), 75 | time: moment(msg.date * 1000).format("HH-mm"), 76 | user_id: msg.from ? msg.from.id : msg.chat.id, 77 | origin_name: getForwardOrigin(msg)?.origin_name || getSenderName(msg), 78 | }; 79 | 80 | return data; 81 | } 82 | 83 | function getForwardOrigin(msg: MessageUpdate) { 84 | if (!msg.forward_origin) { 85 | return null; 86 | } 87 | 88 | const { type } = msg.forward_origin; 89 | 90 | switch (type) { 91 | case "user": 92 | return { 93 | origin_name: getUserName(msg.forward_origin.sender_user), 94 | origin_username: msg.forward_origin.sender_user.username || "", 95 | }; 96 | case "hidden_user": 97 | return { 98 | origin_name: msg.forward_origin.sender_user_name, 99 | origin_username: "", 100 | }; 101 | case "channel": { 102 | const chat = msg.forward_origin.chat; 103 | return { 104 | origin_name: chat.title, 105 | origin_username: chat.username || "", 106 | origin_link: `https://t.me/${chat.username ? chat.username : chat.id}/${msg.forward_origin.message_id 107 | }`, 108 | }; 109 | } 110 | case "chat": { 111 | const chat = msg.forward_origin.sender_chat; 112 | if (chat.type === "private") { 113 | return { 114 | origin_name: chat.first_name + chat.last_name ? ` ${chat.last_name}` : '', 115 | origin_username: "", 116 | }; 117 | } if (chat.type === "group") { 118 | return { 119 | origin_name: chat.title, 120 | origin_username: "", 121 | }; 122 | } 123 | break; 124 | } 125 | } 126 | } 127 | 128 | function getUserName(user: User) { 129 | return `${user.first_name}${user.last_name ? ` ${user.last_name}` : ''}`; 130 | } 131 | 132 | function getSenderName(msg: MessageUpdate) { 133 | if (msg.from) { 134 | return getUserName(msg.from); 135 | } else { 136 | return msg.chat.title!; 137 | } 138 | } 139 | -------------------------------------------------------------------------------- /styles.css: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | This CSS file will be included with your plugin, and 4 | available in the app when your plugin is enabled. 5 | 6 | If your plugin does not need CSS, delete this file. 7 | 8 | */ 9 | .bot-settings-title { 10 | display: flex; 11 | justify-content: space-between; 12 | align-items: center; 13 | } 14 | -------------------------------------------------------------------------------- /test/buildData.spec.ts: -------------------------------------------------------------------------------- 1 | import { type MessageData, buildMsgData } from "../src/utils/template"; 2 | import { describe, expect, test } from "@jest/globals" 3 | import { msg, msgHidden, msgFowardUser, msgCh, channel_post_fw, channel_post } from "./msgs"; 4 | import type { TGInboxSettings } from "src/settings"; 5 | import { MsgChannel, MsgNonChannel } from "src/type"; 6 | 7 | 8 | const settings: TGInboxSettings = { 9 | token: "", 10 | marker: "", 11 | allow_users: [], 12 | download_dir: "", 13 | download_media: false, 14 | message_template: "", 15 | markdown_escaper: false, 16 | is_custom_file: false, 17 | custom_file_path: "", 18 | disable_auto_reception: true, 19 | reverse_order: false, 20 | remove_formatting: false, 21 | } 22 | 23 | 24 | describe('buildData', () => { 25 | 26 | test('forward message', () => { 27 | 28 | const data: MessageData = { 29 | origin_name: "猫", 30 | origin_username: "cat", 31 | message_id: 1234, 32 | name: "Neko ✨", 33 | text: "喵呜呜～", 34 | user_id: 12345, 35 | date: "2021-07-21", 36 | time: "14:00", 37 | username: "neko" 38 | } 39 | 40 | expect(buildMsgData(msgFowardUser, settings)).toStrictEqual(data) 41 | }) 42 | 43 | 44 | test('hidden user', () => { 45 | 46 | const data: MessageData = { 47 | origin_name: "Black Cat", 48 | origin_username: "", 49 | text: "I am a black cat.", 50 | date: "2021-07-21", 51 | time: "14:00", 52 | name: "Neko ✨", 53 | username: "neko", 54 | user_id: 12345, 55 | message_id: 1234, 56 | } 57 | 58 | expect(buildMsgData(msgHidden, settings)).toStrictEqual(data) 59 | }) 60 | 61 | test('without forward_origin', () => { 62 | 63 | const data: MessageData = { 64 | text: "I am a cat.", 65 | date: "2021-07-21", 66 | time: "14:00", 67 | name: "Neko ✨", 68 | username: "neko", 69 | user_id: 12345, 70 | message_id: 1234, 71 | } 72 | expect(buildMsgData(msg, settings)).toStrictEqual(data) 73 | }); 74 | 75 | test("Ch", () => { 76 | const data: MessageData = { 77 | origin_name: "Many cats every day", 78 | origin_username: "miaowu", 79 | message_id: 1234, 80 | text: "Cats rule the earth.", 81 | date: "2021-07-21", 82 | time: "14:00", 83 | name: "Neko ✨", 84 | username: "neko", 85 | user_id: 12345, 86 | origin_link: "https://t.me/miaowu/42065" 87 | } 88 | 89 | expect(buildMsgData(msgCh, settings)).toStrictEqual( 90 | data 91 | ) 92 | }) 93 | 94 | test("channel post", () => { 95 | const data: MessageData = { 96 | message_id: 263, 97 | text: "test", 98 | date: "2025-01-10", 99 | time: "13:03", 100 | name: "📒", 101 | username: "rin", 102 | user_id: -1001234567890, 103 | } 104 | 105 | expect(buildMsgData(channel_post, settings)).toStrictEqual(data) 106 | }) 107 | 108 | test("channel post forward", () => { 109 | 110 | const data: MessageData = { 111 | origin_name: "Haha", 112 | origin_username: "haha", 113 | message_id: 259, 114 | text: "喵呜呜", 115 | date: "2025-01-10", 116 | time: "00:40", 117 | name: "📒", 118 | username: "rin", 119 | user_id: -1001234567890, 120 | origin_link: "https://t.me/haha/2174789" 121 | } 122 | expect(buildMsgData(channel_post_fw, settings)).toStrictEqual(data) 123 | 124 | }) 125 | }); 126 | -------------------------------------------------------------------------------- /test/buildPathData.spec.ts: -------------------------------------------------------------------------------- 1 | import { TGInboxSettings } from "src/settings"; 2 | import { type PathData, buildPathData } from "../src/utils/template"; 3 | import { msg, msgFowardUser, channel_post, channel_post_fw } from "./msgs"; 4 | 5 | describe('generatePath', () => { 6 | test('normal message', () => { 7 | const data: PathData = { 8 | date: "2021-07-21", 9 | first_name: "Neko", 10 | name: "Neko ✨", 11 | time: "14-00", 12 | user_id: 12345, 13 | origin_name: "Neko ✨" 14 | } 15 | 16 | expect(buildPathData(msg)).toStrictEqual(data) 17 | }) 18 | 19 | test('forward message', () => { 20 | 21 | const data: PathData = { 22 | date: "2021-07-21", 23 | first_name: "Neko", 24 | name: "Neko ✨", 25 | time: "14-00", 26 | user_id: 12345, 27 | origin_name: "猫" 28 | } 29 | 30 | expect(buildPathData(msgFowardUser)).toStrictEqual(data) 31 | }) 32 | 33 | test('channel post', () => { 34 | const data: PathData = { 35 | date: "2025-01-10", 36 | first_name: "📒", 37 | name: "📒", 38 | time: "13-03", 39 | user_id: -1001234567890, 40 | origin_name: "📒" 41 | } 42 | expect(buildPathData(channel_post)).toStrictEqual(data) 43 | }) 44 | 45 | test('channel post forward', () => { 46 | const data: PathData = { 47 | date: "2025-01-10", 48 | first_name: "📒", 49 | name: "📒", 50 | time: "00-40", 51 | user_id: -1001234567890, 52 | origin_name: "Haha" 53 | } 54 | expect(buildPathData(channel_post_fw)).toStrictEqual(data) 55 | }) 56 | }) -------------------------------------------------------------------------------- /test/generatePath.spec.ts: -------------------------------------------------------------------------------- 1 | import { TGInboxSettings } from "src/settings"; 2 | import { generatePath, PathData } from "../src/utils/template"; 3 | import { msgFowardUser, channel_post_fw, channel_post } from "./msgs"; 4 | 5 | const settings: TGInboxSettings = { 6 | token: "", 7 | marker: "", 8 | allow_users: [], 9 | download_dir: "", 10 | download_media: false, 11 | message_template: "", 12 | markdown_escaper: false, 13 | is_custom_file: false, 14 | custom_file_path: "/Telegram/{{name}}-{{origin_name}}-{{user_id}}/{{date}}-{{time}}", 15 | disable_auto_reception: true, 16 | reverse_order: false, 17 | remove_formatting: false, 18 | } 19 | 20 | describe('generatePath', () => { 21 | 22 | test('forward message', () => { 23 | const path = "/Telegram/Neko ✨-猫-12345/2021-07-21-14-00" 24 | 25 | expect(generatePath(msgFowardUser, settings)).toBe(path) 26 | }) 27 | 28 | test('channel_post', () => { 29 | const path = "/Telegram/📒-📒--1001234567890/2025-01-10-13-03" 30 | 31 | expect(generatePath(channel_post, settings)).toBe(path) 32 | }) 33 | 34 | test('channel_post_fw', () => { 35 | const path = "/Telegram/📒-Haha--1001234567890/2025-01-10-00-40" 36 | 37 | expect(generatePath(channel_post_fw, settings)).toBe(path) 38 | 39 | }) 40 | }) 41 | -------------------------------------------------------------------------------- /test/msgs.ts: -------------------------------------------------------------------------------- 1 | import { MessageUpdate, MsgChannel, MsgNonChannel } from "../src/type"; 2 | 3 | export const msgHidden: MessageUpdate = { 4 | "message_id": 1234, 5 | "from": { 6 | "id": 12345, 7 | "is_bot": false, 8 | "first_name": "Neko", 9 | "last_name": "✨", 10 | "username": "neko", 11 | "language_code": "en" 12 | }, 13 | "chat": { 14 | "id": 12345, 15 | "first_name": "Neko", 16 | "last_name": "✨", 17 | "username": "neko", 18 | "type": "private" 19 | }, 20 | "date": 1626847200, 21 | "forward_origin": { 22 | "type": "hidden_user", 23 | "sender_user_name": "Black Cat", 24 | "date": 1626847200 25 | }, 26 | "text": "I am a black cat." 27 | } 28 | 29 | export const msg: MessageUpdate = { 30 | "message_id": 1234, 31 | "from": { 32 | "id": 12345, 33 | "is_bot": false, 34 | "first_name": "Neko", 35 | "last_name": "✨", 36 | "username": "neko", 37 | "language_code": "en" 38 | }, 39 | "chat": { 40 | "id": 12345, 41 | "first_name": "Neko", 42 | "last_name": "✨", 43 | "username": "neko", 44 | "type": "private" 45 | }, 46 | "date": 1626847200, 47 | "text": "I am a cat." 48 | } 49 | 50 | export const msgCh: MessageUpdate = { 51 | "message_id": 1234, 52 | "from": { 53 | "id": 12345, 54 | "is_bot": false, 55 | "first_name": "Neko", 56 | "last_name": "✨", 57 | "username": "neko", 58 | "language_code": "en" 59 | }, 60 | "chat": { 61 | "id": 12345, 62 | "first_name": "Neko", 63 | "last_name": "✨", 64 | "username": "neko", 65 | "type": "private" 66 | }, 67 | "date": 1626847200, 68 | "forward_origin": { 69 | "type": "channel", 70 | "chat": { 71 | "id": -1001021086777, 72 | "title": "Many cats every day", 73 | "username": "miaowu", 74 | "type": "channel" 75 | }, 76 | "message_id": 42065, 77 | "date": 1626847200 78 | }, 79 | "text": "Cats rule the earth." 80 | } 81 | 82 | export const msgFowardUser: MessageUpdate = { 83 | "message_id": 1234, 84 | "from": { 85 | "id": 12345, 86 | "is_bot": false, 87 | "first_name": "Neko", 88 | "last_name": "✨", 89 | "username": "neko", 90 | "language_code": "en" 91 | }, 92 | "chat": { 93 | "id": 12345, 94 | "first_name": "Neko", 95 | "last_name": "✨", 96 | "username": "neko", 97 | "type": "private" 98 | }, 99 | "date": 1626847200, 100 | "forward_origin": { 101 | "type": "user", 102 | "sender_user": { 103 | "id": 414141414, 104 | "is_bot": false, 105 | "first_name": "猫", 106 | "username": "cat", 107 | "language_code": "zh-hans" 108 | }, 109 | "date": 1626847200 110 | }, 111 | "text": "喵呜呜～" 112 | } 113 | 114 | export const channel_post_fw: MsgChannel = { 115 | "message_id": 259, 116 | "sender_chat": { 117 | "id": -1001234567890, 118 | "title": "📒", 119 | "type": "channel", 120 | "username": "rin" 121 | }, 122 | "chat": { 123 | "id": -1001234567890, 124 | "title": "📒", 125 | "type": "channel", 126 | "username": "rin" 127 | }, 128 | "date": 1736440840, 129 | "forward_origin": { 130 | "type": "channel", 131 | "chat": { 132 | "id": -100133210000, 133 | "title": "Haha", 134 | "username": "haha", 135 | "type": "channel" 136 | }, 137 | "message_id": 2174789, 138 | "date": 1736440781 139 | }, 140 | "text": "喵呜呜", 141 | } 142 | 143 | export const channel_post: MsgChannel = { 144 | 145 | "message_id": 263, 146 | "sender_chat": { 147 | "id": -1001234567890, 148 | "title": "📒", 149 | "username": "rin", 150 | "type": "channel" 151 | }, 152 | "chat": { 153 | "id": -1001234567890, 154 | "title": "📒", 155 | "username": "rin", 156 | "type": "channel" 157 | }, 158 | "date": 1736485426, 159 | "text": "test" 160 | } 161 | 162 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": ".", 4 | "inlineSourceMap": true, 5 | "inlineSources": true, 6 | "module": "ESNext", 7 | "target": "ES6", 8 | "allowJs": true, 9 | "noImplicitAny": true, 10 | "moduleResolution": "node", 11 | "importHelpers": true, 12 | "isolatedModules": true, 13 | "strictNullChecks": true, 14 | "lib": [ 15 | "DOM", 16 | "ES5", 17 | "ES6", 18 | "ES7" 19 | ] 20 | }, 21 | "include": [ 22 | "**/*.ts" 23 | ] 24 | } 25 | -------------------------------------------------------------------------------- /version-bump.mjs: -------------------------------------------------------------------------------- 1 | import { readFileSync, writeFileSync } from "fs"; 2 | 3 | const targetVersion = process.env.npm_package_version; 4 | 5 | // read minAppVersion from manifest.json and bump version to target version 6 | let manifest = JSON.parse(readFileSync("manifest.json", "utf8")); 7 | const { minAppVersion } = manifest; 8 | manifest.version = targetVersion; 9 | writeFileSync("manifest.json", JSON.stringify(manifest, null, "\t")); 10 | 11 | // update versions.json with target version and minAppVersion from manifest.json 12 | let versions = JSON.parse(readFileSync("versions.json", "utf8")); 13 | versions[targetVersion] = minAppVersion; 14 | writeFileSync("versions.json", JSON.stringify(versions, null, "\t")); 15 | -------------------------------------------------------------------------------- /versions.json: -------------------------------------------------------------------------------- 1 | { 2 | "1.0.0": "0.15.0", 3 | "1.3.0": "1.5.11", 4 | "1.3.1": "1.5.11", 5 | "1.4.0": "1.5.11", 6 | "1.4.1": "1.5.11", 7 | "1.4.2": "1.5.11", 8 | "1.5.0": "1.5.11" 9 | } --------------------------------------------------------------------------------