@oncehub/knowledgeowl-angular 4.1.11 → 5.0.0-beta.2

package/.eslintrc.json

@@ -0,0 +1,82 @@
+{
+  "root": true,
+  "ignorePatterns": [
+    "projects/**/*"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.ts"
+      ],
+      "parserOptions": {
+        "project": [
+          "tsconfig.json"
+        ],
+        "createDefaultProgram": true
+      },
+      "extends": [
+        "plugin:@angular-eslint/recommended",
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "plugin:@angular-eslint/template/process-inline-templates"
+      ],
+      "rules": {
+        "@angular-eslint/component-class-suffix": "off",
+        "@angular-eslint/directive-class-suffix": "off",
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": [
+              "knowledge"
+            ],
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "prefix": [
+              "knowledge"
+            ]
+          }
+        ],
+        "@typescript-eslint/consistent-type-definitions": "error",
+        "@typescript-eslint/dot-notation": "off",
+        "@typescript-eslint/no-floating-promises": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-member-access": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/member-ordering": "off",
+        "@typescript-eslint/explicit-member-accessibility": [
+          "off",
+          {
+            "accessibility": "explicit"
+          }
+        ],
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-use-before-define": "off",
+        "brace-style": [
+          "error",
+          "1tbs"
+        ],
+        "complexity": "error",
+        "id-blacklist": "off",
+        "id-match": "off",
+        "no-underscore-dangle": "off",
+        "no-useless-escape": "off"
+      }
+    },
+    {
+      "files": [
+        "*.html"
+      ],
+      "extends": [
+        "plugin:@angular-eslint/template/recommended"
+      ],
+      "rules": {}
+    }
+  ]
+}

package/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['main']
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm test

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: 'CodeQL'
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: '42 2 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['javascript']
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,23 @@
+# This workflow will publish a package to npm when a release is published
+# For more information, see https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run package
+      # scoped packages are private by default so need to add public flag
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.prettierignore

@@ -0,0 +1,2 @@
+package.json
+dist

package/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

package/CHANGELOG.md

@@ -0,0 +1,257 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [4.1.4] - 2024-02-01
+
+- [ONCEHUB-77374](https://scheduleonce.atlassian.net/browse/ONCEHUB-77374) fixed vulnerability found in package vite
+
+## [4.1.3] - 2023-09-29
+
+- [ONCEHUB-65303](https://scheduleonce.atlassian.net/browse/ONCEHUB-65303) Final upgrade to Angular version 16 on knowledge-owl
+
+## [4.1.3-beta.0] - 2023-07-14
+
+- [ONCEHUB-65303] Upgrade Angular app to version 16 on knowledge-owl
+
+## [4.1.2-beta.0] - 2023-06-16
+
+- [ONCEHUB-65303] Upgrade Angular app to version 15 on knowledge-owl
+
+## [4.1.1] - 2023-06-14
+
+- [ONCEHUB-62023] engine.io, socket.io, socket.io-parser vulnerability has been fixed in project knowledgeowl-angular
+
+## [4.0.9] - 2023-01-04
+
+- [ONCEHUB-62023](https://scheduleonce.atlassian.net/browse/ONCEHUB-62023): CVE-2022-46175 vulnerability found in package json5 in project knowledgeowl-angular
+
+## [4.0.8] - 2022-12-13
+
+- [ONCEHUB-60847](https://scheduleonce.atlassian.net/browse/ONCEHUB-60847): CVE-2022-38900 vulnerability found in package decode-uri-component
+
+## [4.0.7] - 2022-11-22
+
+### Updated
+
+- [ONCEHUB-60383](https://scheduleonce.atlassian.net/browse/ONCEHUB-60383): CVE-2022-37603 vulnerability found in package loader-utils
+- [ONCEHUB-60450](https://scheduleonce.atlassian.net/browse/ONCEHUB-60450): CVE-2022-41940 vulnerability found in package engine.io
+
+## [4.0.6] - 2022-11-09
+
+### Updated
+
+- Fixed loader-utils vulnerability.
+
+## [4.0.5] - 2022-10-31
+
+### Updated
+
+- Fixed socket.io-parser vulnerability.
+
+## [4.0.4] - 2022-07-21
+
+### Updated
+
+- Updated @angular-devkit/build-angular packges to v13 latest.
+
+## [4.0.3] - 2022-07-06
+
+### Added
+
+- Added readme documentation on NPM.
+
+## [4.0.2] - 2022-04-28
+
+### Added
+
+- NA
+
+### Changed
+
+- NA
+
+### Removed
+
+- NA
+
+### Fixed
+
+- Vulnerability fixes [ONCEHUB-53689](https://scheduleonce.atlassian.net/browse/ONCEHUB-53689)
+
+## [4.0.0] - 2022-03-01
+
+### Added
+
+- NA
+
+### Changed
+
+- Updated project knowledgeowl-angular to use Angular 13
+
+### Removed
+
+- NA
+
+### Fixed
+
+- NA
+
+## [3.0.2] - 2022-02-07
+
+### Added
+
+- NA
+
+### Changed
+
+- NA
+
+### Removed
+
+- NA
+
+### Fixed
+
+- [`ONCEHUB-50833`](https://scheduleonce.atlassian.net/browse/ONCEHUB-50833) Fixed package vulnerabilities
+- [`ONCEHUB-50603`](https://scheduleonce.atlassian.net/browse/ONCEHUB-50603) Fixed package vulnerabilities
+- [`ONCEHUB-47262`](https://scheduleonce.atlassian.net/browse/ONCEHUB-47262) Fixed package vulnerabilities
+
+## [3.0.1] - 2022-01-24
+
+### Added
+
+- NA
+
+### Changed
+
+- NA
+
+### Removed
+
+- NA
+
+### Fixed
+
+- [`ONCEHUB-50115`](https://scheduleonce.atlassian.net/browse/ONCEHUB-50115) Fixed package vulnerabilities
+- [`ONCEHUB-50604`](https://scheduleonce.atlassian.net/browse/ONCEHUB-50604) Fixed package vulnerabilities
+- [`ONCEHUB-50609`](https://scheduleonce.atlassian.net/browse/ONCEHUB-50609) Fixed package vulnerabilities
+- [`ONCEHUB-50641`](https://scheduleonce.atlassian.net/browse/ONCEHUB-50641) Fixed package vulnerabilities
+- [`ONCEHUB-50756`](https://scheduleonce.atlassian.net/browse/ONCEHUB-50756) Fixed package vulnerabilities
+
+## [2.0.4] - 2021-06-23
+
+### Added
+
+- NA
+
+### Changed
+
+- NA
+
+### Removed
+
+- NA
+
+### Fixed
+
+- [`ONCEHUB-43676`](https://scheduleonce.atlassian.net/browse/ONCEHUB-43676) Fixed package vulnerabilities
+- [`ONCEHUB-42560`](https://scheduleonce.atlassian.net/browse/ONCEHUB-42560) Fixed package vulnerabilities
+- [`ONCEHUB-42564`](https://scheduleonce.atlassian.net/browse/ONCEHUB-42564) Fixed package vulnerabilities
+- [`ONCEHUB-43237`](https://scheduleonce.atlassian.net/browse/ONCEHUB-43237) Fixed package vulnerabilities
+
+## [2.0.1] - 2021-04-16
+
+### Added
+
+- NA
+
+### Changed
+
+- NA
+
+### Removed
+
+- NA
+
+### Fixed
+
+- [`ONCEHUB-40864`](https://scheduleonce.atlassian.net/browse/ONCEHUB-40864) Fixed package vulnerabilities for ssri
+
+## [1.0.0] - 2020-09-15
+
+### Added
+
+- NA
+
+### Changed
+
+- Updated project knowledgeowl-angular to use Angular 9
+
+### Removed
+
+- NA
+
+### Fixed
+
+- [`ONCEHUB-32452`](https://scheduleonce.atlassian.net/browse/ONCEHUB-32452) Fixed package vulnerabilities for npm-registry-fetch
+
+## [0.1.9] - 2020-07-07
+
+### Added
+
+- NA
+
+### Changed
+
+- NA
+
+### Removed
+
+- NA
+
+### Fixed
+
+- [`ONCEHUB-32349`](https://scheduleonce.atlassian.net/browse/ONCEHUB-32349) Fixed package vulnerabilities
+
+## [0.1.8] - 2019-09-02
+
+### Added
+
+- NA
+
+### Changed
+
+- Converted knowledgeOwlLink component into directive [`ONCEHUB-16716`](https://scheduleonce.atlassian.net/browse/ONCEHUB-16716)
+
+### Removed
+
+- NA
+
+### Fixed
+
+-NA
+
+## [0.1.7] - 2019-08-20
+
+### Added
+
+- NA
+
+### Changed
+
+- NA
+
+### Removed
+
+- NA
+
+### Fixed
+
+Dependency upgrades
+
+- [`ONCEHUB-15146`](https://scheduleonce.atlassian.net/browse/ONCEHUB-15146)
+- [`ONCEHUB-15340`](https://scheduleonce.atlassian.net/browse/ONCEHUB-15340)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Oncehub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/OWNERS

@@ -0,0 +1,4 @@
+approvers:
+- developers
+reviewers:
+- developers

package/OWNERS_ALIASES

@@ -0,0 +1,20 @@
+aliases:
+  developers:
+    - mderazon
+    - so-abahadur
+    - amanpreetSO
+    - AmitPandeyScheduleonce
+    - ashishsatiSO
+    - SO-ashusrivastava
+    - BharatSinghoh
+    - giladgoraly
+    - sohimanshu
+    - so-kaushal
+    - nalingarg
+    - so-sdhawan
+    - ShivamKe
+    - ushankar208
+    - vaibhavso
+    - vinaykumar01
+    - SoniRani
+    - ryadavso

package/README.md

@@ -1,8 +1,10 @@
 # knowledgeowl-angular
 
-[![Build status](https://github.com/scheduleonce/knowledgeowl-angular/actions/workflows/node.js.yml/badge.svg)](https://github.com/scheduleonce/knowledgeowl-angular/actions)
+[![Build status](https://github.com/scheduleonce/knowledgeowl-angular/actions/workflows/node.js.yml/badge.svg)](https://github.com/scheduleonce/relative-luminance/actions) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 
-Project that enables angular application to integrate KnowledgeOwl widget. This gives following features:
+> KnowledgeOwl knowledgebase for Angular
+
+Project that enables Angular applications to integrate [KnowledgeOwl](https://www.knowledgeowl.com) widget. This gives following features:
 
 1. Integrate KnowledgeOwl angular widget into application.
 2. Link HTML element to KnowledgeOwl article.
@@ -33,7 +35,7 @@ export class AppModule { }
 
 Add widget in app.component.html
 
-```sh
+```tsx
 <knowledge-owl-widget
     [projectKey]="'projectKeyProvidedByKnowledgeOwl'"
 ></knowledge-owl-widget>
@@ -41,7 +43,7 @@ Add widget in app.component.html
 
 ## How to link article to `<a>` or `button`?
 
-```sh
+```tsx
 <a knowledgeOwlLink="test-article"></a>
 ```
 
@@ -64,7 +66,7 @@ Exported as: `knowledgeOwlWidget`
 
 The widget exposes an API to open/close programmatically.
 
-```sh
+```ts
 class MyComponent {
   @ViewChild(KnowledgeOwlWidget) widget: KnowledgeOwlWidget;
 
@@ -78,7 +80,7 @@ class MyComponent {
 
 The widget exposes an API to open/close widget with article programmatically.
 
-```sh
+```ts
 class MyComponent {
   @ViewChild(KnowledgeOwlWidget) widget: KnowledgeOwlWidget;
 
@@ -102,10 +104,14 @@ Exported as: `knowledgeOwlLink`
 | ---------------------------------------- | -------- | ------------------------- |
 | @Input() <br/>`knowledgeOwlLink: string` | true     | KnowledgeOwl Article Name |
 
-### Development
+## Development
+
+### How to publish a new version
 
-Package is automatically pushed to npm when [creating a new release](.github/workflows/npm-publish.yml) on Github. Check out the release section in the repo. Read more about releases [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
+Create a new version
 
-### License
+```sh
+npm version [<new_version> | major | minor | patch]
+```
 
-This module is licensed under the MIT License. See the LICENSE file for details.
+New version is automatically published to npm when [creating a new release](.github/workflows/npm-publish.yml) on Github. Check out the release section in the repo. Read more about releases [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).

package/angular.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "cli": {
+    "analytics": "47c16505-5eb3-4e8a-a186-dc68f7f3ea3b"
+  },
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "knowledgeowl-angular": {
+      "root": "",
+      "sourceRoot": "src",
+      "projectType": "library",
+      "prefix": "",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:ng-packagr",
+          "options": {
+            "tsConfig": "src/tsconfig.lib.json",
+            "project": "src/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "test/test.ts",
+            "tsConfig": "src/tsconfig.spec.json",
+            "karmaConfig": "test/karma.conf.js"
+          }
+        },
+        "lint": {
+          "builder": "@angular-eslint/builder:lint",
+          "options": {
+            "lintFilePatterns": [
+              "src/**/*.ts",
+              "src/**/*.html"
+            ]
+          }
+        }
+      }
+    }
+  },
+  "schematics": {
+    "@angular-eslint/schematics:application": {
+      "setParserOptionsProject": true
+    },
+    "@angular-eslint/schematics:library": {
+      "setParserOptionsProject": true
+    }
+  }
+}