vike 0.4.247 → 0.4.249-commit-775a43e

package/dist/esm/shared/route/abort.d.ts

@@ -1,120 +0,0 @@
-export { redirect };
-export { render };
-export { RenderErrorPage };
-export { isAbortError };
-export { isAbortPageContext };
-export { logAbortErrorHandled };
-export { getPageContextFromAllRewrites };
-export { AbortRender };
-export { assertNoInfiniteAbortLoop };
-export type { RedirectStatusCode };
-export type { AbortStatusCode };
-export type { ErrorAbort };
-export type { PageContextFromRewrite };
-export type { UrlRedirect };
-export type { PageContextAbort };
-type RedirectStatusCode = number & Parameters<typeof redirect>[1];
-type AbortStatusCode = number & Parameters<InferTwoOverloads<typeof render>[0]>[0];
-type UrlRedirect = {
-    url: string;
-    statusCode: RedirectStatusCode;
-};
-type AbortRedirect = Error;
-type AbortReason = Required<({
-    abortReason?: unknown;
-} & Vike.PageContext)['abortReason']>;
-/**
- * Abort the rendering of the current page, and redirect the user to another URL instead.
- *
- * https://vike.dev/redirect
- *
- * @param url The URL to redirect to.
- * @param statusCode By default a temporary redirection (`302`) is performed. For permanent redirections (`301`), use `config.redirects` https://vike.dev/redirects instead or, alternatively, set the `statusCode` argument to `301`.
- */
-declare function redirect(url: string, statusCode?: 301 | 302): AbortRedirect;
-/**
- * Abort the rendering of the current page, and render the error page instead.
- *
- * https://vike.dev/render
- *
- *
- * **Recommended** status codes:
- *   `401` — Unauthorized (user isn't logged in)
- *   `403` — Forbidden (user is logged in but isn't allowed)
- *   `404` — Not Found
- *   `410` — Gone (use this instead of `404` if the page existed in the past, see https://github.com/vikejs/vike/issues/1097#issuecomment-1695260887)
- *   `429` — Too Many Requests (rate limiting)
- *   `500` — Internal Server Error (your client or server has a bug)
- *   `503` — Service Unavailable (server is overloaded, or a third-party API isn't responding)
- *
- * **Not recommended** status codes:
- *   `400` — See https://github.com/vikejs/vike/issues/1008#issuecomment-3270894445
- *   Other status codes — See https://github.com/vikejs/vike/issues/1008
- *
- * @param abortStatusCode - One of the recommended status codes listed above.
- *
- * @param abortReason - Sets `pageContext.abortReason` which is usually used by the error page to show a message to the user, see https://vike.dev/error-page
- */
-declare function render(abortStatusCode: 401 | 403 | 404 | 410 | 429 | 500 | 503, abortReason?: AbortReason): Error;
-/**
- * Abort the rendering of the current page, and render another page instead.
- *
- * https://vike.dev/render
- *
- * @param url The URL to render.
- * @param abortReason Sets `pageContext.abortReason` which is used by the error page to show a message to the user, see https://vike.dev/error-page
- */
-declare function render(url: `/${string}`, abortReason?: AbortReason): Error;
-type AbortCall = `redirect(${string})` | `render(${string})` | `RenderErrorPage()`;
-type AbortCaller = `throw redirect()` | `throw render()` | `throw RenderErrorPage()`;
-type PageContextAbort = {
-    _abortCall: AbortCall;
-    _abortCaller: AbortCaller;
-} & (({
-    _abortCall: `redirect(${string})`;
-    _abortCaller: 'throw redirect()';
-    _urlRedirect: UrlRedirect;
-} & Omit<AbortUndefined, '_urlRedirect'>) | ({
-    _abortCall: `render(${string})` | `RenderErrorPage()`;
-    _abortCaller: 'throw render()' | 'throw RenderErrorPage()';
-    abortReason: undefined | unknown;
-    _urlRewrite: string;
-} & Omit<AbortUndefined, '_urlRewrite'>) | ({
-    _abortCall: `render(${string})` | `RenderErrorPage()`;
-    _abortCaller: 'throw render()' | 'throw RenderErrorPage()';
-    abortReason: undefined | unknown;
-    abortStatusCode: number;
-} & Omit<AbortUndefined, 'abortStatusCode'>));
-type AbortUndefined = {
-    _urlRedirect?: undefined;
-    _urlRewrite?: undefined;
-    abortStatusCode?: undefined;
-};
-declare function AbortRender(pageContextAbort: PageContextAbort): Error;
-/**
- * @deprecated Use `throw render()` or `throw redirect()` instead, see https://vike.dev/render'
- */
-declare function RenderErrorPage({ pageContext }?: {
-    pageContext?: Record<string, unknown>;
-}): Error;
-type ErrorAbort = {
-    _pageContextAbort: PageContextAbort;
-};
-declare function isAbortError(thing: unknown): thing is ErrorAbort;
-declare function isAbortPageContext(pageContext: Record<string, unknown>): pageContext is PageContextAbort;
-declare function logAbortErrorHandled(err: ErrorAbort, isProduction: boolean, pageContext: {
-    urlOriginal: string;
-    _urlRewrite: null | string;
-}): void;
-type PageContextFromRewrite = {
-    _urlRewrite: string;
-};
-type PageContextFromAllRewrites = {
-    _urlRewrite: null | string;
-};
-declare function getPageContextFromAllRewrites(pageContextsFromRewrite: PageContextFromRewrite[]): PageContextFromAllRewrites;
-declare function assertNoInfiniteAbortLoop(rewriteCount: number, redirectCount: number): void;
-type InferTwoOverloads<F extends Function> = F extends {
-    (...a1: infer A1): infer R1;
-    (...a0: infer A0): infer R0;
-} ? [(...a1: A1) => R1, (...a0: A0) => R0] : never;

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

@@ -1,213 +0,0 @@
-export { redirect };
-export { render };
-export { RenderErrorPage };
-export { isAbortError };
-export { isAbortPageContext };
-export { logAbortErrorHandled };
-export { getPageContextFromAllRewrites };
-export { AbortRender };
-export { assertNoInfiniteAbortLoop };
-import { isUserHookError } from '../hooks/execHook.js';
-import { assert, assertInfo, assertUsage, assertUsageUrlPathAbsolute, assertUsageUrlRedirectTarget, assertWarning, checkType, hasProp, isBrowser, joinEnglish, objectAssign, truncateString, } from './utils.js';
-import pc from '@brillout/picocolors';
-/**
- * Abort the rendering of the current page, and redirect the user to another URL instead.
- *
- * https://vike.dev/redirect
- *
- * @param url The URL to redirect to.
- * @param statusCode By default a temporary redirection (`302`) is performed. For permanent redirections (`301`), use `config.redirects` https://vike.dev/redirects instead or, alternatively, set the `statusCode` argument to `301`.
- */
-function redirect(url, statusCode) {
-    const abortCaller = 'throw redirect()';
-    assertUsageUrlRedirectTarget(url, getErrPrefix(abortCaller));
-    const args = [JSON.stringify(url)];
-    if (!statusCode) {
-        statusCode = 302;
-    }
-    else {
-        if (
-        // Tree-shaking to save client-side KBs
-        !globalThis.__VIKE__IS_CLIENT ||
-            globalThis.__VIKE__IS_DEV ||
-            globalThis.__VIKE__IS_DEBUG) {
-            assertStatusCode(statusCode, [301, 302], 'redirect');
-        }
-        args.push(String(statusCode));
-    }
-    const pageContextAbort = {};
-    objectAssign(pageContextAbort, {
-        _abortCaller: abortCaller,
-        _abortCall: `redirect(${args.join(', ')})`,
-        _urlRedirect: {
-            url,
-            statusCode,
-        },
-    });
-    return AbortRender(pageContextAbort);
-}
-function render(urlOrStatusCode, abortReason) {
-    const args = [typeof urlOrStatusCode === 'number' ? String(urlOrStatusCode) : JSON.stringify(urlOrStatusCode)];
-    if (abortReason !== undefined)
-        args.push(truncateString(JSON.stringify(abortReason), 30));
-    const abortCaller = 'throw render()';
-    const abortCall = `render(${args.join(', ')})`;
-    return render_(urlOrStatusCode, abortReason, abortCall, abortCaller);
-}
-function render_(urlOrStatusCode, abortReason, abortCall, abortCaller, pageContextAddendum) {
-    const pageContextAbort = {
-        abortReason,
-        _abortCaller: abortCaller,
-        _abortCall: abortCall,
-    };
-    if (pageContextAddendum) {
-        assert(pageContextAddendum._isLegacyRenderErrorPage === true);
-        objectAssign(pageContextAbort, pageContextAddendum);
-    }
-    if (typeof urlOrStatusCode === 'string') {
-        const url = urlOrStatusCode;
-        assertUsageUrlPathAbsolute(url, getErrPrefix(abortCaller));
-        objectAssign(pageContextAbort, {
-            _urlRewrite: url,
-        });
-        return AbortRender(pageContextAbort);
-    }
-    else {
-        if (
-        // Tree-shaking to save client-side KBs
-        !globalThis.__VIKE__IS_CLIENT ||
-            globalThis.__VIKE__IS_DEV ||
-            globalThis.__VIKE__IS_DEBUG) {
-            assertStatusCode(urlOrStatusCode, [401, 403, 404, 410, 429, 500, 503], 'render');
-        }
-        const abortStatusCode = urlOrStatusCode;
-        objectAssign(pageContextAbort, {
-            abortStatusCode,
-            is404: abortStatusCode === 404,
-        });
-        return AbortRender(pageContextAbort);
-    }
-}
-function AbortRender(pageContextAbort) {
-    const err = new Error('AbortRender');
-    objectAssign(err, { _pageContextAbort: pageContextAbort, [stamp]: true });
-    checkType(err);
-    return err;
-}
-// TO-DO/next-major-release: remove
-/**
- * @deprecated Use `throw render()` or `throw redirect()` instead, see https://vike.dev/render'
- */
-function RenderErrorPage({ pageContext = {} } = {}) {
-    assertWarning(false, `${pc.cyan('throw RenderErrorPage()')} is deprecated and will be removed in the next major release. Use ${pc.cyan('throw render()')} or ${pc.cyan('throw redirect()')} instead, see https://vike.dev/render`, { onlyOnce: false });
-    let abortStatusCode = 404;
-    let abortReason = 'Page Not Found';
-    if (pageContext.is404 === false || pageContext.pageProps?.is404 === false) {
-        abortStatusCode = 500;
-        abortReason = 'Something went wrong';
-    }
-    objectAssign(pageContext, { _isLegacyRenderErrorPage: true });
-    return render_(abortStatusCode, abortReason, 'RenderErrorPage()', 'throw RenderErrorPage()', pageContext);
-}
-const stamp = '_isAbortError';
-function isAbortError(thing) {
-    return typeof thing === 'object' && thing !== null && stamp in thing;
-}
-function isAbortPageContext(pageContext) {
-    if (!(pageContext._urlRewrite || pageContext._urlRedirect || pageContext.abortStatusCode)) {
-        return false;
-    }
-    assert(hasProp(pageContext, '_abortCall', 'string'));
-    /* Isn't needed and is missing on the client-side
-    assert(hasProp(pageContext, '_abortCaller', 'string'))
-    */
-    checkType(pageContext);
-    return true;
-}
-function logAbortErrorHandled(err, isProduction, pageContext) {
-    if (isProduction)
-        return;
-    const urlCurrent = pageContext._urlRewrite ?? pageContext.urlOriginal;
-    assert(urlCurrent);
-    const abortCall = err._pageContextAbort._abortCall;
-    assert(abortCall);
-    const hookLoc = isUserHookError(err);
-    let thrownBy = '';
-    if (hookLoc) {
-        thrownBy = ` by ${pc.cyan(`${hookLoc.hookName}()`)} hook defined at ${hookLoc.hookFilePath}`;
-    }
-    else {
-        // hookLoc is missing when serializing abort errors from server to client
-    }
-    assertInfo(false, `${pc.cyan(abortCall)} thrown${thrownBy} while rendering ${pc.cyan(urlCurrent)}`, {
-        onlyOnce: false,
-    });
-}
-function assertStatusCode(statusCode, expected, caller) {
-    assert(!globalThis.__VIKE__IS_CLIENT || globalThis.__VIKE__IS_DEV || globalThis.__VIKE__IS_DEBUG); // assert tree-shaking
-    // double check vike:pluginReplaceConstantsGlobalThis
-    if (globalThis.__VIKE__IS_CLIENT) {
-        assert(isBrowser());
-        assert(typeof globalThis.__VIKE__IS_DEV === 'boolean');
-        assert(typeof globalThis.__VIKE__IS_CLIENT === 'boolean');
-        assert(import.meta.env.SSR === false);
-        assert(import.meta.env.DEV === globalThis.__VIKE__IS_DEV);
-    }
-    else {
-        assert(!isBrowser());
-        if (import.meta.env) {
-            assert(typeof globalThis.__VIKE__IS_DEV === 'boolean');
-            assert(typeof globalThis.__VIKE__IS_CLIENT === 'boolean');
-            assert(import.meta.env.SSR === true);
-            assert(import.meta.env.DEV === globalThis.__VIKE__IS_DEV);
-        }
-        else {
-            // import.meta.env isn't defined when 'vike' is ssr.external
-        }
-    }
-    const expectedEnglish = joinEnglish(expected.map((s) => pc.bold(String(s))), 'or');
-    const statusCodeWithColor = pc.bold(String(statusCode));
-    if (statusCode === 400) {
-        assert(!expected.includes(statusCode));
-        assertWarning(false, `We recommend against using the status code ${statusCodeWithColor} passed to ${caller}() — we recommend using ${pc.bold('404')} instead, see https://github.com/vikejs/vike/issues/1008#issuecomment-3270894445`, { onlyOnce: true, showStackTrace: true });
-    }
-    else {
-        assertWarning(expected.includes(statusCode), `Unexpected status code ${statusCodeWithColor} passed to ${caller}() — we recommend using ${expectedEnglish} instead. (Or reach out at https://github.com/vikejs/vike/issues/1008 if you believe ${statusCodeWithColor} should be added.)`, { onlyOnce: true, showStackTrace: true });
-    }
-}
-function getPageContextFromAllRewrites(pageContextsFromRewrite) {
-    assertNoInfiniteLoop(pageContextsFromRewrite);
-    const pageContextFromAllRewrites = { _urlRewrite: null };
-    pageContextsFromRewrite.forEach((pageContextFromRewrite) => {
-        Object.assign(pageContextFromAllRewrites, pageContextFromRewrite);
-    });
-    return pageContextFromAllRewrites;
-}
-function assertNoInfiniteLoop(pageContextsFromRewrite) {
-    const urlRewrites = [];
-    pageContextsFromRewrite.forEach((pageContext) => {
-        const urlRewrite = pageContext._urlRewrite;
-        {
-            const idx = urlRewrites.indexOf(urlRewrite);
-            if (idx !== -1) {
-                const loop = [...urlRewrites.slice(idx), urlRewrite].map((url) => `render('${url}')`).join(' => ');
-                assertUsage(false, `Infinite loop of render() calls: ${loop}`);
-            }
-        }
-        urlRewrites.push(urlRewrite);
-    });
-}
-function assertNoInfiniteAbortLoop(rewriteCount, redirectCount) {
-    const abortCalls = [
-        // prettier-ignore
-        // biome-ignore format:
-        rewriteCount > 0 && pc.cyan("throw render('/some-url')"),
-        redirectCount > 0 && pc.cyan("throw redirect('/some-url')"),
-    ]
-        .filter(Boolean)
-        .join(' and ');
-    assertUsage(rewriteCount + redirectCount <= 7, `Maximum chain length of 7 ${abortCalls} exceeded. Did you define an infinite loop of ${abortCalls}?`);
-}
-function getErrPrefix(abortCaller) {
-    return `URL passed to ${pc.code(abortCaller)}`;
-}