@contentful/app-scripts 1.1.38 → 1.2.1

package/README.md

@@ -16,17 +16,18 @@ Globally:
 npm i -g @contentful/app-scripts
 ```
 
-
 ## ⚙️ Usage
 
 ### 💻 CLI
 
 When installed
+
 ```
 $ contentful-app-scripts create-app-definition
 ```
 
 Otherwise
+
 ```
 $ npx @contentful/app-scripts create-app-definition
 ```
@@ -34,14 +35,12 @@ $ npx @contentful/app-scripts create-app-definition
 ### 👨‍💻 Programmatic
 
 ```javascript
-const { createAppDefinition } = require('@contentful/app-scripts')
-const { myCustomLogic } = require('./my-custom-logic')
-
-(async function main() {
+const { createAppDefinition } = require('@contentful/app-scripts');
+const { myCustomLogic } = require('./my-custom-logic')(async function main() {
   myCustomLogic();
 
-  await createAppDefinition.interactive()
-})()
+  await createAppDefinition.interactive();
+})();
 ```
 
 ## 📜 API
@@ -107,18 +106,17 @@ When passing the `--ci` argument the command will fail when the required variabl
 
 **Options:**
 
-| Argument                 | Description                                                                                                                                    |
-| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--bundle-dir`           | The directory of your build folder (e.g.: `./build`)                                                                                           |
-| `--organization-id`      | The ID of your organisation                                                                                                                    |
-| `--definition-id`        | The ID of the app to which to add the bundle                                                                                                   |
-| `--token`                | A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens)     |
-| `--skip-activation`      | (optional) Boolean flag to skip the automatic activation of the `AppBundle`                                                                    |
-| `--comment`              | (optional) A comment which will be associated with the created `AppBundle`. Can be used to differentiate bundles.                               |
+| Argument            | Description                                                                                                                                |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `--bundle-dir`      | The directory of your build folder (e.g.: `./build`)                                                                                       |
+| `--organization-id` | The ID of your organisation                                                                                                                |
+| `--definition-id`   | The ID of the app to which to add the bundle                                                                                               |
+| `--token`           | A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens) |
+| `--skip-activation` | (optional) Boolean flag to skip the automatic activation of the `AppBundle`                                                                |
+| `--comment`         | (optional) A comment which will be associated with the created `AppBundle`. Can be used to differentiate bundles.                          |
 
 **Note:** You can also pass all arguments in interactive mode to skip being asked for it.
 
-
 ### Activate an AppBundle
 
 Allows you to activate an AppBundle for an AppDefinition.
@@ -150,12 +148,12 @@ When passing the `--ci` argument adding all variables as arguments is required
 
 **Options:**
 
-| Argument                 | Description                                                                                                                                    |
-| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--bundle-id`            | The ID of the AppBundle you want to activate                                                                                                   |
-| `--organization-id`      | The ID of your organisation                                                                                                                    |
-| `--definition-id`        | The ID of the app to which to add the bundle                                                                                                   |
-| `--token`                | A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens)     |
+| Argument            | Description                                                                                                                                |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `--bundle-id`       | The ID of the AppBundle you want to activate                                                                                               |
+| `--organization-id` | The ID of your organisation                                                                                                                |
+| `--definition-id`   | The ID of the app to which to add the bundle                                                                                               |
+| `--token`           | A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens) |
 
 **Note:** You can also pass all arguments in interactive mode to skip being asked for it.
 
@@ -177,7 +175,6 @@ You can also execute this command without the argument if the environment variab
 > $ CONTENTFUL_APP_DEF_ID=some-definition-id npx --no-install @contentful/app-scripts open-settings
 > ```
 
-
 ### Clean up bundles
 
 Allows you to clean the list of previous bundles. It fetches the list and deletes all bundles except the 50 newest ones.
@@ -211,11 +208,12 @@ When passing the `--ci` argument adding all variables as arguments is required
 
 **Options:**
 
-| Argument                 | Description                                                                                                                                    |
-| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| `--bundle-id`            | The ID of the AppBundle you want to activate                                                                                                   |
-| `--organization-id`      | The ID of your organisation                                                                                                                    |
-| `--definition-id`        | The ID of the app to which to add the bundle                                                                                                   |
-| `--keep`                 | Optional, the amount of bundles to keep                                                                                                        |
+| Argument            | Description                                  |
+| ------------------- | -------------------------------------------- |
+| `--bundle-id`       | The ID of the AppBundle you want to activate |
+| `--organization-id` | The ID of your organisation                  |
+| `--definition-id`   | The ID of the app to which to add the bundle |
+| `--keep`            | Optional, the amount of bundles to keep      |
+| `--host`            | Optional, the Contentful CMA-endpoint to use |
 
 **Note:** You can also pass all arguments in interactive mode to skip being asked for it.

package/bin/app-scripts

@@ -3,25 +3,22 @@
 const { program } = require('commander');
 const { version } = require('../package.json');
 
-const {createAppDefinition, upload, activate, cleanup, open} = require('../')
-
+const { createAppDefinition, upload, activate, cleanup, open } = require('../');
 
 async function runCommand(command, options) {
-  const {ci} = program.opts()
+  const { ci } = program.opts();
   return ci ? await command.nonInteractive(options) : await command.interactive(options);
 }
 
 (async function main() {
-  program
-    .version(version)
-    .option('--ci', 'Execute in non-interactive mode', false)
+  program.version(version).option('--ci', 'Execute in non-interactive mode', false);
 
   program
     .command('create-app-definition')
     .description('Create a new AppDefinition for an App')
     .action(async (options) => {
       await runCommand(createAppDefinition, options);
-    })
+    });
 
   program
     .command('upload')
@@ -34,7 +31,7 @@ async function runCommand(command, options) {
     .option('--skip-activation', 'A Boolean flag to skip automatic activation')
     .action(async (options) => {
       await runCommand(upload, options);
-    })
+    });
 
   program
     .command('activate')
@@ -45,7 +42,7 @@ async function runCommand(command, options) {
     .option('--token [accessToken]', 'Your content management access token')
     .action(async (options) => {
       await runCommand(activate, options);
-    })
+    });
 
   program
     .command('open-settings')
@@ -53,7 +50,7 @@ async function runCommand(command, options) {
     .option('--definition-id  [defId]', 'The id of your apps definition')
     .action(async (options) => {
       await runCommand(open, options);
-    })
+    });
 
   program
     .command('bundle-cleanup')
@@ -62,13 +59,14 @@ async function runCommand(command, options) {
     .option('--definition-id  [defId]', 'The id of your apps definition')
     .option('--token [accessToken]', 'Your content management access token')
     .option('--keep [keepAmount]', 'The amount of bundles that should remain')
+    .option('--host [host]', 'Contentful CMA-endpoint to use')
     .action(async (options) => {
       await runCommand(cleanup, options);
-    })
+    });
 
   await program.parseAsync(process.argv);
-})().catch(e => {
+})().catch((e) => {
   console.error(e);
   // eslint-disable-next-line no-process-exit
   process.exit(1);
-})
+});

package/lib/clean-up/build-clean-up-settings.js

@@ -3,7 +3,11 @@ const { getAppInfo } = require('../get-app-info');
 
 async function buildCleanUpSettings(options) {
   const appInfo = await getAppInfo(options);
-  return { ...appInfo, keep: options.keep !== undefined ? +options.keep : DEFAULT_BUNDLES_TO_KEEP };
+  return {
+    ...appInfo,
+    keep: options.keep !== undefined ? +options.keep : DEFAULT_BUNDLES_TO_KEEP,
+    host: options.host,
+  };
 }
 
 module.exports = {

package/lib/clean-up/clean-up-bundles.js

@@ -30,7 +30,13 @@ const scheduleBundleDeletion = async (bundlesToDelete, client, settings) => {
 
 async function cleanUpBundles(settings) {
   let bundles, definition;
-  const client = createClient({ accessToken: settings.accessToken }, { type: 'plain' });
+  const client = createClient(
+    {
+      host: settings.host,
+      accessToken: settings.accessToken,
+    },
+    { type: 'plain' }
+  );
   const bundlesSpinner = ora(`Fetching all bundles...`).start();
   try {
     bundles = await client.appBundle.getMany({

package/lib/get-app-info.js

@@ -4,9 +4,9 @@ const { createClient } = require('contentful-management');
 const { getManagementToken } = require('./get-management-token');
 
 const getAppInfo = async (options) => {
-  const accessToken = options.token || (await getManagementToken());
-
-  const client = createClient({ accessToken });
+  const { host } = options;
+  const accessToken = options.token || (await getManagementToken(host));
+  const client = createClient({ accessToken, host });
 
   const organization = options.organizationId
     ? await getOrganizationById(client, options.organizationId)

package/lib/get-management-token.js

@@ -5,22 +5,19 @@ const open = require('open');
 const inquirer = require('inquirer');
 const { cacheEnvVars } = require('../utils/cache-credential');
 const { createClient } = require('contentful-management');
-const {
-  ACCESS_TOKEN_ENV_KEY
-} = require('../utils/constants');
+const { ACCESS_TOKEN_ENV_KEY } = require('../utils/constants');
 
-const checkTokenValidity = async (accessToken) => {
+const checkTokenValidity = async (accessToken, host) => {
   try {
-    const client = createClient({ accessToken });
+    const client = createClient({ accessToken, host });
     await client.getCurrentUser();
     return true;
-
-  } catch(err) {
+  } catch (err) {
     return false;
   }
-}
+};
 
-async function getManagementToken() {
+async function getManagementToken(host) {
   const redirectUrl = 'https://www.contentful.com/developers/cli-oauth-page/';
   const CLIENT_ID = '9f86a1d54f3d6f85c159468f5919d6e5d27716b3ed68fd01bd534e3dea2df864';
   const oauthUrl = `https://be.contentful.com/oauth/authorize?response_type=token&scope=content_management_manage&client_id=${CLIENT_ID}&&redirect_uri=${encodeURIComponent(
@@ -28,7 +25,7 @@ async function getManagementToken() {
   )}`;
 
   const cachedAccessToken = process.env[ACCESS_TOKEN_ENV_KEY];
-  const cachedTokenValid = await checkTokenValidity(cachedAccessToken);
+  const cachedTokenValid = await checkTokenValidity(cachedAccessToken, host);
 
   if (cachedTokenValid) {
     return cachedAccessToken;
@@ -57,7 +54,7 @@ async function getManagementToken() {
     },
   ]);
 
-  await cacheEnvVars({[ACCESS_TOKEN_ENV_KEY]: mgmtToken});
+  await cacheEnvVars({ [ACCESS_TOKEN_ENV_KEY]: mgmtToken });
 
   return mgmtToken;
 }

package/lib/get-management-token.test.js

@@ -1,50 +1,82 @@
 const proxyquire = require('proxyquire');
-const { stub } = require('sinon');
+const { stub, spy } = require('sinon');
 const assert = require('assert');
 
-describe('getManagementToken', () => {
-  let subject, promptMock, openMock;
+describe('getManagementToken-js', () => {
+  context('getManagementToken', () => {
+    let subject, promptMock, openMock;
 
-  beforeEach(() => {
-    stub(console, 'log');
-  });
+    beforeEach(() => {
+      stub(console, 'log');
+    });
 
-  afterEach(() => {
-    console.log.restore();
-  });
+    afterEach(() => {
+      console.log.restore();
+    });
 
-  beforeEach(() => {
-    promptMock = stub();
-    openMock = stub();
-
-    ({ getManagementToken: subject } = proxyquire('./get-management-token', {
-      inquirer: { prompt: promptMock },
-      open: openMock,
-      'contentful-management': {
-        createClient() {
-          return {
-            async getOrganizations() {
-              throw new Error();
-            }
-          }
-        }
-      }
-    }));
-  });
+    beforeEach(() => {
+      promptMock = stub();
+      openMock = stub();
 
-  it('throws when unable to open the browser', async () => {
-    openMock.throws(new Error());
-    await assert.rejects(() => subject());
-  });
+      ({ getManagementToken: subject } = proxyquire('./get-management-token', {
+        inquirer: { prompt: promptMock },
+        open: openMock,
+        'contentful-management': {
+          createClient() {
+            return {
+              async getOrganizations() {
+                throw new Error();
+              },
+            };
+          },
+        },
+      }));
+    });
+
+    it('throws when unable to open the browser', async () => {
+      openMock.throws(new Error());
+      await assert.rejects(() => subject());
+    });
 
-  it('throws when unable to get input', async () => {
-    promptMock.throws(new Error());
-    await assert.rejects(() => subject());
+    it('throws when unable to get input', async () => {
+      promptMock.throws(new Error());
+      await assert.rejects(() => subject());
+    });
+
+    it('returns management token', async () => {
+      const mgmtToken = 'token';
+      promptMock.returns({ mgmtToken });
+      assert.strictEqual(await subject(), mgmtToken);
+    });
   });
 
-  it('returns management token', async () => {
+  context('checkTokenValidity', () => {
+    let subject, createClientSpy, promptMock, openMock;
     const mgmtToken = 'token';
-    promptMock.returns({ mgmtToken });
-    assert.strictEqual(await subject(), mgmtToken);
+    const host = 'host';
+    const mockedSettings = {
+      host,
+      accessToken: mgmtToken,
+    };
+
+    beforeEach(() => {
+      promptMock = stub();
+      openMock = stub();
+      createClientSpy = spy();
+
+      ({ getManagementToken: subject } = proxyquire('./get-management-token', {
+        inquirer: { prompt: promptMock },
+        open: openMock,
+        'contentful-management': {
+          createClient: createClientSpy,
+        },
+      }));
+    });
+
+    it('Call CMA with a host argument', async () => {
+      promptMock.returns({ mgmtToken });
+      assert.strictEqual(await subject(host), mgmtToken);
+      assert.strictEqual(createClientSpy.args[0][0].host, mockedSettings.host);
+    });
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.1.38",
+  "version": "1.2.1",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -52,7 +52,7 @@
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "9.4.1",
-    "contentful-management": "10.20.1",
+    "contentful-management": "10.21.0",
     "dotenv": "16.0.3",
     "ignore": "5.2.0",
     "inquirer": "8.2.5",
@@ -60,5 +60,5 @@
     "open": "8.4.0",
     "ora": "5.4.1"
   },
-  "gitHead": "12c0d6996aa8f20723b4db3fc738dbe9b5e9418f"
+  "gitHead": "4931037eadb494e1b4de4d07f07adf52f39701e8"
 }