Merge pull request #17 from api-components/feat/update-amf-client-5.4.4

@W-21680934 Feat/update amf client 5.4.4

Author: alexpmule

.gitignore

@@ -58,3 +58,6 @@ node_modules
 bower_components
 build
 dist
+
+coverage
+.nyc_output

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## 0.3.0 (2026-04-07)
+
+### Features
+
+* **amf**: upgrade amf-client-js from 4.7.8 to 5.10.2
+* **grpc**: add support for gRPC/Protobuf API parsing
+* **api**: migrate to AMF v5 API (RAMLConfiguration, OASConfiguration, GRPCConfiguration)
+
+### Breaking Changes
+
+* Requires amf-client-js ^5.10.2
+* API method signatures changed to use AMF v5 configuration objects
+
 ### 0.2.5 (2020-01-22)
 
 

README.md

@@ -21,13 +21,13 @@ If the value is an array then first element must be API format and second is API
 `ApisList.dest` ⇒ `String` - path where output generated models. Default to `demo/`.
 `ApisList.<path>` ⇒ `String`, `Array`, `ApiDefinition` - a definition of an API to process. Key is a path to the API main file. The value depending on a type has different meaning.
 
-`String` value represents API type. Can be `RAML 0.8`, `RAML 1.0`, `OAS 2.0`, or `OAS 3.0`. It generates api model for `application/yaml` media type and for the `editing` resolution pipeline.
+`String` value represents API type. Can be `RAML 0.8`, `RAML 1.0`, `OAS 2.0`, `OAS 3.0`, `ASYNC 2.0`, or `GRPC`. It generates api model for `application/yaml` media type and for the `editing` resolution pipeline.
 
 `Array` value is deprecated. Please don't use it.
 
 `ApiDefinition` ⇒ `Object`
-`ApiDefinition.type` ⇒ `String`. API type to process. Can be `RAML 0.8`, `RAML 1.0`, `OAS 2.0`, or `OAS 3.0`.
-`ApiDefinition.mime` ⇒ `String`. API media type. Default to `application/yaml`.
+`ApiDefinition.type` ⇒ `String`. API type to process. Can be `RAML 0.8`, `RAML 1.0`, `OAS 2.0`, `OAS 3.0`, `ASYNC 2.0`, or `GRPC`.
+`ApiDefinition.mime` ⇒ `String`. API media type. Default to `application/yaml`. For GRPC use `application/x-protobuf`.
 `ApiDefinition.resolution` ⇒ `String`. AMF resolution pipeline. Default to `editing` which is the original resolution pipeline for API Console. Future releases of AMF can support different options.
 
 

index.js

@@ -3,84 +3,93 @@ const amf = require('amf-client-js');
 const fs = require('fs-extra');
 const path = require('path');
 
-amf.plugins.document.WebApi.register();
-amf.plugins.document.Vocabularies.register();
-amf.plugins.features.AMFValidation.register();
+const {
+  RAMLConfiguration,
+  OASConfiguration,
+  AsyncAPIConfiguration,
+  GRPCConfiguration,
+  RenderOptions,
+  PipelineId,
+} = amf;
 
 /** @typedef {import('./types').ApiConfiguration} ApiConfiguration */
 /** @typedef {import('./types').FilePrepareResult} FilePrepareResult */
 /** @typedef {import('./types').ApiGenerationOptions} ApiGenerationOptions */
 /** @typedef {import('./types').ApiType} ApiType */
 
 /**
- * Generates json/ld file from parsed document.
+ * @param {string} type
+ * @returns {any}
+ */
+function getConfiguration(type) {
+  switch (type) {
+    case 'RAML 0.8': return RAMLConfiguration.RAML08();
+    case 'RAML 1.0': return RAMLConfiguration.RAML10();
+    case 'OAS 2.0':
+    case 'OAS 2':
+      return OASConfiguration.OAS20();
+    case 'OAS 3.0':
+    case 'OAS 3':
+      return OASConfiguration.OAS30();
+    case 'ASYNC 2.0': return AsyncAPIConfiguration.Async20();
+    case 'GRPC': return GRPCConfiguration.GRPC();
+    default: throw new Error(`Unknown API type: ${type}`);
+  }
+}
+
+/**
+ * Generates json/ld file from parsed document using AMF v5 API.
  *
- * @param {amf.model.document.BaseUnit} doc
+ * @param {string} sourceFile
  * @param {string} file
  * @param {string} type
  * @param {string} destPath
  * @param {string} resolution
  * @param {boolean} flattened
  * @return {Promise<void>}
  */
-async function processFile(doc, file, type, destPath, resolution, flattened) {
-  let validateProfile;
-  switch (type) {
-    case 'RAML 1.0': validateProfile = amf.ProfileNames.RAML; break;
-    case 'RAML 0.8': validateProfile = amf.ProfileNames.RAML08; break;
-    case 'OAS 2.0':
-    case 'OAS 3.0':
-      validateProfile = amf.ProfileNames.OAS;
-      break;
-    case 'ASYNC 2.0':
-      // @ts-ignore
-      validateProfile = amf.ProfileNames.ASYNC20;
-      break;
-  }
+async function processFile(sourceFile, file, type, destPath, resolution, flattened) {
   let dest = `${file.substr(0, file.lastIndexOf('.')) }.json`;
   if (dest.indexOf('/') !== -1) {
     dest = dest.substr(dest.lastIndexOf('/'));
   }
 
-  const generator = amf.Core.generator('AMF Graph', 'application/ld+json');
-  const vResult = await amf.AMF.validate(doc, validateProfile, undefined);
-  if (!vResult.conforms) {
-    /* eslint-disable-next-line no-console */
-    console.log(vResult.toString());
-  }
-  let resolver;
-  switch (type) {
-    case 'RAML 1.0': resolver = amf.Core.resolver('RAML 1.0'); break;
-    case 'RAML 0.8': resolver = amf.Core.resolver('RAML 0.8'); break;
-    case 'OAS 2.0': resolver = amf.Core.resolver('OAS 2.0'); break;
-    case 'OAS 3.0': resolver = amf.Core.resolver('OAS 3.0'); break;
-    case 'ASYNC 2.0': resolver = amf.Core.resolver('ASYNC 2.0'); break;
+  // Setup render options
+  let renderOpts = new RenderOptions().withSourceMaps().withCompactUris();
+  if (flattened) {
+    renderOpts = renderOpts.withCompactedEmission();
   }
-  if (resolver) {
-    doc = resolver.resolve(doc, resolution);
+
+  // Get configuration for API type
+  const apiConfiguration = getConfiguration(type).withRenderOptions(renderOpts);
+  const client = apiConfiguration.baseUnitClient();
+
+  // Parse the file
+  const parseResult = await client.parse(sourceFile);
+
+  if (!parseResult.conforms) {
+    /* eslint-disable-next-line no-console */
+    console.log('Validation warnings/errors:');
+    console.log(parseResult.toString());
   }
+
+  // Transform using resolution pipeline
+  const pipelineId = resolution === 'editing' ? PipelineId.Editing : PipelineId.Default;
+  const transformed = client.transform(parseResult.baseUnit, pipelineId);
+
+  // Render to JSON-LD
   const fullFile = path.join(destPath, dest);
   const compactDest = dest.replace('.json', '-compact.json');
   const compactFile = path.join(destPath, compactDest);
 
-  // @ts-ignore
-  let fullOpts = amf.render.RenderOptions().withSourceMaps;
-  if (flattened) {
-    fullOpts = fullOpts.withFlattenedJsonLd;
-  }
-  const fullData = await generator.generateString(doc, fullOpts);
+  // Generate full model (same as compact in v5 with withCompactUris)
+  const modelData = await client.render(transformed.baseUnit, 'application/ld+json');
+
   await fs.ensureFile(fullFile);
-  await fs.writeFile(fullFile, fullData, 'utf8');
+  await fs.writeFile(fullFile, modelData, 'utf8');
 
-  // @ts-ignore
-  let compactOpts = amf.render.RenderOptions().withSourceMaps.withCompactUris;
-  if (flattened) {
-    compactOpts = compactOpts.withFlattenedJsonLd;
-  }
-  // withRawSourceMaps.
-  const compactData = await generator.generateString(doc, compactOpts);
   await fs.ensureFile(compactFile);
-  await fs.writeFile(compactFile, compactData, 'utf8');
+  await fs.writeFile(compactFile, modelData, 'utf8');
 }
 
 /**
@@ -119,9 +128,8 @@ async function parseFile(file, cnf, opts) {
     dest += '/';
   }
   const { type, mime='application/yaml', resolution='editing', flattened = false } = normalizeOptions(cnf);
-  const parser = amf.Core.parser(type, mime);
-  const doc = await parser.parseFileAsync(`file://${src}${file}`);
-  return processFile(doc, file, type, dest, resolution, flattened);
+  const sourceFile = `file://${src}${file}`;
+  return processFile(sourceFile, file, type, dest, resolution, flattened);
 }
 
 /**
@@ -166,7 +174,7 @@ async function main(init, opts={}) {
     init = cnfFiles;
     opts = { ...cnfOpts, ...opts };
   }
-  await amf.Core.init();
+  // AMF v5 doesn't require explicit initialization
   for (const [file, type] of init) {
     await parseFile(file, type, opts);
   }