Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import {
downloadJSONDataFromGuppy,
GuppyDownloadDataParams,
} from '@gen3/core';
import { handleDownload } from './utils';
import { jsonToCsv } from '../utils/jsonToCsv';

export interface DownloadTabularParams {
resourceIndexType: string;
fileFields: string[];
type: string;
filter?: any;
filename?: string;
accessibility?: any;
sort?: any;
}

export const downloadTabularAction = async (
params: DownloadTabularParams,
done?: () => void,
onError?: (error: Error) => void,
onAbort?: () => void,
signal?: AbortSignal,
): Promise<void> => {
const { resourceIndexType, fileFields, type, filter, accessibility, sort, filename } = params;
const downloadFilename = filename ?? `${type}_export.csv`;

const cohortFilterParams: GuppyDownloadDataParams = {
filter,
type: resourceIndexType || type,
fields: fileFields,
accessibility,
sort,
format: 'json',
};

try {
const data = await downloadJSONDataFromGuppy({
parameters: cohortFilterParams,
onAbort,
signal,
});

if (!data?.length) {
throw new Error('no data found for the current filters');
}

const csv = jsonToCsv(data);
const blob = new Blob([csv], { type: 'text/csv;charset=utf-8' });
handleDownload(blob, downloadFilename);

if (done) done();
} catch (err) {
const resultErr = err instanceof Error
? err
: typeof err === 'string'
? new Error(err)
: new Error('unknown error in download tabular data');

if (onError) onError(resultErr);
}
};
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
} from '../../types';
import { downloadToFileAction } from './downloadToFile';
import { downloadToManifestAction } from './downloadManifest';
import { downloadTabularAction } from './downloadTabular';

// create a factory for the action creators

Expand Down Expand Up @@ -62,6 +63,10 @@ export const registerDefaultButtonActions = () => {
action: downloadToManifestAction,
args: { format: 'manifest' },
});
registerButtonAction('data-table', {
action: downloadTabularAction,
args: { format: 'csv' },
});
};

registerDefaultButtonActions();
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
export const jsonToCsv = (data: Record<string, any>[]): string => {
if (!data?.length) return '';
const headers = [...new Set(data.flatMap(Object.keys))];

const escape = (val: any): string => {
if (val == null) return '';
const str = String(val);
// wrap in quotes if comma, quote, or newline (csv data syntax edge cases)
return /[,"\n]/.test(str) ? `"${str.replace(/"/g, '""')}"` : str;
};

return [
headers.map(escape).join(','),
...data.map(row => headers.map(h => escape(row[h])).join(','))
].join('\n');
};