clevertype/index.d.ts

An extensive Javascript/Typescript API wrapper for Cleverbot

declare module "clevertype" {
    export type CleverbotState = string;

    export interface Mood {
        emotion ?: number;
        engagement ?: number;
        regard ?: number;
    }

    export interface Config {
        apiKey : string;
        cs ?: CleverbotState;
        mood : Mood;
    }

    export type UserInput = string;
    export type CleverbotResponse = string;

    export type Interaction  = [UserInput, CleverbotResponse];

    export interface ChatHistory {
        input: UserInput;
        response: CleverbotResponse;
        number : number;
        mood: Mood;
        requestDate: Date;
        responseDate: Date;
        delay: number;
        getConversation(): Interaction
    }

    export interface APIResponse {
        cs : CleverbotState;
        interaction_count: string;
        output: string;
        input: string;
        input_other: string;
        predicted_input: string;
        filtered_input: string;
        filtered_input_other: string;
        input_label: string;
        emotion: string;
        emotion_tone: string;
        emotion_values: string;
        accuracy: string;
        conversation_id: string;
        database_version: string;
        errorline: string;
        reaction: string;
        reaction_tone: string;
        reaction_values: string;
        CSRES30: string;
        clever_accuracy: string;
        clever_output: string;
        clever_match: string;
        callback: string;
        time_elapsed: string;
        time_taken: string;
        random_number: string;
        time_second: string;
        time_minute: string;
        time_hour: string;
        time_day_of_week: string;
        time_day: string;
        time_month: string;
        time_year: string;
    }

    export class User {
        public id: string;
        public mood: Mood ;
        public messages: number;
        public history :ChatHistory[];
        public cs?: CleverbotState;
        public getFirst() : Interaction;
        public getLast() : Interaction;
    }

    export class Cleverbot {
        private endpoint : string;
        private config : Config;
        private CleverbotState : CleverbotState;
        private readonly numberOfAPICalls : number;
        private readonly wrapperName : string;
        private readonly encodedWrapperName: string;
        public constructor(apiKey: string | Config, multiUser?: boolean);
        private encodedEmotion(emotion?: number );
        private encodedEngagement(engagement?: number);
        private encodedRegard(regard?: number);
        private encodedCleverbotState(state?: string);
        private static encodeInput(input: string);
        private setCleverbotState(state:string, id?:string|number);
        private createHistory(userInput: string, cleverbotResponse: string, id: string | number, requestDate: Date);
        private static createUser(id: string, eng?: number, emo?: number, reg?: number);
        private resolveUser(user: number | string, safe?: boolean);
        public readonly apiKey: string;
        public readonly users: User[];
        public readonly callAmount : number;
        public say(message: string, user?: string | number): Promise<string>;
        public setEmotion(amount: number, user?: number | string): void;
        public setEngagement(amount: number, user?: number | string): void;
        public setRegard(amount: number, user?: number | string): void;
        public mood(user?: string | number): Mood;
        public getUser(user: string | number): User;
        public getHistory(user: string | number): ChatHistory[];

    }
}