@shys/crud 1.0.1-beta.0

package/templates/controller.njk

@@ -0,0 +1,65 @@
+import { Controller, Inject } from '@midwayjs/core';
+import { CrudPiped } from '@shys/crud-piped';
+import { {{ Pascal }} } from '../entity/{{ Camel }}.entity';
+import { {{ ServiceName }} } from '../service/{{ Camel }}.service';
+import {
+  {{ CreateName }},
+  {{ UpdateName }},
+  {{ ReplaceName }},
+  {{ QueryName }},
+} from '../dto/{{ Camel }}';
+import { {{ VOName }}, {{ ListVOName }} } from '../vo/{{ Camel }}';
+
+@Controller({{ ('/api/' + pluralKebab) | json }}, {
+  tagName: {{ tagName | json }},
+  description: {{ desc | json }},
+})
+@CrudPiped({
+  model: {{ Pascal }},
+  service: {{ ServiceName }},
+  id: {{ idField | json }},
+  dto: {
+    create: {{ CreateName }},
+    update: {{ UpdateName }},
+    replace: {{ ReplaceName }},
+    query: {{ QueryName }},
+  },
+  serialize: {
+    get: {{ VOName }},
+    list: {{ ListVOName }},
+    create: {{ VOName }},
+    update: {{ VOName }},
+  },
+  routes: {
+    only: ['list', 'detail', 'create', 'update', 'replace', 'delete'],
+  },
+  query: {
+    maxLimit: 100,
+    defaultLimit: 10,
+    sortable: [{{ sortable }}],
+    filterable: [{{ filterable }}],
+    searchable: [{{ searchable }}],
+    defaultSort: {{ defaultSort }},
+  },
+  piped: {
+    create: {
+      enabled: true,
+      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
+      validate: { enabled: true, errorStatus: 422 },
+    },
+    update: {
+      enabled: true,
+      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
+      validate: { enabled: true, errorStatus: 422 },
+    },
+    replace: {
+      enabled: true,
+      stages: ['deserialize', 'sanitize', 'mapFields', 'transform', 'validate'],
+      validate: { enabled: true, errorStatus: 422 },
+    },
+  },
+})
+export class {{ CtrlName }} {
+  @Inject()
+  crudService: {{ ServiceName }};
+}

package/templates/crud-page-vo.njk

@@ -0,0 +1,59 @@
+import { ApiProperty } from '@midwayjs/swagger';
+import { Exclude, Expose, Type } from 'class-transformer';
+
+@Exclude()
+export class CrudPageMetaVO {
+  @ApiProperty({ type: 'integer', description: '当前页码，从 1 开始', example: 1 })
+  @Expose()
+  page: number;
+
+  @ApiProperty({ type: 'integer', description: '每页条数', example: 10 })
+  @Expose()
+  limit: number;
+
+  @ApiProperty({ type: 'integer', description: '总记录数', example: 1024 })
+  @Expose()
+  total: number;
+
+  @ApiProperty({ type: 'integer', description: '总页数', example: 103 })
+  @Expose()
+  pageCount: number;
+
+  @ApiProperty({ type: 'boolean', description: '是否存在下一页', example: true })
+  @Expose()
+  hasNext: boolean;
+
+  @ApiProperty({ type: 'boolean', description: '是否存在上一页', example: false })
+  @Expose()
+  hasPrev: boolean;
+}
+
+export interface CrudPageResult<T> {
+  data: T[];
+  meta: CrudPageMetaVO;
+}
+
+type ClassLike<T = any> = new (...args: any[]) => T;
+
+export function createCrudPageListVO<T extends ClassLike>(
+  ItemVOClass: T,
+  options?: { className?: string }
+): ClassLike<CrudPageResult<InstanceType<T>>> {
+  const baseName = options?.className || \`\${ItemVOClass.name}ListVO\`;
+
+  @Exclude()
+  class ListVO implements CrudPageResult<InstanceType<T>> {
+    @ApiProperty({ type: () => [ItemVOClass], description: '当前页数据列表' })
+    @Expose()
+    @Type(() => ItemVOClass)
+    data: InstanceType<T>[];
+
+    @ApiProperty({ type: () => CrudPageMetaVO, description: '分页元信息' })
+    @Expose()
+    @Type(() => CrudPageMetaVO)
+    meta: CrudPageMetaVO;
+  }
+
+  Object.defineProperty(ListVO, 'name', { value: baseName, writable: false });
+  return ListVO as ClassLike<CrudPageResult<InstanceType<T>>>;
+}

package/templates/dto-create.njk

@@ -0,0 +1,18 @@
+import { Rule } from '@midwayjs/validation';
+import { ApiPropertyOptional } from '@midwayjs/swagger';
+import * as Joi from 'joi';
+
+export class {{ CreateName }} {
+{% for f in createFields -%}
+  @ApiPropertyOptional({
+    type: {{ f.swagType | json }},
+{% if f.len %}    maxLength: {{ f.len }},
+{% endif %}{% if f.nullable %}    nullable: true,
+{% endif %}    description: {{ (f.comment or f.camel) | json }},
+{% if f.defaultVal != null %}    example: {{ f.defaultVal | json }},
+{% endif %}  })
+  @Rule({{ f.joiRule }}.description({{ (f.comment or f.camel) | json }}))
+  {{ f.camel }}?: {{ f.createDtoType }};
+
+{% endfor -%}
+}

package/templates/dto-index.njk

@@ -0,0 +1,4 @@
+export * from './create.dto';
+export * from './update.dto';
+export * from './replace.dto';
+export * from './query.dto';

package/templates/dto-query.njk

@@ -0,0 +1,71 @@
+import { Rule, PickDto } from '@midwayjs/validation';
+import { ApiPropertyOptional } from '@midwayjs/swagger';
+import * as Joi from 'joi';
+import { {{ CreateName }} } from './create.dto';
+
+type _QueryFilterFields = Pick<{{ CreateName }}, {{ typeArgs }}>;
+
+const _QueryFilterPicked = PickDto({{ CreateName }}, [
+  {{ picks }}
+]) as unknown as new () => Partial<_QueryFilterFields>;
+
+export class {{ QueryName }} extends _QueryFilterPicked {
+{% for f in filterable -%}
+  @ApiPropertyOptional({
+    type: {{ f.swagType | json }},
+{% if f.len %}    maxLength: {{ f.len }},
+{% endif %}    description: {{ ((f.comment or f.camel) + '（列表筛选条件，可选）') | json }},
+  })
+  override {{ f.camel }}?: {{ f.jsType }};
+
+{% endfor -%}
+{% if filterable.length %}
+
+{% endif %}  @ApiPropertyOptional({
+    type: 'integer',
+    minimum: 1,
+    default: 1,
+    description: '当前页码，从1开始',
+    example: 1,
+  })
+  @Rule(Joi.number().integer().min(1).default(1).description('当前页码，从1开始，默认1'))
+  page?: number;
+
+  @ApiPropertyOptional({
+    type: 'integer',
+    minimum: 1,
+    maximum: 100,
+    default: 10,
+    description: '每页条数，范围 1-100',
+    example: 10,
+  })
+  @Rule(Joi.number().integer().min(1).max(100).default(10).description('每页条数，1-100，默认10'))
+  limit?: number;
+
+  @ApiPropertyOptional({
+    type: 'string',
+    description: {{ sortDescription | json }},
+    example: 'id:DESC',
+  })
+  @Rule(Joi.string().description('排序字段，例如 id:ASC 或 name:DESC,id:DESC'))
+  sort?: string;
+
+  @ApiPropertyOptional({
+    type: 'string',
+    description:
+      '过滤条件（兼容两种写法）。官方标准：field||op||value，多条件多次传或逗号分隔。简写：field:op:value 逗号分隔。' +
+      '操作符 eq/ne/gt/gte/lt/lte/in/like，别名 ==/!=/>/>=/</<=/contains。' +
+      '示例：age||gte||18,name||like||张 或 age:gte:18,name:like:张',
+    example: {{ filterExample | json }},
+  })
+  @Rule(Joi.string().description('过滤条件，支持 field||op||value 或 field:op:value，逗号分隔多条件'))
+  filter?: string;
+
+  @ApiPropertyOptional({
+    type: 'string',
+    description: {{ searchDescription | json }},
+    example: 'zhang',
+  })
+  @Rule(Joi.string().description('搜索关键字，用于模糊搜索可搜索字段'))
+  search?: string;
+}

package/templates/dto-replace.njk

@@ -0,0 +1,21 @@
+import { Rule, PickDto } from '@midwayjs/validation';
+import { ApiProperty } from '@midwayjs/swagger';
+import * as Joi from 'joi';
+import { {{ CreateName }} } from './create.dto';
+
+export class {{ ReplaceName }} extends PickDto({{ CreateName }}, [
+  {{ picks }}
+]) {
+{% for f in writable -%}
+  @ApiProperty({
+    type: {{ f.swagType | json }},
+{% if f.len %}    maxLength: {{ f.len }},
+{% endif %}{% if f.nullable %}    nullable: true,
+{% endif %}    required: true,
+    description: {{ ((f.comment or f.camel) + '（PUT：必须完整传入）') | json }},
+  })
+  @Rule({{ f.joiRuleRequired }}.description({{ (f.comment or f.camel) | json }}))
+  override {{ f.camel }}: {{ f.createDtoType }};
+
+{% endfor -%}
+}

package/templates/dto-update.njk

@@ -0,0 +1,22 @@
+import { ApiPropertyOptional } from '@midwayjs/swagger';
+import { PickDto } from '@midwayjs/validation';
+import { {{ CreateName }} } from './create.dto';
+
+type _UpdateFields = Pick<{{ CreateName }}, {{ typeArgs }}>;
+
+const _UpdatePicked = PickDto({{ CreateName }}, [
+  {{ picks }}
+]) as unknown as new () => Partial<_UpdateFields>;
+
+export class {{ UpdateName }} extends _UpdatePicked {
+{% for f in writable -%}
+  @ApiPropertyOptional({
+    type: {{ f.swagType | json }},
+{% if f.len %}    maxLength: {{ f.len }},
+{% endif %}{% if f.nullable %}    nullable: true,
+{% endif %}    description: {{ ((f.comment or f.camel) + '（PATCH：不传则不修改）') | json }},
+  })
+  override {{ f.camel }}?: {{ f.createDtoType }};
+
+{% endfor -%}
+}

package/templates/entity.njk

@@ -0,0 +1,60 @@
+{% if orm !== 'typeorm' -%}
+// {{ orm }} Entity 模板占位（TypeORM 是当前唯一完整生成的 ORM）
+export class {{ Pascal }} {}
+{%- else -%}
+import { Entity, Column{% if hasPk %}, PrimaryGeneratedColumn{% endif %}{% if idxCount %}, Index{% endif %} } from 'typeorm';
+import { Expose{% if hasDateField %}, Transform{% endif %} } from 'class-transformer';
+import { ApiProperty, ApiPropertyOptional } from '@midwayjs/swagger';
+import { Rule } from '@midwayjs/validation';
+import { z } from 'zod';
+import { BaseEntity } from '../../../framework/entity/base.entity';
+
+@Entity({{ tableName | json }}, {
+  comment: {{ (tableName + ' 表') | json }},
+})
+export class {{ Pascal }} extends BaseEntity {
+{% if hasPk and pkInfo -%}
+  @PrimaryGeneratedColumn({
+    type: {{ pkInfo.type | json }},
+    name: {{ pkInfo.name | json }},
+    comment: {{ (pkInfo.comment or '主键') | json }},
+  })
+  @ApiProperty({
+    type: 'integer',
+    description: {{ (pkInfo.comment or '主键ID') | json }},
+  })
+  @Expose()
+  @Rule(z.number().int().describe({{ (pkInfo.comment or '主键ID') | json }}))
+  {{ pkInfo.camel }}: number;
+
+{% endif -%}
+{% for f in fields -%}
+{% if f.idx -%}  @Index()
+{% endif -%}  @Column({
+    type: {{ f.ormType | json }},
+{% if f.supportsLength and f.len %}    length: {{ f.len }},
+{% endif %}    name: {{ f.name | json }},
+    nullable: {% if f.nullable %}true{% else %}false{% endif %},
+{% if f.defaultVal != null %}    default: {{ f.defaultVal | json }},
+{% endif %}{% if f.comment %}    comment: {{ f.comment | json }},
+{% endif %}  })
+  @ApiPropertyOptional({
+    type: {{ f.swagType | json }},
+{% if f.supportsLength and f.len %}    maxLength: {{ f.len }},
+{% endif %}{% if f.nullable %}    nullable: true,
+{% endif %}    description: {{ (f.comment or f.camel) | json }},
+{% if f.defaultVal != null %}    example: {{ f.defaultVal | json }},
+{% endif %}  })
+  @Expose()
+  @Rule({{ f.zodRule }}.nullable().optional())
+{% if f.isDate %}  @Transform(({ value }) => {
+    if (value == null) return null;
+    const d = value instanceof Date ? value : new Date(value);
+    if (isNaN(d.getTime())) return value == null ? null : String(value);
+    return d.toISOString();
+  })
+{% endif %}  {{ f.camel }}?: {{ f.jsType }};
+
+{% endfor -%}
+}
+{%- endif %}

package/templates/service.njk

@@ -0,0 +1,20 @@
+{% if ormInfo.orm === 'typeorm' -%}
+import { Provide, Scope, ScopeEnum } from '@midwayjs/core';
+import { InjectEntityModel } from '@midwayjs/typeorm';
+import { Repository } from 'typeorm';
+import { {{ ormInfo.serviceParent }} } from '@midwayjs/crud/typeorm';
+import { {{ Pascal }} } from '../entity/{{ Camel }}.entity';
+
+@Provide()
+@Scope(ScopeEnum.Request, { allowDowngrade: true })
+export class {{ ServiceName }} extends {{ ormInfo.serviceParent }}<{{ Pascal }}> {
+  @InjectEntityModel({{ Pascal }})
+  repo: Repository<{{ Pascal }}>;
+}
+{%- else -%}
+// {{ ormInfo.orm }} Service 模板（请按项目注入方式调整）
+import { Provide } from '@midwayjs/core';
+
+@Provide()
+export class {{ ServiceName }} {}
+{%- endif %}

package/templates/vo-index.njk

@@ -0,0 +1,2 @@
+export * from './{{ Camel }}.vo';
+export * from './{{ Camel }}List.vo';

package/templates/vo-list.njk

@@ -0,0 +1,15 @@
+import {
+  CrudPageMetaVO,
+  createCrudPageListVO,
+  type CrudPageResult,
+} from '../../../../framework/vo/crudPage.vo';
+import { {{ VOName }} } from './{{ Camel }}.vo';
+
+export { CrudPageMetaVO };
+export type { CrudPageResult };
+
+export const {{ ListVOName }} = createCrudPageListVO({{ VOName }}, {
+  className: {{ ListVOName | json }},
+});
+
+export type {{ ListVOName }}Type = CrudPageResult<{{ VOName }}>;

package/templates/vo-single.njk

@@ -0,0 +1,24 @@
+import { Exclude, Expose{% if hasTransform %}, Transform{% endif %} } from 'class-transformer';
+import { ApiProperty } from '@midwayjs/swagger';
+
+@Exclude()
+export class {{ VOName }} {
+{% for f in fields -%}
+  @ApiProperty({
+    type: {{ f.swagType | json }},
+{% if f.len %}    maxLength: {{ f.len }},
+{% endif %}{% if f.nullable %}    nullable: true,
+{% endif %}    description: {{ (f.comment or f.camel) | json }},
+  })
+  @Expose()
+{% if f.isDate %}  @Transform(({ value }) => {
+    if (value == null) return null;
+    const d = value instanceof Date ? value : new Date(value);
+    if (isNaN(d.getTime())) return value == null ? null : String(value);
+    return d.toISOString();
+  })
+{% endif %}{% if f.isSensitive %}  @Transform(() => undefined, { toPlainOnly: true })
+{% endif %}  {{ f.camel }}: {{ f.voType }}{% if f.nullable %} | null{% endif %};
+
+{% endfor -%}
+}