@api-client/core 0.7.11 → 0.8.0

package/src/amf/AmfShapeGenerator.ts

@@ -2,9 +2,9 @@ import { IPropertyBindings, IPropertySchema, IPropertyWebBindings } from "../mod
 import { DataAssociation } from "../models/data/DataAssociation.js";
 import { DataEntity } from "../models/data/DataEntity.js";
 import { DataProperty } from "../models/data/DataProperty.js";
-import { ExampleTypes, modelTypeToAmfDataType } from "./AmfTypes.js";
+import { IAmfExampleTypes, modelTypeToAmfDataType } from "./AmfTypes.js";
 import { AmfNamespace } from "./definitions/Namespace.js";
-import { anyShape, arrayShape, fileShape, IAnyShape, IArrayShape, IDataExample, IFileShape, INodeShape, IPropertyShape, IRecursiveShape, IScalarShape, IShape, IShapeUnion, nodeShape, propertyShape, recursiveShape, scalarShape, unionShape } from "./definitions/Shapes.js";
+import { anyShape, arrayShape, fileShape, IApiAnyShape, IApiArrayShape, IApiDataExample, IApiFileShape, IApiNodeShape, IApiPropertyShape, IApiRecursiveShape, IApiScalarShape, IApiShape, IShapeUnion, nodeShape, propertyShape, recursiveShape, scalarShape, unionShape } from "./definitions/Shapes.js";
 import { AmfDataNode } from "./models/AmfDataNode.js";
 import v4 from '../lib/uuid.js';
 
@@ -18,7 +18,7 @@ export class AmfShapeGenerator {
    * @param input The Property to serialize.
    * @param generatedEntities The list keys of already generated entities. This prohibits recursive shape generation.
    */
-  entity(input: DataEntity, generatedEntities: string[] = []): INodeShape | IRecursiveShape {
+  entity(input: DataEntity, generatedEntities: string[] = []): IApiNodeShape | IApiRecursiveShape {
     // const adapted = input.readAdapted();
     if (generatedEntities.includes(input.key)) {
       // create a recursive shape.
@@ -59,7 +59,7 @@ export class AmfShapeGenerator {
    * 
    * @param input The Property to serialize.
    */
-  property(input: DataProperty): IPropertyShape {
+  property(input: DataProperty): IApiPropertyShape {
     const { required, key } = input;
     const result = propertyShape(key);
     result.path = `${AmfNamespace.aml.vocabularies.data.key}${input.info.name}`;
@@ -84,7 +84,7 @@ export class AmfShapeGenerator {
    * 
    * @param input The Property to serialize.
    */
-  associationProperty(input: DataAssociation, generatedEntities: string[] = []): IPropertyShape {
+  associationProperty(input: DataAssociation, generatedEntities: string[] = []): IApiPropertyShape {
     const { required, key } = input;
     const result = propertyShape(key);
     result.path = `${AmfNamespace.aml.vocabularies.data.key}${input.info.name}`;
@@ -104,7 +104,7 @@ export class AmfShapeGenerator {
    */
   associationShape(input: DataAssociation, generatedEntities: string[] = []): IShapeUnion | undefined {
     const adapted = input.readAdapted();
-    let schema = adapted && adapted.schema;
+    const schema = adapted && adapted.schema;
     if (schema && schema.linked) {
       // This is a link to the schema. In an API that would be the id
       // of a resource to request the data from.
@@ -172,7 +172,7 @@ export class AmfShapeGenerator {
    * @param input 
    * @returns 
    */
-  protected _readPropertyRange(input: DataProperty): IArrayShape | IFileShape | IScalarShape {
+  protected _readPropertyRange(input: DataProperty): IApiArrayShape | IApiFileShape | IApiScalarShape {
     const adapted = input.readAdapted();
     let bindings: IPropertyWebBindings | undefined;
     let schema: IPropertySchema | undefined;
@@ -188,7 +188,7 @@ export class AmfShapeGenerator {
     return this._createAmfSchema(input, schema, bindings);
   }
 
-  protected _createAmfSchema(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IArrayShape | IFileShape | IScalarShape {
+  protected _createAmfSchema(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IApiArrayShape | IApiFileShape | IApiScalarShape {
     const { multiple, type } = input;
     if (multiple) {
       return this._generateArrayShape(input, schema, bindings);
@@ -208,7 +208,7 @@ export class AmfShapeGenerator {
    * @param type The data type of the parent property as set on the `range`
    * @param isArray Whether the DataProperty is multiple
    */
-  protected _setShapeSchema(result: IAnyShape, schema: IPropertySchema, type: string, isArray?: boolean): void {
+  protected _setShapeSchema(result: IApiAnyShape, schema: IPropertySchema, type: string, isArray?: boolean): void {
     if (schema.defaultValue) {
       const dt = AmfDataNode.scalar(schema.defaultValue, type);
       result.defaultValue = dt.toJSON();
@@ -225,7 +225,7 @@ export class AmfShapeGenerator {
     }
   }
 
-  protected _generateArrayShape(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IArrayShape {
+  protected _generateArrayShape(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IApiArrayShape {
     const result = arrayShape(input.key);
     const { type } = input;
     if (type === 'binary') {
@@ -235,13 +235,13 @@ export class AmfShapeGenerator {
       result.items = this._generateScalarShape(input, undefined, bindings);
     }
     if (schema) {
-      const type = (result.items as IScalarShape).dataType as string;
+      const type = (result.items as IApiScalarShape).dataType as string;
       this._setShapeSchema(result, schema, type, input.multiple);
     }
     return result;
   }
 
-  protected _generateScalarShape(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IScalarShape {
+  protected _generateScalarShape(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IApiScalarShape {
     const result = scalarShape(input.key);
     this._updateBaseProperties(input, result);
     if (bindings) {
@@ -259,26 +259,26 @@ export class AmfShapeGenerator {
     return result;
   }
 
-  protected _generateExamples(examples: string[], type: string): IDataExample[] {
+  protected _generateExamples(examples: string[], type: string): IApiDataExample[] {
     return examples.map((current) => {
       const value = AmfDataNode.scalar(current, type).toJSON();
-      const item: IDataExample = {
+      const item: IApiDataExample = {
         id: v4(),
         customDomainProperties: [],
         strict: true,
-        types: ExampleTypes,
+        types: IAmfExampleTypes,
         structuredValue: value,
       };
       return item;
     });
   }
 
-  protected _generateArrayExamples(examples: string[], type: string): IDataExample[] {
-    const item: IDataExample = {
+  protected _generateArrayExamples(examples: string[], type: string): IApiDataExample[] {
+    const item: IApiDataExample = {
       id: v4(),
       customDomainProperties: [],
       strict: true,
-      types: ExampleTypes,
+      types: IAmfExampleTypes,
     };
     const value = new AmfDataNode('array');
     examples.forEach((item) => {
@@ -289,7 +289,7 @@ export class AmfShapeGenerator {
     return [item];
   }
 
-  protected _generateFileShape(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IFileShape {
+  protected _generateFileShape(input: DataProperty, schema?: IPropertySchema, bindings?: IPropertyWebBindings): IApiFileShape {
     if (bindings && bindings.dataType === AmfNamespace.w3.xmlSchema.base64Binary) {
       // this is a binary format of a string shape
     }
@@ -304,7 +304,7 @@ export class AmfShapeGenerator {
     return result;
   }
 
-  protected _fillScalarShapeCommonProperties(result: IFileShape | IScalarShape, input: DataProperty, bindings: IPropertyWebBindings): void {
+  protected _fillScalarShapeCommonProperties(result: IApiFileShape | IApiScalarShape, input: DataProperty, bindings: IPropertyWebBindings): void {
     if (bindings.name) {
       result.name = bindings.name;
     }
@@ -346,7 +346,7 @@ export class AmfShapeGenerator {
     }
   }
 
-  protected _updateBaseProperties(input: DataProperty | DataAssociation | DataEntity, target: IShape): void {
+  protected _updateBaseProperties(input: DataProperty | DataAssociation | DataEntity, target: IApiShape): void {
     const adopted = input.readAdapted();
     if (adopted && adopted.info.name) {
       target.name = adopted.info.name;
@@ -370,7 +370,7 @@ export class AmfShapeGenerator {
     }
   }
 
-  protected _recursiveShape(input: DataEntity): IRecursiveShape {
+  protected _recursiveShape(input: DataEntity): IApiRecursiveShape {
     return recursiveShape(input.key, input.key);
   }
 
@@ -380,7 +380,7 @@ export class AmfShapeGenerator {
    * @param array The source array.
    * @returns The definition of the `items` of the array.
    */
-  refactorArrayToShape(array: IArrayShape): IShapeUnion {
+  refactorArrayToShape(array: IApiArrayShape): IShapeUnion {
     const { items } = array;
     return items!;
   }
@@ -392,7 +392,7 @@ export class AmfShapeGenerator {
    * @param shape The shape to wrap as an array.
    * @returns Array shape.
    */
-  refactorShapeToArray(id: string, shape: IShapeUnion): IArrayShape {
+  refactorShapeToArray(id: string, shape: IShapeUnion): IApiArrayShape {
     const result = arrayShape(id);
     result.items = shape;
     return result;

package/src/amf/AmfTypes.ts

@@ -2,67 +2,67 @@ import { DataPropertyType } from "../models/data/DataProperty.js";
 import { IPropertyWebBindings } from "../models/data/Bindings.js";
 import { AmfNamespace } from "./definitions/Namespace.js";
 
-export const ScalarTypes = [
+export const IAmfScalarTypes = [
   AmfNamespace.aml.vocabularies.shapes.ScalarShape,
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const ArrayTypes = [
+export const IAmfArrayTypes = [
   AmfNamespace.aml.vocabularies.shapes.ArrayShape,
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const NodeTypes = [
+export const IAmfNodeTypes = [
   AmfNamespace.w3.shacl.NodeShape,
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const PropertyTypes = [
+export const IAmfPropertyTypes = [
   AmfNamespace.w3.shacl.PropertyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const NilTypes = [
+export const IAmfNilTypes = [
   AmfNamespace.aml.vocabularies.shapes.NilShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const UnionTypes = [
+export const IAmfUnionTypes = [
   AmfNamespace.aml.vocabularies.shapes.UnionShape,
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const FileTypes = [
+export const IAmfFileTypes = [
   AmfNamespace.aml.vocabularies.shapes.FileShape,
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const AnyTypes = [
+export const IAmfAnyTypes = [
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const SchemaTypes = [
+export const IAmfSchemaTypes = [
   AmfNamespace.aml.vocabularies.shapes.SchemaShape,
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const TupleTypes = [
+export const IAmfTupleTypes = [
   AmfNamespace.aml.vocabularies.shapes.TupleShape,
   AmfNamespace.aml.vocabularies.shapes.ArrayShape,
   AmfNamespace.aml.vocabularies.shapes.AnyShape,
@@ -70,34 +70,34 @@ export const TupleTypes = [
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const RecursiveTypes = [
+export const IAmfRecursiveTypes = [
   AmfNamespace.aml.vocabularies.shapes.RecursiveShape,
   AmfNamespace.w3.shacl.Shape,
   AmfNamespace.aml.vocabularies.shapes.Shape,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const XmlSerializationTypes = [
+export const IAmfXmlSerializationTypes = [
   AmfNamespace.aml.vocabularies.shapes.XMLSerializer,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
 
-export const ScalarNodeTypes = [
+export const IAmfScalarNodeTypes = [
   AmfNamespace.aml.vocabularies.data.Scalar,
   AmfNamespace.aml.vocabularies.data.Node,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const ArrayNodeTypes = [
+export const IAmfArrayNodeTypes = [
   AmfNamespace.aml.vocabularies.data.Array,
   AmfNamespace.w3.rdfSchema.Seq,
   AmfNamespace.aml.vocabularies.data.Node,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const ObjectNodeTypes = [
+export const IAmfObjectNodeTypes = [
   AmfNamespace.aml.vocabularies.data.Object,
   AmfNamespace.aml.vocabularies.data.Node,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];
-export const ExampleTypes = [
+export const IAmfExampleTypes = [
   AmfNamespace.aml.vocabularies.apiContract.Example,
   AmfNamespace.aml.vocabularies.document.DomainElement,
 ];

package/src/amf/ApiExampleGenerator.ts

@@ -3,7 +3,7 @@ import { JsonDataNodeGenerator } from './data-node/JsonDataNodeGenerator.js';
 import { XmlDataNodeGenerator } from './data-node/XmlDataNodeGenerator.js';
 import { UrlEncodedDataNodeGenerator } from './data-node/UrlEncodedDataNodeGenerator.js';
 import { formatXmlValue } from './Utils.js';
-import { IArrayShape, IDataExample, IDataNode, IShapeUnion } from "./definitions/Shapes.js";
+import { IApiArrayShape, IApiDataExample, IApiDataNode, IShapeUnion } from "./definitions/Shapes.js";
 
 /**
  * A class that processes AMF's Example object to read the example value
@@ -19,7 +19,7 @@ export class ApiExampleGenerator {
    * @param shape The optional shape containing this example to use with the XML examples which needs wrapping into an element.
    * @returns The read or generated example.
    */
-  read(example: IDataExample, mime?: string, shape?: IShapeUnion): string | undefined {
+  read(example: IApiDataExample, mime?: string, shape?: IShapeUnion): string | undefined {
     const { value, structuredValue } = example;
     if (!value && !structuredValue) {
       return undefined;
@@ -67,7 +67,7 @@ export class ApiExampleGenerator {
    * @param shape The optional shape containing this example to use with the XML examples which needs wrapping into an element.
    * @returns The generated example or null if couldn't process the data.
    */
-  fromStructuredValue(mime: string, structuredValue: IDataNode, shape?: IShapeUnion): string | undefined {
+  fromStructuredValue(mime: string, structuredValue: IApiDataNode, shape?: IShapeUnion): string | undefined {
     if (mime.includes('json')) {
       const generator = new JsonDataNodeGenerator();
       return generator.generate(structuredValue);
@@ -76,7 +76,7 @@ export class ApiExampleGenerator {
     if (shape && shape.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
       shapeName = shape.name;
     } else if (shape && shape.types.includes(ns.aml.vocabularies.shapes.ArrayShape)) {
-      const typed = shape as IArrayShape;
+      const typed = shape as IApiArrayShape;
       if (typed.items && typed.items.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
         shapeName = typed.items.name || shape.name;
       }

package/src/amf/ApiMonacoSchemaGenerator.ts

@@ -1,5 +1,5 @@
 import { AmfNamespace as ns } from "./definitions/Namespace.js";
-import { IArrayShape, INodeShape, IPropertyShape, IScalarNode, IScalarShape, IShapeUnion } from "./definitions/Shapes.js";
+import { IApiArrayShape, IApiNodeShape, IApiPropertyShape, IApiScalarNode, IApiScalarShape, IShapeUnion } from "./definitions/Shapes.js";
 import { collectNodeProperties } from './Utils.js';
 
 export interface IMonacoSchema {
@@ -73,7 +73,7 @@ export class ApiMonacoSchemaGenerator {
     }
     const { types } = schema;
     if (types.includes(ns.w3.shacl.NodeShape)) {
-      return this.fromNodeShape(schema as INodeShape, parentUri);
+      return this.fromNodeShape(schema as IApiNodeShape, parentUri);
     }
     return [];
   }
@@ -81,7 +81,7 @@ export class ApiMonacoSchemaGenerator {
   /**
    * @param parentUri The URI for the fileMatch property.
    */
-  fromNodeShape(schema: INodeShape, parentUri?: string): IMonacoSchema[] {
+  fromNodeShape(schema: IApiNodeShape, parentUri?: string): IMonacoSchema[] {
     const { id, name } = schema;
     const properties = collectNodeProperties(schema);
     const content: IMonacoObjectProperty = {
@@ -105,7 +105,7 @@ export class ApiMonacoSchemaGenerator {
     return this.schemas;
   }
 
-  appendSchemaProperty(content: IMonacoObjectProperty, property: IPropertyShape): void {
+  appendSchemaProperty(content: IMonacoObjectProperty, property: IApiPropertyShape): void {
     const { name, range, minCount } = property;
     if (!range) {
       return;
@@ -122,18 +122,18 @@ export class ApiMonacoSchemaGenerator {
   rangeToPropertySchema(range: IShapeUnion): IMonacoScalarProperty | IMonacoObjectProperty | IMonacoArrayProperty | undefined {
     const { types } = range;
     if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-      return this.scalarRangeToPropertySchema(range as IScalarShape);
+      return this.scalarRangeToPropertySchema(range as IApiScalarShape);
     }
     if (types.includes(ns.w3.shacl.NodeShape)) {
-      return this.nodeShapeRangeToPropertySchema(range as INodeShape);
+      return this.nodeShapeRangeToPropertySchema(range as IApiNodeShape);
     }
     if (types.includes(ns.aml.vocabularies.shapes.ArrayShape)) {
-      return this.arrayShapeRangeToPropertySchema(range as IArrayShape);
+      return this.arrayShapeRangeToPropertySchema(range as IApiArrayShape);
     }
     return undefined;
   }
 
-  scalarRangeToPropertySchema(schema: IScalarShape): IMonacoScalarProperty {
+  scalarRangeToPropertySchema(schema: IApiScalarShape): IMonacoScalarProperty {
     const { values, description, name, displayName, defaultValueStr, exclusiveMaximum, exclusiveMinimum, minimum, maximum, minLength, maxLength, id, multipleOf, pattern, readOnly, writeOnly } = schema;
     const type = this.schemaTypeToJsonDataType(schema.dataType);
     const result: IMonacoScalarProperty = {
@@ -189,7 +189,7 @@ export class ApiMonacoSchemaGenerator {
       values.forEach((value) => {
         const { types } = value;
         if (types.includes(ns.aml.vocabularies.data.Scalar)) {
-          const typed = value as IScalarNode;
+          const typed = value as IApiScalarNode;
           if (typed.value) {
             result.enum!.push(typed.value);
           }
@@ -222,7 +222,7 @@ export class ApiMonacoSchemaGenerator {
     }
   }
 
-  nodeShapeRangeToPropertySchema(schema: INodeShape): IMonacoObjectProperty {
+  nodeShapeRangeToPropertySchema(schema: IApiNodeShape): IMonacoObjectProperty {
     const { description, name, displayName, id, readOnly, writeOnly, closed, minProperties, maxProperties } = schema;
     const properties = collectNodeProperties(schema);
 
@@ -255,7 +255,7 @@ export class ApiMonacoSchemaGenerator {
     return result;
   }
 
-  arrayShapeRangeToPropertySchema(schema: IArrayShape): IMonacoArrayProperty {
+  arrayShapeRangeToPropertySchema(schema: IApiArrayShape): IMonacoArrayProperty {
     const { description, name, displayName, id, readOnly, writeOnly, items, minItems, maxItems, uniqueItems } = schema;
     const result: IMonacoArrayProperty = {
       '$id': id,

package/src/amf/ApiSchemaGenerator.ts

@@ -1,10 +1,10 @@
 import { AmfNamespace as ns } from "./definitions/Namespace.js";
-import { IAnyShape, IDataExample, IShapeUnion } from "./definitions/Shapes.js";
+import { IApiAnyShape, IApiDataExample, IShapeUnion } from "./definitions/Shapes.js";
 import { ShapeBase, IShapeRenderOptions } from "./shape/ShapeBase.js";
 import { ShapeJsonSchemaGenerator } from './shape/ShapeJsonSchemaGenerator.js';
 import { ShapeXmlSchemaGenerator } from './shape/ShapeXmlSchemaGenerator.js';
 
-export interface ISchemaExample extends IDataExample {
+export interface ISchemaExample extends IApiDataExample {
   /**
    * The value to render as the example value.
    */
@@ -96,7 +96,7 @@ export class ApiSchemaGenerator {
       renderValue,
       customDomainProperties: [],
     };
-    const typed = shape as IAnyShape;
+    const typed = shape as IApiAnyShape;
     if (Array.isArray(typed.examples) && typed.examples.length) {
       const [example] = typed.examples;
       if (example.value) {

package/src/amf/ApiSchemaValues.ts

@@ -2,8 +2,8 @@ import { DataMock, ILoremWordInit, ITypeHashInit, ITypeNumberInit, Time } from '
 import { AmfNamespace as ns } from "./definitions/Namespace.js";
 import { JsonDataNodeGenerator } from "./data-node/JsonDataNodeGenerator.js";
 import { parseBooleanInput, parseNumberInput, readTypedValue } from "./Utils.js";
-import { ApiParameter } from './definitions/Api.js';
-import { IAnyShape, IArrayNode, IArrayShape, IDataExample, IScalarNode, IScalarShape, IShapeUnion } from './definitions/Shapes.js';
+import { IApiParameter } from './definitions/Api.js';
+import { IApiAnyShape, IApiArrayNode, IApiArrayShape, IApiDataExample, IApiScalarNode, IApiScalarShape, IShapeUnion } from './definitions/Shapes.js';
 
 export interface IApiSchemaReadOptions {
   /**
@@ -27,7 +27,7 @@ export class ApiSchemaValues {
    *
    * @returns The value to set on the input. Note, it is not cast to the type.
    */
-  static readInputValue(parameter: ApiParameter, schema: IScalarShape, opts: IApiSchemaReadOptions = {}): any {
+  static readInputValue(parameter: IApiParameter, schema: IApiScalarShape, opts: IApiSchemaReadOptions = {}): any {
     const { required } = parameter;
     const { defaultValueStr, values } = schema;
     if (!required && opts.requiredOnly === true) {
@@ -37,11 +37,11 @@ export class ApiSchemaValues {
       return ApiSchemaValues.readTypedValue(defaultValueStr, schema.dataType);
     }
     if (Array.isArray(values) && values.length) {
-      const firstEnum = values[0] as IScalarNode;
+      const firstEnum = values[0] as IApiScalarNode;
       return ApiSchemaValues.readTypedValue(firstEnum.value, firstEnum.dataType);
     }
     if (opts.fromExamples) {
-      let examples: IDataExample[] | undefined;
+      let examples: IApiDataExample[] | undefined;
       if (Array.isArray(parameter.examples) && parameter.examples.length) {
         // just in case when an ApiParameter was passed.
         examples = parameter.examples.filter(i => typeof i !== 'string');
@@ -59,7 +59,7 @@ export class ApiSchemaValues {
    * @param parameter The parameter that has the array schema.
    * @param schema The final schema to use to read the data from.
    */
-  static readInputValues(parameter: ApiParameter, schema: IShapeUnion, opts: IApiSchemaReadOptions = {}): any {
+  static readInputValues(parameter: IApiParameter, schema: IShapeUnion, opts: IApiSchemaReadOptions = {}): any {
     if (!parameter.required && opts.requiredOnly === true) {
       // for a non required array items just skip showing example values
       // as they are not crucial to make an HTTP request.
@@ -73,9 +73,9 @@ export class ApiSchemaValues {
         return result;
       }
     }
-    const anySchema = schema as IAnyShape;
+    const anySchema = schema as IApiAnyShape;
     if (opts.fromExamples) {
-      let examples: IDataExample[] | undefined;
+      let examples: IApiDataExample[] | undefined;
       if (Array.isArray(parameter.examples) && parameter.examples.length) {
         // just in case when an ApiParameter was passed.
         examples = parameter.examples.filter(i => typeof i !== 'string');
@@ -90,7 +90,7 @@ export class ApiSchemaValues {
   /**
    * Reads the value for the form input(s) from examples.
    */
-  static inputValueFromExamples(examples: IDataExample[]): any | null | undefined {
+  static inputValueFromExamples(examples: IApiDataExample[]): any | null | undefined {
     if (!Array.isArray(examples) || !examples.length) {
       return undefined;
     }
@@ -100,7 +100,7 @@ export class ApiSchemaValues {
       return undefined;
     }
     if (structuredValue.types.includes(ns.aml.vocabularies.data.Scalar)) {
-      const value = structuredValue as IScalarNode;
+      const value = structuredValue as IApiScalarNode;
       return ApiSchemaValues.readTypedValue(value.value, value.dataType);
     }
     return undefined;
@@ -110,7 +110,7 @@ export class ApiSchemaValues {
    * Reads the array value from examples.
    * @param examples Examples set on an array item.
    */
-  static arrayValuesFromExamples(examples?: IDataExample[]): any[] {
+  static arrayValuesFromExamples(examples?: IApiDataExample[]): any[] {
     const defaultReturn: any[] = [];
     if (!Array.isArray(examples) || !examples.length) {
       return defaultReturn;
@@ -119,14 +119,14 @@ export class ApiSchemaValues {
     if (!example.structuredValue || !example.structuredValue.types.includes(ns.aml.vocabularies.data.Array)) {
       return defaultReturn;
     }
-    const value = example.structuredValue as IArrayNode;
+    const value = example.structuredValue as IApiArrayNode;
     const { members } = value;
     if (!Array.isArray(members) || !members.length) {
       return defaultReturn;
     }
     const result: any[] = [];
     members.forEach((item) => {
-      const scalar = item as IScalarNode;
+      const scalar = item as IApiScalarNode;
       if (!scalar.value) {
         return;
       }
@@ -143,7 +143,7 @@ export class ApiSchemaValues {
    * For booleans it returns `false`, for numbers `0`, nulls `null`, etc.
    * It does not generate a value for `string` types!
    */
-  static generateDefaultValue(schema: IScalarShape): any {
+  static generateDefaultValue(schema: IApiScalarShape): any {
     const { dataType } = schema;
     return this.defaultValue(dataType);
   }
@@ -153,7 +153,7 @@ export class ApiSchemaValues {
    * For booleans it returns `false`, for numbers `0`, nulls `null`, etc.
    * It does not generate a value for `string` types!
    */
-  static generateMockedValue(schema: IScalarShape): any {
+  static generateMockedValue(schema: IApiScalarShape): any {
     const { dataType } = schema;
     switch (dataType) {
       case ns.w3.xmlSchema.string: return this.generateStringValue(schema);
@@ -209,7 +209,7 @@ export class ApiSchemaValues {
   /**
    * Generates a random number value given the schema definition for a number scalar.
    */
-  static generateNumberValue(schema: IScalarShape): number {
+  static generateNumberValue(schema: IApiScalarShape): number {
     const { minimum, maximum, format, multipleOf } = schema;
     const init: ITypeNumberInit = {};
     if (typeof minimum === 'number') {
@@ -239,7 +239,7 @@ export class ApiSchemaValues {
     return generator(init);
   }
 
-  static generateStringValue(schema: IScalarShape): string {
+  static generateStringValue(schema: IApiScalarShape): string {
     const { minLength, maxLength, name = '', format } = schema;
     const lowerName = name.toLowerCase();
     // we employ some heuristics to generate content based on the property name.
@@ -394,7 +394,7 @@ export class ApiSchemaValues {
   /**
    * Parses the the value according to array schema value.
    */
-  static parseArrayInput(value: any, schema: IArrayShape): string | number | boolean | null | undefined {
+  static parseArrayInput(value: any, schema: IApiArrayShape): string | number | boolean | null | undefined {
     const { items } = schema;
     if (!items) {
       return String(value);
@@ -411,10 +411,10 @@ export class ApiSchemaValues {
     }
     const { types } = schema;
     if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-      return ApiSchemaValues.parseScalarInput(value, schema as IScalarShape);
+      return ApiSchemaValues.parseScalarInput(value, schema as IApiScalarShape);
     }
     if (types.includes(ns.aml.vocabularies.shapes.ArrayShape) || types.includes(ns.aml.vocabularies.shapes.MatrixShape)) {
-      return ApiSchemaValues.parseArrayInput(value, schema as IArrayShape);
+      return ApiSchemaValues.parseArrayInput(value, schema as IApiArrayShape);
     }
     return value;
   }
@@ -422,7 +422,7 @@ export class ApiSchemaValues {
   /**
    * Parses the user entered value as scalar value.
    */
-  static parseScalarInput(value: unknown, schema: IScalarShape): string | number | boolean | null | undefined {
+  static parseScalarInput(value: unknown, schema: IApiScalarShape): string | number | boolean | null | undefined {
     return this.parseScalar(value, schema.dataType, schema.format);
   }
 

package/src/amf/Parsing.ts

@@ -1,4 +1,4 @@
-export interface AmfServiceProcessingOptions {
+export interface IAmfServiceProcessingOptions {
   /**
    * When true it treats the source as a zip data. Files are unzipped to a temporary location before processing.
    */
@@ -15,7 +15,7 @@ export interface AmfServiceProcessingOptions {
   mainFile?: string;
 }
 
-export interface ApiSearchCandidate {
+export interface IApiSearchCandidate {
   /**
    * Absolute path to the file
    */
@@ -26,7 +26,7 @@ export interface ApiSearchCandidate {
   relative: string;
 }
 
-export interface ApiSearchTypeResult {
+export interface IApiSearchTypeResult {
   /**
    * API type
    */
@@ -37,7 +37,7 @@ export interface ApiSearchTypeResult {
   contentType: string;
 }
 
-export interface ApiParseResult {
+export interface IApiParseResult {
   /**
    * The parsed API
    */
@@ -45,5 +45,5 @@ export interface ApiParseResult {
   /**
    * Api type info
    */
-  type: ApiSearchTypeResult;
+  type: IApiSearchTypeResult;
 }