@api-client/core 0.8.1 → 0.8.3

package/src/amf/shape/ShapeXmlSchemaGenerator.ts

@@ -12,7 +12,7 @@ interface IProcessNodeOptions {
 }
 
 interface ICollectExamplesOptions {
-  nodeName?: string; 
+  nodeName?: string;
   indent?: number;
   isWrapped?: boolean;
   tagFill?: string;
@@ -28,7 +28,7 @@ export const normalizeXmlTagName = (name: string): string => name.replace(/[^a-z
 const UNKNOWN_TYPE = 'unknown-type';
 
 export function shapeToXmlTagName(shape: IApiAnyShape): string {
-  const { name, inherits=[], xmlSerialization } = shape;
+  const { name, inherits = [], xmlSerialization } = shape;
   let label: string | undefined = xmlSerialization && xmlSerialization.name ? xmlSerialization.name : name || UNKNOWN_TYPE;
   if (label === 'schema' && inherits.length) {
     const n = inherits.find(i => i.name && i.name !== 'schema');
@@ -45,15 +45,15 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
    * 
    * @param schema The Shape definition
    */
-  generate(schema: IShapeUnion): string {
-    const value = this.processNode(schema);
+  generate(schema: IShapeUnion): string | undefined {
+    const value = this.processNode(schema, {}, true);
     return value;
   }
 
   /**
    * Processes the Shape definition and returns a JavaScript object or array.
    */
-  processNode(schema: IShapeUnion, options: IProcessNodeOptions = {}): string {
+  processNode(schema: IShapeUnion, options: IProcessNodeOptions = {}, isRoot = false): string | undefined {
     const { types } = schema;
     if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
       return this._scalarShapeObject(schema as IApiScalarShape, options);
@@ -74,7 +74,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       return this._tupleShapeObject();
     }
     if (types.includes(ns.aml.vocabularies.shapes.ArrayShape) || types.includes(ns.aml.vocabularies.shapes.MatrixShape)) {
-      return this._arrayShapeObject(schema as IApiArrayShape, options);
+      return this._arrayShapeObject(schema as IApiArrayShape, options, isRoot);
     }
     return this._anyShapeObject(schema as IApiAnyShape);
   }
@@ -82,8 +82,8 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
   /**
    * Serializes generated JS value according to the mime type.
    */
-  serialize(value: any): string|undefined {
-    return value;
+  serialize(value: unknown): string | undefined {
+    return value as string;
   }
 
   /**
@@ -99,9 +99,9 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     return collectNodeProperties(schema, selectedUnions);
   }
 
-  protected _nodeShapeObject(schema: IApiNodeShape, options: IProcessNodeOptions={}): string {
+  protected _nodeShapeObject(schema: IApiNodeShape, options: IProcessNodeOptions = {}): string {
     const label = options.forceName || shapeToXmlTagName(schema);
-    const parts = [];
+    const parts: string[] = [];
     const currentIndent = (options.indent || 0);
     const exampleValue = this._collectExamples(schema, {
       tagFill: new Array(currentIndent * 2 + 0).fill(' ').join(''),
@@ -114,7 +114,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     const attributes: string[] = [];
     const properties = this._collectProperties(schema);
     properties.forEach((property) => {
-      const { range, minCount=0 } = property;
+      const { range, minCount = 0 } = property;
       if (minCount === 0 && !this.opts.renderOptional || !range) {
         return;
       }
@@ -135,10 +135,14 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       }
       const value = this._propertyShapeObject(property, { indent: currentIndent });
       if (typeof value !== 'undefined') {
-        const fill = new Array(currentIndent * 2 + 2).fill(' ').join('');
+        const offset = options.noWrap ? 0 : 2;
+        const fill = new Array(currentIndent * 2 + offset).fill(' ').join('');
         parts.push(formatXmlValue(fill, value));
       }
     });
+    if (options.noWrap) {
+      return parts.join('\n');
+    }
 
     let opening = `<${label}`;
     if (attributes.length) {
@@ -146,12 +150,12 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       opening += attributes.join(' ');
     }
     parts.unshift(`${opening}>`);
-    const fill = new Array(currentIndent*2).fill(' ').join('');
+    const fill = new Array(currentIndent * 2).fill(' ').join('');
     parts.push(`${fill}</${label}>`);
     return parts.join('\n');
   }
 
-  protected _scalarShapeObject(schema: IApiScalarShape, options: IProcessNodeOptions={}): any {
+  protected _scalarShapeObject(schema: IApiScalarShape, options: IProcessNodeOptions = {}): string {
     const { xmlSerialization, defaultValue } = schema;
     let content;
     if (defaultValue) {
@@ -182,11 +186,11 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     parts.push(opening);
     parts.push(content);
     parts.push(`</${label}>`);
-    
+
     return parts.join('');
   }
 
-  protected _nilShapeObject(schema: IApiScalarShape, options: IProcessNodeOptions={}): any|undefined {
+  protected _nilShapeObject(schema: IApiScalarShape, options: IProcessNodeOptions = {}): string | undefined {
     const { xmlSerialization } = schema;
     const content = '';
     let label = options.forceName || shapeToXmlTagName(schema);
@@ -211,24 +215,24 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     parts.push(opening);
     parts.push(content);
     parts.push(`</${label}>`);
-    
+
     return parts.join('');
   }
 
   /**
    * @returns The value for the property or undefined when cannot generate the value.
    */
-  protected _propertyShapeObject(schema: IApiPropertyShape, options: IProcessNodeOptions = {}): string|undefined {
-    const { range, minCount=0 } = schema;
+  protected _propertyShapeObject(schema: IApiPropertyShape, options: IProcessNodeOptions = {}): string | undefined {
+    const { range, minCount = 0 } = schema;
     if (minCount === 0 && !this.opts.renderOptional || !range) {
       return undefined;
     }
     const { types } = range;
-    const name = shapeToXmlTagName(schema as IApiAnyShape);
     if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
       return this._scalarShapeObject(range as IApiScalarShape, { ...options });
-    } 
+    }
     if (types.includes(ns.aml.vocabularies.shapes.NilShape)) {
+      const name = shapeToXmlTagName(schema as IApiAnyShape);
       return this._nilShapeObject(range as IApiScalarShape, { ...options, forceName: name });
     }
     if (types.includes(ns.aml.vocabularies.shapes.RecursiveShape)) {
@@ -240,6 +244,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     if (types.includes(ns.aml.vocabularies.shapes.ArrayShape) || types.includes(ns.aml.vocabularies.shapes.MatrixShape)) {
       return this._nodePropertyArray(schema as IApiPropertyShape<IApiArrayShape>, options);
     }
+    const name = shapeToXmlTagName(schema as IApiAnyShape);
     return this.processNode(range, { ...options, forceName: name });
   }
 
@@ -247,15 +252,15 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     if (!this.opts.renderExamples) {
       return undefined;
     }
-    const { isWrapped, nodeName, tagFill='', indent = 0  } = opts;
-    let { examples=[] } = (schema as IApiAnyShape);
+    const { isWrapped, nodeName, tagFill = '', indent = 0 } = opts;
+    let { examples = [] } = (schema as IApiAnyShape);
     const { inherits } = schema;
     if (Array.isArray(inherits) && inherits.length) {
       inherits.forEach((parent) => {
         let node = parent;
         if (node.types.includes(ns.aml.vocabularies.shapes.UnionShape)) {
           const union = node as IApiUnionShape;
-          const { anyOf=[] } = union;
+          const { anyOf = [] } = union;
           node = this._readCurrentUnion(anyOf);
         }
         const anyShape = node as IApiAnyShape;
@@ -264,18 +269,19 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
         }
       });
     }
-    
+
     const validExamples = examples.filter(item => !!item.structuredValue);
     if (!validExamples.length) {
       return undefined;
     }
+    
     const parts: string[] = [];
     if (isWrapped) {
       parts.push(`${tagFill}<${nodeName}>`);
     }
     const generator = new XmlDataNodeGenerator();
     validExamples.forEach((item) => {
-      const value = generator.generate(item.structuredValue!, nodeName, {
+      const value = generator.generate(item.structuredValue as IApiDataNodeUnion, nodeName, {
         indent: indent + 1,
       });
       if (value !== undefined) {
@@ -285,6 +291,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     if (isWrapped) {
       parts.push(`${tagFill}</${nodeName}>`);
     }
+    
     return parts.join('\n');
   }
 
@@ -295,7 +302,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
   protected _nodePropertyObject(schema: IApiPropertyShape<IApiNodeShape>, options: IProcessNodeOptions = {}): string {
     const parts: string[] = [];
     const name = normalizeXmlTagName(String(schema.name));
-    const { indent=0 } = options;
+    const { indent = 0 } = options;
     const baseTabs = this._createTabs(indent);
     let value: string;
     const range = schema.range as IApiNodeShape;
@@ -310,14 +317,14 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     } else {
       const propertyParts: string[] = [];
       const properties = this._collectProperties(range);
-      
+
       properties.forEach((property) => {
-        const { range, minCount=0 } = property;
+        const { range, minCount = 0 } = property;
         if (minCount === 0 && !this.opts.renderOptional) {
           return;
         }
         const anyRange = range as IApiAnyShape;
-        
+
         if (anyRange.xmlSerialization) {
           const { prefix, attribute } = anyRange.xmlSerialization;
           if (attribute && anyRange.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
@@ -351,7 +358,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
   }
 
   protected _nodePropertyArray(schema: IApiPropertyShape<IApiArrayShape>, options: IProcessNodeOptions = {}): string {
-    const range = schema.range as IApiArrayShape;    
+    const range = schema.range as IApiArrayShape;
     const parts: string[] = [];
     let name: string;
     if (range.xmlSerialization && range.xmlSerialization.name) {
@@ -359,7 +366,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     } else {
       name = normalizeXmlTagName(String(schema.name));
     }
-    const { indent=0 } = options;
+    const { indent = 0 } = options;
     const isScalarItems = !!range.items && range.items.types.includes(ns.aml.vocabularies.shapes.ScalarShape);
 
     const baseTabs = this._createTabs(indent);
@@ -375,7 +382,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     return parts.join('\n');
   }
 
-  protected _arrayShapeObject(schema: IApiArrayShape, options: IProcessNodeOptions={}): string {
+  protected _arrayShapeObject(schema: IApiArrayShape, options: IProcessNodeOptions = {}, isRoot = false): string {
     const { items } = schema;
     const isScalarItems = !!items && items.types.includes(ns.aml.vocabularies.shapes.ScalarShape);
     // the name is either from the XML serialization info, or the parent property.
@@ -388,21 +395,30 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     //   nodeName = normalizeXmlTagName(items.name);
     // }
 
-    if (!isScalarItems && items?.name) {
+    if (isRoot && schema.xmlSerialization && schema.xmlSerialization.name) {
+      nodeName = normalizeXmlTagName(schema.xmlSerialization.name);
+    } else if (isRoot && schema.name) {
+      nodeName = normalizeXmlTagName(schema.name);
+    } else if (!isScalarItems && items?.name) {
       nodeName = normalizeXmlTagName(items.name);
     } else if (schema.name) {
       nodeName = normalizeXmlTagName(schema.name);
     }
+    
     // wrapping can only be defined on the array shape and it "wraps" the generated
     // content into an element that has the same name as the items
+    let hasWrapped = false;
+    if (schema.xmlSerialization && typeof schema.xmlSerialization.wrapped === 'boolean') {
+      hasWrapped = true;
+    }
     const isWrapped = !!schema.xmlSerialization && !!schema.xmlSerialization.wrapped;
-    
+
     const currentIndent = (options.indent || 0);
     const tagFill = new Array((currentIndent) * 2 + 0).fill(' ').join('');
     const valueFill = new Array((currentIndent) * 2 + (isWrapped ? 2 : 0)).fill(' ').join('');
     // let's start with examples
     if (this.opts.renderExamples) {
-      const { examples=[] } = schema;
+      const { examples = [] } = schema;
       const validExamples = examples.filter(item => !!item.structuredValue);
       if (validExamples.length) {
         const parts: string[] = [];
@@ -414,7 +430,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
           if (!nodeName && items?.name) {
             nodeName = normalizeXmlTagName(items.name);
           }
-          const value = generator.generate(example.structuredValue!, nodeName, {
+          const value = generator.generate(example.structuredValue as IApiDataNodeUnion, nodeName, {
             indent: currentIndent,
           });
           if (value !== undefined) {
@@ -422,7 +438,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
           }
         } else if (isScalarItems && isWrapped) {
           const [example] = validExamples;
-          const value = generator.generate(example.structuredValue!, nodeName, {
+          const value = generator.generate(example.structuredValue as IApiDataNodeUnion, nodeName, {
             indent: currentIndent,
           });
           parts.push(`${tagFill}<${nodeName}>`);
@@ -434,7 +450,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
           // when wrapped we wrap each example into the "name", else we render all examples under the "name".
           validExamples.forEach((item) => {
             parts.push(`${tagFill}<${nodeName}>`);
-            const value = generator.generate(item.structuredValue!, /* nodeName */ undefined, {
+            const value = generator.generate(item.structuredValue as IApiDataNodeUnion, /* nodeName */ undefined, {
               indent: currentIndent + 2,
             });
             if (value !== undefined) {
@@ -444,7 +460,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
           });
         } else {
           validExamples.forEach((item) => {
-            const value = generator.generate(item.structuredValue!, /* nodeName */ undefined, {
+            const value = generator.generate(item.structuredValue as IApiDataNodeUnion, /* nodeName */ undefined, {
               indent: currentIndent,
             });
             if (value !== undefined) {
@@ -455,7 +471,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
         return parts.join('\n');
       }
     }
-    
+
     if (isScalarItems && schema.defaultValue) {
       const gen = new XmlDataNodeGenerator();
       const value = gen.generate(schema.defaultValue);
@@ -476,6 +492,9 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       if (nodeName) {
         init.forceName = nodeName;
       }
+      if (!isRoot && (!hasWrapped || (hasWrapped && !isWrapped))) {
+        init.noWrap = true;
+      }
       const value = this.processNode(items, init);
       if (value !== undefined) {
         parts.push(`${valueFill}${value}`);
@@ -497,7 +516,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     //     return this._nodeItems(schema as IArrayShape<INodeShape>, options);
     //   }
     // }
-    
+
     // let label = shapeToXmlTagName(schema);
     // if (label === UNKNOWN_TYPE && isScalarItems) {
     //   // label = shapeToXmlTagName(items as IScalarShape);
@@ -593,7 +612,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     //     parts.push(`${fill}${value}`);
     //   }
     // }
-    
+
     // parts.push(`${rootFill}</${label}>`);
     // return parts.join('\n');
   }
@@ -605,7 +624,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
    * @param schema The array schema
    * @param options Processing options.
    */
-  protected _scalarItems(schema: IApiArrayShape<IApiScalarShape>, options: IProcessNodeOptions={}): string {
+  protected _scalarItems(schema: IApiArrayShape<IApiScalarShape>, options: IProcessNodeOptions = {}): string {
     const items = schema.items as IApiScalarShape;
     const currentIndent = (options.indent || 0);
     const tagFill = new Array(currentIndent * 2).fill(' ').join('');
@@ -619,7 +638,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
 
     // let's start with examples
     if (this.opts.renderExamples) {
-      let { examples=[] } = schema;
+      let { examples = [] } = schema;
       if (Array.isArray(items.examples)) {
         examples = examples.concat(items.examples);
       }
@@ -628,7 +647,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
         const parts: string[] = [];
         const generator = new XmlDataNodeGenerator();
         validExamples.forEach((item) => {
-          const value = generator.generate(item.structuredValue!, nodeName);
+          const value = generator.generate(item.structuredValue as IApiDataNodeUnion, nodeName);
           if (value !== undefined) {
             parts.push(`${tagFill}${value}`);
           }
@@ -636,7 +655,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
         return parts.join('\n');
       }
     }
-    
+
     // then the default value
     if (schema.defaultValue) {
       const generator = new XmlDataNodeGenerator();
@@ -645,7 +664,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
         return `${tagFill}${value}`;
       }
     }
-    
+
     // finally we generate stuff.
     const opts: IProcessNodeOptions = {
       indent: currentIndent + 1,
@@ -661,7 +680,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
    * @param schema The array shape with item that is NodeShape.
    * @param options Rendering options.
    */
-  protected _nodeItems(schema: IApiArrayShape<IApiNodeShape>, options: IProcessNodeOptions={}): string {
+  protected _nodeItems(schema: IApiArrayShape<IApiNodeShape>, options: IProcessNodeOptions = {}): string {
     const items = schema.items as IApiNodeShape;
     const currentIndent = (options.indent || 0);
     const tagFill = new Array(currentIndent * 2).fill(' ').join('');
@@ -685,7 +704,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
 
     // let's start with examples
     if (this.opts.renderExamples) {
-      let { examples=[] } = schema;
+      let { examples = [] } = schema;
       if (Array.isArray(items.examples)) {
         examples = examples.concat(items.examples);
       }
@@ -694,7 +713,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
         const parts: string[] = [];
         const generator = new XmlDataNodeGenerator();
         validExamples.forEach((item) => {
-          const value = generator.generate(item.structuredValue!, nodeName);
+          const value = generator.generate(item.structuredValue as IApiDataNodeUnion, nodeName);
           if (value !== undefined) {
             parts.push(`${tagFill}${value}`);
           }
@@ -710,7 +729,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
         parts.push(`${tagFill}${value}`);
         rendered = true;
       }
-    } 
+    }
     if (!rendered) {
       const properties = this._collectProperties(items);
       properties.forEach((prop) => {
@@ -729,7 +748,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
   /**
    * @param example The example to turn into a JS object
    */
-  protected _exampleToObject(example?: IApiDataExample): any {
+  protected _exampleToObject(example?: IApiDataExample): string | undefined {
     if (example && example.structuredValue) {
       const generator = new XmlDataNodeGenerator();
       return generator.generate(example.structuredValue);
@@ -737,8 +756,8 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     return undefined;
   }
 
-  protected _unionShapeObject(schema: IApiUnionShape, options: IProcessNodeOptions={}): any {
-    let { anyOf=[], examples=[] } = schema;
+  protected _unionShapeObject(schema: IApiUnionShape, options: IProcessNodeOptions = {}): string | undefined {
+    let { anyOf = [], examples = [] } = schema;
     if (Array.isArray(schema.inherits) && schema.inherits) {
       schema.inherits.forEach((parent) => {
         const anyParent = parent as IApiAnyShape;
@@ -763,7 +782,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       if (value !== undefined) {
         const label = shapeToXmlTagName(schema);
         const currentIndent = (options.indent || 0);
-        const rootFill = new Array(currentIndent*2).fill(' ').join('');
+        const rootFill = new Array(currentIndent * 2).fill(' ').join('');
         const valueFill = new Array(currentIndent * 2 + 2).fill(' ').join('');
         const parts = [];
         parts.push(`${rootFill}<${label}>`);
@@ -787,13 +806,13 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
    * @param schema The schema with unions
    * @param defaultValue The definition of a default value.
    */
-  protected _unionDefaultValue(schema: IShapeUnion, defaultValue: IApiDataNodeUnion, options: IProcessNodeOptions = {}): any|undefined {
+  protected _unionDefaultValue(schema: IShapeUnion, defaultValue: IApiDataNodeUnion, options: IProcessNodeOptions = {}): string | undefined {
     const gen = new XmlDataNodeGenerator();
     const value = gen.generate(defaultValue);
     const anySchema = schema as IApiAnyShape;
     const label = shapeToXmlTagName(anySchema);
     const currentIndent = (options.indent || 0);
-    const rootFill = new Array(currentIndent*2).fill(' ').join('');
+    const rootFill = new Array(currentIndent * 2).fill(' ').join('');
     const parts = [
       `${rootFill}<${label}>`
     ];
@@ -803,20 +822,20 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
     return parts.join('\n');
   }
 
-  protected _fileShapeObject(): any {
+  protected _fileShapeObject(): string | undefined {
     return undefined;
   }
 
-  protected _schemaShapeObject(): any {
+  protected _schemaShapeObject(): string | undefined {
     return undefined;
   }
 
-  protected _tupleShapeObject(): any {
+  protected _tupleShapeObject(): string | undefined {
     return undefined;
   }
 
-   protected _anyShapeObject(schema: IApiAnyShape): string {
-    const { and=[], xone=[], or=[] } = schema;
+  protected _anyShapeObject(schema: IApiAnyShape): string | undefined {
+    const { and = [], xone = [], or = [] } = schema;
     if (and.length) {
       // we combine all properties together under `schema` with changed properties
       const copy = JsonCore.clone(schema) as IApiNodeShape;
@@ -840,7 +859,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       return this._nodeShapeObject(copy);
     }
     if (xone.length) {
-      const { selectedUnions=[] } = this.opts;
+      const { selectedUnions = [] } = this.opts;
       let selected = xone.find(i => selectedUnions.includes(i.id));
       if (!selected) {
         // select firs available
@@ -849,7 +868,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       return this.processNode(selected);
     }
     if (or.length) {
-      const { selectedUnions=[] } = this.opts;
+      const { selectedUnions = [] } = this.opts;
       let selected = or.find(i => selectedUnions.includes(i.id));
       if (!selected) {
         // select firs available
@@ -857,7 +876,7 @@ export class ShapeXmlSchemaGenerator extends ShapeBase {
       }
       return this.processNode(selected);
     }
-    const { examples=[] } = schema;
+    const { examples = [] } = schema;
     const label = shapeToXmlTagName(schema);
     if (this.opts.renderExamples && examples && examples.length) {
       const example = examples.find((item) => !!item.structuredValue);