cabloy 5.1.61 → 5.1.62

package/vona/src/suite/a-training/modules/training-student/src/dto/studentSelectRes.tsx

@@ -0,0 +1,11 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { $Dto } from 'vona-module-a-orm';
+import { Dto } from 'vona-module-a-web';
+
+import { DtoStudentSelectResItem } from './studentSelectResItem.tsx';
+
+export interface IDtoOptionsStudentSelectRes extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsStudentSelectRes>()
+export class DtoStudentSelectRes extends $Dto.listAndCount(DtoStudentSelectResItem) {}

package/vona/src/suite/a-training/modules/training-student/src/dto/studentSelectResItem.tsx

@@ -0,0 +1,45 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { $Dto } from 'vona-module-a-orm';
+import { Dto } from 'vona-module-a-web';
+import { ZovaRender } from 'zova-rest-cabloy-basic-admin';
+
+import { $locale } from '../.metadata/locales.ts';
+import { ModelStudent } from '../model/student.ts';
+
+export interface IDtoOptionsStudentSelectResItem extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsStudentSelectResItem>({
+  blocks: [
+    ZovaRender.block('basic-page:blockPage', {
+      blocks: [
+        ZovaRender.block('basic-page:blockFilter'),
+        ZovaRender.block('basic-page:blockToolbarBulk', {
+          actions: [ZovaRender.tableActionBulk('basic-table:actionCreate')],
+        }),
+        ZovaRender.block('basic-page:blockTable'),
+        ZovaRender.block('basic-page:blockPager'),
+      ],
+    }),
+  ],
+})
+export class DtoStudentSelectResItem extends $Dto.get(() => ModelStudent) {
+  @Api.field(
+    v.title($locale('Operations')),
+    ZovaRender.order(1, 'max'),
+    ZovaRender.cell('basic-table:actionOperationsRow', {
+      actions: [
+        ZovaRender.tableActionRow('training-student:actionSummary', {
+          permission: { actionInherit: 'view' },
+        }),
+        ZovaRender.tableActionRow('basic-table:actionUpdate'),
+        ZovaRender.tableActionRow('basic-table:actionDelete'),
+        ZovaRender.tableActionRow('training-student:actionDeleteForce', {
+          permission: { actionInherit: 'delete' },
+        }),
+      ],
+    }),
+  )
+  _operationsRow?: unknown;
+}

package/vona/src/suite/a-training/modules/training-student/src/dto/studentSummary.tsx

@@ -0,0 +1,42 @@
+import type { TableIdentity } from 'table-identity';
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+
+import { $locale } from '../.metadata/locales.ts';
+
+export interface IDtoOptionsStudentSummary extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsStudentSummary>()
+export class DtoStudentSummary {
+  @Api.field(v.tableIdentity())
+  id: TableIdentity;
+
+  @Api.field(v.title($locale('Name')))
+  name: string;
+
+  @Api.field(
+    v.title($locale('Mobile')),
+    v.serializerReplace({
+      patternFrom: /^(\d{3})\d{4}(\d+)$/,
+      patternTo: '$1****$2',
+    }),
+  )
+  mobile: string;
+
+  @Api.field(v.title($locale('Level')))
+  level: 1 | 2 | 3;
+
+  @Api.field(v.title($locale('LevelTitle')))
+  levelTitle: string;
+
+  @Api.field(v.title($locale('Description')), v.optional())
+  description?: string;
+
+  @Api.field(v.title($locale('DescriptionLength')))
+  descriptionLength: number;
+
+  @Api.field(v.title($locale('Summary')))
+  summaryText: string;
+}

package/vona/src/suite/a-training/modules/training-student/src/dto/studentUpdate.tsx

@@ -0,0 +1,28 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { $Dto } from 'vona-module-a-orm';
+import { Dto } from 'vona-module-a-web';
+import { ZovaRender } from 'zova-rest-cabloy-basic-admin';
+
+import { ModelStudent } from '../model/student.ts';
+
+export interface IDtoOptionsStudentUpdate extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsStudentUpdate>({
+  blocks: [
+    ZovaRender.block('basic-pageentry:blockPageEntry', {
+      blocks: [
+        ZovaRender.block('basic-pageentry:blockForm'),
+        ZovaRender.block('basic-pageentry:blockToolbarRow', {
+          actions: [
+            ZovaRender.formActionRow('basic-form:actionSubmit', {
+              permission: { actionInherit: 'update', formScene: ['create', 'edit'] },
+            }),
+            ZovaRender.formActionRow('basic-form:actionBack', { permission: { public: true } }),
+          ],
+        }),
+      ],
+    }),
+  ],
+})
+export class DtoStudentUpdate extends $Dto.update(() => ModelStudent) {}

package/vona/src/suite/a-training/modules/training-student/src/dto/studentView.tsx

@@ -0,0 +1,25 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { $Dto } from 'vona-module-a-orm';
+import { Dto } from 'vona-module-a-web';
+import { ZovaRender } from 'zova-rest-cabloy-basic-admin';
+
+import { ModelStudent } from '../model/student.ts';
+
+export interface IDtoOptionsStudentView extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsStudentView>({
+  blocks: [
+    ZovaRender.block('basic-pageentry:blockPageEntry', {
+      blocks: [
+        ZovaRender.block('basic-pageentry:blockForm'),
+        ZovaRender.block('basic-pageentry:blockToolbarRow', {
+          actions: [
+            ZovaRender.formActionRow('basic-form:actionBack', { permission: { public: true } }),
+          ],
+        }),
+      ],
+    }),
+  ],
+})
+export class DtoStudentView extends $Dto.get(() => ModelStudent) {}

package/vona/src/suite/a-training/modules/training-student/src/entity/student.tsx

@@ -0,0 +1,84 @@
+import type { IDecoratorEntityOptions } from 'vona-module-a-orm';
+
+import { $makeMetadata, Api, v } from 'vona-module-a-openapiutils';
+import { Entity, EntityBase } from 'vona-module-a-orm';
+import z from 'zod';
+import { ZovaRender } from 'zova-rest-cabloy-basic-admin';
+
+import { $locale } from '../.metadata/locales.ts';
+
+export const studentLevelSchema = z.union([z.literal(1), z.literal(2), z.literal(3)]);
+
+export const studentLevelItems = [
+  { value: 1, title: $locale('LevelBeginner') },
+  { value: 2, title: $locale('LevelIntermediate') },
+  { value: 3, title: $locale('LevelAdvanced') },
+];
+
+export interface IEntityOptionsStudent extends IDecoratorEntityOptions {}
+
+@Entity<IEntityOptionsStudent>('trainingStudent', {
+  openapi: { title: $locale('Student') },
+  fields: {
+    id: $makeMetadata(ZovaRender.order(1, 'core')),
+    iid: $makeMetadata(ZovaRender.visible(false)),
+    deleted: $makeMetadata(ZovaRender.visible(false)),
+    createdAt: $makeMetadata(
+      ZovaRender.order(-2, 'max'),
+      ZovaRender.field('basic-date:formFieldDate'),
+      ZovaRender.cell('basic-date:date'),
+    ),
+    updatedAt: $makeMetadata(
+      ZovaRender.order(-1, 'max'),
+      ZovaRender.field('basic-date:formFieldDate'),
+      ZovaRender.cell('basic-date:date'),
+    ),
+  },
+})
+export class EntityStudent extends EntityBase {
+  @Api.field(
+    v.title($locale('Name')),
+    v.required(),
+    v.min(2),
+    ZovaRender.order(1),
+    ZovaRender.cell('basic-table:actionView'),
+  )
+  name: string;
+
+  @Api.field(v.title($locale('Description')), v.optional(), ZovaRender.order(2))
+  description?: string;
+
+  @Api.field(
+    v.title($locale('Mobile')),
+    v.required(),
+    v.min(11),
+    v.serializerReplace({
+      patternFrom: /^(\d{3})\d{4}(\d+)$/,
+      patternTo: '$1****$2',
+    }),
+    ZovaRender.order(3),
+  )
+  mobile: string;
+
+  @Api.field(
+    v.title($locale('Level')),
+    v.required(),
+    ZovaRender.order(4),
+    // Tutorial 3 built-in form renderer example. Keep it commented here for side-by-side comparison.
+    // ZovaRender.field('basic-select:formFieldSelect', {
+    //   items: studentLevelItems,
+    //   placeholder: $locale('Level'),
+    // }),
+    // Tutorial 3 built-in table cell renderer example.
+    // ZovaRender.cell('basic-select:select', { items: studentLevelItems }),
+    // Tutorial 4 custom form renderer example used by the current implementation.
+    ZovaRender.field('training-student:formFieldLevel', {
+      items: studentLevelItems,
+      placeholder: $locale('Level'),
+    }),
+    // Tutorial 4 custom table cell renderer example used by the current implementation.
+    ZovaRender.cell('training-student:level', { items: studentLevelItems }),
+    studentLevelSchema,
+  )
+  level: 1 | 2 | 3;
+}

package/vona/src/suite/a-training/modules/training-student/src/index.ts

@@ -0,0 +1,2 @@
+export * from './.metadata/locales.ts';
+export * from './.metadata/index.ts';

package/vona/src/suite/a-training/modules/training-student/src/model/student.ts

@@ -0,0 +1,10 @@
+import type { IDecoratorModelOptions } from 'vona-module-a-orm';
+
+import { BeanModelBase, Model } from 'vona-module-a-orm';
+
+import { EntityStudent } from '../entity/student.tsx';
+
+export interface IModelOptionsStudent extends IDecoratorModelOptions<EntityStudent> {}
+
+@Model<IModelOptionsStudent>({ entity: EntityStudent })
+export class ModelStudent extends BeanModelBase<EntityStudent> {}

package/vona/src/suite/a-training/modules/training-student/src/service/student.ts

@@ -0,0 +1,57 @@
+import type { TableIdentity } from 'table-identity';
+import type { IQueryParams } from 'vona-module-a-orm';
+
+import { BeanBase } from 'vona';
+import { Service } from 'vona-module-a-bean';
+
+import type { DtoStudentCreate } from '../dto/studentCreate.tsx';
+import type { DtoStudentSelectRes } from '../dto/studentSelectRes.tsx';
+import type { DtoStudentSummary } from '../dto/studentSummary.tsx';
+import type { DtoStudentUpdate } from '../dto/studentUpdate.tsx';
+import type { DtoStudentView } from '../dto/studentView.tsx';
+import type { EntityStudent } from '../entity/student.tsx';
+import type { ModelStudent } from '../model/student.ts';
+
+@Service()
+export class ServiceStudent extends BeanBase {
+  async create(student: DtoStudentCreate): Promise<EntityStudent> {
+    return await this.scope.model.student.insert(student);
+  }
+
+  async select(params?: IQueryParams<ModelStudent>): Promise<DtoStudentSelectRes> {
+    return await this.scope.model.student.selectAndCount(params);
+  }
+
+  async view(id: TableIdentity): Promise<DtoStudentView | undefined> {
+    return await this.scope.model.student.getById(id);
+  }
+
+  async update(id: TableIdentity, student: DtoStudentUpdate) {
+    return await this.scope.model.student.updateById(id, student);
+  }
+
+  async summary(id: TableIdentity): Promise<DtoStudentSummary | undefined> {
+    const student = await this.scope.model.student.getById(id);
+    if (!student) return undefined;
+    const descriptionLength = student.description?.length ?? 0;
+    const levelTitle = String(student.level);
+    return {
+      id: student.id,
+      name: student.name,
+      mobile: student.mobile,
+      level: student.level,
+      levelTitle,
+      description: student.description,
+      descriptionLength,
+      summaryText: `${student.name} is in level ${student.level}. Description length: ${descriptionLength}.`,
+    };
+  }
+
+  async delete(id: TableIdentity) {
+    return await this.scope.model.student.deleteById(id);
+  }
+
+  async deleteForce(id: TableIdentity) {
+    return await this.scope.model.student.deleteById(id, { disableDeleted: true });
+  }
+}

package/vona/src/suite/a-training/modules/training-student/test/student.test.ts

@@ -0,0 +1,173 @@
+import type {
+  DtoStudentCreate,
+  DtoStudentSelectRes,
+  DtoStudentSummary,
+  DtoStudentUpdate,
+  EntityStudent,
+} from 'vona-module-training-student';
+
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
+import { app } from 'vona-mock';
+
+describe('student.test.ts', () => {
+  it('action:student', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      // data
+      const mobile = '13812345678';
+      const maskedMobile = '138****5678';
+      const mobileUpdate = '13987654321';
+      const maskedMobileUpdate = '139****4321';
+      const data: DtoStudentCreate = {
+        name: '__Tom__',
+        description: 'This is a test',
+        mobile,
+        level: 1,
+      };
+      const dataUpdate: DtoStudentUpdate = {
+        name: '__TomNew__',
+        description: 'This is a test',
+        mobile: mobileUpdate,
+        level: 2,
+      };
+      // login
+      await app.bean.passport.signinMock();
+      // create
+      const studentId = await app.bean.executor.performAction('post', '/training/student', {
+        body: data,
+      });
+      assert.equal(!!studentId, true);
+      // findMany
+      const selectRes: DtoStudentSelectRes = await app.bean.executor.performAction(
+        'get',
+        '/training/student',
+      );
+      const studentItem = selectRes.list.find(item => item.name === data.name);
+      assert.equal(!!studentItem, true);
+      assert.equal(studentItem!.level, data.level);
+      assert.equal(studentItem!.mobile, maskedMobile);
+      // findMany: level filter
+      const selectResByLevel: DtoStudentSelectRes = await app.bean.executor.performAction(
+        'get',
+        '/training/student',
+        {
+          query: {
+            level: data.level,
+          },
+        },
+      );
+      assert.equal(
+        selectResByLevel.list.some(item => item.name === data.name),
+        true,
+      );
+      assert.equal(
+        selectResByLevel.list.every(item => item.level === data.level),
+        true,
+      );
+      // update
+      await app.bean.executor.performAction('patch', '/training/student/:id', {
+        params: { id: studentId },
+        body: dataUpdate,
+      });
+      // findOne
+      let student: EntityStudent = await app.bean.executor.performAction(
+        'get',
+        '/training/student/:id',
+        { params: { id: studentId } },
+      );
+      assert.equal(student.name, dataUpdate.name);
+      assert.equal(student.level, dataUpdate.level);
+      assert.equal(student.mobile, maskedMobileUpdate);
+      const studentRaw = await app.bean.scope('training-student').model.student.getById(studentId, {
+        disableDeleted: true,
+      });
+      assert.equal(studentRaw!.mobile, mobileUpdate);
+      // summary
+      const summary: DtoStudentSummary = await app.bean.executor.performAction(
+        'get',
+        '/training/student/summary/:id',
+        { params: { id: studentId } },
+      );
+      assert.equal(summary.name, dataUpdate.name);
+      assert.equal(summary.mobile, maskedMobileUpdate);
+      assert.equal(summary.level, dataUpdate.level);
+      assert.equal(summary.descriptionLength, dataUpdate.description?.length);
+      assert.equal(typeof summary.levelTitle, 'string');
+      assert.equal(typeof summary.summaryText, 'string');
+      // delete
+      await app.bean.executor.performAction('delete', '/training/student/:id', {
+        params: { id: student.id },
+      });
+      // findOne
+      student = await app.bean.executor.performAction('get', '/training/student/:id', {
+        params: { id: student.id },
+      });
+      assert.equal(student, undefined);
+      // create again for force delete
+      const studentIdForce = await app.bean.executor.performAction('post', '/training/student', {
+        body: data,
+      });
+      await app.bean.executor.performAction('delete', '/training/student/deleteForce/:id', {
+        params: { id: studentIdForce },
+      });
+      const studentForce = await app.bean
+        .scope('training-student')
+        .model.student.getById(studentIdForce, {
+          disableDeleted: true,
+        });
+      assert.equal(studentForce, undefined);
+      // logout
+      await app.bean.passport.signout();
+    });
+  });
+
+  it('action:student:level invalid', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      await app.bean.passport.signinMock();
+      await assert.rejects(async () => {
+        await app.bean.executor.performAction('post', '/training/student', {
+          body: {
+            name: '__Tom__',
+            description: 'This is a test',
+            mobile: '13812345678',
+            level: 4,
+          },
+        });
+      });
+      await app.bean.passport.signout();
+    });
+  });
+
+  it('action:student:mobile required', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      await app.bean.passport.signinMock();
+      await assert.rejects(async () => {
+        await app.bean.executor.performAction('post', '/training/student', {
+          body: {
+            name: '__Tom__',
+            description: 'This is a test',
+            level: 1,
+          },
+        });
+      });
+      await app.bean.passport.signout();
+    });
+  });
+
+  it('action:student:mobile too short', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      await app.bean.passport.signinMock();
+      await assert.rejects(async () => {
+        await app.bean.executor.performAction('post', '/training/student', {
+          body: {
+            name: '__Tom__',
+            description: 'This is a test',
+            mobile: '1381234567',
+            level: 1,
+          },
+        });
+      });
+      await app.bean.passport.signout();
+    });
+  });
+});

package/vona/src/suite/a-training/modules/training-student/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.base",
+  "compilerOptions": {
+    "rootDir": "src",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist"
+  },
+  "include": ["src", "src/.metadata/*.ts", "src/**/*.json"]
+}

package/vona/src/suite/a-training/modules/training-student/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "include": ["src", "src/.metadata/*.ts", "src/**/*.json", "test"]
+}

package/vona/src/suite/a-training/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "vona-suite-a-training",
+  "version": "5.0.0",
+  "description": "",
+  "author": "",
+  "files": [],
+  "type": "module",
+  "dependencies": {
+    "vona-module-training-student": "^5.0.0"
+  },
+  "title": "a-training"
+}

package/vona/src/suite/a-training/tsconfig.base.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../tsconfig.base",
+  "compilerOptions": {}
+}

package/vona/src/suite/a-training/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.base",
+  "compilerOptions": {},
+  "references": [
+    {
+      "path": "modules/training-student/tsconfig.build.json"
+    }
+  ],
+  "exclude": ["modules"]
+}

package/zova/packages-zova/zova/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zova",
-  "version": "5.1.103",
+  "version": "5.1.104",
   "gitHead": "2c5c19284bab738e492856189acb6fad74b8a7b7",
   "description": "A vue3 framework with ioc",
   "keywords": [
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "zova-core": "^5.1.57",
-    "zova-suite-a-zova": "^5.1.102"
+    "zova-suite-a-zova": "^5.1.103"
   },
   "devDependencies": {
     "clean-package": "^2.2.0",