vona-cli-set-api 1.1.149 → 1.1.150

package/cli/templates/tools/crudBasic/boilerplate/src/controller/{{resourceName}}.ts_

@@ -27,42 +27,42 @@ export interface IControllerOptions<%=argv.resourceNameCapitalize%> extends IDec
 export class Controller<%=argv.resourceNameCapitalize%> extends BeanBase {
   @Web.post('', { summary: $locale('<%=argv.resourceNameCapitalize%>Create') })
   @Api.body(v.tableIdentity())
-  @Passport.systemAdmin()
+  @Passport.rbac()
   async create(@Arg.body() <%=argv.resourceName%>: Dto<%=argv.resourceNameCapitalize%>Create): Promise<TableIdentity> {
     return (await this.scope.service.<%=argv.resourceName%>.create(<%=argv.resourceName%>)).id;
   }
 
   @Web.get('', { summary: $locale('<%=argv.resourceNameCapitalize%>Select') })
   @Api.body(Dto<%=argv.resourceNameCapitalize%>SelectRes)
-  @Passport.systemAdmin()
+  @Passport.rbac()
   async select(@Arg.filter(Dto<%=argv.resourceNameCapitalize%>SelectReq) params: IQueryParams<Model<%=argv.resourceNameCapitalize%>>): Promise<Dto<%=argv.resourceNameCapitalize%>SelectRes> {
     return await this.scope.service.<%=argv.resourceName%>.select(params);
   }
 
   @Web.get(':id', { summary: $locale('<%=argv.resourceNameCapitalize%>View') })
   @Api.body(v.optional(), v.object(Dto<%=argv.resourceNameCapitalize%>View))
-  @Passport.systemAdmin()
+  @Passport.rbac()
   async view(@Arg.param('id', v.tableIdentity()) id: TableIdentity): Promise<Dto<%=argv.resourceNameCapitalize%>View | undefined> {
     return await this.scope.service.<%=argv.resourceName%>.view(id);
   }
 
   @Web.patch(':id', { summary: $locale('<%=argv.resourceNameCapitalize%>Update') })
   @Api.body(z.null())
-  @Passport.systemAdmin()
+  @Passport.rbac()
   async update(@Arg.param('id', v.tableIdentity()) id: TableIdentity, @Arg.body() <%=argv.resourceName%>: Dto<%=argv.resourceNameCapitalize%>Update): Promise<void> {
     await this.scope.service.<%=argv.resourceName%>.update(id, <%=argv.resourceName%>);
   }
 
   @Web.delete(':id', { summary: $locale('<%=argv.resourceNameCapitalize%>Delete') })
   @Api.body(z.null())
-  @Passport.systemAdmin()
+  @Passport.rbac()
   async delete(@Arg.param('id', v.tableIdentity()) id: TableIdentity): Promise<void> {
     await this.scope.service.<%=argv.resourceName%>.delete(id);
   }
 
-  @Web.post('bulk/delete', { summary: $locale('BulkDelete') })
+  @Web.post('bulk/delete', { summary: $locale('<%=argv.resourceNameCapitalize%>DeleteBulk') })
   @Api.body(z.null())
-  @Passport.systemAdmin()
+  @Passport.rbac({ actionInherit: 'delete' })
   async deleteBulk(@Arg.body() command: Dto<%=argv.resourceNameCapitalize%>DeleteBulk): Promise<void> {
     await this.scope.service.<%=argv.resourceName%>.deleteBulk(command.ids);
   }

package/cli/templates/tools/crudBasic/boilerplate/test/{{resourceName}}.test.ts_

@@ -1,12 +1,74 @@
 import type { Dto<%=argv.resourceNameCapitalize%>Create, Dto<%=argv.resourceNameCapitalize%>SelectRes, Dto<%=argv.resourceNameCapitalize%>Update, Entity<%=argv.resourceNameCapitalize%> } from 'vona-module-<%=argv.moduleInfo.relativeName%>';
+
 import assert from 'node:assert';
 import { describe, it } from 'node:test';
+import { appMetadata } from 'vona';
 import { app } from 'vona-mock';
+import { SymbolOpenApiOptions } from 'vona-module-a-openapiutils';
+
+describe('<%=argv.resourceName%>.test.ts', { concurrency: false }, () => {
+  it('action:<%=argv.resourceName%>:openapiMetadata', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      const controllerBeanFullName = '<%=argv.moduleInfo.relativeName%>.controller.<%=argv.resourceName%>';
+      const controller = app.bean.onion.controller
+        .getOnionsEnabledCached()
+        .find(item => item.beanOptions.beanFullName === controllerBeanFullName)
+        ?.beanOptions.beanClass;
+      if (!controller) throw new Error(`${controllerBeanFullName} not found`);
+
+      const controllerMetadata = appMetadata.getMetadata<any>(
+        SymbolOpenApiOptions,
+        controller,
+      );
+      assert.equal(
+        controllerMetadata?.summary?.toString(),
+        '<%=argv.moduleInfo.relativeName%>::<%=argv.resourceNameCapitalize%>Controller',
+      );
+
+      const expectedSummaries = {
+        create: ['post', '<%=argv.moduleActionPathRaw%>', 'Create <%=argv.resourceNameCapitalize%>'],
+        select: ['get', '<%=argv.moduleActionPathRaw%>', 'Query <%=argv.resourceNameCapitalize%> List'],
+        view: ['get', '<%=argv.moduleActionPathRaw%>/{id}', 'View <%=argv.resourceNameCapitalize%>'],
+        update: ['patch', '<%=argv.moduleActionPathRaw%>/{id}', 'Update <%=argv.resourceNameCapitalize%>'],
+        delete: ['delete', '<%=argv.moduleActionPathRaw%>/{id}', 'Delete <%=argv.resourceNameCapitalize%>'],
+        deleteBulk: ['post', '<%=argv.moduleActionPathRaw%>/bulk/delete', 'Bulk Delete <%=argv.resourceNameCapitalize%>'],
+      } as const;
+      for (const [action, [method, path, summary]] of Object.entries(expectedSummaries)) {
+        const apiJson = await app.bean.openapi.generateJsonOfControllerAction(
+          controller,
+          action,
+          'V31',
+        );
+        const operation = (apiJson.paths as any)?.[path]?.[method];
+        assert.ok(operation, `${action} operation is missing`);
+        assert.equal(operation.summary?.toJSON(), summary);
+      }
+    });
+  });
+
+  it('action:<%=argv.resourceName%>:rbacCatalog', async () => {
+    await app.bean.executor.mockCtx(async () => {
+      const controllerBeanFullName = '<%=argv.moduleInfo.relativeName%>.controller.<%=argv.resourceName%>';
+      const catalog = app.bean.rbacCatalog.getCatalog();
+      const expectedInherits = {
+        create: undefined,
+        select: undefined,
+        view: undefined,
+        update: undefined,
+        delete: undefined,
+        deleteBulk: `${controllerBeanFullName}#delete`,
+      } as const;
+      for (const [action, actionInheritKey] of Object.entries(expectedInherits)) {
+        const descriptor = catalog.get(`${controllerBeanFullName}#${action}`);
+        assert.ok(descriptor, `${action} RBAC action is missing`);
+        assert.equal(descriptor.actionInheritKey, actionInheritKey);
+        assert.equal(descriptor.options.dataScope, undefined);
+      }
+    });
+  });
 
-describe('<%=argv.resourceName%>.test.ts', () => {
   it('action:<%=argv.resourceName%>', async () => {
     await app.bean.executor.mockCtx(async () => {
-      // data
       const data: Dto<%=argv.resourceNameCapitalize%>Create = {
         name: '__Tom__',
         description: 'This is a test',
@@ -15,48 +77,40 @@ describe('<%=argv.resourceName%>.test.ts', () => {
         name: '__TomNew__',
         description: 'This is a test',
       };
-      // role-less authenticated users cannot access generated admin actions
+      let <%=argv.resourceName%>Id: Entity<%=argv.resourceNameCapitalize%>['id'] | undefined;
+      // sign in as an unrestricted test identity
       await app.bean.passport.signinMock();
       try {
-        app.bean.passport.current!.roles = [];
-        const actions = ['create', 'select', 'view', 'update', 'delete'];
-        const permissions = await Promise.all(
-          actions.map(action =>
-            app.bean.permission.retrievePermissionAction(
-              '<%=argv.moduleInfo.relativeName%>:<%=argv.resourceName%>',
-              action,
-            ),
-          ),
-        );
-        assert.deepEqual(permissions, actions.map(() => false));
+        // create
+        <%=argv.resourceName%>Id = await app.bean.executor.performAction('post', '<%=argv.moduleActionPathRaw%>', { body: data });
+        assert.equal(!!<%=argv.resourceName%>Id, true);
+        // findMany
+        const selectRes: Dto<%=argv.resourceNameCapitalize%>SelectRes = await app.bean.executor.performAction('get', '<%=argv.moduleActionPathRaw%>');
+        assert.equal(selectRes.list.findIndex(item => item.name === data.name) > -1, true);
+        // update
+        const updateRes = await app.bean.executor.performAction('patch', '<%=argv.moduleActionPathRaw%>/:id', {
+          params: { id: <%=argv.resourceName%>Id },
+          body: dataUpdate,
+        });
+        assert.equal(updateRes, null);
+        // findOne
+        let <%=argv.resourceName%>: Entity<%=argv.resourceNameCapitalize%> = await app.bean.executor.performAction('get', '<%=argv.moduleActionPathRaw%>/:id', { params: { id: <%=argv.resourceName%>Id } });
+        assert.equal(<%=argv.resourceName%>.name, dataUpdate.name);
+        // delete
+        const deleteRes = await app.bean.executor.performAction('delete', '<%=argv.moduleActionPathRaw%>/:id', { params: { id: <%=argv.resourceName%>.id } });
+        assert.equal(deleteRes, null);
+        // findOne
+        <%=argv.resourceName%> = await app.bean.executor.performAction('get', '<%=argv.moduleActionPathRaw%>/:id', { params: { id: <%=argv.resourceName%>.id } });
+        assert.equal(<%=argv.resourceName%>, undefined);
       } finally {
+        if (<%=argv.resourceName%>Id) {
+          await app.scope('<%=argv.moduleInfo.relativeName%>').model.<%=argv.resourceName%>.deleteById(
+            <%=argv.resourceName%>Id,
+            { disableDeleted: true },
+          );
+        }
         await app.bean.passport.signout();
       }
-      // login as system admin
-      await app.bean.passport.signinMock();
-      // create
-      const <%=argv.resourceName%>Id = await app.bean.executor.performAction('post', '<%=argv.moduleActionPathRaw%>', { body: data });
-      assert.equal(!!<%=argv.resourceName%>Id, true);
-      // findMany
-      const selectRes: Dto<%=argv.resourceNameCapitalize%>SelectRes = await app.bean.executor.performAction('get', '<%=argv.moduleActionPathRaw%>');
-      assert.equal(selectRes.list.findIndex(item => item.name === data.name) > -1, true);
-      // update
-      const updateRes = await app.bean.executor.performAction('patch', '<%=argv.moduleActionPathRaw%>/:id', {
-        params: { id: <%=argv.resourceName%>Id },
-        body: dataUpdate,
-      });
-      assert.equal(updateRes, null);
-      // findOne
-      let <%=argv.resourceName%>: Entity<%=argv.resourceNameCapitalize%> = await app.bean.executor.performAction('get', '<%=argv.moduleActionPathRaw%>/:id', { params: { id: <%=argv.resourceName%>Id } });
-      assert.equal(<%=argv.resourceName%>.name, dataUpdate.name);
-      // delete
-      const deleteRes = await app.bean.executor.performAction('delete', '<%=argv.moduleActionPathRaw%>/:id', { params: { id: <%=argv.resourceName%>.id } });
-      assert.equal(deleteRes, null);
-      // findOne
-      <%=argv.resourceName%> = await app.bean.executor.performAction('get', '<%=argv.moduleActionPathRaw%>/:id', { params: { id: <%=argv.resourceName%>.id } });
-      assert.equal(<%=argv.resourceName%>, undefined);
-      // logout
-      await app.bean.passport.signout();
     });
   });
 });

package/cli/templates/tools/crudBasic/snippets/3-en-us.ts

@@ -9,7 +9,6 @@ const __resources = {
   Name: 'Name',
   Description: 'Description',
   Operations: 'Operations',
-  BulkDelete: 'Bulk Delete',
 };
 
 declare module '@cabloy/cli' {
@@ -40,6 +39,7 @@ export default metadataCustomSnippet({
       [`${resource}View`]: `View ${resource}`,
       [`${resource}Update`]: `Update ${resource}`,
       [`${resource}Delete`]: `Delete ${resource}`,
+      [`${resource}DeleteBulk`]: `Bulk Delete ${resource}`,
     };
     return locale_transform({ ast, argv, resources });
   },

package/cli/templates/tools/crudBasic/snippets/4-zh-cn.ts

@@ -7,7 +7,6 @@ const __resources = {
   Name: '名称',
   Description: '描述',
   Operations: '操作',
-  BulkDelete: '批量删除',
 };
 
 export default metadataCustomSnippet({
@@ -23,6 +22,7 @@ export default metadataCustomSnippet({
       [`${resource}View`]: `查看${resource}`,
       [`${resource}Update`]: `更新${resource}`,
       [`${resource}Delete`]: `删除${resource}`,
+      [`${resource}DeleteBulk`]: `批量删除${resource}`,
     };
     return locale_transform({ ast, argv, resources });
   },

package/dist-cli/templates/tools/crudBasic/snippets/3-en-us.js

@@ -7,7 +7,6 @@ const __resources = {
     Name: 'Name',
     Description: 'Description',
     Operations: 'Operations',
-    BulkDelete: 'Bulk Delete',
 };
 export default metadataCustomSnippet({
     file: 'src/config/locale/en-us.ts',
@@ -30,6 +29,7 @@ export default metadataCustomSnippet({
             [`${resource}View`]: `View ${resource}`,
             [`${resource}Update`]: `Update ${resource}`,
             [`${resource}Delete`]: `Delete ${resource}`,
+            [`${resource}DeleteBulk`]: `Bulk Delete ${resource}`,
         };
         return locale_transform({ ast, argv, resources });
     },

package/dist-cli/templates/tools/crudBasic/snippets/4-zh-cn.js

@@ -5,7 +5,6 @@ const __resources = {
     Name: '名称',
     Description: '描述',
     Operations: '操作',
-    BulkDelete: '批量删除',
 };
 export default metadataCustomSnippet({
     file: 'src/config/locale/zh-cn.ts',
@@ -20,6 +19,7 @@ export default metadataCustomSnippet({
             [`${resource}View`]: `查看${resource}`,
             [`${resource}Update`]: `更新${resource}`,
             [`${resource}Delete`]: `删除${resource}`,
+            [`${resource}DeleteBulk`]: `批量删除${resource}`,
         };
         return locale_transform({ ast, argv, resources });
     },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-cli-set-api",
-  "version": "1.1.149",
-  "gitHead": "fa2e21535d7220ab079e8ba9028266d9aa6f5a98",
+  "version": "1.1.150",
+  "gitHead": "e2843e4cab02a08051be465a8993919c9a37b5f5",
   "description": "vona cli-set-api",
   "keywords": [
     "framework",