@bitblit/ratchet-echarts 0.1.4-alpha → 4.0.1-alpha

package/README.md

@@ -6,7 +6,7 @@ indebted.  I have forked it because that library appears to now be dormant, and
 versions of echarts, and the new prebuilt versions of canvas in my Lambda functions.  I also prefer typescript
 and will be bringing in type information.
 
-### Install
+## Install
 
 Note: Since this library depends on Echarts >= 5.x and node-canvas (canvas) >= 2.9.3, it auto-bundles in the 
 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:
 npm install @bitblit/ratchet-echarts
 ```
 
-### Usage
+### Special notes for AWS Lambda
+
+Most important - you MUST set your lambda to have sufficient memory - probably 512Mb or more.  If you find yourself
+getting timeouts with no errors logged after adding the library, you most likely have insufficient memory set.
+
+
+If you are using AWS Lambda (either Node 14/16, or containers built from the AWS parent container for them), you will
+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)"
+
+See [the node-canvas issue for more details](https://github.com/Automattic/node-canvas/issues/1779).  The solution
+varies depending on how you use Lambda.  
+
+### Using a custom docker container (1st way)
+To make sure it is compatible with whatever the current build of the image is, we will build from scratch.  In our
+docker container, we'll add :
+
+```docker
+# To build things in yarn
+RUN yum -y install python3
+RUN yum -y install pkgconfig make
+
+# Specifically for building canvas
+RUN yum -y install gcc-c++ cairo-devel pango-devel libjpeg-turbo-devel giflib-devel
+```
+
+And then, in the container we'll force a clean build, either by using
+```docker
+RUN npm install --build-from-source
+```
+
+or
+
+```docker
+RUN npm_config_build_from_source=true yarn install
+```
+
+### Using a custom docker container (alternate way)
+Add this to your container:
+```docker
+# Bring these in to make echarts work...
+# Also requires setting the LD_LIBRARY_PATH variable in the config
+# https://github.com/Automattic/node-canvas/issues/1779
+RUN yum -y install libuuid-devel libmount-devel
+RUN cp /lib64/{libuuid,libmount,libblkid}.so.1 ${LAMBDA_TASK_ROOT}/node_modules/canvas/build/Release/
+# End charts stuff
+```
+
+And then set an environment variable:
+```
+LD_LIBRARY_PATH="${LAMBDA_TASK_ROOT}/modules/api/node_modules/canvas/build/Release:${LD_LIBRARY_PATH}"
+```
+
+### Using one of the AWS Node options
+Use a [prebuilt layer](https://serverlessrepo.aws.amazon.com/applications/arn:aws:serverlessrepo:us-east-1:990551184979:applications~lambda-layer-canvas-nodejs)
+
+## Usage
 
 ```typescript
 

package/lib/build/ratchet-echarts-info.d.ts

@@ -0,0 +1,5 @@
+import { BuildInformation } from '@bitblit/ratchet-common';
+export declare class RatchetEchartsInfo {
+    private constructor();
+    static buildInformation(): BuildInformation;
+}

package/{dist → lib/common}/echart-ratchet.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { EChartsOption } from 'echarts';
 import { Canvas } from 'canvas';
-import { EChartCanvasConfig } from './echart-canvas-config';
+import { EChartCanvasConfig } from './echart-canvas-config.js';
 export declare class EChartRatchet {
     static renderChartUsingProvidedCanvas(opt: EChartsOption, canvas: Canvas): Promise<Buffer>;
     static renderChart(opts: EChartsOption, config: EChartCanvasConfig): Promise<Buffer>;

package/lib/examples/area.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/examples/bar.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/examples/bubble.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/examples/pie.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/examples/simple-bar.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './build/ratchet-echarts-info.js';
+export * from './common/echart-canvas-config.js';
+export * from './common/echart-ratchet.js';

package/lib/index.mjs

@@ -0,0 +1,2 @@
+import*as r from"echarts";import{Canvas as t}from"canvas";import e from"fs";class n{constructor(){}static buildInformation(){return{version:"LOCAL-SNAPSHOT",hash:"LOCAL-HASH",branch:"LOCAL-BRANCH",tag:"LOCAL-TAG",timeBuiltISO:"LOCAL-TIME-ISO",notes:"LOCAL-NOTES"}}}class a{static async renderChartUsingProvidedCanvas(t,e){if(!t)throw new Error("You must supply an opts parameter");if(!e)throw new Error("You must supply an canvas parameter");let n=null;t.animation=!1;const a=e;return r.init(a).setOption(t),n=e.toBuffer(),n}static async renderChart(r,e){if(!r)throw new Error("You must supply an opts parameter");if(!e)throw new Error("You must supply an config parameter");const n=new t(e.width,e.height);return await this.renderChartUsingProvidedCanvas(r,n)}static async renderChartToPngFile(r,t,n){if(!t)throw new Error("You must supply an opts parameter");if(!n)throw new Error("You must supply an config parameter");if(!r||0===r.trim().length)throw new Error("You must supply a non-empty filename parameter");if(!r.toLowerCase().endsWith(".png"))throw new Error("Your filename should end with .png - this generates a png file");const a=await this.renderChart(t,n);return e.writeFileSync(r,a),a}}export{a as EChartRatchet,n as RatchetEchartsInfo};
+//# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/build/ratchet-echarts-info.ts","../src/common/echart-ratchet.ts"],"sourcesContent":[null,null],"names":["RatchetEchartsInfo","constructor","static","version","hash","branch","tag","timeBuiltISO","notes","EChartRatchet","opt","canvas","Error","rval","animation","canvasHtml","echarts","init","setOption","toBuffer","opts","config","Canvas","width","height","this","renderChartUsingProvidedCanvas","filename","trim","length","toLowerCase","endsWith","renderChart","fs","writeFileSync"],"mappings":"kFAEaA,EAGXC,cAAwB,CAEjBC,0BASL,MAR8B,CAC5BC,QAAS,iBACTC,KAAM,aACNC,OAAQ,eACRC,IAAK,YACLC,aAAc,iBACdC,MAAO,cAGV,QCXUC,EACJP,4CAA4CQ,EAAoBC,GACrE,IAAKD,EACH,MAAM,IAAIE,MAAM,qCAElB,IAAKD,EACH,MAAM,IAAIC,MAAM,uCAElB,IAAIC,EAAe,KAEnBH,EAAII,WAAY,EAChB,MAAMC,EAA0BJ,EAMhC,OAHuBK,EAAQC,KAAKF,GAC9BG,UAAUR,GAChBG,EAAOF,EAAOQ,WACPN,CACR,CAEMX,yBAAyBkB,EAAqBC,GACnD,IAAKD,EACH,MAAM,IAAIR,MAAM,qCAElB,IAAKS,EACH,MAAM,IAAIT,MAAM,uCAElB,MAAMD,EAAiB,IAAIW,EAAOD,EAAOE,MAAOF,EAAOG,QAGvD,aAF2BC,KAAKC,+BAA+BN,EAAMT,EAGtE,CAEMT,kCAAkCyB,EAAkBP,EAAqBC,GAC9E,IAAKD,EACH,MAAM,IAAIR,MAAM,qCAElB,IAAKS,EACH,MAAM,IAAIT,MAAM,uCAElB,IAAKe,GAAuC,IAA3BA,EAASC,OAAOC,OAC/B,MAAM,IAAIjB,MAAM,kDAElB,IAAKe,EAASG,cAAcC,SAAS,QACnC,MAAM,IAAInB,MAAM,kEAElB,MAAMC,QAAqBY,KAAKO,YAAYZ,EAAMC,GAGlD,OAFAY,EAAGC,cAAcP,EAAUd,GAEpBA,CACR"}

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "@bitblit/ratchet-echarts",
-  "version": "0.1.4-alpha",
+  "version": "4.0.1-alpha",
   "description": "Library for using echarts on Node",
+  "type": "module",
   "files": [
-    "dist"
+    "lib/*",
+    "bin/*"
   ],
-  "main": "./dist/index.js",
-  "typings": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.mjs"
+    }
+  },
   "contributors": [
     "Christopher Weiss <bitblit@gmail.com>"
   ],
@@ -22,56 +28,21 @@
   },
   "config": {},
   "scripts": {
-    "prepare-to-publish": "yarn build && yarn remove-compiled-tests && yarn run apply-ci-vars",
-    "copy-static-files": "shx cp -R src/static dist",
-    "build": "yarn run clean && yarn run generate-barrels && yarn run compile && yarn copy-static-files",
-    "compile": "tsc",
     "watch": "tsc-watch",
-    "remove-compiled-tests": "rimraf ./dist/examples && rimraf ./dist/**/*.spec.d.ts && rimraf ./dist/**/*.spec.js && rimraf ./dist/**/*.spec.js.map",
-    "clean": "shx rm -Rf dist",
-    "compile-test": "yarn compile && yarn test",
-    "apply-ci-vars": "node node_modules/@bitblit/ratchet/dist/node-only/ci/apply-ci-env-variables-to-files github dist/static/build-properties.json",
-    "test": "jest",
+    "clean": "shx rm -Rf lib",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest",
     "lint": "eslint src/**/*.ts",
     "lint-fix": "eslint --fix src/**/*.ts",
-    "generate-barrels": "barrelsby -q --delete -d src -l top -e .*\\.spec\\.ts"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/bitblit/ratchet-echarts"
-  },
-  "engines": {
-    "node": ">=16.15"
+    "generate-barrels": "barrelsby -q --delete -d src -e .*\\.spec\\.ts && sed -i 's/\\x27;/.js\\x27;/' src/index.ts",
+    "build": "yarn clean && yarn generate-barrels && shx mkdir -p lib/native && rollup -c rollup.config.js",
+    "force-build": "tsc --build --force"
   },
   "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/bitblit/ratchet-echarts-echarts/issues"
-  },
-  "homepage": "https://github.com/bitblit/ratchet-echarts-echarts#readme",
   "dependencies": {
-    "canvas": "2.9.3",
-    "echarts": "5.3.3"
+    "canvas": "2.11.2",
+    "echarts": "5.4.2"
   },
   "devDependencies": {
-    "@bitblit/ratchet": "0.21.25",
-    "@types/jest": "28.1.4",
-    "@types/node": "14.18.1",
-    "@typescript-eslint/eslint-plugin": "5.30.5",
-    "@typescript-eslint/parser": "5.30.5",
-    "barrelsby": "2.3.4",
-    "cross-fetch": "3.1.5",
-    "eslint": "8.19.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-prettier": "4.2.1",
-    "husky": "8.0.1",
-    "jest": "28.1.2",
-    "jsonwebtoken": "8.5.1",
-    "prettier": "2.7.1",
-    "pretty-quick": "3.1.3",
-    "rimraf": "3.0.2",
-    "shx": "0.3.4",
-    "ts-jest": "28.0.5",
-    "typescript": "4.6.4"
+    "@bitblit/ratchet-common": "4.0.1-alpha"
   }
 }

package/dist/echart-canvas-config.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=echart-canvas-config.js.map

package/dist/echart-canvas-config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"echart-canvas-config.js","sourceRoot":"","sources":["../src/echart-canvas-config.ts"],"names":[],"mappings":""}

package/dist/echart-ratchet.js

@@ -1,96 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EChartRatchet = void 0;
-const echarts = __importStar(require("echarts"));
-const canvas_1 = require("canvas");
-const fs_1 = __importDefault(require("fs"));
-class EChartRatchet {
-    static renderChartUsingProvidedCanvas(opt, canvas) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!opt) {
-                throw new Error('You must supply an opts parameter');
-            }
-            if (!canvas) {
-                throw new Error('You must supply an canvas parameter');
-            }
-            let rval = null;
-            opt.animation = false; // Always do not animate given its is a static image
-            const canvasHtml = canvas;
-            // This is deprecated, and unneeded so far as I can tell
-            //echarts.setCanvasCreator(()=>{return canvasHtml;});
-            const chart = echarts.init(canvasHtml);
-            chart.setOption(opt);
-            rval = canvas.toBuffer();
-            return rval;
-        });
-    }
-    static renderChart(opts, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!opts) {
-                throw new Error('You must supply an opts parameter');
-            }
-            if (!config) {
-                throw new Error('You must supply an config parameter');
-            }
-            const canvas = new canvas_1.Canvas(config.width, config.height);
-            const rval = yield this.renderChartUsingProvidedCanvas(opts, canvas);
-            return rval;
-        });
-    }
-    static renderChartToPngFile(filename, opts, config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!opts) {
-                throw new Error('You must supply an opts parameter');
-            }
-            if (!config) {
-                throw new Error('You must supply an config parameter');
-            }
-            if (!filename || filename.trim().length === 0) {
-                throw new Error('You must supply a non-empty filename parameter');
-            }
-            if (!filename.toLowerCase().endsWith('.png')) {
-                throw new Error('Your filename should end with .png - this generates a png file');
-            }
-            const rval = yield this.renderChart(opts, config);
-            fs_1.default.writeFileSync(filename, rval);
-            return rval;
-        });
-    }
-}
-exports.EChartRatchet = EChartRatchet;
-//# sourceMappingURL=echart-ratchet.js.map

package/dist/echart-ratchet.js.map

@@ -1 +0,0 @@
-{"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"}

package/dist/index.d.ts

@@ -1,5 +0,0 @@
-/**
- * @file Automatically generated by barrelsby.
- */
-export * from './echart-canvas-config';
-export * from './echart-ratchet';

package/dist/index.js

@@ -1,22 +0,0 @@
-"use strict";
-/**
- * @file Automatically generated by barrelsby.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./echart-canvas-config"), exports);
-__exportStar(require("./echart-ratchet"), exports);
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;AAEH,yDAAuC;AACvC,mDAAiC"}

package/dist/static/build-properties.json

@@ -1,7 +0,0 @@
-{
-  "buildVersion": "4",
-  "buildHash": "df9f733d07443116a0c1b22e5862355579ad1e73",
-  "buildBranch": "alpha-2022-08-06-10",
-  "buildTag": "alpha-2022-08-06-10",
-  "buildTime": "2022-08-06 23:21:55 PM America/Los_Angeles"
-}