@contentful/app-scripts 1.9.0 → 1.10.1

package/bin/app-scripts

@@ -29,6 +29,7 @@ async function runCommand(command, options) {
     .option('--token [accessToken]', 'Your content management access token')
     .option('--comment [comment]', 'Optional comment for the created bundle')
     .option('--skip-activation', 'A Boolean flag to skip automatic activation')
+    .option('--host [host]', 'Contentful domain to use')
     .action(async (options) => {
       await runCommand(upload, options);
     });
@@ -40,6 +41,7 @@ async function runCommand(command, options) {
     .option('--organization-id [orgId]', 'The id of your organization')
     .option('--definition-id  [defId]', 'The id of your apps definition')
     .option('--token [accessToken]', 'Your content management access token')
+    .option('--host [host]', 'Contentful domain to use')
     .action(async (options) => {
       await runCommand(activate, options);
     });
@@ -59,14 +61,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')
+    .option('--host [host]', 'Contentful domain to use')
     .action(async (options) => {
       await runCommand(cleanup, options);
     });
 
   program.hook('preAction', (thisCommand) => {
-    track({ command: thisCommand.args[0], ci: `${thisCommand._optionValues.ci}` })
-  })
+    track({ command: thisCommand.args[0], ci: `${thisCommand._optionValues.ci}` });
+  });
 
   await program.parseAsync(process.argv);
 })().catch((e) => {

package/lib/activate/activate-bundle.js

@@ -3,9 +3,9 @@ const chalk = require('chalk');
 const { throwError } = require('../utils');
 const { createClient } = require('contentful-management');
 
-async function activateBundle({ accessToken, organization, definition, bundleId }) {
+async function activateBundle({ accessToken, organization, definition, bundleId, host }) {
   const activationSpinner = ora('Activating your bundle').start();
-  const plainClient = createClient({ accessToken }, { type: 'plain' });
+  const plainClient = createClient({ accessToken, host }, { type: 'plain' });
   const defaultLocations = [{ location: 'dialog' }];
 
   const currentDefinition = await plainClient.appDefinition.get({

package/lib/activate/activate-bundle.test.js

@@ -10,7 +10,8 @@ const mockedSettings = {
 };
 
 describe('activate-bundle', () => {
-  let activateBundle, clientMock, updateStub;
+  // eslint-disable-next-line no-unused-vars
+  let activateBundle, clientMock, updateStub, createClientArgs;
   beforeEach(() => {
     stub(console, 'log');
   });
@@ -23,7 +24,7 @@ describe('activate-bundle', () => {
   const definitionMock = {
     src: 'src',
     bundle: undefined,
-    locations: []
+    locations: [],
   };
 
   beforeEach(() => {
@@ -37,7 +38,8 @@ describe('activate-bundle', () => {
 
     ({ activateBundle } = proxyquire('./activate-bundle', {
       'contentful-management': {
-        createClient: () => {
+        createClient: (...args) => {
+          createClientArgs = args;
           return clientMock;
         },
       },
@@ -60,4 +62,8 @@ describe('activate-bundle', () => {
     await activateBundle(mockedSettings);
     assert.strictEqual(throwErrorStub.called, true);
   });
+  it('supports custom defined host domain', async () => {
+    await activateBundle({ ...mockedSettings, host: 'jane.doe.com' });
+    assert.strictEqual(createClientArgs[0].host, 'jane.doe.com');
+  });
 });

package/lib/activate/build-bundle-activate-settings.js

@@ -4,7 +4,7 @@ const inquirer = require('inquirer');
 const { getAppInfo } = require('../get-app-info');
 
 async function buildBundleActivateSettings(options) {
-  let bundleId = options.bundleId;
+  let { bundleId, host } = options;
   if (!bundleId) {
     const prompts = await inquirer.prompt([
       {
@@ -22,6 +22,7 @@ async function buildBundleActivateSettings(options) {
   return {
     ...appInfo,
     bundleId,
+    host,
   };
 }
 

package/lib/activate/get-activate-args.js

@@ -20,6 +20,7 @@ async function getActivateSettingsArgs(options) {
       ...appInfo,
       bundleId: options.bundleId,
       comment: options.comment,
+      host: options.host,
     };
   } catch (err) {
     console.log(`

package/lib/upload/build-upload-settings.js

@@ -7,14 +7,15 @@ const { getActionsManifest } = require('../utils');
 async function buildAppUploadSettings(options) {
   const actionsManifest = getActionsManifest();
   const prompts = [];
-  if (!options.bundleDir) {
+  const { bundleDir, comment, skipActivation, host } = options;
+  if (!bundleDir) {
     prompts.push({
       name: 'bundleDirectory',
       message: `Bundle directory, if not default:`,
       default: './build',
     });
   }
-  if (!options.comment) {
+  if (!comment) {
     prompts.push({
       name: 'comment',
       message: `Add a comment to the created bundle:`,
@@ -27,9 +28,10 @@ async function buildAppUploadSettings(options) {
   const appInfo = await getAppInfo(options);
   // Add app-config & dialog automatically
   return {
-    bundleDirectory: options.bundleDir,
-    skipActivation: !!options.skipActivation,
-    comment: options.comment,
+    bundleDirectory: bundleDir,
+    skipActivation: !!skipActivation,
+    comment,
+    host,
     actions: actionsManifest,
     ...appUploadSettings,
     ...appInfo,

package/lib/upload/create-app-bundle.js

@@ -6,12 +6,12 @@ const { createClient } = require('contentful-management');
 const { createAppUpload } = require('./create-app-upload');
 
 async function createAppBundleFromUpload(settings, appUploadId) {
+  const { accessToken, host, userAgentApplication, comment, actions } = settings;
   const clientSpinner = ora('Verifying your upload...').start();
   const client = createClient({
-    accessToken: settings.accessToken,
-    application: settings.userAgentApplication
-      ? settings.userAgentApplication
-      : 'contentful.app-scripts',
+    accessToken,
+    host,
+    application: userAgentApplication ? userAgentApplication : 'contentful.app-scripts',
   });
   const organization = await client.getOrganization(settings.organization.value);
   const appDefinition = await organization.getAppDefinition(settings.definition.value);
@@ -22,8 +22,8 @@ async function createAppBundleFromUpload(settings, appUploadId) {
   try {
     appBundle = await appDefinition.createAppBundle({
       appUploadId,
-      comment: settings.comment && settings.comment.length > 0 ? settings.comment : undefined,
-      actions: settings.actions,
+      comment: comment && comment.length > 0 ? comment : undefined,
+      actions,
     });
   } catch (err) {
     showCreationError('app upload', err.message);

package/lib/upload/create-app-bundle.test.js

@@ -10,7 +10,8 @@ const mockedSettings = {
 };
 
 describe('createAppBundleFromUpload', () => {
-  let createAppBundleFromUpload, clientMock;
+  // eslint-disable-next-line no-unused-vars
+  let createAppBundleFromUpload, clientMock, createClientArgs;
 
   beforeEach(() => {
     stub(console, 'log');
@@ -32,7 +33,8 @@ describe('createAppBundleFromUpload', () => {
 
     ({ createAppBundleFromUpload } = proxyquire('./create-app-bundle', {
       'contentful-management': {
-        createClient: () => {
+        createClient: (...args) => {
+          createClientArgs = args;
           return clientMock;
         },
       },
@@ -52,10 +54,14 @@ describe('createAppBundleFromUpload', () => {
 
     assert(console.log.calledWith(match(/Creation error:/)));
   });
+  it('supports custom defined host domain creating appbundle from upload', async () => {
+    await createAppBundleFromUpload({ ...mockedSettings, host: 'jane.doe.com' });
+    assert.strictEqual(createClientArgs[0].host, 'jane.doe.com');
+  });
 });
 
 describe('createAppBundleFromSettings', () => {
-  let createAppBundleFromSettings, clientMock, uploadMock;
+  let createAppBundleFromSettings, clientMock, uploadMock, createClientArgs;
 
   beforeEach(() => {
     stub(console, 'log');
@@ -79,7 +85,8 @@ describe('createAppBundleFromSettings', () => {
 
     ({ createAppBundleFromSettings } = proxyquire('./create-app-bundle', {
       'contentful-management': {
-        createClient: () => {
+        createClient: (...args) => {
+          createClientArgs = args;
           return clientMock;
         },
       },
@@ -96,4 +103,8 @@ describe('createAppBundleFromSettings', () => {
     await createAppBundleFromSettings(mockedSettings);
     assert(console.log.calledWith(match(/Creation error:/)));
   });
+  it('supports custom defined host domain creating appbundle from settings', async () => {
+    await createAppBundleFromSettings({ ...mockedSettings, host: 'jane.doe.com' });
+    assert.strictEqual(createClientArgs[0].host, 'jane.doe.com');
+  });
 });

package/lib/upload/create-app-upload.js

@@ -4,8 +4,8 @@ const { validateBundle } = require('./validate-bundle');
 const { showCreationError } = require('../utils');
 const { createClient } = require('contentful-management');
 
-async function createAppBundleFromFile(orgId, token, zip) {
-  const client = await createClient({ accessToken: token });
+async function createAppBundleFromFile(orgId, token, zip, host = '') {
+  const client = await createClient({ accessToken: token, host, hostUpload: host.replace(/^api/i, 'upload') });
   const org = await client.getOrganization(orgId);
   return await org.createAppUpload(zip);
 }
@@ -24,7 +24,8 @@ async function createAppUpload(settings) {
     appUpload = await createAppBundleFromFile(
       settings.organization.value,
       settings.accessToken,
-      zipFile
+      zipFile,
+      settings.host
     );
   } catch (err) {
     showCreationError('app bundle', err.message);

package/lib/upload/get-upload-settings-args.js

@@ -14,16 +14,18 @@ const requiredOptions = {
 async function getUploadSettingsArgs(options) {
   const validateSpinner = ora('Validating your input...').start();
   const actionsManifest = getActionsManifest();
+  const { bundleDir, comment, skipActivation, host, userAgentApplication } = options;
 
   try {
     validateArguments(requiredOptions, options, 'upload');
     const appInfo = await getAppInfo(options);
     return {
       ...appInfo,
-      bundleDirectory: options.bundleDir,
-      skipActivation: options.skipActivation,
-      comment: options.comment,
-      userAgentApplication: options.userAgentApplication,
+      bundleDirectory: bundleDir,
+      skipActivation,
+      comment,
+      host,
+      userAgentApplication,
       actions: actionsManifest,
     };
   } catch (err) {

package/lib/utils.js

@@ -15,7 +15,7 @@ const throwValidationException = (subject, message, details) => {
 
 const isValidNetwork = (address) => {
   const addressRegex =
-    /^(?:localhost|(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,6}|(?:\d{1,3}\.){3}\d{1,3}|(\[(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}\]|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}))(?::\d{1,5})?$/;
+    /^(?:localhost|(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,6}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(\[(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}\]|(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}))(?::\d{1,5})?$/;
   return addressRegex.test(address);
 };
 
@@ -94,17 +94,16 @@ function getActionsManifest() {
     console.log('');
 
     const actions = manifest.actions.map((action) => {
-      const allowedNetworks = Array.isArray(action.allowedNetworks)
-        ? allowedNetworks.map(stripProtocol)
+      const allowNetworks = Array.isArray(action.allowNetworks)
+        ? action.allowNetworks.map(stripProtocol)
         : [];
 
-      const hasInvalidNetwork = allowedNetworks.find((netWork) => !isValidNetwork(netWork));
-
+      const hasInvalidNetwork = allowNetworks.find((netWork) => !isValidNetwork(netWork));
       if (hasInvalidNetwork) {
         console.log(
           `${chalk.red(
             'Error:'
-          )} Invalid IP address ${hasInvalidNetwork} found in the allowedNetworks array for action "${
+          )} Invalid IP address ${hasInvalidNetwork} found in the allowNetworks array for action "${
             action.name
           }".`
         );
@@ -112,10 +111,14 @@ function getActionsManifest() {
         process.exit(1);
       }
 
+      // EntryFile is not used but we do want to strip it from action
+      // eslint-disable-next-line no-unused-vars
+      const { entryFile: _, ...actionWithoutEntryFile } = action;
+
       return {
         parameters: [],
-        ...action,
-        allowedNetworks,
+        ...actionWithoutEntryFile,
+        allowNetworks,
       };
     });
 

package/lib/utils.test.js

@@ -0,0 +1,198 @@
+const assert = require('assert');
+const { stub } = require('sinon');
+const proxyquire = require('proxyquire');
+
+const { isValidNetwork, stripProtocol } = require('./utils');
+
+describe('isValidIpAddress', () => {
+  it('returns true for a valid IP address', () => {
+    const result = isValidNetwork('192.168.0.1');
+    assert.strictEqual(result, true);
+  });
+
+  it('returns true for a valid domain', () => {
+    const result = isValidNetwork('google.com');
+    assert.strictEqual(result, true);
+  });
+
+  it('returns true for a valid ipv6 address', () => {
+    const result = isValidNetwork('2001:0db8:85a3:0000:0000:8a2e:0370:7334');
+    assert.strictEqual(result, true);
+  });
+
+  it('returns true for a valid domain with port', () => {
+    const result = isValidNetwork('google.com:4000');
+    assert.strictEqual(result, true);
+  });
+
+  it('returns true for a valid IP address with port', () => {
+    const result = isValidNetwork('192.168.0.1:2000');
+    assert.strictEqual(result, true);
+  });
+
+  it('returns false for an invalid IP address', () => {
+    const result = isValidNetwork('not an ip address');
+    assert.strictEqual(result, false);
+  });
+
+  it('returns false for an invalid IP address', () => {
+    const result = isValidNetwork('427.0.0.1');
+    assert.strictEqual(result, false);
+  });
+
+  it('returns true for an valid ipv6 address with port', () => {
+    const result = isValidNetwork('[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:443');
+    assert.strictEqual(result, true);
+  });
+});
+
+describe('removeProtocolFromUrl', () => {
+  it('returns the host of a URL without a protocol', () => {
+    const result = stripProtocol('http://example.com');
+    assert.strictEqual(result, 'example.com');
+  });
+
+  it('returns valid ipv6 address', () => {
+    const result = stripProtocol('http://[2001:0db8:85a3:0000:0000:8a2e:0370]:7334');
+    assert.strictEqual(result, '[2001:0db8:85a3:0000:0000:8a2e:0370]:7334');
+  });
+
+  it('returns valid domain', () => {
+    const result = stripProtocol('example.com');
+    assert.strictEqual(result, 'example.com');
+  });
+
+  it('returns valid domain with port', () => {
+    const result = stripProtocol('example.com:40');
+    assert.strictEqual(result, 'example.com:40');
+  });
+});
+
+describe('getActionsManifest', () => {
+  let fs, exitStub, consoleLog, chalk;
+  let DEFAULT_MANIFEST_PATH = 'path/to/manifest';
+
+  const actionMock = {
+    name: 'name',
+    category: 'Custom',
+    description: 'descriptoin',
+    type: 'function',
+    path: 'actions/mock.js',
+    entryFile: './actions/mock.ts',
+    parameters: [],
+    allowNetworks: ['127.0.0.1', 'some.domain.tld'],
+  };
+  // eslint-disable-next-line no-unused-vars
+  const { entryFile: _, ...resultMock } = actionMock;
+
+  fs = {
+    existsSync: stub(),
+    readFileSync: stub(),
+  };
+  chalk = {
+    bold: stub(),
+    red: stub(),
+  };
+
+  let { getActionsManifest } = proxyquire('./utils', { fs, chalk });
+
+  beforeEach(() => {
+    exitStub = stub(process, 'exit');
+    consoleLog = stub(console, 'log');
+  });
+  afterEach(() => {
+    exitStub.restore();
+    consoleLog.restore();
+  });
+
+  it('should return undefined if manifest does not exist', () => {
+    fs.existsSync.returns(false);
+
+    const result = getActionsManifest(DEFAULT_MANIFEST_PATH);
+
+    assert.equal(result, undefined);
+  });
+
+  it('should return undefined if manifest has no actions', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(JSON.stringify({ actions: [] }));
+
+    const result = getActionsManifest(DEFAULT_MANIFEST_PATH);
+    assert.equal(result, undefined);
+  });
+
+  it('should return an array of actions if manifest is valid', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        actions: [actionMock],
+      })
+    );
+
+    const result = getActionsManifest();
+
+    assert.deepEqual(result, [resultMock]);
+    assert.ok(consoleLog.called);
+  });
+
+  it('should strip the protocol when a domain has a protocol in allowNetworks', () => {
+    const mockAction = {
+      ...actionMock,
+      allowNetworks: ['http://some.domain.tld'],
+    };
+    // eslint-disable-next-line no-unused-vars
+    const { entryFile: _, ...resultMock } = mockAction;
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        actions: [mockAction],
+      })
+    );
+
+    const result = getActionsManifest();
+
+    assert.deepEqual(result, [{ ...resultMock, allowNetworks: ['some.domain.tld'] }]);
+    assert.ok(consoleLog.called);
+  });
+
+  it('should return an array of actions without entryFile prop if manifest is valid', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        actions: [actionMock],
+      })
+    );
+
+    const result = getActionsManifest();
+
+    assert.notDeepEqual(result, [actionMock]);
+  });
+
+  it('should exit with error if invalid network is found in allowNetworks', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        actions: [
+          {
+            name: 'action1',
+            entryFile: 'entry1',
+            allowNetworks: ['412.1.1.1'],
+          },
+        ],
+      })
+    );
+
+    getActionsManifest();
+
+    assert.ok(exitStub.calledOnceWith(1));
+  });
+
+  it('should exit with error if manifest is invalid JSON', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.throws();
+
+    getActionsManifest();
+
+    assert.ok(exitStub.calledOnceWith(1));
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.9.0",
+  "version": "1.10.1",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -53,7 +53,7 @@
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "10.0.1",
-    "contentful-management": "10.35.3",
+    "contentful-management": "10.35.4",
     "dotenv": "16.0.3",
     "ignore": "5.2.4",
     "inquirer": "8.2.5",
@@ -61,5 +61,5 @@
     "open": "8.4.2",
     "ora": "5.4.1"
   },
-  "gitHead": "63817dc3be779cc5bf2258d955618069bbeecbe5"
+  "gitHead": "acb35d8d35b30e8d5c3ded1a761e849d68b37d0d"
 }

package/lib/utills.test.js

@@ -1,62 +0,0 @@
-const assert = require('assert');
-
-const { isValidNetwork, stripProtocol } = require('./utils');
-
-describe('isValidIpAddress', () => {
-  it('returns true for a valid IP address', () => {
-    const result = isValidNetwork('192.168.0.1');
-    assert.strictEqual(result, true);
-  });
-
-  it('returns true for a valid domain', () => {
-    const result = isValidNetwork('google.com');
-    assert.strictEqual(result, true);
-  });
-
-  it('returns true for a valid ipv6 address', () => {
-    const result = isValidNetwork('2001:0db8:85a3:0000:0000:8a2e:0370:7334');
-    assert.strictEqual(result, true);
-  });
-
-  it('returns true for a valid domain with port', () => {
-    const result = isValidNetwork('google.com:4000');
-    assert.strictEqual(result, true);
-  });
-
-  it('returns true for a valid IP address with port', () => {
-    const result = isValidNetwork('192.168.0.1:2000');
-    assert.strictEqual(result, true);
-  });
-
-  it('returns false for an invalid IP address', () => {
-    const result = isValidNetwork('not an ip address');
-    assert.strictEqual(result, false);
-  });
-
-  it('returns true for an valid ipv6 address with port', () => {
-    const result = isValidNetwork('[2001:0db8:85a3:0000:0000:8a2e:0370:7334]:443');
-    assert.strictEqual(result, true);
-  });
-});
-
-describe('removeProtocolFromUrl', () => {
-  it('returns the host of a URL without a protocol', () => {
-    const result = stripProtocol('http://example.com');
-    assert.strictEqual(result, 'example.com');
-  });
-
-  it('returns valid ipv6 address', () => {
-    const result = stripProtocol('http://[2001:0db8:85a3:0000:0000:8a2e:0370]:7334');
-    assert.strictEqual(result, '[2001:0db8:85a3:0000:0000:8a2e:0370]:7334');
-  });
-
-  it('returns valid domain', () => {
-    const result = stripProtocol('example.com');
-    assert.strictEqual(result, 'example.com');
-  });
-
-  it('returns valid domain with port', () => {
-    const result = stripProtocol('example.com:40');
-    assert.strictEqual(result, 'example.com:40');
-  });
-});