plugin-tls 0.0.0 → 1.0.0

package/README.md

@@ -1,5 +1,5 @@
-[教程]: ./docs/教程.md
-[API接口文档]: ./doc/index.md
+[教程]: ./doc/教程.md
+[API接口文档]: ./doc/api/index.md
 
 [GitHub仓库]: https://github.com/GuoBinyong/library-vite-template
 [发行地址]: https://github.com/GuoBinyong/library-vite-template/releases
@@ -55,13 +55,13 @@
 
 
 ## 3.1. 方式1：通过 npm 安装
+通过 npm （或 yarn、pnpm 等包管理器）安装
 ```
 npm install library-vite-template
 ```
 
 
 
-
 ## 3.2. 方式3：通过`<script>`标签引入
 您可直接从项目的 [发行地址][] 中下载以 `.iife.js` 作为缀的文件，然后使用如下代码引用 和 使用 library-vite-template：
 
@@ -71,10 +71,10 @@ npm install library-vite-template
    <script src="path/to/package/library-vite-template.iife.js"></script>
    ```
    
-2. 使用全局的 `library-vite-template`
+2. 使用全局的 `LibraryViteTemplate`
    ```
    <script>
-   // 使用全局的 library-vite-template
+   // 使用全局的 LibraryViteTemplate
    </script>
    ```
 

package/dist/index.d.ts

@@ -1,22 +1,254 @@
+import { AnyFunction, Optional } from 'type-tls';
+
 /**
- * 插件系统
+ * 插件宿主的实例类型
+ */
+export declare type HostInst<H> = H extends new (...args: any) => any ? InstanceType<H> : H;
+/**
+ * 插件的接口
+ *
+ * @typeParam HOST - 插件宿主的类类型
+ * @typeParam Options - 插件的选项类型
+ */
+export interface IPlugin<HOST, Options = any> {
+	/**
+	 * 当插件被注册时调用
+	 * @param Host - 宿主的类型
+	 * @param options - 注册插件时的选项
+	 */
+	used(Host: HOST, options?: Options): any;
+	/**
+	 * 当宿主实例被创建时调用
+	 * @param host - 新建的宿主实例
+	 * @param options - 注册插件时的选项
+	 */
+	created?(host: HostInst<HOST>, options?: Options): any;
+}
+export declare type PluginOptions = any;
+/**
+ * 插件的 used 方法的返回值类型
+ */
+export declare type PluginUseReturnType<P extends IPlugin<any>> = ReturnType<P["used"]>;
+/**
+ * 插件的 created 方法的返回值类型
+ */
+export declare type PluginCreatedReturnType<P extends IPlugin<any>> = P["created"] extends AnyFunction ? ReturnType<P["created"]> : void;
+/**
+ * 插件管理者
  *
  * @remarks
- * 主要负责 SDK 的插件机制的实现
- * 插件系统应该具备以下功能：
- * - 注册插件
- * - 可扩展类的静态级功能
- * - 可扩展类的实例级功能
- * - 可自定义暴露的功能
- * - 可拥有私有自身的API
- *
- * 额外的也提供了其它的功能
- * - 全局选项
- * - 实例选项
- *
- * @packageDocumentation
- */
-export * from "./PluginManager";
-export * from "./PluginHost";
-export * from "./OptionsPluginHost";
-export * from "./defaultOptions";
+ * 负责管理插件的注册、应用 等
+ */
+export declare class PluginManager<HOST> {
+	/**
+	 * 插件的宿主
+	 */
+	host: HOST;
+	/**
+	 * 插件与插件选项的映射
+	 */
+	pluginOptsMap: Map<IPlugin<HOST, any>, any>;
+	/**
+	 * 注册的插件
+	 */
+	plugins: IPlugin<HOST>[];
+	/**
+	 * 使用插件、注册插件
+	 * @param plugin - 插件
+	 * @param options - 传递给插件的选项
+	 */
+	use<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(plugin: Plugin, options?: Options): PluginUseReturnType<Plugin> | undefined;
+	/**
+	 * 插件宿主创建实例时调用
+	 *
+	 * @remarks
+	 * 会调用每个插件的 {@link IPlugin.created | IPlugin.created()} 方法
+	 * @param hostInst - 插件宿主的新实例
+	 */
+	created(hostInst: HostInst<HOST>): void;
+	/**
+	 * 插件宿主实例的注册插件的方法
+	 *
+	 * @remarks
+	 * 会调用每个插件的 {@link IPlugin.created | IPlugin.created()} 方法
+	 * @param hostInst - 插件宿主的新实例
+	 */
+	instUse<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(hostInst: HostInst<HOST>, plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+/**
+ * 插件宿主的接口
+ */
+export interface IPluginHost<HOST> {
+	/**
+  * PluginHost 的插件管理器
+  */
+	get pluginManager(): PluginManager<HOST>;
+	/**
+  * 实例的注册插件的方法
+  * @param plugin
+  * @param options
+  * @returns
+  */
+	use<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+/**
+ * 插件宿主构造函数的接口
+ */
+export interface IPluginHostConstructor<HOST> {
+	/**
+   * PluginHost 的插件管理器
+   */
+	get pluginManager(): PluginManager<HOST>;
+	/**
+	 * {@inheritDoc PluginManager.use}
+	 */
+	use<Plugin extends IPlugin<HOST, Options>, Options>(plugin: Plugin, options: Options): PluginUseReturnType<Plugin> | undefined;
+}
+/**
+ * 插件的宿主
+ *
+ * @remarks
+ * 插件宿主 就是 拥有插件机制的宿主
+ */
+export declare class PluginHost {
+	/**
+	 * 插件管理器
+	 */
+	static get pluginManager(): PluginManager<any>;
+	static _pluginManager: PluginManager<any>;
+	/**
+	 * 插件管理器 {@link PluginHost.pluginManager}
+	 */
+	get pluginManager(): PluginManager<any>;
+	/**
+	 * {@inheritDoc PluginManager.use}
+	 */
+	static use<Plugin extends IPlugin<HOST, Options>, Options extends PluginOptions, HOST = typeof PluginHost>(plugin: Plugin, options: Options): ReturnType<Plugin["used"]> | undefined;
+	constructor();
+	/**
+	 * 实例的注册插件的方法
+	 * @param plugin
+	 * @param options
+	 * @returns
+	 */
+	use<Options extends PluginOptions, Plugin extends IPlugin<typeof PluginHost, Options>>(plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+/**
+ * 创建插件的缩主类
+ *
+ * @remarks
+ * 比 直接使用 PluginHost 提供了完善的类型推导
+ * @returns
+ */
+export declare function createPluginHost<HOST>(): {
+	new (): {
+		/**
+	 *  插件管理器 {@link CEarth.pluginManager}
+	 */
+		readonly pluginManager: PluginManager<HOST>;
+		/**
+	 * 实例的注册插件的方法
+	 * @param plugin
+	 * @param options
+	 * @returns
+	 */
+		use<Options extends unknown, Plugin_1 extends IPlugin<HOST, Options>>(plugin: Plugin_1, options?: Options | undefined): PluginCreatedReturnType<Plugin_1> | undefined;
+	};
+	/**
+	 * PluginHost 的插件管理器
+	 */
+	readonly pluginManager: PluginManager<HOST>;
+	_pluginManager: PluginManager<HOST>;
+	/**
+	 * {@inheritDoc PluginManager.use}
+	 */
+	use<Options_1>(plugin: IPlugin<HOST, Options_1>, options: Options_1): any;
+};
+/**
+ * 插件缩主类的装饰器
+ * @param target
+ * @returns
+ */
+export declare function pluginHost<HOST extends new (...args: any) => any>(target: HOST): HOST;
+/**
+ * 选项插件宿主接口
+ */
+export interface IOptionsPluginHost<Options, HOST> extends IPluginHost<HOST> {
+	readonly defaultOptions: Options;
+}
+/**
+ * 选项插件宿主的构建函数接口
+ */
+export interface IOptionsPluginHostConstructor<Options, HOST> extends IPluginHostConstructor<HOST> {
+	get defaultOptions(): Options;
+}
+export declare class OptionsPluginHost<Options = any> extends PluginHost {
+	/**
+	 * 全局级别的默认选项
+	 */
+	static readonly defaultOptions: any;
+	/**
+	 * 实例级的默认选项
+	 */
+	get defaultOptions(): Options;
+	protected _defaultOptions: Options;
+}
+/**
+ * 创建带有选项机制的插件宿主类
+ * @remakers
+ * 比 直接使用 OptionsPluginHost 提供了完善的类型推导
+ *
+ * @returns
+ */
+export declare function createOptionsPluginHost<HOST, Options>(): {
+	new (): {
+		/**
+		 * 实例级的默认选项
+		 */
+		readonly defaultOptions: Options;
+		_defaultOptions: Options;
+		readonly pluginManager: PluginManager<HOST>;
+		use<Options_1 extends unknown, Plugin_1 extends IPlugin<HOST, Options_1>>(plugin: Plugin_1, options?: Options_1 | undefined): PluginCreatedReturnType<Plugin_1> | undefined;
+	};
+	/**
+	 * 全局级别的默认选项
+	 */
+	readonly defaultOptions: Options;
+	readonly pluginManager: PluginManager<HOST>;
+	_pluginManager: PluginManager<HOST>;
+	use<Options_2>(plugin: IPlugin<HOST, Options_2>, options: Options_2): any;
+};
+/**
+ * 默认选项宿主接口
+ */
+export interface IDefaultOptionsHost<Options> {
+	readonly defaultOptions: Options;
+}
+/**
+ * 默认选项宿主的构建函数接口
+ */
+export interface IIDefaultOptionsHostConstructor<Options> {
+	get defaultOptions(): Options;
+}
+/**
+ * 创建增加带有选项机制的装饰器
+ *
+ * @remarks
+ * 类装饰器的工厂函数
+ *
+ * @param options - 选项内容
+ * @returns
+ */
+export declare function addDefaultOptions<Options>(options: Options, name?: Optional<string>): <Clas extends new (...args: any) => any>(target: Clas) => void;
+/**
+ * 创建增加带有选项机制的装饰器
+ *
+ * @remarks
+ * 静态属性装饰器
+ *
+ * @param options - 选项内容
+ * @returns
+ */
+export declare function addInstOptions<Clas extends new (...args: any) => any>(target: Clas, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+
+export {};

package/dist/plugin-tls.d.ts

@@ -0,0 +1,273 @@
+import { AnyFunction } from 'type-tls';
+import { Optional } from 'type-tls';
+
+/**
+ * 创建增加带有选项机制的装饰器
+ *
+ * @remarks
+ * 类装饰器的工厂函数
+ *
+ * @param options - 选项内容
+ * @returns
+ */
+export declare function addDefaultOptions<Options>(options: Options, name?: Optional<string>): <Clas extends new (...args: any) => any>(target: Clas) => void;
+
+/**
+ * 创建增加带有选项机制的装饰器
+ *
+ * @remarks
+ * 静态属性装饰器
+ *
+ * @param options - 选项内容
+ * @returns
+ */
+export declare function addInstOptions<Clas extends new (...args: any) => any>(target: Clas, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+
+/**
+ * 创建带有选项机制的插件宿主类
+ * @remakers
+ * 比 直接使用 OptionsPluginHost 提供了完善的类型推导
+ *
+ * @returns
+ */
+export declare function createOptionsPluginHost<HOST, Options>(): {
+    	new (): {
+        		/**
+         		 * 实例级的默认选项
+         		 */
+        		readonly defaultOptions: Options;
+        		_defaultOptions: Options;
+        		readonly pluginManager: PluginManager<HOST>;
+        		use<Options_1 extends unknown, Plugin_1 extends IPlugin<HOST, Options_1>>(plugin: Plugin_1, options?: Options_1 | undefined): PluginCreatedReturnType<Plugin_1> | undefined;
+        	};
+    	/**
+     	 * 全局级别的默认选项
+     	 */
+    	readonly defaultOptions: Options;
+    	readonly pluginManager: PluginManager<HOST>;
+    	_pluginManager: PluginManager<HOST>;
+    	use<Options_2>(plugin: IPlugin<HOST, Options_2>, options: Options_2): any;
+};
+
+/**
+ * 创建插件的缩主类
+ *
+ * @remarks
+ * 比 直接使用 PluginHost 提供了完善的类型推导
+ * @returns
+ */
+export declare function createPluginHost<HOST>(): {
+    	new (): {
+        		/**
+         	 *  插件管理器 {@link CEarth.pluginManager}
+         	 */
+        		readonly pluginManager: PluginManager<HOST>;
+        		/**
+         	 * 实例的注册插件的方法
+         	 * @param plugin
+         	 * @param options
+         	 * @returns
+         	 */
+        		use<Options extends unknown, Plugin_1 extends IPlugin<HOST, Options>>(plugin: Plugin_1, options?: Options | undefined): PluginCreatedReturnType<Plugin_1> | undefined;
+        	};
+    	/**
+     	 * PluginHost 的插件管理器
+     	 */
+    	readonly pluginManager: PluginManager<HOST>;
+    	_pluginManager: PluginManager<HOST>;
+    	/**
+     	 * {@inheritDoc PluginManager.use}
+     	 */
+    	use<Options_1>(plugin: IPlugin<HOST, Options_1>, options: Options_1): any;
+};
+
+/**
+ * 插件宿主的实例类型
+ */
+export declare type HostInst<H> = H extends new (...args: any) => any ? InstanceType<H> : H;
+
+/**
+ * 默认选项宿主接口
+ */
+export declare interface IDefaultOptionsHost<Options> {
+    	readonly defaultOptions: Options;
+}
+
+/**
+ * 默认选项宿主的构建函数接口
+ */
+export declare interface IIDefaultOptionsHostConstructor<Options> {
+    	get defaultOptions(): Options;
+}
+
+/**
+ * 选项插件宿主接口
+ */
+export declare interface IOptionsPluginHost<Options, HOST> extends IPluginHost<HOST> {
+    	readonly defaultOptions: Options;
+}
+
+/**
+ * 选项插件宿主的构建函数接口
+ */
+export declare interface IOptionsPluginHostConstructor<Options, HOST> extends IPluginHostConstructor<HOST> {
+    	get defaultOptions(): Options;
+}
+
+/**
+ * 插件的接口
+ *
+ * @typeParam HOST - 插件宿主的类类型
+ * @typeParam Options - 插件的选项类型
+ */
+export declare interface IPlugin<HOST, Options = any> {
+    	/**
+     	 * 当插件被注册时调用
+     	 * @param Host - 宿主的类型
+     	 * @param options - 注册插件时的选项
+     	 */
+    	used(Host: HOST, options?: Options): any;
+    	/**
+     	 * 当宿主实例被创建时调用
+     	 * @param host - 新建的宿主实例
+     	 * @param options - 注册插件时的选项
+     	 */
+    	created?(host: HostInst<HOST>, options?: Options): any;
+}
+
+/**
+ * 插件宿主的接口
+ */
+export declare interface IPluginHost<HOST> {
+    	/**
+     * PluginHost 的插件管理器
+     */
+    	get pluginManager(): PluginManager<HOST>;
+    	/**
+     * 实例的注册插件的方法
+     * @param plugin
+     * @param options
+     * @returns
+     */
+    	use<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+
+/**
+ * 插件宿主构造函数的接口
+ */
+export declare interface IPluginHostConstructor<HOST> {
+    	/**
+     * PluginHost 的插件管理器
+     */
+    	get pluginManager(): PluginManager<HOST>;
+    	/**
+     	 * {@inheritDoc PluginManager.use}
+     	 */
+    	use<Plugin extends IPlugin<HOST, Options>, Options>(plugin: Plugin, options: Options): PluginUseReturnType<Plugin> | undefined;
+}
+
+export declare class OptionsPluginHost<Options = any> extends PluginHost {
+    	/**
+     	 * 全局级别的默认选项
+     	 */
+    	static readonly defaultOptions: any;
+    	/**
+     	 * 实例级的默认选项
+     	 */
+    	get defaultOptions(): Options;
+    	protected _defaultOptions: Options;
+}
+
+/**
+ * 插件的 created 方法的返回值类型
+ */
+export declare type PluginCreatedReturnType<P extends IPlugin<any>> = P["created"] extends AnyFunction ? ReturnType<P["created"]> : void;
+
+/**
+ * 插件的宿主
+ *
+ * @remarks
+ * 插件宿主 就是 拥有插件机制的宿主
+ */
+export declare class PluginHost {
+    	/**
+     	 * 插件管理器
+     	 */
+    	static get pluginManager(): PluginManager<any>;
+    	static _pluginManager: PluginManager<any>;
+    	/**
+     	 * 插件管理器 {@link PluginHost.pluginManager}
+     	 */
+    	get pluginManager(): PluginManager<any>;
+    	/**
+     	 * {@inheritDoc PluginManager.use}
+     	 */
+    	static use<Plugin extends IPlugin<HOST, Options>, Options extends PluginOptions, HOST = typeof PluginHost>(plugin: Plugin, options: Options): ReturnType<Plugin["used"]> | undefined;
+    	constructor();
+    	/**
+     	 * 实例的注册插件的方法
+     	 * @param plugin
+     	 * @param options
+     	 * @returns
+     	 */
+    	use<Options extends PluginOptions, Plugin extends IPlugin<typeof PluginHost, Options>>(plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+
+/**
+ * 插件缩主类的装饰器
+ * @param target
+ * @returns
+ */
+export declare function pluginHost<HOST extends new (...args: any) => any>(target: HOST): HOST;
+
+/**
+ * 插件管理者
+ *
+ * @remarks
+ * 负责管理插件的注册、应用 等
+ */
+export declare class PluginManager<HOST> {
+    	/**
+     	 * 插件的宿主
+     	 */
+    	host: HOST;
+    	/**
+     	 * 插件与插件选项的映射
+     	 */
+    	pluginOptsMap: Map<IPlugin<HOST, any>, any>;
+    	/**
+     	 * 注册的插件
+     	 */
+    	plugins: IPlugin<HOST>[];
+    	/**
+     	 * 使用插件、注册插件
+     	 * @param plugin - 插件
+     	 * @param options - 传递给插件的选项
+     	 */
+    	use<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(plugin: Plugin, options?: Options): PluginUseReturnType<Plugin> | undefined;
+    	/**
+     	 * 插件宿主创建实例时调用
+     	 *
+     	 * @remarks
+     	 * 会调用每个插件的 {@link IPlugin.created | IPlugin.created()} 方法
+     	 * @param hostInst - 插件宿主的新实例
+     	 */
+    	created(hostInst: HostInst<HOST>): void;
+    	/**
+     	 * 插件宿主实例的注册插件的方法
+     	 *
+     	 * @remarks
+     	 * 会调用每个插件的 {@link IPlugin.created | IPlugin.created()} 方法
+     	 * @param hostInst - 插件宿主的新实例
+     	 */
+    	instUse<Options extends PluginOptions, Plugin extends IPlugin<HOST, Options>>(hostInst: HostInst<HOST>, plugin: Plugin, options?: Options): PluginCreatedReturnType<Plugin> | undefined;
+}
+
+export declare type PluginOptions = any;
+
+/**
+ * 插件的 used 方法的返回值类型
+ */
+export declare type PluginUseReturnType<P extends IPlugin<any>> = ReturnType<P["used"]>;
+
+export { }