chore: readme + exports

This commit is contained in:
alina 🌸 2024-03-07 09:53:30 +03:00
parent 2fe476cf3c
commit 149fa6b49e
Signed by: teidesu
SSH key fingerprint: SHA256:uNeCpw6aTSU4aIObXLvHfLkDa82HWH9EiOj9AXOIRpI
6 changed files with 61 additions and 17 deletions

View file

@ -1,22 +1,46 @@
# @mtcute/file-id # @mtcute/convert
📖 [API Reference](https://ref.mtcute.dev/modules/_mtcute_file_id.html) 📖 [API Reference](https://ref.mtcute.dev/modules/_mtcute_convert.html)
This package is used internally by `@mtcute/core` to parse, serialize This package can be used to convert other libraries sessions to/from mtcute sessions
and manipulate TDLib and Bot API compatible File IDs, but can also be used
for any other purposes.
## Acknowledgements Currently only the libraries that support exporting sessions to strings are supported, namely:
This is basically a port of a portion of TDLib APIs, but greatly
simplified in usage and made to work seamlessly with the rest of the
mtcute APIs.
This is a list of files from TDLib repository, from which most of the code was taken: ## [Telethon](https://github.com/LonamiWebs/Telethon)
- [td/telegram/files/FileManager.cpp](https://github.com/tdlib/td/blob/master/td/telegram/files/FileManager.cpp)
- [td/telegram/files/FileLocation.hpp](https://github.com/tdlib/td/blob/master/td/telegram/files/FileLocation.hpp)
- [td/telegram/PhotoSizeSource.h](https://github.com/tdlib/td/blob/master/td/telegram/PhotoSizeSource.h)
- [td/telegram/PhotoSizeSource.hpp](https://github.com/tdlib/td/blob/master/td/telegram/PhotoSizeSource.hpp)
- [td/telegram/Version.h](https://github.com/tdlib/td/blob/master/td/telegram/Version.h)
Additionally, some of the test cases were taken from a similar Python > Telethon v2 seems to have removed the ability to export sessions,
library, [luckydonald/telegram_file_id](https://github.com/luckydonald/telegram_file_id) > so it's currently not supported
```ts
import { convertFromTelethonSession } from '@mtcute/convert'
const client = new TelegramClient({ ... })
await client.importSession(convertFromTelethonSession("..."))
```
## [Pyrogram](https://github.com/gram-js/gramjs)
```ts
import { convertFromPyrogramSession } from '@mtcute/convert'
const client = new TelegramClient({ ... })
await client.importSession(convertFromPyrogramSession("..."))
```
## GramJS
```ts
import { convertFromGramjsSession } from '@mtcute/convert'
const client = new TelegramClient({ ... })
await client.importSession(convertFromGramjsSession("..."))
```
## [MTKruto](https://github.com/MTKruto/MTKruto)
```ts
import { convertFromMtkrutoSession } from '@mtcute/convert'
const client = new TelegramClient({ ... })
await client.importSession(convertFromMtkrutoSession("..."))
```

View file

@ -0,0 +1,4 @@
export * from './convert.js'
export * from './parse.js'
export * from './serialize.js'
export * from './types.js'

View file

@ -0,0 +1,4 @@
export * from './gramjs/index.js'
export * from './mtkruto/index.js'
export * from './pyrogram/index.js'
export * from './telethon/index.js'

View file

@ -0,0 +1,4 @@
export * from './convert.js'
export * from './parse.js'
export * from './serialize.js'
export * from './types.js'

View file

@ -0,0 +1,4 @@
export * from './convert.js'
export * from './parse.js'
export * from './serialize.js'
export * from './types.js'

View file

@ -0,0 +1,4 @@
export * from './convert.js'
export * from './parse.js'
export * from './serialize.js'
export * from './types.js'