vike
Version:
The Framework *You* Control - Next.js & Nuxt alternative for unprecedented flexibility and dependability.
101 lines (100 loc) • 4.53 kB
JavaScript
// TODO:v1-release: remove this file
export { getPageFilesClientSide };
export { getPageFilesServerSide };
import { assert, assertUsage, isNotNullish } from '../utils.js';
function getPageFilesClientSide(pageFilesAll, pageId) {
return determine(pageFilesAll, pageId, true);
}
function getPageFilesServerSide(pageFilesAll, pageId) {
return determine(pageFilesAll, pageId, false);
}
function determine(pageFilesAll, pageId, envIsClient) {
const env = envIsClient ? 'CLIENT_ONLY' : 'SERVER_ONLY';
const pageFilesRelevant = pageFilesAll
.filter((p) => p.isRelevant(pageId) && p.fileType !== '.page.route')
.sort(getPageFilesSorter(envIsClient, pageId));
// Load the `.page.js` files specific to `pageId`
const getPageIdFile = (iso) => {
const files = pageFilesRelevant.filter((p) => p.pageId === pageId && p.isEnv(iso ? 'CLIENT_AND_SERVER' : env));
assertUsage(files.length <= 1, `Merge the following files into a single file: ${files.map((p) => p.filePath).join(' ')}`);
const pageIdFile = files[0];
assert(pageIdFile === undefined || !pageIdFile.isDefaultPageFile);
return pageIdFile;
};
const pageIdFileEnv = getPageIdFile(false);
const pageIdFileIso = getPageIdFile(true);
// A page can have only one renderer. In other words: Multiple `renderer/` overwrite each other.
// Load only load renderer (`/renderer/_default.*`)
const getRendererFile = (iso) => pageFilesRelevant.filter((p) => p.isRendererPageFile && p.isEnv(iso ? 'CLIENT_AND_SERVER' : env))[0];
const rendererFileEnv = getRendererFile(false);
const rendererFileIso = getRendererFile(true);
// A page can load multiple `_default.page.*` files of the same `fileType`. In other words: non-renderer `_default.page.*` files are cumulative.
// The exception being HTML-only pages because we pick a single page file as client entry. We handle that use case at `renderPage()`.
const defaultFilesNonRenderer = pageFilesRelevant.filter((p) => p.isDefaultPageFile && !p.isRendererPageFile && (p.isEnv(env) || p.isEnv('CLIENT_AND_SERVER')));
// Ordered by `pageContext.exports` precedence
const pageFiles = [pageIdFileEnv, pageIdFileIso, ...defaultFilesNonRenderer, rendererFileEnv, rendererFileIso].filter(isNotNullish);
return pageFiles;
}
function getPageFilesSorter(envIsClient, pageId) {
const env = envIsClient ? 'CLIENT_ONLY' : 'SERVER_ONLY';
const e1First = -1;
const e2First = +1;
const noOrder = 0;
return (e1, e2) => {
// `.page.js` files specific to `pageId` first
if (!e1.isDefaultPageFile && e2.isDefaultPageFile) {
return e1First;
}
if (!e2.isDefaultPageFile && e1.isDefaultPageFile) {
return e2First;
}
// Non-renderer `_default.page.*` before `renderer/**/_default.page.*`
{
const e1_isRenderer = e1.isRendererPageFile;
const e2_isRenderer = e2.isRendererPageFile;
if (!e1_isRenderer && e2_isRenderer) {
return e1First;
}
if (!e2_isRenderer && e1_isRenderer) {
return e2First;
}
assert(e1_isRenderer === e2_isRenderer);
}
// Filesystem nearest first
{
const e1_distance = getPathDistance(pageId, e1.filePath);
const e2_distance = getPathDistance(pageId, e2.filePath);
if (e1_distance < e2_distance) {
return e1First;
}
if (e2_distance < e1_distance) {
return e2First;
}
assert(e1_distance === e2_distance);
}
// `.page.server.js`/`.page.client.js` before `.page.js`
{
if (e1.isEnv(env) && e2.isEnv('CLIENT_AND_SERVER')) {
return e1First;
}
if (e2.isEnv(env) && e1.isEnv('CLIENT_AND_SERVER')) {
return e2First;
}
}
return noOrder;
};
}
function getPathDistance(pathA, pathB) {
// Index of first different character
let idx = 0;
for (; idx < pathA.length && idx < pathB.length; idx++) {
if (pathA[idx] !== pathB[idx])
break;
}
const pathAWithoutCommon = pathA.slice(idx);
const pathBWithoutCommon = pathB.slice(idx);
const distanceA = pathAWithoutCommon.split('/').length;
const distanceB = pathBWithoutCommon.split('/').length;
const distance = distanceA + distanceB;
return distance;
}