@zenorm/generate 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.2.0] - 2023-3-24
+- update: bindQuery 改为函数形式
+
+## [1.1.1] - 2023-3-24
+- fix: 生成格式少个空格和空行
+- update: bindQuery 增加 count 和 exists
+- 补充注释说明
+
 ## [1.1.0] - 2023-3-24
 - 新增: 绑定静态 Query
 

package/README.md

@@ -17,7 +17,7 @@
 | tablesFilename | `string` | `'_tables'` | 生成数据库表结构文件名
 | repositoriesFilename | `string` | `'_repositories'` | 生成 repositories 文件名
 | globalFilename | `string` | 无 | 全局文件名 - 如果设置所有表将继承于此 - 例如设置为：'_global' - 如果文件不存在则自动创建
-| bindQuery | `string` | 无 | 绑定 Query 对象 - 设置 query 源，格式: 'QueryParam@filename' 例如: 'pool@../db'
+| bindQuery | `boolean` | `false` | repositories 文件生成 bindQuery(query: QueryParam) 方法用于设置模型的 Query 源 - 并生成模型的静态 Repository 方法
 | generateRepositories | `boolean` | `false` | 是否生成 Repositories 类 - 通常用于多租户模式做数据库前置绑定 `Query` 对象
 | declareRepositoriesToModules | `string[]` | 无 | 是否需将 Repositories 实例定义到目标模块中 - 例如: `["@zenweb/core.Core.repositories"]`
 | filter | `string` | 无 | 表过滤规则正则

package/dist/generate.js

@@ -90,13 +90,12 @@ async function generate(tables, cfg) {
     await fs_1.promises.writeFile(tablesFilename, structs.filter(i => i !== null).join('\n'));
     const repositories = [
         ...remark,
-        `import {${config.generateRepositories ? `QueryParam, ` : ''} createRepositoryQuery } from '${zenormName}';`,
+        `import { ${(config.generateRepositories || config.bindQuery) ? `QueryParam, ` : ''}createRepositoryQuery } from '${zenormName}';`,
         ...models.map(({ name, className }) => `import _${className} from './${name}';`),
     ];
     // 绑定静态 Query
     if (config.bindQuery) {
-        const [v, p] = config.bindQuery.split('@', 2);
-        repositories.push(`import { ${v} as _query } from '${p}';`);
+        repositories.push('', `let _bindQuery: QueryParam;`, `function _query() { return typeof _bindQuery === 'function' ? _bindQuery() : _bindQuery }`, `/** 绑定模型 Query 源 */`, `export function bindQuery(query: QueryParam) { _bindQuery = query; }`);
     }
     // static
     models.forEach(({ className, pkType }) => {
@@ -109,19 +108,24 @@ async function generate(tables, cfg) {
                 'find',
                 'findByPk',
                 'getByPk',
+                'count',
+                'exists',
                 'create',
                 'createAndGet',
             ].map(i => `  static ${i}: typeof ${className}.repository.${i} = ${className}.repository.${i}.bind(${className}.repository);`));
             // 实例方法
+            repositories.push(`  /** 保存当前实例数据 */`);
             repositories.push(`  save() { return ${className}.repository.save(this); }`);
+            repositories.push(`  /** 更新当前实例数据 */`);
             repositories.push(`  update(data: Partial<${className}>) { return ${className}.repository.update(this, data); }`);
+            repositories.push(`  /** 删除当前实例数据 */`);
             repositories.push(`  delete() { return ${className}.repository.delete(this); }`);
         }
         repositories.push('}');
     });
     // Repositories
     if (config.generateRepositories) {
-        repositories.push(`export class Repositories {`, `  constructor(private _query: QueryParam) {}`, ...models.map(({ className }) => `  get ${className}Repository() { return ${className}.query(this._query); }`), `}`, '');
+        repositories.push('', `export class Repositories {`, `  constructor(private _query: QueryParam) {}`, ...models.map(({ className }) => `  get ${className}Repository() { return ${className}.query(this._query); }`), `}`, '');
         // 添加 Repositories 到目标模块中
         if (config.declareRepositoriesToModules) {
             for (const mod of config.declareRepositoriesToModules) {

package/dist/types.d.ts

@@ -86,11 +86,12 @@ export interface GenerateConfig {
     globalFilename?: string;
     /**
      * 绑定 Query 对象
-     * - 设置 query 源，格式: 'QueryParam@filename' 例如: 'pool@../db'
-     * - 生成模型的静态 Repository 方法
-     * - 对于多租户数据库系统不适用
+     * - repositories 文件生成 bindQuery(query: QueryParam) 方法用于设置模型的 Query 源
+     * - 并生成模型的静态 Repository 方法
+     * - 对于多租户多数据库系统不适用
+     * @default false
      */
-    bindQuery?: string;
+    bindQuery?: boolean;
     /**
      * 是否生成 Repositories 类
      * - 通常用于多租户模式做数据库前置绑定 `Query` 对象

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenorm/generate",
   "description": "Easy ORM, easy query. easy typing! Auto generate typescript declaration.",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "repository": "https://github.com/yefei/zenorm-generate",