@mieweb/ui 0.6.1-dev.138 → 0.6.1-dev.140

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 CHANGED
@@ -54,7 +54,7 @@ Heavy or specialized dependencies are kept in separate entry points so they don'
54
54
  | Entry point | Install | Import path |
55
55
  | ------------------------ | ---------------------------------------------------- | ------------------------ |
56
56
  | **AG Grid** | `npm install ag-grid-community ag-grid-react` | `@mieweb/ui/ag-grid` |
57
- | **DataVis** | `npm install datavis-ace` | `@mieweb/ui/datavis` |
57
+ | **DataVis** | `npm install @mieweb/datavis datavis-ace` | `@mieweb/ui/datavis` |
58
58
 
59
59
  ## Quick Start
60
60
 
@@ -120,7 +120,7 @@ git clone --recurse-submodules https://github.com/mieweb/ui.git
120
120
  cd ui
121
121
  ```
122
122
 
123
- > `--recurse-submodules` is strongly recommended for first clone so `packages/esheet`, `packages/datavis`, and `packages/ychart` are populated immediately. Without these submodules, eSheet, DataVis, and YChart stories will not work.
123
+ > `--recurse-submodules` is strongly recommended for first clone so the `packages/esheet` and `packages/ychart` submodules are populated immediately. Without them, the eSheet and YChart stories will not work. DataVis NITRO is not a submodule — it ships as the published `@mieweb/datavis` npm package.
124
124
 
125
125
  If you already cloned without submodules, run:
126
126
 
@@ -136,18 +136,13 @@ npm install
136
136
 
137
137
  Use one package manager consistently per clone. The commands below use npm.
138
138
 
139
- 3. **Build eSheet packages** (required before first Storybook run):
139
+ 3. **eSheet packages build automatically.** A `prestorybook` hook runs `npm run build:esheet` before Storybook starts, so the `@esheet/*` packages are compiled on first run with no manual step. It's a near-instant no-op on later runs once the artifacts exist.
140
140
 
141
- ```bash
142
- npm run build:esheet
143
- ```
144
-
145
- This installs eSheet's own dependencies and compiles all `@esheet/*` packages.
146
-
147
- If `packages/esheet` is updated later (submodule update, branch switch, or pull), force a fresh rebuild:
141
+ If `packages/esheet` is updated later (submodule update, branch switch, or pull) and you need to force a fresh rebuild, remove the built artifacts and run the build again:
148
142
 
149
143
  ```bash
150
- npm run rebuild:esheet
144
+ rm -f packages/esheet/packages/core/dist/index.d.ts packages/esheet/packages/renderer/src/index.output.css
145
+ npm run build:esheet
151
146
  ```
152
147
 
153
148
  4. **Start Storybook:**
@@ -156,7 +151,15 @@ npm run rebuild:esheet
156
151
  npm run storybook
157
152
  ```
158
153
 
159
- This starts the Storybook development server at [http://localhost:6006](http://localhost:6006) with all components, including eSheet, DataVis, and YChart.
154
+ This starts the Storybook development server at [http://localhost:6006](http://localhost:6006) with all components, including eSheet, DataVis NITRO, and YChart.
155
+
156
+ ### How the Sub-Packages Are Wired
157
+
158
+ Storybook integrates three sibling MIE projects, each sourced differently:
159
+
160
+ - **DataVis NITRO** — npm package `@mieweb/datavis`. No build step; consumed as a published package (no submodule needed).
161
+ - **eSheet** — git submodule `packages/esheet`. Built automatically by the `prestorybook` hook; rebuilds only when its artifacts are missing.
162
+ - **YChart** — git submodule `packages/ychart`. No build step; the story imports it directly from source via a relative dynamic import, and Storybook's Vite config adds a `virtual:git-info` plugin, a `__YCHART_VERSION__` define, and dependency pre-bundling (`optimizeDeps`).
160
163
 
161
164
  ### Library Development (watch mode)
162
165
 
@@ -173,8 +176,7 @@ This watches for source changes and rebuilds automatically. It does **not** star
173
176
  | Script | Description |
174
177
  | ------------------------- | --------------------------------------------------------- |
175
178
  | `npm run dev` | Watch & rebuild the library (for local consumers, not Storybook) |
176
- | `npm run build:esheet` | Build eSheet submodule packages for first-time setup (skips when already built) |
177
- | `npm run rebuild:esheet` | Force a full eSheet rebuild after `packages/esheet` changes |
179
+ | `npm run build:esheet` | Build eSheet submodule packages (auto-run by `prestorybook`/`prebuild`; skips when already built) |
178
180
  | `npm run build` | Build the library for production |
179
181
  | `npm run storybook` | Start Storybook development server |
180
182
  | `npm run build-storybook` | Build Storybook for static hosting |