/*****************************************************************************\
|                                               ( )_  _                       |
|    _ _    _ __   _ _    __    ___ ___     _ _ | ,_)(_)  ___   ___     _     |
|   ( '_`\ ( '__)/'_` ) /'_ `\/' _ ` _ `\ /'_` )| |  | |/',__)/' _ `\ /'_`\   |
|   | (_) )| |  ( (_| |( (_) || ( ) ( ) |( (_| || |_ | |\__, \| (˅) |( (_) )  |
|   | ,__/'(_)  `\__,_)`\__  |(_) (_) (_)`\__,_)`\__)(_)(____/(_) (_)`\___/'  |
|   | |                ( )_) |                                                |
|   (_)                 \___/'                                                |
|                                                                             |
| General Bots Copyright (c) Pragmatismo.io. All rights reserved.             |
| Licensed under the AGPL-3.0.                                                |
|                                                                             |
| According to our dual licensing model, this program can be used either      |
| under the terms of the GNU Affero General Public License, version 3,        |
| or under a proprietary license.                                             |
|                                                                             |
| The texts of the GNU Affero General Public License with an additional       |
| permission and of our proprietary license can be found at and               |
| in the LICENSE file you have received along with this program.              |
|                                                                             |
| This program is distributed in the hope that it will be useful,             |
| but WITHOUT ANY WARRANTY, without even the implied warranty of              |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                |
| GNU Affero General Public License for more details.                         |
|                                                                             |
| "General Bots" is a registered trademark of Pragmatismo.io.                 |
| The licensing of the program under the AGPLv3 does not imply a              |
| trademark license. Therefore any rights, title and interest in              |
| our trademarks remain entirely with us.                                     |
|                                                                             |
\*****************************************************************************/


import { IGBCoreService } from './IGBCoreService'
import { Sequelize } from 'sequelize-typescript'
import { GBMinInstance } from '.'
import { GBDialogStep } from './GBDialogStep';

// TODO: Include "use strict" in all files.

export interface IGBPackage{

    /** 
     * Each app has its own set of sys packages. 
     */
    sysPackages: IGBPackage[]

    /** 
     * Called when a package is being loaded, once per server or at demand. 
     */
    loadPackage(core: IGBCoreService, sequelize: Sequelize): void

    /** 
     * Called when a package needs to be unloaded. 
     */
    unloadPackage(core: IGBCoreService): void

   /** 
     * Called when a new bot instance is loaded. 
     */
    getDialogs(min: GBMinInstance) 

    /** 
     * Called when a new bot instance is loaded. 
     */
    loadBot(min: GBMinInstance): void

    /** 
     * Called whenever a bot instance needs to be shutdown.
     */
    unloadBot(min: GBMinInstance): void

    /**
     * Called in each new session. 
     */
    onNewSession(min: GBMinInstance, step: GBDialogStep): void
}