@strapi/upgrade 0.0.0-experimental.f75e3c6d67cc47c64ab37479efdbb7b43be50b78 → 0.0.0-experimental.f78dd29ef270559728250589cde1cfb0b9f7343a

package/resources/codemods/5.0.0/deprecate-helper-plugin.code.ts

@@ -0,0 +1,192 @@
+import type { Transform } from 'jscodeshift';
+import { changeImportSpecifier } from '../../utils/change-import';
+import { replaceJSXElement } from '../../utils/replace-jsx';
+
+/**
+ * This codemods automates all the imports and naming changes
+ * for methods or components that used to be imported from '@strapi/helper-plugin'
+ */
+const transform: Transform = (file, api) => {
+  const { j } = api;
+
+  const root = j.withParser('tsx')(file.source);
+
+  type Replacement = {
+    oldName: string;
+    oldDependency: string;
+    toReplace: boolean;
+    toChangeImportSpecifier: boolean;
+    newDependency?: string;
+    newName?: string;
+    newImport?: string;
+  };
+
+  const replacements: Replacement[] = [
+    {
+      oldName: 'AnErrorOccurred',
+      newImport: 'Page',
+      newName: 'Page.Error',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toReplace: true,
+      toChangeImportSpecifier: true,
+    },
+    {
+      oldName: 'CheckPagePermissions',
+      newImport: 'Page',
+      newName: 'Page.Protect',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toReplace: true,
+      toChangeImportSpecifier: true,
+    },
+    {
+      oldName: 'ConfirmDialog',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'DateTimePicker',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/design-system',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'getFetchClient',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'LoadingIndicatorPage',
+      newImport: 'Page',
+      newName: 'Page.Loading',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toReplace: true,
+      toChangeImportSpecifier: true,
+    },
+    {
+      oldName: 'NoContent',
+      newImport: 'EmptyStateLayout',
+      newName: 'EmptyStateLayout',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/design-system',
+      toReplace: true,
+      toChangeImportSpecifier: true,
+    },
+    {
+      oldName: 'NoPermissions',
+      newImport: 'Page',
+      newName: 'Page.NoPermissions',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toReplace: true,
+      toChangeImportSpecifier: true,
+    },
+    {
+      oldName: 'Status',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/design-system',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'translatedErrors',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useAPIErrorHandler',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useCallbackRef',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/design-system',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useCollator',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/design-system',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useFetchClient',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useFilter',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/design-system',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useQueryParams',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useRBAC',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'SearchURLQuery',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+    {
+      oldName: 'useSettingsForm',
+      oldDependency: '@strapi/helper-plugin',
+      newDependency: '@strapi/strapi/admin',
+      toChangeImportSpecifier: true,
+      toReplace: false,
+    },
+  ];
+
+  replacements.forEach((replacement) => {
+    if (replacement.toReplace && replacement.newName) {
+      replaceJSXElement(root, j, {
+        oldElementName: replacement.oldName,
+        newElementName: replacement.newName,
+        oldDependency: replacement.oldDependency,
+      });
+    }
+
+    if (replacement.toChangeImportSpecifier && replacement.newDependency) {
+      changeImportSpecifier(root, j, {
+        oldMethodName: replacement.oldName,
+        newMethodName: replacement.newImport,
+        oldDependency: replacement.oldDependency,
+        newDependency: replacement.newDependency,
+      });
+    }
+  });
+
+  return root.toSource();
+};
+
+export default transform;

package/resources/codemods/5.0.0/sqlite3-to-better-sqlite3.json.ts

@@ -30,7 +30,6 @@ const transform: modules.runner.json.JSONTransform = (file, params) => {
   });
 
   if (removed && !j.has('dependencies.better-sqlite3')) {
-    // TODO check this version when releasing V5
     j.set('dependencies.better-sqlite3', '9.4.3');
   }
 

package/resources/codemods/5.1.0/dependency-better-sqlite3.json.ts

@@ -0,0 +1,48 @@
+import path from 'path';
+import semver from 'semver';
+import type { modules } from '../../../dist';
+
+const DEP_NAME = 'better-sqlite3';
+const DEP_PATH = `dependencies.${DEP_NAME}`;
+const DEP_VERSION = '11.3.0';
+
+/**
+ *
+ */
+const transform: modules.runner.json.JSONTransform = (file, params) => {
+  return upgradeIfExists(file, params, DEP_PATH, DEP_VERSION);
+};
+
+export default transform;
+
+// TODO: move this to a utility once we solve the issue where codemods are not transpiled properly
+const upgradeIfExists = (
+  file: modules.runner.json.JSONSourceFile,
+  params: modules.runner.json.JSONTransformParams,
+  packagePath: string,
+  targetVersion: string
+) => {
+  const { cwd, json } = params;
+
+  // Return early if the file path is not the root package.json
+  if (file.path !== path.join(cwd, 'package.json')) {
+    return file.json;
+  }
+
+  const packageJson = json(file.json);
+
+  // Check if the package exists
+  if (packageJson.has(packagePath)) {
+    const currentVersion = packageJson.get(packagePath);
+    // ensure we only upgrade, not downgrade
+    if (
+      typeof currentVersion === 'string' &&
+      semver.valid(currentVersion) &&
+      semver.lt(currentVersion, targetVersion)
+    ) {
+      packageJson.set(packagePath, targetVersion);
+    }
+  }
+
+  return packageJson.root();
+};

package/resources/utils/change-import.ts

@@ -0,0 +1,118 @@
+import type { ImportDeclaration, JSCodeshift, Collection } from 'jscodeshift';
+
+export const changeImportSpecifier = (
+  root: Collection,
+  j: JSCodeshift,
+  options: {
+    oldDependency: string;
+    newDependency: string;
+    oldMethodName: string;
+    newMethodName?: string;
+  }
+): void => {
+  const { oldMethodName, newMethodName, oldDependency, newDependency } = options;
+  const methodNameToReplace = newMethodName ?? oldMethodName;
+
+  // Flag to check if the method was imported from the old dependency
+  let methodImportedFromOldDependency = false;
+  const methodAliases: string[] = [];
+
+  // Remove the method from the old dependency and check if it was imported
+  root
+    .find(j.ImportDeclaration)
+    .filter((path) => path.node.source.value === oldDependency)
+    .forEach((path) => {
+      const importDeclaration: ImportDeclaration = path.node;
+
+      // Check if the method is imported from the old dependency
+      const methodSpecifiers = importDeclaration.specifiers?.filter(
+        (specifier) =>
+          specifier.type === 'ImportSpecifier' && specifier.imported.name === oldMethodName
+      );
+
+      if (methodSpecifiers && methodSpecifiers.length > 0) {
+        methodImportedFromOldDependency = true;
+
+        // Collect all aliases for the method
+        methodSpecifiers.forEach((specifier) => {
+          if (specifier.local && specifier.local.name !== oldMethodName) {
+            methodAliases.push(specifier.local.name);
+          } else {
+            methodAliases.push(methodNameToReplace);
+          }
+        });
+
+        // Remove the method specifiers from the old import
+        const updatedSpecifiers = importDeclaration.specifiers?.filter(
+          (specifier) =>
+            specifier.type !== 'ImportSpecifier' || specifier.imported.name !== oldMethodName
+        );
+
+        if (updatedSpecifiers && updatedSpecifiers.length > 0) {
+          // Replace the import with the updated specifiers if there are other imports left
+          j(path).replaceWith(j.importDeclaration(updatedSpecifiers, j.literal(oldDependency)));
+        } else {
+          // Remove the entire import statement if the specified method was the only import
+          j(path).remove();
+        }
+      }
+    });
+
+  // Add new import dependency if the method was imported from the old dependency
+  if (methodImportedFromOldDependency) {
+    const dependencies = root
+      .find(j.ImportDeclaration)
+      .filter((path) => path.node.source.value === newDependency);
+
+    if (dependencies.length > 0) {
+      // we have to use a flag to prevent adding the method to multiple imports
+      let methodAdded = false;
+      dependencies.forEach((path) => {
+        const importDeclaration: ImportDeclaration = path.node;
+        if (!methodAdded) {
+          methodAliases.forEach((alias) => {
+            // Check if the methodNameToReplace or its alias is already imported
+            const specifiersArray = importDeclaration.specifiers || [];
+            const methodAlreadyExists = specifiersArray.some(
+              (specifier) =>
+                specifier.type === 'ImportSpecifier' &&
+                specifier.imported.name === methodNameToReplace && // Check if imported method matches
+                specifier.local?.name === alias // Check if local alias matches
+            );
+
+            if (!methodAlreadyExists) {
+              // If method does not exist, add it
+              const newSpecifier = j.importSpecifier(
+                j.identifier(methodNameToReplace),
+                j.identifier(alias)
+              );
+              path.get('specifiers').replace([...specifiersArray, newSpecifier]);
+              methodAdded = true;
+            }
+          });
+        }
+      });
+    } else {
+      const newSpecifiers = methodAliases.map((alias) =>
+        j.importSpecifier(j.identifier(methodNameToReplace), j.identifier(alias))
+      );
+
+      const newImportDeclaration = j.importDeclaration(newSpecifiers, j.literal(newDependency));
+
+      // Find the index of the first non-import declaration
+      const body = root.get().node.program.body;
+      const lastImportIndex = body.findIndex((node) => node.type !== 'ImportDeclaration');
+
+      if (lastImportIndex > -1) {
+        // Insert the new import declaration just before the first non-import node
+        body.splice(lastImportIndex, 0, newImportDeclaration);
+      } else {
+        // Check if 'use strict' exists at the beginning
+        const hasUseStrict =
+          body[0]?.type === 'ExpressionStatement' && body[0]?.expression?.value === 'use strict';
+        // Add the new import after 'use strict' if it exists, otherwise at the beginning
+        body.splice(hasUseStrict ? 1 : 0, 0, newImportDeclaration);
+      }
+    }
+  }
+};

package/resources/utils/replace-jsx.ts

@@ -0,0 +1,49 @@
+import type { JSCodeshift, Collection } from 'jscodeshift';
+
+export const replaceJSXElement = (
+  root: Collection,
+  j: JSCodeshift,
+  {
+    oldElementName,
+    newElementName,
+    oldDependency,
+  }: {
+    oldElementName: string;
+    newElementName: string;
+    oldDependency: string;
+  }
+) => {
+  // Find the import declaration for the old dependency
+  const importDeclaration = root.find(j.ImportDeclaration, {
+    source: { value: oldDependency },
+  });
+
+  if (importDeclaration.size() === 0) {
+    return;
+  }
+
+  // Get the local name of the imported element
+  const localName = importDeclaration
+    .find(j.ImportSpecifier, {
+      imported: { name: oldElementName },
+    })
+    .nodes()[0]?.local?.name;
+
+  if (!localName) {
+    return;
+  }
+
+  // Replace JSX elements
+  root.findJSXElements(localName).forEach((path) => {
+    const openingElement = path.node.openingElement;
+    const closingElement = path.node.closingElement;
+
+    if (j.JSXIdentifier.check(openingElement.name)) {
+      openingElement.name.name = newElementName;
+    }
+
+    if (closingElement && j.JSXIdentifier.check(closingElement.name)) {
+      closingElement.name.name = newElementName;
+    }
+  });
+};