datahub/wherehows-web/app/constants/dataset-comments.ts

import { CommentTypeUnion } from 'wherehows-web/typings/api/datasets/comments';

/**
 * List of CrUD actions that can be performed on a stream comment
 */
type StreamCommentActionsUnion = 'create' | 'update' | 'destroy';

/**
 * List of CrUD actions that can be performed on the dataset stream
 */
type DatasetStreamActionsUnion = 'add' | 'modify' | 'destroy';

/**
 * Common options to pass to the editor component on instantiation
 * @type {object}
 */
const baseCommentEditorOptions = {
  disableDoubleReturn: true,
  disableExtraSpaces: true,
  disableEditing: true
};

/**
 * Options relevant to the new comment editor
 * @type {object}
 */
const newCommentEditorOptions = {
  placeholder: {
    text: 'Type here. You can format text by selecting it, and/or using keyboard shortcuts like cmd-b, e.t.c',
    hideOnClick: false
  }
};

/**
 * List of Dataset Comment types
 * @type {ReadonlyArray<CommentTypeUnion>}
 */
const CommentTypes: ReadonlyArray<CommentTypeUnion> = Object.freeze<CommentTypeUnion>([
  'Comment',
  'Question',
  'Description',
  'Partition',
  'ETL Schedule',
  'Grain',
  'DQ Issue'
]);

export {
  baseCommentEditorOptions,
  newCommentEditorOptions,
  CommentTypes,
  StreamCommentActionsUnion,
  DatasetStreamActionsUnion
};