@bagelink/vue 1.9.59 → 1.9.63

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bagelink/vue",
   "type": "module",
-  "version": "1.9.59",
+  "version": "1.9.63",
   "description": "Bagel core sdk packages",
   "author": {
     "name": "Bagel Studio",

package/src/composables/index.ts

@@ -1,40 +1,15 @@
 import type { BglFormSchemaT } from '@bagelink/vue'
 
-import type { MaybeRefOrGetter, Ref } from 'vue'
+import type { MaybeRefOrGetter } from 'vue'
 import { getFallbackSchema } from '@bagelink/vue'
-import { computed, ref, toValue, watch } from 'vue'
+import { computed, toValue } from 'vue'
 
 export { useAddToCalendar } from './useAddToCalendar'
 export { useDevice } from './useDevice'
 export { useExcel } from './useExcel'
+export { useLocalStore } from './useLocalStore'
 export { usePolling } from './usePolling'
 export { useTheme } from './useTheme'
-
-const _localStoreCache: Record<string, Ref> = {}
-let _storageListenerRegistered = false
-
-export function useLocalStore() {
-	if (!_storageListenerRegistered) {
-		_storageListenerRegistered = true
-		window.addEventListener('storage', (e) => {
-			if (e.key && _localStoreCache[e.key]) {
-				_localStoreCache[e.key].value = e.newValue !== null ? JSON.parse(e.newValue) : null
-			}
-		})
-	}
-	return new Proxy({} as Record<string, Ref>, {
-		get(_, key: string) {
-			if (!_localStoreCache[key]) {
-				const stored = localStorage.getItem(key)
-				_localStoreCache[key] = ref(stored !== null ? JSON.parse(stored) : null)
-				watch(_localStoreCache[key], (val) => {
-					localStorage.setItem(key, JSON.stringify(val))
-				})
-			}
-			return _localStoreCache[key]
-		},
-	})
-}
 interface UseBglSchemaParamsT<T> {
 	schema?: MaybeRefOrGetter<BglFormSchemaT<T>>
 	columns?: MaybeRefOrGetter<string[]>

package/src/composables/useLocalStore.ts

@@ -0,0 +1,43 @@
+import type { Ref } from 'vue'
+import { ref, watch } from 'vue'
+
+type LocalStoreDefaults = Record<string, unknown>
+type LocalStoreResult<T extends LocalStoreDefaults> = { [K in keyof T]: Ref<T[K]> }
+type LocalStoreTyped<T extends LocalStoreDefaults> = { [K in keyof T]: Ref<T[K] | null> }
+
+const _localStoreCache: Record<string, Ref> = {}
+let _storageListenerRegistered = false
+
+function _ensureListener() {
+	if (_storageListenerRegistered) return
+	_storageListenerRegistered = true
+	window.addEventListener('storage', (e) => {
+		if (e.key !== null && e.key in _localStoreCache) {
+			_localStoreCache[e.key].value = e.newValue !== null ? JSON.parse(e.newValue) : null
+		}
+	})
+}
+
+function _getRef<T>(key: string, defaultValue: T | null = null): Ref<T | null> {
+	if (!(key in _localStoreCache)) {
+		const stored = localStorage.getItem(key)
+		_localStoreCache[key] = ref(stored !== null ? JSON.parse(stored) : defaultValue)
+		watch(_localStoreCache[key], (val) => {
+			localStorage.setItem(key, JSON.stringify(val))
+		})
+	}
+	return _localStoreCache[key] as Ref<T | null>
+}
+
+export function useLocalStore<T extends LocalStoreDefaults>(defaults: T): LocalStoreResult<T>
+// eslint-disable-next-line no-redeclare
+export function useLocalStore<T extends LocalStoreDefaults>(): LocalStoreTyped<T>
+// eslint-disable-next-line no-redeclare
+export function useLocalStore<T extends LocalStoreDefaults>(defaults?: T) {
+	_ensureListener()
+	return new Proxy({} as Record<string, Ref>, {
+		get(_, key: string) {
+			return _getRef(key, defaults?.[key] ?? null)
+		},
+	})
+}