Skip to content

Commit b274996

Browse files
NoOne7135NoOne7135
authored
Merge pull request #601 from devforth/add-column-select-to-get-data
feat: add optional columns property to resource data request schema a…
2 parents 798da36 + ad83afc commit b274996

13 files changed

Lines changed: 340 additions & 27 deletions

File tree

‎adminforth/dataConnectors/baseConnector.ts‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -261,12 +261,13 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
261261
}
262262
}
263263

264-
getDataWithOriginalTypes({ resource, limit, offset, sort, filters }: {
264+
getDataWithOriginalTypes({ resource, limit, offset, sort, filters, columns }: {
265265
resource: AdminForthResource,
266266
limit: number,
267267
offset: number,
268268
sort: IAdminForthSort[],
269269
filters: IAdminForthAndOrFilter,
270+
columns?: AdminForthResourceColumn[],
270271
}): Promise<any[]> {
271272
throw new Error('Method not implemented.');
272273
}
@@ -599,13 +600,14 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
599600
throw new Error('Method not implemented.');
600601
}
601602

602-
async getData({ resource, limit, offset, sort, filters, getTotals }: {
603+
async getData({ resource, limit, offset, sort, filters, getTotals, columns }: {
603604
resource: AdminForthResource,
604605
limit: number,
605606
offset: number,
606607
sort: { field: string, direction: AdminForthSortDirections }[],
607608
filters: IAdminForthAndOrFilter,
608609
getTotals: boolean,
610+
columns?: AdminForthResourceColumn[],
609611
}): Promise<{ data: any[], total: number }> {
610612
let normalizedFilters = filters;
611613

@@ -617,7 +619,8 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
617619
normalizedFilters = filterValidation.normalizedFilters as IAdminForthAndOrFilter;
618620
}
619621

620-
const promises: Promise<any>[] = [this.getDataWithOriginalTypes({ resource, limit, offset, sort, filters: normalizedFilters })];
622+
const dataSourceColumns = columns ?? resource.dataSourceColumns;
623+
const promises: Promise<any>[] = [this.getDataWithOriginalTypes({ resource, limit, offset, sort, filters: normalizedFilters, columns: dataSourceColumns })];
621624
if (getTotals) {
622625
promises.push(this.getCount({ resource, filters }));
623626
} else {
@@ -628,7 +631,7 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
628631

629632
// call getFieldValue for each field
630633
data.map((record) => {
631-
for (const col of resource.dataSourceColumns) {
634+
for (const col of dataSourceColumns) {
632635
record[col.name] = this.getFieldValue(col, record[col.name]);
633636
}
634637
});

‎adminforth/dataConnectors/clickhouse.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -510,14 +510,15 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
510510
}));
511511
}
512512

513-
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters }: {
513+
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters, columns }: {
514514
resource: AdminForthResource,
515515
limit: number,
516516
offset: number,
517517
sort: { field: string, direction: AdminForthSortDirections }[],
518518
filters: IAdminForthAndOrFilter,
519+
columns?: AdminForthResourceColumn[],
519520
}): Promise<Array<{ group?: string, [key: string]: any }>> {
520-
const columns = resource.dataSourceColumns.map((col) => {
521+
const selectedColumns = (columns ?? resource.dataSourceColumns).map((col) => {
521522
// for decimal cast to string
522523
if (col.type == AdminForthDataTypes.DECIMAL) {
523524
return `toString(${col.name}) as ${col.name}`
@@ -532,7 +533,7 @@ class ClickhouseConnector extends AdminForthBaseConnector implements IAdminForth
532533
const orderBy = sort.length ? `ORDER BY ${sort.map((s) => `${s.field} ${this.SortDirectionsMap[s.direction]}`).join(', ')}` : '';
533534

534535

535-
const q = `SELECT ${columns} FROM ${tableName} ${where} ${orderBy} LIMIT {limit:Int} OFFSET {offset:Int}`;
536+
const q = `SELECT ${selectedColumns} FROM ${tableName} ${where} ${orderBy} LIMIT {limit:Int} OFFSET {offset:Int}`;
536537
const d = {
537538
...params,
538539
limit,

‎adminforth/dataConnectors/mongo.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,13 +408,14 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
408408
});
409409
}
410410

411-
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters }:
411+
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters, columns }:
412412
{
413413
resource: AdminForthResource,
414414
limit: number,
415415
offset: number,
416416
sort: { field: string, direction: AdminForthSortDirections }[],
417417
filters: IAdminForthAndOrFilter,
418+
columns?: Array<{ name: string }>,
418419
}
419420
): Promise<any[]> {
420421

@@ -429,7 +430,11 @@ class MongoConnector extends AdminForthBaseConnector implements IAdminForthDataS
429430
return [s.field, this.SortDirectionsMap[s.direction]];
430431
});
431432

432-
const result = await collection.find(query)
433+
const projection = columns
434+
? Object.fromEntries(columns.map((col) => [col.name, 1]))
435+
: undefined;
436+
437+
const result = await collection.find(query, projection ? { projection } : undefined)
433438
.sort(sortArray)
434439
.skip(offset)
435440
.limit(limit)

‎adminforth/dataConnectors/mysql.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -453,14 +453,14 @@ class MysqlConnector extends AdminForthBaseConnector implements IAdminForthDataS
453453
return rows;
454454
}
455455

456-
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters }): Promise<any[]> {
457-
const columns = resource.dataSourceColumns.map((col: { name: string }) => `${col.name}`).join(', ');
456+
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters, columns }): Promise<any[]> {
457+
const selectedColumns = (columns ?? resource.dataSourceColumns).map((col: { name: string }) => `${col.name}`).join(', ');
458458
const tableName = resource.table;
459459

460460
const { sql: where, values: filterValues } = this.whereClauseAndValues(filters);
461461

462462
const orderBy = sort.length ? `ORDER BY ${sort.map((s: { field: string; direction: AdminForthSortDirections }) => `${s.field} ${this.SortDirectionsMap[s.direction]}`).join(', ')}` : '';
463-
let selectQuery = `SELECT ${columns} FROM ${tableName}`;
463+
let selectQuery = `SELECT ${selectedColumns} FROM ${tableName}`;
464464
if (where) selectQuery += ` ${where}`;
465465
if (orderBy) selectQuery += ` ${orderBy}`;
466466
if (limit) selectQuery += ` LIMIT ${limit}`;

‎adminforth/dataConnectors/postgres.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -428,16 +428,16 @@ class PostgresConnector extends AdminForthBaseConnector implements IAdminForthDa
428428
return stmt.rows;
429429
}
430430

431-
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters }): Promise<any[]> {
432-
const columns = resource.dataSourceColumns.map((col) => `"${col.name}"`).join(', ');
431+
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters, columns }): Promise<any[]> {
432+
const selectedColumns = (columns ?? resource.dataSourceColumns).map((col) => `"${col.name}"`).join(', ');
433433
const tableName = resource.table;
434434

435435
const { sql: where, paramsCount, values: filterValues } = this.whereClauseAndValues(resource, filters);
436436

437437
const limitOffset = `LIMIT $${paramsCount} OFFSET $${paramsCount + 1}`;
438438
const d = [...filterValues, limit, offset];
439439
const orderBy = sort.length ? `ORDER BY ${sort.map((s) => `"${s.field}" ${this.SortDirectionsMap[s.direction]}`).join(', ')}` : '';
440-
const selectQuery = `SELECT ${columns} FROM "${tableName}" ${where} ${orderBy} ${limitOffset}`;
440+
const selectQuery = `SELECT ${selectedColumns} FROM "${tableName}" ${where} ${orderBy} ${limitOffset}`;
441441
dbLogger.trace(`🪲📜 PG Q: ${selectQuery}, params: ${JSON.stringify(d)}`);
442442
const stmt = await this.client.query(selectQuery, d);
443443
const rows = stmt.rows;

‎adminforth/dataConnectors/sqlite.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -430,8 +430,8 @@ class SQLiteConnector extends AdminForthBaseConnector implements IAdminForthData
430430
return results.sort((a, b) => a.group.localeCompare(b.group));
431431
}
432432

433-
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters }): Promise<any[]> {
434-
const columns = resource.dataSourceColumns.map((col) => col.name).join(', ');
433+
async getDataWithOriginalTypes({ resource, limit, offset, sort, filters, columns }): Promise<any[]> {
434+
const selectedColumns = (columns ?? resource.dataSourceColumns).map((col) => col.name).join(', ');
435435
const tableName = resource.table;
436436

437437
const where = this.whereClause(filters);
@@ -440,7 +440,7 @@ class SQLiteConnector extends AdminForthBaseConnector implements IAdminForthData
440440

441441
const orderBy = sort.length ? `ORDER BY ${sort.map((s) => `${s.field} ${this.SortDirectionsMap[s.direction]}`).join(', ')}` : '';
442442

443-
const q = `SELECT ${columns} FROM ${tableName} ${where} ${orderBy} LIMIT ? OFFSET ?`;
443+
const q = `SELECT ${selectedColumns} FROM ${tableName} ${where} ${orderBy} LIMIT ? OFFSET ?`;
444444
const stmt = this.client.prepare(q);
445445
const d = [...filterValues, limit, offset];
446446

‎adminforth/modules/restApi.ts‎

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,13 @@ const getResourceDataRequestSchema: AnySchemaObject = {
272272
},
273273
sort: commonSortSchema,
274274
filters: commonFiltersSchema,
275+
columns: {
276+
type: 'array',
277+
description: 'Optional list of resource column names to include in returned rows. For list requests, computed row helper fields such as _label and _clickUrl are still returned when available.',
278+
minItems: 1,
279+
uniqueItems: true,
280+
items: { type: 'string' },
281+
},
275282
},
276283
additionalProperties: true,
277284
allOf: [
@@ -1296,6 +1303,42 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
12961303
}
12971304
}
12981305
const { limit, offset, filters, sort } = body;
1306+
const selectedColumnNames = body.columns
1307+
? [...new Set(body.columns as string[])]
1308+
: undefined;
1309+
1310+
if (selectedColumnNames) {
1311+
const resourceColumnNames = new Set(resource.columns.map((col) => col.name));
1312+
const invalidColumnName = selectedColumnNames.find((columnName) => !resourceColumnNames.has(columnName));
1313+
1314+
if (invalidColumnName) {
1315+
return { error: `Column ${invalidColumnName} not found in resource ${resourceId}` };
1316+
}
1317+
}
1318+
const selectedColumnNameSet = selectedColumnNames ? new Set(selectedColumnNames) : undefined;
1319+
const shouldAddListHelpers = source === 'list';
1320+
const selectedDataSourceColumnNameSet = selectedColumnNames
1321+
? new Set(selectedColumnNames.filter((columnName) => resource.dataSourceColumns.some((col) => col.name === columnName)))
1322+
: undefined;
1323+
1324+
if (selectedDataSourceColumnNameSet) {
1325+
for (const col of resource.columns) {
1326+
if (
1327+
selectedColumnNameSet.has(col.name) &&
1328+
col.foreignResource?.polymorphicOn
1329+
) {
1330+
selectedDataSourceColumnNameSet.add(col.foreignResource.polymorphicOn);
1331+
}
1332+
}
1333+
}
1334+
1335+
const selectedDataSourceColumns = selectedDataSourceColumnNameSet && !shouldAddListHelpers
1336+
? (
1337+
resource.dataSourceColumns.some((col) => selectedDataSourceColumnNameSet.has(col.name))
1338+
? resource.dataSourceColumns.filter((col) => selectedDataSourceColumnNameSet.has(col.name))
1339+
: resource.dataSourceColumns.filter((col) => col.primaryKey || col.name === resource.dataSourceColumns[0]?.name)
1340+
)
1341+
: undefined;
12991342

13001343
// remove virtual fields from sort if still presented after beforeDatasourceRequest hook
13011344
const sortFiltered = sort.filter((sortItem: IAdminForthSort) => {
@@ -1334,11 +1377,14 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
13341377
filters: normalizedFilters as IAdminForthAndOrFilter,
13351378
sort: sortFiltered,
13361379
getTotals: source === 'list',
1380+
columns: selectedDataSourceColumns,
13371381
});
13381382

13391383
// for foreign keys, add references
13401384
await Promise.all(
1341-
resource.columns.filter((col) => col.foreignResource).map(async (col) => {
1385+
resource.columns.filter((col) => (
1386+
col.foreignResource && (!selectedColumnNameSet || shouldAddListHelpers || selectedColumnNameSet.has(col.name))
1387+
)).map(async (col) => {
13421388
let targetDataMap = {};
13431389

13441390
if (col.foreignResource.resourceId) {
@@ -1448,7 +1494,6 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
14481494
})
14491495
);
14501496

1451-
const pkField = resource.columns.find((col) => col.primaryKey)?.name;
14521497
// remove all columns which are not defined in resources, or defined but backendOnly
14531498
{
14541499
const ctx = {
@@ -1471,10 +1516,12 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
14711516
delete item[key];
14721517
}
14731518
}
1474-
item._label = resource.recordLabel(item);
1519+
if (!selectedColumnNameSet || shouldAddListHelpers) {
1520+
item._label = resource.recordLabel(item);
1521+
}
14751522
}
14761523
}
1477-
if (source === 'list' && resource.options.listTableClickUrl) {
1524+
if (shouldAddListHelpers && resource.options.listTableClickUrl) {
14781525
await Promise.all(
14791526
data.data.map(async (item) => {
14801527
item._clickUrl = await resource.options.listTableClickUrl(item, adminUser, resource);
@@ -1501,6 +1548,16 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
15011548
}
15021549
}
15031550

1551+
if (selectedColumnNameSet) {
1552+
for (const item of data.data) {
1553+
for (const key of Object.keys(item)) {
1554+
if (!selectedColumnNameSet.has(key) && key !== '_label' && key !== '_clickUrl') {
1555+
delete item[key];
1556+
}
1557+
}
1558+
}
1559+
}
1560+
15041561
return data;
15051562
},
15061563
});

‎adminforth/types/Back.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,12 +334,13 @@ export interface IAdminForthDataSourceConnector {
334334
*
335335
* Fields are returned from db "as is" then {@link AdminForthBaseConnector.getData} will transform each field using {@link IAdminForthDataSourceConnector.getFieldValue}
336336
*/
337-
getDataWithOriginalTypes({ resource, limit, offset, sort, filters }: {
337+
getDataWithOriginalTypes({ resource, limit, offset, sort, filters, columns }: {
338338
resource: AdminForthResource,
339339
limit: number,
340340
offset: number,
341341
sort: IAdminForthSort[],
342342
filters: IAdminForthAndOrFilter,
343+
columns?: AdminForthResourceColumn[],
343344
}): Promise<Array<any>>;
344345

345346
/**
@@ -397,13 +398,14 @@ export interface IAdminForthDataSourceConnectorBase extends IAdminForthDataSourc
397398

398399
getPrimaryKey(resource: AdminForthResource): string;
399400

400-
getData({ resource, limit, offset, sort, filters }: {
401+
getData({ resource, limit, offset, sort, filters, columns }: {
401402
resource: AdminForthResource,
402403
limit: number,
403404
offset: number,
404405
sort: IAdminForthSort[],
405406
filters: IAdminForthAndOrFilter,
406407
getTotals?: boolean,
408+
columns?: AdminForthResourceColumn[],
407409
}): Promise<{ data: Array<any>, total: number }>;
408410

409411
getRecordByPrimaryKey(resource: AdminForthResource, recordId: string): Promise<any>;

‎tests/application/index.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import cars_sl_dont_allow_delete_by_hook from './resources/cars_sl_dont_allow_de
2020

2121
import carsDescriptionImage from '../../dev-demo/resources/cars_description_image.js';
2222
import passkeysResource from '../../dev-demo/resources/passkeys.js';
23+
import polymorphicCarRefs from './resources/polymorphic_car_refs.js';
2324

2425
const ADMIN_BASE_URL = '';
2526
const appFilePath = fileURLToPath(import.meta.url);
@@ -95,6 +96,7 @@ export const admin = new AdminForth({
9596
cars_sl_dont_allow_delete_by_hook,
9697

9798
carsDescriptionImage,
99+
polymorphicCarRefs,
98100
passkeysResource
99101
],
100102
menu: [

‎tests/application/resources/adminuser.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ import usersResource from "../../../dev-demo/resources/adminuser.js";
33
export default {
44
...usersResource,
55
plugins: [
6-
...usersResource.plugins?.filter(p => p.className !== 'TwoFactorsAuthPlugin') || [],
6+
...usersResource.plugins?.filter((p) => ![
7+
'AdminForthAgentPlugin',
8+
'TwoFactorsAuthPlugin',
9+
].includes(p.className)) || [],
710
],
811
}

0 commit comments

Comments
 (0)