@google/adk 2.2.1 → 2.4.0

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

@@ -0,0 +1,671 @@
+/**
+  * @license
+  * Copyright 2026 Google LLC
+  * SPDX-License-Identifier: Apache-2.0
+  */
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+var connections_client_exports = {};
+__export(connections_client_exports, {
+  CONNECTOR_BASE_SPEC: () => CONNECTOR_BASE_SPEC,
+  ConnectionsClient: () => ConnectionsClient,
+  actionRequest: () => actionRequest,
+  actionResponse: () => actionResponse,
+  connectorPayload: () => connectorPayload,
+  createOperation: () => createOperation,
+  createOperationRequest: () => createOperationRequest,
+  deleteOperation: () => deleteOperation,
+  deleteOperationRequest: () => deleteOperationRequest,
+  executeCustomQueryRequest: () => executeCustomQueryRequest,
+  getActionOperation: () => getActionOperation,
+  getOperation: () => getOperation,
+  getOperationRequest: () => getOperationRequest,
+  listOperation: () => listOperation,
+  listOperationRequest: () => listOperationRequest,
+  updateOperation: () => updateOperation,
+  updateOperationRequest: () => updateOperationRequest
+});
+module.exports = __toCommonJS(connections_client_exports);
+var import_experimental = require("../../../utils/experimental.js");
+var import_json_utils = require("../../../utils/json_utils.js");
+var import_cloud_request = require("./cloud_request.js");
+/**
+ * @license
+ * Copyright 2026 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const CONNECTOR_URL = "https://connectors.googleapis.com";
+const OPERATION_POLL_INTERVAL_MS = 1e3;
+function toStringValue(value) {
+  return typeof value === "string" ? value : "";
+}
+__name(toStringValue, "toStringValue");
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+__name(sleep, "sleep");
+function schemaRef(name) {
+  return { $ref: `#/components/schemas/${name}` };
+}
+__name(schemaRef, "schemaRef");
+const CONNECTOR_BASE_SPEC = {
+  openapi: "3.0.1",
+  info: {
+    title: "ExecuteConnection",
+    description: "This tool can execute a query on connection",
+    version: "4"
+  },
+  servers: [{ url: "https://integrations.googleapis.com" }],
+  security: [{ google_auth: ["https://www.googleapis.com/auth/cloud-platform"] }],
+  paths: {},
+  components: {
+    schemas: {
+      operation: {
+        type: "string",
+        default: "LIST_ENTITIES",
+        description: "Operation to execute. Possible values are LIST_ENTITIES, GET_ENTITY, CREATE_ENTITY, UPDATE_ENTITY, DELETE_ENTITY in case of entities. EXECUTE_ACTION in case of actions. and EXECUTE_QUERY in case of custom queries."
+      },
+      entityId: {
+        type: "string",
+        description: "Name of the entity"
+      },
+      connectorInputPayload: { type: "object" },
+      filterClause: {
+        type: "string",
+        default: "",
+        description: "WHERE clause in SQL query"
+      },
+      pageSize: {
+        type: "integer",
+        default: 50,
+        description: "Number of entities to return in the response"
+      },
+      pageToken: {
+        type: "string",
+        default: "",
+        description: "Page token to return the next page of entities"
+      },
+      connectionName: {
+        type: "string",
+        default: "",
+        description: "Connection resource name to run the query for"
+      },
+      serviceName: {
+        type: "string",
+        default: "",
+        description: "Service directory for the connection"
+      },
+      host: {
+        type: "string",
+        default: "",
+        description: "Host name in case of tls service directory"
+      },
+      entity: {
+        type: "string",
+        default: "Issues",
+        description: "Entity to run the query for"
+      },
+      action: {
+        type: "string",
+        default: "ExecuteCustomQuery",
+        description: "Action to run the query for"
+      },
+      query: {
+        type: "string",
+        default: "",
+        description: "Custom Query to execute on the connection"
+      },
+      dynamicAuthConfig: {
+        type: "object",
+        default: {},
+        description: "Dynamic auth config for the connection"
+      },
+      timeout: {
+        type: "integer",
+        default: 120,
+        description: "Timeout in seconds for execution of custom query"
+      },
+      connectorOutputPayload: { type: "object" },
+      nextPageToken: { type: "string" },
+      "execute-connector_Response": {
+        required: ["connectorOutputPayload"],
+        type: "object",
+        properties: {
+          connectorOutputPayload: schemaRef("connectorOutputPayload"),
+          nextPageToken: schemaRef("nextPageToken")
+        }
+      }
+    },
+    securitySchemes: {
+      google_auth: {
+        type: "oauth2",
+        flows: {
+          implicit: {
+            authorizationUrl: "https://accounts.google.com/o/oauth2/auth",
+            scopes: {
+              "https://www.googleapis.com/auth/cloud-platform": "Auth for google cloud services"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+function connectorPayload(jsonSchema) {
+  const openApiSchema = {};
+  if ("description" in jsonSchema) {
+    openApiSchema["description"] = jsonSchema["description"];
+  }
+  if ("type" in jsonSchema) {
+    const type = jsonSchema["type"];
+    if (Array.isArray(type)) {
+      if (type.includes("null")) {
+        openApiSchema["nullable"] = true;
+        const otherTypes = type.filter((t) => t !== "null");
+        if (otherTypes.length > 0) {
+          openApiSchema["type"] = otherTypes[0];
+        }
+      } else if (type.length > 0) {
+        openApiSchema["type"] = type[0];
+      }
+    } else {
+      openApiSchema["type"] = type;
+    }
+  }
+  if (openApiSchema["type"] === "object" && "properties" in jsonSchema) {
+    const properties = {};
+    for (const [name, schema] of Object.entries(
+      (0, import_json_utils.toJsonObject)(jsonSchema["properties"])
+    )) {
+      properties[name] = connectorPayload((0, import_json_utils.toJsonObject)(schema));
+    }
+    openApiSchema["properties"] = properties;
+  } else if (openApiSchema["type"] === "array" && "items" in jsonSchema) {
+    const items = jsonSchema["items"];
+    openApiSchema["items"] = Array.isArray(items) ? items.map((item) => connectorPayload((0, import_json_utils.toJsonObject)(item))) : connectorPayload((0, import_json_utils.toJsonObject)(items));
+  }
+  return openApiSchema;
+}
+__name(connectorPayload, "connectorPayload");
+function postOperation(options) {
+  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: responseSchema
+          }
+        }
+      }
+    }
+  };
+  if (xEntity !== void 0) {
+    post["x-entity"] = xEntity;
+  }
+  if (xAction !== void 0) {
+    post["x-action"] = xAction;
+  }
+  return { post };
+}
+__name(postOperation, "postOperation");
+function getActionOperation(options) {
+  const {
+    action,
+    operation,
+    actionDisplayName,
+    toolName = "",
+    toolInstructions = ""
+  } = options;
+  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.";
+  }
+  return postOperation({
+    summary: actionDisplayName,
+    description: `${description} ${toolInstructions}`,
+    operationId: `${toolName}_${actionDisplayName}`,
+    xOperation: operation,
+    xAction: action,
+    requestSchemaRef: `#/components/schemas/${actionDisplayName}_Request`,
+    responseSchema: schemaRef(`${actionDisplayName}_Response`)
+  });
+}
+__name(getActionOperation, "getActionOperation");
+function listOperation(options) {
+  const {
+    entity,
+    schemaAsString = "",
+    toolName = "",
+    toolInstructions = ""
+  } = options;
+  return postOperation({
+    summary: `List ${entity}`,
+    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}`,
+      $ref: "#/components/schemas/execute-connector_Response"
+    }
+  });
+}
+__name(listOperation, "listOperation");
+function getOperation(options) {
+  const {
+    entity,
+    schemaAsString = "",
+    toolName = "",
+    toolInstructions = ""
+  } = options;
+  return postOperation({
+    summary: `Get ${entity}`,
+    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}`,
+      $ref: "#/components/schemas/execute-connector_Response"
+    }
+  });
+}
+__name(getOperation, "getOperation");
+function createOperation(options) {
+  const { entity, toolName = "", toolInstructions = "" } = options;
+  return postOperation({
+    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")
+  });
+}
+__name(createOperation, "createOperation");
+function updateOperation(options) {
+  const { entity, toolName = "", toolInstructions = "" } = options;
+  return postOperation({
+    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")
+  });
+}
+__name(updateOperation, "updateOperation");
+function deleteOperation(options) {
+  const { entity, toolName = "", toolInstructions = "" } = options;
+  return postOperation({
+    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, 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: [
+      "connectorInputPayload",
+      "operation",
+      "connectionName",
+      "serviceName",
+      "host",
+      "entity"
+    ],
+    properties
+  };
+}
+__name(createOperationRequest, "createOperationRequest");
+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: [
+      "connectorInputPayload",
+      "entityId",
+      "operation",
+      "connectionName",
+      "serviceName",
+      "host",
+      "entity"
+    ],
+    properties
+  };
+}
+__name(updateOperationRequest, "updateOperationRequest");
+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(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(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
+  };
+}
+__name(listOperationRequest, "listOperationRequest");
+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: [
+      "operation",
+      "connectionName",
+      "serviceName",
+      "host",
+      "action",
+      "connectorInputPayload"
+    ],
+    properties
+  };
+}
+__name(actionRequest, "actionRequest");
+function actionResponse(action) {
+  return {
+    type: "object",
+    properties: {
+      connectorOutputPayload: schemaRef(`connectorOutputPayload_${action}`)
+    }
+  };
+}
+__name(actionResponse, "actionResponse");
+function executeCustomQueryRequest() {
+  return {
+    type: "object",
+    required: [
+      "operation",
+      "connectionName",
+      "serviceName",
+      "host",
+      "action",
+      "query",
+      "timeout",
+      "pageSize"
+    ],
+    properties: {
+      operation: schemaRef("operation"),
+      connectionName: schemaRef("connectionName"),
+      serviceName: schemaRef("serviceName"),
+      host: schemaRef("host"),
+      action: schemaRef("action"),
+      query: schemaRef("query"),
+      timeout: schemaRef("timeout"),
+      pageSize: schemaRef("pageSize")
+    }
+  };
+}
+__name(executeCustomQueryRequest, "executeCustomQueryRequest");
+let ConnectionsClient = class {
+  constructor(options) {
+    this.project = options.project;
+    this.location = options.location;
+    this.connection = options.connection;
+    this.tokenSource = new import_cloud_request.CloudPlatformTokenSource(options.serviceAccountJson);
+  }
+  /**
+   * 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 = (0, import_json_utils.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 { name, serviceName, host, authOverrideEnabled };
+  }
+  /**
+   * Reads the JSON schema of an entity and the operations it supports.
+   *
+   * @param entity The entity name.
+   * @throws Error When the API starts no operation for the entity.
+   */
+  async getEntitySchemaAndOperations(entity) {
+    const url = `${CONNECTOR_URL}/v1/projects/${this.project}/locations/${this.location}/connections/${this.connection}/connectionSchemaMetadata:getEntityType?entityId=${entity}`;
+    const operationId = toStringValue(
+      (0, import_json_utils.toJsonObject)(await this.executeApiCall(url))["name"]
+    );
+    if (!operationId) {
+      throw new Error(
+        `Failed to get entity schema and operations for entity: ${entity}`
+      );
+    }
+    const response = (0, import_json_utils.toJsonObject)(
+      (await this.pollOperation(operationId))["response"]
+    );
+    const operations = response["operations"];
+    return {
+      schema: (0, import_json_utils.toJsonObject)(response["jsonSchema"]),
+      operations: Array.isArray(operations) ? operations.filter((op) => typeof op === "string") : []
+    };
+  }
+  /**
+   * Reads the input and output JSON schemas of an action.
+   *
+   * @param action The action name.
+   * @throws Error When the API starts no operation for the action.
+   */
+  async getActionSchema(action) {
+    const url = `${CONNECTOR_URL}/v1/projects/${this.project}/locations/${this.location}/connections/${this.connection}/connectionSchemaMetadata:getAction?actionId=${action}`;
+    const operationId = toStringValue(
+      (0, import_json_utils.toJsonObject)(await this.executeApiCall(url))["name"]
+    );
+    if (!operationId) {
+      throw new Error(`Failed to get action schema for action: ${action}`);
+    }
+    const response = (0, import_json_utils.toJsonObject)(
+      (await this.pollOperation(operationId))["response"]
+    );
+    return {
+      inputSchema: (0, import_json_utils.toJsonObject)(response["inputJsonSchema"]),
+      outputSchema: (0, import_json_utils.toJsonObject)(response["outputJsonSchema"]),
+      description: toStringValue(response["description"]),
+      displayName: toStringValue(response["displayName"])
+    };
+  }
+  /**
+   * Converts the JSON schema of an entity or an action payload into the
+   * OpenAPI schema the connector spec carries.
+   */
+  connectorPayload(jsonSchema) {
+    return connectorPayload(jsonSchema);
+  }
+  executeApiCall(url) {
+    return (0, import_cloud_request.sendCloudRequest)({
+      url,
+      method: "GET",
+      tokenSource: this.tokenSource,
+      invalidRequestMessage: `Invalid request. Please check the provided values of project(${this.project}), location(${this.location}), connection(${this.connection}).`
+    });
+  }
+  /** Polls a long-running operation until it reports `done`. */
+  async pollOperation(operationId) {
+    const url = `${CONNECTOR_URL}/v1/${operationId}`;
+    let operation = (0, import_json_utils.toJsonObject)(await this.executeApiCall(url));
+    while (operation["done"] !== true) {
+      await sleep(OPERATION_POLL_INTERVAL_MS);
+      operation = (0, import_json_utils.toJsonObject)(await this.executeApiCall(url));
+    }
+    return operation;
+  }
+};
+__name(ConnectionsClient, "ConnectionsClient");
+ConnectionsClient = __decorateClass([
+  import_experimental.experimental
+], ConnectionsClient);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CONNECTOR_BASE_SPEC,
+  ConnectionsClient,
+  actionRequest,
+  actionResponse,
+  connectorPayload,
+  createOperation,
+  createOperationRequest,
+  deleteOperation,
+  deleteOperationRequest,
+  executeCustomQueryRequest,
+  getActionOperation,
+  getOperation,
+  getOperationRequest,
+  listOperation,
+  listOperationRequest,
+  updateOperation,
+  updateOperationRequest
+});