@vue/runtime-core 3.4.26 → 3.4.28

package/dist/runtime-core.d.ts

@@ -1,5 +1,5 @@
-import { computed as computed$1, ShallowUnwrapRef, UnwrapNestedRefs, DebuggerEvent, ComputedGetter, WritableComputedOptions, Ref, ReactiveEffect, ComputedRef, DebuggerOptions, reactive } from '@vue/reactivity';
-export { ComputedGetter, ComputedRef, ComputedSetter, CustomRefFactory, DebuggerEvent, DebuggerEventExtraInfo, DebuggerOptions, DeepReadonly, EffectScheduler, EffectScope, MaybeRef, MaybeRefOrGetter, Raw, ReactiveEffect, ReactiveEffectOptions, ReactiveEffectRunner, ReactiveFlags, Ref, ShallowReactive, ShallowRef, ShallowUnwrapRef, ToRef, ToRefs, TrackOpTypes, TriggerOpTypes, UnwrapNestedRefs, UnwrapRef, WritableComputedOptions, WritableComputedRef, customRef, effect, effectScope, getCurrentScope, isProxy, isReactive, isReadonly, isRef, isShallow, markRaw, onScopeDispose, proxyRefs, reactive, readonly, ref, shallowReactive, shallowReadonly, shallowRef, stop, toRaw, toRef, toRefs, toValue, triggerRef, unref } from '@vue/reactivity';
+import { computed as computed$1, ShallowUnwrapRef, UnwrapNestedRefs, DebuggerEvent, ComputedGetter, WritableComputedOptions, Ref, ReactiveEffect, ComputedRef, DebuggerOptions, ReactiveMarker, reactive } from '@vue/reactivity';
+export { ComputedGetter, ComputedRef, ComputedSetter, CustomRefFactory, DebuggerEvent, DebuggerEventExtraInfo, DebuggerOptions, DeepReadonly, EffectScheduler, EffectScope, MaybeRef, MaybeRefOrGetter, Raw, Reactive, ReactiveEffect, ReactiveEffectOptions, ReactiveEffectRunner, ReactiveFlags, Ref, ShallowReactive, ShallowRef, ShallowUnwrapRef, ToRef, ToRefs, TrackOpTypes, TriggerOpTypes, UnwrapNestedRefs, UnwrapRef, WritableComputedOptions, WritableComputedRef, customRef, effect, effectScope, getCurrentScope, isProxy, isReactive, isReadonly, isRef, isShallow, markRaw, onScopeDispose, proxyRefs, reactive, readonly, ref, shallowReactive, shallowReadonly, shallowRef, stop, toRaw, toRef, toRefs, toValue, triggerRef, unref } from '@vue/reactivity';
 import { IfAny, Prettify, Awaited, UnionToIntersection, LooseRequired } from '@vue/shared';
 export { camelize, capitalize, normalizeClass, normalizeProps, normalizeStyle, toDisplayString, toHandlerKey } from '@vue/shared';
 
@@ -128,7 +128,7 @@ C extends ComputedOptions = {}, M extends MethodOptions = {}, E extends EmitsOpt
     $options: Options & MergedComponentOptionsOverride;
     $forceUpdate: () => void;
     $nextTick: typeof nextTick;
-    $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R]) => any : (...args: any) => any, options?: WatchOptions): WatchStopHandle;
+    $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, OnCleanup]) => any : (...args: [any, any, OnCleanup]) => any, options?: WatchOptions): WatchStopHandle;
 } & IfAny<P, P, Omit<P, keyof ShallowUnwrapRef<B>>> & ShallowUnwrapRef<B> & UnwrapNestedRefs<D> & ExtractComputedReturns<C> & M & ComponentCustomProperties & InjectToObject<I>;
 
 declare enum LifecycleHooks {
@@ -198,7 +198,7 @@ export interface SuspenseBoundary {
     fallback(fallbackVNode: VNode): void;
     move(container: RendererElement, anchor: RendererNode | null, type: MoveType): void;
     next(): RendererNode | null;
-    registerDep(instance: ComponentInternalInstance, setupRenderEffect: SetupRenderEffectFn): void;
+    registerDep(instance: ComponentInternalInstance, setupRenderEffect: SetupRenderEffectFn, optimized: boolean): void;
     unmount(parentSuspense: SuspenseBoundary | null, doRemove?: boolean): void;
 }
 declare function createSuspenseBoundary(vnode: VNode, parentSuspense: SuspenseBoundary | null, parentComponent: ComponentInternalInstance | null, container: RendererElement, hiddenContainer: RendererElement, anchor: RendererNode | null, namespace: ElementNamespace, slotScopeIds: string[] | null, optimized: boolean, rendererInternals: RendererInternals, isHydrating?: boolean): SuspenseBoundary;
@@ -268,7 +268,7 @@ export declare const BaseTransition: new () => {
         default(): VNode[];
     };
 };
-export declare function resolveTransitionHooks(vnode: VNode, props: BaseTransitionProps<any>, state: TransitionState, instance: ComponentInternalInstance): TransitionHooks;
+export declare function resolveTransitionHooks(vnode: VNode, props: BaseTransitionProps<any>, state: TransitionState, instance: ComponentInternalInstance, postClone?: (hooks: TransitionHooks) => void): TransitionHooks;
 export declare function setTransitionHooks(vnode: VNode, hooks: TransitionHooks): void;
 export declare function getTransitionRawChildren(children: VNode[], keepComment?: boolean, parentKey?: VNode['key']): VNode[];
 
@@ -369,16 +369,16 @@ export declare const KeepAlive: {
 export declare function onActivated(hook: Function, target?: ComponentInternalInstance | null): void;
 export declare function onDeactivated(hook: Function, target?: ComponentInternalInstance | null): void;
 
-export declare const onBeforeMount: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
-export declare const onMounted: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
-export declare const onBeforeUpdate: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
-export declare const onUpdated: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
-export declare const onBeforeUnmount: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
-export declare const onUnmounted: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
-export declare const onServerPrefetch: (hook: () => any, target?: ComponentInternalInstance | null) => false | Function | undefined;
+export declare const onBeforeMount: (hook: () => any, target?: ComponentInternalInstance | null) => void;
+export declare const onMounted: (hook: () => any, target?: ComponentInternalInstance | null) => void;
+export declare const onBeforeUpdate: (hook: () => any, target?: ComponentInternalInstance | null) => void;
+export declare const onUpdated: (hook: () => any, target?: ComponentInternalInstance | null) => void;
+export declare const onBeforeUnmount: (hook: () => any, target?: ComponentInternalInstance | null) => void;
+export declare const onUnmounted: (hook: () => any, target?: ComponentInternalInstance | null) => void;
+export declare const onServerPrefetch: (hook: () => any, target?: ComponentInternalInstance | null) => void;
 type DebuggerHook = (e: DebuggerEvent) => void;
-export declare const onRenderTriggered: (hook: DebuggerHook, target?: ComponentInternalInstance | null) => false | Function | undefined;
-export declare const onRenderTracked: (hook: DebuggerHook, target?: ComponentInternalInstance | null) => false | Function | undefined;
+export declare const onRenderTriggered: (hook: DebuggerHook, target?: ComponentInternalInstance | null) => void;
+export declare const onRenderTracked: (hook: DebuggerHook, target?: ComponentInternalInstance | null) => void;
 type ErrorCapturedHook<TError = unknown> = (err: TError, instance: ComponentPublicInstance | null, info: string) => boolean | void;
 export declare function onErrorCaptured<TError = Error>(hook: ErrorCapturedHook<TError>, target?: ComponentInternalInstance | null): void;
 
@@ -488,7 +488,7 @@ return withDirectives(h(comp), [
 */
 
 export interface DirectiveBinding<V = any> {
-    instance: ComponentPublicInstance | null;
+    instance: ComponentPublicInstance | Record<string, any> | null;
     value: V;
     oldValue: V | null;
     arg?: string;
@@ -496,7 +496,7 @@ export interface DirectiveBinding<V = any> {
     dir: ObjectDirective<any, V>;
 }
 export type DirectiveHook<T = any, Prev = VNode<any, T> | null, V = any> = (el: T, binding: DirectiveBinding<V>, vnode: VNode<any, T>, prevVNode: Prev) => void;
-type SSRDirectiveHook = (binding: DirectiveBinding, vnode: VNode) => Data | undefined;
+type SSRDirectiveHook<V> = (binding: DirectiveBinding<V>, vnode: VNode) => Data | undefined;
 export interface ObjectDirective<T = any, V = any> {
     created?: DirectiveHook<T, null, V>;
     beforeMount?: DirectiveHook<T, null, V>;
@@ -505,7 +505,7 @@ export interface ObjectDirective<T = any, V = any> {
     updated?: DirectiveHook<T, VNode<any, T>, V>;
     beforeUnmount?: DirectiveHook<T, null, V>;
     unmounted?: DirectiveHook<T, null, V>;
-    getSSRProps?: SSRDirectiveHook;
+    getSSRProps?: SSRDirectiveHook<V>;
     deep?: boolean;
 }
 export type FunctionDirective<T = any, V = any> = DirectiveHook<T, any, V>;
@@ -772,7 +772,7 @@ export interface App<HostElement = any> {
     directive<T = any, V = any>(name: string, directive: Directive<T, V>): this;
     mount(rootContainer: HostElement | string, isHydrate?: boolean, namespace?: boolean | ElementNamespace): ComponentPublicInstance;
     unmount(): void;
-    provide<T>(key: InjectionKey<T> | string, value: T): this;
+    provide<T, K = InjectionKey<T> | string | number>(key: K, value: K extends InjectionKey<infer V> ? V : T): this;
     /**
      * Runs a function with the app as active instance. This allows using of `inject()` within the function to get access
      * to variables provided via `app.provide()`.
@@ -896,7 +896,7 @@ type VNodeNormalizedRef = VNodeNormalizedRefAtom | VNodeNormalizedRefAtom[];
 type VNodeMountHook = (vnode: VNode) => void;
 type VNodeUpdateHook = (vnode: VNode, oldVNode: VNode) => void;
 export type VNodeProps = {
-    key?: string | number | symbol;
+    key?: PropertyKey;
     ref?: VNodeRef;
     ref_for?: boolean;
     ref_key?: string;
@@ -916,7 +916,7 @@ export interface VNode<HostNode = RendererNode, HostElement = RendererElement, E
 }> {
     type: VNodeTypes;
     props: (VNodeProps & ExtraProps) | null;
-    key: string | number | symbol | null;
+    key: PropertyKey | null;
     ref: VNodeNormalizedRef | null;
     /**
      * SFC only. This is assigned on vnode creation using currentScopeId
@@ -1087,7 +1087,7 @@ export type SetupContext<E = EmitsOptions, S extends SlotsType = {}> = E extends
     attrs: Data;
     slots: UnwrapSlotsType<S>;
     emit: EmitFn<E>;
-    expose: (exposed?: Record<string, any>) => void;
+    expose: <Exposed extends Record<string, any> = Record<string, any>>(exposed?: Exposed) => void;
 } : never;
 /**
  * We expose a subset of properties on the internal instance as they are
@@ -1141,8 +1141,9 @@ export declare const isRuntimeOnly: () => boolean;
 export type WatchEffect = (onCleanup: OnCleanup) => void;
 export type WatchSource<T = any> = Ref<T> | ComputedRef<T> | (() => T);
 export type WatchCallback<V = any, OV = any> = (value: V, oldValue: OV, onCleanup: OnCleanup) => any;
+type MaybeUndefined<T, I> = I extends true ? T | undefined : T;
 type MapSources<T, Immediate> = {
-    [K in keyof T]: T[K] extends WatchSource<infer V> ? Immediate extends true ? V | undefined : V : T[K] extends object ? Immediate extends true ? T[K] | undefined : T[K] : never;
+    [K in keyof T]: T[K] extends WatchSource<infer V> ? MaybeUndefined<V, Immediate> : T[K] extends object ? MaybeUndefined<T[K], Immediate> : never;
 };
 type OnCleanup = (cleanupFn: () => void) => void;
 export interface WatchOptionsBase extends DebuggerOptions {
@@ -1158,10 +1159,10 @@ export declare function watchEffect(effect: WatchEffect, options?: WatchOptionsB
 export declare function watchPostEffect(effect: WatchEffect, options?: DebuggerOptions): WatchStopHandle;
 export declare function watchSyncEffect(effect: WatchEffect, options?: DebuggerOptions): WatchStopHandle;
 type MultiWatchSources = (WatchSource<unknown> | object)[];
-export declare function watch<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchOptions<Immediate>): WatchStopHandle;
+export declare function watch<T, Immediate extends Readonly<boolean> = false>(source: WatchSource<T>, cb: WatchCallback<T, MaybeUndefined<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
+export declare function watch<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(sources: readonly [...T] | T, cb: [T] extends [ReactiveMarker] ? WatchCallback<T, MaybeUndefined<T, Immediate>> : WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
 export declare function watch<T extends MultiWatchSources, Immediate extends Readonly<boolean> = false>(sources: [...T], cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
-export declare function watch<T extends Readonly<MultiWatchSources>, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
-export declare function watch<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchOptions<Immediate>): WatchStopHandle;
+export declare function watch<T extends object, Immediate extends Readonly<boolean> = false>(source: T, cb: WatchCallback<T, MaybeUndefined<T, Immediate>>, options?: WatchOptions<Immediate>): WatchStopHandle;
 
 type AsyncComponentResolveResult<T = Component> = T | {
     default: T;
@@ -1236,7 +1237,7 @@ type BooleanKey<T, K extends keyof T = keyof T> = K extends any ? [T[K]] extends
  * const emit = defineEmits<{
  *   // <eventName>: <expected arguments>
  *   change: []
- *   update: [value: string] // named tuple syntax
+ *   update: [value: number] // named tuple syntax
  * }>()
  *
  * emit('change')
@@ -1283,7 +1284,7 @@ export declare function defineOptions<RawBindings = {}, D = {}, C extends Comput
     slots?: undefined;
 }): void;
 export declare function defineSlots<S extends Record<string, any> = Record<string, any>>(): StrictUnwrapSlotsType<SlotsType<S>>;
-export type ModelRef<T, M extends string | number | symbol = string> = Ref<T> & [
+export type ModelRef<T, M extends PropertyKey = string> = Ref<T> & [
     ModelRef<T, M>,
     Record<M, true | undefined>
 ];
@@ -1324,20 +1325,20 @@ type DefineModelOptions<T = any> = {
  * const count = defineModel<number>('count', { default: 0 })
  * ```
  */
-export declare function defineModel<T, M extends string | number | symbol = string>(options: {
+export declare function defineModel<T, M extends PropertyKey = string>(options: {
     required: true;
 } & PropOptions<T> & DefineModelOptions<T>): ModelRef<T, M>;
-export declare function defineModel<T, M extends string | number | symbol = string>(options: {
+export declare function defineModel<T, M extends PropertyKey = string>(options: {
     default: any;
 } & PropOptions<T> & DefineModelOptions<T>): ModelRef<T, M>;
-export declare function defineModel<T, M extends string | number | symbol = string>(options?: PropOptions<T> & DefineModelOptions<T>): ModelRef<T | undefined, M>;
-export declare function defineModel<T, M extends string | number | symbol = string>(name: string, options: {
+export declare function defineModel<T, M extends PropertyKey = string>(options?: PropOptions<T> & DefineModelOptions<T>): ModelRef<T | undefined, M>;
+export declare function defineModel<T, M extends PropertyKey = string>(name: string, options: {
     required: true;
 } & PropOptions<T> & DefineModelOptions<T>): ModelRef<T, M>;
-export declare function defineModel<T, M extends string | number | symbol = string>(name: string, options: {
+export declare function defineModel<T, M extends PropertyKey = string>(name: string, options: {
     default: any;
 } & PropOptions<T> & DefineModelOptions<T>): ModelRef<T, M>;
-export declare function defineModel<T, M extends string | number | symbol = string>(name: string, options?: PropOptions<T> & DefineModelOptions<T>): ModelRef<T | undefined, M>;
+export declare function defineModel<T, M extends PropertyKey = string>(name: string, options?: PropOptions<T> & DefineModelOptions<T>): ModelRef<T | undefined, M>;
 type NotUndefined<T> = T extends undefined ? never : T;
 type MappedOmit<T, K extends keyof any> = {
     [P in keyof T as P extends K ? never : P]: T[P];
@@ -1376,7 +1377,7 @@ export declare function withDefaults<T, BKeys extends keyof T, Defaults extends
 export declare function useSlots(): SetupContext['slots'];
 export declare function useAttrs(): SetupContext['attrs'];
 
-export declare function useModel<M extends string | number | symbol, T extends Record<string, any>, K extends keyof T>(props: T, name: K, options?: DefineModelOptions<T[K]>): ModelRef<T[K], M>;
+export declare function useModel<M extends PropertyKey, T extends Record<string, any>, K extends keyof T>(props: T, name: K, options?: DefineModelOptions<T[K]>): ModelRef<T[K], M>;
 
 type RawProps = VNodeProps & {
     __v_isVNode?: never;
@@ -1520,7 +1521,7 @@ export declare function renderList<T>(source: Iterable<T>, renderItem: (value: T
 /**
  * v-for object
  */
-export declare function renderList<T>(source: T, renderItem: <K extends keyof T>(value: T[K], key: K, index: number) => VNodeChild): VNodeChild[];
+export declare function renderList<T>(source: T, renderItem: <K extends keyof T>(value: T[K], key: string, index: number) => VNodeChild): VNodeChild[];
 
 /**
  * For prefixing keys in v-on="obj" with "on"
@@ -1580,8 +1581,8 @@ export type LegacyConfig = {
 
 type LegacyPublicInstance = ComponentPublicInstance & LegacyPublicProperties;
 interface LegacyPublicProperties {
-    $set(target: object, key: string, value: any): void;
-    $delete(target: object, key: string): void;
+    $set<T extends Record<keyof any, any>, K extends keyof T>(target: T, key: K, value: T[K]): void;
+    $delete<T extends Record<keyof any, any>, K extends keyof T>(target: T, key: K): void;
     $mount(el?: string | Element): this;
     $destroy(): void;
     $scopedSlots: Slots;
@@ -1618,11 +1619,11 @@ export type CompatVue = Pick<App, 'version' | 'component' | 'directive'> & {
     /**
      * @deprecated Vue 3 no longer needs set() for adding new properties.
      */
-    set(target: any, key: string | number | symbol, value: any): void;
+    set(target: any, key: PropertyKey, value: any): void;
     /**
      * @deprecated Vue 3 no longer needs delete() for property deletions.
      */
-    delete(target: any, key: string | number | symbol): void;
+    delete(target: any, key: PropertyKey): void;
     /**
      * @deprecated use `reactive` instead.
      */