@amaster.ai/client 1.1.0-beta.6 → 1.1.0-beta.61

package/types/auth/permissions.d.ts

@@ -1,254 +0,0 @@
-/**
- * ============================================================================
- * Permission Checking - Type Definitions & Helpers
- * ============================================================================
- * 
- * Permission and role checking utilities:
- * - Type-safe permission checking
- * - Role validation
- * - Permission helpers
- * 
- * @module auth/permissions
- */
-
-import type { User } from './user';
-
-/**
- * Permission check result
- */
-export interface PermissionCheckResult {
-  /** Whether the permission check passed */
-  granted: boolean;
-  
-  /** Optional reason if denied */
-  reason?: string;
-}
-
-/**
- * Permission checking helpers
- * 
- * @example
- * Check single permission:
- * ```typescript
- * import { hasPermission } from '@amaster.ai/client/auth/permissions';
- * 
- * const user = await client.auth.getMe().then(r => r.data);
- * 
- * if (hasPermission(user, 'user:delete')) {
- *   showDeleteButton();
- * }
- * ```
- * 
- * @example
- * Check role:
- * ```typescript
- * import { hasRole } from '@amaster.ai/client/auth/permissions';
- * 
- * if (hasRole(user, 'admin')) {
- *   showAdminPanel();
- * }
- * ```
- * 
- * @example
- * Check any of multiple permissions:
- * ```typescript
- * import { hasAnyPermission } from '@amaster.ai/client/auth/permissions';
- * 
- * if (hasAnyPermission(user, ['user:read', 'user:write', 'user:delete'])) {
- *   showUserManagement();
- * }
- * ```
- */
-export namespace PermissionHelpers {
-  /**
-   * Check if user has a specific permission
-   * 
-   * @param user - User object with permissions
-   * @param permission - Permission to check (format: "resource:action")
-   * @returns True if user has the permission
-   * 
-   * @example
-   * ```typescript
-   * const canDelete = hasPermission(user, 'user:delete');
-   * const canRead = hasPermission(user, 'order:read');
-   * ```
-   */
-  export function hasPermission(user: User | null | undefined, permission: string): boolean;
-
-  /**
-   * Check if user has a specific role
-   * 
-   * @param user - User object with roles
-   * @param role - Role code to check
-   * @returns True if user has the role
-   * 
-   * @example
-   * ```typescript
-   * const isAdmin = hasRole(user, 'admin');
-   * const isManager = hasRole(user, 'manager');
-   * ```
-   */
-  export function hasRole(user: User | null | undefined, role: string): boolean;
-
-  /**
-   * Check if user has ANY of the specified permissions
-   * 
-   * @param user - User object with permissions
-   * @param permissions - Array of permissions to check
-   * @returns True if user has at least one permission
-   * 
-   * @example
-   * ```typescript
-   * // User can access if they have ANY of these permissions
-   * const canAccessUsers = hasAnyPermission(user, [
-   *   'user:read',
-   *   'user:write',
-   *   'user:delete'
-   * ]);
-   * ```
-   */
-  export function hasAnyPermission(user: User | null | undefined, permissions: string[]): boolean;
-
-  /**
-   * Check if user has ALL of the specified permissions
-   * 
-   * @param user - User object with permissions
-   * @param permissions - Array of permissions to check
-   * @returns True if user has all permissions
-   * 
-   * @example
-   * ```typescript
-   * // User needs ALL of these permissions
-   * const canManageUsers = hasAllPermissions(user, [
-   *   'user:read',
-   *   'user:write',
-   *   'user:delete'
-   * ]);
-   * ```
-   */
-  export function hasAllPermissions(user: User | null | undefined, permissions: string[]): boolean;
-
-  /**
-   * Check if user has ANY of the specified roles
-   * 
-   * @param user - User object with roles
-   * @param roles - Array of role codes to check
-   * @returns True if user has at least one role
-   * 
-   * @example
-   * ```typescript
-   * const isStaff = hasAnyRole(user, ['admin', 'moderator', 'support']);
-   * ```
-   */
-  export function hasAnyRole(user: User | null | undefined, roles: string[]): boolean;
-
-  /**
-   * Check if user has ALL of the specified roles
-   * 
-   * @param user - User object with roles
-   * @param roles - Array of role codes to check
-   * @returns True if user has all roles
-   * 
-   * @example
-   * ```typescript
-   * const isSuperAdmin = hasAllRoles(user, ['admin', 'superuser']);
-   * ```
-   */
-  export function hasAllRoles(user: User | null | undefined, roles: string[]): boolean;
-}
-
-/**
- * Re-export helpers as individual functions for convenience
- * 
- * @example
- * ```typescript
- * import { hasPermission, hasRole } from '@amaster.ai/client/auth/permissions';
- * 
- * const canDelete = hasPermission(user, 'user:delete');
- * const isAdmin = hasRole(user, 'admin');
- * ```
- */
-
-/**
- * Check if user has a specific permission
- * 
- * @param user - User object with permissions
- * @param permission - Permission to check (format: "resource:action")
- * @returns True if user has the permission
- * 
- * @example
- * ```typescript
- * const canDelete = hasPermission(user, 'user:delete');
- * ```
- */
-export declare function hasPermission(user: User | null | undefined, permission: string): boolean;
-
-/**
- * Check if user has a specific role
- * 
- * @param user - User object with roles
- * @param role - Role code to check
- * @returns True if user has the role
- * 
- * @example
- * ```typescript
- * const isAdmin = hasRole(user, 'admin');
- * ```
- */
-export declare function hasRole(user: User | null | undefined, role: string): boolean;
-
-/**
- * Check if user has ANY of the specified permissions
- * 
- * @param user - User object with permissions
- * @param permissions - Array of permissions to check
- * @returns True if user has at least one permission
- * 
- * @example
- * ```typescript
- * const canAccessUsers = hasAnyPermission(user, ['user:read', 'user:write']);
- * ```
- */
-export declare function hasAnyPermission(user: User | null | undefined, permissions: string[]): boolean;
-
-/**
- * Check if user has ALL of the specified permissions
- * 
- * @param user - User object with permissions
- * @param permissions - Array of permissions to check
- * @returns True if user has all permissions
- * 
- * @example
- * ```typescript
- * const canManageUsers = hasAllPermissions(user, ['user:read', 'user:write', 'user:delete']);
- * ```
- */
-export declare function hasAllPermissions(user: User | null | undefined, permissions: string[]): boolean;
-
-/**
- * Check if user has ANY of the specified roles
- * 
- * @param user - User object with roles
- * @param roles - Array of role codes to check
- * @returns True if user has at least one role
- * 
- * @example
- * ```typescript
- * const isStaff = hasAnyRole(user, ['admin', 'moderator']);
- * ```
- */
-export declare function hasAnyRole(user: User | null | undefined, roles: string[]): boolean;
-
-/**
- * Check if user has ALL of the specified roles
- * 
- * @param user - User object with roles
- * @param roles - Array of role codes to check
- * @returns True if user has all roles
- * 
- * @example
- * ```typescript
- * const isSuperAdmin = hasAllRoles(user, ['admin', 'superuser']);
- * ```
- */
-export declare function hasAllRoles(user: User | null | undefined, roles: string[]): boolean;