admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Import v2 - add label for subfield in csv export (#12355)

Browse Source 
To test : Export companies record - "Domain Name PrimaryLinkUrl" >>
"Domain Name / Link URL"

closes https://github.com/twentyhq/core-team-issues/issues/907
This commit is contained in:
Etienne
2025-06-02 17:21:44 +02:00
committed by GitHub
parent dc205370df
commit e71aef5a3a
4 changed files with 151 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
packages/twenty-front/src/modules/object-record/record-index/export/hooks/__tests__/useExportRecords.test.ts
View File

@ -1,7 +1,10 @@
import { FieldMetadata } from '@/object-record/record-field/types/FieldMetadata';
import { ColumnDefinition } from '@/object-record/record-table/types/ColumnDefinition';
import { RelationDefinitionType } from '~/generated-metadata/graphql';
import {
FieldMetadataType,
RelationDefinitionType,
} from '~/generated-metadata/graphql';
import { displayedExportProgress, generateCsv } from '../useExportRecords';
jest.useFakeTimers();
@ -11,7 +14,11 @@ describe('generateCsv', () => {
const columns = [
{ label: 'Foo', metadata: { fieldName: 'foo' } },
{ label: 'Empty', metadata: { fieldName: 'empty' } },
{ label: 'Nested', metadata: { fieldName: 'nested' } },
{
label: 'Nested link field',
type: FieldMetadataType.LINKS,
metadata: { fieldName: 'nestedLinkField' },
},
{
label: 'Relation',
metadata: {
@ -26,13 +33,21 @@ describe('generateCsv', () => {
bar: 'another field',
empty: null,
foo: 'some field',
nested: { __typename: 'type', foo: 'foo', nested: 'nested' },
nestedLinkField: {
__typename: 'Links',
primaryLinkUrl: 'https://www.test.com',
secondaryLinks: [
{ label: 'secondary link 1', url: 'https://www.test.com' },
{ label: 'secondary link 2', url: 'https://www.test.com' },
],
},
relation: 'a relation',
},
];
const csv = generateCsv({ columns, rows });
expect(csv).toEqual(`Id,Foo,Empty,Nested Foo,Nested Nested,Relation
1,some field,,foo,nested,a relation`);
expect(csv)
.toEqual(`Id,Foo,Empty,Nested link field / Link URL,Nested link field / Secondary Links,Relation
1,some field,,https://www.test.com,"[{""label"":""secondary link 1"",""url"":""https://www.test.com""},{""label"":""secondary link 2"",""url"":""https://www.test.com""}]",a relation`);
});
});

39
packages/twenty-front/src/modules/object-record/record-index/export/hooks/useExportRecords.ts
View File

@ -1,6 +1,7 @@
import { json2csv } from 'json-2-csv';
import { useMemo } from 'react';
import { isCompositeFieldType } from '@/object-record/object-filter-dropdown/utils/isCompositeFieldType';
import { EXPORT_TABLE_DATA_DEFAULT_PAGE_SIZE } from '@/object-record/object-options-dropdown/constants/ExportTableDataDefaultPageSize';
import { useExportProcessRecordsForCSV } from '@/object-record/object-options-dropdown/hooks/useExportProcessRecordsForCSV';
import { FieldMetadata } from '@/object-record/record-field/types/FieldMetadata';
@ -10,16 +11,17 @@ import {
} from '@/object-record/record-index/export/hooks/useExportFetchRecords';
import { ColumnDefinition } from '@/object-record/record-table/types/ColumnDefinition';
import { ObjectRecord } from '@/object-record/types/ObjectRecord';
import { COMPOSITE_FIELD_SUB_FIELD_LABELS } from '@/settings/data-model/constants/CompositeFieldSubFieldLabel';
import { t } from '@lingui/core/macro';
import { saveAs } from 'file-saver';
import { isDefined } from 'twenty-shared/utils';
import { RelationDefinitionType } from '~/generated-metadata/graphql';
import { FieldMetadataType } from '~/generated/graphql';
import { isUndefinedOrNull } from '~/utils/isUndefinedOrNull';
import { isDefined } from 'twenty-shared/utils';
type GenerateExportOptions = {
columns: ColumnDefinition<FieldMetadata>[];
rows: object[];
rows: Record<string, any>[];
};
type GenerateExport = (data: GenerateExportOptions) => string;
@ -62,31 +64,20 @@ export const generateCsv: GenerateExport = ({
.join(' '),
};
const fieldsWithSubFields = rows.find((row) => {
const fieldValue = (row as any)[column.field];
const columnType = col.type;
if (!isCompositeFieldType(columnType)) return [column];
const hasSubFields =
fieldValue &&
typeof fieldValue === 'object' &&
!Array.isArray(fieldValue);
return hasSubFields;
});
if (isDefined(fieldsWithSubFields)) {
const nestedFieldsWithoutTypename = Object.keys(
(fieldsWithSubFields as any)[column.field],
)
.filter((key) => key !== '__typename')
.map((key) => ({
const nestedFieldsWithoutTypename = Object.keys(rows[0][column.field])
.filter((key) => key !== '__typename')
.map((key) => {
const subFieldLabel = COMPOSITE_FIELD_SUB_FIELD_LABELS[columnType][key];
return {
field: `${column.field}.${key}`,
title: `${column.title} ${key[0].toUpperCase() + key.slice(1)}`,
}));
title: `${column.title} / ${subFieldLabel}`,
};
});
return nestedFieldsWithoutTypename;
}
return [column];
return nestedFieldsWithoutTypename;
});
return json2csv(rows, {