@squidcloud/client 1.0.452 → 1.0.453

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.
@@ -3,7 +3,7 @@
3
3
  * Should be in sync with MetricName.kt.
4
4
  * See MetricName.kt for documentation on each value.
5
5
  */
6
- export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_aiContextUpsert_count", "squid_aiContextDelete_count", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_acquireLock_count", "squid_releaseLock_count", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_testAgentProtocolConnection_count", "squid_testAgentProtocolConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time"];
6
+ export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_aiContextUpsert_count", "squid_aiContextDelete_count", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_testAgentProtocolConnection_count", "squid_testAgentProtocolConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time", "squid_acquireLock_count", "squid_acquireLock_time", "squid_releaseLock_count", "squid_releaseLock_time"];
7
7
  export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
8
8
  /** Common prefix for all Squid metrics. */
9
9
  export declare const SQUID_METRIC_NAME_PREFIX = "squid_";
@@ -19,6 +19,8 @@ export declare const ObservableNames: {
19
19
  readonly testGraphQLConnection: ObservableNameMetrics;
20
20
  readonly testAgentProtocolConnection: ObservableNameMetrics;
21
21
  readonly graphql: ObservableNameMetrics;
22
+ readonly acquireLock: ObservableNameMetrics;
23
+ readonly releaseLock: ObservableNameMetrics;
22
24
  };
23
25
  export type ObservableName = keyof typeof ObservableNames;
24
26
  export interface MetricEvent {
@@ -64,6 +66,11 @@ export interface AgentAuditLogEvent {
64
66
  integrationId?: string;
65
67
  }
66
68
  export type AgentAuditLogUpdateType = 'statusUpdate' | 'response';
69
+ /** Usage metric for AI model input/output — either token count or character count depending on provider. */
70
+ export interface AiUsageMetric {
71
+ unit: 'tokens' | 'characters';
72
+ value: number;
73
+ }
67
74
  /** Agent audit log update entry - status updates and responses for agent invocations */
68
75
  export interface AgentAuditLogUpdateEvent {
69
76
  appId: AppId;
@@ -79,6 +86,10 @@ export interface AgentAuditLogUpdateEvent {
79
86
  createdAt: Date;
80
87
  /** Integration ID for query-with-AI operations (nullable, used when not invoked via agent) */
81
88
  integrationId?: string;
89
+ /** Input usage metric (tokens or characters depending on provider). */
90
+ inputUsage?: AiUsageMetric;
91
+ /** Output usage metric (tokens or characters depending on provider). */
92
+ outputUsage?: AiUsageMetric;
82
93
  }
83
94
  /** Tag for metric events. Value: '0' - not an error, '1' - is an error. */
84
95
  export declare const O11Y_TAG_IS_ERROR = "isError";
@@ -2,8 +2,8 @@
2
2
  * Stage of the Squid deployment:
3
3
  * - 'local' - Squid is run locally.
4
4
  * - 'prod' - Production environment (https://console.getsquid.ai).
5
- * - 'sandbox' - One of the sandbox environments (https://console.sandbox.squid.cloud).
6
- * - 'staging' - One of the staging environments (https://console.staging.squid.cloud).
5
+ * - 'sandbox' - One of the sandbox environments (https://console.sandbox.getsquid.ai).
6
+ * - 'staging' - One of the staging environments (https://console.staging.getsquid.ai).
7
7
  */
8
8
  export declare const STAGES: readonly ["local", "prod", "sandbox", "staging"];
9
9
  export type Stage = (typeof STAGES)[number];
@@ -365,10 +365,11 @@ export declare class Squid {
365
365
  * finishes.
366
366
  * @param mutex A string that uniquely identifies the lock.
367
367
  * @param fn The callback to execute while holding the lock.
368
+ * @param options Optional configuration for the lock, including acquisition timeout and maximum hold time.
368
369
  * @returns A promise that resolves with the result of the callback. The promise will reject if failed
369
370
  * to acquire the lock.
370
371
  */
371
- withLock<T>(mutex: string, fn: (lock: DistributedLock) => Promise<T>): Promise<T>;
372
+ withLock<T>(mutex: string, fn: (lock: DistributedLock) => Promise<T>, options?: DistributedLockOptions): Promise<T>;
372
373
  /**
373
374
  * Returns a queue manager for the given topic name and integration id. Using the queue manager you can consume and
374
375
  * produce messages
@@ -2,4 +2,4 @@
2
2
  * The current version of the SquidCloud client package.
3
3
  * @category Platform
4
4
  */
5
- export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.452";
5
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.453";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.452",
3
+ "version": "1.0.453",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",