@strapi/upgrade 0.0.0-experimental.e3e48deb89bd0a1b6cc69b698696566fa7854a95 → 0.0.0-experimental.e8d8fc824d0f6a695b2a9ebaa4680ed21c3645ca

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-remove-strapi-plugin-i18n.json.ts

@@ -0,0 +1,31 @@
+import path from 'node:path';
+
+import type { modules } from '../../../dist';
+
+const STRAPI_I18N_DEP_NAME = '@strapi/plugin-i18n';
+const STRAPI_I18N_DEP_PATH = `dependencies.${STRAPI_I18N_DEP_NAME}`;
+
+/**
+ * Specifically targets the root package.json and removes the @strapi/plugin-i18n dependency.
+ *
+ * Why? The i18n plugin is now a hard dependency of @strapi/strapi and isn't needed in the package.json anymore.
+ */
+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(STRAPI_I18N_DEP_PATH)) {
+    j.remove(STRAPI_I18N_DEP_PATH);
+  }
+
+  return j.root();
+};
+
+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/dependency-upgrade-react-router-dom.json.ts

@@ -0,0 +1,59 @@
+import path from 'node:path';
+import semver from 'semver';
+
+import type { modules } from '../../../dist';
+
+const REACT_ROUTER_DEP_NAME = 'react-router-dom';
+const REACT_ROUTER_DEP_PATH = `dependencies.${REACT_ROUTER_DEP_NAME}`;
+
+const DEP_NEW_VERSION_RANGE = '^6.0.0';
+
+/**
+ * Specifically targets the root package.json and updates the react-router-dom dependency version.
+ *
+ * We first check if the react-router-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-router-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_ROUTER_DEP_PATH)) {
+    const currentVersion = j.get(REACT_ROUTER_DEP_PATH);
+
+    // If the current version is not a string, then something is wrong, abort
+    if (typeof currentVersion !== 'string') {
+      return j.root();
+    }
+
+    const currentSatisfiesNew = semver.satisfies(currentVersion, 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_ROUTER_DEP_PATH, DEP_NEW_VERSION_RANGE);
+  }
+
+  // If the dependency is not listed yet, add it
+  else {
+    j.set(REACT_ROUTER_DEP_PATH, DEP_NEW_VERSION_RANGE);
+  }
+
+  return j.root();
+};
+
+export default transform;

package/resources/codemods/5.0.0/dependency-upgrade-styled-components.json.ts

@@ -0,0 +1,49 @@
+import path from 'node:path';
+import semver from 'semver';
+
+import type { modules } from '../../../dist';
+
+const DEP_NAME = 'styled-components';
+const DEP_PATH = `dependencies.${DEP_NAME}`;
+
+const DEP_NEW_VERSION_RANGE = '^6.0.0';
+
+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(DEP_PATH)) {
+    const currentVersion = j.get(DEP_PATH);
+
+    // If the current version is not a string, then something is wrong, abort
+    if (typeof currentVersion !== 'string') {
+      return j.root();
+    }
+
+    const currentSatisfiesNew = semver.satisfies(currentVersion, 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(DEP_PATH, DEP_NEW_VERSION_RANGE);
+  }
+
+  // If the dependency is not listed yet, add it
+  else {
+    j.set(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;