@squidcloud/client 1.0.425 → 1.0.427

package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts

@@ -457,6 +457,12 @@ export interface BaseAiChatOptions {
      * Note: Only supported by OpenAI and Gemini models. Ignored for other providers.
      */
     useCodeInterpreter?: 'none' | 'llm';
+    /**
+     * File IDs to include in the chat context.
+     * These are IDs returned from the AI provider's Files API after uploading files.
+     * Files are attached to the conversation and can be read/analyzed by the AI.
+     */
+    fileIds?: string[];
 }
 /**
  * Chat options specific to Gemini models, extending base options.

package/dist/internal-common/src/public-types/ai-query.public-types.d.ts

@@ -1,22 +1,8 @@
 import { AiChatOptions, AiSessionContext } from './ai-agent.public-types';
 import { ApiOptions } from './api-client.public-types';
 import { AiAgentId, IntegrationId } from './communication.public-types';
-/**
- * Request to execute an AI query using a specific integration.
- * Supports additional query execution options.
- * @category AI
- */
-export interface AiQueryRequest {
-    /** ID of the integration to execute the AI query. */
-    integrationId: IntegrationId;
-    /** User-provided prompt for the AI query. */
-    prompt: string;
-    /** Additional options for query execution. */
-    options?: AiQueryOptions;
-}
 /**
  * Options for configuring AI query execution.
- * Includes instructions, model overrides, and additional execution settings.
  * @category AI
  */
 export interface AiQueryOptions {
@@ -38,6 +24,19 @@ export interface AiQueryOptions {
     /** Session information for the AI query execution. */
     sessionContext?: AiSessionContext;
 }
+/**
+ * Request to execute an AI query using a specific integration.
+ * Supports additional query execution options.
+ * @category AI
+ */
+export interface AiQueryRequest {
+    /** ID of the integration to execute the AI query. */
+    integrationId: IntegrationId;
+    /** User-provided prompt for the AI query. */
+    prompt: string;
+    /** Additional options for query execution. */
+    options?: AiQueryOptions;
+}
 /**
  * Options for the collection selection stage.
  *

package/dist/internal-common/src/public-types/integration.public-types.d.ts

@@ -1,6 +1,6 @@
 import { IntegrationId } from './communication.public-types';
 /** List of all integration types supported by Squid. */
-export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
+export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
 /**
  * @category Database
  */

package/dist/internal-common/src/utils/object.d.ts

@@ -50,7 +50,7 @@ export declare function invert<K extends string | number, V extends string | num
  */
 export declare function range(start: number, end: number, step: number, maximumNumberOfItems?: number): number[];
 /** Returns count of top level properties in object. */
-export declare function countObjectKeys(obj: object | undefined): number;
+export declare function countObjectKeys(obj: object | undefined | null): number;
 /** Returns object entries sorted by name. */
 export declare function getSortedEntries<T>(record: Record<string, T>): Array<[string, T]>;
 /** Removes top level fields which are empty objects. May be used for value formatting. */

package/dist/typescript-client/src/integration-client.d.ts

@@ -57,4 +57,276 @@ export declare class IntegrationClient {
      * @returns A promise that resolves when the operation is complete.
      */
     upsertIntegration<ConfigurationType = Record<string, any>>(integration: IntegrationInfo<ConfigurationType>): Promise<void>;
+    /**
+     * Generates AI descriptions for the data schema of an integration.
+     * Uses AI to analyze the schema structure and generate meaningful descriptions
+     * for collections and their fields.
+     *
+     * @param integrationId - The ID of the integration.
+     * @param request - The request containing schema and optional parameters.
+     * @returns A promise that resolves with the schema containing AI-generated descriptions.
+     */
+    generateAiDescriptionsForDataSchema<SchemaType = Record<string, any>>(integrationId: IntegrationId, request: GenerateAiDescriptionsForDataSchemaRequest<SchemaType>): Promise<GenerateAiDescriptionsForDataSchemaResponse<SchemaType>>;
+    /**
+     * Generates AI descriptions for associations (relationships) in a data schema.
+     * Uses AI to analyze entity relationships and generate meaningful descriptions.
+     *
+     * @param integrationId - The ID of the integration.
+     * @param request - The request containing schema with associations and optional parameters.
+     * @returns A promise that resolves with the schema containing AI-generated association descriptions.
+     */
+    generateAiDescriptionsForAssociations<SchemaType = Record<string, any>>(integrationId: IntegrationId, request: GenerateAiDescriptionsForAssociationsRequest<SchemaType>): Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>;
+    /**
+     * Generates AI descriptions for stored procedures in a data schema.
+     * Uses AI to analyze stored procedures and generate meaningful descriptions.
+     *
+     * @param integrationId - The ID of the integration.
+     * @param request - The request containing schema with stored procedures and optional parameters.
+     * @returns A promise that resolves with the schema containing AI-generated stored procedure descriptions.
+     */
+    generateAiDescriptionsForStoredProcedures<SchemaType = Record<string, any>>(integrationId: IntegrationId, request: GenerateAiDescriptionsForStoredProceduresRequest<SchemaType>): Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>;
+    /**
+     * Generates AI descriptions for API endpoints in an API schema.
+     * Uses AI to analyze endpoints and generate meaningful descriptions.
+     *
+     * @param integrationId - The ID of the integration.
+     * @param request - The request containing API schema with endpoints and optional parameters.
+     * @returns A promise that resolves with the schema containing AI-generated endpoint descriptions.
+     */
+    generateAiDescriptionsForEndpoints<SchemaType = Record<string, any>>(integrationId: IntegrationId, request: GenerateAiDescriptionsForEndpointsRequest<SchemaType>): Promise<GenerateAiDescriptionsForSchemaResponse<SchemaType>>;
+    /**
+     * Discovers the schema of a data connection (database).
+     * Connects to the database and introspects its structure including tables, columns, and relationships.
+     *
+     * @param integrationId - The ID of the database integration.
+     * @returns A promise that resolves with the discovered schema and collection readiness information.
+     */
+    discoverDataConnectionSchema<SchemaType = Record<string, any>>(integrationId: IntegrationId): Promise<DiscoverDataConnectionSchemaResponse<SchemaType>>;
+    /**
+     * Discovers the schema of a GraphQL connection.
+     * Performs introspection on the GraphQL endpoint to discover types and operations.
+     *
+     * @param integrationId - The ID of the GraphQL integration.
+     * @param request - The request containing GraphQL connection options.
+     * @returns A promise that resolves with the discovered GraphQL schema.
+     */
+    discoverGraphQLConnectionSchema<SchemaType = Record<string, any>>(integrationId: IntegrationId, request: DiscoverGraphQLConnectionSchemaRequest): Promise<DiscoverGraphQLConnectionSchemaResponse<SchemaType>>;
+    /**
+     * Discovers the schema from an OpenAPI specification URL.
+     * Fetches and parses the OpenAPI spec to discover endpoints and their schemas.
+     *
+     * @param integrationId - The ID of the API integration.
+     * @param request - The request containing OpenAPI discovery options.
+     * @returns A promise that resolves with the discovered API schema.
+     */
+    discoverOpenApiSchema<SchemaType = Record<string, any>>(integrationId: IntegrationId, request: DiscoverOpenApiSchemaRequest): Promise<DiscoverOpenApiSchemaResponse<SchemaType>>;
+    /**
+     * Discovers the schema from an uploaded OpenAPI specification file.
+     * Parses the OpenAPI spec file that was previously uploaded to the integration.
+     *
+     * @param integrationId - The ID of the API integration with the uploaded spec file.
+     * @returns A promise that resolves with the discovered API schema.
+     */
+    discoverOpenApiSchemaFromFile<SchemaType = Record<string, any>>(integrationId: IntegrationId): Promise<DiscoverOpenApiSchemaResponse<SchemaType>>;
+}
+/**
+ * Request for generating AI descriptions for a data schema.
+ * @category Platform
+ */
+export interface GenerateAiDescriptionsForDataSchemaRequest<SchemaType = Record<string, any>> {
+    /**
+     * List of collection names to generate descriptions for.
+     * If not provided or empty, descriptions will be generated for all collections.
+     */
+    collections?: string[];
+    /**
+     * The current schema of the integration containing collections and their fields.
+     */
+    schema: SchemaType;
+    /**
+     * Optional instructions to guide the AI in generating descriptions.
+     * For example: "Focus on business context" or "Use technical terminology".
+     */
+    instructions?: string;
+}
+/**
+ * Response from generating AI descriptions for a data schema.
+ * @category Platform
+ */
+export interface GenerateAiDescriptionsForDataSchemaResponse<SchemaType = Record<string, any>> {
+    /**
+     * The schema with AI-generated descriptions added to collections and fields.
+     */
+    schema: SchemaType;
+}
+/**
+ * Generic response from generating AI descriptions for a schema.
+ * @category Platform
+ */
+export interface GenerateAiDescriptionsForSchemaResponse<SchemaType = Record<string, any>> {
+    /**
+     * The schema with AI-generated descriptions.
+     */
+    schema: SchemaType;
+}
+/**
+ * Request for generating AI descriptions for associations in a data schema.
+ * @category Platform
+ */
+export interface GenerateAiDescriptionsForAssociationsRequest<SchemaType = Record<string, any>> {
+    /**
+     * List of association names to generate descriptions for.
+     * If not provided or empty, descriptions will be generated for all associations.
+     */
+    associations?: string[];
+    /**
+     * The current schema of the integration containing associations.
+     */
+    schema: SchemaType;
+    /**
+     * Optional instructions to guide the AI in generating descriptions.
+     */
+    instructions?: string;
+}
+/**
+ * Request for generating AI descriptions for stored procedures in a data schema.
+ * @category Platform
+ */
+export interface GenerateAiDescriptionsForStoredProceduresRequest<SchemaType = Record<string, any>> {
+    /**
+     * List of stored procedure names to generate descriptions for.
+     * If not provided or empty, descriptions will be generated for all stored procedures.
+     */
+    storedProcedures?: string[];
+    /**
+     * The current schema of the integration containing stored procedures.
+     */
+    schema: SchemaType;
+    /**
+     * Optional instructions to guide the AI in generating descriptions.
+     */
+    instructions?: string;
+}
+/**
+ * Request for generating AI descriptions for API endpoints.
+ * @category Platform
+ */
+export interface GenerateAiDescriptionsForEndpointsRequest<SchemaType = Record<string, any>> {
+    /**
+     * List of endpoint IDs to generate descriptions for.
+     * If not provided or empty, descriptions will be generated for all endpoints.
+     */
+    endpoints?: string[];
+    /**
+     * The current API schema containing endpoints.
+     */
+    schema: SchemaType;
+    /**
+     * Optional instructions to guide the AI in generating descriptions.
+     */
+    instructions?: string;
+}
+/**
+ * Response from discovering a data connection schema.
+ * @category Platform
+ */
+export interface DiscoverDataConnectionSchemaResponse<SchemaType = Record<string, any>> {
+    /**
+     * The discovered schema containing collections, fields, associations, and stored procedures.
+     */
+    schema: SchemaType;
+    /**
+     * Information about collection readiness for CRUD operations and replication.
+     */
+    collectionReadiness: Record<string, CollectionReadiness>;
+}
+/**
+ * Information about a collection's readiness for operations.
+ * @category Platform
+ */
+export interface CollectionReadiness {
+    /**
+     * Whether the user has permissions to perform CRUD operations on the collection.
+     */
+    hasPermissions: boolean;
+    /**
+     * Commands needed to grant the required permissions.
+     */
+    grantPermissionsCommands: string[];
+    /**
+     * Whether the collection is ready for external updates/replication.
+     */
+    replicationEnabled: boolean;
+    /**
+     * Commands needed to enable replication.
+     */
+    enableReplicationCommands: string[];
+}
+/**
+ * Request for discovering a GraphQL connection schema.
+ * @category Platform
+ */
+export interface DiscoverGraphQLConnectionSchemaRequest {
+    /**
+     * GraphQL connection options including URL and authentication.
+     */
+    connectionOptions: DiscoverGraphQLConnectionOptions;
+}
+/**
+ * GraphQL connection options for schema discovery.
+ * @category Platform
+ */
+export interface DiscoverGraphQLConnectionOptions {
+    /**
+     * The GraphQL endpoint URL.
+     */
+    url: string;
+    /**
+     * Optional headers to include in requests.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * Response from discovering a GraphQL connection schema.
+ * @category Platform
+ */
+export interface DiscoverGraphQLConnectionSchemaResponse<SchemaType = Record<string, any>> {
+    /**
+     * The discovered GraphQL schema.
+     */
+    schema: SchemaType;
+}
+/**
+ * Request for discovering an OpenAPI schema from a URL.
+ * @category Platform
+ */
+export interface DiscoverOpenApiSchemaRequest {
+    /**
+     * OpenAPI discovery options including URL and authentication.
+     */
+    discoveryOptions: DiscoverOpenApiOptions;
+}
+/**
+ * OpenAPI discovery options for schema discovery.
+ * @category Platform
+ */
+export interface DiscoverOpenApiOptions {
+    /**
+     * The URL of the OpenAPI specification.
+     */
+    openApiSpecUrl?: string;
+    /**
+     * Optional headers to include when fetching the spec.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * Response from discovering an OpenAPI schema.
+ * @category Platform
+ */
+export interface DiscoverOpenApiSchemaResponse<SchemaType = Record<string, any>> {
+    /**
+     * The discovered API schema containing endpoints and their definitions.
+     */
+    schema: SchemaType;
 }

package/dist/typescript-client/src/version.d.ts

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.425";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.427";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.425",
+  "version": "1.0.427",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",