@api-client/ui 0.1.9 → 0.2.2

package/demo/lib/io/ApiStore.ts

@@ -1,16 +0,0 @@
-export class ApiStore {
-  channel: BroadcastChannel
-
-  constructor() {
-    this.channel = new BroadcastChannel('api-store')
-  }
-
-  async initialize(): Promise<void> {
-    this.channel.addEventListener('message', this._messageHandler.bind(this))
-  }
-
-  protected _messageHandler(e: MessageEvent): void {
-    const { data } = e
-    console.log('ApiStore', data)
-  }
-}

package/demo/lib/io/SharedWorkerThread.ts

@@ -1,31 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-import { IoThread } from '../../../src/bindings/base/IoThread.js'
-import { IoCommand, IoEvent, IoNotification } from '../../../src/bindings/base/PlatformBindings.js'
-
-/**
- * Base class for ShareWorker threads.
- */
-export default class SharedWorkerThread extends IoThread {
-  ports: MessagePort[] = []
-
-  async initialize(): Promise<void> {
-    // @ts-ignore
-    self.onconnect = (e: any): void => {
-      const port = e.ports[0] as MessagePort
-      this.ports.push(port)
-      port.addEventListener('message', this._messageHandler.bind(this))
-      port.start()
-      port.postMessage('ready')
-    }
-  }
-
-  postMessage(message: IoNotification | IoEvent): void {
-    this.ports.forEach((p) => p.postMessage(message))
-  }
-
-  protected _messageHandler(e: MessageEvent): void {
-    const event = e.data as IoCommand | IoEvent
-    this.handleMessage(event)
-  }
-}

package/demo/lib/io/main.ts

@@ -1,23 +0,0 @@
-import { ApiStore } from './ApiStore.js'
-
-/**
- * Mocks some of the IO process' functionality.
- *
- * Call to this class are only async.
- *
- * In an electron application the is the background process
- * that runs the application logic.
- *
- * This mimics some of the behavior of the IO process.
- */
-export class IoProcess {
-  store: ApiStore
-
-  constructor() {
-    this.store = new ApiStore()
-  }
-
-  async initialize(): Promise<void> {
-    await this.store.initialize()
-  }
-}

package/demo/model.js

@@ -1,203 +0,0 @@
-import pkg from 'amf-client-js'
-import path from 'path'
-import { writeFile, mkdir } from 'fs/promises'
-
-/** @typedef {import('amf-client-js').AMFConfiguration} AMFConfiguration */
-/**
- * @typedef ApiConfiguration
- * @property {string} type
- * @property {string=} mime
- */
-
-const { RAMLConfiguration, OASConfiguration, AsyncAPIConfiguration, RenderOptions, PipelineId } = pkg
-
-/** @type {Map<string, ApiConfiguration>} */
-const config = new Map()
-config.set('demo-api/demo-api.raml', { type: 'RAML 1.0' })
-config.set('amf-helper-api/amf-helper-api.raml', { type: 'RAML 1.0' })
-config.set('navigation-api/navigation-api.raml', { type: 'RAML 1.0' })
-config.set('security-api/security-api.raml', { type: 'RAML 1.0' })
-config.set('array-body/array-body.raml', { type: 'RAML 1.0' })
-config.set('google-drive-api/google-drive-api.raml', { type: 'RAML 1.0' })
-config.set('appian-api/appian-api.raml', { type: 'RAML 1.0' })
-config.set('nexmo-sms-api/nexmo-sms-api.raml', { type: 'RAML 1.0' })
-config.set('httpbin/httpbin.json', { type: 'OAS 2.0', mime: 'application/json' })
-config.set('oas-demo/oas-demo.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('21143/21143.json', { type: 'OAS 2.0' })
-config.set('APIC-15/APIC-15.raml', { type: 'RAML 1.0' })
-config.set('apic-83/apic-83.raml', { type: 'RAML 1.0' })
-config.set('APIC-168/APIC-168.raml', { type: 'RAML 1.0' })
-config.set('apic-169/apic-169.raml', { type: 'RAML 1.0' })
-config.set('APIC-282/APIC-282.raml', { type: 'RAML 1.0' })
-config.set('APIC-289/APIC-289.yaml', { type: 'OAS 2.0', mime: 'application/yaml' })
-config.set('APIC-298/APIC-298.json', { type: 'OAS 2.0', mime: 'application/json' })
-config.set('APIC-332/APIC-332.raml', { type: 'RAML 1.0' })
-config.set('APIC-349-cache-resolution/APIC-349-cache-resolution.raml', { type: 'RAML 1.0' })
-config.set('APIC-390/APIC-390.raml', { type: 'RAML 1.0' })
-config.set('APIC-429/APIC-429.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('APIC-435/APIC-435.yaml', { type: 'OAS 2.0', mime: 'application/yaml' })
-config.set('APIC-449/APIC-449.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('APIC-463/APIC-463.raml', { type: 'RAML 1.0' })
-config.set('APIC-480/APIC-480.raml', { type: 'RAML 1.0' })
-config.set('APIC-483/APIC-483.raml', { type: 'RAML 1.0' })
-config.set('APIC-550/APIC-550.raml', { type: 'RAML 1.0' })
-config.set('APIC-553/APIC-553.raml', { type: 'RAML 1.0' })
-config.set('APIC-554/APIC-554.raml', { type: 'RAML 1.0' })
-config.set('APIC-554-ii/APIC-554-ii.raml', { type: 'RAML 1.0' })
-config.set('APIC-560/APIC-560.yaml', { type: 'ASYNC 2.0' })
-config.set('APIC-582/APIC-582.yaml', { type: 'ASYNC 2.0' })
-config.set('APIC-613/APIC-613.raml', { type: 'RAML 1.0' })
-config.set('APIC-631/APIC-631.raml', { type: 'RAML 1.0' })
-config.set('APIC-641/APIC-641.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('APIC-649/APIC-649.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('APIC-650/APIC-650.yaml', { type: 'OAS 3.0' })
-config.set('APIC-667/APIC-667.raml', { type: 'RAML 1.0' })
-config.set('APIC-671/APIC-671.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('APIC-689/APIC-689.raml', { type: 'RAML 1.0' })
-config.set('APIC-711/APIC-711.raml', { type: 'RAML 1.0' })
-config.set('aap-1698/aap-1698.raml', { type: 'RAML 1.0' })
-config.set('SE-10469/SE-10469.raml', { type: 'RAML 1.0' })
-config.set('SE-11155/SE-11155.raml', { type: 'RAML 1.0' })
-config.set('SE-11415/SE-11415.raml', { type: 'RAML 1.0' })
-config.set('SE-11508/SE-11508.raml', { type: 'RAML 1.0' })
-config.set('SE-12042/SE-12042.raml', { type: 'RAML 1.0' })
-config.set('SE-12224/SE-12224.raml', { type: 'RAML 1.0' })
-config.set('SE-12291/SE-12291.json', { type: 'OAS 2.0', mime: 'application/json' })
-config.set('SE-12752/SE-12752.raml', { type: 'RAML 1.0' })
-config.set('SE-12957/SE-12957.json', { type: 'OAS 2.0', mime: 'application/json' })
-config.set('SE-12959/SE-12959.json', { type: 'OAS 2.0', mime: 'application/json' })
-config.set('SE-17897/SE-17897.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('SE-19215/SE-19215.raml', { type: 'RAML 1.0' })
-config.set('SE-19500/SE-19500.raml', { type: 'RAML 1.0' })
-config.set('oauth1-fragment/oauth1-fragment.raml', { type: 'RAML 1.0' })
-config.set('oauth2-fragment/oauth2-fragment.raml', { type: 'RAML 1.0' })
-config.set('type-fragment/type-fragment.raml', { type: 'RAML 1.0' })
-config.set('documentation-fragment/documentation-fragment.raml', { type: 'RAML 1.0' })
-config.set('lib-fragment/lib-fragment.raml', { type: 'RAML 1.0' })
-config.set('example-fragment/example-fragment.raml', { type: 'RAML 1.0' })
-config.set('multi-server/multi-server.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('async-api/async-api.yaml', { type: 'ASYNC 2.0' })
-config.set('Streetlights/streetlights.yaml', { type: 'ASYNC 2.0' })
-config.set('streetlights2/streetlights2.yaml', { type: 'ASYNC 2.0' })
-config.set('api-keys/api-keys.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('oauth-flows/oauth-flows.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('oas-bearer/oas-bearer.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('oauth-pkce/oauth-pkce.raml', { type: 'RAML 1.0' })
-config.set('secured-unions/secured-unions.yaml', { type: 'OAS 3.0' })
-config.set('secured-api/secured-api.raml', { type: 'RAML 1.0' })
-config.set('oas-callbacks/oas-callbacks.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('documented-api/documented-api.raml', { type: 'RAML 1.0' })
-config.set('annotated-api/annotated-api.raml', { type: 'RAML 1.0' })
-config.set('examples-api/examples-api.raml', { type: 'RAML 1.0' })
-config.set('enum-test/enum-test.raml', { type: 'RAML 1.0' })
-config.set('oas-api/Petstore-v2.yaml', { type: 'OAS 2.0', mime: 'application/yaml' })
-config.set('petstore/petstore.yaml', { type: 'OAS 3.0' })
-config.set('new-oas3-types/new-oas3-types.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('oas-api/read-only-properties.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('anyOf/anyOf.yaml', { type: 'ASYNC 2.0' })
-config.set('steveTest-1/stevetest.json', { type: 'OAS 2.0' })
-config.set('mocking-service/mocking-service.raml', { type: 'RAML 1.0' })
-config.set('no-endpoints/no-endpoints.raml', { type: 'RAML 1.0' })
-config.set('no-server/no-server.raml', { type: 'RAML 1.0' })
-config.set('prevent-xss/prevent-xss.json', { type: 'OAS 2.0', mime: 'application/json' })
-config.set('loan-ms/loan-microservice.json', { type: 'OAS 2.0', mime: 'application/json' })
-config.set('annotated-parameters/annotated-parameters.raml', { type: 'RAML 1.0' })
-config.set('oas-3-api/oas-3-api.yaml', { type: 'OAS 3.0' })
-config.set('modular-api/modular-api.raml', { type: 'RAML 1.0' })
-config.set('servers-api/servers-api.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('no-servers-api/no-servers-api.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('multiple-servers/multiple-servers.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('flattened-api/flattened-api.raml', { type: 'RAML 1.0', mime: 'application/yaml', flattened: true })
-config.set('expanded-api/expanded-api.raml', { type: 'RAML 1.0', mime: 'application/yaml', flattened: false })
-config.set('ext-docs/ext-docs.yaml', { type: 'OAS 3.0' })
-config.set('missing-endpoints/missing-endpoints.raml', { type: 'RAML 1.0' })
-config.set('unordered-endpoints/unordered-endpoints.raml', { type: 'RAML 1.0' })
-config.set('rearrange-api/rearrange-api.raml', { type: 'RAML 1.0' })
-config.set('simple-api/simple-api.raml', { type: 'RAML 1.0' })
-config.set('types-list/types-list.raml', { type: 'RAML 1.0' })
-config.set('not-schema/not-schema.yaml', { type: 'OAS 3.0' })
-
-// do not use node's path.join() here! AMF only allow `/` separators
-const srcFolder = 'demo/apis/'
-const descFolder = 'demo/models/'
-
-class ApiParser {
-  /**
-   * @param {Map<string, ApiConfiguration>} list
-   */
-  async batch(list) {
-    await mkdir(descFolder, { recursive: true })
-    for (const [file, info] of list) {
-      // console.log('Processing API file', file)
-      try {
-        await this.run(file, info.type)
-      } catch (e) {
-        let message
-        if (e.message) {
-          message = e.message
-        } else {
-          message = e.toString()
-        }
-        // eslint-disable-next-line no-undef
-        console.error(`Unable to finish: `, message)
-        // eslint-disable-next-line no-undef
-        process.exit(1)
-      }
-    }
-  }
-
-  /**
-   * @param {string} file
-   * @param {string} vendor
-   * @returns {Promise<void>}
-   */
-  async run(file, vendor) {
-    let destFile = `${file.substring(0, file.lastIndexOf('.'))}.json`
-    if (destFile.indexOf('/') !== -1) {
-      destFile = destFile.substring(destFile.lastIndexOf('/'))
-    }
-    // do not use node's path.join() here! AMF only allow `/` separators
-    const location = `${srcFolder}/${file}`
-    const content = await this.parse(vendor, location)
-    const destination = path.join(descFolder, destFile)
-    await writeFile(destination, content)
-  }
-
-  /**
-   * @param {string} vendor
-   * @param {string} location
-   * @returns {Promise<string>}
-   */
-  async parse(vendor, location) {
-    const ro = new RenderOptions().withSourceMaps().withCompactUris()
-    const apiConfiguration = this.getConfiguration(vendor).withRenderOptions(ro)
-    const client = apiConfiguration.baseUnitClient()
-    const result = await client.parse(`file://${location}`)
-    const transformed = client.transform(result.baseUnit, PipelineId.Editing)
-    return client.render(transformed.baseUnit, 'application/ld+json')
-  }
-
-  /**
-   * @param {string} vendor
-   * @returns {AMFConfiguration}
-   */
-  getConfiguration(vendor) {
-    switch (vendor) {
-      case 'RAML 0.8':
-        return RAMLConfiguration.RAML08()
-      case 'RAML 1.0':
-        return RAMLConfiguration.RAML10()
-      case 'OAS 2.0':
-        return OASConfiguration.OAS20()
-      case 'OAS 3.0':
-        return OASConfiguration.OAS30()
-      case 'ASYNC 2.0':
-        return AsyncAPIConfiguration.Async20()
-      default:
-        throw new Error(`Unknown vendor: ${vendor}`)
-    }
-  }
-}
-
-const parser = new ApiParser()
-parser.batch(config)

package/demo/store/IpAddress.js

@@ -1,15 +0,0 @@
-import { networkInterfaces } from 'os'
-
-const nets = networkInterfaces()
-
-let ip = '127.0.0.1'
-
-for (const interfaceName of Object.keys(nets)) {
-  for (const net of nets[interfaceName]) {
-    if (net.family === 'IPv4' && !net.internal) {
-      ip = net.address
-    }
-  }
-}
-
-export default ip

package/demo/store/StorePlugin.js

@@ -1,18 +0,0 @@
-/** @typedef {import('@web/dev-server-core').Plugin} Plugin */
-
-// eslint-disable-next-line no-undef
-const systemVariables = { ...process.env }
-
-export default /** @type Plugin */ ({
-  name: 'api-store',
-
-  serve(context) {
-    if (context.path === '/demo/env.js') {
-      const data = {
-        systemVariables,
-      }
-      return `export default ${JSON.stringify(data)}`
-    }
-    return undefined
-  },
-})

package/demo/stores.md

@@ -1,5 +0,0 @@
-# Dev stores
-
-- http://api-client.me:8101/v1 - Dev store (requires process start)
-- http://api-client.me:8489/v1 - Multi user (local service)
-- http://localhost:8551/v1 - Single user (local service)

package/dev/amf-server/AmfParser.js

@@ -1,144 +0,0 @@
-import { fork } from 'child_process'
-
-/** @typedef {import('child_process').ChildProcess} ChildProcess */
-/** @typedef {import('../types').ProcessingStatus} ProcessingStatus */
-/** @typedef {import('../types').ParserProcessResult} ParserProcessResult */
-/** @typedef {import('../types').ParserProcessMessage} ParserProcessMessage */
-/** @typedef {import('../types').ContentParseCommand} ContentParseCommand */
-
-/**
- * A class that parses API content.
- */
-export class AmfParser {
-  constructor() {
-    /** @type ProcessingStatus */
-    this.status = 'initialized'
-    /**
-     * The result of the parser computations.
-     * Is is set when the status is `finished`
-     * @type any
-     */
-    this.result = undefined
-    /**
-     * Any error message that made the process failed.
-     * Is is set when the status is `failed`
-     * @type string
-     */
-    this.error = undefined
-    /** @type ChildProcess */
-    this.process = undefined
-
-    this.processExitHandler = this.processDisconnectHandler.bind(this)
-    this.processMessage = this.processMessage.bind(this)
-    this.processError = this.processError.bind(this)
-  }
-
-  /**
-   * Cancels the current job.
-   */
-  cancel() {
-    if (this.process && this.process.connected) {
-      this.process.disconnect()
-    }
-    this.status = 'failed'
-    this.error = 'The process was cancelled.'
-  }
-
-  /**
-   * Parses an API from the body
-   * @param {Buffer} body The request body
-   * @param {string} vendor API vendor.
-   * @param {string} mime API mime type.
-   * @returns {Promise<void>}
-   */
-  async parseText(body, vendor, mime) {
-    this.status = 'running'
-    const proc = this.createProcess()
-    this.process = proc
-    this.addProcessListeners(proc)
-    const command = /** @type ContentParseCommand */ ({
-      vendor,
-      mime,
-      content: body.toString('utf8'),
-    })
-    const message = /** @type ParserProcessMessage */ ({
-      action: 'parse-content',
-      command,
-    })
-    proc.send(message)
-  }
-
-  /**
-   * Creates a parser process.
-   * @returns {ChildProcess}
-   */
-  createProcess() {
-    // eslint-disable-next-line no-undef
-    const env = { ...process.env, NODE_OPTIONS: '--max-old-space-size=4096' }
-    const options = {
-      execArgv: [],
-      env,
-    }
-    const dir = import.meta.url.replace('AmfParser.js', '').replace('file:', '')
-    const proc = fork(`${dir}/ParserProcess.js`, options)
-    return proc
-  }
-
-  /**
-   * @param {ChildProcess} proc
-   */
-  addProcessListeners(proc) {
-    proc.on('disconnect', this.processDisconnectHandler)
-    proc.on('message', this.processMessage)
-    proc.on('error', this.processError)
-  }
-
-  /**
-   * Logic executed when the process finish.
-   */
-  processDisconnectHandler() {
-    if (!this.process) {
-      return
-    }
-    this.clearProcessListeners(this.process)
-    this.process = undefined
-    if (this.status !== 'failed') {
-      this.status = 'finished'
-    }
-  }
-
-  /**
-   * @param {ParserProcessResult} result
-   */
-  processMessage(result) {
-    this.status = result.status
-    if (result.status === 'failed') {
-      this.error = /** @type string */ (result.result)
-    } else {
-      this.result = /** @type string */ (result.result)
-    }
-    if (this.process.connected) {
-      this.process.disconnect()
-    }
-  }
-
-  /**
-   * @param {Error} err
-   */
-  processError(err) {
-    // eslint-disable-next-line no-undef
-    console.error(err)
-    this.status = 'failed'
-    this.error = err.message
-    if (this.process.connected) {
-      this.process.disconnect()
-    }
-  }
-
-  /**
-   * @param {ChildProcess} proc
-   */
-  clearProcessListeners(proc) {
-    proc.removeAllListeners()
-  }
-}

package/dev/amf-server/AmfService.js

@@ -1,136 +0,0 @@
-import { nanoid } from 'nanoid'
-import { ApiError } from './ApiError.js'
-import { AmfParser } from './AmfParser.js'
-
-/** @typedef {import('koa').Request} Request */
-/** @typedef {import('../types').AmfProcessItem} AmfProcessItem */
-/** @typedef {import('../types').ProcessingStatus} ProcessingStatus */
-
-/**
- * A demo page AMF parsing service.
- */
-export class AmfService {
-  constructor() {
-    /**
-     * @type {Map<string, AmfProcessItem>}
-     */
-    this.processes = new Map()
-  }
-
-  /**
-   * Handles the request when requesting parsing of an API content.
-   * @param {Request} request
-   * @returns {Promise<any>}
-   */
-  async parseText(request) {
-    const { method, headers } = request
-    if (method !== 'POST') {
-      throw new ApiError('Only POST method is allowed', 400)
-    }
-    const mime = headers['content-type']
-    const vendor = /** @type string */ (headers['x-api-vendor'])
-    if (!mime) {
-      throw new ApiError('content-type header is missing', 400)
-    }
-    if (!vendor) {
-      throw new ApiError('x-api-vendor header is missing', 400)
-    }
-    const body = await this.readBody(request)
-    const key = this.addProcess()
-    const info = this.processes.get(key)
-    info.parser.parseText(body, vendor, mime)
-    return key
-  }
-
-  /**
-   * Reads the request body.
-   * @param {Request} request
-   * @returns {Promise<Buffer>}
-   */
-  async readBody(request) {
-    return new Promise((resolve, reject) => {
-      let message
-      request.req.on('data', (chunk) => {
-        try {
-          if (message) {
-            // eslint-disable-next-line no-undef
-            message = Buffer.concat([message, chunk])
-          } else {
-            message = chunk
-          }
-        } catch (e) {
-          reject(e)
-          throw e
-        }
-      })
-      request.req.on('end', () => {
-        resolve(message)
-      })
-    })
-  }
-
-  /**
-   * Checks for the status of a job.
-   * @param {string} key
-   * @returns {Promise<ProcessingStatus>}
-   */
-  async checkStatus(key) {
-    if (!this.processes.has(key)) {
-      throw new ApiError(`Unknown resource ${key}`, 400)
-    }
-    const info = this.processes.get(key)
-    return info.parser.status
-  }
-
-  /**
-   * Reads the process' error message.
-   * @param {string} key The process key.
-   * @returns {Promise<string>} The error message set on the process.
-   */
-  async getError(key) {
-    if (!this.processes.has(key)) {
-      throw new ApiError(`Unknown resource ${key}`, 400)
-    }
-    const info = this.processes.get(key)
-    return info.parser.error
-  }
-
-  /**
-   * Reads the process' computation result.
-   * @param {string} key The process key.
-   * @returns {Promise<any>} The result
-   */
-  async getResult(key) {
-    if (!this.processes.has(key)) {
-      throw new ApiError(`Unknown resource ${key}`, 400)
-    }
-    const info = this.processes.get(key)
-    return info.parser.result
-  }
-
-  /**
-   * Creates a new instance of an AMF parser.
-   * @returns {string} The id of the parser instance.
-   */
-  addProcess() {
-    const key = nanoid()
-    const parser = new AmfParser()
-    const info = /** @type AmfProcessItem */ ({
-      parser,
-    })
-    this.processes.set(key, info)
-    return key
-  }
-
-  /**
-   * @param {string} key
-   */
-  removeProcess(key) {
-    if (!this.processes.has(key)) {
-      throw new ApiError(`Unknown resource ${key}`, 400)
-    }
-    const info = this.processes.get(key)
-    info.parser.cancel()
-    this.processes.delete(key)
-  }
-}

package/dev/amf-server/ApiError.js

@@ -1,10 +0,0 @@
-export class ApiError extends Error {
-  /**
-   * @param {string} message The error message
-   * @param {number} code The response status code.
-   */
-  constructor(message, code) {
-    super(message)
-    this.code = code
-  }
-}