@qwik.dev/core 2.0.0-beta.4 → 2.0.0-beta.40

package/dist/optimizer.d.ts

@@ -1,4 +1,10 @@
+import { EntryStrategy } from '@qwik.dev/optimizer';
+import { Optimizer } from '@qwik.dev/optimizer';
+import { OptimizerOptions } from '@qwik.dev/optimizer';
 import type { Plugin as Plugin_2 } from 'vite';
+import { SegmentAnalysis } from '@qwik.dev/optimizer';
+import { TransformModule } from '@qwik.dev/optimizer';
+import { TransformModuleInput } from '@qwik.dev/optimizer';
 
 /**
  * A function that returns a map of bundle names to their dependencies.
@@ -10,37 +16,6 @@ export declare type BundleGraphAdder = (manifest: QwikManifest) => Record<string
     dynamicImports?: string[];
 }>;
 
-/** @public */
-export declare interface ComponentEntryStrategy {
-    type: 'component';
-    manual?: Record<string, string>;
-}
-
-/** @public */
-export declare const createOptimizer: (optimizerOptions?: OptimizerOptions) => Promise<Optimizer>;
-
-declare function createSymbolMapper(base: string): SymbolMapperFn;
-
-/** @public */
-export declare interface Diagnostic {
-    scope: string;
-    category: DiagnosticCategory;
-    code: string | null;
-    file: string;
-    message: string;
-    highlights: SourceLocation[] | null;
-    suggestions: string[] | null;
-}
-
-/** @public */
-export declare type DiagnosticCategory = 'error' | 'warning' | 'sourceError';
-
-/** @public */
-declare type EmitMode = 'dev' | 'prod' | 'lib';
-
-/** @public */
-export declare type EntryStrategy = InlineEntryStrategy | HoistEntryStrategy | SingleEntryStrategy | HookEntryStrategy_2 | SegmentEntryStrategy | ComponentEntryStrategy | SmartEntryStrategy;
-
 /**
  * Use `__EXPERIMENTAL__.x` to check if feature `x` is enabled. It will be replaced with `true` or
  * `false` via an exact string replacement.
@@ -50,18 +25,20 @@ export declare type EntryStrategy = InlineEntryStrategy | HoistEntryStrategy | S
  * @public
  */
 export declare enum ExperimentalFeatures {
-    /** Enable the usePreventNavigate hook */
-    preventNavigate = "preventNavigate",
+    /** Enable the Each keyed-list primitive */
+    each = "each",
+    /** Enable the Show conditional primitive */
+    show = "show",
+    /** Enable the Suspense fallback primitive */
+    suspense = "suspense",
     /** Enable the Valibot form validation */
     valibot = "valibot",
     /** Disable SPA navigation handler in Qwik Router */
     noSPA = "noSPA",
-    /** Enable request.rewrite() */
-    enableRequestRewrite = "enableRequestRewrite",
-    /** Enable worker$ */
-    webWorker = "webWorker",
-    /** Enable the ability to use the Qwik Insights vite plugin and <Insights/> component */
-    insights = "insights"
+    /** Enable the ability to use the Qwik Insights vite plugin and `<Insights/>` component */
+    insights = "insights",
+    /** Enable the `blockSSR: false` route loader option */
+    blockSSR = "blockSSR"
 }
 
 /** @public */
@@ -73,59 +50,11 @@ export declare interface GlobalInjections {
     location: 'head' | 'body';
 }
 
-/** @public */
-declare interface HoistEntryStrategy {
-    type: 'hoist';
-}
-
-/** @deprecated Use SegmentStrategy instead */
-declare interface HookEntryStrategy_2 {
-    type: 'hook';
-    manual?: Record<string, string>;
-}
-
-/** @public */
-export declare interface InlineEntryStrategy {
-    type: 'inline';
-}
-
-/** @public */
-export declare type MinifyMode = 'simplify' | 'none';
-
-declare interface NormalizedQwikPluginOptions extends Omit<Required<QwikPluginOptions>, 'vendorRoots' | 'experimental'> {
+declare interface NormalizedQwikPluginOptions extends Omit<Required<QwikPluginOptions>, 'input' | 'vendorRoots' | 'srcInputs' | 'experimental'> {
     input: string[] | {
         [entry: string]: string;
-    };
-    experimental?: Record<keyof typeof ExperimentalFeatures, boolean>;
-}
-
-/** @public */
-export declare interface Optimizer {
-    /** Transforms the input code string, does not access the file system. */
-    transformModules(opts: TransformModulesOptions): Promise<TransformOutput>;
-    /** Optimizer system use. This can be updated with a custom file system. */
-    sys: OptimizerSystem;
-}
-
-/** @public */
-export declare interface OptimizerOptions {
-    sys?: OptimizerSystem;
-    binding?: any;
-    /** Inline the global styles if they're smaller than this */
-    inlineStylesUpToBytes?: number;
-    /** Enable sourcemaps */
-    sourcemap?: boolean;
-}
-
-/** @public */
-export declare interface OptimizerSystem {
-    cwd: () => string;
-    env: SystemEnvironment;
-    os: string;
-    dynamicImport: (path: string) => Promise<any>;
-    strictDynamicImport: (path: string) => Promise<any>;
-    getInputFiles?: (rootDir: string) => Promise<TransformModuleInput[]>;
-    path: Path;
+    } | undefined;
+    experimental: Record<keyof typeof ExperimentalFeatures, boolean> | undefined;
 }
 
 /**
@@ -138,36 +67,6 @@ declare type P<T> = Plugin_2<T> & {
     config: Extract<Plugin_2<T>['config'], Function>;
 };
 
-/** @public */
-export declare interface Path {
-    resolve(...paths: string[]): string;
-    normalize(path: string): string;
-    isAbsolute(path: string): boolean;
-    join(...paths: string[]): string;
-    relative(from: string, to: string): string;
-    dirname(path: string): string;
-    basename(path: string, ext?: string): string;
-    extname(path: string): string;
-    format(pathObject: {
-        root: string;
-        dir: string;
-        base: string;
-        ext: string;
-        name: string;
-    }): string;
-    parse(path: string): {
-        root: string;
-        dir: string;
-        base: string;
-        ext: string;
-        name: string;
-    };
-    readonly sep: string;
-    readonly delimiter: string;
-    readonly win32: null;
-    readonly posix: Path;
-}
-
 /** @public */
 export declare interface QwikAsset {
     /** Name of the asset */
@@ -265,9 +164,33 @@ export declare interface QwikManifest {
     };
 }
 
+/** @public */
 declare interface QwikPluginDevTools {
+    /**
+     * Validates image sizes for CLS issues during development. In case of issues, provides you with a
+     * correct image size resolutions. If set to `false`, image dev tool will be disabled.
+     *
+     * Default `true`
+     */
     imageDevTools?: boolean | true;
+    /**
+     * Press-hold the defined keys to enable qwik dev inspector. By default the behavior is activated
+     * by pressing the left or right `Alt` key. If set to `false`, qwik dev inspector will be
+     * disabled.
+     *
+     * Valid values are `KeyboardEvent.code` values. Please note that the 'Left' and 'Right' suffixes
+     * are ignored.
+     */
     clickToSource?: string[] | false;
+    /**
+     * Enable HMR for Qwik components. When enabled, editing a component file re-renders only that
+     * component without a full page reload, preserving client state.
+     *
+     * Set this to `false` for full page reloads on component edits.
+     *
+     * Default `true`
+     */
+    hmr?: boolean;
 }
 
 declare interface QwikPluginOptions {
@@ -281,13 +204,16 @@ declare interface QwikPluginOptions {
     vendorRoots?: string[];
     manifestOutput?: ((manifest: QwikManifest) => Promise<void> | void) | null;
     manifestInput?: QwikManifest | null;
+    manifestInputPath?: string | null;
     input?: string[] | string | {
         [entry: string]: string;
     };
     outDir?: string;
-    assetsDir?: string;
+    ssrOutDir?: string;
+    clientOutDir?: string;
     srcDir?: string | null;
     scope?: string | null;
+    /** @deprecated Not used */
     srcInputs?: TransformModuleInput[] | null;
     sourcemap?: boolean;
     resolveQwikBuild?: boolean;
@@ -313,10 +239,10 @@ declare interface QwikPluginOptions {
 }
 
 /** @public */
-export declare function qwikRollup(qwikRollupOpts?: QwikRollupPluginOptions): any;
+export declare function qwikRolldown(qwikRolldownOpts?: QwikRolldownPluginOptions): any;
 
 /** @public */
-export declare interface QwikRollupPluginOptions {
+export declare interface QwikRolldownPluginOptions {
     csr?: boolean;
     /**
      * Build `production` or `development`.
@@ -395,6 +321,22 @@ export declare interface QwikRollupPluginOptions {
     experimental?: (keyof typeof ExperimentalFeatures)[];
 }
 
+/**
+ * Renamed to `qwikRolldown`.
+ *
+ * @deprecated Use `qwikRolldown`.
+ * @public
+ */
+export declare const qwikRollup: typeof qwikRolldown;
+
+/**
+ * Renamed to `QwikRolldownPluginOptions`.
+ *
+ * @deprecated Use `QwikRolldownPluginOptions`.
+ * @public
+ */
+export declare type QwikRollupPluginOptions = QwikRolldownPluginOptions;
+
 /** @public */
 export declare interface QwikSymbol {
     origin: string;
@@ -414,7 +356,7 @@ export declare interface QwikSymbol {
 }
 
 /**
- * The types for Vite/Rollup don't allow us to be too specific about the return type. The correct
+ * The types for Vite/Rolldown don't allow us to be too specific about the return type. The correct
  * return type is `[QwikVitePlugin, VitePlugin<never>]`, and if you search the plugin by name you'll
  * get the `QwikVitePlugin`.
  *
@@ -422,12 +364,6 @@ export declare interface QwikSymbol {
  */
 export declare function qwikVite(qwikViteOpts?: QwikVitePluginOptions): any;
 
-/** @public */
-export declare interface QwikViteDevResponse {
-    _qwikEnvData?: Record<string, any>;
-    _qwikRenderResolve?: () => void;
-}
-
 /**
  * This is the type of the "pre" Qwik Vite plugin. `qwikVite` actually returns a tuple of two
  * plugins, but after Vite flattens them, you can find the plugin by name.
@@ -446,8 +382,11 @@ export declare interface QwikVitePluginApi {
     getRootDir: () => string | null;
     getClientOutDir: () => string | null;
     getClientPublicOutDir: () => string | null;
-    getAssetsDir: () => string | undefined;
     registerBundleGraphAdder: (adder: BundleGraphAdder) => void;
+    /** Register a callback that fires for each segment emitted during transform. */
+    onSegment: (callback: SegmentCallback) => void;
+    /** @internal */
+    _oldDevSsrServer: () => boolean | undefined;
 }
 
 declare interface QwikVitePluginCommonOptions {
@@ -501,29 +440,12 @@ declare interface QwikVitePluginCommonOptions {
      * before bundling.
      */
     transformedModuleOutput?: ((transformedModules: TransformModule[]) => Promise<void> | void) | null;
-    devTools?: {
-        /**
-         * Validates image sizes for CLS issues during development. In case of issues, provides you with
-         * a correct image size resolutions. If set to `false`, image dev tool will be disabled.
-         *
-         * Default `true`
-         */
-        imageDevTools?: boolean | true;
-        /**
-         * Press-hold the defined keys to enable qwik dev inspector. By default the behavior is
-         * activated by pressing the left or right `Alt` key. If set to `false`, qwik dev inspector will
-         * be disabled.
-         *
-         * Valid values are `KeyboardEvent.code` values. Please note that the 'Left' and 'Right'
-         * suffixes are ignored.
-         */
-        clickToSource?: string[] | false;
-    };
+    devTools?: QwikPluginDevTools;
     /**
      * Predicate function to filter out files from the optimizer. hook for resolveId, load, and
      * transform
      */
-    fileFilter?: (id: string, hook: string) => boolean;
+    fileFilter?: (id: string, hook: keyof Plugin_2) => boolean;
     /**
      * Run eslint on the source files for the ssr build or dev server. This can slow down startup on
      * large projects. Defaults to `true`
@@ -571,13 +493,6 @@ declare interface QwikVitePluginSSROptions extends QwikVitePluginCommonOptions {
          * Default `src/components/app/app.tsx`
          */
         input?: string[] | string;
-        /**
-         * Entry input for client-side only development with hot-module reloading. This is for Vite
-         * development only and does not use SSR.
-         *
-         * Default `src/entry.dev.tsx`
-         */
-        devInput?: string;
         /**
          * Output directory for the client build.
          *
@@ -592,15 +507,7 @@ declare interface QwikVitePluginSSROptions extends QwikVitePluginCommonOptions {
          */
         manifestOutput?: (manifest: QwikManifest) => Promise<void> | void;
     };
-    /**
-     * Qwik is SSR first framework. This means that Qwik requires either SSR or SSG. In dev mode the
-     * dev SSR server is responsible for rendering and pausing the application on the server.
-     *
-     * Under normal circumstances this should be on, unless you have your own SSR server which you
-     * would like to use instead and wish to disable this one.
-     *
-     * Default: true
-     */
+    /** @deprecated Use the `devSsrServer` option of the qwikRouter() plugin instead. */
     devSsrServer?: boolean;
     /** Controls the SSR behavior. */
     ssr?: {
@@ -626,6 +533,8 @@ declare interface QwikVitePluginSSROptions extends QwikVitePluginCommonOptions {
          * Default `undefined`
          */
         manifestInput?: QwikManifest;
+        /** Same as `manifestInput` but allows passing the path to the file. */
+        manifestInputPath?: string;
     };
 }
 
@@ -638,34 +547,7 @@ export declare interface ResolvedManifest {
 }
 
 /** @public */
-declare interface SegmentAnalysis {
-    origin: string;
-    name: string;
-    entry: string | null;
-    displayName: string;
-    hash: string;
-    canonicalFilename: string;
-    extension: string;
-    parent: string | null;
-    ctxKind: 'eventHandler' | 'function';
-    ctxName: string;
-    captures: boolean;
-    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[];
-}
-export { SegmentAnalysis as HookAnalysis }
-export { SegmentAnalysis }
-
-/** @public */
-declare interface SegmentEntryStrategy {
-    type: 'segment';
-    manual?: Record<string, string>;
-}
-export { SegmentEntryStrategy as HookEntryStrategy }
-export { SegmentEntryStrategy }
+declare type SegmentCallback = (parentId: string, segment: SegmentAnalysis) => void;
 
 /**
  * The manifest values that are needed for SSR.
@@ -674,106 +556,13 @@ export { SegmentEntryStrategy }
  */
 export declare type ServerQwikManifest = Pick<QwikManifest, 'manifestHash' | 'injections' | 'bundleGraph' | 'bundleGraphAsset' | 'mapping' | 'preloader' | 'core' | 'qwikLoader'>;
 
-/** @public */
-export declare interface SingleEntryStrategy {
-    type: 'single';
-    manual?: Record<string, string>;
-}
-
-/** @public */
-export declare interface SmartEntryStrategy {
-    type: 'smart';
-    manual?: Record<string, string>;
-}
-
-/** @public */
-export declare interface SourceLocation {
-    hi: number;
-    lo: number;
-    startLine: number;
-    startCol: number;
-    endLine: number;
-    endCol: number;
-}
-
-/** @public */
-export declare type SourceMapsOption = 'external' | 'inline' | undefined | null;
-
 /** @public */
 export declare type SymbolMapper = Record<string, readonly [symbol: string, chunk: string]>;
 
-/**
- * @beta
- *   For a given symbol (QRL such as `onKeydown$`) the server needs to know which bundle the symbol is in.
- *
- *   Normally this is provided by Qwik's `q-manifest` . But `q-manifest` only exists after a full client build.
- *
- *   This would be a problem in dev mode. So in dev mode the symbol is mapped to the expected URL using the symbolMapper function below. For Vite the given path is fixed for a given symbol.
- */
-export declare let symbolMapper: ReturnType<typeof createSymbolMapper>;
-
 /** @public */
 export declare type SymbolMapperFn = (symbolName: string, mapper: SymbolMapper | undefined, parent?: string) => readonly [symbol: string, chunk: string] | undefined;
 
-/** @public */
-export declare type SystemEnvironment = 'node' | 'deno' | 'bun' | 'webworker' | 'browsermain' | 'unknown';
-
-/** @public */
-export declare interface TransformModule {
-    path: string;
-    isEntry: boolean;
-    code: string;
-    map: string | null;
-    segment: SegmentAnalysis | null;
-    origPath: string | null;
-}
 
-/** @public */
-export declare interface TransformModuleInput {
-    path: string;
-    devPath?: string;
-    code: string;
-}
-
-/** @public */
-export declare interface TransformModulesOptions extends TransformOptions {
-    input: TransformModuleInput[];
-}
-
-/** @public */
-export declare interface TransformOptions {
-    srcDir: string;
-    rootDir?: string;
-    entryStrategy?: EntryStrategy;
-    minify?: MinifyMode;
-    sourceMaps?: boolean;
-    transpileTs?: boolean;
-    transpileJsx?: boolean;
-    preserveFilenames?: boolean;
-    explicitExtensions?: boolean;
-    mode?: EmitMode;
-    scope?: string;
-    stripExports?: string[];
-    regCtxName?: string[];
-    stripCtxName?: string[];
-    stripEventHandlers?: boolean;
-    isServer?: boolean;
-}
-
-/** @public */
-export declare interface TransformOutput {
-    modules: TransformModule[];
-    diagnostics: Diagnostic[];
-    isTypeScript: boolean;
-    isJsx: boolean;
-}
-
-/** @public */
-export declare type TranspileOption = boolean | undefined | null;
-
-/** @public */
-export declare const versions: {
-    qwik: string;
-};
+export * from "@qwik.dev/optimizer";
 
 export { }