@shuvi/platform-web 0.0.1-rc.32 → 1.0.0-rc.0

package/lib/shared/routeTypes.d.ts

@@ -0,0 +1,47 @@
+import { IURLParams, IURLQuery } from '@shuvi/platform-shared/shared';
+import { IRequestHandlerWithNext } from '@shuvi/service';
+import { IResponse, IRequest } from '@shuvi/service';
+export interface IApiReq {
+    pathname: string;
+    query: IURLQuery;
+    params: IURLParams;
+    cookies: {
+        [key: string]: string;
+    };
+    body?: {
+        [key: string]: any;
+    };
+}
+export declare type IApiRequest = IRequest & IApiReq;
+export declare type Send<T> = (body: T) => void;
+export declare type IApiRes<T = any> = {
+    send: Send<T>;
+    json: Send<T>;
+    status: (statusCode: number) => IApiRes<T>;
+    redirect(url: string): IApiRes<T>;
+    redirect(status: number, url: string): IApiRes<T>;
+};
+export declare type IApiResponse<T = any> = IResponse & IApiRes<T>;
+export declare type IApiRequestHandler<T = any> = (req: IApiRequest, res: IApiResponse<T>) => void | Promise<void>;
+export interface IApiConfig {
+    apiConfig?: {
+        bodyParser?: {
+            sizeLimit: number | string;
+        } | boolean;
+    };
+}
+export interface IApiHandler {
+    default: IApiRequestHandler;
+    config?: IApiConfig;
+}
+export interface IMiddlewareConfig {
+    default: IRequestHandlerWithNext;
+}
+export declare type IApiRoutes = {
+    path: string;
+    api: IApiHandler;
+}[];
+export declare type IMiddlewareRoutes = {
+    path: string;
+    middleware: IMiddlewareConfig;
+}[];

package/lib/shared/routeTypes.js

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

package/lib/shared/serverTypes.d.ts

@@ -0,0 +1,6 @@
+import { ServerPluginConstructor } from '@shuvi/service';
+export interface IServerModule {
+    getPageData?: ServerPluginConstructor['getPageData'];
+    handlePageRequest?: ServerPluginConstructor['handlePageRequest'];
+    modifyHtml?: ServerPluginConstructor['modifyHtml'];
+}

package/lib/shared/serverTypes.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuvi/platform-web",
-  "version": "0.0.1-rc.32",
+  "version": "1.0.0-rc.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/shuvijs/shuvi.git",
@@ -11,28 +11,82 @@
   "sideEffects": [
     "**/shuvi-app/entry/client/**"
   ],
-  "main": "./lib/index.js",
-  "module": "./es/index.js",
   "files": [
     "lib",
-    "shuvi-app"
+    "esm",
+    "types",
+    "shuvi-app-extensions.d.ts"
   ],
-  "scripts": {
-    "dev": "run-p watch:*",
-    "watch:app": "tsc -p tsconfig.build.app.json -w",
-    "watch:node": "tsc -p tsconfig.build.node.json -w",
-    "prebuild": "rimraf lib shuvi-app",
-    "build": "run-p build:*",
-    "build:app": "tsc -p tsconfig.build.app.json",
-    "build:node": "tsc -p tsconfig.build.node.json"
+  "exports": {
+    ".": {
+      "default": "./lib/node/index.js"
+    },
+    "./node": {
+      "default": "./lib/node/index.js"
+    },
+    "./node/*": {
+      "default": "./lib/node/*.js"
+    },
+    "./shared": {
+      "default": "./esm/shared/index.js"
+    },
+    "./shared/*": {
+      "default": "./esm/shared/*.js"
+    },
+    "./shuvi-app": {
+      "default": "./esm/shuvi-app/index.js"
+    },
+    "./shuvi-app/*": {
+      "default": [
+        "./esm/shuvi-app/*.js",
+        "./esm/shuvi-app/*.jsx"
+      ]
+    },
+    "./shuvi-app-extensions.d.ts": "./shuvi-app-extensions.d.ts"
   },
   "engines": {
     "node": ">= 12.0.0"
   },
   "dependencies": {
-    "@shuvi/app": "^0.0.1-rc.32",
-    "@shuvi/platform-core": "^0.0.1-rc.32",
-    "@shuvi/service": "^0.0.1-rc.32",
-    "@shuvi/shared": "^0.0.1-rc.32"
+    "@next/react-refresh-utils": "12.1.6",
+    "@shuvi/hook": "1.0.0-rc.0",
+    "@shuvi/platform-shared": "1.0.0-rc.0",
+    "@shuvi/redox-react": "0.0.3",
+    "@shuvi/router": "1.0.0-rc.0",
+    "@shuvi/router-react": "1.0.0-rc.0",
+    "@shuvi/runtime": "1.0.0-rc.0",
+    "@shuvi/service": "1.0.0-rc.0",
+    "@shuvi/shared": "1.0.0-rc.0",
+    "@shuvi/toolpack": "1.0.0-rc.0",
+    "@shuvi/utils": "1.0.0-rc.0",
+    "content-type": "1.0.4",
+    "cookie": "0.4.1",
+    "ejs": "3.1.5",
+    "fs-extra": "9.0.1",
+    "node-mocks-http": "1.11.0",
+    "raw-body": "2.4.1",
+    "react": "18.1.0",
+    "react-app-polyfill": "2.0.0",
+    "react-dom": "18.1.0",
+    "react-refresh": "0.12.0",
+    "use-sync-external-store": "1.1.0"
+  },
+  "devDependencies": {
+    "@shuvi/redox": "0.0.3",
+    "@testing-library/react": "^10.0.2",
+    "@types/content-type": "^1.1.5",
+    "@types/cookie": "^0.4.1",
+    "@types/ejs": "^3.1.0",
+    "@types/raw-body": "^2.3.0",
+    "webpack": "5.73.0"
+  },
+  "scripts": {
+    "dev": "run-p watch:*",
+    "watch:esm": "tsc -p tsconfig.build.browser.json -w",
+    "watch:cjs": "tsc -p tsconfig.build.node.json -w",
+    "prebuild": "rimraf lib esm types",
+    "build": "run-p build:*",
+    "build:esm": "tsc -p tsconfig.build.browser.json",
+    "build:cjs": "tsc -p tsconfig.build.node.json"
   }
-}
+}

package/shuvi-app-extensions.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="@shuvi/platform-shared/shuvi-app-extensions.d.ts" />
+
+declare module '@shuvi/app/files/routes' {
+  import { IRawPageRouteRecord } from '@shuvi/platform-shared/shared';
+  declare const routes: IRawPageRouteRecord[];
+  export default routes;
+}
+
+declare module '@shuvi/app/files/routerConfig' {
+  import { ILoaderOptions } from '@shuvi/platform-shared/shared/loader';
+  export const historyMode: 'browser' | 'hash';
+}
+
+declare module '@shuvi/app/files/page-loaders' {
+  import { IRouteLoaderContext } from '@shuvi/platform-shared/shared';
+  import { Loader } from '@shuvi/platform-shared/shared';
+
+  const loaders: Record<string, Loader>;
+  export default loaders;
+}
+
+declare module '@shuvi/app/files/apiRoutes' {
+  import { IApiRoutes } from '@shuvi/platform-web/shared';
+  declare const apiRoutes: IApiRoutes[];
+  export default apiRoutes;
+}
+
+declare module '@shuvi/app/files/middlewareRoutes' {
+  import { IMiddlewareRoutes } from '@shuvi/platform-web/shared';
+  declare const middlewareRoutes: IMiddlewareRoutes[];
+  export default middlewareRoutes;
+}
+
+declare module '@shuvi/app/files/user/server' {
+  export {};
+}

package/lib/index.d.ts

@@ -1,3 +0,0 @@
-import { Runtime } from '@shuvi/service';
-declare const platform: Runtime.IRuntime<any>;
-export default platform;

package/lib/index.js

@@ -1,44 +0,0 @@
-"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 });
-const paths_1 = require("./paths");
-const platform = {
-    install(api) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // set application and entry
-            const { ssr, router: { history } } = api.config;
-            let ApplicationModule;
-            if (history === 'browser') {
-                ApplicationModule = 'create-application-history-browser';
-            }
-            else if (history === 'hash') {
-                ApplicationModule = 'create-application-history-hash';
-            }
-            else {
-                ApplicationModule = 'create-application-history-memory';
-            }
-            api.setServerModule({
-                application: paths_1.resolveAppFile('application', 'server', ssr ? 'create-application' : 'create-application-spa'),
-                entry: paths_1.resolveAppFile('entry', 'server')
-            });
-            api.setClientModule({
-                application: paths_1.resolveAppFile('application', 'client', ApplicationModule),
-                entry: paths_1.resolveAppFile('entry', 'client')
-            });
-            // install framework
-            const { framework = 'react' } = api.config.platform || {};
-            const frameworkInstance = require(`@shuvi/platform-web-${framework}`)
-                .default;
-            frameworkInstance.install(api);
-        });
-    }
-};
-exports.default = platform;

package/lib/paths.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-exports.PACKAGE_DIR = path_1.dirname(require.resolve('@shuvi/platform-web/package.json'));
-exports.resolveAppFile = (...paths) => `${path_1.resolve(exports.PACKAGE_DIR, 'shuvi-app', ...paths)}`;
-exports.resolveDep = (module) => require.resolve(module);
-exports.resolveLib = (module) => path_1.dirname(exports.resolveDep(path_1.join(module, 'package.json')));

package/shuvi-app/application/client/create-application-factory.d.ts

@@ -1,3 +0,0 @@
-import { History } from '@shuvi/router/lib/types';
-import { Runtime } from '@shuvi/service';
-export declare const createFactory: (historyCreater: () => History) => Runtime.ApplicationCreater;

package/shuvi-app/application/client/create-application-factory.js

@@ -1,70 +0,0 @@
-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());
-    });
-};
-import AppComponent from '@shuvi/app/core/app';
-import routes from '@shuvi/app/core/routes';
-import { getRoutes } from '@shuvi/app/core/platform';
-import { Application } from '@shuvi/platform-core';
-import runPlugins from '@shuvi/platform-core/lib/runPlugins';
-import { createRouter } from '@shuvi/router';
-let app;
-let history;
-let appContext;
-export const createFactory = (historyCreater) => {
-    const create = function (context, options) {
-        appContext = context;
-        // app is a singleton in client side
-        if (app) {
-            return app;
-        }
-        history = historyCreater();
-        const router = createRouter({
-            history,
-            routes: getRoutes(routes, context)
-        });
-        app = new Application({
-            AppComponent,
-            router,
-            context,
-            render: options.render
-        });
-        runPlugins(app);
-        return app;
-    };
-    return create;
-};
-if (module.hot) {
-    module.hot.accept([
-        '@shuvi/app/entry.client',
-        '@shuvi/app/core/app',
-        '@shuvi/app/core/routes',
-        '@shuvi/app/user/plugin'
-    ], () => __awaiter(void 0, void 0, void 0, function* () {
-        const rerender = () => {
-            const AppComponent = require('@shuvi/app/core/app').default;
-            const routes = require('@shuvi/app/core/routes').default;
-            const router = createRouter({
-                history,
-                routes: getRoutes(routes, appContext)
-            });
-            app.rerender({ router, AppComponent });
-        };
-        // to solve routing problem, we need to rerender routes
-        // wait navigation complete only rerender to ensure getInitialProps is called
-        if (__SHUVI.router._pending) {
-            const removelistener = __SHUVI.router.afterEach(() => {
-                rerender();
-                removelistener();
-            });
-        }
-        else {
-            rerender();
-        }
-    }));
-}

package/shuvi-app/application/client/create-application-history-browser.d.ts

@@ -1 +0,0 @@
-export declare const create: import("@shuvi/service/lib/types/runtime").ApplicationCreater;

package/shuvi-app/application/client/create-application-history-browser.js

@@ -1,3 +0,0 @@
-import { createFactory } from './create-application-factory';
-import { createBrowserHistory } from '@shuvi/router';
-export const create = createFactory(createBrowserHistory);

package/shuvi-app/application/client/create-application-history-hash.d.ts

@@ -1 +0,0 @@
-export declare const create: import("@shuvi/service/lib/types/runtime").ApplicationCreater;

package/shuvi-app/application/client/create-application-history-hash.js

@@ -1,3 +0,0 @@
-import { createFactory } from './create-application-factory';
-import { createHashHistory } from '@shuvi/router';
-export const create = createFactory(createHashHistory);

package/shuvi-app/application/client/create-application-history-memory.d.ts

@@ -1 +0,0 @@
-export declare const create: import("@shuvi/service/lib/types/runtime").ApplicationCreater;

package/shuvi-app/application/client/create-application-history-memory.js

@@ -1,3 +0,0 @@
-import { createFactory } from './create-application-factory';
-import { createMemoryHistory } from '@shuvi/router';
-export const create = createFactory(createMemoryHistory);

package/shuvi-app/application/server/create-application-spa.d.ts

@@ -1,2 +0,0 @@
-import { Runtime } from '@shuvi/service';
-export declare const create: Runtime.ApplicationCreater;

package/shuvi-app/application/server/create-application-spa.js

@@ -1,8 +0,0 @@
-import { Application } from '@shuvi/platform-core';
-export const create = function (context, options) {
-    return new Application({
-        AppComponent: null,
-        context,
-        render: options.render
-    });
-};

package/shuvi-app/application/server/create-application.d.ts

@@ -1,2 +0,0 @@
-import { Runtime } from '@shuvi/service';
-export declare const create: Runtime.ApplicationCreater;

package/shuvi-app/application/server/create-application.js

@@ -1,25 +0,0 @@
-import AppComponent from '@shuvi/app/core/app';
-import routes from '@shuvi/app/core/routes';
-import { getRoutes } from '@shuvi/app/core/platform';
-import { Application } from '@shuvi/platform-core';
-import runPlugins from '@shuvi/platform-core/lib/runPlugins';
-import { createRouter, createMemoryHistory } from '@shuvi/router';
-export const create = function (context, options) {
-    const { req } = context;
-    const history = createMemoryHistory({
-        initialEntries: [(req && req.url) || '/'],
-        initialIndex: 0
-    });
-    const router = createRouter({
-        history,
-        routes: getRoutes(routes, context)
-    });
-    const app = new Application({
-        AppComponent,
-        router,
-        context,
-        render: options.render
-    });
-    runPlugins(app);
-    return app;
-};

package/shuvi-app/entry/client/index.d.ts

@@ -1 +0,0 @@
-import './setup-env';

package/shuvi-app/entry/client/index.js

@@ -1,11 +0,0 @@
-// This is the shuvi client-side entry
-// IMPORTANT: `setup-env` must be runned before any other codes
-import './setup-env';
-import { rerender } from './setup-app';
-window.__SHUVI = Object.assign(Object.assign({}, (window.__SHUVI || {})), { rerender });
-if (process.env.NODE_ENV === 'development') {
-    require('./run.dev');
-}
-else {
-    require('./run.prod');
-}

package/shuvi-app/entry/client/run.prod.js

@@ -1,3 +0,0 @@
-/// <reference lib="dom" />
-import { app } from './setup-app';
-app.run();

package/shuvi-app/entry/client/setup-app.d.ts

@@ -1,3 +0,0 @@
-declare const app: import("@shuvi/runtime-core").IApplication;
-declare const rerender: () => void;
-export { app, rerender };

package/shuvi-app/entry/client/setup-app.js

@@ -1,38 +0,0 @@
-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());
-    });
-};
-import { CLIENT_CONTAINER_ID } from '@shuvi/shared/lib/constants';
-// renderer must be imported before application
-// we need to init init renderer before import AppComponent
-import { view } from '@shuvi/app/core/platform';
-import { create } from '@shuvi/app/core/client/application';
-import { getAppData } from '@shuvi/platform-core/lib/helper';
-const appData = getAppData();
-const { routeProps = {} } = appData;
-const app = create({
-    pageData: appData.pageData || {},
-    routeProps
-}, {
-    render({ appContext, AppComponent, router }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const appContainer = document.getElementById(CLIENT_CONTAINER_ID);
-            view.renderApp({
-                AppComponent: AppComponent,
-                router: router,
-                appData,
-                appContainer,
-                appContext
-            });
-        });
-    }
-});
-const rerender = () => {
-    app.rerender();
-};
-export { app, rerender };

package/shuvi-app/entry/client/setup-env.js

@@ -1,27 +0,0 @@
-/**
- * Following codes should be run beforen any other codes.
- * Do not try to import any module from `@shuvi/app`.
- */
-import { IDENTITY_RUNTIME_PUBLICPATH, IDENTITY_SSR_RUNTIME_PUBLICPATH } from '@shuvi/shared/lib/constants';
-import setRuntimeConfig from '@shuvi/app/core/setRuntimeConfig';
-import runtimeConfig from '@shuvi/app/core/runtimeConfig';
-import { getAppData } from '@shuvi/platform-core/lib/helper';
-const win = window;
-// server runtime public path
-if (win[IDENTITY_SSR_RUNTIME_PUBLICPATH]) {
-    __webpack_public_path__ = win[IDENTITY_SSR_RUNTIME_PUBLICPATH];
-}
-// client runtime public path
-if (win[IDENTITY_RUNTIME_PUBLICPATH]) {
-    __webpack_public_path__ = win[IDENTITY_RUNTIME_PUBLICPATH];
-}
-// === set runtime config ===
-const appData = getAppData();
-// build-time config for none-ssr
-if (runtimeConfig) {
-    setRuntimeConfig(runtimeConfig);
-}
-// runtime config from server
-if (appData.runtimeConfig) {
-    setRuntimeConfig(appData.runtimeConfig);
-}

package/shuvi-app/entry/server/index.d.ts

@@ -1,6 +0,0 @@
-import * as server from '@shuvi/app/user/server';
-import * as document from '@shuvi/app/user/document';
-import * as application from '@shuvi/app/core/server/application';
-import { default as apiRoutes } from '@shuvi/app/core/apiRoutes';
-export { server, document, application, apiRoutes };
-export { view } from '@shuvi/app/core/platform';

package/shuvi-app/entry/server/index.js

@@ -1,7 +0,0 @@
-// This is the shuvi server-side main module exports collection
-import * as server from '@shuvi/app/user/server';
-import * as document from '@shuvi/app/user/document';
-import * as application from '@shuvi/app/core/server/application';
-import { default as apiRoutes } from '@shuvi/app/core/apiRoutes';
-export { server, document, application, apiRoutes };
-export { view } from '@shuvi/app/core/platform';