@api-client/core 0.19.10 → 0.19.12

package/src/amf/Utils.ts

@@ -1,172 +0,0 @@
-import { AmfNamespace } from './definitions/Namespace.js'
-import { IApiNodeShape, IApiPropertyShape, IShapeUnion, IApiUnionShape } from './definitions/Shapes.js'
-
-/**
- * @param indent The current indent
- */
-export function toXml(obj: Record<string, unknown>, indent = 0): string {
-  if (typeof obj !== 'object') {
-    return obj
-  }
-  let xml = ''
-  const tabs = new Array(indent).fill('  ').join('')
-  Object.keys(obj).forEach((prop) => {
-    xml += Array.isArray(obj[prop]) ? '' : `${tabs}<${prop}>`
-    if (Array.isArray(obj[prop])) {
-      ;(obj[prop] as Record<string, unknown>[]).forEach((item) => {
-        xml += tabs
-        xml += `<${prop}>\n`
-        xml += toXml({ ...item }, indent + 1)
-        xml += tabs
-        xml += `</${prop}>\n`
-      })
-    } else if (typeof obj[prop] === 'object') {
-      xml += `\n`
-      xml += toXml({ ...(obj[prop] as Record<string, unknown>) }, indent + 1)
-      xml += tabs
-    } else {
-      xml += `${obj[prop]}`
-    }
-    xml += Array.isArray(obj[prop]) ? '' : `</${prop}>\n`
-  })
-  xml = xml.replace(/<\/?[0-9]{1,}>/g, '')
-  return xml
-}
-
-/**
- * @param fill The fill value (spaces to put in front of the value)
- * @param value The value to format
- */
-export function formatXmlValue(fill: string, value: unknown): string {
-  const typed = String(value)
-  const parts = typed.split('\n').filter((i) => !!i)
-  const formatted = parts.map((i) => `${fill}${i}`).join('\n')
-  return formatted
-}
-
-/**
- * Processes a value that should be a number.
- */
-export function parseNumberInput(value: unknown, defaultValue?: number): number | undefined {
-  if (typeof value === 'number') {
-    return value
-  }
-  const n = Number(value)
-  if (Number.isNaN(n)) {
-    return defaultValue
-  }
-  return n
-}
-
-/**
- * Processes a value that should be a number.
- */
-export function parseBooleanInput(value: unknown, defaultValue?: boolean): boolean | undefined {
-  const type = typeof value
-  if (type === 'boolean') {
-    return value as boolean
-  }
-  if (type === 'string') {
-    const trimmed = (value as string).trim()
-    if (trimmed === 'true') {
-      return true
-    }
-    if (trimmed === 'false') {
-      return false
-    }
-  }
-  return defaultValue
-}
-
-/**
- * Casts the `value` to the corresponding data type
- * @param type The w3 schema type
- */
-export function readTypedValue(value: unknown, type?: string): string | null | number | boolean | undefined {
-  if (value === undefined || value === null) {
-    return value
-  }
-  switch (type) {
-    case AmfNamespace.aml.vocabularies.shapes.number:
-    case AmfNamespace.aml.vocabularies.shapes.integer:
-    case AmfNamespace.aml.vocabularies.shapes.float:
-    case AmfNamespace.aml.vocabularies.shapes.long:
-    case AmfNamespace.aml.vocabularies.shapes.double:
-    case AmfNamespace.w3.xmlSchema.number:
-    case AmfNamespace.w3.xmlSchema.integer:
-    case AmfNamespace.w3.xmlSchema.float:
-    case AmfNamespace.w3.xmlSchema.long:
-    case AmfNamespace.w3.xmlSchema.double:
-      return parseNumberInput(value, 0)
-    case AmfNamespace.aml.vocabularies.shapes.boolean:
-    case AmfNamespace.w3.xmlSchema.boolean:
-      return parseBooleanInput(value, false)
-    case AmfNamespace.aml.vocabularies.shapes.nil:
-    case AmfNamespace.w3.xmlSchema.nil:
-      return null
-    default:
-      return value as string | null | number | boolean | undefined
-  }
-}
-
-/**
- * Picks the union member to render.
- * @param anyOf The list of union members
- * @param selectedUnions Optional list of domain ids of currently selected unions.
- *  When set is returns a member that is "selected" or the first member otherwise.
- */
-export function getUnionMember(anyOf: IShapeUnion[], selectedUnions: string[] = []): IShapeUnion {
-  let renderedItem: IShapeUnion | undefined
-  if (Array.isArray(selectedUnions) && selectedUnions.length) {
-    renderedItem = anyOf.find((item) => selectedUnions.includes(item.id))
-  }
-  if (!renderedItem) {
-    ;[renderedItem] = anyOf
-  }
-  return renderedItem
-}
-
-/**
- * @param {ApiNodeShape} schema
- * @param {string[]=} [selectedUnions=[]]
- * @returns {ApiPropertyShape[]}
- */
-export function collectNodeProperties(schema: IApiNodeShape, selectedUnions?: string[]): IApiPropertyShape[] {
-  let result: IApiPropertyShape[] = []
-  const { properties, inherits } = schema
-  if (properties.length) {
-    result = [...properties]
-  }
-  if (Array.isArray(inherits) && inherits.length) {
-    inherits.forEach((s) => {
-      let node = s
-      if (node.types.includes(AmfNamespace.aml.vocabularies.shapes.UnionShape)) {
-        const union = node as IApiUnionShape
-        const { anyOf = [] } = union
-        node = getUnionMember(anyOf, selectedUnions)
-      }
-      if (!node.types.includes(AmfNamespace.w3.shacl.NodeShape)) {
-        return
-      }
-      const typed = node as IApiNodeShape
-      // const p = typed.properties;
-      // if (Array.isArray(p) && p.length) {
-      //   result = result.concat(p);
-      // }
-      const upper = collectNodeProperties(typed)
-      if (upper.length) {
-        result = result.concat(upper)
-      }
-    })
-  }
-  const merged: IApiPropertyShape[] = []
-  result.forEach((item) => {
-    const existing = merged.find((i) => i.name === item.name)
-    if (existing) {
-      // this should (?) merge properties from the two.
-      return
-    }
-    merged.push(item)
-  })
-  return merged
-}

package/src/amf/data-node/DataNodeBase.ts

@@ -1,83 +0,0 @@
-import { AmfNamespace as ns } from '../definitions/Namespace.js'
-import { IApiArrayNode, IApiDataNode, IApiObjectNode, IApiScalarNode } from '../definitions/Shapes.js'
-import { readTypedValue } from '../Utils.js'
-
-type ReturnType = Record<string, unknown> | string | null | number | boolean | undefined
-
-/**
- * Base class for all schema generators based on AMF's DataNode which includes AMF's examples.
- */
-export class DataNodeBase {
-  /**
-   * @param node The AMF data node to turn into a schema.
-   * @returns Undefined when passed non-DataNode domain element.
-   */
-  processNode(node: IApiDataNode): ReturnType | ReturnType[] {
-    const { types } = node
-    if (types.includes(ns.aml.vocabularies.data.Scalar)) {
-      return this.processScalarNode(node as IApiScalarNode)
-    }
-    if (types.includes(ns.aml.vocabularies.data.Array)) {
-      return this.processArrayNode(node as IApiArrayNode)
-    }
-    if (types.includes(ns.aml.vocabularies.data.Object)) {
-      return this.processObjectNode(node as IApiObjectNode)
-    }
-    return undefined
-  }
-
-  /**
-   * @param scalar The scalar node to process.
-   * @returns The scalar value.
-   */
-  processScalarNode(scalar: IApiScalarNode): string | null | number | boolean | undefined {
-    return readTypedValue(scalar.value, scalar.dataType)
-  }
-
-  /**
-   * @param array The array node to process.
-   * @returns Array value.
-   */
-  processArrayNode(array: IApiArrayNode): ReturnType[] {
-    const container: ReturnType[] = []
-    array.members.forEach((member) => {
-      const result = this.processNode(member) as ReturnType
-      if (result !== undefined) {
-        container.push(result)
-      }
-    })
-    return container
-  }
-
-  /**
-   * @param object The object node to process.
-   * @returns Object value.
-   */
-  processObjectNode(object: IApiObjectNode): Record<string, unknown> {
-    const container: Record<string, unknown> = {}
-    const { properties } = object
-    Object.keys(properties).forEach((key) => {
-      const definition = properties[key]
-      const result = this.processNode(definition)
-      if (typeof result !== 'undefined') {
-        const name = this.normalizePropertyName(key)
-        container[name] = result
-      }
-    })
-    return container
-  }
-
-  /**
-   * Normalizes a property name. It decodes URL encoded values.
-   * @param name The property name to normalize
-   */
-  normalizePropertyName(name: string): string {
-    let result = name
-    try {
-      result = decodeURIComponent(result)
-    } catch {
-      // ...
-    }
-    return result
-  }
-}

package/src/amf/data-node/JsonDataNodeGenerator.ts

@@ -1,24 +0,0 @@
-import { IApiDataNode } from '../definitions/Shapes.js'
-import { DataNodeBase } from './DataNodeBase.js'
-
-/**
- * A class that processes AMF's `structuredValue` into a JSON example.
- */
-export class JsonDataNodeGenerator extends DataNodeBase {
-  /**
-   * Generates a JSON schema from the AMF's DataNode.
-   *
-   * @param node The AMF's data node to transform into a schema.
-   * @returns Undefined when passed non-DataNode domain element.
-   */
-  generate(node: IApiDataNode): string | number | false | null | undefined {
-    const result = this.processNode(node)
-    if (!result) {
-      return result
-    }
-    if (typeof result === 'string') {
-      return result
-    }
-    return JSON.stringify(result, null, 2)
-  }
-}

package/src/amf/data-node/README.md

@@ -1,3 +0,0 @@
-# Data node based schema generators
-
-In this directory you will find libraries to generate a schema from AMF generated examples (DataNode).

package/src/amf/data-node/UrlEncodedDataNodeGenerator.ts

@@ -1,49 +0,0 @@
-import { DataNodeBase } from './DataNodeBase.js'
-import { IApiDataNode } from '../definitions/Shapes.js'
-import { UrlEncoder } from '../../lib/parsers/UrlEncoder.js'
-
-/** @typedef {import('../../helpers/api').ApiDataNode} ApiDataNode */
-
-export class UrlEncodedDataNodeGenerator extends DataNodeBase {
-  /**
-   * Generates a JSON example from the structured value.
-   * @param node The AMF's data node to transform into a schema.
-   * @param shapeName When provided it wraps the returned value with the shape name.
-   * @returns Undefined when passed non-DataNode domain element.
-   */
-  generate(node: IApiDataNode, shapeName?: string): string | undefined {
-    const result = this.processNode(node)
-    if (result === undefined) {
-      return undefined
-    }
-    const isArray = Array.isArray(result)
-    if (shapeName && (typeof result !== 'object' || isArray)) {
-      if (isArray) {
-        return result
-          .map((v) => `${shapeName}[]=${v}`)
-          .filter((v) => !!v)
-          .join('&')
-      }
-      return `${shapeName}=${result}`
-    }
-    return this.createUrlEncoded(result as Record<string, unknown>)
-  }
-
-  createUrlEncoded(obj: Record<string, unknown>): string {
-    if (typeof obj !== 'object') {
-      return String(obj)
-    }
-    const parts = Object.keys(obj).map((key) => {
-      let value = obj[key]
-      if (typeof value === 'object' && value !== null) {
-        value = this.createUrlEncoded(value as Record<string, unknown>)
-      } else if (value) {
-        value = UrlEncoder.encodeQueryString(value as string, true)
-      } else if (value === null) {
-        value = 'null'
-      }
-      return `${key}=${value}`
-    })
-    return parts.join('&')
-  }
-}

package/src/amf/data-node/XmlDataNodeGenerator.ts

@@ -1,46 +0,0 @@
-import { DataNodeBase } from './DataNodeBase.js'
-import { toXml } from '../Utils.js'
-import { IApiDataNode } from '../definitions/Shapes.js'
-
-export interface IDataGenerateOptions {
-  /**
-   * A string to prefix the generated value with. This is added before the element.
-   */
-  indent?: number
-}
-
-/**
- * A class that processes AMF's `structuredValue` into an XML example.
- */
-export class XmlDataNodeGenerator extends DataNodeBase {
-  /**
-   * Generates a JSON example from the structured value.
-   *
-   * @param node The AMF's data node to transform into a schema.
-   * @param shapeName When provided it wraps the returned value with the shape name.
-   * @returns Undefined when passed non-DataNode domain element.
-   */
-  generate(
-    node: IApiDataNode,
-    shapeName?: string,
-    opts: IDataGenerateOptions = {}
-  ): string | number | false | null | undefined {
-    const result = this.processNode(node)
-    if (!result) {
-      return result
-    }
-    const { indent = 0 } = opts
-    const tabs = new Array(indent).fill('  ').join('')
-    if (shapeName) {
-      if (Array.isArray(result)) {
-        return result
-          .map((v) => `${tabs}<${shapeName}>${toXml(v as Record<string, unknown>)}</${shapeName}>`)
-          .filter((v) => !!v)
-          .join('\n')
-      }
-      // return `${tabs}<${shapeName}>${toXml(result)}</${shapeName}>`;
-      return `${toXml({ [shapeName]: result })}`
-    }
-    return `${toXml(result as Record<string, unknown>, indent)}`
-  }
-}