@microsoft/agents-a365-runtime 0.1.0-preview.103

package/dist/esm/utility.js

@@ -0,0 +1,147 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import * as jwt from 'jsonwebtoken';
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+import { LIB_VERSION } from './version';
+/**
+ * Utility class providing helper methods for agent runtime operations.
+ */
+export class Utility {
+    /**
+     * Reads the application name from package.json at module load time.
+     * This ensures file I/O happens during initialization, not during requests.
+     *
+     * Note: Uses process.cwd() which assumes the application is started from its root directory.
+     * This is a fallback mechanism - npm_package_name (checked first in getApplicationName) is
+     * the preferred source as it's reliably set by npm/pnpm when running package scripts.
+     */
+    static initPackageName() {
+        try {
+            const packageJsonPath = path.resolve(process.cwd(), 'package.json');
+            const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+            return packageJson.name || null;
+        }
+        catch {
+            // TODO: Add debug-level logging once a logger implementation is available
+            // to help troubleshoot package.json read failures in production environments
+            return null;
+        }
+    }
+    /**
+     * **WARNING: NO SIGNATURE VERIFICATION** - This method uses jwt.decode() which does NOT
+     * verify the token signature. The token claims can be spoofed by malicious actors.
+     * This method is ONLY suitable for logging, analytics, and diagnostics purposes.
+     * Do NOT use the returned value for authorization, access control, or security decisions.
+     *
+     * Decodes the current token and retrieves the App ID (appid or azp claim).
+     *
+     * Note: Returns a default GUID ('00000000-0000-0000-0000-000000000000') for empty tokens
+     * for backward compatibility with callers that expect a valid-looking GUID.
+     * For agent identification where empty string is preferred, use {@link getAgentIdFromToken}.
+     *
+     * @param token Token to Decode
+     * @returns AppId, or default GUID for empty token, or empty string if decode fails
+     */
+    static GetAppIdFromToken(token) {
+        if (!token || token.trim() === '') {
+            return '00000000-0000-0000-0000-000000000000';
+        }
+        try {
+            const decoded = jwt.decode(token);
+            if (!decoded) {
+                return '';
+            }
+            // Look for appid claim first, then azp claim as fallback
+            const appIdClaim = decoded['appid'] || decoded['azp'];
+            return appIdClaim || '';
+        }
+        catch (_error) {
+            // Silent error handling - return empty string on decode failure
+            return '';
+        }
+    }
+    /**
+     * **WARNING: NO SIGNATURE VERIFICATION** - This method uses jwt.decode() which does NOT
+     * verify the token signature. The token claims can be spoofed by malicious actors.
+     * This method is ONLY suitable for logging, analytics, and diagnostics purposes.
+     * Do NOT use the returned value for authorization, access control, or security decisions.
+     *
+     * Decodes the token and retrieves the best available agent identifier.
+     * Checks claims in priority order: xms_par_app_azp (agent blueprint ID) > appid > azp.
+     *
+     * Note: Returns empty string for empty/missing tokens (unlike {@link GetAppIdFromToken} which
+     * returns a default GUID). This allows callers to omit headers when no identifier is available.
+     *
+     * @param token JWT token to decode
+     * @returns Agent ID (GUID) or empty string if not found or token is empty
+     */
+    static getAgentIdFromToken(token) {
+        if (!token || token.trim() === '') {
+            return '';
+        }
+        try {
+            const decoded = jwt.decode(token);
+            if (!decoded) {
+                return '';
+            }
+            // Priority: xms_par_app_azp (agent blueprint ID) > appid > azp
+            return decoded['xms_par_app_azp'] || decoded['appid'] || decoded['azp'] || '';
+        }
+        catch (_error) {
+            // Silent error handling - return empty string on decode failure
+            return '';
+        }
+    }
+    /**
+     * Resolves the agent identity from the turn context or auth token.
+     * @param context Turn Context of the turn.
+     * @param authToken Auth token if available.
+     * @returns Agent identity (App ID)
+     */
+    static ResolveAgentIdentity(context, authToken) {
+        // App ID is required to pass to MCP server URL.
+        const agenticAppId = context.activity.isAgenticRequest()
+            ? context.activity.getAgenticInstanceId() || ''
+            : this.GetAppIdFromToken(authToken);
+        return agenticAppId;
+    }
+    /**
+     * Generates a User-Agent header string containing SDK version, OS type, Node.js version, and orchestrator.
+     * @param orchestrator Optional orchestrator identifier to include in the User-Agent string.
+     * @returns Formatted User-Agent header string.
+     */
+    static GetUserAgentHeader(orchestrator) {
+        const osType = os.type();
+        const orchestratorPart = orchestrator ? `; ${orchestrator}` : '';
+        return `Agent365SDK/${LIB_VERSION} (${osType}; Node.js ${process.version}${orchestratorPart})`;
+    }
+    /**
+     * Gets the application name from npm_package_name environment variable or package.json.
+     * The package.json result is cached at module load time to avoid sync I/O during requests.
+     * @returns Application name or undefined if not available.
+     */
+    static getApplicationName() {
+        // First try npm_package_name (set automatically by npm/pnpm when running scripts)
+        // eslint-disable-next-line no-restricted-properties -- npm_package_name is set by npm at runtime, not a configurable setting
+        if (process.env.npm_package_name) {
+            // eslint-disable-next-line no-restricted-properties -- npm_package_name is set by npm at runtime, not a configurable setting
+            return process.env.npm_package_name;
+        }
+        // Fall back to cached package.json name (read at module load time)
+        return this.cachedPackageName || undefined;
+    }
+    /**
+     * Resets the cached application name. Used for testing purposes.
+     * @internal
+     */
+    static resetApplicationNameCache() {
+        this.cachedPackageName = Utility.initPackageName();
+    }
+}
+// Cache for application name read from package.json
+// null = checked but not found, string = found
+// Eagerly initialized at module load time to avoid sync I/O during requests
+Utility.cachedPackageName = Utility.initPackageName();
+//# sourceMappingURL=utility.js.map

package/dist/esm/utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.js","sourceRoot":"","sources":["../../src/utility.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC;;GAEG;AACH,MAAM,OAAO,OAAO;IAMlB;;;;;;;OAOG;IACK,MAAM,CAAC,eAAe;QAC5B,IAAI,CAAC;YACH,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;YACpE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;YAC1E,OAAO,WAAW,CAAC,IAAI,IAAI,IAAI,CAAC;QAClC,CAAC;QAAC,MAAM,CAAC;YACP,0EAA0E;YAC1E,6EAA6E;YAC7E,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,iBAAiB,CAAC,KAAa;QAC3C,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAClC,OAAO,sCAAsC,CAAC;QAChD,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAmB,CAAC;YACpD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,yDAAyD;YACzD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;YACtD,OAAO,UAAU,IAAI,EAAE,CAAC;QAC1B,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAChB,gEAAgE;YAChE,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,MAAM,CAAC,mBAAmB,CAAC,KAAa;QAC7C,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAClC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAmB,CAAC;YACpD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,+DAA+D;YAC/D,OAAO,OAAO,CAAC,iBAAiB,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAChF,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YAChB,gEAAgE;YAChE,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,oBAAoB,CAAC,OAAoB,EAAE,SAAiB;QACxE,gDAAgD;QAChD,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EAAE;YACtD,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,IAAI,EAAE;YAC/C,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAEtC,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,YAAqB;QACpD,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;QACzB,MAAM,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,OAAO,eAAe,WAAW,KAAK,MAAM,aAAa,OAAO,CAAC,OAAO,GAAG,gBAAgB,GAAG,CAAC;IACjG,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB;QAC9B,kFAAkF;QAClF,6HAA6H;QAC7H,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YACjC,6HAA6H;YAC7H,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;QACtC,CAAC;QAED,mEAAmE;QACnE,OAAO,IAAI,CAAC,iBAAiB,IAAI,SAAS,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,yBAAyB;QACrC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IACrD,CAAC;;AA9ID,oDAAoD;AACpD,+CAA+C;AAC/C,4EAA4E;AAC7D,yBAAiB,GAAkB,OAAO,CAAC,eAAe,EAAE,CAAC"}

package/dist/esm/version.d.ts

@@ -0,0 +1,2 @@
+export declare const LIB_VERSION = "0.1.0-preview.103";
+//# sourceMappingURL=version.d.ts.map

package/dist/esm/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,sBAAsB,CAAC"}

package/dist/esm/version.js

@@ -0,0 +1,2 @@
+export const LIB_VERSION = "0.1.0-preview.103";
+//# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,WAAW,GAAG,mBAAmB,CAAC"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@microsoft/agents-a365-runtime",
+  "version": "0.1.0-preview.103",
+  "description": "Agent 365 Runtime SDK for AI agents built with TypeScript/Node.js",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "keywords": [
+    "ai",
+    "agents",
+    "azure",
+    "typescript"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/Agent365-nodejs.git",
+    "directory": "packages/agents-a365-runtime"
+  },
+  "dependencies": {
+    "@azure/identity": "^4.12.1",
+    "@microsoft/agents-hosting": "^1.1.0-alpha.85",
+    "jsonwebtoken": "^9.0.3"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/jest": "^30.0.0",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/node": "^20.17.0",
+    "@typescript-eslint/eslint-plugin": "^8.47.0",
+    "@typescript-eslint/parser": "^8.47.0",
+    "eslint": "^9.39.1",
+    "jest": "^30.2.0",
+    "rimraf": "^6.0.0",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.47.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE.md"
+  ],
+  "scripts": {
+    "prebuild": "node -p \"'export const LIB_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
+    "build:cjs": "npx tsc --project tsconfig.cjs.json",
+    "build:esm": "npx tsc --project tsconfig.esm.json",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:watch": "npx tsc --watch",
+    "clean": "npx rimraf dist",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "ci": "npm ci",
+    "pack": "node ../../copyFiles.js . && pnpm pack --pack-destination=../"
+  }
+}