@diyaner/egg-typeorm 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# egg-ts-template
+
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![David deps][david-image]][david-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/egg-ts-template.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-ts-template
+[travis-image]: https://img.shields.io/travis/eggjs/egg-ts-template.svg?style=flat-square
+[travis-url]: https://travis-ci.org/eggjs/egg-ts-template
+[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-ts-template.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/eggjs/egg-ts-template?branch=master
+[david-image]: https://img.shields.io/david/eggjs/egg-ts-template.svg?style=flat-square
+[david-url]: https://david-dm.org/eggjs/egg-ts-template
+[snyk-image]: https://snyk.io/test/npm/egg-ts-template/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/egg-ts-template
+[download-image]: https://img.shields.io/npm/dm/egg-ts-template.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-ts-template
+
+<!--
+Description here.
+-->
+
+## Install
+
+```bash
+$ npm i egg-ts-template --save
+```
+
+## Usage
+
+```js
+// {app_root}/config/plugin.js
+exports.typeorm = {
+  enable: true,
+  package: 'egg-typeorm',
+};
+```
+
+## Configuration
+
+```js
+// {app_root}/config/config.default.js
+exports.typeorm = {
+  agent:true,
+  datasources:[
+    {...}
+  ]
+};
+```
+
+see [config/config.default.js](config/config.default.js) for more detail.
+
+## Example
+
+<!-- example here -->
+- 实体entity放在app/entity目录下
+- 实体必须使用默认default导出，这样才能正确使用ets自动类型声明并绑定给app.entity
+- 实体default导出，同时还是必须要设置class的类名，否则typeorm无法正确解析设置数据库表名
+- 如果有多个连接，则每个连接必须提供name属性，且唯一。name也是entity下的子目录区分。这是entity目录下直接实体将挂在第一个数据库配置连接上。比如连接2使用db2，则entity目录下db2目录下的entity才会绑定给这个连接。
+- 如果单个连接，则所有实体entity都会挂在这个连接上，不会按二级目录区分。
+
+
+
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](LICENSE)

package/README.zh_CN.md

@@ -0,0 +1,76 @@
+# egg-ts-template
+
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![David deps][david-image]][david-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: https://img.shields.io/npm/v/egg-ts-template.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/egg-ts-template
+[travis-image]: https://img.shields.io/travis/eggjs/egg-ts-template.svg?style=flat-square
+[travis-url]: https://travis-ci.org/eggjs/egg-ts-template
+[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-ts-template.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/eggjs/egg-ts-template?branch=master
+[david-image]: https://img.shields.io/david/eggjs/egg-ts-template.svg?style=flat-square
+[david-url]: https://david-dm.org/eggjs/egg-ts-template
+[snyk-image]: https://snyk.io/test/npm/egg-ts-template/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/egg-ts-template
+[download-image]: https://img.shields.io/npm/dm/egg-ts-template.svg?style=flat-square
+[download-url]: https://npmjs.org/package/egg-ts-template
+
+<!--
+Description here.
+-->
+
+## 依赖说明
+
+### 依赖的 egg 版本
+
+egg-ts-template 版本 | egg 1.x
+--- | ---
+1.x | 😁
+0.x | ❌
+
+### 依赖的插件
+<!--
+
+如果有依赖其它插件，请在这里特别说明。如
+
+- security
+- multipart
+
+-->
+
+## 开启插件
+
+```js
+// config/plugin.js
+exports.tsTemplate = {
+  enable: true,
+  package: 'egg-ts-template',
+};
+```
+
+## 使用场景
+
+- Why and What: 描述为什么会有这个插件，它主要在完成一件什么事情。
+尽可能描述详细。
+- How: 描述这个插件是怎样使用的，具体的示例代码，甚至提供一个完整的示例，并给出链接。
+
+## 详细配置
+
+请到 [config/config.default.js](config/config.default.js) 查看详细配置项说明。
+
+## 单元测试
+
+<!-- 描述如何在单元测试中使用此插件，例如 schedule 如何触发。无则省略。-->
+
+## 提问交流
+
+请到 [egg issues](https://github.com/eggjs/egg/issues) 异步交流。
+
+## License
+
+[MIT](LICENSE)

package/agent.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const loader_1 = require("./lib/loader");
+const connection_1 = require("./lib/connection");
+class EggTypeOrmAppBoot {
+    constructor(app) {
+        this.app = app;
+    }
+    configDidLoad() {
+        if (this.app.config.typeorm.agent) {
+            this.app.typeorm = this.app.typeorm || {
+                dataSource: {},
+            };
+            loader_1.default(this.app);
+            connection_1.default(this.app);
+        }
+    }
+}
+exports.default = EggTypeOrmAppBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJhZ2VudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLDRCQUEwQjtBQUUxQix5Q0FBc0M7QUFDdEMsaURBQTJDO0FBRTNDLE1BQXFCLGlCQUFpQjtJQUVyQyxZQUFZLEdBQWdCO1FBQzNCLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO0lBQ2hCLENBQUM7SUFDRCxhQUFhO1FBQ1osSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsS0FBSyxFQUFFO1lBQ2xDLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxJQUFJO2dCQUN0QyxVQUFVLEVBQUUsRUFBRTthQUNkLENBQUM7WUFDRixnQkFBVSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztZQUNyQixvQkFBVyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztTQUl0QjtJQUNGLENBQUM7Q0FDRDtBQWpCRCxvQ0FpQkMifQ==

package/app.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const loader_1 = require("./lib/loader");
+const connection_1 = require("./lib/connection");
+class EggTypeOrmAppBoot {
+    constructor(app) {
+        this.app = app;
+    }
+    configDidLoad() {
+        this.app.typeorm = this.app.typeorm || {
+            dataSource: {}
+        };
+        loader_1.default(this.app);
+        connection_1.default(this.app);
+    }
+}
+exports.default = EggTypeOrmAppBoot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiYXBwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsNEJBQTBCO0FBRTFCLHlDQUFzQztBQUN0QyxpREFBMEM7QUFFMUMsTUFBcUIsaUJBQWlCO0lBRXJDLFlBQVksR0FBZ0I7UUFDM0IsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7SUFDaEIsQ0FBQztJQUNELGFBQWE7UUFDWixJQUFJLENBQUMsR0FBRyxDQUFDLE9BQU8sR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLE9BQU8sSUFBSTtZQUN0QyxVQUFVLEVBQUMsRUFBRTtTQUNiLENBQUM7UUFDRixnQkFBVSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNyQixvQkFBVyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUd2QixDQUFDO0NBR0Q7QUFoQkQsb0NBZ0JDIn0=

package/config/config.default.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = () => {
+    const config = {};
+    config.typeorm = {
+        agent: false
+    };
+    return config;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJjb25maWcuZGVmYXVsdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFRQSxZQUFZLENBQUM7O0FBVWIsa0JBQWUsR0FBRyxFQUFFO0lBQ25CLE1BQU0sTUFBTSxHQUFHLEVBQWdDLENBQUM7SUFDaEQsTUFBTSxDQUFDLE9BQU8sR0FBRztRQUNoQixLQUFLLEVBQUMsS0FBSztLQUNYLENBQUM7SUFDRixPQUFPLE1BQU0sQ0FBQztBQUNmLENBQUMsQ0FBQyJ9

package/index.d.ts

@@ -0,0 +1,36 @@
+/*
+ * @copyright: Huang Ding
+ * @Author: ding-cx
+ * @Date: 2021-02-21 17:47:08
+ * @LastEditors: ding-cx
+ * @LastEditTime: 2021-02-21 17:47:51
+ * @Description: file content
+ */
+
+import Egg from "egg";
+import * as typeorm from "typeorm";
+
+declare module "egg" {
+	/** egg插件的typeorm的连接选项 */
+
+	/** typeorm 已弃用name属性，但egg-typeorm需要使用 */
+	type EggConfigTypeormDataSourceOptions = { name?: string } & typeorm.DataSourceOptions;
+	interface EggAppConfig {
+		/** typeorm 数据库连接配置 */
+		typeorm: {
+			agent: boolean;
+			datasources: EggConfigTypeormDataSourceOptions[];
+		};
+	}
+
+	interface Application {
+		typeorm: {
+			/** 数据库连接实例 其key为配置时的name属性 */
+			dataSource: {
+				[key: string]: typeorm.DataSource;
+			};
+			// entity: any;
+		};
+	}
+}
+export = Egg;

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@diyaner/egg-typeorm",
+  "version": "0.0.2",
+  "description": "egg plugin for nodejs orm freamwork typeorm.",
+  "eggPlugin": {
+    "name": "typeorm"
+  },
+  "keywords": [
+    "egg",
+    "eggPlugin",
+    "egg-plugin",
+    "egg-typeorm",
+    "typeorm"
+  ],
+  "dependencies": {
+    "reflect-metadata": "^0.1.13",
+    "typeorm": "^0.3.13"
+  },
+  "devDependencies": {
+    "@types/mocha": "^8.2.1",
+    "autod": "^3.0.1",
+    "autod-egg": "^1.1.0",
+    "egg": "^2.16.0",
+    "egg-bin": "^4.11.0",
+    "egg-ci": "^1.11.0",
+    "egg-mock": "^3.21.0",
+    "eslint": "^5.13.0",
+    "eslint-config-egg": "^7.1.0",
+    "mysql2": "^3.2.0",
+    "typescript": "^4.1.5"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "scripts": {
+    "test": "npm run lint -- --fix && egg-bin pkgfiles && npm run test-local",
+    "test-local": "tsc && egg-bin test && npm run clean:js",
+    "tsc": "tsc",
+    "clean:js": "ets clean",
+    "release": "tsc && npm publish --access public && npm run clean:js",
+    "cov": "egg-bin cov",
+    "lint": "eslint .",
+    "ci": "egg-bin pkgfiles --check && npm run lint && npm run cov",
+    "pkgfiles": "egg-bin pkgfiles",
+    "autod": "autod"
+  },
+  "files": [
+    "app.js",
+    "agent.js",
+    "tshelper.js",
+    "config/**/*.js",
+    "app/**/*.js",
+    "index.d.ts"
+  ],
+  "ci": {
+    "version": "8, 10"
+  },
+  "author": "ding",
+  "license": "MIT"
+}

package/tshelper.js

@@ -0,0 +1,24 @@
+module.exports = {
+	watchDirs: {
+		entity: {
+			directory: "app/entity",
+			generator: "object",
+			interface: "IEntity",
+			declareTo: "Application.entity",
+			// caseStyle: "upper",
+			watch: true,
+			distName: "entity.d.ts",
+		},
+	},
+	generatorConfig: {
+		entity: {
+			directory: "app/entity",
+			generator: "object",
+			interface: "IEntity",
+			declareTo: "Application.entity",
+			// caseStyle: "upper",
+			watch: true,
+			distName: "entity.d.ts",
+		},
+	},
+};