@elliemae/ds-codemods 3.46.0-rc.9 → 3.46.1

package/bin/cli/code-mods/command-logics/deprecated-components-usage-report/utils.mjs

@@ -6,6 +6,8 @@ import {
   LEGACY_WITH_NEW_MEDIUM_MIGRATION_EFFORT,
   LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT,
   DISMISSED_WITH_EXAMPLE,
+  NEVER_INTENDED_FOR_EXTERNAL_USAGE,
+  DISMISSED_BEFORE_DEPRECATION_FLOWS_EXISTED,
   STORYPOINTS_TO_EFFORT,
 } from '../../../constants/index.mjs';
 
@@ -15,6 +17,8 @@ import {
  *    | typeof LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT} deprecatedEffortMap
  * @typedef {deprecatedEffortMap[number]} deprecatedEffortMapEntry
  * @typedef {typeof DISMISSED_WITH_EXAMPLE[number]} dismissedWithExampleEntry
+ * @typedef {typeof NEVER_INTENDED_FOR_EXTERNAL_USAGE[number]} reportingUsageOfInternalOnlyEntry
+ * @typedef {typeof DISMISSED_BEFORE_DEPRECATION_FLOWS_EXISTED[number]} dismissedBeforeDeprecationFlowsExistedEntry
  *
  * @typedef { object } regexpInfo
  * @property { string } regexpInfo.fullMatch
@@ -30,10 +34,18 @@ import {
  * @typedef { object } matchDeprecatedEntryPropeties
  * @property { dismissedWithExampleEntry[] } matchDeprecatedEntryPropeties.matchingEffortsMetainfo
  *
+ * @typedef { object } matchInternalOnlyEntryPropeties
+ * @property { reportingUsageOfInternalOnlyEntry[] } matchInternalOnlyEntryPropeties.matchingEffortsMetainfo
+ *
+ * @typedef { object } matchDeprecatedBeforeDeprecationFlowsExistedEntryPropeties
+ * @property { dismissedBeforeDeprecationFlowsExistedEntry[] } matchDeprecatedBeforeDeprecationFlowsExistedEntryPropeties.matchingEffortsMetainfo
+ *
  * @typedef {matchSharedPropieties & matchWithEffortEntryPropeties} matchWithEffortMetaInfo
  * @typedef {matchSharedPropieties & matchDeprecatedEntryPropeties} matchDeprecatedWithExample
+ * @typedef {matchSharedPropieties & matchInternalOnlyEntryPropeties} matchInternalOnlyUsedExternally
+ * @typedef {matchSharedPropieties & matchDeprecatedBeforeDeprecationFlowsExistedEntryPropeties} matchDeprecatedBeforeDeprecationFlowsExisted
  *
- * @typedef {matchWithEffortMetaInfo | matchDeprecatedWithExample} matchedEffortMapValue
+ * @typedef {matchWithEffortMetaInfo | matchDeprecatedWithExample | matchInternalOnlyUsedExternally | matchDeprecatedBeforeDeprecationFlowsExisted} matchedEffortMapValue
  *
  * @typedef {Map<string, matchedEffortMapValue>} matchedEffortMap
  *
@@ -42,12 +54,14 @@ import {
  * @property {matchWithEffortMetaInfo} fileReport.deprecatedSmallEffort
  * @property {matchWithEffortMetaInfo} fileReport.deprecatedMediumEffort
  * @property {matchWithEffortMetaInfo} fileReport.deprecatedLargeEffort
- * @property {matchDeprecatedWithExample} fileReport.deprecatedDismissed
+ * @property {matchDeprecatedWithExample} fileReport.deprecatedWithExample
+ * @property {matchInternalOnlyUsedExternally} fileReport.reportingUsageOfInternalOnly
+ * @property {matchDeprecatedBeforeDeprecationFlowsExisted} fileReport.deprecatedBeforeDeprecationFlowsExisted
  *
  */
 
 const subStringAdhocDSMatcher = (str, substr) => {
-  if (str === substr) return true;
+  if (str === substr || substr === '*') return true;
   const substrRegExp = substr.startsWith('@elliemae/ds-')
     ? new RegExp(`@\\belliemae\/ds-${substr.split('@elliemae/ds-')[1]}`, 'g')
     : new RegExp(`\\b${substr}\\b`, 'g');
@@ -189,11 +203,11 @@ export const checkDeprecatedLargeEffort = (importStatements) =>
   checkDeprecatedEffort(importStatements, LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT, 'large');
 
 /**
- * given a list of import statements, it checks if any of them is a large effort deprecation
+ * given a list of import statements, it checks if any of them is a deprecated with example effort
  * @param {string[][]} importStatements - list of import statements to check generated by the regex
  * @returns {Map<string, matchDeprecatedWithExample>} - a map of matched statements
  */
-export const checkDeprecatedDismissed = (importStatements) => {
+export const checkDeprecatedWithExample = (importStatements) => {
   const matchedEfforts = new Map();
   importStatements.forEach((importStatement) => {
     const [fullMatch, importedComponent, packageName] = importStatement;
@@ -212,6 +226,54 @@ export const checkDeprecatedDismissed = (importStatements) => {
   return matchedEfforts;
 };
 
+/**
+ * given a list of import statements, it checks if any of them is importing a component that was never intended for external usage
+ * @param {string[][]} importStatements - list of import statements to check generated by the regex
+ * @returns {Map<string, matchInternalOnlyUsedExternally>} - a map of matched statements
+ */
+export const checkInternalUsageOnlyIntended = (importStatements) => {
+  const matchedEfforts = new Map();
+  importStatements.forEach((importStatement) => {
+    const [fullMatch, importedComponent, packageName] = importStatement;
+    const matchingDeprecations = NEVER_INTENDED_FOR_EXTERNAL_USAGE.filter(
+      (effortMetainfo) =>
+        subStringAdhocDSMatcher(importedComponent, effortMetainfo.component) &&
+        // {DSGroupBox} from 'ds-mobile' is not (yet) deprecated, DSGroupBox is a repeated component name, we need the extra package check
+        subStringAdhocDSMatcher(packageName, effortMetainfo.oldPackage),
+    );
+    if (matchingDeprecations.length < 1) return;
+    matchedEfforts.set(fullMatch, {
+      regexpInfo: { fullMatch, importedComponent, packageName },
+      matchingEffortsMetainfo: matchingDeprecations,
+    });
+  });
+  return matchedEfforts;
+};
+
+/**
+ * given a list of import statements, it checks if any of them is importing a component that was deprecated before the deprecation flows existed
+ * @param {string[][]} importStatements - list of import statements to check generated by the regex
+ * @returns {Map<string, matchDeprecatedBeforeDeprecationFlowsExisted>} - a map of matched statements
+ */
+export const checkDeprecatedBeforeDeprecationFlowExisted = (importStatements) => {
+  const matchedEfforts = new Map();
+  importStatements.forEach((importStatement) => {
+    const [fullMatch, importedComponent, packageName] = importStatement;
+    const matchingDeprecations = DISMISSED_BEFORE_DEPRECATION_FLOWS_EXISTED.filter(
+      (effortMetainfo) =>
+        subStringAdhocDSMatcher(importedComponent, effortMetainfo.component) &&
+        // {DSGroupBox} from 'ds-mobile' is not (yet) deprecated, DSGroupBox is a repeated component name, we need the extra package check
+        subStringAdhocDSMatcher(packageName, effortMetainfo.oldPackage),
+    );
+    if (matchingDeprecations.length < 1) return;
+    matchedEfforts.set(fullMatch, {
+      regexpInfo: { fullMatch, importedComponent, packageName },
+      matchingEffortsMetainfo: matchingDeprecations,
+    });
+  });
+  return matchedEfforts;
+};
+
 /**
  * given a file path, it checks if the file contains any deprecated components
  * @param {string} filePath - path to the file to check
@@ -224,20 +286,26 @@ export const checkFileForDeprecatedComponents = (filePath) => {
   const deprecatedSmallEffort = checkDeprecatedSmallEffort(importStatements);
   const deprecatedMediumEffort = checkDeprecatedMediumEffort(importStatements);
   const deprecatedLargeEffort = checkDeprecatedLargeEffort(importStatements);
-  const deprecatedDismissed = checkDeprecatedDismissed(importStatements);
+  const deprecatedWithExample = checkDeprecatedWithExample(importStatements);
+  const reportingUsageOfInternalOnly = checkInternalUsageOnlyIntended(importStatements);
+  const deprecatedBeforeDeprecationFlowsExisted = checkDeprecatedBeforeDeprecationFlowExisted(importStatements);
 
   const isFileProblematic =
     deprecatedSmallEffort.size > 0 ||
     deprecatedMediumEffort.size > 0 ||
     deprecatedLargeEffort.size > 0 ||
-    deprecatedDismissed.size > 0;
+    deprecatedWithExample.size > 0 ||
+    reportingUsageOfInternalOnly.size > 0 ||
+    deprecatedBeforeDeprecationFlowsExisted.size > 0;
 
   return {
     isFileProblematic,
     deprecatedSmallEffort,
     deprecatedMediumEffort,
     deprecatedLargeEffort,
-    deprecatedDismissed,
+    deprecatedWithExample,
+    reportingUsageOfInternalOnly,
+    deprecatedBeforeDeprecationFlowsExisted,
   };
 };
 
@@ -276,7 +344,14 @@ const generateCsvRowFromMatchedEffort = (matchingEffortMetainfo, filePath, org,
  * @returns {string[]} - list of csv rows
  */
 export const generateCsvRows = (fileReport, filePath, org, repo) => {
-  const { deprecatedSmallEffort, deprecatedMediumEffort, deprecatedLargeEffort, deprecatedDismissed } = fileReport;
+  const {
+    deprecatedSmallEffort,
+    deprecatedMediumEffort,
+    deprecatedLargeEffort,
+    deprecatedWithExample,
+    reportingUsageOfInternalOnly,
+    deprecatedBeforeDeprecationFlowsExisted,
+  } = fileReport;
   // csv structure = `Legacy Component,${options.org ? 'Org,' : ''}${options.repo ? 'Repository,' : ''}Legacy Package,Filename,File Path,Effort Size,Story Points`
   // Legacy Component -> matchingEffortMetainfo.component
   // Legacy Package -> matchingEffortMetainfo.oldPackage
@@ -304,7 +379,21 @@ export const generateCsvRows = (fileReport, filePath, org, repo) => {
     });
   });
 
-  deprecatedDismissed.forEach((effort) => {
+  deprecatedWithExample.forEach((effort) => {
+    const { matchingEffortsMetainfo } = effort;
+    matchingEffortsMetainfo.forEach((effort) => {
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    });
+  });
+
+  reportingUsageOfInternalOnly.forEach((effort) => {
+    const { matchingEffortsMetainfo } = effort;
+    matchingEffortsMetainfo.forEach((effort) => {
+      csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));
+    });
+  });
+
+  deprecatedBeforeDeprecationFlowsExisted.forEach((effort) => {
     const { matchingEffortsMetainfo } = effort;
     matchingEffortsMetainfo.forEach((effort) => {
       csvRows.push(generateCsvRowFromMatchedEffort(effort, filePath, org, repo));

package/bin/cli/constants/deprecatedPackages.mjs

@@ -222,6 +222,11 @@ export const LEGACY_WITH_NEW_SMALL_MIGRATION_EFFORT = [
     tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "50",
   },
 
+  { component:    'comboboxfreesolo',                 oldPackage: '@elliemae/ds-form',    
+    newComponent: 'DSComboBoxV3',                     newPackage: '@elliemae/ds-controlled-form',
+    tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "50",
+  },
+
   { component:    'DSPill',                           oldPackage: '@elliemae/ds-pills',
     newComponent: 'DSPillV2',                         newPackage: '@elliemae/ds-pills-v2',
     tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "50",
@@ -331,11 +336,6 @@ export const LEGACY_WITH_NEW_MEDIUM_MIGRATION_EFFORT = [
     newComponent: 'DSDropzone',                       newPackage: '@elliemae/ds-dropzone',
     tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "250",
   },
-
-  { component:    'DSZipCodeSearch',                  oldPackage: '@elliemae/ds-zipcode-search',
-    newComponent: 'DSAutocomplete',                   newPackage: '@elliemae/ds-form-layout-autocomplete',
-    tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "250",
-  },
 ]
 
 /* prettier-ignore */
@@ -349,13 +349,8 @@ export const LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT = [
     newComponent: 'DataTable',                        newPackage: '@elliemae/ds-data-table',
     tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "500",
   },
-  { component:    'DSDataGrid',                         oldPackage: '@elliemae/ds-datagrids',
-    newComponent: 'DataTable',                        newPackage: '@elliemae/ds-data-table',
-    tags:[ SEVERITY_TAGS.A11Y_LIMITATIONS ],          storyPoints: "500",
-  },
 ];
 
-// all of those are considered LOW effort
 /**
  * @type {DeprecatedPackageMatch[]}
  */
@@ -412,6 +407,45 @@ export const DISMISSED_WITH_EXAMPLE = [
   { component: 'DSZoom',                              oldPackage:    '@elliemae/ds-zoom',                 
     storyPoints: "300",
   },
+  { component: '*',                                   oldPackage:    '@elliemae/ds-popover',                 
+    storyPoints: "300",
+  },
+  { component: '*',                                   oldPackage:    '@elliemae/ds-popper',                 
+    storyPoints: "300",
+  },
+];
+/**
+ * @type {DeprecatedPackageMatch[]}
+ */
+/* prettier-ignore */
+export const NEVER_INTENDED_FOR_EXTERNAL_USAGE = [
+  { component: '*',                                   oldPackage:    '@elliemae/ds-overlay',                 
+    storyPoints: "50",
+  },
+  { component: '*',                                   oldPackage:    '@elliemae/ds-shared',                 
+    storyPoints: "150",
+  },
+  { component: '*',                                   oldPackage:    '@elliemae/ds-classnames',                 
+    storyPoints: "500",
+  },
+  { component: '*',                                   oldPackage:    '@elliemae/ds-common',                 
+    storyPoints: "150",
+  },
+  { component: '*',                                   oldPackage:    '@elliemae/ds-portal',                 
+    storyPoints: "50",
+  },
+  { component: '*',                                   oldPackage:    '@elliemae/ds-scrollable-container',                 
+    storyPoints: "50",
+  },
+];
+/**
+ * @type {DeprecatedPackageMatch[]}
+ */
+/* prettier-ignore */
+export const DISMISSED_BEFORE_DEPRECATION_FLOWS_EXISTED = [
+  { component: '*',                                   oldPackage:    '@elliemae/ds-imagelibrarymodal',                 
+    storyPoints: "300",
+  },
 ];
 
 /* prettier-ignore */

package/bin/cli/constants/index.mjs

@@ -4,5 +4,7 @@ export {
   LEGACY_WITH_NEW_MEDIUM_MIGRATION_EFFORT,
   LEGACY_WITH_NEW_LARGE_MIGRATION_EFFORT,
   DISMISSED_WITH_EXAMPLE,
+  NEVER_INTENDED_FOR_EXTERNAL_USAGE,
+  DISMISSED_BEFORE_DEPRECATION_FLOWS_EXISTED,
   STORYPOINTS_TO_EFFORT,
 } from './deprecatedPackages.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-codemods",
-  "version": "3.46.0-rc.9",
+  "version": "3.46.1",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Code Mods",
   "files": [