cabloy 5.1.171 → 5.1.172

package/.cabloy-version

@@ -1 +1 @@
-5.1.171
+5.1.172

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 5.1.172
+
+### Features
+
+- Add action refresh capabilities.
+- Add update functionality.
+
+### Improvements
+
+- Update the table guide documentation.
+- Improve REST build handling in the CLI.
+
 ## 5.1.171
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cabloy",
-  "version": "5.1.171",
+  "version": "5.1.172",
   "gitHead": "2c5c19284bab738e492856189acb6fad74b8a7b7",
   "description": "A Node.js fullstack framework",
   "keywords": [

package/repo-docs/frontend/table-guide.md

@@ -245,6 +245,32 @@ In the shared table CEL scope, `getValue(name)` reads the current row value and
 
 For the schema side of that contract, also see [API Schema Guide](/frontend/api-schema-guide).
 
+## Persisted per-user column layouts
+
+`ZovaRender.column(...)` defines the schema defaults for column visibility, order, width, and fixed regions. On a standard resource list page, an authenticated user can personalize those defaults through the **Column Configuration** toolbar action. The saved layout is scoped to that user and the current page route path, then restored on later visits.
+
+| Edition      | Toolbar block                 | Column-configuration action      |
+| ------------ | ----------------------------- | -------------------------------- |
+| Cabloy Basic | `basic-page:blockToolbarBulk` | `basic-table:actionColumnConfig` |
+| Cabloy Start | `start-page:blockToolbarBulk` | `start-table:actionColumnConfig` |
+
+For example, in Cabloy Basic:
+
+```ts
+ZovaRender.tableActionBulk('basic-table:actionColumnConfig', {
+  permission: { public: true },
+  placement: 'end',
+});
+```
+
+In Cabloy Start, use `start-table:actionColumnConfig` in the corresponding `start-page:blockToolbarBulk`. `permission: { public: true }` controls action discoverability in the toolbar; loading and saving a personal layout still require an authenticated user.
+
+The dialog lets the user show or hide eligible columns, choose a numeric or automatic width, and reorder columns within their schema-defined left, center, or right fixed region. **Save** persists the layout. **Reset** removes the saved profile and restores the current schema defaults.
+
+Schema metadata remains authoritative. When the schema changes, stale or malformed saved entries are discarded, newly eligible schema columns are appended with their defaults, fixed regions are preserved, and the synthetic row-selection column is never persisted.
+
+Automatic loading, saving, and resetting belong to the standard resource-page `blockPage` flow. A direct `ZTable` consumer can pass a `layout`, but it owns any persistence workflow itself. Current CRUD generators add the edition-appropriate column-configuration action.
+
 ## Step 5: Use built-in or custom `tableCell` render resources
 
 A column render is usually chosen through schema metadata such as:

package/vona/packages-cli/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vona-cli",
-  "version": "1.1.148",
+  "version": "1.1.149",
   "gitHead": "a79189b882c17af5911573896a781bbb0046d37d",
   "description": "vona cli",
   "keywords": [

package/vona/packages-cli/cli-set-api/cli/templates/tools/crudBasic/boilerplate/src/dto/{{resourceName}}SelectResItem.tsx_

@@ -44,6 +44,10 @@ export interface IDtoOptions<%=argv.resourceNameCapitalize%>SelectResItem extend
               requiresSelection: true,
               selectedMaxIds: 100,
             }),
+            ZovaRender.tableActionBulk('basic-table:actionRefresh', {
+              permission: { public: true },
+              placement: 'end',
+            }),
             ZovaRender.tableActionBulk('basic-table:actionColumnConfig', {
               permission: { public: true },
               placement: 'end',

package/vona/packages-cli/cli-set-api/cli/templates/tools/crudStart/boilerplate/src/dto/{{resourceName}}SelectResItem.tsx_

@@ -44,6 +44,10 @@ export interface IDtoOptions<%=argv.resourceNameCapitalize%>SelectResItem extend
               requiresSelection: true,
               selectedMaxIds: 100,
             }),
+            ZovaRender.tableActionBulk('start-table:actionRefresh', {
+              permission: { public: true },
+              placement: 'end',
+            }),
             ZovaRender.tableActionBulk('start-table:actionColumnConfig', {
               permission: { public: true },
               placement: 'end',

package/vona/packages-cli/cli-set-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vona-cli-set-api",
-  "version": "1.1.146",
+  "version": "1.1.147",
   "gitHead": "a79189b882c17af5911573896a781bbb0046d37d",
   "description": "vona cli-set-api",
   "keywords": [

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

@@ -46,6 +46,10 @@ export interface IDtoOptionsStudentSelectResItem extends IDecoratorDtoOptions {}
               requiresSelection: true,
               selectedMaxIds: 100,
             }),
+            ZovaRender.tableActionBulk('basic-table:actionRefresh', {
+              permission: { public: true },
+              placement: 'end',
+            }),
             ZovaRender.tableActionBulk('basic-table:actionColumnConfig', {
               permission: { public: true },
               placement: 'end',

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

@@ -103,6 +103,11 @@ describe('student.test.ts', { concurrency: false }, () => {
       );
       assert.equal(deleteBulkAction?.options?.requiresSelection, true);
       assert.equal(deleteBulkAction?.options?.selectedMaxIds, 100);
+      const refreshAction = toolbarBlock?.options?.actions?.find(
+        (action: any) => action.render === 'basic-table:actionRefresh',
+      );
+      assert.equal(refreshAction?.options?.requiresSelection, undefined);
+      assert.equal(refreshAction?.options?.selectedMaxIds, undefined);
       const columnConfigAction = toolbarBlock?.options?.actions?.find(
         (action: any) => action.render === 'basic-table:actionColumnConfig',
       );

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

@@ -1,6 +1,6 @@
 {
   "name": "zova-cli",
-  "version": "1.2.108",
+  "version": "1.2.109",
   "gitHead": "6f675a8cc46d596142c591c28a40cc4d82fcc6cc",
   "description": "zova cli",
   "keywords": [
@@ -44,7 +44,7 @@
     "@cabloy/process-helper": "^3.1.8",
     "fs-extra": "^11.3.5",
     "semver": "^7.6.2",
-    "zova-cli-set-front": "^1.2.106"
+    "zova-cli-set-front": "^1.2.107"
   },
   "devDependencies": {
     "clean-package": "^2.2.0",

package/zova/packages-cli/cli-set-front/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zova-cli-set-front",
-  "version": "1.2.106",
+  "version": "1.2.107",
   "gitHead": "6f675a8cc46d596142c591c28a40cc4d82fcc6cc",
   "description": "zova cli-set-front",
   "keywords": [

package/zova/packages-cli/cli-set-front/src/lib/bean/cli.bin.buildRest.ts

@@ -45,6 +45,13 @@ declare module '@cabloy/cli' {
   }
 }
 
+interface IBinBuildRestPackageJson {
+  name: string;
+  version: string;
+  dependencies?: Record<string, string>;
+  [key: string]: unknown;
+}
+
 interface IBinBuildRestContext {
   projectPath: string;
   flavor: ZovaMetaFlavor;
@@ -54,6 +61,7 @@ interface IBinBuildRestContext {
   outDir: string;
   bundleModules?: string[];
   sideEffectImportModuleNames?: string[];
+  packageJson?: IBinBuildRestPackageJson;
 }
 
 export class CliBinBuildRest extends BeanCliBase {
@@ -129,6 +137,7 @@ export class CliBinBuildRest extends BeanCliBase {
     const templateDir = this.template.resolveTemplatePath(__ThisSetName__, 'rest');
     // render
     await this.template.renderDir(srcDir, templateDir);
+    context.packageJson = await loadJSONFile(path.join(srcDir, 'package.json'));
   }
 
   async _buildTs({ srcDir, outDir }: IBinBuildRestContext) {
@@ -204,7 +213,7 @@ export class CliBinBuildRest extends BeanCliBase {
   }
 
   async _build(buildContext: IBinBuildRestContext) {
-    const { projectPath, flavor, bundleNameCopy, srcDir, outDir } = buildContext;
+    const { projectPath, flavor, bundleNameCopy, outDir, packageJson } = buildContext;
     // build
     await this._buildTs(buildContext);
     await this._buildDts(buildContext);
@@ -212,8 +221,10 @@ export class CliBinBuildRest extends BeanCliBase {
     const deps = await _extractDeps(path.join(outDir, 'index.d.mts'));
     const depsVersion = await _extractDepsVersion(projectPath, deps);
     // package.json
-    const pkgContent = await loadJSONFile(path.join(srcDir, 'package.json'));
-    pkgContent.dependencies = depsVersion;
+    const pkgContent = {
+      ...packageJson!,
+      dependencies: depsVersion,
+    };
     await saveJSONFile(path.join(outDir, 'package.json'), pkgContent);
     // await fse.copyFile(path.join(srcDir, 'package.json'), path.join(outDir, 'package.json'));
     // release

package/zova/src/suite/cabloy-basic/modules/basic-table/src/.metadata/component/actionRefresh.ts

@@ -0,0 +1,31 @@
+import type { TypeControllerInnerProps } from 'zova';
+
+import { defineComponent } from 'vue';
+import { prepareComponentOptions, useController } from 'zova';
+
+import type { ControllerActionRefreshProps } from '../../component/actionRefresh/controller.jsx';
+
+import { ControllerActionRefresh } from '../../component/actionRefresh/controller.jsx';
+export type ZActionRefreshProps = {
+  controllerRef?: (ref: ControllerActionRefresh) => void;
+} & ControllerActionRefreshProps;
+
+type ControllerInnerProps = TypeControllerInnerProps<
+  ControllerActionRefreshProps,
+  keyof typeof ControllerActionRefresh.$propsDefault
+>;
+declare module 'zova-module-basic-table' {
+  export interface ControllerActionRefresh {
+    $props: ControllerInnerProps;
+  }
+}
+
+export const ZActionRefresh = defineComponent((_props: ZActionRefreshProps) => {
+  useController(ControllerActionRefresh, undefined, undefined);
+  return () => {};
+}, prepareComponentOptions(ControllerActionRefresh.$componentOptions));
+declare module 'zova-module-a-bean' {
+  export interface IVonaComponentRecord {
+    'basic-table:actionRefresh': ControllerActionRefreshProps;
+  }
+}

package/zova/src/suite/cabloy-basic/modules/basic-table/src/.metadata/index.ts

@@ -3,6 +3,7 @@
 export * from '../component/actionColumnConfig/controller.jsx';
 export * from '../component/actionCreate/controller.jsx';
 export * from '../component/actionDeleteBulk/controller.jsx';
+export * from '../component/actionRefresh/controller.jsx';
 export * from '../component/table/controller.jsx';
 
 import 'zova';
@@ -27,6 +28,11 @@ declare module 'zova-module-basic-table' {
           get scope(): ScopeModuleBasicTable;
         }
 
+        export interface ControllerActionRefresh {
+          /** @internal */
+          get scope(): ScopeModuleBasicTable;
+        }
+
         export interface ControllerTable {
           /** @internal */
           get scope(): ScopeModuleBasicTable;
@@ -37,6 +43,7 @@ declare module 'zova-module-basic-table' {
 import type { ControllerActionColumnConfig } from '../component/actionColumnConfig/controller.jsx';
 import type { ControllerActionCreate } from '../component/actionCreate/controller.jsx';
 import type { ControllerActionDeleteBulk } from '../component/actionDeleteBulk/controller.jsx';
+import type { ControllerActionRefresh } from '../component/actionRefresh/controller.jsx';
 import type { ControllerTable } from '../component/table/controller.jsx';
 import 'zova';
 declare module 'zova' {
@@ -44,6 +51,7 @@ declare module 'zova' {
     'basic-table.controller.actionColumnConfig': ControllerActionColumnConfig;
 'basic-table.controller.actionCreate': ControllerActionCreate;
 'basic-table.controller.actionDeleteBulk': ControllerActionDeleteBulk;
+'basic-table.controller.actionRefresh': ControllerActionRefresh;
 'basic-table.controller.table': ControllerTable;
   }
 }
@@ -56,12 +64,15 @@ export * from './component/actionCreate.js';
 import { ZActionCreate } from './component/actionCreate.js';
 export * from './component/actionDeleteBulk.js';
 import { ZActionDeleteBulk } from './component/actionDeleteBulk.js';
+export * from './component/actionRefresh.js';
+import { ZActionRefresh } from './component/actionRefresh.js';
 export * from './component/table.js';
 import { ZTable } from './component/table.js';
 export const components = {
   'actionColumnConfig': ZActionColumnConfig,
 'actionCreate': ZActionCreate,
 'actionDeleteBulk': ZActionDeleteBulk,
+'actionRefresh': ZActionRefresh,
 'table': ZTable,
 };
 import 'zova';
@@ -70,12 +81,14 @@ export interface IComponentRecord {
   'basic-table:actionColumnConfig': ControllerActionColumnConfig;
 'basic-table:actionCreate': ControllerActionCreate;
 'basic-table:actionDeleteBulk': ControllerActionDeleteBulk;
+'basic-table:actionRefresh': ControllerActionRefresh;
 'basic-table:table': ControllerTable;
 }
 export interface IZovaComponentRecord {
   'basic-table:actionColumnConfig': typeof ZActionColumnConfig;
 'basic-table:actionCreate': typeof ZActionCreate;
 'basic-table:actionDeleteBulk': typeof ZActionDeleteBulk;
+'basic-table:actionRefresh': typeof ZActionRefresh;
 'basic-table:table': typeof ZTable;
 }
 }

package/zova/src/suite/cabloy-basic/modules/basic-table/src/component/actionRefresh/controller.tsx

@@ -0,0 +1,42 @@
+import type { IComponentOptions } from 'zova';
+import type {
+  IJsxRenderContextPage,
+  IResourceTableActionBulkPropsBase,
+} from 'zova-module-a-openapi';
+
+import { BeanControllerBase, Use } from 'zova';
+import { Controller } from 'zova-module-a-bean';
+
+declare module 'zova-module-a-openapi' {
+  export interface IResourceTableActionBulkRecord {
+    'basic-table:actionRefresh'?: ControllerActionRefreshProps;
+  }
+}
+
+export interface ControllerActionRefreshProps extends IResourceTableActionBulkPropsBase {}
+
+@Controller()
+export class ControllerActionRefresh extends BeanControllerBase {
+  static $propsDefault = { class: 'btn join-item' };
+  static $componentOptions: IComponentOptions = { inheritAttrs: false, deepExtendDefault: true };
+
+  @Use({ injectionScope: 'host' })
+  $$renderContext: IJsxRenderContextPage;
+
+  protected render() {
+    const disabled = this.$props.disabled === true || this.$props.dynamicDisabled === true;
+    return (
+      <button
+        class={this.$props.class}
+        type="button"
+        disabled={disabled}
+        onClick={async () => {
+          if (disabled) return;
+          await this.$$renderContext.$$page.queryData.refetch();
+        }}
+      >
+        {this.scope.locale.Refresh() as string}
+      </button>
+    );
+  }
+}

package/zova/src/suite/cabloy-basic/modules/basic-table/src/config/locale/en-us.ts

@@ -5,6 +5,7 @@ export default {
   SelectRow: 'Select row %s',
   DeleteBulk: 'Bulk Delete',
   DeleteBulkConfirm: 'Are you sure you want to bulk delete %d selected items?',
+  Refresh: 'Refresh',
   ColumnConfiguration: 'Column configuration',
   Columns: 'Columns',
   Visible: 'Visible',

package/zova/src/suite/cabloy-basic/modules/basic-table/src/config/locale/zh-cn.ts

@@ -5,6 +5,7 @@ export default {
   SelectRow: '选择行 %s',
   DeleteBulk: '批量删除',
   DeleteBulkConfirm: '您确认要批量删除已选择的 %d 项吗？',
+  Refresh: '刷新',
   ColumnConfiguration: '列配置',
   Columns: '字段',
   Visible: '显示',