@stencil/core 5.0.0-alpha.9 → 5.0.0-beta.1

package/dist/runtime/server/index.d.mts

@@ -1,4 +1,6 @@
 import { BUILD, Env, NAMESPACE } from "@stencil/core/app-data";
+import "rolldown";
+import "typescript";
 //#region src/declarations/stencil-public-runtime.d.ts
 interface UserBuildConditionals {
   isDev: boolean;
@@ -9,6 +11,17 @@ interface UserBuildConditionals {
 type ResolutionHandler = (elm: HTMLElement) => string | undefined | null;
 type ErrorHandler = (err: any, element?: HTMLElement) => void;
 type TagTransformer = (tag: string) => string;
+/**
+ * A map of `@Prop`/`@State` property names to their new and previous
+ * values, passed to `componentShouldUpdate` once per render cycle.
+ *
+ * Pass `this` as `T` to type `changes` against your component's own
+ * members, e.g. `componentShouldUpdate(changes: ComponentShouldUpdateChanges<this>)`.
+ */
+type ComponentShouldUpdateChanges<T = any> = { [K in Extract<keyof T, string>]?: {
+  newVal: T[K];
+  oldVal: T[K];
+}; };
 interface ComponentInterface {
   connectedCallback?(): void;
   disconnectedCallback?(): void;
@@ -34,14 +47,18 @@ interface ComponentInterface {
    */
   componentDidLoad?(): void;
   /**
-   * A `@Prop` or `@State` property changed and a rerender is about to be requested.
+   * One or more `@Prop` or `@State` properties changed and a rerender is
+   * about to be requested. `changes` contains every property that changed
+   * since the last render, keyed by property name.
    *
-   * Called multiple times throughout the life of
-   * the component as its properties change.
+   * Called once per render cycle, batching all properties that changed
+   * synchronously since the last render.
+   *
+   * Return `false` to prevent the pending render.
    *
    * componentShouldUpdate is not called on the first render.
    */
-  componentShouldUpdate?(newVal: any, oldVal: any, propName: string): boolean | void;
+  componentShouldUpdate?(changes: ComponentShouldUpdateChanges<this>): boolean | void;
   /**
    * The component is about to update and re-render.
    *
@@ -476,6 +493,15 @@ interface HostElement extends HTMLElement {
    * must be resolved for the top, ancestor component to be fully hydrated
    */
   ['s-p']?: Promise<void>[];
+  /**
+   * Pending Connects:
+   * A list of {@link HostRef.$onFirstConnectPromise$} promises for descendants that
+   * were already registered with this component (their nearest Stencil ancestor) by
+   * the time this component's own initial `componentWillLoad` was scheduled. Awaited
+   * so this component's `componentWillLoad` can't fire before those descendants'
+   * real `connectedCallback`s have.
+   */
+  ['s-pc']?: Promise<void>[];
   componentOnReady?: () => Promise<this>;
 }
 interface SsrResults {
@@ -567,6 +593,11 @@ interface RenderNode extends HostElement {
    * Slot name of either the slot itself or the slotted node
    */
   ['s-sn']?: string;
+  /**
+   * `slot` attribute of a `<slot>` reference rendered as a text node (no fallback content),
+   * since text nodes can't carry real DOM attributes.
+   */
+  ['s-sa']?: string;
   /**
    * Host element tag name:
    * The tag name of the host element that this
@@ -619,7 +650,7 @@ interface RenderNode extends HostElement {
    * Used to know the components encapsulation.
    * empty "" for shadow, "c" from scoped
    */
-  ['s-en']?: '' | /*shadow*/'c';
+  ['s-en']?: '' | /*shadow*/ 'c';
   /**
    * On a `scoped: true` component
    * with `lightDomPatches` flag enabled,
@@ -744,10 +775,26 @@ interface PatchedSlotNode extends Node {
   __previousElementSibling?: RenderNode;
 }
 type LazyBundlesRuntimeData = LazyBundleRuntimeData[];
-type LazyBundleRuntimeData = [/** bundleIds */string, ComponentRuntimeMetaCompact[]];
-type ComponentRuntimeMetaCompact = [/** flags */number, /** tagname */string, /** members */{
+type LazyBundleRuntimeData = [
+/** bundleIds */
+string, ComponentRuntimeMetaCompact[]];
+type ComponentRuntimeMetaCompact = [
+/** flags */
+number,
+/** tagname */
+string,
+/** members */
+{
   [memberName: string]: ComponentRuntimeMember;
-}?, /** listeners */ComponentRuntimeHostListener[]?, /** watchers */ComponentConstructorChangeHandlers?, /** serializers */ComponentConstructorChangeHandlers?, /** deserializers */ComponentConstructorChangeHandlers?];
+}?,
+/** listeners */
+ComponentRuntimeHostListener[]?,
+/** watchers */
+ComponentConstructorChangeHandlers?,
+/** serializers */
+ComponentConstructorChangeHandlers?,
+/** deserializers */
+ComponentConstructorChangeHandlers?];
 /**
  * Runtime metadata for a Stencil component
  */
@@ -850,6 +897,11 @@ interface HostRef {
   $cmpMeta$: ComponentRuntimeMeta;
   $hostElement$: HostElement;
   $instanceValues$?: Map<string, any>;
+  /**
+   * Prop/state changes accumulated since the last render, flushed to
+   * `componentShouldUpdate` once per render cycle.
+   */
+  $queuedPropChanges$?: ComponentShouldUpdateChanges;
   $signalValues$?: Map<string, import('@preact/signals-core').Signal<any>>;
   /** Dispose function that tears down all signal effects for this component. */
   $signalCleanup$?: () => void;
@@ -885,6 +937,21 @@ interface HostRef {
    * It is called after {@link HostRef.$onInstancePromise$} resolves.
    */
   $onRenderResolve$?: () => void;
+  /**
+   * A promise that resolves once this component's real `connectedCallback` has fired
+   * for the first time. Created lazily - either by a descendant that needs to wait for
+   * this component's connection before firing its own real `connectedCallback`
+   * ({@link HOST_FLAGS.hasFiredConnected}), or by this component registering itself
+   * with its nearest Stencil ancestor's `s-pc` list. This is what lets a component's
+   * real `connectedCallback` (and, transitively, a pending ancestor's initial
+   * `componentWillLoad`) stay ordered correctly regardless of which of an
+   * ancestor/descendant pair's lazy module happens to resolve first.
+   */
+  $onFirstConnectPromise$?: Promise<void>;
+  /**
+   * A callback which resolves {@link HostRef.$onFirstConnectPromise$}
+   */
+  $onFirstConnectResolve$?: () => void;
   $vnode$?: VNode;
   $queuedListeners$?: [string, any][];
   $rmListeners$?: (() => void)[];
@@ -894,6 +961,11 @@ interface HostRef {
    * Defer connectedCallback until after first render for components with slot relocation.
    */
   $deferredConnectedCallback$?: boolean;
+  /**
+   * The number of times this host's lazy component load has failed and been retried.
+   * Used to give up retrying after {@link MAX_LAZY_LOAD_RETRIES} failed attempts.
+   */
+  $loadRetryCount$?: number;
 }
 interface PlatformRuntime {
   /**
@@ -997,6 +1069,32 @@ declare const Fragment: FunctionalComponent;
 //#region src/runtime/host-listener.d.ts
 declare const addHostEventListeners: (elm: HostElement, hostRef: HostRef, listeners?: ComponentRuntimeHostListener[]) => void;
 //#endregion
+//#region src/runtime/inject-side-effect-style.d.ts
+/**
+ * Registers a root (a shadow root, or `document`) to receive every side-effect CSS import
+ * (a plain, non-component `import './foo.css'`), now and in future. Call in `connectedCallback`,
+ * paired with `unregisterSideEffectStyleTarget` in `disconnectedCallback` so the registry doesn't
+ * hold disconnected roots forever.
+ * @param root the root to register
+ */
+declare function registerSideEffectStyleTarget(root: DocumentOrShadowRoot): void;
+/**
+ * Removes a root registered via `registerSideEffectStyleTarget` - call in `disconnectedCallback`.
+ * @param root the root to unregister
+ */
+declare function unregisterSideEffectStyleTarget(root: DocumentOrShadowRoot): void;
+/**
+ * Applies plain (non-component) CSS text to every registered root - respects shadow DOM
+ * encapsulation instead of always reaching for the top-level document. Not meant to be called
+ * directly: this is what the compiler's CSS-to-ESM output calls for CSS with no Stencil `tag`
+ * (i.e. not a component's own `styleUrl`), typically a third-party dependency's CSS import.
+ *
+ * `@font-face` rules are pulled out and adopted onto top-level `document` not per-root
+ * (Chromium (https://issues.chromium.org/issues/41085401) per-root never loads).
+ * @param cssText the CSS text to apply
+ */
+declare function injectSideEffectStyle(cssText: string): void;
+//#endregion
 //#region src/runtime/mixin.d.ts
 type Ctor<T = {}> = new (...args: any[]) => T;
 declare function Mixin(...mixins: ((base: Ctor) => Ctor)[]): Ctor<{}>;
@@ -1176,4 +1274,4 @@ declare const setAssetPath: (path: string) => string;
 declare const setScopedSsr: (opts: SsrFactoryOptions) => void;
 declare const needsScopedSSR: () => boolean;
 //#endregion
-export { BUILD, Build, Env, Fragment, Host, Mixin, NAMESPACE, addHostEventListeners, bootstrapLazy, cmpModules, connectedCallback, consoleDevError, consoleDevInfo, consoleDevWarn, consoleError, createEvent, defineCustomElement, disconnectedCallback, forceModeUpdate, forceUpdate, getAssetPath, getElement, getHostRef, getMode, getRenderingRef, getShadowRoot, getValue, hAsync as h, insertVdomAnnotations, isMemberInElement, jsx, jsxs, loadModule, modeResolutionChain, needsScopedSSR, nextTick, parsePropertyValue, plt, postUpdateComponent, proxyComponent, proxyCustomElement, readTask, registerComponents, registerHost, registerInstance, renderVdom, setAssetPath, setErrorHandler, setMode, setNonce, setPlatformHelpers, setScopedSsr, setTagTransformer, setValue, ssrApp, styles, supportsConstructableStylesheets, supportsListenerOptions, supportsMutableAdoptedStyleSheets, transformTag, win, writeTask };
+export { BUILD, Build, Env, Fragment, Host, Mixin, NAMESPACE, addHostEventListeners, bootstrapLazy, cmpModules, connectedCallback, consoleDevError, consoleDevInfo, consoleDevWarn, consoleError, createEvent, defineCustomElement, disconnectedCallback, forceModeUpdate, forceUpdate, getAssetPath, getElement, getHostRef, getMode, getRenderingRef, getShadowRoot, getValue, hAsync as h, injectSideEffectStyle, insertVdomAnnotations, isMemberInElement, jsx, jsxs, loadModule, modeResolutionChain, needsScopedSSR, nextTick, parsePropertyValue, plt, postUpdateComponent, proxyComponent, proxyCustomElement, readTask, registerComponents, registerHost, registerInstance, registerSideEffectStyleTarget, renderVdom, setAssetPath, setErrorHandler, setMode, setNonce, setPlatformHelpers, setScopedSsr, setTagTransformer, setValue, ssrApp, styles, supportsConstructableStylesheets, supportsListenerOptions, supportsMutableAdoptedStyleSheets, transformTag, unregisterSideEffectStyleTarget, win, writeTask };