wevu 0.0.1 → 0.0.2-alpha.0

package/README.md

@@ -0,0 +1,122 @@
+# wevu
+
+Vue 3 风格的小程序运行时，复用同款响应式与调度器，通过快照 diff 最小化 `setData`，并内置 Pinia 风格的状态管理。
+
+## 特性
+
+- `ref`/`reactive`/`computed`/`watch` 与 `nextTick` 同源于 Vue 3 的响应式核心
+- `definePage`/`defineComponent` + `setup` 生命周期钩子（onShow/onPageScroll/onShareAppMessage 等）自动注册微信小程序 Page/Component
+- 快照 diff + 去重调度，最小化 `setData` 体积，支持 `bindModel` 的双向绑定语法
+- 插件、`app.config.globalProperties` 及小程序原生选项可自由组合
+- 内置 `defineStore`/`storeToRefs`/`createStore`，支持 getters、actions、订阅与补丁
+- TypeScript first，输出 ESM/CJS/types
+
+## 安装
+
+```bash
+pnpm add wevu
+# 或 npm/yarn/pnpm dlx 按需安装
+```
+
+## 快速上手：页面定义
+
+```ts
+import {
+  computed,
+  definePage,
+  nextTick,
+  onMounted,
+  onPageScroll,
+  onShareAppMessage,
+  ref,
+} from 'wevu'
+
+definePage(
+  {
+    data: () => ({ count: 0 }),
+    computed: {
+      doubled() {
+        return this.count * 2
+      },
+    },
+    methods: {
+      inc() {
+        this.count += 1
+      },
+    },
+    watch: {
+      count(n) {
+        console.log('count changed', n)
+      },
+    },
+    setup({ state }) {
+      const title = computed(() => `count: ${state.count}`)
+      const local = ref(0)
+
+      onMounted(() => {
+        nextTick(() => console.log('page ready'))
+      })
+      onPageScroll((e) => {
+        console.log('scrollTop', e?.scrollTop)
+      })
+      onShareAppMessage(() => ({ title: title.value }))
+
+      return { local }
+    },
+  },
+  {
+    listenPageScroll: true,
+    enableShareAppMessage: true,
+  },
+)
+```
+
+- 当全局存在 `Page`/`Component` 构造器时自动注册；否则可拿到 `component.__wevu_runtime` 手动挂载适配器。
+- 组件场景使用 `defineComponent`，SFC 构建产物可调用 `createWevuComponent`。
+
+## 状态管理
+
+```ts
+import { createStore, defineStore, storeToRefs } from 'wevu'
+
+createStore() // 在小程序入口只需要调用一次，注入插件可选
+
+export const useCounter = defineStore('counter', {
+  state: () => ({ count: 0 }),
+  getters: {
+    doubled: state => state.count * 2,
+  },
+  actions: {
+    inc() {
+      this.count += 1
+    },
+  },
+})
+
+// 在页面/组件内使用
+const counter = useCounter()
+const { count, doubled } = storeToRefs(counter)
+counter.$subscribe(({ type }) => console.log('mutation', type))
+counter.inc()
+```
+
+## 调度与适配
+
+- 更新被批量加入微任务队列，`nextTick` 与 Vue 3 行为一致。
+- 对状态做快照 diff，只把变更路径传给 `setData`，避免大对象全量下发。
+- 可在 `createApp().mount(adapter)` 传入自定义 `setData` 适配器（例如单元测试或其他小程序平台）。
+
+## 本地开发
+
+```bash
+# 从仓库根目录执行
+pnpm dev --filter wevu
+pnpm test --filter wevu
+pnpm build --filter wevu
+```
+
+## 更多资料
+
+- 架构细节：`packages/wevu/ARCHITECTURE.md`
+- 与 Vue 3 对比：`packages/wevu/VUE3_VS_WEVU.md`
+- 兼容性说明：`packages/wevu/VUE3_COMPAT.md`

package/dist/index-D1r6nN-t.d.cts

@@ -0,0 +1,78 @@
+//#region src/reactivity/ref.d.ts
+interface Ref<T = any> {
+  value: T;
+}
+declare function isRef(value: unknown): value is Ref<any>;
+declare function ref<T>(value: T): Ref<T>;
+declare function unref<T>(value: T | Ref<T>): T;
+//#endregion
+//#region src/store/types.d.ts
+type MutationType = 'patch object' | 'patch function';
+interface SubscriptionCallback<S = any> {
+  (mutation: {
+    type: MutationType;
+    storeId: string;
+  }, state: S): void;
+}
+interface ActionSubscriber<TStore = any> {
+  (context: {
+    name: string;
+    store: TStore;
+    args: any[];
+    after: (cb: (result: any) => void) => void;
+    onError: (cb: (error: any) => void) => void;
+  }): void;
+}
+interface StoreManager {
+  install: (app: any) => void;
+  _stores: Map<string, any>;
+  use: (plugin: (context: {
+    store: any;
+  }) => void) => StoreManager;
+  _plugins: Array<(context: {
+    store: any;
+  }) => void>;
+}
+type GetterTree<S extends Record<string, any>> = Record<string, (state: S) => any>;
+type StoreGetters<G extends GetterTree<any>> = { [K in keyof G]: G[K] extends ((...args: any[]) => infer R) ? R : never };
+interface DefineStoreOptions<S extends Record<string, any>, G extends GetterTree<S>, A extends Record<string, any>> {
+  state: () => S;
+  getters?: G & Record<string, (state: S) => any> & ThisType<S & StoreGetters<G> & A>;
+  actions?: A & ThisType<S & StoreGetters<G> & A>;
+}
+//#endregion
+//#region src/store/define.d.ts
+type SetupDefinition<T> = () => T;
+declare function defineStore<T extends Record<string, any>>(id: string, setup: SetupDefinition<T>): () => T & {
+  $id: string;
+  $patch: (patch: Record<string, any> | ((state: any) => void)) => void;
+  $subscribe: (cb: (mutation: {
+    type: MutationType;
+    storeId: string;
+  }, state: any) => void, opts?: {
+    detached?: boolean;
+  }) => () => void;
+  $onAction: (cb: (context: any) => void) => () => void;
+};
+declare function defineStore<S extends Record<string, any>, G extends Record<string, any>, A extends Record<string, any>>(id: string, options: DefineStoreOptions<S, G, A>): () => S & StoreGetters<G> & A & {
+  $id: string;
+  $state: S;
+  $patch: (patch: Partial<S> | ((state: S) => void)) => void;
+  $reset: () => void;
+  $subscribe: (cb: (mutation: {
+    type: MutationType;
+    storeId: string;
+  }, state: S) => void, opts?: {
+    detached?: boolean;
+  }) => () => void;
+  $onAction: (cb: (context: any) => () => void) => () => void;
+};
+//#endregion
+//#region src/store/manager.d.ts
+declare function createStore(): StoreManager;
+//#endregion
+//#region src/store/storeToRefs.d.ts
+type StoreToRefsResult<T extends Record<string, any>> = { [K in keyof T]: T[K] extends ((...args: any[]) => any) ? T[K] : T[K] extends Ref<infer V> ? Ref<V> : Ref<T[K]> };
+declare function storeToRefs<T extends Record<string, any>>(store: T): StoreToRefsResult<T>;
+//#endregion
+export { DefineStoreOptions as a, SubscriptionCallback as c, ref as d, unref as f, ActionSubscriber as i, Ref as l, createStore as n, MutationType as o, defineStore as r, StoreManager as s, storeToRefs as t, isRef as u };

package/dist/index-DHBSC7mS.d.mts

@@ -0,0 +1,78 @@
+//#region src/reactivity/ref.d.ts
+interface Ref<T = any> {
+  value: T;
+}
+declare function isRef(value: unknown): value is Ref<any>;
+declare function ref<T>(value: T): Ref<T>;
+declare function unref<T>(value: T | Ref<T>): T;
+//#endregion
+//#region src/store/types.d.ts
+type MutationType = 'patch object' | 'patch function';
+interface SubscriptionCallback<S = any> {
+  (mutation: {
+    type: MutationType;
+    storeId: string;
+  }, state: S): void;
+}
+interface ActionSubscriber<TStore = any> {
+  (context: {
+    name: string;
+    store: TStore;
+    args: any[];
+    after: (cb: (result: any) => void) => void;
+    onError: (cb: (error: any) => void) => void;
+  }): void;
+}
+interface StoreManager {
+  install: (app: any) => void;
+  _stores: Map<string, any>;
+  use: (plugin: (context: {
+    store: any;
+  }) => void) => StoreManager;
+  _plugins: Array<(context: {
+    store: any;
+  }) => void>;
+}
+type GetterTree<S extends Record<string, any>> = Record<string, (state: S) => any>;
+type StoreGetters<G extends GetterTree<any>> = { [K in keyof G]: G[K] extends ((...args: any[]) => infer R) ? R : never };
+interface DefineStoreOptions<S extends Record<string, any>, G extends GetterTree<S>, A extends Record<string, any>> {
+  state: () => S;
+  getters?: G & Record<string, (state: S) => any> & ThisType<S & StoreGetters<G> & A>;
+  actions?: A & ThisType<S & StoreGetters<G> & A>;
+}
+//#endregion
+//#region src/store/define.d.ts
+type SetupDefinition<T> = () => T;
+declare function defineStore<T extends Record<string, any>>(id: string, setup: SetupDefinition<T>): () => T & {
+  $id: string;
+  $patch: (patch: Record<string, any> | ((state: any) => void)) => void;
+  $subscribe: (cb: (mutation: {
+    type: MutationType;
+    storeId: string;
+  }, state: any) => void, opts?: {
+    detached?: boolean;
+  }) => () => void;
+  $onAction: (cb: (context: any) => void) => () => void;
+};
+declare function defineStore<S extends Record<string, any>, G extends Record<string, any>, A extends Record<string, any>>(id: string, options: DefineStoreOptions<S, G, A>): () => S & StoreGetters<G> & A & {
+  $id: string;
+  $state: S;
+  $patch: (patch: Partial<S> | ((state: S) => void)) => void;
+  $reset: () => void;
+  $subscribe: (cb: (mutation: {
+    type: MutationType;
+    storeId: string;
+  }, state: S) => void, opts?: {
+    detached?: boolean;
+  }) => () => void;
+  $onAction: (cb: (context: any) => () => void) => () => void;
+};
+//#endregion
+//#region src/store/manager.d.ts
+declare function createStore(): StoreManager;
+//#endregion
+//#region src/store/storeToRefs.d.ts
+type StoreToRefsResult<T extends Record<string, any>> = { [K in keyof T]: T[K] extends ((...args: any[]) => any) ? T[K] : T[K] extends Ref<infer V> ? Ref<V> : Ref<T[K]> };
+declare function storeToRefs<T extends Record<string, any>>(store: T): StoreToRefsResult<T>;
+//#endregion
+export { DefineStoreOptions as a, SubscriptionCallback as c, ref as d, unref as f, ActionSubscriber as i, Ref as l, createStore as n, MutationType as o, defineStore as r, StoreManager as s, storeToRefs as t, isRef as u };