@bitblit/ratchet-echarts 0.1.3-alpha → 0.1.6-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@ indebted. I have forked it because that library appears to now be dormant, and
6
6
  versions of echarts, and the new prebuilt versions of canvas in my Lambda functions. I also prefer typescript
7
7
  and will be bringing in type information.
8
8
 
9
- ### Install
9
+ ## Install
10
10
 
11
11
  Note: Since this library depends on Echarts >= 5.x and node-canvas (canvas) >= 2.9.3, it auto-bundles in the
12
12
  correct native libraries (prebuilt) for Windows, OSX, and Linux - see [the canvas github page](https://github.com/Automattic/node-canvas)
@@ -16,7 +16,62 @@ for details. Therefore, all you have to do is:
16
16
  npm install @bitblit/ratchet-echarts
17
17
  ```
18
18
 
19
- ### Usage
19
+ ### Special notes for AWS Lambda
20
+
21
+ Most important - you MUST set your lambda to have sufficient memory - probably 512Mb or more. If you find yourself
22
+ getting timeouts with no errors logged after adding the library, you most likely have insufficient memory set.
23
+
24
+
25
+ If you are using AWS Lambda (either Node 14/16, or containers built from the AWS parent container for them), you will
26
+ likely encounter the error "/lib64/libz.so.1: version `ZLIB_1.2.9' not found (required by /var/task/node_modules/canvas/build/Release/libpng16.so.16)"
27
+
28
+ See [the node-canvas issue for more details](https://github.com/Automattic/node-canvas/issues/1779). The solution
29
+ varies depending on how you use Lambda.
30
+
31
+ ### Using a custom docker container (1st way)
32
+ To make sure it is compatible with whatever the current build of the image is, we will build from scratch. In our
33
+ docker container, we'll add :
34
+
35
+ ```docker
36
+ # To build things in yarn
37
+ RUN yum -y install python3
38
+ RUN yum -y install pkgconfig make
39
+
40
+ # Specifically for building canvas
41
+ RUN yum -y install gcc-c++ cairo-devel pango-devel libjpeg-turbo-devel giflib-devel
42
+ ```
43
+
44
+ And then, in the container we'll force a clean build, either by using
45
+ ```docker
46
+ RUN npm install --build-from-source
47
+ ```
48
+
49
+ or
50
+
51
+ ```docker
52
+ RUN npm_config_build_from_source=true yarn install
53
+ ```
54
+
55
+ ### Using a custom docker container (alternate way)
56
+ Add this to your container:
57
+ ```docker
58
+ # Bring these in to make echarts work...
59
+ # Also requires setting the LD_LIBRARY_PATH variable in the config
60
+ # https://github.com/Automattic/node-canvas/issues/1779
61
+ RUN yum -y install libuuid-devel libmount-devel
62
+ RUN cp /lib64/{libuuid,libmount,libblkid}.so.1 ${LAMBDA_TASK_ROOT}/node_modules/canvas/build/Release/
63
+ # End charts stuff
64
+ ```
65
+
66
+ And then set an environment variable:
67
+ ```
68
+ LD_LIBRARY_PATH="${LAMBDA_TASK_ROOT}/modules/api/node_modules/canvas/build/Release:${LD_LIBRARY_PATH}"
69
+ ```
70
+
71
+ ### Using one of the AWS Node options
72
+ Use a [prebuilt layer](https://serverlessrepo.aws.amazon.com/applications/arn:aws:serverlessrepo:us-east-1:990551184979:applications~lambda-layer-canvas-nodejs)
73
+
74
+ ## Usage
20
75
 
21
76
  ```typescript
22
77
 
@@ -0,0 +1,4 @@
1
+ export interface EChartCanvasConfig {
2
+ width: number;
3
+ height: number;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=echart-canvas-config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"echart-canvas-config.js","sourceRoot":"","sources":["../src/echart-canvas-config.ts"],"names":[],"mappings":""}
@@ -0,0 +1,9 @@
1
+ /// <reference types="node" />
2
+ import { EChartsOption } from 'echarts';
3
+ import { Canvas } from 'canvas';
4
+ import { EChartCanvasConfig } from './echart-canvas-config';
5
+ export declare class EChartRatchet {
6
+ static renderChartUsingProvidedCanvas(opt: EChartsOption, canvas: Canvas): Promise<Buffer>;
7
+ static renderChart(opts: EChartsOption, config: EChartCanvasConfig): Promise<Buffer>;
8
+ static renderChartToPngFile(filename: string, opts: EChartsOption, config: EChartCanvasConfig): Promise<Buffer>;
9
+ }
@@ -0,0 +1,96 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
26
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
27
+ return new (P || (P = Promise))(function (resolve, reject) {
28
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
29
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
30
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
31
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
32
+ });
33
+ };
34
+ var __importDefault = (this && this.__importDefault) || function (mod) {
35
+ return (mod && mod.__esModule) ? mod : { "default": mod };
36
+ };
37
+ Object.defineProperty(exports, "__esModule", { value: true });
38
+ exports.EChartRatchet = void 0;
39
+ const echarts = __importStar(require("echarts"));
40
+ const canvas_1 = require("canvas");
41
+ const fs_1 = __importDefault(require("fs"));
42
+ class EChartRatchet {
43
+ static renderChartUsingProvidedCanvas(opt, canvas) {
44
+ return __awaiter(this, void 0, void 0, function* () {
45
+ if (!opt) {
46
+ throw new Error('You must supply an opts parameter');
47
+ }
48
+ if (!canvas) {
49
+ throw new Error('You must supply an canvas parameter');
50
+ }
51
+ let rval = null;
52
+ opt.animation = false; // Always do not animate given its is a static image
53
+ const canvasHtml = canvas;
54
+ // This is deprecated, and unneeded so far as I can tell
55
+ //echarts.setCanvasCreator(()=>{return canvasHtml;});
56
+ const chart = echarts.init(canvasHtml);
57
+ chart.setOption(opt);
58
+ rval = canvas.toBuffer();
59
+ return rval;
60
+ });
61
+ }
62
+ static renderChart(opts, config) {
63
+ return __awaiter(this, void 0, void 0, function* () {
64
+ if (!opts) {
65
+ throw new Error('You must supply an opts parameter');
66
+ }
67
+ if (!config) {
68
+ throw new Error('You must supply an config parameter');
69
+ }
70
+ const canvas = new canvas_1.Canvas(config.width, config.height);
71
+ const rval = yield this.renderChartUsingProvidedCanvas(opts, canvas);
72
+ return rval;
73
+ });
74
+ }
75
+ static renderChartToPngFile(filename, opts, config) {
76
+ return __awaiter(this, void 0, void 0, function* () {
77
+ if (!opts) {
78
+ throw new Error('You must supply an opts parameter');
79
+ }
80
+ if (!config) {
81
+ throw new Error('You must supply an config parameter');
82
+ }
83
+ if (!filename || filename.trim().length === 0) {
84
+ throw new Error('You must supply a non-empty filename parameter');
85
+ }
86
+ if (!filename.toLowerCase().endsWith('.png')) {
87
+ throw new Error('Your filename should end with .png - this generates a png file');
88
+ }
89
+ const rval = yield this.renderChart(opts, config);
90
+ fs_1.default.writeFileSync(filename, rval);
91
+ return rval;
92
+ });
93
+ }
94
+ }
95
+ exports.EChartRatchet = EChartRatchet;
96
+ //# sourceMappingURL=echart-ratchet.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"echart-ratchet.js","sourceRoot":"","sources":["../src/echart-ratchet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AAEnC,mCAAgC;AAEhC,4CAAoB;AAEpB,MAAa,aAAa;IACjB,MAAM,CAAO,8BAA8B,CAAC,GAAkB,EAAE,MAAc;;YACnF,IAAI,CAAC,GAAG,EAAE;gBACR,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACtD;YACD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aACxD;YACD,IAAI,IAAI,GAAW,IAAI,CAAC;YAExB,GAAG,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC,oDAAoD;YAC3E,MAAM,UAAU,GAAsB,MAAsC,CAAC;YAC7E,wDAAwD;YACxD,qDAAqD;YACrD,MAAM,KAAK,GAAY,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAChD,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAEM,MAAM,CAAO,WAAW,CAAC,IAAmB,EAAE,MAA0B;;YAC7E,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACtD;YACD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aACxD;YACD,MAAM,MAAM,GAAW,IAAI,eAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC/D,MAAM,IAAI,GAAW,MAAM,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAE7E,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAEM,MAAM,CAAO,oBAAoB,CAAC,QAAgB,EAAE,IAAmB,EAAE,MAA0B;;YACxG,IAAI,CAAC,IAAI,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;aACtD;YACD,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aACxD;YACD,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7C,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;aACnE;YACD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAC5C,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;aACnF;YACD,MAAM,IAAI,GAAW,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC1D,YAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAEjC,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;CACF;AAnDD,sCAmDC"}
@@ -1,6 +1,5 @@
1
1
  /**
2
2
  * @file Automatically generated by barrelsby.
3
3
  */
4
-
5
4
  export * from './echart-canvas-config';
6
5
  export * from './echart-ratchet';
package/dist/index.js ADDED
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ /**
3
+ * @file Automatically generated by barrelsby.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
17
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
18
+ };
19
+ Object.defineProperty(exports, "__esModule", { value: true });
20
+ __exportStar(require("./echart-canvas-config"), exports);
21
+ __exportStar(require("./echart-ratchet"), exports);
22
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;AAEH,yDAAuC;AACvC,mDAAiC"}
@@ -0,0 +1,7 @@
1
+ {
2
+ "buildVersion": "6",
3
+ "buildHash": "9c183335f67bfe4cd9351c534a7246a6aa373ae3",
4
+ "buildBranch": "alpha-2023-01-23-9",
5
+ "buildTag": "alpha-2023-01-23-9",
6
+ "buildTime": "2023-01-23 23:18:56 PM America/Los_Angeles"
7
+ }
package/package.json CHANGED
@@ -1,7 +1,10 @@
1
1
  {
2
2
  "name": "@bitblit/ratchet-echarts",
3
- "version": "0.1.3-alpha",
3
+ "version": "0.1.6-alpha",
4
4
  "description": "Library for using echarts on Node",
5
+ "files": [
6
+ "dist"
7
+ ],
5
8
  "main": "./dist/index.js",
6
9
  "typings": "./dist/index.d.ts",
7
10
  "contributors": [
@@ -27,7 +30,7 @@
27
30
  "remove-compiled-tests": "rimraf ./dist/examples && rimraf ./dist/**/*.spec.d.ts && rimraf ./dist/**/*.spec.js && rimraf ./dist/**/*.spec.js.map",
28
31
  "clean": "shx rm -Rf dist",
29
32
  "compile-test": "yarn compile && yarn test",
30
- "apply-ci-vars": "node node_modules/@bitblit/ratchet/dist/node-only/ci/apply-ci-env-variables-to-files github dist/static/build-properties.json",
33
+ "apply-ci-vars": "yarn ratchet-apply-ci-env-variables-to-files github dist/static/build-properties.json",
31
34
  "test": "jest",
32
35
  "lint": "eslint src/**/*.ts",
33
36
  "lint-fix": "eslint --fix src/**/*.ts",
@@ -46,29 +49,29 @@
46
49
  },
47
50
  "homepage": "https://github.com/bitblit/ratchet-echarts-echarts#readme",
48
51
  "dependencies": {
49
- "canvas": "2.9.3",
50
- "echarts": "5.3.3"
52
+ "canvas": "2.11.0",
53
+ "echarts": "5.4.1"
51
54
  },
52
55
  "devDependencies": {
53
- "@bitblit/ratchet": "0.21.25",
54
- "@types/jest": "28.1.4",
56
+ "@bitblit/ratchet": "3.0.68",
57
+ "@types/jest": "29.2.6",
55
58
  "@types/node": "14.18.1",
56
- "@typescript-eslint/eslint-plugin": "5.30.5",
57
- "@typescript-eslint/parser": "5.30.5",
58
- "barrelsby": "2.3.4",
59
+ "@typescript-eslint/eslint-plugin": "5.49.0",
60
+ "@typescript-eslint/parser": "5.49.0",
61
+ "barrelsby": "2.5.1",
59
62
  "cross-fetch": "3.1.5",
60
63
  "eslint": "8.19.0",
61
- "eslint-config-prettier": "8.5.0",
62
- "eslint-plugin-import": "2.26.0",
64
+ "eslint-config-prettier": "8.6.0",
65
+ "eslint-plugin-import": "2.27.5",
63
66
  "eslint-plugin-prettier": "4.2.1",
64
- "husky": "8.0.1",
65
- "jest": "28.1.2",
67
+ "husky": "8.0.3",
68
+ "jest": "29.3.1",
66
69
  "jsonwebtoken": "8.5.1",
67
- "prettier": "2.7.1",
70
+ "prettier": "2.8.3",
68
71
  "pretty-quick": "3.1.3",
69
- "rimraf": "3.0.2",
72
+ "rimraf": "4.1.2",
70
73
  "shx": "0.3.4",
71
- "ts-jest": "28.0.5",
74
+ "ts-jest": "29.0.5",
72
75
  "typescript": "4.6.4"
73
76
  }
74
77
  }
package/.eslintrc.json DELETED
@@ -1,14 +0,0 @@
1
- {
2
- "extends": ["plugin:@typescript-eslint/recommended", "prettier"],
3
- "plugins": ["prettier"],
4
- "parser": "@typescript-eslint/parser",
5
- "parserOptions": {
6
- "ecmaVersion": 6,
7
- "sourceType": "module"
8
- },
9
- "rules": {
10
- "prettier/prettier": ["error"],
11
- "@typescript-eslint/no-inferrable-types": "off",
12
- "@typescript-eslint/no-explicit-any": "off"
13
- }
14
- }
@@ -1,11 +0,0 @@
1
- ## Version
2
- ~
3
-
4
- ## What is expected
5
- ~
6
-
7
- ## Step to reproduce
8
- ~
9
-
10
- ## Environment
11
- ~
@@ -1,8 +0,0 @@
1
- name: "Build"
2
- description: "Builds the library"
3
-
4
- runs:
5
- using: "composite"
6
- steps:
7
- - run: yarn prepare-to-publish
8
- shell: bash
@@ -1,38 +0,0 @@
1
- name: 'Node Setup'
2
- description: 'Initial setup for node'
3
-
4
- inputs:
5
- npmToken:
6
- description: "Token for NPM"
7
- requried: true
8
-
9
- runs:
10
- using: "composite"
11
- steps:
12
- - uses: ./.github/workflows/actions/job-setup
13
-
14
- - name: Setup Node
15
- uses: actions/setup-node@v2
16
- with:
17
- cache: "yarn"
18
- node-version: "16.15.1"
19
- registry-url: 'https://registry.npmjs.org'
20
-
21
- - name: Set Node Memory flags
22
- run: echo "NODE_OPTIONS=\"--max_old_space_size=8192\"" >> $GITHUB_ENV
23
- shell: bash
24
-
25
- - name: Setup NPMJS
26
- run: |
27
- npm config set "//registry.npmjs.org/:_authToken" ${{ inputs.npmToken }}
28
- shell: bash
29
-
30
- - name: Setup Java
31
- uses: actions/setup-java@v2
32
- with:
33
- distribution: "temurin"
34
- java-version: "11"
35
-
36
- - name: Yarn install
37
- run: yarn install --frozen-lockfile
38
- shell: bash
@@ -1,17 +0,0 @@
1
- name: "Job Setup"
2
- description: "Initial setup for workflow jobs"
3
-
4
- runs:
5
- using: "composite"
6
-
7
- steps:
8
- - name: Parse repo name
9
- uses: actions-ecosystem/action-regex-match@v2
10
- id: repo-match
11
- with:
12
- text: ${{ github.repository }}
13
- regex: "^(?:.*)/(.*)$"
14
-
15
- - uses: zcong1993/setup-timezone@master
16
- with:
17
- timezone: America/Los_Angeles
@@ -1,13 +0,0 @@
1
- name: 'Test Report'
2
- description: 'Saves the test reports'
3
-
4
- runs:
5
- using: "composite"
6
- steps:
7
- - uses: actions/upload-artifact@v2
8
- with:
9
- name: test-reports
10
- path: |
11
- junit.xml
12
- coverage
13
- packages/*/coverage
@@ -1,24 +0,0 @@
1
- name: CI
2
-
3
- on:
4
- push:
5
- branches:
6
- - "*"
7
- tags-ignore:
8
- - "alpha-*"
9
- - "release-*"
10
-
11
- jobs:
12
- build:
13
- runs-on: ubuntu-latest
14
-
15
- concurrency:
16
- group: ${{ github.workflow }}-${{ github.ref }}
17
-
18
- steps:
19
- - name: Checkout code
20
- uses: actions/checkout@v2
21
-
22
- - uses: ./.github/workflows/actions/build-env-setup
23
-
24
- - uses: ./.github/workflows/actions/build
@@ -1,40 +0,0 @@
1
- name: Build and Deploy Alpha Library
2
-
3
- on:
4
- push:
5
- tags:
6
- - "alpha-*"
7
-
8
- jobs:
9
- build-and-deploy-alpha-library:
10
- runs-on: ubuntu-latest
11
-
12
- concurrency:
13
- group: ${{ github.workflow }}-${{ github.ref }}
14
-
15
- steps:
16
- - name: Checkout code
17
- uses: actions/checkout@v2
18
-
19
- - name: Configure environment
20
- uses: ./.github/workflows/actions/build-env-setup
21
- with:
22
- npmToken: ${{ secrets.NPM_TOKEN }}
23
-
24
- - name: Build, Test, Package
25
- run: yarn prepare-to-publish
26
- shell: bash
27
-
28
- - name: Apply CI vars
29
- run: yarn apply-ci-vars
30
- shell: bash
31
-
32
- - name: Deploy to NPMJS
33
- run: yarn publish --no-git-tag-version --non-interactive --new-version 0.1.$GITHUB_RUN_NUMBER-alpha
34
- shell: bash
35
- env:
36
- NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
37
-
38
-
39
- - name: Save coverage reports
40
- uses: ./.github/workflows/actions/test-report
@@ -1,37 +0,0 @@
1
- name: Build and Deploy Production Library
2
-
3
- on:
4
- push:
5
- tags:
6
- - "release-*"
7
-
8
- jobs:
9
- build-and-deploy-alpha-library:
10
- runs-on: ubuntu-latest
11
-
12
- concurrency:
13
- group: ${{ github.workflow }}-${{ github.ref }}
14
-
15
- steps:
16
- - name: Checkout code
17
- uses: actions/checkout@v2
18
-
19
- - name: Configure environment
20
- uses: ./.github/workflows/actions/build-env-setup
21
-
22
- - name: Build, Test, Package
23
- run: yarn prepare-to-publish
24
- shell: bash
25
-
26
- - name: Apply CI vars
27
- run: yarn apply-ci-vars
28
- shell: bash
29
-
30
- - name: Deploy to NPMJS
31
- run: yarn publish --no-git-tag-version --non-interactive --new-version 0.1.$GITHUB_RUN_NUMBER
32
- shell: bash
33
- env:
34
- NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
35
-
36
- - name: Save coverage reports
37
- uses: ./.github/workflows/actions/test-report
package/jest.config.js DELETED
@@ -1,4 +0,0 @@
1
- module.exports = {
2
- preset: 'ts-jest',
3
- testEnvironment: 'node',
4
- };
@@ -1,4 +0,0 @@
1
- export interface EChartCanvasConfig {
2
- width: number; // Image width, type is number.
3
- height: number; // Image height, type is number.
4
- }
@@ -1,58 +0,0 @@
1
- import * as echarts from 'echarts';
2
- import { ECharts, EChartsOption } from 'echarts';
3
- import { Canvas } from 'canvas';
4
- import { EChartCanvasConfig } from './echart-canvas-config';
5
- import fs from 'fs';
6
-
7
- export class EChartRatchet {
8
- public static async renderChartUsingProvidedCanvas(opt: EChartsOption, canvas: Canvas): Promise<Buffer> {
9
- if (!opt) {
10
- throw new Error('You must supply an opts parameter');
11
- }
12
- if (!canvas) {
13
- throw new Error('You must supply an canvas parameter');
14
- }
15
- let rval: Buffer = null;
16
-
17
- opt.animation = false; // Always do not animate given its is a static image
18
- const canvasHtml: HTMLCanvasElement = canvas as unknown as HTMLCanvasElement;
19
- // This is deprecated, and unneeded so far as I can tell
20
- //echarts.setCanvasCreator(()=>{return canvasHtml;});
21
- const chart: ECharts = echarts.init(canvasHtml);
22
- chart.setOption(opt);
23
- rval = canvas.toBuffer();
24
- return rval;
25
- }
26
-
27
- public static async renderChart(opts: EChartsOption, config: EChartCanvasConfig): Promise<Buffer> {
28
- if (!opts) {
29
- throw new Error('You must supply an opts parameter');
30
- }
31
- if (!config) {
32
- throw new Error('You must supply an config parameter');
33
- }
34
- const canvas: Canvas = new Canvas(config.width, config.height);
35
- const rval: Buffer = await this.renderChartUsingProvidedCanvas(opts, canvas);
36
-
37
- return rval;
38
- }
39
-
40
- public static async renderChartToPngFile(filename: string, opts: EChartsOption, config: EChartCanvasConfig): Promise<Buffer> {
41
- if (!opts) {
42
- throw new Error('You must supply an opts parameter');
43
- }
44
- if (!config) {
45
- throw new Error('You must supply an config parameter');
46
- }
47
- if (!filename || filename.trim().length === 0) {
48
- throw new Error('You must supply a non-empty filename parameter');
49
- }
50
- if (!filename.toLowerCase().endsWith('.png')) {
51
- throw new Error('Your filename should end with .png - this generates a png file');
52
- }
53
- const rval: Buffer = await this.renderChart(opts, config);
54
- fs.writeFileSync(filename, rval);
55
-
56
- return rval;
57
- }
58
- }
@@ -1,112 +0,0 @@
1
- import { EChartsOption } from 'echarts';
2
- import { EChartRatchet } from '../echart-ratchet';
3
-
4
- const options: EChartsOption = {
5
- title: {
6
- text: 'Stacked Area Chart',
7
- },
8
- tooltip: {
9
- trigger: 'axis',
10
- axisPointer: {
11
- type: 'cross',
12
- label: {
13
- backgroundColor: '#6a7985',
14
- },
15
- },
16
- },
17
- legend: {
18
- data: ['Email', 'Union Ads', 'Video Ads', 'Direct', 'Search Engine'],
19
- },
20
- toolbox: {
21
- feature: {
22
- saveAsImage: {},
23
- },
24
- },
25
- grid: {
26
- left: '3%',
27
- right: '4%',
28
- bottom: '3%',
29
- containLabel: true,
30
- },
31
- xAxis: [
32
- {
33
- type: 'category',
34
- boundaryGap: false,
35
- data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
36
- },
37
- ],
38
- yAxis: [
39
- {
40
- type: 'value',
41
- },
42
- ],
43
- series: [
44
- {
45
- name: 'Email',
46
- type: 'line',
47
- stack: 'Total',
48
- areaStyle: {},
49
- emphasis: {
50
- focus: 'series',
51
- },
52
- data: [120, 132, 101, 134, 90, 230, 210],
53
- },
54
- {
55
- name: 'Union Ads',
56
- type: 'line',
57
- stack: 'Total',
58
- areaStyle: {},
59
- emphasis: {
60
- focus: 'series',
61
- },
62
- data: [220, 182, 191, 234, 290, 330, 310],
63
- },
64
- {
65
- name: 'Video Ads',
66
- type: 'line',
67
- stack: 'Total',
68
- areaStyle: {},
69
- emphasis: {
70
- focus: 'series',
71
- },
72
- data: [150, 232, 201, 154, 190, 330, 410],
73
- },
74
- {
75
- name: 'Direct',
76
- type: 'line',
77
- stack: 'Total',
78
- areaStyle: {},
79
- emphasis: {
80
- focus: 'series',
81
- },
82
- data: [320, 332, 301, 334, 390, 330, 320],
83
- },
84
- {
85
- name: 'Search Engine',
86
- type: 'line',
87
- stack: 'Total',
88
- label: {
89
- show: true,
90
- position: 'top',
91
- },
92
- areaStyle: {},
93
- emphasis: {
94
- focus: 'series',
95
- },
96
- data: [820, 932, 901, 934, 1290, 1330, 1320],
97
- },
98
- ],
99
- };
100
-
101
- describe('#areaChart', function () {
102
- it('should generate the chart', async () => {
103
- const data: Buffer = await EChartRatchet.renderChart(options, {
104
- width: 1000,
105
- height: 500,
106
- });
107
-
108
- // As of 2022-08-06 this is 54255... there must be a better test than this...
109
- expect(data.length).toBeGreaterThan(50_000);
110
- expect(data.length).toBeLessThan(60_000);
111
- });
112
- });
@@ -1,76 +0,0 @@
1
- import { EChartsOption } from 'echarts';
2
- import { EChartRatchet } from '../echart-ratchet';
3
- import { LabelOption } from 'echarts/types/src/util/types';
4
-
5
- const labelRight: LabelOption = {
6
- position: 'right',
7
- };
8
-
9
- const options: EChartsOption = {
10
- title: {
11
- text: 'Bar Chart with Negative Value',
12
- },
13
- tooltip: {
14
- trigger: 'axis',
15
- axisPointer: {
16
- type: 'shadow',
17
- },
18
- },
19
- grid: {
20
- top: 80,
21
- bottom: 30,
22
- },
23
- xAxis: {
24
- type: 'value',
25
- position: 'top',
26
- splitLine: {
27
- lineStyle: {
28
- type: 'dashed',
29
- },
30
- },
31
- },
32
- yAxis: {
33
- type: 'category',
34
- axisLine: { show: false },
35
- axisLabel: { show: false },
36
- axisTick: { show: false },
37
- splitLine: { show: false },
38
- data: ['ten', 'nine', 'eight', 'seven', 'six', 'five', 'four', 'three', 'two', 'one'],
39
- },
40
- series: [
41
- {
42
- name: 'Cost',
43
- type: 'bar',
44
- stack: 'Total',
45
- label: {
46
- show: true,
47
- formatter: '{b}',
48
- },
49
- data: [
50
- { value: -0.07, label: labelRight },
51
- { value: -0.09, label: labelRight },
52
- 0.2,
53
- 0.44,
54
- { value: -0.23, label: labelRight },
55
- 0.08,
56
- { value: -0.17, label: labelRight },
57
- 0.47,
58
- { value: -0.36, label: labelRight },
59
- 0.18,
60
- ],
61
- },
62
- ],
63
- };
64
-
65
- describe('#simpleBarChart', function () {
66
- it('should generate the chart', async () => {
67
- const data: Buffer = await EChartRatchet.renderChartToPngFile('test.png', options, {
68
- width: 1000,
69
- height: 500,
70
- });
71
-
72
- // As of 2022-08-06 this is 15569... there must be a better test than this..
73
- expect(data.length).toBeGreaterThan(15_000);
74
- expect(data.length).toBeLessThan(20_000);
75
- });
76
- });
@@ -1,172 +0,0 @@
1
- import { EChartsOption } from 'echarts';
2
- import { EChartRatchet } from '../echart-ratchet';
3
-
4
- import * as echarts from 'echarts';
5
-
6
- const data = [
7
- [
8
- [28604, 77, 17096869, 'Australia', 1990],
9
- [31163, 77.4, 27662440, 'Canada', 1990],
10
- [1516, 68, 1154605773, 'China', 1990],
11
- [13670, 74.7, 10582082, 'Cuba', 1990],
12
- [28599, 75, 4986705, 'Finland', 1990],
13
- [29476, 77.1, 56943299, 'France', 1990],
14
- [31476, 75.4, 78958237, 'Germany', 1990],
15
- [28666, 78.1, 254830, 'Iceland', 1990],
16
- [1777, 57.7, 870601776, 'India', 1990],
17
- [29550, 79.1, 122249285, 'Japan', 1990],
18
- [2076, 67.9, 20194354, 'North Korea', 1990],
19
- [12087, 72, 42972254, 'South Korea', 1990],
20
- [24021, 75.4, 3397534, 'New Zealand', 1990],
21
- [43296, 76.8, 4240375, 'Norway', 1990],
22
- [10088, 70.8, 38195258, 'Poland', 1990],
23
- [19349, 69.6, 147568552, 'Russia', 1990],
24
- [10670, 67.3, 53994605, 'Turkey', 1990],
25
- [26424, 75.7, 57110117, 'United Kingdom', 1990],
26
- [37062, 75.4, 252847810, 'United States', 1990],
27
- ],
28
- [
29
- [44056, 81.8, 23968973, 'Australia', 2015],
30
- [43294, 81.7, 35939927, 'Canada', 2015],
31
- [13334, 76.9, 1376048943, 'China', 2015],
32
- [21291, 78.5, 11389562, 'Cuba', 2015],
33
- [38923, 80.8, 5503457, 'Finland', 2015],
34
- [37599, 81.9, 64395345, 'France', 2015],
35
- [44053, 81.1, 80688545, 'Germany', 2015],
36
- [42182, 82.8, 329425, 'Iceland', 2015],
37
- [5903, 66.8, 1311050527, 'India', 2015],
38
- [36162, 83.5, 126573481, 'Japan', 2015],
39
- [1390, 71.4, 25155317, 'North Korea', 2015],
40
- [34644, 80.7, 50293439, 'South Korea', 2015],
41
- [34186, 80.6, 4528526, 'New Zealand', 2015],
42
- [64304, 81.6, 5210967, 'Norway', 2015],
43
- [24787, 77.3, 38611794, 'Poland', 2015],
44
- [23038, 73.13, 143456918, 'Russia', 2015],
45
- [19360, 76.5, 78665830, 'Turkey', 2015],
46
- [38225, 81.4, 64715810, 'United Kingdom', 2015],
47
- [53354, 79.1, 321773631, 'United States', 2015],
48
- ],
49
- ];
50
-
51
- const options: EChartsOption = {
52
- backgroundColor: new echarts.graphic.RadialGradient(0.3, 0.3, 0.8, [
53
- {
54
- offset: 0,
55
- color: '#f7f8fa',
56
- },
57
- {
58
- offset: 1,
59
- color: '#cdd0d5',
60
- },
61
- ]),
62
- title: {
63
- text: 'Life Expectancy and GDP by Country',
64
- left: '5%',
65
- top: '3%',
66
- },
67
- legend: {
68
- right: '10%',
69
- top: '3%',
70
- data: ['1990', '2015'],
71
- },
72
- grid: {
73
- left: '8%',
74
- top: '10%',
75
- },
76
- xAxis: {
77
- splitLine: {
78
- lineStyle: {
79
- type: 'dashed',
80
- },
81
- },
82
- },
83
- yAxis: {
84
- splitLine: {
85
- lineStyle: {
86
- type: 'dashed',
87
- },
88
- },
89
- scale: true,
90
- },
91
- series: [
92
- {
93
- name: '1990',
94
- data: data[0],
95
- type: 'scatter',
96
- symbolSize: function (data) {
97
- return Math.sqrt(data[2]) / 5e2;
98
- },
99
- emphasis: {
100
- focus: 'series',
101
- label: {
102
- show: true,
103
- formatter: function (param) {
104
- return param.data[3];
105
- },
106
- position: 'top',
107
- },
108
- },
109
- itemStyle: {
110
- shadowBlur: 10,
111
- shadowColor: 'rgba(120, 36, 50, 0.5)',
112
- shadowOffsetY: 5,
113
- color: new echarts.graphic.RadialGradient(0.4, 0.3, 1, [
114
- {
115
- offset: 0,
116
- color: 'rgb(251, 118, 123)',
117
- },
118
- {
119
- offset: 1,
120
- color: 'rgb(204, 46, 72)',
121
- },
122
- ]),
123
- },
124
- },
125
- {
126
- name: '2015',
127
- data: data[1],
128
- type: 'scatter',
129
- symbolSize: function (data) {
130
- return Math.sqrt(data[2]) / 5e2;
131
- },
132
- emphasis: {
133
- focus: 'series',
134
- label: {
135
- show: true,
136
- formatter: function (param) {
137
- return param.data[3];
138
- },
139
- position: 'top',
140
- },
141
- },
142
- itemStyle: {
143
- shadowBlur: 10,
144
- shadowColor: 'rgba(25, 100, 150, 0.5)',
145
- shadowOffsetY: 5,
146
- color: new echarts.graphic.RadialGradient(0.4, 0.3, 1, [
147
- {
148
- offset: 0,
149
- color: 'rgb(129, 227, 238)',
150
- },
151
- {
152
- offset: 1,
153
- color: 'rgb(25, 183, 207)',
154
- },
155
- ]),
156
- },
157
- },
158
- ],
159
- };
160
-
161
- describe('#bubbleChart', function () {
162
- it('should generate the chart', async () => {
163
- const data: Buffer = await EChartRatchet.renderChart(options, {
164
- width: 1000,
165
- height: 500,
166
- });
167
-
168
- // As of 2022-08-06 this is 140641... there must be a better test than this..
169
- expect(data.length).toBeGreaterThan(140_000);
170
- expect(data.length).toBeLessThan(150_000);
171
- });
172
- });
@@ -1,77 +0,0 @@
1
- import { EChartsOption } from 'echarts';
2
- import { EChartRatchet } from '../echart-ratchet';
3
-
4
- const options: EChartsOption = {
5
- backgroundColor: '#2c343c',
6
- title: {
7
- text: 'Customized Pie',
8
- left: 'center',
9
- top: 20,
10
- textStyle: {
11
- color: '#ccc',
12
- },
13
- },
14
- tooltip: {
15
- trigger: 'item',
16
- },
17
- visualMap: {
18
- show: false,
19
- min: 80,
20
- max: 600,
21
- inRange: {
22
- colorLightness: [0, 1],
23
- },
24
- },
25
- series: [
26
- {
27
- name: 'Access From',
28
- type: 'pie',
29
- radius: '55%',
30
- center: ['50%', '50%'],
31
- data: [
32
- { value: 335, name: 'Direct' },
33
- { value: 310, name: 'Email' },
34
- { value: 274, name: 'Union Ads' },
35
- { value: 235, name: 'Video Ads' },
36
- { value: 400, name: 'Search Engine' },
37
- ].sort(function (a, b) {
38
- return a.value - b.value;
39
- }),
40
- roseType: 'radius',
41
- label: {
42
- color: 'rgba(255, 255, 255, 0.3)',
43
- },
44
- labelLine: {
45
- lineStyle: {
46
- color: 'rgba(255, 255, 255, 0.3)',
47
- },
48
- smooth: 0.2,
49
- length: 10,
50
- length2: 20,
51
- },
52
- itemStyle: {
53
- color: '#c23531',
54
- shadowBlur: 200,
55
- shadowColor: 'rgba(0, 0, 0, 0.5)',
56
- },
57
- animationType: 'scale',
58
- animationEasing: 'elasticOut',
59
- animationDelay: function (idx) {
60
- return Math.random() * 200;
61
- },
62
- },
63
- ],
64
- };
65
-
66
- describe('#pieChart', function () {
67
- it('should generate the chart', async () => {
68
- const data: Buffer = await EChartRatchet.renderChartToPngFile('test.png', options, {
69
- width: 1000,
70
- height: 500,
71
- });
72
-
73
- // As of 2022-08-06 this is 32175... there must be a better test than this..
74
- expect(data.length).toBeGreaterThan(30_000);
75
- expect(data.length).toBeLessThan(40_000);
76
- });
77
- });
@@ -1,36 +0,0 @@
1
- import { EChartRatchet } from '../echart-ratchet';
2
- import { EChartsOption } from 'echarts';
3
-
4
- const options: EChartsOption = {
5
- title: {
6
- text: 'test',
7
- },
8
- tooltip: {},
9
- legend: {
10
- data: ['test'],
11
- },
12
- xAxis: {
13
- data: ['a', 'b', 'c', 'd', 'f', 'g'],
14
- },
15
- yAxis: {},
16
- series: [
17
- {
18
- name: 'test',
19
- type: 'bar',
20
- data: [5, 20, 36, 10, 10, 20],
21
- },
22
- ],
23
- };
24
-
25
- describe('#simpleBarChart', function () {
26
- it('should generate the chart', async () => {
27
- const data: Buffer = await EChartRatchet.renderChart(options, {
28
- width: 1000,
29
- height: 500,
30
- });
31
-
32
- // As of 2022-08-06 this is 7606... there must be a better test than this..
33
- expect(data.length).toBeGreaterThan(5_000);
34
- expect(data.length).toBeLessThan(10_000);
35
- });
36
- });
@@ -1,7 +0,0 @@
1
- {
2
- "buildVersion": "LOCAL-SNAPSHOT",
3
- "buildHash": "LOCAL-HASH",
4
- "buildBranch": "LOCAL-BRANCH",
5
- "buildTag": "LOCAL-TAG",
6
- "buildTime": "LOCAL-TIME"
7
- }
package/test.png DELETED
Binary file
package/tsconfig.json DELETED
@@ -1,27 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "target": "es6",
4
- "module": "commonjs",
5
- "declaration": true,
6
- "sourceMap": true,
7
- "outDir": "./dist",
8
- "strict": true,
9
- "esModuleInterop": true,
10
- "resolveJsonModule": true,
11
- "moduleResolution": "node",
12
- "noImplicitAny": false,
13
- "noUnusedLocals": false,
14
- "noImplicitThis": false,
15
- "strictNullChecks": false,
16
- "skipLibCheck": true,
17
- "noImplicitReturns": true,
18
- "preserveConstEnums": true,
19
- "suppressImplicitAnyIndexErrors": true,
20
- "forceConsistentCasingInFileNames": true,
21
- "lib": ["es2015", "es6", "dom"]
22
- },
23
- "include": ["src/**/*.ts"],
24
- "exclude": ["node_modules", "build", "webpack"],
25
- "types": ["typePatches"],
26
- "CAW_NOTES": "Set noImplicitAny, noImplicitThis and noUnusedLocals back to true at some point"
27
- }