plugin-tls 1.0.0 → 1.1.0

package/dist/options-manager/ModeOptions.d.ts

@@ -0,0 +1,88 @@
+import { OptionsManager } from "./OptionsManager";
+import { TierOptions } from "./TierOptions";
+/**
+ * 模式选项
+ * @remarks
+ * 针对选项提供了模式和继承的功能；
+ *
+ * 适用以下场景：
+ * 你设计了一个支持许多选项的工具，不同场景下需要配置不同的选项值，比如有如下几个场景：
+ * - 性能模式：所有的配置项以性能为目标进行配置，关闭那些效果类的选项；
+ * - 特效模式：以高质量的渲染效果为目标进行配置，会开启所有的效果选项；
+ * - 平衡模式：兼顾性能和效果，取个折中；
+ *
+ * 并且这些模式也会一些共同的选项；
+ *
+ * 使用该类，你可以：
+ * - 设置一个基本模式：该模式提供的所有模式都会有的共用选项
+ * - 设置 性能模式、特效模式、平衡模式 继承 基本模式；
+ */
+export declare class ModeOptions<Mode extends string | number = string, Option extends {} = any> extends OptionsManager<Option> {
+    constructor(mode: Mode);
+    constructor(mode: Mode, options?: Option);
+    /**
+     * 模式的配置
+     */
+    modes: Record<Mode, TierOptions<Option>>;
+    /**
+     * 当前模式
+     */
+    get mode(): Mode;
+    set mode(value: Mode);
+    protected _mode?: Mode;
+    /**
+     * 所有的模式名字
+     */
+    get modeNames(): Mode[];
+    protected _modeNames: Mode[] | null;
+    /**
+     * 获取所有的模式名字
+     * @returns
+     */
+    getModeNames(): Mode[];
+    /**
+     * 判断是否有某个模式
+     * @param mode
+     * @returns
+     */
+    hasMode(mode: string | number): boolean;
+    /**
+     * 当前模式的选项
+     */
+    get optionManager(): TierOptions<Option>;
+    /**
+     * 当前模式对应的选项
+     */
+    get option(): Option;
+    get plainFullOption(): Option;
+    protected _plainFullOption: Option | null;
+    /**
+     * 更新
+     */
+    updateFullOption(): void;
+    /**
+     * 返回已合并继承选项的选项
+     * @remarks
+     * 与继承选项只是浅合并
+     * @param mode
+     * @returns
+     */
+    getModeOption(mode: Mode): Option | null;
+    /**
+     * 返回已合并继承选项的完整选项
+     * @remarks
+     * 与继承选项合并
+     * @param mode
+     * @returns
+     */
+    getFullModeOption(mode: Mode): Option | null;
+    /**
+     * 给模式设置选项
+     * @param mode
+     * @param option
+     * @param deep - 是否要进行深度合并
+     * @param extend - 继承哪个模式
+     */
+    setModeOption(mode: Mode, option: Option, deep?: boolean, extend?: Mode): Record<Mode, TierOptions<Option>>[Mode];
+}
+//# sourceMappingURL=ModeOptions.d.ts.map

package/dist/options-manager/ModeOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModeOptions.d.ts","sourceRoot":"","sources":["../../src/options-manager/ModeOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAA;AAC/C,OAAQ,EAAC,WAAW,EAAC,MAAM,eAAe,CAAA;AAG1C;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,WAAW,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAC,MAAM,SAAS,EAAE,GAAG,GAAG,CAAE,SAAQ,cAAc,CAAC,MAAM,CAAC;gBAEtG,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM;IASxC;;OAEG;IACH,KAAK,oCAA0C;IAE/C;;OAEG;IACH,IAAI,IAAI,IAAG,IAAI,CAEd;IACD,IAAI,IAAI,CAAC,KAAK,EAHH,IAGG,EAMb;IACD,SAAS,CAAC,KAAK,CAAC,EAAC,IAAI,CAAC;IAGtB;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED,SAAS,CAAC,UAAU,EAAC,IAAI,EAAE,GAAG,IAAI,CAAQ;IAG1C;;;OAGG;IACH,YAAY;IAKZ;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAC,MAAM,GAAG,MAAM;IAM5B;;OAEG;IACH,IAAI,aAAa,IAAG,WAAW,CAAC,MAAM,CAAC,CAEtC;IAID;;OAEG;IACH,IAAI,MAAM,WAET;IAED,IAAI,eAAe,WAElB;IAED,SAAS,CAAC,gBAAgB,EAAC,MAAM,GAAC,IAAI,CAAQ;IAG9C;;OAEG;IACH,gBAAgB;IAOhB;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAC,IAAI,GAAE,MAAM,GAAC,IAAI;IAIpC;;;;;;OAMG;IACH,iBAAiB,CAAC,IAAI,EAAC,IAAI,GAAE,MAAM,GAAC,IAAI;IAKxC;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAC,IAAI,EAAC,MAAM,EAAC,MAAM,EAAC,IAAI,CAAC,EAAC,OAAO,EAAC,MAAM,CAAC,EAAC,IAAI;CAiBnE"}

package/dist/options-manager/OptionsManager.d.ts

@@ -0,0 +1,105 @@
+/**
+ * 视为未定义的选项值
+ * @remarks
+ * 当选项的值是未定义的值
+ */
+export declare enum UndefinedOptionValue {
+    /**
+     * 将 undefined 和 null 都视为未定义的选项
+     */
+    UndefinedAndNull = "UndefinedAndNull",
+    /**
+     * 只将 undefined 视为未定义的选项
+     */
+    Undefined = "Undefined",
+    /**
+     * 只将 null 视为未定义的选项
+     */
+    Null = "Null"
+}
+/**
+ * 各种判断未定义值的函数集
+ */
+export declare const isUndefinedMap: {
+    UndefinedAndNull: (value: any) => boolean;
+    Undefined: (value: any) => boolean;
+    Null: (value: any) => boolean;
+};
+/**
+ * 选项管理器
+ */
+export declare abstract class OptionsManager<Option extends {} = any> {
+    /**
+     * 选项
+     */
+    abstract option: Option;
+    /**
+     * 是否要冻结 fullOption 的成员
+     * @remarks
+     * 只会冻结 fullOption 的直接成员的值，不会冻结 fullOption 孙子成员的值
+     */
+    freezeMember: boolean;
+    /**
+     * 可更新顶级成员值的完整的选项
+     * @remarks
+     * 合并后的选项；
+     * plainFullOption 的代理对象，自动监听了顶层成员的屐；所以可以更改顶级成员的值，不可以更改非顶级成员的值；
+     */
+    fullOption: Option;
+    /**
+     * 完整的选项
+     * @remarks
+     * 合并后的选项
+     */
+    abstract readonly plainFullOption: Option;
+    /**
+     * 更新完整的选项
+     */
+    abstract updateFullOption(): void;
+    /**
+     * 设置选项
+     * @remarks
+     * 会将被设置的选项浅合并进当前选项中
+     * @param option
+     * @param deep - 是否要进行深度合并
+     */
+    setOption(option: Option, deep?: boolean): void | Option;
+    /**
+     * 未定义值的类型
+     */
+    get undefinedValue(): UndefinedOptionValue;
+    set undefinedValue(value: UndefinedOptionValue);
+    protected _undefinedValue: UndefinedOptionValue;
+    /**
+     * 未定义值的判断函数
+     */
+    isUndefined: (value: any) => boolean;
+    /**
+     * 获取选项成员
+     * @param key
+     * @returns
+     */
+    getMember<Key extends keyof Option>(key: Key): Option[Key] | undefined | null;
+    /**
+     * 设置选项成员
+     * @param key
+     * @param value
+     * @param deep - 是否要进行深度合并
+     */
+    setMember<Key extends keyof Option>(key: Key, value?: Option[Key] | null, deep?: boolean): void;
+    /**
+     * 获取属性路径对应的值
+     * @param propPath
+     * @returns
+     */
+    getValue(propPath: string[]): any;
+    /**
+     * 设置属性路径对应的值
+     * @param propPath
+     * @param value
+     * @param deep - 是否要进行深度合并
+     * @returns
+     */
+    setValue(propPath: string[], value: any, deep?: boolean): void;
+}
+//# sourceMappingURL=OptionsManager.d.ts.map

package/dist/options-manager/OptionsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OptionsManager.d.ts","sourceRoot":"","sources":["../../src/options-manager/OptionsManager.ts"],"names":[],"mappings":"AAMA;;;;GAIG;AACH,oBAAY,oBAAoB;IAC5B;;OAEG;IACH,gBAAgB,qBAAqB;IACrC;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;CAEhB;AAED;;GAEG;AACH,eAAO,MAAM,cAAc;8BACuB,GAAG;uBAGV,GAAG;kBAGR,GAAG;CAGxC,CAAA;AAID;;GAEG;AACH,8BAAsB,cAAc,CAAC,MAAM,SAAS,EAAE,GAAG,GAAG;IAGxD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,YAAY,UAAQ;IAEpB;;;;;OAKG;IACH,UAAU,SAiCc;IAGxB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,gBAAgB,IAAI,IAAI;IAEjC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO;IAQxC;;OAEG;IACH,IAAI,cAAc,yBAEjB;IACD,IAAI,cAAc,CAAC,KAAK,sBAAA,EAGvB;IAED,SAAS,CAAC,eAAe,uBAAyC;IAElE;;OAEG;IACH,WAAW,0BAAmC;IAG9C;;;;OAIG;IACH,SAAS,CAAC,GAAG,SAAS,MAAM,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,IAAI;IAI7E;;;;;OAKG;IACH,SAAS,CAAC,GAAG,SAAS,MAAM,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE,OAAO;IAiBxF;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,GAAG;IAIjC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO;CAW1D"}

package/dist/options-manager/TierModeOptions.d.ts

@@ -0,0 +1,69 @@
+import { ModeOptions } from "./ModeOptions";
+import type { TierOptions } from "./TierOptions";
+/**
+ * 层级模式选项
+ * @remarks
+ * 即 ModeOptions 和 TierOptions 的结合
+ */
+export declare class TierModeOptions<Mode extends string | number = string, Option extends {} = any> extends ModeOptions<Mode, Option> {
+    constructor(mode: Mode);
+    constructor(mode: Mode, options?: Option, extend?: TierModeOptions<Mode, Option>);
+    /**
+     * 继承的选项
+     */
+    get extends(): TierModeOptions<Mode, Option> | null;
+    set extends(value: TierModeOptions<Mode, Option> | null);
+    protected _extends: TierModeOptions<Mode, Option> | null;
+    /**
+     * 返回已合并继承选项的最终选项
+     * @remarks
+     * 与继承选项只是浅合并
+     * @param mode
+     * @returns
+     */
+    getFullModeOption(mode: Mode): Option | null;
+    /**
+     * 获取所有的模式名字
+     * @returns
+     */
+    getModeNames(): Mode[];
+    /**
+     * 在整个层级上判断是否有某个模式
+     * @param mode
+     * @returns
+     */
+    hasModeOnTier(mode: string | number): boolean;
+    /**
+     * 当前模式的选项
+     */
+    get optionManager(): TierOptions<Option>;
+    /**
+     * 获取模式对应的选项管理器
+     * @param mode
+     * @returns
+     */
+    getModeOptionManager(mode: Mode): TierOptions<Option> | null;
+    /**
+     * 获取选项成员
+     * @param key
+     * @returns
+     */
+    getMember<Key extends keyof Option>(key: Key): Option[Key] | undefined | null;
+    /**
+     * 获取属性路径对应的值
+     * @param propPath
+     * @returns
+     */
+    getValue(propPath: string[]): any;
+}
+/**
+ * 层级模式选项主机装饰器
+ * @remarks
+ * 可让宿主具备层级模式选项；
+ * 需要宿主有静态的同名属性；
+ * @param target
+ * @param context
+ * @returns
+ */
+export declare function tierModeOptionsDecorator<This, Value>(value: ClassAccessorDecoratorTarget<This, Value>, context: ClassAccessorDecoratorContext<This, Value>): ClassAccessorDecoratorResult<This, Value>;
+//# sourceMappingURL=TierModeOptions.d.ts.map

package/dist/options-manager/TierModeOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TierModeOptions.d.ts","sourceRoot":"","sources":["../../src/options-manager/TierModeOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAA;AAI9C;;;;GAIG;AACH,qBAAa,eAAe,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,MAAM,SAAS,EAAE,GAAG,GAAG,CAAE,SAAQ,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC;gBAE9G,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,EAAC,MAAM,CAAC,EAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC;IAQ9E;;OAEG;IACH,IAAI,OAAO,yCAEV;IACD,IAAI,OAAO,CAAC,KAAK,sCAAA,EAGhB;IACD,SAAS,CAAC,QAAQ,EAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,GAAC,IAAI,CAAQ;IAG7D;;;;;;OAMG;IACM,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAC,IAAI;IAanD;;;OAGG;IACM,YAAY,IAAG,IAAI,EAAE;IAU9B;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAC,MAAM,GAAG,MAAM,GAAE,OAAO;IAM3C;;OAEG;IACH,IAAa,aAAa,IAAG,WAAW,CAAC,MAAM,CAAC,CAE/C;IACD;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,EAAC,IAAI,GAAE,WAAW,CAAC,MAAM,CAAC,GAAC,IAAI;IAQxD;;;;OAIG;IACM,SAAS,CAAC,GAAG,SAAS,MAAM,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,GAAG,IAAI;IAWtF;;;;OAIG;IACM,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,GAAG;CAW7C;AAMD;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAC,KAAK,EAC/C,KAAK,EAAE,4BAA4B,CAAC,IAAI,EAAC,KAAK,CAAC,EAC/C,OAAO,EAAC,6BAA6B,CAAC,IAAI,EAAC,KAAK,CAAC,GACjD,4BAA4B,CAAC,IAAI,EAAC,KAAK,CAAC,CAS3C"}

package/dist/options-manager/TierOptions.d.ts

@@ -0,0 +1,48 @@
+import { OptionsManager } from "./OptionsManager";
+export declare class TierOptions<Option extends {} = any> extends OptionsManager<Option> {
+    constructor(option?: Option, extend?: TierOptions<Option>);
+    /**
+     * 继承的选项
+     */
+    get extends(): TierOptions<Option> | null;
+    set extends(value: TierOptions<Option> | null);
+    protected _extends: TierOptions<Option> | null;
+    /**
+     * 选项
+     */
+    option: Option;
+    /**
+     * 获取完整的选项
+     * @remarks
+     * 会与继承来的选项进行合并
+     */
+    get plainFullOption(): Option;
+    protected _plainFullOption: Option | null;
+    /**
+     * 更新
+     */
+    updateFullOption(): void;
+    /**
+     * 获取选项成员
+     * @param key
+     * @returns
+     */
+    getMember<Key extends keyof Option>(key: Key): Option[Key] | undefined | null;
+    /**
+     * 获取属性路径对应的值
+     * @param propPath
+     * @returns
+     */
+    getValue(propPath: string[]): any;
+}
+/**
+ * 层级选项主机装饰器
+ * @remarks
+ * 可让宿主具备层级选项；
+ * 需要宿主有静态的同名属性；
+ * @param target
+ * @param context
+ * @returns
+ */
+export declare function tierOptionsDecorator<This, Value>(value: ClassAccessorDecoratorTarget<This, Value>, context: ClassAccessorDecoratorContext<This, Value>): ClassAccessorDecoratorResult<This, Value>;
+//# sourceMappingURL=TierOptions.d.ts.map

package/dist/options-manager/TierOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TierOptions.d.ts","sourceRoot":"","sources":["../../src/options-manager/TierOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAA;AAI/C,qBAAa,WAAW,CAAC,MAAM,SAAS,EAAE,GAAG,GAAG,CAAE,SAAQ,cAAc,CAAC,MAAM,CAAC;gBAChE,MAAM,CAAC,EAAC,MAAM,EAAC,MAAM,CAAC,EAAC,WAAW,CAAC,MAAM,CAAC;IAStD;;OAEG;IACH,IAAI,OAAO,+BAEV;IACD,IAAI,OAAO,CAAC,KAAK,4BAAA,EAGhB;IACD,SAAS,CAAC,QAAQ,EAAC,WAAW,CAAC,MAAM,CAAC,GAAC,IAAI,CAAQ;IAEnD;;OAEG;IACH,MAAM,SAAgB;IAGtB;;;;OAIG;IACH,IAAI,eAAe,IAAG,MAAM,CAW3B;IACD,SAAS,CAAC,gBAAgB,EAAC,MAAM,GAAC,IAAI,CAAQ;IAG9C;;OAEG;IACH,gBAAgB;IAMhB;;;;OAIG;IACM,SAAS,CAAC,GAAG,SAAS,MAAM,MAAM,EAAE,GAAG,EAAC,GAAG,GAAE,MAAM,CAAC,GAAG,CAAC,GAAC,SAAS,GAAC,IAAI;IAWhF;;;;OAIG;IACM,QAAQ,CAAC,QAAQ,EAAC,MAAM,EAAE,GAAE,GAAG;CAU3C;AASD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAC,KAAK,EAC3C,KAAK,EAAE,4BAA4B,CAAC,IAAI,EAAC,KAAK,CAAC,EAC/C,OAAO,EAAC,6BAA6B,CAAC,IAAI,EAAC,KAAK,CAAC,GACjD,4BAA4B,CAAC,IAAI,EAAC,KAAK,CAAC,CAS3C"}

package/dist/options-manager/defaultOptions.d.ts

@@ -0,0 +1,34 @@
+import type { Optional } from "type-tls";
+/**
+ * 默认选项宿主接口
+ */
+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;
+//# sourceMappingURL=defaultOptions.d.ts.map

package/dist/options-manager/defaultOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultOptions.d.ts","sourceRoot":"","sources":["../../src/options-manager/defaultOptions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,UAAU,CAAA;AAItC;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,OAAO;IACxC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B,CAAC,OAAO;IACpD,IAAI,cAAc,IAAI,OAAO,CAAC;CACjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,+BAGtB,GAAG,KAAK,GAAG,wBAkBxE;AAKD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,IAAI,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,sBAYvI"}

package/dist/options-manager/tools.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 解析属性路径为属性列表
+ * @param propPath
+ * @returns
+ */
+export declare function parsePropertyPath(propPath: string): string[];
+/**
+ * 通过key列表获取对象中对应属性的值
+ * @param obj
+ * @param props
+ * @returns
+ */
+export declare function getPropertyValue(obj: any, props: string[]): any;
+/**
+ * 获取对象的属性路径对应的属性值
+ * @param obj
+ * @param propPath
+ * @returns
+ */
+export declare function getPropertyValueByPath(obj: any, propPath: string): any;
+/**
+ * 通过属性路径列表设置对象中对应属性的值
+ * @param obj
+ * @param props
+ * @returns
+ */
+export declare function setPropertyValue(obj: any, props: string[], value: any): any;
+/**
+ * 获取对象的属性路径对应的属性值
+ * @param obj
+ * @param propPath
+ * @returns
+ */
+export declare function setPropertyValueByPath(obj: any, propPath: string, value: any): any;
+//# sourceMappingURL=tools.d.ts.map

package/dist/options-manager/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../../src/options-manager/tools.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAC,MAAM,YAMhD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAC,KAAK,EAAC,MAAM,EAAE,OAMvD;AAGD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,EAAC,QAAQ,EAAC,MAAM,OAE9D;AAKD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAC,KAAK,EAAC,MAAM,EAAE,EAAC,KAAK,EAAC,GAAG,OAoBjE;AAMD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,EAAC,QAAQ,EAAC,MAAM,EAAC,KAAK,EAAC,GAAG,OAExE"}

package/dist/plugin-host/PluginHost.d.ts

@@ -0,0 +1,184 @@
+import { PluginManager } from "../plugin-manager/PluginManager";
+import type { IPlugin, PluginCreatedReturnType, PluginUseReturnType, GetNormalizePluginOptions, FormatUsePluginParameters } from "../plugin-manager/PluginManager";
+import type { ReplaceConstructorReturn } from "../extend/mixin";
+/**
+ * 插件宿主的接口
+ *
+ * @typeParam HostClassType 插件宿主类的类型
+ */
+export interface IPluginHost<HostClassType extends IPluginHostConstructor<any, Plugin>, Plugin extends IPlugin<HostClassType, any> = IPlugin<HostClassType, any>> {
+    /**
+     * PluginHost 的插件管理器
+     */
+    get pluginManager(): HostClassType["pluginManager"];
+    /**
+     * 实例的注册插件的方法
+     * @param plugin
+     * @param options
+     * @returns
+     */
+    use<P extends Plugin>(plugin: P, options: GetNormalizePluginOptions<P>): PluginCreatedReturnType<P> | void;
+}
+/**
+ * 插件宿主构造函数的接口
+ * @typeParam HostClassType 插件宿主类的类型
+ */
+export interface IPluginHostConstructor<HostClassType, Plugin extends IPlugin<HostClassType, any> = IPlugin<HostClassType, any>> {
+    /**
+     * PluginHost 的插件管理器
+     */
+    get pluginManager(): PluginManager<HostClassType, Plugin>;
+    /**
+     * {@inheritDoc PluginManager.use}
+     */
+    use<P extends Plugin>(plugin: P, options: GetNormalizePluginOptions<P>): PluginUseReturnType<P> | void;
+}
+/**
+ * 插件的宿主
+ *
+ * @remarks
+ * 插件宿主 就是 拥有插件机制的宿主
+ *
+ * 子类需要在构建函数中调用 `this.pluginManager.created(this);`
+ *
+ * 之所以没写在该类中的函数中，是因为 `this.pluginManager.created(this)` 通常会在构建函数执行的最后时才调用；
+ * 如果像下面写在该类的构建函数中，然后子类通过 `super()` 来调用，这样就会导致 `this.pluginManager.created(this)` 不是在最后的执行；
+ */
+export declare class PluginHost<Plugin extends IPlugin<typeof PluginHost, any> = IPlugin<typeof PluginHost, any>> {
+    /**
+     * 插件管理器
+     */
+    static get pluginManager(): PluginManager<any, IPlugin<any, any>>;
+    protected static _pluginManager: PluginManager<any>;
+    /**
+     * 插件管理器 {@link PluginHost.pluginManager}
+     */
+    get pluginManager(): PluginManager<any, IPlugin<any, any>>;
+    /**
+     * {@inheritDoc PluginManager.use}
+     */
+    static use<Plugin extends IPlugin<typeof PluginHost, any>>(plugin: Plugin, ...options: FormatUsePluginParameters<Plugin>): void | ReturnType<Plugin["used"]>;
+    /**
+     * 需要在子类中调用
+     *
+     * 之所以没写在该类中的函数中，是因为 `this.pluginManager.created(this)` 通常会在构建函数执行的最后时才调用；
+     * 如果像下面写在该类的构建函数中，然后子类通过 `super()` 来调用，这样就会导致 `this.pluginManager.created(this)` 不是在最后的执行；
+     */
+    /**
+     * 实例的注册插件的方法
+     * @param plugin
+     * @param options
+     * @returns
+     */
+    use<P extends Plugin>(plugin: P, ...options: FormatUsePluginParameters<P>): PluginCreatedReturnType<P> | void;
+    /**
+     * 销毁实例
+     * @returns
+     */
+    destroy(): void;
+}
+/**
+ * 创建插件的缩主类
+ *
+ * @remarks
+ * 比 直接使用 PluginHost 提供了完善的类型推导
+ *
+ * 子类需要在构建函数中调用 `this.pluginManager.created(this);`
+ *
+ * 之所以没写在该类中的函数中，是因为 `this.pluginManager.created(this)` 通常会在构建函数执行的最后时才调用；
+ * 如果像下面写在该类的构建函数中，然后子类通过 `super()` 来调用，这样就会导致 `this.pluginManager.created(this)` 不是在最后的执行；
+ * @returns
+ */
+export declare function createPluginHost<HOST, Plugin extends IPlugin<HOST, any> = IPlugin<HOST, any>>(): {
+    new (): {
+        /**
+         *  插件管理器 {@link CEarth.pluginManager}
+         */
+        readonly pluginManager: PluginManager<any, IPlugin<any, any>>;
+        /**
+        /**
+         * 实例的注册插件的方法
+         * @param plugin
+         * @param options
+         * @returns
+         */
+        use<P extends Plugin>(plugin: P, ...options: FormatUsePluginParameters<P>): void | PluginCreatedReturnType<P>;
+        /**
+         * 销毁实例
+         * @returns
+         */
+        destroy(): void;
+    };
+    /**
+     * PluginHost 的插件管理器
+     */
+    readonly pluginManager: PluginManager<typeof PluginHost & HOST, Plugin>;
+    _pluginManager: PluginManager<typeof PluginHost & HOST, Plugin>;
+    /**
+     * {@inheritDoc PluginManager.use}
+     */
+    use<P_1 extends Plugin>(plugin: P_1, ...options: FormatUsePluginParameters<P_1>): void | ReturnType<P_1["used"]>;
+};
+/**
+ * 将 HOST 变成插件宿主类型
+ */
+export type BecomePluginHost<HOST extends new (...args: any) => any, Plugin extends IPlugin<HOST, any> = IPlugin<HOST, any>> = HOST & IPluginHostConstructor<HOST & IPluginHostConstructor<HOST, Plugin>, Plugin> & ReplaceConstructorReturn<HOST, InstanceType<HOST> & IPluginHost<HOST & IPluginHostConstructor<HOST & IPluginHostConstructor<HOST, Plugin>, Plugin>>>;
+/**
+ * 变成插件宿主
+ * @remarks
+ * 也可作为装饰器
+ *
+ * 子类需要在构建函数中调用 `this.pluginManager.created(this);`
+ *
+ * 之所以没写在该类中的函数中，是因为 `this.pluginManager.created(this)` 通常会在构建函数执行的最后时才调用；
+ * 如果像下面写在该类的构建函数中，然后子类通过 `super()` 来调用，这样就会导致 `this.pluginManager.created(this)` 不是在最后的执行；
+ * @param target
+ * @param context
+ * @returns
+ */
+export declare function becomePluginHost<HOST extends new (...args: any) => any, Plugin extends IPlugin<HOST, any> = IPlugin<HOST, any>>(target: HOST): BecomePluginHost<HOST, Plugin>;
+/**
+ * 变成插件宿主
+ * @remarks
+ * 也可作为装饰器
+ * @param target
+ * @param context
+ * @returns
+ */
+export declare function becomePluginHost_Proxy<HOST extends new (...args: any) => any, Plugin extends IPlugin<HOST, any> = IPlugin<HOST, any>>(target: HOST): HOST;
+/**
+ * 插件缩主类的装饰器（继承版）
+ * @remarks
+ * 通过继承实现
+ */
+export declare function becomePluginHost_Extends<HOST extends new (...args: any) => any>(target: HOST): {
+    new (...args: any): {
+        [x: string]: any;
+        /**
+         * 插件管理器 {@link PluginHost.pluginManager}
+         */
+        readonly pluginManager: PluginManager<any & HOST, IPlugin<any & HOST, any>>;
+        /**
+         * 实例的注册插件的方法
+         * @param plugin
+         * @param options
+         * @returns
+         */
+        use<Plugin_1 extends IPlugin<any & HOST, any>>(plugin: Plugin_1, ...options: FormatUsePluginParameters<Plugin_1>): void | PluginCreatedReturnType<Plugin_1>;
+        /**
+         * 销毁实例
+         * @returns
+         */
+        destroy(): void;
+    };
+    /**
+     * 插件管理器
+     */
+    readonly pluginManager: PluginManager<any & HOST, IPlugin<any & HOST, any>>;
+    _pluginManager: PluginManager<any & HOST, IPlugin<any & HOST, any>>;
+    /**
+     * {@inheritDoc PluginManager.use}
+     */
+    use<Plugin_2 extends IPlugin<any & HOST, any>>(plugin: Plugin_2, ...options: FormatUsePluginParameters<Plugin_2>): void | ReturnType<Plugin_2["used"]>;
+} & HOST;
+//# sourceMappingURL=PluginHost.d.ts.map

package/dist/plugin-host/PluginHost.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginHost.d.ts","sourceRoot":"","sources":["../../src/plugin-host/PluginHost.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,OAAO,EAEP,uBAAuB,EACvB,mBAAmB,EACnB,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,iCAAiC,CAAC;AAGzC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAEhE;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,aAAa,SAAS,sBAAsB,CAAC,GAAG,EAAC,MAAM,CAAC,EAAC,MAAM,SAAS,OAAO,CAAC,aAAa,EAAC,GAAG,CAAC,GAAG,OAAO,CAAC,aAAa,EAAC,GAAG,CAAC;IAC1J;;OAEG;IACH,IAAI,aAAa,IAAI,aAAa,CAAC,eAAe,CAAC,CAAC;IACpD;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC5G;AACD;;;GAGG;AACH,MAAM,WAAW,sBAAsB,CAAC,aAAa,EAAC,MAAM,SAAS,OAAO,CAAC,aAAa,EAAC,GAAG,CAAC,GAAG,OAAO,CAAC,aAAa,EAAC,GAAG,CAAC;IAC1H;;OAEG;IACH,IAAI,aAAa,IAAI,aAAa,CAAC,aAAa,EAAC,MAAM,CAAC,CAAC;IAEzD;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CACvG;AAED;;;;;;;;;;GAUG;AACH,qBAAa,UAAU,CAAC,MAAM,SAAS,OAAO,CAAC,OAAO,UAAU,EAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,UAAU,EAAC,GAAG,CAAC;IACpG;;OAEG;IACH,MAAM,KAAK,aAAa,0CAMvB;IACD,SAAS,CAAC,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAEpD;;OAEG;IACH,IAAI,aAAa,0CAEhB;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,CAAE,MAAM,SAAS,OAAO,CAAC,OAAO,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,yBAAyB,CAAC,MAAM,CAAC;IAIzH;;;;;OAKG;IAKH;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,EAAI,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,GAAG,IAAI;IAI/G;;;OAGG;IACH,OAAO;CAIR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAC,MAAM,SAAS,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC;;QAqBtF;;WAEG;;QAeH;;;;;;WAMG;;QAKH;;;WAGG;;;IA3CH;;OAEG;;;IAiBH;;OAEG;;EA2BN;AAGD;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EAAC,MAAM,SAAS,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,IAAG,IAAI,GAAG,sBAAsB,CAAC,IAAI,GAAG,sBAAsB,CAAC,IAAI,EAAC,MAAM,CAAC,EAAC,MAAM,CAAC,GAAG,wBAAwB,CAAC,IAAI,EAAC,YAAY,CAAC,IAAI,CAAC,GAAC,WAAW,CAAC,IAAI,GAAC,sBAAsB,CAAC,IAAI,GAAG,sBAAsB,CAAC,IAAI,EAAC,MAAM,CAAC,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAG5V;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EAAC,MAAM,SAAS,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,kCAgDzI;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EAAC,MAAM,SAAS,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,EAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,QAU/I;AAGD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI;kBA8BrE,GAAG;;QAfvB;;WAEG;;QAoBH;;;;;WAKG;;QAOD;;;WAGG;;;IAjDL;;OAEG;;;IAkBH;;OAEG;;SAoCN"}