move API_KEY_HEADER_NAME to konfig-lib

konfig-dev · Sep 28, 2023 · ad98f7a · ad98f7a
1 parent 811698c
commit ad98f7a
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 6 deletions.
diff --git a/generator/konfig-dash/api/src/functions/prCreate/prCreate.ts b/generator/konfig-dash/api/src/functions/prCreate/prCreate.ts
@@ -4,7 +4,8 @@ import { App } from 'octokit'
 
 import { findRepository } from 'konfig-lib'
 import { CORS_HEADERS_ORIGIN } from 'src/lib/cors-headers'
-import { validateApiKey, API_KEY_HEADER_NAME } from 'src/lib/api-keys'
+import { validateApiKey } from 'src/lib/api-keys'
+import { API_KEY_HEADER_NAME } from 'konfig-lib'
 import {
   PrCreateResponseBodyType,
   PrCreateResponseBody,

diff --git a/generator/konfig-dash/api/src/functions/prMerge/prMerge.ts b/generator/konfig-dash/api/src/functions/prMerge/prMerge.ts
@@ -3,7 +3,8 @@ import { logger } from 'src/lib/logger'
 import { App } from 'octokit'
 
 import { findRepository } from 'konfig-lib'
-import { validateApiKey, API_KEY_HEADER_NAME } from 'src/lib/api-keys'
+import { validateApiKey } from 'src/lib/api-keys'
+import { API_KEY_HEADER_NAME } from 'konfig-lib'
 import { CORS_HEADERS_ORIGIN } from 'src/lib/cors-headers'
 import {
   PrMergeResponseBodyType,

diff --git a/generator/konfig-dash/api/src/lib/api-keys.ts b/generator/konfig-dash/api/src/lib/api-keys.ts
@@ -1,4 +1,4 @@
-export const API_KEY_HEADER_NAME = 'x-konfig-api-key'
+import { API_KEY_HEADER_NAME } from 'konfig-lib'
 
 const apiKeys: Record<string, string> = {
   qXx6mYhoJgbj8brJe11NeBNsul375Nv3: 'humanloop',

diff --git a/generator/konfig-dash/bash-scripts/guard-api-key-leak.sh b/generator/konfig-dash/bash-scripts/guard-api-key-leak.sh
@@ -12,7 +12,8 @@ for apiKey in "${apiKeys[@]}"; do
     --exclude=../../../generator/konfig-dash/.redwood/prebuild/api/src/lib/api-keys.js \
     --exclude=../../../generator/konfig-dash/api/dist/lib/api-keys.js.map \
     --exclude=../../../generator/konfig-dash/api/dist/lib/api-keys.js \
-    --exclude=../../../generator/konfig-dash/api/src/lib/api-keys.ts)
+    --exclude=../../../generator/konfig-dash/api/src/lib/api-keys.ts
+  )
   if [ -n "$files" ]; then
     foundKey=true
     echo "ERROR: Security risk detected. API key leaked in the following file(s):"

diff --git a/generator/konfig-dash/packages/konfig-cli/src/commands/pr-create.ts b/generator/konfig-dash/packages/konfig-cli/src/commands/pr-create.ts
@@ -4,6 +4,7 @@ import {
   PrCreateRequestBodyType,
   PrCreateResponseBody,
 } from 'konfig-openapi-spec'
+import { API_KEY_HEADER_NAME } from 'konfig-lib'
 
 export default class PrCreate extends Command {
   static description = 'Creates a github pull request'
@@ -72,7 +73,7 @@ export default class PrCreate extends Command {
 
     CliUx.ux.action.start(`Creating ${suffix}`)
     const result = await axios.post(url, body, {
-      headers: { 'x-konfig-api-key': apiKey },
+      headers: { [API_KEY_HEADER_NAME]: apiKey },
     })
     CliUx.ux.action.stop()
 

diff --git a/generator/konfig-dash/packages/konfig-cli/src/commands/pr-merge.ts b/generator/konfig-dash/packages/konfig-cli/src/commands/pr-merge.ts
@@ -4,6 +4,7 @@ import {
   PrMergeRequestBodyType,
   PrMergeResponseBody,
 } from 'konfig-openapi-spec'
+import { API_KEY_HEADER_NAME } from 'konfig-lib'
 
 export default class PrMerge extends Command {
   static description = 'Merges a github pull request'
@@ -62,7 +63,7 @@ export default class PrMerge extends Command {
 
     CliUx.ux.action.start(`Merging ${suffix}`)
     const result = await axios.post(url, body, {
-      headers: { 'x-konfig-api-key': apiKey },
+      headers: { [API_KEY_HEADER_NAME]: apiKey },
     })
     CliUx.ux.action.stop()
 

diff --git a/generator/konfig-dash/packages/konfig-lib/src/index.ts b/generator/konfig-dash/packages/konfig-lib/src/index.ts
@@ -53,3 +53,4 @@ export * from './forEachReferenceUntyped'
 export * from './recurseObject'
 export * from './snaptrade-demo'
 export * from './util/find-repository'
+export * from './util/konfig-api-key-header'
diff --git a/generator/konfig-dash/packages/konfig-lib/src/util/konfig-api-key-header.ts b/generator/konfig-dash/packages/konfig-lib/src/util/konfig-api-key-header.ts
@@ -0,0 +1 @@
+export const API_KEY_HEADER_NAME = 'x-konfig-api-key'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export const API_KEY_HEADER_NAME = 'x-konfig-api-key'