visio-core 0.1.0 → 0.1.1
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 +41 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,46 @@
|
|
|
1
1
|
# visio-core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/visio-core)
|
|
4
|
+
[](https://github.com/ChristopherVR/visio-viewer/blob/main/LICENSE)
|
|
5
|
+
[](https://www.npmjs.com/package/visio-core)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
> The DOM-free Visio document API. This package is a thin re-export of `ooxml-core/visio`; it contains no separate parser, editing engine or viewer.
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
[Live demo](https://christophervr.github.io/visio-viewer/demo/) | [npm](https://www.npmjs.com/package/visio-core) | [Full docs](https://christophervr.github.io/visio-viewer/) | [Source](https://github.com/ChristopherVR/visio-viewer)
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install visio-core
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Quick start
|
|
18
|
+
|
|
19
|
+
```js
|
|
20
|
+
import { readFile } from 'node:fs/promises';
|
|
21
|
+
import { parseVsdx } from 'visio-core';
|
|
22
|
+
|
|
23
|
+
const document = await parseVsdx(await readFile('diagram.vsdx'));
|
|
24
|
+
console.log(document.pages);
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## API and limitations
|
|
28
|
+
|
|
29
|
+
Exports include the document model, `parseVsdx`, layer helpers and the core's
|
|
30
|
+
supported edit and geometry APIs. The installed `ooxml-core` version defines the
|
|
31
|
+
exact API. Review returned diagnostics and validation errors; native Visio parity
|
|
32
|
+
and lossless export are not established.
|
|
33
|
+
|
|
34
|
+
For a browser UI, install `visio-react-viewer`, `visio-vue-viewer`,
|
|
35
|
+
`visio-angular-viewer`, `visio-svelte-viewer`, `visio-solid-viewer` or
|
|
36
|
+
`visio-vanilla-viewer`. Each already re-exports this document API.
|
|
37
|
+
For headless MCP access, use `visio-viewer-mcp`.
|
|
38
|
+
|
|
39
|
+
## Documentation
|
|
40
|
+
|
|
41
|
+
[Viewer guide](https://christophervr.github.io/visio-viewer/docs/) |
|
|
42
|
+
[Core source](https://github.com/ChristopherVR/ooxml)
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
Apache-2.0.
|