Merge pull request #4 from yndlingsfar/feature/resonse-params

add responseParameters template

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.3.0 (2021-05-05)
+- additional template and auto-generation for responseParameters if cors support enabled
+
+## 1.2.5 (2021-04-20)
+- Updated Readme
+
+## 1.2.4 (2021-04-20)
+- Updated Readme
+
+## 1.2.3 (2021-04-20)
+- Updated Readme
+
+## 1.2.2 (2021-04-20)
+- Updated Readme
+
 ## 1.2.0 (2021-04-19)
 - added support for CORS generation
 

README.md

@@ -224,6 +224,7 @@ You can customize the CORS templates by placing your own files inside a director
 | headers.yml    | All headers required for CORS support |
 | integration.yml      | Contains the x-amazon-apigateway-integration block  |
 | path.yml| OpenApi specification for the OPTIONS method       |
+| response-parameters.yml| The response Parameters of the x-amazon-apigateway-integration responses      |
 
 See the EXAMPLES directory for detailed instructions.
 

examples/openapi-integration/response-parameters.yml

@@ -0,0 +1,3 @@
+method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key'''
+method.response.header.Access-Control-Allow-Methods: '''*'''
+method.response.header.Access-Control-Allow-Origin: '''*'''

lib/index.js

@@ -6,6 +6,7 @@ const AddCorsHeader = require('./pipelines/add-cors-header')
 const WriteOutputFile = require('./pipelines/write-file-output')
 const AddIntegrations = require('./pipelines/add-integration')
 const AddCorsIntegration = require('./pipelines/add-cors-integrations')
+const AddCorsResponseParameters = require('./pipelines/add-cors-response-parameters')
 const Pipeline = require('./pipeline')
 
 class MergeIntegrationPlugin {
@@ -66,6 +67,7 @@ class MergeIntegrationPlugin {
             .step(new AddCorsMethods())
             .step(new AddCorsHeader())
             .step(new AddCorsIntegration())
+            .step(new AddCorsResponseParameters())
             .step(new WriteOutputFile())
             .end()
 

lib/options-resolver.js

@@ -19,7 +19,6 @@ class OptionsResolver {
 
             return false;
         }
-        console.log(this.options.cors)
         return this.options.cors && (this.options.cors === true || this.options.cors === "true")
     }
 

lib/pipelines/add-cors-response-parameters.js

@@ -0,0 +1,52 @@
+const jsYml = require('js-yaml');
+const fs = require('fs');
+const path = require('path');
+const merge = require('lodash.merge')
+
+class AddCorsResponseParameters {
+    invoke(options, content, serverless) {
+        try {
+            if (!options.cors) {
+                return content;
+            }
+
+            const cors = this.readTemplate(serverless);
+            Object.entries(content.paths).forEach(([key, pathContent]) => {
+                Object.entries(pathContent).forEach(([method, methodContent]) => {
+                    if ((methodContent.hasOwnProperty('x-amazon-apigateway-integration'))) {
+                        Object.entries(methodContent['x-amazon-apigateway-integration'].responses).forEach(([responses, responseContent]) => {
+                            if (!responseContent.hasOwnProperty('responseParameters')) {
+                                let params = {responseParameters: cors};
+                                Object.assign(responseContent, merge(responseContent, params));
+                            } else {
+                                Object.assign(responseContent.responseParameters, merge(responseContent.responseParameters, cors));
+                            }
+                        });
+                    }
+                });
+            });
+
+            return content;
+        } catch (e) {
+            console.log(e);
+        }
+        return content
+    }
+
+    readTemplate(serverless) {
+        const templatePath = path.resolve(process.cwd(), 'openapi-integration/response-parameters.yml')
+        try {
+            if (fs.existsSync(templatePath)) {
+                serverless.cli.log(`Openapi Integration: add custom CORS integration template`);
+                return jsYml.load(fs.readFileSync(templatePath))
+            }
+        } catch (err) {
+            console.error(err)
+        }
+
+        serverless.cli.log(`Openapi Integration: add default CORS integration template`);
+        return jsYml.load(fs.readFileSync(__dirname + '/../../templates/cors/response-parameters.yml'));
+    }
+}
+
+module.exports = AddCorsResponseParameters

package.json

@@ -10,7 +10,7 @@
     "serverless-plugin",
     "x-amazon-apigateway-integration"
   ],
-  "version": "1.2.5",
+  "version": "1.3.0",
   "description": "Serverless plugin for integrating aws gateway syntax into open api specification",
   "main": "lib/index.js",
   "scripts": {

templates/cors/response-parameters.yml

@@ -0,0 +1,3 @@
+method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key'''
+method.response.header.Access-Control-Allow-Methods: '''*'''
+method.response.header.Access-Control-Allow-Origin: '''*'''