cabloy 5.1.162 → 5.1.164

package/zova/src/suite-vendor/a-cabloy/modules/rest-resource/src/model/resource.ts

@@ -18,6 +18,7 @@ import { ScopeModuleAOpenapi, SymbolOpenapiSchemaName } from 'zova-module-a-open
 
 import { prepareDeleteRequestConfig } from '../lib/deleteRequest.js';
 import { runMutationSuccess } from '../lib/mutationSuccess.js';
+import { validateSelectedIds } from '../lib/selectedIds.js';
 
 export interface IModelOptionsResource extends IDecoratorModelOptions {}
 
@@ -40,6 +41,14 @@ interface IModelResourceMutationItemOptions<TData = void, TVariables = void> {
   invalidateSelect?: boolean;
 }
 
+interface IModelResourceMutationSelectedOptions<TData = void, TVariables = void> {
+  action: string;
+  getIds: (variables: TVariables) => readonly TableIdentity[];
+  mutationFn: (params: TVariables) => Promise<TData>;
+  onSuccess?: (data: TData, variables: TVariables, context: unknown) => void | Promise<void>;
+  invalidateSelect?: boolean;
+}
+
 @Model<IModelOptionsResource>({
   enableSelector: true,
 })
@@ -187,6 +196,47 @@ export class ModelResource<
     });
   }
 
+  mutationSelected<TData = void, TVariables = void>(
+    options: IModelResourceMutationSelectedOptions<TData, TVariables>,
+  ) {
+    const { action, getIds, mutationFn, onSuccess, invalidateSelect = true } = options;
+    return this.$useMutationData<TData, TVariables>({
+      mutationKey: ['selected', action, 'mutation'],
+      mutationFn: async variables => {
+        this._getMutationSelectedIds(getIds, variables);
+        return await mutationFn(variables);
+      },
+      onSuccess: async (data, variables, context) => {
+        const ids = this._getMutationSelectedIds(getIds, variables);
+        await runMutationSuccess({
+          invalidateSelect: invalidateSelect
+            ? () => this.$invalidateQueries({ queryKey: ['select'] })
+            : undefined,
+          invalidateItem: async () => {
+            await Promise.all(
+              ids.map(id => this.$invalidateQueries({ queryKey: this.keyItemRoot(id) })),
+            );
+          },
+          onSuccess: () => onSuccess?.(data, variables, context),
+        });
+      },
+    });
+  }
+
+  deleteBulk() {
+    return this.mutationSelected<void, { ids: readonly TableIdentity[] }>({
+      action: 'delete',
+      getIds: body => body.ids,
+      mutationFn: async body => {
+        return this.$fetch.post<any, void, { ids: readonly TableIdentity[] }>(
+          this.sys.util.apiActionPathTranslate(`${this.resourceApi}/bulk/delete`),
+          body,
+          this.sys.util.apiActionConfigPrepare(),
+        );
+      },
+    });
+  }
+
   update(id: TableIdentity) {
     return this.mutationItem<void, EntityUpdate>({
       id,
@@ -276,6 +326,13 @@ export class ModelResource<
     return this.$sdk.getSchemaDefaultValue(schemaName) as EntityCreate | undefined;
   }
 
+  private _getMutationSelectedIds<TVariables>(
+    getIds: (variables: TVariables) => readonly TableIdentity[],
+    variables: TVariables,
+  ) {
+    return validateSelectedIds(getIds(variables));
+  }
+
   protected keySelect(actionPath?: string, query?: ITableQuery) {
     return ['select', actionPath ?? '', hashkey(query)] as const;
   }

package/zova/src/suite-vendor/a-cabloy/modules/rest-resource/test/lib/selectedIds.test.ts

@@ -0,0 +1,20 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+
+import { validateSelectedIds } from '../../src/lib/selectedIds.ts';
+
+test('selected mutation IDs require a nonempty unique normalized collection', () => {
+  assert.deepEqual(validateSelectedIds([7, 'student-8']), [7, 'student-8']);
+  assert.throws(() => validateSelectedIds([]), /selected ids cannot empty/);
+  assert.throws(() => validateSelectedIds([undefined as never]), /selected row id cannot empty/);
+  assert.throws(() => validateSelectedIds(['']), /selected row id cannot empty/);
+  assert.throws(() => validateSelectedIds([1, '1']), /duplicate selected row id: 1/);
+});
+
+test('selected mutation IDs do not impose a frontend count limit', () => {
+  const ids = Array.from({ length: 101 }, (_, index) => index + 1);
+  const validatedIds = validateSelectedIds(ids);
+
+  assert.deepEqual(validatedIds, ids);
+  assert.notEqual(validatedIds, ids);
+});

package/zova/src/suite-vendor/a-cabloy/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zova-suite-a-cabloy",
-  "version": "5.1.51",
+  "version": "5.1.52",
   "gitHead": "4dece229b6d3f4735930e833afcb4b95ec51bf86",
   "description": "",
   "author": "",
@@ -8,7 +8,7 @@
   "type": "module",
   "dependencies": {
     "zova-module-a-rbac": "^5.0.1",
-    "zova-module-rest-resource": "^5.1.50"
+    "zova-module-rest-resource": "^5.1.51"
   },
   "title": "a-cabloy"
 }

package/zova/src/suite-vendor/a-zova/modules/a-command/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zova-module-a-command",
-  "version": "5.1.34",
+  "version": "5.1.35",
   "gitHead": "09d901d17140a80ee0764211b441cda72fd94663",
   "description": "",
   "keywords": [

package/zova/src/suite-vendor/a-zova/modules/a-command/src/lib/beanCommandSelectedBase.ts

@@ -0,0 +1,33 @@
+import type { TableIdentity } from 'table-identity';
+import type { IJsxRenderContextBase, IJsxRenderContextPage } from 'zova-module-a-openapi';
+
+import { isNil } from '@cabloy/utils';
+import { BeanBase } from 'zova';
+
+import type { ICommandSelectedOptionsBase } from '../types/command.js';
+
+export class BeanCommandSelectedBase extends BeanBase {
+  getResourceAndIds(
+    options: ICommandSelectedOptionsBase,
+    renderContext: IJsxRenderContextBase,
+  ): { resource: string; ids: readonly TableIdentity[] } {
+    let resource: string | undefined = options.resource;
+    let ids = options.ids;
+    if (renderContext.$scene === 'page') {
+      const { $celScope } = renderContext as IJsxRenderContextPage;
+      resource = resource ?? $celScope.resource;
+      ids = ids ?? $celScope.selection?.ids;
+    }
+    if (isNil(resource) || !ids || ids.length === 0) {
+      throw new Error(`should specify resource and selected ids in scene: ${renderContext.$scene}`);
+    }
+    const keys = new Set<string>();
+    for (const id of ids) {
+      if (isNil(id) || id === '') throw new Error('selected row id cannot empty');
+      const key = String(id);
+      if (keys.has(key)) throw new Error(`duplicate selected row id: ${key}`);
+      keys.add(key);
+    }
+    return { resource, ids };
+  }
+}

package/zova/src/suite-vendor/a-zova/modules/a-command/src/lib/index.ts

@@ -1,4 +1,5 @@
 export * from './beanCommandBulkBase.js';
 export * from './beanCommandRowBase.js';
+export * from './beanCommandSelectedBase.js';
 export * from './command.js';
 export * from './performCommand.js';

package/zova/src/suite-vendor/a-zova/modules/a-command/src/types/command.ts

@@ -40,6 +40,11 @@ export interface ICommandRowOptionsBase<Result = any> extends ICommandOptionsBas
   id?: TableIdentity;
 }
 
+export interface ICommandSelectedOptionsBase<Result = any> extends ICommandOptionsBase<Result> {
+  resource?: string;
+  ids?: readonly TableIdentity[];
+}
+
 export interface ICommandDetailsRowOptionsBase<Result = any> extends ICommandOptionsBase<Result> {}
 
 declare module 'zova-module-a-bean' {

package/zova/src/suite-vendor/a-zova/modules/a-command/test/lib/beanCommandSelectedBase.test.ts

@@ -0,0 +1,47 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+
+import { BeanCommandSelectedBase } from '../../src/lib/beanCommandSelectedBase.ts';
+
+const command = Object.create(BeanCommandSelectedBase.prototype) as BeanCommandSelectedBase;
+const renderContext = { $scene: 'app' } as any;
+
+test('selected command IDs do not impose a frontend count limit', () => {
+  const ids = Array.from({ length: 101 }, (_, index) => index + 1);
+
+  assert.deepEqual(
+    command.getResourceAndIds({ resource: 'test:resource', ids } as any, renderContext),
+    {
+      resource: 'test:resource',
+      ids,
+    },
+  );
+});
+
+test('selected command IDs require a nonempty unique normalized collection', () => {
+  assert.throws(
+    () => command.getResourceAndIds({ resource: 'test:resource', ids: [] } as any, renderContext),
+    /should specify resource and selected ids/,
+  );
+  assert.throws(
+    () => command.getResourceAndIds({ ids: [1] } as any, renderContext),
+    /should specify resource and selected ids/,
+  );
+  assert.throws(
+    () =>
+      command.getResourceAndIds(
+        { resource: 'test:resource', ids: [undefined as never] } as any,
+        renderContext,
+      ),
+    /selected row id cannot empty/,
+  );
+  assert.throws(
+    () => command.getResourceAndIds({ resource: 'test:resource', ids: [''] } as any, renderContext),
+    /selected row id cannot empty/,
+  );
+  assert.throws(
+    () =>
+      command.getResourceAndIds({ resource: 'test:resource', ids: [1, '1'] } as any, renderContext),
+    /duplicate selected row id: 1/,
+  );
+});

package/zova/src/suite-vendor/a-zova/modules/a-openapi/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zova-module-a-openapi",
-  "version": "5.1.52",
+  "version": "5.1.53",
   "gitHead": "09d901d17140a80ee0764211b441cda72fd94663",
   "description": "",
   "keywords": [

package/zova/src/suite-vendor/a-zova/modules/a-openapi/src/types/action.ts

@@ -3,6 +3,8 @@ import type { ZovaJsx } from 'zova-jsx';
 
 import { TableIdentity } from 'table-identity';
 
+import type { IResourceTableSelectionPayload } from './resource/tableActionBulk.js';
+
 import { TypeOpenapiPermissions } from './permissions.js';
 
 export interface IJsxRenderContextBase {
@@ -41,6 +43,7 @@ export interface IJsxRenderSceneRecord {
 export interface IPageScope {
   resource?: string;
   permissions?: TypeOpenapiPermissions;
+  selection?: IResourceTableSelectionPayload;
 }
 
 export interface IJsxRenderContextPage extends IJsxRenderContextBase {

package/zova/src/suite-vendor/a-zova/modules/a-openapi/src/types/resource/tableActionBulk.ts

@@ -1,3 +1,5 @@
+import type { TableIdentity } from 'table-identity';
+
 import { types } from 'typestyle';
 import { TypeRenderComponentJsx } from 'zova-jsx';
 
@@ -11,11 +13,28 @@ export type IResourceTableActionBulkNameRecord = {
 
 export interface IResourceTableActionBulkRecord {}
 
+export interface IResourceTableSelectionPayload<TData extends {} = Record<string, unknown>> {
+  ids: readonly TableIdentity[];
+  rows: readonly TData[];
+  count: number;
+}
+
+/** Declarative bulk-action metadata authored by a resource schema. */
 export interface IResourceTableActionBulkOptionsBase {
   class?: any;
   style?: types.NestedCSSProperties;
   resource?: string;
   permission?: IPermissionHintTableActionBulk;
+  requiresSelection?: boolean;
+  selectedMaxIds?: number;
+  disabled?: boolean;
+}
+
+/** Runtime bulk-action props supplied by the owning toolbar for the current render. */
+export interface IResourceTableActionBulkPropsBase extends IResourceTableActionBulkOptionsBase {
+  dynamicSelection?: IResourceTableSelectionPayload;
+  dynamicDisabled?: boolean;
+  dynamicDisabledReason?: string;
 }
 
 export interface IResourceRenderTableActionBulkOptionsAction {

package/zova/src/suite-vendor/a-zova/modules/a-table/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zova-module-a-table",
-  "version": "5.1.39",
+  "version": "5.1.40",
   "gitHead": "09d901d17140a80ee0764211b441cda72fd94663",
   "description": "",
   "keywords": [

package/zova/src/suite-vendor/a-zova/modules/a-table/src/component/table/controller.tsx

@@ -14,6 +14,7 @@ import {
   getCoreRowModel,
   OnChangeFn,
   Row,
+  RowSelectionState,
   SortingState,
   TableOptionsWithReactiveData,
 } from '@tanstack/vue-table';
@@ -46,6 +47,7 @@ import type {
 } from '../../types/tableColumn.js';
 
 import { BeanControllerTableBase } from '../../lib/beanControllerTableBase.js';
+import { TableColumnIdSelection } from '../../types/table.js';
 import { ITableCellRenderColumnOptions } from '../../types/tableColumn.js';
 
 export interface ControllerTableProps<TData extends {} = {}> {
@@ -54,6 +56,9 @@ export interface ControllerTableProps<TData extends {} = {}> {
   schemaOrder?: SchemaObject;
   sorting?: SortingState;
   onSortingChange?: OnChangeFn<SortingState>;
+  enableRowSelection?: boolean | ((row: Row<TData>) => boolean);
+  rowSelection?: RowSelectionState;
+  onRowSelectionChange?: OnChangeFn<RowSelectionState>;
   tableScope?: ITableScope;
   getColumns?: TypeTableGetColumns<TData>;
   slotDefault?: (table: ControllerTable<TData>) => VNode;
@@ -89,6 +94,13 @@ export class ControllerTable<TData extends {} = {}> extends BeanControllerTableB
         await this.refreshMeta();
       },
     );
+    this.$watch(
+      () => this.$props.enableRowSelection,
+      async (newValue, oldValue) => {
+        if (newValue === oldValue) return;
+        await this.refreshMeta();
+      },
+    );
     // table
     this._createTable();
   }
@@ -105,6 +117,10 @@ export class ControllerTable<TData extends {} = {}> extends BeanControllerTableB
     return this.$props.sorting ?? [];
   }
 
+  public get rowSelection() {
+    return this.$props.rowSelection ?? {};
+  }
+
   public async refreshMeta() {
     this.tableMeta = await this._createTableMeta();
     this.columns = await this._createColumns();
@@ -115,22 +131,30 @@ export class ControllerTable<TData extends {} = {}> extends BeanControllerTableB
     // eslint-disable-next-line
     const self = this;
     const tableOptions: TableOptionsWithReactiveData<TData> = {
-      getRowId: this.$props.getRowId ?? ((originalRow: TData) => cast(originalRow).id),
+      getRowId: (originalRow, index, parent) => this._getRowId(originalRow, index, parent),
       getCoreRowModel: getCoreRowModel(),
       renderFallbackValue: this.scope.config.renderFallbackValue,
       manualPagination: true,
       manualSorting: true,
       enableMultiSort: false,
       enableSortingRemoval: false,
+      enableRowSelection: row => self._canSelectRow(row),
       state: {
         get sorting() {
           return self.sorting;
         },
+        get rowSelection() {
+          return self.rowSelection;
+        },
       },
       onSortingChange: updater => {
         const sorting = functionalUpdate(updater, self.sorting).slice(0, 1);
         self.$props.onSortingChange?.(sorting);
       },
+      onRowSelectionChange: updater => {
+        const rowSelection = functionalUpdate(updater, self.rowSelection);
+        self.$props.onRowSelectionChange?.(rowSelection);
+      },
       get initialState() {
         const columnPinning = self._getColumnPinning();
         return { columnPinning };
@@ -148,31 +172,50 @@ export class ControllerTable<TData extends {} = {}> extends BeanControllerTableB
 
   private async _createColumns() {
     if (!this.properties) return [];
-    if (!this.$props.getColumns) return await this._createColumnsMiddle(this.tableMeta.properties);
-    return await this.$props.getColumns(
-      async properties => {
-        return await this._createColumnsMiddle(properties ?? this.tableMeta.properties);
-      },
-      async (
-        key: string,
-        render: TypeTableCellRenderComponent,
-      ): Promise<TypeTableCellRender<TData, any> | undefined> => {
-        // columnScope
-        const columnScope = this.getColumnScope(key);
-        // renderContext
-        const jsxRenderContext = this.getColumnJsxRenderContext(columnScope);
-        // columnProps
-        const { visible, columnProps } = this.getColumnComponentPropsTop(
-          key,
-          columnScope,
-          jsxRenderContext,
+    const columns = !this.$props.getColumns
+      ? await this._createColumnsMiddle(this.tableMeta.properties)
+      : await this.$props.getColumns(
+          async properties => {
+            return await this._createColumnsMiddle(properties ?? this.tableMeta.properties);
+          },
+          async (
+            key: string,
+            render: TypeTableCellRenderComponent,
+          ): Promise<TypeTableCellRender<TData, any> | undefined> => {
+            // columnScope
+            const columnScope = this.getColumnScope(key);
+            // renderContext
+            const jsxRenderContext = this.getColumnJsxRenderContext(columnScope);
+            // columnProps
+            const { visible, columnProps } = this.getColumnComponentPropsTop(
+              key,
+              columnScope,
+              jsxRenderContext,
+            );
+            // visible
+            if (visible === false) return;
+            return await this._createColumnRender(
+              render,
+              columnProps,
+              columnScope,
+              jsxRenderContext,
+            );
+          },
+          this,
         );
-        // visible
-        if (visible === false) return;
-        return await this._createColumnRender(render, columnProps, columnScope, jsxRenderContext);
-      },
-      this,
-    );
+    if (!this.$props.enableRowSelection) return columns;
+    const columnHelper = createColumnHelper<TData>();
+    return [
+      columnHelper.display({
+        id: TableColumnIdSelection,
+        header: '',
+        cell: '',
+        size: 48,
+        enableSorting: false,
+        meta: { rest: { fixed: 'left', width: 48, align: 'center' } },
+      }),
+      ...columns,
+    ];
   }
 
   private async _createColumnsMiddle(
@@ -200,8 +243,25 @@ export class ControllerTable<TData extends {} = {}> extends BeanControllerTableB
     return columns;
   }
 
+  private _getRowId(originalRow: TData, index: number, parent?: Row<TData>) {
+    const id = this.$props.getRowId?.(originalRow, index, parent) ?? cast(originalRow).id;
+    if (isNilOrEmptyString(id)) {
+      return `__unselectable_${parent ? `${parent.id}.` : ''}${index}`;
+    }
+    return String(id);
+  }
+
+  private _canSelectRow(row: Row<TData>) {
+    const enableRowSelection = this.$props.enableRowSelection;
+    if (!enableRowSelection) return false;
+    const originalId =
+      this.$props.getRowId?.(row.original, row.index, row.getParentRow()) ?? cast(row.original).id;
+    if (isNilOrEmptyString(originalId)) return false;
+    return typeof enableRowSelection === 'function' ? enableRowSelection(row) : true;
+  }
+
   private _getColumnPinning() {
-    const left: string[] = [];
+    const left: string[] = this.$props.enableRowSelection ? [TableColumnIdSelection] : [];
     const right: string[] = [];
     for (const property of this.tableMeta?.properties ?? []) {
       const fixed = property.rest?.fixed;

package/zova/src/suite-vendor/a-zova/modules/a-table/src/component/table/render.tsx

@@ -4,6 +4,8 @@ import { FlexRender } from '@tanstack/vue-table';
 import { BeanRenderBase } from 'zova';
 import { Render } from 'zova-module-a-bean';
 
+import { TableColumnIdSelection } from '../../types/table.js';
+
 @Render()
 export class RenderTable extends BeanRenderBase {
   private _getColumnStyle(column: any): CSSProperties {
@@ -33,7 +35,18 @@ export class RenderTable extends BeanRenderBase {
               const sorted = column.getIsSorted();
               const fixed = column.getIsPinned();
               const headerDefinition = column.columnDef.header;
-              const headerContent = (
+              const selection = column.id === TableColumnIdSelection;
+              const headerContent = selection ? (
+                <input
+                  type="checkbox"
+                  checked={table.getIsAllPageRowsSelected()}
+                  indeterminate={table.getIsSomePageRowsSelected()}
+                  aria-checked={table.getIsSomePageRowsSelected() ? 'mixed' : undefined}
+                  aria-label="Select all rows on this page"
+                  disabled={table.getRowModel().rows.every(row => !row.getCanSelect())}
+                  onChange={table.getToggleAllPageRowsSelectedHandler()}
+                />
+              ) : (
                 <FlexRender render={headerDefinition} props={header.getContext()}></FlexRender>
               );
               let sortAria: AriaAttributes['aria-sort'] = 'none';
@@ -73,19 +86,30 @@ export class RenderTable extends BeanRenderBase {
         <tbody>
           {table.getRowModel().rows.map(row => {
             return (
-              <tr key={row.id}>
+              <tr key={row.id} aria-selected={row.getIsSelected()}>
                 {row.getVisibleCells().map(cell => {
                   const column = cell.column;
+                  const selection = column.id === TableColumnIdSelection;
                   return (
                     <td
                       key={cell.id}
                       class={column.getIsPinned() ? 'bg-base-100' : undefined}
                       style={this._getColumnStyle(column)}
                     >
-                      <FlexRender
-                        render={column.columnDef.cell}
-                        props={cell.getContext()}
-                      ></FlexRender>
+                      {selection ? (
+                        <input
+                          type="checkbox"
+                          checked={row.getIsSelected()}
+                          disabled={!row.getCanSelect()}
+                          aria-label={`Select row ${row.id}`}
+                          onChange={row.getToggleSelectedHandler()}
+                        />
+                      ) : (
+                        <FlexRender
+                          render={column.columnDef.cell}
+                          props={cell.getContext()}
+                        ></FlexRender>
+                      )}
                     </td>
                   );
                 })}

package/zova/src/suite-vendor/a-zova/modules/a-table/src/types/table.ts

@@ -11,6 +11,8 @@ export type TypeTable<TData extends {} = {}> = ReturnType<typeof useVueTable<TDa
 
 export type TypeColumn<TData extends {} = {}> = ColumnDef<TData, any>;
 
+export const TableColumnIdSelection = '$$selection';
+
 export interface ITableMeta<TData extends {} = {}> {
   properties: ISchemaObjectExtensionField[];
   renders: Record<string, TypeTableCellRender<TData>>;

package/zova/src/suite-vendor/a-zova/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zova-suite-a-zova",
-  "version": "5.1.155",
+  "version": "5.1.156",
   "gitHead": "2c5c19284bab738e492856189acb6fad74b8a7b7",
   "description": "zova",
   "license": "MIT",
@@ -14,7 +14,7 @@
     "zova-module-a-behavior": "^5.1.26",
     "zova-module-a-behaviors": "^5.1.22",
     "zova-module-a-boundary": "^5.1.22",
-    "zova-module-a-command": "^5.1.34",
+    "zova-module-a-command": "^5.1.35",
     "zova-module-a-fetch": "^5.1.25",
     "zova-module-a-form": "^5.1.51",
     "zova-module-a-icon": "^5.1.27",
@@ -22,7 +22,7 @@
     "zova-module-a-logger": "^5.1.28",
     "zova-module-a-meta": "^5.1.22",
     "zova-module-a-model": "^5.1.36",
-    "zova-module-a-openapi": "^5.1.52",
+    "zova-module-a-openapi": "^5.1.53",
     "zova-module-a-router": "^5.1.34",
     "zova-module-a-routerstack": "^5.1.27",
     "zova-module-a-routertabs": "^5.1.34",
@@ -30,7 +30,7 @@
     "zova-module-a-ssrhmr": "^5.1.23",
     "zova-module-a-ssrserver": "^5.1.26",
     "zova-module-a-style": "^5.1.35",
-    "zova-module-a-table": "^5.1.39",
+    "zova-module-a-table": "^5.1.40",
     "zova-module-a-zod": "^5.1.37",
     "zova-module-a-zova": "^5.1.103"
   },