datahub/datahub-web/packages/data-portal/app/utils/api/datasets/schema-comments.ts

import { IDatasetComment, IDatasetCommentsGetResponse } from 'datahub-web/typings/api/datasets/comments';
import { datasetColumnUrlById } from 'datahub-web/utils/api/datasets/columns';
import { ApiStatus } from '@datahub/utils/api/shared';
import { getJSON, postJSON, deleteJSON, putJSON } from '@datahub/utils/api/fetcher';
import { IDatasetSchemaCommentResponse } from 'datahub-web/typings/api/datasets/schema-comments';

/**
 *
 * @param {number} datasetId
 * @param {number} columnId
 */
const datasetSchemaCommentUrlById = (datasetId: number, columnId: number): string =>
  `${datasetColumnUrlById(datasetId)}/${columnId}/comments`;

/**
 *
 * @param {number} datasetId
 * @param {number} columnId
 * @return {Promise<Array<IDatasetComment>>}
 */
const readDatasetSchemaComments = async (datasetId: number, columnId: number): Promise<Array<IDatasetComment>> => {
  const defaultData: { comments: Array<IDatasetComment> } = { comments: [] };
  const { status, data: { comments = [] } = defaultData } = await getJSON<IDatasetCommentsGetResponse>({
    url: datasetSchemaCommentUrlById(datasetId, columnId)
  });

  if (status === ApiStatus.OK) {
    return comments;
  }

  throw new Error('');
};

const createDatasetSchemaComment = async (datasetId: number, columnId: number, comment: string): Promise<void> => {
  const { status } = await postJSON<IDatasetSchemaCommentResponse>({
    url: datasetSchemaCommentUrlById(datasetId, columnId),
    data: { comment }
  });

  if (status !== ApiStatus.OK) {
    throw new Error();
  }
};

const deleteDatasetSchemaComment = async (datasetId: number, columnId: number): Promise<void> => {
  const { status } = await deleteJSON<IDatasetSchemaCommentResponse>({
    url: datasetSchemaCommentUrlById(datasetId, columnId)
  });

  if (status !== ApiStatus.OK) {
    throw new Error();
  }
};

const updateDatasetSchemaComment = async (datasetId: number, columnId: number, comment: string): Promise<void> => {
  const { status } = await putJSON<IDatasetSchemaCommentResponse>({
    url: datasetSchemaCommentUrlById(datasetId, columnId),
    data: { comment }
  });

  if (status !== ApiStatus.OK) {
    throw new Error();
  }
};

export {
  readDatasetSchemaComments,
  createDatasetSchemaComment,
  deleteDatasetSchemaComment,
  updateDatasetSchemaComment
};