@api-client/core 0.6.13 → 0.6.16

package/data/apis/schema-api/schemas/person.json

@@ -0,0 +1,104 @@
+{
+  "$id": "http://example.com/example.json",
+  "type": "object",
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "id": {
+      "$id": "/properties/id",
+      "type": "string",
+      "title": "The Id Schema ",
+      "default": "",
+      "examples": [
+        "R34fg663H9KW9MMSKISI"
+      ]
+    },
+    "name": {
+      "$id": "/properties/name",
+      "type": "string",
+      "title": "The Name Schema ",
+      "default": "",
+      "examples": [
+        "Pawel Psztyc"
+      ]
+    },
+    "birthday": {
+      "$id": "/properties/birthday",
+      "type": "string",
+      "title": "The Birthday Schema ",
+      "default": "",
+      "examples": [
+        "1983-10-20"
+      ]
+    },
+    "gender": {
+      "$id": "/properties/gender",
+      "type": "string",
+      "title": "The Gender Schema ",
+      "default": "",
+      "examples": [
+        "male"
+      ]
+    },
+    "url": {
+      "$id": "/properties/url",
+      "type": "string",
+      "title": "The Url Schema ",
+      "default": "",
+      "examples": [
+        "https://domain.com/profile/pawel.psztyc"
+      ]
+    },
+    "image": {
+      "$id": "/properties/image",
+      "type": "object",
+      "properties": {
+        "url": {
+          "$id": "/properties/image/properties/url",
+          "type": "string",
+          "title": "The Url Schema ",
+          "default": "",
+          "examples": [
+            "https://domain.com/profile/pawel.psztyc/image"
+          ]
+        },
+        "thumb": {
+          "$id": "/properties/image/properties/thumb",
+          "type": "string",
+          "title": "The Thumb Schema ",
+          "default": "",
+          "examples": [
+            "https://domain.com/profile/pawel.psztyc/image/thumb"
+          ]
+        }
+      }
+    },
+    "tagline": {
+      "$id": "/properties/tagline",
+      "type": "string",
+      "title": "The Tagline Schema ",
+      "default": "",
+      "examples": [
+        "Some text about me."
+      ]
+    },
+    "language": {
+      "$id": "/properties/language",
+      "type": "string",
+      "title": "The Language Schema ",
+      "default": "",
+      "examples": [
+        "en_GB"
+      ]
+    },
+    "etag": {
+      "$id": "/properties/etag",
+      "type": "string",
+      "title": "The Etag Schema ",
+      "default": "",
+      "examples": [
+        "W\\244m4n5kj3gbn2nj4k4n4"
+      ]
+    }
+  }
+}

package/data/apis/schema-api/schemas/person.xsd

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
+  <xs:element name="resource">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="id" type="xs:string"></xs:element>
+        <xs:element name="name" type="xs:string"></xs:element>
+        <xs:element name="birthday" type="xs:date"></xs:element>
+        <xs:element name="gender" type="xs:string"></xs:element>
+        <xs:element name="url" type="xs:string"></xs:element>
+        <xs:element name="image">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="url" type="xs:string"></xs:element>
+              <xs:element name="thumb" type="xs:string"></xs:element>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+        <xs:element name="tagline" type="xs:string"></xs:element>
+        <xs:element name="language" type="xs:string"></xs:element>
+      </xs:sequence>
+      <xs:attribute name="error" type="xs:boolean" use="required"></xs:attribute>
+      <xs:attribute name="type" type="xs:string" use="required"></xs:attribute>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

package/data/apis/schema-api/types/DemoPerson.raml

@@ -0,0 +1,67 @@
+#%RAML 1.0 DataType
+
+displayName: Person
+description: |
+  A person but without examples defined inline.
+
+type: object
+
+properties:
+  id:
+    xml:
+      attribute: true
+    description: A unique identifier for a person. It is a 32 bit string containing alphanumeric characters.
+    type: string
+    example: ad3fd6d4-af89-11eb-8529-0242ac130003
+  name:
+    required: true
+    example: John Smith
+    description: Person full name. The input will be rejected if this property is not set while creating new object.
+    type: string
+    pattern: "[0-9a-zA-Z ]+"
+    xml:
+      attribute: true
+      name: fullname
+  birthday:
+    type: date-only
+    description: The person's date of birth, represented as YYYY-MM-DD.
+    examples:
+      Example 1: 1983-10-20
+      Example 2: 1994-08-29
+  gender?:
+    type: string
+    description: |
+      The person's gender. Possible values includes, but are not limited to, the following values:
+      * "male" - Male gender.
+      * "female" - Female gender.
+      * "other" - Other.
+    example: male
+  url:
+    type: string
+    description: The URL of this person's profile.
+  image: 
+    type: !include ../resourceTypes/image.raml
+    xml:
+      wrapped: true
+  tagline:
+    type: string
+    description: The brief description (tagline) of this person.
+  language:
+    type: string
+    description: The user's preferred language for rendering.
+    example: "Polish"
+  tags:
+    description: Tags added to the person.
+    type: array
+    items: 
+      properties:
+        name: 
+          type: string
+          description: The name of the tag
+          example: Manager
+        id:
+          type: string
+          description: Tag's identifier.
+          example: ad3fda8a-af89-11eb-8529-0242ac130003
+      xml:
+        wrapped: false

package/data/model.js

@@ -0,0 +1,106 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+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" });
+
+const srcFolder = path.join('data', 'apis');
+const descFolder = path.join('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 {
+        // eslint-disable-next-line no-await-in-loop
+        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 = path.join(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();
+    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);