openvidu/typings/src/auth-preferences.ts

95 lines
2.1 KiB
TypeScript

export interface AuthenticationPreferences {
authMode: AuthMode;
method: ValidAuthMethod;
}
/**
* Authentication modes available to enter a room.
*/
export const enum AuthMode {
NONE = 'none', // No authentication required
MODERATORS_ONLY = 'moderators_only', // Only moderators need authentication
ALL_USERS = 'all_users' // All users need authentication
}
/**
* Authentication method base interface.
*/
export interface AuthMethod {
type: AuthType;
}
/**
* Enum for authentication types.
*/
export const enum AuthType {
SINGLE_USER = 'single-user'
// MULTI_USER = 'multi-user',
// OAUTH_ONLY = 'oauth-only'
}
/**
* Authentication method: Single user with fixed credentials.
*/
export interface SingleUserAuth extends AuthMethod {
type: AuthType.SINGLE_USER;
credentials: SingleUserCredentials;
}
/**
* Authentication method: Multiple users with optional OAuth integration.
*/
// export interface MultiUserAuth extends AuthMethod {
// type: AuthType.MULTI_USER;
// oauthProviders?: OAuthProviderConfig[];
// }
/**
* Authentication method: Only OAuth authentication.
*/
// export interface OAuthOnlyAuth extends AuthMethod {
// type: AuthType.OAUTH_ONLY;
// oauthProviders: OAuthProviderConfig[];
// }
/**
* Union type for allowed authentication methods.
*/
export type ValidAuthMethod = SingleUserAuth /* | MultiUserAuth | OAuthOnlyAuth */;
/**
* Configuration for a single user login method.
*/
export interface SingleUserCredentials {
username: string;
passwordHash: string;
}
/**
* Configuration for OAuth authentication.
*/
// export interface OAuthProviderConfig {
// provider: OAuthProvider;
// clientId: string;
// clientSecret: string;
// redirectUri: string;
// }
/**
* Supported OAuth providers.
*/
// export const enum OAuthProvider {
// GOOGLE = 'google',
// GITHUB = 'github'
// }
// DTOs
export interface AuthenticationPreferencesDTO {
authMode: AuthMode;
method: ValidAuthMethodDTO;
}
export type ValidAuthMethodDTO = SingleUserAuthDTO;
export type SingleUserAuthDTO = Omit<SingleUserAuth, 'credentials'>;