@api-client/core 0.19.10 → 0.19.11

package/src/amf/AmfTypes.ts

@@ -1,147 +0,0 @@
-import { type DomainPropertyType } from '../modeling/DataFormat.js'
-import { PropertyWebBindings } from '../modeling/Bindings.js'
-import { AmfNamespace } from './definitions/Namespace.js'
-
-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 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 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 IAmfPropertyTypes = [
-  AmfNamespace.w3.shacl.PropertyShape,
-  AmfNamespace.w3.shacl.Shape,
-  AmfNamespace.aml.vocabularies.shapes.Shape,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-export const IAmfNilTypes = [
-  AmfNamespace.aml.vocabularies.shapes.NilShape,
-  AmfNamespace.w3.shacl.Shape,
-  AmfNamespace.aml.vocabularies.shapes.Shape,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-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 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 IAmfAnyTypes = [
-  AmfNamespace.aml.vocabularies.shapes.AnyShape,
-  AmfNamespace.w3.shacl.Shape,
-  AmfNamespace.aml.vocabularies.shapes.Shape,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-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 IAmfTupleTypes = [
-  AmfNamespace.aml.vocabularies.shapes.TupleShape,
-  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 IAmfRecursiveTypes = [
-  AmfNamespace.aml.vocabularies.shapes.RecursiveShape,
-  AmfNamespace.w3.shacl.Shape,
-  AmfNamespace.aml.vocabularies.shapes.Shape,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-export const IAmfXmlSerializationTypes = [
-  AmfNamespace.aml.vocabularies.shapes.XMLSerializer,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-
-export const IAmfScalarNodeTypes = [
-  AmfNamespace.aml.vocabularies.data.Scalar,
-  AmfNamespace.aml.vocabularies.data.Node,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-export const IAmfArrayNodeTypes = [
-  AmfNamespace.aml.vocabularies.data.Array,
-  AmfNamespace.w3.rdfSchema.Seq,
-  AmfNamespace.aml.vocabularies.data.Node,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-export const IAmfObjectNodeTypes = [
-  AmfNamespace.aml.vocabularies.data.Object,
-  AmfNamespace.aml.vocabularies.data.Node,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-export const IAmfExampleTypes = [
-  AmfNamespace.aml.vocabularies.apiContract.Example,
-  AmfNamespace.aml.vocabularies.document.DomainElement,
-]
-
-/**
- * Translates the DomainProperty type to an AMF data type.
- * @param type The property data type
- * @returns AMF shape dataType
- */
-export function modelTypeToAmfDataType(type: DomainPropertyType, bindings?: PropertyWebBindings): string {
-  if (type === 'number') {
-    if (bindings?.format === 'int32' || bindings?.format === 'int64') {
-      return AmfNamespace.w3.xmlSchema.integer
-    }
-    return AmfNamespace.w3.xmlSchema.number
-  }
-  if (type === 'boolean') {
-    return AmfNamespace.aml.vocabularies.shapes.boolean
-  }
-  if (type === 'date') {
-    return AmfNamespace.w3.xmlSchema.date
-  }
-  if (type === 'datetime') {
-    return AmfNamespace.w3.xmlSchema.dateTime
-  }
-  if (type === 'time') {
-    return AmfNamespace.aml.vocabularies.shapes.dateTimeOnly
-  }
-  if (type === 'binary' && bindings && bindings.format === 'base64') {
-    return AmfNamespace.w3.xmlSchema.base64Binary
-  }
-  return AmfNamespace.w3.xmlSchema.string
-  // switch (type) {
-  //   // case 'nil':
-  //   //   return AmfNamespace.aml.vocabularies.shapes.nil
-  //   // case 'any':
-  //   //   return AmfNamespace.aml.vocabularies.shapes.AnyShape
-  //   default:
-  //     if (type === 'binary' && bindings && bindings.format === 'base64') {
-  //       return AmfNamespace.w3.xmlSchema.base64Binary
-  //     }
-  //     // if (bindings && bindings.format === 'binary') {
-  //     //   return AmfNamespace.w3.xmlSchema.base64Binary
-  //     // }
-  //     return AmfNamespace.w3.xmlSchema.string
-  // }
-}

package/src/amf/ApiExampleGenerator.ts

@@ -1,122 +0,0 @@
-import { AmfNamespace as ns } from './definitions/Namespace.js'
-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 { IApiArrayShape, IApiDataExample, IApiDataNode, IShapeUnion } from './definitions/Shapes.js'
-
-/**
- * A class that processes AMF's Example object to read the example value
- * or to generate the example for the given media type.
- */
-export class ApiExampleGenerator {
-  /**
-   * Reads or generates an example.
-   * When the `mime` is set then it tries to "guess" whether the mime type corresponds to the value.
-   * If it doesn't then it generates the example from the structured value, when possible.
-   * @param example The structured value of the example
-   * @param mime The optional mime type of the example. When not set it
-   *    won't generate example from the structured value.
-   * @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: IApiDataExample, mime?: string, shape?: IShapeUnion): string | number | false | null | undefined {
-    const { value, structuredValue } = example
-    if (!value && !structuredValue) {
-      return undefined
-    }
-    if (structuredValue && !value && mime) {
-      return this.fromStructuredValue(mime, structuredValue, shape)
-    }
-    if (!mime) {
-      return value
-    }
-    if (this.mimeMatches(mime, value)) {
-      return value
-    }
-    if (structuredValue) {
-      return this.fromStructuredValue(mime, structuredValue, shape)
-    }
-    return undefined
-  }
-
-  /**
-   * Employs some basic heuristics to determine whether the given mime type patches the content.
-   * @param mime The mime type for the value.
-   * @param value The value.
-   * @returns True when the value matches the mime type.
-   */
-  mimeMatches(mime: string, value?: string): boolean {
-    const trimmed = String(value).trim()
-    if (mime.includes('json')) {
-      // JSON string has to start with either of these characters
-      return trimmed[0] === '{' || trimmed[0] === '['
-    }
-    if (mime.includes('xml')) {
-      return trimmed.startsWith('<')
-    }
-    if (mime.includes('x-www-form-urlencoded')) {
-      return trimmed.includes('=') || trimmed.includes('&')
-    }
-    return true
-  }
-
-  /**
-   * Generates the example for the given structured value and the media type.
-   * @param mime The mime type for the value.
-   * @param structuredValue The structuredValue of the example.
-   * @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: IApiDataNode,
-    shape?: IShapeUnion
-  ): string | number | false | null | undefined {
-    if (mime.includes('json')) {
-      const generator = new JsonDataNodeGenerator()
-      return generator.generate(structuredValue)
-    }
-    let shapeName
-    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 IApiArrayShape
-      if (typed.items && typed.items.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-        shapeName = typed.items.name || shape.name
-      }
-    }
-    if (mime.includes('xml')) {
-      const generator = new XmlDataNodeGenerator()
-      let value = generator.generate(structuredValue, shapeName)
-      if (shape && !shapeName) {
-        value = this.wrapXmlValue(value, shape)
-      }
-      return value
-    }
-    if (mime.includes('x-www-form-urlencoded')) {
-      const generator = new UrlEncodedDataNodeGenerator()
-      return generator.generate(structuredValue, shapeName)
-    }
-    return undefined
-  }
-
-  /**
-   * Wraps the generated XML example into an element according to the `shape` properties.
-   */
-  wrapXmlValue(
-    value?: string | number | false | null | undefined,
-    shape?: IShapeUnion
-  ): string | number | false | null | undefined {
-    if (!value || !shape) {
-      return value
-    }
-    const { name } = shape
-    const parts = [`<${name}>`]
-    parts.push(formatXmlValue('  ', String(value).trim()))
-    parts.push(`</${name}>`)
-    return parts.join('\n')
-  }
-}

package/src/amf/ApiMonacoSchemaGenerator.ts

@@ -1,332 +0,0 @@
-import { AmfNamespace as ns } from './definitions/Namespace.js'
-import {
-  IApiArrayShape,
-  IApiNodeShape,
-  IApiPropertyShape,
-  IApiScalarNode,
-  IApiScalarShape,
-  IShapeUnion,
-} from './definitions/Shapes.js'
-import { collectNodeProperties } from './Utils.js'
-
-export interface IMonacoSchema {
-  uri: string
-  schema: IMonacoProperty
-  fileMatch?: string[]
-}
-
-export interface IMonacoProperty {
-  $id?: string
-  title: string
-  type: string
-  description?: string
-  readOnly?: boolean
-  writeOnly?: boolean
-}
-
-export interface IMonacoScalarProperty extends IMonacoProperty {
-  default?: string
-  pattern?: string
-  format?: string
-  exclusiveMaximum?: boolean
-  exclusiveMinimum?: boolean
-  maxLength?: number
-  minLength?: number
-  minimum?: number
-  maximum?: number
-  multipleOf?: number
-  enum?: string[]
-}
-
-export interface IMonacoObjectProperty extends IMonacoProperty {
-  properties: Record<string, IMonacoProperty>
-  required: string[]
-  additionalProperties?: boolean
-  minProperties?: number
-  maxProperties?: number
-}
-
-export interface IMonacoArrayProperty extends IMonacoProperty {
-  additionalItems?: boolean
-  items: {
-    anyOf: IMonacoProperty[]
-  }
-  uniqueItems?: boolean
-  minItems?: number
-  maxItems?: number
-  required: string[]
-}
-
-function cleanName(name?: string): string {
-  if (!name) {
-    return ''
-  }
-  return name.replace('?', '')
-}
-
-/**
- * A class to generate JSON schema from an ApiShapeUnion declaration to use with the Monaco editor schemas.
- */
-export class ApiMonacoSchemaGenerator {
-  schemas: IMonacoSchema[] = []
-
-  /**
-   * @param parentUri The URI for the fileMatch property.
-   */
-  generate(schema: IShapeUnion, parentUri: string): IMonacoSchema[] {
-    this.schemas = []
-    if (!schema) {
-      return []
-    }
-    const { types } = schema
-    if (types.includes(ns.w3.shacl.NodeShape)) {
-      return this.fromNodeShape(schema as IApiNodeShape, parentUri)
-    }
-    return []
-  }
-
-  /**
-   * @param parentUri The URI for the fileMatch property.
-   */
-  fromNodeShape(schema: IApiNodeShape, parentUri?: string): IMonacoSchema[] {
-    const { id, name } = schema
-    const properties = collectNodeProperties(schema)
-    const content: IMonacoObjectProperty = {
-      title: cleanName(name),
-      type: 'object',
-      properties: {},
-      required: [],
-    }
-    const result: IMonacoSchema = {
-      uri: id,
-      schema: content,
-    }
-    if (parentUri) {
-      result.fileMatch = [parentUri]
-    }
-    this.schemas.push(result)
-    if (!Array.isArray(properties) || !properties.length) {
-      return this.schemas
-    }
-    properties.forEach((property) => this.appendSchemaProperty(content, property))
-    return this.schemas
-  }
-
-  appendSchemaProperty(content: IMonacoObjectProperty, property: IApiPropertyShape): void {
-    const { name, range, minCount } = property
-    if (!range) {
-      return
-    }
-    const value = this.rangeToPropertySchema(range)
-    if (value && name) {
-      content.properties[name] = value
-      if (minCount === 1) {
-        content.required.push(name)
-      }
-    }
-  }
-
-  rangeToPropertySchema(
-    range: IShapeUnion
-  ): IMonacoScalarProperty | IMonacoObjectProperty | IMonacoArrayProperty | undefined {
-    const { types } = range
-    if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
-      return this.scalarRangeToPropertySchema(range as IApiScalarShape)
-    }
-    if (types.includes(ns.w3.shacl.NodeShape)) {
-      return this.nodeShapeRangeToPropertySchema(range as IApiNodeShape)
-    }
-    if (types.includes(ns.aml.vocabularies.shapes.ArrayShape)) {
-      return this.arrayShapeRangeToPropertySchema(range as IApiArrayShape)
-    }
-    return undefined
-  }
-
-  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 = {
-      $id: id,
-      type,
-      title: cleanName(displayName || name),
-    }
-    if (description) {
-      result.description = description
-    }
-    if (defaultValueStr) {
-      result.default = defaultValueStr
-    }
-    if (typeof exclusiveMaximum === 'boolean') {
-      result.exclusiveMaximum = exclusiveMaximum
-    }
-    if (typeof exclusiveMinimum === 'boolean') {
-      result.exclusiveMinimum = exclusiveMinimum
-    }
-    if (typeof maxLength === 'number') {
-      result.maxLength = maxLength
-    }
-    if (typeof minLength === 'number') {
-      result.minLength = minLength
-    }
-    if (typeof minimum === 'number') {
-      result.minimum = minimum
-    }
-    if (typeof maximum === 'number') {
-      result.maximum = maximum
-    }
-    if (typeof multipleOf === 'number') {
-      result.multipleOf = multipleOf
-    }
-    if (typeof pattern === 'string') {
-      result.pattern = pattern
-    }
-    if (typeof readOnly === 'boolean') {
-      result.readOnly = readOnly
-    }
-    if (typeof writeOnly === 'boolean') {
-      result.writeOnly = writeOnly
-    }
-    switch (schema.dataType) {
-      case ns.aml.vocabularies.shapes.dateTimeOnly:
-        result.format = 'date-time'
-        break
-      case ns.w3.xmlSchema.date:
-        result.format = 'date'
-        break
-      case ns.w3.xmlSchema.time:
-        result.format = 'time'
-        break
-      default:
-    }
-    if (Array.isArray(values) && values.length) {
-      // enum properties
-      result.enum = []
-      values.forEach((value) => {
-        const { types } = value
-        if (types.includes(ns.aml.vocabularies.data.Scalar)) {
-          const typed = value as IApiScalarNode
-          if (typed.value) {
-            ;(result.enum as string[]).push(typed.value)
-          }
-        }
-      })
-    }
-    return result
-  }
-
-  /**
-   * Translates AMF data type to JSON schema data type.
-   */
-  schemaTypeToJsonDataType(schemaType?: string): string {
-    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.boolean:
-      case ns.aml.vocabularies.shapes.boolean:
-        return 'boolean'
-      case ns.aml.vocabularies.shapes.nil:
-      case ns.w3.xmlSchema.nil:
-        return 'null'
-      default:
-        return 'string'
-    }
-  }
-
-  nodeShapeRangeToPropertySchema(schema: IApiNodeShape): IMonacoObjectProperty {
-    const { description, name, displayName, id, readOnly, writeOnly, closed, minProperties, maxProperties } = schema
-    const properties = collectNodeProperties(schema)
-
-    const result: IMonacoObjectProperty = {
-      $id: id,
-      type: 'object',
-      title: cleanName(displayName || name),
-      properties: {},
-      required: [],
-    }
-    if (description) {
-      result.description = description
-    }
-    if (typeof readOnly === 'boolean') {
-      result.readOnly = readOnly
-    }
-    if (typeof writeOnly === 'boolean') {
-      result.writeOnly = writeOnly
-    }
-    if (typeof closed === 'boolean') {
-      result.additionalProperties = !closed
-    }
-    if (typeof minProperties === 'number') {
-      result.minProperties = minProperties
-    }
-    if (typeof maxProperties === 'number') {
-      result.maxProperties = maxProperties
-    }
-    properties.forEach((property) => this.appendSchemaProperty(result, property))
-    return result
-  }
-
-  arrayShapeRangeToPropertySchema(schema: IApiArrayShape): IMonacoArrayProperty {
-    const { description, name, displayName, id, readOnly, writeOnly, items, minItems, maxItems, uniqueItems } = schema
-    const result: IMonacoArrayProperty = {
-      $id: id,
-      type: 'array',
-      title: cleanName(displayName || name),
-      items: {
-        anyOf: [],
-      },
-      required: [],
-      additionalItems: false,
-    }
-    if (description) {
-      result.description = description
-    }
-    if (typeof readOnly === 'boolean') {
-      result.readOnly = readOnly
-    }
-    if (typeof writeOnly === 'boolean') {
-      result.writeOnly = writeOnly
-    }
-    if (typeof uniqueItems === 'boolean') {
-      result.uniqueItems = uniqueItems
-    }
-    if (items) {
-      const value = this.rangeToPropertySchema(items)
-      if (value) {
-        result.items.anyOf.push(value)
-      }
-    }
-    if (typeof minItems === 'number') {
-      result.minItems = minItems
-    }
-    if (typeof maxItems === 'number') {
-      result.maxItems = maxItems
-    }
-    return result
-  }
-}