Merge pull request #18 from Lorenzohidalgo/dev

package.json

@@ -46,7 +46,7 @@
   "dependencies": {
     "commander": "^11.0.0",
     "graphql": "^16.7.1",
-    "postman-collection": "^4.1.7",
+    "postman-collection": "^4.2.0",
     "prettier": "^3.0.0"
   },
   "devDependencies": {

src/index.js

@@ -6,6 +6,8 @@ const main = async ({
   destDirPath,
   collectionName,
   rawUrl,
+  apiKey,
+  generatePostmanOnly = 'false',
   useVariables = 'false',
   maxDepth = 10,
   encoding = 'utf-8',
@@ -15,11 +17,17 @@ const main = async ({
 
   const parsedSchema = await parseSchema(gqlSchema, JSON.parse(useVariables), maxDepth);
 
-  saveAsFiles(destDirPath, parsedSchema);
+  if (!JSON.parse(generatePostmanOnly)) saveAsFiles(destDirPath, parsedSchema);
 
-  saveAsPostman(destDirPath, parsedSchema, collectionName, rawUrl);
+  if (JSON.parse(generatePostmanOnly) && (!collectionName || !rawUrl))
+    console.warn(
+      '--generatePostmanOnly was set to true but no valid --collectionName or --rawUrl where provided',
+    );
+
+  if (collectionName && rawUrl)
+    saveAsPostman(destDirPath, parsedSchema, collectionName, rawUrl, apiKey);
 };
 
 module.exports = {
   main,
-};
+};

src/io/saveAsPostman.js

@@ -1,4 +1,4 @@
-const { Collection, ItemGroup, Item, Url } = require('postman-collection');
+const { Collection, ItemGroup, Item, Url, RequestAuth } = require('postman-collection');
 
 const { mkdirSync, writeFileSync } = require('fs');
 const { resolve, join } = require('path');
@@ -22,19 +22,42 @@ const buildItemList = (operations, rawUrl) =>
       }),
   );
 
-const saveAsPostman = (destinationDirectory, parsedSchema, collectionName, rawUrl) => {
+const saveAsPostman = (destinationDirectory, parsedSchema, collectionName, rawUrl, apiKey) => {
   if (!parsedSchema.mutations && !parsedSchema.queries && !parsedSchema.subscriptions) {
     // eslint-disable-next-line no-console
     console.error('No operations found to be saved');
     return;
   }
-  
+
   const newCollection = new Collection({
     info: {
       name: collectionName,
     },
   });
 
+  if (apiKey?.length > 0) {
+    newCollection.auth = new RequestAuth({
+      type: 'apikey',
+      apikey: [
+        {
+          key: 'value',
+          value: apiKey,
+          type: 'string',
+        },
+        {
+          key: 'key',
+          value: 'x-api-key',
+          type: 'string',
+        },
+        {
+          key: 'in',
+          value: 'header',
+          type: 'string',
+        },
+      ],
+    });
+  }
+
   if (parsedSchema.mutations) {
     newCollection.items.add(
       new ItemGroup({

src/standAlone.js

@@ -10,6 +10,8 @@ program
   )
   .option('--collectionName [value]', 'Name to use name the Postman Collection')
   .option('--rawUrl [value]', 'GraphQL API endpoint URL, used to generate the Postman Collection')
+  .option('--apiKey [value]', 'API Key, will be used to generate a x-api-key header')
+  .option('--generatePostmanOnly [value]', 'Defines if only the postman collection should be generated', 'false')
   .option('--maxDepth [value]', 'query depth you want to limit (The default is 10)', 10)
   .option('--useVariables [value]', 'Defines if variables should be used while generating the requests', 'true')
   .option('--encoding [value]', 'The encoding to use while reading the files (The default is utf-8)', 'utf-8')