@team-supercharge/oasg 9.1.1 → 9.2.1

package/.gitlab-ci.yml

@@ -1,7 +1,7 @@
 include:
   - project: team-supercharge/jarvis/jarvis
     file: jarvis.yml
-    ref: v8.0.0
+    ref: v9.1.0
 
 stages:
   - lint
@@ -11,7 +11,7 @@ stages:
 
 default:
   image:
-    name: node:12.18
+    name: node:18.15.0
   tags: [arm64]
 
 # lint

package/.nvmrc

@@ -0,0 +1 @@
+v18.15.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 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.
 
+### [9.2.1](https://gitlab.com/team-supercharge/oasg/compare/v9.2.0...v9.2.1) (2023-04-13)
+
+
+### Bug Fixes
+
+* **nestjs:** use node for post-processing files instead of sed ([22d996b](https://gitlab.com/team-supercharge/oasg/commit/22d996bd0c958108871bc8d331a44aa4f72f99b7))
+
+
+### CI
+
+* upgrade to latest jarvis ([c444628](https://gitlab.com/team-supercharge/oasg/commit/c4446285ce4a97e6fd75239be27cb08b054f9f68))
+* use latest lts node version ([bdd39a6](https://gitlab.com/team-supercharge/oasg/commit/bdd39a663a5d8c1f37704c9ad0c12148dd217f6f))
+
+## [9.2.0](https://gitlab.com/team-supercharge/oasg/compare/v9.1.1...v9.2.0) (2023-04-03)
+
+
+### Features
+
+* add glob patterns to merger ([e7ea3bd](https://gitlab.com/team-supercharge/oasg/commit/e7ea3bdc28958e3a8ea4de7af10a1cac48645b5b))
+
 ### [9.1.1](https://gitlab.com/team-supercharge/oasg/compare/v9.1.0...v9.1.1) (2023-03-06)
 
 

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:12.18
+FROM node:18.15.0
 
 WORKDIR /app
 COPY . .

package/README.md

@@ -263,6 +263,8 @@ Common source parameters
 
 #### Simple
 
+A single file can be used as an input.
+
 ```json
 {
   "id": "source-simple",
@@ -277,20 +279,24 @@ Common source parameters
 
 #### Merged
 
+More files are merged into a single OpenApi specification file and used as an input. The files are merged in the order they are defined in the `inputs` array. Take care during naming of the schemas, as they are merged into a single namespace.
+
+Glob patterns are supported.
+
 ```json
 {
   "id": "source-merged",
   "type": "merged",
   "inputs": [
     "api/swagger1.yaml",
-    "api/swagger2.yaml"
+    "api/swagger/*.yaml"
   ]
 }
 ```
 
 |Parameter| Description| Required | Default |
 |-|-|-|-|
-| inputs | Array of paths of specification files | Y | - |
+| inputs | Array of paths of specification files or globs | Y | - |
 
 #### Overrides
 

package/bin/merger.js

@@ -2,6 +2,7 @@ const crypto = require('crypto');
 const fs = require('fs');
 const path = require('path');
 const SwaggerParser = require("@apidevtools/swagger-parser");
+const { glob } = require('glob');
 
 const { dump } = require(`${__dirname}/dump.js`);
 
@@ -10,8 +11,10 @@ async function merge(source) {
     fs.mkdirSync('./out');
   }
 
-  if (source.inputs.length == 1) {
-    return source.inputs[0];
+  const inputFiles = await glob(source.inputs);
+
+  if (inputFiles.length == 1) {
+    return inputFiles[0];
   }
 
   if (!fs.existsSync('./out/.tmp')) {
@@ -19,7 +22,7 @@ async function merge(source) {
   }
   const outFile = `./out/.tmp/${source.id}-${crypto.randomBytes(4).readUInt32LE(0)}.yaml`;
 
-  const document = await mergeDocuments(source.inputs);
+  const document = await mergeDocuments(inputFiles);
 
   dump(document, outFile);
 

package/bin/oasg

@@ -18,6 +18,7 @@ const { exec } = require(`${__dirname}/exec.js`);
 const { merge } = require(`${__dirname}/merger.js`);
 const { applyOverrides } = require(`${__dirname}/overrider.js`);
 const { openApiTarget } = require(`${__dirname}/openapi-target.js`);
+const { globSync } = require('glob');
 
 let VERSION = JSON.parse(fs.readFileSync('package.json')).version;
 
@@ -274,10 +275,15 @@ async function parseConfig() {
 
       case 'merged':
         s.inputs.forEach(i => {
-          if (!fs.existsSync(i)) {
-            console.error(`input file: ${i} not found for source: ${s.id}`);
-            exit(1);
+          if (fs.existsSync(i)) {
+            return;
           }
+          const matches = globSync(i);
+          if (matches.every(m => fs.existsSync(m))) {
+            return;
+          }
+          console.error(`input file: ${i} not found for source: ${s.id}`);
+          exit(1);
         });
 
         break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "9.1.1",
+  "version": "9.2.1",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",
@@ -12,6 +12,10 @@
     "type": "git",
     "url": "git@gitlab.com:team-supercharge/oasg/oasg.git"
   },
+  "engines": {
+    "node": "^18",
+    "npm": "^9"
+  },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.6",
     "@apidevtools/swagger-parser": "^10.0.2",
@@ -22,6 +26,7 @@
     "command-exists": "^1.2.9",
     "express": "^4.17.1",
     "express-http-proxy": "^1.6.2",
+    "glob": "^9.2.1",
     "js-yaml": "^4.1.0",
     "json-schema-merge-allof": "^0.7.0",
     "openapi-types": "^7.0.1",

package/targets/nestjs/generate.sh

@@ -18,17 +18,13 @@ cd out/$targetId
 # remove unnecessary files
 rm -rf variables.ts configuration.ts api.module.ts encoder.ts ng-package.json
 
-# rewrite http method annotatinos
-sed -i 's/^  \/\/\/\/ @get/  @Get/g' api/*.api.ts
-sed -i 's/^  \/\/\/\/ @post/  @Post/g' api/*.api.ts
-sed -i 's/^  \/\/\/\/ @put/  @Put/g' api/*.api.ts
-sed -i 's/^  \/\/\/\/ @delete/  @Delete/g' api/*.api.ts
-sed -i 's/^  \/\/\/\/ @patch/  @Patch/g' api/*.api.ts
-sed -i 's/^  \/\/\/\/ @options/  @Options/g' api/*.api.ts
-sed -i 's/^  \/\/\/\/ @head/  @Head/g' api/*.api.ts
+# rewrite http method annotations
+node rewrite-http-annotations.js
+rm rewrite-http-annotations.js
 
 # remove empty params objects from context objects
-sed -i 's/{ params: {  }, /{ /g' api/*.api.ts
+node remove-empty-param-objects-from-context.js
+rm remove-empty-param-objects-from-context.js
 
 # reorder operations (place ones with path params backwards)
 node reorder-operations.js
@@ -38,8 +34,8 @@ rm reorder-operations.js
 node unescape-patterns.js
 rm unescape-patterns.js
 
-# rewrite path parameters
-sed -i 's/\${encodeURIComponent(String(\(.*\)))}/:\1/g' api/*.api.ts
+node rewrite-path-parameters.js
+rm rewrite-path-parameters.js
 
 npm install
 npm run build

package/targets/nestjs/generator-config.json

@@ -23,6 +23,15 @@
     },
     "unescape-patterns.js": {
       "templateType": "SupportingFiles"
+    },
+    "rewrite-http-annotations.js": {
+      "templateType": "SupportingFiles"
+    },
+    "rewrite-path-parameters.js": {
+      "templateType": "SupportingFiles"
+    },
+    "remove-empty-param-objects-from-context.js": {
+      "templateType": "SupportingFiles"
     }
   },
   "typeMappings": {

package/targets/nestjs/templates/remove-empty-param-objects-from-context.js

@@ -0,0 +1,18 @@
+var fs = require('fs')
+
+const apiFolder = './api';
+const apiFileSuffix = '.api.ts';
+
+// remove empty param objects from context objects
+const apiFiles = fs.readdirSync(apiFolder).filter(fn => fn.endsWith(apiFileSuffix));
+apiFiles.forEach(apiFile => removeEmptyParamObjects(apiFile));
+
+function removeEmptyParamObjects(fileName) {
+    const file = `${apiFolder}/${fileName}`;
+    const contents = fs.readFileSync(file, 'utf-8');
+
+    const result = contents.replace(/{ params: {  }, /g, '{ ');
+
+    var options = { flag : 'w', encoding: 'utf8' };
+    fs.writeFileSync(file, result, options);
+}

package/targets/nestjs/templates/rewrite-http-annotations.js

@@ -0,0 +1,24 @@
+var fs = require('fs')
+
+const apiFolder = './api';
+const apiFileSuffix = '.api.ts';
+
+// rewrite http annotations
+const apiFiles = fs.readdirSync(apiFolder).filter(fn => fn.endsWith(apiFileSuffix));
+apiFiles.forEach(apiFile => rewriteHttpAnnotations(apiFile));
+
+function rewriteHttpAnnotations(fileName) {
+    const file = `${apiFolder}/${fileName}`;
+    const contents = fs.readFileSync(file, 'utf-8');
+
+    var result = contents.replace(/  \/\/\/\/ @get/g, '  @Get');
+    result = result.replace(/  \/\/\/\/ @post/g, '  @Post');
+    result = result.replace(/  \/\/\/\/ @put/g, '  @Put');
+    result = result.replace(/  \/\/\/\/ @delete/g, '  @Delete');
+    result = result.replace(/  \/\/\/\/ @patch/g, '  @Patch');
+    result = result.replace(/  \/\/\/\/ @options/g, '  @Options');
+    result = result.replace(/  \/\/\/\/ @head/g, '  @Head');
+
+    var options = { flag : 'w', encoding: 'utf8' };
+    fs.writeFileSync(file, result, options);
+}

package/targets/nestjs/templates/rewrite-path-parameters.js

@@ -0,0 +1,19 @@
+var fs = require('fs')
+
+const apiFolder = './api';
+const apiFileSuffix = '.api.ts';
+
+// rewrite path parameters
+const apiFiles = fs.readdirSync(apiFolder).filter(fn => fn.endsWith(apiFileSuffix));
+apiFiles.forEach(apiFile => rewritePathParameters(apiFile));
+
+function rewritePathParameters(fileName) {
+    const file = `${apiFolder}/${fileName}`;
+    const contents = fs.readFileSync(file, 'utf-8');
+
+    var result = contents.replace(/\${encodeURIComponent\(String\(/g, ':');
+    result = result.replace(/\)\)\}/g, '');
+
+    var options = { flag : 'w', encoding: 'utf8' };
+    fs.writeFileSync(file, result, options);
+}

package/targets/stubby/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:lts-alpine
+FROM node:18.15-alpine
 
 RUN npm install -g stubby