@molecule/app-react-native 2.0.1 → 3.0.0

package/README.md

@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
 Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
 Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
 To change this document, edit the module-level JSDoc in src/index.ts.
-Generated: 2026-10-26T04:14:39.672Z
+Generated: 2026-10-27T23:36:39.690Z
 -->
 
 # @molecule/app-react-native
@@ -279,7 +279,7 @@ Form controller interface.
 All form providers must implement this interface.
 
 ```typescript
-interface FormController<T extends Record<string, unknown> = Record<string, unknown>> {
+interface FormController<T extends FormValuesConstraint<T> = Record<string, unknown>> {
   /**
    * Gets the current form state.
    */
@@ -387,7 +387,7 @@ interface FormController<T extends Record<string, unknown> = Record<string, unkn
 Form creation options.
 
 ```typescript
-interface FormOptions<T extends Record<string, unknown>> {
+interface FormOptions<T extends FormValuesConstraint<T>> {
   /**
    * Default values, captured as the form's clean baseline when the controller
    * is created. Mutating this object afterwards does not change the baseline.
@@ -839,7 +839,7 @@ provider (`createForm` from `@molecule/app-forms`), which uses the built-in
 native provider until the app bonds its own.
 
 ```typescript
-interface UseFormOptions<T extends Record<string, unknown>> extends FormOptions<T> {
+interface UseFormOptions<T extends FormValuesConstraint<T>> extends FormOptions<T> {
   /**
    * Explicit form factory for this one form. Defaults to the bonded forms
    * provider; pass it only to pin a specific provider instance.
@@ -853,7 +853,7 @@ interface UseFormOptions<T extends Record<string, unknown>> extends FormOptions<
 Result of useForm hook.
 
 ```typescript
-interface UseFormResult<T extends Record<string, unknown>> {
+interface UseFormResult<T extends FormValuesConstraint<T>> {
   formState: FormState<T>
   isValid: boolean
   isDirty: boolean
@@ -1002,8 +1002,11 @@ interface UsePlatformResult {
 
 Configuration for a profile form; transport stays in the auth bond.
 
+`TValues` is the page's own controlled-values type, named once as an
+`interface` or a type alias — both satisfy the shared form-values constraint.
+
 ```typescript
-interface UseProfileFormOptions<TUser, TValues extends Record<string, unknown>> extends Omit<
+interface UseProfileFormOptions<TUser, TValues extends FormValuesConstraint<TValues>> extends Omit<
   UseFormOptions<TValues>,
   'defaultValues'
 > {
@@ -1038,7 +1041,7 @@ interface UseProfileFormOptions<TUser, TValues extends Record<string, unknown>>
 Controlled profile form state and native form bindings.
 
 ```typescript
-interface UseProfileFormResult<TUser, TValues extends Record<string, unknown>> extends Omit<
+interface UseProfileFormResult<TUser, TValues extends FormValuesConstraint<TValues>> extends Omit<
   UseFormResult<TValues>,
   'register' | 'handleSubmit' | 'reset'
 > {
@@ -1167,6 +1170,43 @@ interface UseStorageValueResult<T> {
 }
 ```
 
+#### `UseStoragePreferenceOptions`
+
+Options for {@link useStoragePreference}.
+
+```typescript
+interface UseStoragePreferenceOptions<T> {
+  /**
+   * Value reported until the provider supplies one. It is NEVER written to
+   * storage: a default is a display fallback, not a decision the user made.
+   */
+  defaultValue?: T
+}
+```
+
+#### `UseStoragePreferenceResult`
+
+Result of {@link useStoragePreference}.
+
+```typescript
+interface UseStoragePreferenceResult<T> {
+  /** The persisted value, or `defaultValue` while none is known. */
+  value: T | undefined
+  /**
+   * Writes the value through the preference store: subscribers update
+   * immediately and persistence is best-effort.
+   */
+  setValue: (next: T | ((previous: T | undefined) => T)) => void
+  /** Removes the key through the preference store. */
+  removeValue: () => void
+  /**
+   * `true` once the store has a definite answer — the synchronous snapshot on
+   * a synchronous provider, or the hydration result on an asynchronous one.
+   */
+  ready: boolean
+}
+```
+
 #### `UseVerifyPaymentReturnOptions`
 
 Options for {@link useVerifyPaymentReturn}.
@@ -2169,7 +2209,9 @@ wires a form library once (`setProvider` from `@molecule/app-forms`) and
 every form picks it up. Passing `createForm` overrides that for one form.
 
 ```typescript
-function useForm<T extends Record<string, unknown>>(options?: UseFormOptions<T>): UseFormResult<T>
+function useForm<T extends FormValuesConstraint<T> = Record<string, unknown>>(
+  options?: UseFormOptions<T>,
+): UseFormResult<T>
 ```
 
 - `options` — Form options. `defaultValues`, `mode` and the form-level `validate` are forwarded to the provider; omit the options entirely for a form whose fields are registered with their own defaults.
@@ -2181,7 +2223,7 @@ function useForm<T extends Record<string, unknown>>(options?: UseFormOptions<T>)
 Hook to watch a specific field value.
 
 ```typescript
-function useWatch<T extends Record<string, unknown>, K extends keyof T>(
+function useWatch<T extends FormValuesConstraint<T>, K extends keyof T>(
   form: FormController<T>,
   name: K,
 ): T[K]
@@ -2197,7 +2239,7 @@ function useWatch<T extends Record<string, unknown>, K extends keyof T>(
 Hook to get field-level state.
 
 ```typescript
-function useFieldState<T extends Record<string, unknown>>(
+function useFieldState<T extends FormValuesConstraint<T>>(
   form: FormController<T>,
   name: keyof T,
 ): FieldState<T[keyof T]>
@@ -2460,7 +2502,7 @@ the clean baseline; edits made while saving remain dirty. No request is made
 for a patch with no fields. A failed request retains the edits and shared user.
 
 ```typescript
-function useProfileForm<TUser, TValues extends Record<string, unknown>>(
+function useProfileForm<TUser, TValues extends FormValuesConstraint<TValues>>(
   options: UseProfileFormOptions<TUser, TValues>,
 ): UseProfileFormResult<TUser, TValues>
 ```
@@ -2595,6 +2637,33 @@ function useStorageValue<T>(
 
 **Returns:** Storage value state (value, loading, error) and mutators (setValue, removeValue).
 
+#### `useStoragePreference(key, options)`
+
+Subscribes React state to ONE persisted preference.
+
+This is the component-side half of `getPreferenceStore()`: a render-time value
+is available immediately when the bonded provider can answer synchronously,
+and an asynchronous provider's hydration CONVERGES onto the same component
+without a remount. Ordering is the store's: a read that started before a
+newer write, remove or external change is discarded, so a slow hydration
+never overwrites an edit the user already made.
+
+Pass `null` for `key` while the real key is unknown (no project selected
+yet): the hook then behaves as local state around `defaultValue` and persists
+nothing.
+
+```typescript
+function useStoragePreference<T = unknown>(
+  key: string | null | undefined,
+  options?: UseStoragePreferenceOptions<T>,
+): UseStoragePreferenceResult<T>
+```
+
+- `key` — The storage key, or `null` when there is nothing to persist.
+- `options` — `defaultValue`, reported until the provider supplies one.
+
+**Returns:** The current value, its mutators, and whether it is definite yet.
+
 #### `useStorage()`
 
 Hook for simple storage operations without React state sync.
@@ -3213,7 +3282,7 @@ Peer dependencies:
 
 - `@molecule/app-keyboard` ^1.0.1
 - `@molecule/app-lifecycle` ^1.0.1
-- `@molecule/app-react` ^2.0.0
+- `@molecule/app-react` ^3.0.0
 - `react` ^18.0.0 || ^19.0.0
 - `react-native` >=0.72.0
 - `react-native-safe-area-context` >=4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/app-react-native",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "React Native framework bindings for molecule.dev",
   "homepage": "https://www.molecule.dev/packages/app-react-native",
   "type": "module",
@@ -33,7 +33,7 @@
     "directory": "packages/app/frameworks/react-native"
   },
   "devDependencies": {
-    "@molecule/app-react": "2.0.1",
+    "@molecule/app-react": "3.0.0",
     "@types/node": "26.6.5",
     "react": "19.3.1",
     "typescript": "6.0.3",
@@ -42,7 +42,7 @@
   "peerDependencies": {
     "@molecule/app-keyboard": "^1.0.1",
     "@molecule/app-lifecycle": "^1.0.1",
-    "@molecule/app-react": "^2.0.0",
+    "@molecule/app-react": "^3.0.0",
     "react": "^18.0.0 || ^19.0.0",
     "react-native": ">=0.72.0",
     "react-native-safe-area-context": ">=4.0.0"