ag-charts-react - npm Package Compare versions

Comparing version 8.2.1 to 9.0.0

CONTRIBUTING.md

@@ -6,9 +6,9 @@ # Contributing to ag-grid-react
 
- - [Question or Problem?](#question)
- - [Issues and Bugs](#issue)
- - [Feature Requests](#feature)
- - [Submission Guidelines](#submit)
- - [Coding Rules](#rules)
- - [Commit Message Guidelines](#commit)
- - [Signing the CLA](#cla)
+-   [Question or Problem?](#question)
+-   [Issues and Bugs](#issue)
+-   [Feature Requests](#feature)
+-   [Submission Guidelines](#submit)
+-   [Coding Rules](#rules)
+-   [Commit Message Guidelines](#commit)
+-   [Signing the CLA](#cla)
 
@@ -24,2 +24,3 @@ ## <a name="question"></a> Got a Question or Problem?
 ## <a name="issue"></a> Found a Bug?
+
 If you find a bug in the source code, you can help us by
@@ -29,3 +30,4 @@ [submitting an issue](#submit-issue) to our [GitHub Repository][github].
 ## <a name="feature"></a> Missing a Feature?
-You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub
+
+You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub
 Repository.
@@ -41,5 +43,5 @@
 
-- version of React used
-- 3rd-party libraries and their versions
-- and most importantly - a use-case that fails
+-   version of React used
+-   3rd-party libraries and their versions
+-   and most importantly - a use-case that fails
 
@@ -46,0 +48,0 @@ A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. If plunker is not a suitable way to demonstrate the problem (for example for issues related to our npm packaging), please create a standalone git repository demonstrating the problem.

package.json

 {
   "name": "ag-charts-react",
-  "version": "8.2.1",
+  "version": "9.0.0",
   "description": "AG Charts React Component",
-  "main": "main.js",
-  "typings": "./main.d.ts",
-  "scripts": {
-    "clean": "rimraf lib umd .hash",
-    "build": "npx gulp",
-    "build-prod": "npm run build",
-    "umd": "npx rollup -c",
-    "test": "npx jest --passWithNoTests"
-  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "type": "module",
+  "types": "./dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ag-grid/ag-grid.git"
+    "url": "https://github.com/ag-grid/ag-charts.git"
   },
@@ -25,8 +20,8 @@ "keywords": [
   ],
-  "author": "Sean Landsman <[e-mail]>",
+  "author": "AG Grid <[e-mail]>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/ag-grid/ag-grid/issues"
+    "url": "https://github.com/ag-grid/ag-charts/issues"
   },
-  "homepage": "https://www.ag-grid.com/",
+  "homepage": "https://charts.ag-grid.com/",
   "dependencies": {
@@ -36,27 +31,11 @@ "prop-types": "^15.6.2"
   "devDependencies": {
-    "ag-charts-community": "~8.2.1",
-    "@types/jest": "^25.2.1",
-    "@types/react": "~18.0.0",
-    "@types/react-dom": "~18.0.0",
+    "ag-charts-community": "9.0.0",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
     "babel-preset-react-app": "^9.0.1",
     "enzyme": "^3.10.0",
     "enzyme-adapter-react-16": "^1.14.0",
-    "gulp": "^4.0.0",
-    "gulp-clean": "^0.4.0",
-    "gulp-header": "^2.0.0",
-    "gulp-merge": "^0.1.1",
-    "gulp-rename": "^1.4.0",
-    "gulp-sourcemaps": "^2.6.0",
-    "gulp-typescript": "^5.0.0",
-    "jest": "^25.4.0",
-    "jest-environment-jsdom-fourteen": "0.1.0",
-    "jest-watch-typeahead": "0.3.1",
     "react": "^16.9.0",
     "react-app-polyfill": "^1.0.2",
     "react-dom": "^16.9.0",
-    "rollup": "~0.67.3",
-    "rollup-plugin-commonjs": "^9.1.6",
-    "rollup-plugin-typescript": "^1.0.0",
-    "rollup-plugin-uglify": "^6.0.0",
-    "rollup-stream": "^1.24.0",
     "serialize-javascript": "2.1.0",
@@ -69,3 +48,3 @@ "tslib": "^1.10.0",
   "peerDependencies": {
-    "ag-charts-community": "~8.2.1",
+    "ag-charts-community": "9.0.0",
     "react": "^16.3.0 || ^17.0.0 || ^18.0.0",
@@ -130,2 +109,2 @@ "react-dom": "^16.3.0 || ^17.0.0 || ^18.0.0"
   }
-}
+}

README.md

@@ -1,8 +0,17 @@
-[![npm](https://img.shields.io/npm/dm/ag-charts-react.svg)](https://www.npmjs.com/package/ag-charts-react)
-[![npm](https://img.shields.io/npm/dt/ag-charts-react.svg)](https://www.npmjs.com/package/ag-charts-react)
+picture><source media="(prefers-color-scheme: dark)" srcset="./../../.github/banner-dark.png"><source media="(prefers-color-scheme: light)" srcset="./../../.github/banner-light.png"><img alt="AG Charts canvas-based charting trusted by the community, built for enterprise." src="./../../.github/banner-light.png"></picture>
 
+[![Github Stars](https://img.shields.io/github/stars/ag-grid/ag-charts?style=social)](https://github.com/ag-grid/ag-charts) [![Twitter](https://img.shields.io/twitter/follow/ag_grid?style=social)](https://twitter.com/ag_grid)
+
+| Module               |                                                                                                                                                                                                                                                                                                        Info |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| ag-charts-community  | [![npm](https://img.shields.io/npm/dm/ag-charts-community)](https://www.npmjs.com/package/ag-charts-community) <br> [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ag-charts-community&metric=alert_status)](https://sonarcloud.io/dashboard?id=ag-charts-community) <br> |
+| ag-charts-enterprise |    [![npm](https://img.shields.io/npm/dm/ag-charts-enterprise)](https://www.npmjs.com/package/ag-charts-enterprise) <br> [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ag-charts-community&metric=alert_status)](https://sonarcloud.io/dashboard?id=ag-charts-community) |
+| ag-charts-react      |                                                                                  [![npm](https://img.shields.io/npm/dm/ag-charts-react.svg)](https://www.npmjs.com/package/ag-charts-react) <br> [![npm](https://img.shields.io/npm/dt/ag-charts-react.svg)](https://www.npmjs.com/package/ag-charts-react) |
+
 # AG Charts React Community
 
-AG Charts is a fully-featured and highly customizable JavaScript charting library.
+AG Charts is a fully-featured and highly customizable JavaScript charting library. The professional choice for developers building enterprise applications
 
+It delivers [outstanding performance](https://charts.ag-grid.com/?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github), has no third-party dependencies and [integrates smoothly with all major JavaScript frameworks](https://charts.ag-grid.com/react/quick-start?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github).
+
 ## Features
@@ -12,33 +21,46 @@
 
-* modern, lightweight and performant
-* thin, easy-to-use wrappers for all popular frameworks: React, Angular, Vue
-* framework agnostic, easy to use from plain JavaScript or TypeScript
-* zero dependencies
-* support for all common chart types:
-    * Line Charts
-    * Bar/Column Charts
-    * Area Charts
-    * Scatter/Bubble Charts
-    * Pie/Doughnut Charts
-* reactive - property changes are automatically batched to take effect on next frame
-* simple, clean API
-* interactive documentation
+-   Modern, lightweight and performant
+-   Thin, easy-to-use wrappers for all popular frameworks: React, Angular, Vue
+-   Framework agnostic, easy to use from plain JavaScript or TypeScript
+-   Zero dependencies
+-   Support for many chart types:
+    -   Line
+    -   Bar
+    -   Area
+    -   Scatter
+    -   Bubble
+    -   Pie
+    -   Doughnut
+    -   Histogram
+    -   Box Plot \*
+    -   Heatmap \*
+    -   Nightingale \*
+    -   Range
+        -   Bar \*
+        -   Area \*
+    -   Radar
+        -   Area \*
+        -   Line \*
+        -   Bar \*
+        -   Column \*
+    -   Bullet \*
+-   Reactive - property changes are automatically batched to take effect on next frame
+-   Simple, clean API
+-   Interactive documentation
 
-Visit [our official docs](https://www.ag-grid.com/react-charts/overview/?utm_source=ag-charts-readme&utm_medium=repository&utm_campaign=github) for full documentation.
+\* The features marked with an asterisk are available in the [Enterprise version](https://charts.ag-grid.com/license-pricing/?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) only.
 
+Check out the [developer documentation](https://charts.ag-grid.com/react/?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) for a complete list of features or visit [our official docs](https://charts.ag-grid.com/gallery/?utm_source=ag-grid-readme&utm_medium=repository&utm_campaign=github) for tutorials and feature demos.
+
 ## Getting started
 
-### Install dependencies
+See [Get Started with React](https://charts.ag-grid.com/react/quick-start/?utm_source=ag-charts-readme&utm_medium=repository&utm_campaign=github).
 
-```sh
-$ npm install --save ag-charts-community ag-charts-react
-```
+### Installation
 
-### Usage
+See [Installation for React](https://charts.ag-grid.com/react/installation/).
 
-Please refer to our [Getting Started](https://www.ag-grid.com/react-charts/getting-started/) Tutorial.
-
 ## Issue Reporting
 
-If you have found a bug, please report them at this repository `issues` section. If you're using Enterprise version please use the [private ticketing](https://ag-grid.zendesk.com/) system to do that.
+If you have found a bug, please report it in this repository's [issues](https://github.com/ag-grid/ag-charts/issues) section. If you're using the Enterprise version, please use the [private ticketing](https://ag-grid.zendesk.com/) system to do that.
 
@@ -45,0 +67,0 @@ ## Asking Questions

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39670

increased by163.8%

Dev dependency count

14

decreased by-53.33%

Number of package files

18

increased by63.64%

Lines of code

591

increased by432.43%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

77

increased by40%

Is type module

Yes

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes