{"analyzedAt":"2023-01-15T12:21:47.385Z","collected":{"metadata":{"name":"@hpcc-js/wasm","scope":"hpcc-js","version":"2.7.0","description":"hpcc-js - WASM Libraries","keywords":["graphviz","typescript","webassembly","wasm","dot","zstd","graphviz-dot","zstandard","expat","base91","expat-xml-parser","webassemby"],"date":"2023-01-15T07:53:22.970Z","author":{"name":"Gordon Smith","email":"gordonjsmith@gmail.com"},"publisher":{"username":"hpcc-js","email":"gordon.smith@lexisnexisrisk.com"},"maintainers":[{"username":"hpcc-js","email":"gordon.smith@lexisnexisrisk.com"}],"repository":{"type":"git","url":"git+https://github.com/hpcc-systems/hpcc-js-wasm.git"},"links":{"npm":"https://www.npmjs.com/package/%40hpcc-js%2Fwasm","homepage":"https://hpcc-systems.github.io/hpcc-js-wasm/","repository":"https://github.com/hpcc-systems/hpcc-js-wasm","bugs":"https://github.com/hpcc-systems/hpcc-js-wasm/issues"},"license":"Apache-2.0","dependencies":{"yargs":"17.6.2"},"devDependencies":{"@istanbuljs/nyc-config-typescript":"1.0.2","@rollup/plugin-commonjs":"23.0.7","@rollup/plugin-node-resolve":"15.0.1","@rollup/plugin-terser":"0.1.0","@types/chai":"4.3.4","@types/emscripten":"1.39.6","@types/mocha":"10.0.1","@types/node":"16.18.10","@types/yargs":"17.0.17","@typescript-eslint/eslint-plugin":"5.47.0","@typescript-eslint/parser":"5.47.0","assemblyscript":"0.25.2","chai":"4.3.7","coveralls":"3.1.1","eslint":"8.30.0","fzstd":"0.1.0","karma":"6.4.1","karma-chai":"0.1.0","karma-chrome-launcher":"3.1.1","karma-firefox-launcher":"2.1.2","karma-mocha":"2.0.1","karma-spec-reporter":"0.0.36","local-web-server":"5.2.1","mocha":"10.2.0","npm-run-all":"4.1.5","nyc":"15.1.0","rimraf":"3.0.2","rollup":"3.8.1","rollup-plugin-sourcemaps":"0.6.3","run-script-os":"1.1.6","standard-version":"9.5.0","tslib":"2.4.1","typedoc":"0.23.23","typedoc-plugin-markdown":"3.14.0","typescript":"4.9.4","vitepress":"1.0.0-alpha.31"},"releases":[{"from":"2022-12-16T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":3},{"from":"2022-10-17T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":17},{"from":"2022-07-19T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":30},{"from":"2022-01-15T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":36},{"from":"2021-01-15T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":67}],"hasTestScript":true,"hasSelectiveFiles":true,"readme":"# @hpcc-js/wasm - Version 2\r\n\r\n![Tests](https://github.com/hpcc-systems/hpcc-js-wasm/workflows/Test%20PR/badge.svg)\r\n[![Coverage Status](https://coveralls.io/repos/github/GordonSmith/hpcc-js-wasm/badge.svg?branch=BUMP_VERSIONS)](https://coveralls.io/github/GordonSmith/hpcc-js-wasm?branch=BUMP_VERSIONS)\r\n\r\n**@hpcc-js/wasm is now an ESM by default package** - this is a good thing, but does require some breaking changes.\r\n\r\nThis repository contains a collection of useful c++ libraries compiled to WASM for (re)use in Node JS, Web Browsers and JavaScript Libraries:\r\n- [base91](https://base91.sourceforge.net/) - v0.6.0\r\n- [expat](https://libexpat.github.io/) - v2.5.0\r\n- [graphviz](https://www.graphviz.org/) - v7.0.6\r\n- [zstd](https://github.com/facebook/zstd) - v1.5.2\r\n- ...more to follow...\r\n\r\nBuilt with:\r\n- [emsdk](https://github.com/emscripten-core/emsdk) - v3.1.29\r\n\r\n## Homepage and Documents\r\n\r\n* [Homepage](https://hpcc-systems.github.io/hpcc-js-wasm/)\r\n    * [Base91](https://hpcc-systems.github.io/hpcc-js-wasm/classes/base91.Base91.html)\r\n    * [Expat](https://hpcc-systems.github.io/hpcc-js-wasm/classes/expat.Expat.html)\r\n    * [Graphviz](https://hpcc-systems.github.io/hpcc-js-wasm/classes/graphviz.Graphviz.html)\r\n    * [Zstd](https://hpcc-systems.github.io/hpcc-js-wasm/classes/zstd.Zstd.html)\r\n\r\n## Quick Migration Example\r\n\r\nv1.x.x\r\n```ts\r\nimport { graphviz, wasmFolder } from \"@hpcc-js/wasm\";\r\n\r\nwasmFolder(\"https://cdn.jsdelivr.net/npm/@hpcc-js/wasm/dist\");\r\n\r\nconst dot = \"digraph G { Hello -> World }\";\r\n\r\ngraphviz.dot(dot).then(svg => {\r\n    const div = document.getElementById(\"placeholder\");\r\n    div.innerHTML = svg;    \r\n});\r\n\r\ngraphvizVersion.then(version => console.log(version));\r\n```\r\n\r\nv2.x.x\r\n```ts\r\nimport { Graphviz } from \"@hpcc-js/wasm/graphviz\";\r\n\r\nconst graphviz = await Graphviz.load();\r\n\r\nconst dot = \"digraph G { Hello -> World }\";\r\nconst svg = graphviz.dot(dot);\r\nconsole.log(graphviz.version());\r\n```\r\n\r\nNotes:\r\n* Import must specify which wasm library your using\r\n* wasmFolder is no longer needed\r\n* All wasm libraries have the same asynchronous load pattern\r\n    - `const instance = await Wasm.load();`\r\n\r\n### ⚠⚠⚠ TypeScript Notes ⚠⚠⚠ \r\n\r\nWhen importing an ESM package AND referencing explicit `exports` (like `@hpcc-js/wasm/graphviz` or `@hpcc-js/wasm/expat`), you should change the following tsconfig.json setting:\r\n* `moduleResolution: Node16`\r\n\r\nThis will ensure the correct \"types\" are auto discovered."},"npm":{"downloads":[{"from":"2023-01-14T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":1265},{"from":"2023-01-08T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":28904},{"from":"2022-12-16T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":95522},{"from":"2022-10-17T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":256195},{"from":"2022-07-19T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":429793},{"from":"2022-01-15T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":692672}],"starsCount":0},"github":{"homepage":"https://hpcc-systems.github.io/hpcc-js-wasm/","starsCount":217,"forksCount":18,"subscribersCount":12,"issues":{"count":134,"openCount":0,"distribution":{"3600":54,"10800":16,"32400":13,"97200":24,"291600":10,"874800":8,"2624400":4,"7873200":4,"23619600":1,"70858800":0,"212576400":0},"isDisabled":false},"contributors":[{"username":"GordonSmith","commitsCount":223},{"username":"dependabot[bot]","commitsCount":7},{"username":"inokawa","commitsCount":1},{"username":"akbo","commitsCount":1},{"username":"magjac","commitsCount":1}],"commits":[{"from":"2023-01-08T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":3},{"from":"2022-12-16T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":13},{"from":"2022-10-17T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":48},{"from":"2022-07-19T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":75},{"from":"2022-01-15T00:00:00.000Z","to":"2023-01-15T00:00:00.000Z","count":90}]},"source":{"files":{"readmeSize":2474,"testsSize":153436,"hasChangelog":true},"badges":[{"urls":{"original":"https://coveralls.io/repos/github/GordonSmith/hpcc-js-wasm/badge.svg?branch=BUMP_VERSIONS","service":"https://coveralls.io/repos/github/GordonSmith/hpcc-js-wasm/badge.svg?branch=BUMP_VERSIONS","shields":"https://img.shields.io/coveralls/GordonSmith/hpcc-js-wasm/BUMP_VERSIONS.svg","content":"https://img.shields.io/coveralls/GordonSmith/hpcc-js-wasm/BUMP_VERSIONS.json"},"info":{"service":"coveralls","type":"coverage","modifiers":{"branch":"BUMP_VERSIONS"}}}],"linters":["eslint"],"coverage":0.98}},"evaluation":{"quality":{"carefulness":0.9999999999999999,"tests":0.747,"health":1,"branding":0.55},"popularity":{"communityInterest":252,"downloadsCount":85398.33333333333,"downloadsAcceleration":444.08563546423136,"dependentsCount":0},"maintenance":{"releasesFrequency":1,"commitsFrequency":1,"openIssues":1,"issuesDistribution":1}},"score":{"final":0.6625159596530228,"detail":{"quality":0.8464094502755721,"popularity":0.16742094464040352,"maintenance":0.9999879827034572}}}