@qwik.dev/core 2.0.0-beta.13 → 2.0.0-beta.14

package/dist/core-internal.d.ts

@@ -89,20 +89,12 @@ declare interface AddRootFn {
 
 declare type AllEventKeys = keyof AllEventsMap;
 
-declare type AllEventMapRaw = HTMLElementEventMap & DocumentEventMap & WindowEventHandlersEventMap & {
-    qidle: QwikIdleEvent;
-    qinit: QwikInitEvent;
-    qsymbol: QwikSymbolEvent;
-    qvisible: QwikVisibleEvent;
-    qviewtransition: QwikViewTransitionEvent;
-};
+declare type AllEventMapRaw = QwikHTMLElementEventMap & QwikDocumentEventMap & QwikWindowEventMap;
 
 declare type AllEventsMap = Omit<AllEventMapRaw, keyof EventCorrectionMap> & EventCorrectionMap;
 
 declare type _AllowPlainQrl<Q> = QRLEventHandlerMulti<any, any> extends Q ? Q extends QRLEventHandlerMulti<infer EV, infer EL> ? Q | (EL extends Element ? EventHandler<EV, EL> : never) : Q : Q extends QRL<infer U> ? Q | U : NonNullable<Q> extends never ? Q : QRL<Q> | Q;
 
-declare type AllPascalEventMaps = PascalMap<AllEventsMap>;
-
 declare type AllSignalFlags = SignalFlags | WrappedSignalFlags | SerializationSignalFlags;
 
 /**
@@ -375,7 +367,8 @@ export declare interface AsyncComputedReadonlySignal<T = unknown> extends Comput
     loading: boolean;
     /** The error that occurred while computing the signal. */
     error: Error | null;
-    resolve(): Promise<T>;
+    /** A promise that resolves when the value is computed. */
+    promise(): Promise<T>;
 }
 
 /** @public */
@@ -388,13 +381,14 @@ export declare type AsyncComputedReturnType<T> = T extends Promise<infer T> ? As
  *
  * # ================================
  */
-declare class AsyncComputedSignalImpl<T> extends ComputedSignalImpl<T, AsyncComputeQRL<T>> implements BackRef {
+declare class AsyncComputedSignalImpl<T> extends ComputedSignalImpl<T | undefined, AsyncComputeQRL<T>> implements BackRef {
     $untrackedLoading$: boolean;
     $untrackedError$: Error | null;
     $loadingEffects$: null | Set<EffectSubscription>;
     $errorEffects$: null | Set<EffectSubscription>;
     $destroy$: NoSerialize<() => void> | null;
-    private $promiseValue$;
+    $promiseValue$: T | typeof NEEDS_COMPUTATION;
+    private $promise$;
     [_EFFECT_BACK_REF]: Map<EffectProperty | string, EffectSubscription> | null;
     constructor(container: Container | null, fn: AsyncComputeQRL<T>, flags?: SignalFlags | SerializationSignalFlags);
     /**
@@ -409,8 +403,10 @@ declare class AsyncComputedSignalImpl<T> extends ComputedSignalImpl<T, AsyncComp
     set untrackedError(value: Error | null);
     get untrackedError(): Error | null;
     invalidate(): void;
-    resolve(): Promise<T>;
-    $computeIfNeeded$(): boolean | undefined;
+    promise(): Promise<T>;
+    $computeIfNeeded$(): Promise<void> | undefined;
+    private $promiseComputation$;
+    private setValue;
 }
 
 declare type AsyncComputeQRL<T> = QRLInternal<AsyncComputedFn<T>>;
@@ -1004,7 +1000,6 @@ export declare interface CSSProperties extends CSS_2.Properties<string | number>
     [v: `--${string}`]: string | number | undefined;
 }
 
-/** @public */
 declare interface DescriptorBase<T = unknown, B = unknown> extends BackRef {
     $flags$: number;
     $index$: number;
@@ -1171,11 +1166,10 @@ export declare const event$: <T>(qrl: T) => QRL_2<T>;
 
 declare type EventCorrectionMap = {
     auxclick: PointerEvent;
-    beforetoggle: CorrectedToggleEvent;
     click: PointerEvent;
     dblclick: PointerEvent;
     input: InputEvent;
-    toggle: CorrectedToggleEvent;
+    qvisible: QwikVisibleEvent;
 };
 
 declare type EventFromName<T extends string> = LcEvent<T>;
@@ -1576,6 +1570,14 @@ declare interface JsxDevOpts {
     columnNumber: number;
 }
 
+declare type JSXDocumentEvents = {
+    [K in keyof QwikDocumentEventMap as `document:on${PascalCaseName<K>}$`]: QwikDocumentEventMap[K];
+};
+
+declare type JSXElementEvents = {
+    [K in keyof QwikHTMLElementEventMap as `on${PascalCaseName<K>}$`]: QwikHTMLElementEventMap[K];
+};
+
 /**
  * A JSX Node, an internal structure. You probably want to use `JSXOutput` instead.
  *
@@ -1688,6 +1690,10 @@ export declare const _jsxSplit: <T extends string | FunctionComponent<any>>(type
 /** @public */
 export declare type JSXTagName = keyof HTMLElementTagNameMap | Omit<string, keyof HTMLElementTagNameMap>;
 
+declare type JSXWindowEvents = {
+    [K in keyof QwikWindowEventMap as `window:on${PascalCaseName<K>}$`]: QwikWindowEventMap[K];
+};
+
 /**
  * The names of events that Qwik knows about. They are all lowercase, but on the JSX side, they are
  * PascalCase for nicer DX. (`onAuxClick$` vs `onauxclick$`)
@@ -1788,6 +1794,12 @@ export declare type NativeUIEvent = UIEvent;
 /** @public @deprecated Use `WheelEvent` and use the second argument to the handler function for the current event target */
 export declare type NativeWheelEvent = WheelEvent;
 
+/**
+ * Special value used to mark that a given signal needs to be computed. This is essentially a
+ * "marked as dirty" flag.
+ */
+declare const NEEDS_COMPUTATION: any;
+
 declare interface NodePropData {
     $scopedStyleIdPrefix$: string | null;
     $isConst$: boolean;
@@ -1867,6 +1879,8 @@ export declare interface OnVisibleTaskOptions {
 /** @internal */
 declare const _OWNER: unique symbol;
 
+declare type PascalCaseName<T extends string> = T extends keyof LcEventNameMap ? LcEventNameMap[T] : Capitalize<T>;
+
 /**
  * Capitalized multi-word names of some known events so we have nicer qwik attributes. For example,
  * instead of `oncompositionEnd$` we can use `onCompositionEnd$`. Note that any capitalization
@@ -1874,15 +1888,7 @@ declare const _OWNER: unique symbol;
  *
  * Add any multi-word event names to this list. Single word events are automatically converted.
  */
-declare type PascalCaseNames = 'AnimationEnd' | 'AnimationIteration' | 'AnimationStart' | 'AuxClick' | 'BeforeToggle' | 'CanPlay' | 'CanPlayThrough' | 'CompositionEnd' | 'CompositionStart' | 'CompositionUpdate' | 'ContextMenu' | 'DblClick' | 'DragEnd' | 'DragEnter' | 'DragExit' | 'DragLeave' | 'DragOver' | 'DragStart' | 'DurationChange' | 'FocusIn' | 'FocusOut' | 'FullscreenChange' | 'FullscreenError' | 'GotPointerCapture' | 'KeyDown' | 'KeyPress' | 'KeyUp' | 'LoadedData' | 'LoadedMetadata' | 'LoadEnd' | 'LoadStart' | 'LostPointerCapture' | 'MouseDown' | 'MouseEnter' | 'MouseLeave' | 'MouseMove' | 'MouseOut' | 'MouseOver' | 'MouseUp' | 'PointerCancel' | 'PointerDown' | 'PointerEnter' | 'PointerLeave' | 'PointerMove' | 'PointerOut' | 'PointerOver' | 'PointerUp' | 'QIdle' | 'QInit' | 'QSymbol' | 'QVisible' | 'RateChange' | 'RateChange' | 'SecurityPolicyViolation' | 'SelectionChange' | 'SelectStart' | 'TimeUpdate' | 'TouchCancel' | 'TouchEnd' | 'TouchMove' | 'TouchStart' | 'TransitionCancel' | 'TransitionEnd' | 'TransitionRun' | 'TransitionStart' | 'VisibilityChange' | 'VolumeChange';
-
-/**
- * Convert an event map to PascalCase. For example, `HTMLElementEventMap` contains lowercase keys,
- * so this will capitalize them, and use the `LcEventNameMap` for multi-word events names.
- */
-declare type PascalMap<M> = {
-    [K in Extract<keyof M, string> as K extends keyof LcEventNameMap ? LcEventNameMap[K] : Capitalize<K>]: M[K];
-};
+declare type PascalCaseNames = 'AnimationEnd' | 'AnimationIteration' | 'AnimationStart' | 'AuxClick' | 'BeforeToggle' | 'CanPlay' | 'CanPlayThrough' | 'CompositionEnd' | 'CompositionStart' | 'CompositionUpdate' | 'ContextMenu' | 'DblClick' | 'DragEnd' | 'DragEnter' | 'DragExit' | 'DragLeave' | 'DragOver' | 'DragStart' | 'DurationChange' | 'FocusIn' | 'FocusOut' | 'FullscreenChange' | 'FullscreenError' | 'GotPointerCapture' | 'KeyDown' | 'KeyPress' | 'KeyUp' | 'LoadedData' | 'LoadedMetadata' | 'LoadEnd' | 'LoadStart' | 'LostPointerCapture' | 'MouseDown' | 'MouseEnter' | 'MouseLeave' | 'MouseMove' | 'MouseOut' | 'MouseOver' | 'MouseUp' | 'PointerCancel' | 'PointerDown' | 'PointerEnter' | 'PointerLeave' | 'PointerMove' | 'PointerOut' | 'PointerOver' | 'PointerUp' | 'QIdle' | 'QInit' | 'QResume' | 'QSymbol' | 'QVisible' | 'QViewTransition' | 'RateChange' | 'RateChange' | 'SecurityPolicyViolation' | 'SelectionChange' | 'SelectStart' | 'TimeUpdate' | 'TouchCancel' | 'TouchEnd' | 'TouchMove' | 'TouchStart' | 'TransitionCancel' | 'TransitionEnd' | 'TransitionRun' | 'TransitionStart' | 'VisibilityChange' | 'VolumeChange';
 
 declare type PopoverTargetAction = 'hide' | 'show' | 'toggle';
 
@@ -2025,7 +2031,7 @@ export declare interface _QDocument extends Document {
 }
 
 declare interface QElement extends Element {
-    qDispatchEvent?: (event: Event, scope: QwikLoaderEventScope) => boolean;
+    qDispatchEvent?: (event: Event, scope: QwikLoaderEventScope) => ValueOrPromise<unknown>;
     vNode?: _VNode;
 }
 
@@ -2161,7 +2167,7 @@ export declare type QRL<TYPE = unknown> = {
     getCaptured(): unknown[] | null;
     getSymbol(): string;
     getHash(): string;
-    dev: QRLDev | null;
+    dev?: QRLDev | null;
 } & BivariantQrlFn<QrlArgs<TYPE>, QrlReturn<TYPE>>;
 
 /**
@@ -2195,7 +2201,7 @@ export declare const qrlDEV: <T = any>(chunkOrFn: string | (() => Promise<any>),
  *
  * @public
  */
-export declare type QRLEventHandlerMulti<EV extends Event, EL> = QRL<EventHandler<EV, EL>> | undefined | null | QRLEventHandlerMulti<EV, EL>[] | EventHandler<EV, EL>;
+export declare type QRLEventHandlerMulti<EV extends Event, EL> = QRL<EventHandler<EV, EL>> | undefined | null | QRLEventHandlerMulti<EV, EL>[];
 
 declare type QRLInternal<TYPE = unknown> = QRL<TYPE> & QRLInternalMethods<TYPE>;
 
@@ -2282,13 +2288,19 @@ export declare type QwikClipboardEvent<T = Element> = NativeClipboardEvent;
 /** @public @deprecated Use `CompositionEvent` and use the second argument to the handler function for the current event target */
 export declare type QwikCompositionEvent<T = Element> = NativeCompositionEvent;
 
-declare type QwikCustomEvents<EL> = {};
-
 declare type QwikCustomEventsPlain<EL> = {
     /** The handler */
     [key: `${'document:' | 'window:' | ''}on${string}$`]: QRLEventHandlerMulti<Event, EL> | EventHandler<Event, EL>;
 };
 
+declare type QwikDocumentEventMap = Omit<DocumentEventMap, keyof QwikHTMLElementEventMap> & Omit<QwikHTMLElementEventMap, 'qvisible' | 'focus' | 'blur'> & {
+    qidle: QwikIdleEvent;
+    qinit: QwikInitEvent;
+    qsymbol: QwikSymbolEvent;
+    qresume: QwikResumeEvent;
+    qviewtransition: QwikViewTransitionEvent;
+};
+
 /** @public */
 export declare interface QwikDOMAttributes extends DOMAttributes<Element> {
 }
@@ -2297,11 +2309,13 @@ export declare interface QwikDOMAttributes extends DOMAttributes<Element> {
 export declare type QwikDragEvent<T = Element> = NativeDragEvent;
 
 /** @public */
-declare type QwikEvents<EL, Plain extends boolean = true> = Plain extends true ? QwikKnownEventsPlain<EL> & QwikCustomEventsPlain<EL> : QwikKnownEvents<EL> & QwikCustomEvents<EL>;
+declare type QwikEvents<EL, Plain extends boolean = true> = Plain extends true ? QwikKnownEventsPlain<EL> & QwikCustomEventsPlain<EL> : QwikKnownEvents<EL>;
 
 /** @public @deprecated Use `FocusEvent` and use the second argument to the handler function for the current event target */
 export declare type QwikFocusEvent<T = Element> = NativeFocusEvent;
 
+declare type QwikHTMLElementEventMap = Omit<HTMLElementEventMap, keyof EventCorrectionMap> & EventCorrectionMap;
+
 /**
  * The DOM props without plain handlers, for use inside functions
  *
@@ -2372,15 +2386,17 @@ declare namespace QwikJSX {
 export { QwikJSX as JSX }
 export { QwikJSX }
 
+declare type QwikJSXEvents = JSXElementEvents & JSXDocumentEvents & JSXWindowEvents;
+
 /** @public @deprecated Use `KeyboardEvent` and use the second argument to the handler function for the current event target */
 export declare type QwikKeyboardEvent<T = Element> = NativeKeyboardEvent;
 
 declare type QwikKnownEvents<EL> = {
-    [K in keyof AllPascalEventMaps as `${'document:' | 'window:' | ''}on${K}$`]?: QRLEventHandlerMulti<AllPascalEventMaps[K], EL>;
+    [K in keyof QwikJSXEvents]?: QRLEventHandlerMulti<QwikJSXEvents[K], EL>;
 };
 
 declare type QwikKnownEventsPlain<EL> = {
-    [K in keyof AllPascalEventMaps as `${'document:' | 'window:' | ''}on${K}$`]?: QRLEventHandlerMulti<AllPascalEventMaps[K], EL> | EventHandler<AllPascalEventMaps[K], EL>;
+    [K in keyof QwikJSXEvents]?: QRLEventHandlerMulti<QwikJSXEvents[K], EL> | EventHandler<QwikJSXEvents[K], EL>;
 };
 
 declare type QwikLoaderEventScope = '-document' | '-window' | '';
@@ -2446,6 +2462,12 @@ export declare type QwikMouseEvent<T = Element, E = NativeMouseEvent> = E;
 /** @public @deprecated Use `PointerEvent` and use the second argument to the handler function for the current event target */
 export declare type QwikPointerEvent<T = Element> = NativePointerEvent;
 
+/**
+ * Emitted by qwik-core on the container element when it resumes from a paused state. You cannot put
+ * a Qwik event handler on the container so you must listen on the document instead. @public
+ */
+export declare type QwikResumeEvent = CustomEvent<{}>;
+
 /** @public @deprecated Use `SubmitEvent` and use the second argument to the handler function for the current event target */
 export declare type QwikSubmitEvent<T = Element> = SubmitEvent;
 
@@ -2476,7 +2498,7 @@ declare interface QwikSymbol {
     captureNames?: string[];
 }
 
-/** Emitted by qwik-loader when a module was lazily loaded @public */
+/** Emitted by qwik-loader on document when a module was lazily loaded @public */
 export declare type QwikSymbolEvent = CustomEvent<{
     symbol: string;
     element: Element;
@@ -2497,14 +2519,19 @@ export declare type QwikTransitionEvent<T = Element> = NativeTransitionEvent;
 export declare type QwikUIEvent<T = Element> = NativeUIEvent;
 
 /** Emitted by qwik-core on document when the a view transition start @public */
-declare type QwikViewTransitionEvent = CustomEvent<ViewTransition>;
+export declare type QwikViewTransitionEvent = CustomEvent<ViewTransition>;
 
-/** Emitted by qwik-loader when an element becomes visible. Used by `useVisibleTask$` @public */
+/**
+ * Handled by qwik-loader when an element becomes visible. Used by `useVisibleTask$`. Does not
+ * bubble. @public
+ */
 export declare type QwikVisibleEvent = CustomEvent<IntersectionObserverEntry>;
 
 /** @public @deprecated Use `WheelEvent` and use the second argument to the handler function for the current event target */
 export declare type QwikWheelEvent<T = Element> = NativeWheelEvent;
 
+declare type QwikWindowEventMap = Omit<WindowEventHandlersEventMap, keyof QwikDocumentEventMap> & QwikDocumentEventMap;
+
 /** @public */
 export declare interface ReadonlySignal<T = unknown> {
     readonly value: T;
@@ -3652,18 +3679,11 @@ declare type SymbolToChunkResolver = (symbol: string) => string;
 export declare const sync$: <T extends Function>(fn: T) => SyncQRL<T>;
 
 /** @public */
-export declare interface SyncQRL<TYPE extends Function = any> extends QRL<TYPE> {
+export declare type SyncQRL<TYPE extends Function> = QRL<TYPE> & {
     __brand__SyncQRL__: TYPE;
-    /**
-     * Resolve the QRL of closure and invoke it.
-     *
-     * @param args - Closure arguments.
-     * @returns A return value of the closure.
-     */
-    (...args: TYPE extends (...args: infer ARGS) => any ? ARGS : never): TYPE extends (...args: any[]) => infer RETURN ? RETURN : never;
     resolved: TYPE;
-    dev: QRLDev | null;
-}
+    dev?: QRLDev | null;
+} & BivariantQrlFn<QrlArgs<TYPE>, QrlReturn<TYPE>>;
 
 declare type TableCellSpecialAttrs = {
     align?: 'left' | 'center' | 'right' | 'justify' | 'char' | undefined;
@@ -3700,6 +3720,12 @@ declare const TaskEvent = "qTask";
 /** @public */
 export declare type TaskFn = (ctx: TaskCtx) => ValueOrPromise<void | (() => void)>;
 
+/** @public */
+export declare interface TaskOptions {
+    /** Block the rendering of the component until the task completes. Default is `true` */
+    deferUpdates?: boolean;
+}
+
 /** @internal */
 export declare class _TextVNode extends _VNode {
     textNode: Text | null;
@@ -4373,10 +4399,10 @@ export declare const useStylesScopedQrl: (styles: QRL<string>) => UseStylesScope
  * @public
  * @see `Tracker`
  */
-export declare const useTask$: (fn: TaskFn) => void;
+export declare const useTask$: (fn: TaskFn, opts?: TaskOptions) => void;
 
 /** @internal */
-export declare const useTaskQrl: (qrl: QRL<TaskFn>) => void;
+export declare const useTaskQrl: (qrl: QRL<TaskFn>, opts?: TaskOptions) => void;
 
 /**
  * ```tsx
@@ -4427,7 +4453,7 @@ export declare const _VAR_PROPS: unique symbol;
 export declare const _verifySerializable: <T>(value: T, preMessage?: string) => T;
 
 /**
- * 2.0.0-beta.13-dev+cb19ff7
+ * 2.0.0-beta.14-dev+1e7496d
  *
  * @public
  */