@jungvonmatt/contentful-migrations 6.2.6 → 7.0.0

package/index.d.ts

@@ -1,19 +1,19 @@
-import type Migration from "contentful-migration";
-import type { MigrationContext, MigrationFunction } from "contentful-migration";
-import type { LocaleHelpers } from "./lib/helpers/locale";
-import type { ValidationHelpers } from "./lib/helpers/validation";
+import type Migration from 'contentful-migration';
+import type { 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
+  locale: LocaleHelpers;
+  validation: ValidationHelpers;
 }
 
 export type EnhancedMigrationFunction = (
   migration: Migration,
   context?: MigrationContext,
-  helpers?: MigrationHelpers
+  helpers?: MigrationHelpers,
 ) => void;
 
 export function withHelpers(cb: EnhancedMigrationFunction): MigrationFunction;
-export { getLocaleHelpers } from "./lib/helpers/locale";
-export { getValidationHelpers } from "./lib/helpers/validation";
+export { getLocaleHelpers } from './lib/helpers/locale';
+export { getValidationHelpers } from './lib/helpers/validation';

package/lib/backend.js

@@ -1,9 +1,19 @@
-const path = require('path');
-const fs = require('fs/promises');
-const pc = require('picocolors');
-const cliProgress = require('cli-progress');
-const { getEnvironment, getDefaultLocale, getMigrationItems } = require('./contentful');
-const { STORAGE_TAG, STORAGE_CONTENT, STATE_SUCCESS, STATE_FAILURE } = require('./config');
+const path = require("path");
+const fs = require("fs/promises");
+const pc = require("picocolors");
+const cliProgress = require("cli-progress");
+const { glob } = require("tinyglobby");
+const {
+  getEnvironment,
+  getDefaultLocale,
+  getMigrationItems,
+} = require("./contentful");
+const {
+  STORAGE_TAG,
+  STORAGE_CONTENT,
+  STATE_SUCCESS,
+  STATE_FAILURE,
+} = require("./config");
 
 /**
  * Create contentful-migrations content-type
@@ -15,79 +25,90 @@ const initializeContentModel = async (config) => {
   const environmentId = client.sys.id;
   const { items: contentTypes } = await client.getContentTypes();
 
-  const exists = (contentTypes || []).some((contentType) => contentType.sys.id === migrationContentTypeId);
+  const exists = (contentTypes || []).some(
+    (contentType) => contentType.sys.id === migrationContentTypeId,
+  );
 
   if (!exists) {
     console.log(
-      `\nCreating content-type: ${pc.green(migrationContentTypeId)} in environment ${pc.green(environmentId)}`
+      `\nCreating content-type: ${pc.green(migrationContentTypeId)} in environment ${pc.green(environmentId)}`,
+    );
+    const contentType = await client.createContentTypeWithId(
+      migrationContentTypeId,
+      {
+        name: "Migrations",
+        description: "Internal data model holding references to all migrations",
+        displayField: "name",
+        fields: [
+          {
+            id: "version",
+            name: "Version",
+            type: "Symbol",
+            localized: false,
+            required: true,
+            validations: [],
+            disabled: false,
+            omitted: false,
+          },
+          {
+            id: "name",
+            name: "Name",
+            type: "Symbol",
+            localized: false,
+            required: false,
+            validations: [],
+            disabled: false,
+            omitted: false,
+          },
+          {
+            id: "state",
+            name: "State",
+            type: "Symbol",
+            localized: false,
+            required: false,
+            validations: [
+              {
+                in: [STATE_SUCCESS, STATE_FAILURE],
+              },
+            ],
+            disabled: false,
+            omitted: false,
+          },
+          {
+            id: "message",
+            name: "Message",
+            type: "Text",
+            localized: false,
+            required: false,
+            validations: [],
+            disabled: false,
+            omitted: false,
+          },
+        ],
+      },
     );
-    const contentType = await client.createContentTypeWithId(migrationContentTypeId, {
-      name: 'Migrations',
-      description: 'Internal data model holding references to all migrations',
-      displayField: 'name',
-      fields: [
-        {
-          id: 'version',
-          name: 'Version',
-          type: 'Symbol',
-          localized: false,
-          required: true,
-          validations: [],
-          disabled: false,
-          omitted: false,
-        },
-        {
-          id: 'name',
-          name: 'Name',
-          type: 'Symbol',
-          localized: false,
-          required: false,
-          validations: [],
-          disabled: false,
-          omitted: false,
-        },
-        {
-          id: 'state',
-          name: 'State',
-          type: 'Symbol',
-          localized: false,
-          required: false,
-          validations: [
-            {
-              in: [STATE_SUCCESS, STATE_FAILURE],
-            },
-          ],
-          disabled: false,
-          omitted: false,
-        },
-        {
-          id: 'message',
-          name: 'Message',
-          type: 'Text',
-          localized: false,
-          required: false,
-          validations: [],
-          disabled: false,
-          omitted: false,
-        },
-      ],
-    });
     await contentType.publish();
 
-    const editorInterface = await client.getEditorInterfaceForContentType(migrationContentTypeId);
+    const editorInterface = await client.getEditorInterfaceForContentType(
+      migrationContentTypeId,
+    );
     if (editorInterface) {
-      const messageIndex = editorInterface.controls.findIndex((value) => value.fieldId === 'message');
+      const messageIndex = editorInterface.controls.findIndex(
+        (value) => value.fieldId === "message",
+      );
       editorInterface.controls[messageIndex] = {
         ...editorInterface.controls[messageIndex],
-        widgetNamespace: 'builtin',
-        widgetId: 'multipleLine',
+        widgetNamespace: "builtin",
+        widgetId: "multipleLine",
       };
 
-      const stateIndex = editorInterface.controls.findIndex((value) => value.fieldId === 'state');
+      const stateIndex = editorInterface.controls.findIndex(
+        (value) => value.fieldId === "state",
+      );
       editorInterface.controls[stateIndex] = {
         ...editorInterface.controls[stateIndex],
-        widgetNamespace: 'builtin',
-        widgetId: 'radio',
+        widgetNamespace: "builtin",
+        widgetId: "radio",
       };
 
       await editorInterface.update();
@@ -116,26 +137,30 @@ const addMigrationEntry = async (data, config) => {
   } catch {}
 
   if (!entry) {
-    entry = await client.createEntryWithId(migrationContentTypeId, `${version}`, {
-      fields: {
-        version: {
-          [defaultLocale]: `${version}`,
-        },
-        name: {
-          [defaultLocale]: name,
-        },
-        state: {
-          [defaultLocale]: state,
-        },
-        message: {
-          [defaultLocale]: message || '',
+    entry = await client.createEntryWithId(
+      migrationContentTypeId,
+      `${version}`,
+      {
+        fields: {
+          version: {
+            [defaultLocale]: `${version}`,
+          },
+          name: {
+            [defaultLocale]: name,
+          },
+          state: {
+            [defaultLocale]: state,
+          },
+          message: {
+            [defaultLocale]: message || "",
+          },
         },
       },
-    });
+    );
   } else {
     entry.fields.name = { [defaultLocale]: name };
     entry.fields.state = { [defaultLocale]: state };
-    entry.fields.message = { [defaultLocale]: message || '' };
+    entry.fields.message = { [defaultLocale]: message || "" };
   }
 
   try {
@@ -200,8 +225,9 @@ const migrateToContentStorage = async (config) => {
   const client = await getEnvironment(config);
   const version = await getMigrationVersionFromTag(config);
 
-  const { globby } = await import('globby');
-  const migrations = await globby([`${directory}/*.js`, `${directory}/*.cjs`]);
+  const migrations = await glob([`${directory}/*.js`, `${directory}/*.cjs`], {
+    absolute: true,
+  });
   const environmentId = client.sys.id;
   const filtered = migrations.filter((file) => {
     const name = path.basename(file);
@@ -210,11 +236,13 @@ const migrateToContentStorage = async (config) => {
     return version && parseInt(version, 10) >= parseInt(num, 10);
   });
 
-  console.log(`\nFound ${pc.green(filtered.length)} executed migrations in environment ${pc.green(environmentId)}`);
+  console.log(
+    `\nFound ${pc.green(filtered.length)} executed migrations in environment ${pc.green(environmentId)}`,
+  );
 
   const bar = new cliProgress.SingleBar(
-    { format: 'Adding content-entries: {value}/{total} | ETA: {eta}s' },
-    cliProgress.Presets.legacy
+    { format: "Adding content-entries: {value}/{total} | ETA: {eta}s" },
+    cliProgress.Presets.legacy,
   );
   let progress = 0;
 
@@ -223,7 +251,10 @@ const migrateToContentStorage = async (config) => {
     const name = path.basename(file);
     const [, num] = /^(\d+)-/.exec(name);
 
-    await addMigrationEntry({ version: num, name, state: STATE_SUCCESS }, config);
+    await addMigrationEntry(
+      { version: num, name, state: STATE_SUCCESS },
+      config,
+    );
     progress++;
     bar.update(progress);
   }
@@ -235,7 +266,7 @@ const migrateToContentStorage = async (config) => {
       await migrationTag.delete();
     } catch {}
   }
-  console.log('All done 👍🏼');
+  console.log("All done 👍🏼");
 };
 
 /**
@@ -248,24 +279,30 @@ const migrateToTagStorage = async (config) => {
   const oldVersion = await getMigrationVersionFromTag(config);
   if (migrationContentTypeId) {
     const client = await getEnvironment(config);
-    const { items } = await client.getEntries({ content_type: migrationContentTypeId });
+    const { items } = await client.getEntries({
+      content_type: migrationContentTypeId,
+    });
 
     const version =
       items.length &&
       Math.max(
         ...items
-          .filter((item) => item?.fields?.state?.[defaultLocale] === STATE_SUCCESS)
-          .map((item) => parseInt(item.sys.id, 10))
+          .filter(
+            (item) => item?.fields?.state?.[defaultLocale] === STATE_SUCCESS,
+          )
+          .map((item) => parseInt(item.sys.id, 10)),
       );
 
     if (version && (oldVersion || 0) < version) {
-      console.log(`\nAdding ${pc.green(fieldId)} tag with version ${pc.green(version)}`);
+      console.log(
+        `\nAdding ${pc.green(fieldId)} tag with version ${pc.green(version)}`,
+      );
       await setMigrationTag(version, config);
     }
 
     const bar = new cliProgress.SingleBar(
-      { format: 'Removing content-entries: {value}/{total} | ETA: {eta}s' },
-      cliProgress.Presets.legacy
+      { format: "Removing content-entries: {value}/{total} | ETA: {eta}s" },
+      cliProgress.Presets.legacy,
     );
     let progress = 0;
 
@@ -288,7 +325,7 @@ const migrateToTagStorage = async (config) => {
     }
   }
 
-  console.log('All done 👍🏼');
+  console.log("All done 👍🏼");
 };
 
 /**
@@ -371,8 +408,9 @@ const getVersionFromFile = (file) => {
  */
 const getNewMigrations = async (config) => {
   const { directory, storage, migrationContentTypeId } = config || {};
-  const { globby } = await import('globby');
-  const migrations = (await globby([`${directory}/*.js`, `${directory}/*.cjs`])).sort((a, b) => {
+  const migrations = (
+    await glob([`${directory}/*.js`, `${directory}/*.cjs`], { absolute: true })
+  ).sort((a, b) => {
     const numA = getVersionFromFile(a);
     const numB = getVersionFromFile(b);
     return (numA || 0) - (numB || 0);
@@ -387,21 +425,27 @@ const getNewMigrations = async (config) => {
       });
 
       return result;
-    } catch (error) {
+    } catch {
       // check if we have a migration scheduled which adds the initial content-type
-      const regexp = new RegExp(`createContentType\\(['"]${migrationContentTypeId}['"]\\)`, 'mg');
+      const regexp = new RegExp(
+        `createContentType\\(['"]${migrationContentTypeId}['"]\\)`,
+        "mg",
+      );
       const initial = (
         await Promise.all(
           migrations.map(async (file) => {
-            return fs.readFile(file, 'utf8');
-          })
+            return fs.readFile(file, "utf8");
+          }),
         )
       ).some((content) => regexp.test(content));
 
       if (initial) {
         return migrations;
       }
-      console.error(pc.red('\nError:'), `Missing migration content type. Run ${pc.cyan('npx migrations init')}`);
+      console.error(
+        pc.red("\nError:"),
+        `Missing migration content type. Run ${pc.cyan("npx migrations init")}`,
+      );
       process.exit(1);
     }
   }

package/lib/content.js

@@ -61,8 +61,8 @@ const transferContent = async (config) => {
   if (sourceVersion !== destVersion) {
     throw new Error(
       `Different migration states detected. ${pc.bold(sourceEnvironmentId)} (${sourceVersion}) !== ${pc.bold(
-        destEnvironmentId
-      )} (${destVersion})`
+        destEnvironmentId,
+      )} (${destVersion})`,
     );
   }
 
@@ -72,7 +72,7 @@ const transferContent = async (config) => {
     entries: sourceEntries,
     assets: sourceAssetsBase,
     filteredEntries,
-    contentTypes: sourceContentTypes,
+    contentTypes: _sourceContentTypes,
   } = await getContent({
     ...config,
     environmentId: sourceEnvironmentId,
@@ -147,8 +147,8 @@ const transferContent = async (config) => {
 
   console.log(
     `${br}Transfering ${pc.cyan(`${entries.length} Entries`)} and ${pc.cyan(`${assets.length} Assets`)} from ${pc.cyan(
-      sourceEnvironmentId
-    )} to ${pc.cyan(destEnvironmentId)}`
+      sourceEnvironmentId,
+    )} to ${pc.cyan(destEnvironmentId)}`,
   );
 
   proceed = await confirm(config);

package/lib/contentful.js

@@ -1,23 +1,22 @@
-const contentful = require('contentful-management');
-const flatMap = require('array.prototype.flatmap');
-const hasher = require('node-object-hash');
+const contentful = require("contentful-management");
+const { hasher } = require("node-object-hash");
 const objectHash = hasher();
 
 let client;
 let environmentCache = new Map();
 let spaceCache = new Map();
 
-const TYPE_SYMBOL = 'Symbol';
-const TYPE_TEXT = 'Text';
-const TYPE_RICHTEXT = 'RichText';
-const TYPE_NUMBER = 'Integer';
-const TYPE_DATE = 'Date';
-const TYPE_LOCATION = 'Location';
-const TYPE_ARRAY = 'Array';
-const TYPE_BOOLEAN = 'Boolean';
-const TYPE_LINK = 'Link';
-const LINK_TYPE_ASSET = 'Asset';
-const LINK_TYPE_ENTRY = 'Entry';
+const TYPE_SYMBOL = "Symbol";
+const TYPE_TEXT = "Text";
+const TYPE_RICHTEXT = "RichText";
+const TYPE_NUMBER = "Integer";
+const TYPE_DATE = "Date";
+const TYPE_LOCATION = "Location";
+const TYPE_ARRAY = "Array";
+const TYPE_BOOLEAN = "Boolean";
+const TYPE_LINK = "Link";
+const LINK_TYPE_ASSET = "Asset";
+const LINK_TYPE_ENTRY = "Entry";
 
 const MAX_ALLOWED_LIMIT = 1000;
 
@@ -47,13 +46,13 @@ const getContentId = (node) => {
 
 const getContentName = (node, displayField) => {
   const { fields, sys } = node;
-  const { id: fallback = 'unknown' } = sys || {};
+  const { id: fallback = "unknown" } = sys || {};
   const { [displayField]: field, name, title, id } = fields || {};
 
   for (const tmp of [field, name, title, id].filter((v) => v)) {
     const [result] = Object.values(tmp);
 
-    if (result && typeof result === 'string') {
+    if (result && typeof result === "string") {
       return result;
     }
   }
@@ -81,10 +80,13 @@ const getClient = async (options) => {
     return client;
   }
 
-  throw new Error('You need to login first. Run npx contentful login');
+  throw new Error("You need to login first. Run npx contentful login");
 };
 
-const getSpaces = async (options, { skip = 0, aggregatedResponse = null } = {}) => {
+const getSpaces = async (
+  options,
+  { skip = 0, aggregatedResponse = null } = {},
+) => {
   const client = await getClient(options);
   const query = {
     skip: skip,
@@ -132,7 +134,10 @@ const getEnvironments = async (options) => {
   return environments;
 };
 
-const getApiKeys = async (options, { skip = 0, aggregatedResponse = null } = {}) => {
+const getApiKeys = async (
+  options,
+  { skip = 0, aggregatedResponse = null } = {},
+) => {
   const space = await getSpace(options);
   const query = {
     skip: skip,
@@ -177,10 +182,12 @@ const getEnvironment = async (options) => {
   if (targetEnvironmentId && environmentIds.includes(targetEnvironmentId)) {
     environmentCache.set(cacheKey, space.getEnvironment(targetEnvironmentId));
   } else if (targetEnvironmentId) {
-    throw new Error(`Environment "${targetEnvironmentId}" is not available in space "${spaceId}"`);
+    throw new Error(
+      `Environment "${targetEnvironmentId}" is not available in space "${spaceId}"`,
+    );
   } else {
     throw new Error(
-      'Missing environment id. Use -e <environment-id> or set environment variable CONTENTFUL_ENVIRONMENT_ID'
+      "Missing environment id. Use -e <environment-id> or set environment variable CONTENTFUL_ENVIRONMENT_ID",
     );
   }
 
@@ -198,7 +205,7 @@ const getDefaultLocale = async (config) => {
 
   const defaultLocale = locales.find((locale) => locale.default);
   const { code } = defaultLocale || {};
-  return code || 'de';
+  return code || "de";
 };
 
 /**
@@ -210,12 +217,15 @@ const getDefaultLocale = async (config) => {
  * - getEntries
  * - getAssets
  */
-const pagedGet = async (environment, { method, skip = 0, aggregatedResponse = null, query = null }) => {
+const pagedGet = async (
+  environment,
+  { method, skip = 0, aggregatedResponse = null, query = null },
+) => {
   const fullQuery = {
     skip: skip,
     limit: MAX_ALLOWED_LIMIT,
-    order: 'sys.createdAt,sys.id',
-    ...(query || {}),
+    order: "sys.createdAt,sys.id",
+    ...query,
   };
 
   const response = await environment[method](fullQuery);
@@ -227,17 +237,28 @@ const pagedGet = async (environment, { method, skip = 0, aggregatedResponse = nu
   }
 
   if (skip + fullQuery.limit <= response.total) {
-    return pagedGet(environment, { method, skip: skip + fullQuery.limit, aggregatedResponse, query });
+    return pagedGet(environment, {
+      method,
+      skip: skip + fullQuery.limit,
+      aggregatedResponse,
+      query,
+    });
   }
   return aggregatedResponse;
 };
 
-const filterDrafts = (items, includeDrafts) => {
-  return includeDrafts ? items : items.filter((item) => !!item.sys.publishedVersion || !!item.sys.archivedVersion);
+const _filterDrafts = (items, includeDrafts) => {
+  return includeDrafts
+    ? items
+    : items.filter(
+        (item) => !!item.sys.publishedVersion || !!item.sys.archivedVersion,
+      );
 };
 
-const filterArchived = (items, includeArchived) => {
-  return includeArchived ? items : items.filter((item) => !item.sys.archivedVersion);
+const _filterArchived = (items, includeArchived) => {
+  return includeArchived
+    ? items
+    : items.filter((item) => !item.sys.archivedVersion);
 };
 
 const getLinkedId = (node, destType) => {
@@ -251,7 +272,7 @@ const getLinkedId = (node, destType) => {
 const getLinkedIds = (entry, destType) => {
   const { fields } = entry || {};
   const ids = Object.values(fields).reduce((result, locales) => {
-    const ids = flatMap(Object.values(locales), (value) => {
+    const ids = Object.values(locales).flatMap((value) => {
       if (Array.isArray(value)) {
         return value.map((node) => getLinkedId(node, destType));
       }
@@ -271,15 +292,26 @@ const getLinkedEntries = (entries, allEntries, options) => {
     return [];
   }
   const entryIds = (entries || []).map((entry) => getContentId(entry));
-  const linkedIds = (entries || []).reduce((result, entry) => [...result, ...getLinkedIds(entry, LINK_TYPE_ENTRY)], []);
+  const linkedIds = (entries || []).reduce(
+    (result, entry) => [...result, ...getLinkedIds(entry, LINK_TYPE_ENTRY)],
+    [],
+  );
   const newIds = linkedIds.filter(
-    (id) => !collectedIds.includes(id) && !entryIds.includes(id) && includeIds.includes(id)
+    (id) =>
+      !collectedIds.includes(id) &&
+      !entryIds.includes(id) &&
+      includeIds.includes(id),
+  );
+  const newEntries = allEntries.filter((entry) =>
+    newIds.includes(getContentId(entry)),
   );
-  const newEntries = allEntries.filter((entry) => newIds.includes(getContentId(entry)));
 
   return [
     ...newEntries,
-    ...getLinkedEntries(newEntries, allEntries, { ...(options || {}), collectedIds: [...collectedIds, ...entryIds] }),
+    ...getLinkedEntries(newEntries, allEntries, {
+      ...options,
+      collectedIds: [...collectedIds, ...entryIds],
+    }),
   ];
 };
 
@@ -287,7 +319,10 @@ const getLinkedAssets = (entries, assets) => {
   if ((entries || []).length === 0) {
     return [];
   }
-  const linkedIds = (entries || []).reduce((result, entry) => [...result, ...getLinkedIds(entry, LINK_TYPE_ASSET)], []);
+  const linkedIds = (entries || []).reduce(
+    (result, entry) => [...result, ...getLinkedIds(entry, LINK_TYPE_ASSET)],
+    [],
+  );
 
   return assets.filter((asset) => linkedIds.includes(getContentId(asset)));
 };
@@ -305,12 +340,20 @@ const getContent = async (options) => {
   const { contentType } = options;
   const environment = await getEnvironment(options);
 
-  const { items: contentTypes } = await pagedGet(environment, { method: 'getContentTypes' });
-  const { items: entries } = await pagedGet(environment, { method: 'getEntries' });
-  const { items: assets } = await pagedGet(environment, { method: 'getAssets' });
+  const { items: contentTypes } = await pagedGet(environment, {
+    method: "getContentTypes",
+  });
+  const { items: entries } = await pagedGet(environment, {
+    method: "getEntries",
+  });
+  const { items: assets } = await pagedGet(environment, {
+    method: "getAssets",
+  });
 
   if (contentType) {
-    const baseEntries = entries.filter((entry) => getContentTypeId(entry) === contentType);
+    const baseEntries = entries.filter(
+      (entry) => getContentTypeId(entry) === contentType,
+    );
 
     return {
       entries,
@@ -328,7 +371,7 @@ const getMigrationItems = async (options) => {
   const { migrationContentTypeId } = options;
   const environment = await getEnvironment(options);
   const { items } = await pagedGet(environment, {
-    method: 'getEntries',
+    method: "getEntries",
     query: { content_type: migrationContentTypeId },
   });
 
@@ -339,7 +382,9 @@ const getContentTypes = async (options) => {
   const { contentType } = options;
   const environment = await getEnvironment(options);
 
-  const { items: contentTypes } = await pagedGet(environment, { method: 'getContentTypes' });
+  const { items: contentTypes } = await pagedGet(environment, {
+    method: "getContentTypes",
+  });
 
   if (contentType) {
     return contentTypes.filter((entry) => getContentId(entry) === contentType);
@@ -351,7 +396,9 @@ const getContentTypes = async (options) => {
 const getEditorInterfaces = async (options) => {
   const environment = await getEnvironment(options);
 
-  const { items: editorInterfaces } = await pagedGet(environment, { method: 'getEditorInterfaces' });
+  const { items: editorInterfaces } = await pagedGet(environment, {
+    method: "getEditorInterfaces",
+  });
 
   return editorInterfaces;
 };