feat: types

Author: GochoMugo

doc/api.md

@@ -141,6 +141,7 @@ Error code is `"ESESS"`.
     * [.processForm(name, chatID, ref, [options])](#FormSet+processForm)
     * [.process(chatID, text, ref)](#FormSet+process)
     * [.cancel(chatID)](#FormSet+cancel)
+    * [._emitQuery(question, ref)](#FormSet+_emitQuery)
 
 <a name="new_FormSet_new"></a>
 
@@ -274,6 +275,18 @@ Cancel current form processing for chat.
 | --- | --- | --- |
 | chatID | <code>String</code> \| <code>Number</code> | Unique identifier for the originating  chat |
 
+<a name="FormSet+_emitQuery"></a>
+
+### formSet.\_emitQuery(question, ref)
+Emits the `query` event.
+
+**Kind**: instance method of [<code>FormSet</code>](#FormSet)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| question | <code>Object</code> | Query |
+| ref | <code>Object</code> | Reference |
+
 
 * * *
 

index.d.ts

@@ -0,0 +1,135 @@
+export namespace constants {
+    const SESSION_VERSION: number;
+}
+
+export namespace errors {
+    class BaseError {}
+
+    const BusyErrorCode: string;
+    class BusyError {}
+
+    const FormNotFoundErrorCode: string;
+    class FormNotFoundError {}
+
+    const I18nErrorCode: string;
+    class I18nError {}
+
+    const QueryNotFoundErrorCode: string;
+    class QueryNotFoundError {}
+
+    const SessionErrorCode: string;
+    class SessionError {}
+}
+
+interface AddFormOptions<Answers, Ref> {
+    cb?: (
+        answers: Answers,
+        ref: Ref,
+    ) => Promise<any>;
+    i18n?: (
+        text: string,
+        answers: Partial<Answers>,
+        ref: Ref,
+    ) => Promise<any>;
+}
+
+type ChatId = number | string;
+
+export interface Form<Answers, Ref> {
+    name: string;
+    queries: Query<Answers, Ref>[];
+    options: AddFormOptions<Answers, Ref>;
+}
+
+export class FormSet<Answers, Ref> {
+    addForm(
+        formName: string,
+        queries: Query<Answers, Ref>[],
+        options?: AddFormOptions<Answers, Ref>,
+    ): Form<Answers, Ref>;
+
+    cancel(chatId: ChatId): Promise<boolean>;
+
+    getForms(): Form<Answers, Ref>[];
+
+    on(
+        event: "query",
+        cb: (
+            question: {
+                choices: Array<{ text: string }>;
+                text: string;
+            },
+            ref: Ref,
+        ) => void,
+    ): void;
+
+    process(
+        chatId: ChatId,
+        text: string,
+        ref: Ref,
+    ): Promise<void>;
+
+    processForm(
+        formName: string,
+        chatId: ChatId,
+        ref: Ref,
+        options?: {
+            answers?: Answers;
+        },
+    ): Promise<void>;
+}
+
+export interface Query<Answers, Ref> {
+    name?: keyof Answers;
+
+    post?(
+        this: QueryController<Answers, Ref>,
+        answer: string,
+    ): Promise<any>;
+
+    pre?(this: QueryController<Answers, Ref>): Promise<any>;
+
+    question?: {
+        choices?: (string | { id: number | string; text: string })[];
+        strict?: boolean;
+        retryText?: string;
+        text?: string;
+    };
+
+    text?: string;
+}
+
+export interface QueryController<Answers, Ref> {
+    form: Form<Answers, Ref>;
+    formset: FormSet<Answers, Ref>;
+    ref: Ref;
+
+    do<Key extends keyof Answers>(name: Key): Promise<never>;
+    
+    getAnswer<Key extends keyof Answers>(): Answers[Key];
+    getAnswer<Key extends keyof Answers>(name: Key, defaultValue?: any): Answers[Key];
+
+    getAnswers(): Partial<Answers>;
+
+    goto<Key extends keyof Answers>(name: Key): Promise<never>;
+
+    post(): Promise<never>;
+
+    retry(text?: string): Promise<never>;
+
+    send(text: string): Promise<void>;
+
+    setAnswer<Key extends keyof Answers>(key: Key, value: Answers[Key]): void;
+    setAnswer<Key extends keyof Answers>(value: Answers[Key]): void;
+
+    setText(text: string): void;
+
+    skip(): Promise<never>;
+
+    stop(): Promise<never>;
+
+    text(text: string, ctx?: Partial<Answers>): Promise<string>;
+
+    unsetAnswer(): void;
+    unsetAnswer<Key extends keyof Answers>(name: Key): void;
+}

package.json

@@ -12,6 +12,7 @@
     "url": "https://mugo.gocho.live"
   },
   "main": "lib/index.js",
+  "types": "index.d.ts",
   "engines": {
     "node": ">=7"
   },