@google/adk 2.3.0 → 2.4.0

package/dist/esm/tools/application_integration_tool/application_integration_toolset.js

@@ -20,15 +20,24 @@ import {
   AuthCredentialTypes
 } from "../../auth/auth_credential.js";
 import { experimental } from "../../utils/experimental.js";
-import { isJsonObject } from "../../utils/json_utils.js";
+import {
+  isJsonObject,
+  toJsonObject
+} from "../../utils/json_utils.js";
+import { logger } from "../../utils/logger.js";
 import { BaseToolset } from "../base_toolset.js";
 import { serviceAccountDictToSchemeCredential } from "../openapi_tool/auth/auth_helpers.js";
+import { OpenApiSpecParser } from "../openapi_tool/openapi_spec_parser/openapi_spec_parser.js";
 import { OpenAPIToolset } from "../openapi_tool/openapi_toolset.js";
+import { createRestApiTool } from "../openapi_tool/rest_api_tool.js";
 import { CLOUD_PLATFORM_SCOPE } from "./clients/cloud_request.js";
 import {
   ConnectionsClient
 } from "./clients/connections_client.js";
 import { IntegrationClient } from "./clients/integration_client.js";
+import {
+  IntegrationConnectorTool
+} from "./integration_connector_tool.js";
 const AUTH_SCHEME = {
   type: "http",
   scheme: "bearer",
@@ -36,19 +45,20 @@ const AUTH_SCHEME = {
 };
 let ApplicationIntegrationToolset = class extends BaseToolset {
   /**
-   * @throws Error Unless the options name either an integration and a trigger,
-   *   or a connection with at least one entity operation or action.
+   * @throws Error Unless the options name either an integration, or a
+   *   connection with at least one entity operation or action.
    */
   constructor(options) {
-    var _a, _b;
-    super([]);
-    const hasIntegration = Boolean(options.integration && options.trigger);
+    var _a, _b, _c;
+    super((_a = options.toolFilter) != null ? _a : []);
+    this.openApiToolsets = [];
+    const hasIntegration = Boolean(options.integration);
     const hasConnection = Boolean(
-      options.connection && (Object.keys((_a = options.entityOperations) != null ? _a : {}).length > 0 || ((_b = options.actions) != null ? _b : []).length > 0)
+      options.connection && (Object.keys((_b = options.entityOperations) != null ? _b : {}).length > 0 || ((_c = options.actions) != null ? _c : []).length > 0)
     );
     if (!hasIntegration && !hasConnection) {
       throw new Error(
-        "Either (integration and trigger) or (connection and (entityOperations or actions)) should be provided."
+        "Either integration or (connection and (entityOperations or actions)) should be provided."
       );
     }
     this.options = options;
@@ -59,72 +69,117 @@ let ApplicationIntegrationToolset = class extends BaseToolset {
    * The first call fetches the spec and builds the tools. Concurrent calls
    * share that load. When it fails, the next call tries again.
    */
-  async getTools() {
+  async getTools(context) {
     if (!this.toolsPromise) {
       this.toolsPromise = this.loadTools();
     }
     try {
-      return await this.toolsPromise;
+      const tools = await this.toolsPromise;
+      return tools.filter((tool) => this.isToolSelected(tool, context));
     } catch (e) {
       this.toolsPromise = void 0;
       throw e;
     }
   }
   async close() {
+    for (const openApiToolset of this.openApiToolsets) {
+      await openApiToolset.close();
+    }
   }
   async loadTools() {
-    var _a;
+    var _a, _b;
     const {
       project,
       location,
       integration,
-      trigger,
+      triggers,
       connection,
       entityOperations,
       actions,
-      toolName = "",
+      toolNamePrefix,
       toolInstructions = "",
-      serviceAccountJson
+      serviceAccountJson,
+      authScheme,
+      authCredential: dynamicAuthCredential
     } = this.options;
+    const resolvedToolName = toolNamePrefix != null ? toolNamePrefix : "";
+    this.openApiToolsets = [];
     const integrationClient = new IntegrationClient({
       project,
       location,
       integration,
-      trigger,
+      triggers,
       connection,
       entityOperations,
       actions,
       serviceAccountJson
     });
-    let specDict;
-    if (integration && trigger) {
-      specDict = await integrationClient.getOpenApiSpecForIntegration();
-    } else {
-      const connectionName = connection != null ? connection : "";
-      const { serviceName, host } = await new ConnectionsClient({
-        project,
-        location,
-        connection: connectionName,
-        serviceAccountJson
-      }).getConnectionDetails();
-      const instructions = `${toolInstructions}ALWAYS use serviceName = ${serviceName}, host = ${host} and the connection name = projects/${project}/locations/${location}/connections/${connectionName} when using this tool. DO NOT ask the user for these values as you already have those.`;
-      specDict = await integrationClient.getOpenApiSpecForConnection(
-        toolName,
-        instructions
-      );
-    }
-    const spec = specDict;
     const authCredential = buildAuthCredential(serviceAccountJson);
     const toolsByName = /* @__PURE__ */ new Map();
-    for (const [path, pathItem] of Object.entries((_a = spec.paths) != null ? _a : {})) {
-      const tools = await new OpenAPIToolset({
-        specDict: { ...spec, paths: { [removeFragment(path)]: pathItem } },
-        authCredential,
-        authScheme: AUTH_SCHEME
-      }).getTools();
-      for (const tool of tools) {
-        toolsByName.set(tool.name, tool);
+    if (integration) {
+      const specDict2 = await integrationClient.getOpenApiSpecForIntegration();
+      const spec2 = toOpenApiDocument(specDict2);
+      for (const [path, pathItem] of Object.entries((_a = spec2.paths) != null ? _a : {})) {
+        const openApiToolset = new OpenAPIToolset({
+          specDict: { ...spec2, paths: { [removeFragment(path)]: pathItem } },
+          authCredential,
+          authScheme: AUTH_SCHEME
+        });
+        this.openApiToolsets.push(openApiToolset);
+        const tools = await openApiToolset.getTools();
+        for (const tool of tools) {
+          toolsByName.set(tool.name, tool);
+        }
       }
+      return [...toolsByName.values()];
+    }
+    const connectionName = connection != null ? connection : "";
+    const connectionDetails = await new ConnectionsClient({
+      project,
+      location,
+      connection: connectionName,
+      serviceAccountJson
+    }).getConnectionDetails();
+    if (authScheme && dynamicAuthCredential && !connectionDetails.authOverrideEnabled) {
+      logger.warn(
+        "Authentication schema and credentials are not used because authOverrideEnabled is not enabled in the connection."
+      );
+    }
+    const specDict = await integrationClient.getOpenApiSpecForConnection(
+      resolvedToolName,
+      toolInstructions
+    );
+    const spec = toOpenApiDocument(specDict);
+    addDynamicAuthConfigToConnectionSchemas(spec);
+    const operations = new OpenApiSpecParser().parse(spec);
+    for (const openApiOperation of operations) {
+      const operationObject = toJsonObject(openApiOperation.operation);
+      const operation = toStringValue(operationObject["x-operation"]);
+      const entity = toStringValue(operationObject["x-entity"]);
+      const action = toStringValue(operationObject["x-action"]);
+      const restApiTool = createRestApiTool({
+        ...openApiOperation,
+        endpoint: {
+          ...openApiOperation.endpoint,
+          path: removeFragment(openApiOperation.endpoint.path)
+        }
+      });
+      restApiTool.configureAuthScheme(AUTH_SCHEME);
+      restApiTool.configureAuthCredential(authCredential);
+      const tool = new IntegrationConnectorTool({
+        name: restApiTool.name,
+        description: restApiTool.description,
+        connectionName: (_b = connectionDetails.name) != null ? _b : "",
+        connectionHost: connectionDetails.host,
+        connectionServiceName: connectionDetails.serviceName,
+        entity,
+        action,
+        operation,
+        restApiTool,
+        authScheme: connectionDetails.authOverrideEnabled ? authScheme : void 0,
+        authCredential: connectionDetails.authOverrideEnabled ? dynamicAuthCredential : void 0
+      });
+      toolsByName.set(tool.name, tool);
     }
     return [...toolsByName.values()];
   }
@@ -133,6 +188,32 @@ __name(ApplicationIntegrationToolset, "ApplicationIntegrationToolset");
 ApplicationIntegrationToolset = __decorateClass([
   experimental
 ], ApplicationIntegrationToolset);
+function addDynamicAuthConfigToConnectionSchemas(spec) {
+  var _a;
+  const schemas = (_a = spec.components) == null ? void 0 : _a.schemas;
+  if (!schemas) {
+    return;
+  }
+  for (const [schemaName, schema] of Object.entries(schemas)) {
+    if (schemaName.endsWith("_Request") && isJsonObject(schema) && isJsonObject(schema.properties) && !("query" in schema.properties) && !("dynamicAuthConfig" in schema.properties)) {
+      schema.properties = {
+        ...schema.properties,
+        dynamicAuthConfig: {
+          $ref: "#/components/schemas/dynamicAuthConfig"
+        }
+      };
+    }
+  }
+}
+__name(addDynamicAuthConfigToConnectionSchemas, "addDynamicAuthConfigToConnectionSchemas");
+function toOpenApiDocument(specDict) {
+  return specDict;
+}
+__name(toOpenApiDocument, "toOpenApiDocument");
+function toStringValue(value) {
+  return typeof value === "string" ? value : "";
+}
+__name(toStringValue, "toStringValue");
 function buildAuthCredential(serviceAccountJson) {
   if (!serviceAccountJson) {
     return {
@@ -159,5 +240,6 @@ function removeFragment(path) {
 }
 __name(removeFragment, "removeFragment");
 export {
-  ApplicationIntegrationToolset
+  ApplicationIntegrationToolset,
+  IntegrationConnectorTool
 };

package/dist/esm/tools/application_integration_tool/clients/connections_client.js

@@ -173,55 +173,48 @@ function connectorPayload(jsonSchema) {
 }
 __name(connectorPayload, "connectorPayload");
 function postOperation(options) {
-  const { summary, description, operationId, requestSchemaRef, responseSchema } = options;
-  return {
-    post: {
-      summary,
-      description,
-      operationId,
-      requestBody: {
+  const {
+    summary,
+    description,
+    operationId,
+    xOperation,
+    xEntity,
+    xAction,
+    requestSchemaRef,
+    responseSchema
+  } = options;
+  const post = {
+    summary,
+    description,
+    operationId,
+    "x-operation": xOperation,
+    requestBody: {
+      content: {
+        "application/json": {
+          schema: { $ref: requestSchemaRef }
+        }
+      }
+    },
+    responses: {
+      "200": {
+        description: "Success response",
         content: {
           "application/json": {
-            schema: { $ref: requestSchemaRef }
-          }
-        }
-      },
-      responses: {
-        "200": {
-          description: "Success response",
-          content: {
-            "application/json": {
-              schema: responseSchema
-            }
+            schema: responseSchema
           }
         }
       }
     }
   };
+  if (xEntity !== void 0) {
+    post["x-entity"] = xEntity;
+  }
+  if (xAction !== void 0) {
+    post["x-action"] = xAction;
+  }
+  return { post };
 }
 __name(postOperation, "postOperation");
-function entityIdRequest() {
-  return {
-    type: "object",
-    required: [
-      "entityId",
-      "operation",
-      "connectionName",
-      "serviceName",
-      "host",
-      "entity"
-    ],
-    properties: {
-      entityId: schemaRef("entityId"),
-      operation: schemaRef("operation"),
-      connectionName: schemaRef("connectionName"),
-      serviceName: schemaRef("serviceName"),
-      host: schemaRef("host"),
-      entity: schemaRef("entity")
-    }
-  };
-}
-__name(entityIdRequest, "entityIdRequest");
 function getActionOperation(options) {
   const {
     action,
@@ -230,7 +223,7 @@ function getActionOperation(options) {
     toolName = "",
     toolInstructions = ""
   } = options;
-  let description = `Use this tool with action = "${action}" and operation = "${operation}" only. Don't ask these values from user.`;
+  let description = `Use this tool to execute ${action}`;
   if (operation === "EXECUTE_QUERY") {
     description += " Use pageSize = 50 and timeout = 120 until user specifies a different value otherwise. If user provides a query in natural language, convert it to SQL query and then execute it using the tool.";
   }
@@ -238,6 +231,8 @@ function getActionOperation(options) {
     summary: actionDisplayName,
     description: `${description} ${toolInstructions}`,
     operationId: `${toolName}_${actionDisplayName}`,
+    xOperation: operation,
+    xAction: action,
     requestSchemaRef: `#/components/schemas/${actionDisplayName}_Request`,
     responseSchema: schemaRef(`${actionDisplayName}_Response`)
   });
@@ -252,8 +247,10 @@ function listOperation(options) {
   } = options;
   return postOperation({
     summary: `List ${entity}`,
-    description: `Returns all entities of type ${entity}. Use this tool with entity = "${entity}" and operation = "LIST_ENTITIES" only. Don't ask these values from user. Always use "" as filter clause and "" as page token and 50 as page size until user specifies a different value otherwise. Use single quotes for strings in filter clause. ${toolInstructions}`,
+    description: `Returns the list of ${entity} data. If the page token was available in the response, let users know there are more records available. Ask if the user wants to fetch the next page of results. When passing filter use the following format: \`field_name1='value1' AND field_name2='value2'\`. ${toolInstructions}`,
     operationId: `${toolName}_list_${entity}`,
+    xOperation: "LIST_ENTITIES",
+    xEntity: entity,
     requestSchemaRef: `#/components/schemas/list_${entity}_Request`,
     responseSchema: {
       description: `Returns a list of ${entity} of json schema: ${schemaAsString}`,
@@ -271,8 +268,10 @@ function getOperation(options) {
   } = options;
   return postOperation({
     summary: `Get ${entity}`,
-    description: `Returns the details of the ${entity}. Use this tool with entity = "${entity}" and operation = "GET_ENTITY" only. Don't ask these values from user.  ${toolInstructions}`,
+    description: `Returns the details of the ${entity}. ${toolInstructions}`,
     operationId: `${toolName}_get_${entity}`,
+    xOperation: "GET_ENTITY",
+    xEntity: entity,
     requestSchemaRef: `#/components/schemas/get_${entity}_Request`,
     responseSchema: {
       description: `Returns ${entity} of json schema: ${schemaAsString}`,
@@ -284,9 +283,11 @@ __name(getOperation, "getOperation");
 function createOperation(options) {
   const { entity, toolName = "", toolInstructions = "" } = options;
   return postOperation({
-    summary: `Create ${entity}`,
-    description: `Creates a new entity of type ${entity}. Use this tool with entity = "${entity}" and operation = "CREATE_ENTITY" only. Don't ask these values from user. Follow the schema of the entity provided in the instructions to create ${entity}.  ${toolInstructions}`,
+    summary: `Creates a new ${entity}`,
+    description: `Creates a new ${entity}. ${toolInstructions}`,
     operationId: `${toolName}_create_${entity}`,
+    xOperation: "CREATE_ENTITY",
+    xEntity: entity,
     requestSchemaRef: `#/components/schemas/create_${entity}_Request`,
     responseSchema: schemaRef("execute-connector_Response")
   });
@@ -295,9 +296,11 @@ __name(createOperation, "createOperation");
 function updateOperation(options) {
   const { entity, toolName = "", toolInstructions = "" } = options;
   return postOperation({
-    summary: `Update ${entity}`,
-    description: `Updates an entity of type ${entity}. Use this tool with entity = "${entity}" and operation = "UPDATE_ENTITY" only. Don't ask these values from user. Use entityId to uniquely identify the entity to update. Follow the schema of the entity provided in the instructions to update ${entity}.  ${toolInstructions}`,
+    summary: `Updates the ${entity}`,
+    description: `Updates the ${entity}. ${toolInstructions}`,
     operationId: `${toolName}_update_${entity}`,
+    xOperation: "UPDATE_ENTITY",
+    xEntity: entity,
     requestSchemaRef: `#/components/schemas/update_${entity}_Request`,
     responseSchema: schemaRef("execute-connector_Response")
   });
@@ -306,15 +309,28 @@ __name(updateOperation, "updateOperation");
 function deleteOperation(options) {
   const { entity, toolName = "", toolInstructions = "" } = options;
   return postOperation({
-    summary: `Delete ${entity}`,
-    description: `Deletes an entity of type ${entity}. Use this tool with entity = "${entity}" and operation = "DELETE_ENTITY" only. Don't ask these values from user.  ${toolInstructions}`,
+    summary: `Delete the ${entity}`,
+    description: `Deletes the ${entity}. ${toolInstructions}`,
     operationId: `${toolName}_delete_${entity}`,
+    xOperation: "DELETE_ENTITY",
+    xEntity: entity,
     requestSchemaRef: `#/components/schemas/delete_${entity}_Request`,
     responseSchema: schemaRef("execute-connector_Response")
   });
 }
 __name(deleteOperation, "deleteOperation");
-function createOperationRequest(entity) {
+function createOperationRequest(entity, options) {
+  const properties = {
+    connectorInputPayload: schemaRef(`connectorInputPayload_${entity}`),
+    operation: schemaRef("operation"),
+    connectionName: schemaRef("connectionName"),
+    serviceName: schemaRef("serviceName"),
+    host: schemaRef("host"),
+    entity: schemaRef("entity")
+  };
+  if (options == null ? void 0 : options.includeDynamicAuthConfig) {
+    properties["dynamicAuthConfig"] = schemaRef("dynamicAuthConfig");
+  }
   return {
     type: "object",
     required: [
@@ -325,18 +341,24 @@ function createOperationRequest(entity) {
       "host",
       "entity"
     ],
-    properties: {
-      connectorInputPayload: schemaRef(`connectorInputPayload_${entity}`),
-      operation: schemaRef("operation"),
-      connectionName: schemaRef("connectionName"),
-      serviceName: schemaRef("serviceName"),
-      host: schemaRef("host"),
-      entity: schemaRef("entity")
-    }
+    properties
   };
 }
 __name(createOperationRequest, "createOperationRequest");
-function updateOperationRequest(entity) {
+function updateOperationRequest(entity, options) {
+  const properties = {
+    connectorInputPayload: schemaRef(`connectorInputPayload_${entity}`),
+    entityId: schemaRef("entityId"),
+    operation: schemaRef("operation"),
+    connectionName: schemaRef("connectionName"),
+    serviceName: schemaRef("serviceName"),
+    host: schemaRef("host"),
+    entity: schemaRef("entity"),
+    filterClause: schemaRef("filterClause")
+  };
+  if (options == null ? void 0 : options.includeDynamicAuthConfig) {
+    properties["dynamicAuthConfig"] = schemaRef("dynamicAuthConfig");
+  }
   return {
     type: "object",
     required: [
@@ -348,44 +370,96 @@ function updateOperationRequest(entity) {
       "host",
       "entity"
     ],
-    properties: {
-      connectorInputPayload: schemaRef(`connectorInputPayload_${entity}`),
-      entityId: schemaRef("entityId"),
-      operation: schemaRef("operation"),
-      connectionName: schemaRef("connectionName"),
-      serviceName: schemaRef("serviceName"),
-      host: schemaRef("host"),
-      entity: schemaRef("entity")
-    }
+    properties
   };
 }
 __name(updateOperationRequest, "updateOperationRequest");
-function getOperationRequest() {
-  return entityIdRequest();
+function getOperationRequest(options) {
+  const properties = {
+    entityId: schemaRef("entityId"),
+    operation: schemaRef("operation"),
+    connectionName: schemaRef("connectionName"),
+    serviceName: schemaRef("serviceName"),
+    host: schemaRef("host"),
+    entity: schemaRef("entity")
+  };
+  if (options == null ? void 0 : options.includeDynamicAuthConfig) {
+    properties["dynamicAuthConfig"] = schemaRef("dynamicAuthConfig");
+  }
+  return {
+    type: "object",
+    required: [
+      "entityId",
+      "operation",
+      "connectionName",
+      "serviceName",
+      "host",
+      "entity"
+    ],
+    properties
+  };
 }
 __name(getOperationRequest, "getOperationRequest");
-function deleteOperationRequest() {
-  return entityIdRequest();
+function deleteOperationRequest(options) {
+  const properties = {
+    entityId: schemaRef("entityId"),
+    operation: schemaRef("operation"),
+    connectionName: schemaRef("connectionName"),
+    serviceName: schemaRef("serviceName"),
+    host: schemaRef("host"),
+    entity: schemaRef("entity"),
+    filterClause: schemaRef("filterClause")
+  };
+  if (options == null ? void 0 : options.includeDynamicAuthConfig) {
+    properties["dynamicAuthConfig"] = schemaRef("dynamicAuthConfig");
+  }
+  return {
+    type: "object",
+    required: [
+      "entityId",
+      "operation",
+      "connectionName",
+      "serviceName",
+      "host",
+      "entity"
+    ],
+    properties
+  };
 }
 __name(deleteOperationRequest, "deleteOperationRequest");
-function listOperationRequest() {
+function listOperationRequest(options) {
+  const properties = {
+    filterClause: schemaRef("filterClause"),
+    pageSize: schemaRef("pageSize"),
+    pageToken: schemaRef("pageToken"),
+    operation: schemaRef("operation"),
+    connectionName: schemaRef("connectionName"),
+    serviceName: schemaRef("serviceName"),
+    host: schemaRef("host"),
+    entity: schemaRef("entity")
+  };
+  if (options == null ? void 0 : options.includeDynamicAuthConfig) {
+    properties["dynamicAuthConfig"] = schemaRef("dynamicAuthConfig");
+  }
   return {
     type: "object",
     required: ["operation", "connectionName", "serviceName", "host", "entity"],
-    properties: {
-      filterClause: schemaRef("filterClause"),
-      pageSize: schemaRef("pageSize"),
-      pageToken: schemaRef("pageToken"),
-      operation: schemaRef("operation"),
-      connectionName: schemaRef("connectionName"),
-      serviceName: schemaRef("serviceName"),
-      host: schemaRef("host"),
-      entity: schemaRef("entity")
-    }
+    properties
   };
 }
 __name(listOperationRequest, "listOperationRequest");
-function actionRequest(action) {
+function actionRequest(action, options) {
+  const properties = {
+    operation: schemaRef("operation"),
+    connectionName: schemaRef("connectionName"),
+    serviceName: schemaRef("serviceName"),
+    host: schemaRef("host"),
+    action: schemaRef("action"),
+    connectorInputPayload: schemaRef(`connectorInputPayload_${action}`)
+  };
+  if (options == null ? void 0 : options.includeDynamicAuthConfig) {
+    properties["dynamicAuthConfig"] = schemaRef("dynamicAuthConfig");
+  }
   return {
     type: "object",
     required: [
@@ -396,14 +470,7 @@ function actionRequest(action) {
       "action",
       "connectorInputPayload"
     ],
-    properties: {
-      operation: schemaRef("operation"),
-      connectionName: schemaRef("connectionName"),
-      serviceName: schemaRef("serviceName"),
-      host: schemaRef("host"),
-      action: schemaRef("action"),
-      connectorInputPayload: schemaRef(`connectorInputPayload_${action}`)
-    }
+    properties
   };
 }
 __name(actionRequest, "actionRequest");
@@ -450,16 +517,17 @@ let ConnectionsClient = class {
     this.tokenSource = new CloudPlatformTokenSource(options.serviceAccountJson);
   }
   /**
-   * Reads the service name and host of the connection, and whether it allows
-   * an authentication override.
+   * Reads the resource name, service name and host of the connection, and
+   * whether it allows an authentication override.
    */
   async getConnectionDetails() {
     const url = `${CONNECTOR_URL}/v1/projects/${this.project}/locations/${this.location}/connections/${this.connection}?view=BASIC`;
     const connectionData = toJsonObject(await this.executeApiCall(url));
+    const name = toStringValue(connectionData["name"]);
     const host = toStringValue(connectionData["host"]);
     const serviceName = host ? toStringValue(connectionData["tlsServiceDirectory"]) : toStringValue(connectionData["serviceDirectory"]);
     const authOverrideEnabled = connectionData["authOverrideEnabled"] === true;
-    return { serviceName, host, authOverrideEnabled };
+    return { name, serviceName, host, authOverrideEnabled };
   }
   /**
    * Reads the JSON schema of an entity and the operations it supports.