Skip to main content

Stores and Types

Store Exports​

  • useAppStore — authentication state, current user info, menu maps, and permission tokens; persisted (isAuthenticated / custom / authTokens survive reload).
  • useTabStore — the open-tabs list backing the multi-tab layout; persisted.
  • useThemeStore — color scheme, semantic theme colors, menu layout mode, and layout toggles; persisted.

All three are created with createPersistedStore (see Store and Atom) — their state types do not need a name field; the storage key comes from the persistence options instead.

Related types:

  • AppState
  • Tab
  • TabState
  • ColorScheme — "system" | "light" | "dark"
  • ThemeColors — Record<SemanticColor, string>
  • MenuLayoutMode — "vertical" | "horizontal" | "mixed"
  • ThemeState

API and Domain Types​

Entity identity:

  • Entity<TId = string> — base interface that only carries id

Standalone audit field interfaces (use these for composite primary keys or non-id keyed records):

  • CreationTracked<TId, TDate> — createdAt / createdBy / createdByName
  • FullTracked<TId, TDate> — extends CreationTracked with updatedAt / updatedBy / updatedByName

Composed entity interfaces:

  • CreationAuditedEntity<TId, TDate> — Entity + CreationTracked
  • FullAuditedEntity<TId, TDate> — Entity + FullTracked

Batch parameter helper:

  • Many<T> — wraps a list: T[] for batch create / update payloads

User and Menu Types​

  • Gender — "male" | "female" | "unknown"
  • UserMenuType — "directory" | "menu" | "view" | "report", open to project-specific extension via LiteralUnion
  • UserMenu — type / path / name / icon? / meta? / children?
  • UserMenuMeta — params?: Record<string, string> and search?: Record<string, string> bound to a menu's route, plus any keys augmented onto Register['menuMeta']
  • UserInfo — details is typed via the Register augmentation point (see below)
  • AppCustomState — the shape of AppState.custom; defaults to AnyObject, narrowed via Register['appCustomState']
  • ChallengeSpec — { data?: unknown; response: unknown }, the contract for one login challenge type
  • ResolvedChallenges — the challenge-type registry resolved from Register['challenges'], or an open Record<string, ChallengeSpec> when not augmented
  • Register — empty interface that projects augment via declare module to refine UserInfo['details'], AppState.custom, UserMenuMeta, and the login challenge registry. For the built-in password_change challenge, register PasswordChangeChallengeSpec under PASSWORD_CHANGE_CHALLENGE_TYPE — see Login challenges
  • UserDetails — fallback shape (Record<string, unknown>) when Register['userDetails'] is not augmented
  • OrderSpec — { column: string; direction: "asc" | "desc" }

Extending UserInfo.details​

UserInfo.details resolves through the Register interface, mirroring the pattern used by @tanstack/react-query for mutationMeta. Augment it once in your project to get strongly typed user attributes everywhere UserInfo flows through the app:

// src/types/vef-augment.d.ts
declare module "@vef-framework-react/starter" {
  interface Register {
    userDetails: {
      department: string;
      organization: string;
    };
  }
}

After this declaration, userInfo.details.department is typed as string across the application without forking the framework. The same Register interface also accepts appCustomState, menuMeta, and challenges members for the other extension points above.

Router Types​

  • RouterContext

Query Helpers​

  • extractQueryParams
  • noopMutationFn