microsoft-teams-botbuilder 2.0.0__tar.gz

microsoft_teams_botbuilder-2.0.0/.gitignore

@@ -0,0 +1,51 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# pytest-cov
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+.copilot-instructions.md
+
+# other
+.DS_STORE
+*.bak
+*~
+*.tmp
+
+ref/
+py.typed
+
+.env.claude/
+.claude/
+tmpclaude-*-cwd
+
+examples/**/.vscode/
+examples/**/appPackage/
+examples/**/infra/
+examples/**/teamsapp*
+examples/**/aad.manifest.json
+
+# Node (from tab)
+node_modules
+dist/
+build/

microsoft_teams_botbuilder-2.0.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: microsoft-teams-botbuilder
+Version: 2.0.0
+Summary: BotBuilder plugin for Microsoft Teams
+Project-URL: Homepage, https://github.com/microsoft/teams.py/tree/main/packages/botbuilder/src/microsoft/teams/botbuilder
+Author-email: Microsoft <TeamsAISDKFeedback@microsoft.com>
+License-Expression: MIT
+Keywords: agents,ai,bot,microsoft,teams
+Requires-Python: <3.15,>=3.12
+Requires-Dist: botbuilder-core>=4.14.0
+Requires-Dist: botbuilder-integration-aiohttp>=4.17.0
+Requires-Dist: microsoft-teams-api>=2.0.0
+Requires-Dist: microsoft-teams-apps>=2.0.0
+Requires-Dist: microsoft-teams-common>=2.0.0
+Description-Content-Type: text/markdown
+
+# Microsoft Teams BotBuilder
+
+<p>
+    <a href="https://pypi.org/project/microsoft-teams-botbuilder/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/microsoft-teams-botbuilder" />
+    </a>
+    <a href="https://pypi.org/project/microsoft-teams-botbuilder" target="_blank">
+        <img src="https://img.shields.io/pypi/dw/microsoft-teams-botbuilder" />
+    </a>
+</p>
+
+A package used to make the `microsoft-teams-apps` package backwards compatible with legacy bots built using
+`BotBuilder`.
+
+<a href="https://microsoft.github.io/teams-sdk" target="_blank">
+    <img src="https://img.shields.io/badge/📖 Getting Started-blue?style=for-the-badge" />
+</a>

microsoft_teams_botbuilder-2.0.0/README.md

@@ -0,0 +1,17 @@
+# Microsoft Teams BotBuilder
+
+<p>
+    <a href="https://pypi.org/project/microsoft-teams-botbuilder/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/microsoft-teams-botbuilder" />
+    </a>
+    <a href="https://pypi.org/project/microsoft-teams-botbuilder" target="_blank">
+        <img src="https://img.shields.io/pypi/dw/microsoft-teams-botbuilder" />
+    </a>
+</p>
+
+A package used to make the `microsoft-teams-apps` package backwards compatible with legacy bots built using
+`BotBuilder`.
+
+<a href="https://microsoft.github.io/teams-sdk" target="_blank">
+    <img src="https://img.shields.io/badge/📖 Getting Started-blue?style=for-the-badge" />
+</a>

microsoft_teams_botbuilder-2.0.0/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "microsoft-teams-botbuilder"
+dynamic = ["version"]
+description = "BotBuilder plugin for Microsoft Teams"
+authors = [{ name = "Microsoft", email = "TeamsAISDKFeedback@microsoft.com" }]
+readme = "README.md"
+requires-python = ">=3.12,<3.15"
+repository = "https://github.com/microsoft/teams.py"
+keywords = ["microsoft", "teams", "ai", "bot", "agents"]
+license = "MIT"
+dependencies = [
+    "botbuilder-core>=4.14.0",
+    "botbuilder-integration-aiohttp>=4.17.0",
+    "microsoft-teams-apps",
+    "microsoft-teams-api",
+    "microsoft-teams-common"
+]
+
+[project.urls]
+Homepage = "https://github.com/microsoft/teams.py/tree/main/packages/botbuilder/src/microsoft/teams/botbuilder"
+
+
+[build-system]
+requires = ["hatchling", "hatch-teams-build"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "teams-build"
+
+[tool.hatch.metadata.hooks.teams-build]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/microsoft_teams", "src/microsoft"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src"]
+
+[tool.uv.sources]
+microsoft-teams-apps = { workspace = true }
+microsoft-teams-api = { workspace = true }
+microsoft-teams-common = { workspace = true }

microsoft_teams_botbuilder-2.0.0/src/microsoft_teams/botbuilder/__init__.py

@@ -0,0 +1,12 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+import logging
+
+from .botbuilder_plugin import BotBuilderPlugin, BotBuilderPluginOptions
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+__all__ = ["BotBuilderPlugin", "BotBuilderPluginOptions"]

microsoft_teams_botbuilder-2.0.0/src/microsoft_teams/botbuilder/botbuilder_plugin.py

@@ -0,0 +1,131 @@
+"""
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the MIT License.
+"""
+
+import importlib.metadata
+import logging
+from types import SimpleNamespace
+from typing import Annotated, Optional, TypedDict, Unpack, cast
+
+from microsoft_teams.api import Credentials
+from microsoft_teams.apps import (
+    DependencyMetadata,
+    HttpServer,
+    Plugin,
+    PluginBase,
+)
+from microsoft_teams.apps.http import HttpRequest, HttpResponse
+
+from botbuilder.core import (
+    ActivityHandler,
+    TurnContext,
+)
+from botbuilder.integration.aiohttp import (
+    CloudAdapter,
+    ConfigurationBotFrameworkAuthentication,
+)
+from botbuilder.schema import Activity
+
+version = importlib.metadata.version("microsoft-teams-botbuilder")
+
+logger = logging.getLogger(__name__)
+
+# Constants for app types
+SINGLE_TENANT = "singletenant"
+MULTI_TENANT = "multitenant"
+
+
+class BotBuilderPluginOptions(TypedDict, total=False):
+    """Options for configuring the BotBuilder plugin."""
+
+    handler: ActivityHandler
+    adapter: CloudAdapter
+
+
+@Plugin(name="botbuilder", version=version, description="BotBuilder plugin for Microsoft Bot Framework integration")
+class BotBuilderPlugin(PluginBase):
+    """
+    BotBuilder plugin that provides Microsoft Bot Framework integration.
+    """
+
+    # Dependency injections
+    credentials: Annotated[Optional[Credentials], DependencyMetadata(optional=True)]
+    http_server: Annotated[HttpServer, DependencyMetadata()]
+
+    def __init__(self, **options: Unpack[BotBuilderPluginOptions]):
+        """
+        Initialize the BotBuilder plugin.
+
+        Args:
+            options: Configuration options for the plugin
+        """
+        super().__init__()
+        self.handler: Optional[ActivityHandler] = options.get("handler")
+        self.adapter: Optional[CloudAdapter] = options.get("adapter")
+
+    async def on_init(self) -> None:
+        """Initialize the plugin when the app starts."""
+        if not self.adapter:
+            # Extract credentials for Bot Framework authentication
+            client_id: Optional[str] = None
+            client_secret: Optional[str] = None
+            tenant_id: Optional[str] = None
+
+            if self.credentials:
+                client_id = getattr(self.credentials, "client_id", None)
+                client_secret = getattr(self.credentials, "client_secret", None)
+                tenant_id = getattr(self.credentials, "tenant_id", None)
+
+            config = SimpleNamespace(
+                APP_TYPE=SINGLE_TENANT if tenant_id else MULTI_TENANT,
+                APP_ID=client_id,
+                APP_PASSWORD=client_secret,
+                APP_TENANTID=tenant_id,
+            )
+
+            bot_framework_auth = ConfigurationBotFrameworkAuthentication(configuration=config)
+            self.adapter = CloudAdapter(bot_framework_auth)
+
+            logger.debug("BotBuilder plugin initialized successfully")
+
+        # Register the messaging endpoint route via adapter (bypasses HttpServer's default route)
+        self.http_server.adapter.register_route("POST", self.http_server.messaging_endpoint, self._handle_activity)
+
+    async def _handle_activity(self, request: HttpRequest) -> HttpResponse:
+        """
+        Handler for the messaging endpoint.
+
+        Runs Bot Framework CloudAdapter auth + handler first,
+        then routes through HttpServer.handle_request for SDK-level JWT validation and pipeline.
+        """
+        if not self.adapter:
+            raise RuntimeError("plugin not registered")
+
+        body = request["body"]
+        headers = request["headers"]
+
+        try:
+            # Parse activity from body
+            activity_bf = cast(Activity, Activity().deserialize(body))
+
+            if not activity_bf.type:
+                return HttpResponse(status=400, body={"detail": "Missing activity type"})
+
+            async def logic(turn_context: TurnContext) -> None:
+                if not turn_context.activity.id:
+                    return
+                # Handle activity with botframework handler
+                if self.handler:
+                    await self.handler.on_turn(turn_context)
+
+            # Grab the auth header from the inbound request
+            auth_header = headers.get("authorization") or headers.get("Authorization") or ""
+            await self.adapter.process_activity(auth_header, activity_bf, logic)
+
+            # Route through HttpServer for SDK auth + Teams pipeline
+            return await self.http_server.handle_request(request)
+
+        except Exception as err:
+            logger.error(f"Error processing activity: {err}", exc_info=True)
+            return HttpResponse(status=500, body={"detail": str(err)})