@kitr/storage 0.3.1 → 0.4.0

package/dist/kitr.js

@@ -18,19 +18,21 @@ export default defineConfig({
 
 /** Cookies are typed once and read with \`cookies(event).get(item)\` from @kitr/storage/server. */
 export const localeCookie = defineCookie('locale', { default: 'en', maxAge: 60 * 60 * 24 * 365 })
-` : `import { defineCookie, defineStorage } from '@kitr/storage'
+` : `import { defineCookie } from '@kitr/storage'
 
 /**
  * Every persisted value, in one file, typed. Components read them with
  * \`useStorage(item)\` / \`useCookie(item)\` from @kitr/storage/react; plain code with \`item.get()\`.
+ * A local or session storage value is declared the same way:
+ *
+ *   import { defineStorage } from '@kitr/storage'
+ *
+ *   export const sidebar = defineStorage('sidebar', { default: { collapsed: false } })
+ *   export const recentSearches = defineStorage<string[]>('recent-searches', {
+ *     default: [],
+ *     area: 'session',
+ *   })
  */
-export const sidebar = defineStorage('sidebar', { default: { collapsed: false } })
-
-export const recentSearches = defineStorage<string[]>('recent-searches', {
-  default: [],
-  area: 'session',
-  version: 1,
-})
 
 /** Readable on the server too (\`localeCookie.get(request.headers)\`), so SSR picks the right locale. */
 export const localeCookie = defineCookie('locale', { default: 'en', maxAge: 60 * 60 * 24 * 365 })

package/docs/index.md

@@ -35,7 +35,7 @@ kitr add storage
 
 - Installs `@kitr/storage` and adds its provider and package to `kitrrc.ts`.
 - Writes `config/storage.ts` (see [Configure](#configure)).
-- Writes `app/storage.ts` with three sample values: `sidebar`, `recentSearches` and `localeCookie`. A server-only project gets only `localeCookie`.
+- Writes `app/storage.ts` with one value, `localeCookie`, and a commented `defineStorage` example.
 - Adds a `## kitr: storage` section to `AGENTS.md`.
 
 It asks no questions and adds no environment variables or scripts. It does not overwrite `config/storage.ts` or `app/storage.ts` when they exist.
@@ -50,19 +50,21 @@ The generated `app/storage.ts` in a project with React:
 
 ```ts
 // app/storage.ts
-import { defineCookie, defineStorage } from '@kitr/storage'
+import { defineCookie } from '@kitr/storage'
 
 /**
  * Every persisted value, in one file, typed. Components read them with
  * `useStorage(item)` / `useCookie(item)` from @kitr/storage/react; plain code with `item.get()`.
+ * A local or session storage value is declared the same way:
+ *
+ *   import { defineStorage } from '@kitr/storage'
+ *
+ *   export const sidebar = defineStorage('sidebar', { default: { collapsed: false } })
+ *   export const recentSearches = defineStorage<string[]>('recent-searches', {
+ *     default: [],
+ *     area: 'session',
+ *   })
  */
-export const sidebar = defineStorage('sidebar', { default: { collapsed: false } })
-
-export const recentSearches = defineStorage<string[]>('recent-searches', {
-  default: [],
-  area: 'session',
-  version: 1,
-})
 
 /** Readable on the server too (`localeCookie.get(request.headers)`), so SSR picks the right locale. */
 export const localeCookie = defineCookie('locale', { default: 'en', maxAge: 60 * 60 * 24 * 365 })
@@ -103,7 +105,16 @@ export default defineConfig({
 
 ## Save your first value
 
-Read and write a value from a component with `useStorage`. It returns the value, a setter and a remover, like `useState`:
+Declare the value in `app/storage.ts` first, with its default. The type comes from the default:
+
+```ts
+// app/storage.ts
+import { defineStorage } from '@kitr/storage'
+
+export const sidebar = defineStorage('sidebar', { default: { collapsed: false } })
+```
+
+Read and write it from a component with `useStorage`. It returns the value, a setter and a remover, like `useState`:
 
 ```tsx
 // app/components/sidebar-toggle.tsx

package/docs/overview.md

@@ -18,11 +18,20 @@ Storage items run in the browser and native shells; cookies run on both sides. F
 kitr add storage
 ```
 
-Adds `@kitr/storage`, its provider, `config/storage.ts` and `app/storage.ts` with three sample items. [Every change](/packages/storage/guide#install).
+Adds `@kitr/storage`, its provider, `config/storage.ts` and `app/storage.ts` with the locale cookie. [Every change](/packages/storage/guide#install).
 
 ## Quick start
 
-Declare each value once in `app/storage.ts`, then read and write it like `useState`:
+Declare each value once in `app/storage.ts`, with its default:
+
+```ts
+// app/storage.ts
+import { defineStorage } from '@kitr/storage'
+
+export const sidebar = defineStorage('sidebar', { default: { collapsed: false } })
+```
+
+Then read and write it like `useState`:
 
 ```tsx
 // app/components/sidebar-toggle.tsx

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitr/storage",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "@kitr/storage: typed localStorage/sessionStorage items and cookies with one API on the client and the server; SSR-safe React hooks.",
   "keywords": [
     "kitr",
@@ -47,7 +47,7 @@
     "docs"
   ],
   "dependencies": {
-    "@kitr/core": "0.3.1"
+    "@kitr/core": "0.4.0"
   },
   "peerDependencies": {
     "react": ">=18.0.0",
@@ -69,7 +69,7 @@
     "h3": "^2.0.8",
     "@types/node": "^22.19.0",
     "react-dom": "^19.3.1",
-    "@kitr/devtools": "0.3.1"
+    "@kitr/devtools": "0.4.0"
   },
   "kitr": {
     "name": "storage",