@jungvonmatt/contentful-migrations 6.2.5 → 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();
@@ -112,30 +133,34 @@ const addMigrationEntry = async (data, config) => {
 
   let entry;
   try {
-    entry = await client.getEntry(version);
+    entry = await client.getEntry(`${version}`);
   } 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 👍🏼");
 };
 
 /**
@@ -358,8 +395,11 @@ const getLatestVersion = async (config) => {
 
 const getVersionFromFile = (file) => {
   const name = path.basename(file);
-  const [, num] = /^(\d+)-/.exec(name);
-  return parseInt(num, 10);
+  const versionMatch = /^\d+/.exec(name);
+  if (!versionMatch) {
+    return undefined;
+  }
+  return Number.parseInt(versionMatch[0], 10);
 };
 
 /**
@@ -368,11 +408,12 @@ 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 - numB;
+    return (numA || 0) - (numB || 0);
   });
 
   if (storage === STORAGE_CONTENT) {
@@ -380,25 +421,31 @@ const getNewMigrations = async (config) => {
       const versions = await getMigrationVersions(config);
       const result = migrations.filter((file) => {
         const num = getVersionFromFile(file);
-        return !(versions || []).includes(num);
+        return !!num && !(versions || []).includes(num);
       });
 
       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);
     }
   }
@@ -420,3 +467,4 @@ module.exports.getMigrationVersionFromTag = getMigrationVersionFromTag;
 module.exports.getLatestVersion = getLatestVersion;
 module.exports.storeMigration = storeMigration;
 module.exports.getNewMigrations = getNewMigrations;
+module.exports.getVersionFromFile = getVersionFromFile;

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);