milkio 0.0.3 → 0.0.4

package/defines/define-http-handler.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import { configFramework, loggerPushTags, loggerSubmit, useLogger, loggerSubmitAll, runtime, MiddlewareEvent } from "..";
+import { configMilkio, loggerPushTags, loggerSubmit, useLogger, loggerSubmitAll, runtime, MiddlewareEvent } from "..";
 import type { ExecuteId, MilkioApp, Mixin } from "..";
 import { hanldeCatchError } from "../utils/handle-catch-error";
 import { routerHandler } from "../../../src/router";
@@ -33,7 +33,7 @@ export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOpti
     exit(1);
   });
 
-  const fetch = async (request: milkioHTTPRequest) => {
+  const fetch = async (request: MilkioHTTPRequest) => {
     const fullurl = new URL(request.request.url, `http://${request.request.headers.get("host") ?? "localhost"}`);
     const executeId = (options?.executeIdGenerator ? await options.executeIdGenerator(request.request) : createUlid()) as ExecuteId;
     runtime.execute.executeIds.add(executeId);
@@ -50,14 +50,14 @@ export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOpti
       timein: new Date().getTime()
     });
 
-    const response: milkioHTTPResponse = {
+    const response: MilkioHTTPResponse = {
       body: "",
       status: 200,
       headers: {
         "Content-Type": "application/json",
-        "Access-Control-Allow-Methods": configFramework.corsAllowMethods ?? "*",
-        "Access-Control-Allow-Headers": configFramework.corsAllowHeaders ?? "*",
-        "Access-Control-Allow-Origin": configFramework.corsAllowOrigin ?? "*"
+        "Access-Control-Allow-Methods": configMilkio.corsAllowMethods ?? "*",
+        "Access-Control-Allow-Headers": configMilkio.corsAllowHeaders ?? "*",
+        "Access-Control-Allow-Origin": configMilkio.corsAllowOrigin ?? "*"
       }
     };
 
@@ -69,9 +69,9 @@ export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOpti
 
         return new Response("", {
           headers: {
-            "Access-Control-Allow-Methods": configFramework.corsAllowMethods ?? "*",
-            "Access-Control-Allow-Headers": configFramework.corsAllowHeaders ?? "*",
-            "Access-Control-Allow-Origin": configFramework.corsAllowOrigin ?? "*"
+            "Access-Control-Allow-Methods": configMilkio.corsAllowMethods ?? "*",
+            "Access-Control-Allow-Headers": configMilkio.corsAllowHeaders ?? "*",
+            "Access-Control-Allow-Origin": configMilkio.corsAllowOrigin ?? "*"
           }
         });
       }
@@ -80,7 +80,7 @@ export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOpti
 
       // Compatible with API gateway's ability to differentiate versions by path
       // see: /src/config/ConfigProgram.ts in "ignorePathLevel"
-      if (configFramework.ignorePathLevel !== 0) path = path.slice(configFramework.ignorePathLevel);
+      if (configMilkio.ignorePathLevel !== 0) path = path.slice(configMilkio.ignorePathLevel);
 
       let pathstr = path.join("/") as keyof (typeof schema)["apiMethodsSchema"];
 
@@ -92,7 +92,7 @@ export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOpti
           loggerPushTags(executeId, {
             body: rawbody || "no body"
           });
-          response.body = `{"executeId":"${executeId}","success":false,"fail":{"code":"NOT_FOUND","message":${JSON.stringify(failCode["NOT_FOUND"]())}}}`;
+          response.body = `{"executeId":"${executeId}","success":false,"fail":{"code":"NOT_FOUND","message":${JSON.stringify(failCode.NOT_FOUND())}}}`;
 
           loggerPushTags(executeId, {
             status: response.status,
@@ -188,11 +188,11 @@ export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOpti
   return fetch;
 }
 
-export type milkioHTTPRequest = {
+export type MilkioHTTPRequest = {
   request: Request;
 };
 
-export type milkioHTTPResponse = Mixin<
+export type MilkioHTTPResponse = Mixin<
   ResponseInit,
   {
     //

package/kernel/config.ts

@@ -1,13 +1,12 @@
 import { cwd, env } from "node:process";
 import { envToBoolean, envToNumber, envToString } from "..";
 
-export const configFramework = {
+export const configMilkio = {
   cwd: cwd(),
   port: envToNumber(env.PORT, 9000),
   milkioRunMode: envToString(env.milkio_RUN_MODE, "DEFAULT"),
   milkioTest: envToString(env.milkio_TEST, ""),
   debug: envToBoolean(env.DEBUG, false),
-  redisUrl: envToString(env.REDIS_URL, "redis://:123456@your-not-redis-url:6379"),
   ignorePathLevel: envToNumber(env.IGNORE_PATH_LEVEL, 0),
   corsAllowMethods: envToString(env.CORS_ALLOW_METHODS, "*"),
   corsAllowHeaders: envToString(env.CORS_ALLOW_HEADERS, "*"),

package/kernel/context.ts

@@ -1,5 +1,5 @@
 import type { URL } from "node:url";
-import type { ExecuteId, Logger, milkioHTTPResponse } from "..";
+import type { ExecuteId, Logger, MilkioHTTPResponse } from "..";
 
 export type MilkioContext = {
   path: string;
@@ -20,5 +20,5 @@ export type FrameworkHTTPDetail = {
   fullurl: URL;
   ip: string;
   request: Request;
-  response: milkioHTTPResponse;
+  response: MilkioHTTPResponse;
 };

package/kernel/fail.ts

@@ -4,7 +4,7 @@ export function reject<Code extends keyof typeof failCode, FailData extends (typ
   // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-argument
   const message = failCode[code]?.(data as any) ?? "";
   const error = {
-    name: "milkioReject",
+    name: "MilkioReject",
     code,
     message,
     data,
@@ -16,7 +16,7 @@ export function reject<Code extends keyof typeof failCode, FailData extends (typ
   return error;
 }
 
-export type milkioReject = ReturnType<typeof reject>;
+export type MilkioReject = ReturnType<typeof reject>;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type MilkioFailCode = Record<string, (arg: any) => string>;

package/kernel/milkio.ts

@@ -47,7 +47,7 @@ export async function createMilkioApp(MilkioAppOptions: MilkioAppOptions = {}) {
 
   if (MilkioAppOptions.enableMaxRunningTimeoutLimit && MilkioAppOptions.enableMaxRunningTimeoutLimit >= 1) {
     setTimeout(() => {
-      console.log('❌ milkio reached the limit of "maxRunningTimeout" in the options and automatically exited.');
+      console.log('❌ Milkio reached the limit of "maxRunningTimeout" in the options and automatically exited.');
       exit(0);
     }, MilkioAppOptions.enableMaxRunningTimeoutLimit * 60 * 1000);
     runtime.maxRunningTimeout.enable = true;
@@ -137,7 +137,7 @@ async function _executeCore<Path extends keyof (typeof schema)["apiMethodsTypeSc
 
   if (runtime.maxRequest.enable) {
     if (runtime.maxRequest.counter >= runtime.maxRequest.expected) {
-      console.log("❌ milkio reached the limit of 'maxRequest' in the options and automatically exited.");
+      console.log("❌ Milkio reached the limit of 'maxRequest' in the options and automatically exited.");
       exit(0);
     }
     runtime.maxRequest.counter++;
@@ -149,7 +149,7 @@ async function _executeCore<Path extends keyof (typeof schema)["apiMethodsTypeSc
       success: false,
       fail: {
         code: "NOT_FOUND",
-        message: failCode["NOT_FOUND"](),
+        message: failCode.NOT_FOUND(),
         data: undefined
       }
     } satisfies ExecuteResult<Result>;

package/kernel/validate.ts

@@ -5,7 +5,7 @@ export function _validate(validator: IValidation.IFailure | IValidation.ISuccess
   if (validator.success) return;
   const error = validator.errors[0];
 
-  throw reject("PARAMS_TYPE_ERROR", {
+  throw reject("TYPE_SAFE_ERROR", {
     path: error.path,
     expected: error.expected,
     value: error.value

package/package.json

@@ -2,7 +2,7 @@
   "name": "milkio",
   "type": "module",
   "module": "index.ts",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "peerDependencies": {
     "typescript": "^5.4.2"
   },

package/utils/handle-catch-error.ts

@@ -9,8 +9,8 @@ export function hanldeCatchError(error: any, executeId: ExecuteId): ExecuteResul
   if (error.stack) logger.error("\nError Stack: ", error.stack);
   else logger.error("\nError Stack: ", error);
 
-  if (error.name !== "milkioReject") {
-    // If it is not milkioReject, it is considered an internal server error that should not be exposed
+  if (error.name !== "MilkioReject") {
+    // If it is not MilkioReject, it is considered an internal server error that should not be exposed
     logger.error(`FailCode: INTERNAL_SERVER_ERROR`);
 
     return {
@@ -18,7 +18,7 @@ export function hanldeCatchError(error: any, executeId: ExecuteId): ExecuteResul
       success: false,
       fail: {
         code: "INTERNAL_SERVER_ERROR",
-        message: failCode["INTERNAL_SERVER_ERROR"](),
+        message: failCode.INTERNAL_SERVER_ERROR(),
         data: undefined
       }
     };