@squidcloud/client 1.0.432 → 1.0.434
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.js +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +10 -0
- package/dist/internal-common/src/public-types/ai-query.public-types.d.ts +14 -2
- package/dist/internal-common/src/public-types/integration.public-types.d.ts +1 -1
- package/dist/typescript-client/src/connection-details.d.ts +2 -0
- package/dist/typescript-client/src/index.d.ts +1 -0
- package/dist/typescript-client/src/job-client.d.ts +1 -0
- package/dist/typescript-client/src/runtime-options.d.ts +1 -0
- package/dist/typescript-client/src/squid.d.ts +11 -0
- package/dist/typescript-client/src/version.d.ts +1 -1
- package/package.json +1 -1
|
@@ -254,6 +254,16 @@ export interface AiConnectedIntegrationMetadata<AiConnectedIntegrationOptionsTyp
|
|
|
254
254
|
description?: string;
|
|
255
255
|
/** Optional instructions for the connected integration agent, overriding the default if provided. */
|
|
256
256
|
instructions?: string;
|
|
257
|
+
/**
|
|
258
|
+
* A list of AI function IDs that the AI agent can use from this integration.
|
|
259
|
+
*
|
|
260
|
+
* - When `undefined` (not provided), the AI agent has access to all AI functions for this integration type.
|
|
261
|
+
* - When an empty array `[]`, the AI agent has access to no AI functions.
|
|
262
|
+
* - When an array with function IDs, the AI agent only has access to those specific functions.
|
|
263
|
+
*
|
|
264
|
+
* Example function IDs: 'jiraService__searchJiraIssues', 'confluenceService__searchInConfluence'
|
|
265
|
+
*/
|
|
266
|
+
functionsToUse?: AiFunctionId[];
|
|
257
267
|
/**
|
|
258
268
|
* Additional options for the connected integration.
|
|
259
269
|
* Squid Core or AI functions in connector packages may use these options to adjust behavior of the integration agent.
|
|
@@ -94,6 +94,18 @@ export interface AiQueryAnalyzeResultsOptions {
|
|
|
94
94
|
*/
|
|
95
95
|
agentId?: AiAgentId;
|
|
96
96
|
}
|
|
97
|
+
/**
|
|
98
|
+
* Information about an executed query in a multi-query scenario.
|
|
99
|
+
* @category AI
|
|
100
|
+
*/
|
|
101
|
+
export interface ExecutedQueryInfo {
|
|
102
|
+
/** The executed query string. */
|
|
103
|
+
query: string;
|
|
104
|
+
/** Optional description of what this query retrieves. */
|
|
105
|
+
purpose?: string;
|
|
106
|
+
/** Whether this specific query executed successfully. */
|
|
107
|
+
success: boolean;
|
|
108
|
+
}
|
|
97
109
|
/**
|
|
98
110
|
* Response from an AI query execution.
|
|
99
111
|
* Contains the generated answer, optional explanation, and executed query details.
|
|
@@ -104,8 +116,8 @@ export interface AiQueryResponse {
|
|
|
104
116
|
answer: string;
|
|
105
117
|
/** Optional explanation for the AI-generated answer. */
|
|
106
118
|
explanation?: string;
|
|
107
|
-
/**
|
|
108
|
-
|
|
119
|
+
/** All executed queries with their details. */
|
|
120
|
+
executedQueries?: ExecutedQueryInfo[];
|
|
109
121
|
/** Markdown format type of the executed query response. */
|
|
110
122
|
queryMarkdownType?: string;
|
|
111
123
|
/** URL to access raw results from the query execution. */
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { IntegrationId } from './communication.public-types';
|
|
2
2
|
/** List of all integration types supported by Squid. */
|
|
3
|
-
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", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
|
|
3
|
+
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", "jira_jsm", "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", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
|
|
4
4
|
/**
|
|
5
5
|
* @category Database
|
|
6
6
|
*/
|
|
@@ -7,6 +7,7 @@ import { ClientId } from '../../internal-common/src/public-types/communication.p
|
|
|
7
7
|
export declare class ConnectionDetails {
|
|
8
8
|
private readonly clientIdService;
|
|
9
9
|
private readonly socketManager;
|
|
10
|
+
private readonly runtimeOptions;
|
|
10
11
|
private isConnected;
|
|
11
12
|
/** Whether the Squid Client SDK is currently connected to the Squid Server. */
|
|
12
13
|
get connected(): boolean;
|
|
@@ -19,6 +20,7 @@ export declare class ConnectionDetails {
|
|
|
19
20
|
/**
|
|
20
21
|
* Returns an observable that emits true when the client is connected to the server and false when the client is
|
|
21
22
|
* disconnected from the server.
|
|
23
|
+
* @throws Error if client is in passive mode.
|
|
22
24
|
*/
|
|
23
25
|
observeConnected(): Observable<boolean>;
|
|
24
26
|
}
|
|
@@ -50,6 +50,7 @@ export * from './query/snapshot-emitter';
|
|
|
50
50
|
export * from './queue.manager';
|
|
51
51
|
export * from './rate-limiter';
|
|
52
52
|
export * from './rpc.manager';
|
|
53
|
+
export * from './runtime-options';
|
|
53
54
|
export * from './scheduler-client';
|
|
54
55
|
export * from './secret.client';
|
|
55
56
|
export * from './socket.manager';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -65,6 +65,11 @@ export interface SquidOptions {
|
|
|
65
65
|
* The console region (optional and used for on-prem deployments of Squid)
|
|
66
66
|
*/
|
|
67
67
|
consoleRegion?: string;
|
|
68
|
+
/**
|
|
69
|
+
* Enable passive (HTTP-only) mode. Default: false.
|
|
70
|
+
* In passive mode, real-time features (WebSocket) are disabled.
|
|
71
|
+
*/
|
|
72
|
+
isPassiveMode?: boolean;
|
|
68
73
|
}
|
|
69
74
|
/**
|
|
70
75
|
* Authentication data provider for Squid requests.
|
|
@@ -125,6 +130,7 @@ export declare class Squid {
|
|
|
125
130
|
private readonly schedulerClient;
|
|
126
131
|
private readonly notificationClient;
|
|
127
132
|
private readonly _appId;
|
|
133
|
+
private readonly runtimeOptions;
|
|
128
134
|
/**
|
|
129
135
|
* Creates a new instance of Squid with the given options.
|
|
130
136
|
*
|
|
@@ -251,6 +257,11 @@ export declare class Squid {
|
|
|
251
257
|
* @typeParam T - The expected type of the result returned by the webhook.
|
|
252
258
|
*/
|
|
253
259
|
executeWebhook<T = any>(webhookId: string, options?: ExecuteWebhookOptions): Promise<T>;
|
|
260
|
+
/**
|
|
261
|
+
* Returns the URL for the webhook with the given ID. If no ID is provided, returns the base URL for webhooks.
|
|
262
|
+
* @param webhookId - The ID of the webhook (optional).
|
|
263
|
+
*/
|
|
264
|
+
getWebhookUrl(webhookId?: string): string;
|
|
254
265
|
/**
|
|
255
266
|
* Executes a native relational query with the given parameters and returns a promise with the result.
|
|
256
267
|
* See https://docs.getsquid.ai/docs/sdk/client-sdk/database/native-queries.
|