Typing updates (telegraf#993)

* chore(npm): dont create an package-lock in the first place

* chore(typings): dont explicitly list only a few files

* fix(typings): ctx.match can be null

normaliseTriggers and RegExp.exec can both return null

* fix(typings): branch predicate function can return Promise

* fix(typings): MessageMedia.media can be InputFile

* fixup! chore(typings): dont explicitly list only a few files

* fix(typings): hears function has generic type

* feat(typings): export interfaces facing public

d.ts files only include public facing interfaces...

Author: EdJoPaTo

.npmrc

@@ -0,0 +1 @@
+package-lock=false

tsconfig.json

@@ -16,9 +16,7 @@
     "noEmit": true,
     "forceConsistentCasingInFileNames": true
   },
-  "files": [
-    "typings/index.d.ts",
-    "typings/telegram-types.d.ts",
-    "typings/test.ts"
+  "include": [
+    "typings"
   ]
 }

typings/composer.d.ts

@@ -3,7 +3,8 @@
 import * as tt from './telegram-types.d'
 import { TelegrafContext } from './context'
 
-type HearsTriggers = string[] | string | RegExp | RegExp[] | Function
+type HearsTriggers<TContext> = string[] | string | RegExp | RegExp[] | ((value: string, ctx: TContext) => RegExpExecArray | null)
+type BranchPredicate<TContext> = boolean | ((ctx: TContext) => boolean | Promise<boolean>)
 
 export interface MiddlewareFn<TContext extends TelegrafContext> {
   /*
@@ -51,15 +52,15 @@ export declare class Composer<TContext extends TelegrafContext>
    * Registers middleware for handling text messages.
    */
   hears(
-    triggers: HearsTriggers,
+    triggers: HearsTriggers<TContext>,
     ...middlewares: ReadonlyArray<Middleware<TContext>>
   ): this
 
   /**
    * Registers middleware for handling callbackQuery data with regular expressions
    */
   action(
-    triggers: HearsTriggers,
+    triggers: HearsTriggers<TContext>,
     ...middlewares: ReadonlyArray<Middleware<TContext>>
   ): this
 
@@ -111,15 +112,15 @@ export declare class Composer<TContext extends TelegrafContext>
    * Generates middleware for handling matching text messages.
    */
   static hears<TContext extends TelegrafContext>(
-    triggers: HearsTriggers,
+    triggers: HearsTriggers<TContext>,
     ...middlewares: ReadonlyArray<Middleware<TContext>>
   ): MiddlewareFn<TContext>
 
   /**
    * Generates middleware for handling matching callback queries.
    */
   static action<TContext extends TelegrafContext>(
-    triggers: HearsTriggers,
+    triggers: HearsTriggers<TContext>,
     ...middlewares: ReadonlyArray<Middleware<TContext>>
   ): MiddlewareFn<TContext>
 
@@ -138,23 +139,30 @@ export declare class Composer<TContext extends TelegrafContext>
    * @param middleware middleware to run if the predicate returns true
    */
   static optional<TContext extends TelegrafContext>(
-    test: boolean | ((ctx: TContext) => boolean),
+    predicate: BranchPredicate<TContext>,
     ...middlewares: ReadonlyArray<Middleware<TContext>>
   ): MiddlewareFn<TContext>
 
   /**
    * Generates filter middleware.
    */
   static filter<TContext extends TelegrafContext>(
-    test: boolean | ((ctx: TContext) => boolean)
+    predicate: BranchPredicate<TContext>
   ): MiddlewareFn<TContext>
 
+  /**
+   * Generates drop middleware.
+   */
+  static drop<TContext extends TelegrafContext>(
+    predicate: BranchPredicate<TContext>
+  ): Middleware<TContext>
+
   /**
    * @param trueMiddleware middleware to run if the predicate returns true
    * @param falseMiddleware middleware to run if the predicate returns false
    */
   static branch<TContext extends TelegrafContext>(
-    test: boolean | ((ctx: TContext) => boolean),
+    predicate: BranchPredicate<TContext>,
     trueMiddleware: Middleware<TContext>,
     falseMiddleware: Middleware<TContext>
   ): MiddlewareFn<TContext>

typings/context.d.ts

@@ -19,7 +19,7 @@ export declare class TelegrafContext {
   editedMessage?: tt.Message
   from?: tt.User
   inlineQuery?: tt.InlineQuery
-  match?: RegExpExecArray
+  match?: RegExpExecArray | null
   me?: string
   message?: tt.IncomingMessage
   preCheckoutQuery?: tt.PreCheckoutQuery

typings/markup.d.ts

@@ -69,7 +69,7 @@ export interface PayButton {
   hide: boolean
 }
 
-interface LoginUrl {
+export interface LoginUrl {
   url: string
   forward_text?: string
   bot_username?: string
@@ -91,7 +91,7 @@ export type InlineKeyboardButton =
   | PayButton
   | LoginButton
 
-interface KeyboardOptions<TBtn> {
+export interface KeyboardOptions<TBtn> {
   columns?: number
   wrap?(btn: TBtn, index: number, currentRow: TBtn[]): boolean
 }

typings/telegraf.d.ts

@@ -13,7 +13,7 @@ import { TelegrafContext } from './context'
 import { Composer } from './composer'
 import { Telegram, TelegramOptions } from './telegram'
 
-interface TelegrafOptions {
+export interface TelegrafOptions {
   /**
    * Telegram options
    */
@@ -25,7 +25,7 @@ interface TelegrafOptions {
   username?: string
 }
 
-interface LaunchPollingOptions {
+export interface LaunchPollingOptions {
   /**
    * Poll timeout in seconds
    */
@@ -47,7 +47,7 @@ interface LaunchPollingOptions {
   stopCallback?: () => void | null
 }
 
-interface LaunchWebhookOptions {
+export interface LaunchWebhookOptions {
   /**
    * Public domain for webhook. If domain is not specified, hookPath should contain a domain name as well (not only path component).
    */
@@ -185,7 +185,7 @@ export declare class Telegraf<
   catch(logFn?: Function): void
 }
 
-interface TOptions {
+export interface TOptions {
   /**
    * Telegram options
    */

typings/telegram-types.d.ts

@@ -93,14 +93,14 @@ export type MessageMedia =
 
 export interface InputMediaPhoto {
   type: string
-  media: string
+  media: InputFile
   caption?: string
   parse_mode?: string
 }
 
 export interface InputMediaVideo {
  type: string
- media: string
+ media: InputFile
  thumb?: string | InputFile
  caption?: string
  parse_mode?: string
@@ -112,7 +112,7 @@ export interface InputMediaVideo {
 
 export interface InputMediaAnimation {
  type: string
- media: string
+ media: InputFile
  thumb?: string | InputFile
  caption?: string
  parse_mode?: string
@@ -124,7 +124,7 @@ export interface InputMediaAnimation {
 
 export interface InputMediaAudio {
  type: string
- media: string
+ media: InputFile
  thumb?: string | InputFile
  caption?: string
  parse_mode?: string
@@ -136,7 +136,7 @@ export interface InputMediaAudio {
 
 export interface InputMediaDocument {
  type: string
- media: string
+ media: InputFile
  thumb?: string | InputFile
  caption?: string
  parse_mode?: string
@@ -150,19 +150,19 @@ export interface StickerData {
 
 type FileId = string
 
-interface InputFileByPath {
+export interface InputFileByPath {
   source: string
 }
 
-interface InputFileByReadableStream {
+export interface InputFileByReadableStream {
   source: NodeJS.ReadableStream
 }
 
-interface InputFileByBuffer {
+export interface InputFileByBuffer {
   source: Buffer
 }
 
-interface InputFileByURL {
+export interface InputFileByURL {
   url: string
   filename: string
 }