@strapi/upgrade 0.0.0-experimental.e9122b401c96877b6707775c4f893660eab93ae3 → 0.0.0-experimental.f0d3b2d782e972f1dcb8acf0dce31d4090d1e420

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

@@ -65,19 +65,32 @@ 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(methodNameToReplace),
-            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) =>

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/nocontent-migrate-to-emptystatelayout.code.ts

@@ -1,30 +0,0 @@
-import type { Transform } from 'jscodeshift';
-import { changeImportSpecifier } from '../../utils/change-import';
-import { replaceJSXElement } from '../../utils/replace-jsx';
-
-/**
- * change NoContent import from '@strapi/helper-plugin' to EmptyStateLayout from '@strapi/design-system'
- * And replace all uses of NoContent with EmptyStateLayout
- */
-const transform: Transform = (file, api) => {
-  const { j } = api;
-
-  const root = j.withParser('tsx')(file.source);
-
-  replaceJSXElement(root, j, {
-    oldElementName: 'NoContent',
-    newElementName: 'EmptyStateLayout',
-    oldDependency: '@strapi/helper-plugin',
-  });
-
-  changeImportSpecifier(root, j, {
-    oldMethodName: 'NoContent',
-    newMethodName: 'EmptyStateLayout',
-    oldDependency: '@strapi/helper-plugin',
-    newDependency: '@strapi/design-system',
-  });
-
-  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, {
-    oldMethodName: 'useRBAC',
-    oldDependency: '@strapi/helper-plugin',
-    newDependency: '@strapi/strapi/admin',
-  });
-
-  return root.toSource();
-};
-
-export default transform;