@shuvi/platform-shared 1.0.0-rc.1 → 1.0.0-rc.12

package/lib/node/platform/runtimeFiles.js

@@ -45,7 +45,8 @@ const getPresetRuntimeFilesCreator = (platformModule, polyfills) => (pluginConte
     const context = (0, projectContext_1.createProjectContext)();
     context.userModule = {
         error: getCandidates('error', 'nullish'),
-        app: getCandidates('app', 'noop')
+        app: getCandidates('app', 'noop'),
+        server: getCandidates('server', 'noop')
     };
     context.platformModule = platformModule;
     context.runtimeConfig = Object.assign(Object.assign({}, serverRuntimeConfig), publicRuntimeConfig);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/lib/node/project/file-presets/files/app/user/server.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 { server } = context.userModule;
+    const candidates = Array.isArray(server) ? server : [server];
+    return (0, __1.defineFile)({
+        dependencies: candidates,
+        content: () => {
+            return getFirstModuleExport(getAllFiles(candidates), candidates);
+        }
+    });
+};

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

@@ -1,4 +1,4 @@
-import { FileOptions, DefineFileOption } from '@shuvi/service/lib/project';
+import { FileOption, FileOptionWithoutId } 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">;
+export declare function getFilePresets(context: ProjectContext): FileOption<any>[];
+export declare const defineFile: (options: Omit<FileOptionWithoutId, 'name'>) => Omit<FileOptionWithoutId<string, any>, "name">;

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

@@ -1,7 +1,8 @@
-import { IRuntimeConfig } from '@shuvi/service/lib/core';
+import { IRuntimeConfig } from '../../shared';
 export interface UserModule {
     app: string | string[];
     error: string | string[];
+    server: string | string[];
 }
 export interface ProjectContext {
     entryCodes: string[];

package/lib/node/project/projectContext.js

@@ -9,7 +9,8 @@ const createProjectContext = () => {
         platformModule: '',
         userModule: {
             app: '',
-            error: ''
+            error: '',
+            server: ''
         }
     };
 };

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

@@ -1,20 +1,19 @@
-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 function combineComponents(fisrt: string, sec: 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[];
+declare function sortRoutes<T extends {
+    path: string;
+    children?: T[];
+}>(routes: T[]): T[];
 export { fileTypeChecker, sortRoutes };

package/lib/node/route/helpers.js

@@ -12,7 +12,7 @@ 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;
+exports.sortRoutes = exports.fileTypeChecker = exports.hasRouteChildren = exports.readDir = exports.hasAllowFiles = exports.getAllowFilesAndDirs = exports.isRouteFile = exports.combineComponents = exports.normalizeRoutePath = exports.parseDynamicPath = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = require("path");
 const file_1 = require("@shuvi/utils/lib/file");
@@ -20,53 +20,26 @@ 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;
+const dynamicMatchAllRegex = /\$$/;
+const dynamicMatchPartRegex = /\$/g;
 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: |\\{}()^$+*?');
+    (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('');
+        .replace(dynamicMatchAllRegex, '*')
+        .replace(dynamicMatchPartRegex, ':');
 }
 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);
+    return /[|\\{}()^:+*?]/g.test(string);
 }
 function normalizeRoutePath(rawPath) {
+    let routePath = rawPath
+        // Remove the file extension from the end
+        .replace(/\.\w+$/, '')
+        // Convert to unix path
+        .replace(/\\/g, '/');
     // /xxxx/index -> /xxxx/
-    let routePath = rawPath.replace(/\/index$/, '/');
+    routePath = rawPath.replace(/\/index$/, '/');
     // remove the last slash
     // e.g. /abc/ -> /abc
     if (routePath !== '/' && routePath.slice(-1) === '/') {
@@ -76,14 +49,26 @@ function normalizeRoutePath(rawPath) {
     return routePath;
 }
 exports.normalizeRoutePath = normalizeRoutePath;
-const normalize = (path) => {
-    const result = normalizeRoutePath(normalizeFilePath(path));
-    if (result === '/') {
-        return result;
+function combineComponents(fisrt, sec) {
+    if (fisrt === '' || sec === '') {
+        return `${fisrt}${sec}`;
     }
-    return result.replace(/^\//, '');
-};
-exports.normalize = normalize;
+    if (fisrt.endsWith('/')) {
+        if (sec.startsWith('/')) {
+            return `${fisrt}${sec.slice(1)}`;
+        }
+        else {
+            return `${fisrt}${sec}`;
+        }
+    }
+    else if (sec.startsWith('/')) {
+        return `${fisrt}${sec}`;
+    }
+    else {
+        return `${fisrt}/${sec}`;
+    }
+}
+exports.combineComponents = combineComponents;
 const isRouteFile = (file) => {
     return Object.keys(fileTypeChecker).some(key => {
         return fileTypeChecker[key](file);

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

@@ -1 +1 @@
-export { IPageRouteConfig, IApiRouteConfig, IMiddlewareRouteConfig, getPageRoutes, getApiRoutes, getMiddlewareRoutes } from './route';
+export { RawRoutes, PageRoutes, ApiRoutes, MiddlewareRoutes, IPageRouteConfig, IApiRouteConfig, IMiddlewareRouteConfig, getRawRoutesFromDir, getPageRoutes, getApiRoutes, getMiddlewareRoutes } from './route';

package/lib/node/route/index.js

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

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

@@ -0,0 +1,8 @@
+export interface FileMatcherPatterns {
+    excludePattern: string | undefined;
+}
+export declare function getRegularExpressionsForWildcards(specs: readonly string[] | undefined, basePath: string): readonly string[] | undefined;
+export declare function getRegularExpressionForWildcard(specs: readonly string[] | undefined, basePath: string, usage: 'exclude'): string | undefined;
+export declare function getRegexFromPattern(pattern: string, caseSensitive: boolean): RegExp;
+export declare function getFileMatcherPatterns(basePath: string, excludes: readonly string[] | undefined): FileMatcherPatterns;
+export declare function matchFile(file: string, patterns: FileMatcherPatterns, caseSensitive: boolean): boolean;

package/lib/node/route/matchSpec.js

@@ -0,0 +1,138 @@
+"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.matchFile = exports.getFileMatcherPatterns = exports.getRegexFromPattern = exports.getRegularExpressionForWildcard = exports.getRegularExpressionsForWildcards = void 0;
+// port from typescript
+const nodePath = __importStar(require("path"));
+const directorySeparator = '/';
+// Reserved characters, forces escaping of any non-word (or digit), non-whitespace character.
+// It may be inefficient (we could just match (/[-[\]{}()*+?.,\\^$|#\s]/g), but this is future
+// proof.
+const reservedCharacterPattern = /[^\w\s\/]/g;
+const commonPackageFolders = ['node_modules'];
+// does not match centeain directories or directories that start with a . character
+const implicitExcludePathRegexPattern = `/((${commonPackageFolders.join('|')})|([/.][^/]*))`;
+function replaceWildcardCharacter(match, singleAsteriskRegexFragment) {
+    return match === '*'
+        ? singleAsteriskRegexFragment
+        : match === '?'
+            ? '[^/]'
+            : '\\' + match;
+}
+const wildcardMatcher = {
+    singleAsteriskRegexFragment: '[^/]*',
+    doubleAsteriskRegexFragment: '(/.+?)?',
+    replaceWildcardCharacter: match => replaceWildcardCharacter(match, wildcardMatcher.singleAsteriskRegexFragment)
+};
+/**
+ * An "includes" path "foo" is implicitly a glob "foo/** /*" (without the space) if its last component has no extension,
+ * and does not contain any glob characters itself.
+ */
+function isImplicitGlob(lastPathComponent) {
+    return !/[.*?]/.test(lastPathComponent);
+}
+function normalizePath(path, currentDirectory) {
+    return currentDirectory
+        ? nodePath.posix.resolve(currentDirectory, path)
+        : nodePath.posix.normalize(path);
+}
+function getNormalizedPathComponents(path, currentDirectory) {
+    const normalizedPath = normalizePath(path, currentDirectory);
+    const comps = normalizedPath.split('/');
+    if (comps.length && !comps[comps.length - 1])
+        comps.pop();
+    return comps;
+}
+function getSubPatternFromSpec(spec, basePath, { doubleAsteriskRegexFragment, replaceWildcardCharacter }) {
+    let subpattern = '';
+    let hasWrittenComponent = false;
+    const components = getNormalizedPathComponents(spec, basePath);
+    const lastComponent = components[components.length - 1];
+    // remove trailing slash
+    components[0] = components[0].replace(/[/]$/, '');
+    if (isImplicitGlob(lastComponent)) {
+        components.push('**', '*');
+    }
+    for (let component of components) {
+        if (component === '**') {
+            subpattern += doubleAsteriskRegexFragment;
+        }
+        else {
+            if (hasWrittenComponent) {
+                subpattern += directorySeparator;
+            }
+            subpattern += component.replace(reservedCharacterPattern, replaceWildcardCharacter);
+        }
+        hasWrittenComponent = true;
+    }
+    return subpattern;
+}
+function getRegularExpressionsForWildcards(specs, basePath) {
+    if (specs === undefined || specs.length === 0) {
+        return undefined;
+    }
+    const result = [];
+    for (const spec of specs) {
+        if (spec) {
+            let r = getSubPatternFromSpec(spec, basePath, wildcardMatcher);
+            if (r) {
+                result.push(r);
+            }
+        }
+    }
+    return result;
+}
+exports.getRegularExpressionsForWildcards = getRegularExpressionsForWildcards;
+function getRegularExpressionForWildcard(specs, basePath, usage) {
+    const patterns = getRegularExpressionsForWildcards(specs, basePath);
+    if (!patterns || !patterns.length) {
+        return undefined;
+    }
+    const pattern = patterns.map(pattern => `(${pattern})`).join('|');
+    // If excluding, match "foo/bar/baz...", but if including, only allow "foo".
+    const terminator = usage === 'exclude' ? '($|/)' : '$';
+    return `^(${pattern})${terminator}`;
+}
+exports.getRegularExpressionForWildcard = getRegularExpressionForWildcard;
+function getRegexFromPattern(pattern, caseSensitive) {
+    return new RegExp(pattern, caseSensitive ? '' : 'i');
+}
+exports.getRegexFromPattern = getRegexFromPattern;
+function getFileMatcherPatterns(basePath, excludes) {
+    const absolutePath = normalizePath(basePath);
+    return {
+        excludePattern: getRegularExpressionForWildcard(excludes, absolutePath, 'exclude')
+    };
+}
+exports.getFileMatcherPatterns = getFileMatcherPatterns;
+function matchFile(file, patterns, caseSensitive) {
+    file = normalizePath(file);
+    const excludeRegex = patterns.excludePattern &&
+        getRegexFromPattern(patterns.excludePattern, caseSensitive);
+    const implicitExcludeRegex = getRegexFromPattern(implicitExcludePathRegexPattern, caseSensitive);
+    return (!implicitExcludeRegex.test(file) &&
+        (!excludeRegex || !excludeRegex.test(file)));
+}
+exports.matchFile = matchFile;

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

@@ -1,22 +1,19 @@
-import { IUserRouteConfig, IApiRouteConfig, IMiddlewareRouteConfig } from '@shuvi/service';
+import { IPageRouteConfig, IApiRouteConfig, IMiddlewareRouteConfig } from '../../shared';
 import { SupportFileType } from './helpers';
-export declare type IPageRouteConfig = IUserRouteConfig;
-export type { IApiRouteConfig, IMiddlewareRouteConfig };
+export type { IPageRouteConfig, IApiRouteConfig, IMiddlewareRouteConfig };
 interface RawFileRoute {
     kind: 'file';
     type: SupportFileType;
-    name: string;
-    segment: string;
     filepath: string;
+    segment: string;
 }
-interface RawDirRoute {
+export interface RawDirRoute {
     kind: 'dir';
     filepath: string;
     segment: string;
-    parentSegment: string;
     children: (RawFileRoute | RawDirRoute)[];
 }
-declare type RawRoute = RawFileRoute | RawDirRoute;
+export declare type RawRoute = RawFileRoute | RawDirRoute;
 export interface RouteException {
     type: SupportFileType | 'dir';
     msg: string;
@@ -31,7 +28,7 @@ export declare type PageRoutes = RouteResult<IPageRouteConfig>;
 export declare type ApiRoutes = RouteResult<IApiRouteConfig>;
 export declare type MiddlewareRoutes = RouteResult<IMiddlewareRouteConfig>;
 export declare type RouteConfigType = IPageRouteConfig | IApiRouteConfig | IMiddlewareRouteConfig;
-export declare const getRawRoutesFromDir: (dirname: string) => Promise<RawRoutes>;
-export declare const getPageRoutes: (dirname: string) => Promise<PageRoutes>;
-export declare const getApiRoutes: (dir: string) => Promise<ApiRoutes>;
-export declare const getMiddlewareRoutes: (dirname: string) => Promise<MiddlewareRoutes>;
+export declare const getRawRoutesFromDir: (dirname: string, excludes?: string[]) => Promise<RawRoutes>;
+export declare const getPageRoutes: (dir: string | RawRoutes, excludes?: string[]) => Promise<PageRoutes>;
+export declare const getApiRoutes: (dir: string | RawRoutes, excludes?: string[]) => Promise<ApiRoutes>;
+export declare const getMiddlewareRoutes: (dir: string | RawRoutes, excludes?: string[]) => Promise<MiddlewareRoutes>;