/**
 * @license Apache-2.0
 * @copyright Cube Dev, Inc.
 * @fileoverview
 * Cube auth related data types definition.
 */
import { ApiScopes } from './strings';
/**
 * ApiScopes tuple.
 */
type ApiScopesTuple = ApiScopes[];
/**
 * Internal auth logic options object data type.
 */
type CheckAuthInternalOptions = {
    isPlaygroundCheckAuth: boolean;
};
/**
 * JWT options. Used as a part of a main configuration object of
 * the server-core to provide JWT configuration.
 */
interface JWTOptions {
    jwkRetry?: number;
    jwkDefaultExpire?: number;
    jwkUrl?: ((payload: any) => string | Promise<string>) | string;
    jwkRefetchWindow?: number;
    key?: string;
    algorithms?: string[];
    issuer?: string[];
    audience?: string;
    subject?: string;
    claimsNamespace?: string;
}
type CheckAuthResponse = {
    security_context?: unknown;
};
/**
 * Function that should provides basic auth mechanic. Used as a part
 * of a main configuration object of the server-core to provide base
 * auth logic. Can return new security context.
 * @todo ctx can be passed from SubscriptionServer that will cause
 * incapability with Express.Request
 */
type CheckAuthFn = (ctx: any, authorization?: string) => Promise<void | CheckAuthResponse> | CheckAuthResponse | void;
/**
 * Result of the SQL auth workflow.
 */
type CheckSQLAuthSuccessResponse = {
    password: string | null;
    superuser?: boolean;
    securityContext?: any;
    skipPasswordCheck?: boolean;
};
/**
 * Function that should provide SQL auth mechanic. Used as a part
 * of a main configuration object of the server-core to provide SQL
 * auth logic.
 */
type CheckSQLAuthFn = (ctx: any, user: string | null, password: string | null) => Promise<CheckSQLAuthSuccessResponse> | CheckSQLAuthSuccessResponse;
/**
 * Function that should provide changing of security context (__user field) for SQL. This function returns boolean which
 * explains to SQL APi that it's possible to change current user to user.
 */
type CanSwitchSQLUserFn = (current: string | null, user: string) => Promise<boolean> | boolean;
/**
 * Returns scopes tuple from a security context.
 */
type ContextToApiScopesFn = (securityContext?: any, scopes?: ApiScopesTuple) => Promise<ApiScopesTuple>;
export type { CheckAuthInternalOptions, JWTOptions, CheckAuthFn, CheckSQLAuthSuccessResponse, CheckSQLAuthFn, CanSwitchSQLUserFn, ApiScopesTuple, ContextToApiScopesFn, };
//# sourceMappingURL=auth.d.ts.map