@jungvonmatt/contentful-migrations 5.1.2 → 5.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jung von Matt TECH (https://www.jvm.com/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,8 @@
 # JvM Contentful Migrations
 
-JvM Contentful Migrations offers additional functionality on top of the existing migration functionality of the [Contentful CLI](https://github.com/contentful/contentful-cli). It makes it easy and safe to deploy changes to your content model in a way that can be reviewed and tested before being deployed to production. With migrations you can do almost everything with you content and your content model. See the [official documentation](https://github.com/contentful/contentful-migration) for more information.
+[![NPM Version][npm-image]][npm-url] [![Sonarcloud Status][sonarcloud-image]][sonarcloud-url]
+
+JvM Contentful Migrations offers additional functionality on top of the existing migration functionality of the [Contentful CLI](https://github.com/contentful/contentful-cli). It makes it easy and safe to deploy changes to your content model in a way that can be reviewed and tested before being deployed to production. With migrations you can do almost everything with your content and your content model. See the [official documentation](https://github.com/contentful/contentful-migration) for more information.
 
 ## Getting started
 
@@ -37,19 +39,30 @@ This initializes migrations and stores the config values in the `package.json` o
 <br/>
 <br/>
 
+## Showing help
+
+Whenever you get stuck, you can output the help to your terminal:
+
+```bash
+npx migrations help
+
+# Help for a specific command
+npx migrations help <command>
+```
+
 ## Handling contentful environments
 
 It is recommended that you develop and test your migrations in a separate environment before executing them on production content. You can handle environments using the `environment` command:
 
 ```bash
 # Add a new environment and activate it for API usage
-npx migrations environment <environment-id> --create
+npx migrations environment <environment-id> --create [--source-environment-id <source-environment-id>]
 
 # Remove an environment
-npx migrations environment <environment-id> --remove
+npx migrations environment <environment-id> --remove [--source-environment-id <source-environment-id>]
 
 # Reset an environment
-npx migrations environment <environment-id> --reset
+npx migrations environment <environment-id> --reset [--source-environment-id <source-environment-id>]
 ```
 
 ## Generating blank migrations
@@ -155,8 +168,39 @@ npx migrations doc -e <environment> -p <path/to/docs>
 `--template`: Use a custom template for docs. `.js` with default export or `.mustache` is allowed<br/>
 `--extension`: Use a custom file extension (default is `.md`)<br/>
 
+
+## Migration helpers
+We provide you with a few smaller migration helpers. There aren't many at the moment, but there may be more in the future.
+
+To use the helpers you just need to wrap your migration with the provided `withHelpers` function which makes the helpers available as 3rd parameter
+in your migration function:
+
+```js
+const { withHelpers } = require('@jungvonmatt/contentful-migrations');
+
+module.exports = withHelpers(async (migration, context, helpers) => {
+  // Get all locales
+  await helpers.locale.getLocales();
+  // Get default locale
+  await helpers.locale.getDefaultLocale();
+
+  // Add or remove values from "linkContentType" validations without affecting the other elements in the array
+  await helpers.validation.addLinkContentTypeValues('contentTypeId', 'fieldId', ['value']);
+  await helpers.validation.removeLinkContentTypeValues('contentTypeId', 'fieldId', ['value']);
+
+  // Add or remove values from "in" validations without affecting the other elements in the array
+  await helpers.validation.addInValues('contentTypeId', 'fieldId', ['value']);
+  await helpers.validation.removeInValues('contentTypeId', 'fieldId', ['value']);
+});
+```
+
 ## Can I contribute?
 
 Of course. We appreciate all of our [contributors](https://github.com/jungvonmatt/contentful-migrations/graphs/contributors) and
 welcome contributions to improve the project further. If you're uncertain whether an addition should be made, feel
 free to open up an issue and we can discuss it.
+
+[npm-url]: https://www.npmjs.com/package/@jungvonmatt/contentful-migrations
+[npm-image]: https://img.shields.io/npm/v/@jungvonmatt/contentful-migrations.svg
+[sonarcloud-url]: https://sonarcloud.io/dashboard?id=jungvonmatt_contentful-migrations
+[sonarcloud-image]: https://sonarcloud.io/api/project_badges/measure?project=jungvonmatt_contentful-migrations&metric=alert_status

package/cli.js

@@ -0,0 +1,286 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-console */
+/* eslint-env node */
+const fs = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+const { Command } = require('commander');
+
+const { initializeContentModel, migrateToContentStorage, migrateToTagStorage } = require('./lib/backend');
+const { createMigration, runMigrations, fetchMigration, executeMigration } = require('./lib/migration');
+const { versionDelete, versionAdd } = require('./lib/version');
+const { transferContent } = require('./lib/content');
+const { createOfflineDocs } = require('./lib/doc');
+const { createEnvironment, removeEnvironment, resetEnvironment } = require('./lib/environment');
+const { getConfig, askAll, askMissing, STORAGE_CONTENT, STORAGE_TAG } = require('./lib/config');
+const pkg = require('./package.json');
+
+require('dotenv').config();
+
+const parseArgs = (cmd) => {
+  const { parent = {} } = cmd || {};
+  const directory = cmd.path || parent.path;
+  return {
+    ...cmd,
+    environment: cmd.env || parent.env,
+    directory: directory ? path.resolve(directory) : undefined,
+    sourceEnvironmentId: cmd.sourceEnvironmentId || parent.sourceEnvironmentId,
+    destEnvironmentId: cmd.destEnvironmentId || parent.destEnvironmentId,
+    verbose: cmd.verbose || parent.verbose,
+    template: cmd.template || parent.template,
+    yes: cmd.yes || parent.yes,
+    extension: cmd.extension || parent.extension,
+    bail: cmd.bail || parent.bail,
+  };
+};
+
+const errorHandler = (error, log) => {
+  if (log) {
+    const { errors, message } = error;
+    console.error(chalk.red('\nError:'), message);
+    (errors || []).forEach((err) => {
+      console.error(chalk.red('Error:'), err.message);
+    });
+  }
+  process.exit(1);
+};
+
+const actionRunner = (fn, log = true) => {
+  return (...args) => {
+    const verbose = args.some((arg) => arg.verbose);
+    return fn(...args).catch((error) => errorHandler(error, verbose || log));
+  };
+};
+
+const program = new Command();
+
+program.version(pkg.version);
+program
+  .command('init')
+  .description('Initialize contentful-migrations')
+  .action(
+    actionRunner(async (cmd) => {
+      const config = await getConfig(parseArgs(cmd || {}));
+      const verified = await askAll(config);
+      const { managementToken, accessToken, environmentId, spaceId, ...rest } = verified;
+
+      if (verified.storage === STORAGE_CONTENT) {
+        await initializeContentModel({ ...config, ...verified });
+        await migrateToContentStorage({ ...config, ...verified });
+      }
+      if (verified.storage === STORAGE_TAG) {
+        await migrateToTagStorage({ ...config, ...verified });
+      }
+
+      if (!process.env.CONTENTFUL_SPACE_ID) {
+        rest.spaceId = spaceId;
+      }
+
+      // try to store in package.json
+      const { pkgUp } = await import('pkg-up');
+      const localPkg = await pkgUp();
+      if (localPkg) {
+        const packageJson = await fs.readJson(localPkg);
+        rest.directory = path.relative(path.dirname(localPkg), rest.directory);
+        packageJson.migrations = rest;
+        await fs.outputJson(localPkg, packageJson, { spaces: 2 });
+      } else {
+        // store in .migrationsrc if no package.json is available
+        await fs.outputJson(path.join(process.cwd(), '.migrationsrc'), rest, { spaces: 2 });
+      }
+    })
+  );
+
+program
+  .command('fetch')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-c, --content-type <content-type...>', 'Specify content-types')
+  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are saved')
+  .option('-v, --verbose', 'Verbosity')
+  .description('Generated new Contentful migration from content type')
+  .action(
+    actionRunner(async (cmd) => {
+      const config = await getConfig(parseArgs(cmd || {}));
+      const verified = await askMissing(config);
+      await fetchMigration({ ...verified, contentType: cmd.contentType });
+    })
+  );
+
+program
+  .command('generate')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are saved')
+  .option('-v, --verbose', 'Verbosity')
+  .description('Generated new Contentful migration')
+  .action(
+    actionRunner(async (cmd) => {
+      const config = await getConfig(parseArgs(cmd || {}));
+      const verified = await askMissing(config);
+      await createMigration(verified);
+    })
+  );
+
+program
+  .command('migrate')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are stored')
+  .option('-v, --verbose', 'Verbosity')
+  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
+  .option('--bail', 'Abort execution after first failed migration (default: true)', true)
+  .option('--no-bail', 'Ignore failed migrations')
+  .description('Execute all unexecuted migrations available.')
+  .action(
+    actionRunner(async (cmd) => {
+      const config = await getConfig(parseArgs(cmd || {}));
+      const verified = await askMissing(config);
+
+      const { missingStorageModel } = verified;
+      if (missingStorageModel) {
+        console.error(
+          chalk.red('\nError:'),
+          `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`
+        );
+        process.exit(1);
+      }
+
+      await runMigrations(verified);
+    }, false)
+  );
+
+program
+  .command('execute <file>')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-v, --verbose', 'Verbosity')
+  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
+  .description('Execute a single migration.')
+  .action(
+    actionRunner(async (file, options) => {
+      const config = await getConfig(parseArgs(options || {}));
+      const verified = await askMissing(config);
+
+      const { missingStorageModel } = verified;
+      if (missingStorageModel) {
+        console.error(
+          chalk.red('\nError:'),
+          `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`
+        );
+        process.exit(1);
+      }
+
+      await executeMigration(path.resolve(file), verified);
+    }, false)
+  );
+
+program
+  .command('version <file>')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-v, --verbose', 'Verbosity')
+  .option('--add', 'Mark migration as migrated')
+  .option('--remove', 'Delete migration entry in Contentful')
+  .description('Manually mark a migration as migrated or not. (Only available with the Content-model storage)')
+  .action(
+    actionRunner(async (file, options) => {
+      const { remove, add } = options;
+      const config = await getConfig(parseArgs(options || {}));
+      const verified = await askMissing(config);
+
+      const { missingStorageModel } = verified;
+      if (missingStorageModel) {
+        console.error(
+          chalk.red('\nError:'),
+          `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`
+        );
+        process.exit(1);
+      }
+
+      const { storage } = verified || {};
+      if (storage === STORAGE_TAG) {
+        throw new Error('The version command is not available for the "tag" storage');
+      }
+      if (remove) {
+        await versionDelete(file, verified);
+      } else if (add) {
+        await versionAdd(file, verified);
+      }
+    }, true)
+  );
+
+program
+  .command('environment <environment-id>')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-v, --verbose', 'Verbosity')
+  .option('--create', 'Create new contentful environment')
+  .option('--remove', 'Delete contentful environment')
+  .option('--reset', 'Reset contentful environment')
+  .option('--source-environment-id <environment-id>', 'Set the source environment to clone new environment from')
+  .description('Add or remove a contentful environment for migrations')
+  .action(
+    actionRunner(async (environmentId, options) => {
+      const { remove, create, reset } = options;
+      const config = await getConfig(parseArgs({ ...(options || {}), environmentId }));
+      const verified = await askMissing(config, ['accessToken', 'spaceId', 'environmentId']);
+
+      if (create) {
+        return createEnvironment(environmentId, verified);
+      }
+
+      if (remove) {
+        return removeEnvironment(environmentId, verified);
+      }
+
+      if (reset) {
+        return resetEnvironment(environmentId, verified);
+      }
+    }, true)
+  );
+
+program
+  .command('doc')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-p, --path <path/to/docs>', 'Change the path where the docs are stored')
+  .option('-v, --verbose', 'Verbosity')
+  .option('-t, --template <path/to/template>', 'Use custom template for docs')
+  .option('--extension <file-extension>', 'Use custom file extension (default is `md`)')
+  .description('Generate offline docs from content-types')
+  .action(
+    actionRunner(async (cmd) => {
+      const config = await getConfig(parseArgs(cmd || {}));
+      const verified = await askMissing(config, ['accessToken', 'spaceId', 'environmentId']);
+      await createOfflineDocs(verified);
+    }, true)
+  );
+
+program
+  .command('content')
+  .requiredOption('--source-environment-id <environment-id>', 'Set the Contentful source environment (from)')
+  .requiredOption('--dest-environment-id <environment-id>', 'Set the Contentful destination environment (to)')
+  .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-c, --content-type <content-type>', 'Specify content-type')
+  .option('-v, --verbose', 'Verbosity')
+  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
+  .option('--diff', 'Manually choose skip/overwrite for every conflict')
+  .option('--force', 'No manual diffing. Overwrites all conflicting entries/assets')
+  .description('Transfer content from source environment to destination environment')
+  .action(
+    actionRunner(async (cmd) => {
+      const config = await getConfig(parseArgs(cmd || {}));
+      const verified = await askMissing({ ...config, environmentId: 'not-used' });
+
+      // run migrations on destination environment
+      await transferContent({
+        ...verified,
+        contentType: cmd.contentType || '',
+        forceOverwrite: cmd.force || false,
+        diffConflicts: cmd.diff || false,
+      });
+    })
+  );
+
+program.parse(process.argv);

package/index.d.ts

@@ -0,0 +1,18 @@
+import type Migration, { MigrationContext, MigrationFunction } from "contentful-migration";
+import type { LocaleHelpers } from "./lib/helpers/locale";
+import type { ValidationHelpers } from "./lib/helpers/validation";
+
+export interface MigrationHelpers {
+  locale: LocaleHelpers,
+  validation: ValidationHelpers
+}
+
+export type EnhancedMigrationFunction = (
+  migration: Migration,
+  context?: MigrationContext,
+  helpers?: MigrationHelpers
+) => void;
+
+export function withHelpers(cb: EnhancedMigrationFunction): MigrationFunction;
+export { getLocaleHelpers } from "./lib/helpers/locale";
+export { getValidationHelpers } from "./lib/helpers/validation";

package/index.js

@@ -1,287 +1,26 @@
-#!/usr/bin/env node
-
-/* eslint-disable no-console */
-/* eslint-env node */
-const fs = require('fs-extra');
-const path = require('path');
-const chalk = require('chalk');
-const { Command } = require('commander');
-
-const { initializeContentModel, migrateToContentStorage, migrateToTagStorage } = require('./lib/backend');
-const { createMigration, runMigrations, fetchMigration, executeMigration } = require('./lib/migration');
-const { versionDelete, versionAdd } = require('./lib/version');
-const { transferContent } = require('./lib/content');
-const { createOfflineDocs } = require('./lib/doc');
-const { createEnvironment, removeEnvironment, resetEnvironment } = require('./lib/environment');
-const { getConfig, askAll, askMissing, STORAGE_CONTENT, STORAGE_TAG } = require('./lib/config');
-const pkg = require('./package.json');
-
-require('dotenv').config();
-
-const parseArgs = (cmd) => {
-  const { parent = {} } = cmd || {};
-  const directory = cmd.path || parent.path;
-  return {
-    ...cmd,
-    environment: cmd.env || parent.env,
-    directory: directory ? path.resolve(directory) : undefined,
-    sourceEnvironmentId: cmd.sourceEnvironmentId || parent.sourceEnvironmentId,
-    destEnvironmentId: cmd.destEnvironmentId || parent.destEnvironmentId,
-    verbose: cmd.verbose || parent.verbose,
-    template: cmd.template || parent.template,
-    yes: cmd.yes || parent.yes,
-    extension: cmd.extension || parent.extension,
-    bail: cmd.bail || parent.bail,
-  };
-};
-
-const errorHandler = (error, log) => {
-  if (log) {
-    const { errors, message } = error;
-    console.error(chalk.red('\nError:'), message);
-    (errors || []).forEach((error) => {
-      console.error(chalk.red('Error:'), error.message);
-    });
-  }
-  process.exit(1);
-};
-
-const actionRunner = (fn, log = true) => {
-  return (...args) => {
-    const verbose = args.some((arg) => arg.verbose);
-    return fn(...args).catch((error) => errorHandler(error, verbose || log));
-  };
-};
-
-const program = new Command();
-
-program.version(pkg.version);
-program
-  .command('init')
-  .description('Initialize contentful-migrations')
-  .action(
-    actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askAll(config);
-      const { managementToken, accessToken, environmentId, spaceId, ...rest } = verified;
-
-      if (verified.storage === STORAGE_CONTENT) {
-        await initializeContentModel({ ...config, ...verified });
-        await migrateToContentStorage({ ...config, ...verified });
-      }
-      if (verified.storage === STORAGE_TAG) {
-        await migrateToTagStorage({ ...config, ...verified });
-      }
-
-      if (!process.env.CONTENTFUL_SPACE_ID) {
-        rest.spaceId = spaceId;
-      }
-
-      // try to store in package.json
-
-      const {pkgUp} = await import('pkg-up');
-      const localPkg = await pkgUp();
-      if (localPkg) {
-        const packageJson = await fs.readJson(localPkg);
-        rest.directory = path.relative(path.dirname(localPkg), rest.directory);
-        packageJson.migrations = rest;
-        await fs.outputJson(localPkg, packageJson, { spaces: 2 });
-      } else {
-        // store in .migrationsrc if no package.json is available
-        await fs.outputJson(path.join(process.cwd(), '.migrationsrc'), rest, { spaces: 2 });
-      }
-    })
-  );
-
-program
-  .command('fetch')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-c, --content-type <content-type...>', 'Specify content-types')
-  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are saved')
-  .option('-v, --verbose', 'Verbosity')
-  .description('Generated new Contentful migration from content type')
-  .action(
-    actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askMissing(config);
-      await fetchMigration({ ...verified, contentType: cmd.contentType });
-    })
-  );
-
-program
-  .command('generate')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are saved')
-  .option('-v, --verbose', 'Verbosity')
-  .description('Generated new Contentful migration')
-  .action(
-    actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askMissing(config);
-      await createMigration(verified);
-    })
-  );
-
-program
-  .command('migrate')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are stored')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
-  .option('--bail', 'Abort execution after first failed migration (default: true)', true)
-  .option('--no-bail', 'Ignore failed migrations')
-  .description('Execute all unexecuted migrations available.')
-  .action(
-    actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askMissing(config);
-
-      const { missingStorageModel } = verified;
-      if (missingStorageModel) {
-        console.error(
-          chalk.red('\nError:'),
-          `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`
-        );
-        process.exit(1);
-      }
-
-      await runMigrations(verified);
-    }, false)
-  );
-
-program
-  .command('execute <file>')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
-  .description('Execute a single migration.')
-  .action(
-    actionRunner(async (file, options) => {
-      const config = await getConfig(parseArgs(options || {}));
-      const verified = await askMissing(config);
-
-      const { missingStorageModel } = verified;
-      if (missingStorageModel) {
-        console.error(
-          chalk.red('\nError:'),
-          `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`
-        );
-        process.exit(1);
-      }
-
-      await executeMigration(path.resolve(file), verified);
-    }, false)
-  );
-
-program
-  .command('version <file>')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-v, --verbose', 'Verbosity')
-  .option('--add', 'Mark migration as migrated')
-  .option('--remove', 'Delete migration entry in Contentful')
-  .description('Manually mark a migration as migrated or not. (Only available with the Content-model storage)')
-  .action(
-    actionRunner(async (file, options) => {
-      const { remove, add } = options;
-      const config = await getConfig(parseArgs(options || {}));
-      const verified = await askMissing(config);
-
-      const { missingStorageModel } = verified;
-      if (missingStorageModel) {
-        console.error(
-          chalk.red('\nError:'),
-          `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`
-        );
-        process.exit(1);
-      }
-
-      const { storage } = verified || {};
-      if (storage === STORAGE_TAG) {
-        throw new Error('The version command is not available for the "tag" storage');
-      }
-      if (remove) {
-        await versionDelete(file, verified);
-      } else if (add) {
-        await versionAdd(file, verified);
-      }
-    }, true)
-  );
-
-program
-  .command('environment <environment-id>')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-v, --verbose', 'Verbosity')
-  .option('--create', 'Create new contentful environment')
-  .option('--remove', 'Delete contentful environment')
-  .option('--reset', 'Reset contentful environment')
-  .option('--source-environment-id <environment-id>', 'Set the source environment to clone new environment from')
-  .description('Add or remove a contentful environment for migrations')
-  .action(
-    actionRunner(async (environmentId, options) => {
-      const { remove, create, reset } = options;
-      const config = await getConfig(parseArgs({ ...(options || {}), environmentId }));
-      const verified = await askMissing(config, ['accessToken', 'spaceId', 'environmentId']);
-
-      if (create) {
-        return createEnvironment(environmentId, verified);
-      }
-
-      if (remove) {
-        return removeEnvironment(environmentId, verified);
-      }
-
-      if (reset) {
-        return resetEnvironment(environmentId, verified);
-      }
-    }, true)
-  );
-
-program
-  .command('doc')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-p, --path <path/to/docs>', 'Change the path where the docs are stored')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-t, --template <path/to/template>', 'Use custom template for docs')
-  .option('--extension <file-extension>', 'Use custom file extension (default is `md`)')
-  .description('Generate offline docs from content-types')
-  .action(
-    actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askMissing(config, ['accessToken', 'spaceId', 'environmentId']);
-      await createOfflineDocs(verified);
-    }, true)
-  );
-
-program
-  .command('content')
-  .requiredOption('--source-environment-id <environment-id>', 'Set the Contentful source environment (from)')
-  .requiredOption('--dest-environment-id <environment-id>', 'Set the Contentful destination environment (to)')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-c, --content-type <content-type>', 'Specify content-type')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
-  .option('--diff', 'Manually choose skip/overwrite for every conflict')
-  .option('--force', 'No manual diffing. Overwrites all conflicting entries/assets')
-  .description('Transfer content from source environment to destination environment')
-  .action(
-    actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askMissing({ ...config, environmentId: 'not-used' });
-
-      // run migrations on destination environment
-      await transferContent({
-        ...verified,
-        contentType: cmd.contentType || '',
-        forceOverwrite: cmd.force || false,
-        diffConflicts: cmd.diff || false,
-      });
-    })
-  );
-
-program.parse(process.argv);
+/**
+ * Adds helpers for the migration
+ *
+ * Example:
+ * const { withHelpers } = require('@jungvonmatt/contentful-migrations');
+ *
+ * module.exports = withHelpers(async (migration, context, helpers) => {
+ *
+ *   ...
+ *
+ * });
+ *
+ */
+ const { getValidationHelpers } = require('./lib/helpers/validation');
+ const { getLocaleHelpers } = require('./lib/helpers/locale');
+
+ // Export wrapper
+ module.exports.withHelpers = (cb) => (migration, context) => {
+   const locale = getLocaleHelpers(migration, context);
+   const validation = getValidationHelpers(migration, context);
+
+   return cb(migration, context, { locale, validation });
+ };
+
+ module.exports.getValidationHelpers = getValidationHelpers;
+ module.exports.getLocaleHelpers = getLocaleHelpers;

package/lib/helpers/locale.d.ts

@@ -0,0 +1,9 @@
+import type { Locale } from "contentful-management/dist/typings/export-types";
+import type Migration, { MigrationContext } from "contentful-migration";
+
+export interface LocaleHelpers {
+  getLocales(): Promise<[Locale]>;
+  getDefaultLocale(): Promise<Locale>;
+}
+
+export function getLocaleHelpers(migration: Migration, context: MigrationContext): LocaleHelpers;

package/lib/helpers/locale.js

@@ -0,0 +1,42 @@
+/**
+ * Adds utils for the migration
+ *
+ * Example:
+ * const { getLocaleHelpers } = require('@jungvonmatt/contentful-migrations');
+ *
+ * module.exports = async function (migration, context) {
+ *   const localeHelper = getLocaleHelpers(migration, context);
+ *   ...
+ *
+ *   await localeHelper.getLocales();
+ *   await localeHelper.getDefaultLocale();
+ *
+ * };
+ *
+ */
+const getLocaleHelpers = (migration, context) => {
+  const { makeRequest } = context;
+
+  const getLocales = async () => {
+    const { items: locales } = await makeRequest({
+      method: 'GET',
+      url: '/locales',
+    });
+
+    return locales;
+  };
+
+  const getDefaultLocale = async () => {
+    // Fetch locale
+    const locales = await getLocales();
+
+    return locales.find((locale) => locale.default);
+  };
+
+  return {
+    getLocales,
+    getDefaultLocale,
+  };
+};
+
+module.exports.getLocaleHelpers = getLocaleHelpers;

package/lib/helpers/validation.d.ts

@@ -0,0 +1,10 @@
+import type Migration, { MigrationContext } from "contentful-migration";
+
+export interface ValidationHelpers {
+  addLinkContentTypeValues(contentTypeId: string, fieldId: string, values: string | [string]): Promise<void>;
+  addInValues(contentTypeId: string, fieldId: string, values: string | [string]): Promise<void>;
+  removeLinkContentTypeValues(contentTypeId: string, fieldId: string, values: string | [string]): Promise<void>;
+  removeInValues(contentTypeId: string, fieldId: string, values: string | [string]): Promise<void>;
+}
+
+export function getValidationHelpers(migration: Migration, context: MigrationContext): ValidationHelpers;

package/lib/helpers/validation.js

@@ -0,0 +1,95 @@
+const { TYPE_LINK, TYPE_ARRAY } = require('../contentful');
+
+/**
+ * Adds utils for the migration
+ *
+ * Example:
+ * const { getValidationHelpers } = require('@jungvonmatt/contentful-migrations');
+ *
+ * module.exports = async function (migration, context) {
+ *   const validationHelper = getValidationHelpers(migration, context);
+ *   ...
+ *
+ *   await validationHelper.addLinkContentTypeValues('contentTypeId', 'fieldId', ['value']);
+ *   await validationHelper.addInValues('contentTypeId', 'fieldId', ['value']);
+ *   await validationHelper.removeLinkContentTypeValues('contentTypeId', 'fieldId', ['value']);
+ *   await validationHelper.removeInValues('contentTypeId', 'fieldId', ['value']);
+ *
+ * };
+ *
+ */
+const getValidationHelpers = (migration, context) => {
+  const { makeRequest } = context;
+
+  const addValidationValues = (validations, key, values = []) =>
+    validations.map((validation) => {
+      if (validation?.[key]) {
+        if (!Array.isArray(values)) {
+          values = [values];
+        }
+        if (!Array.isArray(validation[key])) {
+          throw new Error(
+            `addValidationValues can only be used on arrays. validation.${key} is typeof ${typeof validation[key]}`
+          );
+        }
+        validation[key] = [...new Set([...validation[key], ...values])];
+      }
+
+      return validation;
+    });
+
+  const removeValidationValues = (validations, key, values = []) =>
+    validations.map((validation) => {
+      if (validation?.[key]) {
+        if (!Array.isArray(values)) {
+          values = [values];
+        }
+        if (!Array.isArray(validation[key])) {
+          throw new Error(
+            `removeValidationValues can only be used on arrays. validation.${key} is typeof ${typeof validation[key]}`
+          );
+        }
+        validation[key] = validation[key].filter((x) => !values.includes(x));
+      }
+
+      return validation;
+    });
+
+  const modifyValidationValuesForType = async (validationKey, method, contentTypeId, fieldId, typeIds) => {
+    // Fetch content type
+    const { fields } = await makeRequest({
+      method: 'GET',
+      url: `/content_types/${contentTypeId}`,
+    });
+
+    const { type, items = {}, validations = [] } = fields?.find((field) => field.id === fieldId) ?? {};
+
+    if (type === TYPE_ARRAY) {
+      const ct = migration.editContentType(contentTypeId);
+      ct.editField(fieldId).items({ ...items, validations: method(items?.validations ?? [], validationKey, typeIds) });
+    } else {
+      const ct = migration.editContentType(contentTypeId);
+      ct.editField(fieldId).validations(method(validations ?? [], validationKey, typeIds));
+    }
+  };
+
+  return {
+    async addLinkContentTypeValues(contentTypeId, fieldId, values) {
+      await modifyValidationValuesForType('linkContentType', addValidationValues, contentTypeId, fieldId, values);
+    },
+
+    async addInValues(contentTypeId, fieldId, values) {
+      await modifyValidationValuesForType('in', addValidationValues, contentTypeId, fieldId, values);
+    },
+
+    async removeLinkContentTypeValues(contentTypeId, fieldId, values) {
+      await modifyValidationValuesForType('linkContentType', removeValidationValues, contentTypeId, fieldId, values);
+    },
+
+    async removeInValues(contentTypeId, fieldId, values) {
+      await modifyValidationValuesForType('in', removeValidationValues, contentTypeId, fieldId, values);
+    },
+  };
+};
+
+module.exports.getValidationHelpers = getValidationHelpers;

package/lib/migration.js

@@ -14,6 +14,17 @@ const { confirm, STATE_SUCCESS, STATE_FAILURE } = require('./config');
 
 const { storeMigration, getNewMigrations } = require('./backend');
 
+const migrationHeader = stripIndent`/* eslint-env node */
+  const { withHelpers } = require('@jungvonmatt/contentful-migrations');
+
+  /**
+   * Contentful migration
+   * API: https://github.com/contentful/contentful-migration
+   * Editor Interfaces: https://www.contentful.com/developers/docs/extensibility/app-framework/editor-interfaces/
+   */
+  module.exports = withHelpers(async function (migration, context, helpers) {
+`;
+
 /**
  * Create new migration file.
  * Adds initial migration file adding the migration field in the content type
@@ -32,16 +43,9 @@ const createMigration = async (config) => {
   const { directory } = config || {};
   const timestamp = Date.now();
   const filename = path.join(directory, `${timestamp}-migration.${module ? 'cjs' : 'js'}`);
-  const content = stripIndent`
-  /* eslint-env node */
-
-  /**
-   * Contentful migration
-   */
-  module.exports = function(migration /*, context */) {
+  const content = stripIndent`${migrationHeader}
     // Add your migration code here
-    // See: https://github.com/contentful/contentful-migration
-  }`;
+  })`;
 
   await fs.outputFile(filename, await format(filename, content));
   console.log(`Generated new migration file to ${chalk.green(filename)}`);
@@ -80,8 +84,33 @@ const fetchMigration = async (config) => {
     const filename = path.join(directory, `${timestamp++}-create-${entry.sys.id}-migration.${module ? 'cjs' : 'js'}`);
 
     const content = await generateMigrationScript(client, [entry]);
+    // Fetch migration script generated by contentful
+    let modifiedContent = content.toString();
+    // Modify migration script to use our helpers
+    const testDefaultValueRegex = /(defaultValue\({\s*)[^\:]+([^\)]+)/g;
+    if (testDefaultValueRegex.test(modifiedContent)) {
+      modifiedContent = content
+        .toString()
+        // Add call to utils.getDefaultLocale() to the top
+        .replace(
+          'module.exports = function (migration) {',`
+          ${migrationHeader}
+          const defaultLocale = helpers.locale.getDefaultLocale();
+        `)
+        // Replace the default locale with defaultLocale.code so that the migration
+        // still works as expected when the locale is changed in contentful
+        .replace(testDefaultValueRegex, '$1[defaultLocale.code]$2')
+        // Add a closing parentheses as we wrap the migration function.
+        .replace(/};\s*$/g, '});');
+    } else {
+      // If we don't have a default value we just wrap the migration function with our withHelpers wrapper
+      modifiedContent = content
+        .toString()
+        .replace('module.exports = function (migration) {', migrationHeader)
+        .replace(/};\s*$/g, '});');
+    }
 
-    await fs.outputFile(filename, await format(filename, content));
+    await fs.outputFile(filename, await format(filename, modifiedContent));
     console.log(`Generated new migration file to ${chalk.green(filename)}`);
   });
 

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "@jungvonmatt/contentful-migrations",
-  "version": "5.1.2",
+  "version": "5.2.2",
   "description": "Helper to handle migrations in contentful",
   "main": "index.js",
   "files": [
+    "index.d.ts",
     "index.js",
+    "cli.js",
     "lib"
   ],
+  "typings": "index.d.ts",
   "bin": {
-    "contentful-migrations": "index.js",
-    "migrations": "index.js"
+    "contentful-migrations": "cli.js",
+    "migrations": "cli.js"
   },
   "scripts": {
     "test": "npm run lint",