feat: add support for header parameters (#724)

Author: eduardoboucas

src/index.test.js

@@ -253,6 +253,31 @@ test('Can use global parameters in request body', async (t) => {
   t.true(scope.isDone())
 })
 
+test('Can set header parameters', async (t) => {
+  const deployId = uuidv4()
+  const functionName = 'testFunction'
+  const body = 'test'
+  const expectedResponse = { test: 'test' }
+  const retryCount = 3
+  const scope = nock(origin)
+    .put(`${pathPrefix}/deploys/${deployId}/functions/${functionName}`, body, {
+      'Content-Type': 'application/octet-stream',
+    })
+    .matchHeader('X-Nf-Retry-Count', retryCount.toString())
+    .reply(200, expectedResponse)
+
+  const client = getClient()
+  const response = await client.uploadDeployFunction({
+    deploy_id: deployId,
+    name: functionName,
+    body: fromString(body),
+    xNfRetryCount: retryCount,
+  })
+
+  t.deepEqual(response, expectedResponse)
+  t.true(scope.isDone())
+})
+
 test('Validates required path parameters', async (t) => {
   const accountId = uuidv4()
   const scope = nock(origin).put(`${pathPrefix}/accounts/${accountId}`).reply(200)

src/methods/index.js

@@ -3,6 +3,7 @@ import fetch from 'node-fetch'
 import { getOperations } from '../operations.js'
 
 import { addBody } from './body.js'
+import { getRequestParams } from './params.js'
 import { parseResponse, getFetchError } from './response.js'
 import { shouldRetry, waitForRetry, MAX_RETRY } from './retry.js'
 import { getUrl } from './url.js'
@@ -32,12 +33,23 @@ const callMethod = async function ({ method, basePath, defaultHeaders, agent, gl
   return parsedResponse
 }
 
-const getOpts = function ({ method: { verb, parameters }, defaultHeaders, agent, requestParams: { body }, opts }) {
+const getOpts = function ({ method: { verb, parameters }, defaultHeaders, agent, requestParams, opts }) {
+  const { body } = requestParams
   const optsA = addHttpMethod(verb, opts)
-  const optsB = addDefaultHeaders(defaultHeaders, optsA)
-  const optsC = addBody(body, parameters, optsB)
-  const optsD = addAgent(agent, optsC)
-  return optsD
+  const optsB = addHeaderParams(parameters, requestParams, optsA)
+  const optsC = addDefaultHeaders(defaultHeaders, optsB)
+  const optsD = addBody(body, parameters, optsC)
+  const optsE = addAgent(agent, optsD)
+  return optsE
+}
+
+// Add header parameters
+const addHeaderParams = function (parameters, requestParams, opts) {
+  if (parameters.header === undefined) {
+    return opts
+  }
+
+  return { ...opts, headers: getRequestParams(parameters.header, requestParams, 'header parameter') }
 }
 
 // Add the HTTP method based on the OpenAPI definition

src/methods/params.js

@@ -0,0 +1,18 @@
+import camelCase from 'lodash.camelcase'
+
+export const getRequestParams = function (params, requestParams, name) {
+  const entries = Object.values(params).map((param) => getRequestParam(param, requestParams, name))
+  return Object.assign({}, ...entries)
+}
+
+const getRequestParam = function (param, requestParams, name) {
+  const value = requestParams[param.name] || requestParams[camelCase(param.name)]
+
+  if (value !== undefined) {
+    return { [param.name]: value }
+  }
+
+  if (param.required) {
+    throw new Error(`Missing required ${name} '${param.name}'`)
+  }
+}

src/methods/url.js

@@ -1,6 +1,7 @@
-import camelCase from 'lodash.camelcase'
 import queryString from 'qs'
 
+import { getRequestParams } from './params.js'
+
 // Replace path parameters and query parameters in the URI, using the OpenAPI
 // definition
 export const getUrl = function ({ path, parameters }, basePath, requestParams) {
@@ -28,20 +29,3 @@ const addQueryParams = function (url, parameters, requestParams) {
 
   return `${url}?${queryString.stringify(queryParams, { arrayFormat: 'brackets' })}`
 }
-
-const getRequestParams = function (params, requestParams, name) {
-  const entries = Object.values(params).map((param) => getRequestParam(param, requestParams, name))
-  return Object.assign({}, ...entries)
-}
-
-const getRequestParam = function (param, requestParams, name) {
-  const value = requestParams[param.name] || requestParams[camelCase(param.name)]
-
-  if (value !== undefined) {
-    return { [param.name]: value }
-  }
-
-  if (param.required) {
-    throw new Error(`Missing required ${name} '${param.name}'`)
-  }
-}