ctx-router 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hyugorix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,130 @@
+# Context Router
+
+A TypeScript router library for handling context-based routing with type safety.
+
+## Installation
+
+```bash
+npm install ctx-router
+```
+
+Or using pnpm:
+
+```bash
+pnpm add ctx-router
+```
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { CtxRouter, TCtx, USER_ROLE } from "ctx-router";
+
+// Create a router instance
+const router = new CtxRouter<TCtx>();
+
+// Define a handler
+async function myHandler(ctx: TCtx): Promise<TCtx> {
+  // Your logic here
+  ctx.res.data = { message: "Hello World" };
+  return ctx;
+}
+
+// Register routes
+router.handle("GET", "/hello", myHandler);
+router.handle("POST", "/api/data", myHandler);
+
+// Handle errors
+router.onError(async (ctx, error) => {
+  console.error("Route error:", error);
+  ctx.res.code = "ERROR";
+  ctx.res.msg = "Something went wrong";
+  return ctx;
+});
+
+// Execute routes
+const result = await router.exec("GET", "/hello", context);
+```
+
+### Express.js Integration
+
+Here's how to use it with Express.js by splitting router configuration and server setup:
+
+#### `router.ts` - Router Configuration
+
+```typescript
+import { CtxRouter, TCtx } from "ctx-router";
+import * as api from "./api/index";
+
+// Set your router
+const router = new CtxRouter<TCtx>();
+
+router.handle("GET", "/health/ping", api.health.ping);
+router.handle("POST", "/user/update", api.user.update);
+router.handle("GET", "/user/detail", api.user.detail);
+
+router.onError(async (ctx, error) => {
+  console.error("Route error:", error);
+  ctx.res.code = "ERROR";
+  ctx.res.msg = "Something went wrong";
+  return ctx;
+});
+
+export { router };
+```
+
+#### `express.ts` - Express Server Setup
+
+```typescript
+import express, { Request, Response } from "express";
+import { toCtx, TCtx } from "ctx-router";
+import { router } from "./router";
+
+const app = express();
+
+function getHttpCode(ctx: TCtx) {
+  if (ctx.res.code === "OK") return 200;
+  if (ctx.res.code === "UNKNOWN_ERROR") return 500;
+  return 400;
+}
+
+app.all("/{*any}", async (req: Request, res: Response) => {
+  const ctx: TCtx = toCtx.fromExpress(req);
+  await router.exec(ctx.req.method, ctx.req.path, ctx);
+  res.type("application/json").status(getHttpCode(ctx)).send(ctx.res);
+});
+
+app.listen(3000, () => {
+  console.log(`Express server listening on port 3000`);
+});
+```
+
+## Exports
+
+### Classes
+
+- `CtxRouter<TContext>` - Main router class for handling context-based routing
+
+### Types
+
+- `TCtx` - Main context type with request, response, user, and metadata
+- `IBaseApi` - Interface for base API implementation
+
+### Constants
+
+- `USER_ROLE` - User role constants (user, admin, server, none)
+
+## API Reference
+
+### CtxRouter
+
+#### Methods
+
+- `handle(method: string, path: string, handler: (ctx: TContext) => Promise<TContext>)` - Register a route handler
+- `exec(method: string, path: string, ctx: TContext): Promise<TContext>` - Execute a route
+- `onError(handler: (ctx: TContext, error: Error | unknown) => Promise<TContext>)` - Set error handler
+
+## License
+
+MIT

package/dist/ctx/ctx.err.d.ts

@@ -0,0 +1,28 @@
+type TCtxErrorData = {
+    [key: string]: number | string | object | boolean | null;
+};
+type TCtxError = {
+    name: string;
+    msg: string;
+    data?: TCtxErrorData;
+    info?: unknown;
+};
+export declare class CtxError extends Error {
+    data: {
+        [key: string]: number | string | object | boolean | null;
+    };
+    info?: unknown;
+    constructor({ name, msg, data, info }: TCtxError);
+}
+type TResErr = Partial<Pick<TCtxError, "data" | "info" | "msg">>;
+export declare namespace ctxErr {
+    const general: {
+        unknown: (e?: TResErr) => CtxError;
+        responseNotSet: (e?: TResErr) => CtxError;
+        malformedRequestData: (e?: TResErr) => CtxError;
+        handlerNotFound: (e?: TResErr) => CtxError;
+        notAuthorized: (e?: TResErr) => CtxError;
+    };
+}
+export {};
+//# sourceMappingURL=ctx.err.d.ts.map

package/dist/ctx/ctx.err.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.err.d.ts","sourceRoot":"","sources":["../../src/ctx/ctx.err.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,GAAG;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CAC1D,CAAC;AACF,KAAK,SAAS,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AACF,qBAAa,QAAS,SAAQ,KAAK;IACjC,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IACnE,IAAI,CAAC,EAAE,OAAO,CAAC;gBACH,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,SAAS;CAMjD;AAED,KAAK,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;AAEjE,yBAAiB,MAAM,CAAC;IACf,MAAM,OAAO;sBACJ,OAAO;6BAMA,OAAO;mCAMD,OAAO;8BAMZ,OAAO;4BAMT,OAAO;KAM5B,CAAC;CACH"}

package/dist/ctx/ctx.err.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ctxErr = exports.CtxError = void 0;
+class CtxError extends Error {
+    constructor({ name, msg, data, info }) {
+        super(msg);
+        super.name = name;
+        this.data = data || {};
+        this.info = info;
+    }
+}
+exports.CtxError = CtxError;
+var ctxErr;
+(function (ctxErr) {
+    ctxErr.general = {
+        unknown: (e) => new CtxError({
+            name: "UNKNOWN_ERROR",
+            msg: "Something went wrong",
+            ...e,
+        }),
+        responseNotSet: (e) => new CtxError({
+            name: "RESPONSE_NOT_SET",
+            msg: "Response not set",
+            ...e,
+        }),
+        malformedRequestData: (e) => new CtxError({
+            name: "MALFORMED_REQUEST_DATA",
+            msg: "Malformed request data",
+            ...e,
+        }),
+        handlerNotFound: (e) => new CtxError({
+            name: "HANDLER_NOT_FOUND",
+            msg: "Handler not found",
+            ...e,
+        }),
+        notAuthorized: (e) => new CtxError({
+            name: "NOT_AUTHORIZED",
+            msg: "Not authorized",
+            ...e,
+        }),
+    };
+})(ctxErr || (exports.ctxErr = ctxErr = {}));
+//# sourceMappingURL=ctx.err.js.map

package/dist/ctx/ctx.err.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.err.js","sourceRoot":"","sources":["../../src/ctx/ctx.err.ts"],"names":[],"mappings":";;;AASA,MAAa,QAAS,SAAQ,KAAK;IAGjC,YAAY,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAa;QAC9C,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AATD,4BASC;AAID,IAAiB,MAAM,CAiCtB;AAjCD,WAAiB,MAAM;IACR,cAAO,GAAG;QACrB,OAAO,EAAE,CAAC,CAAW,EAAE,EAAE,CACvB,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,eAAe;YACrB,GAAG,EAAE,sBAAsB;YAC3B,GAAG,CAAC;SACL,CAAC;QACJ,cAAc,EAAE,CAAC,CAAW,EAAE,EAAE,CAC9B,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,kBAAkB;YACvB,GAAG,CAAC;SACL,CAAC;QACJ,oBAAoB,EAAE,CAAC,CAAW,EAAE,EAAE,CACpC,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,wBAAwB;YAC9B,GAAG,EAAE,wBAAwB;YAC7B,GAAG,CAAC;SACL,CAAC;QACJ,eAAe,EAAE,CAAC,CAAW,EAAE,EAAE,CAC/B,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,mBAAmB;YACzB,GAAG,EAAE,mBAAmB;YACxB,GAAG,CAAC;SACL,CAAC;QACJ,aAAa,EAAE,CAAC,CAAW,EAAE,EAAE,CAC7B,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,gBAAgB;YACtB,GAAG,EAAE,gBAAgB;YACrB,GAAG,CAAC;SACL,CAAC;KACL,CAAC;AACJ,CAAC,EAjCgB,MAAM,sBAAN,MAAM,QAiCtB"}

package/dist/ctx/ctx.router.d.ts

@@ -0,0 +1,9 @@
+import { CtxError } from "./ctx.err";
+export declare class CtxRouter<TContext> {
+    private routeObj;
+    private onErrorHandler;
+    exec(method: string, path: string, ctx: TContext): Promise<TContext>;
+    handle(method: string, path: string, handler: (ctx: TContext) => Promise<TContext>): void;
+    onError(handler: (ctx: TContext, error: CtxError | Error | unknown) => Promise<TContext>): void;
+}
+//# sourceMappingURL=ctx.router.d.ts.map

package/dist/ctx/ctx.router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.router.d.ts","sourceRoot":"","sources":["../../src/ctx/ctx.router.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,QAAQ,EAAE,MAAM,WAAW,CAAC;AAO7C,qBAAa,SAAS,CAAC,QAAQ;IAC7B,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,cAAc,CAMpB;IAEI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAc1E,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,CAAC,GAAG,EAAE,QAAQ,KAAK,OAAO,CAAC,QAAQ,CAAC;IAM/C,OAAO,CACL,OAAO,EAAE,CACP,GAAG,EAAE,QAAQ,EACb,KAAK,EAAE,QAAQ,GAAG,KAAK,GAAG,OAAO,KAC9B,OAAO,CAAC,QAAQ,CAAC;CAIzB"}

package/dist/ctx/ctx.router.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CtxRouter = void 0;
+const ctx_err_1 = require("./ctx.err");
+class CtxRouter {
+    constructor() {
+        this.routeObj = {};
+        this.onErrorHandler = async (ctx, error) => {
+            console.log("CtxError:onErrorHandler", error);
+            return ctx;
+        };
+    }
+    async exec(method, path, ctx) {
+        const handler = this.routeObj[method]?.[path];
+        if (!handler) {
+            throw ctx_err_1.ctxErr.general.handlerNotFound({
+                data: { method, path },
+            });
+        }
+        try {
+            return await handler(ctx);
+        }
+        catch (error) {
+            return await this.onErrorHandler(ctx, error);
+        }
+    }
+    handle(method, path, handler) {
+        const methodRoute = this.routeObj[method] || (this.routeObj[method] = {});
+        methodRoute[path] = handler;
+    }
+    onError(handler) {
+        this.onErrorHandler = handler;
+    }
+}
+exports.CtxRouter = CtxRouter;
+const ctxRouter = new CtxRouter();
+async function handler(ctx) {
+    console.log(ctx);
+    return ctx;
+}
+ctxRouter.handle("GET", "/", handler);
+ctxRouter.handle("GET", "/instance/ping", handler);
+ctxRouter.handle("GET", "/instance/health", handler);
+ctxRouter.handle("POST", "/route/test", handler);
+//# sourceMappingURL=ctx.router.js.map

package/dist/ctx/ctx.router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.router.js","sourceRoot":"","sources":["../../src/ctx/ctx.router.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAO7C,MAAa,SAAS;IAAtB;QACU,aAAQ,GAAwB,EAAE,CAAC;QACnC,mBAAc,GAGG,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YAC5C,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;IAiCJ,CAAC;IA/BC,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,IAAY,EAAE,GAAa;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,gBAAM,CAAC,OAAO,CAAC,eAAe,CAAC;gBACnC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;aACvB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,MAAM,CACJ,MAAc,EACd,IAAY,EACZ,OAA6C;QAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;QAC1E,WAAW,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,OAAO,CACL,OAGsB;QAEtB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;IAChC,CAAC;CACF;AAzCD,8BAyCC;AAED,MAAM,SAAS,GAAG,IAAI,SAAS,EAAQ,CAAC;AACxC,KAAK,UAAU,OAAO,CAAC,GAAS;IAC9B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AACtC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;AACnD,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;AACrD,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC"}

package/dist/ctx/ctx.types.d.ts

@@ -0,0 +1,96 @@
+export declare const USER_ROLE: {
+    readonly user: "user";
+    readonly admin: "admin";
+    readonly server: "server";
+    readonly none: "none";
+};
+type CtxReq = {
+    header: {
+        authorization?: string;
+        "x-ctx-device-name"?: string;
+        "x-ctx-device-id"?: string;
+        "x-ctx-os"?: string;
+        "x-ctx-app-version"?: string;
+        "x-ctx-api-version"?: string;
+        "x-ctx-session-id"?: string;
+        "x-ctx-seq"?: string;
+        "x-ctx-refresh-token"?: string;
+        [key: string]: string | string[] | undefined;
+    };
+    method: string;
+    path: string;
+    data: {
+        userId?: string;
+        [key: string]: unknown;
+    };
+    ip: string;
+    ips: string[];
+};
+type CtxRes = {
+    code: string;
+    msg: string;
+    data: {
+        [key: string]: unknown;
+    };
+    meta?: {
+        ctxId: string;
+        seq: number;
+        traceId: string;
+        spanId: string;
+        inTime: Date;
+        outTime: Date;
+        execTime: number;
+        owd: number;
+    };
+};
+type CtxMeta = {
+    serviceName: string;
+    instance: {
+        id: string;
+        createdAt: Date;
+        seq: number;
+        inflight: number;
+    };
+    ts: {
+        in: Date;
+        clientIn: Date;
+        owd: number;
+        out?: Date;
+        execTime?: number;
+    };
+    monitor: {
+        traceId: string;
+        spanId: string;
+        stdout: string[];
+        dbLog: string[];
+    };
+};
+type CtxUser = {
+    id: string;
+    role: keyof typeof USER_ROLE;
+    deviceName: string;
+    deviceId: string;
+    os: string;
+    appVersion: string;
+    sessionId: string;
+    seq: number;
+    apiVersion: string;
+    auth: {
+        token: string;
+        refresh: string;
+    };
+};
+export type TCtx = {
+    id: string;
+    meta: CtxMeta;
+    req: CtxReq;
+    res: CtxRes;
+    user: CtxUser;
+};
+export interface IBaseApi {
+    auth(ctx: TCtx): Promise<TCtx>;
+    validate(ctx: TCtx): Promise<TCtx>;
+    handle(ctx: TCtx): Promise<TCtx>;
+}
+export {};
+//# sourceMappingURL=ctx.types.d.ts.map

package/dist/ctx/ctx.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.types.d.ts","sourceRoot":"","sources":["../../src/ctx/ctx.types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;CAKZ,CAAC;AAEX,KAAK,MAAM,GAAG;IACZ,MAAM,EAAE;QACN,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;KAC9C,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAClD,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF,KAAK,MAAM,GAAG;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACjC,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,IAAI,CAAC;QACb,OAAO,EAAE,IAAI,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,IAAI,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,EAAE,EAAE;QACF,EAAE,EAAE,IAAI,CAAC;QACT,QAAQ,EAAE,IAAI,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,CAAC,EAAE,IAAI,CAAC;QACX,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,OAAO,SAAS,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,QAAQ,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClC"}

package/dist/ctx/ctx.types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_ROLE = void 0;
+exports.USER_ROLE = {
+    user: "user",
+    admin: "admin",
+    server: "server",
+    none: "none",
+};
+//# sourceMappingURL=ctx.types.js.map

package/dist/ctx/ctx.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.types.js","sourceRoot":"","sources":["../../src/ctx/ctx.types.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG;IACvB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;CACJ,CAAC"}

package/dist/ctx.types.d.ts

@@ -0,0 +1,96 @@
+export declare const USER_ROLE: {
+    readonly user: "user";
+    readonly admin: "admin";
+    readonly server: "server";
+    readonly none: "none";
+};
+type CtxReq = {
+    header: {
+        authorization?: string;
+        "x-ctx-device-name"?: string;
+        "x-ctx-device-id"?: string;
+        "x-ctx-os"?: string;
+        "x-ctx-app-version"?: string;
+        "x-ctx-api-version"?: string;
+        "x-ctx-session-id"?: string;
+        "x-ctx-seq"?: string;
+        "x-ctx-refresh-token"?: string;
+        [key: string]: string | string[] | undefined;
+    };
+    method: string;
+    path: string;
+    data: {
+        userId?: string;
+        [key: string]: unknown;
+    };
+    ip: string;
+    ips: string[];
+};
+type CtxRes = {
+    code: string;
+    msg: string;
+    data: {
+        [key: string]: unknown;
+    };
+    meta?: {
+        ctxId: string;
+        seq: number;
+        traceId: string;
+        spanId: string;
+        inTime: Date;
+        outTime: Date;
+        execTime: number;
+        owd: number;
+    };
+};
+type CtxMeta = {
+    serviceName: string;
+    instance: {
+        id: string;
+        createdAt: Date;
+        seq: number;
+        inflight: number;
+    };
+    ts: {
+        in: Date;
+        clientIn: Date;
+        owd: number;
+        out?: Date;
+        execTime?: number;
+    };
+    monitor: {
+        traceId: string;
+        spanId: string;
+        stdout: string[];
+        dbLog: string[];
+    };
+};
+type CtxUser = {
+    id: string;
+    role: keyof typeof USER_ROLE;
+    deviceName: string;
+    deviceId: string;
+    os: string;
+    appVersion: string;
+    sessionId: string;
+    seq: number;
+    apiVersion: string;
+    auth: {
+        token: string;
+        refresh: string;
+    };
+};
+export type TCtx = {
+    id: string;
+    meta: CtxMeta;
+    req: CtxReq;
+    res: CtxRes;
+    user: CtxUser;
+};
+export interface IBaseApi {
+    auth(ctx: TCtx): Promise<TCtx>;
+    validate(ctx: TCtx): Promise<TCtx>;
+    handle(ctx: TCtx): Promise<TCtx>;
+}
+export {};
+//# sourceMappingURL=ctx.types.d.ts.map

package/dist/ctx.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.types.d.ts","sourceRoot":"","sources":["../src/ctx.types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;CAKZ,CAAC;AAEX,KAAK,MAAM,GAAG;IACZ,MAAM,EAAE;QACN,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;KAC9C,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAClD,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF,KAAK,MAAM,GAAG;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACjC,IAAI,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,IAAI,CAAC;QACb,OAAO,EAAE,IAAI,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,IAAI,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,EAAE,EAAE;QACF,EAAE,EAAE,IAAI,CAAC;QACT,QAAQ,EAAE,IAAI,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,CAAC,EAAE,IAAI,CAAC;QACX,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;CACH,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,OAAO,SAAS,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,QAAQ,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClC"}

package/dist/ctx.types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_ROLE = void 0;
+exports.USER_ROLE = {
+    user: "user",
+    admin: "admin",
+    server: "server",
+    none: "none",
+};
+//# sourceMappingURL=ctx.types.js.map

package/dist/ctx.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.types.js","sourceRoot":"","sources":["../src/ctx.types.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG;IACvB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;CACJ,CAAC"}

package/dist/ctxErr.d.ts

@@ -0,0 +1,28 @@
+type TCtxErrorData = {
+    [key: string]: number | string | object | boolean | null;
+};
+type TCtxError = {
+    name: string;
+    msg: string;
+    data?: TCtxErrorData;
+    info?: unknown;
+};
+export declare class CtxError extends Error {
+    data: {
+        [key: string]: number | string | object | boolean | null;
+    };
+    info?: unknown;
+    constructor({ name, msg, data, info }: TCtxError);
+}
+type TResErr = Partial<Pick<TCtxError, "data" | "info" | "msg">>;
+export declare namespace ctxErr {
+    const general: {
+        unknown: (e?: TResErr) => CtxError;
+        responseNotSet: (e?: TResErr) => CtxError;
+        malformedRequestData: (e?: TResErr) => CtxError;
+        handlerNotFound: (e?: TResErr) => CtxError;
+        notAuthorized: (e?: TResErr) => CtxError;
+    };
+}
+export {};
+//# sourceMappingURL=ctxErr.d.ts.map

package/dist/ctxErr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctxErr.d.ts","sourceRoot":"","sources":["../src/ctxErr.ts"],"names":[],"mappings":"AAAA,KAAK,aAAa,GAAG;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CAC1D,CAAC;AACF,KAAK,SAAS,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AACF,qBAAa,QAAS,SAAQ,KAAK;IACjC,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IACnE,IAAI,CAAC,EAAE,OAAO,CAAC;gBACH,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,SAAS;CAMjD;AAED,KAAK,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;AAEjE,yBAAiB,MAAM,CAAC;IACf,MAAM,OAAO;sBACJ,OAAO;6BAMA,OAAO;mCAMD,OAAO;8BAMZ,OAAO;4BAMT,OAAO;KAM5B,CAAC;CACH"}

package/dist/ctxErr.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ctxErr = exports.CtxError = void 0;
+class CtxError extends Error {
+    constructor({ name, msg, data, info }) {
+        super(msg);
+        super.name = name;
+        this.data = data || {};
+        this.info = info;
+    }
+}
+exports.CtxError = CtxError;
+var ctxErr;
+(function (ctxErr) {
+    ctxErr.general = {
+        unknown: (e) => new CtxError({
+            name: "UNKNOWN_ERROR",
+            msg: "Something went wrong",
+            ...e,
+        }),
+        responseNotSet: (e) => new CtxError({
+            name: "RESPONSE_NOT_SET",
+            msg: "Response not set",
+            ...e,
+        }),
+        malformedRequestData: (e) => new CtxError({
+            name: "MALFORMED_REQUEST_DATA",
+            msg: "Malformed request data",
+            ...e,
+        }),
+        handlerNotFound: (e) => new CtxError({
+            name: "HANDLER_NOT_FOUND",
+            msg: "Handler not found",
+            ...e,
+        }),
+        notAuthorized: (e) => new CtxError({
+            name: "NOT_AUTHORIZED",
+            msg: "Not authorized",
+            ...e,
+        }),
+    };
+})(ctxErr || (exports.ctxErr = ctxErr = {}));
+//# sourceMappingURL=ctxErr.js.map

package/dist/ctxErr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctxErr.js","sourceRoot":"","sources":["../src/ctxErr.ts"],"names":[],"mappings":";;;AASA,MAAa,QAAS,SAAQ,KAAK;IAGjC,YAAY,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAa;QAC9C,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AATD,4BASC;AAID,IAAiB,MAAM,CAiCtB;AAjCD,WAAiB,MAAM;IACR,cAAO,GAAG;QACrB,OAAO,EAAE,CAAC,CAAW,EAAE,EAAE,CACvB,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,eAAe;YACrB,GAAG,EAAE,sBAAsB;YAC3B,GAAG,CAAC;SACL,CAAC;QACJ,cAAc,EAAE,CAAC,CAAW,EAAE,EAAE,CAC9B,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,kBAAkB;YACxB,GAAG,EAAE,kBAAkB;YACvB,GAAG,CAAC;SACL,CAAC;QACJ,oBAAoB,EAAE,CAAC,CAAW,EAAE,EAAE,CACpC,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,wBAAwB;YAC9B,GAAG,EAAE,wBAAwB;YAC7B,GAAG,CAAC;SACL,CAAC;QACJ,eAAe,EAAE,CAAC,CAAW,EAAE,EAAE,CAC/B,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,mBAAmB;YACzB,GAAG,EAAE,mBAAmB;YACxB,GAAG,CAAC;SACL,CAAC;QACJ,aAAa,EAAE,CAAC,CAAW,EAAE,EAAE,CAC7B,IAAI,QAAQ,CAAC;YACX,IAAI,EAAE,gBAAgB;YACtB,GAAG,EAAE,gBAAgB;YACrB,GAAG,CAAC;SACL,CAAC;KACL,CAAC;AACJ,CAAC,EAjCgB,MAAM,sBAAN,MAAM,QAiCtB"}

package/dist/example/api/health/healthPing.api.d.ts

@@ -0,0 +1,14 @@
+import { TCtx } from "../../..";
+export declare function execute(reqData: TReqData): Promise<TResData>;
+export declare function auth(ctx: TCtx): Promise<TCtx>;
+export declare function validate(ctx: TCtx): Promise<TReqData>;
+type TReqData = {
+    userId: string;
+    pingAt: Date;
+};
+type TResData = {
+    pingAt: Date;
+    pongAt: Date;
+};
+export {};
+//# sourceMappingURL=healthPing.api.d.ts.map

package/dist/example/api/health/healthPing.api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthPing.api.d.ts","sourceRoot":"","sources":["../../../../src/example/api/health/healthPing.api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAa,MAAM,UAAU,CAAC;AAG3C,wBAAsB,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAMlE;AAED,wBAAsB,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAOnD;AAED,wBAAsB,QAAQ,CAAC,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,CAG3D;AAED,KAAK,QAAQ,GAAG;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AACF,KAAK,QAAQ,GAAG;IACd,MAAM,EAAE,IAAI,CAAC;IACb,MAAM,EAAE,IAAI,CAAC;CACd,CAAC"}

package/dist/example/api/health/healthPing.api.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execute = execute;
+exports.auth = auth;
+exports.validate = validate;
+const __1 = require("../../..");
+const ctx_err_1 = require("../../../ctx/ctx.err");
+async function execute(reqData) {
+    const pongAt = new Date();
+    return {
+        pingAt: reqData.pingAt,
+        pongAt,
+    };
+}
+async function auth(ctx) {
+    // authenticate the request, and return the context if the request is authenticated
+    // await authRequest(ctx);
+    if (__1.USER_ROLE.user === ctx.user.role)
+        return ctx;
+    if (__1.USER_ROLE.admin === ctx.user.role)
+        return ctx;
+    if (__1.USER_ROLE.server === ctx.user.role)
+        return ctx;
+    throw ctx_err_1.ctxErr.general.notAuthorized();
+}
+async function validate(ctx) {
+    // Validate request data and return the request data
+    return ctx.req.data;
+}
+//# sourceMappingURL=healthPing.api.js.map

package/dist/example/api/health/healthPing.api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthPing.api.js","sourceRoot":"","sources":["../../../../src/example/api/health/healthPing.api.ts"],"names":[],"mappings":";;AAGA,0BAMC;AAED,oBAOC;AAED,4BAGC;AAvBD,gCAA2C;AAC3C,kDAA8C;AAEvC,KAAK,UAAU,OAAO,CAAC,OAAiB;IAC7C,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;IAC1B,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM;KACP,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,IAAI,CAAC,GAAS;IAClC,mFAAmF;IACnF,0BAA0B;IAC1B,IAAI,aAAS,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI;QAAE,OAAO,GAAG,CAAC;IACjD,IAAI,aAAS,CAAC,KAAK,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI;QAAE,OAAO,GAAG,CAAC;IAClD,IAAI,aAAS,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI;QAAE,OAAO,GAAG,CAAC;IACnD,MAAM,gBAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;AACvC,CAAC;AAEM,KAAK,UAAU,QAAQ,CAAC,GAAS;IACtC,oDAAoD;IACpD,OAAO,GAAG,CAAC,GAAG,CAAC,IAAgB,CAAC;AAClC,CAAC"}