@api-client/core 0.19.9 → 0.19.11

package/src/amf/ApiSchemaGenerator.ts

@@ -1,115 +0,0 @@
-import { AmfNamespace as ns } from './definitions/Namespace.js'
-import { IApiAnyShape, IApiDataExample, IApiPropertyShape, 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 IApiDataExample {
-  /**
-   * The value to render as the example value.
-   */
-  renderValue?: string | number | boolean | null | undefined
-  label?: string
-}
-
-/**
- * A class that processes AMF's Shape to auto-generate a schema from examples/type for a given media type.
- * This should be used when examples for the Shape are not available but the application still needs to
- * render an example or a schema from the Shape.
- * If examples can be found directly in the shape, use the `ApiExampleGenerator` instead.
- */
-export class ApiSchemaGenerator {
-  opts: Readonly<IShapeRenderOptions>
-
-  generator?: ShapeBase
-
-  /**
-   *
-   * @param mime The example mime type to format the generated example.
-   * @param opts Optional configuration.
-   */
-  constructor(
-    public mime: string,
-    opts: IShapeRenderOptions = {}
-  ) {
-    this.opts = Object.freeze({ ...opts })
-    if (mime.includes('json')) {
-      this.generator = new ShapeJsonSchemaGenerator(opts)
-    } else if (mime.includes('xml')) {
-      this.generator = new ShapeXmlSchemaGenerator(opts)
-    }
-  }
-
-  /**
-   * @param shape The Shape definition
-   * @param mime The mime type for the value.
-   * @returns Customized Example with the `renderValue` that is the generated Example value.
-   */
-  static asExample(shape: IShapeUnion, mime: string, opts?: IShapeRenderOptions): ISchemaExample | undefined {
-    const generator = new ApiSchemaGenerator(mime, opts)
-    return generator.toExample(shape)
-  }
-
-  /**
-   * @param shape The Shape definition
-   * @param mime The mime type for the value.
-   * @returns The generated schema
-   */
-  static asSchema(
-    shape: IShapeUnion,
-    mime: string,
-    opts?: IShapeRenderOptions
-  ): string | number | boolean | null | undefined {
-    const generator = new ApiSchemaGenerator(mime, opts)
-    return generator.toValue(shape)
-  }
-
-  /**
-   * Generates the schema from the AMF shape.
-   *
-   * @param shape The Shape definition
-   */
-  generate(shape: IShapeUnion | IApiPropertyShape<IShapeUnion>): string | number | boolean | null | undefined {
-    const { generator } = this
-    if (!generator) {
-      return undefined
-    }
-    return generator.generate(shape)
-  }
-
-  /**
-   * @link {#generate()}
-   * @param shape The Shape definition
-   */
-  toValue(shape: IShapeUnion): string | number | boolean | null | undefined {
-    return this.generate(shape)
-  }
-
-  /**
-   * Generates an API Example object with the value to render.
-   * @param shape The Shape definition
-   * @returns Customized Example with the `renderValue` that is the generated Example value.
-   */
-  toExample(shape: IShapeUnion): ISchemaExample | undefined {
-    const renderValue = this.generate(shape)
-    if (renderValue === null || renderValue === undefined) {
-      return undefined
-    }
-    const result: ISchemaExample = {
-      id: `${shape.id}/generated`,
-      strict: true,
-      types: [ns.aml.vocabularies.apiContract.Example],
-      mediaType: this.mime,
-      renderValue,
-      customDomainProperties: [],
-    }
-    const typed = shape as IApiAnyShape
-    if (Array.isArray(typed.examples) && typed.examples.length) {
-      const [example] = typed.examples
-      if (example.value) {
-        result.value = example.value
-      }
-    }
-    return result
-  }
-}

package/src/amf/ApiSchemaValues.ts

@@ -1,509 +0,0 @@
-import { Types } from '@pawel-up/data-mock/Types.js'
-import { Person } from '@pawel-up/data-mock/Person.js'
-import { Lorem } from '@pawel-up/data-mock/Lorem.js'
-import { Time } from '@pawel-up/data-mock/Time.js'
-import { AmfNamespace as ns } from './definitions/Namespace.js'
-import { JsonDataNodeGenerator } from './data-node/JsonDataNodeGenerator.js'
-import { parseBooleanInput, parseNumberInput, readTypedValue } from './Utils.js'
-import { IApiParameter } from './definitions/Api.js'
-import {
-  IApiAnyShape,
-  IApiArrayNode,
-  IApiArrayShape,
-  IApiDataExample,
-  IApiScalarNode,
-  IApiScalarShape,
-  IShapeUnion,
-} from './definitions/Shapes.js'
-import type { ILoremWordInit, ITypeHashInit, ITypeNumberInit } from '@pawel-up/data-mock/types.js'
-import { RandExp } from '../mocking/RandExp.js'
-
-export interface IApiSchemaReadOptions {
-  /**
-   * Whether the value should be read only when the required property is set.
-   */
-  requiredOnly?: boolean
-  /**
-   * Whether to read the examples to generate the value.
-   */
-  fromExamples?: boolean
-}
-
-/**
- * A utility class with helper functions to read values from a schema definition
- */
-// eslint-disable-next-line @typescript-eslint/no-extraneous-class
-export class ApiSchemaValues {
-  static types = new Types()
-  static person = new Person()
-  static lorem = new Lorem()
-  /**
-   * Reads the value to be set on an input. This is for Scalar shapes only.
-   *
-   * @returns The value to set on the input. Note, it is not cast to the type.
-   */
-  static readInputValue(
-    parameter: IApiParameter,
-    schema: IApiScalarShape,
-    opts: IApiSchemaReadOptions = {}
-  ): string | number | boolean | null | undefined {
-    const { required } = parameter
-    const { defaultValueStr, values } = schema
-    if (!required && opts.requiredOnly === true) {
-      return undefined
-    }
-    if (defaultValueStr) {
-      return ApiSchemaValues.readTypedValue(defaultValueStr, schema.dataType)
-    }
-    if (Array.isArray(values) && values.length) {
-      const firstEnum = values[0] as IApiScalarNode
-      return ApiSchemaValues.readTypedValue(firstEnum.value, firstEnum.dataType)
-    }
-    if (opts.fromExamples) {
-      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')
-      } else if (Array.isArray(schema.examples) && schema.examples.length) {
-        examples = schema.examples
-      }
-      if (examples && examples.length) {
-        return ApiSchemaValues.inputValueFromExamples(examples)
-      }
-    }
-    return ApiSchemaValues.generateDefaultValue(schema)
-  }
-
-  /**
-   * @param parameter The parameter that has the array schema.
-   * @param schema The final schema to use to read the data from.
-   */
-  static readInputValues(parameter: IApiParameter, schema: IShapeUnion, opts: IApiSchemaReadOptions = {}): unknown[] {
-    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.
-      return []
-    }
-    const { defaultValue } = schema
-    if (defaultValue) {
-      const gen = new JsonDataNodeGenerator()
-      const result = gen.processNode(defaultValue)
-      if (Array.isArray(result)) {
-        return result
-      }
-    }
-    const anySchema = schema as IApiAnyShape
-    if (opts.fromExamples) {
-      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')
-      } else if (Array.isArray(anySchema.examples) && anySchema.examples.length) {
-        examples = anySchema.examples
-      }
-      return ApiSchemaValues.arrayValuesFromExamples(examples)
-    }
-    return []
-  }
-
-  /**
-   * Reads the value for the form input(s) from examples.
-   */
-  static inputValueFromExamples(examples: IApiDataExample[]): string | number | boolean | null | undefined {
-    if (!Array.isArray(examples) || !examples.length) {
-      return undefined
-    }
-    const [example] = examples
-    const { structuredValue } = example
-    if (!structuredValue) {
-      return undefined
-    }
-    if (structuredValue.types.includes(ns.aml.vocabularies.data.Scalar)) {
-      const value = structuredValue as IApiScalarNode
-      return ApiSchemaValues.readTypedValue(value.value, value.dataType)
-    }
-    return undefined
-  }
-
-  /**
-   * Reads the array value from examples.
-   * @param examples Examples set on an array item.
-   */
-  static arrayValuesFromExamples(examples?: IApiDataExample[]): (string | number | boolean | null | undefined)[] {
-    const result: (string | number | boolean | null | undefined)[] = []
-    if (!Array.isArray(examples) || !examples.length) {
-      return result
-    }
-    const [example] = examples
-    if (!example.structuredValue || !example.structuredValue.types.includes(ns.aml.vocabularies.data.Array)) {
-      return result
-    }
-    const value = example.structuredValue as IApiArrayNode
-    const { members } = value
-    if (!Array.isArray(members) || !members.length) {
-      return result
-    }
-    members.forEach((item) => {
-      const scalar = item as IApiScalarNode
-      if (!scalar.value) {
-        return
-      }
-      const typedValue = ApiSchemaValues.readTypedValue(scalar.value, scalar.dataType)
-      if (typeof value !== 'undefined' && value !== null) {
-        result.push(typedValue)
-      }
-    })
-    return result
-  }
-
-  /**
-   * Generates a default value from the schema type.
-   * For booleans it returns `false`, for numbers `0`, nulls `null`, etc.
-   * It does not generate a value for `string` types!
-   */
-  static generateDefaultValue(schema: IApiScalarShape): string | number | boolean | null | undefined {
-    const { dataType } = schema
-    return this.defaultValue(dataType)
-  }
-
-  /**
-   * Generates a default value from the schema type.
-   * For booleans it returns `false`, for numbers `0`, nulls `null`, etc.
-   * It does not generate a value for `string` types!
-   */
-  static generateMockedValue(schema: IApiScalarShape): string | number | boolean | null | undefined {
-    const { dataType } = schema
-    switch (dataType) {
-      case ns.w3.xmlSchema.string:
-        return this.generateStringValue(schema)
-      // XML schema, for DataNode
-      case ns.w3.xmlSchema.number:
-      case ns.w3.xmlSchema.integer:
-      case ns.w3.xmlSchema.float:
-      case ns.w3.xmlSchema.long:
-      case ns.w3.xmlSchema.double:
-      case ns.aml.vocabularies.shapes.number:
-      case ns.aml.vocabularies.shapes.integer:
-      case ns.aml.vocabularies.shapes.float:
-      case ns.aml.vocabularies.shapes.long:
-      case ns.aml.vocabularies.shapes.double:
-        return this.generateNumberValue(schema)
-      case ns.aml.vocabularies.shapes.boolean:
-      case ns.w3.xmlSchema.boolean:
-        return this.types.boolean()
-      case ns.aml.vocabularies.shapes.nil:
-      case ns.w3.xmlSchema.nil:
-        return null
-      case ns.w3.xmlSchema.date:
-        return new Time().dateOnly()
-      case ns.w3.xmlSchema.dateTime:
-        return new Time().dateTime((schema.format === 'date-time' ? 'rfc3339' : schema.format) as 'rfc3339' | 'rfc2616')
-      case ns.aml.vocabularies.shapes.dateTimeOnly:
-        return new Time().dateTimeOnly()
-      case ns.w3.xmlSchema.time:
-        return new Time().timeOnly()
-      default:
-        return undefined
-    }
-  }
-
-  static defaultValue(dataType?: string): string | number | boolean | null | undefined {
-    switch (dataType) {
-      case ns.w3.xmlSchema.string:
-        return ''
-      // XML schema, for DataNode
-      case ns.w3.xmlSchema.number:
-      case ns.w3.xmlSchema.integer:
-      case ns.w3.xmlSchema.float:
-      case ns.w3.xmlSchema.long:
-      case ns.w3.xmlSchema.double:
-      case ns.aml.vocabularies.shapes.number:
-      case ns.aml.vocabularies.shapes.integer:
-      case ns.aml.vocabularies.shapes.float:
-      case ns.aml.vocabularies.shapes.long:
-      case ns.aml.vocabularies.shapes.double:
-        return 0
-      case ns.aml.vocabularies.shapes.boolean:
-      case ns.w3.xmlSchema.boolean:
-        return false
-      case ns.aml.vocabularies.shapes.nil:
-      case ns.w3.xmlSchema.nil:
-        return null
-      case ns.w3.xmlSchema.date:
-        return ''
-      case ns.w3.xmlSchema.dateTime:
-        return ''
-      case ns.aml.vocabularies.shapes.dateTimeOnly:
-        return ''
-      case ns.w3.xmlSchema.time:
-        return ''
-      default:
-        return undefined
-    }
-  }
-
-  /**
-   * Generates a random number value given the schema definition for a number scalar.
-   */
-  static generateNumberValue(schema: IApiScalarShape): number {
-    const { minimum, maximum, format, multipleOf } = schema
-    const init: ITypeNumberInit = {}
-    if (typeof minimum === 'number') {
-      init.min = minimum
-    }
-    if (typeof maximum === 'number') {
-      init.max = maximum
-    }
-    let generator: ((init?: number | ITypeNumberInit | undefined) => number) | undefined
-    if (format && ['float', 'double'].includes(format)) {
-      generator = this.types.float.bind(this.types)
-    } else if (format && ['uint32', 'uint64', 'fixed32', 'fixed64'].includes(format)) {
-      // these are unsigned numbers, make sure the generate anything above 0
-      init.min = 0
-      if (init.max && init.max < 0) {
-        delete init.max
-      }
-    }
-
-    if (!generator) {
-      // by default generate an integer
-      generator = this.types.number.bind(this.types)
-    }
-    if (typeof multipleOf === 'number') {
-      init.precision = multipleOf
-    }
-    return generator(init)
-  }
-
-  static generateStringValue(schema: IApiScalarShape): string {
-    const { minLength, maxLength, name = '', format, pattern } = schema
-    if (pattern) {
-      // if the pattern is set we generate a random string that matches the pattern.
-      // Note, this is not a full regex support, just a simple one.
-      const randExp = new RandExp(pattern, undefined, { max: 10 })
-      return randExp.gen()
-    }
-    const lowerName = name.toLowerCase()
-    // we employ some heuristics to generate content based on the property name.
-    if (lowerName === 'description') {
-      return this.lorem.paragraph()
-    }
-    if (format === 'uuid') {
-      return this.types.uuid()
-    }
-    if (lowerName === 'id') {
-      const init: ITypeHashInit = { length: 12 }
-      const hasMin = typeof minLength === 'number'
-      if (hasMin) {
-        init.length = minLength
-      } else if (!hasMin && typeof maxLength === 'number') {
-        init.length = maxLength
-      }
-      return this.types.hash(init)
-    }
-    if (['name', 'fullname'].includes(lowerName)) {
-      return this.person.name()
-    }
-    if (lowerName === 'firstname') {
-      return this.person.firstName()
-    }
-    if (lowerName === 'lastname') {
-      return this.person.lastName()
-    }
-    // if (['zip', 'postcode', 'postalcode', 'zipcode'].includes(lowerName)) {
-    //   return this.mocking.word
-    // }
-
-    const init: ILoremWordInit = {}
-    const hasMin = typeof minLength === 'number'
-    if (hasMin) {
-      init.length = minLength
-    } else if (!hasMin && typeof maxLength === 'number') {
-      init.length = maxLength
-    }
-
-    return this.lorem.word(init)
-  }
-
-  /**
-   * Casts the `value` to the corresponding data type
-   * @param type The w3 schema type
-   */
-  static readTypedValue(value: unknown, type?: string): string | number | boolean | null | undefined {
-    return readTypedValue(value, type)
-  }
-
-  /**
-   * @param schemaType Data type encoded in the parameter schema.
-   * @returns One of the HTML input element type values.
-   */
-  static readInputType(schemaType: string): 'number' | 'boolean' | 'date' | 'time' | 'datetime-local' | 'text' {
-    switch (schemaType) {
-      case ns.aml.vocabularies.shapes.number:
-      case ns.aml.vocabularies.shapes.integer:
-      case ns.aml.vocabularies.shapes.float:
-      case ns.aml.vocabularies.shapes.long:
-      case ns.aml.vocabularies.shapes.double:
-      case ns.w3.xmlSchema.number:
-      case ns.w3.xmlSchema.integer:
-      case ns.w3.xmlSchema.float:
-      case ns.w3.xmlSchema.long:
-      case ns.w3.xmlSchema.double:
-        return 'number'
-      case ns.w3.xmlSchema.date:
-        return 'date'
-      case ns.w3.xmlSchema.time:
-        return 'time'
-      case ns.w3.xmlSchema.dateTime:
-      case ns.aml.vocabularies.shapes.dateTimeOnly:
-        return 'datetime-local'
-      case ns.aml.vocabularies.shapes.boolean:
-      case ns.w3.xmlSchema.boolean:
-        return 'boolean'
-      default:
-        return 'text'
-    }
-  }
-
-  /**
-   * Processes a value that should be a number.
-   */
-  static parseNumberInput(value: unknown, defaultValue?: number): number | undefined {
-    return parseNumberInput(value, defaultValue)
-  }
-
-  /**
-   * Processes a value that should be a number.
-   */
-  static parseBooleanInput(value: unknown, defaultValue?: boolean): boolean | undefined {
-    return parseBooleanInput(value, defaultValue)
-  }
-
-  /**
-   * Processes a value that should be a date formatted as yyyy-MM-dd.
-   */
-  static parseDateOnlyInput(value: unknown): string | undefined {
-    const d = new Date(value as string | number)
-    if (Number.isNaN(d.getTime())) {
-      return undefined
-    }
-    const result = d.toJSON()
-    const timeSeparator = result.indexOf('T')
-    return result.substring(0, timeSeparator)
-  }
-
-  /**
-   * Processes a value that should be a date formatted as hh:mm:ss.
-   */
-  static parseTimeOnlyInput(input: unknown): string | undefined {
-    const value = String(input).trim()
-    if (/^\d\d:\d\d$/.test(value)) {
-      return `${value}:00`
-    }
-    if (/^\d\d:\d\d:\d\d$/.test(value)) {
-      return value
-    }
-    return undefined
-  }
-
-  /**
-   * Processes a value that should be a date formatted in one of the supported formats:
-   * - rfc3339 (default): 2016-02-28T16:41:41.090Z
-   * - rfc2616: Sun, 28 Feb 2016 16:41:41 GMT
-   */
-  static parseDateTimeInput(value: string | number, format = 'rfc3339'): string | undefined {
-    const d = new Date(value)
-    if (Number.isNaN(d.getTime())) {
-      return undefined
-    }
-    if (format === 'rfc2616') {
-      return d.toUTCString()
-    }
-    // OAS has the `date-time` format describing rfc3339.
-    if (['rfc3339', 'date-time'].includes(format)) {
-      return d.toISOString()
-    }
-    return undefined
-  }
-
-  /**
-   * Processes a value that should be a date formatted as yyyy-MM-ddThh:mm
-   */
-  static parseDateTimeOnlyInput(value: string | number): string | undefined {
-    const d = new Date(value)
-    if (Number.isNaN(d.getTime())) {
-      return undefined
-    }
-    const jsonDate = d.toJSON() // "yyyy-MM-ddThh:mm:ss.090Z"
-    const dot = jsonDate.indexOf('.')
-    return jsonDate.substring(0, dot)
-  }
-
-  /**
-   * Parses the the value according to array schema value.
-   */
-  static parseArrayInput(value: unknown, schema: IApiArrayShape): string | number | boolean | null | undefined {
-    const { items } = schema
-    if (!items) {
-      return String(value)
-    }
-    return ApiSchemaValues.parseUserInput(value, items)
-  }
-
-  /**
-   * Parses the user entered value according to the schema definition.
-   */
-  static parseUserInput(value: unknown, schema: IShapeUnion): string | number | boolean | null | undefined {
-    if (!schema || value === undefined || value === null) {
-      return value as null | undefined
-    }
-    const { types } = schema
-    if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-      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 IApiArrayShape)
-    }
-    return value as string | number | boolean
-  }
-
-  /**
-   * Parses the user entered value as scalar value.
-   */
-  static parseScalarInput(value: unknown, schema: IApiScalarShape): string | number | boolean | null | undefined {
-    return this.parseScalar(value, schema.dataType, schema.format)
-  }
-
-  static parseScalar(value: unknown, dataType?: string, format?: string): string | number | boolean | null | undefined {
-    switch (dataType) {
-      // AML shapes, for Shape
-      case ns.aml.vocabularies.shapes.number:
-      case ns.aml.vocabularies.shapes.integer:
-      case ns.aml.vocabularies.shapes.float:
-      case ns.aml.vocabularies.shapes.long:
-      case ns.aml.vocabularies.shapes.double:
-      case ns.w3.xmlSchema.number:
-      case ns.w3.xmlSchema.integer:
-      case ns.w3.xmlSchema.float:
-      case ns.w3.xmlSchema.long:
-      case ns.w3.xmlSchema.double:
-        return ApiSchemaValues.parseNumberInput(value)
-      case ns.aml.vocabularies.shapes.boolean:
-      case ns.w3.xmlSchema.boolean:
-        return ApiSchemaValues.parseBooleanInput(value)
-      case ns.w3.xmlSchema.date:
-        return ApiSchemaValues.parseDateOnlyInput(value)
-      case ns.w3.xmlSchema.time:
-        return ApiSchemaValues.parseTimeOnlyInput(value)
-      case ns.w3.xmlSchema.dateTime:
-        return ApiSchemaValues.parseDateTimeInput(value as string | number, format)
-      case ns.aml.vocabularies.shapes.dateTimeOnly:
-        return ApiSchemaValues.parseDateTimeOnlyInput(value as string | number)
-      default:
-        return String(value)
-    }
-  }
-}

package/src/amf/Parsing.ts

@@ -1,50 +0,0 @@
-export interface IAmfServiceProcessingOptions {
-  /**
-   * When true it treats the source as a zip data. Files are unzipped to a temporary location before processing.
-   */
-  zip?: boolean
-  /**
-   * When true it validates the API when parsing.
-   *
-   * Validation is made in the `parse` phase and results (as string)
-   * are stored in the `validationResult` property of the service.
-   */
-  validate?: boolean
-  /**
-   * The main file to use, if known
-   */
-  mainFile?: string
-}
-
-export interface IApiSearchCandidate {
-  /**
-   * Absolute path to the file
-   */
-  absolute: string
-  /**
-   * Relative path to the file
-   */
-  relative: string
-}
-
-export interface IApiSearchTypeResult {
-  /**
-   * API type
-   */
-  type: string
-  /**
-   * File media type
-   */
-  contentType: string
-}
-
-export interface IApiParseResult {
-  /**
-   * The parsed API
-   */
-  model: string
-  /**
-   * Api type info
-   */
-  type: IApiSearchTypeResult
-}