@elqnt/admin 2.0.5 → 2.2.0

package/dist/hooks/index.d.ts

@@ -0,0 +1,249 @@
+import { ApiClientOptions } from '@elqnt/api-client';
+import { Org, OrgInfo, OrgSchemaTypeTS, CreateOrgWithSchemasResponse, User, UserSettingsResponse, UserSettings, NotificationPreferences, Invite, InviteInput, InvitesResult, AnalyticsSummary, ChatAnalytics, AgentAnalytics, UsageAnalytics, DailyAnalytics, AnalyticsEvent, DateFilter, GlobalAnalyticsSummary, OrgAnalytics, CreateOrgRequest, OrgArtifactTypeTS } from '../models/index.js';
+import { L as ListOrgsFilter, P as ProvisioningProgress, V as ValidationResult } from '../provisioning-Il9t2jnH.js';
+import { OrgSettings } from '@elqnt/agents/models';
+import '@elqnt/types';
+
+type UseOrgAdminOptions = ApiClientOptions;
+/**
+ * Hook for organization CRUD operations
+ *
+ * @example
+ * ```tsx
+ * const { loading, error, listOrgs, createOrg, updateOrg } = useOrgAdmin({
+ *   baseUrl: apiGatewayUrl,
+ *   orgId: selectedOrgId,
+ *   userId: user?.id,
+ *   userEmail: user?.email,
+ * });
+ *
+ * const orgs = await listOrgs();
+ * const newOrg = await createOrg({ name: "Acme Corp" });
+ * ```
+ */
+declare function useOrgAdmin(options: UseOrgAdminOptions): {
+    loading: boolean;
+    error: string | null;
+    listOrgs: (filter?: ListOrgsFilter) => Promise<Org[]>;
+    getOrg: (orgId: string) => Promise<Org | null>;
+    getOrgInfo: (orgId: string) => Promise<OrgInfo | null>;
+    createOrg: (org: Partial<Org>) => Promise<Org | null>;
+    createOrgWithSchemas: (org: Partial<Org>, schemas: OrgSchemaTypeTS[]) => Promise<CreateOrgWithSchemasResponse | null>;
+    updateOrg: (orgId: string, updates: Partial<Org>) => Promise<Org | null>;
+    deleteOrg: (orgId: string) => Promise<boolean>;
+};
+
+type UseUsersAdminOptions = ApiClientOptions;
+/**
+ * Hook for user CRUD operations
+ *
+ * @example
+ * ```tsx
+ * const { loading, error, listUsers, createUser, updateUser } = useUsersAdmin({
+ *   baseUrl: apiGatewayUrl,
+ *   orgId: selectedOrgId,
+ *   userId: user?.id,
+ *   userEmail: user?.email,
+ * });
+ *
+ * const users = await listUsers();
+ * const user = await getUserByEmail("user@example.com");
+ * ```
+ */
+declare function useUsersAdmin(options: UseUsersAdminOptions): {
+    loading: boolean;
+    error: string | null;
+    listUsers: () => Promise<User[]>;
+    getUser: (userId: string) => Promise<User | null>;
+    getUserByEmail: (email: string) => Promise<User | null>;
+    getUserByPhone: (phone: string) => Promise<User | null>;
+    createUser: (user: Partial<User>) => Promise<User | null>;
+    updateUser: (userId: string, updates: Partial<User>) => Promise<User | null>;
+    deleteUser: (userId: string) => Promise<boolean>;
+    getUserSettings: (userId: string) => Promise<UserSettingsResponse | null>;
+    updateUserSettings: (userId: string, settings: {
+        settings?: UserSettings;
+        notificationPreferences?: NotificationPreferences;
+    }) => Promise<UserSettingsResponse | null>;
+};
+
+type UseInvitesAdminOptions = ApiClientOptions;
+/**
+ * Hook for invitation CRUD operations
+ *
+ * @example
+ * ```tsx
+ * const { loading, error, listInvites, sendInvite, revokeInvite } = useInvitesAdmin({
+ *   baseUrl: apiGatewayUrl,
+ *   orgId: selectedOrgId,
+ *   userId: user?.id,
+ *   userEmail: user?.email,
+ * });
+ *
+ * const invites = await listInvites();
+ * await sendInvite({ email: "user@example.com", role: "member" });
+ * ```
+ */
+declare function useInvitesAdmin(options: UseInvitesAdminOptions): {
+    loading: boolean;
+    error: string | null;
+    listInvites: () => Promise<Invite[]>;
+    getInvite: (inviteId: string) => Promise<Invite | null>;
+    sendInvite: (invite: InviteInput) => Promise<Invite | null>;
+    sendInvites: (invites: InviteInput[]) => Promise<InvitesResult | null>;
+    resendInvite: (inviteId: string) => Promise<Invite | null>;
+    revokeInvite: (inviteId: string) => Promise<boolean>;
+    acceptInvite: (inviteId: string) => Promise<Invite | null>;
+};
+
+type UseOrgSettingsOptions = ApiClientOptions;
+/**
+ * Hook for organization settings CRUD operations
+ *
+ * @example
+ * ```tsx
+ * const { loading, error, getSettings, createSettings, updateSettings } = useOrgSettings({
+ *   baseUrl: apiGatewayUrl,
+ *   orgId: selectedOrgId,
+ * });
+ *
+ * const settings = await getSettings();
+ * await updateSettings({ timezone: "America/New_York" });
+ * ```
+ */
+declare function useOrgSettings(options: UseOrgSettingsOptions): {
+    loading: boolean;
+    error: string | null;
+    getSettings: () => Promise<OrgSettings | null>;
+    createSettings: (settings: Partial<OrgSettings>) => Promise<OrgSettings | null>;
+    updateSettings: (settings: Partial<OrgSettings>) => Promise<OrgSettings | null>;
+};
+
+type UseProductAnalyticsOptions = ApiClientOptions;
+interface ProductAnalyticsState {
+    summary: AnalyticsSummary | null;
+    chats: ChatAnalytics[];
+    agents: AgentAnalytics[];
+    usage: UsageAnalytics[];
+    daily: DailyAnalytics[];
+    events: AnalyticsEvent[];
+    loading: boolean;
+    error: string | null;
+}
+/**
+ * Hook for product analytics queries and event tracking
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   loading,
+ *   error,
+ *   summary,
+ *   getSummary,
+ *   trackEvent,
+ * } = useProductAnalytics({
+ *   baseUrl: apiGatewayUrl,
+ *   orgId: user?.orgId,
+ *   userId: user?.id,
+ *   userEmail: user?.email,
+ * });
+ *
+ * // Fetch analytics
+ * await getSummary({ from: "2024-01-01", to: "2024-12-31" });
+ *
+ * // Track events
+ * trackEvent("button_click", "ui", { buttonId: "submit" });
+ * ```
+ */
+declare function useProductAnalytics(options: UseProductAnalyticsOptions): {
+    getSummary: (filter?: DateFilter) => Promise<AnalyticsSummary | null>;
+    getChats: (filter?: DateFilter, agentId?: string) => Promise<ChatAnalytics[]>;
+    getAgents: (filter?: DateFilter) => Promise<AgentAnalytics[]>;
+    getUsage: (filter?: DateFilter) => Promise<UsageAnalytics[]>;
+    getDaily: (filter?: DateFilter) => Promise<DailyAnalytics[]>;
+    getEvents: (filter?: DateFilter) => Promise<AnalyticsEvent[]>;
+    trackEvent: (eventType: string, eventCategory: string, properties?: Record<string, unknown>) => Promise<void>;
+    trackPageView: (pageName?: string) => Promise<void>;
+    getGlobalSummary: (filter?: DateFilter) => Promise<GlobalAnalyticsSummary | null>;
+    getGlobalOrgs: (filter?: DateFilter) => Promise<OrgAnalytics[]>;
+    summary: AnalyticsSummary | null;
+    chats: ChatAnalytics[];
+    agents: AgentAnalytics[];
+    usage: UsageAnalytics[];
+    daily: DailyAnalytics[];
+    events: AnalyticsEvent[];
+    loading: boolean;
+    error: string | null;
+};
+/**
+ * Hook to use analytics context (for event tracking throughout the app)
+ *
+ * This is an alias for useProductAnalytics that makes the intent clearer
+ * when used primarily for event tracking.
+ *
+ * @example
+ * ```tsx
+ * const { trackEvent } = useAnalyticsContext(options);
+ * trackEvent("form_submit", "ui", { formId: "contact" });
+ * ```
+ */
+declare const useAnalyticsContext: typeof useProductAnalytics;
+
+type UseOrgProvisioningOptions = ApiClientOptions;
+interface ProvisioningState {
+    status: "idle" | "creating" | "provisioning" | "completed" | "failed" | "partial";
+    progress: ProvisioningProgress | null;
+    org: Org | null;
+    error: string | null;
+    percentage: number;
+}
+/**
+ * Hook for organization provisioning with real-time progress
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   state,
+ *   createOrgWithProvisioning,
+ *   retryProvisioning,
+ *   cancelProvisioning,
+ * } = useOrgProvisioning({
+ *   baseUrl: apiGatewayUrl,
+ *   orgId: selectedOrgId,
+ * });
+ *
+ * // Create org and track progress
+ * await createOrgWithProvisioning({
+ *   title: "Acme Corp",
+ *   product: "eloquent",
+ * });
+ *
+ * // state.progress will update in real-time
+ * console.log(state.percentage); // 0-100
+ * ```
+ */
+declare function useOrgProvisioning(options: UseOrgProvisioningOptions): {
+    state: ProvisioningState;
+    createOrgWithProvisioning: (request: CreateOrgRequest) => Promise<Org | null>;
+    getProvisioningStatus: (orgId: string) => Promise<ProvisioningProgress | null>;
+    retryProvisioning: (orgId: string, artifacts?: OrgArtifactTypeTS[]) => Promise<boolean>;
+    validateProvisioning: (orgId: string) => Promise<ValidationResult | null>;
+    cancelProvisioning: (orgId: string) => Promise<boolean>;
+    cleanupOrg: (orgId: string) => Promise<boolean>;
+    reset: () => void;
+    isComplete: boolean;
+    isFailed: boolean;
+    isPartial: boolean;
+    isProvisioning: boolean;
+    failedArtifacts: {
+        type: OrgArtifactTypeTS;
+        status: string;
+        critical: boolean;
+        error?: string;
+        duration?: number;
+        estimatedDuration?: number;
+    }[];
+    hasCriticalFailures: boolean;
+};
+
+export { type ProductAnalyticsState, type ProvisioningState, type UseInvitesAdminOptions, type UseOrgAdminOptions, type UseOrgProvisioningOptions, type UseOrgSettingsOptions, type UseProductAnalyticsOptions, type UseUsersAdminOptions, useAnalyticsContext, useInvitesAdmin, useOrgAdmin, useOrgProvisioning, useOrgSettings, useProductAnalytics, useUsersAdmin };