@modern-js/bff-core 1.0.1-beta.0

package/CHANGELOG.md

@@ -0,0 +1,224 @@
+# @modern-js/adapter-helpers
+
+## 1.2.4
+
+### Patch Changes
+
+- d32f35134: chore: add modern/jest/eslint/ts config files to .npmignore
+
+## 1.2.3
+
+### Patch Changes
+
+- 6cffe99d: chore:
+  remove react eslint rules for `modern-js` rule set.
+  add .eslintrc for each package to speed up linting
+- 60f7d8bf: feat: add tests dir to npmignore
+- befd9e5b: fix: compatible with babel-plugin-resolver's handling of relative paths on windows
+- 3bf4f8b0: feat: support start api server only
+
+## 1.2.2
+
+### Patch Changes
+
+- 55e18278: chore: remove unused dependencies and devDependencies
+
+## 1.2.1
+
+### Patch Changes
+
+- 83166714: change .npmignore
+
+## 1.2.0
+
+### Minor Changes
+
+- cfe11628: Make Modern.js self bootstraping
+
+## 1.1.1
+
+### Patch Changes
+
+- 0fa83663: support more .env files
+
+## 1.1.0
+
+### Minor Changes
+
+- 96119db2: Relese v1.1.0
+
+## 1.0.0
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 0fd196e: feat: fix bugs
+- 204c626: feat: initial
+- 63be0a5: fix: #118 #104
+
+## 1.0.0-rc.23
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 0fd196e: feat: fix bugs
+- 204c626: feat: initial
+- 63be0a5: fix: #118 #104
+
+## 1.0.0-rc.22
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 0fd196e: feat: fix bugs
+- 204c626: feat: initial
+- 63be0a5: fix: #118 #104
+
+## 1.0.0-rc.21
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 0fd196e: feat: fix bugs
+- 204c626: feat: initial
+- 63be0a5: fix: #118 #104
+
+## 1.0.0-rc.20
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- feat: fix bugs
+- 204c626: feat: initial
+- 63be0a5: fix: #118 #104
+
+## 1.0.0-rc.19
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 204c626: feat: initial
+- 63be0a5: fix: #118 #104
+
+## 1.0.0-rc.18
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 204c626: feat: initial
+- 63be0a5: fix: #118 #104
+
+## 1.0.0-rc.17
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 204c626: feat: initial
+- fix: #118 #104
+
+## 1.0.0-rc.16
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 204c626: feat: initial
+
+## 1.0.0-rc.15
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 30ac27c: feat: add generator package description
+- 204c626: feat: initial
+
+## 1.0.0-rc.14
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.13
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.12
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.11
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.10
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.9
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.8
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.7
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.6
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.5
+
+### Patch Changes
+
+- 224f7fe: fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.4
+
+### Patch Changes
+
+- fix server route match
+- 204c626: feat: initial
+
+## 1.0.0-rc.3
+
+### Patch Changes
+
+- feat: initial

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Modern.js
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,30 @@
+
+<p align="center">
+  <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>
+</p>
+<p align="center">
+现代 Web 工程体系
+  <br/>
+  <a href="https://modernjs.dev" target="blank">
+    modernjs.dev
+  </a>
+</p>
+<p align="center">
+  The meta-framework suite designed from scratch for frontend-focused modern web development
+</p>
+
+# Introduction
+
+> 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.
+
+- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)
+
+## Getting Started
+
+- [Quick Start](https://modernjs.dev/docs/start)
+- [Guides](https://modernjs.dev/docs/guides)
+- [API References](https://modernjs.dev/docs/apis)
+
+## Contributing
+
+- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)

package/dist/js/modern/api.js

@@ -0,0 +1,59 @@
+import 'reflect-metadata';
+import compose from 'koa-compose';
+import { validateFunction, HANDLER_WITH_META } from "./utils";
+export function Api(...args) {
+  const handler = args.pop();
+  validateFunction(handler, 'Apihandler');
+  const operators = args;
+  const metadataHelper = {
+    getMetadata(key) {
+      return Reflect.getMetadata(key, runner);
+    },
+
+    setMetadata(key, value) {
+      return Reflect.defineMetadata(key, value, runner);
+    }
+
+  };
+
+  for (const operator of operators) {
+    if (operator.metadata) {
+      operator.metadata(metadataHelper);
+    }
+  }
+
+  const validateHandlers = operators.filter(operator => operator.validate).map(operator => operator.validate);
+
+  async function runner(inputs) {
+    // 错误组合传给用户哪些信息？
+    // 取出来所有的 schema，然后做校验
+    // 包裹中间件，怎么根据不同框架去包裹?
+    // 需要满足的需求，可以关闭某一样 schema 的校验
+    // 可以关闭某一个字段的校验
+    // 可以设置校验函数以替换 zod ？类型怎么搞?
+    // 全局可配置校验函数
+    // middleware 多框架实现要支持在路由上配，但这样 middleware 就要在校验之前先执行了
+    // 简易模式适配怎么处理?
+    // 不同框架适配，响应怎么处理？都传入 co ntext 给这个函数？
+    // 如何不依赖 zod 库？支持用户自定义 schema 库？ Query，Data 实现可以统一代码，类型好像无解，除非这些函数是创建出来的，保证只有 http 中依赖 zod 吧
+    const executeHelper = {
+      result: null,
+
+      get inputs() {
+        return inputs;
+      }
+
+    };
+    const stack = [...validateHandlers];
+    stack.push(async (helper, next) => {
+      const res = await handler(inputs);
+      helper.result = res;
+      return next();
+    });
+    await compose(stack)(executeHelper);
+    return executeHelper.result;
+  }
+
+  runner[HANDLER_WITH_META] = true;
+  return runner;
+}

package/dist/js/modern/client/generate-client.js

@@ -0,0 +1,64 @@
+import * as path from 'path';
+import { ApiRouter } from "../router";
+import { Ok, Err } from "./result";
+export const DEFAULT_CLIENT_REQUEST_CREATOR = '@modern-js/create-request';
+export const generateClient = async ({
+  resourcePath,
+  apiDir,
+  prefix,
+  port,
+  target,
+  requestCreator,
+  fetcher,
+  requireResolve: _requireResolve = require.resolve
+}) => {
+  if (!requestCreator) {
+    // eslint-disable-next-line no-param-reassign
+    requestCreator = _requireResolve(`${DEFAULT_CLIENT_REQUEST_CREATOR}${target ? `/${target}` : ''}`).replace(/\\/g, '/');
+  } else {
+    // 这里约束传入的 requestCreator 包也必须有两个导出 client 和 server，因为目前的机制 client 和 server 要导出不同的 configure 函数；该 api 不对使用者暴露，后续可优化
+    let resolvedPath = requestCreator;
+
+    try {
+      resolvedPath = path.dirname(_requireResolve(requestCreator));
+    } catch (error) {} // eslint-disable-next-line no-param-reassign
+
+
+    requestCreator = `${resolvedPath}${target ? `/${target}` : ''}`.replace(/\\/g, '/');
+  }
+
+  const apiRouter = new ApiRouter({
+    apiDir,
+    prefix,
+    lambdaDir: apiDir
+  });
+  const handlerInfos = apiRouter.getSingleModuleHandlers(resourcePath);
+
+  if (!handlerInfos) {
+    return Err(`Cannot require module ${resourcePath}`);
+  }
+
+  let handlersCode = '';
+
+  for (const handlerInfo of handlerInfos) {
+    const {
+      name,
+      httpMethod,
+      routePath
+    } = handlerInfo;
+    let exportStatement = `const ${name} =`;
+
+    if (name.toLowerCase() === 'default') {
+      exportStatement = 'default';
+    }
+
+    const upperHttpMethod = httpMethod.toUpperCase();
+    const routeName = routePath;
+    handlersCode += `export ${exportStatement} createRequest('${routeName}', '${upperHttpMethod}', process.env.PORT || ${String(port)}${fetcher ? `, fetch` : ''});
+`;
+  }
+
+  const importCode = `import { createRequest } from '${requestCreator}';
+${fetcher ? `import { fetch } from '${fetcher}';\n` : ''}`;
+  return Ok(`${importCode}\n${handlersCode}`);
+};

package/dist/js/modern/client/index.js

@@ -0,0 +1 @@
+export * from "./generate-client";

package/dist/js/modern/client/result.js

@@ -0,0 +1,20 @@
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const Err = value => {
+  const err = {
+    kind: 'Err',
+    value,
+    isErr: true,
+    isOk: false
+  };
+  return err;
+}; // eslint-disable-next-line @typescript-eslint/no-redeclare
+
+export const Ok = value => {
+  const ok = {
+    kind: 'Ok',
+    value,
+    isErr: false,
+    isOk: true
+  };
+  return ok;
+};

package/dist/js/modern/errors/http.js

@@ -0,0 +1,13 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+export class HttpError extends Error {
+  constructor(status, message) {
+    super(message);
+
+    _defineProperty(this, "status", void 0);
+
+    this.status = status;
+  }
+
+}
+export class ValidationError extends HttpError {}

package/dist/js/modern/index.js

@@ -0,0 +1,7 @@
+export { Api } from "./api";
+export { HttpError, ValidationError } from "./errors/http";
+export * from "./router";
+export * from "./types";
+export * from "./utils";
+export * from "./client";
+export * from "./operators/http";

package/dist/js/modern/operators/http.js

@@ -0,0 +1,183 @@
+import { z } from 'zod';
+import { HttpMetadata, OperatorType, HttpMethod, TriggerType } from "../types";
+import { ValidationError } from "../errors/http";
+
+const validateInput = async (schema, input) => {
+  try {
+    await schema.parseAsync(input);
+  } catch (error) {
+    if (error instanceof z.ZodError) {
+      throw new ValidationError(400, error.message);
+    }
+
+    throw error;
+  }
+};
+
+export const createHttpOperator = method => {
+  return urlPath => {
+    return {
+      name: method,
+
+      metadata({
+        setMetadata
+      }) {
+        setMetadata(OperatorType.Trigger, {
+          type: TriggerType.Http,
+          path: urlPath,
+          method
+        });
+      }
+
+    };
+  };
+};
+export const Get = createHttpOperator(HttpMethod.Get);
+export const Post = createHttpOperator(HttpMethod.Post);
+export const Put = createHttpOperator(HttpMethod.Put);
+export const Delete = createHttpOperator(HttpMethod.Delete);
+export const Connect = createHttpOperator(HttpMethod.Connect);
+export const Trace = createHttpOperator(HttpMethod.Trace);
+export const Patch = createHttpOperator(HttpMethod.Patch);
+export const Option = createHttpOperator(HttpMethod.Option);
+export const Head = createHttpOperator(HttpMethod.Head);
+export const Data = schema => {
+  return {
+    name: HttpMetadata.Data,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(HttpMetadata.Data, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        data
+      } = inputs;
+      await validateInput(schema, data);
+      return next();
+    }
+
+  };
+};
+export const Query = schema => {
+  return {
+    name: HttpMetadata.Query,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(HttpMetadata.Query, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        query
+      } = inputs;
+      await validateInput(schema, query);
+      return next();
+    }
+
+  };
+};
+export const Params = schema => {
+  return {
+    name: HttpMetadata.Params,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(HttpMetadata.Params, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        params
+      } = inputs;
+      await validateInput(schema, params);
+      return next();
+    }
+
+  };
+};
+export const Headers = schema => {
+  return {
+    name: HttpMetadata.Headers,
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(HttpMetadata.Headers, schema);
+    },
+
+    async validate(helper, next) {
+      const {
+        inputs
+      } = helper;
+      const {
+        headers
+      } = inputs;
+      await validateInput(schema, headers);
+      return next();
+    }
+
+  };
+};
+export const HttpCode = statusCode => {
+  return {
+    name: 'HttpCode',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(HttpMetadata.StatusCode, statusCode);
+    }
+
+  };
+};
+export const SetHeaders = headers => {
+  return {
+    name: 'SetHeaders',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(HttpMetadata.ResponseHeaders, headers);
+    }
+
+  };
+};
+export const Redirect = url => {
+  return {
+    name: 'Redirect',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(HttpMetadata.Redirect, url);
+    }
+
+  };
+};
+export const Middleware = middleware => {
+  return {
+    name: 'Middleware',
+
+    metadata({
+      setMetadata
+    }) {
+      setMetadata(OperatorType.Middleware, middleware);
+    }
+
+  };
+};

package/dist/js/modern/router/constants.js

@@ -0,0 +1,13 @@
+import { HttpMethod } from "../types";
+export const AllHttpMethods = Object.values(HttpMethod);
+export let APIMode;
+
+(function (APIMode) {
+  APIMode["FARMEWORK"] = "FARMEWORK";
+  APIMode["FUNCTION"] = "FUNCTION";
+})(APIMode || (APIMode = {}));
+
+export const FRAMEWORK_MODE_LAMBDA_DIR = 'lambda';
+export const INDEX_SUFFIX = 'index';
+export const API_DIR = 'api';
+export const API_FILE_RULES = ['**/*.[tj]s', '!**/_*', '!**/_*/**/*.[tj]s', '!**/*.test.js', '!**/*.test.ts', '!**/*.d.ts', '!__test__/*.ts', '!__tests__/*.ts', '!node_modules/**', '!bootstrap.js'];