fix param name from definition to description

Author: svozza

packages/event-handler/src/bedrock-agent-function/BedrockAgentFunctionResolver.ts

@@ -4,12 +4,12 @@ import type {
   BedrockAgentFunctionEvent,
   BedrockAgentFunctionResponse,
   Configuration,
-  GenericLogger,
   ResolverOptions,
   ResponseOptions,
   Tool,
   ToolFunction,
-} from '../types/index.js';
+} from '../types/bedrock-agent-function.js';
+import type { GenericLogger } from '../types/common.js';
 import { isPrimitive } from './utils.js';
 
 export class BedrockAgentFunctionResolver {
@@ -43,7 +43,7 @@ export class BedrockAgentFunctionResolver {
    *   return `Hello, ${name}!`;
    * }, {
    *   name: 'greeting',
-   *   definition: 'Greets a person by name',
+   *   description: 'Greets a person by name',
    * });
    *
    * export const handler = async (event, context) =>
@@ -59,7 +59,7 @@ export class BedrockAgentFunctionResolver {
    * const app = new BedrockAgentFunctionResolver();
    *
    * class Lambda {
-   *   @app.tool({ name: 'greeting', definition: 'Greets a person by name' })
+   *   @app.tool({ name: 'greeting', description: 'Greets a person by name' })
    *   async greeting(params) {
    *     const { name } = params;
    *     return `Hello, ${name}!`;
@@ -77,15 +77,16 @@ export class BedrockAgentFunctionResolver {
    * @param fn - The tool function
    * @param config - The configuration object for the tool
    */
-  public tool(fn: ToolFunction, config: Configuration): void;
+  public tool(fn: ToolFunction, config: Configuration): undefined;
   public tool(config: Configuration): MethodDecorator;
   public tool(
     fnOrConfig: ToolFunction | Configuration,
     config?: Configuration
-  ): MethodDecorator | void {
+  ): MethodDecorator | undefined {
     // When used as a method (not a decorator)
     if (typeof fnOrConfig === 'function') {
-      return this.#registerTool(fnOrConfig, config as Configuration);
+      this.#registerTool(fnOrConfig, config as Configuration);
+      return;
     }
 
     // When used as a decorator

packages/event-handler/src/types/bedrock-agent-function.ts

@@ -3,7 +3,7 @@ import type { GenericLogger } from '../types/common.js';
 
 type Configuration = {
   name: string;
-  definition: string;
+  description: string;
 };
 
 type Parameter = {
@@ -12,9 +12,9 @@ type Parameter = {
   value: string;
 };
 
-type ParameterPrimitives = string | number | boolean
+type ParameterPrimitives = string | number | boolean;
 
-type ParameterValue = ParameterPrimitives | Array<ParameterValue>
+type ParameterValue = ParameterPrimitives | Array<ParameterValue>;
 
 type Tool<TParams = Record<string, ParameterValue>> = {
   // biome-ignore lint/suspicious/noConfusingVoidType: we need to support async functions that don't have an explicit return value

packages/event-handler/tests/unit/bedrock-agent/BedrockAgentFunctionResolver.test.ts

@@ -34,7 +34,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
 
     app.tool(async (_params) => {}, {
       name: 'noop',
-      definition: 'Does nothing',
+      description: 'Does nothing',
     });
 
     // Assess
@@ -48,7 +48,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
 
     app.tool(async (_params) => {}, {
       name: 'noop',
-      definition: 'Does nothing',
+      description: 'Does nothing',
     });
 
     // Assess
@@ -68,7 +68,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
 
     app.tool(async (_params) => {}, {
       name: 'noop',
-      definition: 'Does nothing',
+      description: 'Does nothing',
     });
 
     // Act
@@ -88,7 +88,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
     for (const num of [1, 2, 3, 4, 5]) {
       app.tool(async (_params) => {}, {
         name: `noop${num}`,
-        definition: 'Does nothing',
+        description: 'Does nothing',
       });
     }
 
@@ -98,7 +98,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       },
       {
         name: 'mult',
-        definition: 'Multiplies two numbers',
+        description: 'Multiplies two numbers',
       }
     );
 
@@ -151,7 +151,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       },
       {
         name: 'math',
-        definition: 'Adds two numbers',
+        description: 'Adds two numbers',
       }
     );
 
@@ -167,7 +167,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       },
       {
         name: 'math',
-        definition: 'Multiplies two numbers',
+        description: 'Multiplies two numbers',
       }
     );
 
@@ -183,12 +183,12 @@ describe('Class: BedrockAgentFunctionResolver', () => {
     const app = new BedrockAgentFunctionResolver();
 
     class Lambda {
-      @app.tool({ name: 'hello', definition: 'Says hello' })
+      @app.tool({ name: 'hello', description: 'Says hello' })
       async helloWorld() {
         return 'Hello, world!';
       }
 
-      @app.tool({ name: 'add', definition: 'Adds two numbers' })
+      @app.tool({ name: 'add', description: 'Adds two numbers' })
       async add(params: { a: string; b: string }) {
         const { a, b } = params;
         return Number.parseInt(a) + Number.parseInt(b);
@@ -229,23 +229,23 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       toolFunction: async () => 'Hello, world',
       toolParams: {
         name: 'string',
-        definition: 'Returns string',
+        description: 'Returns string',
       },
       expected: 'Hello, world',
     },
     {
       toolFunction: async () => 42,
       toolParams: {
         name: 'number',
-        definition: 'Returns number',
+        description: 'Returns number',
       },
       expected: '42',
     },
     {
       toolFunction: async () => true,
       toolParams: {
         name: 'boolean',
-        definition: 'Returns boolean',
+        description: 'Returns boolean',
       },
       expected: 'true',
     },
@@ -261,7 +261,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       }),
       toolParams: {
         name: 'object',
-        definition: 'Returns an object',
+        description: 'Returns an object',
       },
       expected:
         '{"name":"John Doe","age":30,"isActive":true,"address":{"street":"123 Main St","city":"Anytown"}}',
@@ -270,7 +270,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       toolFunction: async () => [1, 'two', false, null],
       toolParams: {
         name: 'array',
-        definition: 'Returns an array',
+        description: 'Returns an array',
       },
       expected: '[1,"two",false,null]',
     },
@@ -298,14 +298,14 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       toolFunction: async () => null,
       toolParams: {
         name: 'null',
-        definition: 'Returns null',
+        description: 'Returns null',
       },
     },
     {
       toolFunction: async () => void 0,
       toolParams: {
         name: 'undefined',
-        definition: 'Returns undefined',
+        description: 'Returns undefined',
       },
     },
   ])(
@@ -337,7 +337,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       },
       {
         name: 'error-tool',
-        definition: 'Throws an error',
+        description: 'Throws an error',
       }
     );
 
@@ -365,7 +365,7 @@ describe('Class: BedrockAgentFunctionResolver', () => {
       },
       {
         name: 'greeting',
-        definition: 'Greets a person by name',
+        description: 'Greets a person by name',
       }
     );