@molecule/app-angular 3.2.1 → 3.2.2

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-04T14:09:03.868Z
+Generated: 2026-11-08T06:24:39.687Z
 -->
 
 # @molecule/app-angular
@@ -100,25 +100,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).
    */
@@ -139,58 +144,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-angular/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`
 
@@ -204,72 +233,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.
    *
@@ -281,6 +315,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.
    *
@@ -291,6 +326,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.
    */
@@ -298,14 +334,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.
    */
@@ -324,26 +363,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.
    */
@@ -365,54 +410,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.
    *
@@ -424,11 +480,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`.
@@ -459,6 +517,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).
    *
@@ -480,6 +539,7 @@ interface I18nProvider {
    * Gets the current locale.
    */
   getLocale(): string
+
   /**
    * Sets the current locale.
    *
@@ -494,14 +554,17 @@ interface I18nProvider {
    * from a working one until a user notices the wrong language on screen.
    */
   setLocale(locale: string): Promise<void>
+
   /**
    * Gets all available locales.
    */
   getLocales(): LocaleConfig[]
+
   /**
    * Adds a locale.
    */
   addLocale(config: LocaleConfig): void
+
   /**
    * Removes a locale by code, notifying subscribers so language pickers
    * built on `onLocaleChange` re-render their list. If the removed locale
@@ -513,6 +576,7 @@ interface I18nProvider {
    * otherwise.
    */
   removeLocale(code: string): boolean
+
   /**
    * Adds translations to a locale. Auto-creates the locale if it doesn't exist.
    *
@@ -523,6 +587,7 @@ interface I18nProvider {
    * contract on the API side.
    */
   addTranslations(locale: string, translations: Translations, namespace?: string): void
+
   /**
    * Translates a key with optional interpolation values and pluralization.
    *
@@ -540,11 +605,9 @@ interface I18nProvider {
   t(
     key: string,
     values?: InterpolationValues,
-    options?: {
-      defaultValue?: string
-      count?: number
-    },
+    options?: { defaultValue?: string; count?: number },
   ): string
+
   /**
    * Checks if a translation key exists.
    *
@@ -559,46 +622,42 @@ interface I18nProvider {
    * @returns `true` if the key has a translation.
    */
   exists(key: string): boolean
+
   /**
    * Formats a number according to the current locale.
    *
    * @returns The locale-formatted number string.
    */
   formatNumber(value: number, options?: NumberFormatOptions): string
+
   /**
    * Formats a date according to the current locale.
    *
    * @returns The locale-formatted date string.
    */
   formatDate(value: Date | number | string, options?: DateFormatOptions): string
+
   /**
    * Formats a relative time (e.g. "2 hours ago").
    *
    * @returns The locale-formatted relative time string.
    */
-  formatRelativeTime(
-    value: Date | number,
-    options?: {
-      unit?: Intl.RelativeTimeFormatUnit
-    },
-  ): string
+  formatRelativeTime(value: Date | number, options?: { unit?: Intl.RelativeTimeFormatUnit }): string
+
   /**
    * Formats a list (e.g. "A, B, and C").
    *
    * @returns The locale-formatted list string.
    */
-  formatList(
-    values: string[],
-    options?: {
-      type?: 'conjunction' | 'disjunction' | 'unit'
-    },
-  ): string
+  formatList(values: string[], options?: { type?: 'conjunction' | 'disjunction' | 'unit' }): string
+
   /**
    * Subscribes to locale changes.
    *
    * @returns An unsubscribe function.
    */
   onLocaleChange(listener: (locale: string) => void): () => void
+
   /**
    * Gets a counter that advances for every change `onLocaleChange` announces:
    * a locale switch, a locale-list change, or translations added for a locale
@@ -620,24 +679,29 @@ interface I18nProvider {
    * @returns The provider's current revision.
    */
   getRevision?(): number
+
   /**
    * Gets the text direction for the current locale.
    *
    * @returns `'ltr'` or `'rtl'`.
    */
   getDirection(): 'ltr' | 'rtl'
+
   /**
    * Checks if a translation key exists (alias for exists).
    */
   hasKey?(key: string): boolean
+
   /**
    * Checks if the provider is ready.
    */
   isReady?(): boolean
+
   /**
    * Registers a callback for when the provider is ready.
    */
   onReady?(callback: () => void): () => void
+
   /**
    * Registers a lazily-loaded content module for automatic reload on locale changes.
    * All registered content is reloaded during `setLocale()` before listeners fire,
@@ -660,42 +724,52 @@ interface Logger {
    * Logs a trace message.
    */
   trace(message: string, ...args: unknown[]): void
+
   /**
    * Logs a debug message.
    */
   debug(message: string, ...args: unknown[]): void
+
   /**
    * Logs an info message.
    */
   info(message: string, ...args: unknown[]): void
+
   /**
    * Logs a warning message.
    */
   warn(message: string, ...args: unknown[]): void
+
   /**
    * Logs an error message.
    */
   error(message: string | Error, ...args: unknown[]): void
+
   /**
    * Sets the log level.
    */
   setLevel(level: LogLevel): void
+
   /**
    * Gets the current log level.
    */
   getLevel(): LogLevel
+
   /**
    * Creates a child logger with a namespace.
    */
   child(name: string, context?: Record<string, unknown>): Logger
+
   /**
    * Adds additional context to the logger.
    */
   withContext(context: Record<string, unknown>): Logger
+
   /**
    * Adds a transport.
    */
   addTransport(transport: LogTransport): () => void
+
   /**
    * Removes a transport.
    */
@@ -714,30 +788,37 @@ interface LoggerProvider {
    * Gets a logger by name, or the root logger if no name given.
    */
   getLogger(name?: string): Logger
+
   /**
    * Creates a named logger.
    */
   createLogger(nameOrConfig: string | LoggerConfig, config?: LoggerConfig): Logger
+
   /**
    * Sets the global log level.
    */
   setLevel(level: LogLevel): void
+
   /**
    * Gets the global log level.
    */
   getLevel(): LogLevel
+
   /**
    * Adds a global transport.
    */
   addTransport(transport: LogTransport): () => void
+
   /**
    * Enables logging.
    */
   enable(): void
+
   /**
    * Disables logging.
    */
   disable(): void
+
   /**
    * Checks if logging is enabled.
    *
@@ -757,18 +838,22 @@ interface RouteLocation {
    * Current pathname.
    */
   pathname: string
+
   /**
    * Query string (including leading ?).
    */
   search: string
+
   /**
    * Hash (including leading #).
    */
   hash: string
+
   /**
    * State data passed with navigation.
    */
   state?: unknown
+
   /**
    * Unique key for this location.
    */
@@ -788,26 +873,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.
    */
@@ -817,36 +908,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.
    */
@@ -854,26 +953,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.
    */
@@ -891,10 +996,12 @@ interface StoreConfig<T> {
    * Initial state value.
    */
   initialState: T
+
   /**
    * Optional name for debugging.
    */
   name?: string
+
   /**
    * Optional middleware functions.
    */
@@ -914,15 +1021,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.
    */
@@ -956,34 +1066,42 @@ interface StorageProvider {
    * Gets a value from storage.
    */
   get<T = unknown>(key: string): Promise<T | null>
+
   /**
    * Sets a value in storage.
    */
   set<T = unknown>(key: string, value: T): Promise<void>
+
   /**
    * Removes a value from storage.
    */
   remove(key: string): Promise<void>
+
   /**
    * Clears all values from storage.
    */
   clear(): Promise<void>
+
   /**
    * Gets all keys in storage.
    */
   keys(): Promise<string[]>
+
   /**
    * Gets multiple values from storage.
    */
   getMany?<T = unknown>(keys: string[]): Promise<Map<string, T | null>>
+
   /**
    * Sets multiple values in storage.
    */
   setMany?<T = unknown>(entries: Array<[string, T]>): Promise<void>
+
   /**
    * Removes multiple values from storage.
    */
   removeMany?(keys: string[]): Promise<void>
+
   /**
    * Reads a value synchronously.
    *
@@ -997,6 +1115,7 @@ interface StorageProvider {
    * @returns The stored value, or `null` when it is absent, unreadable or corrupt.
    */
   getSync?<T = unknown>(key: string): T | null
+
   /**
    * Subscribes to changes made to a key OUTSIDE this provider instance — for
    * example another browser tab's `localStorage` write.
@@ -1023,16 +1142,19 @@ interface ThemeProvider {
    * Returns the currently active theme.
    */
   getTheme(): Theme
+
   /**
    * Sets the active theme by reference or by name.
    *
    * @param theme - A `Theme` object or a theme name string to activate.
    */
   setTheme(theme: Theme | string): void
+
   /**
    * Toggles between light and dark mode for the active theme.
    */
   toggleMode(): void
+
   /**
    * Subscribes to theme changes. The callback fires whenever
    * `setTheme()` or `toggleMode()` is called.
@@ -1041,11 +1163,13 @@ interface ThemeProvider {
    * @returns An unsubscribe function.
    */
   subscribe(callback: (theme: Theme) => void): () => void
+
   /**
    * Returns all registered themes. Optional — not all providers
    * support multiple themes.
    */
   getThemes?(): Theme[]
+
   /**
    * Returns the theme a render WITHOUT a browser produces — a server or
    * build-time render, which has no storage and no `prefers-color-scheme`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/app-angular",
-  "version": "3.2.1",
+  "version": "3.2.2",
   "description": "Angular framework bindings for molecule.dev",
   "type": "module",
   "main": "dist/index.js",