gentiq 0.7.31 → 0.7.32

package/dist/src/hooks/useGentiqUser.d.ts

@@ -0,0 +1,184 @@
+import { GentiqUser } from '../types';
+export declare const currentUserQueryKey: (cacheNamespace: string) => readonly [string, "currentUser"];
+export interface UseGentiqUserOptions {
+    /** Set to false to defer loading the authenticated user profile. */
+    enabled?: boolean;
+}
+/**
+ * Loads the authenticated Gentiq user and exposes common display values.
+ */
+export declare function useGentiqUser(options?: UseGentiqUserOptions): {
+    user: GentiqUser | null;
+    firstName: string | null;
+    data: GentiqUser;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<GentiqUser, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<GentiqUser>;
+} | {
+    user: GentiqUser | null;
+    firstName: string | null;
+    data: GentiqUser;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<GentiqUser, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<GentiqUser>;
+} | {
+    user: GentiqUser | null;
+    firstName: string | null;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<GentiqUser, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<GentiqUser>;
+} | {
+    user: GentiqUser | null;
+    firstName: string | null;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<GentiqUser, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<GentiqUser>;
+} | {
+    user: GentiqUser | null;
+    firstName: string | null;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<GentiqUser, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<GentiqUser>;
+} | {
+    user: GentiqUser | null;
+    firstName: string | null;
+    data: GentiqUser;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    isEnabled: boolean;
+    refetch: (options?: import('@tanstack/react-query').RefetchOptions) => Promise<import('@tanstack/react-query').QueryObserverResult<GentiqUser, Error>>;
+    fetchStatus: import('@tanstack/react-query').FetchStatus;
+    promise: Promise<GentiqUser>;
+};

package/dist/src/index.d.ts

@@ -19,5 +19,6 @@ export { default as RequireAuth } from './components/RequireAuth';
 export { default as UserLoginPage } from './pages/UserLoginPage';
 export { default as SharedChatView } from './pages/SharedChatView';
 export { useGentiqChat } from './hooks/useGentiqChat';
+export { useGentiqUser, type UseGentiqUserOptions, } from './hooks/useGentiqUser';
 export { useComponents } from './ComponentsContext';
 export { useTranslation, withTranslation, Translation, Trans } from 'react-i18next';

package/dist/src/lib/api.d.ts

@@ -1,4 +1,4 @@
-import { GentiqConfig, GentiqEndpoints } from '../types';
+import { GentiqConfig, GentiqEndpoints, GentiqUser } from '../types';
 export declare const userAPI: {
     init: (config: GentiqConfig) => void;
     getConfig: () => GentiqConfig;
@@ -27,14 +27,14 @@ export declare const userAPI: {
      */
     getPublicAttachmentBlobUrl(object_name: string): Promise<string>;
     saveFeedback: (threadId: string, messageId: string, sentiment: "like" | "dislike" | null) => Promise<any>;
-    getMe: () => Promise<any>;
+    getMe: () => Promise<GentiqUser>;
     updateMe: (data: {
         name?: string;
         surname?: string;
         phone?: string;
         password?: string;
         metadata?: Record<string, any>;
-    }) => Promise<any>;
+    }) => Promise<GentiqUser>;
     pinThread: (threadId: string, pinned: boolean) => Promise<any>;
     shareThread: (threadId: string) => Promise<any>;
     getSharedThread: (shareId: string) => Promise<any>;

package/dist/src/types.d.ts

@@ -1,5 +1,6 @@
 import { ComponentType } from 'react';
 import { UIMessage, UIMessagePart } from 'ai';
+import { TFunction } from 'i18next';
 /**
  * Represents a single conversation thread in the history.
  */
@@ -13,6 +14,35 @@ export interface ConversationEntry {
     /** Whether the thread is pinned to the top of the list. */
     pinned?: boolean;
 }
+/**
+ * The authenticated user's profile returned by Gentiq.
+ */
+export interface GentiqUser {
+    id: string;
+    phone: string;
+    /** The user's first name. */
+    name: string;
+    surname: string;
+    metadata: Record<string, any>;
+    balance?: {
+        tokens: number;
+        requests: number;
+        token_limit: number;
+        request_limit: number;
+        updated_at?: string | null;
+    } | null;
+    created_at?: string;
+}
+/**
+ * User data available when building a personalized welcome greeting.
+ */
+export interface WelcomeGreetingContext {
+    user: GentiqUser | null;
+    firstName: string | null;
+    isLoading: boolean;
+    /** Translate the greeting using Gentiq's active language and resources. */
+    t: TFunction;
+}
 /**
  * Adapter for managing authentication tokens and headers.
  */
@@ -132,8 +162,11 @@ export interface WelcomeSuggestion {
  * Configuration for the welcome/empty-state screen.
  */
 export interface WelcomeScreenConfig {
-    /** Optional override for the welcome message title. */
-    greeting?: string;
+    /**
+     * Optional override for the welcome message title. A function can be used
+     * to personalize the greeting with the authenticated user's first name.
+     */
+    greeting?: string | ((context: WelcomeGreetingContext) => string);
     /** Optional override for the welcome message subtitle. */
     subtitle?: string;
     /** Optional override for the starter prompt suggestions. */

package/package.json

@@ -10,7 +10,7 @@
     "provenance": true
   },
   "description": "React UI library for the Gentiq AI framework.",
-  "version": "0.7.31",
+  "version": "0.7.32",
   "type": "module",
   "files": [
     "dist"