@shuvi/platform-shared 1.0.0-rc.0

package/lib/node/platform/plugins/main/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const service_1 = require("@shuvi/service");
+const paths_1 = require("../../../paths");
+const hooks_1 = require("./hooks");
+const core = (0, service_1.createPlugin)({
+    setup: ({ addHooks }) => {
+        addHooks(hooks_1.extendedHooks);
+    },
+    addRuntimeService: () => [
+        {
+            // must be export separately, we need the module path to always be the
+            // same as what we've defined in
+            // "packages/toolpack/src/webpack/config/parts/external.ts"
+            source: (0, paths_1.resolvePkgFile)('lib/shared/shuvi-singleton-runtimeConfig'),
+            exported: '{ getRuntimeConfig }'
+        },
+        {
+            source: (0, paths_1.resolvePkgFile)('esm/shuvi-app/shuvi-runtime-index'),
+            exported: '*'
+        },
+        {
+            source: (0, paths_1.resolvePkgFile)('esm/shuvi-app/shuvi-runtime-app'),
+            filepath: 'app.ts',
+            exported: '*'
+        }
+    ]
+});
+exports.default = {
+    core,
+    types: (0, paths_1.resolvePkgFile)('lib/node/platform/plugins/main/shuvi-app.d.ts')
+};

package/lib/node/platform/plugins/main/shuvi-app.d.ts

@@ -0,0 +1,8 @@
+import { extendedHooks } from './hooks';
+declare module '@shuvi/runtime' {
+    interface CustomCorePluginHooks {
+        addEntryCode: typeof extendedHooks.addEntryCode;
+        addPolyfill: typeof extendedHooks.addPolyfill;
+        modifyRuntimeConfig: typeof extendedHooks.modifyRuntimeConfig;
+    }
+}

package/lib/node/platform/plugins/main/shuvi-app.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/node/platform/runtimeFiles.d.ts

@@ -0,0 +1,11 @@
+import { IPluginContext } from '@shuvi/service';
+export declare const getRuntimeConfigFromConfig: (pluginContext: IPluginContext) => Promise<{
+    public: import("@shuvi/service/lib/core/apiTypes").IRuntimeConfig;
+    server: import("@shuvi/service/lib/core/apiTypes").IRuntimeConfig;
+}>;
+/**
+ * A creator for `getPresetRuntimeFiles` which helps platforms to build a bunch of runtime files including
+ * `core/error`, `core/platform`, `core/plugins`, `core/polyfill`, `core/runtimeConfig`, `core/setRuntimeConfig`,
+ * `user/error`, `user/runtime` and `entry`
+ */
+export declare const getPresetRuntimeFilesCreator: (platformModule: string, polyfills: string[]) => (pluginContext: IPluginContext) => Promise<import("@shuvi/service/lib/project").FileOptions<any, any>[]>;

package/lib/node/platform/runtimeFiles.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPresetRuntimeFilesCreator = exports.getRuntimeConfigFromConfig = void 0;
+const project_1 = require("@shuvi/service/lib/project");
+const projectContext_1 = require("../project/projectContext");
+const file_presets_1 = require("../project/file-presets");
+const getRuntimeConfigFromConfig = (pluginContext) => __awaiter(void 0, void 0, void 0, function* () {
+    const { pluginRunner, config } = pluginContext;
+    return yield pluginRunner.modifyRuntimeConfig({
+        public: config.publicRuntimeConfig || {},
+        server: config.runtimeConfig || {}
+    });
+});
+exports.getRuntimeConfigFromConfig = getRuntimeConfigFromConfig;
+/**
+ * A creator for `getPresetRuntimeFiles` which helps platforms to build a bunch of runtime files including
+ * `core/error`, `core/platform`, `core/plugins`, `core/polyfill`, `core/runtimeConfig`, `core/setRuntimeConfig`,
+ * `user/error`, `user/runtime` and `entry`
+ */
+const getPresetRuntimeFilesCreator = (platformModule, polyfills) => (pluginContext) => __awaiter(void 0, void 0, void 0, function* () {
+    const getCandidates = (fileName, fallbackType) => project_1.fileUtils.getUserCustomFileCandidates(pluginContext.paths.rootDir, fileName, fallbackType);
+    const context = (0, projectContext_1.createProjectContext)();
+    context.userModule = {
+        error: getCandidates('error', 'nullish'),
+        app: getCandidates('app', 'noop')
+    };
+    context.platformModule = platformModule;
+    const { public: publicRuntimeConfig, server: serverRuntimeConfig } = yield (0, exports.getRuntimeConfigFromConfig)(pluginContext);
+    context.runtimeConfig = Object.assign(Object.assign({}, serverRuntimeConfig), publicRuntimeConfig);
+    const runner = pluginContext.pluginRunner;
+    const appPolyfills = (yield runner.addPolyfill()).flat();
+    const appEntryCodes = (yield runner.addEntryCode()).flat();
+    context.entryCodes.push(...appEntryCodes);
+    context.polyfills.push(...polyfills, ...appPolyfills);
+    const files = (0, file_presets_1.getFilePresets)(context);
+    return files;
+});
+exports.getPresetRuntimeFilesCreator = getPresetRuntimeFilesCreator;

package/lib/node/project/file-presets/files/app/core/entry.js.d.ts

@@ -0,0 +1,3 @@
+import { ProjectContext } from '../../../../projectContext';
+declare const _default: (context: ProjectContext) => Omit<import("@shuvi/service/lib/project").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/core/entry.js.js

@@ -0,0 +1,52 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const project_1 = require("@shuvi/service/lib/project");
+const __1 = require("../../..");
+const os = __importStar(require("os"));
+exports.default = (context) => (0, __1.defineFile)({
+    content: () => {
+        const codes = context.entryCodes;
+        let imports = '';
+        let body = '';
+        for (let index = 0; index < codes.length; index++) {
+            const code = codes[index];
+            const snippet = project_1.fileUtils.getCodeSnippet(code);
+            if (snippet.imports) {
+                imports += `${snippet.imports}${os.EOL}`;
+            }
+            if (snippet.body) {
+                body += `${snippet.body}${os.EOL}`;
+            }
+        }
+        const content = `${imports}${os.EOL}${body}`;
+        if (content.trim() === '') {
+            return '// empty entry';
+        }
+        else {
+            return content;
+        }
+    }
+});

package/lib/node/project/file-presets/files/app/core/error.js.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Omit<import("@shuvi/service/lib/project/index").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/core/error.js.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../../..");
+const content = `import userError from '@shuvi/app/user/error'
+export default userError
+`;
+exports.default = () => (0, __1.defineFile)({
+    content: () => content
+});

package/lib/node/project/file-presets/files/app/core/platform.js.d.ts

@@ -0,0 +1,3 @@
+import { ProjectContext } from '../../../../projectContext';
+declare const _default: (context: ProjectContext) => Omit<import("@shuvi/service/lib/project").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/core/platform.js.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../../..");
+const project_1 = require("@shuvi/service/lib/project");
+exports.default = (context) => (0, __1.defineFile)({
+    content: () => {
+        return project_1.fileUtils.getModuleExport(context.platformModule);
+    }
+});

package/lib/node/project/file-presets/files/app/core/polyfill.js.d.ts

@@ -0,0 +1,3 @@
+import { ProjectContext } from '../../../../projectContext';
+declare const _default: (context: ProjectContext) => Omit<import("@shuvi/service/lib/project/index").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/core/polyfill.js.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../../..");
+exports.default = (context) => (0, __1.defineFile)({
+    content: () => context.polyfills.map(file => `import "${file}"`).join('\n')
+});

package/lib/node/project/file-presets/files/app/core/runtimeConfig.js.d.ts

@@ -0,0 +1,3 @@
+import { ProjectContext } from '../../../../projectContext';
+declare const _default: (context: ProjectContext) => Omit<import("@shuvi/service/lib/project/index").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/core/runtimeConfig.js.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../../..");
+const shuvi_singleton_runtimeConfig_1 = require("../../../../../../shared/shuvi-singleton-runtimeConfig");
+exports.default = (context) => (0, __1.defineFile)({
+    content: () => {
+        const runtimeConfigContent = (0, shuvi_singleton_runtimeConfig_1.getPublicRuntimeConfig)()
+            ? JSON.stringify((0, shuvi_singleton_runtimeConfig_1.getPublicRuntimeConfig)())
+            : null;
+        return `export default ${runtimeConfigContent}`;
+    }
+});

package/lib/node/project/file-presets/files/app/core/setPublicRuntimeConfig.js.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Omit<import("@shuvi/service/lib/project/index").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/core/setPublicRuntimeConfig.js.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../../..");
+const paths_1 = require("../../../../../paths");
+exports.default = () => (0, __1.defineFile)({
+    content: () => `export { setPublicRuntimeConfig as default } from '${(0, paths_1.resolvePkgFile)('lib/shared/shuvi-singleton-runtimeConfig')}'`
+});

package/lib/node/project/file-presets/files/app/core/setRuntimeConfig.js.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Omit<import("@shuvi/service/lib/project/index").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/core/setRuntimeConfig.js.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../../..");
+const paths_1 = require("../../../../../paths");
+exports.default = () => (0, __1.defineFile)({
+    content: () => `export { setRuntimeConfig as default } from '${(0, paths_1.resolvePkgFile)('lib/shared/shuvi-singleton-runtimeConfig')}'`
+});

package/lib/node/project/file-presets/files/app/user/app.js.d.ts

@@ -0,0 +1,3 @@
+import { ProjectContext } from '../../../../projectContext';
+declare const _default: (context: ProjectContext) => Omit<import("@shuvi/service/lib/project").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/user/app.js.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const project_1 = require("@shuvi/service/lib/project");
+const __1 = require("../../..");
+const { getAllFiles, getFirstModuleExport } = project_1.fileUtils;
+exports.default = (context) => {
+    const { app } = context.userModule;
+    const candidates = Array.isArray(app) ? app : [app];
+    return (0, __1.defineFile)({
+        dependencies: candidates,
+        content: () => {
+            return getFirstModuleExport(getAllFiles(candidates), candidates);
+        }
+    });
+};

package/lib/node/project/file-presets/files/app/user/error.js.d.ts

@@ -0,0 +1,3 @@
+import { ProjectContext } from '../../../../projectContext';
+declare const _default: (context: ProjectContext) => Omit<import("@shuvi/service/lib/project").DefineFileOption, "name">;
+export default _default;

package/lib/node/project/file-presets/files/app/user/error.js.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const project_1 = require("@shuvi/service/lib/project");
+const __1 = require("../../..");
+const { getAllFiles, getFirstModuleExport } = project_1.fileUtils;
+exports.default = (context) => {
+    const { error } = context.userModule;
+    const candidates = Array.isArray(error) ? error : [error];
+    return (0, __1.defineFile)({
+        dependencies: candidates,
+        content: () => {
+            return getFirstModuleExport(getAllFiles(candidates), candidates, true);
+        }
+    });
+};

package/lib/node/project/file-presets/index.d.ts

@@ -0,0 +1,4 @@
+import { FileOptions, DefineFileOption } from '@shuvi/service/lib/project';
+import { ProjectContext } from '../projectContext';
+export declare function getFilePresets(context: ProjectContext): FileOptions[];
+export declare const defineFile: (options: Omit<DefineFileOption, 'name'>) => Omit<DefineFileOption, "name">;

package/lib/node/project/file-presets/index.js

@@ -0,0 +1,58 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineFile = exports.getFilePresets = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const project_1 = require("@shuvi/service/lib/project");
+const EXT_REGEXP = /\.[a-zA-Z]+$/;
+/**
+ * All preset files are listed in `files` folder as real files arrange.
+ * These presets export objects as FileOptions with which fileManager will generate files.
+ */
+const getAllFiles = (context, dirPath, parent = '', fileList = []) => {
+    const files = fs.readdirSync(dirPath);
+    let currentFileList = fileList;
+    files.forEach((file) => {
+        const filepath = path.join(dirPath, file);
+        const name = path.join(parent, file.replace(EXT_REGEXP, ''));
+        if (fs.statSync(filepath).isDirectory()) {
+            currentFileList = getAllFiles(context, filepath, name, currentFileList);
+            // Match *.ts (source) or *.js (compiled) file, but ignore *.d.ts file
+        }
+        else if (/\.(js|ts)$/.test(file) && !/\.d\.ts$/.test(file)) {
+            const fileOptionsCreater = require(filepath).default;
+            const options = fileOptionsCreater(context);
+            currentFileList.push((0, project_1.defineFile)(Object.assign(Object.assign({}, options), { name })));
+        }
+    });
+    return currentFileList;
+};
+function getFilePresets(context) {
+    return getAllFiles(context, path.join(__dirname, 'files'));
+}
+exports.getFilePresets = getFilePresets;
+const defineFile = (options) => options;
+exports.defineFile = defineFile;

package/lib/node/project/index.d.ts

@@ -0,0 +1,2 @@
+export { getFilePresets } from './file-presets';
+export { createProjectContext } from './projectContext';

package/lib/node/project/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProjectContext = exports.getFilePresets = void 0;
+var file_presets_1 = require("./file-presets");
+Object.defineProperty(exports, "getFilePresets", { enumerable: true, get: function () { return file_presets_1.getFilePresets; } });
+var projectContext_1 = require("./projectContext");
+Object.defineProperty(exports, "createProjectContext", { enumerable: true, get: function () { return projectContext_1.createProjectContext; } });

package/lib/node/project/projectContext.d.ts

@@ -0,0 +1,13 @@
+import { IRuntimeConfig } from '@shuvi/service/lib/core';
+export interface UserModule {
+    app: string | string[];
+    error: string | string[];
+}
+export interface ProjectContext {
+    entryCodes: string[];
+    polyfills: string[];
+    runtimeConfig: IRuntimeConfig;
+    platformModule: string;
+    userModule: UserModule;
+}
+export declare const createProjectContext: () => ProjectContext;

package/lib/node/project/projectContext.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProjectContext = void 0;
+const createProjectContext = () => {
+    return {
+        entryCodes: [],
+        polyfills: [],
+        runtimeConfig: {},
+        platformModule: '',
+        userModule: {
+            app: '',
+            error: ''
+        }
+    };
+};
+exports.createProjectContext = createProjectContext;

package/lib/node/route/helpers.d.ts

@@ -0,0 +1,20 @@
+import { IApiRouteConfig, IMiddlewareRouteConfig, IPageRouteConfig } from './route';
+declare const supportFileTypes: readonly ["page", "layout", "middleware", "api"];
+declare type GetArrayElementType<T extends readonly any[]> = T extends readonly any[] ? T[number] : never;
+export declare type SupportFileType = GetArrayElementType<typeof supportFileTypes>;
+declare type CapName = Capitalize<SupportFileType>;
+declare type FileTypeChecker = Record<`is${CapName}`, (filename: string) => boolean>;
+export declare function normalizeFilePath(filepath: string): string;
+export declare function parseDynamicPath(normalizedRoute: string): string;
+export declare function normalizeRoutePath(rawPath: string): string;
+export declare const normalize: (path: string) => string;
+export declare const isRouteFile: (file: string) => boolean;
+export declare const getAllowFilesAndDirs: (dirname: string) => Promise<string[]>;
+export declare const hasAllowFiles: (files: string[]) => boolean;
+export declare const readDir: (fullPath: string) => Promise<string[]>;
+export declare const hasRouteChildren: (files: string[], parentPath: string) => Promise<boolean>;
+declare const fileTypeChecker: FileTypeChecker;
+declare function sortRoutes(routes: IApiRouteConfig[]): IApiRouteConfig[];
+declare function sortRoutes(routes: IMiddlewareRouteConfig[]): IMiddlewareRouteConfig[];
+declare function sortRoutes(routes: IPageRouteConfig[]): IPageRouteConfig[];
+export { fileTypeChecker, sortRoutes };

package/lib/node/route/helpers.js

@@ -0,0 +1,199 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortRoutes = exports.fileTypeChecker = exports.hasRouteChildren = exports.readDir = exports.hasAllowFiles = exports.getAllowFilesAndDirs = exports.isRouteFile = exports.normalize = exports.normalizeRoutePath = exports.parseDynamicPath = exports.normalizeFilePath = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+const file_1 = require("@shuvi/utils/lib/file");
+const invariant_1 = __importDefault(require("@shuvi/utils/lib/invariant"));
+const router_1 = require("../../shared/router");
+const supportFileTypes = ['page', 'layout', 'middleware', 'api'];
+const allowReadFilExtList = ['ts', 'js', 'tsx', 'jsx'];
+const dynamicMatchAllRegex = /\[\[(.+?)\]\]/g;
+const dynamicMatchPartRegex = /\[(.+?)\]/g;
+function normalizeFilePath(filepath) {
+    const res = filepath
+        // Remove the file extension from the end
+        .replace(/\.\w+$/, '')
+        // Convert to unix path
+        .replace(/\\/g, '/');
+    return res.charAt(0) !== '/' ? '/' + res : res;
+}
+exports.normalizeFilePath = normalizeFilePath;
+function parseDynamicPath(normalizedRoute) {
+    (0, invariant_1.default)(normalizedRoute.length >= 1, 'parseDynamicPath param normalizedRoute length should not >= 1');
+    (0, invariant_1.default)(!checkSpecialRegexChars(normalizedRoute), 'filePath should not be special regex chars: |\\{}()^$+*?');
+    return normalizedRoute
+        .slice(1)
+        .split('/')
+        .map(segment => {
+        let result = '';
+        result = segment.replace(dynamicMatchAllRegex, function (matchString, ...matchArr) {
+            return parseMatchRepeat(matchArr[0], true);
+        });
+        result = result.replace(dynamicMatchPartRegex, function (matchString, ...matchArr) {
+            return parseMatchRepeat(matchArr[0], false);
+        });
+        return `/${result}`;
+    })
+        .join('');
+}
+exports.parseDynamicPath = parseDynamicPath;
+function parseMatchRepeat(param, optional) {
+    const repeat = param.startsWith('...');
+    if (repeat) {
+        param = param.slice(3);
+    }
+    return repeat
+        ? optional
+            ? `:${param}*`
+            : `:${param}+`
+        : `:${param}${optional ? '?' : ''}`;
+}
+function checkSpecialRegexChars(string) {
+    return /[|\\{}()^$+*?]/g.test(string);
+}
+function normalizeRoutePath(rawPath) {
+    // /xxxx/index -> /xxxx/
+    let routePath = rawPath.replace(/\/index$/, '/');
+    // remove the last slash
+    // e.g. /abc/ -> /abc
+    if (routePath !== '/' && routePath.slice(-1) === '/') {
+        routePath = routePath.slice(0, -1);
+    }
+    routePath = parseDynamicPath(routePath);
+    return routePath;
+}
+exports.normalizeRoutePath = normalizeRoutePath;
+const normalize = (path) => {
+    const result = normalizeRoutePath(normalizeFilePath(path));
+    if (result === '/') {
+        return result;
+    }
+    return result.replace(/^\//, '');
+};
+exports.normalize = normalize;
+const isRouteFile = (file) => {
+    return Object.keys(fileTypeChecker).some(key => {
+        return fileTypeChecker[key](file);
+    });
+};
+exports.isRouteFile = isRouteFile;
+const getAllowFilesAndDirs = (dirname) => __awaiter(void 0, void 0, void 0, function* () {
+    const result = [];
+    const resultHistory = {};
+    const files = yield (0, exports.readDir)(dirname);
+    for (const file of files) {
+        const isDir = yield (0, file_1.isDirectory)((0, path_1.join)(dirname, file));
+        if (isDir) {
+            result.push(file);
+            continue;
+        }
+        if ((0, exports.isRouteFile)(file)) {
+            const ext = (0, path_1.extname)(file);
+            const extWithoutDot = ext.slice(1);
+            const pureFilename = (0, path_1.basename)(file, ext);
+            const fileHistory = (resultHistory[pureFilename] =
+                resultHistory[pureFilename] || {});
+            const { type } = fileHistory;
+            switch (extWithoutDot) {
+                case 'js':
+                    if (type) {
+                        continue;
+                    }
+                    fileHistory.type = 'js';
+                    break;
+                case 'jsx':
+                    if (type) {
+                        if (['ts', 'tsx'].includes(type)) {
+                            continue;
+                        }
+                        fileHistory.type = 'jsx';
+                        result[fileHistory.index] = file;
+                        continue;
+                    }
+                    fileHistory.type = 'jsx';
+                    break;
+                case 'ts':
+                    if (type) {
+                        if (type === 'tsx') {
+                            continue;
+                        }
+                        fileHistory.type = 'ts';
+                        result[fileHistory.index] = file;
+                        continue;
+                    }
+                    fileHistory.type = 'ts';
+                    break;
+                case 'tsx':
+                    fileHistory.type = 'tsx';
+                    if (type) {
+                        result[fileHistory.index] = file;
+                        continue;
+                    }
+                    break;
+            }
+            fileHistory.index = result.length;
+            result.push(file);
+        }
+    }
+    return result;
+});
+exports.getAllowFilesAndDirs = getAllowFilesAndDirs;
+const hasAllowFiles = (files) => files.some(file => (0, exports.isRouteFile)(file));
+exports.hasAllowFiles = hasAllowFiles;
+const readDir = (fullPath) => {
+    return fs_1.default.promises.readdir(fullPath, { encoding: 'utf-8' });
+};
+exports.readDir = readDir;
+const hasRouteChildren = (files, parentPath) => __awaiter(void 0, void 0, void 0, function* () {
+    for (const file of files) {
+        if ((0, exports.isRouteFile)(file)) {
+            return true;
+        }
+        const fullPath = (0, path_1.join)(parentPath, file);
+        if (yield (0, file_1.isDirectory)(fullPath)) {
+            let result = yield (0, exports.hasRouteChildren)(yield (0, exports.readDir)(fullPath), fullPath);
+            if (result) {
+                return true;
+            }
+        }
+    }
+    return false;
+});
+exports.hasRouteChildren = hasRouteChildren;
+const fileTypeChecker = {};
+exports.fileTypeChecker = fileTypeChecker;
+supportFileTypes.forEach(fileType => {
+    const allowNames = allowReadFilExtList.map(ext => `${fileType}.${ext}`);
+    const capName = (fileType.charAt(0).toUpperCase() +
+        fileType.slice(1));
+    fileTypeChecker[`is${capName}`] = (filename) => {
+        return allowNames.includes(filename);
+    };
+});
+function sortRoutes(routes) {
+    let rankRoutes = routes.map(route => {
+        return [route.path, route];
+    });
+    rankRoutes = (0, router_1.rankRouteBranches)(rankRoutes);
+    return rankRoutes.map(rankRoute => {
+        const rankRawRoute = rankRoute[1];
+        if (rankRawRoute.children) {
+            rankRawRoute.children = sortRoutes(rankRawRoute.children);
+        }
+        return rankRoute[1];
+    });
+}
+exports.sortRoutes = sortRoutes;

package/lib/node/route/index.d.ts

@@ -0,0 +1 @@
+export { IPageRouteConfig, IApiRouteConfig, IMiddlewareRouteConfig, getPageRoutes, getApiRoutes, getMiddlewareRoutes } from './route';

package/lib/node/route/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMiddlewareRoutes = exports.getApiRoutes = exports.getPageRoutes = void 0;
+var route_1 = require("./route");
+Object.defineProperty(exports, "getPageRoutes", { enumerable: true, get: function () { return route_1.getPageRoutes; } });
+Object.defineProperty(exports, "getApiRoutes", { enumerable: true, get: function () { return route_1.getApiRoutes; } });
+Object.defineProperty(exports, "getMiddlewareRoutes", { enumerable: true, get: function () { return route_1.getMiddlewareRoutes; } });