vike 0.4.227-commit-f991d58 → 0.4.228

package/dist/cjs/node/api/dev.js

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.dev = dev;
 const prepareViteApiCall_js_1 = require("./prepareViteApiCall.js");
 const vite_1 = require("vite");
+const globalContext_js_1 = require("../runtime/globalContext.js");
 /**
  * Programmatically trigger `$ vike dev`
  *
  * https://vike.dev/api#dev
  */
 async function dev(options = {}) {
+    (0, globalContext_js_1.setGlobalContext_isProduction)(false);
     const { viteConfigFromUserEnhanced } = await (0, prepareViteApiCall_js_1.prepareViteApiCall)(options, 'dev');
     const server = await (0, vite_1.createServer)(viteConfigFromUserEnhanced);
     return {

package/dist/cjs/node/runtime/globalContext.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGlobalContext = getGlobalContext;
 exports.getGlobalContextSync = getGlobalContextSync;
 exports.getGlobalContextAsync = getGlobalContextAsync;
 exports.getGlobalContextInternal = getGlobalContextInternal;
@@ -58,13 +59,24 @@ function assertGlobalContextIsDefined() {
     assertIsDefined(globalObject.globalContext);
     (0, utils_js_1.assert)(globalObject.globalContext_public);
 }
-/** @experimental https://vike.dev/getGlobalContext */
-function getGlobalContextSync() {
-    const { globalContext_public } = globalObject;
-    (0, utils_js_1.assertUsage)(globalContext_public, "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContextAsync() instead.");
-    return globalContext_public;
-}
-/** @experimental https://vike.dev/getGlobalContext */
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ */
+async function getGlobalContext() {
+    debug('getGlobalContext()');
+    const { isProduction } = globalObject;
+    // This assertion cannot fail for vike-server users (because when using vike-server it's guaranteed that globalObject.isProduction is set before executing any user-land code and any Vike extension code).
+    (0, utils_js_1.assertUsage)(isProduction !== undefined, "The global context isn't set yet, use getGlobalContextAsync() instead.");
+    (0, utils_js_1.assert)(typeof globalObject.isProduction === 'boolean');
+    return await getGlobalContextAsync(isProduction);
+}
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ */
 async function getGlobalContextAsync(isProduction) {
     debug('getGlobalContextAsync()');
     (0, utils_js_1.assertUsage)(typeof isProduction === 'boolean', `[getGlobalContextAsync(isProduction)] Argument ${picocolors_1.default.cyan('isProduction')} ${isProduction === undefined ? 'is missing' : `should be ${picocolors_1.default.cyan('true')} or ${picocolors_1.default.cyan('false')}`}`);
@@ -78,6 +90,23 @@ async function getGlobalContextAsync(isProduction) {
     (0, utils_js_1.assert)(globalContext_public);
     return globalContext_public;
 }
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ *
+ * @deprecated
+ */
+function getGlobalContextSync() {
+    debug('getGlobalContextSync()');
+    const { globalContext_public } = globalObject;
+    (0, utils_js_1.assertUsage)(globalContext_public, "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContext() instead.");
+    (0, utils_js_1.assertWarning)(false, 
+    // We discourage users from using it because using `pageContext.globalContext` is better: it doesn't have the race condition issue that `getGlobalContextSync()` would have when called inside React/Vue components.
+    // We're lying about "is going to be deprecated in the next major release": let's keep it and see if users need it (so far I can't see a use case for it).
+    'getGlobalContextSync() is going to be deprecated in the next major release, see https://vike.dev/getGlobalContext', { onlyOnce: true });
+    return globalContext_public;
+}
 function makePublic(globalContext) {
     const globalContextPublic = (0, utils_js_1.makePublicCopy)(globalContext, 'globalContext', [
         'assetsManifest',
@@ -118,8 +147,13 @@ function setGlobalContext_isPrerendering() {
     globalObject.isPrerendering = true;
     setIsProduction(true);
 }
-function setGlobalContext_isProduction(isProduction) {
-    setIsProduction(isProduction);
+function setGlobalContext_isProduction(isProduction, tolerateContraditction) {
+    if (globalObject.isProduction === undefined) {
+        setIsProduction(isProduction);
+    }
+    else {
+        (0, utils_js_1.assert)(globalObject.isProduction === isProduction || tolerateContraditction);
+    }
 }
 function getViteDevServer() {
     return globalObject.viteDevServer ?? null;

package/dist/cjs/node/runtime/index-common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPageRenderer = exports._injectAssets = exports.createDevMiddleware = exports.getGlobalContextAsync = exports.getGlobalContextSync = exports.version = exports.stampPipe = exports.pipeStream = exports.pipeNodeStream = exports.pipeWebStream = exports.dangerouslySkipEscape = exports.escapeInject = exports.renderPage = void 0;
+exports.createPageRenderer = exports._injectAssets = exports.createDevMiddleware = exports.getGlobalContextAsync = exports.getGlobalContextSync = exports.getGlobalContext = exports.version = exports.stampPipe = exports.pipeStream = exports.pipeNodeStream = exports.pipeWebStream = exports.dangerouslySkipEscape = exports.escapeInject = exports.renderPage = void 0;
 var renderPage_js_1 = require("./renderPage.js");
 Object.defineProperty(exports, "renderPage", { enumerable: true, get: function () { return renderPage_js_1.renderPage; } });
 var renderHtml_js_1 = require("./html/renderHtml.js");
@@ -14,6 +14,7 @@ Object.defineProperty(exports, "stampPipe", { enumerable: true, get: function ()
 var utils_js_1 = require("./utils.js");
 Object.defineProperty(exports, "version", { enumerable: true, get: function () { return utils_js_1.PROJECT_VERSION; } });
 var globalContext_js_1 = require("./globalContext.js");
+Object.defineProperty(exports, "getGlobalContext", { enumerable: true, get: function () { return globalContext_js_1.getGlobalContext; } });
 Object.defineProperty(exports, "getGlobalContextSync", { enumerable: true, get: function () { return globalContext_js_1.getGlobalContextSync; } });
 Object.defineProperty(exports, "getGlobalContextAsync", { enumerable: true, get: function () { return globalContext_js_1.getGlobalContextAsync; } });
 var index_js_1 = require("../runtime-dev/index.js");

package/dist/cjs/node/runtime-dev/createDevMiddleware.js

@@ -10,7 +10,7 @@ const globalContext_js_1 = require("../runtime/globalContext.js");
  * https://vike.dev/createDevMiddleware
  */
 async function createDevMiddleware(options = {}) {
-    (0, globalContext_js_1.setGlobalContext_isProduction)(false);
+    (0, globalContext_js_1.setGlobalContext_isProduction)(false, true);
     const optionsMod = {
         ...options,
         viteConfig: {

package/dist/cjs/utils/PROJECT_VERSION.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PROJECT_VERSION = void 0;
 // Automatically updated by @brillout/release-me
-exports.PROJECT_VERSION = '0.4.227-commit-f991d58';
+exports.PROJECT_VERSION = '0.4.228';

package/dist/esm/node/api/dev.js

@@ -1,12 +1,14 @@
 export { dev };
 import { prepareViteApiCall } from './prepareViteApiCall.js';
 import { createServer } from 'vite';
+import { setGlobalContext_isProduction } from '../runtime/globalContext.js';
 /**
  * Programmatically trigger `$ vike dev`
  *
  * https://vike.dev/api#dev
  */
 async function dev(options = {}) {
+    setGlobalContext_isProduction(false);
     const { viteConfigFromUserEnhanced } = await prepareViteApiCall(options, 'dev');
     const server = await createServer(viteConfigFromUserEnhanced);
     return {

package/dist/esm/node/runtime/globalContext.d.ts

@@ -1,3 +1,4 @@
+export { getGlobalContext };
 export { getGlobalContextSync };
 export { getGlobalContextAsync };
 export { getGlobalContextInternal };
@@ -49,16 +50,32 @@ type GlobalContext = {
     viteConfig: ResolvedConfig;
 })));
 declare function getGlobalContextInternal(): Promise<GlobalContextInternal>;
-/** @experimental https://vike.dev/getGlobalContext */
-declare function getGlobalContextSync(): GlobalContextPublic;
-/** @experimental https://vike.dev/getGlobalContext */
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ */
+declare function getGlobalContext(): Promise<GlobalContextPublic>;
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ */
 declare function getGlobalContextAsync(isProduction: boolean): Promise<GlobalContextPublic>;
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ *
+ * @deprecated
+ */
+declare function getGlobalContextSync(): GlobalContextPublic;
 type GlobalContextPublic = ReturnType<typeof makePublic>;
 declare function makePublic(globalContext: GlobalContext): Pick<GlobalContext, "pages" | "baseServer" | "baseAssets" | "config" | "assetsManifest" | "viteConfig" | "viteConfigRuntime">;
 declare function setGlobalContext_viteDevServer(viteDevServer: ViteDevServer): Promise<void>;
 declare function setGlobalContext_viteConfig(viteConfig: ResolvedConfig, viteConfigRuntime: ViteConfigRuntime): void;
 declare function setGlobalContext_isPrerendering(): void;
-declare function setGlobalContext_isProduction(isProduction: boolean): void;
+declare function setGlobalContext_isProduction(isProduction: boolean, tolerateContraditction?: true): void;
 declare function getViteDevServer(): ViteDevServer | null;
 declare function getViteConfig(): ResolvedConfig | null;
 declare function initGlobalContext_renderPage(): Promise<void>;

package/dist/esm/node/runtime/globalContext.js

@@ -1,4 +1,5 @@
 // Public use
+export { getGlobalContext };
 export { getGlobalContextSync };
 export { getGlobalContextAsync };
 // Internal use
@@ -55,13 +56,24 @@ function assertGlobalContextIsDefined() {
     assertIsDefined(globalObject.globalContext);
     assert(globalObject.globalContext_public);
 }
-/** @experimental https://vike.dev/getGlobalContext */
-function getGlobalContextSync() {
-    const { globalContext_public } = globalObject;
-    assertUsage(globalContext_public, "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContextAsync() instead.");
-    return globalContext_public;
-}
-/** @experimental https://vike.dev/getGlobalContext */
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ */
+async function getGlobalContext() {
+    debug('getGlobalContext()');
+    const { isProduction } = globalObject;
+    // This assertion cannot fail for vike-server users (because when using vike-server it's guaranteed that globalObject.isProduction is set before executing any user-land code and any Vike extension code).
+    assertUsage(isProduction !== undefined, "The global context isn't set yet, use getGlobalContextAsync() instead.");
+    assert(typeof globalObject.isProduction === 'boolean');
+    return await getGlobalContextAsync(isProduction);
+}
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ */
 async function getGlobalContextAsync(isProduction) {
     debug('getGlobalContextAsync()');
     assertUsage(typeof isProduction === 'boolean', `[getGlobalContextAsync(isProduction)] Argument ${pc.cyan('isProduction')} ${isProduction === undefined ? 'is missing' : `should be ${pc.cyan('true')} or ${pc.cyan('false')}`}`);
@@ -75,6 +87,23 @@ async function getGlobalContextAsync(isProduction) {
     assert(globalContext_public);
     return globalContext_public;
 }
+/**
+ * Get runtime information about your app.
+ *
+ * https://vike.dev/getGlobalContext
+ *
+ * @deprecated
+ */
+function getGlobalContextSync() {
+    debug('getGlobalContextSync()');
+    const { globalContext_public } = globalObject;
+    assertUsage(globalContext_public, "The global context isn't set yet, call getGlobalContextSync() later or use getGlobalContext() instead.");
+    assertWarning(false, 
+    // We discourage users from using it because using `pageContext.globalContext` is better: it doesn't have the race condition issue that `getGlobalContextSync()` would have when called inside React/Vue components.
+    // We're lying about "is going to be deprecated in the next major release": let's keep it and see if users need it (so far I can't see a use case for it).
+    'getGlobalContextSync() is going to be deprecated in the next major release, see https://vike.dev/getGlobalContext', { onlyOnce: true });
+    return globalContext_public;
+}
 function makePublic(globalContext) {
     const globalContextPublic = makePublicCopy(globalContext, 'globalContext', [
         'assetsManifest',
@@ -115,8 +144,13 @@ function setGlobalContext_isPrerendering() {
     globalObject.isPrerendering = true;
     setIsProduction(true);
 }
-function setGlobalContext_isProduction(isProduction) {
-    setIsProduction(isProduction);
+function setGlobalContext_isProduction(isProduction, tolerateContraditction) {
+    if (globalObject.isProduction === undefined) {
+        setIsProduction(isProduction);
+    }
+    else {
+        assert(globalObject.isProduction === isProduction || tolerateContraditction);
+    }
 }
 function getViteDevServer() {
     return globalObject.viteDevServer ?? null;

package/dist/esm/node/runtime/index-common.d.ts

@@ -2,7 +2,7 @@ export { renderPage } from './renderPage.js';
 export { escapeInject, dangerouslySkipEscape } from './html/renderHtml.js';
 export { pipeWebStream, pipeNodeStream, pipeStream, stampPipe } from './html/stream.js';
 export { PROJECT_VERSION as version } from './utils.js';
-export { getGlobalContextSync, getGlobalContextAsync } from './globalContext.js';
+export { getGlobalContext, getGlobalContextSync, getGlobalContextAsync } from './globalContext.js';
 export { createDevMiddleware } from '../runtime-dev/index.js';
 export { injectAssets__public as _injectAssets } from './html/injectAssets/injectAssets__public.js';
 export { createPageRenderer } from '../createPageRenderer.js';

package/dist/esm/node/runtime/index-common.js

@@ -2,7 +2,7 @@ export { renderPage } from './renderPage.js';
 export { escapeInject, dangerouslySkipEscape } from './html/renderHtml.js';
 export { pipeWebStream, pipeNodeStream, pipeStream, stampPipe } from './html/stream.js';
 export { PROJECT_VERSION as version } from './utils.js';
-export { getGlobalContextSync, getGlobalContextAsync } from './globalContext.js';
+export { getGlobalContext, getGlobalContextSync, getGlobalContextAsync } from './globalContext.js';
 export { createDevMiddleware } from '../runtime-dev/index.js';
 // TODO/v1-release: remove
 export { injectAssets__public as _injectAssets } from './html/injectAssets/injectAssets__public.js';

package/dist/esm/node/runtime-dev/createDevMiddleware.js

@@ -8,7 +8,7 @@ import { setGlobalContext_isProduction } from '../runtime/globalContext.js';
  * https://vike.dev/createDevMiddleware
  */
 async function createDevMiddleware(options = {}) {
-    setGlobalContext_isProduction(false);
+    setGlobalContext_isProduction(false, true);
     const optionsMod = {
         ...options,
         viteConfig: {

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

@@ -120,11 +120,9 @@ type PageContextBuiltInCommon<Data> = {
     /** @experimental https://github.com/vikejs/vike/issues/1268 */
     sources: Sources;
     /**
-     * Information shared by all pages.
+     * Runtime information about your app.
      *
      * https://vike.dev/getGlobalContext
-     *
-     * @experimental
      */
     globalContext: GlobalContextPublic;
     /** @deprecated */

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

@@ -1 +1 @@
-export declare const PROJECT_VERSION: "0.4.227-commit-f991d58";
+export declare const PROJECT_VERSION: "0.4.228";

package/dist/esm/utils/PROJECT_VERSION.js

@@ -1,2 +1,2 @@
 // Automatically updated by @brillout/release-me
-export const PROJECT_VERSION = '0.4.227-commit-f991d58';
+export const PROJECT_VERSION = '0.4.228';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vike",
-  "version": "0.4.227-commit-f991d58",
+  "version": "0.4.228",
   "repository": "https://github.com/vikejs/vike",
   "exports": {
     "./server": {