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

microsoft_agents/hosting/core/channel_service_adapter.py

@@ -44,12 +44,29 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
     _AGENT_CONNECTOR_CLIENT_KEY = "ConnectorClient"
 
     def __init__(self, channel_service_client_factory: ChannelServiceClientFactoryBase):
+        """
+        Initialize the ChannelServiceAdapter.
+
+        :param channel_service_client_factory: The factory for creating channel service clients.
+        :type channel_service_client_factory: :class:`microsoft_agents.hosting.core.channel_service_client_factory_base.ChannelServiceClientFactoryBase`
+        """
         super().__init__()
         self._channel_service_client_factory = channel_service_client_factory
 
     async def send_activities(
         self, context: TurnContext, activities: list[Activity]
     ) -> list[ResourceResponse]:
+        """
+        Send a list of activities to the conversation.
+
+        :param context: The turn context for this conversation turn.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param activities: The list of activities to send.
+        :type activities: list[:class:`microsoft_agents.activity.Activity`]
+        :return: List of resource responses for the sent activities.
+        :rtype: list[:class:`microsoft_agents.activity.ResourceResponse`]
+        :raises TypeError: If context or activities are None/invalid.
+        """
         if not context:
             raise TypeError("Expected TurnContext but got None instead")
 
@@ -66,10 +83,7 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
 
             response = ResourceResponse()
 
-            if activity.type == "delay":
-                delay_time = int((activity.value or 1000) / 1000)
-                await sleep(delay_time)
-            elif activity.type == ActivityTypes.invoke_response:
+            if activity.type == ActivityTypes.invoke_response:
                 context.turn_state[self.INVOKE_RESPONSE_KEY] = activity
             elif (
                 activity.type == ActivityTypes.trace
@@ -105,6 +119,17 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
         return responses
 
     async def update_activity(self, context: TurnContext, activity: Activity):
+        """
+        Update an existing activity in the conversation.
+
+        :param context: The turn context for this conversation turn.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param activity: The activity to update.
+        :type activity: :class:`microsoft_agents.activity.Activity`
+        :return: Resource response for the updated activity.
+        :rtype: :class:`microsoft_agents.activity.ResourceResponse`
+        :raises TypeError: If context or activity are None/invalid.
+        """
         if not context:
             raise TypeError("Expected TurnContext but got None instead")
 
@@ -125,6 +150,15 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
     async def delete_activity(
         self, context: TurnContext, reference: ConversationReference
     ):
+        """
+        Delete an activity from the conversation.
+
+        :param context: The turn context for this conversation turn.
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param reference: Reference to the conversation and activity to delete.
+        :type reference: :class:`microsoft_agents.activity.ConversationReference`
+        :raises TypeError: If context or reference are None/invalid.
+        """
         if not context:
             raise TypeError("Expected TurnContext but got None instead")
 
@@ -158,9 +192,9 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
             and is generally found in the `MicrosoftAppId` parameter in `config.py`.
         :type agent_app_id: str
         :param continuation_activity: The activity to continue the conversation with.
-        :type continuation_activity: Activity
+        :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[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`], Awaitable]
         """
         if not callable:
             raise TypeError(
@@ -185,6 +219,18 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
         callback: Callable[[TurnContext], Awaitable],
         audience: str = None,
     ):
+        """
+        Continue a conversation with the provided claims identity.
+
+        :param claims_identity: The claims identity for the conversation.
+        :type claims_identity: :class:`microsoft_agents.hosting.core.authorization.ClaimsIdentity`
+        :param continuation_activity: The activity to continue the conversation with.
+        :type continuation_activity: :class:`microsoft_agents.activity.Activity`
+        :param callback: The method to call for the resulting agent turn.
+        :type callback: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`], Awaitable]
+        :param audience: The audience for the conversation.
+        :type audience: Optional[str]
+        """
         return await self.process_proactive(
             claims_identity, continuation_activity, audience, callback
         )
@@ -302,14 +348,15 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
         """
         Creates a turn context and runs the middleware pipeline for an incoming activity.
 
-        :param auth_header: The HTTP authentication header of the request
-        :type auth_header: Union[str, AuthenticateRequestResult]
+        :param claims_identity: The claims identity of the agent.
+        :type claims_identity: :class:`microsoft_agents.hosting.core.authorization.ClaimsIdentity`
         :param activity: The incoming activity
-        :type activity: Activity
+        :type activity: :class:`microsoft_agents.activity.Activity`
         :param callback: The callback to execute at the end of the adapter's middleware pipeline.
-        :type callback: Callable[[TurnContext], Awaitable]
+        :type callback: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`], Awaitable]
 
         :return: A task that represents the work queued to execute.
+        :rtype: Optional[:class:`microsoft_agents.activity.InvokeResponse`]
 
         .. remarks::
             This class processes an activity received by the agents web server. This includes any messages
@@ -375,6 +422,14 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
         return self._process_turn_results(context)
 
     def create_claims_identity(self, agent_app_id: str = "") -> ClaimsIdentity:
+        """
+        Create a claims identity for the given agent app ID.
+
+        :param agent_app_id: The agent application ID.
+        :type agent_app_id: str
+        :return: A claims identity for the agent.
+        :rtype: :class:`microsoft_agents.hosting.core.authorization.ClaimsIdentity`
+        """
         return ClaimsIdentity(
             {
                 AuthenticationConstants.AUDIENCE_CLAIM: agent_app_id,

microsoft_agents/hosting/core/channel_service_client_factory_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
 

microsoft_agents/hosting/core/client/agent_conversation_reference.py

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

microsoft_agents/hosting/core/client/channel_factory_protocol.py

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

microsoft_agents/hosting/core/client/channel_host_protocol.py

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

microsoft_agents/hosting/core/client/channel_info_protocol.py

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

microsoft_agents/hosting/core/client/channel_protocol.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Protocol
 
 from microsoft_agents.activity import AgentsModel, Activity, InvokeResponse

microsoft_agents/hosting/core/client/channels_configuration.py

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

microsoft_agents/hosting/core/client/configuration_channel_host.py

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

microsoft_agents/hosting/core/client/conversation_constants.py

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

microsoft_agents/hosting/core/client/conversation_id_factory.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from uuid import uuid4
 from functools import partial
 from typing import Type

microsoft_agents/hosting/core/client/conversation_id_factory_options.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from microsoft_agents.activity import Activity
 
 from .channel_info_protocol import ChannelInfoProtocol

microsoft_agents/hosting/core/client/conversation_id_factory_protocol.py

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

microsoft_agents/hosting/core/client/http_agent_channel.py

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

microsoft_agents/hosting/core/client/http_agent_channel_factory.py

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

microsoft_agents/hosting/core/connector/client/connector_client.py

@@ -124,7 +124,7 @@ class ConversationsOperations(ConversationsBase):
 
     def __init__(self, client: ClientSession, **kwargs):
         self.client = client
-        self._max_conversation_id_length = kwargs.get("max_conversation_id_length", 200)
+        self._max_conversation_id_length = kwargs.get("max_conversation_id_length", 150)
 
     def _normalize_conversation_id(self, conversation_id: str) -> str:
         return conversation_id[: self._max_conversation_id_length]
@@ -197,9 +197,6 @@ class ConversationsOperations(ConversationsBase):
             )
             raise ValueError("conversationId and activityId are required")
 
-        print("\n*3")
-        print(conversation_id)
-        print("\n*3")
         conversation_id = self._normalize_conversation_id(conversation_id)
         url = f"v3/conversations/{conversation_id}/activities/{activity_id}"
 

microsoft_agents/hosting/core/connector/client/user_token_client.py

@@ -8,7 +8,12 @@ from typing import Optional
 from aiohttp import ClientSession
 
 from microsoft_agents.hosting.core.connector import UserTokenClientBase
-from microsoft_agents.activity import TokenResponse, TokenStatus, SignInResource
+from microsoft_agents.activity import (
+    TokenOrSignInResourceResponse,
+    TokenResponse,
+    TokenStatus,
+    SignInResource,
+)
 from ..get_product_info import get_product_info
 from ..user_token_base import UserTokenBase
 from ..agent_sign_in_base import AgentSignInBase
@@ -110,15 +115,6 @@ class UserToken(UserTokenBase):
         channel_id: Optional[str] = None,
         code: Optional[str] = None,
     ) -> TokenResponse:
-        """
-        Gets a token for a user and connection.
-
-        :param user_id: ID of the user.
-        :param connection_name: Name of the connection to use.
-        :param channel_id: ID of the channel.
-        :param code: Optional authorization code.
-        :return: A token response.
-        """
         params = {"userId": user_id, "connectionName": connection_name}
 
         if channel_id:
@@ -137,6 +133,40 @@ class UserToken(UserTokenBase):
             data = await response.json()
             return TokenResponse.model_validate(data)
 
+    async def _get_token_or_sign_in_resource(
+        self,
+        user_id: str,
+        connection_name: str,
+        channel_id: str,
+        state: str,
+        code: str = "",
+        final_redirect: str = "",
+        fwd_url: str = "",
+    ) -> TokenOrSignInResourceResponse:
+
+        params = {
+            "userId": user_id,
+            "connectionName": connection_name,
+            "channelId": channel_id,
+            "state": state,
+            "code": code,
+            "finalRedirect": final_redirect,
+            "fwdUrl": fwd_url,
+        }
+
+        logger.info("Getting token or sign-in resource with params: %s", params)
+        async with self.client.get(
+            "/api/usertoken/GetTokenOrSignInResource", params=params
+        ) as response:
+            if response.status != 200:
+                logger.error(
+                    "Error getting token or sign-in resource: %s", response.status
+                )
+                response.raise_for_status()
+
+            data = await response.json()
+            return TokenOrSignInResourceResponse.model_validate(data)
+
     async def get_aad_tokens(
         self,
         user_id: str,
@@ -144,15 +174,6 @@ class UserToken(UserTokenBase):
         channel_id: Optional[str] = None,
         body: Optional[dict] = None,
     ) -> dict[str, TokenResponse]:
-        """
-        Gets Azure Active Directory tokens for a user and connection.
-
-        :param user_id: ID of the user.
-        :param connection_name: Name of the connection to use.
-        :param channel_id: ID of the channel.
-        :param body: An optional dictionary containing resource URLs.
-        :return: A dictionary of tokens.
-        """
         params = {"userId": user_id, "connectionName": connection_name}
 
         if channel_id:
@@ -175,13 +196,6 @@ class UserToken(UserTokenBase):
         connection_name: Optional[str] = None,
         channel_id: Optional[str] = None,
     ) -> None:
-        """
-        Signs the user out from the specified connection.
-
-        :param user_id: ID of the user.
-        :param connection_name: Name of the connection to use.
-        :param channel_id: ID of the channel.
-        """
         params = {"userId": user_id}
 
         if connection_name:
@@ -203,14 +217,6 @@ class UserToken(UserTokenBase):
         channel_id: Optional[str] = None,
         include: Optional[str] = None,
     ) -> list[TokenStatus]:
-        """
-        Gets token status for the user.
-
-        :param user_id: ID of the user.
-        :param channel_id: ID of the channel.
-        :param include: Optional filter.
-        :return: A list of token status objects.
-        """
         params = {"userId": user_id}
 
         if channel_id:
@@ -236,15 +242,6 @@ class UserToken(UserTokenBase):
         channel_id: str,
         body: Optional[dict] = None,
     ) -> TokenResponse:
-        """
-        Exchanges a token.
-
-        :param user_id: ID of the user.
-        :param connection_name: Name of the connection to use.
-        :param channel_id: ID of the channel.
-        :param body: An optional token exchange request body.
-        :return: A token response.
-        """
         params = {
             "userId": user_id,
             "connectionName": connection_name,

microsoft_agents/hosting/core/connector/user_token_base.py

@@ -1,10 +1,19 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from abc import abstractmethod
 from typing import Protocol
 
-from microsoft_agents.activity import TokenResponse, TokenStatus
+from microsoft_agents.activity import (
+    TokenResponse,
+    TokenStatus,
+    TokenOrSignInResourceResponse,
+)
 
 
 class UserTokenBase(Protocol):
+    """Base class for user token operations."""
+
     @abstractmethod
     async def get_token(
         self,
@@ -13,6 +22,40 @@ class UserTokenBase(Protocol):
         channel_id: str = None,
         code: str = None,
     ) -> TokenResponse:
+        """
+        Get sign-in URL.
+
+        :param state: State parameter for OAuth flow.
+        :param code_challenge: Code challenge for PKCE.
+        :param emulator_url: Emulator URL if used.
+        :param final_redirect: Final redirect URL.
+        :return: The sign-in URL.
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    async def _get_token_or_sign_in_resource(
+        self,
+        user_id: str,
+        connection_name: str,
+        channel_id: str,
+        state: str,
+        code: str = "",
+        final_redirect: str = "",
+        fwd_url: str = "",
+    ) -> TokenOrSignInResourceResponse:
+        """
+        Gets a token or a sign-in resource for a user and connection.
+
+        :param user_id: ID of the user.
+        :param connection_name: Name of the connection to use.
+        :param channel_id: ID of the channel.
+        :param state: State parameter for OAuth flow.
+        :param code: Optional authorization code.
+        :param final_redirect: Final redirect URL.
+        :param fwd_url: Forward URL.
+        :return: A token or sign-in resource response.
+        """
         raise NotImplementedError()
 
     @abstractmethod
@@ -23,22 +66,55 @@ class UserTokenBase(Protocol):
         channel_id: str = None,
         body: dict = None,
     ) -> dict[str, TokenResponse]:
+        """
+        Gets Azure Active Directory tokens for a user and connection.
+
+        :param user_id: ID of the user.
+        :param connection_name: Name of the connection to use.
+        :param channel_id: ID of the channel.
+        :param body: An optional dictionary containing resource URLs.
+        :return: A dictionary of tokens.
+        """
         raise NotImplementedError()
 
     @abstractmethod
     async def sign_out(
         self, user_id: str, connection_name: str = None, channel_id: str = None
     ) -> None:
+        """
+        Signs the user out from the specified connection.
+
+        :param user_id: ID of the user.
+        :param connection_name: Name of the connection to use.
+        :param channel_id: ID of the channel.
+        """
         raise NotImplementedError()
 
     @abstractmethod
     async def get_token_status(
         self, user_id: str, channel_id: str = None, include: str = None
     ) -> list[TokenStatus]:
+        """
+        Gets token status for the user.
+
+        :param user_id: ID of the user.
+        :param channel_id: ID of the channel.
+        :param include: Optional filter.
+        :return: A list of token status objects.
+        """
         raise NotImplementedError()
 
     @abstractmethod
     async def exchange_token(
         self, user_id: str, connection_name: str, channel_id: str, body: dict = None
     ) -> TokenResponse:
+        """
+        Exchanges a token.
+
+        :param user_id: ID of the user.
+        :param connection_name: Name of the connection to use.
+        :param channel_id: ID of the channel.
+        :param body: An optional token exchange request body.
+        :return: A token response.
+        """
         raise NotImplementedError()

microsoft_agents/hosting/core/connector/user_token_client_base.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/rest_channel_service_client_factory.py

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