@composy/store-vue 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+## [0.0.2] - 2026-10-12
+
+### ✨ 新功能
+
+- **store**: 优化核心类型定义与基础实现，完善文档及示例 ([1a4771d](https://gitee.com/ldesign-v1/ldesign-store/commit/1a4771ddfb2802408500d13d4824f40b1290812d)) - @swimly
+- **store**: 添加 LDesign 项目配置及 Store 优化实施规范 ([7c2671e](https://gitee.com/ldesign-v1/ldesign-store/commit/7c2671e5cef66284d3acdd84297472afeea0b5e0)) - @swimly
+- **store**: 添加文档与示例，优化 usePersistedState 并补充运行时测试 ([9ac19c9](https://gitee.com/ldesign-v1/ldesign-store/commit/9ac19c959b36103b08ce7ce427834cc16d0cb2a0)) - @swimly
+- **store**: 完善构建配置并暴露 getters 和 actions 运行时属性 ([8545317](https://gitee.com/ldesign-v1/ldesign-store/commit/854531704d5a9ec9222eee40d445112722f2e698)) - @swimly
+- auto-generated playground + README for store sub-packages ([90e109c](https://gitee.com/ldesign-v1/ldesign-store/commit/90e109c10b911656a6ed2322b2815bf83baaea2f)) - @swimly
+- add playground for store\packages\vue ([711b15a](https://gitee.com/ldesign-v1/ldesign-store/commit/711b15ad5dee7299358755f7d5b79cae93226769)) - @swimly
+- 新增 Vue 插件、工具函数与 Playground 示例 ([4df6602](https://gitee.com/ldesign-v1/ldesign-store/commit/4df6602a2800b3698e6bc5c7036a140958a0504c)) - @swimly
+- 新增工具类型、错误处理和快照功能 ([6219701](https://gitee.com/ldesign-v1/ldesign-store/commit/6219701e7327f26794df8264cbd70c3037618080)) - @swimly
+- **vue**: 新增持久化状态管理和增强版持久化插件 ([17fcaf6](https://gitee.com/ldesign-v1/ldesign-store/commit/17fcaf6e7a3334e54056e72296fb6e8aa8663fb1)) - @swimly
+
+### ♻️ 代码重构
+
+- 重构项目配置与代码结构，优化类型系统与功能 ([64e29ac](https://gitee.com/ldesign-v1/ldesign-store/commit/64e29ac61444ffff1e6e792bbe9a9501227e376b)) - @swimly
+- **vue**: 重构运行时架构并统一持久化实现 ([c9a66e3](https://gitee.com/ldesign-v1/ldesign-store/commit/c9a66e3e563780a4f46879387faaa9f8b1408709)) - @swimly
+- 移除文档系统和playground，标准化构建配置 ([9ae1c1b](https://gitee.com/ldesign-v1/ldesign-store/commit/9ae1c1b150aa765fae43e3599d338691a9a01345)) - @swimly
+- **core**: 重构核心模块结构并优化类型定义 ([20a3436](https://gitee.com/ldesign-v1/ldesign-store/commit/20a343674d6f5117089729acd0732a64ad0d21b8)) - @swimly
+- **build**: 移除umd格式并更新构建配置 ([c02dc47](https://gitee.com/ldesign-v1/ldesign-store/commit/c02dc47d00a56a6ed22b7391777953053ad6c740)) - @swimly
+
+### 📦 构建系统
+
+- add rolldown bundler config for vue and core packages ([2a1f932](https://gitee.com/ldesign-v1/ldesign-store/commit/2a1f932a150c946b8c453a25527c4de1353c5d0a)) - @swimly
+- 升级项目所有依赖至兼容最新版本 ([2bf6f05](https://gitee.com/ldesign-v1/ldesign-store/commit/2bf6f05ca266c410d2df4d5ec1ccea5840654492)) - @swimly
+- **deps**: 修复并完善依赖包版本配置 ([a327dd4](https://gitee.com/ldesign-v1/ldesign-store/commit/a327dd43f03a16a1f00cc79f89cfae7fe94e624d)) - @swimly
+- **vue**: 添加vue包下的rollup构建缓存文件 ([12d429a](https://gitee.com/ldesign-v1/ldesign-store/commit/12d429a7d1edc901d9744b60d2e56f623a60ae55)) - @swimly
+- 重构构建配置与修复类型检查问题 ([2ef2c0b](https://gitee.com/ldesign-v1/ldesign-store/commit/2ef2c0b74779cf4911cb61954bfce8523b9b5725)) - @swimly
+- 标准化构建配置并调整输出目录结构 ([33c101e](https://gitee.com/ldesign-v1/ldesign-store/commit/33c101ee476820b3a3de8be1be354169ba4e90b5)) - @swimly
+- **vue**: 添加 libraryType 配置并扩展 core 包导出 ([980c3e8](https://gitee.com/ldesign-v1/ldesign-store/commit/980c3e87ce3be2b73f2d74073e702da3ce79b8f8)) - @swimly
+
+### 🔧 其他
+
+- 更新项目配置与依赖版本 ([a98d95c](https://gitee.com/ldesign-v1/ldesign-store/commit/a98d95c2cf6fc17d601dcdfc34940dca631426f3)) - @swimly
+- 更新 core 和 vue 包的依赖版本 ([8e29acd](https://gitee.com/ldesign-v1/ldesign-store/commit/8e29acdad154447e140c7475313ff947265ffef2)) - @swimly
+- update store (26 files) ([b8cccd2](https://gitee.com/ldesign-v1/ldesign-store/commit/b8cccd20cd665d78968b104c030aacf01f33f2a8)) - @swimly
+- normalize versions, clean artifacts, update gitignore ([7b373ed](https://gitee.com/ldesign-v1/ldesign-store/commit/7b373ed6f54f1afc004ae7ac3ebc33fea062a22b)) - @swimly
+- update - docs(core): 新增@ldesign/store-core优化任务æ ([a486937](https://gitee.com/ldesign-v1/ldesign-store/commit/a486937b0c0939cad23dcfcb675dd2aa450171cd)) - @swimly
+- 批量更新 - 规范 .gitignore 清理源码 ([d4fc64e](https://gitee.com/ldesign-v1/ldesign-store/commit/d4fc64ebb656fa8ef03adc319b41becaa453fd00)) - @swimly
+- unified build config and structure ([e41794e](https://gitee.com/ldesign-v1/ldesign-store/commit/e41794e94409cf358de7568b812794d44b656813)) - @swimly
+- 统一配置 ESLint、Prettier 和测试脚本 ([de95488](https://gitee.com/ldesign-v1/ldesign-store/commit/de95488a91bbe087badc21feabf9f54a22ee5459)) - @swimly
+- 统一代码规范配置并更新测试工具 ([7ecaf03](https://gitee.com/ldesign-v1/ldesign-store/commit/7ecaf03f7bd22ae43b9d0775f8439a583f548829)) - @swimly
+- 更新依赖版本至固定版本并移除冗余插件 ([fd11677](https://gitee.com/ldesign-v1/ldesign-store/commit/fd116777c7ca95a0d29ea1e05d6c4e7513584a33)) - @swimly
+- batch commit submodule changes ([b2bb508](https://gitee.com/ldesign-v1/ldesign-store/commit/b2bb508085b6eac2b9e748a89b46470964382b6d)) - @swimly
+- set versions to 0.0.1 and pin @ldesign deps ([b4219a7](https://gitee.com/ldesign-v1/ldesign-store/commit/b4219a727eeaf842199869cb9b40c702010bbb2f)) - @swimly
+- 更新多个子模块至最新提交并重构lottie库依赖配置 ([792a7ec](https://gitee.com/ldesign-v1/ldesign-store/commit/792a7eca24e6f9825ad37fb70926b1562c17ae52)) - @swimly
+- 移除多余的空行并删除vue示例的README文件 ([37c15f7](https://gitee.com/ldesign-v1/ldesign-store/commit/37c15f7d7df4acafdc3307a6417e468c503bfa0f)) - @swimly
+
+### 👥 Contributors
+
+swimly, swimly
+
+### 📊 Statistics
+
+- Total Commits: **35**
+- Contributors: **2**

package/README.md

@@ -1,154 +1,169 @@
-# @composy/store-vue
-
-`@composy/store-vue` 是 `packages/store` 的 Vue 3 适配层。
-
-它保留现有定位不变：
-
-- 基于 Pinia 提供 Vue 侧接入能力
-- 提供一组围绕 Store 的 composables
-- 提供持久化、注册表和调试相关插件能力
-- 同时支持原生 Vue Plugin 用法和 `@composy/engine-core` plugin 用法
-
-## 目录结构
-
-```text
-src/
-├─ composables/   # Vue 侧组合式 API
-├─ context/       # 注入 key
-├─ plugins/       # 对外公开的插件入口与兼容导出
-├─ runtime/       # 运行时、注册表、安装链
-├─ index.ts       # 包入口
-└─ types.ts       # Vue 侧公开类型
-```
-
-当前实现中，真正的安装与生命周期逻辑已经收敛到 `runtime/`：
-
-- `runtime/store-plugin-options.ts`
-  - 统一运行时配置和默认值
-- `runtime/store-registry.ts`
-  - 统一 Store 注册、查询、批量重置和运行时 API
-- `runtime/store-runtime.ts`
-  - 统一创建 Pinia、注册 registry、挂接 persist plugin
-- `runtime/install-store-app.ts`
-  - 统一把 runtime 安装到 Vue app，并处理 `provide`、`globalProperties` 和卸载清理
-
-`plugins/` 只保留明确职责的公开入口：
-
-- `vue-plugin.ts`
-  - 原生 Vue Plugin 入口
-- `engine-plugin.ts`
-  - `@composy/engine-core` plugin 入口，内部委托 `@composy/store-core/engine` 的 `createStoreEngineBridge()`
-- `pinia-plugin.ts`
-  - 持久化插件与控制器
-- `registry-plugin.ts`
-  - registry 能力导出
-- `enhanced-persist-plugin.ts`
-  - 旧子路径兼容导出
-
-## 推荐用法
-
-### 原生 Vue Plugin
-
-```ts
-import {
-  createStoreVuePlugin,
-  defineStore,
-} from '@composy/store-vue'
-import { createApp } from 'vue'
-import App from './App.vue'
-
-const app = createApp(App)
-
-app.use(createStoreVuePlugin({
-  persist: true,
-  persistOptions: {
-    keyPrefix: 'demo:',
-    syncTabs: true,
-  },
-}))
-
-app.mount('#app')
-
-export const useCounterStore = defineStore('counter', {
-  state: () => ({
-    count: 0,
-  }),
-})
-```
-
-### `@composy/engine-core` Plugin
-
-```ts
-import { createStoreEnginePlugin } from '@composy/store-vue'
-
-export const storePlugin = createStoreEnginePlugin({
-  name: 'store',
-  version: '1.0.0',
-  persist: true,
-  provide: true,
-  globalProperties: true,
-})
-```
-
-设计要点：
-
-- 如果 engine 已拿到 Vue app，插件会直接复用同一条 runtime 安装链。
-- 如果 app 还没创建，插件会先准备 runtime，再在 `app:created` 时接入。
-- 如果外部 app 已安装过 store runtime，engine plugin 会复用已有 runtime，而不是重复创建第二套 Pinia/registry。
-- engine state/API/container/events 的同步逻辑由 core bridge 统一处理，Vue 包只传入 `createStoreRuntime()`、`installStoreRuntime()` 和 Vue App 识别函数。
-
-## 持久化能力
-
-`createPersistPlugin()` 和 `createEnhancedPersistPlugin()` 现在共享同一套实现，统一支持：
-
-- `paths`
-- `excludePaths`
-- `debounce`
-- `syncTabs`
-- `ttl`
-- `serializer.serialize`
-- `serializer.deserialize`
-
-示例：
-
-```ts
-import { defineStore } from 'pinia'
-
-export const useUserStore = defineStore('user', {
-  state: () => ({
-    profile: null,
-    token: '',
-    session: {
-      lastSeenAt: 0,
-    },
-  }),
-  persist: {
-    paths: ['profile', 'token'],
-    excludePaths: ['session.lastSeenAt'],
-    syncTabs: true,
-    ttl: 1000 * 60 * 60 * 24,
-  },
-})
-```
-
-## 本轮整理结果
-
-- 原生 Vue Plugin 和 engine plugin 已统一复用同一条 runtime/install 链
-- engine plugin 已收口为 core bridge 的 Vue 薄封装，不再复制 engine state/API 生命周期逻辑
-- registry、persist、Pinia 安装和 app 卸载清理都集中在 `runtime/`
-- `plugins/` 目录不再承载重复 runtime 逻辑，只保留公开入口和兼容层
-- `useFormStore`、`useStoreDevtools`、`usePersistedState` 等 composable 的实现更清晰，避免继续堆叠历史写法
-- 持久化、Store registry 的 `$dispose` 补丁逻辑已支持重复挂载/运行时重建场景，避免残留旧清理回调
-
-## 开发校验
-
-当前包建议优先使用：
-
-```bash
-pnpm -C packages/store/packages/vue run lint:check
-pnpm -C packages/store/packages/vue run type-check
-pnpm -C packages/store/packages/vue run test:run
-pnpm -C packages/store/packages/vue run build
-```
-
-完整构建后必须同时存在 `dist`、`es`、`esm`、`lib` 四类产物目录。
+# @composy/store-vue
+
+`@composy/store-vue` 是 `packages/store` 的 Vue 3 适配层。
+
+它保留现有定位不变：
+
+- 基于 Pinia 提供 Vue 侧接入能力
+- 提供一组围绕 Store 的 composables
+- 提供持久化、注册表和调试相关插件能力
+- 同时支持原生 Vue Plugin 用法和 `@composy/engine-core` plugin 用法
+
+Registry lifecycle is explicit: `unregister()` and `clear()` restore any `$dispose` patches they
+installed. Registering a different Pinia store with an existing ID first removes the old entry, so
+disposing the old instance cannot remove the replacement.
+
+## 目录结构
+
+```text
+src/
+├─ composables/   # Vue 侧组合式 API
+├─ context/       # 注入 key
+├─ plugins/       # 对外公开的插件入口与兼容导出
+├─ runtime/       # 运行时、注册表、安装链
+├─ index.ts       # 包入口
+└─ types.ts       # Vue 侧公开类型
+```
+
+当前实现中，真正的安装与生命周期逻辑已经收敛到 `runtime/`：
+
+- `runtime/store-plugin-options.ts`
+  - 统一运行时配置和默认值
+- `runtime/store-registry.ts`
+  - 统一 Store 注册、查询、批量重置和运行时 API
+- `runtime/store-runtime.ts`
+  - 统一创建 Pinia、注册 registry、挂接 persist plugin
+- `runtime/install-store-app.ts`
+  - 统一把 runtime 安装到 Vue app，并处理 `provide`、`globalProperties` 和卸载清理
+
+Pinia 不提供移除已安装插件的 API。runtime
+dispose 会停用它安装的 registry 和持久化插件，避免同一 Pinia 后续创建的 Store 被旧 runtime 再次捕获；Pinia 仍拥有现有 Store，如需销毁实例请调用其
+`$dispose()`。
+
+`plugins/` 只保留明确职责的公开入口：
+
+- `vue-plugin.ts`
+  - 原生 Vue Plugin 入口
+- `engine-plugin.ts`
+  - `@composy/engine-core` plugin 入口，内部委托 `@composy/store-core/engine` 的
+    `createStoreEngineBridge()`
+- `pinia-plugin.ts`
+  - 持久化插件与控制器
+- `registry-plugin.ts`
+  - registry 能力导出
+- `enhanced-persist-plugin.ts`
+  - 旧子路径兼容导出
+
+## 推荐用法
+
+### 原生 Vue Plugin
+
+```ts
+import { createStoreVuePlugin, defineStore } from '@composy/store-vue'
+import { createApp } from 'vue'
+import App from './App.vue'
+
+const app = createApp(App)
+
+app.use(
+  createStoreVuePlugin({
+    persist: true,
+    persistOptions: {
+      keyPrefix: 'demo:',
+      syncTabs: true,
+    },
+  })
+)
+
+app.mount('#app')
+
+export const useCounterStore = defineStore('counter', {
+  state: () => ({
+    count: 0,
+  }),
+})
+```
+
+### `@composy/engine-core` Plugin
+
+```ts
+import { createStoreEnginePlugin } from '@composy/store-vue'
+
+export const storePlugin = createStoreEnginePlugin({
+  name: 'store',
+  version: '1.0.0',
+  persist: true,
+  provide: true,
+  globalProperties: true,
+})
+```
+
+设计要点：
+
+- 如果 engine 已拿到 Vue app，插件会直接复用同一条 runtime 安装链。
+- 如果 app 还没创建，插件会先准备 runtime，再在 `app:created` 时接入。
+- 如果外部 app 已安装过 store runtime，engine
+  plugin 会复用已有 runtime，而不是重复创建第二套 Pinia/registry。
+- engine state/API/container/events 的同步逻辑由 core bridge 统一处理，Vue 包只传入
+  `createStoreRuntime()`、`installStoreRuntime()` 和 Vue App 识别函数。
+
+## 持久化能力
+
+`createPersistPlugin()` 和 `createEnhancedPersistPlugin()` 现在共享同一套实现，统一支持：
+
+- `paths`
+- `excludePaths`
+- `debounce`
+- `syncTabs`
+- `ttl`
+- `serializer.serialize`
+- `serializer.deserialize`
+
+示例：
+
+```ts
+import { defineStore } from 'pinia'
+
+export const useUserStore = defineStore('user', {
+  state: () => ({
+    profile: null,
+    token: '',
+    session: {
+      lastSeenAt: 0,
+    },
+  }),
+  persist: {
+    paths: ['profile', 'token'],
+    excludePaths: ['session.lastSeenAt'],
+    syncTabs: true,
+    ttl: 1000 * 60 * 60 * 24,
+  },
+})
+```
+
+## 本轮整理结果
+
+- 原生 Vue Plugin 和 engine plugin 已统一复用同一条 runtime/install 链
+- engine plugin 已收口为 core bridge 的 Vue 薄封装，不再复制 engine state/API 生命周期逻辑
+- registry、persist、Pinia 安装和 app 卸载清理都集中在 `runtime/`
+- `plugins/` 目录不再承载重复 runtime 逻辑，只保留公开入口和兼容层
+- `useFormStore`、`useStoreDevtools`、`usePersistedState`
+  等 composable 的实现更清晰，避免继续堆叠历史写法
+- 持久化、Store registry 的 `$dispose` 补丁逻辑支持重复挂载/运行时重建；disposed
+  runtime 留在 Pinia 插件列表中的回调会变为 no-op，避免旧 registry 重新持有后续 Store
+
+## 开发校验
+
+当前包建议优先使用：
+
+```bash
+pnpm -C packages/store/packages/vue run lint:check
+pnpm -C packages/store/packages/vue run type-check
+pnpm -C packages/store/packages/vue run test:run
+pnpm -C packages/store/packages/vue run build
+```
+
+完整构建后必须同时存在 `dist`、`es`、`esm`、`lib` 四类产物目录。
+
+Build, ESLint and TypeScript settings are maintained in `.ldesign/`; package-root `tsconfig.json`,
+`tsconfig.typecheck.json` and `eslint.config.js` are compatibility entry points.