{"_id":"@allioide/diagram-visualizer","name":"@allioide/diagram-visualizer","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@allioide/diagram-visualizer","version":"0.1.0","description":"A CLI and library for visualizing the AllIO diagram","author":{"name":"Nuntipat Narkthong"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/allioide/allio-diagram-visualizer.git"},"homepage":"https://allio.build","type":"module","main":"./dist/cjs/index.js","module":"./dist/esm/index.js","bin":{"allio-visualize":"dist/cli.js"},"engines":{"node":">=18"},"scripts":{"build":"rimraf dist && npm run check-types && node esbuild.js && node script/postbuild.js","prepublishOnly":"npm run build","check-types":"tsc --noEmit","lint":"xo --fix","test":"rimraf build && tsc --project tsconfig.test.json && copyfiles test/**/*.alliodiagram build/ && ava","compile-schema":"json2ts -i src/schema/alliodiagram.json -o src/schema/alliodiagram.ts"},"devDependencies":{"@ava/typescript":"^5.0.0","@types/fontkit":"^2.0.7","ava":"^6.1.3","copyfiles":"^2.4.1","esbuild":"0.23.0","esbuild-node-externals":"^1.14.0","esbuild-plugin-d.ts":"^1.3.0","json-schema-to-typescript":"^14.1.0","rimraf":"^6.0.1","typescript":"^5.5.3","xo":"^0.59.0"},"dependencies":{"@svgdotjs/svg.js":"^3.2.4","ajv":"^8.17.1","commander":"^12.1.0","fontkit":"^2.0.2","svgdom":"^0.1.19","yaml":"^2.4.5"},"_id":"@allioide/diagram-visualizer@0.1.0","gitHead":"114a3cca7fd9d66f830f4fe24fbe0e55fefec8ae","types":"./dist/cjs/index.d.ts","bugs":{"url":"https://github.com/allioide/allio-diagram-visualizer/issues"},"_nodeVersion":"20.15.1","_npmVersion":"10.7.0","dist":{"integrity":"sha512-UfNULOVHqtFe7BTS5skk82K1SD+cTUQt3ZUfdYLnSfqmvihfhO90ovv79a9CiKRVgucGV5P3vM8aJnJN9BYxhA==","shasum":"80c31ad762e5ffe55d2039cd42b71e69c9b0795d","tarball":"https://registry.npmjs.org/@allioide/diagram-visualizer/-/diagram-visualizer-0.1.0.tgz","fileCount":10,"unpackedSize":403680,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDaRjHFs9H5FPy7JydvqztvuNXncE+zMp+fw5btyvR5RwIhANlJPiw5ZYnqTuthezDGcfe4Nn1kbgYTbFoEBaSmRAWv"}]},"_npmUser":{"name":"nuntipat","email":"nuntipat@gmail.com"},"directories":{},"maintainers":[{"name":"nuntipat","email":"nuntipat@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/diagram-visualizer_0.1.0_1722551840981_0.5281051709808766"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-01T22:37:20.873Z","0.1.0":"2024-08-01T22:37:21.141Z","modified":"2024-08-01T22:37:21.428Z"},"maintainers":[{"name":"nuntipat","email":"nuntipat@gmail.com"}],"description":"A CLI and library for visualizing the AllIO diagram","homepage":"https://allio.build","repository":{"type":"git","url":"git+https://github.com/allioide/allio-diagram-visualizer.git"},"author":{"name":"Nuntipat Narkthong"},"bugs":{"url":"https://github.com/allioide/allio-diagram-visualizer/issues"},"license":"MIT","readme":"# AllIO Diagram Visualizer\n\nA CLI and library for visualizing the AllIO diagram\n\n# Install\n\nUsing npm: \n\n```\nnpm install @allioide/diagram-visualizer\n```\n\nTo use the `allio-visualize` command globally add the `-g` flag\n\n```\nnpm install -g @allioide/diagram-visualizer\n```\n\n# Usage\n\nThe following command can be used to generate the diagram image. For additional options, run `allio-visualize -h`.\n\n```\n$ allio-visualize -i diagram.alliodiagram -o diagram.svg\n```\n\nTo use as a library\n\n```js\n// For ESM/TypeScript (recommend)\nimport diagramVisualizer from '@allioide/diagram-visualizer';\n// or \n// import { loadDiagram, getNodeCanvas, renderSvg } from '@allioide/diagram-visualizer';\n\n// For CommonJS\n// const diagramVisualizer = require('@allioide/diagram-visualizer');\n\nconst file = /* diagram content as string e.g. fs.readFileSync('diagram.alliodiagram', 'utf8') */;\nconst diagram = diagramVisualizer.loadDiagram(file);\nconst canvas = diagramVisualizer.getNodeCanvas();\nconst svg = diagramVisualizer.renderSvg(diagram, canvas);\nconsole.log(svg); \n// <svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" ...\n//   ...\n// </svg>\n```","readmeFilename":"README.md"}