@modern-js/bff-core 1.21.2-beta.1 → 1.21.2-beta.2

package/dist/js/node/utils/index.js

@@ -0,0 +1,72 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  debug: true
+};
+Object.defineProperty(exports, "debug", {
+  enumerable: true,
+  get: function () {
+    return _debug.debug;
+  }
+});
+
+var _storage = require("./storage");
+
+Object.keys(_storage).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _storage[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _storage[key];
+    }
+  });
+});
+
+var _alias = require("./alias");
+
+Object.keys(_alias).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _alias[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _alias[key];
+    }
+  });
+});
+
+var _debug = require("./debug");
+
+var _meta = require("./meta");
+
+Object.keys(_meta).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _meta[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _meta[key];
+    }
+  });
+});
+
+var _validate = require("./validate");
+
+Object.keys(_validate).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _validate[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _validate[key];
+    }
+  });
+});

package/dist/js/node/utils/meta.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isWithMetaHandler = exports.HANDLER_WITH_META = void 0;
+const HANDLER_WITH_META = 'HANDLER_WITH_META';
+exports.HANDLER_WITH_META = HANDLER_WITH_META;
+
+const isWithMetaHandler = handler => {
+  return typeof handler === 'function' && handler[HANDLER_WITH_META];
+};
+
+exports.isWithMetaHandler = isWithMetaHandler;

package/dist/js/node/utils/storage.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createStorage = void 0;
+
+var ah = _interopRequireWildcard(require("async_hooks"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+const createStorage = () => {
+  let storage;
+
+  if (typeof ah.AsyncLocalStorage !== 'undefined') {
+    storage = new ah.AsyncLocalStorage();
+  }
+
+  const run = (context, cb) => {
+    if (!storage) {
+      throw new Error(`Unable to use async_hook, please confirm the node version >= 12.17
+        `);
+    }
+
+    return new Promise((resolve, reject) => {
+      storage.run(context, () => {
+        try {
+          return resolve(cb());
+        } catch (error) {
+          return reject(error);
+        }
+      });
+    });
+  };
+
+  const useContext = () => {
+    if (!storage) {
+      throw new Error(`Unable to use async_hook, please confirm the node version >= 12.17
+        `);
+    }
+
+    const context = storage.getStore();
+
+    if (!context) {
+      throw new Error(`Can't call useContext out of scope, it should be placed in the bff function`);
+    }
+
+    return context;
+  };
+
+  return {
+    run,
+    useContext
+  };
+};
+
+exports.createStorage = createStorage;

package/dist/js/node/utils/validate.js

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateFunction = exports.getTypeErrorMessage = exports.ERR_INVALID_ARG_TYPE = void 0;
+
+var _util = _interopRequireDefault(require("util"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// fork from https://github.com/nodejs/node/blob/master/lib/internal/errors.js
+const getTypeErrorMessage = actual => {
+  let msg = '';
+
+  if (actual == null) {
+    msg += `. Received ${actual}`;
+  } else if (typeof actual === 'function' && actual.name) {
+    msg += `. Received function ${actual.name}`;
+  } else if (typeof actual === 'object') {
+    var _actual$constructor;
+
+    if ((_actual$constructor = actual.constructor) !== null && _actual$constructor !== void 0 && _actual$constructor.name) {
+      msg += `. Received an instance of ${actual.constructor.name}`;
+    } else {
+      const inspected = _util.default.inspect(actual, {
+        depth: -1
+      });
+
+      msg += `. Received ${inspected}`;
+    }
+  } else {
+    let inspected = _util.default.inspect(actual, {
+      colors: false
+    });
+
+    if (inspected.length > 25) {
+      inspected = `${inspected.slice(0, 25)}...`;
+    }
+
+    msg += `. Received type ${typeof actual} (${inspected})`;
+  }
+
+  return msg;
+}; // eslint-disable-next-line @typescript-eslint/naming-convention
+
+
+exports.getTypeErrorMessage = getTypeErrorMessage;
+
+class ERR_INVALID_ARG_TYPE extends Error {
+  constructor(funcName, expectedType, actual) {
+    const message = `[ERR_INVALID_ARG_TYPE]: The '${funcName}' argument must be of type ${expectedType}${getTypeErrorMessage(actual)}`;
+    super(message);
+  }
+
+}
+
+exports.ERR_INVALID_ARG_TYPE = ERR_INVALID_ARG_TYPE;
+
+const validateFunction = (maybeFunc, name) => {
+  if (typeof maybeFunc !== 'function') {
+    throw new ERR_INVALID_ARG_TYPE(name, 'function', maybeFunc);
+  }
+
+  return true;
+};
+
+exports.validateFunction = validateFunction;

package/dist/types/api.d.ts

@@ -0,0 +1,3 @@
+import 'reflect-metadata';
+import type { ApiRunner, ArrayToObject, ExtractInputType, ExtractOuputType, Operator, MaybeAsync } from './types';
+export declare function Api<Operators extends Operator<any, any>[], Res extends MaybeAsync<any>>(...args: [...operators: Operators, handler: (arg: ArrayToObject<ExtractOuputType<Operators>>) => Res]): ApiRunner<ExtractInputType<Operators> extends void[] ? void : ArrayToObject<ExtractInputType<Operators>>, Res>;

package/dist/types/client/generate-client.d.ts

@@ -0,0 +1,24 @@
+import { Result } from './result';
+export declare type GenClientResult = Result<string>;
+export declare type GenClientOptions = {
+  resourcePath: string;
+  source: string;
+  apiDir: string;
+  prefix: string;
+  port: number;
+  requestCreator?: string;
+  fetcher?: string;
+  target?: string;
+  requireResolve?: typeof require.resolve;
+};
+export declare const DEFAULT_CLIENT_REQUEST_CREATOR = "@modern-js/create-request";
+export declare const generateClient: ({
+  resourcePath,
+  apiDir,
+  prefix,
+  port,
+  target,
+  requestCreator,
+  fetcher,
+  requireResolve
+}: GenClientOptions) => Promise<GenClientResult>;

package/dist/types/client/index.d.ts

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

package/dist/types/client/result.d.ts

@@ -0,0 +1,15 @@
+export declare type Err<T = unknown> = {
+  kind: 'Err';
+  value: T;
+  isErr: true;
+  isOk: false;
+};
+export declare type Ok<T = unknown> = {
+  kind: 'Ok';
+  value: T;
+  isErr: false;
+  isOk: true;
+};
+export declare type Result<T = unknown, E = string> = Err<E> | Ok<T>;
+export declare const Err: <E = string>(value: E) => Err<E>;
+export declare const Ok: <T, E = string>(value: T) => Result<T, E>;

package/dist/types/errors/http.d.ts

@@ -0,0 +1,8 @@
+export declare class HttpError extends Error {
+  status: number;
+  constructor(status: number, message: string);
+}
+export declare class ValidationError extends HttpError {
+  private code;
+  constructor(status: number, message: string);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export { Api } from './api';
+export { HttpError, ValidationError } from './errors/http';
+export * from './router';
+export * from './types';
+export * from './client';
+export * from './operators/http';
+export { getRelativeRuntimePath, HANDLER_WITH_META, isWithMetaHandler, createStorage, registerPaths } from './utils';

package/dist/types/operators/http.d.ts

@@ -0,0 +1,39 @@
+import type { z } from 'zod';
+import { Operator, HttpMethod, ResponseMetaType } from '../types';
+export interface ResponseMeta {
+  type: ResponseMetaType;
+  value: unknown;
+}
+export declare const createHttpOperator: (method: HttpMethod) => (urlPath: string) => Operator<void>;
+export declare const Get: (urlPath: string) => Operator<void>;
+export declare const Post: (urlPath: string) => Operator<void>;
+export declare const Put: (urlPath: string) => Operator<void>;
+export declare const Delete: (urlPath: string) => Operator<void>;
+export declare const Connect: (urlPath: string) => Operator<void>;
+export declare const Trace: (urlPath: string) => Operator<void>;
+export declare const Patch: (urlPath: string) => Operator<void>;
+export declare const Option: (urlPath: string) => Operator<void>;
+export declare const Head: (urlPath: string) => Operator<void>;
+export declare const Data: <Schema extends z.ZodType<any, z.ZodTypeDef, any>>(schema: Schema) => Operator<{
+  data: z.input<Schema>;
+}, {
+  data: z.output<Schema>;
+}>;
+export declare const Query: <Schema extends z.ZodType<any, z.ZodTypeDef, any>>(schema: Schema) => Operator<{
+  query: z.input<Schema>;
+}, {
+  query: z.output<Schema>;
+}>;
+export declare const Params: <Schema extends z.ZodType<any, z.ZodTypeDef, any>>(schema: Schema) => Operator<{
+  params: z.input<Schema>;
+}, {
+  params: z.output<Schema>;
+}>;
+export declare const Headers: <Schema extends z.ZodType<any, z.ZodTypeDef, any>>(schema: Schema) => Operator<{
+  headers: z.input<Schema>;
+}, {
+  headers: z.output<Schema>;
+}>;
+export declare const HttpCode: (statusCode: number) => Operator<void>;
+export declare const SetHeaders: (headers: Record<string, string>) => Operator<void>;
+export declare const Redirect: (url: string) => Operator<void>;

package/dist/types/router/constants.d.ts

@@ -0,0 +1,17 @@
+export declare const AllHttpMethods: string[];
+export declare enum APIMode {
+  /**
+   * 框架模式
+   */
+  FARMEWORK = "framework",
+
+  /**
+   * 函数模式
+   */
+  FUNCTION = "function",
+}
+export declare const FRAMEWORK_MODE_LAMBDA_DIR = "lambda";
+export declare const FRAMEWORK_MODE_APP_DIR = "app";
+export declare const INDEX_SUFFIX = "index";
+export declare const API_DIR = "api";
+export declare const API_FILE_RULES: string[];

package/dist/types/router/index.d.ts

@@ -0,0 +1,51 @@
+import 'reflect-metadata';
+import { HttpMethod } from '../types';
+import { APIMode } from './constants';
+import { ApiHandler, APIHandlerInfo } from './types';
+export * from './types';
+export * from './constants';
+export declare class ApiRouter {
+  private apiMode;
+  private apiDir;
+  private existLambdaDir;
+  private lambdaDir;
+  private prefix;
+  private apiFiles;
+  constructor({
+    apiDir,
+    lambdaDir,
+    prefix
+  }: {
+    apiDir: string;
+    lambdaDir?: string;
+    prefix?: string;
+  });
+  isExistLambda(): boolean;
+  getApiMode(): APIMode;
+  getLambdaDir(): string;
+  isApiFile(filename: string): boolean;
+  getSingleModuleHandlers(filename: string): APIHandlerInfo[] | null;
+  getHandlerInfo(filename: string, originFuncName: string, handler: ApiHandler): APIHandlerInfo | null;
+  getSafeRoutePath(filename: string, handler?: ApiHandler): string;
+  getRouteName(filename: string, handler?: ApiHandler): string;
+  getHttpMethod(originHandlerName: string, handler?: ApiHandler): HttpMethod | null;
+  loadApiFiles(): string[];
+  getApiFiles(): string[];
+  getApiHandlers(): APIHandlerInfo[];
+  /**
+   * 如果用户未传入或传入空串，默认为 /api
+   * 如果传入 /，则 prefix 为 /
+   */
+
+  private initPrefix;
+  private validateAbsolute;
+  private getExactApiMode;
+  private createExistChecker;
+  private getExactLambdaDir;
+  private getModuleInfos;
+  private getModuleInfo;
+  private getHandlerInfos;
+  private getModuleHandlerInfos;
+  private validateValidApifile;
+  private getRoutePath;
+}

package/dist/types/router/types.d.ts

@@ -0,0 +1,17 @@
+import { HttpMethod } from '../types';
+export declare type ModuleInfo = {
+  filename: string;
+  module: HandlerModule;
+};
+declare type Handler = (...args: any) => any | Promise<any>;
+export declare type ApiHandler = Handler;
+export declare type HandlerModule = Record<string, ApiHandler>;
+export declare type APIHandlerInfo = {
+  handler: ApiHandler;
+  name: string;
+  httpMethod: HttpMethod;
+  filename: string;
+  routeName: string;
+  routePath: string;
+};
+export {};

package/dist/types/router/utils.d.ts

@@ -0,0 +1,10 @@
+import { APIHandlerInfo, HandlerModule } from './types';
+declare type MaybeAsync<I> = I | Promise<I>;
+export declare type NormalHandler = (...args: any[]) => any;
+export declare type Handler<I, O> = (input: I) => MaybeAsync<O>;
+export declare const getFiles: (lambdaDir: string, rules: string | string[]) => string[];
+export declare const getPathFromFilename: (baseDir: string, filename: string) => string;
+export declare const isHandler: (input: any) => input is Handler<any, any>;
+export declare const requireHandlerModule: (modulePath: string) => HandlerModule;
+export declare const sortRoutes: (apiHandlers: APIHandlerInfo[]) => APIHandlerInfo[];
+export {};

package/dist/types/types.d.ts

@@ -0,0 +1,58 @@
+import { Merge } from 'type-fest';
+export declare enum OperatorType {
+  Trigger = 0,
+  Middleware = 1,
+}
+export declare enum TriggerType {
+  Http = 0,
+}
+export declare enum HttpMetadata {
+  Method = "METHOD",
+  Data = "DATA",
+  Query = "QUERY",
+  Params = "PARAMS",
+  Headers = "HEADERS",
+  Response = "RESPONSE",
+}
+export declare enum ResponseMetaType {
+  StatusCode = 0,
+  Redirect = 1,
+  Headers = 2,
+}
+export declare enum HttpMethod {
+  Get = "GET",
+  Post = "POST",
+  Put = "PUT",
+  Delete = "DELETE",
+  Connect = "CONNECT",
+  Trace = "TRACE",
+  Patch = "PATCH",
+  Option = "OPTION",
+  Head = "HEAD",
+}
+export declare type InputSchemaMeata = Extract<HttpMetadata, HttpMetadata.Data | HttpMetadata.Query | HttpMetadata.Headers | HttpMetadata.Params>;
+export declare type ExecuteFunc<Outputs> = (helper: ExecuteHelper<Outputs>, next: () => Promise<any>) => Promise<any>;
+export declare type ExecuteHelper<Outputs> = {
+  result?: any;
+  inputs: Outputs;
+};
+export declare type MetadataHelper = {
+  setMetadata: <T = any>(key: any, value: T) => void;
+  getMetadata: <T = any>(key: any) => T;
+};
+export declare type Operator<Input = any, Output = Input> = {
+  name: string;
+  inputType?: Input;
+  outputType?: Output;
+  metadata?: (helper: MetadataHelper) => void;
+  validate?: ExecuteFunc<Output>;
+  execute?: ExecuteFunc<Output>;
+};
+export declare type MaybeAsync<T> = Promise<T> | T;
+export declare type ApiRunner<Input extends object | void | unknown, Output extends MaybeAsync<any>> = (...args: Input extends void ? never : [input: Input]) => Output;
+export declare type NonNullable<T> = Exclude<T, null | undefined>;
+export declare type ExtractInputType<T> = { [key in keyof T]: T[key] extends Operator<any, any> ? NonNullable<T[key]['inputType']> : void };
+export declare type ExtractOuputType<T> = { [key in keyof T]: T[key] extends Operator<any, any> ? NonNullable<T[key]['outputType']> : void };
+export declare type ArrayToObject<T, R = {}> = T extends [infer First, ...infer Rest] ? First extends PromiseLike<infer PromiseValue> ? PromiseValue : First extends object ? Merge<First, ArrayToObject<Rest, R>> : ArrayToObject<Rest, R> : R;
+export declare type AsyncFunction = (...args: any[]) => Promise<any>;
+export declare const httpMethods: HttpMethod[];

package/dist/types/utils/alias.d.ts

@@ -0,0 +1,7 @@
+interface Paths {
+  [key: string]: string[] | string;
+}
+export declare const getRelativeRuntimePath: (appDirectory: string, serverRuntimePath: string) => string;
+export declare const createMatchPath: (paths: Paths) => (request: string) => string | null;
+export declare const registerPaths: (paths: Paths) => () => void;
+export {};

package/dist/types/utils/debug.d.ts

@@ -0,0 +1 @@
+export declare const debug: import("@modern-js/utils/compiled/debug").Debugger;

package/dist/types/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './storage';
+export * from './alias';
+export { debug } from './debug';
+export * from './meta';
+export * from './validate';

package/dist/types/utils/meta.d.ts

@@ -0,0 +1,2 @@
+export declare const HANDLER_WITH_META = "HANDLER_WITH_META";
+export declare const isWithMetaHandler: (handler: any) => any;

package/dist/types/utils/storage.d.ts

@@ -0,0 +1,5 @@
+declare const createStorage: <T>() => {
+  run: <O>(context: T, cb: () => O | Promise<O>) => Promise<O>;
+  useContext: () => T;
+};
+export { createStorage };

package/dist/types/utils/validate.d.ts

@@ -0,0 +1,5 @@
+export declare const getTypeErrorMessage: (actual: unknown) => string;
+export declare class ERR_INVALID_ARG_TYPE extends Error {
+  constructor(funcName: string, expectedType: string, actual: unknown);
+}
+export declare const validateFunction: (maybeFunc: unknown, name: string) => boolean;

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.21.2-beta.1",
+  "version": "1.21.2-beta.2",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -20,6 +20,7 @@
   "exports": {
     ".": {
       "jsnext:source": "./src/index.ts",
+      "types": "./dist/types/index.d.ts",
       "default": "./dist/js/node/index.js"
     }
   },