All files / src/contracts/documents csv.ts

50% Statements 1/2
100% Branches 0/0
0% Functions 0/1
50% Lines 1/2

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164                                                                                                                                            12x                                                                                                                                                                                          
/*
    Copyright (C) 2017 Red Hat, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
            http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
 
import { IDocument, IField, IParameter } from '../common';
 
/**
 * The CSV inspection data model contracts between frontend and backend.
 */
 
/**
 * The root object that carries {@link ICsvInspectionResponse}
 * when it's received from backend.
 */
export interface ICsvInspectionResponseContainer {
  CsvInspectionResponse: ICsvInspectionResponse;
}
 
/**
 * The serialized CSV inspection response.
 */
export interface ICsvInspectionResponse {
  csvDocument: IDocument;
  errorMessage?: string;
  executionTime?: number;
}
 
/**
 * The root object that carries {@link ICsvDocument}
 * when it's inspected with maven plugin.
 */
export interface ICsvDocumentContainer {
  CsvDocument: IDocument;
}
 
/**
 * The serialized CSV complex field.
 */
export interface ICsvComplexType extends ICsvField {
  csvFields: ICsvFields;
  uri?: string;
}
 
/**
 * The serialized CSV primitive field.
 */
export interface ICsvField extends IField {
  column: number;
}
 
/**
 * The container of {@link ICsvField}.
 */
export interface ICsvFields {
  csvField: ICsvField[];
}
 
// TODO: Retrieve from the backend CSV module
export function getCsvParameterOptions(): IParameter[] {
  return [
    {
      name: 'format',
      label: 'CSV File Format',
      value: 'Default',
      options: [
        { label: 'Default', value: 'Default' },
        { label: 'Excel', value: 'Excel' },
        { label: 'InformixUnload', value: 'InformixUnload' },
        { label: 'InformixUnloadCsv', value: 'InformixUnloadCsv' },
        { label: 'MongoDBCsv', value: 'MongoDBCsv' },
        { label: 'MongoDBTsv', value: 'MongoDBTsv' },
        { label: 'MySQL', value: 'MySQL' },
        { label: 'Oracle', value: 'Oracle' },
        { label: 'PostgreSQLCsv', value: 'PostgreSQLCsv' },
        { label: 'PostgreSQLText', value: 'PostgreSQLText' },
        { label: 'RFC4180', value: 'RFC4180' },
        { label: 'TDF', value: 'TDF' },
      ],
      required: true,
    },
    {
      name: 'allowDuplicateHeaderNames',
      label: 'Allow Duplicate Header Names',
      value: 'true',
      boolean: true,
      required: false,
    },
    {
      name: 'allowMissingColumnNames',
      label: 'Allow Missing Column Names',
      value: 'true',
      boolean: true,
      required: false,
    },
    {
      name: 'commentMarker',
      label: 'Comment Marker',
      value: '',
      required: false,
    },
    {
      name: 'delimiter',
      label: 'Delimiter',
      value: '',
      required: false,
    },
    { name: 'escape', label: 'Escape', value: '', required: false },
    {
      name: 'firstRecordAsHeader',
      label: 'First Record As Header',
      value: 'true',
      boolean: true,
      required: false,
    },
    { name: 'headers', label: 'Headers', value: '', required: false },
    {
      name: 'ignoreEmptyLines',
      label: 'Ignore Empty Lines',
      value: 'true',
      boolean: true,
      required: false,
    },
    {
      name: 'ignoreHeaderCase',
      label: 'Ignore Header Case',
      value: 'true',
      boolean: true,
      required: false,
    },
    {
      name: 'ignoreSurroundingSpaces',
      label: 'Ignore Surrounding Spaces',
      value: 'true',
      boolean: true,
      required: false,
    },
    {
      name: 'nullString',
      label: 'Null String',
      value: '',
      required: false,
    },
    {
      name: 'skipHeaderRecord',
      label: 'Skip Header Record',
      value: 'true',
      boolean: true,
      required: false,
    },
  ];
}