feat(*): add Angular Elements setup for wrapping grid components (#14421)

Co-authored-by: gmurray81 <[email protected]>
Co-authored-by: Robert Stoffers <[email protected]>
Co-authored-by: Konstantin Dinev <[email protected]>
Co-authored-by: Radoslav Karaivanov <[email protected]>
Co-authored-by: Maya <[email protected]>
Co-authored-by: skrustev <[email protected]>
Co-authored-by: Martin Dragnev <[email protected]>
Co-authored-by: Deyan Kamburov <[email protected]>
Co-authored-by: IMinchev <[email protected]>
Co-authored-by: Tihomir Tonev <[email protected]>

Author: 11 people

.github/workflows/nodejs.yml

@@ -56,6 +56,16 @@ jobs:
         run: |
             npm run build:i18n
             npm run test:i18n:dist
+      - name: Build Elements
+        run: npm run elements:configure && npm run build:elements
+      - name: Check for Elements config changes
+        run: |
+            if [ -n "$(git status --porcelain -- projects/igniteui-angular-elements/**/elements.config.ts)" ]; then
+                echo "Error: There are changes to the Elements config. Run 'npm run elements:configure' and commit." >&2
+                exit 1
+            fi
+      - name: Test Elements
+        run: npm run test:elements
       - name: Bundle Tree-Shake & SSR Test
         run: npm run build:bundletest
       - name: Publish to coveralls.io

angular.json

@@ -240,6 +240,129 @@
         }
       }
     },
+    "igniteui-angular-elements": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        },
+        "@schematics/angular:application": {
+          "strict": true
+        }
+      },
+      "root": "projects/igniteui-angular-elements",
+      "sourceRoot": "projects/igniteui-angular-elements/src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:application",
+          "options": {
+            "outputPath": {
+              "base": "dist/igniteui-angular-elements"
+            },
+            "index": "projects/igniteui-angular-elements/src/index.html",
+            "polyfills": [
+              "projects/igniteui-angular-elements/src/polyfills.ts"
+            ],
+            "tsConfig": "projects/igniteui-angular-elements/tsconfig.app.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "projects/igniteui-angular-elements/src/favicon.ico",
+              "projects/igniteui-angular-elements/src/assets",
+              "projects/igniteui-angular-elements/src/index.js"
+            ],
+            "styles": [
+              "projects/igniteui-angular-elements/src/styles.scss"
+            ],
+            "scripts": [
+                { "input": "./node_modules/lit-html/lit-html.js", "inject": false },
+                { "input": "./node_modules/lit-html/development/directive.js", "inject": false }
+            ],
+            "stylePreprocessorOptions": {
+                "includePaths": ["node_modules"]
+            },
+            "browser": "projects/igniteui-angular-elements/src/main.ts"
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "allScript",
+                  "maximumWarning": "2.1mb",
+                  "maximumError": "2.5mb"
+                },
+                {
+                  "type": "bundle",
+                  "name": "styles",
+                  "maximumWarning": "450kb",
+                  "maximumError": "480kb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "fileReplacements": [
+                {
+                  "replace": "projects/igniteui-angular-elements/src/environments/environment.ts",
+                  "with": "projects/igniteui-angular-elements/src/environments/environment.prod.ts"
+                }
+              ],
+              "outputHashing": "none",
+              "optimization": true,
+              "externalDependencies": ["lit-html"]
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true,
+              "namedChunks": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "configurations": {
+            "production": {
+              "buildTarget": "igniteui-angular-elements:build:production"
+            },
+            "development": {
+              "buildTarget": "igniteui-angular-elements:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "buildTarget": "igniteui-angular-elements:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/igniteui-angular-elements/src/test.ts",
+            "polyfills": "projects/igniteui-angular-elements/src/polyfills.ts",
+            "tsConfig": "projects/igniteui-angular-elements/tsconfig.spec.json",
+            "karmaConfig": "projects/igniteui-angular-elements/karma.conf.js",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "projects/igniteui-angular-elements/src/favicon.ico",
+              "projects/igniteui-angular-elements/src/assets"
+            ],
+            "styles": [
+              "projects/igniteui-angular-elements/src/styles.scss"
+            ],
+            "stylePreprocessorOptions": {
+                "includePaths": ["node_modules"]
+            },
+            "scripts": []
+          }
+        }
+      }
+    },
     "bundle-test": {
       "projectType": "application",
       "schematics": {

gulpfile.js

@@ -174,3 +174,9 @@ module.exports.sassdocImportJson = sassdocImportJson;
 module.exports.sassdocBuildJson = sassdocBuildJson;
 module.exports.sassdocBuildJA = series(sassdocCleanOutputDir, sassdocBuildJA);
 module.exports.sassdocBuildEN = series(sassdocCleanOutputDir, sassdocBuildEN);
+
+module.exports.copyPackageForElements = (cb) => {
+    return gulp.src([
+        path.join(__dirname, 'projects/igniteui-angular-elements/package.json')
+    ]).pipe(gulp.dest(path.join(__dirname, 'dist/igniteui-angular-elements/browser')));
+};

package-lock.json

@@ -4,6 +4,7 @@
   "scripts": {
     "ng": "ng",
     "start": "ng serve --open --hmr",
+    "start:elements": "ng serve --project igniteui-angular-elements",
     "build": "ng build --configuration production",
     "test": "ng test igniteui-angular",
     "lint": "ng lint",
@@ -25,6 +26,8 @@
     "test:schematics": "ts-node --project projects/igniteui-angular/migrations/tsconfig.json ./node_modules/jasmine/bin/jasmine.js ./projects/igniteui-angular/migrations/**/*.spec.ts ./projects/igniteui-angular/schematics/**/*.spec.ts",
     "test:styles": "ts-node --skip-project ./node_modules/jasmine/bin/jasmine.js ./projects/igniteui-angular/src/lib/core/styles/spec/tests.ts",
     "test:i18n": "ts-node --skip-project ./projects/igniteui-angular/src/lib/core/i18n/tests/tests.ts",
+    "test:elements": "ng test igniteui-angular-elements --watch=false --no-progress --code-coverage --source-map=false",
+    "test:elements:watch": "ng test igniteui-angular-elements",
     "build:lib": "ng build igniteui-angular --configuration production && npm run build:styles",
     "build:styles": "node scripts/build-styles.mjs",
     "build:migrations": "gulp copyMigrations && tsc --listEmittedFiles --project ./projects/igniteui-angular/migrations/tsconfig.json",
@@ -50,6 +53,10 @@
     "build:bundletest": "ng build bundle-test --configuration production",
     "lint:i18n": "eslint projects/igniteui-angular-i18n/src/**/*.ts",
     "test:i18n:dist": "eslint -c projects/igniteui-angular-i18n/.eslintrc.dist.i18n.json dist/igniteui-angular-i18n/**/*.d.ts --no-eslintrc",
+    "build:elements": "ng build igniteui-angular-elements && npm run pack:elements && gulp copyPackageForElements",
+    "pack:elements": "node projects/igniteui-angular-elements/esbuild.mjs && node scripts/build-elements-styles.mjs",
+    "elements:configure": "ts-node -T -H --skip-project --compilerOptions {\\\"moduleResolution\\\":\\\"NodeNext\\\"} ./projects/igniteui-angular-elements/src/analyzer/analyzer.ts",
+    "test:elements:configure": "ts-node --skip-project ./node_modules/jasmine/bin/jasmine.js --config=projects/igniteui-angular-elements/jasmine.json",
     "postinstall": "gulp copyGitHooks",
     "cypress:open": "cypress open --config-file=cypress.config.ts",
     "cypress:run": "cypress run --config-file=cypress.config.ts",
@@ -61,13 +68,15 @@
     "@angular/common": "^18.0.1",
     "@angular/compiler": "^18.0.1",
     "@angular/core": "^18.0.1",
+    "@angular/elements": "^18.0.1",
     "@angular/forms": "^18.0.1",
     "@angular/platform-browser": "^18.0.1",
     "@angular/platform-browser-dynamic": "^18.0.1",
     "@angular/platform-server": "^18.0.1",
     "@angular/router": "^18.0.1",
     "@angular/ssr": "^18.0.2",
     "@igniteui/material-icons-extended": "^3.0.0",
+    "@lit-labs/ssr-dom-shim": "^1.2.0",
     "@types/source-map": "0.5.2",
     "express": "^4.19.2",
     "fflate": "^0.8.1",
@@ -128,6 +137,7 @@
     "karma-junit-reporter": "^2.0.1",
     "karma-parallel": "^0.3.1",
     "karma-spec-reporter": "^0.0.36",
+    "lit-html": "^3.1.2",
     "ng-packagr": "^18.0.0",
     "postcss": "^8.4.31",
     "postcss-scss": "^4.0.6",