Module supertokens_python.recipe.totp.asyncio

# Copyright (c) 2024, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from typing import Any, Dict, Union, Optional
from ..recipe import TOTPRecipe
from supertokens_python.recipe.totp.types import (
    CreateDeviceOkResult,
    DeviceAlreadyExistsError,
    UnknownUserIdError,
    UpdateDeviceOkResult,
    UnknownDeviceError,
    ListDevicesOkResult,
    RemoveDeviceOkResult,
    VerifyDeviceOkResult,
    InvalidTOTPError,
    LimitReachedError,
    VerifyTOTPOkResult,
)


async def create_device(
    user_id: str,
    user_identifier_info: Optional[str] = None,
    device_name: Optional[str] = None,
    skew: Optional[int] = None,
    period: Optional[int] = None,
    user_context: Optional[Dict[str, Any]] = None,
) -> Union[CreateDeviceOkResult, DeviceAlreadyExistsError, UnknownUserIdError]:
    if user_context is None:
        user_context = {}
    return await TOTPRecipe.get_instance_or_throw().recipe_implementation.create_device(
        user_id,
        user_identifier_info,
        device_name,
        skew,
        period,
        user_context,
    )


async def update_device(
    user_id: str,
    existing_device_name: str,
    new_device_name: str,
    user_context: Optional[Dict[str, Any]] = None,
) -> Union[UpdateDeviceOkResult, UnknownDeviceError, DeviceAlreadyExistsError]:
    if user_context is None:
        user_context = {}
    return await TOTPRecipe.get_instance_or_throw().recipe_implementation.update_device(
        user_id,
        existing_device_name,
        new_device_name,
        user_context,
    )


async def list_devices(
    user_id: str,
    user_context: Optional[Dict[str, Any]] = None,
) -> ListDevicesOkResult:
    if user_context is None:
        user_context = {}
    return await TOTPRecipe.get_instance_or_throw().recipe_implementation.list_devices(
        user_id,
        user_context,
    )


async def remove_device(
    user_id: str,
    device_name: str,
    user_context: Optional[Dict[str, Any]] = None,
) -> RemoveDeviceOkResult:
    if user_context is None:
        user_context = {}
    return await TOTPRecipe.get_instance_or_throw().recipe_implementation.remove_device(
        user_id,
        device_name,
        user_context,
    )


async def verify_device(
    tenant_id: str,
    user_id: str,
    device_name: str,
    totp: str,
    user_context: Optional[Dict[str, Any]] = None,
) -> Union[
    VerifyDeviceOkResult, UnknownDeviceError, InvalidTOTPError, LimitReachedError
]:
    if user_context is None:
        user_context = {}
    return await TOTPRecipe.get_instance_or_throw().recipe_implementation.verify_device(
        tenant_id,
        user_id,
        device_name,
        totp,
        user_context,
    )


async def verify_totp(
    tenant_id: str,
    user_id: str,
    totp: str,
    user_context: Optional[Dict[str, Any]] = None,
) -> Union[VerifyTOTPOkResult, UnknownUserIdError, InvalidTOTPError, LimitReachedError]:
    if user_context is None:
        user_context = {}
    return await TOTPRecipe.get_instance_or_throw().recipe_implementation.verify_totp(
        tenant_id,
        user_id,
        totp,
        user_context,
    )