All files / src/contracts/documents xml.ts

100% Statements 4/4
100% Branches 0/0
100% Functions 0/0
100% Lines 4/4

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                                            12x 12x   12x   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 { IDataSource, IDocument, IField } from '../common';
 
/**
 * The XML inspection data model contracts between frontend and backend.
 */
 
export const XML_MODEL_PACKAGE_PREFIX = 'io.atlasmap.xml.v2';
export const XML_DATA_SOURCE_JSON_TYPE =
  XML_MODEL_PACKAGE_PREFIX + '.XmlDataSource';
export const XML_ENUM_FIELD_JSON_TYPE =
  XML_MODEL_PACKAGE_PREFIX + '.XmlEnumField';
export const XML_INSPECTION_REQUEST_JSON_TYPE =
  XML_MODEL_PACKAGE_PREFIX + '.XmlInspectionRequest';
 
/**
 * The root object that carries {@link IXmlInspectionResponse}
 * when it's sent to backend.
 */
export interface IXmlInspectionResponseContainer {
  XmlInspectionResponse: IXmlInspectionResponse;
}
 
/**
 * The serialized XML inspection response.
 */
export interface IXmlInspectionResponse {
  xmlDocument: IXmlDocument;
  errorMessage?: string;
  executionTime?: number;
}
 
/**
 * The root object that carries {@link IXmlDocument}
 * when it's inspected with maven plugin.
 */
export interface IXmlDocumentContainer {
  XmlDocument: IXmlDocument;
}
 
/**
 * The serialized XML document in inspection result.
 */
export interface IXmlDocument extends IDocument {
  xmlNamespaces?: IXmlNamespaces;
}
 
/**
 * The serialized XML DataSource.
 * @see IXmlNamespaces
 */
export interface IXmlDataSource extends IDataSource {
  template?: string;
  xmlNamespaces?: IXmlNamespaces;
}
 
/**
 * The container of XML namespace.
 */
export interface IXmlNamespaces {
  xmlNamespace: IXmlNamespace[];
}
 
/**
 * The serialized XML namespace.
 */
export interface IXmlNamespace {
  alias: string;
  uri: string;
  locationUri?: string;
  targetNamespace: boolean;
}
 
/**
 * The serialized XML primitive field.
 */
export interface IXmlField extends IField {
  userCreated?: boolean;
  attribute?: boolean;
}
 
/**
 * The serialized XML complex field.
 */
export interface IXmlComplexType extends IField {
  xmlEnumFields?: IXmlEnumFields;
  xmlFields?: IXmlFields;
  annotation?: boolean;
  anonymous?: boolean;
  enumeration: boolean;
  uri?: string;
}
 
/**
 * The container of XML enum field.
 */
export interface IXmlEnumFields {
  xmlEnumField: IXmlEnumField[];
}
 
/**
 * The serialized XML enum field.
 */
export interface IXmlEnumField extends IField {
  ordinal: number;
  typeName: string;
  attribute: boolean;
  userCreated: boolean;
}
 
/**
 * The container of XML field.
 */
export interface IXmlFields {
  xmlField: IXmlField[];
}