@fox-js/fox 3.1.1-24 → 3.1.1-26

package/libs/index.esm.d.ts

@@ -1,11 +1,8 @@
 import { App } from 'vue';
-import { ComponentInternalInstance } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
-import { ComponentPublicInstance } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
-import { InjectionKey } from 'vue';
 import { PropType } from 'vue';
 import { PublicProps } from 'vue';
 import { Ref } from 'vue';
@@ -48,6 +45,12 @@ declare interface BeforeRouteFilter {
     }, session: Record<string | number | symbol, any>): void;
 }
 
+/**
+ * 在当前scope中绑定Lifecycle context
+ * @params 扩展范围引用
+ */
+export declare function bindLifecycleContextToCurrentScope(extScopeRefs?: Array<Object>): boolean;
+
 declare const _buildPage: unique symbol;
 
 /**
@@ -126,15 +129,15 @@ declare const cursorKey: unique symbol;
 /**
  * 自定义过渡
  */
-export declare type CustomTransition = 'custom';
+declare type CustomTransition = 'custom';
 
 /**
  * 删除 context value
- * @param proxy
+ * @param contextRelationKey 上下文关联key
  * @param key
  *
  */
-export declare function deleteContextValue(proxy: ComponentPublicInstance, key: KeyType_2): void;
+export declare function deleteContextValue(contextRelationKey: FoxContextRelationKey | null, key: KeyType_2, route?: Route): void;
 
 declare const _destroy: unique symbol;
 
@@ -439,8 +442,9 @@ export declare interface Fox {
     /**
      * 安装
      * @param app
+     * @param options
      */
-    install(app: App<Element>): void;
+    install(app: App<Element>, options?: FoxInstallOptions): void;
 }
 
 /**
@@ -454,9 +458,10 @@ export declare const FoxBeforeEnter = "FoxBeforeEnter";
 export declare const FoxBeforeLeave = "FoxLeave";
 
 /**
- * 全局Bus
+ * FoxContextKey
+ * 上下文key
  */
-export declare const foxBusKey: FoxInjectionKey<BusInterface>;
+declare type FoxContextRelationKey = Object;
 
 /**
  * Fox过渡进入事件
@@ -464,16 +469,12 @@ export declare const foxBusKey: FoxInjectionKey<BusInterface>;
 export declare const FoxEnter = "FoxEnter";
 
 /**
- * 全局Event Proxy
- */
-export declare const foxEventProxyKey: FoxInjectionKey<EventProxy>;
-
-declare type FoxInjectionKey<T> = InjectionKey<T>;
-
-/**
- * 全局Fox
+ * Fox安装参数
  */
-export declare const foxKey: FoxInjectionKey<Fox>;
+declare interface FoxInstallOptions {
+    install?: boolean;
+    optionsApi?: boolean;
+}
 
 /**
  *  Fox过渡离开事件
@@ -487,15 +488,15 @@ export declare const FoxLeave = "FoxLeave";
 export declare const FoxLeaveEnd = "FoxLeaveEnd";
 
 /**
- * 参数
+ * Fox参数
  */
-export declare interface FoxOptions extends RouterOptions {
+declare interface FoxOptions extends RouterOptions {
 }
 
 /**
  * 通用函数接口
  */
-export declare interface GenericFunction {
+declare interface GenericFunction {
     (...args: any[]): any;
 }
 
@@ -538,10 +539,17 @@ declare const initKey: unique symbol;
 
 /**
  * inject context value
- * @param proxy
+ * @param contextRelationKey 上下文关联key
+ * @param key
  * @returns
  */
-export declare function injectContextValue(proxy: ComponentPublicInstance, key: KeyType_2): unknown;
+export declare function injectContextValue<T extends unknown>(contextRelationKey: FoxContextRelationKey | null, key: KeyType_2): T | null;
+
+/**
+ * inject Lifecycle context
+ * @param contextRelationKey 上下文关联key
+ */
+export declare function injectLifecycleContext(contextRelationKey?: FoxContextRelationKey | null): LifecycleContext | null;
 
 /**
  * 是否数组
@@ -633,6 +641,9 @@ export declare const isString: (val: unknown) => val is string;
  */
 export declare const isSymbol: (val: unknown) => val is symbol;
 
+/**
+ * 数据类型key
+ */
 declare type KeyType_2 = string | number | Symbol;
 
 /**
@@ -645,6 +656,44 @@ declare class Layer {
     views: View[];
 }
 
+/**
+ * 生命周期上下文
+ */
+declare class LifecycleContext {
+    /**
+     * 数据列表
+     */
+    private [registerKey_3];
+    /**
+     * 构造函数
+     */
+    constructor();
+    /**
+     * 设置value
+     * @param key
+     * @param value
+     */
+    set(key: KeyType_2, value: any): void;
+    /**
+     * 获取数据
+     * @param key
+     * @returns
+     */
+    get(key: KeyType_2): any;
+    /**
+     * 是否有对应的数据
+     * @param key
+     * @returns
+     */
+    has(key: KeyType_2): boolean;
+    /**
+     * 删除数据
+     * @param key
+     * @returns
+     */
+    delete(key: KeyType_2): boolean;
+}
+
 declare const _load: unique symbol;
 
 declare const mainDispatcherKey: unique symbol;
@@ -724,10 +773,6 @@ declare class ModelLayer {
  * model插槽
  */
 declare class ModelSlot {
-    /**
-     * 实例
-     */
-    instance: ComponentInternalInstance | null;
     /**
      * model
      */
@@ -778,8 +823,14 @@ export declare function onBeforeRouteUpdate(callback: {
     (to: Route, from?: Route): void;
 }): void;
 
+/**
+ * 导出注册Fox Activated方法
+ */
 export declare const onFoxActivated: (hook: GenericFunction) => void;
 
+/**
+ * 导出注册Fox Inactivated方法
+ */
 export declare const onFoxInactivated: (hook: GenericFunction) => void;
 
 /**
@@ -840,7 +891,7 @@ declare type PersistPolicy = 'memory' | 'session' | 'local' | 'custom';
 /**
  * 属性函数
  */
-export declare type PropFunction = {
+declare type PropFunction = {
     (route: Route, index: number): any;
 };
 
@@ -855,13 +906,11 @@ declare const propsFilterKey: unique symbol;
 
 /**
  * provide context value
- * @param proxy
+ * @param contextRelationKey 上下文关联key
  * @param key
  * @param value
  */
-export declare function provideContextValue(proxy: ComponentPublicInstance, key: KeyType_2, value: any): void;
-
-declare type Proxy_2 = ComponentPublicInstance | null;
+export declare function provideContextValue(contextRelationKey: FoxContextRelationKey | null, key: KeyType_2, value: any): void;
 
 /**
  * raw state
@@ -887,6 +936,11 @@ declare const registerKey: unique symbol;
 
 declare const registerKey_2: unique symbol;
 
+/**
+ * 注册表key
+ */
+declare const registerKey_3: unique symbol;
+
 /**
  * remove route 条件
  */
@@ -1215,7 +1269,7 @@ export declare class Route {
      * @param y
      * @returns
      */
-    static isSamePathForRoute(x: Route, y: Route): boolean;
+    static isSamePathForRoute(x: Route | null, y: Route | null): boolean;
     /**
      * 由对象生成路由
      * @param obj
@@ -2439,7 +2493,7 @@ declare const routeSessionCacheKey: unique symbol;
 
 declare const routeUpdatedCallback: unique symbol;
 
-export declare const sessionKey: unique symbol;
+declare const sessionKey: unique symbol;
 
 /**
  * shallow reactive state
@@ -2519,7 +2573,6 @@ declare interface Storage_2 {
      */
     removeItem(key: string): void;
 }
-export { Storage_2 as Storage }
 
 declare const successFnsKey: unique symbol;
 
@@ -2551,7 +2604,7 @@ export declare const toTypeString: (value: unknown) => string;
 /**
  * 过渡属性
  */
-export declare type TransitionProp = {
+declare type TransitionProp = {
     (route: Route, index: number): CustomTransition | boolean;
 } | CustomTransition | boolean;
 
@@ -2699,37 +2752,38 @@ declare enum UpdateType {
 
 /**
  * Returns the global bus
- * @param proxy
+ * @param contextRelationKey 上下文关联key
  * @returns
  */
-export declare function useBus(proxy?: Proxy_2): BusInterface;
+export declare function useBus(contextRelationKey?: FoxContextRelationKey): BusInterface | null;
 
 /**
  * Returns the global event proxy
- * @param proxy
  * @returns
  */
-export declare function useEventProxy(proxy?: Proxy_2): EventProxy;
+export declare function useEventProxy(contextRelationKey?: FoxContextRelationKey): EventProxy | null;
 
 /**
  * Returns the current fox
- * @param proxy
+ * @param contextRelationKey 上下文关联key
+ *
  * @returns
  */
-export declare function useFox(proxy?: Proxy_2): Fox;
+export declare function useFox(contextRelationKey?: FoxContextRelationKey): Fox | null;
 
 /**
  * Returns the current route
- * @param proxy
+ * @param 上下文关联key
  * @returns
  */
-export declare function useRoute(proxy?: Proxy_2): Route | null;
+export declare function useRoute(contextRelationKey?: FoxContextRelationKey): Route | null;
 
 /**
  * Returns the current router
+ * @param 上下文关联key
  * @returns
  */
-export declare function useRouter(proxy?: Proxy_2): Router;
+export declare function useRouter(contextRelationKey?: FoxContextRelationKey): Router | null;
 
 declare const valueKey: unique symbol;
 
@@ -2809,4 +2863,14 @@ declare class ViewPlace {
     static include(list: ViewPlace[], viewPlace: ViewPlace): boolean;
 }
 
+/**
+ * 在绑定LifecycleContext上下文中中执行函数
+ *
+ * currentScope(effectScope)为空的情况的替代方案
+ * @param ctx
+ * @param fn
+ * @returns
+ */
+export declare function withLifecycleContext<T>(ctx: LifecycleContext, fn: () => Promise<T> | T): Promise<T>;
+
 export { }