@authorizerdev/authorizer-js 2.0.3 → 3.0.0-rc.1

package/lib/index.d.ts

@@ -9,107 +9,16 @@ interface ApiResponse<T> {
 interface ConfigType {
     authorizerURL: string;
     redirectURL: string;
-    clientID: string;
+    clientID?: string;
     extraHeaders?: Record<string, string>;
 }
-interface User {
-    id: string;
-    email: string;
-    preferred_username: string;
-    email_verified: boolean;
-    signup_methods: string;
-    given_name?: string | null;
-    family_name?: string | null;
-    middle_name?: string | null;
-    nickname?: string | null;
-    picture?: string | null;
-    gender?: string | null;
-    birthdate?: string | null;
-    phone_number?: string | null;
-    phone_number_verified?: boolean | null;
-    roles?: string[];
-    created_at: number;
-    updated_at: number;
-    is_multi_factor_auth_enabled?: boolean;
-    app_data?: Record<string, any>;
+interface Pagination {
+    limit: number;
+    page: number;
+    offset: number;
+    total: number;
 }
-interface AuthToken {
-    message?: string;
-    access_token: string;
-    expires_in: number;
-    id_token: string;
-    refresh_token?: string;
-    user?: User;
-    should_show_email_otp_screen?: boolean;
-    should_show_mobile_otp_screen?: boolean;
-    should_show_totp_screen?: boolean;
-    authenticator_scanner_image?: string;
-    authenticator_secret?: string;
-    authenticator_recovery_codes?: string[];
-}
-interface GenericResponse {
-    message: string;
-}
-type Headers = Record<string, string>;
-interface LoginInput {
-    email?: string;
-    phone_number?: string;
-    password: string;
-    roles?: string[];
-    scope?: string[];
-    state?: string;
-}
-interface SignupInput {
-    email?: string;
-    password: string;
-    confirm_password: string;
-    given_name?: string;
-    family_name?: string;
-    middle_name?: string;
-    nickname?: string;
-    picture?: string;
-    gender?: string;
-    birthdate?: string;
-    phone_number?: string;
-    roles?: string[];
-    scope?: string[];
-    redirect_uri?: string;
-    is_multi_factor_auth_enabled?: boolean;
-    state?: string;
-    app_data?: Record<string, any>;
-}
-interface MagicLinkLoginInput {
-    email: string;
-    roles?: string[];
-    scopes?: string[];
-    state?: string;
-    redirect_uri?: string;
-}
-interface VerifyEmailInput {
-    token: string;
-    state?: string;
-}
-interface ResendVerifyEmailInput {
-    email: string;
-    identifier: string;
-}
-interface VerifyOtpInput {
-    email?: string;
-    phone_number?: string;
-    otp: string;
-    state?: string;
-    is_totp?: boolean;
-}
-interface ResendOtpInput {
-    email?: string;
-    phone_number?: string;
-}
-interface GraphqlQueryInput {
-    query: string;
-    variables?: Record<string, any>;
-    headers?: Headers;
-}
-interface MetaData {
+interface Meta {
     version: string;
     client_id: string;
     is_google_login_enabled: boolean;
@@ -117,6 +26,7 @@ interface MetaData {
     is_github_login_enabled: boolean;
     is_linkedin_login_enabled: boolean;
     is_apple_login_enabled: boolean;
+    is_discord_login_enabled: boolean;
     is_twitter_login_enabled: boolean;
     is_microsoft_login_enabled: boolean;
     is_twitch_login_enabled: boolean;
@@ -130,49 +40,209 @@ interface MetaData {
     is_mobile_basic_authentication_enabled: boolean;
     is_phone_verification_enabled: boolean;
 }
-interface UpdateProfileInput {
-    old_password?: string;
-    new_password?: string;
-    confirm_new_password?: string;
-    email?: string;
-    given_name?: string;
-    family_name?: string;
-    middle_name?: string;
-    nickname?: string;
-    gender?: string;
-    birthdate?: string;
-    phone_number?: string;
-    picture?: string;
-    is_multi_factor_auth_enabled?: boolean;
-    app_data?: Record<string, any>;
-}
-interface ForgotPasswordInput {
-    email?: string;
-    phone_number?: string;
-    state?: string;
-    redirect_uri?: string;
+interface User {
+    id: string;
+    email: string | null;
+    email_verified: boolean;
+    signup_methods: string;
+    given_name: string | null;
+    family_name: string | null;
+    middle_name: string | null;
+    nickname: string | null;
+    preferred_username: string | null;
+    gender: string | null;
+    birthdate: string | null;
+    phone_number: string | null;
+    phone_number_verified: boolean;
+    picture: string | null;
+    roles: string[];
+    created_at: number | null;
+    updated_at: number | null;
+    revoked_timestamp: number | null;
+    is_multi_factor_auth_enabled: boolean | null;
+    app_data: Record<string, any> | null;
+}
+interface Users {
+    pagination: Pagination;
+    users: User[];
+}
+interface VerificationRequest {
+    id: string;
+    identifier: string | null;
+    token: string | null;
+    email: string | null;
+    expires: number | null;
+    created_at: number | null;
+    updated_at: number | null;
+    nonce: string | null;
+    redirect_uri: string | null;
+}
+interface VerificationRequests {
+    pagination: Pagination;
+    verification_requests: VerificationRequest[];
+}
+interface AuthorizerError {
+    message: string;
+    reason: string;
+}
+interface AuthResponse {
+    message: string;
+    should_show_email_otp_screen: boolean | null;
+    should_show_mobile_otp_screen: boolean | null;
+    should_show_totp_screen: boolean | null;
+    access_token: string | null;
+    id_token: string | null;
+    refresh_token: string | null;
+    expires_in: number | null;
+    user: User | null;
+    authenticator_scanner_image: string | null;
+    authenticator_secret: string | null;
+    authenticator_recovery_codes: string[] | null;
+}
+type AuthToken = AuthResponse;
+interface Response {
+    message: string;
 }
+type GenericResponse = Response;
 interface ForgotPasswordResponse {
     message: string;
-    should_show_mobile_otp_screen?: boolean;
+    should_show_mobile_otp_screen: boolean | null;
+}
+interface InviteMembersResponse {
+    message: string;
+    Users: User[];
 }
-interface ResetPasswordInput {
-    token?: string;
-    otp?: string;
-    phone_number?: string;
+interface LoginRequest {
+    email?: string | null;
+    phone_number?: string | null;
+    password: string;
+    roles?: string[] | null;
+    scope?: string[] | null;
+    state?: string | null;
+}
+interface SignUpRequest {
+    email?: string | null;
+    given_name?: string | null;
+    family_name?: string | null;
+    middle_name?: string | null;
+    nickname?: string | null;
+    gender?: string | null;
+    birthdate?: string | null;
+    phone_number?: string | null;
+    picture?: string | null;
     password: string;
     confirm_password: string;
+    roles?: string[] | null;
+    scope?: string[] | null;
+    redirect_uri?: string | null;
+    is_multi_factor_auth_enabled?: boolean | null;
+    state?: string | null;
+    app_data?: Record<string, any> | null;
+}
+type SignupRequest = SignUpRequest;
+interface MagicLinkLoginRequest {
+    email: string;
+    roles?: string[] | null;
+    scope?: string[] | null;
+    state?: string | null;
+    redirect_uri?: string | null;
 }
-interface SessionQueryInput {
-    roles?: string[];
+interface VerifyEmailRequest {
+    token: string;
+    state?: string | null;
 }
-interface IsValidJWTQueryInput {
-    jwt: string;
-    roles?: string[];
+interface ResendVerifyEmailRequest {
+    email: string;
+    identifier: string;
+    state?: string | null;
 }
-interface ValidJWTResponse {
-    valid: string;
-    message: string;
+interface VerifyOTPRequest {
+    email?: string | null;
+    phone_number?: string | null;
+    otp: string;
+    is_totp?: boolean | null;
+    state?: string | null;
+}
+type VerifyOtpRequest = VerifyOTPRequest;
+interface ResendOTPRequest {
+    email?: string | null;
+    phone_number?: string | null;
+    state?: string | null;
+}
+type ResendOtpRequest = ResendOTPRequest;
+interface UpdateProfileRequest {
+    old_password?: string | null;
+    new_password?: string | null;
+    confirm_new_password?: string | null;
+    email?: string | null;
+    given_name?: string | null;
+    family_name?: string | null;
+    middle_name?: string | null;
+    nickname?: string | null;
+    gender?: string | null;
+    birthdate?: string | null;
+    phone_number?: string | null;
+    picture?: string | null;
+    is_multi_factor_auth_enabled?: boolean | null;
+    app_data?: Record<string, any> | null;
+}
+interface UpdateUserRequest {
+    id: string;
+    email?: string | null;
+    email_verified?: boolean | null;
+    given_name?: string | null;
+    family_name?: string | null;
+    middle_name?: string | null;
+    nickname?: string | null;
+    gender?: string | null;
+    birthdate?: string | null;
+    phone_number?: string | null;
+    phone_number_verified?: boolean | null;
+    picture?: string | null;
+    roles?: string[] | null;
+    is_multi_factor_auth_enabled?: boolean | null;
+    app_data?: Record<string, any> | null;
+}
+interface ForgotPasswordRequest {
+    email?: string | null;
+    phone_number?: string | null;
+    state?: string | null;
+    redirect_uri?: string | null;
+}
+interface ResetPasswordRequest {
+    token?: string | null;
+    otp?: string | null;
+    phone_number?: string | null;
+    password: string;
+    confirm_password: string;
+}
+type ResetPasswordInput = ResetPasswordRequest;
+interface DeleteUserRequest {
+    email: string;
+}
+interface SessionQueryRequest {
+    roles?: string[] | null;
+    scope?: string[] | null;
+}
+type SessionQueryInput = SessionQueryRequest;
+interface ValidateJWTTokenRequest {
+    token_type: string;
+    token: string;
+    roles?: string[] | null;
+}
+type ValidateJWTTokenInput = ValidateJWTTokenRequest;
+interface ValidateJWTTokenResponse {
+    is_valid: boolean;
+    claims: Record<string, any>;
+}
+interface ValidateSessionRequest {
+    cookie: string;
+    roles?: string[] | null;
+}
+type ValidateSessionInput = ValidateSessionRequest;
+interface ValidateSessionResponse {
+    is_valid: boolean;
+    user: User;
 }
 declare enum OAuthProviders {
     Apple = "apple",
@@ -183,17 +253,19 @@ declare enum OAuthProviders {
     Twitter = "twitter",
     Microsoft = "microsoft",
     Twitch = "twitch",
-    Roblox = "roblox"
+    Roblox = "roblox",
+    Discord = "discord"
 }
 declare enum ResponseTypes {
     Code = "code",
     Token = "token"
 }
-interface AuthorizeInput {
+interface AuthorizeRequest {
     response_type: ResponseTypes;
     use_refresh_token?: boolean;
     response_mode?: string;
 }
+type AuthorizeInput = AuthorizeRequest;
 interface AuthorizeResponse {
     state: string;
     code?: string;
@@ -203,66 +275,66 @@ interface AuthorizeResponse {
 interface RevokeTokenInput {
     refresh_token: string;
 }
-interface GetTokenInput {
+interface GetTokenRequest {
     code?: string;
     grant_type?: string;
     refresh_token?: string;
 }
+type GetTokenInput = GetTokenRequest;
 interface GetTokenResponse {
     access_token: string;
     expires_in: number;
     id_token: string;
     refresh_token?: string;
 }
-interface ValidateJWTTokenInput {
-    token_type: 'access_token' | 'id_token' | 'refresh_token';
-    token: string;
-    roles?: string[];
-}
-interface ValidateJWTTokenResponse {
-    is_valid: boolean;
-    claims: Record<string, any>;
+type Headers = Record<string, string>;
+interface GraphqlQueryRequest {
+    query: string;
+    variables?: Record<string, any>;
+    headers?: Headers;
 }
-interface ValidateSessionInput {
-    cookie?: string;
+interface IsValidJWTQueryInput {
+    jwt: string;
     roles?: string[];
 }
-interface ValidateSessionResponse {
-    is_valid: boolean;
-    user: User;
+interface ValidJWTResponse {
+    valid: string;
+    message: string;
 }
+type MetaDataResponse = Meta;
+type MetaData = Meta;
 
 declare class Authorizer {
     config: ConfigType;
     codeVerifier: string;
     constructor(config: ConfigType);
-    authorize: (data: AuthorizeInput) => Promise<ApiResponse<GetTokenResponse> | ApiResponse<AuthorizeResponse>>;
+    authorize: (data: AuthorizeRequest) => Promise<ApiResponse<GetTokenResponse> | ApiResponse<AuthorizeResponse>>;
     browserLogin: () => Promise<ApiResponse<AuthToken>>;
-    forgotPassword: (data: ForgotPasswordInput) => Promise<ApiResponse<ForgotPasswordResponse>>;
+    forgotPassword: (data: ForgotPasswordRequest) => Promise<ApiResponse<ForgotPasswordResponse>>;
     getMetaData: () => Promise<ApiResponse<MetaData>>;
     getProfile: (headers?: Headers) => Promise<ApiResponse<User>>;
-    getSession: (headers?: Headers, params?: SessionQueryInput) => Promise<ApiResponse<AuthToken>>;
-    getToken: (data: GetTokenInput) => Promise<ApiResponse<GetTokenResponse>>;
-    login: (data: LoginInput) => Promise<ApiResponse<AuthToken>>;
+    getSession: (headers?: Headers, params?: SessionQueryRequest) => Promise<ApiResponse<AuthToken>>;
+    getToken: (data: GetTokenRequest) => Promise<ApiResponse<GetTokenResponse>>;
+    login: (data: LoginRequest) => Promise<ApiResponse<AuthToken>>;
     logout: (headers?: Headers) => Promise<ApiResponse<GenericResponse>>;
-    magicLinkLogin: (data: MagicLinkLoginInput) => Promise<ApiResponse<GenericResponse>>;
+    magicLinkLogin: (data: MagicLinkLoginRequest) => Promise<ApiResponse<GenericResponse>>;
     oauthLogin: (oauthProvider: string, roles?: string[], redirect_uri?: string, state?: string) => Promise<void>;
-    resendOtp: (data: ResendOtpInput) => Promise<ApiResponse<GenericResponse>>;
-    resetPassword: (data: ResetPasswordInput) => Promise<ApiResponse<GenericResponse>>;
+    resendOtp: (data: ResendOtpRequest) => Promise<ApiResponse<GenericResponse>>;
+    resetPassword: (data: ResetPasswordRequest) => Promise<ApiResponse<GenericResponse>>;
     revokeToken: (data: {
         refresh_token: string;
     }) => Promise<ApiResponse<any>>;
-    signup: (data: SignupInput) => Promise<ApiResponse<AuthToken>>;
-    updateProfile: (data: UpdateProfileInput, headers?: Headers) => Promise<ApiResponse<GenericResponse>>;
+    signup: (data: SignUpRequest) => Promise<ApiResponse<AuthToken>>;
+    updateProfile: (data: UpdateProfileRequest, headers?: Headers) => Promise<ApiResponse<GenericResponse>>;
     deactivateAccount: (headers?: Headers) => Promise<ApiResponse<GenericResponse>>;
-    validateJWTToken: (params?: ValidateJWTTokenInput) => Promise<ApiResponse<ValidateJWTTokenResponse>>;
-    validateSession: (params?: ValidateSessionInput) => Promise<ApiResponse<ValidateSessionResponse>>;
-    verifyEmail: (data: VerifyEmailInput) => Promise<ApiResponse<AuthToken>>;
-    resendVerifyEmail: (data: ResendVerifyEmailInput) => Promise<ApiResponse<GenericResponse>>;
-    verifyOtp: (data: VerifyOtpInput) => Promise<ApiResponse<AuthToken>>;
-    graphqlQuery: (data: GraphqlQueryInput) => Promise<GrapQlResponseType>;
+    validateJWTToken: (params?: ValidateJWTTokenRequest) => Promise<ApiResponse<ValidateJWTTokenResponse>>;
+    validateSession: (params?: ValidateSessionRequest) => Promise<ApiResponse<ValidateSessionResponse>>;
+    verifyEmail: (data: VerifyEmailRequest) => Promise<ApiResponse<AuthToken>>;
+    resendVerifyEmail: (data: ResendVerifyEmailRequest) => Promise<ApiResponse<GenericResponse>>;
+    verifyOtp: (data: VerifyOtpRequest) => Promise<ApiResponse<AuthToken>>;
+    graphqlQuery: (data: GraphqlQueryRequest) => Promise<GrapQlResponseType>;
     errorResponse: (errors: Error[]) => ApiResponse<any>;
     okResponse: (data: any) => ApiResponse<any>;
 }
 
-export { type ApiResponse, type AuthToken, type AuthorizeInput, type AuthorizeResponse, Authorizer, type ConfigType, type ForgotPasswordInput, type ForgotPasswordResponse, type GenericResponse, type GetTokenInput, type GetTokenResponse, type GrapQlResponseType, type GraphqlQueryInput, type Headers, type IsValidJWTQueryInput, type LoginInput, type MagicLinkLoginInput, type MetaData, OAuthProviders, type ResendOtpInput, type ResendVerifyEmailInput, type ResetPasswordInput, ResponseTypes, type RevokeTokenInput, type SessionQueryInput, type SignupInput, type UpdateProfileInput, type User, type ValidJWTResponse, type ValidateJWTTokenInput, type ValidateJWTTokenResponse, type ValidateSessionInput, type ValidateSessionResponse, type VerifyEmailInput, type VerifyOtpInput };
+export { type ApiResponse, type AuthResponse, type AuthToken, type AuthorizeInput, type AuthorizeRequest, type AuthorizeResponse, Authorizer, type AuthorizerError, type ConfigType, type DeleteUserRequest, type ForgotPasswordRequest, type ForgotPasswordResponse, type GenericResponse, type GetTokenInput, type GetTokenRequest, type GetTokenResponse, type GrapQlResponseType, type GraphqlQueryRequest, type Headers, type InviteMembersResponse, type IsValidJWTQueryInput, type LoginRequest, type MagicLinkLoginRequest, type Meta, type MetaData, type MetaDataResponse, OAuthProviders, type Pagination, type ResendOTPRequest, type ResendOtpRequest, type ResendVerifyEmailRequest, type ResetPasswordInput, type ResetPasswordRequest, type Response, ResponseTypes, type RevokeTokenInput, type SessionQueryInput, type SessionQueryRequest, type SignUpRequest, type SignupRequest, type UpdateProfileRequest, type UpdateUserRequest, type User, type Users, type ValidJWTResponse, type ValidateJWTTokenInput, type ValidateJWTTokenRequest, type ValidateJWTTokenResponse, type ValidateSessionInput, type ValidateSessionRequest, type ValidateSessionResponse, type VerificationRequest, type VerificationRequests, type VerifyEmailRequest, type VerifyOTPRequest, type VerifyOtpRequest };