@softlock/sdk
Version:
Official Softlock SDK for access key validation and management
32 lines • 1.07 kB
TypeScript
import { UseAccessKeyOptions, UseAccessKeyResult, ValidationResult } from './types';
/**
* React hook for access key validation
*/
export declare function useAccessKey(initialKey?: string, options?: UseAccessKeyOptions): UseAccessKeyResult;
/**
* Hook for managing user access state
*/
export declare function useUserAccess(userId?: string): {
hasAccess: boolean | null;
loading: boolean;
error: string | null;
checkAccess: (key: string) => Promise<ValidationResult>;
revokeAccess: () => void;
userKey: string | undefined;
validationResult: ValidationResult | null;
};
/**
* Hook for protecting components based on access key validation
*/
export declare function useAccessGuard(keyValue?: string, options?: {
redirectUrl?: string;
onUnauthorized?: () => void;
fallback?: React.ComponentType;
}): {
isAuthorized: boolean | null;
loading: boolean;
error: string | null;
checkKey: (key: string) => Promise<ValidationResult>;
validationResult: ValidationResult | null;
};
//# sourceMappingURL=hooks.d.ts.map