@strapi/upgrade 0.0.0-experimental.da85533897155e719d784f0271223c866d2f69ab → 0.0.0-experimental.de2b94258659463e5ddc5992e9a9490d66d950dd

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/utils/change-import.ts

@@ -3,9 +3,15 @@ import type { ImportDeclaration, JSCodeshift, Collection } from 'jscodeshift';
 export const changeImportSpecifier = (
   root: Collection,
   j: JSCodeshift,
-  options: { methodName: string; oldDependency: string; newDependency: string }
+  options: {
+    oldDependency: string;
+    newDependency: string;
+    oldMethodName: string;
+    newMethodName?: string;
+  }
 ): void => {
-  const { methodName, oldDependency, newDependency } = options;
+  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;
@@ -21,7 +27,7 @@ export const changeImportSpecifier = (
       // Check if the method is imported from the old dependency
       const methodSpecifiers = importDeclaration.specifiers?.filter(
         (specifier) =>
-          specifier.type === 'ImportSpecifier' && specifier.imported.name === methodName
+          specifier.type === 'ImportSpecifier' && specifier.imported.name === oldMethodName
       );
 
       if (methodSpecifiers && methodSpecifiers.length > 0) {
@@ -29,17 +35,17 @@ export const changeImportSpecifier = (
 
         // Collect all aliases for the method
         methodSpecifiers.forEach((specifier) => {
-          if (specifier.local && specifier.local.name !== methodName) {
+          if (specifier.local && specifier.local.name !== oldMethodName) {
             methodAliases.push(specifier.local.name);
           } else {
-            methodAliases.push(methodName);
+            methodAliases.push(methodNameToReplace);
           }
         });
 
         // Remove the method specifiers from the old import
         const updatedSpecifiers = importDeclaration.specifiers?.filter(
           (specifier) =>
-            specifier.type !== 'ImportSpecifier' || specifier.imported.name !== methodName
+            specifier.type !== 'ImportSpecifier' || specifier.imported.name !== oldMethodName
         );
 
         if (updatedSpecifiers && updatedSpecifiers.length > 0) {
@@ -59,20 +65,36 @@ export const changeImportSpecifier = (
       .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
+            );
 
-        methodAliases.forEach((alias) => {
-          const newSpecifier = j.importSpecifier(j.identifier(methodName), j.identifier(alias));
-          const specifiersArray = importDeclaration.specifiers || [];
-          j(path).replaceWith(
-            j.importDeclaration([...specifiersArray, newSpecifier], j.literal(newDependency))
-          );
-        });
+            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(methodName), j.identifier(alias))
+        j.importSpecifier(j.identifier(methodNameToReplace), j.identifier(alias))
       );
 
       const newImportDeclaration = j.importDeclaration(newSpecifiers, j.literal(newDependency));

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

package/resources/codemods/5.0.0/change-useAPIErrorHandler-import.code.ts

@@ -1,21 +0,0 @@
-import type { Transform } from 'jscodeshift';
-import { changeImportSpecifier } from '../../utils/change-import';
-
-/**
- * change useAPIErrorHandler import from '@strapi/helper-plugin' to '@strapi/strapi/admin'
- */
-const transform: Transform = (file, api) => {
-  const { j } = api;
-
-  const root = j.withParser('tsx')(file.source);
-
-  changeImportSpecifier(root, j, {
-    methodName: 'useAPIErrorHandler',
-    oldDependency: '@strapi/helper-plugin',
-    newDependency: '@strapi/strapi/admin',
-  });
-
-  return root.toSource();
-};
-
-export default transform;

package/resources/codemods/5.0.0/useRBAC-hook-import-change.code.ts

@@ -1,21 +0,0 @@
-import type { Transform } from 'jscodeshift';
-import { changeImportSpecifier } from '../../utils/change-import';
-
-/**
- * change useRBAC import from '@strapi/helper-plugin' to '@strapi/strapi/admin'
- */
-const transform: Transform = (file, api) => {
-  const { j } = api;
-
-  const root = j.withParser('tsx')(file.source);
-
-  changeImportSpecifier(root, j, {
-    methodName: 'useRBAC',
-    oldDependency: '@strapi/helper-plugin',
-    newDependency: '@strapi/strapi/admin',
-  });
-
-  return root.toSource();
-};
-
-export default transform;