milkio 0.0.2 → 0.0.4

package/defines/define-api-test-handler.ts

@@ -1,9 +1,9 @@
 /* eslint-disable @typescript-eslint/no-unsafe-argument, no-console, @typescript-eslint/no-explicit-any */
 import { exit } from "node:process";
 import schema from "../../../generate/api-schema";
-import { type milkioApp } from "..";
+import { type MilkioApp } from "..";
 
-export const defineApiTestHandler = async <Paths extends Array<keyof (typeof schema)["apiTestsSchema"]>>(app: milkioApp, paths: Paths | string | 1 | undefined) => {
+export const defineApiTestHandler = async <Paths extends Array<keyof (typeof schema)["apiTestsSchema"]>>(app: MilkioApp, paths: Paths | string | 1 | undefined) => {
   console.log(`🧊 Milkio Api Testing..\n`);
 
   if (!paths) {

package/defines/define-http-handler.ts

@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
-import { configFramework, loggerPushTags, loggerSubmit, useLogger, loggerSubmitAll, runtime, MiddlewareEvent } from "..";
-import type { ExecuteId, milkioApp, Mixin } 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";
 import schema from "../../../generate/api-schema";
@@ -20,7 +20,7 @@ export type ExecuteHttpServerOptions = {
   executeIdGenerator?: (request: Request) => string | Promise<string>;
 };
 
-export function defineHttpHandler(app: milkioApp, options: ExecuteHttpServerOptions = {}) {
+export function defineHttpHandler(app: MilkioApp, options: ExecuteHttpServerOptions = {}) {
   // If an unexpected error occurs, exit the process.
   // For modern production environments such as Serverless, Kubernetes, or Docker Compose:
   // The process will automatically restart after exiting.
@@ -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,7 +1,7 @@
 import type { URL } from "node:url";
-import type { ExecuteId, Logger, milkioHTTPResponse } from "..";
+import type { ExecuteId, Logger, MilkioHTTPResponse } from "..";
 
-export type FrameworkContext = {
+export type MilkioContext = {
   path: string;
   executeId: ExecuteId;
   headers: Headers;
@@ -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>;
+export type MilkioFailCode = Record<string, (arg: any) => string>;

package/kernel/middleware.ts

@@ -2,9 +2,9 @@
 
 import type { Context } from "../../../src/context";
 import type { FrameworkHTTPDetail } from "./context";
-import { type milkioApp } from "milkio";
+import { type MilkioApp } from "milkio";
 
-export type BootstrapMiddleware = (milkio: milkioApp) => Promise<void> | void;
+export type BootstrapMiddleware = (milkio: MilkioApp) => Promise<void> | void;
 export type BeforeExecuteMiddleware = (context: Context) => Promise<void> | void;
 export type AfterExecuteMiddleware = (context: Context, response: { value: unknown }) => Promise<void> | void;
 export type AfterHTTPRequestMiddleware = (headers: Headers, detail: FrameworkHTTPDetail) => Promise<void> | void;

package/kernel/milkio.ts

@@ -3,14 +3,14 @@ import { type MiddlewareOptions, _middlewares, MiddlewareEvent } from "./middlew
 import schema from "../../../generate/api-schema";
 import type { Context } from "../../../src/context";
 import { failCode } from "../../../src/fail-code";
-import type { FrameworkContext } from "./context";
+import type { MilkioContext } from "./context";
 import { type Mixin, type ExecuteId, type Fail, type FailEnumerates, loggerPushTags, loggerSubmit, runtime, TSON, type Logger, useLogger } from "..";
 import { hanldeCatchError } from "../utils/handle-catch-error";
 import { _validate } from "./validate";
 import { cwd, exit } from "node:process";
 import { createUlid } from "../utils/create-ulid";
 
-export type milkioAppOptions = {
+export type MilkioAppOptions = {
   /**
    * bootstraps
    * @description
@@ -39,39 +39,39 @@ export type milkioAppOptions = {
   enableMaxRunningTimeoutLimit?: number | null | undefined;
 };
 
-export async function createMilkioApp(milkioAppOptions: milkioAppOptions = {}) {
-  if (milkioAppOptions?.enableMaxRequestLimit && milkioAppOptions.enableMaxRequestLimit >= 1) {
-    runtime.maxRequest.expected = milkioAppOptions.enableMaxRequestLimit;
+export async function createMilkioApp(MilkioAppOptions: MilkioAppOptions = {}) {
+  if (MilkioAppOptions?.enableMaxRequestLimit && MilkioAppOptions.enableMaxRequestLimit >= 1) {
+    runtime.maxRequest.expected = MilkioAppOptions.enableMaxRequestLimit;
     runtime.maxRequest.enable = true;
   }
 
-  if (milkioAppOptions.enableMaxRunningTimeoutLimit && milkioAppOptions.enableMaxRunningTimeoutLimit >= 1) {
+  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);
+    }, MilkioAppOptions.enableMaxRunningTimeoutLimit * 60 * 1000);
     runtime.maxRunningTimeout.enable = true;
   }
 
-  const milkioApp = {
+  const MilkioApp = {
     execute: _execute,
     executeToJson: _executeToJson,
     _executeCore,
     _executeCoreToJson
   };
 
-  if (milkioAppOptions.bootstraps) {
-    await Promise.all(milkioAppOptions.bootstraps());
+  if (MilkioAppOptions.bootstraps) {
+    await Promise.all(MilkioAppOptions.bootstraps());
   }
 
-  if (milkioAppOptions.middlewares) {
+  if (MilkioAppOptions.middlewares) {
     MiddlewareEvent.define("bootstrap", (a, b) => a.index - b.index);
     MiddlewareEvent.define("beforeExecute", (a, b) => a.index - b.index);
     MiddlewareEvent.define("afterExecute", (a, b) => b.index - a.index);
     MiddlewareEvent.define("afterHTTPRequest", (a, b) => a.index - b.index);
     MiddlewareEvent.define("beforeHTTPResponse", (a, b) => b.index - a.index);
 
-    const middlewares = milkioAppOptions.middlewares();
+    const middlewares = MilkioAppOptions.middlewares();
 
     for (let index = 0; index < middlewares.length; index++) {
       const middlewareOptions = middlewares[index];
@@ -87,12 +87,12 @@ export async function createMilkioApp(milkioAppOptions: milkioAppOptions = {}) {
     }
     MiddlewareEvent._sort();
 
-    await MiddlewareEvent.handle("bootstrap", [milkioApp]);
+    await MiddlewareEvent.handle("bootstrap", [MilkioApp]);
   }
 
   console.log(`🧊 Milkio is running on : ${cwd()}`);
 
-  return milkioApp;
+  return MilkioApp;
 }
 
 async function _execute<Path extends keyof (typeof schema)["apiMethodsTypeSchema"], Result extends Awaited<ReturnType<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>>>(path: Path, params: Parameters<(typeof schema)["apiMethodsTypeSchema"][Path]["api"]["action"]>[0] | string, headersInit: Record<string, string> | Headers = {}, options?: ExecuteOptions): Promise<ExecuteResult<Result>> {
@@ -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++;
@@ -148,8 +148,8 @@ async function _executeCore<Path extends keyof (typeof schema)["apiMethodsTypeSc
       executeId,
       success: false,
       fail: {
-        code: "not-found",
-        message: failCode["not-found"](),
+        code: "NOT_FOUND",
+        message: failCode.NOT_FOUND(),
         data: undefined
       }
     } satisfies ExecuteResult<Result>;
@@ -257,7 +257,7 @@ export type ExecuteOptions = {
    * These are usually only fully implemented when called by an HTTP server
    * During testing or when calling between microservices, some or all of the values may be undefined
    */
-  detail?: FrameworkContext["detail"];
+  detail?: MilkioContext["detail"];
 };
 
 export type ExecuteCoreOptions = Mixin<

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("general-type-safe-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.2",
+  "version": "0.0.4",
   "peerDependencies": {
     "typescript": "^5.4.2"
   },

package/types.ts

@@ -3,7 +3,7 @@
 import { type createMilkioApp } from ".";
 import type { failCode } from "../../src/fail-code";
 
-export type milkioApp = Awaited<ReturnType<typeof createMilkioApp>>;
+export type MilkioApp = Awaited<ReturnType<typeof createMilkioApp>>;
 
 export type ExecuteId = string | "global";
 
@@ -19,7 +19,7 @@ export type Fail<FailCode extends keyof FailEnumerates> = {
   data: Parameters<FailEnumerates[FailCode]>[0];
 };
 
-export type milkioMeta = {
+export type MilkioMeta = {
   //
 };
 

package/utils/handle-catch-error.ts

@@ -9,16 +9,16 @@ 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
-    logger.error(`FailCode: internal-server-error`);
+  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 {
       executeId,
       success: false,
       fail: {
-        code: "internal-server-error",
-        message: failCode["internal-server-error"](),
+        code: "INTERNAL_SERVER_ERROR",
+        message: failCode.INTERNAL_SERVER_ERROR(),
         data: undefined
       }
     };