mirror of
https://github.com/datahub-project/datahub.git
synced 2025-08-12 03:07:05 +00:00
843a6c5bbb
* Releases updated version of datahub-web client UI code * Fix typo in yarn lock * Change yarn lock to match yarn registry directories * Previous commit missed some paths * Even more changes to yarnlock missing in previous commit * Include codegen file for typings * Add files to get parity for datahub-web and current OS datahub-midtier * Add in typo fix from previous commit - change to proper license * Implement proper OS fix for person entity picture url * Workarounds for open source DH issues * Fixes institutional memory api and removes unopensourced tabs for datasets * Fixes search dataset deprecation and user search issue as a result of changes * Remove internal only options in the avatar menu
94 lines
3.6 KiB
TypeScript
94 lines
3.6 KiB
TypeScript
import { datasetUrlById } from 'datahub-web/utils/api/datasets/shared';
|
|
import {
|
|
IDatasetColumn,
|
|
IDatasetColumnsGetResponse,
|
|
IDatasetColumnWithHtmlComments
|
|
} from 'datahub-web/typings/api/datasets/columns';
|
|
import { getJSON } from '@datahub/utils/api/fetcher';
|
|
import { ApiStatus } from '@datahub/utils/api/shared';
|
|
import { arrayMap } from '@datahub/utils/array/index';
|
|
import { renderLinksAsAnchorTags } from '@datahub/utils/helpers/render-links-as-anchor-tags';
|
|
|
|
// TODO: DSS-6122 Create and move to Error module
|
|
|
|
/**
|
|
* default exception string for columns api
|
|
* @type {string}
|
|
*/
|
|
const datasetColumnsException = 'An error occurred with the columns api';
|
|
|
|
/**
|
|
* Constructs a dataset column url using a dataset id
|
|
* @param {number} id the id of the dataset
|
|
* @return {string}
|
|
*/
|
|
const datasetColumnUrlById = (id: number): string => `${datasetUrlById(id)}/columns`;
|
|
|
|
/**
|
|
* Maps an object with a column prop to an object containing markdown comments, if the dataset has a comment attribute
|
|
* @template T
|
|
* @param {T} objectWithComment
|
|
* @returns {(T | T & {commentHtml: string})}
|
|
*/
|
|
const augmentWithHtmlComment = <T extends { comment: string }>(
|
|
objectWithComment: T
|
|
): T | (T & { commentHtml: string }) => {
|
|
const { comment } = objectWithComment;
|
|
// TODO: DSS-6122 Refactor global function reference to marked
|
|
// not using spread operator here: https://github.com/Microsoft/TypeScript/issues/10727
|
|
// current ts version: 2.5.3
|
|
return comment
|
|
? Object.assign({}, objectWithComment, { commentHtml: renderLinksAsAnchorTags([comment]) })
|
|
: objectWithComment;
|
|
};
|
|
|
|
/**
|
|
* Picks out the dataset dataType and fullFieldPath (as fieldName) properties
|
|
* @param {string} dataType string representing the data type of the field
|
|
* @param {string} fullFieldPath the path of the field on this dataset
|
|
* @return {Pick<IDatasetColumn, "dataType" | "fieldName">}
|
|
*/
|
|
const columnDataTypeAndFieldName = ({
|
|
dataType,
|
|
fullFieldPath
|
|
}: IDatasetColumn | IDatasetColumnWithHtmlComments): Pick<IDatasetColumn, 'dataType' | 'fieldName'> => ({
|
|
dataType,
|
|
fieldName: fullFieldPath
|
|
});
|
|
|
|
/**
|
|
* Takes a list of objects with comments and returns an array of objects with comments or html comments
|
|
* @type {(array: Array<T extends { comment: string } & Object>) => Array<T | T extends { commentHtml: string }>}
|
|
*/
|
|
const augmentObjectsWithHtmlComments = arrayMap<IDatasetColumn, IDatasetColumnWithHtmlComments | IDatasetColumn>(
|
|
augmentWithHtmlComment
|
|
);
|
|
|
|
/**
|
|
* Takes a list of IDatasetColumn / IDatasetColumn with html comments and pulls the dataType and and fullFieldPath (as fieldName) attributes
|
|
* @type {(array: Array<IDatasetColumn | IDatasetColumnWithHtmlComments>) => Array<Pick<IDatasetColumn, "dataType" | "fieldName">>}
|
|
*/
|
|
const columnDataTypesAndFieldNames = arrayMap(columnDataTypeAndFieldName);
|
|
|
|
/**
|
|
* Gets the dataset columns for a dataset with the id specified and the schemaless flag
|
|
* @param {number} id the id of the dataset
|
|
* @return {(Promise<{schemaless: boolean; columns: Array<IDatasetColumn>}>)}
|
|
*/
|
|
const readDatasetColumns = async (id: number): Promise<{ schemaless: boolean; columns: Array<IDatasetColumn> }> => {
|
|
const { status, columns = [], schemaless, message = datasetColumnsException } = await getJSON<
|
|
IDatasetColumnsGetResponse
|
|
>({
|
|
url: datasetColumnUrlById(id)
|
|
});
|
|
|
|
// Returns an empty list if the status is ok but the columns is falsey
|
|
if (status === ApiStatus.OK) {
|
|
return { schemaless, columns };
|
|
}
|
|
|
|
throw new Error(message);
|
|
};
|
|
|
|
export { readDatasetColumns, columnDataTypesAndFieldNames, augmentObjectsWithHtmlComments, datasetColumnUrlById };
|