Merge pull request #3624 from SillyTavern/server-events Add server events emitter

35b72cc6e650286ea2b7001a92865616cce37630

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed

index.d.ts+31 -3 Viewed

 import { UserDirectoryList, UserEventEmitter } from "./src/users"'node:events';
 import { CommandLineArgumentsCsrfSyncedToken } from "./src/command'csrf-line"sync';
 import { CsrfSyncedTokenUserDirectoryList, User } from "csrf-sync"'./src/users.js';
 +import { CommandLineArguments } from './src/command-line.js';
 +import { EVENT_NAMES } from './src/server-events.js';
++
 +/**
 + * Event payload for SERVER_STARTED event.
 + */
 +export interface ServerStartedEvent {
 +    /**
 +     * The URL the server is listening on.
 +     */
 +    url: URL;
 +}
++
 +/**
 + * Map of all server events to their payload types.
 + */
 +export interface ServerEventMap {
 +    [EVENT_NAMES.SERVER_STARTED]: [ServerStartedEvent];
 +}
 declare global {
 +    declare namespace NodeJS {
 +        export interface Process {
 +            /**
 +             * A global instance of the server events emitter.
 +             */
 +            serverEvents: EventEmitter<ServerEventMap>;
 +        }
 +    }
++
     declare namespace CookieSessionInterfaces {
         export interface CookieSessionObject {
             /**

server.js+2 -0 Viewed

 import open from 'open';
 // local library imports
 +import { serverEvents, EVENT_NAMES } from './src/server-events.js';
 import { CommandLineParser } from './src/command-line.js';
 import { loadPlugins } from './src/plugin-loader.js';
 import {

     console.log('\n' + getSeparator(plainGoToLog.length) + '\n');
     setupLogLevel();
 +    serverEvents.emit(EVENT_NAMES.SERVER_STARTED, { url: autorunUrl });
+}
 /**

src/server-events.js+21 -0 Viewed

 +import EventEmitter from 'node:events';
 +import process from 'node:process';
++
 +/**
 + * @typedef {import('../index').ServerEventMap} ServerEventMap
 + * @type {EventEmitter<ServerEventMap>} The default event source.
 + */
 +export const serverEvents = new EventEmitter();
 +process.serverEvents = serverEvents;
 +export default serverEvents;
++
 +/**
 + * @enum {string}
 + * @readonly
 + */
 +export const EVENT_NAMES = Object.freeze({
 +    /**
 +     * Emitted when the server has started.
 +     */
 +    SERVER_STARTED: 'server-started',
 +});