@deviceinsight/ng-ui-components 7.24.0 → 7.25.0

package/README.md

@@ -95,9 +95,10 @@ npx yalc link "@deviceinsight/ng-ui-components"
 
 # CI
 
-`.gitlab-ci.yml` installs the dependencies and then runs `test`, `scan`, `lint` and
-`typecheck` on every branch except `main`. On `develop` the `pages` job publishes the
-static Storybook to GitLab Pages. The `publish` job runs for `develop` and for tags:
+`.gitlab-ci.yml` installs the dependencies and then runs `test`, `lint` and `typecheck`
+on every branch except `main`. The `audit` job (`npm run scan`) only runs on `develop`,
+`feature/*` and `renovate/*` branches, so hotfixes and tags are not blocked by it. On `develop` the
+`pages` job publishes the static Storybook to GitLab Pages. The `publish` job runs for `develop` and for tags:
 `-SNAPSHOT` versions are published to the internal Nexus registry under the `next`
 tag, releases go to the public npm registry. A release older than the currently
 published `latest` is published under a `hotfix-<major>.<minor>` tag so that `latest`
@@ -118,77 +119,55 @@ After git flow is installed, the repo needs to be initialized. Run `git flow ini
 question with the default (press Enter/Return). The script verifies that the branches
 are named `main` and `develop`.
 
-## Building a release
+## Releasing the develop branch
 
-To build a release of this library, execute `./release.sh`, which consists of the following steps:
+Run the release script from the repository root:
 
-### Before the release: Check for vulnerabilities and run the tests
-
-Vulnerabilities can occur at any time.
-To be sure, the pipeline for the branches and the tags created
-in the release process will not fail, the script runs the checks locally before building the
-release:
-
-```
-npm install
-npm run scan
-npm run test
+```shell
+./release.sh
 ```
 
-If `package-lock.json` changed during the install, the script commits it.
-
-### Building the release
-
-1. Switch to develop branch and make sure both main and develop are current:
-
-`git checkout develop && git pull && git fetch origin main:main`
-
-The script also aborts if the workarea is dirty or if `develop` has unpushed commits.
-
-2. Get the upcoming release from `package.json` and start the release:
-
-`git flow release start $RELEASE_VERSION`, e.g. `git flow release start 1.2.0`.
-
-3. Edit the version in `package.json`.
-
-3.1. Edit the version in `package.json`, remove the `-SNAPSHOT`.
-
-3.2. Commit `package.json`. Commit message should be `Release $RELEASE_VERSION`, e.g. `Release 1.2.0`.
-
-4. Finish the release:
-
-`git flow release finish`
-
-This will merge the release branch into the `main` branch and create a tag.
-It will also merge the release branch into the `develop` branch.
-
-After this you should be on the `develop` branch.
-
-4.1 A merge conflict might occur in `package.json` for the `version`, when main is merged into the develop branch:
-
-Resolve it by taking the version of the `develop` branch. Then run `npm install` to resolve conflicts in `package-lock.version`.
-
-Run `git status` to see if there are more conflicts. If there are, resolve them and `git add` the fixed files.
-
-If there are no more conflicts, run `git add package*` and `git commit`.
-
-5. Start a new snapshot version:
-
-5.1.
-Edit the version in `package.json`,
-increment the minor version (e.g., from `1.1.0` to `1.2.0`) and add the `-SNAPSHOT` again,
-so that the version is e.g. `1.2.0-SNAPSHOT`.
-
-5.2. Run `npm install`.
-
-5.3. Commit `package.json` and `package-lock.json`. Commit message should be `Starting $NEW_SNAPSHOT_VERSION`, e.g. `Starting 1.2.0`.
-
-6. Push the branches and the tag:
-
-On branch `develop`:
-
-`git push`
-`git checkout main`
-`git push`
-`git push --tags`
-`git checkout develop`
+Before running it, make sure the workarea is clean and all commits on `develop` are pushed; otherwise the script aborts.
+It releases the current version from `package.json` (without `-SNAPSHOT`) and afterwards starts the next minor snapshot version.
+
+## Building a hotfix for a specific version of this library
+
+When building a hotfix in `ng-ui-scale`, first check which version of this library is used on the `main` branch of `ng-ui-scale`, e.g. with `git show origin/main:package.json | grep ng-ui-components`.
+Then build the hotfix on top of exactly that version, so that no unrelated changes from newer releases end up in the `ng-ui-scale` hotfix.
+Do not use `release.sh` or `git flow hotfix` for this: `git flow hotfix finish` merges into `main`, which already contains the newer release.
+
+Example: `ng-ui-scale` uses 7.22.0 while 7.24.0 is already released (the version on `main` of this library):
+
+1. Create the branch `hotfix/7.22.1` from the tag 7.22.0:
+   ```shell
+   git fetch --tags
+   git checkout -b hotfix/7.22.1 7.22.0
+   ```
+2. Set the version in `package.json` and `package-lock.json` to 7.22.1:
+   ```shell
+   npm version 7.22.1 --no-git-tag-version
+   ```
+   If the `audit` job in `.gitlab-ci.yml` still runs on every branch except `main`, copy its `rules` from `develop`, so that the vulnerability audit does not block the hotfix pipeline.
+3. Implement or cherry-pick the changes needed for the hotfix, either directly on the hotfix branch or in a feature branch that is merged into it.
+4. Add a `## Version 7.22.1` entry to `CHANGELOG.md` describing the changes in the hotfix.
+5. Run `npm run build`, `npm test -- --run` and `npm run lint` to verify there are no errors.
+6. Commit the changes.
+7. Tag the hotfix commit and push the tag:
+   ```shell
+   git tag -a 7.22.1 -m "Hotfix 7.22.1"
+   git push origin 7.22.1
+   ```
+   The `publish` CI job builds the tag and publishes it to npm.
+   Because 7.22.1 is older than the `latest` version, it is published under the dist-tag `hotfix-7.22` and `latest` stays at 7.24.0.
+8. Merge the hotfix branch into `develop` and push `develop`:
+   ```shell
+   git checkout develop
+   git pull
+   git merge --no-ff hotfix/7.22.1
+   git push
+   ```
+   `package.json` and `package-lock.json` will conflict; keep the `-SNAPSHOT` version of `develop` and run `npm install` before committing the merge.
+   In `CHANGELOG.md`, keep the 7.22.1 entry between the entries for 7.23.0 and 7.22.0.
+   Do not merge the hotfix branch into `main`.
+9. Delete the local hotfix branch: `git branch -d hotfix/7.22.1`.
+10. Update `ng-ui-scale` on its hotfix branch to 7.22.1.

package/dist/index.cjs

@@ -6,7 +6,6 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __commonJSMin = (cb, mod) => () => (mod || (cb((mod = { exports: {} }).exports, mod), cb = null), mod.exports);
 var __copyProps = (to, from, except, desc) => {
 	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
 		key = keys[i];
@@ -73,7 +72,6 @@ let _svgdotjs_svg_js = require("@svgdotjs/svg.js");
 let highcharts = require("highcharts");
 highcharts = __toESM(highcharts, 1);
 let highcharts_react_official = require("highcharts-react-official");
-highcharts_react_official = __toESM(highcharts_react_official, 1);
 let _rc_component_slider = require("@rc-component/slider");
 _rc_component_slider = __toESM(_rc_component_slider, 1);
 let _rc_component_tooltip = require("@rc-component/tooltip");
@@ -3423,7 +3421,7 @@ var Chart = class extends react.Component {
 	render() {
 		const built = this.buildOptions();
 		const options = this.props.updateOptions ? this.props.updateOptions(built) : built;
-		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(highcharts_react_official.default, {
+		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(highcharts_react_official.HighchartsReact, {
 			highcharts: highcharts.default,
 			options,
 			containerProps: { className: this.props.className },
@@ -3433,54 +3431,15 @@ var Chart = class extends react.Component {
 };
 //#endregion
 //#region src/components/slider/RcSliderWithTooltip.tsx
-var import_raf = /* @__PURE__ */ __toESM((/* @__PURE__ */ __commonJSMin(((exports) => {
-	Object.defineProperty(exports, "__esModule", { value: true });
-	exports.default = void 0;
-	var raf = (callback) => +setTimeout(callback, 16);
-	var caf = (num) => clearTimeout(num);
-	if (typeof window !== "undefined" && "requestAnimationFrame" in window) {
-		raf = (callback) => window.requestAnimationFrame(callback);
-		caf = (handle) => window.cancelAnimationFrame(handle);
-	}
-	var rafUUID = 0;
-	var rafIds = /* @__PURE__ */ new Map();
-	function cleanup(id) {
-		rafIds.delete(id);
-	}
-	var wrapperRaf = (callback, times = 1) => {
-		rafUUID += 1;
-		const id = rafUUID;
-		function callRef(leftTimes) {
-			if (leftTimes === 0) {
-				cleanup(id);
-				callback();
-			} else {
-				const realId = raf(() => {
-					callRef(leftTimes - 1);
-				});
-				rafIds.set(id, realId);
-			}
-		}
-		callRef(times);
-		return id;
-	};
-	wrapperRaf.cancel = (id) => {
-		const realId = rafIds.get(id);
-		cleanup(id);
-		return caf(realId);
-	};
-	if (process.env.NODE_ENV !== "production") wrapperRaf.ids = () => rafIds;
-	exports.default = wrapperRaf;
-})))(), 1);
 var HandleTooltip = (props) => {
 	const { value, children, visible, tipFormatter = (val) => `${val}`, ...restProps } = props;
 	const tooltipRef = (0, react.useRef)(null);
 	const rafRef = (0, react.useRef)(null);
 	function cancelKeepAlign() {
-		if (rafRef.current) import_raf.default.cancel(rafRef.current);
+		if (rafRef.current) cancelAnimationFrame(rafRef.current);
 	}
 	function keepAlign() {
-		rafRef.current = (0, import_raf.default)(() => {
+		rafRef.current = requestAnimationFrame(() => {
 			tooltipRef.current?.forceAlign();
 		});
 	}