@strapi/upgrade 5.0.0-rc.9 → 5.0.1

package/dist/tasks/upgrade/upgrade.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../../src/tasks/upgrade/upgrade.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,eAAO,MAAM,OAAO,YAAmB,cAAc,kBAmDpD,CAAC"}
+{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../../src/tasks/upgrade/upgrade.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,eAAO,MAAM,OAAO,YAAmB,cAAc,kBAuDpD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/upgrade",
-  "version": "5.0.0-rc.9",
+  "version": "5.0.1",
   "description": "CLI to upgrade Strapi applications effortless",
   "keywords": [
     "strapi",
@@ -59,13 +59,13 @@
     "watch": "pack-up watch"
   },
   "dependencies": {
-    "@strapi/utils": "5.0.0-rc.9",
+    "@strapi/utils": "5.0.1",
     "chalk": "4.1.2",
     "cli-table3": "0.6.2",
     "commander": "8.3.0",
     "esbuild-register": "3.5.0",
+    "fast-glob": "3.3.2",
     "fs-extra": "11.2.0",
-    "glob": "10.3.10",
     "jscodeshift": "0.15.1",
     "lodash": "4.17.21",
     "memfs": "4.6.0",
@@ -76,15 +76,15 @@
   },
   "devDependencies": {
     "@strapi/pack-up": "5.0.0",
-    "@strapi/types": "5.0.0-rc.9",
+    "@strapi/types": "5.0.1",
     "@types/fs-extra": "11.0.4",
     "@types/jscodeshift": "0.11.10",
-    "eslint-config-custom": "5.0.0-rc.9",
+    "eslint-config-custom": "5.0.1",
     "rimraf": "5.0.5"
   },
   "engines": {
     "node": ">=18.0.0 <=20.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "e281ba8e37693c2fc24795be4df4f2ed516063fc"
+  "gitHead": "99323ff7d720a309ae03d2fa50b232a25cf57116"
 }

package/resources/codemods/5.0.0/comment-out-lifecycle-files.code.ts

@@ -0,0 +1,63 @@
+import { Transform } from 'jscodeshift';
+
+/**
+ * comments out lifecycles.js/ts files and adds a description for the reason at the top
+ */
+const transform: Transform = (file, api) => {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+
+  // check if file path follows this pattern `content-types/[content-type-name]/lifecycles`
+  if (/content-types\/[^/]+\/lifecycles\.(js|ts)$/.test(file.path)) {
+    // Get the entire source code as a string
+    const sourceCode = root.toSource();
+
+    // Split the source code into lines and prepend // to each line
+    // we are using line comments instead of block comments so we don't face issues with existing block comments
+    const commentedCode = sourceCode
+      .split('\n')
+      .map((line) => `// ${line}`)
+      .join('\n');
+
+    // Add a header comment at the top to explain why the file is commented out
+    const headerComment = `
+/*
+ *
+ * ============================================================
+ * WARNING: THIS FILE HAS BEEN COMMENTED OUT
+ * ============================================================
+ *
+ * CONTEXT:
+ *
+ * The lifecycles.js file has been commented out to prevent unintended side effects when starting Strapi 5 for the first time after migrating to the document service.
+ *
+ * STRAPI 5 introduces a new document service that handles lifecycles differently compared to previous versions. Without migrating your lifecycles to document service middlewares, you may experience issues such as:
+ *
+ * - \`unpublish\` actions triggering \`delete\` lifecycles for every locale with a published entity, which differs from the expected behavior in v4.
+ * - \`discardDraft\` actions triggering both \`create\` and \`delete\` lifecycles, leading to potential confusion.
+ *
+ * MIGRATION GUIDE:
+ *
+ * For a thorough guide on migrating your lifecycles to document service middlewares, please refer to the following link:
+ * [Document Services Middlewares Migration Guide](https://docs.strapi.io/dev-docs/migration/v4-to-v5/breaking-changes/lifecycle-hooks-document-service)
+ *
+ * IMPORTANT:
+ *
+ * Simply uncommenting this file without following the migration guide may result in unexpected behavior and inconsistencies. Ensure that you have completed the migration process before re-enabling this file.
+ *
+ * ============================================================
+ */
+`;
+
+    // Combine the header comment with the commented-out code
+    const finalCode = `${headerComment}\n${commentedCode}`;
+
+    return finalCode;
+  }
+
+  return root.toSource();
+};
+
+export const parser = 'tsx';
+
+export default transform;

package/resources/codemods/5.0.0/dependency-upgrade-react-and-react-dom.json.ts

@@ -0,0 +1,67 @@
+import path from 'node:path';
+import semver from 'semver';
+
+import type { modules } from '../../../dist';
+
+const REACT_DEP_NAME = 'react';
+const REACT_DEP_PATH = `dependencies.${REACT_DEP_NAME}`;
+
+const REACT_DOM_DEP_NAME = 'react-dom';
+const REACT_DOM_DEP_PATH = `dependencies.${REACT_DOM_DEP_NAME}`;
+
+const DEP_NEW_VERSION_RANGE = '^18.0.0';
+
+/**
+ * Specifically targets the root package.json and updates the react and react-dom dependency version.
+ *
+ * We first check if the react and react-dom dependency is listed in the package.json. If the dependency is
+ * found, we verify its version.
+ *
+ * If the detected version does not satisfy the new version range, we replace it with the new one.
+ *
+ * Conversely, if no react or react-dom dependency is listed, we add it with the new version range.
+ */
+const transform: modules.runner.json.JSONTransform = (file, params) => {
+  const { cwd, json } = params;
+
+  const rootPackageJsonPath = path.join(cwd, 'package.json');
+
+  if (file.path !== rootPackageJsonPath) {
+    return file.json;
+  }
+
+  const j = json(file.json);
+
+  if (j.has(REACT_DEP_PATH) && j.has(REACT_DOM_DEP_PATH)) {
+    const currentReactVersion = j.get(REACT_DEP_PATH);
+    const currentReactDOMVersion = j.get(REACT_DOM_DEP_PATH);
+
+    // If the current version is not a string, then something is wrong, abort
+    if (typeof currentReactVersion !== 'string' || typeof currentReactDOMVersion !== 'string') {
+      return j.root();
+    }
+
+    const currentSatisfiesNew =
+      semver.satisfies(currentReactVersion, DEP_NEW_VERSION_RANGE) &&
+      semver.satisfies(currentReactDOMVersion, DEP_NEW_VERSION_RANGE);
+
+    // if the current version satisfies the new range, keep it as is and abort
+    if (currentSatisfiesNew) {
+      return j.root();
+    }
+
+    // else, update the version with the new one
+    j.set(REACT_DEP_PATH, DEP_NEW_VERSION_RANGE);
+    j.set(REACT_DOM_DEP_PATH, DEP_NEW_VERSION_RANGE);
+  }
+
+  // If the dependency is not listed yet, add it
+  else {
+    j.set(REACT_DEP_PATH, DEP_NEW_VERSION_RANGE);
+    j.set(REACT_DOM_DEP_PATH, DEP_NEW_VERSION_RANGE);
+  }
+
+  return j.root();
+};
+
+export default transform;

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

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