@api-client/core 0.19.10 → 0.19.11

package/src/amf/shape/ShapeBase.ts

@@ -1,174 +0,0 @@
-import { Time } from '@pawel-up/data-mock/Time.js'
-import { AmfNamespace as ns } from '../definitions/Namespace.js'
-import { ApiSchemaValues } from '../ApiSchemaValues.js'
-import { JsonDataNodeGenerator } from '../data-node/JsonDataNodeGenerator.js'
-import {
-  IApiAnyShape,
-  IApiArrayShape,
-  IApiDataExample,
-  IApiFileShape,
-  IApiNodeShape,
-  IApiPropertyShape,
-  IApiScalarNode,
-  IApiScalarShape,
-  IApiSchemaShape,
-  IShapeUnion,
-  IApiTupleShape,
-  IApiUnionShape,
-} from '../definitions/Shapes.js'
-
-export interface IShapeRenderOptions {
-  /**
-   * All selected unions in the current view.
-   * When the processor encounter an union it checks this array
-   * to pick the selected union.
-   * When the selected union cannot be determined it picks the first union.
-   */
-  selectedUnions?: string[]
-  /**
-   * Whether to include optional fields into the schema.
-   * @default false
-   */
-  renderOptional?: boolean
-  /**
-   * When set it uses the data mocking library to generate the values
-   * when examples and default are not set.
-   */
-  renderMocked?: boolean
-  /**
-   * The library **always** uses default values in the schema.
-   * When a default value is not set by default it inserts an empty value for
-   * the given data type ('', false, null, random date). When this is set
-   * it includes examples in the generated value.
-   */
-  renderExamples?: boolean
-}
-
-/**
- * A base class for generators that generates a schema from AMF's shape definition.
- */
-export abstract class ShapeBase {
-  opts: Readonly<IShapeRenderOptions>
-  time = new Time()
-
-  constructor(opts: IShapeRenderOptions = {}) {
-    this.opts = Object.freeze({ ...opts })
-  }
-
-  protected _scalarValue(schema: IApiScalarShape): string | number | boolean | null | undefined {
-    const { defaultValue, examples, values, inherits, dataType } = schema
-    // check examples
-    if (this.opts.renderExamples && examples && examples.length) {
-      const example = examples.find((item) => !!item.structuredValue)
-      const value = this._exampleToObject(example)
-      if (typeof value !== 'undefined') {
-        return ApiSchemaValues.readTypedValue(value, dataType)
-      }
-    }
-
-    // check the default value
-    if (defaultValue) {
-      const gen = new JsonDataNodeGenerator()
-      const processed = gen.processNode(defaultValue)
-      // return ApiSchemaValues.readTypedValue(processed, dataType);
-      return processed as string | number | boolean | null | undefined
-    }
-    // check enum values
-    if (values && values.length) {
-      const typed = values[0] as IApiScalarNode
-      if (typed.value !== undefined) {
-        return ApiSchemaValues.readTypedValue(typed.value, dataType)
-      }
-    }
-    // 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 IApiScalarShape)
-        if (result !== undefined) {
-          return result
-        }
-      }
-    }
-    if (this.opts.renderMocked) {
-      return ApiSchemaValues.generateMockedValue(schema)
-    }
-    // return this[dataTypeToExample](dataType, format);
-    // create a default value.
-    return ApiSchemaValues.generateDefaultValue(schema)
-  }
-
-  /**
-   * Checks whether the union represents a scalar + nil which is equivalent
-   * to having scalar that is not required.
-   *
-   * See more about nil values in RAML:
-   * https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#nil-type
-   *
-   * @param union The list of unions in the shape
-   */
-  protected _isNotRequiredUnion(union: IShapeUnion[]): boolean {
-    let scalars = 0
-    let hasNil = false
-    union.forEach((i) => {
-      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 IApiScalarShape
-        if (scalar.dataType === ns.w3.xmlSchema.nil) {
-          hasNil = true
-        } else {
-          scalars += 1
-        }
-      } else if (i.types.includes(ns.aml.vocabularies.shapes.FileShape)) {
-        scalars += 1
-      }
-    })
-    if (!hasNil) {
-      return false
-    }
-    // size of union minus the nil union
-    if (scalars === union.length - 1) {
-      return true
-    }
-    return false
-  }
-
-  /**
-   * Generates a schema from AMF's shape.
-   * @param schema The Shape definition
-   * @returns The generated example
-   */
-  abstract generate(schema: IShapeUnion | IApiPropertyShape<IShapeUnion>): string | number | boolean | null | undefined
-
-  /**
-   * Serializes generated values into the final mime type related form.
-   *
-   * @returns The generated example
-   */
-  abstract serialize(value: unknown): string | undefined
-
-  /**
-   * @param example The example to turn into a JS object
-   */
-  protected abstract _exampleToObject(example?: IApiDataExample): unknown
-
-  protected abstract _scalarShapeObject(schema: IApiScalarShape): unknown
-
-  protected abstract _nilShapeObject(schema: IApiScalarShape): unknown
-
-  protected abstract _nodeShapeObject(schema: IApiNodeShape): unknown
-
-  protected abstract _unionShapeObject(schema: IApiUnionShape): unknown
-
-  protected abstract _fileShapeObject(schema?: IApiFileShape): unknown
-
-  protected abstract _schemaShapeObject(schema?: IApiSchemaShape): unknown
-
-  protected abstract _arrayShapeObject(schema: IApiArrayShape): unknown
-
-  protected abstract _tupleShapeObject(schema?: IApiTupleShape): unknown
-
-  protected abstract _anyShapeObject(schema: IApiAnyShape): unknown
-
-  protected abstract _propertyShapeObject(schema: IApiPropertyShape): unknown
-}

package/src/amf/shape/ShapeJsonSchemaGenerator.ts

@@ -1,457 +0,0 @@
-import { AmfNamespace as ns } from '../definitions/Namespace.js'
-import { ShapeBase } from './ShapeBase.js'
-import { JsonDataNodeGenerator } from '../data-node/JsonDataNodeGenerator.js'
-import {
-  IApiAnyShape,
-  IApiArrayShape,
-  IApiDataExample,
-  IApiDataNodeUnion,
-  IApiNodeShape,
-  IApiPropertyShape,
-  IApiScalarShape,
-  IShapeUnion,
-  IApiTupleShape,
-  IApiUnionShape,
-} from '../definitions/Shapes.js'
-
-export class ShapeJsonSchemaGenerator extends ShapeBase {
-  /**
-   * Generates a schema from AMF's shape.
-   *
-   * @param schema The Shape definition
-   */
-  generate(schema: IShapeUnion | IApiPropertyShape<IShapeUnion>): string | number | boolean | null | undefined {
-    let result: string | number | boolean | object | object[] | null | undefined
-    if (schema.types.includes(ns.w3.shacl.PropertyShape)) {
-      result = this._propertyShapeObject(schema as IApiPropertyShape<IShapeUnion>)
-    } else {
-      result = this.toObject(schema as IShapeUnion)
-    }
-    if (result !== null && typeof result === 'object') {
-      return this.serialize(result)
-    }
-    return result
-  }
-
-  /**
-   * Processes the Shape definition and returns a JavaScript object or array.
-   */
-  toObject(schema: IShapeUnion): object | object[] | string | number | boolean | null | undefined {
-    const { types } = schema
-    if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-      return this._scalarShapeObject(schema as IApiScalarShape)
-    }
-    if (types.includes(ns.w3.shacl.NodeShape)) {
-      return this._nodeShapeObject(schema as IApiNodeShape)
-    }
-    if (types.includes(ns.aml.vocabularies.shapes.UnionShape)) {
-      return this._unionShapeObject(schema as IApiUnionShape)
-    }
-    if (types.includes(ns.aml.vocabularies.shapes.FileShape)) {
-      return this._fileShapeObject()
-    }
-    if (types.includes(ns.aml.vocabularies.shapes.SchemaShape)) {
-      return this._schemaShapeObject()
-    }
-    if (types.includes(ns.aml.vocabularies.shapes.TupleShape)) {
-      return this._tupleShapeObject(schema as IApiTupleShape)
-    }
-    if (
-      types.includes(ns.aml.vocabularies.shapes.ArrayShape) ||
-      types.includes(ns.aml.vocabularies.shapes.MatrixShape)
-    ) {
-      return this._arrayShapeObject(schema as IApiArrayShape)
-    }
-    return this._anyShapeObject(schema as IApiAnyShape)
-  }
-
-  /**
-   * Serializes generated JS value according to the mime type.
-   */
-  serialize(value: object | object[]): string {
-    return JSON.stringify(value, null, 2)
-  }
-
-  protected _scalarShapeObject(schema: IApiScalarShape): string | number | boolean | null | undefined {
-    return this._scalarValue(schema)
-  }
-
-  protected _nilShapeObject(): undefined {
-    return undefined
-  }
-
-  protected _nodeShapeObject(schema: IApiNodeShape): object {
-    const { inherits } = schema
-    let { examples = [] } = schema
-    if (Array.isArray(inherits) && inherits.length) {
-      inherits.forEach((parent) => {
-        const anyParent = parent as IApiAnyShape
-        if (Array.isArray(anyParent.examples) && anyParent.examples.length) {
-          examples = examples.concat(anyParent.examples)
-        }
-      })
-    }
-    if (this.opts.renderExamples && examples.length) {
-      const example = examples.find((item) => !!item.structuredValue)
-      const value = this._exampleToObject(example)
-      if (value !== undefined) {
-        return value as object | object[]
-      }
-    }
-    let result: Record<string, unknown> = {}
-    const { properties } = schema
-    if (Array.isArray(inherits) && inherits.length) {
-      inherits.forEach((s) => {
-        const part = this.toObject(s)
-        if (typeof part === 'object') {
-          result = { ...result, ...part }
-        }
-      })
-    }
-    properties.forEach((property) => {
-      const { name } = property
-      const value = this._propertyShapeObject(property)
-      if (typeof value !== 'undefined' && name) {
-        result[name] = value
-      }
-    })
-    return result
-  }
-
-  protected _unionShapeObject(
-    schema: IApiUnionShape
-  ): object | object[] | string | number | boolean | null | undefined {
-    if (schema.and && schema.and.length) {
-      return this._allOfUnion(schema)
-    }
-    if (schema.xone && schema.xone.length) {
-      return this._oneOfUnion(schema)
-    }
-    // the default
-    return this._anyOfUnion(schema)
-  }
-
-  protected _anyOfUnion(schema: IApiUnionShape): object | object[] | string | number | boolean | null | undefined {
-    let { anyOf = [], examples = [] } = schema
-    if (Array.isArray(schema.inherits) && schema.inherits) {
-      schema.inherits.forEach((parent) => {
-        const anyParent = parent as IApiAnyShape
-        if (Array.isArray(anyParent.examples) && anyParent.examples.length) {
-          examples = examples.concat(anyParent.examples)
-        }
-        const typed = parent as IApiUnionShape
-        if (Array.isArray(typed.anyOf) && typed.anyOf.length) {
-          anyOf = anyOf.concat(typed.anyOf)
-        }
-      })
-    }
-    const { opts } = this
-    if (this._isNotRequiredUnion(anyOf)) {
-      // This generates schema for required values.
-      // This implicitly mean that the property is not required therefore the value should
-      // not be generated.
-      return undefined
-    }
-    if (this.opts.renderExamples) {
-      const example = examples.find((item) => !!item.structuredValue)
-      const value = this._exampleToObject(example)
-      if (value !== undefined) {
-        return value
-      }
-    }
-    if (schema.defaultValue) {
-      return this._unionDefaultValue(anyOf, schema.defaultValue)
-    }
-    const { selectedUnions } = opts
-    let renderedItem: IShapeUnion | undefined
-    if (selectedUnions && selectedUnions.length) {
-      renderedItem = anyOf.find((item) => selectedUnions.includes(item.id))
-    } else {
-      ;[renderedItem] = anyOf
-    }
-    if (renderedItem) {
-      return this.toObject(renderedItem)
-    }
-    return undefined
-  }
-
-  protected _oneOfUnion(schema: IApiUnionShape): object | object[] | string | number | boolean | null | undefined {
-    let { examples = [] } = schema
-    const { xone = [] } = schema
-    if (Array.isArray(schema.inherits) && schema.inherits) {
-      schema.inherits.forEach((parent) => {
-        const anyParent = parent as IApiAnyShape
-        if (Array.isArray(anyParent.examples) && anyParent.examples.length) {
-          examples = examples.concat(anyParent.examples)
-        }
-      })
-    }
-    const { opts } = this
-    if (this.opts.renderExamples) {
-      const example = examples.find((item) => !!item.structuredValue)
-      const value = this._exampleToObject(example)
-      if (value !== undefined) {
-        return value
-      }
-    }
-    if (schema.defaultValue) {
-      return this._unionDefaultValue(xone, schema.defaultValue)
-    }
-    const { selectedUnions } = opts
-    let renderedItem: IShapeUnion | undefined
-    if (selectedUnions && selectedUnions.length) {
-      renderedItem = xone.find((item) => selectedUnions.includes(item.id))
-    } else {
-      ;[renderedItem] = xone
-    }
-    if (renderedItem) {
-      return this.toObject(renderedItem)
-    }
-    return undefined
-  }
-
-  /**
-   * Combines all properties from both all shapes in the union
-   */
-  protected _allOfUnion(schema: IApiUnionShape): object | object[] | string | number | boolean | null | undefined {
-    let { examples = [] } = schema
-    const { and = [] } = schema
-    if (Array.isArray(schema.inherits) && schema.inherits) {
-      schema.inherits.forEach((parent) => {
-        const anyParent = parent as IApiAnyShape
-        if (Array.isArray(anyParent.examples) && anyParent.examples.length) {
-          examples = examples.concat(anyParent.examples)
-        }
-      })
-    }
-    if (this.opts.renderExamples) {
-      const example = examples.find((item) => !!item.structuredValue)
-      const value = this._exampleToObject(example)
-      if (value !== undefined) {
-        return value
-      }
-    }
-    let result: Record<string, unknown> = {}
-    and.forEach((item) => {
-      const props = this.toObject(item)
-      if (typeof props === 'object') {
-        result = { ...result, ...props }
-      }
-    })
-    return result
-  }
-
-  /**
-   * @param union The list of unions in the shape
-   * @param defaultValue The definition of a default value.
-   */
-  protected _unionDefaultValue(
-    union: IShapeUnion[],
-    defaultValue: IApiDataNodeUnion
-  ): string | number | boolean | null | undefined {
-    const gen = new JsonDataNodeGenerator()
-    const result = gen.generate(defaultValue)
-    let hasNumber = false
-    let hasBoolean = false
-    let hasNil = false
-    union.forEach((i) => {
-      if (i.types.includes(ns.aml.vocabularies.shapes.NilShape)) {
-        hasNil = true
-      }
-      if (!i.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-        return
-      }
-      const scalar = i as IApiScalarShape
-      if (!hasBoolean) {
-        hasBoolean = scalar.dataType === ns.w3.xmlSchema.boolean
-      }
-      if (!hasNumber) {
-        hasNumber = [
-          ns.w3.xmlSchema.number,
-          ns.w3.xmlSchema.long,
-          ns.w3.xmlSchema.integer,
-          ns.w3.xmlSchema.float,
-          ns.w3.xmlSchema.double,
-          ns.aml.vocabularies.shapes.number,
-          ns.aml.vocabularies.shapes.long,
-          ns.aml.vocabularies.shapes.integer,
-          ns.aml.vocabularies.shapes.float,
-          ns.aml.vocabularies.shapes.double,
-        ].includes(scalar.dataType as string)
-      }
-      if (!hasNil) {
-        hasNil = scalar.dataType === ns.w3.xmlSchema.nil
-      }
-    })
-    if (hasNumber) {
-      const parsed = Number(result)
-      if (!Number.isNaN(parsed)) {
-        return parsed
-      }
-    }
-    if (hasBoolean) {
-      if (result === 'true') {
-        return true
-      }
-      if (result === 'false') {
-        return false
-      }
-    }
-    if (hasNil && (result === 'null' || result === 'nil')) {
-      return null
-    }
-    return result
-  }
-
-  protected _arrayShapeObject(schema: IApiArrayShape): unknown[] {
-    const { items } = schema
-    const defaultValue = schema.defaultValue || (items && items.defaultValue)
-
-    let { examples = [] } = schema
-    const anyItems = items as IApiAnyShape
-    if (Array.isArray(anyItems.examples)) {
-      examples = examples.concat(anyItems.examples)
-    }
-    if (this.opts.renderExamples && examples && examples.length) {
-      const example = examples.find((item) => !!item.structuredValue)
-      const value = this._exampleToObject(example)
-      if (Array.isArray(value)) {
-        return value
-      }
-      if (typeof value !== 'undefined') {
-        return [value]
-      }
-    }
-    if (defaultValue) {
-      const gen = new JsonDataNodeGenerator()
-      const arr = gen.processNode(defaultValue)
-      if (Array.isArray(arr)) {
-        return arr
-      } else if (arr) {
-        return [arr]
-      }
-    }
-    if (items) {
-      const value = this.toObject(items)
-      if (typeof value !== 'undefined') {
-        return [value]
-      }
-    }
-    return []
-  }
-
-  protected _tupleShapeObject(
-    schema: IApiTupleShape
-  ): object | object[] | string | number | boolean | null | undefined {
-    const { items, examples } = schema
-    if (this.opts.renderExamples && examples && examples.length) {
-      const example = examples.find((item) => !!item.structuredValue)
-      const value = this._exampleToObject(example)
-      if (typeof value !== 'undefined') {
-        return [value]
-      }
-    }
-    if (schema.defaultValue) {
-      const gen = new JsonDataNodeGenerator()
-      const arr = gen.processNode(schema.defaultValue)
-      if (Array.isArray(arr)) {
-        return arr
-      }
-    }
-    if (items.length) {
-      const result: unknown[] = []
-      items.forEach((i) => {
-        const value = this.toObject(i)
-        if (typeof value !== 'undefined') {
-          result.push(value)
-        }
-      })
-      return result
-    }
-    return []
-  }
-
-  protected _anyShapeObject(schema: IApiAnyShape): object | object[] | string | number | boolean | null | undefined {
-    const { and = [], xone = [], or = [] } = schema
-    if (and.length) {
-      let result: Record<string, unknown> = {}
-      and.forEach((item) => {
-        const props = this.toObject(item)
-        if (typeof props === 'object') {
-          result = { ...result, ...props }
-        }
-      })
-      return result
-    }
-    if (xone.length) {
-      const { selectedUnions = [] } = this.opts
-      let selected = xone.find((i) => selectedUnions.includes(i.id))
-      if (!selected) {
-        // select firs available
-        selected = xone[0]
-      }
-      return this.toObject(selected)
-    }
-    if (or.length) {
-      const { selectedUnions = [] } = this.opts
-      let selected = or.find((i) => selectedUnions.includes(i.id))
-      if (!selected) {
-        // select firs available
-        selected = or[0]
-      }
-      return this.toObject(selected)
-    }
-    return this._scalarShapeObject(schema)
-  }
-
-  /**
-   * @returns The value for the property or undefined when cannot generate the value.
-   */
-  protected _propertyShapeObject(
-    schema: IApiPropertyShape
-  ): object | object[] | string | number | boolean | null | undefined {
-    const { minCount = 0 } = schema
-    if (minCount === 0 && !this.opts.renderOptional) {
-      return undefined
-    }
-    const { range } = schema
-    if (!range) {
-      return undefined
-    }
-    const { types } = range
-    if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-      // const defaultValue = schema.defaultValue || range.defaultValue;
-      // if (!this.opts.renderExamples && defaultValue) {
-      //   const gen = new JsonDataNodeGenerator();
-      //   const value = gen.generate(defaultValue);
-      //   if (value) {
-      //     return ApiSchemaValues.readTypedValue(value, /** @type IScalarShape */ (range).dataType);
-      //   }
-      // }
-      const anyRange = range as IApiAnyShape
-      return this._scalarShapeObject(anyRange)
-    }
-    return this.toObject(range)
-  }
-
-  /**
-   * @param example The example to turn into a JS object
-   */
-  protected _exampleToObject(
-    example?: IApiDataExample
-  ): object | object[] | string | number | boolean | null | undefined {
-    if (example && example.structuredValue) {
-      const jsonGenerator = new JsonDataNodeGenerator()
-      return jsonGenerator.processNode(example.structuredValue)
-    }
-    return undefined
-  }
-
-  protected _fileShapeObject(): undefined {
-    return undefined
-  }
-
-  protected _schemaShapeObject(): undefined {
-    return undefined
-  }
-}