@openvizai/shared-types 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 +25 -1
- package/package.json +21 -1
package/README.md
CHANGED
|
@@ -1,3 +1,27 @@
|
|
|
1
1
|
# @openvizai/shared-types
|
|
2
2
|
|
|
3
|
-
Shared TypeScript
|
|
3
|
+
Shared TypeScript contracts and constants for OpenVizAI packages.
|
|
4
|
+
|
|
5
|
+
This package provides the canonical chart type constants used across backend prompts, validation schemas, and frontend rendering.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @openvizai/shared-types
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { SUPPORTED_CHART_TYPES } from "@openvizai/shared-types";
|
|
17
|
+
import type { ChartType } from "@openvizai/shared-types";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Why this package exists
|
|
21
|
+
|
|
22
|
+
- Prevents chart type drift between packages
|
|
23
|
+
- Keeps core and react contracts aligned
|
|
24
|
+
- Improves type safety across package boundaries
|
|
25
|
+
|
|
26
|
+
For full context, see:
|
|
27
|
+
https://github.com/OpenVizAI/OpenVizAI
|
package/package.json
CHANGED
|
@@ -1,6 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openvizai/shared-types",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Shared TypeScript contracts and chart constants for OpenVizAI packages.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "Jay Gajera",
|
|
7
|
+
"homepage": "https://github.com/OpenVizAI/OpenVizAI#readme",
|
|
8
|
+
"bugs": {
|
|
9
|
+
"url": "https://github.com/OpenVizAI/OpenVizAI/issues"
|
|
10
|
+
},
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "git+https://github.com/OpenVizAI/OpenVizAI.git",
|
|
14
|
+
"directory": "packages/shared-types"
|
|
15
|
+
},
|
|
16
|
+
"keywords": [
|
|
17
|
+
"openvizai",
|
|
18
|
+
"typescript",
|
|
19
|
+
"types",
|
|
20
|
+
"contracts",
|
|
21
|
+
"charting",
|
|
22
|
+
"shared"
|
|
23
|
+
],
|
|
4
24
|
"type": "module",
|
|
5
25
|
"main": "./dist/index.js",
|
|
6
26
|
"types": "./dist/index.d.ts",
|