/**
 * The `SimpleCalendar.Hooks` property contains a list of all hooks that the Simple Calendar module can emit, when they are emitted and what information they pass along.
 */
namespace SimpleCalendar.Hooks {
    /**
     * This hook is emitted any time the current date is updated. The current date can be updated by several means:
     *
     * - When the GM clicks on the "Set Current Date" button after adjusting the current date.
     * - When the clock is running every interval update.
     * - When the {@link SimpleCalendar.api.setDate} function is called.
     * - When the {@link SimpleCalendar.api.changeDate} function is called.
     * - When the game world time changed and Simple Calendar is configured to update when that changes.
     *
     * **What is passed**: When this hook is emitted it will pass a {@link SimpleCalendar.Hooks.DateChangeResponse | DateChangeResponse} object.
     *
     * **Examples:**
     *
     * @example How to listen for the hook:
     *   ```javascript
     * Hooks.on(SimpleCalendar.Hooks.DateTimeChange, (data) => {
     *      console.log(data);
     *  });
     * ```
     * Response Data:
     * ```json
     * {
     *   "date": {
     *     "year": 2021,
     *     "month": 6,
     *     "dayOffset": 0,
     *     "day": 8,
     *     "dayOfTheWeek": 5,
     *     "hour": 0,
     *     "minute": 15,
     *     "second": 30,
     *     "yearZero": 1970,
     *     "sunrise": 1622527200,
     *     "sunset": 1622570400,
     *     "midday": 1622548800,
     *     "weekdays": [
     *       "Sunday",
     *       "Monday",
     *       "Tuesday",
     *       "Wednesday",
     *       "Thursday",
     *       "Friday",
     *       "Saturday"
     *     ],
     *     "showWeekdayHeadings": true,
     *     "currentSeason": {
     *       "color": "#f3fff3",
     *       "startingMonth": 5,
     *       "startingDay": 19,
     *       "name": "Summer"
     *     },
     *     "isLeapYear": false,
     *     "display": {
     *       "day": "9",
     *       "daySuffix": "th",
     *       "weekday": "Friday",
     *       "monthName": "July",
     *       "month": "7",
     *       "year": "2021",
     *       "yearName": "",
     *       "yearPrefix": "",
     *       "yearPostfix": "",
     *       "time": "00:15:30"
     *     }
     *   },
     *   "diff": 1,
     *   "moons": [
     *     {
     *       "name": "Moon",
     *       "color": "#ffffff",
     *       "cycleLength": 29.53059,
     *       "cycleDayAdjust": 0.5,
     *       "currentPhase": {
     *         "name": "New Moon",
     *         "length": 1,
     *         "icon": "new",
     *         "singleDay": true
     *       }
     *     }
     *   ]
     * }
     * ```
     */
    const DateTimeChange = 'simple-calendar-date-time-change';
    /**
     * This hook is emitted in the following cases:
     *
     * - When the clock is started.
     * - When the clock is stopped.
     * - When the game is paused or unpaused.
     * - When a combat is started or ended in the active scene
     * - When a combat round is advanced.
     *
     * **What is passed**: When this hook is emitted it will pass a {@link SimpleCalendar.ClockStatus | ClockStatus} object.
     *
     * **Examples:**
     *
     * @example How to listen for the hook:
     *   ```javascript
     * Hooks.on(SimpleCalendar.Hooks.ClockStartStop, (data) => {
     *      console.log(data);
     *  });
     * ```
     * Response Data:
     * ```json
     * {
     *   "started": false,
     *   "stopped": true,
     *   "paused": false
     * }
     * ```
     */
    const ClockStartStop = 'simple-calendar-clock-start-stop';
    /**
     * This hook is emitted when the current users is promoted to the primary GM role.
     *
     * This will happen 5 seconds after loading the game if no other GM is currently in the primary role.
     *
     * **What is passed**: When this hook is emitted it will pass a {@link SimpleCalendar.Hooks.IsPrimaryGmResponse | IsPrimaryGmResponse} object.
     *
     * **Examples:**
     *
     * @example How to listen for the hook:
     *   ```javascript
     * Hooks.on(SimpleCalendar.Hooks.PrimaryGM, (data) => {
     *      console.log(data);
     *  });
     * ```
     * Response Data:
     * ```json
     * {
     *   "isPrimaryGM": true
     * }
     * ```
     */
    const PrimaryGM = 'simple-calendar-primary-gm';
    /**
     * This hook is emitted while Simple Calendar is initializing, before the module is ready to use.
     *
     * **What is passed**: No data is passed when this hook is fired.
     *
     * **Examples:**
     *
     * @example How to listen for the hook:
     *   ```javascript
     * Hooks.on(SimpleCalendar.Hooks.Init, () => {
     *      console.log(`Simple Calendar is initializing!`);
     *  });
     * ```
     */
    const Init = 'simple-calendar-init';
    /**
     * This hook is emitted when Simple Calendar is fully initialized and ready to use.
     *
     * For GMs this will happen up to 5 seconds after loading the game as additional checks are done to see which GM is to be considered the primary GM.
     *
     * **What is passed**: No data is passed when this hook is fired.
     *
     * **Examples:**
     *
     * @example How to listen for the hook:
     *   ```javascript
     * Hooks.on(SimpleCalendar.Hooks.Ready, () => {
     *      console.log(`Simple Calendar is ready!`);
     *  });
     * ```
     */
    const Ready = 'simple-calendar-ready';


    /**
     * The structure of the object passed when the Simple Calendar module emits a {@link SimpleCalendar.Hooks.DateTimeChange} hook
     */
    interface DateChangeResponse {
        /** This contains all information about the current date. */
        date: DateData;
        /** This contains the difference in seconds from the previous date and time to this new date and time. */
        diff: number;
        moons: MoonData[];
    }

    /**
     * The structure of the object passed when the Simple Calendar module emits a {@link SimpleCalendar.Hooks.PrimaryGM} hook
     */
    interface IsPrimaryGmResponse {
        /** If the user is the primary gm (true). */
        isPrimaryGM: boolean;
    }
}