Add support for Postman Authorization via API key

README.md

@@ -73,8 +73,9 @@ previous versions if needed.
 
 ### CLI Options
 
-- Custom output filename: `--out=FILNAME`
-- Headers: `-H="header:value"`, can be used multiple times.
+- Custom output filename: `--out=FILENAME`
+- Headers: `-H="header: value"`, can be used multiple times.
+- Global Postman collection authorization header: `--AuthHeader="header: value"` or `-A="header: value"`
 - Get help: `--help` or `-h`
 
 ### Examples

deno.jsonc

@@ -5,8 +5,6 @@
  "ci": "deno fmt --check && deno lint"
  },
  "fmt": {
- "files": {
- "exclude": ["out"]
- }
+ "exclude": ["out"]
  }
 }

src/cli.ts

@@ -11,21 +11,31 @@ import { createPostmanCollection } from "./index.ts";
 function help() {
  console.log(`Error: not enough arguments.
 Usage:
- deno run index.ts <GRAPHQL_ENDPOINT_URL>
+ deno run index.ts <GRAPHQL_ENDPOINT_URL>
 Options:
  --out=OUTPUT_FILE Output file path
  -H="header: value" Header to add to the request, the flag can be used multiple times.
+ --AuthHeader="header: value", -A="header: value" Global header for Postman collection authorization.
 Help:
  deno run index.ts [--help | -h]
 `);
 }
 
-const args = parse(Deno.args, { boolean: ["help", "h"], collect: ["H"] }) as {
+const args = parse(Deno.args, {
+ boolean: ["help", "h"],
+ collect: ["H"],
+ string: ["AuthHeader", "A"],
+ alias: {
+ AuthHeader: "A",
+ },
+}) as {
  _: [string];
  help?: boolean;
  h?: boolean;
  out?: string;
  H?: [string];
+ AuthHeader?: string;
+ A?: string;
 };
 
 if (Deno.args.length < 1 || args.help || args.h) {
@@ -35,19 +45,30 @@ if (Deno.args.length < 1 || args.help || args.h) {
 
 const url = args._[0];
 let path = args.out;
-const headers = parseHeaders(args.H);
+
+const headers = parseHeaders(args.H || []);
+
+// Handle the AuthHeader separately
+const authHeader = (args.AuthHeader ?? args.A)
+ ? (args.AuthHeader ?? args.A)!.split(": ", 2) as [string, string]
+ : undefined;
+
+if (authHeader) {
+ headers.push(authHeader); // Add AuthHeader to headers for API access
+}
 
 const urlRegexp = /https?:\/\/*/;
 if (!urlRegexp.test(url)) {
  console.error(`${url} is not a valid url`);
  Deno.exit(1);
 }
 
-console.log(`Creating the postman collection for ${url}`);
+console.log(`Creating the Postman collection for ${url}`);
 
-const { postmanCollection } = await createPostmanCollection(
+const postmanCollection = await createPostmanCollection(
  url,
  headers,
+ authHeader,
 );
 
 path = path ||
@@ -62,4 +83,4 @@ try {
 saveJsonFormatted(postmanCollection, path);
 console.log(`Collection saved at ${path}`);
 
-console.log(`Import it in postman and complete the queries ! 🚀`);
+console.log(`Import it in Postman and complete the queries! 🚀`);