vike 0.4.229 → 0.4.230

package/dist/cjs/shared/preparePageContextForUserConsumption.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.preparePageContextForUserConsumption = preparePageContextForUserConsumption;
-const utils_js_1 = require("./utils.js");
-const addIs404ToPageProps_js_1 = require("./addIs404ToPageProps.js");
-function preparePageContextForUserConsumption(pageContext) {
-    (0, utils_js_1.assert)(pageContext.pageId);
-    (0, utils_js_1.assert)('config' in pageContext);
-    (0, utils_js_1.assert)('configEntries' in pageContext);
-    (0, addIs404ToPageProps_js_1.addIs404ToPageProps)(pageContext);
-    // TODO/next-major-release: remove
-    if (!('_pageId' in pageContext)) {
-        Object.defineProperty(pageContext, '_pageId', {
-            get() {
-                (0, utils_js_1.assertWarning)(false, 'pageContext._pageId has been renamed to pageContext.pageId', {
-                    showStackTrace: true,
-                    onlyOnce: true
-                });
-                return pageContext.pageId;
-            },
-            enumerable: false
-        });
-    }
-    // For a more readable `console.log(pageContext)` output
-    sortPageContext(pageContext);
-}
-// Sort `pageContext` keys alphabetically, in order to make reading the `console.log(pageContext)` output easier
-function sortPageContext(pageContext) {
-    let descriptors = Object.getOwnPropertyDescriptors(pageContext);
-    for (const key of Object.keys(pageContext))
-        delete pageContext[key];
-    descriptors = Object.fromEntries(Object.entries(descriptors).sort(([key1], [key2]) => (0, utils_js_1.compareString)(key1, key2)));
-    Object.defineProperties(pageContext, descriptors);
-}

package/dist/cjs/utils/getPublicProxy.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPublicProxy = getPublicProxy;
-// We use a proxy instead of property getters.
-// - The issue with property getters is that they can't be `writable: true` but we do want the user to be able to modify the value of internal properties.
-//   ```console
-//   TypeError: Invalid property descriptor. Cannot both specify accessors and a value or writable attribute, #<Object>
-//   ```
-// - Previous implementation using property getters: https://github.com/vikejs/vike/blob/main/vike/utils/makePublicCopy.ts
-const assert_js_1 = require("./assert.js");
-// Show warning when user is accessing internal `_` properties.
-function getPublicProxy(obj, objName, propsPublic, expectCustomUserLandProps) {
-    if (!expectCustomUserLandProps) {
-        Object.keys(obj).forEach((key) => (0, assert_js_1.assert)(key.startsWith('_') || propsPublic.includes(key)));
-        propsPublic.forEach((prop) => prop in obj);
-    }
-    return new Proxy(obj, {
-        get(_, prop) {
-            const propStr = String(prop);
-            if (propStr.startsWith('_')) {
-                (0, assert_js_1.assertWarning)(false, `Using internal ${objName}.${propStr} which may break in any minor version update. Reach out on GitHub and elaborate your use case so that the Vike team can add official support for your use case.`, { onlyOnce: true });
-            }
-            // @ts-ignore Seems to be TypeScript bug
-            return Reflect.get(...arguments);
-        }
-    });
-}

package/dist/esm/client/shared/getPageContextProxyForUser.d.ts

@@ -1,2 +0,0 @@
-export { getPageContextProxyForUser };
-declare function getPageContextProxyForUser<PageContext extends Record<string, unknown>>(pageContext: PageContext): PageContext;

package/dist/esm/client/shared/getPageContextProxyForUser.js

@@ -1,14 +0,0 @@
-export { getPageContextProxyForUser };
-import { assertUsage, getPropAccessNotation } from '../server-routing-runtime/utils.js';
-import { NOT_SERIALIZABLE } from '../../shared/NOT_SERIALIZABLE.js';
-// Throw error when pageContext value isn't serializable
-function getPageContextProxyForUser(pageContext) {
-    return new Proxy(pageContext, {
-        get(_, prop) {
-            const val = pageContext[prop];
-            const propName = getPropAccessNotation(prop);
-            assertUsage(val !== NOT_SERIALIZABLE, `Can't access pageContext${propName} on the client side. Because it can't be serialized, see server logs.`);
-            return val;
-        }
-    });
-}

package/dist/esm/client/shared/preparePageContextForUserConsumptionClientSide.d.ts

@@ -1,12 +0,0 @@
-export { preparePageContextForUserConsumptionClientSide };
-export type { PageContextForUserConsumptionClientSide };
-import type { PageConfigUserFriendlyOld } from '../../shared/getPageFiles.js';
-import type { PageConfigRuntime } from '../../shared/page-configs/PageConfig.js';
-type PageContextForUserConsumptionClientSide = PageConfigUserFriendlyOld & {
-    pageId: string;
-    _hasPageContextFromServer: boolean;
-    _pageConfigs: PageConfigRuntime[];
-};
-declare function preparePageContextForUserConsumptionClientSide<T extends PageContextForUserConsumptionClientSide>(pageContext: T, isClientRouting: boolean): T & {
-    Page: unknown;
-};

package/dist/esm/client/shared/preparePageContextForUserConsumptionClientSide.js

@@ -1,44 +0,0 @@
-export { preparePageContextForUserConsumptionClientSide };
-import { assert, objectAssign } from '../server-routing-runtime/utils.js';
-import { getPageContextProxyForUser } from './getPageContextProxyForUser.js';
-import { preparePageContextForUserConsumption } from '../../shared/preparePageContextForUserConsumption.js';
-function preparePageContextForUserConsumptionClientSide(pageContext, isClientRouting) {
-    if (isClientRouting) {
-        const pageContextTyped = pageContext;
-        assert([true, false].includes(pageContextTyped.isHydration));
-        assert([true, false, null].includes(pageContextTyped.isBackwardNavigation));
-    }
-    else {
-        const pageContextTyped = pageContext;
-        assert(pageContextTyped.isHydration === true);
-        assert(pageContextTyped.isBackwardNavigation === null);
-    }
-    const Page = pageContext.config.Page ||
-        // TODO/next-major-release: remove
-        pageContext.exports.Page;
-    objectAssign(pageContext, { Page });
-    // TODO/next-major-release: remove
-    // - Requires https://github.com/vikejs/vike-vue/issues/198
-    // - Last time I tried to remove it (https://github.com/vikejs/vike/commit/705fd23598d9d69bf46a52c8550216cd7117ce71) the tests were failing as expected: only the Vue integrations that used shallowReactive() failed.
-    supportVueReactiviy(pageContext);
-    preparePageContextForUserConsumption(pageContext);
-    const pageContextProxy = getPageContextProxyForUser(pageContext);
-    return pageContextProxy;
-}
-// With Vue + Cient Routing, the `pageContext` is made reactive:
-// ```js
-// import { reactive } from 'vue'
-// // See /examples/vue-full/renderer/createVueApp.ts
-// const pageContextReactive = reactive(pageContext)
-// ```
-function supportVueReactiviy(pageContext) {
-    resolveGetters(pageContext);
-}
-// Remove propery descriptor getters because they break Vue's reactivity.
-// E.g. resolve the `pageContext.urlPathname` getter.
-function resolveGetters(pageContext) {
-    Object.entries(pageContext).forEach(([key, val]) => {
-        delete pageContext[key];
-        pageContext[key] = val;
-    });
-}

package/dist/esm/node/runtime/renderPage/preparePageContextForUserConsumptionServerSide.d.ts

@@ -1,24 +0,0 @@
-export { preparePageContextForUserConsumptionServerSide };
-export type { PageContextForUserConsumptionServerSide };
-import { PageContextUrlInternal } from '../../../shared/getPageContextUrlComputed.js';
-import type { PageConfigRuntime } from '../../../shared/page-configs/PageConfig.js';
-import type { PageConfigUserFriendlyOld } from '../../../shared/page-configs/getPageConfigUserFriendly.js';
-import { PageContextBuiltInServerInternal } from '../../../shared/types.js';
-import type { GlobalContextServerInternal, GlobalContextServer } from '../globalContext.js';
-type PageContextForUserConsumptionServerSide = PageContextBuiltInServerInternal & PageConfigUserFriendlyOld & {
-    urlOriginal: string;
-    /** @deprecated */
-    url: string;
-    urlPathname: string;
-    urlParsed: PageContextUrlInternal['urlParsed'];
-    routeParams: Record<string, string>;
-    Page: unknown;
-    pageId: string;
-    _pageConfigs: PageConfigRuntime[];
-    is404: null | boolean;
-    isClientSideNavigation: boolean;
-    pageProps?: Record<string, unknown>;
-    _globalContext: GlobalContextServerInternal;
-    globalContext: GlobalContextServer;
-} & Record<string, unknown>;
-declare function preparePageContextForUserConsumptionServerSide(pageContext: PageContextForUserConsumptionServerSide): void;

package/dist/esm/node/runtime/renderPage/preparePageContextForUserConsumptionServerSide.js

@@ -1,14 +0,0 @@
-export { preparePageContextForUserConsumptionServerSide };
-import { assert, isPlainObject } from '../utils.js';
-import { assertPageContextUrl } from '../../../shared/getPageContextUrlComputed.js';
-import { preparePageContextForUserConsumption } from '../../../shared/preparePageContextForUserConsumption.js';
-function preparePageContextForUserConsumptionServerSide(pageContext) {
-    assertPageContextUrl(pageContext);
-    assert(isPlainObject(pageContext.routeParams));
-    assert('Page' in pageContext);
-    assert(typeof pageContext.isClientSideNavigation === 'boolean');
-    assert(pageContext.isPageContext);
-    assert(pageContext.isClientSide === false);
-    assert(typeof pageContext.isPrerendering === 'boolean');
-    preparePageContextForUserConsumption(pageContext);
-}

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

@@ -1,14 +0,0 @@
-export { getPageConfigsRuntime };
-export { getAllPageIds };
-import type { PageFile } from './getPageFiles.js';
-import { type PageConfigUserFriendly, type PageConfigsUserFriendly } from './page-configs/getPageConfigUserFriendly.js';
-import type { PageConfigGlobalRuntime, PageConfigRuntime } from './page-configs/PageConfig.js';
-declare function getPageConfigsRuntime(virtualFileExports: unknown): {
-    pageFilesAll: PageFile[];
-    allPageIds: string[];
-    pageConfigs: PageConfigRuntime[];
-    pageConfigGlobal: PageConfigGlobalRuntime;
-    globalConfig: PageConfigUserFriendly;
-    pageConfigsUserFriendly: PageConfigsUserFriendly;
-};
-declare function getAllPageIds(pageFilesAll: PageFile[], pageConfigs: PageConfigRuntime[]): string[];

package/dist/esm/shared/getPageConfigsRuntime.js

@@ -1,21 +0,0 @@
-export { getPageConfigsRuntime };
-export { getAllPageIds };
-import { parseGlobResults } from './getPageFiles/parseGlobResults.js';
-import { getPageConfigGlobalUserFriendly, getPageConfigUserFriendly } from './page-configs/getPageConfigUserFriendly.js';
-import { unique } from './utils.js';
-function getPageConfigsRuntime(virtualFileExports) {
-    const { pageFilesAll, pageConfigs, pageConfigGlobal } = parseGlobResults(virtualFileExports);
-    const allPageIds = getAllPageIds(pageFilesAll, pageConfigs);
-    // TODO/now: re-use this call, instead of calling it twice
-    const globalConfig = getPageConfigGlobalUserFriendly({ pageConfigGlobalValues: pageConfigGlobal.configValues });
-    const pageConfigsUserFriendly = Object.fromEntries(pageConfigs.map((pageConfig) => {
-        return getPageConfigUserFriendly(pageConfigGlobal.configValues, pageConfig, pageConfig.configValues);
-    }));
-    return { pageFilesAll, allPageIds, pageConfigs, pageConfigGlobal, globalConfig, pageConfigsUserFriendly };
-}
-function getAllPageIds(pageFilesAll, pageConfigs) {
-    const fileIds = pageFilesAll.filter(({ isDefaultPageFile }) => !isDefaultPageFile).map(({ pageId }) => pageId);
-    const allPageIds = unique(fileIds);
-    const allPageIds2 = pageConfigs.map((p) => p.pageId);
-    return [...allPageIds, ...allPageIds2];
-}

package/dist/esm/shared/hooks/executeHook.d.ts

@@ -1,21 +0,0 @@
-export { executeHook };
-export { getPageContext };
-export { providePageContext };
-export { isUserHookError };
-import type { PageContextClient, PageContextServer } from '../types.js';
-import type { Hook, HookLoc } from './getHook.js';
-type PageContextUnknown = null | Record<string, any>;
-declare function isUserHookError(err: unknown): false | HookLoc;
-declare function executeHook<T = unknown>(hookFnCaller: () => T, hook: Omit<Hook, 'hookFn'>, pageContext: PageContextUnknown): Promise<T>;
-/**
- * Access `pageContext` object inside Vike hooks, in order to create universal hooks.
- *
- * https://vike.dev/getPageContext
- */
-declare function getPageContext<PageContext = PageContextClient | PageContextServer>(): null | PageContext;
-/**
- * Provide `pageContext` for universal hooks.
- *
- * https://vike.dev/getPageContext
- */
-declare function providePageContext(pageContext: PageContextUnknown): void;

package/dist/esm/shared/hooks/executeHook.js

@@ -1,85 +0,0 @@
-export { executeHook };
-export { getPageContext };
-export { providePageContext };
-export { isUserHookError };
-import { getProjectError, assertWarning } from '../../utils/assert.js';
-import { getGlobalObject } from '../../utils/getGlobalObject.js';
-import { humanizeTime } from '../../utils/humanizeTime.js';
-import { isObject } from '../../utils/isObject.js';
-const globalObject = getGlobalObject('utils/executeHook.ts', {
-    userHookErrors: new WeakMap(),
-    pageContext: null
-});
-function isUserHookError(err) {
-    if (!isObject(err))
-        return false;
-    return globalObject.userHookErrors.get(err) ?? false;
-}
-function executeHook(hookFnCaller, hook, pageContext) {
-    const { hookName, hookFilePath, hookTimeout: { error: timeoutErr, warning: timeoutWarn } } = hook;
-    let resolve;
-    let reject;
-    const promise = new Promise((resolve_, reject_) => {
-        resolve = (ret) => {
-            clearTimeouts();
-            resolve_(ret);
-        };
-        reject = (err) => {
-            clearTimeouts();
-            reject_(err);
-        };
-    });
-    const clearTimeouts = () => {
-        if (currentTimeoutWarn)
-            clearTimeout(currentTimeoutWarn);
-        if (currentTimeoutErr)
-            clearTimeout(currentTimeoutErr);
-    };
-    const currentTimeoutWarn = isNotDisabled(timeoutWarn) &&
-        setTimeout(() => {
-            assertWarning(false, `The ${hookName}() hook defined by ${hookFilePath} is slow: it's taking more than ${humanizeTime(timeoutWarn)} (https://vike.dev/hooksTimeout)`, { onlyOnce: false });
-        }, timeoutWarn);
-    const currentTimeoutErr = isNotDisabled(timeoutErr) &&
-        setTimeout(() => {
-            const err = getProjectError(`The ${hookName}() hook defined by ${hookFilePath} timed out: it didn't finish after ${humanizeTime(timeoutErr)} (https://vike.dev/hooksTimeout)`);
-            reject(err);
-        }, timeoutErr);
-    (async () => {
-        try {
-            providePageContext(pageContext);
-            const ret = await hookFnCaller();
-            resolve(ret);
-        }
-        catch (err) {
-            if (isObject(err)) {
-                globalObject.userHookErrors.set(err, { hookName, hookFilePath });
-            }
-            reject(err);
-        }
-    })();
-    return promise;
-}
-function isNotDisabled(timeout) {
-    return !!timeout && timeout !== Infinity;
-}
-/**
- * Access `pageContext` object inside Vike hooks, in order to create universal hooks.
- *
- * https://vike.dev/getPageContext
- */
-function getPageContext() {
-    return globalObject.pageContext;
-}
-/**
- * Provide `pageContext` for universal hooks.
- *
- * https://vike.dev/getPageContext
- */
-function providePageContext(pageContext) {
-    globalObject.pageContext = pageContext;
-    // Promise.resolve() is quicker than process.nextTick() and setImmediate()
-    // https://stackoverflow.com/questions/67949576/process-nexttick-before-promise-resolve-then
-    Promise.resolve().then(() => {
-        globalObject.pageContext = null;
-    });
-}

package/dist/esm/shared/hooks/executeHookGeneric.d.ts

@@ -1,8 +0,0 @@
-export { executeHookGeneric };
-export { executeHookGenericGlobalCumulative };
-import type { PageConfigUserFriendlyOld } from '../getPageFiles.js';
-import { type HookName } from './getHook.js';
-import type { HookNameGlobal } from '../page-configs/Config.js';
-import type { PageConfigGlobalRuntime } from '../page-configs/PageConfig.js';
-declare function executeHookGeneric(hookName: HookName, pageContext: PageConfigUserFriendlyOld): Promise<void>;
-declare function executeHookGenericGlobalCumulative(hookName: HookNameGlobal, pageConfigGlobal: PageConfigGlobalRuntime, pageContext: object | null, arg: object): Promise<void>;

package/dist/esm/shared/hooks/executeHookGeneric.js

@@ -1,16 +0,0 @@
-export { executeHookGeneric }; // TO-DO/refactor: start using executeHookGeneric() and, eventually, prominently use it
-export { executeHookGenericGlobalCumulative };
-import { executeHook } from './executeHook.js';
-import { getHookFromPageContext, getHookFromPageConfigGlobalCumulative } from './getHook.js';
-async function executeHookGeneric(hookName, pageContext) {
-    const hook = getHookFromPageContext(pageContext, hookName);
-    if (!hook)
-        return;
-    await executeHook(() => hook.hookFn(pageContext), hook, pageContext);
-}
-async function executeHookGenericGlobalCumulative(hookName, pageConfigGlobal, pageContext, arg) {
-    const hooks = getHookFromPageConfigGlobalCumulative(pageConfigGlobal, hookName);
-    await Promise.all(hooks.map(async (hook) => {
-        await executeHook(() => hook.hookFn(arg), hook, pageContext);
-    }));
-}

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

@@ -1,5 +0,0 @@
-export { preparePageContextForUserConsumption };
-import type { PageContextForUserConsumptionClientSide } from '../client/shared/preparePageContextForUserConsumptionClientSide.js';
-import type { PageContextForUserConsumptionServerSide } from '../node/runtime/renderPage/preparePageContextForUserConsumptionServerSide.js';
-type PageContextForUserConsumption = PageContextForUserConsumptionServerSide | PageContextForUserConsumptionClientSide;
-declare function preparePageContextForUserConsumption(pageContext: PageContextForUserConsumption): void;

package/dist/esm/shared/preparePageContextForUserConsumption.js

@@ -1,32 +0,0 @@
-export { preparePageContextForUserConsumption };
-import { assert, assertWarning, compareString } from './utils.js';
-import { addIs404ToPageProps } from './addIs404ToPageProps.js';
-function preparePageContextForUserConsumption(pageContext) {
-    assert(pageContext.pageId);
-    assert('config' in pageContext);
-    assert('configEntries' in pageContext);
-    addIs404ToPageProps(pageContext);
-    // TODO/next-major-release: remove
-    if (!('_pageId' in pageContext)) {
-        Object.defineProperty(pageContext, '_pageId', {
-            get() {
-                assertWarning(false, 'pageContext._pageId has been renamed to pageContext.pageId', {
-                    showStackTrace: true,
-                    onlyOnce: true
-                });
-                return pageContext.pageId;
-            },
-            enumerable: false
-        });
-    }
-    // For a more readable `console.log(pageContext)` output
-    sortPageContext(pageContext);
-}
-// Sort `pageContext` keys alphabetically, in order to make reading the `console.log(pageContext)` output easier
-function sortPageContext(pageContext) {
-    let descriptors = Object.getOwnPropertyDescriptors(pageContext);
-    for (const key of Object.keys(pageContext))
-        delete pageContext[key];
-    descriptors = Object.fromEntries(Object.entries(descriptors).sort(([key1], [key2]) => compareString(key1, key2)));
-    Object.defineProperties(pageContext, descriptors);
-}

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

@@ -1,2 +0,0 @@
-export { getPublicProxy };
-declare function getPublicProxy<Obj extends Record<string, unknown>, PropsPublic extends readonly (keyof Obj)[]>(obj: Obj, objName: string, propsPublic: PropsPublic, expectCustomUserLandProps?: true): Pick<Obj, PropsPublic[number]>;

package/dist/esm/utils/getPublicProxy.js

@@ -1,25 +0,0 @@
-export { getPublicProxy };
-// We use a proxy instead of property getters.
-// - The issue with property getters is that they can't be `writable: true` but we do want the user to be able to modify the value of internal properties.
-//   ```console
-//   TypeError: Invalid property descriptor. Cannot both specify accessors and a value or writable attribute, #<Object>
-//   ```
-// - Previous implementation using property getters: https://github.com/vikejs/vike/blob/main/vike/utils/makePublicCopy.ts
-import { assert, assertWarning } from './assert.js';
-// Show warning when user is accessing internal `_` properties.
-function getPublicProxy(obj, objName, propsPublic, expectCustomUserLandProps) {
-    if (!expectCustomUserLandProps) {
-        Object.keys(obj).forEach((key) => assert(key.startsWith('_') || propsPublic.includes(key)));
-        propsPublic.forEach((prop) => prop in obj);
-    }
-    return new Proxy(obj, {
-        get(_, prop) {
-            const propStr = String(prop);
-            if (propStr.startsWith('_')) {
-                assertWarning(false, `Using internal ${objName}.${propStr} which may break in any minor version update. Reach out on GitHub and elaborate your use case so that the Vike team can add official support for your use case.`, { onlyOnce: true });
-            }
-            // @ts-ignore Seems to be TypeScript bug
-            return Reflect.get(...arguments);
-        }
-    });
-}