streamline-code-by-ikun2274 0.12.6 → 0.12.71

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "streamline-code-by-ikun2274",
-  "version": "0.12.6",
+  "version": "0.12.71",
   "description": "A streamline Express route builder with database operations, pagination, and authentication",
   "main": "src/StreamlineCodeIndex.js",
   "type": "module",
   "exports": {
     ".": {
       "import": "./src/StreamlineCodeIndex.js",
-      "type": "./types/index.d.ts"
+      "types": "./types/index.d.ts"
     }
   },
   "types": "./types/index.d.ts",

package/src/Request/StreamlineCode.js

@@ -193,15 +193,18 @@ export function DefineRoutePlus_A(options) {
             // 处理创建操作
             let createData = req.body;
 
-            // 直接使用自动生成ID的逻辑
-            const records = await ToolDb.find(table);
-            const ids = Array.isArray(records)
-              ? records.map(record => record[primaryKey])
-                .filter(id => id !== null && id !== undefined && typeof id === 'number')
-              : [];
-            const maxId = ids.length > 0 ? Math.max(...ids) : 0;
-            const newId = maxId + 1;
-            createData = { [primaryKey]: newId, ...createData };
+            // 如果需要自动生成ID
+            if (autoGenerateId) {
+              // 直接使用generateId中间件的逻辑
+              const records = await ToolDb.find(table);
+              const ids = Array.isArray(records)
+                ? records.map(record => record[primaryKey])
+                  .filter(id => id !== null && id !== undefined && typeof id === 'number')
+                : [];
+              const maxId = ids.length > 0 ? Math.max(...ids) : 0;
+              const newId = maxId + 1;
+              createData = { [primaryKey]: newId, ...createData };
+            }
 
             await ToolDb.create(table, createData);
             break;

package/types/index.d.ts

@@ -1,83 +1,88 @@
-// types/index.d.ts
-
+/**
+ * 类型定义文件
+ */
 import express from 'express';
 
-
-// types/index.d.ts
-
-// 数据库配置类型
+/**
+ * 数据库配置接口
+ */
 export interface DbConfig {
+  /** 数据库主机地址 */
   host: string;
+  /** 数据库用户名 */
   user: string;
+  /** 数据库密码 */
   password: string;
+  /** 数据库名称 */
   database: string;
 }
 
-// 服务器配置类型
+/**
+ * 服务器配置接口
+ */
 export interface ServerConfig {
+  /** 服务器端口 */
   port: number;
+  /** 允许的域名列表 */
   allowedOrigins: string[];
 }
 
-// 路由配置类型
+/**
+ * 路由配置接口
+ */
 export interface RouteConfig {
+  /** 路由路径 */
   url: string;
+  /** HTTP 方法 */
   method: 'get' | 'post' | 'put' | 'delete';
+  /** 中间件数组 */
   middlewares?: Array<Function>;
+  /** 内置中间件配置 */
   BuiltinMid?: {
+    /** 中间件参数 */
     Parameter?: string | string[];
   };
+  /** 额外处理选项 */
   PlusHandler: {
+    /** 数据库操作配置 */
     db: {
+      /** 数据库表名 */
       table: string;
+      /** 操作类型 */
       operation: 'select' | 'read' | 'create' | 'update' | 'delete';
+      /** 主键字段 */
       primaryKey?: string;
+      /** 查询字段 */
       fields?: string;
+      /** 分类字段 */
       categoryField?: string;
     };
+    /** 模式配置 */
     Mode?: {
+      /** 是否启用分页 */
       pagination?: boolean;
+      /** 是否需要认证 */
       requireAuth?: boolean;
+      /** 是否打乱数据 */
       shuffle?: boolean;
+      /** 分页大小 */
       pageSize?: number;
     };
+    /** 其他配置 */
     other: {
+      /** 成功消息 */
       successMessage?: string;
+      /** 错误消息 */
       errorMessage?: string;
+      /** 自定义逻辑函数 */
       customLogic?: Function;
     };
   };
 }
 
-// 函数类型定义
-export function setDbConfig(config: DbConfig): void;
-export function startServer(config: ServerConfig): void;
-export function DefineRoutePlus_A(config: RouteConfig): void;
-
-
-
-
-/** 数据库配置接口 */
-export interface setDbConfig {
-  /** 数据库主机地址 */
-  host: string;
-  /** 数据库用户名 */
-  user: string;
-  /** 数据库密码 */
-  password: string;
-  /** 数据库名称 */
-  database: string;
-}
-
-/** 服务器配置接口 */
-export interface ServerConfig {
-  /** 服务器端口 */
-  port: number;
-  /** 数据库配置 */
-  db: DbConfig;
-}
-
-/** 数据库操作配置接口 */
+/**
+ * 数据库操作配置接口
+ */
 export interface DbOperationConfig {
   /** 数据库表名 */
   table: string;
@@ -91,7 +96,9 @@ export interface DbOperationConfig {
   categoryField?: string;
 }
 
-/** 其他配置接口 */
+/**
+ * 其他配置接口
+ */
 export interface OtherConfig {
   /** 自定义逻辑函数 */
   customLogic?: (req: express.Request, res: express.Response, ToolDb: any, successMessage: string, errorMessage: string) => Promise<any>;
@@ -101,13 +108,17 @@ export interface OtherConfig {
   errorMessage?: string;
 }
 
-/** 内置中间件配置接口 */
+/**
+ * 内置中间件配置接口
+ */
 export interface BuiltinMidConfig {
   /** 中间件参数，可以是字符串或字符串数组 */
   Parameter: string | string[];
 }
 
-/** 路由配置接口 */
+/**
+ * 路由配置接口（新版）
+ */
 export interface RouteConfig {
   /** 路由路径 */
   url: string;
@@ -128,7 +139,9 @@ export interface RouteConfig {
   };
 }
 
-/** 数据库操作工具类 */
+/**
+ * 数据库操作工具类
+ */
 export interface ToolDb {
   /**
    * 查询单条记录
@@ -178,39 +191,16 @@ export interface ToolDb {
 /**
  * 二次封装 defineRoute 函数
  * @param options 路由配置选项
- * 
- * /**
- * 二次封装 defineRoute 
- * @param {Object} options - 路由配置选项 
- * @param {string} options.url    - 路由路径（必填）
- * @param {string} options.method - HTTP 方法（GET/POST/PUT/DELETE，必填）
- * @param {Array<Function>} [options.middlewares=[]] - 中间件数组（可选 用户自定义中间件）--作者会尽可能集成中间件
- * @param {Object} options.PlusHandler - 额外处理选项（必填）
- * @param {Object} options.PlusHandler.db - 数据库操作（必填）
- * @param {string} options.PlusHandler.db.table - 数据库表名（必填）
- * @param {string} options.PlusHandler.db.operation - 数据表操作（必填）select/insert/update/update/delete
- * @param {string} [options.PlusHandler.db.primaryKey='id'] - 主键字段（可选）
- * @param {string} [options.PlusHandler.db.fields='*'] - 查询字段（可选）
- * @param {string} [options.PlusHandler.db.categoryField='category_id'] - 分类字段（可选）
- * @param {object} [options.BuiltinMid.Parameter=[]] - 中间件参数（可选的内置中间件）填一个激活一个
- * 'requireAuth': () => verifyToken,验证用户身份中间件
- * 'login': () => [validateLogin, verifyUser, generateToken],登陆中间件集合
- * 'register': () => [validateRegister, checkUsername],注册中间件集合
- * 'categoryFilter': (field = categoryField) => categoryFilter(field),分类筛选中间件
- * 'pagination': (size = 10) => Dpagination(Number(size)),分页中间件
- * 'shuffle': () => shuffleData,打乱数据中间件
- * 'unifiedResponse': (message = successMessage) => unifiedResponse(message),统一响应中间件
- * @param {Object} options.PlusHandler.other - 其他选项（必填）
- * @param {string} [options.PlusHandler.other.successMessage='操作成功'] - 成功消息（可选）
- * @param {string} [options.PlusHandler.other.errorMessage='操作失败'] - 错误消息（可选）
- * 
  */
-
 export function DefineRoutePlus_A(options: RouteConfig): void;
 
 /**
  * 二次封装 Express 路由注册
  * @param options 路由配置选项
+ * @param options.url 路由路径
+ * @param options.method HTTP 方法
+ * @param options.middlewares 中间件数组
+ * @param options.handler 业务逻辑处理函数
  */
 export function defineRoute(options: {
   url: string;
@@ -227,6 +217,10 @@ export const ToolDb: ToolDb;
 /**
  * 设置数据库配置
  * @param config 数据库配置
+ * @param config.host 数据库主机地址
+ * @param config.user 数据库用户名
+ * @param config.password 数据库密码
+ * @param config.database 数据库名称
  */
 export function setDbConfig(config: Partial<DbConfig>): void;