@famgia/omnify-client-sso-react 1.0.1 → 1.1.0

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 /**
  * User information from SSO
  */
-interface SsoUser {
+interface SsoUser$1 {
     id: number;
     consoleUserId: number;
     email: string;
@@ -40,7 +40,7 @@ interface SsoConfig {
  */
 interface SsoContextValue {
     /** Current authenticated user */
-    user: SsoUser | null;
+    user: SsoUser$1 | null;
     /** List of organizations user has access to */
     organizations: SsoOrganization[];
     /** Currently selected organization */
@@ -90,14 +90,14 @@ interface SsoProviderProps {
     children: React.ReactNode;
     config: SsoConfig;
     /** Called when auth state changes */
-    onAuthChange?: (isAuthenticated: boolean, user: SsoUser | null) => void;
+    onAuthChange?: (isAuthenticated: boolean, user: SsoUser$1 | null) => void;
 }
 /**
  * Props for SsoCallback component
  */
 interface SsoCallbackProps {
     /** Called on successful login */
-    onSuccess?: (user: SsoUser, organizations: SsoOrganization[]) => void;
+    onSuccess?: (user: SsoUser$1, organizations: SsoOrganization[]) => void;
     /** Called on error */
     onError?: (error: Error) => void;
     /** Redirect path after login */
@@ -151,7 +151,7 @@ declare function SsoProvider({ children, config, onAuthChange }: SsoProviderProp
  */
 interface UseAuthReturn {
     /** Current user or null */
-    user: SsoUser | null;
+    user: SsoUser$1 | null;
     /** Whether auth is being loaded */
     isLoading: boolean;
     /** Whether user is authenticated */
@@ -233,7 +233,7 @@ declare function useOrganization(): UseOrganizationReturn;
  * Combined SSO hook return type
  */
 interface UseSsoReturn {
-    user: SsoUser | null;
+    user: SsoUser$1 | null;
     isLoading: boolean;
     isAuthenticated: boolean;
     login: (redirectTo?: string) => void;
@@ -363,4 +363,345 @@ declare function OrganizationSwitcher({ className, renderTrigger, renderOption,
  */
 declare function ProtectedRoute({ children, fallback, loginFallback, requiredRole, requiredPermission, onAccessDenied, }: ProtectedRouteProps): react_jsx_runtime.JSX.Element;
 
-export { OrganizationSwitcher, type OrganizationSwitcherProps, ProtectedRoute, type ProtectedRouteProps, SsoCallback, type SsoCallbackProps, type SsoCallbackResponse, type SsoConfig, SsoContext, type SsoContextValue, type SsoOrganization, SsoProvider, type SsoProviderProps, type SsoUser, type UseAuthReturn, type UseOrganizationReturn, type UseSsoReturn, useAuth, useOrganization, useSso };
+/**
+ * SSO Service - API client for SSO endpoints
+ *
+ * Provides methods for SSO authentication, tokens, roles, permissions, teams
+ */
+interface SsoUser {
+    id: number;
+    console_user_id: number;
+    email: string;
+    name: string;
+}
+interface Organization {
+    id: number;
+    slug: string;
+    name: string;
+    role: string;
+}
+interface Role {
+    id: number;
+    name: string;
+    slug: string;
+    description: string | null;
+    level: number;
+    permissions_count?: number;
+    created_at: string;
+    updated_at: string;
+}
+interface Permission {
+    id: number;
+    name: string;
+    slug: string;
+    group: string | null;
+    description?: string | null;
+    roles_count?: number;
+    created_at: string;
+    updated_at: string;
+}
+interface RoleWithPermissions extends Role {
+    permissions: Permission[];
+}
+interface PermissionMatrix {
+    roles: Pick<Role, "id" | "slug" | "name">[];
+    permissions: Record<string, Pick<Permission, "id" | "slug" | "name">[]>;
+    matrix: Record<string, string[]>;
+}
+interface ApiToken {
+    id: number;
+    name: string;
+    last_used_at: string | null;
+    created_at: string;
+    is_current: boolean;
+}
+interface TeamWithPermissions {
+    console_team_id: number;
+    name: string;
+    path: string | null;
+    permissions: Pick<Permission, "id" | "slug">[];
+}
+interface TeamPermissionDetail {
+    console_team_id: number;
+    permissions: Pick<Permission, "id" | "slug" | "name">[];
+}
+interface OrphanedTeam {
+    console_team_id: number;
+    permissions_count: number;
+    permissions: string[];
+    deleted_at: string | null;
+}
+interface SsoCallbackInput {
+    code: string;
+    device_name?: string;
+}
+interface CreateRoleInput {
+    slug: string;
+    name: string;
+    level: number;
+    description?: string;
+}
+interface UpdateRoleInput {
+    name?: string;
+    level?: number;
+    description?: string | null;
+}
+interface CreatePermissionInput {
+    slug: string;
+    name: string;
+    group?: string;
+    description?: string;
+}
+interface UpdatePermissionInput {
+    name?: string;
+    group?: string | null;
+    description?: string | null;
+}
+interface SyncPermissionsInput {
+    permissions: (number | string)[];
+}
+interface CleanupOrphanedInput {
+    console_team_id?: number;
+    older_than_days?: number;
+}
+interface SsoServiceConfig {
+    apiUrl: string;
+}
+declare function createSsoService(config: SsoServiceConfig): {
+    /**
+     * Exchange SSO authorization code for tokens
+     * POST /api/sso/callback
+     */
+    callback: (input: SsoCallbackInput) => Promise<{
+        user: SsoUser;
+        organizations: Organization[];
+        token?: string;
+    }>;
+    /**
+     * Logout current user and revoke tokens
+     * POST /api/sso/logout
+     */
+    logout: () => Promise<{
+        message: string;
+    }>;
+    /**
+     * Get current authenticated user with organizations
+     * GET /api/sso/user
+     */
+    getUser: () => Promise<{
+        user: SsoUser;
+        organizations: Organization[];
+    }>;
+    /**
+     * Get Console SSO global logout URL
+     * GET /api/sso/global-logout-url
+     */
+    getGlobalLogoutUrl: (redirectUri?: string) => Promise<{
+        logout_url: string;
+    }>;
+    /**
+     * List all API tokens for current user
+     * GET /api/sso/tokens
+     */
+    getTokens: () => Promise<{
+        tokens: ApiToken[];
+    }>;
+    /**
+     * Revoke a specific token
+     * DELETE /api/sso/tokens/{tokenId}
+     */
+    revokeToken: (tokenId: number) => Promise<{
+        message: string;
+    }>;
+    /**
+     * Revoke all tokens except current
+     * POST /api/sso/tokens/revoke-others
+     */
+    revokeOtherTokens: () => Promise<{
+        message: string;
+        revoked_count: number;
+    }>;
+    /**
+     * Get all roles
+     * GET /api/sso/roles
+     */
+    getRoles: () => Promise<{
+        data: Role[];
+    }>;
+    /**
+     * Get single role with permissions
+     * GET /api/sso/roles/{id}
+     */
+    getRole: (id: number) => Promise<{
+        data: RoleWithPermissions;
+    }>;
+    /**
+     * Get all permissions
+     * GET /api/sso/permissions
+     */
+    getPermissions: (params?: {
+        group?: string;
+        search?: string;
+        grouped?: boolean;
+    }) => Promise<{
+        data: Permission[];
+        groups: string[];
+    }>;
+    /**
+     * Get permission matrix (roles x permissions)
+     * GET /api/sso/permission-matrix
+     */
+    getPermissionMatrix: () => Promise<PermissionMatrix>;
+    /**
+     * List all roles (admin)
+     * GET /api/admin/sso/roles
+     */
+    adminGetRoles: (orgSlug: string) => Promise<{
+        data: Role[];
+    }>;
+    /**
+     * Get single role (admin)
+     * GET /api/admin/sso/roles/{id}
+     */
+    adminGetRole: (id: number, orgSlug: string) => Promise<{
+        data: RoleWithPermissions;
+    }>;
+    /**
+     * Create role (admin only)
+     * POST /api/admin/sso/roles
+     */
+    createRole: (input: CreateRoleInput, orgSlug: string) => Promise<{
+        data: Role;
+        message: string;
+    }>;
+    /**
+     * Update role (admin only)
+     * PUT /api/admin/sso/roles/{id}
+     */
+    updateRole: (id: number, input: UpdateRoleInput, orgSlug: string) => Promise<{
+        data: Role;
+        message: string;
+    }>;
+    /**
+     * Delete role (admin only)
+     * DELETE /api/admin/sso/roles/{id}
+     */
+    deleteRole: (id: number, orgSlug: string) => Promise<void>;
+    /**
+     * Get role's permissions (admin)
+     * GET /api/admin/sso/roles/{id}/permissions
+     */
+    getRolePermissions: (id: number, orgSlug: string) => Promise<{
+        role: Pick<Role, "id" | "slug" | "name">;
+        permissions: Permission[];
+    }>;
+    /**
+     * Sync role's permissions (admin)
+     * PUT /api/admin/sso/roles/{id}/permissions
+     */
+    syncRolePermissions: (id: number, input: SyncPermissionsInput, orgSlug: string) => Promise<{
+        message: string;
+        attached: number;
+        detached: number;
+    }>;
+    /**
+     * List all permissions (admin)
+     * GET /api/admin/sso/permissions
+     */
+    adminGetPermissions: (orgSlug: string, params?: {
+        group?: string;
+        search?: string;
+        grouped?: boolean;
+    }) => Promise<{
+        data: Permission[];
+        groups: string[];
+    }>;
+    /**
+     * Get single permission (admin)
+     * GET /api/admin/sso/permissions/{id}
+     */
+    adminGetPermission: (id: number, orgSlug: string) => Promise<{
+        data: Permission;
+    }>;
+    /**
+     * Create permission (admin only)
+     * POST /api/admin/sso/permissions
+     */
+    createPermission: (input: CreatePermissionInput, orgSlug: string) => Promise<{
+        data: Permission;
+        message: string;
+    }>;
+    /**
+     * Update permission (admin only)
+     * PUT /api/admin/sso/permissions/{id}
+     */
+    updatePermission: (id: number, input: UpdatePermissionInput, orgSlug: string) => Promise<{
+        data: Permission;
+        message: string;
+    }>;
+    /**
+     * Delete permission (admin only)
+     * DELETE /api/admin/sso/permissions/{id}
+     */
+    deletePermission: (id: number, orgSlug: string) => Promise<void>;
+    /**
+     * Get permission matrix (admin)
+     * GET /api/admin/sso/permission-matrix
+     */
+    adminGetPermissionMatrix: (orgSlug: string) => Promise<PermissionMatrix>;
+    /**
+     * Get all teams with their permissions (admin only)
+     * GET /api/admin/sso/teams/permissions
+     */
+    getTeamPermissions: (orgSlug: string) => Promise<{
+        teams: TeamWithPermissions[];
+    }>;
+    /**
+     * Get specific team permissions (admin only)
+     * GET /api/admin/sso/teams/{teamId}/permissions
+     */
+    getTeamPermission: (teamId: number, orgSlug: string) => Promise<TeamPermissionDetail>;
+    /**
+     * Sync team permissions (admin only)
+     * PUT /api/admin/sso/teams/{teamId}/permissions
+     */
+    syncTeamPermissions: (teamId: number, input: SyncPermissionsInput, orgSlug: string) => Promise<{
+        message: string;
+        console_team_id: number;
+        attached: number;
+        detached: number;
+    }>;
+    /**
+     * Remove all permissions for a team (admin only)
+     * DELETE /api/admin/sso/teams/{teamId}/permissions
+     */
+    removeTeamPermissions: (teamId: number, orgSlug: string) => Promise<void>;
+    /**
+     * List orphaned team permissions (admin only)
+     * GET /api/admin/sso/teams/orphaned
+     */
+    getOrphanedTeamPermissions: (orgSlug: string) => Promise<{
+        orphaned_teams: OrphanedTeam[];
+        total_orphaned_permissions: number;
+    }>;
+    /**
+     * Restore orphaned team permissions (admin only)
+     * POST /api/admin/sso/teams/orphaned/{teamId}/restore
+     */
+    restoreOrphanedTeamPermissions: (teamId: number, orgSlug: string) => Promise<{
+        message: string;
+        console_team_id: number;
+        restored_count: number;
+    }>;
+    /**
+     * Cleanup orphaned team permissions (admin only)
+     * DELETE /api/admin/sso/teams/orphaned
+     */
+    cleanupOrphanedTeamPermissions: (orgSlug: string, input?: CleanupOrphanedInput) => Promise<{
+        message: string;
+        deleted_count: number;
+    }>;
+};
+type SsoService = ReturnType<typeof createSsoService>;
+
+export { type ApiToken, type CleanupOrphanedInput, type CreatePermissionInput, type CreateRoleInput, type Organization, OrganizationSwitcher, type OrganizationSwitcherProps, type OrphanedTeam, type Permission, type PermissionMatrix, ProtectedRoute, type ProtectedRouteProps, type Role, type RoleWithPermissions, SsoCallback, type SsoCallbackInput, type SsoCallbackProps, type SsoCallbackResponse, type SsoConfig, SsoContext, type SsoContextValue, type SsoOrganization, SsoProvider, type SsoProviderProps, type SsoService, type SsoServiceConfig, type SsoUser as SsoServiceUser, type SsoUser$1 as SsoUser, type SyncPermissionsInput, type TeamPermissionDetail, type TeamWithPermissions, type UpdatePermissionInput, type UpdateRoleInput, type UseAuthReturn, type UseOrganizationReturn, type UseSsoReturn, createSsoService, useAuth, useOrganization, useSso };