feat(proxy): add proxy and raw-proxy config

README.md

@@ -65,7 +65,11 @@
       - [`transformEntries(config)`](#transformentriesconfig)
         - [`transformEntries` Example](#transformentries-example)
       - [`deriveLinkedEntries(config)`](#derivelinkedentriesconfig)
-        - [`deriveLinkedEntries` Example](#derivelinkedentries-example)
+        - [`deriveLinkedEntries(config)` Example](#derivelinkedentriesconfig-example)
+    - [`context`](#context)
+      - [`makeRequest(config)`](#makerequestconfig)
+      - [`spaceId` : `string`](#spaceid--string)
+      - [`accessToken` : `string`](#accesstoken--string)
     - [Content type](#content-type)
       - [`createField(id[, opts])` : [Field](#field)](#createfieldid-opts--fieldfield)
       - [`editField(id[, opts])` : [Field](#field)](#editfieldid-opts--fieldfield)
@@ -75,6 +79,7 @@
     - [Field](#field)
   - [Validation errors](#validation-errors)
   - [Example migrations](#example-migrations)
+  - [Troubleshooting](#troubleshooting)
   - [Reach out to us](#reach-out-to-us)
     - [You have questions about how to use this library?](#you-have-questions-about-how-to-use-this-library)
     - [You found a bug or want to propose a feature?](#you-found-a-bug-or-want-to-propose-a-feature)
@@ -468,6 +473,18 @@ migrations()
 
 ```
 
+## Troubleshooting
+
+*  Unable to connect to Contentful through your Proxy? Try to set the `rawProxy` option to `true`.
+
+```javascript
+runMigration({
+  proxy: 'https://cat:[email protected]:1234',
+  rawProxy: true,
+  ...
+})
+```
+
 ## Reach out to us
 
 ### You have questions about how to use this library?

src/bin/lib/contentful-client/index.ts

@@ -5,16 +5,19 @@ import { createClient as _createClient } from 'contentful-management'
 let createClient = _createClient
 
 function createManagementClient (params) {
-  const proxyConfig = loadProxyFromEnv(process.env)
-  const { httpsAgent } = agentFromProxy(proxyConfig)
+  if (!params.application) {
+    throw new Error('Please specify the application name that uses this client instance')
+  }
 
-  const config = Object.assign({ httpsAgent }, params)
+  params.proxy = params.proxy || loadProxyFromEnv(process.env)
 
-  if (!config.application) {
-    throw new Error('Please specify the application name that uses this client instance')
+  if (!params.rawProxy) {
+    const { httpsAgent } = agentFromProxy(params.proxy)
+    params.httpsAgent = httpsAgent
+    delete params.proxy
   }
 
-  return createClient(config)
+  return createClient(params)
 }
 
 export {

src/bin/usage-params.ts

@@ -28,6 +28,15 @@ export default yargs
     alias: 'a',
     describe: 'The access token to use\nThis takes precedence over environment variables or .contentfulrc'
   })
+  .option('proxy', {
+    describe: 'Proxy configuration in HTTP auth format: [http|https]://host:port or [http|https]://user:password@host:port',
+    type: 'string'
+  })
+  .option('raw-proxy', {
+    describe: 'Pass proxy config to Axios instead of creating a custom httpsAgent',
+    type: 'boolean',
+    default: false
+  })
   .option('yes', {
     alias: 'y',
     boolean: true,