@modern-js/plugin-koa 1.2.0 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @modern-js/plugin-koa
 
+## 1.3.1
+
+### Patch Changes
+
+- 83166714: change .npmignore
+- Updated dependencies [83166714]
+- Updated dependencies [c3de9882]
+- Updated dependencies [33ff48af]
+  - @modern-js/core@1.3.2
+  - @modern-js/adapter-helpers@1.2.1
+  - @modern-js/bff-runtime@1.2.1
+  - @modern-js/bff-utils@1.2.2
+  - @modern-js/server-plugin@1.2.1
+  - @modern-js/utils@1.2.2
+
+## 1.3.0
+
+### Minor Changes
+
+- cfe11628: Make Modern.js self bootstraping
+
+### Patch Changes
+
+- 146dcd85: modify server framework plugin hook types and hook context
+- 146dcd85: modify server framework plugin hook types
+- 146dcd85: fix test case in babel compiler
+- Updated dependencies [2da09c69]
+- Updated dependencies [fc71e36f]
+- Updated dependencies [146dcd85]
+- Updated dependencies [c3d46ee4]
+- Updated dependencies [cfe11628]
+- Updated dependencies [146dcd85]
+- Updated dependencies [8e7603ee]
+- Updated dependencies [146dcd85]
+  - @modern-js/utils@1.2.0
+  - @modern-js/core@1.3.0
+  - @modern-js/bff-runtime@1.2.0
+  - @modern-js/adapter-helpers@1.2.0
+  - @modern-js/bff-utils@1.2.0
+  - @modern-js/server-plugin@1.2.0
+
+## 1.2.1
+
+### Patch Changes
+
+- ad107726: feat: new action support apppend type define
+
 ## 1.2.0
 
 ### Minor Changes

package/jest.config.js

@@ -0,0 +1,8 @@
+const sharedConfig = require('@scripts/jest-config');
+
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  // eslint-disable-next-line node/no-unsupported-features/es-syntax
+  ...sharedConfig,
+  rootDir: __dirname,
+};

package/modern.config.js

@@ -1,10 +1,2 @@
 /** @type {import('@modern-js/module-tools').UserConfig} */
-module.exports = {
-  testing: {
-    jest: {
-      collectCoverage: true,
-      collectCoverageFrom: ['src/**/*.ts'],
-      coveragePathIgnorePatterns: ['/node_modules/'],
-    },
-  },
-};
+module.exports = {};

package/package.json

@@ -11,26 +11,31 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.2.0",
+  "version": "1.3.1",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
   "module": "./dist/js/treeshaking/index.js",
   "jsnext:modern": "./dist/js/modern/index.js",
   "exports": {
+    "./types": "./types.d.ts",
     ".": {
       "node": {
+        "jsnext:source": "./src/index.ts",
         "import": "./dist/js/modern/index.js",
         "require": "./dist/js/node/index.js"
       },
       "default": "./dist/js/treeshaking/index.js"
     },
-    "./cli": "./dist/js/node/cli/index.js"
+    "./cli": {
+      "jsnext:source": "./src/cli/index.ts",
+      "default": "./dist/js/node/cli/index.js"
+    }
   },
   "dependencies": {
     "@babel/runtime": "^7.15.3",
-    "@modern-js/adapter-helpers": "^1.1.1",
-    "@modern-js/utils": "^1.1.5",
+    "@modern-js/adapter-helpers": "^1.2.1",
+    "@modern-js/utils": "^1.2.2",
     "formidable": "^1.2.2",
     "koa-body": "^4.2.0",
     "koa-router": "^10.0.0",
@@ -47,12 +52,13 @@
     "@types/type-is": "^1.6.3",
     "supertest": "^6.1.6",
     "typescript": "^4",
-    "@modern-js/bff-runtime": "^1.1.1",
-    "@modern-js/bff-utils": "^1.1.1",
-    "@modern-js/core": "^1.2.0",
-    "@modern-js/server-plugin": "^1.1.3",
-    "@modern-js/plugin-testing": "^1.1.1",
-    "@modern-js/module-tools": "^1.1.2"
+    "@modern-js/bff-runtime": "^1.2.1",
+    "@modern-js/bff-utils": "^1.2.2",
+    "@modern-js/core": "^1.3.2",
+    "@modern-js/server-plugin": "^1.2.1",
+    "@scripts/build": "0.0.0",
+    "jest": "^27",
+    "@scripts/jest-config": "0.0.0"
   },
   "modernConfig": {
     "output": {
@@ -60,20 +66,21 @@
     }
   },
   "peerDependencies": {
-    "@modern-js/bff-utils": "^1.1.1",
-    "@modern-js/core": "^1.2.0",
-    "@modern-js/server-plugin": "^1.1.3",
-    "@modern-js/bff-runtime": "^1.1.1",
+    "@modern-js/bff-utils": "^1.2.2",
+    "@modern-js/core": "^1.3.2",
+    "@modern-js/server-plugin": "^1.2.1",
+    "@modern-js/bff-runtime": "^1.2.1",
     "koa": "^2.13.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "types": "./dist/types/index.d.ts"
   },
   "scripts": {
     "new": "modern new",
     "build": "modern build",
-    "test": "modern test"
+    "test": "jest --passWithNoTests"
   },
   "readme": "\n<p align=\"center\">\n  <a href=\"https://modernjs.dev\" target=\"blank\"><img src=\"https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png\" width=\"300\" alt=\"Modern.js Logo\" /></a>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
 }

package/tests/fixtures/function-mode/api/nest/user.ts

@@ -1,5 +1,5 @@
 import { match } from '@modern-js/bff-runtime';
-import { useContext } from '@/context';
+import { useContext } from '../../../../../src/context';
 
 export const get = ({ query }: { query: Record<string, unknown> }) => ({
   query,

package/tests/fixtures/lambda-mode/api/lambda/nest/user.ts

@@ -1,5 +1,5 @@
 import { match } from '@modern-js/bff-runtime';
-import { useContext } from '@/context';
+import { useContext } from '../../../../../../src/context';
 
 export const get = ({ query }: { query: Record<string, unknown> }) => ({
   query,

package/tests/lambdaMode.test.ts

@@ -1,6 +1,6 @@
 import * as path from 'path';
 import request from 'supertest';
-import Koa, { Context, Next } from 'koa';
+import Koa from 'koa';
 import { serverManager } from '@modern-js/server-plugin';
 import Router from 'koa-router';
 import koaBody from 'koa-body';
@@ -111,11 +111,11 @@ describe('add middlewares', () => {
 
   test('should works', async () => {
     const foo = 'foo';
-    const fakeMiddleware = jest.fn(async (ctx: Context, next: Next) => {
+    const fakeMiddleware = jest.fn(async (ctx: any, next: any) => {
       await next();
       ctx.body = foo;
     });
-    const fakeMiddleware2 = jest.fn(async (ctx: Context, next: Next) => {
+    const fakeMiddleware2 = jest.fn(async (ctx: any, next: any) => {
       await next();
     });
 

package/tests/tsconfig.json

@@ -7,8 +7,6 @@
     "isolatedModules": true,
     "sourceMap": true
   },
-  "paths": {
-    "@/*": ["../src/*"]
-  },
+  "paths": {},
   "exclude": ["src/__test__/fixtures/**"]
 }

package/types.d.ts

@@ -1,7 +1,17 @@
 /// <reference path="./dist/types/index.d.ts" />
-
 declare module '@modern-js/runtime/server' {
-  import { Context } from 'koa';
+
+  import { Context, Middleware } from 'koa';
+
+  type KoaOptions = {
+    addMiddleware: (...input: Middleware[]) => void;
+  };
+
+  type KoaAttacher = (options: KoaOptions) => void;
 
   export function useContext(): Context;
+
+  export function hook(attacher: KoaAttacher): KoaAttacher;
+
+  export * from '@modern-js/bff-runtime';
 }

package/src/cli/index.ts

@@ -1,85 +0,0 @@
-import * as path from 'path';
-import { useAppContext, createPlugin } from '@modern-js/core';
-import { createRuntimeExportsUtils } from '@modern-js/utils';
-
-export default createPlugin(
-  () => {
-    let bffExportsUtils: any;
-    const runtimeModulePath = path.resolve(__dirname, '../runtime');
-
-    return {
-      config() {
-        // eslint-disable-next-line react-hooks/rules-of-hooks
-        const appContext = useAppContext();
-        const { appDirectory } = appContext;
-        bffExportsUtils = createRuntimeExportsUtils(
-          appContext.internalDirectory,
-          'server',
-        );
-
-        const serverRuntimePath = bffExportsUtils.getPath();
-
-        // Look up one level, because the artifacts after build have dist directories
-        let relativeRuntimePath = path.join(
-          '../',
-          path.relative(appDirectory, serverRuntimePath),
-        );
-
-        if (
-          process.env.NODE_ENV === 'development' ||
-          process.env.NODE_ENV === 'test'
-        ) {
-          relativeRuntimePath = `./${path.relative(
-            appDirectory,
-            serverRuntimePath,
-          )}`;
-        }
-
-        return {
-          source: {
-            alias: {
-              '@modern-js/runtime/server': relativeRuntimePath,
-            },
-          },
-        };
-      },
-      modifyEntryImports(input) {
-        // eslint-disable-next-line react-hooks/rules-of-hooks
-        const { appDirectory } = useAppContext();
-        const runtimePath = require.resolve(`@modern-js/runtime`, {
-          paths: [appDirectory],
-        });
-
-        const currentFile = bffExportsUtils.getPath();
-
-        const runtimeDir = path.dirname(runtimePath);
-
-        const relativeBffPath = path.relative(
-          path.dirname(currentFile),
-          path.join(runtimeDir, './exports/server'),
-        );
-        const relativeRuntimeModulePath = path.relative(
-          path.dirname(currentFile),
-          runtimeModulePath,
-        );
-
-        const relativeFramePath = path.relative(
-          path.dirname(currentFile),
-          require.resolve('koa'),
-        );
-
-        bffExportsUtils.addExport(`const bffRuntime = require('${relativeBffPath}');
-           const pluginRuntime = require('${relativeRuntimeModulePath}');
-           const Koa = require('${relativeFramePath}')
-           module.exports = {
-            Koa: Koa,
-             ...bffRuntime,
-             ...pluginRuntime
-           }
-          `);
-        return input;
-      },
-    };
-  },
-  { name: '@modern-js/plugin-koa' },
-);

package/src/context.ts

@@ -1,9 +0,0 @@
-import { createStorage } from '@modern-js/adapter-helpers';
-
-import type { Context } from 'koa';
-
-export type { Context };
-
-const { run, useContext } = createStorage<Context>();
-
-export { run, useContext };

package/src/index.ts

@@ -1,5 +0,0 @@
-// eslint-disable-next-line filenames/match-exported
-import plugin from './plugin';
-
-export * from './context';
-export default plugin;

package/src/plugin.ts

@@ -1,125 +0,0 @@
-import * as path from 'path';
-import Koa, { Middleware } from 'koa';
-import type Application from 'koa';
-import Router from 'koa-router';
-import koaBody from 'koa-body';
-import { createPlugin } from '@modern-js/server-plugin';
-import { requireModule } from '@modern-js/bff-utils';
-import { fs } from '@modern-js/utils';
-import { run } from './context';
-import registerRoutes from './registerRoutes';
-
-interface FrameConfig {
-  middleware: (Middleware | string)[];
-}
-
-const findAppModule = async (apiDir: string) => {
-  const exts = ['.ts', '.js'];
-  const paths = exts.map(ext => path.join(apiDir, `app${ext}`));
-
-  for (const filename of paths) {
-    if (await fs.pathExists(filename)) {
-      return requireModule(filename);
-    }
-  }
-
-  return null;
-};
-
-const initMiddlewares = (
-  middleware: (Middleware | string)[],
-  app: Application,
-) => {
-  middleware.forEach(middlewareItem => {
-    const middlewareFunc =
-      typeof middlewareItem === 'string'
-        ? requireModule(middlewareItem)
-        : middlewareItem;
-    app.use(middlewareFunc);
-  });
-};
-
-export type Mode = 'function' | 'framework';
-
-export default createPlugin(
-  () => ({
-    // eslint-disable-next-line max-statements
-    async prepareApiServer({ pwd, mode, config, prefix }) {
-      let app: Application;
-      const router = new Router();
-      const apiDir = path.join(pwd, './api');
-
-      if (mode === 'framework') {
-        app = await findAppModule(apiDir);
-        if (!(app instanceof Koa)) {
-          app = new Koa();
-          app.use(koaBody());
-        }
-
-        if (config) {
-          const { middleware } = config as FrameConfig;
-          initMiddlewares(middleware, app);
-        }
-
-        app.use(run);
-        registerRoutes(router, prefix as string);
-      } else if (mode === 'function') {
-        app = new Koa();
-        app.use(koaBody());
-        if (config) {
-          const { middleware } = config as FrameConfig;
-          initMiddlewares(middleware, app);
-        }
-
-        app.use(run);
-        registerRoutes(router, prefix as string);
-      } else {
-        throw new Error(`mode must be function or framework`);
-      }
-
-      app.use(router.routes());
-
-      return (req, res) => {
-        app.on('error', err => {
-          if (err) {
-            throw err;
-          }
-        });
-        return Promise.resolve(app.callback()(req, res));
-      };
-    },
-    prepareWebServer({ config }) {
-      const app: Application = new Koa();
-
-      app.use(async (ctx, next) => {
-        await next();
-        if (!ctx.body) {
-          // restore statusCode
-          if (ctx.res.statusCode === 404) {
-            ctx.res.statusCode = 200;
-          }
-          ctx.respond = false;
-        }
-      });
-
-      app.use(koaBody());
-      if (config) {
-        const { middleware } = config as FrameConfig;
-        initMiddlewares(middleware, app);
-      }
-
-      return (req, res) => {
-        app.on('error', err => {
-          if (err) {
-            throw err;
-          }
-        });
-        return Promise.resolve(app.callback()(req, res));
-      };
-    },
-  }),
-  {
-    name: '@modern-js/plugin-koa',
-    pre: ['@modern-js/plugin-bff'],
-  },
-) as any;

package/src/registerRoutes.ts

@@ -1,109 +0,0 @@
-import { HttpMethod, useAPIHandlerInfos } from '@modern-js/bff-utils';
-import { isSchemaHandler, InputType } from '@modern-js/bff-runtime';
-import Router from 'koa-router';
-import { Context } from 'koa';
-import typeIs from 'type-is';
-import formidable from 'formidable';
-import { sortDynamicRoutes } from '@modern-js/adapter-helpers';
-import { createDebugger } from '@modern-js/utils';
-
-const debug = createDebugger('koa');
-
-const registerRoutes = (router: Router, prefix?: string) => {
-  // eslint-disable-next-line react-hooks/rules-of-hooks
-  const handlerInfos = useAPIHandlerInfos();
-  sortDynamicRoutes(handlerInfos);
-  debug('handlerInfos', handlerInfos);
-
-  if (prefix) {
-    router.prefix(prefix);
-  }
-
-  handlerInfos.forEach(({ handler, method, name }) => {
-    const wrapedHandler = async (ctx: Context) => {
-      const input = await getInputFromRequest(ctx);
-
-      if (isSchemaHandler(handler)) {
-        const result = await handler(input);
-        if (result.type !== 'HandleSuccess') {
-          if (result.type === 'InputValidationError') {
-            // eslint-disable-next-line require-atomic-updates
-            ctx.status = 400;
-          } else {
-            // eslint-disable-next-line require-atomic-updates
-            ctx.status = 500;
-          }
-          // eslint-disable-next-line require-atomic-updates
-          ctx.body = result.message;
-        } else {
-          // eslint-disable-next-line require-atomic-updates
-          ctx.body = result.value;
-        }
-      } else {
-        const args = Object.values(input.params as any).concat(input);
-        // eslint-disable-next-line require-atomic-updates
-        ctx.type = 'json';
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-expect-error
-        // eslint-disable-next-line require-atomic-updates
-        ctx.body = await handler(...args);
-      }
-    };
-
-    Object.defineProperties(
-      wrapedHandler,
-      Object.getOwnPropertyDescriptors(handler),
-    );
-
-    if (isNormalMethod(method)) {
-      const routeName = method.toLowerCase();
-      (router as any)[routeName](name, wrapedHandler);
-    } else {
-      throw new Error(`Unknown HTTP Method: ${method}`);
-    }
-  });
-};
-
-const isNormalMethod = (method: string): method is HttpMethod =>
-  Object.keys(HttpMethod).includes(method);
-
-export default registerRoutes;
-
-const getInputFromRequest = async (ctx: Context): Promise<InputType> => {
-  const draft: Record<string, any> = {
-    params: ctx.params,
-    query: ctx.query,
-    headers: ctx.headers,
-    cookies: ctx.headers.cookie,
-  };
-
-  if (typeIs.is(ctx.request.type, ['application/json'])) {
-    draft.data = ctx.request.body;
-  } else if (typeIs.is(ctx.request.type, ['multipart/form-data'])) {
-    draft.formData = await resvoleFormData(ctx);
-  } else if (
-    typeIs.is(ctx.request.type, ['application/x-www-form-urlencoded'])
-  ) {
-    draft.formUrlencoded = ctx.request.body;
-  } else {
-    draft.body = ctx.request.body;
-  }
-
-  return draft as any;
-};
-
-const resvoleFormData = (ctx: Context): Promise<Record<string, any>> => {
-  const form = formidable({ multiples: true });
-  return new Promise((resolve, reject) => {
-    form.parse(ctx.req, (err, fields, files) => {
-      if (err) {
-        reject(err);
-      }
-
-      resolve({
-        ...fields,
-        ...files,
-      });
-    });
-  });
-};

package/src/runtime.ts

@@ -1 +0,0 @@
-export { useContext } from './context';