@simonbackx/vue-app-navigation 2.5.2 → 2.6.0

package/dist/src/ModalStackComponent.vue.d.ts

@@ -1,380 +1,63 @@
 import { PushOptions } from './PushOptions';
-import { ComponentWithProperties } from './ComponentWithProperties';
-import { PropType, Ref } from 'vue';
+import { ComponentWithProperties, ComponentWithPropertiesType } from './ComponentWithProperties';
 
-export declare function useModalStackComponent(): Ref<InstanceType<typeof ModalStackComponent>>;
-declare const ModalStackComponent: import('vue').DefineComponent<{
-    root: {
-        default: null;
-        type: PropType<ComponentWithProperties | null>;
-    };
-    initialComponents: {
-        default: null;
-        type: PropType<ComponentWithProperties[] | null>;
-    };
-    initialPresents: {
-        default: null;
-        type: PropType<PushOptions[] | null>;
-    };
-}, unknown, unknown, {
-    stackComponent(): import('vue').CreateComponentPublicInstance<Readonly<import('vue').ExtractPropTypes<{}>> & {
-        onPresent?: ((...args: any[]) => any) | undefined;
-        onReturnToHistoryIndex?: ((...args: any[]) => any) | undefined;
-    }, {}, {
-        components: ComponentWithProperties[];
-    }, {}, {
-        getCustomProvide(index: number, key: number): {
-            reactive_navigation_pop: () => void;
-            reactive_navigation_can_pop: boolean;
-            reactive_navigation_dismiss: () => void;
-            reactive_navigation_can_dismiss: boolean;
-            reactive_navigation_focused: boolean;
-        };
-        show(component: ComponentWithProperties): void;
-        getFocusedComponent(): {
-            component: any;
-            properties: Record<string, any>;
-            provide: Record<string, any>;
-            inheritedDisplayerProvide: Record<string, any>;
-            inheritedParentProvide: Record<string, any>;
-            key: number;
-            type: string | null;
-            vnode: import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
-                [key: string]: any;
-            }> | null;
-            unmount: ((vnode: import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
-                [key: string]: any;
-            }>) => void) | null;
-            keepAlive: boolean;
-            isKeptAlive: boolean;
-            modalDisplayStyle: import('./ComponentWithProperties').ModalDisplayStyle;
-            animated: boolean;
-            checkRoutes: boolean;
-            isDismissing: boolean;
-            historyIndex: number | null;
-            setCheckRoutes: () => ComponentWithProperties;
-            readonly combinedProvide: {
-                [x: string]: any;
-            };
-            inheritFromDisplayer: (component: ComponentWithProperties) => void;
-            inheritFromParent: (component: ComponentWithProperties) => void;
-            clone: () => ComponentWithProperties;
-            beforeMount: () => void;
-            getHistoryIndex: () => number | null | undefined;
-            deleteHistoryIndex: () => void;
-            hasHistoryIndex: () => boolean;
-            assignHistoryIndex: () => void;
-            inheritHistoryIndex: (index: number) => void;
-            ownsHistoryIndex: () => boolean;
-            overrideUrl: (url: import('./HistoryManager').HistoryUrl, title?: string | undefined) => void;
-            setUrl: (url: import('./HistoryManager').HistoryUrl, title?: string | undefined) => void;
-            setTitle: (title: string) => void;
-            returnToHistoryIndex: () => boolean;
-            componentInstance: () => import('vue').ComponentPublicInstance | null;
-            shouldNavigateAway: () => Promise<boolean>;
-            destroy: (vnode: import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
-                [key: string]: any;
-            }>) => void;
-            setDisplayStyle: (style: import('./ComponentWithProperties').ModalDisplayStyle) => ComponentWithProperties;
-            setAnimated: (animated: boolean) => ComponentWithProperties;
-        } | null;
-        removeAt(index: number, key: number): void;
-    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("present" | "returnToHistoryIndex")[], import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & Readonly<import('vue').ExtractPropTypes<{}>> & {
-        onPresent?: ((...args: any[]) => any) | undefined;
+declare function present(options: PushOptions): void;
+declare function replace(component: ComponentWithPropertiesType, animated?: boolean): void;
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    root: ComponentWithPropertiesType;
+    initialComponents?: ComponentWithPropertiesType[] | null;
+    initialPresents?: PushOptions[] | null;
+}>, {
+    initialComponents: null;
+    initialPresents: null;
+}>>, {
+    present: import('vue').ShallowRef<typeof present, typeof present>;
+    stackComponent: import('vue').Ref<import('vue').DefineComponent<{}, {
+        show: (component: ComponentWithProperties) => void;
+        getFocusedComponent: () => ComponentWithProperties | null;
+        removeAt: (index: number, key: number) => void;
+        children: import('vue').Ref<ComponentWithProperties[], ComponentWithProperties[]>;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        returnToHistoryIndex: (...args: any[]) => void;
+    }, string, import('vue').PublicProps, Readonly<{}> & Readonly<{
         onReturnToHistoryIndex?: ((...args: any[]) => any) | undefined;
-    }, {}, true, {}, {}, {
-        P: {};
-        B: {};
-        D: {};
-        C: {};
-        M: {};
-        Defaults: {};
-    }, Readonly<import('vue').ExtractPropTypes<{}>> & {
-        onPresent?: ((...args: any[]) => any) | undefined;
+    }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any> | null, import('vue').DefineComponent<{}, {
+        show: (component: ComponentWithProperties) => void;
+        getFocusedComponent: () => ComponentWithProperties | null;
+        removeAt: (index: number, key: number) => void;
+        children: import('vue').Ref<ComponentWithProperties[], ComponentWithProperties[]>;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        returnToHistoryIndex: (...args: any[]) => void;
+    }, string, import('vue').PublicProps, Readonly<{}> & Readonly<{
         onReturnToHistoryIndex?: ((...args: any[]) => any) | undefined;
-    }, {}, {
-        components: ComponentWithProperties[];
-    }, {}, {
-        getCustomProvide(index: number, key: number): {
-            reactive_navigation_pop: () => void;
-            reactive_navigation_can_pop: boolean;
-            reactive_navigation_dismiss: () => void;
-            reactive_navigation_can_dismiss: boolean;
-            reactive_navigation_focused: boolean;
-        };
-        show(component: ComponentWithProperties): void;
-        getFocusedComponent(): {
-            component: any;
-            properties: Record<string, any>;
-            provide: Record<string, any>;
-            inheritedDisplayerProvide: Record<string, any>;
-            inheritedParentProvide: Record<string, any>;
-            key: number;
-            type: string | null;
-            vnode: import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
-                [key: string]: any;
-            }> | null;
-            unmount: ((vnode: import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
-                [key: string]: any;
-            }>) => void) | null;
-            keepAlive: boolean;
-            isKeptAlive: boolean;
-            modalDisplayStyle: import('./ComponentWithProperties').ModalDisplayStyle;
-            animated: boolean;
-            checkRoutes: boolean;
-            isDismissing: boolean;
-            historyIndex: number | null;
-            setCheckRoutes: () => ComponentWithProperties;
-            readonly combinedProvide: {
-                [x: string]: any;
-            };
-            inheritFromDisplayer: (component: ComponentWithProperties) => void;
-            inheritFromParent: (component: ComponentWithProperties) => void;
-            clone: () => ComponentWithProperties;
-            beforeMount: () => void;
-            getHistoryIndex: () => number | null | undefined;
-            deleteHistoryIndex: () => void;
-            hasHistoryIndex: () => boolean;
-            assignHistoryIndex: () => void;
-            inheritHistoryIndex: (index: number) => void;
-            ownsHistoryIndex: () => boolean;
-            overrideUrl: (url: import('./HistoryManager').HistoryUrl, title?: string | undefined) => void;
-            setUrl: (url: import('./HistoryManager').HistoryUrl, title?: string | undefined) => void;
-            setTitle: (title: string) => void;
-            returnToHistoryIndex: () => boolean;
-            componentInstance: () => import('vue').ComponentPublicInstance | null;
-            shouldNavigateAway: () => Promise<boolean>;
-            destroy: (vnode: import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
-                [key: string]: any;
-            }>) => void;
-            setDisplayStyle: (style: import('./ComponentWithProperties').ModalDisplayStyle) => ComponentWithProperties;
-            setAnimated: (animated: boolean) => ComponentWithProperties;
-        } | null;
-        removeAt(index: number, key: number): void;
-    }, {}>;
-    navigationController(): import('vue').CreateComponentPublicInstance<Readonly<import('vue').ExtractPropTypes<{
-        root: {
-            default: null;
-            type: PropType<ComponentWithProperties | null>;
-        };
-        initialComponents: {
-            default: null;
-            type: PropType<ComponentWithProperties[] | null>;
-        };
-        animationType: {
-            default: string;
-            type: StringConstructor;
-        };
-        customProvide: {
-            type: ObjectConstructor;
-            default: null;
-        };
-    }>> & {
-        onDidPush?: ((...args: any[]) => any) | undefined;
-        onDidPop?: ((...args: any[]) => any) | undefined;
-        onShowDetail?: ((...args: any[]) => any) | undefined;
-        onPresent?: ((...args: any[]) => any) | undefined;
-    }, unknown, {
-        components: import('vue').Raw<ComponentWithProperties>[];
-        mainComponent: import('vue').Raw<ComponentWithProperties> | null;
-        transitionName: string;
-        savedScrollPositions: number[];
-        nextScrollPosition: number;
-        previousScrollPosition: number;
-        nextInternalScrollPosition: number;
-        savedInternalScrollPositions: number[];
-        asyncQueue: (() => Promise<void>)[];
-        asyncQueueRunning: boolean;
-        cachedProvides: Map<number, any>;
-    }, {}, {
-        cacheComponentProvides(newComponent: ComponentWithProperties): void;
-        provideForComponent(key: number): any;
-        runQueue<T>(run: () => Promise<T>): Promise<T>;
-        runQueueIfNeeded(): void;
-        freezeSize(): void;
-        growSize(width: number, height: number): void;
-        unfreezeSize(): void;
-        getInternalScrollElement(element?: Element | null): HTMLElement | null;
-        getScrollElement(element?: HTMLElement | null): HTMLElement;
-        shouldAnimate(): any;
-        returnToHistoryIndex(): boolean;
-        push(options: PushOptions): Promise<void>;
-        shouldNavigateAway(): Promise<boolean>;
-        popToRoot(options?: import('./PopOptions').PopOptions): Promise<ComponentWithProperties[] | undefined>;
-        getPoppableParent(): import('vue').ComponentInternalInstance | null;
-        pop(options?: import('./PopOptions').PopOptions): Promise<ComponentWithProperties[] | undefined>;
-        beforeEnter(insertedElement: Element): void;
-        beforeLeave(leavingElement: Element): void;
-        beforeBeforeEnterAnimation(): void;
-        finishedEnterAnimation(): void;
-        enter(element: any, done: () => void): void;
-        getScrollOuterHeight(scrollElement: HTMLElement): number;
-        leave(element: any, done: () => void): void;
-        afterLeave(element: any): void;
-        afterEnter(element: any): void;
-        enterCancelled(_element: any): void;
-    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("didPush" | "didPop" | "showDetail" | "present")[], import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & Readonly<import('vue').ExtractPropTypes<{
-        root: {
-            default: null;
-            type: PropType<ComponentWithProperties | null>;
-        };
-        initialComponents: {
-            default: null;
-            type: PropType<ComponentWithProperties[] | null>;
-        };
-        animationType: {
-            default: string;
-            type: StringConstructor;
-        };
-        customProvide: {
-            type: ObjectConstructor;
-            default: null;
-        };
-    }>> & {
-        onDidPush?: ((...args: any[]) => any) | undefined;
-        onDidPop?: ((...args: any[]) => any) | undefined;
-        onShowDetail?: ((...args: any[]) => any) | undefined;
-        onPresent?: ((...args: any[]) => any) | undefined;
-    }, {
-        root: ComponentWithProperties | null;
-        customProvide: Record<string, any>;
-        initialComponents: ComponentWithProperties[] | null;
-        animationType: string;
-    }, true, {}, {}, {
-        P: {};
-        B: {};
-        D: {};
-        C: {};
-        M: {};
-        Defaults: {};
-    }, Readonly<import('vue').ExtractPropTypes<{
-        root: {
-            default: null;
-            type: PropType<ComponentWithProperties | null>;
-        };
-        initialComponents: {
-            default: null;
-            type: PropType<ComponentWithProperties[] | null>;
-        };
-        animationType: {
-            default: string;
-            type: StringConstructor;
-        };
-        customProvide: {
-            type: ObjectConstructor;
-            default: null;
-        };
-    }>> & {
-        onDidPush?: ((...args: any[]) => any) | undefined;
-        onDidPop?: ((...args: any[]) => any) | undefined;
-        onShowDetail?: ((...args: any[]) => any) | undefined;
-        onPresent?: ((...args: any[]) => any) | undefined;
-    }, {}, {
-        components: import('vue').Raw<ComponentWithProperties>[];
-        mainComponent: import('vue').Raw<ComponentWithProperties> | null;
-        transitionName: string;
-        savedScrollPositions: number[];
-        nextScrollPosition: number;
-        previousScrollPosition: number;
-        nextInternalScrollPosition: number;
-        savedInternalScrollPositions: number[];
-        asyncQueue: (() => Promise<void>)[];
-        asyncQueueRunning: boolean;
-        cachedProvides: Map<number, any>;
-    }, {}, {
-        cacheComponentProvides(newComponent: ComponentWithProperties): void;
-        provideForComponent(key: number): any;
-        runQueue<T>(run: () => Promise<T>): Promise<T>;
-        runQueueIfNeeded(): void;
-        freezeSize(): void;
-        growSize(width: number, height: number): void;
-        unfreezeSize(): void;
-        getInternalScrollElement(element?: Element | null): HTMLElement | null;
-        getScrollElement(element?: HTMLElement | null): HTMLElement;
-        shouldAnimate(): any;
-        returnToHistoryIndex(): boolean;
-        push(options: PushOptions): Promise<void>;
-        shouldNavigateAway(): Promise<boolean>;
-        popToRoot(options?: import('./PopOptions').PopOptions): Promise<ComponentWithProperties[] | undefined>;
-        getPoppableParent(): import('vue').ComponentInternalInstance | null;
-        pop(options?: import('./PopOptions').PopOptions): Promise<ComponentWithProperties[] | undefined>;
-        beforeEnter(insertedElement: Element): void;
-        beforeLeave(leavingElement: Element): void;
-        beforeBeforeEnterAnimation(): void;
-        finishedEnterAnimation(): void;
-        enter(element: any, done: () => void): void;
-        getScrollOuterHeight(scrollElement: HTMLElement): number;
-        leave(element: any, done: () => void): void;
-        afterLeave(element: any): void;
-        afterEnter(element: any): void;
-        enterCancelled(_element: any): void;
-    }, {
-        root: ComponentWithProperties | null;
-        customProvide: Record<string, any>;
-        initialComponents: ComponentWithProperties[] | null;
-        animationType: string;
-    }>;
-    modalStackComponent(): import('vue').CreateComponentPublicInstance<{
-        readonly root: ComponentWithProperties | null;
-        readonly initialComponents: ComponentWithProperties[] | null;
-        readonly initialPresents: PushOptions[] | null;
-    }, unknown, unknown, any, {
-        present(options: PushOptions): void;
-        returnToHistoryIndex(): boolean;
-        replace(component: ComponentWithProperties, animated?: boolean): void;
-        shouldNavigateAway(): Promise<boolean>;
-    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, {
-        readonly root: ComponentWithProperties | null;
-        readonly initialComponents: ComponentWithProperties[] | null;
-        readonly initialPresents: PushOptions[] | null;
-    }, {
-        root: ComponentWithProperties | null;
-        initialComponents: ComponentWithProperties[] | null;
-        initialPresents: PushOptions[] | null;
-    }, false, {}, {}, {
-        P: {};
-        B: {};
-        D: {};
-        C: {};
-        M: {};
-        Defaults: {};
-    }, {
-        readonly root: ComponentWithProperties | null;
-        readonly initialComponents: ComponentWithProperties[] | null;
-        readonly initialPresents: PushOptions[] | null;
-    }, {}, {}, any, {
-        present(options: PushOptions): void;
-        returnToHistoryIndex(): boolean;
-        replace(component: ComponentWithProperties, animated?: boolean): void;
-        shouldNavigateAway(): Promise<boolean>;
-    }, {
-        root: ComponentWithProperties | null;
-        initialComponents: ComponentWithProperties[] | null;
-        initialPresents: PushOptions[] | null;
-    }>;
-    isFocused(): boolean;
-    isNavigationControllerFocused(): boolean;
-}, {
-    present(options: PushOptions): void;
-    returnToHistoryIndex(): boolean;
-    replace(component: ComponentWithProperties, animated?: boolean): void;
-    shouldNavigateAway(): Promise<boolean>;
-}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
-    root: {
-        default: null;
-        type: PropType<ComponentWithProperties | null>;
-    };
-    initialComponents: {
-        default: null;
-        type: PropType<ComponentWithProperties[] | null>;
-    };
-    initialPresents: {
-        default: null;
-        type: PropType<PushOptions[] | null>;
-    };
-}>>, {
-    root: ComponentWithProperties | null;
-    initialComponents: ComponentWithProperties[] | null;
+    }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any> | null>;
+    replace: typeof replace;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+    root: ComponentWithPropertiesType;
+    initialComponents?: ComponentWithPropertiesType[] | null;
+    initialPresents?: PushOptions[] | null;
+}>, {
+    initialComponents: null;
+    initialPresents: null;
+}>>> & Readonly<{}>, {
+    initialComponents: ComponentWithPropertiesType[] | null;
     initialPresents: PushOptions[] | null;
-}, {}>;
-export default ModalStackComponent;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/src/ModalStackComponentFinderMixin.d.ts

@@ -2,4 +2,4 @@ import { default as ModalStackComponent } from './ModalStackComponent.vue';
 
 export declare const ModalStackComponentFinderMixin: import('vue').DefineComponent<{}, {}, {}, {
     modalStackComponent(): InstanceType<typeof ModalStackComponent> | null;
-}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{}>>, {}, {}>;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;