microsoft-agents-hosting-core 0.4.0.dev16__py3-none-any.whl → 0.5.0__py3-none-any.whl

microsoft_agents/hosting/core/app/oauth/authorization.py

@@ -1,3 +1,8 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
 from datetime import datetime
 import logging
 from typing import TypeVar, Optional, Callable, Awaitable, Generic, cast
@@ -50,11 +55,11 @@ class Authorization:
         only if auth_handlers is empty or None.
 
         :param storage: The storage system to use for state management.
-        :type storage: Storage
+        :type storage: :class:`microsoft_agents.hosting.core.storage.Storage`
         :param connection_manager: The connection manager for OAuth providers.
-        :type connection_manager: Connections
+        :type connection_manager: :class:`microsoft_agents.hosting.core.authorization.Connections`
         :param auth_handlers: Configuration for OAuth providers.
-        :type auth_handlers: dict[str, AuthHandler], optional
+        :type auth_handlers: dict[str, :class:`microsoft_agents.hosting.core.app.oauth.auth_handler.AuthHandler`], Optional
         :raises ValueError: When storage is None or no auth handlers provided.
         """
         if not storage:
@@ -100,7 +105,7 @@ class Authorization:
         it initializes an instance of each variant that is referenced.
 
         :param auth_handlers: A dictionary of auth handler configurations.
-        :type auth_handlers: dict[str, AuthHandler]
+        :type auth_handlers: dict[str, :class:`microsoft_agents.hosting.core.app.oauth.auth_handler.AuthHandler`]
         """
         for name, auth_handler in self._handler_settings.items():
             auth_type = auth_handler.auth_type
@@ -121,26 +126,42 @@ class Authorization:
         can be used to inspect or manipulate the state directly if needed.
 
         :param context: The turn context for the current turn of conversation.
-        :type context: TurnContext
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :return: A unique (across other values of channel_id and user_id) key for the sign-in state.
         :rtype: str
         """
         return f"auth:_SignInState:{context.activity.channel_id}:{context.activity.from_property.id}"
 
     async def _load_sign_in_state(self, context: TurnContext) -> Optional[_SignInState]:
-        """Load the sign-in state from storage for the given context."""
+        """Load the sign-in state from storage for the given context.
+
+        :param context: The turn context for the current turn of conversation.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :return: The sign-in state if found, None otherwise.
+        :rtype: Optional[:class:`microsoft_agents.hosting.core.app.oauth._sign_in_state._SignInState`]
+        """
         key = self._sign_in_state_key(context)
         return (await self._storage.read([key], target_cls=_SignInState)).get(key)
 
     async def _save_sign_in_state(
         self, context: TurnContext, state: _SignInState
     ) -> None:
-        """Save the sign-in state to storage for the given context."""
+        """Save the sign-in state to storage for the given context.
+
+        :param context: The turn context for the current turn of conversation.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param state: The sign-in state to save.
+        :type state: :class:`microsoft_agents.hosting.core.app.oauth._sign_in_state._SignInState`
+        """
         key = self._sign_in_state_key(context)
         await self._storage.write({key: state})
 
     async def _delete_sign_in_state(self, context: TurnContext) -> None:
-        """Delete the sign-in state from storage for the given context."""
+        """Delete the sign-in state from storage for the given context.
+
+        :param context: The turn context for the current turn of conversation.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        """
         key = self._sign_in_state_key(context)
         await self._storage.delete([key])
 
@@ -174,7 +195,7 @@ class Authorization:
         :param handler_id: The ID of the auth handler to resolve.
         :type handler_id: str
         :return: The corresponding AuthorizationHandler instance.
-        :rtype: AuthorizationHandler
+        :rtype: :class:`microsoft_agents.hosting.core.app.oauth._handlers._AuthorizationHandler`
         :raises ValueError: If the handler ID is not recognized or not configured.
         """
         if handler_id not in self._handlers:
@@ -195,13 +216,13 @@ class Authorization:
         Storage is updated as needed with _SignInState data for caching purposes.
 
         :param context: The turn context for the current turn of conversation.
-        :type context: TurnContext
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param state: The turn state for the current turn of conversation.
-        :type state: TurnState
+        :type state: :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`
         :param auth_handler_id: The ID of the auth handler to use for sign-in. If None, the first handler will be used.
         :type auth_handler_id: str
         :return: A _SignInResponse indicating the result of the sign-in attempt.
-        :rtype: _SignInResponse
+        :rtype: :class:`microsoft_agents.hosting.core.app.oauth._sign_in_response._SignInResponse`
         """
 
         auth_handler_id = auth_handler_id or self._default_handler_id
@@ -245,7 +266,7 @@ class Authorization:
         """Attempts to sign out the user from a specified auth handler or the default handler.
 
         :param context: The turn context for the current turn of conversation.
-        :type context: TurnContext
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param auth_handler_id: The ID of the auth handler to sign out from. If None, sign out from all handlers.
         :type auth_handler_id: Optional[str]
         :return: None
@@ -267,11 +288,11 @@ class Authorization:
         from the cached _SignInState.
 
         :param context: The context object for the current turn.
-        :type context: TurnContext
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param state: The turn state for the current turn.
-        :type state: TurnState
+        :type state: :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`
         :return: A tuple indicating whether the turn should be skipped and the continuation activity if applicable.
-        :rtype: tuple[bool, Optional[Activity]]
+        :rtype: tuple[bool, Optional[:class:`microsoft_agents.activity.Activity`]]
         """
         sign_in_state = await self._load_sign_in_state(context)
 
@@ -301,11 +322,11 @@ class Authorization:
         The token is taken from cache, so this does not initiate nor continue a sign-in flow.
 
         :param context: The context object for the current turn.
-        :type context: TurnContext
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param auth_handler_id: The ID of the auth handler to get the token for.
         :type auth_handler_id: str
         :return: The token response from the OAuth provider.
-        :rtype: TokenResponse
+        :rtype: :class:`microsoft_agents.activity.TokenResponse`
         """
         return await self.exchange_token(context, auth_handler_id=auth_handler_id)
 
@@ -319,7 +340,7 @@ class Authorization:
         """Exchanges or refreshes the token for a specific auth handler or the default handler.
 
         :param context: The context object for the current turn.
-        :type context: TurnContext
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param scopes: The scopes to request during the token exchange or refresh. Defaults
             to the list given in the AuthHandler configuration if None.
         :type scopes: Optional[list[str]]
@@ -330,7 +351,7 @@ class Authorization:
             the connection defined in the AuthHandler configuration will be used.
         :type exchange_connection: Optional[str]
         :return: The token response from the OAuth provider.
-        :rtype: TokenResponse
+        :rtype: :class:`microsoft_agents.activity.TokenResponse`
         :raises ValueError: If the specified auth handler ID is not recognized or not configured.
         """
 
@@ -371,6 +392,7 @@ class Authorization:
         Sets a handler to be called when sign-in is successfully completed.
 
         :param handler: The handler function to call on successful sign-in.
+        :type handler: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`, :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`, Optional[str]], Awaitable[None]]
         """
         self._sign_in_success_handler = handler
 
@@ -382,5 +404,6 @@ class Authorization:
         Sets a handler to be called when sign-in fails.
 
         :param handler: The handler function to call on sign-in failure.
+        :type handler: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`, :class:`microsoft_agents.hosting.core.app.state.turn_state.TurnState`, Optional[str]], Awaitable[None]]
         """
         self._sign_in_failure_handler = handler

microsoft_agents/hosting/core/app/state/state.py

@@ -97,9 +97,10 @@ class State(dict[str, StoreItem], ABC):
         """
         Saves The State to Storage
 
-        Args:
-            context (TurnContext): the turn context.
-            storage (Optional[Storage]): storage to save to.
+        :param _context: the turn context.
+        :type _context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param storage: storage to save to.
+        :type storage: Optional[:class:`microsoft_agents.hosting.core.storage.Storage`]
         """
 
         if not storage or self.__key__ == "":
@@ -126,13 +127,24 @@ class State(dict[str, StoreItem], ABC):
         """
         Loads The State from Storage
 
-        Args:
-            context: (TurnContext): the turn context.
-            storage (Optional[Storage]): storage to read from.
+        :param context: the turn context.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param storage: storage to read from.
+        :type storage: Optional[:class:`microsoft_agents.hosting.core.storage.Storage`]
+        :return: The loaded state instance.
+        :rtype: :class:`microsoft_agents.hosting.core.app.state.state.State`
         """
         return cls()
 
     def create_property(self, name: str) -> _StatePropertyAccessor:
+        """
+        Create a property accessor for the given name.
+
+        :param name: The name of the property.
+        :type name: str
+        :return: A state property accessor for the named property.
+        :rtype: :class:`microsoft_agents.hosting.core.state.state_property_accessor.StatePropertyAccessor`
+        """
         return StatePropertyAccessor(self, name)
 
     def __setitem__(self, key: str, item: Any) -> None:
@@ -180,6 +192,14 @@ class StatePropertyAccessor(_StatePropertyAccessor):
     _state: State
 
     def __init__(self, state: State, name: str) -> None:
+        """
+        Initialize the StatePropertyAccessor.
+
+        :param state: The state object to access properties from.
+        :type state: :class:`microsoft_agents.hosting.core.app.state.state.State`
+        :param name: The name of the property to access.
+        :type name: str
+        """
         self._name = name
         self._state = state
 
@@ -190,6 +210,16 @@ class StatePropertyAccessor(_StatePropertyAccessor):
             Union[Any, Callable[[], Optional[Any]]]
         ] = None,
     ) -> Optional[Any]:
+        """
+        Get the property value from the state.
+
+        :param turn_context: The turn context.
+        :type turn_context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param default_value_or_factory: Default value or factory function to use if property doesn't exist.
+        :type default_value_or_factory: Optional[Union[Any, Callable[[], Optional[Any]]]]
+        :return: The property value or default value if not found.
+        :rtype: Optional[Any]
+        """
         value = self._state[self._name] if self._name in self._state else None
 
         if value is None and default_value_or_factory is not None:
@@ -201,7 +231,21 @@ class StatePropertyAccessor(_StatePropertyAccessor):
         return value
 
     async def delete(self, turn_context: TurnContext) -> None:
+        """
+        Delete the property from the state.
+
+        :param turn_context: The turn context.
+        :type turn_context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        """
         del self._state[self._name]
 
     async def set(self, turn_context: TurnContext, value: Any) -> None:
+        """
+        Set the property value in the state.
+
+        :param turn_context: The turn context.
+        :type turn_context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param value: The value to set for the property.
+        :type value: Any
+        """
         self._state[self._name] = value

microsoft_agents/hosting/core/app/typing_indicator.py

@@ -4,9 +4,9 @@ Licensed under the MIT License.
 """
 
 from __future__ import annotations
+import asyncio
 import logging
 
-from threading import Timer
 from typing import Optional
 
 from microsoft_agents.hosting.core import TurnContext
@@ -20,36 +20,60 @@ class TypingIndicator:
     Encapsulates the logic for sending "typing" activity to the user.
     """
 
-    _interval: int
-    _timer: Optional[Timer] = None
-
-    def __init__(self, interval=1000) -> None:
-        self._interval = interval
+    def __init__(self, intervalSeconds=1) -> None:
+        self._intervalSeconds = intervalSeconds
+        self._task: Optional[asyncio.Task] = None
+        self._running: bool = False
+        self._lock = asyncio.Lock()
 
     async def start(self, context: TurnContext) -> None:
-        if self._timer is not None:
-            return
+        async with self._lock:
+            if self._running:
+                return
+
+            logger.debug(
+                f"Starting typing indicator with interval: {self._intervalSeconds} seconds"
+            )
+            self._running = True
+            self._task = asyncio.create_task(self._typing_loop(context))
 
-        logger.debug(f"Starting typing indicator with interval: {self._interval} ms")
-        func = self._on_timer(context)
-        self._timer = Timer(self._interval, func)
-        self._timer.start()
-        await func()
+    async def stop(self) -> None:
+        async with self._lock:
+            if not self._running:
+                return
 
-    def stop(self) -> None:
-        if self._timer:
             logger.debug("Stopping typing indicator")
-            self._timer.cancel()
-            self._timer = None
+            self._running = False
+            task = self._task
+            self._task = None
 
-    def _on_timer(self, context: TurnContext):
-        async def __call__():
+        # Cancel outside the lock to avoid blocking
+        if task and not task.done():
+            task.cancel()
             try:
-                logger.debug("Sending typing activity")
-                await context.send_activity(Activity(type=ActivityTypes.typing))
-            except Exception as e:
-                # TODO: Improve when adding logging
-                logger.error(f"Error sending typing activity: {e}")
-                self.stop()
-
-        return __call__
+                await task
+            except asyncio.CancelledError:
+                pass
+
+    async def _typing_loop(self, context: TurnContext):
+        """Continuously send typing indicators at the specified interval."""
+        try:
+            while True:
+                # Check running status under lock
+                async with self._lock:
+                    if not self._running:
+                        break
+
+                try:
+                    logger.debug("Sending typing activity")
+                    await context.send_activity(Activity(type=ActivityTypes.typing))
+                except Exception as e:
+                    logger.error(f"Error sending typing activity: {e}")
+                    async with self._lock:
+                        self._running = False
+                    break
+
+                await asyncio.sleep(self._intervalSeconds)
+        except asyncio.CancelledError:
+            logger.debug("Typing indicator loop cancelled")
+            raise

microsoft_agents/hosting/core/authorization/access_token_provider_base.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Protocol, Optional
 from abc import abstractmethod
 
@@ -40,6 +43,6 @@ class AccessTokenProviderBase(Protocol):
         raise NotImplementedError()
 
     async def get_agentic_user_token(
-        self, agent_app_instance_id: str, upn: str, scopes: list[str]
+        self, agent_app_instance_id: str, agentic_user_id: str, scopes: list[str]
     ) -> Optional[str]:
         raise NotImplementedError()

microsoft_agents/hosting/core/authorization/agent_auth_configuration.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Optional
 
 from microsoft_agents.hosting.core.authorization.auth_types import AuthTypes

microsoft_agents/hosting/core/authorization/anonymous_token_provider.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Optional
 
 from .access_token_provider_base import AccessTokenProviderBase
@@ -30,6 +33,6 @@ class AnonymousTokenProvider(AccessTokenProviderBase):
         return "", ""
 
     async def get_agentic_user_token(
-        self, agent_app_instance_id: str, upn: str, scopes: list[str]
+        self, agent_app_instance_id: str, agentic_user_id: str, scopes: list[str]
     ) -> Optional[str]:
         return ""

microsoft_agents/hosting/core/authorization/auth_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/hosting/core/authorization/connections.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from abc import abstractmethod
 from typing import Protocol
 

microsoft_agents/hosting/core/authorization/jwt_token_validator.py

@@ -1,3 +1,7 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import asyncio
 import logging
 import jwt
 
@@ -13,10 +17,10 @@ class JwtTokenValidator:
     def __init__(self, configuration: AgentAuthConfiguration):
         self.configuration = configuration
 
-    def validate_token(self, token: str) -> ClaimsIdentity:
+    async def validate_token(self, token: str) -> ClaimsIdentity:
 
         logger.debug("Validating JWT token.")
-        key = self._get_public_key_or_secret(token)
+        key = await self._get_public_key_or_secret(token)
         decoded_token = jwt.decode(
             token,
             key=key,
@@ -36,7 +40,7 @@ class JwtTokenValidator:
         logger.debug("Returning anonymous claims identity.")
         return ClaimsIdentity({}, False, authentication_type="Anonymous")
 
-    def _get_public_key_or_secret(self, token: str) -> PyJWK:
+    async def _get_public_key_or_secret(self, token: str) -> PyJWK:
         header = get_unverified_header(token)
         unverified_payload: dict = decode(token, options={"verify_signature": False})
 
@@ -47,5 +51,6 @@ class JwtTokenValidator:
         )
         jwks_client = PyJWKClient(jwksUri)
 
-        key = jwks_client.get_signing_key(header["kid"])
+        key = await asyncio.to_thread(jwks_client.get_signing_key, header["kid"])
+
         return key

microsoft_agents/hosting/core/channel_adapter.py

@@ -40,7 +40,7 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         Sends a set of activities to the user. An array of responses from the server will be returned.
 
         :param context: The context object for the turn.
-        :type context: :class:`TurnContext`
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param activities: The activities to send.
         :type activities: list[Activity]
         :return:
@@ -53,7 +53,7 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         Replaces an existing activity.
 
         :param context: The context object for the turn.
-        :type context: :class:`TurnContext`
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param activity: New replacement activity.
         :type activity: :class:`microsoft_agents.activity.Activity`
         :return:
@@ -68,7 +68,7 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         Deletes an existing activity.
 
         :param context: The context object for the turn.
-        :type context: :class:`TurnContext`
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param reference: Conversation reference for the activity to delete.
         :type reference: :class:`microsoft_agents.activity.ConversationReference`
         :return:
@@ -102,7 +102,7 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :param reference: A reference to the conversation to continue.
         :type reference: :class:`microsoft_agents.activity.ConversationReference`
         :param callback: The method to call for the resulting agent turn.
-        :type callback: Callable[[TurnContext], Awaitable]
+        :type callback: Callable[[microsoft_agents.hosting.core.turn_context.TurnContext], Awaitable]
         :param claims_identity: A :class:`microsoft_agents.hosting.core.ClaimsIdentity` for the conversation.
         :type claims_identity: :class:`microsoft_agents.hosting.core.ClaimsIdentity`
         :param audience:A value signifying the recipient of the proactive message.
@@ -124,11 +124,11 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         to the user.
 
         :param claims_identity: A :class:`microsoft_agents.hosting.core.ClaimsIdentity` for the conversation.
-        :type claims_identity: :class:`microsoft_agents.hosting.core.ClaimsIdentity`
+        :type claims_identity: :class:`microsoft_agents.hosting.core.authorization.ClaimsIdentity`
         :param continuation_activity: The activity to send.
         :type continuation_activity: :class:`microsoft_agents.activity.Activity`
         :param callback: The method to call for the resulting agent turn.
-        :type callback: Callable[[TurnContext], Awaitable]
+        :type callback: Callable[[microsoft_agents.hosting.core.turn_context.TurnContext], Awaitable]
         :param audience: A value signifying the recipient of the proactive message.
         :type audience: str
         """
@@ -155,9 +155,9 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :param audience: A value signifying the recipient of the proactive message.
         :type audience: str
         :param conversation_parameters: The information to use to create the conversation
-        :type conversation_parameters: :class:`microsoft_agents.activity.models.ConversationParameters`
+        :type conversation_parameters: :class:`microsoft_agents.activity.ConversationParameters`
         :param callback: The method to call for the resulting agent turn.
-        :type callback: Callable[[TurnContext], Awaitable]
+        :type callback: Callable[[microsoft_agents.hosting.core.turn_context.TurnContext], Awaitable]
 
         :raises: Exception - Not implemented or when the implementation fails.
 
@@ -222,7 +222,7 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         the end of the chain.
 
         :param context: The context object for the turn.
-        :type context: :class:`TurnContext`
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param callback: A callback method to run at the end of the pipeline.
         :type callback: Callable[[TurnContext], Awaitable]
         :return:

microsoft_agents/hosting/core/channel_api_handler_protocol.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from abc import abstractmethod
 from typing import Protocol, Optional