@api-client/core 0.19.10 → 0.19.11

package/tests/unit/amf/APIC-187.spec.ts

@@ -1,41 +0,0 @@
-import { test } from '@japa/runner'
-import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IShapeUnion } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-187', (group) => {
-  const loader = new AmfLoader()
-  const jsonMime = 'application/json'
-  const apiFile = 'APIC-187'
-
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-  })
-  ;[
-    ['AS400CityName', 'string', 'Omaha, DG'],
-    ['AS400ECM', 'number', 401571.6],
-    ['AcquiredDate', 'string', '2019-01-16'],
-    ['Age', 'number', 1],
-    ['TransmissionRearRearSN', 'string', '1'],
-    ['TransmissionRearRatio', 'number', 1],
-    ['Weight', 'number', 9300],
-    ['Year', 'string', '2016'],
-  ].forEach((item) => {
-    test(`returns ${item[1]} type (${item[0]})`, ({ assert }) => {
-      const datatype = item[1] as string
-      const payload = loader.getPayloads(model, '/record', 'post')[0]
-      const anyShape = payload.schema as IShapeUnion
-      const result = ApiSchemaGenerator.asExample(anyShape, jsonMime, {
-        renderExamples: true,
-        renderOptional: true,
-      })!
-
-      const data = JSON.parse(String(result.renderValue))
-      assert.typeOf(data.records[0][item[0]], datatype, 'Data type matches')
-      assert.equal(data.records[0][item[0]], item[2], 'Value matches')
-    })
-  })
-})

package/tests/unit/amf/APIC-188.spec.ts

@@ -1,30 +0,0 @@
-import { test } from '@japa/runner'
-import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IApiAnyShape } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-188', (group) => {
-  const loader = new AmfLoader()
-  const jsonMime = 'application/json'
-  const apiFile = 'APIC-188'
-
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-  })
-
-  test(`computes a false example`, ({ assert }) => {
-    const payload = loader.getPayloads(model, '/record', 'post')[0]
-    const anyShape = payload.schema as IApiAnyShape
-    const result = ApiSchemaGenerator.asExample(anyShape, jsonMime, {
-      renderExamples: true,
-      renderOptional: true,
-    })!
-
-    const data = JSON.parse(String(result.renderValue))
-    assert.isFalse(data.allOrNone)
-    assert.typeOf(data.records, 'array')
-  })
-})

package/tests/unit/amf/APIC-233.spec.ts

@@ -1,32 +0,0 @@
-import { test } from '@japa/runner'
-import { ApiExampleGenerator } from '../../../src/amf/ApiExampleGenerator.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IApiAnyShape } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-233', (group) => {
-  const loader = new AmfLoader()
-  const jsonMime = 'application/json'
-  const apiFile = 'APIC-233'
-
-  let reader: ApiExampleGenerator
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-    reader = new ApiExampleGenerator()
-  })
-
-  test('renders examples for arabic letters', ({ assert }) => {
-    const payload = loader.getResponsePayloads(model, '/stuff', 'get', '200')[0]
-    const anyShape = payload.schema as IApiAnyShape
-
-    const result = reader.read(anyShape.examples[0], jsonMime) as string
-    const body = JSON.parse(result)
-    assert.typeOf(body, 'object', 'has the result')
-    assert.deepEqual(body, {
-      الحالة: 'حسنا',
-      message: 'Shop in الممل',
-    })
-  })
-})

package/tests/unit/amf/APIC-391.spec.ts

@@ -1,39 +0,0 @@
-import { test } from '@japa/runner'
-import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IApiAnyShape } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-391', (group) => {
-  const loader = new AmfLoader()
-  const xmlMime = 'application/xml'
-  const apiFile = 'APIC-391'
-
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-  })
-
-  test('generate XML tags correctly for payloads examples', ({ assert }) => {
-    const payload = loader.getPayloads(model, '/shipment-requests', 'post')[0]
-
-    const anyShape = payload.schema as IApiAnyShape
-    const result = ApiSchemaGenerator.asExample(anyShape, xmlMime, {
-      renderExamples: true,
-      renderOptional: true,
-    })!
-
-    assert.equal(
-      result.renderValue,
-      '<unknown-type>\n' +
-        '  <address>250 HIDEOUT LN</address>\n' +
-        '  <comments>Orgin comments entered here.</comments>\n' +
-        '  <references>\n' +
-        '    <referenceType>Delivery Note</referenceType>\n' +
-        '    <referenceValue>7328</referenceValue>\n' +
-        '  </references>\n' +
-        '</unknown-type>'
-    )
-  })
-})

package/tests/unit/amf/APIC-487.spec.ts

@@ -1,44 +0,0 @@
-/* eslint-disable max-len */
-import { test } from '@japa/runner'
-import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IApiAnyShape } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-487', (group) => {
-  const loader = new AmfLoader()
-  const xmlMime = 'application/xml'
-  const apiFile = 'APIC-487'
-
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-  })
-
-  test('returns an example when not XML wrapped', ({ assert }) => {
-    const payload = loader.getResponsePayloads(model, '/test1', 'get', '200')[0]
-    const anyShape = payload.schema as IApiAnyShape
-    const result = ApiSchemaGenerator.asExample(anyShape, xmlMime, {
-      renderExamples: true,
-    })!
-    assert.typeOf(result, 'object', 'generates the example')
-    const expectedExample =
-      '<Person>\n  <addresses>\n    <street></street>\n    <city></city>\n  </addresses>\n</Person>'
-    assert.equal(result.renderValue, expectedExample)
-  })
-
-  test('returns an example when XML wrapped', ({ assert }) => {
-    const payload = loader.getResponsePayloads(model, '/test2', 'post', '200')[0]
-    const anyShape = payload.schema as IApiAnyShape
-    const result = ApiSchemaGenerator.asExample(anyShape, xmlMime, {
-      renderExamples: true,
-    })!
-
-    assert.typeOf(result, 'object', 'generates the example')
-    const expectedExample =
-      '<WrappedPerson>\n  <addresses>\n    <Address>\n      <street></street>\n      <city></city>\n    </Address>\n  </addresses>\n</WrappedPerson>'
-    // this RAML has no name defined for a wrapped property so it inherits the name from the parent.
-    assert.equal(result.renderValue, expectedExample)
-  })
-})

package/tests/unit/amf/APIC-655.spec.ts

@@ -1,41 +0,0 @@
-import { test } from '@japa/runner'
-import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IApiAnyShape } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-655', (group) => {
-  const loader = new AmfLoader()
-  const xmlMime = 'application/xml'
-  const apiFile = 'APIC-655'
-
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-  })
-
-  test('generate XML tags correctly for payloads examples', ({ assert }) => {
-    const payload = loader.getPayloads(model, '/delivery', 'post')[0]
-    const anyShape = payload.schema as IApiAnyShape
-    const result = ApiSchemaGenerator.asExample(anyShape, xmlMime, {
-      renderExamples: true,
-      renderOptional: true,
-    })!
-
-    assert.equal(
-      result.renderValue,
-      '<Delivery>\n' +
-        '  <orderId>732482783718</orderId>\n' +
-        '  <lineItems>\n' +
-        '    <lineItemId>9738187235</lineItemId>\n' +
-        '    <qty>10</qty>\n' +
-        '  </lineItems>\n' +
-        '  <lineItems>\n' +
-        '    <lineItemId>9832837238</lineItemId>\n' +
-        '    <qty>70</qty>\n' +
-        '  </lineItems>\n' +
-        '</Delivery>\n'
-    )
-  })
-})

package/tests/unit/amf/APIC-689.spec.ts

@@ -1,28 +0,0 @@
-import { test } from '@japa/runner'
-import { ApiSchemaValues } from '../../../src/amf/ApiSchemaValues.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IApiScalarShape } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-689', (group) => {
-  const apiFile = 'APIC-689'
-  const loader = new AmfLoader()
-
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-  })
-
-  test('does not set URL query param for an optional enum', async ({ assert }) => {
-    const param = loader.getParameter(model, '/test', 'get', 'param1')
-    const result = ApiSchemaValues.readInputValue(param, param.schema as IApiScalarShape, { requiredOnly: true })
-    assert.isUndefined(result, 'has the empty default value (from schema type)')
-  })
-
-  test('returns the first enum value', async ({ assert }) => {
-    const param = loader.getParameter(model, '/test', 'post', 'param1')
-    const result = ApiSchemaValues.readInputValue(param, param.schema as IApiScalarShape, { requiredOnly: true })
-    assert.equal(result, 'A', 'has the first enum type')
-  })
-})

package/tests/unit/amf/APIC-690.spec.ts

@@ -1,93 +0,0 @@
-/* eslint-disable max-len */
-import { test } from '@japa/runner'
-import { DOMParser } from '@xmldom/xmldom'
-import { ApiSchemaGenerator } from '../../../src/amf/ApiSchemaGenerator.js'
-import { IAmfDocument } from '../../../src/amf/definitions/Amf.js'
-import { IApiAnyShape } from '../../../src/amf/definitions/Shapes.js'
-import { AmfLoader } from './AmfLoader.js'
-
-test.group('APIC-690', (group) => {
-  const loader = new AmfLoader()
-  const xmlMime = 'application/xml'
-  const apiFile = 'APIC-690'
-  let model: IAmfDocument
-
-  group.setup(async () => {
-    model = await loader.getGraph(apiFile)
-  })
-
-  test('generates xml examples for an array body', ({ assert }) => {
-    const payload = loader.getResponsePayloads(model, '/customers', 'get', '200')[0]
-    const anyShape = payload.schema as IApiAnyShape
-    const result = ApiSchemaGenerator.asExample(anyShape, xmlMime, {
-      renderExamples: true,
-    })!
-
-    assert.typeOf(result, 'object', 'generates the example')
-    assert.typeOf(result.renderValue, 'string', 'has the value')
-
-    const parser = new DOMParser()
-    const schema = parser.parseFromString(`<root>${result.renderValue}</root>`, xmlMime)
-
-    const root = schema.getElementsByTagName('root')[0]!
-
-    // this version of the library does not add "schema" to the shape generated from the payload type
-    // The problem is that there is not wrapping object when including a schema directly to the body.
-    // In the previous version this was wrapping the object with <schema> but it is not correct.
-
-    const customers = root.getElementsByTagName('customerID')!
-    assert.equal(customers.length, 2, 'has both customerID')
-    assert.equal(customers[0].textContent!.trim(), '1fe1c22s-3d3a-9n3v', 'has the customerID')
-
-    const firstNames = root.getElementsByTagName('firstName')!
-    assert.equal(firstNames.length, 2, 'has both firstName')
-    assert.equal(firstNames[0].textContent!.trim(), 'Molly', 'has the firstName')
-
-    const displayNames = root.getElementsByTagName('displayName')!
-    assert.equal(displayNames.length, 2, 'has both displayName')
-    assert.equal(displayNames[0].textContent!.trim(), 'Molly the Mule', 'has the displayName')
-
-    const phones = root.getElementsByTagName('phone')!
-    assert.equal(phones.length, 2, 'has both phone')
-    assert.equal(phones[0].textContent!.trim(), '415-000-0000', 'has the phone')
-
-    const emails = root.getElementsByTagName('email')!
-    assert.equal(emails.length, 2, 'has both email')
-    assert.equal(emails[0].textContent!.trim(), 'molly@mulesoft.com', 'has the email')
-
-    const ssns = root.getElementsByTagName('ssn')!
-    assert.equal(ssns.length, 2, 'has both ssn')
-    assert.equal(ssns[0].textContent!.trim(), '321-654-0987', 'has the ssn')
-
-    const dateOfBirths = root.getElementsByTagName('dateOfBirth')!
-    assert.equal(dateOfBirths.length, 2, 'has both dateOfBirth')
-    assert.equal(dateOfBirths[0].textContent!.trim(), '1990-09-04', 'has the dateOfBirth')
-
-    const addresses = root.getElementsByTagName('address')!
-    assert.equal(addresses.length, 2, 'has both addresses')
-
-    // const nodes = root.getElementsByTagName('schema')!;
-
-    // assert.equal(nodes.length, 2, 'has both examples generated');
-    // const testNode = nodes[1]!;
-
-    // assert.equal(testNode.getElementsByTagName('customerID')!.textContent!.trim(), '1fe1c22s-3d3a-9n3v', 'has the customerID');
-    // assert.equal(testNode.getElementsByTagName('firstName')!.textContent!.trim(), 'Molly', 'has the firstName');
-    // assert.equal(testNode.getElementsByTagName('lastName')!.textContent!.trim(), 'Mule', 'has the lastName');
-    // assert.equal(testNode.getElementsByTagName('displayName')!.textContent!.trim(), 'Molly the Mule', 'has the displayName');
-    // assert.equal(testNode.getElementsByTagName('phone')!.textContent!.trim(), '415-000-0000', 'has the phone');
-    // assert.equal(testNode.getElementsByTagName('email')!.textContent!.trim(), 'molly@mulesoft.com', 'has the email');
-    // assert.equal(testNode.getElementsByTagName('ssn')!.textContent!.trim(), '321-654-0987', 'has the ssn');
-    // assert.equal(testNode.getElementsByTagName('dateOfBirth')!.textContent!.trim(), '1990-09-04', 'has the dateOfBirth');
-
-    // const address = testNode.getElementsByTagName('address')!;
-    // assert.ok(address, 'has the address node');
-
-    // assert.equal(address.getElementsByTagName('addressLine1')!.textContent!.trim(), '123 Street', 'has the address.addressLine1');
-    // assert.equal(address.getElementsByTagName('addressLine2')!.textContent!.trim(), 'Apt.#3D', 'has the address.addressLine2');
-    // assert.equal(address.getElementsByTagName('city')!.textContent!.trim(), 'San Francisco', 'has the address.city');
-    // assert.equal(address.getElementsByTagName('state')!.textContent!.trim(), 'California', 'has the address.state');
-    // assert.equal(address.getElementsByTagName('zipCode')!.textContent!.trim(), '94110', 'has the address.zipCode');
-    // assert.equal(address.getElementsByTagName('country')!.textContent!.trim(), 'United States', 'has the address.country');
-  })
-})