@adonis-agora/authkit-react/build/src/queries/admin/index.d.ts

Frontend ergonomics over AuthKit for AdonisJS + Inertia + React apps: a typed useAuth() hook, role-gating hooks and gating components.

import type { AdminClient, AdminClientListResult, AdminOrgDetail, AdminOrgEntry, AdminOrgInvitation, AdminOrgListResult, AdminOverview, AdminUser, AdminUserListResult, AuditListParams, AuditListResult, CreateClientInput, CreatedClientResult, CreateOrgInput, CreateRoleInput, CreateUserInput, ImpersonationPanel, KeysRotateInput, KeysRotateResult, KeysStatus, RegenerateSecretResult, RevokeSessionsResult, RoleCatalogEntry, RoleListResult, SettingEntry, SettingListResult, UpdateClientInput, UpdateOrgInput, UpdateRoleInput, UpdateUserInput, UserSessionsResult } from '../../client/types.js';
export declare function useOverviewQueryOptions(): {
    queryKey: readonly ["authkit", "admin", "overview"];
    queryFn: () => Promise<AdminOverview>;
};
export declare function useUsersQueryOptions(params?: {
    search?: string;
    page?: number;
    size?: number;
}): {
    queryKey: readonly ["authkit", "admin", "users", {
        search?: string;
        page?: number;
        size?: number;
    }];
    queryFn: () => Promise<AdminUserListResult>;
};
export declare function useUserQueryOptions(id: string): {
    queryKey: readonly ["authkit", "admin", "users", string];
    queryFn: () => Promise<AdminUser>;
    enabled: boolean;
};
export declare function useUserSessionsQueryOptions(id: string): {
    queryKey: readonly ["authkit", "admin", "users", string, "sessions"];
    queryFn: () => Promise<UserSessionsResult>;
    enabled: boolean;
};
export declare function useCreateUserMutationOptions(): {
    mutationKey: string[];
    mutationFn: (data: CreateUserInput) => Promise<AdminUser & {
        invited?: boolean;
    }>;
};
export declare function useUpdateUserMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: (data: UpdateUserInput) => Promise<AdminUser>;
};
export declare function useDisableUserMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        id: string;
        disabled: true;
    }>;
};
export declare function useEnableUserMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        id: string;
        disabled: false;
    }>;
};
export declare function useResetPasswordMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        id: string;
        sent: boolean;
    }>;
};
export declare function useDeleteUserMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        id: string;
        deleted: boolean;
    }>;
};
export declare function useRevokeUserSessionsMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<RevokeSessionsResult>;
};
export declare function useSessionsQueryOptions(accountId?: string): {
    queryKey: readonly ["authkit", "admin", "sessions", string | null];
    queryFn: () => Promise<UserSessionsResult>;
};
export declare function useRevokeAllSessionsMutationOptions(accountId?: string): {
    mutationKey: (string | null)[];
    mutationFn: () => Promise<RevokeSessionsResult>;
};
export declare function useClientsQueryOptions(): {
    queryKey: readonly ["authkit", "admin", "clients"];
    queryFn: () => Promise<AdminClientListResult>;
};
export declare function useClientQueryOptions(id: string): {
    queryKey: readonly ["authkit", "admin", "clients", string];
    queryFn: () => Promise<AdminClient>;
    enabled: boolean;
};
export declare function useCreateClientMutationOptions(): {
    mutationKey: string[];
    mutationFn: (data?: CreateClientInput) => Promise<CreatedClientResult>;
};
export declare function useUpdateClientMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: (data?: UpdateClientInput) => Promise<AdminClient>;
};
export declare function useDeleteClientMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        clientId: string;
        deleted: boolean;
    }>;
};
export declare function useRegenerateClientSecretMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<RegenerateSecretResult>;
};
export declare function useRolesQueryOptions(): {
    queryKey: readonly ["authkit", "admin", "roles"];
    queryFn: () => Promise<RoleListResult>;
};
export declare function useCreateRoleMutationOptions(): {
    mutationKey: string[];
    mutationFn: (data: CreateRoleInput) => Promise<RoleCatalogEntry>;
};
export declare function useUpdateRoleMutationOptions(name: string): {
    mutationKey: string[];
    mutationFn: (data: UpdateRoleInput) => Promise<RoleCatalogEntry>;
};
export declare function useDeleteRoleMutationOptions(name: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        ok: boolean;
        deleted: string;
    }>;
};
export declare function useOrgsQueryOptions(): {
    queryKey: readonly ["authkit", "admin", "orgs"];
    queryFn: () => Promise<AdminOrgListResult>;
};
export declare function useOrgQueryOptions(id: string): {
    queryKey: readonly ["authkit", "admin", "orgs", string];
    queryFn: () => Promise<AdminOrgDetail>;
    enabled: boolean;
};
export declare function useCreateOrgMutationOptions(): {
    mutationKey: string[];
    mutationFn: (data: CreateOrgInput) => Promise<AdminOrgEntry>;
};
export declare function useUpdateOrgMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: (data: UpdateOrgInput) => Promise<AdminOrgEntry>;
};
export declare function useDeleteOrgMutationOptions(id: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        id: string;
        deleted: boolean;
    }>;
};
export declare function useAddOrgMemberMutationOptions(orgId: string): {
    mutationKey: string[];
    mutationFn: (data: {
        accountId: string;
        role: string;
    }) => Promise<{
        ok: boolean;
    }>;
};
export declare function useRemoveOrgMemberMutationOptions(orgId: string, accountId: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        ok: boolean;
    }>;
};
export declare function useUpdateOrgMemberRoleMutationOptions(orgId: string, accountId: string): {
    mutationKey: string[];
    mutationFn: (role: string) => Promise<{
        ok: boolean;
    }>;
};
export declare function useCreateOrgInvitationMutationOptions(orgId: string): {
    mutationKey: string[];
    mutationFn: (data: {
        email: string;
        role: string;
    }) => Promise<{
        ok: boolean;
        invitation: AdminOrgInvitation;
    }>;
};
export declare function useRevokeOrgInvitationMutationOptions(orgId: string, invitationId: string): {
    mutationKey: string[];
    mutationFn: () => Promise<{
        ok: boolean;
    }>;
};
export declare function useAuditQueryOptions(params?: AuditListParams): {
    queryKey: readonly ["authkit", "admin", "audit", {
        type?: string;
        page?: number;
        size?: number;
        subject?: string;
    }];
    queryFn: () => Promise<AuditListResult>;
};
export declare function useSettingsQueryOptions(orgId?: string | null): {
    queryKey: readonly ["authkit", "admin", "settings"] | readonly ["authkit", "admin", "settings", string];
    queryFn: () => Promise<SettingListResult>;
};
export declare function useSetSettingMutationOptions(orgId?: string | null): {
    mutationKey: (string | null)[];
    mutationFn: ({ key, value }: {
        key: string;
        value: unknown;
    }) => Promise<SettingEntry>;
};
export declare function useRemoveSettingMutationOptions(orgId?: string | null): {
    mutationKey: (string | null)[];
    mutationFn: (key: string) => Promise<{
        key: string;
        organizationId: string | null;
        deleted: boolean;
    }>;
};
export declare function useImpersonationQueryOptions(userId: string): {
    queryKey: readonly ["authkit", "admin", "impersonation", string];
    queryFn: () => Promise<ImpersonationPanel>;
    enabled: boolean;
};
export declare function useKeysQueryOptions(): {
    queryKey: readonly ["authkit", "admin", "keys"];
    queryFn: () => Promise<KeysStatus>;
};
export declare function useRotateKeysMutationOptions(): {
    mutationKey: string[];
    mutationFn: (input?: KeysRotateInput) => Promise<KeysRotateResult>;
};