@modern-js/bff-runtime 1.2.0 → 1.2.3

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @modern-js/bff-runtime
 
+## 1.2.3
+
+### Patch Changes
+
+- d32f35134: chore: add modern/jest/eslint/ts config files to .npmignore
+- Updated dependencies [d32f35134]
+- Updated dependencies [1a30be07b]
+  - @modern-js/server-utils@1.2.6
+
+## 1.2.2
+
+### 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
+- Updated dependencies [6cffe99d]
+- Updated dependencies [04ae5262]
+- Updated dependencies [60f7d8bf]
+  - @modern-js/server-utils@1.2.3
+
+## 1.2.1
+
+### Patch Changes
+
+- 83166714: change .npmignore
+- Updated dependencies [83166714]
+  - @modern-js/server-utils@1.2.1
+
 ## 1.2.0
 
 ### Minor Changes

package/dist/js/treeshaking/match.js

@@ -1,11 +1,6 @@
-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; }
-
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/esm/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
-
-function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
-
 import { toSchemaCtor, Struct, NonStrict } from 'farrow-schema';
 import { createSchemaValidator } from 'farrow-schema/validator';
 import { HandleSuccess, InputValidationError, OutputValidationError } from "./response";

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.2.0",
+  "version": "1.2.3",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -29,14 +29,14 @@
   },
   "dependencies": {
     "@babel/runtime": "^7",
-    "@modern-js/server-utils": "^1.2.0",
+    "@modern-js/server-utils": "^1.2.6",
     "farrow-api": "^1.10.8",
     "farrow-http": "^1.10.8",
     "farrow-pipeline": "^1.10.6",
     "farrow-schema": "^1.10.8"
   },
   "devDependencies": {
-    "@types/jest": "^26",
+    "@types/jest": "^27",
     "@types/node": "^14",
     "@types/react": "^17",
     "@types/react-dom": "^17",
@@ -48,13 +48,34 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "types": "./dist/types/index.d.ts"
+    "access": "public"
+  },
+  "wireit": {
+    "build": {
+      "command": "modern build",
+      "files": [
+        "src/**/*",
+        "tsconfig.json",
+        "package.json"
+      ],
+      "output": [
+        "dist/**/*"
+      ]
+    },
+    "test": {
+      "command": "jest --passWithNoTests",
+      "files": [
+        "src/**/*",
+        "tsconfig.json",
+        "package.json"
+      ],
+      "output": []
+    }
   },
   "scripts": {
     "new": "modern new",
-    "build": "modern build",
-    "test": "jest --passWithNoTests"
+    "build": "wireit",
+    "test": "wireit"
   },
   "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/jest.config.js

@@ -1,8 +0,0 @@
-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,2 +0,0 @@
-/** @type {import('@modern-js/module-tools').UserConfig} */
-module.exports = {};

package/src/compatible.ts

@@ -1,8 +0,0 @@
-export type RequestOption<TQuery = never, TData = never> = ClearRecord<{
-  query: TQuery;
-  data: TData;
-}> & { dataType?: string };
-
-export type ClearRecord<O extends Record<string, any>> = {
-  [K in keyof O as O[K] extends never ? never : K]: O[K];
-};

package/src/index.ts

@@ -1,16 +0,0 @@
-export * from 'farrow-schema';
-export * from 'farrow-api';
-export * from 'farrow-pipeline';
-
-export { match, isHandler, isSchemaHandler } from './match';
-
-export type { Handler, SchemaHandler } from './match';
-export type { RequestSchema, TypeOfRequestSchema, InputType } from './request';
-export type {
-  HandleResult,
-  HandleSuccess,
-  InputValidationError,
-  OutputValidationError,
-} from './response';
-
-export type { RequestOption } from './compatible';

package/src/match.ts

@@ -1,146 +0,0 @@
-import { TypeOfRouterRequestField } from 'farrow-http/dist/router';
-import {
-  FieldDescriptors,
-  SchemaCtorInput,
-  toSchemaCtor,
-  Struct,
-  NonStrict,
-} from 'farrow-schema';
-import { MaybeAsync } from 'farrow-pipeline';
-import {
-  createSchemaValidator,
-  Validator,
-  ValidationError,
-} from 'farrow-schema/validator';
-
-import {
-  RequestSchema,
-  TypeOfRequestSchema,
-  PureTypeOfRequestSchema,
-} from './request';
-import {
-  HandleResult,
-  HandleSuccess,
-  InputValidationError,
-  OutputValidationError,
-} from './response';
-
-export type NormalHandler = (...args: any[]) => any;
-export type Handler<I, O> = (input: I) => MaybeAsync<O>;
-
-export type Schema<Req extends RequestSchema, Res extends SchemaCtorInput> = {
-  request: Req;
-  response: Res;
-  description?: string;
-  deprecated?: string;
-};
-
-const getErrorMessage = (error: ValidationError) => {
-  let { message } = error;
-
-  if (Array.isArray(error.path) && error.path.length > 0) {
-    message = `path: ${JSON.stringify(error.path)}\n${message}`;
-  }
-
-  return message;
-};
-
-const HANDLER_WITH_SCHEMA = 'HANDLER_WITH_SCHEMA';
-
-export type BaseSchemaHandler<
-  Req extends RequestSchema,
-  Res extends SchemaCtorInput,
-> = ((
-  input: TypeOfRequestSchema<Req>,
-) => Promise<HandleResult<TypeOfRouterRequestField<Res>>>) & {
-  schema: Schema<Req, Res>;
-  [HANDLER_WITH_SCHEMA]: true;
-};
-
-export type SchemaHandler<
-  Req extends RequestSchema,
-  Res extends SchemaCtorInput,
-> = ((
-  input: TypeOfRequestSchema<Req>,
-) => Promise<TypeOfRouterRequestField<Res>>) & {
-  schema: Schema<Req, Res>;
-  [HANDLER_WITH_SCHEMA]: true;
-};
-
-export const isSchemaHandler = (input: any): input is SchemaHandler<any, any> =>
-  input && input?.[HANDLER_WITH_SCHEMA] === true;
-
-export const isHandler = (input: any): input is Handler<any, any> =>
-  input && typeof input === 'function';
-
-export const baseMatch = <
-  Req extends RequestSchema,
-  Res extends SchemaCtorInput,
->(
-  schema: Schema<Req, Res>,
-  handler: Handler<TypeOfRequestSchema<Req>, TypeOfRouterRequestField<Res>>,
-): BaseSchemaHandler<Req, Res> => {
-  const validateApiInput = createRequestSchemaValidator(schema.request);
-
-  const validateApiOutput = createSchemaValidator(
-    toSchemaCtor(schema.response),
-  );
-
-  const handle = async (
-    input: TypeOfRequestSchema<Req>,
-  ): Promise<HandleResult<TypeOfRouterRequestField<Res>>> => {
-    const inputResult = validateApiInput(input);
-    if (inputResult.isErr) {
-      return InputValidationError(getErrorMessage(inputResult.value));
-    }
-
-    const output = await handler(input);
-
-    const outputResult = validateApiOutput(output);
-    if (outputResult.isErr) {
-      return OutputValidationError(getErrorMessage(outputResult.value));
-    }
-
-    return HandleSuccess(output);
-  };
-
-  return Object.assign(handle, {
-    schema,
-    [HANDLER_WITH_SCHEMA]: true as const,
-  });
-};
-
-export const match: <Req extends RequestSchema, Res extends SchemaCtorInput>(
-  schema: Schema<Req, Res>,
-  handler: Handler<PureTypeOfRequestSchema<Req>, TypeOfRouterRequestField<Res>>,
-) => SchemaHandler<Req, Res> = baseMatch as any;
-
-const createRequestSchemaValidator = <T extends RequestSchema>(schema: T) => {
-  const descriptors: FieldDescriptors = {};
-
-  if (schema.params) {
-    descriptors.params = schema.params;
-  }
-
-  if (schema.query) {
-    descriptors.query = schema.query;
-  }
-
-  if (schema.data) {
-    descriptors.data = schema.data;
-  }
-
-  if (schema.headers) {
-    descriptors.headers = schema.headers;
-  }
-
-  if (schema.cookies) {
-    descriptors.cookies = schema.cookies;
-  }
-
-  const RequestStruct = Struct(descriptors);
-
-  return createSchemaValidator(NonStrict(RequestStruct) as any) as Validator<
-    TypeOfRequestSchema<T>
-  >;
-};

package/src/request.ts

@@ -1,103 +0,0 @@
-import { RouterSchemaDescriptor } from 'farrow-http/dist/router';
-import { MarkReadOnlyDeep } from 'farrow-http/dist/types';
-import {
-  TypeOfFieldDescriptor,
-  TypeOfFieldDescriptors,
-  FieldDescriptor,
-  FieldDescriptors,
-} from 'farrow-schema';
-
-export type RequestBaseSchema = {
-  params?: RouterSchemaDescriptor;
-  query?: RouterSchemaDescriptor;
-  headers?: RouterSchemaDescriptor;
-  cookies?: RouterSchemaDescriptor;
-};
-
-export type RequestDataSchema = {
-  data?: RouterSchemaDescriptor;
-};
-
-export type RequestBodyType = {
-  body?: string;
-};
-
-export type PureRequestFormDataType = {
-  formData?: Record<string, any>;
-};
-export type RequestFormDataType = {
-  formData?: FormData;
-};
-export type RequestFormUrlencodedType = {
-  // eslint-disable-next-line node/prefer-global/url-search-params,node/no-unsupported-features/node-builtins
-  formUrlencoded?: URLSearchParams | Record<string, string> | string;
-};
-export type PureRequestFormUrlencodedType = {
-  formUrlencoded?: Record<string, string>;
-};
-
-export type RequestExtraType = RequestBodyType &
-  RequestFormDataType &
-  RequestFormUrlencodedType;
-
-export type PureRequestExtraType = RequestBodyType &
-  PureRequestFormDataType &
-  PureRequestFormUrlencodedType;
-
-export type RequestSchema = RequestBaseSchema & RequestDataSchema;
-
-export type TypeOfRequestField<T> = T extends string
-  ? string
-  : T extends FormData
-  ? FormData
-  : T extends FieldDescriptor
-  ? TypeOfFieldDescriptor<T>
-  : T extends FieldDescriptors
-  ? TypeOfFieldDescriptors<T>
-  : never;
-
-export type TypeOfRequestDataSchema<T extends RequestDataSchema> =
-  MarkReadOnlyDeep<
-    T extends { data: any }
-      ? Pick<
-          {
-            [key in keyof T]: TypeOfRequestField<T[key]>;
-          },
-          'data'
-        >
-      : RequestExtraType
-  >;
-
-export type TypeOfRequestSchema<T extends RequestSchema> = MarkReadOnlyDeep<
-  Omit<
-    {
-      [key in keyof T]: TypeOfRequestField<T[key]>;
-    },
-    'data'
-  > &
-    TypeOfRequestDataSchema<T>
->;
-
-export type PureTypeOfRequestDataSchema<T extends RequestDataSchema> =
-  MarkReadOnlyDeep<
-    T extends { data: any }
-      ? Pick<
-          {
-            [key in keyof T]: TypeOfRequestField<T[key]>;
-          },
-          'data'
-        >
-      : PureRequestExtraType
-  >;
-
-export type PureTypeOfRequestSchema<T extends RequestSchema> = MarkReadOnlyDeep<
-  Omit<
-    {
-      [key in keyof T]: TypeOfRequestField<T[key]>;
-    },
-    'data'
-  > &
-    PureTypeOfRequestDataSchema<T>
->;
-
-export type InputType = TypeOfRequestSchema<RequestSchema>;

package/src/response.ts

@@ -1,41 +0,0 @@
-export type HandleSuccess<T> = {
-  type: 'HandleSuccess';
-  value: T;
-};
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const HandleSuccess = <T>(output: T): HandleSuccess<T> => ({
-  type: 'HandleSuccess',
-  value: output,
-});
-
-export type InputValidationError = {
-  type: 'InputValidationError';
-  message: string;
-};
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const InputValidationError = (
-  message: string,
-): InputValidationError => ({
-  type: 'InputValidationError',
-  message,
-});
-
-export type OutputValidationError = {
-  type: 'OutputValidationError';
-  message: string;
-};
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export const OutputValidationError = (
-  message: string,
-): OutputValidationError => ({
-  type: 'OutputValidationError',
-  message,
-});
-
-export type HandleResult<T> =
-  | HandleSuccess<T>
-  | InputValidationError
-  | OutputValidationError;

package/tests/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['@modern-js'],
-  parserOptions: {
-    project: require.resolve('./tsconfig.json'),
-  },
-};

package/tests/match.test.ts

@@ -1,133 +0,0 @@
-import assert from 'assert';
-import { baseMatch } from '../src/match';
-import { match, isHandler, isSchemaHandler, Any } from '../src';
-
-describe('match', () => {
-  it('should work well', async () => {
-    const foo = baseMatch(
-      {
-        request: { data: { foo: Number } },
-        response: { foo: String },
-      },
-      input => ({ foo: String(input.data.foo) }),
-    );
-
-    const result = await foo({ data: { foo: 0 } });
-
-    expect(result.type).toBe('HandleSuccess');
-    assert(result.type === 'HandleSuccess');
-    expect(result.value.foo).toBe('0');
-  });
-
-  it('should support all file in request', async () => {
-    const foo = baseMatch(
-      {
-        request: {
-          data: { foo: Number },
-          params: { id: String },
-          query: { key: String },
-          headers: { 'Context-Length': String },
-          cookies: { sid: String },
-        },
-        response: { foo: String },
-      },
-      input => ({ foo: String(input.data.foo) }),
-    );
-
-    const result = await foo({
-      data: { foo: 0 },
-      params: { id: 'foo' },
-      query: { key: 'foo' },
-      headers: { 'Context-Length': '100' },
-      cookies: { sid: 'sid0' },
-    });
-
-    expect(result.type).toBe('HandleSuccess');
-    assert(result.type === 'HandleSuccess');
-    expect(result.value.foo).toBe('0');
-  });
-
-  it('should support body,formData,formUrlencoded when data is not exist', () => {
-    const foo = baseMatch(
-      {
-        request: {},
-        response: Any,
-      },
-      input => input,
-    );
-    foo({ body: 'test' });
-    foo({ formData: { foo: 'test' } as any });
-    foo({ formUrlencoded: { foo: 'test' } });
-  });
-
-  it('should fail when input does not match schema', async () => {
-    const foo = baseMatch(
-      {
-        request: { data: { foo: Number } },
-        response: { foo: String },
-      },
-      input => ({ foo: String(input.data.foo) }),
-    );
-
-    const result = await foo({ data: { foo: true as any } });
-
-    expect(result.type).toBe('InputValidationError');
-    assert(result.type === 'InputValidationError');
-    expect(result.message).toBe('path: ["data","foo"]\ntrue is not a number');
-  });
-
-  it('should fail when output does not match schema', async () => {
-    const foo = baseMatch(
-      {
-        request: { data: { foo: Number } },
-        response: { foo: String },
-      },
-      input => ({ foo: input.data.foo } as any),
-    );
-
-    const result = await foo({ data: { foo: 0 } });
-
-    expect(result.type).toBe('OutputValidationError');
-    assert(result.type === 'OutputValidationError');
-    expect(result.message).toBe('path: ["foo"]\n0 is not a string');
-  });
-
-  it('should type nest', async () => {
-    const getFoo = (input: { foo: string }) => input;
-
-    const foo = match(
-      {
-        request: { data: { foo: Number } },
-        response: { foo: String },
-      },
-      input => ({ foo: input.data.foo } as any),
-    );
-
-    const result = await foo({ data: { foo: 0 } });
-
-    getFoo(result);
-  });
-
-  it('isSchemaHandler', () => {
-    const foo = baseMatch(
-      {
-        request: { data: { foo: Number } },
-        response: { foo: String },
-      },
-      input => ({ foo: String(input.data.foo) }),
-    );
-
-    expect(isSchemaHandler(foo)).toBeTruthy();
-    expect(isSchemaHandler({})).toBeFalsy();
-    expect(isSchemaHandler('test')).toBeFalsy();
-    expect(isSchemaHandler(null)).toBeFalsy();
-  });
-
-  it('isHandler', () => {
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    expect(isHandler(() => {})).toBeTruthy();
-    expect(isHandler({})).toBeFalsy();
-    expect(isHandler('test')).toBeFalsy();
-    expect(isHandler(null)).toBeFalsy();
-  });
-});

package/tests/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "@modern-js/tsconfig/base",
-  "compilerOptions": {
-    "declaration": false,
-    "jsx": "preserve",
-    "baseUrl": "./",
-    "isolatedModules": true,
-    "paths": {}
-  }
-}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "@modern-js/tsconfig/base",
-  "compilerOptions": {
-    "declaration": false,
-    "jsx": "preserve",
-    "baseUrl": "./",
-    "isolatedModules": true,
-    "paths": {}
-  },
-  "include": ["src"]
-}