All files / src/contracts common.ts

100% Statements 62/62
100% Branches 12/12
100% Functions 6/6
100% Lines 62/62

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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180                                18x   18x 18x     18x 18x 18x           18x 18x 18x 18x 18x 18x           18x 18x 18x 18x 18x 18x 18x           18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x     18x 18x 18x 18x 18x 18x 18x 18x 18x     18x 18x 18x 18x 18x                                                                                                                                                                
/*
    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.
*/
 
export const FIELD_PATH_SEPARATOR = '/';
 
export const MODEL_PACKAGE_PREFIX = 'io.atlasmap.v2';
export const DATA_SOURCE_JSON_TYPE = MODEL_PACKAGE_PREFIX + '.DataSource';
 
/** SOURCE or TARGET. */
export enum DataSourceType {
  SOURCE = 'SOURCE',
  TARGET = 'TARGET',
}
 
/**
 * The type of collection, such as {@link ARRAY} and {@link LIST}.
 */
export enum CollectionType {
  ALL = 'ALL',
  ARRAY = 'ARRAY',
  LIST = 'LIST',
  MAP = 'MAP',
  NONE = 'NONE',
}
 
/**
 * The field status held by {@link IField}.
 */
export enum FieldStatus {
  SUPPORTED = 'SUPPORTED',
  UNSUPPORTED = 'UNSUPPORTED',
  CACHED = 'CACHED',
  ERROR = 'ERROR',
  NOT_FOUND = 'NOT_FOUND',
  EXCLUDED = 'EXCLUDED',
}
 
/**
 * The field type held by {@link IField}.
 */
export enum FieldType {
  ANY = 'ANY',
  ANY_DATE = 'ANY_DATE',
  BIG_INTEGER = 'BIG_INTEGER',
  BOOLEAN = 'BOOLEAN',
  BYTE = 'BYTE',
  BYTE_ARRAY = 'BYTE_ARRAY',
  CHAR = 'CHAR',
  COMPLEX = 'COMPLEX',
  DATE = 'DATE',
  DATE_TIME = 'DATE_TIME',
  DATE_TIME_TZ = 'DATE_TIME_TZ',
  DATE_TZ = 'DATE_TZ',
  DECIMAL = 'DECIMAL',
  DOUBLE = 'DOUBLE',
  FLOAT = 'FLOAT',
  INTEGER = 'INTEGER',
  LONG = 'LONG',
  NONE = 'NONE',
  NUMBER = 'NUMBER',
  SHORT = 'SHORT',
  STRING = 'STRING',
  TIME = 'TIME',
  TIME_TZ = 'TIME_TZ',
  UNSIGNED_BYTE = 'UNSIGNED_BYTE',
  UNSIGNED_INTEGER = 'UNSIGNED_INTEGER',
  UNSIGNED_LONG = 'UNSIGNED_LONG',
  UNSIGNED_SHORT = 'UNSIGNED_SHORT',
  UNSUPPORTED = 'UNSUPPORTED',
}
 
export enum DocumentType {
  JAVA = 'JAVA',
  XML = 'XML',
  XSD = 'XSD',
  JSON = 'JSON',
  CORE = 'Core',
  CSV = 'CSV',
  CONSTANT = 'Constants',
  PROPERTY = 'Property',
}
 
export enum InspectionType {
  JAVA_CLASS = 'JAVA_CLASS',
  SCHEMA = 'SCHEMA',
  INSTANCE = 'INSTANCE',
  UNKNOWN = 'UNKNOWN',
}
 
/** The serialized DataSource held by {@link IAtlasMapping}. */
export interface IDataSource {
  id: string;
  name?: string;
  description?: string;
  uri: string;
  dataSourceType: DataSourceType;
  characterEncoding?: string;
  locale?: string;
  jsonType: string;
}
 
/**
 * The serialized CSV document inspection result.
 */
export interface IDocument {
  fields: IFields;
}
 
/**
 * The container of {@link IField}.
 */
export interface IFields {
  field: IField[];
}
 
/**
 * The field in the mapping.
 */
export interface IField {
  actions?: IFieldAction[];
  value?: string;
  arrayDimensions?: number;
  arraySize?: number;
  collectionType?: CollectionType;
  docId?: string;
  index?: number;
  path?: string;
  required?: boolean;
  status?: FieldStatus;
  fieldType?: FieldType;
  format?: string;
  name?: string;
  jsonType: string;
}
 
/**
 * The field action, aka transformation in the mapping.
 */
export interface IFieldAction {
  '@type'?: string;
  displayName?: string;
  [x: string]: any;
}
 
export interface IStringList {
  string: string[];
}
 
export interface IParameterOption {
  label: string;
  value: string;
}
 
export interface IParameter {
  name: string;
  label: string;
  value: string;
  boolean?: boolean;
  options?: IParameterOption[];
  enabled?: boolean;
  required?: boolean;
}
 
export interface IStringContainer {
  String: string;
}