@zenorm/generate 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## [0.0.1] - 2023-3-23
+- 从 zenorm@3.25.0 分离为独立项目

package/README.md

@@ -0,0 +1,251 @@
+# ZenORM
+
+[ZenWeb](https://www.npmjs.com/package/zenweb) 衍生的核心项目，此项目可以独立使用
+
+## 安装
+
+```bash
+npm install zenorm mysql-easy-query
+npm install @zenorm/mysql --save-dev
+```
+
+## 配置
+
+在 `package.json` 的 `scripts` 中增加如下代码，用于执行 `dbgen` 命令
+
+```json title="package.json"
+{
+  "scripts": {
+    "dbgen": "zenorm gen .dbgen.json"
+  }
+}
+```
+
+创建文件 `.dbgen.json` 用于生成数据库结构代码时连接到指定数据库
+
+*提示：运行时并不使用此配置*
+
+```json title=".dbgen.json"
+{
+  "host": "localhost",
+  "port": 3306,
+  "user": "root",
+  "password": "",
+  "database": "test"
+}
+```
+
+## 演示
+
+以下数据库结构为演示用，在数据中创建表结构
+
+```sql
+CREATE TABLE `user` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(255) NOT NULL,
+  `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `updated_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+CREATE TABLE `profile` (
+  `id` int(11) NOT NULL,
+  `edu` varchar(255) DEFAULT NULL,
+  `work` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+CREATE TABLE `message` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `user_id` int(11) NOT NULL,
+  `content` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  KEY `fk1` (`user_id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+```
+
+运行命令开始生成数据库结构代码
+
+```bash
+npm run dbgen
+```
+
+### 编辑模型关系
+
+编辑生成的模型文件 `src/model/user.ts`
+
+```ts
+import { model, createRepositoryQuery, join, many, data } from 'zenorm';
+import { UserTable } from './_tables';
+import { Profile } from './profile';
+import { Message } from './message';
+
+@model({
+  pk: 'id',
+  table: 'user',
+})
+export default class User extends UserTable {
+  static query = createRepositoryQuery<User, number>(User);
+
+  // 添加以下代码
+  
+  // join 描述支持使用文件名，解决互相依赖问题
+  @join(__dirname + '/profile', { type: 'OneToMany', asList: false })
+  profile?: Profile;
+
+  @join(Message)
+  messages?: Message[];
+
+  @many(Message)
+  messageList?: Message[];
+
+  @data
+  get age() {
+    return this.birthday ? (new Date().getFullYear()) - this.birthday.getFullYear() : undefined;
+  }
+
+  set age(v) {
+    if (v === undefined) throw new Error('age is undefined');
+    const date = new Date();
+    date.setFullYear(date.getFullYear() - v, 1, 1);
+    this.birthday = date;
+  }
+}
+```
+
+编辑生成的模型文件 `src/model/profile.ts`
+
+```ts
+import { model, createRepositoryQuery, join } from 'zenorm';
+import { ProfileTable } from './_tables';
+import User from './user';
+
+@model({
+  pk: 'id',
+  table: 'profile',
+})
+export default class Profile extends ProfileTable {
+  static query = createRepositoryQuery<Profile, number>(Profile);
+  
+  // 添加以下代码
+
+  @join(User)
+  user?: User;
+}
+```
+
+### 初始化数据库访问层
+
+创建代码 `src/db.ts`
+
+```ts title="src/test.ts"
+import { createPoolCompatible } from 'mysql-easy-query';
+import { Repositories } from './model';
+
+// 创建数据库连接池
+export const pool = createPoolCompatible({
+  pools: {
+    // 主库
+    MASTER: {
+      host: '10.0.0.1',
+      user: 'root',
+      database: 'test',
+      password: '',
+    },
+    // 如果需要读写分离，创建命令规则为 SLAVE* 的只读配置
+    /*
+    SLAVE1: {
+      host: '10.0.0.2'
+    },
+    */
+  }
+});
+
+// 创建仓库访问层
+export const repositories = new Repositories(pool);
+```
+
+### 开始使用
+
+#### 常规使用
+
+```ts
+import { repositories } from './db';
+
+const {
+  UserRepository,
+  MessageRepository,
+} = repositories;
+
+async function test() {
+  // create
+  const id = await UserRepository.create({ name: 'yf' });
+  console.log(id); // 1
+
+  // get and update
+  const user = await UserRepository.findByPk(id);
+  user.name = 'yefei';
+  user.age = 20;
+  await UserRepository.save(user);
+
+  // find all
+  const users = await UserRepository.find().all();
+
+  // find limit
+  const users = await UserRepository.find().limit(10).all();
+
+  // find by where
+  const users = await UserRepository.find({ name: { $like: `%y%` } }).all();
+
+  // get all count
+  const count = await UserRepository.count();
+
+  // page
+  const page = await UserRepository.page();
+
+  // exists
+  const exists = await UserRepository.exists({ id: 1 });
+  // or
+  const exists = await UserRepository.find({ name: 'yf' }).exists();
+
+  // update
+  const updatedCount = await UserRepository.find({ id: 1 }).update({ name: 'yf', age: 11 });
+
+  // delete
+  const user = await UserRepository.findByPk(1);
+  const deletedCount = await UserRepository.delete(user);
+
+  await UserRepository.find({ name: 'aaa' }).delete();
+
+  // join 预定义
+  const user = await UserRepository.find().join("messages").get();
+
+  // join 模型(未定义的)
+  const user = await MessageRepository.find().join(User).all();
+
+  // many 独立查询功能
+  const userList = await UserRepository.find().many("messageList").all();
+
+  // 指定使用主从库
+  await UserRepository.find().of('MASTER').all();
+  await UserRepository.find().of('SLAVE*').all();
+}
+```
+
+#### 事物支持
+
+```ts
+import { pool } from './db';
+import { User, Message } from './model';
+
+async function test() {
+  await pool.transaction(async tx => {
+    await User.query(tx).find().update({ some: 'data' });
+    await Message.query(tx).find().update({ some: 'data' });
+  });
+}
+```
+
+## Related projects
+[mysql-easy-query](https://www.npmjs.com/package/mysql-easy-query)
+[sql-easy-builder](https://www.npmjs.com/package/sql-easy-builder)

package/dist/bin/zenorm-generate.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/zenorm-generate.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
+const generate_1 = require("../generate");
+function getConfig() {
+    const configFile = path.join(process.cwd(), process.argv[3]);
+    const config = require(configFile);
+    return Object.assign({
+        backend: '@zenorm/mysql',
+    }, config);
+}
+async function main() {
+    const config = await getConfig();
+    const call = require(config.backend).default;
+    await (0, generate_1.generate)(call()(config), config);
+}
+if (!process.argv[2]) {
+    console.log('zenorm-generate config.json');
+    process.exit(1);
+}
+else {
+    main().then(() => process.exit(), e => {
+        console.error(e);
+        process.exit(1);
+    });
+}

package/dist/generate.d.ts

@@ -0,0 +1,2 @@
+import { GenerateConfig, TabelDescribe } from './types';
+export declare function generate(tables: AsyncGenerator<TabelDescribe>, cfg?: GenerateConfig): Promise<void>;

package/dist/generate.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+const fs_1 = require("fs");
+const path = require("path");
+const pascal_case_1 = require("pascal-case");
+const snake_case_1 = require("snake-case");
+const zenormName = process.env.ZENORM_NAME || 'zenorm';
+function cwdPath(p) {
+    if (p.startsWith('./')) {
+        return path.join(process.cwd(), p.slice(2));
+    }
+    return p;
+}
+function checkFileDir(dir) {
+    return fs_1.promises.mkdir(dir, { recursive: true });
+}
+function fileExists(f) {
+    return fs_1.promises.access(f).then(() => true, e => false);
+}
+function datetime() {
+    return new Date().toLocaleString();
+}
+async function generate(tables, cfg) {
+    console.log('generate models...');
+    const config = Object.assign({
+        outputDir: './src/model',
+        tablesFilename: '_tables',
+        repositoriesFilename: '_repositories',
+        globalFilename: '_global',
+    }, cfg);
+    const outputDir = cwdPath(config.outputDir);
+    await checkFileDir(outputDir);
+    console.log('database:', config.database);
+    const remark = [
+        '// zenorm 自动生成文件',
+        '// 请不要修改此文件，因为此文件在每次重新生成数据库结构时会被覆盖',
+        `// create at: ${datetime()}`,
+        `// create by: ${process.env.USER || process.env.USERNAME || '-'}@${process.env.COMPUTERNAME || '-'}`,
+        `// database: ${config.database}`,
+    ];
+    const structs = [
+        ...remark,
+        `import _Global from './${config.globalFilename}';`,
+        '',
+    ];
+    const models = [];
+    const filterRegExp = config.filter ? new RegExp(config.filter) : null;
+    const includeRegExp = config.include ? new RegExp(config.include) : null;
+    for await (const t of tables) {
+        const tableName = t.name;
+        if ((filterRegExp && filterRegExp.test(tableName))
+            || (includeRegExp && !includeRegExp.test(tableName))) {
+            // console.log('table:', tableName, 'ignore');
+            continue;
+        }
+        const className = (0, pascal_case_1.pascalCase)(tableName);
+        const name = (0, snake_case_1.snakeCase)(tableName);
+        const outputFilename = path.join(outputDir, name + '.ts');
+        console.log('table:', tableName);
+        let pk = 'id';
+        let pkType = 'number';
+        const props = [];
+        const columns = [];
+        for (const c of t.columns) {
+            if (c.pk) {
+                pk = c.name;
+                pkType = c.type;
+            }
+            if (c.comment && c.comment.length) {
+                props.push(`  /**`);
+                for (const line of c.comment) {
+                    props.push(`   * ${line}`);
+                }
+                props.push(`   */`);
+            }
+            props.push(`  ${c.name}${c.required ? '!' : '?'}: ${c.type};`);
+            columns.push(c.name);
+        }
+        structs.push(`export class ${className}Table extends _Global {`);
+        structs.push(`  static columns = ${JSON.stringify(columns)};`);
+        structs.push(...props);
+        structs.push('}');
+        structs.push('');
+        if (!await fileExists(outputFilename)) {
+            const ts = [
+                `import { model } from '${zenormName}';`,
+                `import { ${className}Table } from './${config.tablesFilename}';`,
+                '',
+                `@model({`,
+                `  pk: '${pk}',`,
+                name != tableName ? `  name: '${name}',` : null,
+                `  table: '${tableName}',`,
+                `})`,
+                `export default class ${className} extends ${className}Table {`,
+                `}`,
+                '',
+            ];
+            await fs_1.promises.writeFile(outputFilename, ts.filter(i => i !== null).join('\n'));
+        }
+        models.push([name, className, pkType]);
+    }
+    const tablesFilename = path.join(outputDir, config.tablesFilename + '.ts');
+    console.log(`write tables file: ${tablesFilename}`);
+    await fs_1.promises.writeFile(tablesFilename, structs.join('\n'));
+    const repositories = [
+        ...remark,
+        `import { QueryParam, createRepositoryQuery } from '${zenormName}';`,
+        ...models.map(([name, className]) => `import _${className} from './${name}';`),
+        '',
+    ];
+    // static
+    models.forEach(([name, className, pkType]) => {
+        repositories.push(`export class ${className} extends _${className} {`, `  static query = createRepositoryQuery<${className}, ${pkType}>(${className});`, `}`, '');
+    });
+    // Repositories
+    repositories.push(`export class Repositories {`, `  constructor(private _query: QueryParam) {}`, ...models.map(([name, className]) => `  get ${className}Repository() { return ${className}.query(this._query); }`), `}`, '');
+    // 添加 Repositories 到目标模块中
+    if (config.declareRepositoriesToModules) {
+        for (const mod of config.declareRepositoriesToModules) {
+            const _m = mod.split('.');
+            repositories.push(`declare module '${_m[0]}' {`);
+            repositories.push(`  interface ${_m.slice(1, -1).join('.')} {`);
+            repositories.push(`    ${_m[_m.length - 1]}: Repositories;`);
+            repositories.push(`  }`);
+            repositories.push(`}`);
+            repositories.push(``);
+        }
+    }
+    const repositoriesFilename = path.join(outputDir, config.repositoriesFilename + '.ts');
+    console.log(`write repositories file: ${repositoriesFilename}`);
+    await fs_1.promises.writeFile(repositoriesFilename, repositories.join('\n'));
+    // 生成 global.ts
+    await notExistsPut(path.join(outputDir, config.globalFilename + '.ts'), () => {
+        return 'export default class Global {}';
+    });
+    // 生成 index.ts
+    await notExistsPut(path.join(outputDir, 'index.ts'), () => {
+        return [
+            `export * from './${config.tablesFilename}';`,
+            `export * from './${config.repositoriesFilename}';`,
+        ].join('\n');
+    });
+}
+exports.generate = generate;
+/**
+ * 文件不存在则创建并写入内容
+ * @param filename
+ * @param getContent
+ */
+async function notExistsPut(filename, getContent) {
+    if (!await fileExists(filename)) {
+        console.log(`write file: ${filename}`);
+        await fs_1.promises.writeFile(filename, getContent());
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 模型文件生成 - 列描述
+ */
+export interface ColumnDescribe {
+    /**
+     * 是否为主键
+     */
+    pk: boolean;
+    /**
+     * 列名称
+     */
+    name: string;
+    /**
+     * 列类型，例如 number, string, boolean
+     */
+    type: string;
+    /**
+     * 是否为必须项（非NULL）
+     */
+    required: boolean;
+    /**
+     * 注释信息，一行一条
+     */
+    comment: string[];
+}
+/**
+ * 模型文件生成 - 表描述
+ */
+export interface TabelDescribe {
+    /**
+     * 表名称
+     */
+    name: string;
+    /**
+     * 列描述信息
+     */
+    columns: ColumnDescribe[];
+}
+/**
+ * 生成配置
+ */
+export interface GenerateConfig {
+    host?: string;
+    port?: number;
+    user?: string;
+    password?: string;
+    database?: string;
+    /**
+     * 代码输出目录
+     * @default './src/model'
+     */
+    outputDir?: string;
+    /**
+     * 生成数据库表结构文件名
+     * 此文件每次生成都会被重新改写
+     * @default '_tables'
+     */
+    tablesFilename?: string;
+    /**
+     * 生成 Repositories 文件名
+     * 此文件每次生成都会被重新改写
+     * @default '_repositories'
+     */
+    repositoriesFilename?: string;
+    /**
+     * 全局文件名
+     * @default '_global'
+     */
+    globalFilename?: string;
+    /**
+     * 是否需将 Repositories 实例定义到目标模块中
+     * - 例如: ["@zenweb/core.Core.repositories"]
+     * @default undefined
+     */
+    declareRepositoriesToModules?: string[];
+    /**
+     * 表过滤规则正则，默认不处理
+     */
+    filter?: string;
+    /**
+     * 表包含规则正则，默认不处理
+     */
+    include?: string;
+}
+/**
+ * 数据库表信息生成方法
+ */
+export type GenerateFunction = (config: GenerateConfig) => AsyncGenerator<TabelDescribe>;

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@zenorm/generate",
+  "description": "Easy ORM, easy query. easy typing! Auto generate typescript declaration.",
+  "version": "0.0.1",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "repository": "https://github.com/yefei/easy-model",
+  "author": "YeFei <316606233@qq.com>",
+  "license": "MIT",
+  "bin": {
+    "zenorm-generate": "./dist/bin/zenorm-generate.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "prepublishOnly": "npm run build",
+    "gen": "cross-env ZENORM_NAME=../../src ts-node ./src/bin/zenorm-generate.ts test/config.json"
+  },
+  "keywords": [
+    "mysql",
+    "query",
+    "model",
+    "types",
+    "generate",
+    "database"
+  ],
+  "devDependencies": {
+    "@types/node": "^12.20.41",
+    "@zenorm/mysql": "^1.0.0",
+    "cross-env": "^7.0.3",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "pascal-case": "^3.1.2",
+    "snake-case": "^3.0.4"
+  }
+}