streamline-code-by-ikun2274 0.12.71 → 0.12.80

package/Example.js

@@ -1,51 +0,0 @@
-import { setDbConfig,startServer,
-    DefineRoutePlus_A } from './src/StreamlineCodeIndex.js';
-
-
-
-
-setDbConfig({
-    host: 'localhost',
-    user: 'root', // 你的 MySQL 用户名
-    password: '123456', // 你的 MySQL 密码
-    database: 'my_test_db' // 数据库名
-
-})
-
-
-startServer({
-  port: 8008, // 端口配置
-  allowedOrigins: [ // 允许的域名
-    'http://127.0.0.1:5501',
-    'http://ztgame.click',
-    'http://60.205.158.63',
-    'http://localhost:5173'
-  ]
-});
-
-
-
-
-DefineRoutePlus_A({
-    url: '/api/productlist',
-    method: 'get',
-    // 可选：内置中间件配置
-    BuiltinMid: {
-        //可选的中间件参数
-        Parameter: ['pagination:12', 'unifiedResponse', 'shuffle','requireAuth']  // 启用分页和统一响应
-    },
-    PlusHandler: {
-        db: {
-            table: 'productdb',
-            operation: 'select', // select/read 都可以
-            primaryKey: 'id',
-            fields: '*',
-            categoryField: 'category_id' // 可选，默认为 'category_id'
-        },
-        other: {
-            successMessage: '操作成功',
-            errorMessage: '操作失败',
-            customLogic: null // 可选，自定义逻辑函数
-        }
-    }
-});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "streamline-code-by-ikun2274",
-  "version": "0.12.71",
+  "version": "0.12.80",
   "description": "A streamline Express route builder with database operations, pagination, and authentication",
   "main": "src/StreamlineCodeIndex.js",
   "type": "module",

package/src/Request/StreamlineCode.js

@@ -2,8 +2,6 @@ import express from 'express';
 const app = express();
 
 
-let s =['','']
-
 import { ToolDb } from '../Databaseope/data.js';
 import {
   validateLogin, verifyUser, generateToken,
@@ -93,7 +91,7 @@ export const defineRoute = (options) => {
  * @param {string} [options.PlusHandler.other.errorMessage='操作失败'] - 错误消息（可选）
  * */
 
-export function DefineRoutePlus_A(options) {
+export function StreamlineRouter(options) {
 
   const {
     url,

package/types/index.d.ts

@@ -1,13 +1,13 @@
-/**
- * 类型定义文件
- */
+// types/index.d.ts
+
 import express from 'express';
 
-/**
- * 数据库配置接口
- */
+
+// types/index.d.ts
+
+// 数据库配置类型
 export interface DbConfig {
-  /** 数据库主机地址 */
+  /** 数据库主机地址--- */
   host: string;
   /** 数据库用户名 */
   user: string;
@@ -17,62 +17,60 @@ export interface DbConfig {
   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;
-      /** 操作类型 */
+      /** 操作类型：create, read, update, delete, select */
       operation: 'select' | 'read' | 'create' | 'update' | 'delete';
-      /** 主键字段 */
+      /** 主键字段，默认为 'id' */
       primaryKey?: string;
-      /** 查询字段 */
+      /** 查询字段，默认为 '*' */
+      fields?: string;
+      /** 分类字段，默认为 'category_id' */
+      categoryField?: string;
+      /** 查询字段，默认为 '*' */
       fields?: string;
-      /** 分类字段 */
+      /** 分类字段，默认为 'category_id' */
       categoryField?: string;
     };
-    /** 模式配置 */
+    /** 模式配置 可选 */
     Mode?: {
-      /** 是否启用分页 */
+      /** 分页，默认为 false */
       pagination?: boolean;
-      /** 是否需要认证 */
+      /** 是否需要认证，默认为 false */
       requireAuth?: boolean;
-      /** 是否打乱数据 */
+      /** 是否随机，默认为 false */
       shuffle?: boolean;
-      /** 分页大小 */
+      /** 每页数量，默认为 10 */
       pageSize?: number;
     };
     /** 其他配置 */
     other: {
-      /** 成功消息 */
+      /** 成功消息，默认为 '操作成功' */
       successMessage?: string;
-      /** 错误消息 */
+      /** 错误消息，默认为 '操作失败' */
       errorMessage?: string;
       /** 自定义逻辑函数 */
       customLogic?: Function;
@@ -80,9 +78,35 @@ export interface RouteConfig {
   };
 }
 
-/**
- * 数据库操作配置接口
- */
+// 函数类型定义
+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;
@@ -96,9 +120,7 @@ export interface DbOperationConfig {
   categoryField?: string;
 }
 
-/**
- * 其他配置接口
- */
+/** 其他配置接口 */
 export interface OtherConfig {
   /** 自定义逻辑函数 */
   customLogic?: (req: express.Request, res: express.Response, ToolDb: any, successMessage: string, errorMessage: string) => Promise<any>;
@@ -108,17 +130,12 @@ export interface OtherConfig {
   errorMessage?: string;
 }
 
-/**
- * 内置中间件配置接口
- */
 export interface BuiltinMidConfig {
   /** 中间件参数，可以是字符串或字符串数组 */
   Parameter: string | string[];
 }
 
-/**
- * 路由配置接口（新版）
- */
+/** 路由配置接口 */
 export interface RouteConfig {
   /** 路由路径 */
   url: string;
@@ -139,9 +156,7 @@ export interface RouteConfig {
   };
 }
 
-/**
- * 数据库操作工具类
- */
+/** 数据库操作工具类 */
 export interface ToolDb {
   /**
    * 查询单条记录
@@ -151,7 +166,7 @@ export interface ToolDb {
    * @returns 查询结果
    */
   findOne(table: string, where?: any, fields?: string[]): Promise<any>;
-  
+
   /**
    * 查询多条记录
    * @param table 表名
@@ -161,7 +176,7 @@ export interface ToolDb {
    * @returns 查询结果数组
    */
   find(table: string, where?: any, fields?: string[], options?: any): Promise<any[]>;
-  
+
   /**
    * 插入记录
    * @param table 表名
@@ -169,7 +184,7 @@ export interface ToolDb {
    * @returns 插入结果
    */
   create(table: string, data: any): Promise<any>;
-  
+
   /**
    * 更新记录
    * @param table 表名
@@ -178,7 +193,7 @@ export interface ToolDb {
    * @returns 是否更新成功
    */
   update(table: string, data: any, where: any): Promise<boolean>;
-  
+
   /**
    * 删除记录
    * @param table 表名
@@ -189,18 +204,37 @@ export interface ToolDb {
 }
 
 /**
- * 二次封装 defineRoute 函数
- * @param options 路由配置选项
+ * StreamlineRouter低代码函数
+ * @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;
+
+export function StreamlineRouter(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;
@@ -217,10 +251,6 @@ 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;
 
@@ -239,7 +269,9 @@ export function query(sql: string, params?: any[]): Promise<any>;
  * @param options.allowedOrigins 允许的域名列表
  */
 export function startServer(options?: {
+  /** 服务器端口，默认3001 */
   port?: number;
+  /** 允许的域名列表 */
   allowedOrigins?: string[];
 }): void;