@jungvonmatt/contentful-migrations 6.2.6 → 7.0.0

package/lib/diff.js

@@ -1,7 +1,9 @@
-const Diff = require('diff');
-const { documentToPlainTextString } = require('@contentful/rich-text-plain-text-renderer');
-const pc = require('picocolors');
-const { diff: deepDiff } = require('deep-diff');
+const Diff = require("diff");
+const {
+  documentToPlainTextString,
+} = require("@contentful/rich-text-plain-text-renderer");
+const pc = require("picocolors");
+const microdiff = require("microdiff").default;
 const {
   getContentId,
   getContentTypeId,
@@ -16,13 +18,19 @@ const {
   TYPE_ARRAY,
   TYPE_BOOLEAN,
   TYPE_LINK,
-} = require('./contentful');
+} = require("./contentful");
 
 const getNodeDate = (node) => {
   const { sys } = node || {};
   const { updatedAt } = sys || {};
   const date = new Date(updatedAt);
-  const options = { hour: '2-digit', minute: '2-digit', year: 'numeric', month: '2-digit', day: 'numeric' };
+  const options = {
+    hour: "2-digit",
+    minute: "2-digit",
+    year: "numeric",
+    month: "2-digit",
+    day: "numeric",
+  };
   const { locale } = Intl.DateTimeFormat().resolvedOptions();
 
   return date.toLocaleDateString(locale, options);
@@ -51,7 +59,7 @@ const diffString = (source, dest) => {
     return unchangedColor(part.value);
   });
 
-  return parts.join('');
+  return parts.join("");
 };
 
 const getField = (fieldId, contentType) => {
@@ -69,7 +77,7 @@ const getFieldValue = (fieldId, node) => {
 
 const normalizeArray = (array) =>
   (array || []).map((val) => {
-    if (typeof val === 'string') {
+    if (typeof val === "string") {
       return val;
     }
 
@@ -80,13 +88,15 @@ const normalizeArray = (array) =>
 
 const diff = (source, dest, contentTypes) => {
   const id = getContentId(dest);
-  const contentType = (contentTypes || []).find((ct) => getContentId(ct) === getContentTypeId(dest));
+  const contentType = (contentTypes || []).find(
+    (ct) => getContentId(ct) === getContentTypeId(dest),
+  );
   const { fields: contentTypeFields } = contentType || {};
   const { fields: sourceFields } = source || {};
   const { fields: destFields } = dest || {};
-  const diffResult = deepDiff(destFields, sourceFields);
+  const diffResult = microdiff(destFields || {}, sourceFields || {});
 
-  if (!diffResult) {
+  if (diffResult.length === 0) {
     return;
   }
 
@@ -100,23 +110,27 @@ const diff = (source, dest, contentTypes) => {
           const [fieldId] = path || [];
           return fieldId;
         })
-        .filter((v) => v)
+        .filter((v) => v),
     ),
   ];
 
   // console.log(contentType);
   const fieldData = changedFields.map((fieldId) => {
-    const { name = fieldId } = (contentTypeFields || []).find(({ id }) => id === fieldId) || {};
+    const { name = fieldId } =
+      (contentTypeFields || []).find(({ id }) => id === fieldId) || {};
     const field = getField(fieldId, contentType);
     const { type, linkType } = field || {};
     const sourceValue = getFieldValue(fieldId, source);
     const destValue = getFieldValue(fieldId, dest);
     if (type === TYPE_SYMBOL) {
-      return `${pc.bold(name)}: ${pc.reset(diffString(`${destValue || ''}`, `${sourceValue || ''}`))}`;
+      return `${pc.bold(name)}: ${pc.reset(diffString(`${destValue || ""}`, `${sourceValue || ""}`))}`;
     }
     if (type === TYPE_RICHTEXT) {
       return `${pc.bold(name)}: ${pc.reset(
-        diffString(documentToPlainTextString(destValue || {}), documentToPlainTextString(sourceValue || {}))
+        diffString(
+          documentToPlainTextString(destValue || {}),
+          documentToPlainTextString(sourceValue || {}),
+        ),
       )}`;
     }
     if (type === TYPE_NUMBER) {
@@ -124,26 +138,26 @@ const diff = (source, dest, contentTypes) => {
       return `${pc.bold(name)}: ${oldValueColor(`${destValue}`)} ${newValueColor(`${sourceValue}`)}`;
     }
     if (type === TYPE_TEXT) {
-      return `${pc.bold(name)}: ${pc.reset(diffString(`${destValue || ''}`, `${sourceValue || ''}`))}`;
+      return `${pc.bold(name)}: ${pc.reset(diffString(`${destValue || ""}`, `${sourceValue || ""}`))}`;
     }
     if (type === TYPE_DATE) {
-      return `${pc.bold(name)}: ${oldValueColor(`${destValue || ''}`)} ${newValueColor(`${sourceValue || ''}`)}`;
+      return `${pc.bold(name)}: ${oldValueColor(`${destValue || ""}`)} ${newValueColor(`${sourceValue || ""}`)}`;
     }
     if (type === TYPE_LOCATION) {
-      return `${pc.bold(name)}: ${oldValueColor(`${JSON.stringify(destValue || '')}`)} ${newValueColor(
-        `${JSON.stringify(sourceValue || '')}`
+      return `${pc.bold(name)}: ${oldValueColor(`${JSON.stringify(destValue || "")}`)} ${newValueColor(
+        `${JSON.stringify(sourceValue || "")}`,
       )}`;
     }
     if (type === TYPE_BOOLEAN) {
       return `${pc.bold(name)}: ${oldValueColor(`${JSON.stringify(destValue)}`)} ${newValueColor(
-        `${JSON.stringify(sourceValue)}`
+        `${JSON.stringify(sourceValue)}`,
       )}`;
     }
     if (type === TYPE_LINK) {
       const sourceValueId = getContentId(sourceValue || {});
       const destValueId = getContentId(destValue || {});
-      return `${pc.bold(name)} (${linkType}):  ${oldValueColor(destValueId || 'deleted')} ${newValueColor(
-        sourceValueId || 'empty'
+      return `${pc.bold(name)} (${linkType}):  ${oldValueColor(destValueId || "deleted")} ${newValueColor(
+        sourceValueId || "empty",
       )}`;
     }
 
@@ -158,24 +172,24 @@ const diff = (source, dest, contentTypes) => {
       const destArray = normalizeArray(destValue);
 
       const array = Array(Math.max(sourceArray.length, destArray.length))
-        .fill('')
+        .fill("")
         .map((_, index) => {
           if (sourceArray[index] === destArray[index]) {
             return unchangedColor(sourceArray[index]);
           }
 
           if (sourceArray[index] && destArray[index]) {
-            return `${oldValueColor(destArray[index] || '')} ${newValueColor(sourceArray[index])}`;
+            return `${oldValueColor(destArray[index] || "")} ${newValueColor(sourceArray[index])}`;
           }
 
           if (destArray[index]) {
             return `${newValueColor(sourceArray[index])}`;
           }
 
-          return `${oldValueColor(destArray[index] || '')}`;
+          return `${oldValueColor(destArray[index] || "")}`;
         });
 
-      return `${pc.bold(name)}: [\n    ${array.join('\n    ')}\n  ]`;
+      return `${pc.bold(name)}: [\n    ${array.join("\n    ")}\n  ]`;
     }
 
     return name;
@@ -185,20 +199,20 @@ const diff = (source, dest, contentTypes) => {
   const sourceEnv = getEnvironmentId(source);
 
   return {
-    type: 'list',
-    message: `${pc.reset('Conflict on')} ${pc.cyan(name)}\n  ${pc.reset(`${fieldData.join('\n  ')}`)}\n`,
+    type: "list",
+    message: `${pc.reset("Conflict on")} ${pc.cyan(name)}\n  ${pc.reset(`${fieldData.join("\n  ")}`)}\n`,
 
     name: id,
     choices: [
       {
-        name: `Use ${oldValueColor(destEnv)} - updated on ${getNodeDate(dest)} ${pc.bold('(skip)')}`,
+        name: `Use ${oldValueColor(destEnv)} - updated on ${getNodeDate(dest)} ${pc.bold("(skip)")}`,
         value: false,
-        short: 'skip',
+        short: "skip",
       },
       {
-        name: `Use ${newValueColor(sourceEnv)} - updated on ${getNodeDate(source)} ${pc.bold('(overwrite)')}`,
+        name: `Use ${newValueColor(sourceEnv)} - updated on ${getNodeDate(source)} ${pc.bold("(overwrite)")}`,
         value: true,
-        short: 'overwrite',
+        short: "overwrite",
       },
     ],
   };

package/lib/helpers/locale.d.ts

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

package/lib/helpers/validation.d.ts

@@ -1,5 +1,5 @@
-import type Migration from "contentful-migration";
-import type { MigrationContext } from "contentful-migration";
+import type Migration from 'contentful-migration';
+import type { MigrationContext } from 'contentful-migration';
 
 export type ValueMappingFunction<T extends string = string> = (values: T[]) => T[];
 
@@ -11,31 +11,110 @@ export interface AddValuesOptions {
 }
 
 // define some known mark and node values here to support code completion, but allow any string as well
-export type RichTextMarks = 'bold' | 'italic' | 'underline' | 'code' | 'superscript' | 'subscript' | 'strikethrough' | string & {};
-export type RichTextNodeType = 'document' | 'paragraph' | 'heading-1' | 'heading-2' | 'heading-3' | 'heading-4' | 'heading-5' | 'heading-6' | 'ordered-list' | 'unordered-list' | 'list-item' | 'hr' | 'blockquote' | 'embedded-entry-block' | 'embedded-asset-block' | 'embedded-resource-block' | 'table' | 'table-row' | 'table-cell' | 'table-header-cell' | 'asset-hyperlink' | 'embedded-entry-inline' | 'embedded-resource-inline' | 'entry-hyperlink' | 'hyperlink' | 'resource-hyperlink' | string & {};
+export type RichTextMarks =
+  | 'bold'
+  | 'italic'
+  | 'underline'
+  | 'code'
+  | 'superscript'
+  | 'subscript'
+  | 'strikethrough'
+  | (string & {});
+export type RichTextNodeType =
+  | 'document'
+  | 'paragraph'
+  | 'heading-1'
+  | 'heading-2'
+  | 'heading-3'
+  | 'heading-4'
+  | 'heading-5'
+  | 'heading-6'
+  | 'ordered-list'
+  | 'unordered-list'
+  | 'list-item'
+  | 'hr'
+  | 'blockquote'
+  | 'embedded-entry-block'
+  | 'embedded-asset-block'
+  | 'embedded-resource-block'
+  | 'table'
+  | 'table-row'
+  | 'table-cell'
+  | 'table-header-cell'
+  | 'asset-hyperlink'
+  | 'embedded-entry-inline'
+  | 'embedded-resource-inline'
+  | 'entry-hyperlink'
+  | 'hyperlink'
+  | 'resource-hyperlink'
+  | (string & {});
 
-export type RichTextLinkedNodeType = 'entry-hyperlink' | 'embedded-entry-block' | 'embedded-entry-inline'
+export type RichTextLinkedNodeType = 'entry-hyperlink' | 'embedded-entry-block' | 'embedded-entry-inline';
 
 export interface RichTextValidationHelpers {
   addEnabledMarksValues(contentTypeId: string, fieldId: string, values: RichTextMarks | RichTextMarks[]): Promise<void>;
-  removeEnabledMarksValues(contentTypeId: string, fieldId: string, values: RichTextMarks | RichTextMarks[]): Promise<void>;
-  modifyEnabledMarksValues(contentTypeId: string, fieldId: string, valueMappingFunction: ValueMappingFunction<RichTextMarks>): Promise<void>;
+  removeEnabledMarksValues(
+    contentTypeId: string,
+    fieldId: string,
+    values: RichTextMarks | RichTextMarks[],
+  ): Promise<void>;
+  modifyEnabledMarksValues(
+    contentTypeId: string,
+    fieldId: string,
+    valueMappingFunction: ValueMappingFunction<RichTextMarks>,
+  ): Promise<void>;
 
-  addEnabledNodeTypeValues(contentTypeId: string, fieldId: string, values: RichTextNodeType | RichTextNodeType[]): Promise<void>;
-  removeEnabledNodeTypeValues(contentTypeId: string, fieldId: string, values: RichTextNodeType | RichTextNodeType[]): Promise<void>;
-  modifyEnabledNodeTypeValues(contentTypeId: string, fieldId: string, valueMappingFunction: ValueMappingFunction<RichTextNodeType>): Promise<void>;
+  addEnabledNodeTypeValues(
+    contentTypeId: string,
+    fieldId: string,
+    values: RichTextNodeType | RichTextNodeType[],
+  ): Promise<void>;
+  removeEnabledNodeTypeValues(
+    contentTypeId: string,
+    fieldId: string,
+    values: RichTextNodeType | RichTextNodeType[],
+  ): Promise<void>;
+  modifyEnabledNodeTypeValues(
+    contentTypeId: string,
+    fieldId: string,
+    valueMappingFunction: ValueMappingFunction<RichTextNodeType>,
+  ): Promise<void>;
 
-  addNodeContentTypeValues(contentTypeId: string, fieldId: string, nodeType: RichTextLinkedNodeType, values: string | string[]): Promise<void>;
-  removeNodeContentTypeValues(contentTypeId: string, fieldId: string, nodeType: RichTextLinkedNodeType, values: string | string[]): Promise<void>;
-  modifyNodeContentTypeValues(contentTypeId: string, fieldId: string, nodeType: RichTextLinkedNodeType, valueMappingFunction: ValueMappingFunction): Promise<void>;
+  addNodeContentTypeValues(
+    contentTypeId: string,
+    fieldId: string,
+    nodeType: RichTextLinkedNodeType,
+    values: string | string[],
+  ): Promise<void>;
+  removeNodeContentTypeValues(
+    contentTypeId: string,
+    fieldId: string,
+    nodeType: RichTextLinkedNodeType,
+    values: string | string[],
+  ): Promise<void>;
+  modifyNodeContentTypeValues(
+    contentTypeId: string,
+    fieldId: string,
+    nodeType: RichTextLinkedNodeType,
+    valueMappingFunction: ValueMappingFunction,
+  ): Promise<void>;
 }
 
 export interface ValidationHelpers {
   addLinkContentTypeValues(contentTypeId: string, fieldId: string, values: string | string[]): Promise<void>;
   removeLinkContentTypeValues(contentTypeId: string, fieldId: string, values: string | string[]): Promise<void>;
-  modifyLinkContentTypeValues(contentTypeId: string, fieldId: string, valueMappingFunction: ValueMappingFunction): Promise<void>;
+  modifyLinkContentTypeValues(
+    contentTypeId: string,
+    fieldId: string,
+    valueMappingFunction: ValueMappingFunction,
+  ): Promise<void>;
 
-  addInValues(contentTypeId: string, fieldId: string, values: string | string[], options?: AddValuesOptions): Promise<void>;
+  addInValues(
+    contentTypeId: string,
+    fieldId: string,
+    values: string | string[],
+    options?: AddValuesOptions,
+  ): Promise<void>;
   removeInValues(contentTypeId: string, fieldId: string, values: string | string[]): Promise<void>;
   modifyInValues(contentTypeId: string, fieldId: string, valueMappingFunction: ValueMappingFunction): Promise<void>;
 

package/lib/helpers/validation.js

@@ -172,7 +172,7 @@ const getValidationHelpers = (migration, context) => {
           removeValidationValues,
           contentTypeId,
           fieldId,
-          values
+          values,
         );
       },
       async modifyEnabledNodeTypeValues(contentTypeId, fieldId, valueMappingFunction) {
@@ -186,7 +186,7 @@ const getValidationHelpers = (migration, context) => {
           addValidationValues,
           contentTypeId,
           fieldId,
-          values
+          values,
         );
       },
       async removeNodeContentTypeValues(contentTypeId, fieldId, nodeType, values) {
@@ -195,7 +195,7 @@ const getValidationHelpers = (migration, context) => {
           removeValidationValues,
           contentTypeId,
           fieldId,
-          values
+          values,
         );
       },
       async modifyNodeContentTypeValues(contentTypeId, fieldId, nodeType, valueMappingFunction) {
@@ -205,7 +205,7 @@ const getValidationHelpers = (migration, context) => {
           uniqueMappingFunction,
           contentTypeId,
           fieldId,
-          []
+          [],
         );
       },
     },

package/lib/migration.js

@@ -1,18 +1,22 @@
-const fs = require('fs-extra');
-const prettier = require('prettier');
-const path = require('path');
-const { stripIndent } = require('common-tags');
-const runMigration = require('contentful-migration/built/bin/cli').runMigration;
+const fs = require("fs-extra");
+const { format: oxfmt } = require("oxfmt");
+const path = require("path");
+const { stripIndent } = require("common-tags");
+const { runMigration } = require("contentful-migration");
 const {
   getContentTypes,
   generateMigrationScript,
-} = require('contentful-cli/dist/lib/cmds/space_cmds/generate_cmds/migration');
-const pc = require('picocolors');
-const { getEnvironment, getOrganizationId } = require('./contentful');
+} = require("contentful-cli/dist/lib/cmds/space_cmds/generate_cmds/migration");
+const pc = require("picocolors");
+const { getEnvironment, getOrganizationId } = require("./contentful");
 
-const { confirm, STATE_SUCCESS, STATE_FAILURE } = require('./config');
+const { confirm, STATE_SUCCESS, STATE_FAILURE } = require("./config");
 
-const { storeMigration, getNewMigrations, getVersionFromFile } = require('./backend');
+const {
+  storeMigration,
+  getNewMigrations,
+  getVersionFromFile,
+} = require("./backend");
 
 const migrationHeader = stripIndent`/* eslint-env node */
   const { withHelpers } = require('@jungvonmatt/contentful-migrations');
@@ -33,42 +37,30 @@ const migrationHeader = stripIndent`/* eslint-env node */
 const createMigration = async (config) => {
   let module = false;
   try {
-    const { readPackageUp } = await import('read-pkg-up');
+    const { readPackageUp } = await import("read-package-up");
     const data = await readPackageUp();
-    module = data?.packageJson?.type === 'module';
+    module = data?.packageJson?.type === "module";
   } catch (err) {
     console.log(err);
   }
 
   const { directory } = config || {};
   const timestamp = Date.now();
-  const filename = path.join(directory, `${timestamp}-migration.${module ? 'cjs' : 'js'}`);
+  const filename = path.join(
+    directory,
+    `${timestamp}-migration.${module ? "cjs" : "js"}`,
+  );
   const content = stripIndent`${migrationHeader}
     // Add your migration code here
   })`;
 
-  await fs.outputFile(filename, await format(filename, content, config));
+  await fs.outputFile(filename, await format(filename, content));
   console.log(`Generated new migration file to ${pc.green(filename)}`);
 };
 
-const format = async (file, content, config) => {
-  try {
-    const prettierOptions = await prettier.resolveConfig(file, { editorconfig: true });
-    return prettier.format(content, {
-      parser: 'babel',
-      ...prettierOptions,
-    });
-  } catch (error) {
-    if (config?.verbose) {
-      console.log(pc.red('Error resolving prettier config. Using default settings.'));
-      console.log();
-      console.log(error);
-      console.log();
-    }
-    return prettier.format(content, {
-      parser: 'babel',
-    });
-  }
+const format = async (file, content) => {
+  const { code } = await oxfmt(file, content, { singleQuote: true });
+  return code;
 };
 
 /**
@@ -80,51 +72,56 @@ const fetchMigration = async (config) => {
   const client = await getEnvironment(config);
   let module = false;
   try {
-    const { readPackageUp } = await import('read-pkg-up');
+    const { readPackageUp } = await import("read-package-up");
     const data = await readPackageUp();
-    module = data?.packageJson?.type === 'module';
+    module = data?.packageJson?.type === "module";
   } catch (err) {
     console.log(err);
   }
 
   let timestamp = Date.now();
   const contentTypes = contentType
-    ? (await Promise.all(contentType.map((ct) => getContentTypes(client, ct)))).flat()
+    ? (
+        await Promise.all(contentType.map((ct) => getContentTypes(client, ct)))
+      ).flat()
     : await getContentTypes(client);
 
   const promises = contentTypes.map(async (entry) => {
-    const filename = path.join(directory, `${timestamp++}-create-${entry.sys.id}-migration.${module ? 'cjs' : 'js'}`);
+    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;
+    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) {',
+          "module.exports = function (migration) {",
           `
           ${migrationHeader}
           const defaultLocale = await 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')
+        .replace(testDefaultValueRegex, "$1[defaultLocale.code]$2")
         // Add a closing parentheses as we wrap the migration function.
-        .replace(/};\s*$/g, '});');
+        .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, '});');
+        .replace("module.exports = function (migration) {", migrationHeader)
+        .replace(/};\s*$/g, "});");
     }
 
-    await fs.outputFile(filename, await format(filename, modifiedContent, config));
+    await fs.outputFile(filename, await format(filename, modifiedContent));
     console.log(`Generated new migration file to ${pc.green(filename)}`);
   });
 
@@ -145,7 +142,9 @@ const executeMigration = async (file, config) => {
   const name = path.basename(file);
   const version = getVersionFromFile(file);
   if (!version) {
-    console.error(`Invalid migration file name "${name}". Must start with a timestamp.`);
+    console.error(
+      `Invalid migration file name "${name}". Must start with a timestamp.`,
+    );
     process.exit(1);
   }
 
@@ -163,7 +162,9 @@ const executeMigration = async (file, config) => {
     options.host = config.host;
   }
 
-  console.log(`\nRun migration ${pc.green(version)} in environment ${pc.green(environmentId)}`);
+  console.log(
+    `\nRun migration ${pc.green(version)} in environment ${pc.green(environmentId)}`,
+  );
   const proceed = await confirm(config);
   if (!proceed) {
     return;
@@ -172,8 +173,13 @@ const executeMigration = async (file, config) => {
     await runMigration(options);
     await storeMigration({ version, name, state: STATE_SUCCESS }, config);
   } catch (error) {
-    const message = (error.errors || [error]).map((error) => error.message).join('\n');
-    await storeMigration({ version, name, state: STATE_FAILURE, message }, config);
+    const message = (error.errors || [error])
+      .map((error) => error.message)
+      .join("\n");
+    await storeMigration(
+      { version, name, state: STATE_FAILURE, message },
+      config,
+    );
 
     throw error;
   }
@@ -197,8 +203,15 @@ const runMigrations = async (config) => {
     console.log(error.message);
     throw error;
   }
-  console.log(`Found ${pc.green(migrations.length)} unexecuted migrations in environment ${pc.green(environmentId)}`);
-
+  console.log(
+    `Found ${pc.green(migrations.length)} unexecuted migrations in environment ${pc.green(environmentId)}`,
+  );
+  if (config?.verbose) {
+    for (const migration of migrations) {
+      console.log(`  ${pc.green(migration)}`);
+    }
+    console.log();
+  }
   const proceed = migrations.length === 0 || (await confirm(config));
   if (!proceed) {
     return;
@@ -214,7 +227,7 @@ const runMigrations = async (config) => {
     }
   }
 
-  console.log(pc.green('\nAll done'), '🚀');
+  console.log(pc.green("\nAll done"), "🚀");
 };
 
 module.exports.fetchMigration = fetchMigration;