@contentful/app-scripts 1.12.0 → 1.13.0

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

@@ -1,129 +1,102 @@
-const chalk = require('chalk');
-const ora = require('ora');
-const Bottleneck = require('bottleneck');
-const {
-  MAX_CONCURRENT_DELETION_CALLS,
-  DEFAULT_BUNDLES_TO_FETCH,
-} = require('../../utils/constants');
-const { throwError } = require('../utils');
-const { createClient } = require('contentful-management');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanUpBundles = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const bottleneck_1 = __importDefault(require("bottleneck"));
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const contentful_management_1 = require("contentful-management");
 async function deleteBundle(bundleId, index, maxIndex, client, settings) {
-  const deleteSpinner = ora(`Deleting ${index + 1} out of ${maxIndex} bundles...`).start();
-  await client.appBundle.delete({
-    appBundleId: bundleId,
-    appDefinitionId: settings.definition.value,
-    organizationId: settings.organization.value,
-  });
-
-  deleteSpinner.stop();
-  console.log(`${chalk.green('Done:')} ${index + 1}/${maxIndex} bundles deleted successfully`);
+    const deleteSpinner = (0, ora_1.default)(`Deleting ${index + 1} out of ${maxIndex} bundles...`).start();
+    await client.appBundle.delete({
+        appBundleId: bundleId,
+        appDefinitionId: settings.definition.value,
+        organizationId: settings.organization.value,
+    });
+    deleteSpinner.stop();
+    console.log(`${chalk_1.default.green('Done:')} ${index + 1}/${maxIndex} bundles deleted successfully`);
 }
-
 const scheduleBundleDeletion = async (bundlesToDelete, client, settings) => {
-  const limiter = new Bottleneck({ maxConcurrent: MAX_CONCURRENT_DELETION_CALLS });
-  await Promise.all(
-    bundlesToDelete.map((bundle, index) =>
-      limiter.schedule(() =>
-        deleteBundle(bundle.sys.id, index, bundlesToDelete.length, client, settings)
-      )
-    )
-  );
+    const limiter = new bottleneck_1.default({ maxConcurrent: constants_1.MAX_CONCURRENT_DELETION_CALLS });
+    await Promise.all(bundlesToDelete.map((bundle, index) => limiter.schedule(() => deleteBundle(bundle.sys.id, index, bundlesToDelete.length, client, settings))));
 };
-
 async function cleanUpBundles(settings) {
-  let bundlesToDelete, definition;
-
-  const client = createClient(
-    {
-      host: settings.host,
-      accessToken: settings.accessToken,
-    },
-    { type: 'plain' }
-  );
-
-  const fetchAppBundles = async (limit = DEFAULT_BUNDLES_TO_FETCH, skip = 0) => {
-    return await client.appBundle.getMany({
-      appDefinitionId: settings.definition.value,
-      organizationId: settings.organization.value,
-      query: {
-        limit,
-        skip,
-      },
-    });
-  };
-
-  const getAppBundles = async (requestedAmount = DEFAULT_BUNDLES_TO_FETCH) => {
-    if (requestedAmount < 1) {
-      throw new Error('Requested amount of bundles to fetch must be greater than 0');
-    }
-    const getBundles = async (limit, skip) => {
-      const result = await fetchAppBundles(limit, skip);
-      const currLength = skip + result.items.length;
-
-      if (result.total > currLength) {
-        return [...result.items, ...(await getBundles(result.items.length, currLength))];
-      } else {
-        return result.items;
-      }
+    let definition;
+    let bundlesToDelete;
+    const client = (0, contentful_management_1.createClient)({
+        host: settings.host,
+        accessToken: settings.accessToken,
+    }, { type: 'plain' });
+    const fetchAppBundles = async (limit = constants_1.DEFAULT_BUNDLES_TO_FETCH, skip = 0) => {
+        return await client.appBundle.getMany({
+            appDefinitionId: settings.definition.value,
+            organizationId: settings.organization.value,
+            query: {
+                limit,
+                skip,
+            },
+        });
     };
-
-    const all = await getBundles(DEFAULT_BUNDLES_TO_FETCH, 0);
-    return all.reverse().slice(0, requestedAmount);
-  };
-
-  const getAppBundleCount = async () => {
-    return await fetchAppBundles(1, 0);
-  };
-
-  const bundlesSpinner = ora(`Fetching all bundles...`).start();
-  try {
-    const { total } = await getAppBundleCount();
-    const amountToDelete = total - settings.keep;
-    if (amountToDelete < 1) {
-      console.log(`${chalk.yellow('Warning:')} There is nothing to delete`);
-      bundlesSpinner.stop();
-      return;
+    const getAppBundles = async (requestedAmount = constants_1.DEFAULT_BUNDLES_TO_FETCH) => {
+        if (requestedAmount < 1) {
+            throw new Error('Requested amount of bundles to fetch must be greater than 0');
+        }
+        const getBundles = async (limit, skip = 0) => {
+            const result = await fetchAppBundles(limit, skip);
+            const currLength = skip + result.items.length;
+            if (result.total > currLength) {
+                return [...result.items, ...(await getBundles(result.items.length, currLength))];
+            }
+            else {
+                return result.items;
+            }
+        };
+        const all = await getBundles(constants_1.DEFAULT_BUNDLES_TO_FETCH, 0);
+        return all.reverse().slice(0, requestedAmount);
+    };
+    const getAppBundleCount = async () => {
+        return await fetchAppBundles(1, 0);
+    };
+    const bundlesSpinner = (0, ora_1.default)(`Fetching all bundles...`).start();
+    try {
+        const { total } = await getAppBundleCount();
+        const amountToDelete = total - settings.keep;
+        if (amountToDelete < 1) {
+            console.log(`${chalk_1.default.yellow('Warning:')} There is nothing to delete`);
+            bundlesSpinner.stop();
+            return;
+        }
+        bundlesToDelete = await getAppBundles(amountToDelete);
+        definition = await client.appDefinition.get({
+            appDefinitionId: settings.definition.value,
+            organizationId: settings.organization.value,
+        });
     }
-    bundlesToDelete = await getAppBundles(amountToDelete);
-    definition = await client.appDefinition.get({
-      appDefinitionId: settings.definition.value,
-      organizationId: settings.organization.value,
-    });
-  } catch (e) {
-    throwError(e, 'Something went wrong fetching the bundles');
-  }
-
-  bundlesSpinner.stop();
-
-  if (definition.bundle) {
-    bundlesToDelete = bundlesToDelete.filter(
-      (bundle) => bundle.sys.id !== definition.bundle.sys.id
-    );
-  }
-
-  if (bundlesToDelete.length < 1) {
-    console.log(`${chalk.yellow('Warning:')} There is nothing to delete`);
-  }
-
-  console.log(`
+    catch (e) {
+        return (0, utils_1.throwError)(e, 'Something went wrong fetching the bundles');
+    }
+    bundlesSpinner.stop();
+    if (definition.bundle) {
+        bundlesToDelete = bundlesToDelete.filter((bundle) => bundle.sys.id !== definition.bundle.sys.id);
+    }
+    if (bundlesToDelete.length < 1) {
+        console.log(`${chalk_1.default.yellow('Warning:')} There is nothing to delete`);
+    }
+    console.log(`
 
-${chalk.cyan('Info:')} ${bundlesToDelete.length} bundle${
-    bundlesToDelete.length > 1 ? 's' : ''
-  } will be deleted
+${chalk_1.default.cyan('Info:')} ${bundlesToDelete.length} bundle${bundlesToDelete.length > 1 ? 's' : ''} will be deleted
 
   `);
-
-  try {
-    await scheduleBundleDeletion(bundlesToDelete, client, settings);
-    console.log(
-      `${chalk.green('Success:')} All ${bundlesToDelete.length} bundles are deleted successfully`
-    );
-  } catch (e) {
-    throwError(e, 'Something went wrong deleting the bundles');
-  }
+    try {
+        await scheduleBundleDeletion(bundlesToDelete, client, settings);
+        console.log(`${chalk_1.default.green('Success:')} All ${bundlesToDelete.length} bundles are deleted successfully`);
+    }
+    catch (e) {
+        return (0, utils_1.throwError)(e, 'Something went wrong deleting the bundles');
+    }
 }
-
-module.exports = {
-  cleanUpBundles,
-};
+exports.cleanUpBundles = cleanUpBundles;

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

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

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

@@ -1,38 +1,40 @@
-const chalk = require('chalk');
-const ora = require('ora');
-const { DEFAULT_BUNDLES_TO_KEEP } = require('../../utils/constants');
-const { validateArguments } = require('../validate-arguments');
-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.getCleanUpSettingsArgs = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const constants_1 = require("../constants");
+const validate_arguments_1 = require("../validate-arguments");
+const get_app_info_1 = require("../get-app-info");
 const requiredOptions = {
-  definitionId: '--definition-id',
-  organizationId: '--organization-id',
-  token: '--token',
+    definitionId: '--definition-id',
+    organizationId: '--organization-id',
+    token: '--token',
 };
-
 async function getCleanUpSettingsArgs(options) {
-  const validateSpinner = ora('Validating your input...').start();
-
-  try {
-    validateArguments(requiredOptions, options, 'upload');
-    const appInfo = await getAppInfo(options);
-    return {
-      ...appInfo,
-      keep: options.keep !== undefined ? +options.keep : DEFAULT_BUNDLES_TO_KEEP,
-      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, 'upload');
+        const appInfo = await (0, get_app_info_1.getAppInfo)(options);
+        return {
+            ...appInfo,
+            keep: options.keep !== undefined ? +options.keep : constants_1.DEFAULT_BUNDLES_TO_KEEP,
+            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();
+    }
 }
-
-module.exports = {
-  getCleanUpSettingsArgs,
-};
+exports.getCleanUpSettingsArgs = getCleanUpSettingsArgs;

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

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

package/lib/clean-up/index.js

@@ -1,14 +1,18 @@
-const { getCleanUpSettingsArgs } = require('./get-clean-up-settings');
-const { buildCleanUpSettings } = require('./build-clean-up-settings');
-const { cleanUpBundles } = require('./clean-up-bundles');
-
-module.exports = {
-  async interactive(options) {
-    const settings = await buildCleanUpSettings(options);
-    await cleanUpBundles(settings);
-  },
-  async nonInteractive(options) {
-    const settings = await getCleanUpSettingsArgs(options);
-    await cleanUpBundles(settings);
-  },
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanup = void 0;
+const get_clean_up_settings_1 = require("./get-clean-up-settings");
+const build_clean_up_settings_1 = require("./build-clean-up-settings");
+const clean_up_bundles_1 = require("./clean-up-bundles");
+const interactive = async (options) => {
+    const settings = await (0, build_clean_up_settings_1.buildCleanUpSettings)(options);
+    await (0, clean_up_bundles_1.cleanUpBundles)(settings);
+};
+const nonInteractive = async (options) => {
+    const settings = await (0, get_clean_up_settings_1.getCleanUpSettingsArgs)(options);
+    await (0, clean_up_bundles_1.cleanUpBundles)(settings);
+};
+exports.cleanup = {
+    interactive,
+    nonInteractive,
 };

package/lib/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const DOTENV_FILE = ".env";
+export declare const ACCESS_TOKEN_ENV_KEY = "CONTENTFUL_ACCESS_TOKEN";
+export declare const ORG_ID_ENV_KEY = "CONTENTFUL_ORG_ID";
+export declare const APP_DEF_ENV_KEY = "CONTENTFUL_APP_DEF_ID";
+export declare const DEFAULT_BUNDLES_TO_KEEP = 50;
+export declare const DEFAULT_BUNDLES_TO_FETCH = 1000;
+export declare const MAX_CONCURRENT_DELETION_CALLS = 5;
+export declare const DEFAULT_CONTENTFUL_API_HOST = "api.contentful.com";

package/lib/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CONTENTFUL_API_HOST = exports.MAX_CONCURRENT_DELETION_CALLS = exports.DEFAULT_BUNDLES_TO_FETCH = exports.DEFAULT_BUNDLES_TO_KEEP = exports.APP_DEF_ENV_KEY = exports.ORG_ID_ENV_KEY = exports.ACCESS_TOKEN_ENV_KEY = exports.DOTENV_FILE = void 0;
+exports.DOTENV_FILE = '.env';
+exports.ACCESS_TOKEN_ENV_KEY = 'CONTENTFUL_ACCESS_TOKEN';
+exports.ORG_ID_ENV_KEY = 'CONTENTFUL_ORG_ID';
+exports.APP_DEF_ENV_KEY = 'CONTENTFUL_APP_DEF_ID';
+exports.DEFAULT_BUNDLES_TO_KEEP = 50;
+exports.DEFAULT_BUNDLES_TO_FETCH = 1000;
+exports.MAX_CONCURRENT_DELETION_CALLS = 5;
+exports.DEFAULT_CONTENTFUL_API_HOST = 'api.contentful.com';

package/lib/create-app-definition/build-app-definition-settings.d.ts

@@ -0,0 +1,7 @@
+import { AppLocation, FieldType } from 'contentful-management';
+export interface AppDefinitionSettings {
+    name: string;
+    locations: AppLocation['location'][];
+    fields?: FieldType[];
+}
+export declare function buildAppDefinitionSettings(): Promise<AppDefinitionSettings>;

package/lib/create-app-definition/build-app-definition-settings.js

@@ -1,84 +1,80 @@
-// @ts-check
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-const path = require('path');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAppDefinitionSettings = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const path_1 = __importDefault(require("path"));
 async function buildAppDefinitionSettings() {
-  console.log(
-    chalk.dim(`
+    console.log(chalk_1.default.dim(`
 NOTE: This will create an app definition in your Contentful organization.
-      - Read more about app definitions: ${chalk.underline('https://ctfl.io/app-definitions')}
-      - Read more about app locations: ${chalk.underline('https://ctfl.io/app-locations')}
-  `)
-  );
-
-  const appDefinitionSettings = await inquirer.prompt([
-    {
-      name: 'name',
-      message: `App name (${path.basename(process.cwd())}):`,
-    },
-    {
-      name: 'locations',
-      message: `Select where your app can be rendered:`,
-      type: 'checkbox',
-      choices: [
-        { name: 'App configuration screen ', value: 'app-config' },
-        { name: 'Entry field', value: 'entry-field' },
-        { name: 'Entry sidebar', value: 'entry-sidebar' },
-        { name: 'Entry editor', value: 'entry-editor' },
-        { name: 'Page', value: 'page' },
-        { name: 'Home', value: 'home' },
-      ],
-    },
-    {
-      name: 'fields',
-      message: 'Select the field types the app can be rendered:',
-      type: 'checkbox',
-      choices: [
-        { name: 'Short text', value: { type: 'Symbol' } },
-        { name: 'Short text, list', value: { type: 'Array', items: { type: 'Symbol' } } },
-        { name: 'Long text', value: { type: 'Text' } },
-        { name: 'Rich text', value: { type: 'RichText' } },
-        { name: 'Number, integer', value: { type: 'Integer' } },
-        { name: 'Number, decimal', value: { type: 'Number' } },
-        { name: 'Date and time', value: { type: 'Date' } },
-        { name: 'Location', value: { type: 'Location' } },
-        { name: 'Boolean', value: { type: 'Boolean' } },
-        { name: 'JSON object', value: { type: 'Object' } },
-        { name: 'Entry reference', value: { type: 'Link', linkType: 'Entry' } },
+      - Read more about app definitions: ${chalk_1.default.underline('https://ctfl.io/app-definitions')}
+      - Read more about app locations: ${chalk_1.default.underline('https://ctfl.io/app-locations')}
+  `));
+    const appDefinitionSettings = await inquirer_1.default.prompt([
         {
-          name: 'Entry reference, list',
-          value: {
-            type: 'Array',
-            items: {
-              type: 'Link',
-              linkType: 'Entry',
-            },
-          },
+            name: 'name',
+            message: `App name (${path_1.default.basename(process.cwd())}):`,
         },
-        { name: 'Media reference', value: { type: 'Link', linkType: 'Asset' } },
         {
-          name: 'Media reference, list',
-          value: { type: 'Array', items: { type: 'Link', linkType: 'Asset' } },
+            name: 'locations',
+            message: `Select where your app can be rendered:`,
+            type: 'checkbox',
+            choices: [
+                { name: 'App configuration screen ', value: 'app-config' },
+                { name: 'Entry field', value: 'entry-field' },
+                { name: 'Entry sidebar', value: 'entry-sidebar' },
+                { name: 'Entry editor', value: 'entry-editor' },
+                { name: 'Page', value: 'page' },
+                { name: 'Home', value: 'home' },
+            ],
         },
-      ],
-      when(answers) {
-        return answers.locations.includes('entry-field');
-      },
-      validate(answers) {
-        if (answers.length < 1) {
-          return 'You must choose at least one field type.';
-        }
-        return true;
-      },
-    },
-  ]);
-
-  appDefinitionSettings.locations = ['dialog', ...appDefinitionSettings.locations];
-
-  return appDefinitionSettings;
+        {
+            name: 'fields',
+            message: 'Select the field types the app can be rendered:',
+            type: 'checkbox',
+            choices: [
+                { name: 'Short text', value: { type: 'Symbol' } },
+                { name: 'Short text, list', value: { type: 'Array', items: { type: 'Symbol' } } },
+                { name: 'Long text', value: { type: 'Text' } },
+                { name: 'Rich text', value: { type: 'RichText' } },
+                { name: 'Number, integer', value: { type: 'Integer' } },
+                { name: 'Number, decimal', value: { type: 'Number' } },
+                { name: 'Date and time', value: { type: 'Date' } },
+                { name: 'Location', value: { type: 'Location' } },
+                { name: 'Boolean', value: { type: 'Boolean' } },
+                { name: 'JSON object', value: { type: 'Object' } },
+                { name: 'Entry reference', value: { type: 'Link', linkType: 'Entry' } },
+                {
+                    name: 'Entry reference, list',
+                    value: {
+                        type: 'Array',
+                        items: {
+                            type: 'Link',
+                            linkType: 'Entry',
+                        },
+                    },
+                },
+                { name: 'Media reference', value: { type: 'Link', linkType: 'Asset' } },
+                {
+                    name: 'Media reference, list',
+                    value: { type: 'Array', items: { type: 'Link', linkType: 'Asset' } },
+                },
+            ],
+            when(answers) {
+                return answers.locations.includes('entry-field');
+            },
+            validate(answers) {
+                if (answers.length < 1) {
+                    return 'You must choose at least one field type.';
+                }
+                return true;
+            },
+        },
+    ]);
+    appDefinitionSettings.locations = ['dialog', ...appDefinitionSettings.locations];
+    return appDefinitionSettings;
 }
-
-module.exports = {
-  buildAppDefinitionSettings,
-};
+exports.buildAppDefinitionSettings = buildAppDefinitionSettings;

package/lib/create-app-definition/create-app-definition.d.ts

@@ -0,0 +1,2 @@
+import { AppDefinitionSettings } from './build-app-definition-settings';
+export declare function createAppDefinition(accessToken: string, appDefinitionSettings: AppDefinitionSettings): Promise<void>;