@foxpage/foxpage-types/lib/manager/main.d.ts

foxpage sdk types

import { ApplicationHooks, ApplicationOption, FoxRoute } from '../application';
import { Application } from '../application';
import { FPEventEmitter } from '../common';
import { ContentDetail } from '../content';
import { LOGGER_USE_LEVEL } from '../logger';
import { FoxpageReporter } from '../reporter';
import { FoxpageHooks } from '..';
import { ManagerEvents } from './event';
export interface ManagerBase<_T> extends FPEventEmitter<ManagerEvents> {
    appId: string;
    appSlug: string;
    exist(key: string): Promise<boolean>;
    destroy(): void;
}
/**
 * manager application meta data
 *
 * @export
 * @interface ManagerAppMeta
 */
export interface ManagerAppMeta extends ApplicationOption {
    /**
     * application id
     *
     * @type {string}
     */
    appId: string;
}
/**
 * dataService option
 * provider dataService config
 * @export
 * @interface DataServiceOption
 */
export interface DataServiceOption {
    /**
     * api host
     *
     * @type {string}
     */
    host: string;
    /**
     * api path
     *
     * @type {string}
     */
    path: string;
    /**
     * response timeout
     *
     * @type {number}
     */
    timeout?: number;
    /**
     * runtime config
     */
    runtimeOpt?: Omit<DataServiceOption, 'runtimeOpt'>;
}
/**
 * manager option
 * provider manager config
 * @export
 * @interface ManagerOption
 */
export interface ManagerOption {
    /**
     * application list
     * metadata
     * @type {ManagerAppMeta[]}
     */
    apps: ManagerAppMeta[];
    /**
     * dataService option
     *
     * @type {DataServiceOption}
     */
    dataService: DataServiceOption;
    /**
     * common plugins
     *
     * @type {string[]}
     */
    plugins?: string[];
    /**
     * common plugin dir
     *
     * @type {string}
     */
    commonPluginDir?: string;
    /**
     *  settings
     */
    settings: {
        /**
         * is open source update
         *
         * @type {boolean}
         */
        openSourceUpdate?: boolean;
        sourceUpdateHook?: ApplicationHooks['sourceUpdateHook'];
    };
    /**
     * process info
     *
     * @type {{
     *     isMaster?: boolean;
     *     procId?: number;
     *   }}
     */
    procInfo?: {
        isMaster?: boolean;
        procId?: number;
    };
    /**
     * logger config
     *
     * @type {{
     *     level?: LOGGER_USE_LEVEL
     *   }}
     */
    loggerConfig?: {
        level?: LOGGER_USE_LEVEL;
    };
    /**
     * foxpage reporter
     */
    reporter?: FoxpageReporter;
}
export interface Manager {
    hooks: FoxpageHooks | undefined;
    prepare(): Promise<void>;
    registerApplications(appMates: ManagerOption['apps']): void;
    unRegisterApplications(appIds: string[]): void;
    removeApplications(appIds: string[]): void;
    existApplication(appId: string): boolean;
    existApplicationBySlug(appName: string): boolean;
    getApplication(appId: string): Application | undefined;
    getApplicationBySlug(name: string): Application | undefined;
    getApplicationByPath(path: string): {
        app: Application;
        matchedRoute?: FoxRoute;
    } | undefined;
    getApplications(appIds?: string[]): Application[];
    clear(): void;
}
export interface ManagerSource extends ContentDetail {
}