Release 8.1.0

.github/workflows/publish-sdk.yml

@@ -0,0 +1,45 @@
+name: Create Tag on Push
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22.15.0'
+          cache: 'npm'
+
+      - name: Check installed versions
+        run: |
+          node -v
+
+      - name: Clean npm cache
+        run: npm cache clean --force
+
+      - name: Install dependencies
+        run: |
+          if [ ! -d "node_modules" ]; then
+            npm ci
+          fi
+
+      - name: Build and Pack
+        run: |
+          npm run build-mobile
+          npm pack ./dist/common-form-elements
+
+      - name: Publish to NPM
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}" > ~/.npmrc
+          npm publish project-sunbird-common-form-elements-*

.github/workflows/pull_request.yml

@@ -0,0 +1,46 @@
+name: Code Quality Checks
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  code-quality:
+    name: Run Code Quality Checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22.15.0'
+
+      - name: Restore node_modules cache
+        id: cache
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-modules-
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Save node_modules cache
+        if: steps.cache.outputs.cache-hit != 'true'
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run test
+        run: npm run test -- --no-watch --no-progress --browsers=ChromeHeadlessCI
+

.gitignore

@@ -29,6 +29,7 @@ speed-measure-plugin.json
 !.vscode/extensions.json
 
 # misc
+/.angular/cache
 /.sass-cache
 /connect.lock
 /coverage

README.md

@@ -1,8 +1,42 @@
-# SunbirdEdForms
+# Sunbird-ED Forms
 
 Contains  Form component powered by angular. This component expects a configuration and renders form according to the view.
 
-# Getting Started
+<p>
+  <img alt="angular" src="https://img.shields.io/badge/-Angular-DD0031?style=flat-square&logo=angular&logoColor=white" height=25 />
+  <img alt="TypeScript" src="https://img.shields.io/badge/-TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white" height=25 />
+</p>
+
+---
+## Getting started
+How to use @project-sunbird/common-form-elements in your projects
+
+## Table of Contents
+
+- [Using library locally](#using-library-locally)
+- [Step 1: Install the package](#step-1-install-the-package)
+- [Step 2: Include the library selector in view( Eg .HTML file)](#step-2-include-the-library-selector-in-view-eg-html-file)
+- [Step 3: Form component emits values on every input , To get value include event callbacks](#step-3-form-component-emits-values-on-every-input--to-get-value-include-event-callbacks)
+- [Steps to Integrate the form](#steps-to-integrate-the-form)
+- [Versions](#versions)
+---
+
+## Using library locally 
+
+1. Build library
+```console
+npm run build-lib
+```
+2. link library
+   -> cd dist/common-form-elements
+```console
+npm link
+```
+3. Link the library to your project
+```console
+npm link @project-sunbird/common-form-elements
+```
+---
 
 ## Step 1: Install the package
 
@@ -12,7 +46,7 @@ Contains  Form component powered by angular. This component expects a configurat
 
    <sb-form [config]='config'></sb-form>
 
-## step3: Form component emits values on every input , To get value include event callbacks
+## Step 3: Form component emits values on every input , To get value include event callbacks
 
   <sb-form (valueChanges)="function($event)" (statusChanges)="function($event)" ></sb-form>
 
@@ -84,8 +118,50 @@ functionName(config: FieldConfig<any>, initial = false): FieldConfigOptionsBuild
 
 
 ## Versions
-|   release branch  | npm package version | Angular Version |
+|   Release branch  | npm package version | Angular Version |
 |:-----------------:|:-------------------:|:---------------:|
 | release-5.0.1     |        5.0.1        |      Ng V9      |
 | release-5.1.0_v10 |        5.1.0        |      Ng V10     |
-| release-5.1.0_v11 |        5.1.1        |      Ng V11     |
+| release-5.1.0_v11 |        5.1.1        |      Ng V11     |
+| release-5.1.0_v12 |        5.1.2        |      Ng V12     |
+| release-6.0.0_v13 |        6.0.0        |      Ng V13     |
+| release-6.0.0_v14 |  6.0.1/6.0.2/6.0.3  |      Ng V14     |
+|     8.0.0_v15     |        8.0.0        |      Ng V15     |
+|     8.0.0_v16     |        8.0.1        |      Ng V16     |
+
+
+## Code Quality
+
+The project maintains code quality through automated checks that run on every pull request:
+
+1. **Linting**
+   - ESLint for code style and quality
+   - Command: `npm run lint`
+
+2. **Dependencies**
+   - Uses `npm ci` for deterministic installations
+   - GitHub Actions cache for faster builds (e.g., `node_modules`). See [GitHub Actions workflow](.github/workflows/pull_request.yml) for caching configuration details.
+
+3. **Code Formatting**
+   - Ensures consistent code formatting
+   - Can be automatically fixed using `npm run lint:fix`
+
+4. **Testing**
+   - Unit tests using Karma
+   - Command: `npm run test`
+
+These checks ensure consistent code style, secure dependency management, and reliable testing.
+
+## Package Publishing
+
+Workflow automatically builds and publishes NPM packages whenever a new tag is pushed to the repository.
+
+### Publish Workflow
+
+The workflow is triggered on:
+- Triggered on push events for any Git tag
+
+Key features of the workflow:
+1. Automatically builds the project
+2. Creates NPM package
+3. Publishes to NPM registry using NPM authentication token (must be provided as GitHub secret `NPM_TOKEN`)

angular.json

@@ -18,8 +18,10 @@
         ,          "configurations": {
             "production": {
               "tsConfig": "projects/common-form-elements/tsconfig.lib.prod.json"
-            }
-          }
+            },
+            "development": {}
+          },
+          "defaultConfiguration": "production"
 },
         "test": {
           "builder": "@angular-devkit/build-angular:karma",
@@ -30,23 +32,21 @@
           }
         },
         "lint": {
-          "builder": "@angular-devkit/build-angular:tslint",
+          "builder": "@angular-eslint/builder:lint",
           "options": {
-            "tsConfig": [
-              "projects/common-form-elements/tsconfig.lib.json",
-              "projects/common-form-elements/tsconfig.spec.json"
+            "lintFilePatterns": [
+              "projects/common-form-elements/**/*.ts",
+              "projects/common-form-elements/**/*.html"
             ],
-            "exclude": [
-              "**/node_modules/**"
-            ]
+            "eslintConfig": "projects/common-form-elements/eslint.config.js"
           }
         }
       }
     },
     "sunbird-forms": {
       "projectType": "application",
       "schematics": {},
-      "root": "src/sunbird-forms",
+      "root": "",
       "sourceRoot": "src",
       "prefix": "app",
       "architect": {
@@ -58,7 +58,6 @@
             "main": "src/main.ts",
             "polyfills": "src/polyfills.ts",
             "tsConfig": "src/tsconfig.app.json",
-            "aot": true,
             "assets": [
               "src/favicon.ico",
               "src/assets"
@@ -75,7 +74,13 @@
               "src/assets/libs/transition.min.js",
               "src/assets/libs/modal.min.js",
               "src/assets/libs/semantic-ui-tree-picker.js"
-            ]
+            ],
+            "vendorChunk": true,
+            "extractLicenses": false,
+            "buildOptimizer": false,
+            "sourceMap": true,
+            "optimization": false,
+            "namedChunks": true
           },
           "configurations": {
             "production": {
@@ -88,7 +93,6 @@
               "optimization": true,
               "outputHashing": "all",
               "sourceMap": false,
-              "extractCss": true,
               "namedChunks": false,
               "extractLicenses": true,
               "vendorChunk": false,
@@ -105,19 +109,24 @@
                   "maximumError": "10kb"
                 }
               ]
-            }
-          }
+            },
+            "development": {}
+          },
+          "defaultConfiguration": "production"
         },
         "serve": {
           "builder": "@angular-devkit/build-angular:dev-server",
           "options": {
-            "browserTarget": "sunbird-forms:build"
           },
           "configurations": {
             "production": {
               "browserTarget": "sunbird-forms:build:production"
+            },
+            "development": {
+              "browserTarget": "sunbird-forms:build:development"
             }
-          }
+          },
+          "defaultConfiguration": "development"
         },
         "extract-i18n": {
           "builder": "@angular-devkit/build-angular:extract-i18n",
@@ -128,5 +137,10 @@
       }
     }
   },
-  "defaultProject": "common-form-elements"
+  "cli": {
+    "analytics": false,
+    "schematicCollections": [
+      "angular-eslint"
+    ]
+  }
 }

build-mobile.js

@@ -3,6 +3,13 @@ const inquirer = require('inquirer');
 const chalk = require('chalk');
 const { spawn } = require("child_process");
 const packageFilepath = "projects/common-form-elements/package.json";
+
+const getVersion = () => {
+    const packageJson = fs.readFileSync(packageFilepath);
+    const { version } = JSON.parse(packageJson);
+    return version;
+};
+
 const filesToRemoveLines = [
     {
         filepath: "projects/common-form-elements/src/lib/dynamic-field/dynamic-field.directive.ts",
@@ -20,14 +27,14 @@ const run = async () => {
         const answers = {
             environment: 'mobile',
             name: '@project-sunbird/common-form-elements',
-            version: '5.1.1'
-          }
+            version: getVersion()
+        };
         const { environment } = answers;
         console.log(answers);
         updateFiles(environment);
         updatePackageFile(packageFilepath, answers);
         console.log(chalk.bgBlue(' =========== Building Angular Package ==========='));
-        const child = spawn('ng', ['build', 'common-form-elements', '--prod']);
+        const child = spawn('ng', ['build', 'common-form-elements']);
         child.stdout.on('data', (data) => {
             console.log(chalk.green(`${data}`));
         });