@qwik.dev/core 2.0.0-beta.3 → 2.0.0-beta.31

package/dist/server.d.ts

@@ -1,18 +1,12 @@
 /// <reference path="./server-modules.d.ts" />
 
 import type { QwikManifest } from './optimizer';
-import type { ResolvedManifest } from './optimizer';
+import { ResolvedManifest } from './optimizer';
 import type { ServerQwikManifest } from './optimizer';
 import type { SnapshotResult } from '.';
-import type { StreamWriter } from '.';
+import type { StreamWriter } from './internal';
 import type { SymbolMapperFn } from './optimizer';
 
-/** @public */
-declare interface ComponentEntryStrategy {
-    type: 'component';
-    manual?: Record<string, string>;
-}
-
 /** @public */
 declare interface DevJSX {
     fileName: string;
@@ -21,9 +15,6 @@ declare interface DevJSX {
     stack?: string;
 }
 
-/** @public */
-declare type EntryStrategy = InlineEntryStrategy | HoistEntryStrategy | SingleEntryStrategy | HookEntryStrategy | SegmentEntryStrategy | ComponentEntryStrategy | SmartEntryStrategy;
-
 /**
  * Any function taking a props object that returns JSXOutput.
  *
@@ -35,6 +26,15 @@ declare type FunctionComponent<P = unknown> = {
     renderFn(props: P, key: string | null, flags: number, dev?: DevJSX): JSXOutput;
 }['renderFn'];
 
+/**
+ * Provides the `backpatch-executor.js` executor script as a string.
+ *
+ * @public
+ */
+export declare function getQwikBackpatchExecutorScript(opts?: {
+    debug?: boolean;
+}): string;
+
 /**
  * Provides the `qwikloader.js` file as a string. Useful for tooling to inline the qwikloader script
  * into HTML.
@@ -55,31 +55,6 @@ export declare function getQwikPrefetchWorkerScript(opts?: {
     debug?: boolean;
 }): string;
 
-/** @public */
-declare interface GlobalInjections {
-    tag: string;
-    attributes?: {
-        [key: string]: string;
-    };
-    location: 'head' | 'body';
-}
-
-/** @public */
-declare interface HoistEntryStrategy {
-    type: 'hoist';
-}
-
-/** @deprecated Use SegmentStrategy instead */
-declare interface HookEntryStrategy {
-    type: 'hook';
-    manual?: Record<string, string>;
-}
-
-/** @public */
-declare interface InlineEntryStrategy {
-    type: 'inline';
-}
-
 /** @public */
 export declare interface InOrderAuto {
     strategy: 'auto';
@@ -166,6 +141,8 @@ export declare interface PreloaderOptions {
      * The minimum probability for a bundle to be added as a preload link during SSR.
      *
      * Defaults to `0.7` (70% probability)
+     *
+     * This makes sure that the most likely bundles are preloaded ahead of time.
      */
     ssrPreloadProbability?: number;
     /**
@@ -187,140 +164,23 @@ export declare interface PreloaderOptions {
      */
     maxIdlePreloads?: number;
     /**
-     * The minimum probability for a bundle to be added to the preload queue.
+     * @deprecated The minimum probability for a bundle to be added to the preload queue.
+     *
+     *   Defaulted to `0.35` (35% probability).
      *
-     * Defaults to `0.35` (35% probability)
+     *   Deprecated because this could cause performance issues with bundles fetched on on click instead
+     *   of being preloaded ahead of time.
      */
     preloadProbability?: number;
 }
 
 /** @public */
-declare interface QwikAsset {
-    /** Name of the asset */
-    name: string | undefined;
-    /** Size of the asset */
-    size: number;
-}
-
-/** @public */
-declare interface QwikBundle {
-    /** Size of the bundle */
-    size: number;
-    /** Total size of this bundle's static import graph */
-    total: number;
-    /** Interactivity score of the bundle */
-    interactivity?: number;
-    /** Symbols in the bundle */
-    symbols?: string[];
-    /** Direct imports */
-    imports?: string[];
-    /** Dynamic imports */
-    dynamicImports?: string[];
-    /** Source files of the bundle */
-    origins?: string[];
-}
-
-/**
- * Bundle graph.
- *
- * Format: [ 'bundle-a.js', 3, 5 // Depends on 'bundle-b.js' and 'bundle-c.js' 'bundle-b.js', 5, //
- * Depends on 'bundle-c.js' 'bundle-c.js', ]
- *
- * @public
- */
-declare type QwikBundleGraph = Array<string | number>;
-
-/** @public */
-export declare interface QwikLoaderOptions {
-    /**
-     * Whether to include the qwikloader script in the document. Normally you don't need to worry
-     * about this, but in case of multi-container apps using different Qwik versions, you might want
-     * to only enable it on one of the containers.
-     *
-     * Defaults to `'auto'`.
-     */
+export declare type QwikLoaderOptions = 'module' | 'inline' | 'never' | {
+    /** @deprecated No longer used. */
     include?: 'always' | 'never' | 'auto';
-    /** @deprecated No longer used, the qwikloader is always loaded as soon as possible */
+    /** @deprecated No longer used. */
     position?: 'top' | 'bottom';
-}
-
-/**
- * The metadata of the build. One of its uses is storing where QRL symbols are located.
- *
- * @public
- */
-declare interface QwikManifest_2 {
-    /** Content hash of the manifest, if this changes, the code changed */
-    manifestHash: string;
-    /** QRL symbols */
-    symbols: {
-        [symbolName: string]: QwikSymbol;
-    };
-    /** Where QRLs are located. The key is the symbol name, the value is the bundle fileName */
-    mapping: {
-        [symbolName: string]: string;
-    };
-    /**
-     * All code bundles, used to know the import graph. The key is the bundle fileName relative to
-     * "build/"
-     */
-    bundles: {
-        [fileName: string]: QwikBundle;
-    };
-    /** All assets. The key is the fileName relative to the rootDir */
-    assets?: {
-        [fileName: string]: QwikAsset;
-    };
-    /** All bundles in a compact graph format with probabilities */
-    bundleGraph?: QwikBundleGraph;
-    /** The bundle graph fileName */
-    bundleGraphAsset?: string;
-    /** The preloader bundle fileName */
-    preloader?: string;
-    /** The Qwik core bundle fileName */
-    core?: string;
-    /** The Qwik loader bundle fileName */
-    qwikLoader?: string;
-    /** CSS etc to inject in the document head */
-    injections?: GlobalInjections[];
-    /** The version of the manifest */
-    version: string;
-    /** The options used to build the manifest */
-    options?: {
-        target?: string;
-        buildMode?: string;
-        entryStrategy?: {
-            type: EntryStrategy['type'];
-        };
-    };
-    /** The platform used to build the manifest */
-    platform?: {
-        [name: string]: string;
-    };
-}
-
-/** @public */
-declare interface QwikSymbol {
-    origin: string;
-    displayName: string;
-    hash: string;
-    canonicalFilename: string;
-    ctxKind: 'function' | 'eventHandler';
-    ctxName: string;
-    /** Whether the symbol captures a variable */
-    captures: boolean;
-    parent: string | null;
-    loc: [number, number];
-    /** The parameter names if it's a function with parameters */
-    paramNames?: string[];
-    /** The transformed names of scoped variables, if any */
-    captureNames?: string[];
-}
-
-/** @public */
-declare interface ReadonlySignal<T = unknown> {
-    readonly value: T;
-}
+};
 
 /** @public */
 export declare type Render = RenderToString | RenderToStream;
@@ -337,11 +197,25 @@ export declare interface RenderOptions extends SerializeDocumentOptions {
     /** Language to use when rendering the document. */
     locale?: string | ((options: RenderOptions) => string);
     /**
-     * Specifies if the Qwik Loader script is added to the document or not.
+     * Specifies how the Qwik Loader is included in the document. This enables interactivity and lazy
+     * loading.
+     *
+     * `module`: Use a `<script>` tag to load the Qwik Loader. Subsequent page loads will have the
+     * script cached and instantly running.
+     *
+     * `inline`: This embeds the Qwik Loader script directly in the document. This adds about 3kB
+     * before compression, which typically is reduced to about 1.6kB with gzip.
      *
-     * Defaults to `{ include: true }`.
+     * `never`: Do not include the Qwik Loader script. This is mostly useful when embedding multiple
+     * containers on the same page.
+     *
+     * Defaults to `module`.
+     *
+     * Note that the Qwik Loader is absolutely required for Qwik to work. There must be an instance of
+     * it loaded for any interactivity to happen.
      */
     qwikLoader?: QwikLoaderOptions;
+    /** Specifies how preloading is handled. This ensures that code is instantly available when needed. */
     preloader?: PreloaderOptions | false;
     /** @deprecated Use `preloader` instead */
     prefetchStrategy?: PrefetchStrategy | null;
@@ -351,12 +225,14 @@ export declare interface RenderOptions extends SerializeDocumentOptions {
      */
     containerTagName?: string;
     containerAttributes?: Record<string, string>;
+    /** Metadata that can be retrieved during SSR with `useServerData()`. */
     serverData?: Record<string, any>;
 }
 
 /** @public */
 export declare interface RenderResult {
-    snapshotResult: SnapshotResult | undefined;
+    /** @deprecated Not longer used in v2 */
+    snapshotResult?: SnapshotResult | undefined;
     isStatic: boolean;
     manifest?: ServerQwikManifest;
 }
@@ -414,26 +290,12 @@ export declare interface RenderToStringResult extends RenderResult {
     };
 }
 
-/** @public */
-declare interface ResolvedManifest_2 {
-    mapper: SymbolMapper;
-    manifest: ServerQwikManifest_2;
-    injections?: GlobalInjections[];
-    bundleGraph?: QwikBundleGraph;
-}
-
 /**
  * Merges a given manifest with the built manifest and provides mappings for symbols.
  *
  * @public
  */
-export declare function resolveManifest(manifest?: Partial<QwikManifest | ResolvedManifest_2> | undefined): ResolvedManifest_2 | undefined;
-
-/** @public */
-declare interface SegmentEntryStrategy {
-    type: 'segment';
-    manual?: Record<string, string>;
-}
+export declare function resolveManifest(manifest?: Partial<QwikManifest | ResolvedManifest> | undefined): ResolvedManifest | undefined;
 
 /** @public */
 export declare interface SerializeDocumentOptions {
@@ -442,13 +304,6 @@ export declare interface SerializeDocumentOptions {
     debug?: boolean;
 }
 
-/**
- * The manifest values that are needed for SSR.
- *
- * @public
- */
-declare type ServerQwikManifest_2 = Pick<QwikManifest_2, 'manifestHash' | 'injections' | 'bundleGraph' | 'bundleGraphAsset' | 'mapping' | 'preloader' | 'core' | 'qwikLoader'>;
-
 /** @public */
 export declare function setServerPlatform(manifest?: Partial<QwikManifest | ResolvedManifest>): Promise<void>;
 
@@ -464,20 +319,16 @@ export declare function setServerPlatform(manifest?: Partial<QwikManifest | Reso
  *
  * @public
  */
-declare interface Signal<T = any> extends ReadonlySignal<T> {
+declare interface Signal<T = any> {
+    /** Reading from this subscribes to updates; writing to this triggers updates. */
     value: T;
-}
-
-/** @public */
-declare interface SingleEntryStrategy {
-    type: 'single';
-    manual?: Record<string, string>;
-}
-
-/** @public */
-declare interface SmartEntryStrategy {
-    type: 'smart';
-    manual?: Record<string, string>;
+    /** Reading from this does not subscribe to updates; writing to this does not trigger updates. */
+    untrackedValue: T;
+    /**
+     * Use this to trigger running subscribers, for example when the value mutated but remained the
+     * same object.
+     */
+    trigger(): void;
 }
 
 /** @public */
@@ -485,9 +336,6 @@ export declare interface StreamingOptions {
     inOrder?: InOrderStreaming;
 }
 
-/** @public */
-declare type SymbolMapper = Record<string, readonly [symbol: string, chunk: string]>;
-
 /**
  * Auto: Prefetch all possible QRLs used by the document. Default
  *