@molecule/app-react 3.4.2 → 3.4.4

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-11-06T00:14:54.331Z
+Generated: 2026-11-08T06:24:47.532Z
 -->
 
 # @molecule/app-react
@@ -200,25 +200,30 @@ interface AuthState<T = UserProfile> {
    * never signs out. See {@link AuthStatus}.
    */
   status: AuthStatus
+
   /**
    * Whether auth state has been initialized.
    */
   initialized: boolean
+
   /**
    * Whether the client has an authenticated session. This is not a server
    * confirmation flag: during `'unavailable'` it can be false for a retained
    * token/cookie-only candidate with no cached profile. Use `status` for redirects.
    */
   authenticated: boolean
+
   /**
    * Current user, or null when none is cached. In particular, an `'unavailable'`
    * token/cookie-only restore has a retained candidate but no profile yet.
    */
   user: T | null
+
   /**
    * Whether an auth operation is in progress.
    */
   loading: boolean
+
   /**
    * Last auth error (if any).
    */
@@ -239,58 +244,82 @@ interface AuthClient<
 > {
   /** Returns the current authentication state snapshot. */
   getState(): AuthState<T>
+
   /** Returns whether the user is currently authenticated. */
   isAuthenticated(): boolean
+
   /** Gets the current user. */
   getUser(): T | null
+
   /** Optional ownership marker for the current session. */
   getSessionRevision?(): number
+
   /** Updates the cached user object (state + persistent storage) without hitting the network. */
   setUser(user: T | null): void
+
   /** Gets the current access token. */
   getAccessToken(): string | null
+
   /** Stores the access token in the configured token storage adapter (in a browser, Web Storage; `'memory'` where no browser store exists). */
   setAccessToken(token: string | null): void
+
   /** Adopts a session an out-of-band exchange already established: stores the access token (and the refresh token when given), caches the user, and sets the COMPLET… */
   setSession(session: AuthSessionSeed<T>): void
+
   /** Gets the refresh token. */
   getRefreshToken(): string | null
+
   /** Logs in with credentials. */
   login(credentials: LoginCredentials): Promise<AuthResult<T>>
+
   /** Logs out the current user. */
   logout(): Promise<void>
+
   /** Registers a new user. */
   register(data: RegisterData<TRegister>): Promise<AuthResult<T>>
+
   /** Refreshes the access token. */
   refresh(): Promise<AuthResult<T>>
+
   /** Requests a password reset. */
   requestPasswordReset(data: PasswordResetRequest): Promise<void>
+
   /** Confirms a password reset. */
   confirmPasswordReset(data: PasswordResetConfirm): Promise<void>
+
   /** Updates the current user's profile. */
   updateProfile(data: Partial<T>): Promise<T>
+
   /** Changes the current user's password. */
   changePassword(oldPassword: string, newPassword: string): Promise<void>
+
   /** Initializes auth state (e.g., from stored tokens). */
   initialize(): Promise<void>
+
   /** Re-checks a restored session against the server, in the background — the boot-time validation an app with a stored token needs when a revoked or expired token… */
   validateSession?(): Promise<void>
+
   /** Resolves when the session restore started by `initialize()` has settled — the point after which the client knows whether this visitor is signed in. */
   whenRestored?(): Promise<void>
+
   /** Subscribes to auth state changes. */
   subscribe(callback: (state: AuthState<T>) => void): () => void
+
   /** Subscribes to auth state changes (alias for subscribe). */
   onAuthChange(callback: (state: AuthState<T>) => void): () => void
+
   /** Gets the current access token (alias for getAccessToken). */
   getToken?(): string | null
+
   /** Adds an auth event listener. */
   addEventListener(listener: AuthEventListener<T>): () => void
+
   /** Destroys the auth client. */
   destroy(): void
 }
 ```
 
-_(Member comments are shortened to their first sentence to fit; the full declaration is in `node_modules/@molecule/app-react/dist`.)_
+_(Member comments are shortened to their first sentence to fit; the full declaration is in `node_modules/@molecule/app-auth/dist/types.d.ts`.)_
 
 #### `FormController`
 
@@ -304,72 +333,77 @@ interface FormController<T extends FormValuesConstraint<T> = Record<string, unkn
    * Gets the current form state.
    */
   getState(): FormState<T>
+
   /**
    * Gets the value of a specific field.
    */
   getValue(name: string): unknown
   getValue<K extends keyof T>(name: K): T[K]
+
   /**
    * Gets all form values.
    */
   getValues(): T
+
   /**
    * Sets the value of a specific field.
    */
   setValue(
     name: string,
     value: unknown,
-    options?: {
-      shouldValidate?: boolean
-      shouldDirty?: boolean
-      shouldTouch?: boolean
-    },
+    options?: { shouldValidate?: boolean; shouldDirty?: boolean; shouldTouch?: boolean },
   ): void
+
   /**
    * Sets multiple values at once.
    */
-  setValues(
-    values: Partial<T>,
-    options?: {
-      shouldValidate?: boolean
-    },
-  ): void
+  setValues(values: Partial<T>, options?: { shouldValidate?: boolean }): void
+
   /**
    * Gets the error for a specific field.
    */
   getError(name: string): string | undefined
+
   /**
    * Sets the error for a specific field.
    */
   setError(name: string, error: string | undefined): void
+
   /**
    * Clears the error for a specific field.
    */
   clearError<K extends keyof T>(name: K): void
+
   /**
    * Clears all errors.
    */
   clearErrors(): void
+
   /**
    * Gets the field state for a specific field.
    */
   getFieldState<K extends keyof T>(name: K): FieldState<T[K]>
+
   /**
    * Registers a field for form management.
    */
   register(nameOrOptions: string | RegisterOptions, options?: RegisterOptions): FieldRegistration
+
   /**
    * Unregisters a field.
    */
   unregister(name: string): void
+
   /**
    * Validates a specific field.
    */
   validateField<K extends keyof T>(name: K): Promise<boolean>
+
   /**
    * Validates all fields.
    */
   validate(): Promise<boolean>
+
   /**
    * Resets the form and clears errors, touched fields and submission state.
    *
@@ -381,6 +415,7 @@ interface FormController<T extends FormValuesConstraint<T> = Record<string, unkn
    * record and cancels a pending submit.
    */
   reset(values?: Partial<T>): void
+
   /**
    * Applies externally loaded values without clearing submission state.
    *
@@ -391,6 +426,7 @@ interface FormController<T extends FormValuesConstraint<T> = Record<string, unkn
    * submit. Equal-content baselines cause no update.
    */
   updateValues(values: Partial<T>, resetOptions?: FormResetOptions): void
+
   /**
    * Handles form submission.
    */
@@ -398,14 +434,17 @@ interface FormController<T extends FormValuesConstraint<T> = Record<string, unkn
     onSubmit: (values: T) => void | Promise<void>,
     onError?: (errors: Partial<Record<keyof T, string>>) => void,
   ): (event?: { preventDefault?: () => void }) => Promise<void>
+
   /**
    * Sets focus to a field.
    */
   setFocus(name: keyof T): void
+
   /**
    * Subscribes to form state changes.
    */
   subscribe(callback: (state: FormState<T>) => void): () => void
+
   /**
    * Destroys the form controller.
    */
@@ -439,26 +478,32 @@ interface FormOptions<T extends FormValuesConstraint<T>> {
    * is created. Mutating this object afterwards does not change the baseline.
    */
   defaultValues?: Partial<T>
+
   /**
    * Externally loaded values, merged over `defaultValues` as the clean
    * baseline. Framework bindings also apply later content changes; use
    * `resetOptions.keepDirtyValues` to preserve edits while pristine fields fill.
    */
   values?: Partial<T>
+
   /** Controls how framework bindings apply changed `values`. */
   resetOptions?: FormResetOptions
+
   /**
    * Validation mode.
    */
   mode?: 'onSubmit' | 'onChange' | 'onBlur' | 'all'
+
   /**
    * Revalidation mode.
    */
   reValidateMode?: 'onChange' | 'onBlur' | 'onSubmit'
+
   /**
    * Whether to focus the first error field on submit.
    */
   shouldFocusError?: boolean
+
   /**
    * Form-level validation function.
    */
@@ -480,54 +525,65 @@ interface HttpClient {
    * Base URL for all requests.
    */
   baseURL: string
+
   /**
    * Default headers for all requests.
    */
   defaultHeaders: Record<string, string>
+
   /**
    * Makes a generic HTTP request. `data` is a field of THIS config object — the same body
    * `post(url, data, config)` takes as its second argument.
    */
   request<T = unknown>(config: FullRequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a GET request.
    */
   get<T = unknown>(url: string, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a POST request. `data` is the request BODY, not a config object: the wire body is
    * `data` itself, so `post(url, { data: body })` sends `{"data":body}` — pass `body` directly.
    * A config (headers, params) is the THIRD argument.
    */
   post<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a PUT request. `data` is the request BODY (second argument) — never `{ data: body }`,
    * which sends `{"data":body}`; a config is the THIRD argument.
    */
   put<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a PATCH request. `data` is the request BODY (second argument) — never `{ data: body }`,
    * which sends `{"data":body}`; a config is the THIRD argument.
    */
   patch<T = unknown>(url: string, data?: unknown, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Makes a DELETE request.
    */
   delete<T = unknown>(url: string, config?: RequestConfig): Promise<HttpResponse<T>>
+
   /**
    * Adds a request interceptor.
    * Returns a function to remove the interceptor.
    */
   addRequestInterceptor(interceptor: RequestInterceptor): () => void
+
   /**
    * Adds a response interceptor.
    * Returns a function to remove the interceptor.
    */
   addResponseInterceptor(interceptor: ResponseInterceptor): () => void
+
   /**
    * Adds an error interceptor.
    * Returns a function to remove the interceptor.
    */
   addErrorInterceptor(interceptor: ErrorInterceptor): () => void
+
   /**
    * Sets the authorization token.
    *
@@ -539,11 +595,13 @@ interface HttpClient {
    * the resolver is removed, the static token is sent again.
    */
   setAuthToken(token: string | null): void
+
   /**
    * Returns the token the client applies to its next request: the resolver's answer when one
    * is registered, else the static token from `setAuthToken`.
    */
   getAuthToken(): string | null
+
   /**
    * Registers the LIVE token resolver every request of this client reads, or clears it with
    * `null`.
@@ -574,6 +632,7 @@ interface HttpClient {
    * @param resolver - Returns the current access token (or null/undefined), or `null` to clear.
    */
   setAuthTokenResolver?(resolver: AuthTokenResolver | null): void
+
   /**
    * Registers a handler for authentication errors (401).
    *
@@ -595,26 +654,32 @@ interface Router {
    * Returns the current route location (pathname, search, hash, state).
    */
   getLocation(): RouteLocation
+
   /**
    * Gets the current route params.
    */
   getParams<T extends RouteParams = RouteParams>(): T
+
   /**
    * Gets the current query params.
    */
   getQuery(): QueryParams
+
   /**
    * Gets a specific query parameter.
    */
   getQueryParam(key: string): string | undefined
+
   /**
    * Gets the current hash.
    */
   getHash(): string
+
   /**
    * Navigates to a path.
    */
   navigate(path: string, options?: NavigateOptions): void
+
   /**
    * Navigates to a named route.
    */
@@ -624,36 +689,44 @@ interface Router {
     query?: QueryParams,
     options?: NavigateOptions,
   ): void
+
   /**
    * Goes back in history.
    */
   back(): void
+
   /**
    * Goes forward in history.
    */
   forward(): void
+
   /**
    * Goes to a specific point in history.
    */
   go(delta: number): void
+
   /**
    * Updates the current query params.
    */
   setQuery(params: QueryParams, options?: NavigateOptions): void
+
   /**
    * Updates a specific query parameter.
    */
   setQueryParam(key: string, value: string | undefined, options?: NavigateOptions): void
+
   /**
    * Updates the current hash.
    */
   setHash(hash: string, options?: NavigateOptions): void
+
   /**
    * Checks if a path matches the current location.
    *
    * @returns `true` if the path matches the current route.
    */
   isActive(path: string, exact?: boolean): boolean
+
   /**
    * Matches a path pattern against a pathname.
    */
@@ -661,26 +734,32 @@ interface Router {
     pattern: string,
     pathname: string,
   ): RouteMatch<Params> | null
+
   /**
    * Generates a URL from a named route.
    */
   generatePath(name: string, params?: RouteParams, query?: QueryParams): string
+
   /**
    * Subscribes to route changes.
    */
   subscribe(listener: RouteChangeListener): () => void
+
   /**
    * Adds a navigation guard.
    */
   addGuard(guard: NavigationGuard): () => void
+
   /**
    * Registers route definitions.
    */
   registerRoutes(routes: RouteDefinition[]): void
+
   /**
    * Gets all registered routes.
    */
   getRoutes(): RouteDefinition[]
+
   /**
    * Destroys the router.
    */
@@ -698,10 +777,12 @@ interface RouterConfig {
    * Router mode.
    */
   mode?: 'history' | 'hash' | 'memory'
+
   /**
    * Base path.
    */
   basePath?: string
+
   /**
    * Initial routes.
    */
@@ -719,10 +800,12 @@ interface StoreConfig<T> {
    * Initial state value.
    */
   initialState: T
+
   /**
    * Optional name for debugging.
    */
   name?: string
+
   /**
    * Optional middleware functions.
    */
@@ -742,15 +825,18 @@ interface Store<T> {
    * Gets the current state.
    */
   getState(): T
+
   /**
    * Sets the state (partial or via updater function).
    */
   setState(partial: Partial<T> | ((state: T) => Partial<T>)): void
+
   /**
    * Subscribes to state changes.
    * Returns an unsubscribe function.
    */
   subscribe(listener: StateListener<T>): () => void
+
   /**
    * Destroys the store and cleans up subscriptions.
    */
@@ -2075,7 +2161,7 @@ client's `AuthResult<MyUser>`; there is no separate `useRegister` hook.
 An app whose API takes its OWN registration fields passes the client's
 second generic here too — `useAuth<MyUser, { username: string }>()` — so
 `register({ email, password, username })` is typed exactly like the client
-call (and `requestBody` receives the same payload). Without it, `register`
+call (and `mapRequestBody` receives that payload as its first argument). Without it, `register`
 accepts only the base fields.
 
 ```typescript

package/dist/hooks/useAuth.d.ts

@@ -42,7 +42,7 @@ export declare function useAuthClient<T = unknown, TRegister extends RegisterExt
  * An app whose API takes its OWN registration fields passes the client's
  * second generic here too — `useAuth<MyUser, { username: string }>()` — so
  * `register({ email, password, username })` is typed exactly like the client
- * call (and `requestBody` receives the same payload). Without it, `register`
+ * call (and `mapRequestBody` receives that payload as its first argument). Without it, `register`
  * accepts only the base fields.
  *
  * @param options - Hook options

package/dist/hooks/useAuth.js

@@ -51,7 +51,7 @@ export function useAuthClient() {
  * An app whose API takes its OWN registration fields passes the client's
  * second generic here too — `useAuth<MyUser, { username: string }>()` — so
  * `register({ email, password, username })` is typed exactly like the client
- * call (and `requestBody` receives the same payload). Without it, `register`
+ * call (and `mapRequestBody` receives that payload as its first argument). Without it, `register`
  * accepts only the base fields.
  *
  * @param options - Hook options

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/app-react",
-  "version": "3.4.2",
+  "version": "3.4.4",
   "description": "React framework bindings for molecule.dev",
   "type": "module",
   "main": "dist/index.js",
@@ -61,7 +61,7 @@
   },
   "devDependencies": {
     "@molecule/app-ai-models": "1.4.4",
-    "@molecule/app-bonds-default-react": "3.0.2",
+    "@molecule/app-bonds-default-react": "3.0.3",
     "@molecule/app-i18n": "1.1.2",
     "@testing-library/dom": "10.4.2",
     "@testing-library/react": "16.3.3",