@microsoft/agents-hosting-express 0.6.1 → 0.6.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/src/startServer.d.ts +6 -5
  2. package/dist/src/startServer.js +6 -5
  3. package/dist/src/startServer.js.map +1 -1
  4. package/package.json +2 -2
  5. package/src/startServer.ts +6 -5
package/dist/src/startServer.d.ts CHANGED
@@ -6,15 +6,16 @@ import { ActivityHandler, AgentApplication, AuthConfiguration, TurnState } from
6
6
  /**
7
7
  * Starts an Express server for handling Agent requests.
8
8
  *
9
- * @param agent - The AgentApplication instance to process incoming activities.
9
+ * @param agent - The AgentApplication or ActivityHandler instance to process incoming activities.
10
10
  * @param authConfiguration - Optional custom authentication configuration. If not provided,
11
- * configuration will be loaded from environment variables.
12
- * @returns void
11
+ * configuration will be loaded from environment variables using loadAuthConfigFromEnv().
12
+ * @returns void - This function does not return a value as it starts a long-running server process.
13
13
  *
14
14
  * @remarks
15
15
  * This function sets up an Express server with the necessary middleware and routes for handling
16
- * bot requests. It configures JWT authorization middleware and sets up the message endpoint.
17
- * The server will listen on the port specified in the environment (or 3978 by default).
16
+ * agent requests. It configures JWT authorization middleware and sets up the message endpoint.
17
+ * The server will listen on the port specified in the PORT environment variable (or 3978 by default)
18
+ * and logs startup information including the SDK version and configured app ID.
18
19
  *
19
20
  * @example
20
21
  * ```typescript
package/dist/src/startServer.js CHANGED
@@ -46,15 +46,16 @@ const agents_hosting_1 = require("@microsoft/agents-hosting");
46
46
  /**
47
47
  * Starts an Express server for handling Agent requests.
48
48
  *
49
- * @param agent - The AgentApplication instance to process incoming activities.
49
+ * @param agent - The AgentApplication or ActivityHandler instance to process incoming activities.
50
50
  * @param authConfiguration - Optional custom authentication configuration. If not provided,
51
- * configuration will be loaded from environment variables.
52
- * @returns void
51
+ * configuration will be loaded from environment variables using loadAuthConfigFromEnv().
52
+ * @returns void - This function does not return a value as it starts a long-running server process.
53
53
  *
54
54
  * @remarks
55
55
  * This function sets up an Express server with the necessary middleware and routes for handling
56
- * bot requests. It configures JWT authorization middleware and sets up the message endpoint.
57
- * The server will listen on the port specified in the environment (or 3978 by default).
56
+ * agent requests. It configures JWT authorization middleware and sets up the message endpoint.
57
+ * The server will listen on the port specified in the PORT environment variable (or 3978 by default)
58
+ * and logs startup information including the SDK version and configured app ID.
58
59
  *
59
60
  * @example
60
61
  * ```typescript
package/dist/src/startServer.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"startServer.js","sourceRoot":"","sources":["../../src/startServer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAA2C;AAC3C,8DAAuK;AAEvK;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,MAAM,WAAW,GAAG,CAAC,KAA8D,EAAE,iBAAqC,EAAE,EAAE;IACnI,MAAM,UAAU,GAAsB,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,IAAA,sCAAqB,GAAE,CAAA;IAClF,IAAI,OAAqB,CAAA;IACzB,IAAI,KAAK,YAAY,gCAAe,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACvD,OAAO,GAAG,IAAI,6BAAY,CAAC,UAAU,CAAC,CAAA;IACxC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,KAAK,CAAC,OAAuB,CAAA;IACzC,CAAC;IACD,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;AAvBY,QAAA,WAAW,eAuBvB"}
1
+ {"version":3,"file":"startServer.js","sourceRoot":"","sources":["../../src/startServer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,sDAA2C;AAC3C,8DAAuK;AAEvK;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,MAAM,WAAW,GAAG,CAAC,KAA8D,EAAE,iBAAqC,EAAE,EAAE;IACnI,MAAM,UAAU,GAAsB,iBAAiB,aAAjB,iBAAiB,cAAjB,iBAAiB,GAAI,IAAA,sCAAqB,GAAE,CAAA;IAClF,IAAI,OAAqB,CAAA;IACzB,IAAI,KAAK,YAAY,gCAAe,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACvD,OAAO,GAAG,IAAI,6BAAY,CAAC,UAAU,CAAC,CAAA;IACxC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,KAAK,CAAC,OAAuB,CAAA;IACzC,CAAC;IACD,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;AAvBY,QAAA,WAAW,eAuBvB"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@microsoft/agents-hosting-express",
4
- "version": "0.6.1",
4
+ "version": "0.6.11",
5
5
  "homepage": "https://github.com/microsoft/Agents-for-js",
6
6
  "repository": {
7
7
  "type": "git",
@@ -19,7 +19,7 @@
19
19
  "main": "dist/src/index.js",
20
20
  "types": "dist/src/index.d.ts",
21
21
  "dependencies": {
22
- "@microsoft/agents-hosting": "0.6.1",
22
+ "@microsoft/agents-hosting": "0.6.11",
23
23
  "express": "^5.1.0"
24
24
  },
25
25
  "license": "MIT",
package/src/startServer.ts CHANGED
@@ -9,15 +9,16 @@ import { ActivityHandler, AgentApplication, AuthConfiguration, authorizeJWT, Clo
9
9
  /**
10
10
  * Starts an Express server for handling Agent requests.
11
11
  *
12
- * @param agent - The AgentApplication instance to process incoming activities.
12
+ * @param agent - The AgentApplication or ActivityHandler instance to process incoming activities.
13
13
  * @param authConfiguration - Optional custom authentication configuration. If not provided,
14
- * configuration will be loaded from environment variables.
15
- * @returns void
14
+ * configuration will be loaded from environment variables using loadAuthConfigFromEnv().
15
+ * @returns void - This function does not return a value as it starts a long-running server process.
16
16
  *
17
17
  * @remarks
18
18
  * This function sets up an Express server with the necessary middleware and routes for handling
19
- * bot requests. It configures JWT authorization middleware and sets up the message endpoint.
20
- * The server will listen on the port specified in the environment (or 3978 by default).
19
+ * agent requests. It configures JWT authorization middleware and sets up the message endpoint.
20
+ * The server will listen on the port specified in the PORT environment variable (or 3978 by default)
21
+ * and logs startup information including the SDK version and configured app ID.
21
22
  *
22
23
  * @example
23
24
  * ```typescript