chartjs-plugin-streaming-react 2.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2021 Akihiko Kusanagi
+
+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/README.md

@@ -0,0 +1,49 @@
+<p align="center">
+  <img src="docs/.vuepress/public/logo.svg" style="width: 300px;">
+</p>
+
+# chartjs-plugin-streaming
+
+[![npm](https://img.shields.io/npm/v/chartjs-plugin-streaming.svg?style=flat-square)](https://npmjs.com/package/chartjs-plugin-streaming) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/nagix/chartjs-plugin-streaming/CI?style=flat-square)](https://github.com/nagix/chartjs-plugin-streaming/actions?query=workflow%3ACI+branch%3Amaster) [![Code Climate](https://img.shields.io/codeclimate/maintainability/nagix/chartjs-plugin-streaming.svg?style=flat-square)](https://codeclimate.com/github/nagix/chartjs-plugin-streaming) [![Awesome](https://awesome.re/badge-flat2.svg)](https://github.com/chartjs/awesome)
+
+*[Chart.js](https://www.chartjs.org) plugin for live streaming data*
+
+chartjs-plugin-streaming 2.x requires Chart.js 3.0.0 or later. If you need Chart.js 2.x support, use the following versions.
+
+- For Chart.js 2.9.x, 2.8.x or 2.7.x, use [version 1.9.0](https://github.com/nagix/chartjs-plugin-streaming/releases/tag/v1.9.0) ([tutorials](https://nagix.github.io/chartjs-plugin-streaming/1.9.0/) and [samples](https://nagix.github.io/chartjs-plugin-streaming/1.9.0/samples/))
+- For Chart.js 2.6.x, use [version 1.2.0](https://github.com/nagix/chartjs-plugin-streaming/releases/tag/v1.2.0)
+
+## Documentation
+
+- [Introduction](https://nagix.github.io/chartjs-plugin-streaming/master/guide/)
+- [Getting Started](https://nagix.github.io/chartjs-plugin-streaming/master/guide/getting-started.html)
+- [Options](https://nagix.github.io/chartjs-plugin-streaming/master/guide/options.html)
+- [Data Feed Models](https://nagix.github.io/chartjs-plugin-streaming/master/guide/data-feed-models.html)
+- [Integration](https://nagix.github.io/chartjs-plugin-streaming/master/guide/integration.html)
+- [Performance](https://nagix.github.io/chartjs-plugin-streaming/master/guide/performance.html)
+- [Migration](https://nagix.github.io/chartjs-plugin-streaming/master/guide/migration.html)
+- [Tutorials](https://nagix.github.io/chartjs-plugin-streaming/master/tutorials/)
+- [Samples](https://nagix.github.io/chartjs-plugin-streaming/master/samples/)
+
+## Development
+
+You first need to install node dependencies (requires [Node.js](https://nodejs.org/)):
+
+```bash
+npm install
+```
+
+The following commands will then be available from the repository root:
+
+```bash
+npm run build      # build dist files
+npm run build:dev  # build and watch for changes
+npm run lint       # perform code linting
+npm run package    # create an archive with dist files
+npm run docs       # generate documentation (`dist/docs`)
+npm run docs:dev   # generate documentation and watch for changes
+```
+
+## License
+
+chartjs-plugin-streaming is available under the [MIT license](https://opensource.org/licenses/MIT).

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "chartjs-plugin-streaming-react",
+  "homepage": "https://github.com/NotPunchnox/chartjs-plugin-streaming-react",
+  "description": "Chart.js plugin for live streaming data",
+  "author": "punchnox <punchnoxpro@gmail.com>",
+  "version": "2.0.1",
+  "license": "MIT",
+  "jsdelivr": "dist/chartjs-plugin-streaming.min.js",
+  "unpkg": "dist/chartjs-plugin-streaming.min.js",
+  "main": "dist/chartjs-plugin-streaming.js",
+  "module": "dist/chartjs-plugin-streaming.esm.js",
+  "types": "types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/NotPunchnox/chartjs-plugin-streaming-react.git"
+  },
+  "bugs": {
+    "url": "https://github.com/NotPunchnox/chartjs-plugin-streaming-react/issues"
+  },
+  "keywords": [
+    "chart.js",
+    "plugin",
+    "live",
+    "streaming",
+    "scroll"
+  ],
+  "files": [
+    "bower.json",
+    "dist/*.js",
+    "types/*.d.ts"
+  ],
+  "directories": {
+    "doc": "docs",
+    "test": "test"
+  },
+  "scripts": {
+    "bower": "node scripts/create-bower-json",
+    "build": "rollup -c",
+    "build:dev": "rollup -c --watch",
+    "docs": "npm run build && vuepress build docs --no-cache",
+    "docs:dev": "npm run build && vuepress dev docs --no-cache",
+    "lint-js": "eslint \"**/*.js\"",
+    "lint-md": "eslint \"**/*.md\"",
+    "lint-types": "eslint \"types/**/*.ts\"",
+    "lint": "concurrently \"npm:lint-*\"",
+    "package": "npm run build && node scripts/create-packages"
+  },
+  "devDependencies": {
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.0",
+    "@simonbrunel/vuepress-plugin-versions": "^0.2.0",
+    "@typescript-eslint/eslint-plugin": "^4.27.0",
+    "@typescript-eslint/parser": "^4.27.0",
+    "@vuepress/plugin-google-analytics": "1.8.2",
+    "@vuepress/plugin-html-redirect": "^0.1.4",
+    "archiver": "^5.3.0",
+    "chart.js": "^3.3.2",
+    "chartjs-adapter-luxon": "^1.0.0",
+    "chartjs-plugin-annotation": "^1.0.2",
+    "chartjs-plugin-datalabels": "^2.0.0-rc.1",
+    "chartjs-plugin-zoom": "^1.0.1",
+    "concurrently": "^6.2.0",
+    "eslint": "^7.29.0",
+    "eslint-config-chartjs": "^0.3.0",
+    "eslint-plugin-es": "^4.1.0",
+    "eslint-plugin-html": "^6.1.2",
+    "eslint-plugin-markdown": "^2.2.0",
+    "luxon": "^1.27.0",
+    "ng-hammerjs": "^2.0.8",
+    "rollup": "^2.52.1",
+    "rollup-plugin-analyzer": "^4.0.0",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-terser": "^7.0.2",
+    "typescript": "^4.3.4",
+    "vuepress": "^1.8.2",
+    "vuepress-plugin-flexsearch": "^0.2.0",
+    "vuepress-plugin-redirect": "^1.2.5",
+    "vuepress-theme-chartjs": "^0.2.0"
+  },
+  "peerDependencies": {
+    "chart.js": "^3.0.0"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,48 @@
+import { Chart, ChartComponent, ChartType, TimeScale, TimeScaleOptions, Plugin } from 'chart.js';
+
+interface Options {
+  duration?: number;
+  delay?: number;
+  frameRate?: number;
+  refresh?: number;
+  onRefresh?: (this: RealTimeScale, chart: Chart) => void | null;
+  pause?: boolean;
+  ttl?: number;
+}
+
+export type RealTimeScaleOptions = TimeScaleOptions & {
+  realtime: Options;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface RealTimeScale<O extends RealTimeScaleOptions = RealTimeScaleOptions> extends TimeScale<O> {}
+
+export const RealTimeScale: ChartComponent & {
+  prototype: RealTimeScale;
+  new <O extends RealTimeScaleOptions = RealTimeScaleOptions>(cfg: Record<string, unknown>): RealTimeScale<O>;
+};
+
+declare module 'chart.js' {
+  interface CartesianScaleTypeRegistry {
+    realtime: {
+      options: RealTimeScaleOptions;
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  interface PluginOptionsByType<TType extends ChartType> {
+    /**
+     * Per chart streaming plugin options.
+     */
+    streaming?: Options;
+  }
+
+  enum UpdateModeEnum {
+    quiet = 'quiet'
+  }
+}
+
+declare const registerables: ChartComponent[];
+
+export const StreamingPlugin: Plugin;
+export default registerables;