@api-client/core 0.7.11 → 0.8.0

package/src/amf/definitions/Shapes.ts

@@ -1,10 +1,10 @@
-import { AnyTypes, ArrayTypes, FileTypes, NodeTypes, PropertyTypes, RecursiveTypes, ScalarTypes, TupleTypes, UnionTypes, XmlSerializationTypes } from '../AmfTypes.js';
-import { ApiDocumentation, ApiDocumentSourceMaps } from './Api.js';
-import { IDomainProperty } from './Base.js';
+import { IAmfAnyTypes, IAmfArrayTypes, IAmfFileTypes, IAmfNodeTypes, IAmfPropertyTypes, IAmfRecursiveTypes, IAmfScalarTypes, IAmfTupleTypes, IAmfUnionTypes, IAmfXmlSerializationTypes } from '../AmfTypes.js';
+import { IApiDocumentation, IApiDocumentSourceMaps } from './Api.js';
+import { IApiDomainProperty } from './Base.js';
 
-export type IShapeUnion = IScalarShape | INodeShape | IUnionShape | IFileShape | ISchemaShape | IAnyShape | IArrayShape | ITupleShape | IRecursiveShape;
+export type IShapeUnion = IApiScalarShape | IApiNodeShape | IApiUnionShape | IApiFileShape | IApiSchemaShape | IApiAnyShape | IApiArrayShape | IApiTupleShape | IApiRecursiveShape;
 
-export interface IAssociationShape {
+export interface IApiAssociationShape {
   /**
    * This is custom property not available in AMF and used with data associations.
    * 
@@ -53,7 +53,7 @@ export interface IAssociationShape {
   unionType?: 'allOf' | 'anyOf' | 'oneOf' | 'not';
 }
 
-export interface IDataExample extends IDomainProperty {
+export interface IApiDataExample extends IApiDomainProperty {
   name?: string;
   displayName?: string;
   description?: string;
@@ -61,23 +61,23 @@ export interface IDataExample extends IDomainProperty {
    * This is the "raw" property of AMF
    */
   value?: string;
-  structuredValue?: IDataNodeUnion;
+  structuredValue?: IApiDataNodeUnion;
   strict: boolean;
   mediaType?: string;
   location?: string;
-  sourceMaps?: ApiDocumentSourceMaps;
+  sourceMaps?: IApiDocumentSourceMaps;
 }
 
-export function xmlSerializer(id: string): IXmlSerializer {
+export function xmlSerializer(id: string): IApiXmlSerializer {
   return {
     id: `xml-serializer-${id}`,
-    types: XmlSerializationTypes,
+    types: IAmfXmlSerializationTypes,
     customDomainProperties: [],
   };
 }
 
-export function shape(id: string): IShape {
-  const result: IShape = {
+export function shape(id: string): IApiShape {
+  const result: IApiShape = {
     id,
     types: [],
     values: [], 
@@ -90,19 +90,19 @@ export function shape(id: string): IShape {
   return result;
 }
 
-export function anyShape(id: string): IAnyShape {
-  const result: IAnyShape = {
+export function anyShape(id: string): IApiAnyShape {
+  const result: IApiAnyShape = {
     ...shape(id),
-    types: AnyTypes,
+    types: IAmfAnyTypes,
     examples: [],
     xmlSerialization: xmlSerializer(id),
   };
   return result;
 }
 
-export function nodeShape(id: string): INodeShape {
+export function nodeShape(id: string): IApiNodeShape {
   const result = anyShape(id);
-  result.types = NodeTypes;
+  result.types = IAmfNodeTypes;
   result.id = `node-shape-${id}`;
   return { 
     ...result, 
@@ -113,62 +113,62 @@ export function nodeShape(id: string): INodeShape {
   };
 }
 
-export function scalarShape(id: string): IScalarShape {
+export function scalarShape(id: string): IApiScalarShape {
   const result = anyShape(id);
   result.id = `scalar-shape-${id}`;
-  result.types = ScalarTypes;
+  result.types = IAmfScalarTypes;
   return result;
 }
 
-export function unionShape(id: string): IUnionShape {
+export function unionShape(id: string): IApiUnionShape {
   const result = anyShape(id);
   result.id = `union-shape-${id}`;
-  result.types = UnionTypes;
+  result.types = IAmfUnionTypes;
   return { ...result, anyOf: [] };
 }
 
-export function fileShape(id: string): IFileShape {
+export function fileShape(id: string): IApiFileShape {
   const result = anyShape(id);
   result.id = `file-shape-${id}`;
-  result.types = FileTypes;
+  result.types = IAmfFileTypes;
   return result;
 }
 
-export function arrayShape(id: string): IArrayShape {
+export function arrayShape(id: string): IApiArrayShape {
   const result = anyShape(id);
   result.id = `array-shape-${id}`;
-  result.types = ArrayTypes;
+  result.types = IAmfArrayTypes;
   return result;
 }
 
-export function tupleShape(id: string): ITupleShape {
+export function tupleShape(id: string): IApiTupleShape {
   const result = anyShape(id);
   result.id = `tuple-shape-${id}`;
-  result.types = TupleTypes;
+  result.types = IAmfTupleTypes;
   return { ...result, items: [] };
 }
 
-export function propertyShape(id: string): IPropertyShape {
+export function propertyShape(id: string): IApiPropertyShape {
   const result = anyShape(id);
-  result.types = PropertyTypes;
+  result.types = IAmfPropertyTypes;
   return result;
 }
 
-export function recursiveShape(id: string, fixedId?: string): IRecursiveShape {
-  const result: IRecursiveShape = {
+export function recursiveShape(id: string, fixedId?: string): IApiRecursiveShape {
+  const result: IApiRecursiveShape = {
     ...shape(id),
     id: `recursive-${id}`,
-    types: RecursiveTypes,
+    types: IAmfRecursiveTypes,
     fixPoint: fixedId || '',
   };
   return result;
 }
 
-export interface IShape extends IDomainProperty {
+export interface IApiShape extends IApiDomainProperty {
   /**
    * Enum values for this shape.
    */
-  values: IDataNodeUnion[];
+  values: IApiDataNodeUnion[];
   /**
    * The list of shapes that this shape inherits from
    */
@@ -204,7 +204,7 @@ export interface IShape extends IDomainProperty {
   /**
    * The description of the default value of the shape.
    */
-  defaultValue?: IDataNodeUnion;
+  defaultValue?: IApiDataNodeUnion;
   /**
    * Whether the shape is deprecated.
    */
@@ -222,13 +222,13 @@ export interface IShape extends IDomainProperty {
    * A label that appeared on a link.
    */
   linkLabel?: string;
-  sourceMaps?: ApiDocumentSourceMaps;
+  sourceMaps?: IApiDocumentSourceMaps;
 }
 
 /**
  * A property of an API operation.
  */
-export interface IPropertyShape<T = IShapeUnion> extends IShape {
+export interface IApiPropertyShape<T = IShapeUnion> extends IApiShape {
   /**
    * The path of the property. Essentially, it is link generated by the AMF library
    * where the fragment part is the name of the property.
@@ -245,22 +245,22 @@ export interface IPropertyShape<T = IShapeUnion> extends IShape {
   maxCount?: number;
 }
 
-export interface IAnyShape extends IShape {
-  documentation?: ApiDocumentation;
+export interface IApiAnyShape extends IApiShape {
+  documentation?: IApiDocumentation;
   /**
    * Description of how the shape should be serialized as XML.
    */
-  xmlSerialization: IXmlSerializer;
+  xmlSerialization: IApiXmlSerializer;
   /**
    * Examples defined for the shape.
    */
-  examples: IDataExample[];
+  examples: IApiDataExample[];
 }
 
 /**
  * Describes an object shape.
  */
-export interface INodeShape extends IAnyShape {
+export interface IApiNodeShape extends IApiAnyShape {
   minProperties?: number;
   maxProperties?: number;
   closed?: boolean;
@@ -268,11 +268,11 @@ export interface INodeShape extends IAnyShape {
   customShapePropertyDefinitions: string[];
   discriminator?: string;
   discriminatorValue?: string;
-  properties: IPropertyShape[];
+  properties: IApiPropertyShape[];
   dependencies: string[];
 }
 
-export interface IXmlSerializer extends IDomainProperty {
+export interface IApiXmlSerializer extends IApiDomainProperty {
   /**
    * Whether this property should be represented as an attribute of the parent shape.
    * 
@@ -337,10 +337,10 @@ export interface IXmlSerializer extends IDomainProperty {
    * ```
    */
   prefix?: string;
-  sourceMaps?: ApiDocumentSourceMaps;
+  sourceMaps?: IApiDocumentSourceMaps;
 }
 
-export interface IScalarShape extends IAnyShape {
+export interface IApiScalarShape extends IApiAnyShape {
   dataType?: string;
   pattern?: string;
   minLength?: number;
@@ -353,7 +353,7 @@ export interface IScalarShape extends IAnyShape {
   multipleOf?: number;
 }
 
-export interface IFileShape extends IAnyShape {
+export interface IApiFileShape extends IApiAnyShape {
   fileTypes?: string[];
   pattern?: string;
   minLength?: number;
@@ -366,49 +366,49 @@ export interface IFileShape extends IAnyShape {
   multipleOf?: number;
 }
 
-export interface ISchemaShape extends IAnyShape {
+export interface IApiSchemaShape extends IApiAnyShape {
   mediaType?: string;
   raw?: string;
 }
 
-export interface IUnionShape extends IAnyShape {
+export interface IApiUnionShape extends IApiAnyShape {
   anyOf: IShapeUnion[];
 }
 
-export interface IDataArrangeShape extends IAnyShape {
+export interface IApiDataArrangeShape extends IApiAnyShape {
   minItems?: number;
   maxItems?: number;
   uniqueItems?: boolean;
 }
 
-export interface IArrayShape<T = IShapeUnion> extends IDataArrangeShape {
+export interface IApiArrayShape<T = IShapeUnion> extends IApiDataArrangeShape {
   items?: T;
 }
 
-export interface ITupleShape<T = IShapeUnion> extends IDataArrangeShape {
+export interface IApiTupleShape<T = IShapeUnion> extends IApiDataArrangeShape {
   items: T[];
   additionalItems?: boolean;
 }
 
-export interface IRecursiveShape extends IShape {
+export interface IApiRecursiveShape extends IApiShape {
   fixPoint: string;
 }
 
-export interface IDataNode extends IDomainProperty {
+export interface IApiDataNode extends IApiDomainProperty {
   name?: string;
 }
 
-export interface IObjectNode extends IDataNode {
-  properties: { [key: string]: IDataNodeUnion };
+export interface IApiObjectNode extends IApiDataNode {
+  properties: { [key: string]: IApiDataNodeUnion };
 }
 
-export interface IScalarNode extends IDataNode {
+export interface IApiScalarNode extends IApiDataNode {
   value?: string;
   dataType?: string;
 }
 
-export interface IArrayNode extends IDataNode {
-  members: IDataNodeUnion[];
+export interface IApiArrayNode extends IApiDataNode {
+  members: IApiDataNodeUnion[];
 }
 
-export type IDataNodeUnion = IDataNode | IObjectNode | IScalarNode | IArrayNode;
+export type IApiDataNodeUnion = IApiDataNode | IApiObjectNode | IApiScalarNode | IApiArrayNode;

package/src/amf/models/AmfDataNode.ts

@@ -1,8 +1,8 @@
 import v4 from '../../lib/uuid.js';
-import { ArrayNodeTypes, ObjectNodeTypes, ScalarNodeTypes } from '../AmfTypes.js';
-import { ICustomDomainProperty } from '../definitions/Base.js';
+import { IAmfArrayNodeTypes, IAmfObjectNodeTypes, IAmfScalarNodeTypes } from '../AmfTypes.js';
+import { IApiCustomDomainProperty } from '../definitions/Base.js';
 import { AmfNamespace } from '../definitions/Namespace.js';
-import { IArrayNode, IDataNode, IDataNodeUnion, IObjectNode, IScalarNode } from '../definitions/Shapes.js';
+import { IApiArrayNode, IApiDataNode, IApiDataNodeUnion, IApiObjectNode, IApiScalarNode } from '../definitions/Shapes.js';
 
 export type IDataNodeInit = 'scalar' | 'object' | 'array';
 
@@ -43,7 +43,7 @@ export class AmfDataNode {
    */
   members?: AmfDataNode[];
 
-  customDomainProperties: ICustomDomainProperty[] = [];
+  customDomainProperties: IApiCustomDomainProperty[] = [];
 
   static scalar(value: string, type: string): AmfDataNode {
     const result = new AmfDataNode('scalar');
@@ -52,14 +52,14 @@ export class AmfDataNode {
     return result;
   }
 
-  constructor(init: IDataNodeUnion | IDataNodeInit) {
+  constructor(init: IApiDataNodeUnion | IDataNodeInit) {
     if (typeof init === 'string') {
       if (init === 'scalar') {
-        this.types = ScalarNodeTypes;
+        this.types = IAmfScalarNodeTypes;
       } else if (init === 'array') {
-        this.types = ArrayNodeTypes;
+        this.types = IAmfArrayNodeTypes;
       } else if (init === 'object') {
-        this.types = ObjectNodeTypes;
+        this.types = IAmfObjectNodeTypes;
       } else {
         throw new Error(`Invalid data node init option: ${init}`);
       }
@@ -68,24 +68,24 @@ export class AmfDataNode {
     if (!init) {
       throw new Error(`Expected an initialization option.`);
     }
-    const union = init as IDataNodeUnion;
+    const union = init as IApiDataNodeUnion;
     const { id, types, customDomainProperties } = union;
     this.id = id;
     this.types = types;
     this.customDomainProperties = customDomainProperties;
     if (types.includes(AmfNamespace.aml.vocabularies.data.Scalar)) {
-      const typed = union as IScalarNode;
+      const typed = union as IApiScalarNode;
       this.value = typed.value;
       this.dataType = typed.dataType;
     } else if (types.includes(AmfNamespace.aml.vocabularies.data.Object)) {
-      const typed = union as IObjectNode;
+      const typed = union as IApiObjectNode;
       this.properties = {};
       Object.keys(typed.properties).forEach((key) => {
         const instance = new AmfDataNode(typed.properties[key]);
         this.properties![key] = instance;
       });
     } else if (types.includes(AmfNamespace.aml.vocabularies.data.Array)) {
-      const typed = union as IArrayNode;
+      const typed = union as IApiArrayNode;
       this.members = [];
       if (Array.isArray(typed.members)) {
         typed.members.forEach((member) => {
@@ -96,9 +96,9 @@ export class AmfDataNode {
     }
   }
 
-  toJSON(): IDataNodeUnion {
+  toJSON(): IApiDataNodeUnion {
     const { id, customDomainProperties, types, name } = this;
-    const result: IDataNode = {
+    const result: IApiDataNode = {
       id,
       types,
       customDomainProperties,
@@ -108,11 +108,11 @@ export class AmfDataNode {
     }
 
     if (types.includes(AmfNamespace.aml.vocabularies.data.Scalar)) {
-      const typed = result as IScalarNode;
+      const typed = result as IApiScalarNode;
       typed.dataType = this.dataType;
       typed.value = this.value;
     } else if (types.includes(AmfNamespace.aml.vocabularies.data.Object)) {
-      const typed = result as IObjectNode;
+      const typed = result as IApiObjectNode;
       typed.properties = {};
       if (this.properties) {
         Object.keys(this.properties).forEach((key) => {
@@ -120,7 +120,7 @@ export class AmfDataNode {
         });
       }
     } else if (types.includes(AmfNamespace.aml.vocabularies.data.Array)) {
-      const typed = result as IArrayNode;
+      const typed = result as IApiArrayNode;
       typed.members = [];
       if (this.members) {
         this.members.forEach((member) => {

package/src/amf/shape/ShapeBase.ts

@@ -2,7 +2,7 @@ import { Time } from '@pawel-up/data-mock';
 import { AmfNamespace as ns } from "../definitions/Namespace.js";
 import { ApiSchemaValues } from '../ApiSchemaValues.js';
 import { JsonDataNodeGenerator } from '../data-node/JsonDataNodeGenerator.js';
-import { IAnyShape, IArrayShape, IDataExample, IFileShape, INodeShape, IPropertyShape, IScalarNode, IScalarShape, ISchemaShape, IShapeUnion, ITupleShape, IUnionShape } from '../definitions/Shapes.js';
+import { IApiAnyShape, IApiArrayShape, IApiDataExample, IApiFileShape, IApiNodeShape, IApiPropertyShape, IApiScalarNode, IApiScalarShape, IApiSchemaShape, IShapeUnion, IApiTupleShape, IApiUnionShape } from '../definitions/Shapes.js';
 
 export interface IShapeRenderOptions {
   /**
@@ -42,7 +42,7 @@ export abstract class ShapeBase {
     this.opts = Object.freeze({ ...opts });
   }
 
-  protected _scalarValue(schema: IScalarShape): string | number | boolean {
+  protected _scalarValue(schema: IApiScalarShape): string | number | boolean {
     const { defaultValue, examples, values, inherits, dataType } = schema;
     // check examples
     if (this.opts.renderExamples && examples && examples.length) {
@@ -62,7 +62,7 @@ export abstract class ShapeBase {
     }
     // check enum values
     if (values && values.length) {
-      const typed = values[0] as IScalarNode;
+      const typed = values[0] as IApiScalarNode;
       if (typed.value !== undefined) {
         return ApiSchemaValues.readTypedValue(typed.value, dataType);
       }
@@ -70,7 +70,7 @@ export abstract class ShapeBase {
     // check parents
     if (Array.isArray(inherits) && inherits.length) {
       for (let i = 0, len = inherits.length; i < len; i += 1) {
-        const result = this._scalarValue(inherits[i] as IScalarShape);
+        const result = this._scalarValue(inherits[i] as IApiScalarShape);
         if (result !== undefined) {
           return result;
         }
@@ -100,7 +100,7 @@ export abstract class ShapeBase {
       if (i.types.includes(ns.aml.vocabularies.shapes.NilShape)) {
         hasNil = true;
       } else if (i.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-        const scalar = i as IScalarShape;
+        const scalar = i as IApiScalarShape;
         if (scalar.dataType === ns.w3.xmlSchema.nil) {
           hasNil = true;
         } else {
@@ -139,25 +139,25 @@ export abstract class ShapeBase {
    * @param {ApiExample} example The example to turn into a JS object
    * @returns {any}
    */
-  protected abstract _exampleToObject(example?: IDataExample): any;
+  protected abstract _exampleToObject(example?: IApiDataExample): any;
 
-  protected abstract _scalarShapeObject(schema: IScalarShape): any;
+  protected abstract _scalarShapeObject(schema: IApiScalarShape): any;
 
-  protected abstract _nilShapeObject(schema: IScalarShape): any;
+  protected abstract _nilShapeObject(schema: IApiScalarShape): any;
 
-  protected abstract _nodeShapeObject(schema: INodeShape): any;
+  protected abstract _nodeShapeObject(schema: IApiNodeShape): any;
 
-  protected abstract _unionShapeObject(schema: IUnionShape): any;
+  protected abstract _unionShapeObject(schema: IApiUnionShape): any;
 
-  protected abstract _fileShapeObject(schema?: IFileShape): any;
+  protected abstract _fileShapeObject(schema?: IApiFileShape): any;
 
-  protected abstract _schemaShapeObject(schema?: ISchemaShape): any;
+  protected abstract _schemaShapeObject(schema?: IApiSchemaShape): any;
 
-  protected abstract _arrayShapeObject(schema: IArrayShape): any;
+  protected abstract _arrayShapeObject(schema: IApiArrayShape): any;
 
-  protected abstract _tupleShapeObject(schema?: ITupleShape): any;
+  protected abstract _tupleShapeObject(schema?: IApiTupleShape): any;
 
-  protected abstract _anyShapeObject(schema: IAnyShape): any;
+  protected abstract _anyShapeObject(schema: IApiAnyShape): any;
 
-  protected abstract _propertyShapeObject(schema: IPropertyShape): any;
+  protected abstract _propertyShapeObject(schema: IApiPropertyShape): any;
 }