@tego/core 1.3.44

package/lib/plugin-manager/plugin-manager.d.ts

@@ -0,0 +1,205 @@
+import net from 'node:net';
+import { CleanOptions, Collection, SyncOptions } from '@tachybase/database';
+import { Constructable } from '@tachybase/utils';
+import Application from '../application';
+import { Plugin } from '../plugin';
+import { PluginManagerRepository } from './plugin-manager-repository';
+import { PluginData } from './types';
+export declare const sleep: (timeout?: number) => Promise<unknown>;
+export interface PluginManagerOptions {
+    app: Application;
+    plugins?: any[];
+}
+export interface InstallOptions {
+    cliArgs?: any[];
+    clean?: CleanOptions | boolean;
+    force?: boolean;
+    sync?: SyncOptions;
+}
+export declare class AddPresetError extends Error {
+}
+export declare class PluginManager {
+    options: PluginManagerOptions;
+    /**
+     * @internal
+     */
+    app: Application;
+    /**
+     * @internal
+     */
+    collection: Collection;
+    /**
+     * @internal
+     */
+    pluginInstances: Map<Constructable<Plugin>, Plugin>;
+    /**
+     * @internal
+     */
+    pluginAliases: Map<string, Plugin>;
+    /**
+     * @internal
+     */
+    server: net.Server;
+    /**
+     * @internal
+     */
+    _repository: PluginManagerRepository;
+    /**
+     * @internal
+     */
+    constructor(options: PluginManagerOptions);
+    get repository(): PluginManagerRepository;
+    /**
+     * @internal
+     */
+    static getPackageJson(packageName: string): Promise<any>;
+    /**
+     * @internal
+     */
+    static getPackageName(name: string): Promise<string>;
+    /**
+     * @internal
+     */
+    static getPluginPkgPrefix(): string[];
+    /**
+     * @internal
+     */
+    static findPackage(name: string): Promise<string>;
+    /**
+     * @internal
+     */
+    static clearCache(packageName: string): void;
+    /**
+     * @internal
+     */
+    static resolvePlugin(pluginName: string | typeof Plugin, isUpgrade?: boolean, isPkg?: boolean): Promise<any>;
+    addPreset(plugin: string | typeof Plugin, options?: any): void;
+    getPlugins(): Map<Constructable<Plugin>, Plugin>;
+    getAliases(): MapIterator<string>;
+    get<T extends Plugin>(name: string): Plugin | undefined;
+    get<T extends Plugin>(name: Constructable<T>): T | undefined;
+    get<T extends Plugin>(name: string | Constructable<T>): Plugin | undefined;
+    has<T extends Plugin>(name: string | Constructable<T>): boolean;
+    del<T extends Plugin>(name: string | Constructable<T>): void;
+    create(pluginName: string, options?: {
+        forceRecreate?: boolean;
+    }): Promise<void>;
+    add(plugin?: any, options?: any, insert?: boolean, isUpgrade?: boolean): Promise<void>;
+    /**
+     * @internal
+     */
+    initPlugins(): Promise<void>;
+    /**
+     * @internal
+     */
+    loadCommands(): Promise<void>;
+    load(options?: any): Promise<void>;
+    install(options?: InstallOptions): Promise<void>;
+    enable(name: string | string[]): Promise<void>;
+    disable(name: string | string[]): Promise<void>;
+    remove(name: string | string[], options?: {
+        removeDir?: boolean;
+        force?: boolean;
+    }): Promise<void>;
+    /**
+     * @deprecated
+     */
+    loadOne(plugin: Plugin): Promise<void>;
+    /**
+     * @internal
+     */
+    addViaCLI(urlOrName: string, options?: PluginData): Promise<void>;
+    /**
+     * @internal
+     */
+    addByNpm(options: {
+        packageName: string;
+        name?: string;
+        registry: string;
+        authToken?: string;
+    }): Promise<void>;
+    /**
+     * @internal
+     */
+    addByFile(options: {
+        file: string;
+        registry?: string;
+        authToken?: string;
+        type?: string;
+        name?: string;
+    }): Promise<void>;
+    /**
+     * @internal
+     */
+    addByCompressedFileUrl(options: {
+        compressedFileUrl: string;
+        registry?: string;
+        authToken?: string;
+        type?: string;
+        name?: string;
+    }): Promise<void>;
+    update(options: PluginData): Promise<void>;
+    /**
+     * @internal
+     */
+    upgradeByNpm(values: PluginData): Promise<void>;
+    /**
+     * @internal
+     */
+    upgradeByCompressedFileUrl(options: PluginData): Promise<void>;
+    /**
+     * @internal
+     */
+    getNameByPackageName(packageName: string): string;
+    list(options?: any): Promise<any[]>;
+    /**
+     * @internal
+     */
+    getNpmVersionList(name: string): Promise<string[]>;
+    /**
+     * @internal
+     */
+    loadPresetMigrations(): Promise<{
+        beforeLoad: {
+            up: () => Promise<void>;
+        };
+        afterSync: {
+            up: () => Promise<void>;
+        };
+        afterLoad: {
+            up: () => Promise<void>;
+        };
+    }>;
+    /**
+     * @internal
+     */
+    loadOtherMigrations(): Promise<{
+        beforeLoad: {
+            up: () => Promise<void>;
+        };
+        afterSync: {
+            up: () => Promise<void>;
+        };
+        afterLoad: {
+            up: () => Promise<void>;
+        };
+    }>;
+    /**
+     * @internal
+     */
+    loadPresetPlugins(): Promise<void>;
+    upgrade(): Promise<void>;
+    /**
+     * @internal
+     */
+    initOtherPlugins(): Promise<void>;
+    /**
+     * @internal
+     */
+    initPresetPlugins(): Promise<void>;
+    /**
+     * @internal
+     */
+    initRuntimePlugins(): Promise<void>;
+}
+export default PluginManager;