@economic/agents 1.7.2 → 1.7.3

package/dist/index.d.mts

@@ -57,9 +57,9 @@ declare function buildLLMParams(config: BuildLLMParamsConfig): LLMParams;
  * type MyContext = AgentToolContext<MyBody>;
  * ```
  */
-type AgentToolContext<TBody = Record<string, unknown>, TJwtIdentity = Record<string, unknown> | undefined> = TBody & {
+type AgentToolContext<TBody = Record<string, unknown>, TUserContext = Record<string, unknown> | undefined> = TBody & {
   _logEvent: (message: string, payload?: Record<string, unknown>) => void | Promise<void>;
-  _jwtIdentity?: TJwtIdentity;
+  _userContext?: TUserContext;
 };
 interface AgentEnv {
   AGENT_DB: D1Database;
@@ -95,7 +95,9 @@ interface JwtAuthConfig<TClaims extends Record<string, unknown> = Record<string,
  * For chat agents with message history, compaction, and conversation recording,
  * extend {@link ChatAgent} instead.
  */
-declare abstract class Agent<Env extends Cloudflare.Env = Cloudflare.Env, TJwtIdentity extends Record<string, unknown> = Record<string, unknown>> extends Agent$1<Env & AgentEnv> {
+declare abstract class Agent<Env extends Cloudflare.Env = Cloudflare.Env, TUserContext extends Record<string, unknown> = Record<string, unknown>> extends Agent$1<Env & AgentEnv> {
+  protected clientIp?: string;
+  protected forwardedFor?: string;
   /**
    * Override to enable JWT authentication on WebSocket connections.
    * Return the auth config based on the incoming request, or undefined to skip auth.
@@ -105,16 +107,17 @@ declare abstract class Agent<Env extends Cloudflare.Env = Cloudflare.Env, TJwtId
    */
   protected getJwtAuthConfig?(request: Request): JwtAuthConfig<Record<string, unknown>> | undefined;
   /**
-   * The identity associated with the session.
-   * Define getIdentity to return the identity from the request.
+   * The user context for the session.
+   * Define getUserContext to set a user context.
    */
-  protected jwtIdentity: TJwtIdentity;
+  protected get userContext(): TUserContext;
   /**
    * Returns the identity following verification of the JWT token - getJwtAuthConfig is required.
-   * @returns The identity from the request.
-   * @param token - The token from the request.
+   * This method should not have side effects - return a single object from it.
+   * @returns The user context from the request.
+   * @param jwtToken - A valid JWT token following authentication.
    */
-  protected getJwtIdentity?(token: string): Promise<TJwtIdentity>;
+  protected getUserContext?(jwtToken: string): Promise<TUserContext>;
   /**
    * Returns the user ID from the durable object name.
    */
@@ -158,7 +161,7 @@ interface MessageRating {
  * Skill loading, compaction, and LLM calls use `buildLLMParams` from
  * `@economic/agents` inside `onChatMessage`.
  */
-declare abstract class ChatAgent<Env extends Cloudflare.Env = Cloudflare.Env, TJwtIdentity extends Record<string, unknown> = Record<string, unknown>> extends AIChatAgent<Env & ChatAgentEnv> {
+declare abstract class ChatAgent<Env extends Cloudflare.Env = Cloudflare.Env, TUserContext extends Record<string, unknown> = Record<string, unknown>> extends AIChatAgent<Env & ChatAgentEnv> {
   /**
    * The binding of the Durable Object instance for this agent.
    */
@@ -203,22 +206,23 @@ declare abstract class ChatAgent<Env extends Cloudflare.Env = Cloudflare.Env, TJ
    */
   protected getJwtAuthConfig?(request: Request): JwtAuthConfig<Record<string, unknown>> | undefined;
   /**
-   * The identity associated with the session.
-   * Define getIdentity to return the identity from the request.
+   * The user context for the session.
+   * Define getUserContext to set a user context.
    */
-  protected get jwtIdentity(): TJwtIdentity;
+  protected get userContext(): TUserContext;
   /**
    * Returns the identity following verification of the JWT token - getJwtAuthConfig is required.
    * This method should not have side effects - return a single object from it.
-   * @returns The identity from the request.
-   * @param token - The token from the request.
+   * @returns The user context from the request.
+   * @param jwtToken - A valid JWT token following authentication.
    */
-  protected getJwtIdentity?(token: string): Promise<TJwtIdentity>;
+  protected getUserContext?(jwtToken: string): Promise<TUserContext>;
   /**
    * Returns the user ID from the durable object name.
    */
   protected getUserId(): string;
   onConnect(connection: Connection, ctx: ConnectionContext): Promise<void>;
+  protected _pendingUserContextRequest?: Promise<void>;
   /**
    * Writes an audit event to D1 if `AGENT_DB` is bound on the environment,
    * otherwise silently does nothing.

package/dist/index.mjs

@@ -473,11 +473,16 @@ async function verifyJwt(request, config) {
 * extend {@link ChatAgent} instead.
 */
 var Agent = class extends Agent$1 {
+	clientIp;
+	forwardedFor;
 	/**
-	* The identity associated with the session.
-	* Define getIdentity to return the identity from the request.
+	* The user context for the session.
+	* Define getUserContext to set a user context.
 	*/
-	jwtIdentity = {};
+	get userContext() {
+		const { connection } = getCurrentAgent();
+		return (connection?.state)?.userContext ?? {};
+	}
 	/**
 	* Returns the user ID from the durable object name.
 	*/
@@ -511,7 +516,10 @@ var Agent = class extends Agent$1 {
 					return;
 				}
 				const token = extractTokenFromConnectRequest(ctx.request);
-				if (token) this.jwtIdentity = await this.getJwtIdentity?.(token) ?? {};
+				if (token) {
+					const userContext = await this.getUserContext?.(token);
+					if (userContext) connection.setState({ userContext });
+				}
 			}
 		}
 		return super.onConnect(connection, ctx);
@@ -542,7 +550,7 @@ var Agent = class extends Agent$1 {
 		const experimental_context = {
 			...config.experimental_context,
 			...config.options?.body,
-			_jwtIdentity: this.jwtIdentity,
+			_userContext: this.userContext,
 			_logEvent: this.logEvent.bind(this)
 		};
 		const onFinish = async (event) => {
@@ -862,12 +870,12 @@ var ChatAgent = class extends AIChatAgent {
 	*/
 	maxMessagesBeforeCompaction = 15;
 	/**
-	* The identity associated with the session.
-	* Define getIdentity to return the identity from the request.
+	* The user context for the session.
+	* Define getUserContext to set a user context.
 	*/
-	get jwtIdentity() {
+	get userContext() {
 		const { connection } = getCurrentAgent();
-		return (connection?.state)?.jwtIdentity ?? {};
+		return (connection?.state)?.userContext ?? {};
 	}
 	/**
 	* Returns the user ID from the durable object name.
@@ -903,13 +911,13 @@ var ChatAgent = class extends AIChatAgent {
 				}
 			}
 			const token = extractTokenFromConnectRequest(ctx.request);
-			if (token) {
-				const jwtIdentity = await this.getJwtIdentity?.(token);
-				if (jwtIdentity) connection.setState({ jwtIdentity });
-			}
+			if (token) this._pendingUserContextRequest = this.getUserContext?.(token).then((userContext) => {
+				if (userContext) connection.setState({ userContext });
+			});
 		}
 		return super.onConnect(connection, ctx);
 	}
+	_pendingUserContextRequest;
 	/**
 	* Writes an audit event to D1 if `AGENT_DB` is bound on the environment,
 	* otherwise silently does nothing.
@@ -941,7 +949,7 @@ var ChatAgent = class extends AIChatAgent {
 		const experimental_context = {
 			...config.experimental_context,
 			...config.options?.body,
-			_jwtIdentity: this.jwtIdentity,
+			_userContext: this.userContext,
 			_logEvent: this.logEvent.bind(this)
 		};
 		const messages = await convertToModelMessages(this.messages);
@@ -1053,6 +1061,7 @@ var ChatAgentHarness = class extends ChatAgent {
 		return [];
 	}
 	async onChatMessage(onFinish, options) {
+		await this._pendingUserContextRequest;
 		const ctx = options?.body;
 		return streamText(await this.buildLLMParams({
 			options,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@economic/agents",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "description": "A starter for creating a TypeScript package.",
   "license": "MIT",
   "bin": {