@contentful/app-scripts 1.11.0 → 1.13.0

package/README.md

@@ -109,7 +109,7 @@ When passing the `--ci` argument the command will fail when the required variabl
 | Argument            | Description                                                                                                                                | Default value |
 | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | - |
 | `--bundle-dir`      | The directory of your build folder (e.g.: `./build`)                                                                                       | |
-| `--organization-id` | The ID of your organisation                                                                                                                | |
+| `--organization-id` | The ID of your organization                                                                                                                | |
 | `--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`                                                                | `false` |
@@ -152,7 +152,7 @@ When passing the `--ci` argument adding all variables as arguments is required.
 | Argument            | Description                                                                                                                                | Default value |
 | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | --- |
 | `--bundle-id`       | The ID of the AppBundle you want to activate                                                                                               | |
-| `--organization-id` | The ID of your organisation                                                                                                                | |
+| `--organization-id` | The ID of your organization                                                                                                                | |
 | `--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) | |
 | `--host`            | (optional) Contentful CMA-endpoint to use                                                                                                  | `api.contentful.com` |
@@ -212,9 +212,9 @@ When passing the `--ci` argument adding all variables as arguments is required
 
 | Argument            | Description                                  | Default value        |
 | ------------------- | -------------------------------------------- | -------------------- |
-| `--bundle-id`       | The ID of the AppBundle you want to activate |                      |
-| `--organization-id` | The ID of your organisation                  |                      |
+| `--organization-id` | The ID of your organization                  |                      |
 | `--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) | |
 | `--keep`            | (optional) The amount of bundles to keep     | `50`                 |
 | `--host`            | (optional) Contentful CMA-endpoint to use    | `api.contentful.com` |
 

package/lib/activate/activate-bundle.d.ts

@@ -0,0 +1,2 @@
+import { ActivateSettings } from '../types';
+export declare function activateBundle({ accessToken, organization, definition, bundleId, host, }: ActivateSettings): Promise<void>;

package/lib/activate/activate-bundle.js

@@ -1,63 +1,50 @@
-const ora = require('ora');
-const chalk = require('chalk');
-const { throwError } = require('../utils');
-const { createClient } = require('contentful-management');
-
-async function activateBundle({ accessToken, organization, definition, bundleId, host }) {
-  const activationSpinner = ora('Activating your bundle').start();
-  const plainClient = createClient({ accessToken, host }, { type: 'plain' });
-  const defaultLocations = [{ location: 'dialog' }];
-
-  const currentDefinition = await plainClient.appDefinition.get({
-    appDefinitionId: definition.value,
-    organizationId: organization.value,
-  });
-
-  currentDefinition.bundle = {
-    sys: {
-      id: bundleId,
-      linkType: 'AppBundle',
-      type: 'Link',
-    },
-  };
-  if (!currentDefinition.locations.length) {
-    currentDefinition.locations = defaultLocations;
-  }
-  delete currentDefinition.src;
-
-  try {
-    await plainClient.appDefinition.update(
-      {
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.activateBundle = void 0;
+const ora_1 = __importDefault(require("ora"));
+const chalk_1 = require("chalk");
+const utils_1 = require("../utils");
+const contentful_management_1 = require("contentful-management");
+async function activateBundle({ accessToken, organization, definition, bundleId, host, }) {
+    const activationSpinner = (0, ora_1.default)('Activating your bundle').start();
+    const plainClient = (0, contentful_management_1.createClient)({ accessToken, host }, { type: 'plain' });
+    const defaultLocations = [{ location: 'dialog' }];
+    const currentDefinition = await plainClient.appDefinition.get({
         appDefinitionId: definition.value,
         organizationId: organization.value,
-      },
-      currentDefinition
-    );
-  } catch (err) {
-    throwError(
-      err,
-      'Something went wrong activating your bundle. Make sure you used the correct definition-id.'
-    );
-  } finally {
-    activationSpinner.stop();
-  }
-
-  console.log(`
-  ${chalk.cyan('Success!')} Your app bundle was activated for ${chalk.cyan(
-    definition.name
-  )} in ${chalk.bold(organization.name)}.
-
-  Bundle Id: ${chalk.yellow(bundleId)}`);
-  console.log(`
+    });
+    currentDefinition.bundle = {
+        sys: {
+            id: bundleId,
+            linkType: 'AppBundle',
+            type: 'Link',
+        },
+    };
+    if (!currentDefinition.locations?.length) {
+        currentDefinition.locations = defaultLocations;
+    }
+    delete currentDefinition.src;
+    try {
+        await plainClient.appDefinition.update({
+            appDefinitionId: definition.value,
+            organizationId: organization.value,
+        }, currentDefinition);
+    }
+    catch (err) {
+        (0, utils_1.throwError)(err, 'Something went wrong activating your bundle. Make sure you used the correct definition-id.');
+    }
+    finally {
+        activationSpinner.stop();
+    }
+    console.log(`
+  ${(0, chalk_1.cyan)('Success!')} Your app bundle was activated for ${(0, chalk_1.cyan)(definition.name)} in ${(0, chalk_1.bold)(organization.name)}.
+  Bundle Id: ${(0, chalk_1.yellow)(bundleId)}`);
+    console.log(`
   ----------------------------
-
-  Ready to share your app with the world? Submit it to the Developer Showcase (${chalk.cyan(
-    'https://ctfl.io/dev-showcase'
-  )}) or our Marketplace (${chalk.cyan('https://ctfl.io/submit-app')}).
-
+  Ready to share your app with the world? Submit it to the Developer Showcase (${(0, chalk_1.cyan)('https://ctfl.io/dev-showcase')}) or our Marketplace (${(0, chalk_1.cyan)('https://ctfl.io/submit-app')}).
  `);
 }
-
-module.exports = {
-  activateBundle,
-};
+exports.activateBundle = activateBundle;

package/lib/activate/build-bundle-activate-settings.d.ts

@@ -0,0 +1,2 @@
+import { ActivateOptions, ActivateSettings } from '../types';
+export declare function buildBundleActivateSettings(options: ActivateOptions): Promise<ActivateSettings>;

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

@@ -1,37 +1,35 @@
-// @ts-check
-
-const inquirer = require('inquirer');
-const { getAppInfo } = require('../get-app-info');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildBundleActivateSettings = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+const get_app_info_1 = require("../get-app-info");
 async function buildBundleActivateSettings(options) {
-  const { bundleId, host } = options;
-  const prompts = [];
-
-  if (!bundleId) {
-    prompts.push({
-      name: 'bundleId',
-      message: `The id of the bundle you want to activate (required):`,
-      validate: (input) => input.length > 0,
-    });
-  }
-  if (!host) {
-    prompts.push({
-      name: 'host',
-      message: `Contentful CMA endpoint URL:`,
-      default: 'api.contentful.com',
-    });
-  }
-
-  const appActivateSettings = await inquirer.prompt(prompts);
-  const appInfo = await getAppInfo(options);
-
-  // Add app-config & dialog automatically
-  return {
-    bundleId,
-    host,
-    ...appActivateSettings,
-    ...appInfo,
-  };
+    const { bundleId, host } = options;
+    const prompts = [];
+    if (!bundleId) {
+        prompts.push({
+            name: 'bundleId',
+            message: `The id of the bundle you want to activate (required):`,
+            validate: (input) => input.length > 0,
+        });
+    }
+    if (!host) {
+        prompts.push({
+            name: 'host',
+            message: `Contentful CMA endpoint URL:`,
+            default: 'api.contentful.com',
+        });
+    }
+    const appActivateSettings = await inquirer_1.default.prompt(prompts);
+    const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+    return {
+        bundleId,
+        host,
+        ...appActivateSettings,
+        ...appInfo,
+    };
 }
-
 exports.buildBundleActivateSettings = buildBundleActivateSettings;

package/lib/activate/get-activate-args.d.ts

@@ -0,0 +1,2 @@
+import { ActivateOptions, ActivateSettings } from '../types';
+export declare function getActivateSettingsArgs(options: ActivateOptions): Promise<ActivateSettings>;

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

@@ -1,37 +1,40 @@
-const chalk = require('chalk');
-const ora = require('ora');
-const { getAppInfo } = require('../get-app-info');
-const { validateArguments } = require('../validate-arguments');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getActivateSettingsArgs = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const get_app_info_1 = require("../get-app-info");
+const validate_arguments_1 = require("../validate-arguments");
 const requiredOptions = {
-  definitionId: '--definition-id',
-  organizationId: '--organization-id',
-  bundleId: '--bundle-id',
-  token: '--token',
+    organizationId: '--organization-id',
+    definitionId: '--definition-id',
+    bundleId: '--bundle-id',
+    token: '--token',
 };
-
 async function getActivateSettingsArgs(options) {
-  const validateSpinner = ora('Validating your input').start();
-
-  try {
-    validateArguments(requiredOptions, options, 'activate');
-    const appInfo = await getAppInfo(options);
-    return {
-      ...appInfo,
-      bundleId: options.bundleId,
-      comment: options.comment,
-      host: options.host,
-    };
-  } catch (err) {
-    console.log(`
-      ${chalk.red('Validation failed')}
+    const validateSpinner = (0, ora_1.default)('Validating your input').start();
+    try {
+        (0, validate_arguments_1.validateArguments)(requiredOptions, options, 'activate');
+        const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+        return {
+            ...appInfo,
+            bundleId: options.bundleId,
+            host: options.host,
+        };
+    }
+    catch (err) {
+        console.log(`
+      ${chalk_1.default.red('Validation failed')}
       ${err.message}
     `);
-    // eslint-disable-next-line no-process-exit
-    process.exit(1);
-  } finally {
-    validateSpinner.stop();
-  }
+        // eslint-disable-next-line no-process-exit
+        process.exit(1);
+    }
+    finally {
+        validateSpinner.stop();
+    }
 }
-
 exports.getActivateSettingsArgs = getActivateSettingsArgs;

package/lib/activate/index.d.ts

@@ -0,0 +1,5 @@
+import { ActivateOptions } from '../types';
+export declare const activate: {
+    interactive: (options: ActivateOptions) => Promise<void>;
+    nonInteractive: (options: ActivateOptions) => Promise<void>;
+};

package/lib/activate/index.js

@@ -1,14 +1,18 @@
-const { activateBundle } = require('./activate-bundle');
-const { getActivateSettingsArgs } = require('./get-activate-args');
-const { buildBundleActivateSettings } = require('./build-bundle-activate-settings');
-
-module.exports = {
-  async interactive(options) {
-    const settings = await buildBundleActivateSettings(options);
-    await activateBundle(settings);
-  },
-  async nonInteractive(options) {
-    const settings = await getActivateSettingsArgs(options);
-    await activateBundle(settings);
-  },
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.activate = void 0;
+const activate_bundle_1 = require("./activate-bundle");
+const get_activate_args_1 = require("./get-activate-args");
+const build_bundle_activate_settings_1 = require("./build-bundle-activate-settings");
+const interactive = async (options) => {
+    const settings = await (0, build_bundle_activate_settings_1.buildBundleActivateSettings)(options);
+    await (0, activate_bundle_1.activateBundle)(settings);
+};
+const nonInteractive = async (options) => {
+    const settings = await (0, get_activate_args_1.getActivateSettingsArgs)(options);
+    await (0, activate_bundle_1.activateBundle)(settings);
+};
+exports.activate = {
+    interactive,
+    nonInteractive,
 };

package/lib/analytics.d.ts

@@ -0,0 +1,11 @@
+/**
+ *
+ * @param {object} properties tracking properties
+ * @param {string} properties.command triggered command e.g create-app-definition, upload, etc.
+ * @param {boolean} properties.ci value if --ci flag has been set
+ * @returns
+ */
+export declare function track({ command, ci }: {
+    command: string;
+    ci: boolean;
+}): void;

package/lib/analytics.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.track = void 0;
+const analytics_node_1 = __importDefault(require("analytics-node"));
+// Public write key scoped to data source
+const SEGMENT_WRITE_KEY = 'IzCq3j4dQlTAgLdMykRW9oBHQKUy1xMm';
+/**
+ *
+ * @param {object} properties tracking properties
+ * @param {string} properties.command triggered command e.g create-app-definition, upload, etc.
+ * @param {boolean} properties.ci value if --ci flag has been set
+ * @returns
+ */
+function track({ command, ci }) {
+    if (process.env.DISABLE_ANALYTICS) {
+        return;
+    }
+    try {
+        const client = new analytics_node_1.default(SEGMENT_WRITE_KEY, {
+            errorHandler: () => {
+                // noop
+            },
+        });
+        client.track({
+            event: 'app-cli-app-scripts',
+            properties: {
+                command,
+                ci: String(ci),
+            },
+            anonymousId: Date.now(),
+            timestamp: new Date(),
+        });
+        // eslint-disable-next-line no-empty
+    }
+    catch (e) {
+        // ignore any error, to not block the call
+    }
+}
+exports.track = track;

package/lib/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/bin.js

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const index_1 = require("./index");
+async function runCommand(command, options) {
+    const { ci } = commander_1.program.opts();
+    return ci ? await command.nonInteractive(options) : await command.interactive(options);
+}
+(async function main() {
+    const version = process.env.npm_package_version ?? '';
+    commander_1.program.version(version).option('--ci', 'Execute in non-interactive mode', false);
+    commander_1.program
+        .command('create-app-definition')
+        .description('Create a new AppDefinition for an App')
+        .action(async () => {
+        await runCommand(index_1.createAppDefinition);
+    });
+    commander_1.program
+        .command('upload')
+        .description('Upload your build folder and create an AppBundle')
+        .option('--bundle-dir [directory]', 'The directory of your build folder')
+        .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('--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(index_1.upload, options);
+    });
+    commander_1.program
+        .command('activate')
+        .description('Mark an AppBundle as "active" for a given AppDefinition')
+        .option('--bundle-id [bundleId]', 'The id of your bundle')
+        .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(index_1.activate, options);
+    });
+    commander_1.program
+        .command('open-settings')
+        .description('Opens the app editor for a given AppDefinition')
+        .option('--definition-id  [defId]', 'The id of your apps definition')
+        .action(async (options) => {
+        await runCommand(index_1.open, options);
+    });
+    commander_1.program
+        .command('bundle-cleanup')
+        .description('Removes old, non-active bundles, only keeps the 50 most recent ones')
+        .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('--keep [keepAmount]', 'The amount of bundles that should remain')
+        .option('--host [host]', 'Contentful domain to use')
+        .action(async (options) => {
+        await runCommand(index_1.cleanup, options);
+    });
+    commander_1.program.hook('preAction', (thisCommand) => {
+        (0, index_1.track)({ command: thisCommand.args[0], ci: thisCommand.opts().ci });
+    });
+    await commander_1.program.parseAsync(process.argv);
+})().catch((e) => {
+    console.error(e);
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
+});

package/lib/cache-credential/index.d.ts

@@ -0,0 +1 @@
+export declare function cacheEnvVars(envObj: Record<string, string>): Promise<void>;

package/lib/cache-credential/index.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheEnvVars = void 0;
+const dotenv_1 = __importDefault(require("dotenv"));
+const fs_1 = __importDefault(require("fs"));
+const os_1 = require("os");
+const ignore_1 = __importDefault(require("ignore"));
+const chalk_1 = __importDefault(require("chalk"));
+const constants_1 = require("../constants");
+const ig = (0, ignore_1.default)();
+const fsPromises = fs_1.default.promises;
+const fsConstants = fs_1.default.constants;
+// Always export set env vars by default
+dotenv_1.default.config();
+async function removeOldEnv(envKey) {
+    const envFileData = await fsPromises.readFile(constants_1.DOTENV_FILE, { encoding: 'utf-8', });
+    const envVarsData = dotenv_1.default.parse(envFileData);
+    if (envVarsData[envKey]) {
+        delete envVarsData[envKey];
+        const stringifiedEnvData = Object.keys(envVarsData).map(key => `${key}=${envVarsData[key]}`).join(os_1.EOL);
+        await fsPromises.writeFile(constants_1.DOTENV_FILE, stringifiedEnvData, {
+            encoding: 'utf-8'
+        });
+    }
+}
+function addEnvFileToGitIgnore() {
+    try {
+        if (!ig.ignores(constants_1.DOTENV_FILE)) {
+            ig.add(constants_1.DOTENV_FILE);
+        }
+    }
+    catch (err) {
+        console.log(`${chalk_1.default.yellow('Warning: could not add .env file to .gitignore. Please don\'t forget to add it manually.')}`);
+    }
+}
+async function checkFileEnvExists() {
+    try {
+        await fsPromises.access(constants_1.DOTENV_FILE, fsConstants.F_OK);
+        return true;
+    }
+    catch (_) {
+        return false;
+    }
+}
+async function cacheEnvVars(envObj) {
+    try {
+        let envVars = '';
+        const envFileExists = await checkFileEnvExists();
+        for (const [key, val] of Object.entries(envObj)) {
+            if (envFileExists) {
+                await removeOldEnv(key);
+            }
+            envVars += `${os_1.EOL}${key}=${val}`;
+        }
+        await fsPromises.writeFile(constants_1.DOTENV_FILE, envVars, {
+            encoding: 'utf-8',
+            flag: 'a'
+        });
+        addEnvFileToGitIgnore();
+        console.log(`
+      Saved new Environment variable(s) locally: ${chalk_1.default.cyan(Object.keys(envObj).join(", "))}.
+    `);
+    }
+    catch (err) {
+        console.log(`
+      ${chalk_1.default.red('Couldn\'t save environment variables locally.')}
+      ${err.message}
+    `);
+    }
+}
+exports.cacheEnvVars = cacheEnvVars;

package/lib/clean-up/build-clean-up-settings.d.ts

@@ -0,0 +1,2 @@
+import { CleanupOptions, CleanupSettings } from '../types';
+export declare function buildCleanUpSettings(options: CleanupOptions): Promise<CleanupSettings>;

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

@@ -1,38 +1,34 @@
-const inquirer = require('inquirer');
-const { DEFAULT_BUNDLES_TO_KEEP, CONTENTFUL_API_HOST } = require('../../utils/constants');
-const { getAppInfo } = require('../get-app-info');
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCleanUpSettings = void 0;
+const inquirer_1 = require("inquirer");
+const constants_1 = require("../constants");
+const get_app_info_1 = require("../get-app-info");
 async function buildCleanUpSettings(options) {
-  const { keep, host } = options;
-  const prompts = [];
-
-  if (!keep) {
-    prompts.push({
-      type: 'number',
-      name: 'keep',
-      message: `The amount of newest bundles to keep:`,
-      default: DEFAULT_BUNDLES_TO_KEEP,
-    });
-  }
-  if (!host) {
-    prompts.push({
-      name: 'host',
-      message: `Contentful CMA endpoint URL:`,
-      default: CONTENTFUL_API_HOST,
-    });
-  }
-
-  const appCleanUpSettings = await inquirer.prompt(prompts);
-  const appInfo = await getAppInfo(options);
-
-  return {
-    keep: +keep,
-    host,
-    ...appCleanUpSettings,
-    ...appInfo,
-  };
+    const { keep, host } = options;
+    const prompts = [];
+    if (keep === undefined) {
+        prompts.push({
+            type: 'number',
+            name: 'keep',
+            message: `The amount of newest bundles to keep:`,
+            default: constants_1.DEFAULT_BUNDLES_TO_KEEP,
+        });
+    }
+    if (!host) {
+        prompts.push({
+            name: 'host',
+            message: `Contentful CMA endpoint URL:`,
+            default: constants_1.DEFAULT_CONTENTFUL_API_HOST,
+        });
+    }
+    const appCleanUpSettings = await (0, inquirer_1.prompt)(prompts);
+    const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+    return {
+        keep: keep === undefined ? +appCleanUpSettings.keep : +keep,
+        host,
+        ...appCleanUpSettings,
+        ...appInfo,
+    };
 }
-
-module.exports = {
-  buildCleanUpSettings,
-};
+exports.buildCleanUpSettings = buildCleanUpSettings;

package/lib/clean-up/clean-up-bundles.d.ts

@@ -0,0 +1,2 @@
+import { CleanupSettings } from '../types';
+export declare function cleanUpBundles(settings: CleanupSettings): Promise<undefined>;