@microsoft/agents-hosting-express 0.2.14

package/README.md

@@ -0,0 +1,18 @@
+# microsoft/agents-hosting-express
+
+## Overview
+
+Provides integration to host the agent in Express using `startServer`
+
+## Usage
+
+ ```ts
+ import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
+ import { startServer } from '@microsoft/agents-hosting-express';
+ 
+ const app = new AgentApplication<TurnState>();
+ app.message('hello', async (context, state) => {
+   await context.sendActivity('Hello, world!');
+ });
+ startServer(app);
+  ```

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export * from './startServer';

package/dist/src/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./startServer"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA6B"}

package/dist/src/startServer.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AgentApplication, AuthConfiguration, TurnState } from '@microsoft/agents-hosting';
+/**
+ * Starts an Express server for handling Agent requests.
+ *
+ * @param agent - The AgentApplication instance to process incoming activities.
+ * @param authConfiguration - Optional custom authentication configuration. If not provided,
+ *                           configuration will be loaded from environment variables.
+ * @returns void
+ *
+ * @remarks
+ * This function sets up an Express server with the necessary middleware and routes for handling
+ * bot requests. It configures JWT authorization middleware and sets up the message endpoint.
+ * The server will listen on the port specified in the environment (or 3978 by default).
+ *
+ * @example
+ * ```typescript
+ * import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
+ * import { startServer } from '@microsoft/agents-hosting-express';
+ *
+ * const app = new AgentApplication<TurnState>();
+ * app.message('hello', async (context, state) => {
+ *   await context.sendActivity('Hello, world!');
+ * });
+ *
+ * startServer(app);
+ * ```
+ */
+export declare const startServer: (agent: AgentApplication<TurnState>, authConfiguration?: AuthConfiguration) => void;

package/dist/src/startServer.js

@@ -0,0 +1,86 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startServer = void 0;
+const express_1 = __importDefault(require("express"));
+const agents_hosting_1 = require("@microsoft/agents-hosting");
+/**
+ * Starts an Express server for handling Agent requests.
+ *
+ * @param agent - The AgentApplication instance to process incoming activities.
+ * @param authConfiguration - Optional custom authentication configuration. If not provided,
+ *                           configuration will be loaded from environment variables.
+ * @returns void
+ *
+ * @remarks
+ * This function sets up an Express server with the necessary middleware and routes for handling
+ * bot requests. It configures JWT authorization middleware and sets up the message endpoint.
+ * The server will listen on the port specified in the environment (or 3978 by default).
+ *
+ * @example
+ * ```typescript
+ * import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
+ * import { startServer } from '@microsoft/agents-hosting-express';
+ *
+ * const app = new AgentApplication<TurnState>();
+ * app.message('hello', async (context, state) => {
+ *   await context.sendActivity('Hello, world!');
+ * });
+ *
+ * startServer(app);
+ * ```
+ */
+const startServer = (agent, authConfiguration) => {
+    const authConfig = authConfiguration !== null && authConfiguration !== void 0 ? authConfiguration : (0, agents_hosting_1.loadAuthConfigFromEnv)();
+    const adapter = new agents_hosting_1.CloudAdapter(authConfig);
+    const server = (0, express_1.default)();
+    server.use(express_1.default.json());
+    server.use((0, agents_hosting_1.authorizeJWT)(authConfig));
+    server.post('/api/messages', (req, res) => adapter.process(req, res, (context) => agent.run(context)));
+    const port = process.env.PORT || 3978;
+    server.listen(port, async () => {
+        const version = (await Promise.resolve().then(() => __importStar(require('@microsoft/agents-hosting/package.json')))).version;
+        console.log(`\nServer listening to port ${port} on sdk ${version} for appId ${authConfig.clientId} debug ${process.env.DEBUG}`);
+    }).on('error', console.error);
+};
+exports.startServer = startServer;
+//# sourceMappingURL=startServer.js.map

package/dist/src/startServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startServer.js","sourceRoot":"","sources":["../../src/startServer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAA2C;AAC3C,8DAAsJ;AAEtJ;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,MAAM,WAAW,GAAG,CAAC,KAAkC,EAAE,iBAAqC,EAAE,EAAE;IACvG,MAAM,UAAU,GAAsB,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,IAAA,sCAAqB,GAAE,CAAA;IAClF,MAAM,OAAO,GAAG,IAAI,6BAAY,CAAC,UAAU,CAAC,CAAA;IAC5C,MAAM,MAAM,GAAG,IAAA,iBAAO,GAAE,CAAA;IACxB,MAAM,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IAC1B,MAAM,CAAC,GAAG,CAAC,IAAA,6BAAY,EAAC,UAAU,CAAC,CAAC,CAAA;IAEpC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE,CAC3D,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CACpC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CACnB,CACF,CAAA;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAA;IACrC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;QAC7B,MAAM,OAAO,GAAG,CAAC,wDAAa,wCAAwC,GAAC,CAAC,CAAC,OAAO,CAAA;QAChF,OAAO,CAAC,GAAG,CAAC,8BAA8B,IAAI,WAAW,OAAO,cAAc,UAAU,CAAC,QAAQ,UAAU,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAA;IACjI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;AAC/B,CAAC,CAAA;AAlBY,QAAA,WAAW,eAkBvB"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@microsoft/agents-hosting-express",
+  "version": "0.2.14",
+  "homepage": "https://github.com/microsoft/Agents-for-js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/Agents-for-js.git"
+  },
+  "author": {
+    "name": "Microsoft",
+    "email": "agentssdk@microsoft.com",
+    "url": "https://aka.ms/Agents"
+  },
+  "description": "Microsoft 365 Agents SDK for JavaScript",
+  "keywords": [
+    "Agents"
+  ],
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "dependencies": {
+    "@microsoft/agents-hosting": "0.2.14",
+    "express": "^5.1.0"
+  },
+  "license": "MIT",
+  "files": [
+    "README.md",
+    "dist/src",
+    "src"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js",
+      "require": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './startServer'

package/src/startServer.ts

@@ -0,0 +1,53 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import express, { Response } from 'express'
+import { AgentApplication, AuthConfiguration, authorizeJWT, CloudAdapter, loadAuthConfigFromEnv, Request, TurnState } from '@microsoft/agents-hosting'
+
+/**
+ * Starts an Express server for handling Agent requests.
+ *
+ * @param agent - The AgentApplication instance to process incoming activities.
+ * @param authConfiguration - Optional custom authentication configuration. If not provided,
+ *                           configuration will be loaded from environment variables.
+ * @returns void
+ *
+ * @remarks
+ * This function sets up an Express server with the necessary middleware and routes for handling
+ * bot requests. It configures JWT authorization middleware and sets up the message endpoint.
+ * The server will listen on the port specified in the environment (or 3978 by default).
+ *
+ * @example
+ * ```typescript
+ * import { AgentApplication, TurnState } from '@microsoft/agents-hosting';
+ * import { startServer } from '@microsoft/agents-hosting-express';
+ *
+ * const app = new AgentApplication<TurnState>();
+ * app.message('hello', async (context, state) => {
+ *   await context.sendActivity('Hello, world!');
+ * });
+ *
+ * startServer(app);
+ * ```
+ */
+export const startServer = (agent: AgentApplication<TurnState>, authConfiguration?: AuthConfiguration) => {
+  const authConfig: AuthConfiguration = authConfiguration ?? loadAuthConfigFromEnv()
+  const adapter = new CloudAdapter(authConfig)
+  const server = express()
+  server.use(express.json())
+  server.use(authorizeJWT(authConfig))
+
+  server.post('/api/messages', (req: Request, res: Response) =>
+    adapter.process(req, res, (context) =>
+      agent.run(context)
+    )
+  )
+
+  const port = process.env.PORT || 3978
+  server.listen(port, async () => {
+    const version = (await import('@microsoft/agents-hosting/package.json')).version
+    console.log(`\nServer listening to port ${port} on sdk ${version} for appId ${authConfig.clientId} debug ${process.env.DEBUG}`)
+  }).on('error', console.error)
+}