@api-client/core 0.19.10 → 0.19.11

package/data/apis/secured-api/secured-api.raml

@@ -1,231 +0,0 @@
-#%RAML 1.0
-title: Authorization Test API
-version: v1
-baseUri: http://api.domain.com/
-
-annotationTypes:
-  oauth-2-custom-settings: !include oauth-2-custom-settings.raml
-
-types:
-  apiTokens: # each is optional, not exclusive with anything
-    properties:
-      userToken: number
-      applicationToken?: number
-
-securitySchemes:
-  basic:
-    type: Basic Authentication
-    description: |
-      This API supports Basic Authentication.
-  digest:
-    description: |
-      This API supports DigestSecurityScheme Authentication.
-    type: Digest Authentication
-  passthrough: !include passthrough.raml
-  passthroughQueryString: !include passthrough-querystring.raml
-  custom_scheme:
-    description: |
-      A custom security scheme for authenticating requests.
-    type: x-custom
-    displayName: RAML's custom scheme
-    describedBy:
-      headers:
-        SpecialToken:
-          description: |
-            Used to send a custom token.
-          type: string
-      queryString:
-        type: apiTokens
-        examples:
-          first:
-            value:
-              userToken: 1234
-              applicationToken: 5678
-          second:
-            value:
-              start: 1239874566
-              page-size: 987321456
-      responses:
-        401:
-          description: |
-            Bad token.
-        403:
-  custom1: !include x-custom.raml
-  custom2: !include x-other.raml
-  custom3: !include x-query-string.raml
-  oauth2:
-    type: OAuth 2.0
-    displayName: Regular OAuth 2.0 definition
-    settings:
-      accessTokenUri: https://token.com
-      authorizationUri: https://auth.com
-      scopes: [profile, email]
-    describedBy:
-      queryParameters:
-        access_token:
-          type: string
-          description: Apply access token here.
-      headers:
-        Authorization:
-          type: string
-  oauth2grants:
-    type: OAuth 2.0
-    displayName: OAuth 2 grants security
-    settings:
-      accessTokenUri: https://token.com
-      authorizationUri: https://auth.com
-      authorizationGrants: authorization_code
-      scopes: [profile, email]
-    describedBy:
-      queryParameters:
-        access_token:
-          type: string
-          description: Apply access token here.
-      headers:
-        Authorization:
-          type: string
-  oauth2Annotation:
-    type: OAuth 2.0
-    displayName: OAuth 2.0 with annotation
-    settings:
-      (oauth-2-custom-settings):
-        # ignoreDefaultGrants:
-        authorizationGrants: [annotated_custom_grant, annotated_custom_grant2]
-        authorizationSettings:
-          queryParameters:
-            resource:
-              type: string
-              required: true
-              description: |
-                A resource ID that defines a domain of authorization.
-              displayName: Hello query parameeter
-              default: default
-              examples:
-                named: named example value
-                otherExample: test example value
-              pattern: "[a-zA-Z]+"
-              maxLength: 12
-              minLength: 3
-            numericParam:
-              type: number
-              minimum: 10
-              maximum: 20
-              multipleOf: 2
-              format: float
-              required: false
-              example: 22
-            dateParam:
-              type: date-only
-              required: false
-            repeatableParam1:
-              type: string[]
-              required: false
-            repetableParam2:
-              type: array
-              items: integer
-              required: false
-        accessTokenSettings:
-          queryParameters:
-            queryTokenResource: string
-            detailedTokenResource:
-              type: number
-              description: some description
-              required: false
-          headers:
-            x-token-resource:
-              type: number
-              default: 123
-          body:
-            bodyTokenResource: string
-            bodyDetailed:
-              type: boolean
-              required: true
-              displayName: Body detailed property
-              default: true
-      accessTokenUri: https://token.com
-      authorizationUri: https://auth.com
-      authorizationGrants: [authorization_code, password, client_credentials, implicit]
-      scopes: [profile, email]
-    describedBy:
-      queryParameters:
-        access_token:
-          type: string
-          description: Apply access token here.
-  oauth2queryDelivery: !include oauth2-query-delivery.raml
-  oauth2headerDelivery: !include oauth2-header-delivery.raml
-  oauth2noDelivery: !include oauth2-no-delivery.raml
-  oauth2noGrants: !include oauth2-no-grants.raml
-  oauth2pkce: !include oauth2-pkce.raml
-  oauth1: !include oauth_1_0.raml
-  oauth1signature: !include oauth_1_0_signature.raml
-  oauth1noSignature: !include oauth_1_0_no-signature.raml
-  oauth1noSettings: !include oauth_1_0_no-settings.raml
-/basic:
-  get:
-    securedBy: basic
-/digest:
-  get:
-    securedBy: digest
-/passthrough:
-  get:
-    securedBy: passthrough
-/passthrough-query-string:
-  get:
-    securedBy: passthroughQueryString
-/custom-query-string:
-  get:
-    securedBy: custom_scheme
-/custom1:
-  get:
-    securedBy: [custom1]
-/custom2:
-  get:
-    securedBy: [custom2]
-/custom3:
-  get:
-    securedBy: [custom3]
-/oauth2:
-  post:
-    securedBy: [oauth2]
-/oauth2-with-annotations:
-  get:
-    securedBy: [oauth2Annotation]
-/oauth2-with-grant-list:
-  get:
-    securedBy: [oauth2grants]
-/oauth2-query-delivery:
-  get:
-    securedBy: [oauth2queryDelivery]
-/oauth2-header-delivery:
-  get:
-    securedBy: [oauth2headerDelivery]
-/oauth2-no-delivery:
-  get:
-    securedBy: [oauth2noDelivery]
-/oauth2-no-grants:
-  get:
-    securedBy: [oauth2noGrants]
-/oauth2-pkce:
-  get:
-    securedBy: [oauth2pkce]
-/oauth1:
-  get:
-    securedBy: [oauth1]
-/oauth1-signature:
-  get:
-    securedBy: [oauth1signature]
-/oauth1-nosignature:
-  get:
-    securedBy: [oauth1noSignature]
-/oauth1-nosettings:
-  get:
-    securedBy: [oauth1noSettings]
-/combo-types:
-  get:
-    securedBy: [basic, digest, passthroughQueryString, custom1, oauth2, oauth1]
-/all-oauth2:
-  get:
-    securedBy: [oauth2, oauth2Annotation, oauth2grants, oauth2queryDelivery, oauth2headerDelivery, oauth2noDelivery, oauth2noGrants]
-/nil-oauth2:
-  get:
-    securedBy: [null, oauth2]

package/data/apis/secured-api/x-custom.raml

@@ -1,33 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  A custom security scheme for authenticating requests.
-  It allows to set `SpecialToken` header from the authorization panel.
-  The same header should be rendered in the headers editor with console using
-  RAML JS parser.
-  With `AMF` console this is separated information.
-  This scheme also sets `debugToken` and `booleanToken` query parameters.
-  Both are enums, however `booleanToken` can only have `true` and `false`
-  values.
-type: x-my-custom
-describedBy:
-  headers:
-    SpecialTokenHeader:
-      description: |
-        Used to send a custom token.
-      type: string
-  queryParameters:
-    debugTokenParam:
-      description: Select one of available values to run the request in the debug mode with selected level.
-      enum: [Info, Log, Warning, Error, Critical]
-      type: string
-      required: false
-    booleanTokenParam:
-      description: Just to test boolean values.
-      type: boolean
-      default: true
-  responses:
-    401:
-      description: |
-        Bad token.
-    403:

package/data/apis/secured-api/x-other.raml

@@ -1,29 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  Other custom security method for authorization.
-type: x-custom
-describedBy:
-  queryParameters:
-    apiUserIdParam:
-      description: |
-        Your api user ID. Some imaginary value.
-      type: number
-      required: true
-    apiNonceParam:
-      description: Random string
-      type: string
-  responses:
-    401:
-      description: |
-        Bad token autorization.
-      body:
-        application/json:
-          type: object
-          properties:
-            error:
-              type: boolean
-              description: Always true. Indicates that the response is errord.
-            message:
-              type: string
-              description: Human readable message describing the error.

package/data/apis/secured-api/x-query-string.raml

@@ -1,16 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  Tests for queryString RAML's property
-type: x-custom
-describedBy:
-  queryString:
-    type: object
-    properties:
-      queryStringProperty1:
-        type: number
-        required: true
-      queryStringProperty2:
-        description: Random string
-        type: string
-        required: false

package/data/apis/tracked-examples/datatypes/employee.raml

@@ -1,5 +0,0 @@
-#%RAML 1.0 DataType
-type: object
-properties:
-  id: integer
-  name: string

package/data/apis/tracked-examples/examples/employee.raml

@@ -1,4 +0,0 @@
-#%RAML 1.0 NamedExample
-employee:
-  id: 1
-  name: "John"

package/data/apis/tracked-examples/examples/employees.raml

@@ -1,8 +0,0 @@
-#%RAML 1.0 NamedExample
-employees:
-  -
-    id: 1
-    name: John
-  -
-    id: 2
-    name: Sam

package/data/apis/tracked-examples/tracked-to-linked.raml

@@ -1,28 +0,0 @@
-#%RAML 1.0
-title: optional-attributes-test
-
-mediaType: application/xml
-
-types:
-  Employee: !include datatypes/employee.raml
-
-/employees:
-  get:
-    body:
-      application/json:
-        type: Employee[]
-        examples: !include examples/employees.raml
-  post:
-    body:
-      application/json:
-        type: Employee
-        examples: !include examples/employee.raml
-  delete:
-    body:
-      application/json:
-        type: Employee
-        examples: !include examples/employee.raml
-  head:
-    body:
-      type: Employee
-      examples: !include examples/employee.raml

package/data/model.js

@@ -1,129 +0,0 @@
-/* eslint-disable no-undef */
-
-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('schema-api/schema-api.raml', { type: 'RAML 1.0' })
-config.set('raml-date/raml-date.raml', { type: 'RAML 1.0' })
-config.set('recursive/recursive.raml', { type: 'RAML 1.0' })
-config.set('oas-types/oas-types.yaml', { type: 'OAS 3.0' })
-config.set('oas-date/oas-date.yaml', { type: 'OAS 3.0' })
-config.set('oas-unions/oas-unions.yaml', { type: 'OAS 3.0' })
-config.set('amf-helper-api/amf-helper-api.raml', { type: 'RAML 1.0' })
-config.set('async-api/async-api.yaml', { type: 'ASYNC 2.0' })
-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('multiple-servers/multiple-servers.yaml', { type: 'OAS 3.0', mime: 'application/yaml' })
-config.set('APIC-187/APIC-187.raml', { type: 'RAML 1.0' })
-config.set('APIC-188/APIC-188.raml', { type: 'RAML 1.0' })
-config.set('APIC-233/APIC-233.raml', { type: 'RAML 0.8' })
-config.set('APIC-391/APIC-391.raml', { type: 'RAML 1.0' })
-config.set('APIC-487/APIC-487.raml', { type: 'RAML 1.0' })
-config.set('APIC-655/APIC-655.raml', { type: 'RAML 1.0' })
-config.set('APIC-689/APIC-689.raml', { type: 'RAML 1.0' })
-config.set('APIC-690/APIC-690.raml', { type: 'RAML 1.0' })
-config.set('example-generator-api/example-generator-api.raml', { type: 'RAML 1.0' })
-config.set('SE-10469/SE-10469.raml', { type: 'RAML 1.0' })
-config.set('SE-13092/SE-13092.raml', { type: 'RAML 1.0' })
-config.set('SE-22063/SE-22063.raml', { type: 'RAML 1.0' })
-config.set('tracked-examples/tracked-to-linked.raml', { type: 'RAML 1.0' })
-config.set('petstore/petstore.yaml', { type: 'OAS 3.0' })
-config.set('arc-demo-api/arc-demo-api.raml', { type: 'RAML 1.0' })
-config.set('APIC-483/APIC-483.raml', { type: 'RAML 1.0' })
-config.set('oas-3-api/oas-3-api.yaml', { type: 'OAS 3.0' })
-config.set('secured-api/secured-api.raml', { type: 'RAML 1.0' })
-
-const srcFolder = 'data/apis/'
-const descFolder = 'data/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()
-        }
-        console.error(`Unable to finish: `, message)
-        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('/'))
-    }
-    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 ro = new RenderOptions().withoutAmfJsonLdSerialization().withoutCompactUris().withoutCompactedEmission().withPrettyPrint();
-    const apiConfiguration = this.getConfiguration(vendor).withRenderOptions(ro)
-    const client = apiConfiguration.baseUnitClient()
-    // console.log(`file://${location}`);
-    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)