koa-ts-core 0.0.9-beta.1 → 0.0.9-beta.3

package/dist/init/address.d.ts

@@ -1,8 +0,0 @@
-import Koa from "koa";
-/**
- * 初始化服务
- * @param app - Koa 应用实例
- * @returns - 可用的端口号
- */
-declare const initializeServer: (app: Koa) => Promise<void>;
-export default initializeServer;

package/dist/init/index.d.ts

@@ -1,16 +0,0 @@
-import Koa from "koa";
-import { TErrorCallback } from '../middleware/exception_middleware';
-import { appRouter } from '../router';
-import type { AuthRouterCallback } from '../types/route';
-export type TInitOPtions = Partial<{
-    koaInstance: Koa;
-    authCheckCallback: AuthRouterCallback;
-    catchErrorCallback: TErrorCallback;
-    registerHighPriorityMiddleware: (app: Koa) => void;
-}>;
-/**
- * 初始化core
- * @param {TInitOPtions} options
- * @returns {[Koa, typeof appRouter]} [app, appRouter]
- */
-export declare const initializeKoaApp: (options: TInitOPtions) => Promise<[Koa, typeof appRouter]>;

package/dist/init/register_controller.d.ts

@@ -1,9 +0,0 @@
-import type { AuthRouterCallback } from '../types/route';
-/**
- * 约定式控制器注册路由
- * @param controllerModulePath 控制器模块路径
- * @param validateModulePath 验证模块路径
- * @param authCallback 鉴权回调
- */
-declare const registerControllers: (authCheckCallback?: AuthRouterCallback) => void;
-export default registerControllers;

package/dist/init/register_env.d.ts

@@ -1,5 +0,0 @@
-/**
- * 初始化dotenv
- */
-declare const initializeDotenv: () => void;
-export default initializeDotenv;

package/dist/init/register_route.d.ts

@@ -1,10 +0,0 @@
-import { AuthRouterHandler, FilePathMeta, RouteConfig } from '../types/route';
-/**
- * 注册路由
- * @param validateModulePath 参数验证器路径
- * @param filePath 控制器文件路径
- * @param routesMap 路由映射
- * @param authCheckResult 鉴权结果处理函数
- */
-declare const registerRoute: (validateModulePath: string, filePath: FilePathMeta, routesMap: Map<string, RouteConfig>, authCheckResult: AuthRouterHandler) => void;
-export default registerRoute;

package/dist/init/render_doc.d.ts

@@ -1,2 +0,0 @@
-declare const generateDocHtml: () => Promise<string>;
-export default generateDocHtml;

package/dist/middleware/context_middleware.d.ts

@@ -1,15 +0,0 @@
-import type { Middleware } from "koa";
-/**
- * Koa 上下文存储中间件
- *
- * 功能：
- * 1. 为每个请求创建独立的上下文存储环境
- * 2. 确保后续中间件和业务逻辑可以安全访问当前请求的上下文
- * 3. 基于 AsyncLocalStorage 实现请求级别的数据隔离
- *
- * @param ctx Koa 上下文对象
- * @param next 后续中间件执行函数
- * @returns Promise<void>
- */
-declare const contextMiddleware: Middleware;
-export default contextMiddleware;

package/dist/middleware/exception_middleware.d.ts

@@ -1,10 +0,0 @@
-import BaseException from '../base/exception';
-import type Koa from "koa";
-export type TErrorCallback = (error: Error | BaseException, ctx: Koa.Context) => void;
-/**
- * 错误处理中间件
- * @param {TErrorCallback} catchCallback
- * @returns
- */
-declare const catchErrorMiddleware: (catchCallback?: TErrorCallback) => (ctx: Koa.Context, next: Koa.Next) => Promise<void>;
-export default catchErrorMiddleware;

package/dist/middleware/request_params_middleware.d.ts

@@ -1,7 +0,0 @@
-import { Middleware } from "koa";
-/**
- * 往global添加属性
- * @param ctx
- */
-declare const requestParamsMiddleware: Middleware;
-export default requestParamsMiddleware;

package/dist/router.d.ts

@@ -1,2 +0,0 @@
-import AppRouter from 'koa-router';
-export declare const appRouter: AppRouter<any, {}>;

package/dist/types/meta_data.d.ts

@@ -1,16 +0,0 @@
-export interface IMetaData {
-    method: string;
-    description: string;
-    path: string;
-    request: Request;
-    response: Response;
-}
-interface Response {
-    body: any;
-}
-interface Request {
-    header: Record<string, string>;
-    body: any;
-    query: any;
-}
-export {};

package/dist/types/route.d.ts

@@ -1,26 +0,0 @@
-import type { Context, Middleware } from "koa";
-import type { Dirent } from "fs";
-export type HttpMethod = "get" | "post" | "put" | "delete" | "patch" | "options";
-/** 文件路径元数据 */
-export interface FilePathMeta {
-    path: string;
-    name: string;
-    wholePath: string;
-}
-export type AuthRouterHandler = (isAuthRouter: boolean, ctx: Context) => Promise<boolean> | boolean;
-export type AuthRouterCallback = (params: {
-    filePath: FilePathMeta;
-    ctx: Context;
-}) => Promise<boolean> | boolean;
-export type WalkSyncHandler = (filePath: FilePathMeta, dirent: Dirent) => void;
-export interface RouteConfig {
-    path: string;
-    method?: HttpMethod;
-    /** 控制器函数（使用 Koa 标准 Middleware 类型） */
-    handler: Middleware;
-    functionName: string;
-    authRequired: boolean;
-    middlewares: Middleware[];
-    className: string;
-    apiPrePath: string;
-}

package/dist/utils/context_store.d.ts

@@ -1,8 +0,0 @@
-import { AsyncLocalStorage } from "async_hooks";
-import type { Context } from "koa";
-export declare const contextStore: AsyncLocalStorage<Context>;
-/**
- * 当前上下文
- * @returns
- */
-export declare const getCurrentContext: () => Context;

package/dist/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./rsp";
-export * from "./context_store";

package/dist/utils/path.d.ts

@@ -1,46 +0,0 @@
-import { FilePathMeta, WalkSyncHandler } from '../types/route';
-/**
- * 获取 src 模块的路径
- * @returns 模块路径对象
- */
-export declare const getSrcModulePaths: () => {
-    controllerModule: string;
-    validateModule: string;
-    viewModule: string;
-    docModule: string;
-};
-/**
- * 获取指定路径的默认导出
- * @param {string} filePath - 文件路径
- * @returns {T | undefined} - 文件的默认导出或 undefined
- */
-export declare const getDefaultExportFromFile: <T = any>(filePath: string) => T | undefined;
-/**
- * 递归同步遍历指定目录下的所有文件
- * @param {string} currentDirPath - 当前目录路径
- * @param {WalkSyncHandler} callback - 处理每个文件的回调函数
- */
-export declare function walkDirectorySync(currentDirPath: string, callback: WalkSyncHandler): void;
-/**
- * 根据文件路径和关键字部分生成路径的模块选项
- * @param {FilePathMeta} filePath - 文件路径元数据
- * @returns {Object} 包含控制器前缀、模块名和文件名的对象
- */
-export declare const generateOptionsByKeyPart: (filePath: FilePathMeta, keyPart: string) => {
-    pathPrefix: string;
-    moduleName: string;
-    name: string;
-};
-/**
- * 统一处理不同平台的文件路径格式，将路径转换为 '/test/file' 格式
- * @param {string} filePath - 原始文件路径
- * @returns {string} 转换后的文件路径
- */
-export declare const formatPathByPlatform: (filePath: string) => string;
-/**
- * 确保文件存在，如果不存在则创建目录和文件
- * @param {string} filePath - 要检查的文件路径
- * @param {string} content - 文件内容，如果不指定，则为空文件
- * @returns {boolean} 文件是否存在
- */
-export declare function ensureFileExists(filePath: string, content?: string): boolean;

package/dist/utils/rsp.d.ts

@@ -1,22 +0,0 @@
-type Options = Partial<{
-    data: any;
-    message: string;
-    code: number;
-}>;
-/**
- * 构建成功的请求响应
- * @param options - 成功响应的选项，如数据和消息
- */
-export declare const successRsp: (options?: Options) => void;
-/**
- * 构建不成功的请求响应，但 HTTP 状态码仍为 200
- * @param options - 包含可能的错误码、消息和数据
- */
-export declare const unSuccessRsp: (options?: Options) => void;
-/**
- * 构建异常请求响应，HTTP 状态码不为 200
- * @param statusCode - 要返回的 HTTP 状态码
- * @param options - 包含可能的错误信息、数据等
- */
-export declare const errorRsp: (statusCode: number, options?: Options) => void;
-export {};