@eggjs/dal-runtime 3.33.0 → 3.33.1

package/dist/src/templates/base_dao.njk

@@ -0,0 +1,150 @@
+{% macro newDataLogic(columns, old, new) %}
+let tmp;
+{% for column in table.columns %}
+// empty-line
+tmp = {{ old }}.{{ column.propertyName }};
+if (tmp !== undefined) {
+  {{ new }}.${{ column.propertyName }} = tmp;
+}
+{% endfor %}
+{% endmacro %}
+
+{% macro findLogic(funcName, sqlName, idx, uniq) %}
+public async {{ funcName }}(
+  {% for key in idx.keys %}
+  ${{ key.propertyName }}: {{columnMap[key.propertyName].type.type | dbTypeToTSType}}{% if loop.last !== true %},{% endif%}
+  {% endfor %}
+): Promise<{{ clazzName }}{{ '| null' if uniq else '[]' }}> {
+  return this.dataSource.{{ 'executeScalar' if uniq else 'execute' }}('{{ sqlName }}', {
+    {% for key in idx.keys %}
+    ${{ key.propertyName }},
+    {% endfor %}
+  });
+}
+{% endmacro %}
+
+{% macro generatePrimaryType(primary) %}
+{% if (primary.keys | length) === 1 %}
+{{primary.keys[0].propertyName}}: {{ columnMap[primary.keys[0].propertyName].type.type | dbTypeToTSType}}
+{% else %}
+primary: {
+  {% for key in primary.keys %}
+  {{ key.propertyName }}: {{columnMap[key.propertyName].type.type | dbTypeToTSType}}{% if loop.last !== true %},{% endif%}
+  {% endfor %}
+}
+{% endif %}
+{% endmacro %}
+
+{% macro generateUpdateValue(primary) %}
+{% if (primary.keys | length) === 1 %}
+const newData: Record<string, any> = {
+  primary: {
+    {{primary.keys[0].propertyName}},
+  },
+};
+{% else %}
+const newData: Record<string, any> = {
+  primary,
+};
+{% endif %}
+{% endmacro %}
+
+{% macro generateDeleteValue(primary) %}
+{% if (primary.keys | length) === 1 %}
+{
+  {{primary.keys[0].propertyName}},
+}
+
+{% else %}
+primary
+{% endif %}
+{% endmacro %}
+
+{% macro generateInsertType(primary) %}
+Optional<{{clazzName}},
+  {% for key in primary.keys %}
+  '{{ key.propertyName }}'{% if loop.last !== true %}|{% endif%}
+  {% endfor %}
+>
+{% endmacro %}
+
+import type { InsertResult, UpdateResult, DeleteResult } from '@eggjs/rds/lib/types';
+import { SingletonProto, AccessLevel, Inject } from '@eggjs/tegg';
+import { DataSource, DataSourceInjectName, DataSourceQualifier, ColumnTsType } from '@eggjs/tegg/dal';
+import { {{ clazzName }} } from '{{ tableModelPath }}';
+// empty-line
+type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;
+/**
+ * 自动生成的 {{ clazzName }}DAO 基类
+ * @class Base{{ clazzName }}DAO
+ * @classdesc 该文件由 @eggjs/tegg 自动生成，请**不要**修改它！
+ */
+/* istanbul ignore next */
+@SingletonProto({
+  accessLevel: AccessLevel.PUBLIC,
+})
+export class Base{{ clazzName }}DAO {
+  static clazzModel = {{ clazzName }};
+
+  @Inject({
+    name: DataSourceInjectName,
+  })
+  @DataSourceQualifier('{{moduleName}}.{{ table.dataSourceName }}.{{ clazzName }}')
+  protected readonly dataSource: DataSource<{{clazzName}}>;
+
+  // empty-line
+  {# insert: 插入 #}
+  public async insert(raw: {{generateInsertType(primaryIndex)}}): Promise<InsertResult> {
+    const data: Record<string, any> = {};
+
+    {{ newDataLogic(columns, 'raw', 'data') }}
+
+    // empty-line
+    return this.dataSource.executeRawScalar('insert', data);
+  }
+
+  // empty-line
+  {# update: 更新 #}
+  public async update({{generatePrimaryType(primaryIndex)}}, data: Partial<{{ ((clazzName)) }}>): Promise<UpdateResult> {
+    // empty-line
+    {{ generateUpdateValue(primaryIndex) }}
+
+    {{ newDataLogic(columns, 'data', 'newData') }}
+
+    // empty-line
+    return this.dataSource.executeRawScalar('update', newData);
+  }
+
+  {% for funcName in [ 'delete', 'del' ] %}
+  // empty-line
+  {# delete: 删除 #}
+  public async {{ funcName }}({{generatePrimaryType(primaryIndex)}}): Promise<DeleteResult> {
+    return this.dataSource.executeRawScalar('delete', {{generateDeleteValue(primaryIndex)}});
+  }
+  {% endfor %}
+
+  {% for idx in table.indices %}
+  // empty-line
+  {# 某个索引 #}
+  {% set tmpName = ((idx.keys[0].propertyName if (idx.keys | length) === 1 else idx.name) | pascalCase) %}
+  {% set findName = 'findBy' + tmpName %}
+  {% set findOneName = 'findOneBy' + tmpName %}
+    {{ findLogic(findName, findName, idx, false) }}
+    // empty-line
+    {{ findLogic(findOneName, findOneName, idx, true) }}
+  {% endfor %}
+
+  // empty-line
+  {# 某个索引 #}
+  {% if primaryIndex %}
+    {% set tmpName = ((primaryIndex.keys[0].propertyName if (primaryIndex.keys | length) === 1 else primaryIndex.name) | pascalCase) %}
+    {% set findName = 'findBy' + tmpName %}
+    {% set findOneName = 'findOneBy' + tmpName %}
+      {{ findLogic(findName, findName, primaryIndex, true) }}
+      {% if (primaryIndex.keys | length) === 1 %}
+      // empty-line
+      {{ findLogic('findByPrimary', findName, primaryIndex, true) }}
+      {% endif %}
+  {% endif %}
+}
+// empty-line

package/dist/src/templates/dao.njk

@@ -0,0 +1,17 @@
+import { SingletonProto, AccessLevel } from '@eggjs/tegg';
+import { Base{{ clazzName }}DAO } from './base/Base{{ clazzName }}DAO';
+// empty-line
+/**
+ * {{ clazzName }}DAO 类
+{% if user.name %} * @author {{ user.name }} {% if user.email %}<{{ user.email }}>{% endif %}
+{% endif %} * @class {{ clazzName }}DAO
+ * @classdesc 在此扩展关于 {{ clazzName }} 数据的一切操作
+ * @extends Base{{ clazzName }}DAO
+ */
+@SingletonProto({
+  accessLevel: AccessLevel.PUBLIC,
+})
+export default class {{ clazzName }}DAO extends Base{{ clazzName }}DAO {
+  // empty-line
+}
+// empty-line

package/dist/src/templates/extension.njk

@@ -0,0 +1,17 @@
+import { SqlMap } from '@eggjs/tegg/dal';
+// empty-line
+/**
+ * Define Custom SQLs
+ *
+ * import { SqlMap, SqlType } from '@eggjs/tegg/dal';
+ *
+ * export default {
+ *   findByName: {
+ *     type: SqlType.SELECT,
+ *     sql: 'SELECT {{ allColumns }} from foo where name = {{ name }}'
+ *   },
+ * }
+ */
+export default {
+// empty-line
+} as Record<string, SqlMap>;

package/dist/src/templates/templates/base_dao.njk

@@ -0,0 +1,150 @@
+{% macro newDataLogic(columns, old, new) %}
+let tmp;
+{% for column in table.columns %}
+// empty-line
+tmp = {{ old }}.{{ column.propertyName }};
+if (tmp !== undefined) {
+  {{ new }}.${{ column.propertyName }} = tmp;
+}
+{% endfor %}
+{% endmacro %}
+
+{% macro findLogic(funcName, sqlName, idx, uniq) %}
+public async {{ funcName }}(
+  {% for key in idx.keys %}
+  ${{ key.propertyName }}: {{columnMap[key.propertyName].type.type | dbTypeToTSType}}{% if loop.last !== true %},{% endif%}
+  {% endfor %}
+): Promise<{{ clazzName }}{{ '| null' if uniq else '[]' }}> {
+  return this.dataSource.{{ 'executeScalar' if uniq else 'execute' }}('{{ sqlName }}', {
+    {% for key in idx.keys %}
+    ${{ key.propertyName }},
+    {% endfor %}
+  });
+}
+{% endmacro %}
+
+{% macro generatePrimaryType(primary) %}
+{% if (primary.keys | length) === 1 %}
+{{primary.keys[0].propertyName}}: {{ columnMap[primary.keys[0].propertyName].type.type | dbTypeToTSType}}
+{% else %}
+primary: {
+  {% for key in primary.keys %}
+  {{ key.propertyName }}: {{columnMap[key.propertyName].type.type | dbTypeToTSType}}{% if loop.last !== true %},{% endif%}
+  {% endfor %}
+}
+{% endif %}
+{% endmacro %}
+
+{% macro generateUpdateValue(primary) %}
+{% if (primary.keys | length) === 1 %}
+const newData: Record<string, any> = {
+  primary: {
+    {{primary.keys[0].propertyName}},
+  },
+};
+{% else %}
+const newData: Record<string, any> = {
+  primary,
+};
+{% endif %}
+{% endmacro %}
+
+{% macro generateDeleteValue(primary) %}
+{% if (primary.keys | length) === 1 %}
+{
+  {{primary.keys[0].propertyName}},
+}
+
+{% else %}
+primary
+{% endif %}
+{% endmacro %}
+
+{% macro generateInsertType(primary) %}
+Optional<{{clazzName}},
+  {% for key in primary.keys %}
+  '{{ key.propertyName }}'{% if loop.last !== true %}|{% endif%}
+  {% endfor %}
+>
+{% endmacro %}
+
+import type { InsertResult, UpdateResult, DeleteResult } from '@eggjs/rds/lib/types';
+import { SingletonProto, AccessLevel, Inject } from '@eggjs/tegg';
+import { DataSource, DataSourceInjectName, DataSourceQualifier, ColumnTsType } from '@eggjs/tegg/dal';
+import { {{ clazzName }} } from '{{ tableModelPath }}';
+// empty-line
+type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;
+/**
+ * 自动生成的 {{ clazzName }}DAO 基类
+ * @class Base{{ clazzName }}DAO
+ * @classdesc 该文件由 @eggjs/tegg 自动生成，请**不要**修改它！
+ */
+/* istanbul ignore next */
+@SingletonProto({
+  accessLevel: AccessLevel.PUBLIC,
+})
+export class Base{{ clazzName }}DAO {
+  static clazzModel = {{ clazzName }};
+
+  @Inject({
+    name: DataSourceInjectName,
+  })
+  @DataSourceQualifier('{{moduleName}}.{{ table.dataSourceName }}.{{ clazzName }}')
+  protected readonly dataSource: DataSource<{{clazzName}}>;
+
+  // empty-line
+  {# insert: 插入 #}
+  public async insert(raw: {{generateInsertType(primaryIndex)}}): Promise<InsertResult> {
+    const data: Record<string, any> = {};
+
+    {{ newDataLogic(columns, 'raw', 'data') }}
+
+    // empty-line
+    return this.dataSource.executeRawScalar('insert', data);
+  }
+
+  // empty-line
+  {# update: 更新 #}
+  public async update({{generatePrimaryType(primaryIndex)}}, data: Partial<{{ ((clazzName)) }}>): Promise<UpdateResult> {
+    // empty-line
+    {{ generateUpdateValue(primaryIndex) }}
+
+    {{ newDataLogic(columns, 'data', 'newData') }}
+
+    // empty-line
+    return this.dataSource.executeRawScalar('update', newData);
+  }
+
+  {% for funcName in [ 'delete', 'del' ] %}
+  // empty-line
+  {# delete: 删除 #}
+  public async {{ funcName }}({{generatePrimaryType(primaryIndex)}}): Promise<DeleteResult> {
+    return this.dataSource.executeRawScalar('delete', {{generateDeleteValue(primaryIndex)}});
+  }
+  {% endfor %}
+
+  {% for idx in table.indices %}
+  // empty-line
+  {# 某个索引 #}
+  {% set tmpName = ((idx.keys[0].propertyName if (idx.keys | length) === 1 else idx.name) | pascalCase) %}
+  {% set findName = 'findBy' + tmpName %}
+  {% set findOneName = 'findOneBy' + tmpName %}
+    {{ findLogic(findName, findName, idx, false) }}
+    // empty-line
+    {{ findLogic(findOneName, findOneName, idx, true) }}
+  {% endfor %}
+
+  // empty-line
+  {# 某个索引 #}
+  {% if primaryIndex %}
+    {% set tmpName = ((primaryIndex.keys[0].propertyName if (primaryIndex.keys | length) === 1 else primaryIndex.name) | pascalCase) %}
+    {% set findName = 'findBy' + tmpName %}
+    {% set findOneName = 'findOneBy' + tmpName %}
+      {{ findLogic(findName, findName, primaryIndex, true) }}
+      {% if (primaryIndex.keys | length) === 1 %}
+      // empty-line
+      {{ findLogic('findByPrimary', findName, primaryIndex, true) }}
+      {% endif %}
+  {% endif %}
+}
+// empty-line

package/dist/src/templates/templates/dao.njk

@@ -0,0 +1,17 @@
+import { SingletonProto, AccessLevel } from '@eggjs/tegg';
+import { Base{{ clazzName }}DAO } from './base/Base{{ clazzName }}DAO';
+// empty-line
+/**
+ * {{ clazzName }}DAO 类
+{% if user.name %} * @author {{ user.name }} {% if user.email %}<{{ user.email }}>{% endif %}
+{% endif %} * @class {{ clazzName }}DAO
+ * @classdesc 在此扩展关于 {{ clazzName }} 数据的一切操作
+ * @extends Base{{ clazzName }}DAO
+ */
+@SingletonProto({
+  accessLevel: AccessLevel.PUBLIC,
+})
+export default class {{ clazzName }}DAO extends Base{{ clazzName }}DAO {
+  // empty-line
+}
+// empty-line

package/dist/src/templates/templates/extension.njk

@@ -0,0 +1,17 @@
+import { SqlMap } from '@eggjs/tegg/dal';
+// empty-line
+/**
+ * Define Custom SQLs
+ *
+ * import { SqlMap, SqlType } from '@eggjs/tegg/dal';
+ *
+ * export default {
+ *   findByName: {
+ *     type: SqlType.SELECT,
+ *     sql: 'SELECT {{ allColumns }} from foo where name = {{ name }}'
+ *   },
+ * }
+ */
+export default {
+// empty-line
+} as Record<string, SqlMap>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/dal-runtime",
-  "version": "3.33.0",
+  "version": "3.33.1",
   "description": "tegg dal decorator",
   "keywords": [
     "egg",
@@ -12,14 +12,16 @@
   "main": "dist/index.js",
   "files": [
     "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "dist/**/*.d.ts",
+    "dist/**/*.njk"
   ],
   "typings": "dist/index.d.ts",
   "scripts": {
     "test": "cross-env NODE_ENV=test NODE_OPTIONS='--no-deprecation' mocha",
     "clean": "tsc -b --clean",
     "tsc": "npm run clean && tsc -p ./tsconfig.json",
-    "tsc:pub": "npm run clean && tsc -p ./tsconfig.pub.json",
+    "tsc:pub": "npm run clean && tsc -p ./tsconfig.pub.json && npm run cp:template",
+    "cp:template": "cp -r src/templates dist/src/templates",
     "prepublishOnly": "npm run tsc:pub"
   },
   "author": "killagu <killa123@126.com>",
@@ -37,7 +39,7 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
-    "@eggjs/dal-decorator": "^3.33.0",
+    "@eggjs/dal-decorator": "^3.33.1",
     "@eggjs/rds": "^1.0.0",
     "js-beautify": "^1.15.1",
     "lodash": "^4.17.21",
@@ -49,7 +51,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "@eggjs/tegg": "^3.33.0",
+    "@eggjs/tegg": "^3.33.1",
     "@types/lodash": "^4.17.0",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.2.4",
@@ -59,5 +61,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },
-  "gitHead": "8415595364405be14730f6151ded8763bfb12454"
+  "gitHead": "0c382d6aeb23cc50bc1f082402901d6ba9f03686"
 }