vike 0.4.235 → 0.4.236-commit-64431e7

package/dist/esm/shared/route/routing.js

@@ -1,4 +1,4 @@
-// TODO/v1-release - move:
+// TO-DO/next-major-release: move
 //   import { resolveRoute } from 'vike/routing'
 // to:
 //   import { resolveRoute } from 'vike'

package/dist/esm/types/Config.d.ts

@@ -44,6 +44,7 @@ import type { Vike, VikePackages } from './VikeNamespace.js';
 import type { HooksTimeoutProvidedByUser } from '../shared/hooks/getHook.js';
 import type { GlobalContext, PageContextClient, PageContextServer } from './PageContext.js';
 import type { InlineConfig } from 'vite';
+import type { PassToClient } from '../node/runtime/html/serializeContext.js';
 type HookNameOld = HookName | HookNameOldDesign;
 type HookName = HookNamePage | HookNameGlobal;
 type HookNamePage = 'onHydrationEnd' | 'onBeforePrerenderStart' | 'onBeforeRender' | 'onPageTransitionStart' | 'onPageTransitionEnd' | 'onRenderHtml' | 'onRenderClient' | 'guard' | 'data' | 'onData' | 'route';
@@ -362,7 +363,7 @@ type ConfigBuiltIn = {
      *
      * https://vike.dev/passToClient
      */
-    passToClient?: string[] | ImportString;
+    passToClient?: PassToClient | ImportString;
     /** Hook called when page is rendered on the client-side.
      *
      * https://vike.dev/onRenderClient
@@ -508,6 +509,12 @@ type ConfigBuiltIn = {
      * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
      */
     cacheControl?: string;
+    /**
+     * Add HTTP headers to the HTTP response.
+     *
+     * https://vike.dev/headers#response
+     */
+    headersResponse?: HeadersInit;
     /**
      * Make development/preview server available over LAN and public addresses.
      *
@@ -561,6 +568,7 @@ type ConfigBuiltInResolved = {
     redirects?: Record<string, string>[];
     prerender?: Exclude<Config['prerender'], ImportString | undefined>[];
     middleware?: Function[];
+    headersResponse?: HeadersInit[];
 };
 type ConfigMeta = Record<string, ConfigDefinition>;
 type ImportString = `import:${string}`;

package/dist/esm/types/PageContext.d.ts

@@ -81,7 +81,7 @@ type PageContextBuiltInCommon<Data> = {
      */
     urlOriginal: string;
     /**
-     * The HTTP Headers of the incoming HTTP Request.
+     * The HTTP request headers.
      *
      * As a string object normalized by Vike.
      *
@@ -90,7 +90,7 @@ type PageContextBuiltInCommon<Data> = {
      */
     headers: Record<string, string> | null;
     /**
-     * The HTTP Headers of the incoming HTTP Request.
+     * The HTTP request headers.
      *
      * The original object provided by the server.
      *
@@ -98,6 +98,12 @@ type PageContextBuiltInCommon<Data> = {
      * https://vike.dev/pageContext#headersOriginal
      */
     headersOriginal?: unknown;
+    /**
+     * The HTTP response headers.
+     *
+     * https://vike.dev/headers#response
+     */
+    headersResponse: Headers;
     /** If an error occurs, whether the error is a `404 Page Not Found`.
      *
      * https://vike.dev/error-page

package/dist/esm/utils/PROJECT_VERSION.d.ts

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.235";
+export declare const PROJECT_VERSION: "0.4.236-commit-64431e7";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.235';
+export const PROJECT_VERSION = '0.4.236-commit-64431e7';

package/dist/esm/utils/assertSetup.js

@@ -24,22 +24,25 @@ function assertIsNotProductionRuntime() {
     setup.shouldNotBeProduction = true;
 }
 function onSetupRuntime() {
+    // TODO/now
+    if (true)
+        return;
     if (debug.isActivated)
         debug('assertSetup()', new Error().stack);
     if (isTest())
         return;
     assertNodeEnvIsNotUndefinedString();
     if (!setup.viteDevServer && setup.isViteDev === undefined) {
-        // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
-        assertWarning(!isNodeEnvDev(), `The ${getEnvDescription()}, which is contradictory because the environment seems to be a production environment (Vite isn't loaded), see https://vike.dev/NODE_ENV`, { onlyOnce: true });
-        assertUsage(!setup.vikeVitePlugin, `Loading Vike's Vite plugin (the ${pc.cyan('vike/plugin')} module) is prohibited in production.`);
+        // TO-DO/eventually: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
+        assertWarning(!isNodeEnvDev(), `The ${getEnvDescription()}, which is contradictory because the environment seems to be a production environment (Vite isn't loaded), see ${pc.underline('https://vike.dev/NODE_ENV')} and ${pc.underline('https://vike.dev/warning/setup')}`, { onlyOnce: true });
+        assertUsage(!setup.vikeVitePlugin, `Vike's Vite plugin (the ${pc.cyan('vike/plugin')} module) shouldn't be loaded in production, see ${pc.underline('https://vike.dev/warning/setup')}`);
         // This assert() one of the main goal of this file: it ensures assertIsNotProductionRuntime()
         assert(!setup.shouldNotBeProduction);
     }
     else {
         if (!setup.isPreview && !setup.vitePreviewServer && !setup.isPrerendering) {
-            // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
-            assertWarning(isNodeEnvDev(), `The ${getEnvDescription()}, but Vite is loaded which is prohibited in production, see https://vike.dev/NODE_ENV`, { onlyOnce: true });
+            // TO-DO/eventually: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
+            assertWarning(isNodeEnvDev(), `The ${getEnvDescription()} while Vite is loaded, but Vite shouldn't be loaded in production, see ${pc.underline('https://vike.dev/warning/setup')}`, { onlyOnce: true });
         }
         assert(setup.vikeVitePlugin);
         assert(setup.shouldNotBeProduction);
@@ -108,8 +111,8 @@ function markSetup_isPreview() {
 function assertUsageNodeEnvIsNotDev(operation) {
     if (!isNodeEnvDev())
         return;
-    // TODO: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
-    assertWarning(false, `The ${getEnvDescription()} which is forbidden upon ${operation}, see https://vike.dev/NODE_ENV`, { onlyOnce: true });
+    // TO-DO/eventually: make it assertUsage() again once https://github.com/vikejs/vike/issues/1528 is implemented.
+    assertWarning(false, `The ${getEnvDescription()} upon ${operation} which shouldn't be the case, see ${pc.underline('https://vike.dev/NODE_ENV')}`, { onlyOnce: true });
 }
 function getEnvDescription() {
     const envType = `${(isNodeEnvDev() ? 'development' : 'production')} environment`;
@@ -120,7 +123,7 @@ function getEnvDescription() {
 // https://github.com/cloudflare/workers-sdk/issues/7886
 function assertNodeEnvIsNotUndefinedString() {
     const nodeEnv = getNodeEnv();
-    assertWarning(nodeEnv !== 'undefined', `${pc.cyan('process.env.NODE_ENV==="undefined"')} which is unexpected: ${pc.cyan('process.env.NODE_ENV')} is allowed to be the *value* ${pc.cyan('undefined')} (i.e. ${pc.cyan('process.env.NODE_ENV===undefined')}) but it shouldn't be the *string* ${pc.cyan('"undefined"')} ${pc.underline('https://vike.dev/NODE_ENV')}`, { onlyOnce: true });
+    assertWarning(nodeEnv !== 'undefined', `${pc.cyan('process.env.NODE_ENV==="undefined"')} which is unexpected: ${pc.cyan('process.env.NODE_ENV')} is allowed to be the *value* ${pc.cyan('undefined')} (i.e. ${pc.cyan('process.env.NODE_ENV===undefined')}) but it shouldn't be the *string* ${pc.cyan('"undefined"')} — see ${pc.underline('https://vike.dev/NODE_ENV')}`, { onlyOnce: true });
 }
 function isNodeEnvDev() {
     const nodeEnv = getNodeEnv();

package/dist/esm/utils/debug.d.ts

@@ -1,7 +1,7 @@
 export { createDebugger };
 export { isDebugActivated };
 export type { Debug };
-declare const flags: readonly ["vike:crawl", "vike:error", "vike:esbuild-resolve", "vike:pluginExtractAssets", "vike:pluginExtractExportNames", "vike:glob", "vike:globalContext", "vike:log", "vike:optimizeDeps", "vike:outDir", "vike:pageFiles", "vike:pointer-imports", "vike:resolve", "vike:routing", "vike:setup", "vike:stream", "vike:virtualFiles"];
+declare const flags: readonly ["vike:crawl", "vike:error", "vike:esbuild-resolve", "vike:pluginExtractAssets", "vike:pluginExtractExportNames", "vike:glob", "vike:globalContext", "vike:log", "vike:optimizeDeps", "vike:outDir", "vike:pageFiles", "vike:pointer-imports", "vike:resolve", "vike:routing", "vike:setup", "vike:stream", "vike:virtualFiles", "vike:vite-rpc"];
 type Flag = (typeof flags)[number];
 type Debug = ReturnType<typeof createDebugger>;
 type Options = {

package/dist/esm/utils/debug.js

@@ -30,6 +30,7 @@ const flags = [
     'vike:setup',
     'vike:stream',
     'vike:virtualFiles',
+    'vike:vite-rpc',
 ];
 const flagsSkipWildcard = ['vike:log'];
 const flagRegex = /\bvike:[a-zA-Z-]+/g;

package/dist/esm/utils/debugGlob.js

@@ -1,3 +1,3 @@
 import { createDebugger } from './debug.js';
-// TODO/v1-release: remove (or rename?)
+// TO-DO/next-major-release: remove (or rename?)
 export const debugGlob = createDebugger('vike:glob');

package/dist/esm/utils/getViteRPC.d.ts

@@ -0,0 +1,6 @@
+export { getViteRPC };
+export { createViteRPC };
+import type { ViteDevServer } from 'vite';
+declare function getViteRPC<RpcFunctions>(): RpcFunctions;
+type AsyncFunction = (...args: any[]) => Promise<unknown>;
+declare function createViteRPC(viteDevServer: ViteDevServer, getRpcFunctions: (viteDevServer: ViteDevServer) => Record<string, AsyncFunction>): void;

package/dist/esm/utils/getViteRPC.js

@@ -0,0 +1,77 @@
+export { getViteRPC }; // consumer (aka RPC client)
+export { createViteRPC }; // provider (aka RPC server)
+import { assert } from './assert.js';
+import { genPromise } from './genPromise.js';
+import { getRandomId } from './getRandomId.js';
+import { getGlobalObject } from './getGlobalObject.js';
+import { createDebugger } from './debug.js';
+import { assertIsNotBrowser } from './assertIsNotBrowser.js';
+assertIsNotBrowser();
+const globalObject = getGlobalObject('utils/getViteRPC.ts', {
+    rpc: null,
+});
+const debug = createDebugger('vike:vite-rpc');
+function getViteRPC() {
+    globalObject.rpc ?? (globalObject.rpc = createRpcClient());
+    return globalObject.rpc;
+}
+function createRpcClient() {
+    // @ts-ignore
+    const hot = import.meta.hot;
+    assert(hot);
+    const callbacks = [];
+    hot.on(`vike:rpc:response`, (dataResponse) => {
+        if (debug.isActivated)
+            debug('Response received', dataResponse);
+        const { callId, functionReturn } = dataResponse;
+        callbacks.forEach((c) => {
+            if (callId !== c.callId)
+                return;
+            c.cb(functionReturn);
+            callbacks.splice(callbacks.indexOf(c), 1);
+        });
+    });
+    const rpc = new Proxy({}, {
+        get(_, functionName) {
+            return async (...functionArgs) => {
+                // @ts-ignore
+                const hot = import.meta.hot;
+                assert(hot);
+                const callId = getRandomId();
+                const { promise, resolve } = genPromise({ timeout: 3 * 1000 });
+                callbacks.push({
+                    callId,
+                    cb: (functionReturn) => {
+                        resolve(functionReturn);
+                    },
+                });
+                const dataRequest = { callId, functionName, functionArgs };
+                if (debug.isActivated)
+                    debug('Request sent', dataRequest);
+                // Vite's type is wrong; it import.meta.hot.send() does seem to return a promise
+                await hot.send('vike:rpc:request', dataRequest);
+                const functionReturn = await promise;
+                return functionReturn;
+            };
+        },
+    });
+    return rpc;
+}
+function createViteRPC(viteDevServer, getRpcFunctions) {
+    const rpcFunctions = getRpcFunctions(viteDevServer);
+    const { environments } = viteDevServer;
+    for (const envName in environments) {
+        debug('Listening to environment', envName);
+        const env = environments[envName];
+        env.hot.on('vike:rpc:request', async (dataRequest) => {
+            if (debug.isActivated)
+                debug('Request received', dataRequest);
+            const { callId, functionName, functionArgs } = dataRequest;
+            const functionReturn = await rpcFunctions[functionName](...functionArgs);
+            const dataResponse = { callId, functionReturn };
+            if (debug.isActivated)
+                debug('Response sent', dataResponse);
+            env.hot.send('vike:rpc:response', dataResponse);
+        });
+    }
+}

package/dist/esm/utils/parseNpmPackage.js

@@ -52,7 +52,7 @@ function isPathAliasRecommended(alias) {
     //  - In principle, we could allow path aliases that don't start with special character as long as they can be distinguished from npm package names.
     //    - But we still enforce path aliases to start with a special character because it's a much simpler rule to follow.
     if (alias.startsWith('@/'))
-        return true; // Needed by contra.com
+        return true; // Needed by contra.com and https://github.com/vikejs/vike/issues/1567#issuecomment-3076374243
     const firstLetter = alias[0];
     assert(firstLetter);
     if (firstLetter === '@' || /[0-9a-z]/.test(firstLetter.toLowerCase()))

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "vike",
-  "version": "0.4.235",
+  "version": "0.4.236-commit-64431e7",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {
       "worker": "./dist/esm/node/runtime/index.js",
+      "workerd": "./dist/esm/node/runtime/index.js",
       "require": "./dist/cjs/node/runtime/index.js",
       "node": "./dist/esm/node/runtime/index.js",
       "browser": "./dist/esm/client/node.js",
@@ -19,6 +20,7 @@
     },
     "./client/router": {
       "worker": "./dist/esm/node/client/router.js",
+      "workerd": "./dist/esm/node/client/router.js",
       "require": "./dist/cjs/node/client/router.js",
       "node": "./dist/esm/node/client/router.js",
       "browser": "./dist/esm/client/runtime-client-routing/index.js",
@@ -27,6 +29,7 @@
     },
     "./routing": {
       "worker": "./dist/esm/shared/route/routing.js",
+      "workerd": "./dist/esm/shared/route/routing.js",
       "require": "./dist/cjs/shared/route/routing.js",
       "node": "./dist/esm/shared/route/routing.js",
       "browser": "./dist/esm/shared/route/routing.js",
@@ -59,6 +62,7 @@
     },
     "./RenderErrorPage": {
       "worker": "./dist/esm/shared/RenderErrorPage.js",
+      "workerd": "./dist/esm/shared/RenderErrorPage.js",
       "require": "./dist/cjs/shared/RenderErrorPage.js",
       "node": "./dist/esm/shared/RenderErrorPage.js",
       "browser": "./dist/esm/shared/RenderErrorPage.js",
@@ -67,6 +71,7 @@
     },
     "./abort": {
       "worker": "./dist/esm/shared/abort.js",
+      "workerd": "./dist/esm/shared/abort.js",
       "require": "./dist/cjs/shared/abort.js",
       "node": "./dist/esm/shared/abort.js",
       "browser": "./dist/esm/shared/abort.js",
@@ -75,6 +80,7 @@
     },
     "./getPageContext": {
       "worker": "./dist/esm/shared/getPageContext.js",
+      "workerd": "./dist/esm/shared/getPageContext.js",
       "require": "./dist/cjs/shared/getPageContext.js",
       "node": "./dist/esm/shared/getPageContext.js",
       "browser": "./dist/esm/shared/getPageContext.js",
@@ -83,6 +89,7 @@
     },
     "./modifyUrl": {
       "worker": "./dist/esm/shared/modifyUrl.js",
+      "workerd": "./dist/esm/shared/modifyUrl.js",
       "require": "./dist/cjs/shared/modifyUrl.js",
       "node": "./dist/esm/shared/modifyUrl.js",
       "browser": "./dist/esm/shared/modifyUrl.js",
@@ -91,6 +98,7 @@
     },
     "./universal-middleware": {
       "worker": "./dist/esm/node/runtime/universal-middleware.js",
+      "workerd": "./dist/esm/node/runtime/universal-middleware.js",
       "require": "./dist/cjs/node/runtime/universal-middleware.js",
       "node": "./dist/esm/node/runtime/universal-middleware.js",
       "browser": "./dist/esm/client/node.js",
@@ -111,6 +119,7 @@
     },
     ".": {
       "worker": "./dist/esm/node/runtime/index.js",
+      "workerd": "./dist/esm/node/runtime/index.js",
       "require": "./dist/cjs/node/runtime/index.js",
       "node": "./dist/esm/node/runtime/index.js",
       "browser": "./dist/esm/client/index.js",
@@ -120,7 +129,7 @@
   },
   "dependencies": {
     "@brillout/import": "^0.2.6",
-    "@brillout/json-serializer": "^0.5.15",
+    "@brillout/json-serializer": "^0.5.16",
     "@brillout/picocolors": "^1.0.26",
     "@brillout/require-shim": "^0.1.2",
     "@brillout/vite-plugin-server-entry": "^0.7.8",
@@ -245,16 +254,13 @@
     "./universal-middleware.js"
   ],
   "devDependencies": {
-    "@biomejs/biome": "^1.9.4",
     "@brillout/release-me": "^0.4.2",
     "@types/estree": "^1.0.5",
-    "@types/jest": "^29.5.11",
     "@types/node": "^20.10.5",
     "@types/picomatch": "^3.0.2",
-    "@types/resolve": "^1.20.6",
     "@types/semver": "^7.5.8",
     "@types/source-map-support": "^0.5.10",
-    "react-streaming": "^0.4.2",
+    "react-streaming": "^0.4.3",
     "rimraf": "^5.0.5",
     "typescript": "^5.8.3",
     "vite": "^6.3.2"

package/dist/esm/node/runtime/renderPage/createHttpResponse/getCacheControl.d.ts

@@ -1,5 +0,0 @@
-export { getCacheControl };
-import type { PageConfigRuntime } from '../../../../types/PageConfig.js';
-import type { HttpResponse } from '../createHttpResponse.js';
-type StatusCode = HttpResponse['statusCode'];
-declare function getCacheControl(pageId: string | null, pageConfigs: PageConfigRuntime[], statusCode: StatusCode): string;