@asyncapi/generator 1.17.24 → 2.0.0

package/docs/index.md

@@ -23,7 +23,7 @@ The AsyncAPI generator is a tool that generates anything you want using the **[A
 2. The **Generator** sends to the **[Parser](generator/parser)** the **asyncapiString** which is a stringified version of the original **AsyncAPI Document**.
 3. The **Parser** uses additional plugins such as the OpenAPI, RAML, or Avro schemas to validate custom schemas of message payloads defined in the **AsyncAPI Document**.
 4. If the **Parser** determines that the original **AsyncAPI Document** is valid, it manipulates the document and returns a set of helper functions and properties and bundles them together into an **asyncapi** variable that is an instance of [**AsyncAPIDocument**](https://github.com/asyncapi/parser-api/blob/master/docs/api.md#asyncapidocument). The **asyncapi** helper functions make it easier to access the contents of the AsyncAPI Document.
-5. At this point, the **Generator** passes the **[asyncapi](generator/asyncapi-document#method-2-asyncapi-and-template)**, the **[originalAsyncAPI](generator/asyncapi-document#method-1-originalasyncapi-and-template)**, and the **params** which collectively make up the **[Template Context](generator/asyncapi-context)** to the **Render Engine**. 
+5. At this point, the **Generator** passes the **[asyncapi](generator/asyncapi-document#method-2-asyncapi-and-template)**, the **[originalAsyncAPI](generator/asyncapi-document#method-1-originalasyncapi-and-template)**, and the **params** which collectively make up the **[Template Context](generator/template-context)** to the **Render Engine**. 
 6. AsyncAPI has two **Render Engines**([react](generator/react-render-engine) and [nunjucks](generator/nunjucks-render-engine). Depending on which one you've specified in your `package.json`, the **Generator** knows the right **Render Engine** to pass both the **Template Files** and the **Template Context**.
 7. Once the **Render Engine** receives the **Template Files** and the **Template Context**, it injects all the dynamic values in your react or nunjucks based **Template Files** using the **Template Context**. As a result, the **Render Engine** generates **markdown**, **pdf**, **boilerplate code**, and **anything else** you specified to be generated as output.
 

package/docs/installation-guide.md

@@ -9,8 +9,8 @@ You can use the generator library to generate whatever you want in your event-dr
   
 ## Prerequisites
 Before you install and use the AsyncAPI CLI and the generator library, ensure you meet the prerequisites below, then [install the CLI](#installation).
-1. Node.js v12.16 and higher
-2. Npm v6.13.7 and higher
+1. Node.js v18.12.0 and higher
+2. Npm v8.19.0 and higher
    
 To verify the versions of Node and Npm you have, run the following command on your terminal:
 ```

package/docs/template.md

@@ -5,7 +5,7 @@ weight: 50
 
 ## Template
 
-A template is a project that specifies the generation process output by using the AsyncAPI generator and an [AsyncAPI document](asyncapi-file.md). These files describe the generation results depending on the AsyncAPI document's content.
+A template is a project that specifies the generation process output by using the AsyncAPI generator and an [AsyncAPI document](asyncapi-document.md). These files describe the generation results depending on the AsyncAPI document's content.
 
 Examples outputs:
 

package/docs/using-private-template.md

@@ -2,14 +2,26 @@
 title: "Using private templates"
 weight: 180
 ---
-Generator allows fetching the template from private repositories like Verdaccio, Nexus, npm, etc.
+Generator allows fetching the template from private repositories like Verdaccio, Nexus, npm, etc.   
+By default, the generator fetches the template from the public npm registry configured in the npm configuration.   
+To fetch the template from a private registry, you need to provide the registry URL and authentication details in the .npmrc. For more information [read the docs](https://docs.npmjs.com/cli/v9/configuring-npm/npmrc).   
+However, you can override the default behavior by providing the registry URL and authentication details as arguments of the commandline.
 
 
-## Private registry options:
+## Private registry using .npmrc:
+```bash
+npm config set registry http://verdaccio:4873
+npm config set //verdaccio:4873/:_auth=$(echo -n 'username:password' | base64)
+```
+* **npm config set registry** : Provide the registry URL that points to the registry URL.
+* **npm config set _auth** : Provide the base64 encoded value that represents the username and password for basic auth.
+* **npm config set _authToken** : Provide the access token generated by the registry.
+
+## Private registry overriding arguments:
 
 * **registry.url**: The URL of the registry where the private template is located. Defaults to `registry.npmjs.org`.
 * **registry.auth**: An optional parameter to pass the npm registry username and password encoded with base64, formatted as `username:password`. For example, if the username and password are `admin` and `nimda`, you need to encode them with the base64 value like `admin:nimda` which results in `YWRtaW46bmltZGE=`.
-**registry.token**: An optional parameter to pass to the npm registry authentication token. To get the token, you can first authenticate with the registry using `npm login` and then grab the generated token from the `.npmrc` file.
+* **registry.token**: An optional parameter to pass to the npm registry authentication token. To get the token, you can first authenticate with the registry using `npm login` and then grab the generated token from the `.npmrc` file.
 
 ## Pulling private template using library:
 
@@ -26,4 +38,4 @@ const generator = new Generator('@asyncapi/html-template', 'output',
         }
       });
 ```
-Assuming you host `@asyncapi/html-template` in a private package registry like Verdaccio. To pull this template, you need to provide `registry.url` option that points to the registry URL and `registry.auth` as a base64 encoded value that represents the username and password. Instead of username and password, you can also pass `registry.token`.
+Assuming you host `@asyncapi/html-template` in a private package registry like Verdaccio. To pull this template, you need to provide `registry.url` option that points to the registry URL and `registry.auth` as a base64 encoded value that represents the username and password. Instead of username and password, you can also pass `registry.token`.

package/lib/generator.js

@@ -7,6 +7,10 @@ const filenamify = require('filenamify');
 const git = require('simple-git');
 const log = require('loglevel');
 const Arborist = require('@npmcli/arborist');
+const Config = require('@npmcli/config');
+const requireg = require('requireg');
+const npmPath = requireg.resolve('npm').replace('index.js','');
+
 const { isAsyncAPIDocument } = require('@asyncapi/parser/cjs/document');
 
 const { configureReact, renderReact, saveRenderedReactContent } = require('./renderer/react');
@@ -31,6 +35,7 @@ const {
 const { parse, usesNewAPI, getProperApiDocument } = require('./parser');
 const { registerFilters } = require('./filtersRegistry');
 const { registerHooks } = require('./hooksRegistry');
+const { definitions, flatten, shorthands } = require('@npmcli/config/lib/definitions');
 
 const FILTERS_DIRNAME = 'filters';
 const HOOKS_DIRNAME = 'hooks';
@@ -532,7 +537,7 @@ class Generator {
       arbOptions.registry = providedRegistry;
       registryUrl = providedRegistry;
     }
-    
+
     const domainName = registryUrl.replace(/^https?:\/\//, '');
     //doing basic if/else so basically only one auth type is used and token as more secure is primary
     if (this.registry.token) {
@@ -541,11 +546,12 @@ class Generator {
     } else if (this.registry.auth) {
       authorizationName = `//${domainName}:_auth`;
       arbOptions[authorizationName] = this.registry.auth;
-    } 
+    }
 
     //not sharing in logs neither token nor auth for security reasons
     log.debug(`Using npm registry ${registryUrl} and authorization type ${authorizationName} to handle template installation.`);
   }
+
   /**
    * Downloads and installs a template and its dependencies
    *
@@ -556,14 +562,14 @@ class Generator {
       let pkgPath;
       let installedPkg;
       let packageVersion;
-  
+
       try {
         installedPkg = getTemplateDetails(this.templateName, PACKAGE_JSON_FILENAME);
         pkgPath = installedPkg && installedPkg.pkgPath;
         packageVersion = installedPkg && installedPkg.version;
         log.debug(logMessage.templateSource(pkgPath));
         if (packageVersion) log.debug(logMessage.templateVersion(packageVersion));
-  
+
         return {
           name: installedPkg.name,
           path: pkgPath
@@ -573,38 +579,45 @@ class Generator {
         // We did our best. Proceed with installation...
       }
     }
-  
+
     const debugMessage = force ? logMessage.TEMPLATE_INSTALL_FLAG_MSG : logMessage.TEMPLATE_INSTALL_DISK_MSG;
     log.debug(logMessage.installationDebugMessage(debugMessage));
-  
+
     if (isFileSystemPath(this.templateName)) log.debug(logMessage.NPM_INSTALL_TRIGGER);
-  
-    const arbOptions = {
-      path: ROOT_DIR,
-    };
-    if (this.registry) {
+
+    const config = new Config({
+      definitions,
+      flatten,
+      shorthands,
+      npmPath
+    });
+
+    await config.load();
+
+    const arbOptions = {...{path: ROOT_DIR}, ...config.flat};
+
+    if (Object.keys(this.registry).length !== 0) {
       this.initialiseArbOptions(arbOptions);
     }
-  
     const arb = new Arborist(arbOptions);
-    
+
     try {
       const installResult = await arb.reify({
         add: [this.templateName],
         saveType: 'prod',
         save: false
       });
-  
+
       const addResult = arb[Symbol.for('resolvedAdd')];
       if (!addResult) throw new Error('Unable to resolve the name of the added package. It was most probably not added to node_modules successfully');
-  
+
       const packageName = addResult[0].name;
       const packageVersion = installResult.children.get(packageName).version;
       const packagePath = installResult.children.get(packageName).path;
-  
+
       if (!isFileSystemPath(this.templateName)) log.debug(logMessage.templateSuccessfullyInstalled(packageName, packagePath));
       if (packageVersion) log.debug(logMessage.templateVersion(packageVersion));
-  
+
       return {
         name: packageName,
         path: packagePath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asyncapi/generator",
-  "version": "1.17.24",
+  "version": "2.0.0",
   "description": "The AsyncAPI generator. It can generate documentation, code, anything!",
   "main": "./lib/generator.js",
   "bin": {
@@ -8,8 +8,8 @@
     "ag": "./cli.js"
   },
   "engines": {
-    "node": ">12.16",
-    "npm": ">6.13.7"
+    "node": ">=18.12.0",
+    "npm": ">=8.19.0"
   },
   "scripts": {
     "test": "npm run test:unit && npm run test:integration && npm run test:cli",
@@ -51,6 +51,7 @@
     "@asyncapi/generator-react-sdk": "^1.0.18",
     "@asyncapi/parser": "^3.0.14",
     "@npmcli/arborist": "5.6.3",
+    "@npmcli/config": "^8.0.2",
     "@smoya/multi-parser": "^5.0.0",
     "ajv": "^8.12.0",
     "chokidar": "^3.4.0",
@@ -65,6 +66,7 @@
     "minimatch": "^3.0.4",
     "node-fetch": "^2.6.0",
     "nunjucks": "^3.2.0",
+    "requireg": "^0.2.2",
     "resolve-from": "^5.0.0",
     "resolve-pkg": "^2.0.0",
     "semver": "^7.3.2",