feat: feature/0.4.0 (#18)

* feat: feature/0.4.0

* style: types.ts

---------

Co-authored-by: cmtlyt <cmt01964896@taobao.com>

Author: cmtlyt

src/constant/index.ts

@@ -2,6 +2,6 @@ import type { ModuleType } from '../types';
 
 export const NEED_READ_PROTOTYPE_TYPES = ['controller', 'service'];
 
-export const NEED_RETURN_TYPES = ['config', 'extend', 'middlewares', 'router', 'controller', 'service'];
+export const NEED_RETURN_TYPES = ['config', 'extend', 'routerSchema', 'service', 'middlewares', 'controller', 'router'];
 
 export const MODULE_LOAD_ORDER: ModuleType[] = ['config', 'extend', 'routerSchema', 'service', 'middlewares', 'controller', 'router'];

src/index.ts

@@ -7,7 +7,7 @@ export * from './build';
 export * from './constant';
 export * from './define';
 
-export type { TeeOptions } from './types';
+export type { TeeMiddlewareCtx, TeeOptions } from './types';
 export { getEnv } from './utils';
 
 export type { Defu as MergeConfig } from 'defu';
@@ -24,13 +24,13 @@ declare namespace TeeKoa {
 
   interface Context extends Koa.DefaultContext {
     config: IComputedConfig;
-    routerSchema: IRouterSchema;
   }
 
   interface Application extends Koa<Koa.DefaultState, Context>, IExtend {
     middlewares: IMiddlewares;
     controller: IController;
     service: IService;
+    routerSchema: IRouterSchema;
   }
 
   interface AppOptions {

src/types.ts

@@ -1,7 +1,6 @@
 import type KoaRouter from '@koa/router';
 import type { Jiti } from 'jiti';
 import type { Server } from 'node:http';
-
 import type TeeKoa from '.';
 
 export { TeeKoa };
@@ -11,6 +10,11 @@ export { TeeKoa };
  */
 export type ModuleType = 'controller' | 'service' | 'middlewares' | 'router' | 'config' | 'extend' | 'routerSchema';
 
+export interface ModuleInfo {
+  content: any;
+  [key: string]: any;
+}
+
 export interface FileInfo {
   /**
    * 模块类型
@@ -35,7 +39,7 @@ export interface FileInfo {
   /**
    * 模块内容
    */
-  module?: any;
+  moduleInfo?: ModuleInfo;
 }
 
 export type FileInfoMap = Record<ModuleType, FileInfo[]>;
@@ -91,7 +95,7 @@ export interface GenerateTypeOptions {
     /**
      * 模块加载完成钩子
      */
-    onModulesLoaded?: (type: string, modules: FileInfo[]) => any;
+    onModulesLoaded?: (type: string, modules: DeepRequired<FileInfo>[]) => any;
   };
 }
 
@@ -146,9 +150,9 @@ export interface ModuleHook {
   /**
    * 模块加载完成钩子
    *
-   * 用于将模块内容注入到上下文, 只有在内置模块无法处理时调用
+   * 用于将模块内容注入到上下文
    *
-   * 返回 true 表示已处理, 返回 false 则表示未处理并跳出警告
+   * 返回 true 表示已处理不进行默认处理, 返回 false 则表示未处理并执行默认处理, 如果不存在默认处理方式则跳出警告
    */
   loaded?: (ctx: ModuleLoadedContext) => boolean | Promise<boolean>;
   /**
@@ -161,6 +165,15 @@ export interface ModuleHook {
   parser?: (ctx: ModuleHandlerContext) => any | Promise<any>;
 }
 
+export interface TypeInfo {
+  [key: string]: string | TypeInfo;
+}
+
+export interface GenerateTypeExtendsConfig {
+  importContent?: string | ((typeInfoMap: TypeInfo) => string | Promise<string>);
+  typeContent?: string | ((typeInfoMap: TypeInfo) => string | Promise<string>);
+}
+
 export interface GenerateTypeConfig {
   /**
    * 自定义需要返回值类型的模块
@@ -171,6 +184,8 @@ export interface GenerateTypeConfig {
    * @default false
    */
   useAbsolutePath?: boolean;
+  extendsInfo?: GenerateTypeExtendsConfig;
+  getInterface?: (moduleType: string, typeInfoMap: TypeInfo) => void | string | boolean | Promise<string | void | boolean>;
 }
 
 export interface ConfigFile {
@@ -208,7 +223,16 @@ export interface ConfigFile {
   generateTypeConfig?: GenerateTypeConfig;
 }
 
+export interface RouterInfo {
+  filePath: string;
+  path: string | RegExp;
+  schema?: any;
+  schemaPath: string;
+  prefix?: string;
+}
+
 export interface Storage {
+  routerInfoMap: Record<string, RouterInfo>;
   /**
    * 应用实例
    */
@@ -267,3 +291,5 @@ export interface DevOptions {
 }
 
 export type TeeOptions<T extends string> = TeeKoa.SetupOptionMap[T];
+
+export type TeeMiddlewareCtx = Parameters<TeeKoa.Application['middleware'][number]>[0];

src/utils/config.ts

@@ -1,4 +1,4 @@
-import type { FileInfo, TeeKoa } from '../types';
+import type { DeepRequired, FileInfo, TeeKoa } from '../types';
 import process from 'node:process';
 import { defu } from '.';
 import { consola } from './consola';
@@ -14,12 +14,12 @@ export function getEnv(app: TeeKoa.Application) {
   return app.env || 'local';
 }
 
-export function configMerge(app: TeeKoa.Application, configs: FileInfo[]) {
+export function configMerge(app: TeeKoa.Application, configs: DeepRequired<FileInfo>[]) {
   const {
     default: defaultConfig = { config: {}, relativePath: '' },
     ...envConfigMap
   } = configs.reduce((result, item) => {
-    const { nameSep, module, relativePath } = item;
+    const { nameSep, moduleInfo: { content: module }, relativePath } = item;
     const name = nameSep.at(-1)!;
     try {
       if (name.includes('Default'))

src/utils/data-map.ts

@@ -0,0 +1,34 @@
+import type KoaRouter from '@koa/router';
+import type { DeepRequired, FileInfo } from '../types';
+import { getStorage } from '../storage';
+
+export function createRouterSchemaInfoMap(moduleInfo: DeepRequired<FileInfo>) {
+  const { moduleInfo: { content: module }, path } = moduleInfo;
+
+  const routerInfoMap = getStorage('routerInfoMap', {});
+
+  for (const key in module) {
+    const schema = module[key];
+    routerInfoMap[key] = {
+      ...routerInfoMap[key],
+      schema,
+      schemaPath: path,
+    };
+  }
+}
+
+export function createRouterInfoMap(moduleInfo: DeepRequired<FileInfo>) {
+  const { moduleInfo: { content: module }, path } = moduleInfo;
+
+  const routerInfoMap = getStorage('routerInfoMap', {});
+
+  const router = module as KoaRouter;
+
+  router.stack.forEach((item) => {
+    routerInfoMap[String(item.path)] = {
+      ...routerInfoMap[String(item.path)],
+      filePath: path,
+      path: item.path,
+    };
+  });
+}

src/utils/generate-type.ts

@@ -1,4 +1,5 @@
-import type { FileInfo, FileInfoMap, ModuleType } from '../types';
+import type { FileInfo, FileInfoMap, ModuleType, TypeInfo } from '../types';
+import { isNull } from '@cmtlyt/base';
 import { readPackageJSON } from 'pkg-types';
 import { pascalCase } from 'scule';
 import { NEED_READ_PROTOTYPE_TYPES, NEED_RETURN_TYPES } from '../constant';
@@ -14,10 +15,6 @@ export function getItemType(item: Pick<FileInfo, 'type' | 'relativePath' | 'path
   return `typeof import('${path}')['default']${NEED_READ_PROTOTYPE_TYPES.includes(item.type) ? `['prototype']` : ''}`;
 }
 
-interface TypeInfo {
-  [key: string]: string | TypeInfo;
-}
-
 function generateTypeInfo(fileInfoMap: FileInfoMap) {
   const { ignoreModules } = getStorage('config');
   const typeInfo: TypeInfo = {};
@@ -55,12 +52,63 @@ function generateType(typeInfoMap: TypeInfo, indent = 0) {
   return typeList.join('\n');
 }
 
+// function getObjectFlatValues(typeInfoMap: TypeInfo, propName: string) {
+//   const result = typeInfoMap[propName];
+//   if (!result)
+//     return [];
+//   if (typeof result === 'string')
+//     return [result];
+//   const names: string[] = [];
+//   for (const name in result) {
+//     names.push(...getObjectFlatValues(result, name));
+//   }
+//   return names;
+// }
+
+// function routerSchemaTypeMerge(typeInfoMap: TypeInfo) {
+//   const allExtendsTypes = getObjectFlatValues(typeInfoMap, 'routerSchema');
+
+//   if (!allExtendsTypes.length)
+//     return '';
+
+//   delete typeInfoMap.routerSchema;
+
+//   return `interface IRouterSchema extends ${allExtendsTypes.join(', ')}, Record<string, any> {}`;
+// }
+
 export async function generateTypeString(fileInfo: FileInfoMap) {
   const { name } = await readPackageJSON(import.meta.url);
+  const { generateTypeConfig: { extendsInfo, getInterface } } = getStorage('config');
+  const originTypeInfoMap = generateTypeInfo(fileInfo);
+  const typeInfoMap = { ...originTypeInfoMap };
+
+  const userTypeContent = [];
 
-  const typeInfoMap = generateTypeInfo(fileInfo);
+  for (const type in typeInfoMap) {
+    const _interface = await getInterface(type, typeInfoMap[type] as TypeInfo);
+    if (!_interface)
+      continue;
+    delete typeInfoMap[type];
+    userTypeContent.push(_interface);
+  }
+
+  const routerSchemaTypeContent = ''; // routerSchemaTypeMerge(typeInfoMap);
 
   const typeContent = generateType(typeInfoMap);
 
-  return `import { MergeConfig } from '@cmtlyt/tee';\nexport {};\ndeclare module '${name}' {\n${typeContent}\n  #{configType}\n}`;
+  let computedType = `import { MergeConfig } from '${name}';\n#{extendsImport}\nexport {};\ndeclare module '${name}' {\n${typeContent}\n  ${userTypeContent.join('\n')}\n  ${routerSchemaTypeContent}\n  #{configType}\n  #{extendsType}\n}`;
+
+  if (extendsInfo) {
+    const { importContent, typeContent } = extendsInfo;
+    if (!isNull(importContent)) {
+      const content = typeof importContent === 'string' ? importContent : await importContent(typeInfoMap);
+      computedType = computedType.replace('#{extendsImport}', content);
+    }
+    if (!isNull(typeContent)) {
+      const content = typeof typeContent === 'string' ? typeContent : await typeContent(typeInfoMap);
+      computedType = computedType.replace('#{extendsType}', content);
+    }
+  }
+
+  return computedType;
 }

src/utils/get-info.ts

@@ -20,15 +20,19 @@ export async function getFileInfoMap({ sourceDir = 'src' }) {
 
   const fileInfoMap = files.reduce((fileInfo, path) => {
     const relativePath = path.slice(srcPath.length).replace(/^[\\/]/, '');
-    const [type, ...names] = relativePath.replace(/\.[^.]*$/, '').split(/[\\/]/);
-    if (!names?.length)
+    const [type, ...nameSep] = relativePath
+      .replace(/\.[^.]*$/, '')
+      .replace(/\./g, '-')
+      .split(/[\\/]/)
+      .map(item => camelCase(item));
+    if (!nameSep?.length)
       return fileInfo;
     (fileInfo[type as ModuleType] ||= []).push({
       type: type as ModuleType,
       path,
       relativePath,
-      name: camelCase(names.join('-').replace(/\./g, '-')),
-      nameSep: names.map(name => camelCase(name)),
+      name: camelCase(nameSep.join('-')),
+      nameSep,
     });
     return fileInfo;
   }, {} as FileInfoMap);