typegram - npm Package Compare versions

Comparing version 2.3.3 to 3.0.0

alias.d.ts

@@ -0,1 +1,3 @@
+import { Typegram } from "./proxied";
+
 export type Integer = number;
@@ -6,1 +8,35 @@ export type Float = number;
 export type True = true;
+
+/** This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser. */
+export type InputFile = String;
+
+type DefaultTypegram = Typegram<InputFile>;
+
+/** Wrapper type to bundle all methods of the Telegram API */
+export type Telegram = DefaultTypegram["Telegram"];
+
+/** Utility type providing the argument type for the given method name or `{}` if the method does not take any parameters */
+export type Opts<
+  M extends keyof DefaultTypegram["Telegram"]
+> = DefaultTypegram["Opts"][M];
+
+/** Utility type providing a promisified version of Telegram */
+export type TelegramP = DefaultTypegram["TelegramP"];
+
+/** This object represents the content of a media message to be sent. It should be one of
+- InputMediaAnimation
+- InputMediaDocument
+- InputMediaAudio
+- InputMediaPhoto
+- InputMediaVideo */
+export type InputMedia = DefaultTypegram["InputMedia"];
+/** Represents a photo to be sent. */
+export type InputMediaPhoto = DefaultTypegram["InputMediaPhoto"];
+/** Represents a video to be sent. */
+export type InputMediaVideo = DefaultTypegram["InputMediaVideo"];
+/** Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. */
+export type InputMediaAnimation = DefaultTypegram["InputMediaAnimation"];
+/** Represents an audio file to be treated as music to be sent. */
+export type InputMediaAudio = DefaultTypegram["InputMediaAudio"];
+/** Represents a general file to be sent. */
+export type InputMediaDocument = DefaultTypegram["InputMediaDocument"];

index.d.ts

@@ -1,3 +0,9 @@
-export * from './alias'
-export * from './types'
-export * from './methods'
+export * from "./alias";
+export * from "./callback";
+export * from "./inline";
+export * from "./manage";
+export * from "./message";
+export * from "./passport";
+export * from "./payment";
+export * from "./proxied";
+export * from "./update";

package.json

 {
   "name": "typegram",
-  "version": "2.3.3",
+  "version": "3.0.0",
   "description": "Type declarations for the Telegram API",
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "repository": {
@@ -13,12 +10,16 @@ "type": "git",
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "keywords": [
+    "telegram",
+    "telegraf",
+    "bot",
+    "api",
+    "types",
+    "typings"
+  ],
+  "author": "KnorpelSenf",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/KnorpelSenf/typegram/issues"
   },
-  "homepage": "https://github.com/KnorpelSenf/typegram#readme",
-  "devDependencies": {
-    "@types/node": "^14.14.8"
-  }
+  "homepage": "https://github.com/KnorpelSenf/typegram#readme"
 }

README.md

@@ -32,7 +32,7 @@ # Types for the Telegram API
 
-(Naturally, when the API specification is actually modelling types to be unions (e.g. `InputMedia`), this is reflected here as a union type, too.)
+(Naturally, when the API specification is actually modelling types to be unions (e.g. `InlineQueryResult`), this is reflected here as a union type, too.)
 
 ## Available Methods
 
-In addition to the types, this package provides you with another `interface Telegram` which contains all available **methods** of the API.
+In addition to the types, this package provides you with another type `Telegram` which contains all available **methods** of the API.
 There is no further structure applied to this, but if you can come up with something reasonable, please suggest it in an issue or directly open a PR.
@@ -46,3 +46,3 @@
 
-## Caveat with JSON-serialized objects
+## Caveat with JSON-Serialized Objects
 
@@ -74,4 +74,59 @@ Some methods of the Telegram API are expected to be called with JSON-serialized objects contained in a property of the payload, rather than an actual JSON payload.
 
-## Where do the types come from
+## Customizing `InputFile`
 
+The Telegram API lets bots send files in [three different ways](https://core.telegram.org/bots/api#sending-files).
+Two of those ways are by specifying a `string`—either a `file_id` or a URL.
+The third option, however, is by uploading files to the server.
+
+Depending on the code you're using the `typegram` types for, you may want to support different ways to specify the file to be uploaded.
+As an example, you may want to be able to make calls to `sendDocument` with an object that conforms to `{ path: string }` in order to specify the location of a local file.
+(Your code is then assumed to able to handle calls to `sendDocument` and the like when supplied with an object alike `{ path: '/tmp/file.txt' }` for the `document` property of the argument object.)
+
+`typegram` cannot possibly know what objects you want to support as `InputFile`s.
+Consequently, the exposed type `InputFile` is merely an alias for `string`, thus covering the first two means to send a file.
+
+However, you can specify your own version of what an `InputFile` is, hence effectively creating a completely new version of `typegram` with your custom `InputFile` type used throughout all affected methods and interfaces.
+
+For instance, let's stick with our example and say that you want to support `InputFile`s of the following type.
+
+```ts
+interface MyInputFile {
+  path: string;
+}
+```
+
+You can then customize `typegram` to fit your needs by
+
+1. importing the magical `Typegram` proxy type and
+2. setting this alias:
+
+```ts
+type MyTypegram = Typegram<MyInputFile>;
+```
+
+You can now access all types that must respect `MyInputFile` through the `MyTypegram` type:
+
+```ts
+// The `Telegram` type that contains all API methods:
+type Telegram = MyTypegram["Telegram"];
+// or, respectively
+type TelegramP = MyTypegram["TelegramP"];
+
+// The utility type `Opts`:
+type Opts<M extends keyof Telegram> = MyTypegram["Opts"][M];
+
+// The adjusted `InputMedia*` types:
+type InputMedia = MyTypegram["InputMedia"];
+type InputMediaPhoto = MyTypegram["InputMediaPhoto"];
+type InputMediaVideo = MyTypegram["InputMediaVideo"];
+type InputMediaAnimation = MyTypegram["InputMediaAnimation"];
+type InputMediaAudio = MyTypegram["InputMediaAudio"];
+type InputMediaDocument = MyTypegram["InputMediaDocument"];
+```
+
+All other interfaces are unaffected by the customization through `MyInputFile`.
+They can simply continued to be imported directly from `typegram`.
+
+## Where Do the Types Come from
+
 They're handwritten.
@@ -78,0 +133,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

209239

increased by3.56%

Dev dependency count

0

decreased by-100%

Number of package files

15

increased by66.67%

Number of low license alerts

0

decreased by-100%

Lines of code

3436

increased by1.3%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

139

increased by65.48%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes