@suey/rxp-meta 0.0.3 → 0.1.1

package/dist/lib/src/extension/ExtensionManager.d.ts

@@ -1,5 +1,42 @@
-import type { Extension, ExtensionName, ExtractExtensionContext } from './declare';
-import { InnerZustandStoreManager } from '../base/InnerZustandStoreManager';
+type ExtensionName = string;
+type ExtensionOnActivated<Context = unknown> = (context?: Context) => ((() => void) | Promise<(() => void)> | void | Promise<void>);
+type ExtensionOnDeactivated<Context = unknown> = (context?: Context) => (void | Promise<void>);
+interface ExtensionOptions<Context = unknown> {
+    /**
+     * 插件的唯一标识 name
+     */
+    readonly name: ExtensionName;
+    /**
+     * 插件版本
+     */
+    readonly version: string | number;
+    /**
+     * 插件数据, 由项目自主决定插件附带携带的数据
+     */
+    meta?: any;
+    /**
+     * 插件被激活, 被使用的状态
+     */
+    readonly onActivated: ExtensionOnActivated<Context>;
+    readonly onDeactivated?: ExtensionOnDeactivated<Context>;
+}
+export declare class Extension {
+    /**
+     * 插件对象标识符
+     */
+    private readonly __TAG__;
+    private isActivated;
+    readonly name: ExtensionName;
+    readonly version: string | number;
+    readonly meta?: any;
+    readonly onActivated: ExtensionOnActivated;
+    readonly onDeactivated?: ExtensionOnDeactivated;
+    constructor(options: ExtensionOptions);
+    getIsActivated(): boolean;
+    activated(): Promise<void>;
+    deactivated(): Promise<void>;
+    static isExtension(extension: any): extension is Extension;
+}
 /**
  * 定义一个插件, 这里所抽象得插件只是一个携带数据得对象、以及具有特殊时机执行得函数
  *
@@ -7,12 +44,13 @@ import { InnerZustandStoreManager } from '../base/InnerZustandStoreManager';
  * 2. 插件可以调动 metadataManager 从而实现插件化开发
  * 3. 调动 emitter 实现事件触发
  */
-export declare class ExtensionManager<Ext extends Extension> extends InnerZustandStoreManager {
+export declare class ExtensionManager<Ext extends Extension> {
+    private readonly rxpInnerStore;
     private readonly extNameMapStore;
     /**
      * Define extension, 定义插件, 那么插件会被存储到 Map 中.
      */
-    defineExtension<DExt extends Ext>(define: DExt): DExt;
+    defineExtension(define: ExtensionOptions): Extension;
     /**
      * 判断一个对象是否是一个 扩展对象
      */
@@ -24,7 +62,7 @@ export declare class ExtensionManager<Ext extends Extension> extends InnerZustan
     /**
      * 获取一个扩展
      */
-    getExtension(extensionName: ExtensionName): Extension<any> | null;
+    getExtension(extensionName: ExtensionName): Extension | null;
     /**
      * 注册一个扩展
      */
@@ -32,17 +70,22 @@ export declare class ExtensionManager<Ext extends Extension> extends InnerZustan
     /**
      * Activated extension
      */
-    activatedExtension<Context extends ExtractExtensionContext<Ext>>(name: ExtensionName, context: Context): Promise<void>;
+    activatedExtension(name: ExtensionName): Promise<void>;
     /**
      * 去活某个插件
      */
-    deactivatedExtension<Context extends ExtractExtensionContext<Ext>>(name: ExtensionName, context: Context): Promise<void>;
-    /**
+    deactivatedExtension(name: ExtensionName): Promise<void>;
+    /**w
      * 删除扩展
      */
-    delExtension<Context extends ExtractExtensionContext<Ext>>(name: ExtensionName, context: Context): Promise<void>;
+    delExtension(name: ExtensionName): Promise<void>;
     /**
      * 获取扩展列表
      */
     useExtensionsList(): readonly [Extension[]];
+    /**
+     * 获得所有的插件
+     */
+    getExtensions(): readonly Extension[];
 }
+export {};

package/dist/lib/src/extension/ExtensionManager.old.d.ts

@@ -0,0 +1,52 @@
+import type { Extension, ExtensionName, ExtractExtensionContext } from './declare';
+import { InnerZustandStoreManager } from '../base/InnerZustandStoreManager';
+/**
+ * 定义一个插件, 这里所抽象得插件只是一个携带数据得对象、以及具有特殊时机执行得函数
+ *
+ * 1. 插件件可以有自己的生命周期函数, 例如 onActivated, onDeactivated
+ * 2. 插件可以调动 metadataManager 从而实现插件化开发
+ * 3. 调动 emitter 实现事件触发
+ */
+export declare class ExtensionManager<Ext extends Extension> extends InnerZustandStoreManager {
+    private readonly extNameMapStore;
+    /**
+     * Define extension, 定义插件, 那么插件会被存储到 Map 中.
+     */
+    defineExtension<DExt extends Ext>(define: DExt): DExt;
+    /**
+     * 判断一个对象是否是一个 扩展对象
+     */
+    isExtension<DExt extends Ext>(extension: DExt | any): extension is DExt;
+    /**
+     * 判断是否含有当前扩展：即是否已经注册
+     */
+    hasExtension(extensionName: ExtensionName): boolean;
+    /**
+     * 获取一个扩展
+     */
+    getExtension(extensionName: ExtensionName): Extension<unknown> | null;
+    /**
+     * 注册一个扩展
+     */
+    registerExtension<DExt extends Ext>(extension: DExt): void;
+    /**
+     * Activated extension
+     */
+    activatedExtension<Context extends ExtractExtensionContext<Ext>>(name: ExtensionName, context?: Context): Promise<void>;
+    /**
+     * 去活某个插件
+     */
+    deactivatedExtension<Context extends ExtractExtensionContext<Ext>>(name: ExtensionName, context?: Context): Promise<void>;
+    /**w
+     * 删除扩展
+     */
+    delExtension<Context extends ExtractExtensionContext<Ext>>(name: ExtensionName, context?: Context): Promise<void>;
+    /**
+     * 获取扩展列表
+     */
+    useExtensionsList(): readonly [Extension[]];
+    /**
+     * 获得所有的插件
+     */
+    getExtensions(): readonly Extension[];
+}

package/dist/lib/src/extension/declare.d.ts

@@ -1,5 +1,7 @@
-export type ExtensionName = string | symbol;
-export interface Extension<Context = any> {
+export type ExtensionName = string;
+export type ExtensionOnActivated<Context = unknown> = (context?: Context) => ((() => void) | Promise<(() => void)> | void | Promise<void>);
+export type ExtensionOnDeactivated<Context = unknown> = (context?: Context) => (void | Promise<void>);
+export interface Extension<Context = unknown> {
     /**
      * 插件的唯一标识 name
      */
@@ -11,15 +13,12 @@ export interface Extension<Context = any> {
     /**
      * 插件数据, 由项目自主决定插件附带携带的数据
      */
-    readonly meta?: any;
+    meta?: any;
     /**
      * 插件被激活, 被使用的状态
      */
-    readonly onActivated?: (this: this, context: Context) => (void | Promise<void>);
-    /**
-     * 插件被去活, 被禁用的状态
-     */
-    readonly onDeactivated?: (this: this, context: Context) => (void | Promise<void>);
+    readonly onActivated?: ExtensionOnActivated<Context>;
+    readonly onDeactivated?: ExtensionOnDeactivated<Context>;
 }
 export interface ExtensionWithLifecycle {
     readonly extension: Extension;
@@ -27,5 +26,7 @@ export interface ExtensionWithLifecycle {
      * 插件是否被激活
      */
     isActivated: boolean;
+    onActivated?: () => void;
+    onDeactivated?: () => void;
 }
 export type ExtractExtensionContext<Ext extends Extension> = Parameters<Exclude<Ext['onActivated'], undefined>>[0];

package/dist/lib/src/extension/index.d.ts

@@ -1,2 +1,3 @@
-export type { Extension, ExtensionName, ExtensionWithLifecycle, ExtractExtensionContext } from './declare';
+export type { ExtensionName, ExtensionWithLifecycle, ExtractExtensionContext } from './declare';
 export { ExtensionManager } from './ExtensionManager';
+export type { Extension } from './ExtensionManager';

package/dist/lib/src/metadata/MetadataManager.d.ts

@@ -1,5 +1,40 @@
-import type { ExtractSingleEntries, ExtractVectorEntries, ExtractElInArray, MetadataStoreChangeListener, MetadataStoreListenerPayload } from './declare';
-import { InnerZustandStoreManager } from '../base/InnerZustandStoreManager';
+type IsAny<T, SuccessReturnType, FailReturnType> = (T extends never ? 'yes' : 'no') extends 'no' ? FailReturnType : SuccessReturnType;
+/**
+ * 从数组中提取出元素的类型
+ * @example
+ * type A = number[];
+ * type B = ExtractElInArray<A>; // number
+ */
+type ExtractElInArray<T> = IsAny<T, never, T extends (infer U)[] ? U : never>;
+/**
+ * 提取列表的 entries, 在 interface {} 中, 只有值为数组类型 U[], 时会被保留, 否则不在此类型中
+ * @example
+ * type A = {
+ *    name: string;
+ *    age: number;
+ *    friends: any[];
+ * }
+ *
+ * type B = ExtractVectorEntries<A>; // { friends: any[]; }
+ */
+type ExtractVectorEntries<Entries> = {
+    [Key in keyof Entries as (IsAny<Entries[Key], never, Entries[Key] extends unknown[] ? Key : never>)]: Entries[Key];
+};
+/**
+ * 提取列表的 entries, 在 interface {} 中, 只有值不为数组类型 U[], 时会被保留, 否则不在此类型中
+ * @description 与上一个 `ExtractVectorEntries` 相反
+ * @example
+ * type A = {
+ *    name: string;
+ *    age: number;
+ *    friends: any[];
+ * }
+ *
+ * type B = ExtractSingleEntries<A>; // { name: string;age: number; }
+ */
+type ExtractSingleEntries<Entries> = {
+    [Key in keyof Entries as Entries[Key] extends unknown[] ? never : Key]: Entries[Key];
+};
 /**
  * 元数据, 在页面中组件的变化可能相距甚远
  * 进入到某一个页面, 可能其他大组件下的某处地方可能发生元素更改, 那么使用本 store 进行连携
@@ -9,17 +44,10 @@ import { InnerZustandStoreManager } from '../base/InnerZustandStoreManager';
  * 2. 在特殊时机, 注册槽点数据, 从而响应式自动更新到子孙或者兄弟级甚远的组件进行渲染
  *
  */
-export declare class MetadataManager<MetadataEntries extends Record<string, any>> extends InnerZustandStoreManager {
+export declare class MetadataManager<MetadataEntries extends Record<string, any>> {
+    private readonly rxpInnerStore;
     private readonly metadataMap;
-    private readonly metadataChangeListeners;
-    /**
-     * 触发元数据更改监听函数
-     */
-    protected triggerMetadataChangeListeners(payload: MetadataStoreListenerPayload): void;
-    /**
-     * 订阅元数据更改
-     */
-    subscribeMetadataStoreChanged(listener: MetadataStoreChangeListener): () => void;
+    constructor();
     /**
      * 定义 store 元数据, 元数据可以是任何东西
      * @example
@@ -28,13 +56,21 @@ export declare class MetadataManager<MetadataEntries extends Record<string, any>
      * metadata.defineMetadata('example-key', {});
      * metadata.defineMetadata('example-key', () => { return (<div />) });
      */
-    defineMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): void;
+    defineMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): () => void;
     /**
      * 获取定义的元数据
      * @example
      * metadata.getMetadata('example-key');
      */
     getMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey): MetadataEntries[MetadataKey] | null;
+    /**
+     * 获取元数据列表中最新注册的元数据
+     */
+    getMetadataLatestInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey): ExtractElInArray<MetadataEntries[MetadataKey]> | null;
+    /**
+     * 获取元数据列表中最旧注册的元数据
+     */
+    getMetadataOldestInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey): ExtractElInArray<MetadataEntries[MetadataKey]> | null;
     /**
      * 删除定义的元数据
      * @example
@@ -45,7 +81,7 @@ export declare class MetadataManager<MetadataEntries extends Record<string, any>
      * 语义化方法, 作用与 defineMetadata 一致. 但是在此基础上排除了数据值类型
      * @description 意为: 定义覆盖式的元数据
      */
-    defineMetadataInSingle<MetadataKey extends keyof ExtractSingleEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): void;
+    defineMetadataInSingle<MetadataKey extends keyof ExtractSingleEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): () => void;
     /**
      * 定义多个元数据组合的容器型元数据列表, 顾名思义, 也就是某个元数据的定义是数组时使用, 能够自动从数组中添加单个该元数据, 而不是全部覆盖
      * @example
@@ -54,7 +90,7 @@ export declare class MetadataManager<MetadataEntries extends Record<string, any>
      * metadata.defineMetadataInVector('example-key', {});
      * metadata.defineMetadataInVector('example-key', () => { return (<div />) });
      */
-    defineMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: ExtractElInArray<MetadataEntries[MetadataKey]>): void;
+    defineMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: ExtractElInArray<MetadataEntries[MetadataKey]>): (() => void);
     /**
      * 在一组元数据集合列表中删除具体的某一个, 通常与 `defineMetadataInVector` 配套使用
      * @example
@@ -111,4 +147,17 @@ export declare class MetadataManager<MetadataEntries extends Record<string, any>
      * 查看是否定义了元数据
      */
     hasMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey): boolean;
+    /**
+     * 在组件中注册元数据, 跟随当前组件生命周期, 组件卸载时自动删除
+     */
+    useFollowMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): void;
+    /**
+     * 在组件中注册元数据, 跟随当前组件生命周期, 组件卸载时自动删除
+     */
+    useFollowMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: ExtractElInArray<MetadataEntries[MetadataKey]>): void;
+    /**
+     * 在组件中注册元数据, 跟随当前组件生命周期, 组件卸载时自动删除
+     */
+    useFollowMetadataInSingle<MetadataKey extends keyof ExtractSingleEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): void;
 }
+export {};

package/dist/lib/src/metadata/MetadataManager.old.d.ts

@@ -0,0 +1,125 @@
+import type { ExtractSingleEntries, ExtractVectorEntries, ExtractElInArray } from './declare';
+import { InnerZustandStoreManager } from '../base/InnerZustandStoreManager';
+/**
+ * 元数据, 在页面中组件的变化可能相距甚远
+ * 进入到某一个页面, 可能其他大组件下的某处地方可能发生元素更改, 那么使用本 store 进行连携
+ *
+ * 1. 在可能变化的地方获取槽点数据, 可能是字符也有可能是其他的
+ *
+ * 2. 在特殊时机, 注册槽点数据, 从而响应式自动更新到子孙或者兄弟级甚远的组件进行渲染
+ *
+ */
+export declare class MetadataManager<MetadataEntries extends Record<string, any>> extends InnerZustandStoreManager {
+    private readonly metadataMap;
+    /**
+     * 定义 store 元数据, 元数据可以是任何东西
+     * @example
+     * metadata.defineMetadata('example-key', 1);
+     * metadata.defineMetadata('example-key', 'a');
+     * metadata.defineMetadata('example-key', {});
+     * metadata.defineMetadata('example-key', () => { return (<div />) });
+     */
+    defineMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): () => void;
+    /**
+     * 获取定义的元数据
+     * @example
+     * metadata.getMetadata('example-key');
+     */
+    getMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey): MetadataEntries[MetadataKey] | null;
+    /**
+     * 获取元数据列表中最新注册的元数据
+     */
+    getMetadataLatestInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey): ExtractElInArray<MetadataEntries[MetadataKey]> | null;
+    /**
+     * 获取元数据列表中最旧注册的元数据
+     */
+    getMetadataOldestInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey): ExtractElInArray<MetadataEntries[MetadataKey]> | null;
+    /**
+     * 删除定义的元数据
+     * @example
+     * metadata.delMetadata('example-key');
+     */
+    delMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey): void;
+    /**
+     * 语义化方法, 作用与 defineMetadata 一致. 但是在此基础上排除了数据值类型
+     * @description 意为: 定义覆盖式的元数据
+     */
+    defineMetadataInSingle<MetadataKey extends keyof ExtractSingleEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): () => void;
+    /**
+     * 定义多个元数据组合的容器型元数据列表, 顾名思义, 也就是某个元数据的定义是数组时使用, 能够自动从数组中添加单个该元数据, 而不是全部覆盖
+     * @example
+     * metadata.defineMetadataInVector('example-key', 1);
+     * metadata.defineMetadataInVector('example-key', 'a');
+     * metadata.defineMetadataInVector('example-key', {});
+     * metadata.defineMetadataInVector('example-key', () => { return (<div />) });
+     */
+    defineMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: ExtractElInArray<MetadataEntries[MetadataKey]>): (() => void);
+    /**
+     * 在一组元数据集合列表中删除具体的某一个, 通常与 `defineMetadataInVector` 配套使用
+     * @example
+     * const data = {};
+     * metadata.defineMetadataInVector('example-key', data);
+     *
+     * metadata.delMetadataInVector('example-key', data);
+     */
+    delMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: ExtractElInArray<MetadataEntries[MetadataKey]>): void;
+    /**
+     * 组件 hook, 观察元数据变化
+     * @description 返回数据是注册的元数据, 如果是非 react 组件, 而是普通数据, 所以外部要监听使用变化时应当加入 effect 副作用列表
+     * @example
+     * const Fc = () => {
+     *   const data = metadata.useMetadata('example-key');
+     *   useEffect(() => {
+     *     // use data
+     *     // some code...
+     *     return () => {
+     *        // clear data use.
+     *        // some code...
+     *     }
+     *   }, [data]);
+     *   return (<div />)
+     * }
+     *
+     * @description 使用的元数据也有可能是 react 组件
+     * @example
+     * const Fc = () => {
+     *   const Component = metadata.useMetadata('example-key');
+     *
+     *   return (
+     *    <div>
+     *      {Component && (<Component />)}
+     *    </div>
+     *   )
+     * }
+     *
+     */
+    useMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey): MetadataEntries[MetadataKey] | null;
+    /**
+     * 使用最先注册的元数据
+     */
+    useOldestMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey): ExtractElInArray<MetadataEntries[MetadataKey]> | null;
+    /**
+     * 使用最后一次注册的元数据
+     */
+    useLatestMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey): ExtractElInArray<MetadataEntries[MetadataKey]> | null;
+    /**
+     * 获取到所有定义的元数据
+     */
+    useAllMetadata(): Map<string | number | symbol, any>;
+    /**
+     * 查看是否定义了元数据
+     */
+    hasMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey): boolean;
+    /**
+     * 在组件中注册元数据, 跟随当前组件生命周期, 组件卸载时自动删除
+     */
+    useFollowMetadata<MetadataKey extends keyof MetadataEntries>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): void;
+    /**
+     * 在组件中注册元数据, 跟随当前组件生命周期, 组件卸载时自动删除
+     */
+    useFollowMetadataInVector<MetadataKey extends keyof ExtractVectorEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: ExtractElInArray<MetadataEntries[MetadataKey]>): void;
+    /**
+     * 在组件中注册元数据, 跟随当前组件生命周期, 组件卸载时自动删除
+     */
+    useFollowMetadataInSingle<MetadataKey extends keyof ExtractSingleEntries<MetadataEntries>>(metadataKey: MetadataKey, metadata: MetadataEntries[MetadataKey]): void;
+}

package/dist/lib/src/metadata/declare.d.ts

@@ -1,5 +1,4 @@
-type IsNever<T, SuccessReturnType, FailReturnType> = T extends never ? SuccessReturnType : FailReturnType;
-type IsAny<T, SuccessReturnType, FailReturnType> = IsNever<T, 'yes', 'no'> extends 'no' ? FailReturnType : SuccessReturnType;
+type IsAny<T, SuccessReturnType, FailReturnType> = (T extends never ? 'yes' : 'no') extends 'no' ? FailReturnType : SuccessReturnType;
 /**
  * 从数组中提取出元素的类型
  * @example
@@ -12,7 +11,7 @@ export type ExtractElInArray<T> = IsAny<T, never, T extends (infer U)[] ? U : ne
  * @example
  * type A = {
  *    name: string;
- *    age: number;w
+ *    age: number;
  *    friends: any[];
  * }
  *
@@ -36,13 +35,4 @@ export type ExtractVectorEntries<Entries> = {
 export type ExtractSingleEntries<Entries> = {
     [Key in keyof Entries as Entries[Key] extends unknown[] ? never : Key]: Entries[Key];
 };
-export type MetadataAction = 'Define' | 'Remove';
-export type MetadataType = 'Vector' | 'Single' | 'All';
-export interface MetadataStoreListenerPayload {
-    action: MetadataAction;
-    type: MetadataType;
-    metadataKey: number | string | symbol;
-    metadata: unknown;
-}
-export type MetadataStoreChangeListener = (payload: MetadataStoreListenerPayload) => void;
 export {};

package/dist/lib/src/metadata/index.d.ts

@@ -1,2 +1 @@
 export { MetadataManager } from './MetadataManager';
-export type { MetadataAction, MetadataType, MetadataStoreChangeListener, MetadataStoreListenerPayload } from './declare';