refactor(migrations): restore dynamic import helper as cjs

This partially reverts commit 69dda0b

Author: damyanpetev

projects/igniteui-angular/migrations/common/import-helper.cts

@@ -0,0 +1,15 @@
+/** Explicit module map, as generic T can't be resolved to a direct string literal via inference */
+type ModuleMap = {
+  '@angular/compiler': typeof import('@angular/compiler', { with: { "resolution-mode": "import" }});
+};
+
+/**
+ * Native Node dynamic import helper
+ * @remarks
+ * NB: Import this via a bare specifier (igniteui-angular/migrations/common/import-helper.cjs)
+ * to escape the schematics encapsulation for this file and thus the dynamic import inside.
+ * This allows to dynamically import ESM modules from outside the schematics host context.
+ */
+export function nativeImport<T extends keyof ModuleMap>(name: T): Promise<ModuleMap[T]> {
+    return import(name);
+};

projects/igniteui-angular/migrations/update-11_0_0/index.ts

@@ -2,15 +2,16 @@ import type { Element } from '@angular/compiler' with { "resolution-mode": "impo
 import type { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
 import { UpdateChanges } from '../common/UpdateChanges';
 import { FileChange, findElementNodes, getAttribute, getSourceOffset, hasAttribute, parseFile, serializeNodes } from '../common/util';
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 
 const version = '11.0.0';
 
 export default (): Rule => async (host: Tree, context: SchematicContext) => {
     context.logger.info(
         `Applying migration for Ignite UI for Angular to version ${version}`
     );
-    // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-    const { HtmlParser, getHtmlTagDefinition } = await import('@angular/compiler');
+    const { HtmlParser, getHtmlTagDefinition } = await nativeImport('@angular/compiler');
 
     const update = new UpdateChanges(__dirname, host, context);
 

projects/igniteui-angular/migrations/update-12_0_0/index.ts

@@ -2,6 +2,8 @@ import type { Element } from '@angular/compiler' with { "resolution-mode": "impo
 import type { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
 import { UpdateChanges } from '../common/UpdateChanges';
 import { FileChange, getAttribute, findElementNodes, getSourceOffset, hasAttribute, parseFile } from '../common/util';
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 import type { Options } from '../../schematics/interfaces/options';
 
 const version = '12.0.0';
@@ -12,8 +14,7 @@ export default (options: Options): Rule =>
             `Applying migration for Ignite UI for Angular to version ${version}`
         );
 
-        // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-        const { HtmlParser } = await import('@angular/compiler');
+        const { HtmlParser } = await nativeImport('@angular/compiler');
 
         // eslint-disable-next-line max-len
         const UPDATE_NOTE = `<!--NOTE: This component has been updated by Infragistics migration: v${version}\nPlease check your template whether all bindings/event handlers are correct.-->\n`;

projects/igniteui-angular/migrations/update-12_1_0/index.ts

@@ -5,14 +5,15 @@ import {
   FileChange, findElementNodes, getAttribute, getSourceOffset, hasAttribute, parseFile,
   serializeNodes, makeNgIf, stringifyAttributes
 } from '../common/util';
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 
 const version = '12.1.0';
 
 export default (): Rule => async (host: Tree, context: SchematicContext) => {
   context.logger.info(`Applying migration for Ignite UI for Angular to version ${version}`);
 
-  // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-  const { HtmlParser, getHtmlTagDefinition } = await import('@angular/compiler');
+  const { HtmlParser, getHtmlTagDefinition } = await nativeImport('@angular/compiler');
 
   const update = new UpdateChanges(__dirname, host, context);
   const TAGS = ['igx-grid', 'igx-tree-grid', 'igx-hierarchical-grid'];

projects/igniteui-angular/migrations/update-13_0_0/index.ts

@@ -7,6 +7,8 @@ import type {
 import type { Options } from '../../schematics/interfaces/options';
 import { UpdateChanges } from '../common/UpdateChanges';
 import { FileChange, findElementNodes, getAttribute, getSourceOffset, hasAttribute, parseFile } from '../common/util';
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 
 const version = '13.0.0';
 
@@ -25,8 +27,7 @@ export default (options: Options): Rule =>
         '[exportExcel]', 'exportExcel', '[exportExcelText]', 'exportExcelText',
         '[exportCsv]', 'exportCsv', '[exportCsvText]', 'exportCsvText', '[exportText]', 'exportText'];
         const actionsLeft = ['igx-grid-toolbar-advanced-filtering'];
-        // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-        const { HtmlParser } = await import('@angular/compiler');
+        const { HtmlParser } = await nativeImport('@angular/compiler');
 
         const moduleTsFiles = tsFiles.filter(x => x.endsWith('.module.ts'));
         for (const path of moduleTsFiles) {

projects/igniteui-angular/migrations/update-13_1_0/index.ts

@@ -4,15 +4,16 @@ import type {
   Tree
 } from '@angular-devkit/schematics';
 import type { Element } from '@angular/compiler' with { "resolution-mode": "import" };
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 import { UpdateChanges } from '../common/UpdateChanges';
 import { FileChange, findElementNodes, getAttribute, getSourceOffset, hasAttribute, parseFile } from '../common/util';
 
 const version = '13.1.0';
 
 export default (): Rule => async (host: Tree, context: SchematicContext) => {
   context.logger.info(`Applying migration for Ignite UI for Angular to version ${version}`);
-  // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-  const { HtmlParser } = await import('@angular/compiler');
+  const { HtmlParser } = await nativeImport('@angular/compiler');
 
   const update = new UpdateChanges(__dirname, host, context);
   const GRID_TAGS = ['igx-grid', 'igx-tree-grid', 'igx-hierarchical-grid', 'igx-row-island'];

projects/igniteui-angular/migrations/update-15_1_0/index.ts

@@ -4,6 +4,8 @@ import type {
     Tree
 } from '@angular-devkit/schematics';
 import type { Element } from '@angular/compiler' with { "resolution-mode": "import" };
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 import type { Options } from '../../schematics/interfaces/options';
 import { BoundPropertyObject, InputPropertyType, UpdateChanges } from '../common/UpdateChanges';
 import { FileChange, findElementNodes, getAttribute, getSourceOffset, parseFile, hasAttribute } from '../common/util';
@@ -13,8 +15,7 @@ const version = '15.1.0';
 export default (options: Options): Rule => async (host: Tree, context: SchematicContext) => {
     context.logger.info(`Applying migration for Ignite UI for Angular to version ${version}`);
 
-    // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-    const { HtmlParser } = await import('@angular/compiler');
+    const { HtmlParser } = await nativeImport('@angular/compiler');
     const update = new UpdateChanges(__dirname, host, context);
     const cardsToMigrate = new Set<any>();
     const CARD_ACTIONS = ['igx-card-actions'];

projects/igniteui-angular/migrations/update-16_1_0/index.ts

@@ -5,14 +5,15 @@ import type {
 } from '@angular-devkit/schematics';
 import { UpdateChanges } from '../common/UpdateChanges';
 import { FileChange, findElementNodes, getAttribute, getSourceOffset, hasAttribute, parseFile } from '../common/util';
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 import type { Element } from '@angular/compiler' with { "resolution-mode": "import" };
 
 const version = '16.1.0';
 
 export default (): Rule => async (host: Tree, context: SchematicContext) => {
     context.logger.info(`Applying migration for Ignite UI for Angular to version ${version}`);
-    // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-    const { HtmlParser } = await import('@angular/compiler');
+    const { HtmlParser } = await nativeImport('@angular/compiler');
     const update = new UpdateChanges(__dirname, host, context);
     update.applyChanges();
 

projects/igniteui-angular/migrations/update-17_0_0/index.ts

@@ -6,15 +6,16 @@ import type {
 import type { Element } from '@angular/compiler' with { "resolution-mode": "import" };
 import * as ts from 'typescript';
 import { UpdateChanges } from '../common/UpdateChanges';
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 import { igNamedImportFilter } from '../common/tsUtils';
 import { FileChange, findElementNodes, getAttribute, getSourceOffset, hasAttribute, parseFile } from '../common/util';
 
 const version = '17.0.0';
 
 export default (): Rule => async (host: Tree, context: SchematicContext) => {
     context.logger.info(`Applying migration for Ignite UI for Angular to version ${version}`);
-    // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-    const { HtmlParser } = await import('@angular/compiler');
+    const { HtmlParser } = await nativeImport('@angular/compiler');
     const update = new UpdateChanges(__dirname, host, context);
     const changes = new Map<string, FileChange[]>();
     const prop = ['type'];

projects/igniteui-angular/migrations/update-17_1_0/index.ts

@@ -5,14 +5,15 @@ import {
 } from '@angular-devkit/schematics';
 import { UpdateChanges } from '../common/UpdateChanges';
 import { FileChange, findElementNodes, getAttribute, getSourceOffset, hasAttribute, parseFile } from '../common/util';
+// use bare specifier to escape the schematics encapsulation for the dynamic import:
+import { nativeImport } from 'igniteui-angular/migrations/common/import-helper.cjs';
 import type { Element } from '@angular/compiler' with { "resolution-mode": "import" };
 
 const version = '17.1.0';
 
 export default (): Rule => async (host: Tree, context: SchematicContext) => {
     context.logger.info(`Applying migration for Ignite UI for Angular to version ${version}`);
-    // bare specifier escapes schematics encapsulation for the compiler dynamic import:
-    const { HtmlParser } = await import('@angular/compiler');
+    const { HtmlParser } = await nativeImport('@angular/compiler');
     const update = new UpdateChanges(__dirname, host, context);
     const changes = new Map<string, FileChange[]>();
     const tags = ['button', 'span', 'a', 'div', 'igx-prefix', 'igx-suffix']