@midwayjs/core 3.0.0-beta.1 → 3.0.0-beta.13

package/dist/context/managedResolverFactory.js

@@ -56,14 +56,14 @@ class ManagedResolverFactory {
     resolveManaged(managed, originPropertyName) {
         const resolver = this.resolvers[managed.type];
         if (!resolver || resolver.type !== managed.type) {
-            throw new Error(`${managed.type} resolver is not exists!`);
+            throw new error_1.MidwayResolverMissingError(managed.type);
         }
         return resolver.resolve(managed, originPropertyName);
     }
     async resolveManagedAsync(managed, originPropertyName) {
         const resolver = this.resolvers[managed.type];
         if (!resolver || resolver.type !== managed.type) {
-            throw new Error(`${managed.type} resolver is not exists!`);
+            throw new error_1.MidwayResolverMissingError(managed.type);
         }
         return resolver.resolveAsync(managed, originPropertyName);
     }
@@ -89,7 +89,7 @@ class ManagedResolverFactory {
                 this.context.get(dep, args);
             }
         }
-        debugLog(`[core:container]: Create id = "${definition.name}" ${definition.id}.`);
+        debugLog(`[core]: Create id = "${definition.name}" ${definition.id}.`);
         const Clzz = definition.creator.load();
         let constructorArgs = [];
         if (args && Array.isArray(args) && args.length > 0) {
@@ -174,7 +174,7 @@ class ManagedResolverFactory {
                 await this.context.getAsync(dep, args);
             }
         }
-        debugLog(`[core:container]: Create id = "${definition.name}" ${definition.id}.`);
+        debugLog(`[core]: Create id = "${definition.name}" ${definition.id}.`);
         const Clzz = definition.creator.load();
         let constructorArgs = [];
         if (args && Array.isArray(args) && args.length > 0) {
@@ -187,7 +187,7 @@ class ManagedResolverFactory {
         inst = await definition.creator.doConstructAsync(Clzz, constructorArgs, this.context);
         if (!inst) {
             this.removeCreateStatus(definition, false);
-            throw new Error(`${definition.id} construct return undefined`);
+            throw new error_1.MidwayCommonError(`${definition.id} construct return undefined`);
         }
         // binding ctx object
         if (definition.isRequestScope() &&

package/dist/definitions/objectCreator.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ObjectCreator = void 0;
 const decorator_1 = require("@midwayjs/decorator");
+const error_1 = require("../error");
 class ObjectCreator {
     constructor(definition) {
         this.definition = definition;
@@ -87,12 +88,12 @@ class ObjectCreator {
         if (this.definition.initMethod && inst[this.definition.initMethod]) {
             if ((0, decorator_1.isGeneratorFunction)(inst[this.definition.initMethod]) ||
                 (0, decorator_1.isAsyncFunction)(inst[this.definition.initMethod])) {
-                throw new Error(`${this.definition.id} not valid by context.get, Use context.getAsync instead!`);
+                throw new error_1.MidwayUseWrongMethodError('context.get', 'context.getAsync', this.definition.id);
             }
             else {
                 const rt = inst[this.definition.initMethod].call(inst);
                 if ((0, decorator_1.isPromise)(rt)) {
-                    throw new Error(`${this.definition.id} not valid by context.get, Use context.getAsync instead!`);
+                    throw new error_1.MidwayUseWrongMethodError('context.get', 'context.getAsync', this.definition.id);
                 }
             }
         }

package/dist/error/base.d.ts

@@ -1,11 +1,32 @@
 interface ErrorOption {
-    cause: Error;
+    cause?: Error;
+    status?: number;
+}
+interface Convertable {
+    [key: string]: string | number;
 }
+declare type ConvertString<T extends Convertable, Group extends string> = {
+    [P in keyof T]: P extends string ? T[P] extends number ? `${Uppercase<Group>}_${T[P]}` : never : never;
+};
+/**
+ * Register error group and code, return the standard ErrorCode
+ * @param errorGroup
+ * @param errorCodeMapping
+ */
+export declare function registerErrorCode<T extends Convertable, G extends string>(errorGroup: G, errorCodeMapping: T): ConvertString<T, G>;
 export declare class MidwayError extends Error {
-    code: number;
+    code: number | string;
     cause: Error;
     constructor(message: string, options?: ErrorOption);
-    constructor(message: string, code: number, options?: ErrorOption);
+    constructor(message: string, code: string, options?: ErrorOption);
+}
+export declare type ResOrMessage = string | {
+    message: string;
+};
+export declare class MidwayHttpError extends MidwayError {
+    status: number;
+    constructor(resOrMessage: ResOrMessage, status: number);
+    constructor(resOrMessage: ResOrMessage, status: number, code: string, options?: ErrorOption);
 }
 export {};
 //# sourceMappingURL=base.d.ts.map

package/dist/error/base.js

@@ -1,13 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MidwayError = void 0;
-const code_1 = require("./code");
+exports.MidwayHttpError = exports.MidwayError = exports.registerErrorCode = void 0;
+const codeGroup = new Set();
+/**
+ * Register error group and code, return the standard ErrorCode
+ * @param errorGroup
+ * @param errorCodeMapping
+ */
+function registerErrorCode(errorGroup, errorCodeMapping) {
+    if (codeGroup.has(errorGroup)) {
+        throw new MidwayError(`Error group ${errorGroup} is duplicated, please check before adding.`);
+    }
+    else {
+        codeGroup.add(errorGroup);
+    }
+    const newCodeEnum = {};
+    // ERROR => GROUP_10000
+    for (const errKey in errorCodeMapping) {
+        newCodeEnum[errKey] =
+            errorGroup.toUpperCase() +
+                '_' +
+                String(errorCodeMapping[errKey]).toUpperCase();
+    }
+    return newCodeEnum;
+}
+exports.registerErrorCode = registerErrorCode;
 class MidwayError extends Error {
     constructor(message, code, options) {
         super(message);
-        if (typeof code !== 'number') {
+        if (!code || typeof code === 'object') {
             options = code;
-            code = code_1.FrameworkErrorEnum.UNKNOWN;
+            code = 'MIDWAY_10000';
         }
         this.name = this.constructor.name;
         this.code = code;
@@ -15,4 +38,11 @@ class MidwayError extends Error {
     }
 }
 exports.MidwayError = MidwayError;
+class MidwayHttpError extends MidwayError {
+    constructor(resOrMessage, status, code, options) {
+        super(typeof resOrMessage === 'string' ? resOrMessage : resOrMessage.message, code !== null && code !== void 0 ? code : String(status), options);
+        this.status = status;
+    }
+}
+exports.MidwayHttpError = MidwayHttpError;
 //# sourceMappingURL=base.js.map

package/dist/error/framework.d.ts

@@ -1,5 +1,17 @@
 import { MidwayError } from './base';
 import { ObjectIdentifier } from '@midwayjs/decorator';
+export declare const FrameworkErrorEnum: {
+    readonly UNKNOWN: "MIDWAY_10000";
+    readonly COMMON: "MIDWAY_10001";
+    readonly PARAM_TYPE: "MIDWAY_10002";
+    readonly DEFINITION_NOT_FOUND: "MIDWAY_10003";
+    readonly FEATURE_NO_LONGER_SUPPORTED: "MIDWAY_10004";
+    readonly FEATURE_NOT_IMPLEMENTED: "MIDWAY_10004";
+    readonly MISSING_CONFIG: "MIDWAY_10006";
+    readonly MISSING_RESOLVER: "MIDWAY_10007";
+    readonly DUPLICATE_ROUTER: "MIDWAY_10008";
+    readonly USE_WRONG_METHOD: "MIDWAY_10009";
+};
 export declare class MidwayCommonError extends MidwayError {
     constructor(message: string);
 }
@@ -15,7 +27,19 @@ export declare class MidwayDefinitionNotFoundError extends MidwayError {
 export declare class MidwayFeatureNoLongerSupportedError extends MidwayError {
     constructor(message?: string);
 }
-export declare class MidwayNoFrameworkFoundError extends MidwayError {
-    constructor();
+export declare class MidwayFeatureNotImplementedError extends MidwayError {
+    constructor(message?: string);
+}
+export declare class MidwayConfigMissingError extends MidwayError {
+    constructor(configKey: string);
+}
+export declare class MidwayResolverMissingError extends MidwayError {
+    constructor(type: string);
+}
+export declare class MidwayDuplicateRouteError extends MidwayError {
+    constructor(routerUrl: string, existPos: string, existPosOther: string);
+}
+export declare class MidwayUseWrongMethodError extends MidwayError {
+    constructor(wrongMethod: string, replacedMethod: string, describeKey?: string);
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/error/framework.js

@@ -1,23 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MidwayNoFrameworkFoundError = exports.MidwayFeatureNoLongerSupportedError = exports.MidwayDefinitionNotFoundError = exports.MidwayParameterError = exports.MidwayCommonError = void 0;
+exports.MidwayUseWrongMethodError = exports.MidwayDuplicateRouteError = exports.MidwayResolverMissingError = exports.MidwayConfigMissingError = exports.MidwayFeatureNotImplementedError = exports.MidwayFeatureNoLongerSupportedError = exports.MidwayDefinitionNotFoundError = exports.MidwayParameterError = exports.MidwayCommonError = exports.FrameworkErrorEnum = void 0;
 const base_1 = require("./base");
-const code_1 = require("./code");
+exports.FrameworkErrorEnum = (0, base_1.registerErrorCode)('midway', {
+    UNKNOWN: 10000,
+    COMMON: 10001,
+    PARAM_TYPE: 10002,
+    DEFINITION_NOT_FOUND: 10003,
+    FEATURE_NO_LONGER_SUPPORTED: 10004,
+    FEATURE_NOT_IMPLEMENTED: 10004,
+    MISSING_CONFIG: 10006,
+    MISSING_RESOLVER: 10007,
+    DUPLICATE_ROUTER: 10008,
+    USE_WRONG_METHOD: 10009,
+});
 class MidwayCommonError extends base_1.MidwayError {
     constructor(message) {
-        super(message, code_1.FrameworkErrorEnum.COMMON);
+        super(message, exports.FrameworkErrorEnum.COMMON);
     }
 }
 exports.MidwayCommonError = MidwayCommonError;
 class MidwayParameterError extends base_1.MidwayError {
     constructor(message) {
-        super(message !== null && message !== void 0 ? message : 'Parameter type not match', code_1.FrameworkErrorEnum.PARAM_TYPE);
+        super(message !== null && message !== void 0 ? message : 'Parameter type not match', exports.FrameworkErrorEnum.PARAM_TYPE);
     }
 }
 exports.MidwayParameterError = MidwayParameterError;
 class MidwayDefinitionNotFoundError extends base_1.MidwayError {
     constructor(identifier) {
-        super(`${identifier} is not valid in current context`, code_1.FrameworkErrorEnum.DEFINITION_NOT_FOUND);
+        super(`${identifier} is not valid in current context`, exports.FrameworkErrorEnum.DEFINITION_NOT_FOUND);
         this[MidwayDefinitionNotFoundError.type] =
             MidwayDefinitionNotFoundError.type;
     }
@@ -36,14 +47,41 @@ exports.MidwayDefinitionNotFoundError = MidwayDefinitionNotFoundError;
 MidwayDefinitionNotFoundError.type = Symbol.for('#NotFoundError');
 class MidwayFeatureNoLongerSupportedError extends base_1.MidwayError {
     constructor(message) {
-        super('This feature no longer supported \n' + message, code_1.FrameworkErrorEnum.FEATURE_NO_LONGER_SUPPORTED);
+        super('This feature no longer supported \n' + message, exports.FrameworkErrorEnum.FEATURE_NO_LONGER_SUPPORTED);
     }
 }
 exports.MidwayFeatureNoLongerSupportedError = MidwayFeatureNoLongerSupportedError;
-class MidwayNoFrameworkFoundError extends base_1.MidwayError {
-    constructor() {
-        super('You must add a component that contains @Framework at least, such as @midwayjs/web, @midwayjs/koa, etc.', code_1.FrameworkErrorEnum.NO_FRAMEWORK_FOUND);
+class MidwayFeatureNotImplementedError extends base_1.MidwayError {
+    constructor(message) {
+        super('This feature not implemented \n' + message, exports.FrameworkErrorEnum.FEATURE_NOT_IMPLEMENTED);
+    }
+}
+exports.MidwayFeatureNotImplementedError = MidwayFeatureNotImplementedError;
+class MidwayConfigMissingError extends base_1.MidwayError {
+    constructor(configKey) {
+        super(`Can't found config key "${configKey}" in your config, please set it first`, exports.FrameworkErrorEnum.MISSING_CONFIG);
+    }
+}
+exports.MidwayConfigMissingError = MidwayConfigMissingError;
+class MidwayResolverMissingError extends base_1.MidwayError {
+    constructor(type) {
+        super(`${type} resolver is not exists!`, exports.FrameworkErrorEnum.MISSING_RESOLVER);
+    }
+}
+exports.MidwayResolverMissingError = MidwayResolverMissingError;
+class MidwayDuplicateRouteError extends base_1.MidwayError {
+    constructor(routerUrl, existPos, existPosOther) {
+        super(`Duplicate router "${routerUrl}" at "${existPos}" and "${existPosOther}"`, exports.FrameworkErrorEnum.DUPLICATE_ROUTER);
+    }
+}
+exports.MidwayDuplicateRouteError = MidwayDuplicateRouteError;
+class MidwayUseWrongMethodError extends base_1.MidwayError {
+    constructor(wrongMethod, replacedMethod, describeKey) {
+        const text = describeKey
+            ? `${describeKey} not valid by ${wrongMethod}, Use ${replacedMethod} instead!`
+            : `You should not invoked by ${wrongMethod}, Use ${replacedMethod} instead!`;
+        super(text, exports.FrameworkErrorEnum.USE_WRONG_METHOD);
     }
 }
-exports.MidwayNoFrameworkFoundError = MidwayNoFrameworkFoundError;
+exports.MidwayUseWrongMethodError = MidwayUseWrongMethodError;
 //# sourceMappingURL=framework.js.map

package/dist/error/http.d.ts

@@ -1,41 +1,148 @@
-export declare class HttpError extends Error {
-    status: number;
-    constructor(response: any, status: any);
-}
-export declare class BadRequestError extends HttpError {
-    constructor(response: any);
-}
-export declare class UnauthorizedError extends HttpError {
-}
-export declare class NotFoundError extends HttpError {
-}
-export declare class ForbiddenError extends HttpError {
-}
-export declare class NotAcceptableError extends HttpError {
-}
-export declare class RequestTimeoutError extends HttpError {
-}
-export declare class ConflictError extends HttpError {
-}
-export declare class GoneError extends HttpError {
-}
-export declare class PayloadTooLargeError extends HttpError {
-}
-export declare class UnsupportedMediaTypeError extends HttpError {
-}
-export declare class UnprocessableError extends HttpError {
-}
-export declare class InternalServerErrorError extends HttpError {
-}
-declare class NotImplementedError extends HttpError {
-}
-export declare class BadGatewayError extends HttpError {
-}
-export declare class ServiceUnavailableError extends HttpError {
-}
-export declare class GatewayTimeoutError extends HttpError {
-}
-export declare const http: {
+import { MidwayHttpError, ResOrMessage } from './base';
+export declare enum HttpStatus {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLYHINTS = 103,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    AMBIGUOUS = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    I_AM_A_TEAPOT = 418,
+    MISDIRECTED = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    FAILED_DEPENDENCY = 424,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505
+}
+/**
+ * 400 http error, Means that the request can be fulfilled because of the bad syntax.
+ */
+export declare class BadRequestError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 401 http error, Means that the request was legal, but the server is rejecting to answer it. For the use when authentication is required and has failed or has not yet been provided.
+ */
+export declare class UnauthorizedError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 	4o4 http error, Means that the requested page cannot be found at the moment, but it may be available again in the future.
+ */
+export declare class NotFoundError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 403 http error, Means that the request is legal, but the server is rejecting to answer it.
+ */
+export declare class ForbiddenError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 406 http error, Means that the server can only generate an answer which the client doesn't accept.
+ */
+export declare class NotAcceptableError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 408 http error, Means that the server timed out waiting for the request.
+ */
+export declare class RequestTimeoutError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 409 http error, Means that the request cannot be completed, because of a conflict in the request.
+ */
+export declare class ConflictError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 410 http error, Means that the requested page is not available anymore.
+ */
+export declare class GoneError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 413 http error, Means that the request entity is too large and that's why the server won't accept the request.
+ */
+export declare class PayloadTooLargeError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 415 http error, Means that the media type is not supported and that's why the server won't accept the request.
+ */
+export declare class UnsupportedMediaTypeError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+export declare class UnprocessableError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 500 http error, Is a generic error and users receive this error message when there is no more suitable specific message.
+ */
+export declare class InternalServerErrorError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 501 http error, Means that the server doesn't recognize the request method or it lacks the ability to fulfill the request.
+ */
+declare class NotImplementedError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 502 http error, Means that the server was acting as a gateway or proxy and it received an invalid answer from the upstream server.
+ */
+export declare class BadGatewayError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 503 http error, Means that the server is not available now (It may be overloaded or down).
+ */
+export declare class ServiceUnavailableError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+/**
+ * 504 http error, Means that the server was acting as a gateway or proxy and it didn't get answer on time from the upstream server.
+ */
+export declare class GatewayTimeoutError extends MidwayHttpError {
+    constructor(resOrMessage?: ResOrMessage);
+}
+export declare const httpError: {
     BadRequestError: typeof BadRequestError;
     UnauthorizedError: typeof UnauthorizedError;
     NotFoundError: typeof NotFoundError;