feat: new shared state utils

Author: antfu

packages/core/package.json

@@ -60,6 +60,7 @@
     "birpc-x": "catalog:deps",
     "cac": "catalog:deps",
     "debug": "catalog:deps",
+    "immer": "catalog:deps",
     "launch-editor": "catalog:deps",
     "mlly": "catalog:deps",
     "open": "catalog:deps",

packages/core/src/node/rpc/anonymous/auth.ts

@@ -39,7 +39,7 @@ export const anonymousAuth = defineRpcFunction({
 
         const message = [
           `A browser is requesting permissions to connect to the Vite DevTools.`,
-
+          '',
           `User Agent: ${c.yellow(c.bold(query.ua || 'Unknown'))}`,
           `Origin    : ${c.cyan(c.bold(query.origin || 'Unknown'))}`,
           `Identifier: ${c.green(c.bold(query.authId))}`,

packages/kit/package.json

@@ -42,7 +42,8 @@
   "dependencies": {
     "@vitejs/devtools-rpc": "workspace:*",
     "birpc": "catalog:deps",
-    "birpc-x": "catalog:deps"
+    "birpc-x": "catalog:deps",
+    "immer": "catalog:deps"
   },
   "devDependencies": {
     "my-ua-parser": "catalog:frontend",

packages/kit/src/utils/state.ts

@@ -0,0 +1,89 @@
+import type { Objectish, Patch } from 'immer'
+import type { EventEmitter } from '../types/events'
+import { applyPatches, produce, produceWithPatches } from 'immer'
+import { createEventEmitter } from './events'
+
+// eslint-disable-next-line ts/no-unsafe-function-type
+type ImmutablePrimitive = undefined | null | boolean | string | number | Function
+
+export type Immutable<T>
+  = T extends ImmutablePrimitive ? T
+    : T extends Array<infer U> ? ImmutableArray<U>
+      : T extends Map<infer K, infer V> ? ImmutableMap<K, V>
+        : T extends Set<infer M> ? ImmutableSet<M> : ImmutableObject<T>
+
+export type ImmutableArray<T> = ReadonlyArray<Immutable<T>>
+export type ImmutableMap<K, V> = ReadonlyMap<Immutable<K>, Immutable<V>>
+export type ImmutableSet<T> = ReadonlySet<Immutable<T>>
+export type ImmutableObject<T> = { readonly [K in keyof T]: Immutable<T[K]> }
+
+/**
+ * State host that is immutable by default with explicit mutate.
+ */
+export interface SharedState<T> {
+  /**
+   * Get the current state. Immutable.
+   */
+  get: () => Immutable<T>
+  /**
+   * Subscribe to state changes.
+   */
+  on: EventEmitter<SharedStateEvents<T>>['on']
+  /**
+   * Mutate the state.
+   */
+  mutate: (fn: (state: T) => void) => void
+  /**
+   * Apply patches to the state.
+   */
+  patch: (patches: Patch[]) => void
+}
+
+export interface SharedStateEvents<T> {
+  updated: (state: T) => void
+  patches: (patches: Patch[]) => void
+}
+
+export interface SharedStateOptions<T> {
+  /**
+   * Initial state.
+   */
+  initialState: T
+  /**
+   * Enable patches.
+   *
+   * @default false
+   */
+  enablePatches?: boolean
+}
+
+export function createSharedState<T extends Objectish>(
+  options: SharedStateOptions<T>,
+): SharedState<T> {
+  const {
+    enablePatches = false,
+  } = options
+
+  const events = createEventEmitter<SharedStateEvents<T>>()
+  let state = options.initialState
+
+  return {
+    on: events.on,
+    get: () => state as Immutable<T>,
+    patch: (patches: Patch[]) => {
+      state = applyPatches<T>(state, patches)
+      events.emit('updated', state)
+    },
+    mutate: (fn) => {
+      if (enablePatches) {
+        const [newState, patches] = produceWithPatches(state, fn)
+        state = newState
+        events.emit('patches', patches)
+      }
+      else {
+        state = produce(state, fn)
+      }
+      events.emit('updated', state)
+    },
+  }
+}

pnpm-lock.yaml

@@ -2,6 +2,7 @@ catalogMode: prefer
 ignoreWorkspaceRootCheck: true
 shamefullyHoist: true
 shellEmulator: true
+strictPeerDependencies: false
 trustPolicy: no-downgrade
 
 packages:
@@ -30,13 +31,13 @@ catalogs:
     '@rolldown/debug': ^1.0.0-beta.54
     ansis: ^4.2.0
     birpc: ^4.0.0
-    # Unstable API, lock the version
     birpc-x: 0.0.6
     cac: ^6.7.14
     debug: ^4.4.3
     diff: ^8.0.2
     get-port-please: ^3.2.0
     h3: ^1.15.4
+    immer: ^11.0.1
     launch-editor: ^2.12.0
     mlly: ^1.8.0
     mrmime: ^2.0.1
@@ -137,5 +138,3 @@ onlyBuiltDependencies:
   - rolldown
   - simple-git-hooks
   - unrs-resolver
-
-strictPeerDependencies: false