@types/node-telegram-bot-api - npm Package Compare versions

Comparing version 0.30.0 to 0.30.1

node-telegram-bot-api/index.d.ts

@@ -31,2 +31,14 @@ // Type definitions for node-telegram-bot-api 0.30
 
+    type ChatType = 'private' | 'group' | 'supergroup' | 'channel';
+
+    type ChatAction = 'typing' | 'upload_photo' | 'record_video' | 'upload_video' | 'record_audio' | 'upload_audio' | 'upload_document' | 'find_location' | 'record_video_note' | 'upload_video_note';
+
+    type ChatMemberStatus = 'creator' | 'administrator' | 'member' | 'restricted' | 'left' | 'kicked';
+
+    type DocumentMimeType = 'application/pdf' | 'application/zip';
+
+    type MessageEntityType = 'mention' | 'hashtag' | 'bot_command' | 'url' | 'email' | 'bold' | 'italic' | 'code' | 'pre' | 'text_link' | 'text_mention';
+
+    type ParseMode = 'Markdown' | 'HTML';
+
     /// METHODS OPTIONS ///
@@ -89,3 +101,3 @@ interface PollingOptions {
     interface SendMessageOptions extends SendBasicOptions {
-        parse_mode?: string;
+        parse_mode?: ParseMode;
         disable_web_page_preview?: boolean;
@@ -202,3 +214,3 @@ }
     interface EditMessageTextOptions extends EditMessageCaptionOptions {
-        parse_mode?: string;
+        parse_mode?: ParseMode;
         disable_web_page_preview?: boolean;
@@ -280,3 +292,3 @@ }
         id: number;
-        type: string;
+        type: ChatType;
         title?: string;
@@ -336,3 +348,3 @@ username?: string;
     interface MessageEntity {
-        type: string;
+        type: MessageEntityType;
         offset: number;
@@ -380,13 +392,22 @@ length: number;
 
-    interface InputMediaPhoto {
-        type: string;
+    interface InputMediaBase {
         media: string;
-        fileOptions?: {
-            filename: string;
-            contentType: string;
-        };
+        caption?: string;
+        parse_mode?: ParseMode;
     }
 
-    type InputMediaVideo = InputMediaPhoto;
+    interface InputMediaPhoto extends InputMediaBase {
+        type: 'photo';
+    }
 
+    interface InputMediaVideo extends InputMediaBase {
+        type: 'video';
+        width?: number;
+        height?: number;
+        duration?: number;
+        supports_streaming?: boolean;
+    }
+
+    type InputMedia = InputMediaPhoto | InputMediaVideo;
+
     interface VideoNote extends FileBase {
@@ -480,3 +501,3 @@ length: number;
         user: User;
-        status: string;
+        status: ChatMemberStatus;
         until_date?: number;
@@ -531,4 +552,3 @@ can_be_edited?: boolean;
 
-    interface InlineQueryResult {
-        type: string;
+    interface InlineQueryResultBase {
         id: string;
@@ -538,3 +558,4 @@ reply_markup?: InlineKeyboardMarkup;
 
-    interface InlineQueryResultArticle extends InlineQueryResult {
+    interface InlineQueryResultArticle extends InlineQueryResultBase {
+        type: 'article';
         title: string;
@@ -550,3 +571,4 @@ input_message_content: InputMessageContent;
 
-    interface InlineQueryResultPhoto extends InlineQueryResult {
+    interface InlineQueryResultPhoto extends InlineQueryResultBase {
+        type: 'photo';
         photo_url: string;
@@ -562,3 +584,4 @@ thumb_url: string;
 
-    interface InlineQueryResultGif extends InlineQueryResult {
+    interface InlineQueryResultGif extends InlineQueryResultBase {
+        type: 'gif';
         gif_url: string;
@@ -574,3 +597,4 @@ gif_width?: number;
 
-    interface InlineQueryResultMpeg4Gif extends InlineQueryResult {
+    interface InlineQueryResultMpeg4Gif extends InlineQueryResultBase {
+        type: 'mpeg4_gif';
         mpeg4_url: string;
@@ -586,3 +610,4 @@ mpeg4_width?: number;
 
-    interface InlineQueryResultVideo extends InlineQueryResult {
+    interface InlineQueryResultVideo extends InlineQueryResultBase {
+        type: 'video';
         video_url: string;
@@ -600,3 +625,4 @@ mime_type: string;
 
-    interface InlineQueryResultAudio extends InlineQueryResult {
+    interface InlineQueryResultAudio extends InlineQueryResultBase {
+        type: 'audio';
         audio_url: string;
@@ -610,3 +636,4 @@ title: string;
 
-    interface InlineQueryResultVoice extends InlineQueryResult {
+    interface InlineQueryResultVoice extends InlineQueryResultBase {
+        type: 'voice';
         voice_url: string;
@@ -619,3 +646,4 @@ title: string;
 
-    interface InlineQueryResultDocument extends InlineQueryResult {
+    interface InlineQueryResultDocument extends InlineQueryResultBase {
+        type: 'document';
         title: string;
@@ -632,3 +660,3 @@ caption?: string;
 
-    interface InlineQueryResultLocation extends InlineQueryResult {
+    interface InlineQueryResultLocationBase extends InlineQueryResultBase {
         latitude: number;
@@ -643,3 +671,8 @@ longitude: number;
 
-    interface InlineQueryResultVenue extends InlineQueryResultLocation {
+    interface InlineQueryResultLocation extends InlineQueryResultLocationBase {
+        type: 'location';
+    }
+
+    interface InlineQueryResultVenue extends InlineQueryResultLocationBase {
+        type: 'venue';
         address: string;
@@ -649,3 +682,4 @@ foursquare_id?: string;
 
-    interface InlineQueryResultContact extends InlineQueryResult {
+    interface InlineQueryResultContact extends InlineQueryResultBase {
+        type: 'contact';
         phone_number: string;
@@ -660,7 +694,9 @@ first_name: string;
 
-    interface InlineQueryResultGame extends InlineQueryResult {
+    interface InlineQueryResultGame extends InlineQueryResultBase {
+        type: 'game';
         game_short_name: string;
     }
 
-    interface InlineQueryResultCachedPhoto extends InlineQueryResult {
+    interface InlineQueryResultCachedPhoto extends InlineQueryResultBase {
+        type: 'photo';
         photo_file_id: string;
@@ -673,3 +709,4 @@ title?: string;
 
-    interface InlineQueryResultCachedGif extends InlineQueryResult {
+    interface InlineQueryResultCachedGif extends InlineQueryResultBase {
+        type: 'gif';
         gif_file_id: string;
@@ -681,3 +718,4 @@ title?: string;
 
-    interface InlineQueryResultCachedMpeg4Gif extends InlineQueryResult {
+    interface InlineQueryResultCachedMpeg4Gif extends InlineQueryResultBase {
+        type: 'mpeg4_gif';
         mpeg4_file_id: string;
@@ -689,3 +727,4 @@ title?: string;
 
-    interface InlineQueryResultCachedSticker extends InlineQueryResult {
+    interface InlineQueryResultCachedSticker extends InlineQueryResultBase {
+        type: 'sticker';
         sticker_file_id: string;
@@ -695,3 +734,4 @@ input_message_content?: InputMessageContent;
 
-    interface InlineQueryResultCachedDocument extends InlineQueryResult {
+    interface InlineQueryResultCachedDocument extends InlineQueryResultBase {
+        type: 'document';
         title: string;
@@ -704,3 +744,4 @@ document_file_id: string;
 
-    interface InlineQueryResultCachedVideo extends InlineQueryResult {
+    interface InlineQueryResultCachedVideo extends InlineQueryResultBase {
+        type: 'video';
         video_file_id: string;
@@ -713,3 +754,4 @@ title: string;
 
-    interface InlineQueryResultCachedVoice extends InlineQueryResult {
+    interface InlineQueryResultCachedVoice extends InlineQueryResultBase {
+        type: 'voice';
         voice_file_id: string;
@@ -721,3 +763,4 @@ title: string;
 
-    interface InlineQueryResultCachedAudio extends InlineQueryResult {
+    interface InlineQueryResultCachedAudio extends InlineQueryResultBase {
+        type: 'audio';
         audio_file_id: string;
@@ -728,2 +771,24 @@ caption?: string;
 
+    type InlineQueryResult =
+        InlineQueryResultCachedAudio |
+        InlineQueryResultCachedDocument |
+        InlineQueryResultCachedGif |
+        InlineQueryResultCachedMpeg4Gif |
+        InlineQueryResultCachedPhoto |
+        InlineQueryResultCachedSticker |
+        InlineQueryResultCachedVideo |
+        InlineQueryResultCachedVoice |
+        InlineQueryResultArticle |
+        InlineQueryResultAudio |
+        InlineQueryResultContact |
+        InlineQueryResultGame |
+        InlineQueryResultDocument |
+        InlineQueryResultGif |
+        InlineQueryResultLocation |
+        InlineQueryResultMpeg4Gif |
+        InlineQueryResultPhoto |
+        InlineQueryResultVenue |
+        InlineQueryResultVideo |
+        InlineQueryResultVoice;
+
     type InputMessageContent = object;
@@ -733,3 +798,3 @@
         message_text: string;
-        parse_mode?: string;
+        parse_mode?: ParseMode;
         disable_web_page_preview?: boolean;
@@ -885,3 +950,3 @@ }
 
-    answerInlineQuery(inlineQueryId: string, results: TelegramBot.InlineQueryResult[], options?: TelegramBot.AnswerInlineQueryOptions): Promise<boolean | Error>;
+    answerInlineQuery(inlineQueryId: string, results: ReadonlyArray<TelegramBot.InlineQueryResult>, options?: TelegramBot.AnswerInlineQueryOptions): Promise<boolean | Error>;
 
@@ -896,3 +961,3 @@ forwardMessage(chatId: number | string, fromChatId: number | string, messageId: number | string, options?: TelegramBot.ForwardMessageOptions): Promise<TelegramBot.Message | Error>;
 
-    sendMediaGroup(chatId: number | string, media: Array<TelegramBot.InputMediaPhoto | TelegramBot.InputMediaVideo>, options?: TelegramBot.SendMediaGroupOptions): Promise<TelegramBot.Message | Error>;
+    sendMediaGroup(chatId: number | string, media: ReadonlyArray<TelegramBot.InputMedia>, options?: TelegramBot.SendMediaGroupOptions): Promise<TelegramBot.Message | Error>;
 
@@ -907,3 +972,3 @@ sendSticker(chatId: number | string, sticker: string | Stream | Buffer, options?: TelegramBot.SendStickerOptions): Promise<TelegramBot.Message | Error>;
 
-    sendChatAction(chatId: number | string, action: string): Promise<boolean | Error>;
+    sendChatAction(chatId: number | string, action: TelegramBot.ChatAction): Promise<boolean | Error>;
 
@@ -995,4 +1060,4 @@ kickChatMember(chatId: number | string, userId: string): Promise<boolean | Error>;
 
-    sendInvoice(chatId: number | string, title: string, description: string, payload: string, providerToken: string, startParameter: string, currency: string, prices: TelegramBot.LabeledPrice[],
-                options?: TelegramBot.SendInvoiceOptions): Promise<TelegramBot.Message | Error>;
+    sendInvoice(chatId: number | string, title: string, description: string, payload: string, providerToken: string, startParameter: string, currency: string,
+                prices: ReadonlyArray<TelegramBot.LabeledPrice>, options?: TelegramBot.SendInvoiceOptions): Promise<TelegramBot.Message | Error>;
 
@@ -999,0 +1064,0 @@ answerShippingQuery(shippingQueryId: string, ok: boolean, options?: TelegramBot.AnswerShippingQueryOptions): Promise<boolean | Error>;

node-telegram-bot-api/package.json

 {
     "name": "@types/node-telegram-bot-api",
-    "version": "0.30.0",
+    "version": "0.30.1",
     "description": "TypeScript definitions for node-telegram-bot-api",
@@ -44,4 +44,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "b5609da88cca67f199f5062f990d6a270f35f3c8c54987b73952817ee4eaa913",
+    "typesPublisherContentHash": "e073266d34deb2555174660e0bb42128f2ac811aba2fe59e104da117bbd912d8",
     "typeScriptVersion": "2.3"
 }

node-telegram-bot-api/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Fri, 01 Jun 2018 22:02:05 GMT
+ * Last updated: Wed, 06 Jun 2018 05:14:33 GMT
  * Dependencies: events, stream, https, request, node
@@ -14,0 +14,0 @@ * Global values: none

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

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

Improved metrics

Total package byte prevSize

34576

increased by7.14%

Lines of code

842

increased by6.99%

No dependency changes