neopg 1.0.1 → 2.0.1

package/README.cn.md

@@ -6,7 +6,7 @@
 
 **NeoPG** 是一个基于 [postgres.js](https://github.com/porsager/postgres)（Node.js 生态中最快的 PostgreSQL 客户端）构建的高性能、零依赖 ORM。
 
-它完美地融合了**链式查询构造器（Query Builder）**带来的极佳开发体验（DX）与**原生 SQL 模板字符串（Template Literals）**的极致性能。
+它完美地融合了链式查询构造器（Query Builder）带来的极佳开发体验（DX）与原生 SQL 模板字符串（Template Literals）的极致性能。
 
 ### [📃 English Document 🔗](./README.md)
 
@@ -212,6 +212,28 @@ console.log('数据库结构已同步！')
 
 ---
 
+### 📂 自动加载模型
+
+NeoPG 支持扫描指定目录并自动注册所有模型，无需手动逐个引入。
+
+**加载规则：**
+*   仅加载 `.js` 和 `.mjs` 后缀的文件。
+*   **忽略**以 `_` 开头的文件（可用作目录内的共享工具或基类）。
+*   **忽略**以 `!` 开头的文件（可用作临时禁用的模型）。
+
+```javascript
+const db = new NeoPG(config)
+
+// 自动加载 ./models 目录下的所有模型
+// 注意：这是一个异步方法，因为它兼容 ESM (.mjs) 的动态导入
+await db.loadModels('./models')
+
+// 加载完成后即可同步或使用
+await db.sync()
+```
+
+---
+
 ## 🔍 查询数据
 
 NeoPG 提供了自然流畅的链式 API。
@@ -239,16 +261,13 @@ const page2 = await db.model('User').page(2, 20).find(); // 第 2 页，每页 2
 
 ```javascript
 await db.model('User')
-  // 对象风格 (自动处理 AND)
   .where({ 
     age: 18, 
     status: 'active' 
   })
-  // 操作符风格
   .where('create_time', '>', 1600000000)
-  // SQL 片段风格 (强大且灵活！)
   .where('id IS NOT NULL')
-  .find();
+  .find()
 ```
 
 ### 结合模板字符串的复杂查询
@@ -259,9 +278,9 @@ await db.model('User')
 // db.sql 是原生的 postgres 实例
 const { sql } = db; 
 
+// 通过模板字符串安全地注入参数
 await db.model('User')
   .where({ status: 'active' })
-  // 通过模板字符串安全地注入参数
   .where(sql`age > ${20} AND email LIKE ${'%@gmail.com'}`)
   .find();
 ```
@@ -412,4 +431,4 @@ await db.sql.begin(async (sql) => {
 
 ISC
 
-![](./images/neopg-programming.jpeg)
+![](./images/neopg-end.webp)

package/README.md

@@ -211,6 +211,28 @@ console.log('Database synced!')
 
 ---
 
+### 📂 Auto-loading Models
+
+Instead of manually importing and defining each model, you can load all models from a directory.
+
+**Rules:**
+*   Only `.js` and `.mjs` files are loaded.
+*   Files starting with `_` are ignored (useful for utils/helpers).
+*   Files starting with `!` are ignored (useful for disabled models).
+
+```javascript
+const db = new NeoPG(config)
+
+// Load all models from the './models' directory
+// This is asynchronous because it supports .mjs dynamic imports
+await db.loadModels('./models')
+
+// Now you can sync and use them
+await db.sync()
+```
+
+---
+
 ## 🔍 Querying
 
 NeoPG provides a fluent, chainable API that feels natural to use.
@@ -238,16 +260,13 @@ const page2 = await db.model('User').page(2, 20).find(); // Page 2, Size 20
 
 ```javascript
 await db.model('User')
-  // Object style (AND logic)
   .where({ 
     age: 18, 
     status: 'active' 
   })
-  // Operator style
   .where('create_time', '>', 1600000000)
-  // SQL Fragment style (Powerful!)
   .where('id IS NOT NULL')
-  .find();
+  .find()
 ```
 
 ### Complex Where with Template Literals
@@ -300,14 +319,14 @@ const stats = await db.model('User')
 const newUser = await db.model('User').insert({
   username: 'neo',
   email: 'neo@matrix.com'
-});
+})
 // ID and Timestamps are automatically generated if configured in Schema
 
 // Insert multiple (Batch)
 await db.model('User').insert([
   { username: 'a' }, 
   { username: 'b' }
-]);
+])
 ```
 
 ### Update
@@ -384,16 +403,15 @@ const result = await db.transaction(async (tx) => {
   const user = await tx.model('User').insert({ username: 'alice' });
   
   // 2. Read operation within transaction
-  const count = await tx.model('User').count();
+  const count = await tx.model('User').count()
   
   // 3. Throwing an error will automatically ROLLBACK
   if (count > 100) {
-    throw new Error('Limit reached'); 
+    throw new Error('Limit reached')
   }
   
-  return user;
-});
-// Automatically COMMITTED here if no error
+  return user
+})
 ```
 
 ### Using Raw Postgres Transaction
@@ -402,7 +420,7 @@ const result = await db.transaction(async (tx) => {
 await db.sql.begin(async (sql) => {
   // sql is the transaction connection
   await sql`INSERT INTO users (name) VALUES ('bob')`;
-});
+})
 ```
 
 ---
@@ -411,5 +429,4 @@ await db.sql.begin(async (sql) => {
 
 ISC
 
-
-![](./images/neopg-programming.jpeg)
+![](./images/neopg-end.webp)

package/lib/NeoPG.js

@@ -7,6 +7,10 @@ const TransactionScope = require('./TransactionScope.js')
 const ModelChain = require('./ModelChain.js')
 const dataTypes = require('./dataTypes.js')
 
+const path = require('node:path')
+const fs = require('node:fs')
+const { pathToFileURL } = require('node:url')
+
 class NeoPG {
   constructor(config) {
     this.driver = postgres(config)
@@ -136,6 +140,64 @@ class NeoPG {
   async close() {
     await this.driver.end()
   }
+
+  /**
+   * 自动加载指定目录下的模型文件
+   * 规则：
+   * 1. 只加载 .js 和 .mjs 文件
+   * 2. 跳过以 '_' 开头的文件 (视为内部共享模块)
+   * 3. 跳过以 '!' 开头的文件 (视为保留或禁用文件)
+   * 
+   * @param {string} dirPath - 目录路径 (相对 process.cwd() 或绝对路径)
+   */
+  async loadModels(dirPath) {
+    // 解析绝对路径
+    const absPath = path.isAbsolute(dirPath) 
+      ? dirPath 
+      : path.resolve(process.cwd(), dirPath)
+
+    if (!fs.existsSync(absPath)) {
+      throw new Error(`[NeoPG] Models directory not found: ${absPath}`)
+    }
+
+    const files = fs.readdirSync(absPath)
+
+    for (const file of files) {
+      // 过滤规则
+      if (file.startsWith('_') || file.startsWith('!')) continue
+      
+      const ext = path.extname(file)
+
+      if (ext !== '.js' && ext !== '.mjs') continue
+
+      const fullFilePath = path.join(absPath, file)
+      let modelExport
+
+      try {
+        if (ext === '.mjs') {
+          // 处理 ESM 动态导入
+          // Windows 下 import() 需要 file:// 协议路径
+          const fileUrl = pathToFileURL(fullFilePath).href
+          const imported = await import(fileUrl)
+          modelExport = imported.default
+        } else {
+          // 处理 CommonJS
+          modelExport = require(fullFilePath)
+        }
+
+        // 注册模型 (如果导出为空或不是合法对象/类，add 方法内部会抛错或处理)
+        if (modelExport) {
+          this.add(modelExport)
+        }
+      } catch (err) {
+        console.error(`[NeoPG] Failed to load model: ${file}`)
+        throw err
+      }
+    }
+
+    return this
+  }
+
 }
 
 NeoPG.dataTypes = dataTypes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neopg",
-  "version": "1.0.1",
+  "version": "2.0.1",
   "description": "orm for postgres",
   "keywords": [
     "neopg",

package/test/test-db.js

@@ -154,12 +154,21 @@ db.add(User);
                 {
                   username: 'Neo',
                   email: '123@w.com',
+                  sex: 1,
                   level: Math.floor((Math.random() * 105))
                 },
                 {
                   username: 'PG',
                   email: '1234@w.com',
+                  sex: 2,
                   level: Math.floor((Math.random() * 100))
+                },
+
+                {
+                  username: 'NPG',
+                  email: '1235@w.com',
+                  sex: 3,
+                  level: 3
                 }
             ])
     )
@@ -179,6 +188,12 @@ db.add(User);
     let result = await tx.model('User').where(tx.sql`level > 10`).returning('*').update(data)
     console.log(result)
 
+    let sex = 3
+    console.log(
+      'test condition or',
+      await tx.model('User').where(tx.sql`(sex = ${sex} or level > 10)`).select(['id', 'level', 'username', 'sex']).find()
+    )
+
     console.log(
       'test avg',
       await tx.model('User').avg('level')