@squidcloud/client 1.0.284 → 1.0.286

package/dist/internal-common/src/metric-name.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Names of the Squid metrics.
+ * Should be in sync with MetricName.kt.
+ * See MetricName.kt for documentation on each value.
+ */
+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_apiControllerCall_count", "squid_apiControllerCall_time", "squid_built_in_db_size", "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_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_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_webhook_count", "squid_webhook_time"];
+export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
+/** Common prefix for all Squid metrics. */
+export declare const SQUID_METRIC_NAME_PREFIX = "squid_";

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

@@ -37,7 +37,8 @@ export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
 export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions | FluxOptions;
 export type AiAudioTranscribeOptions = WhisperOptions;
 export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
-export type VectorDbType = 'pinecone' | 'postgres';
+export declare const VECTOR_DB_TYPES: readonly ["pinecone", "postgres"];
+export type VectorDbType = (typeof VECTOR_DB_TYPES)[number];
 export interface AiAudioCreateSpeechResponse {
     mimeType: string;
     extension: string;

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

@@ -9,7 +9,6 @@ export type MetricActionType = 'write' | 'all';
 /** The different types of actions that can be performed on an AI chatbot. */
 export type AiChatbotActionType = 'chat' | 'mutate' | 'all';
 export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';
-export type FunctionName = string;
 export interface AiFunctionParam {
     name: string;
     description: string;
@@ -17,5 +16,6 @@ export interface AiFunctionParam {
     required: boolean;
 }
 export type TopicName = string;
+export type FunctionName = string;
 export type ServiceName = string;
 export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;

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

@@ -3,10 +3,12 @@ export type AppId = string;
 export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
 export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
 export type SquidDeveloperId = string;
-/** @deprecated. Use ENVIRONMENT_IDS. */
-export declare const allEnvironmentIds: Array<EnvironmentId>;
 /** A type alias for an integration id. */
 export type IntegrationId = string;
 export type ClientId = string;
 export type SquidDocId = string;
 export type ClientRequestId = string;
+/** ID of AI agent. Also known as AI profile id. */
+export type AiAgentId = string;
+export type AiProfileId = AiAgentId;
+export type AiContextId = string;

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

@@ -8,6 +8,7 @@ export interface AuthWithBearer {
     userId: string;
     expiration: number;
     attributes: Record<string, any>;
+    jwt?: string;
 }
 /**
  * The authentication object for the current request in case an API key is used.

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

@@ -1,3 +1,4 @@
+import { IntegrationId } from './communication.public-types';
 export declare enum IntegrationType {
     'built_in_db' = "built_in_db",
     'mongo' = "mongo",
@@ -69,3 +70,4 @@ export declare enum IntegrationSchemaType {
     'api' = "api",
     'graphql' = "graphql"
 }
+export declare const AI_AGENTS_INTEGRATION_ID: IntegrationId;

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

@@ -1,4 +1,5 @@
 import { AiChatModelName, AiEmbeddingsModelName, VectorDbType } from '../ai-chatbot.public-types';
+import { FunctionName } from '../bundle-data.public-types';
 export type AiChatbotConfiguration = {
     apiKey?: string;
 };
@@ -7,8 +8,12 @@ export type AiChatbotProfileMetadata = {
     isPublic: boolean;
     strictContext: boolean;
     instructions: Record<string, string>;
+    /** 'text-embedding-ada-002' if undefined. */
     embeddingModelName?: AiEmbeddingsModelName;
+    /** 'pinecone' if undefined. */
     vectorDbType?: VectorDbType;
+    /** List of AI functions attached to the profile by default. */
+    functions?: Array<FunctionName>;
 };
 export type AiChatbotContextMetadata = {
     title: string;

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

@@ -11,6 +11,7 @@ export type IntegrationApiEndpoints = Record<ApiEndpointId, ApiEndpoint>;
 export interface ApiRequestField {
     location: ApiParameterLocation;
     description?: string;
+    required?: boolean;
 }
 /** The options for calling an API. */
 export interface CallApiOptions {
@@ -55,6 +56,7 @@ export interface ApiEndpoint {
     responseSchema?: Record<FieldPath, ApiResponseField>;
     injectionSchema?: ApiInjectionSchema;
     tags?: Array<string>;
+    description?: string;
 }
 export interface DiscoverOpenApiSchemaRequest {
     integrationId: IntegrationId;

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

@@ -2,7 +2,3 @@
 export declare const SQUID_REGIONS: readonly ["us-east-1.aws", "ap-south-1.aws", "us-central1.gcp"];
 /** Region type used by Squid. */
 export type SquidRegion = (typeof SQUID_REGIONS)[number];
-/** @deprecated: Use 'SQUID_REGIONS'. */
-export declare const SUPPORTED_SQUID_REGIONS: readonly ["us-east-1.aws", "ap-south-1.aws", "us-central1.gcp"];
-/** @deprecated: Use 'SquidRegion'. */
-export type SupportedSquidRegion = SquidRegion;

package/dist/internal-common/src/types/observability.types.d.ts

@@ -0,0 +1,59 @@
+import { MetricName } from '../metric-name';
+import { AppId } from '../public-types/communication.public-types';
+export interface ObservableNameMetrics {
+    count: MetricName;
+    time: MetricName;
+}
+export declare const ObservableNames: {
+    readonly functionExecution: ObservableNameMetrics;
+    readonly codeInitialization: ObservableNameMetrics;
+    readonly getAiChatbotProfiles: ObservableNameMetrics;
+    readonly aiImageGeneration: ObservableNameMetrics;
+    readonly aiRemoveBackground: ObservableNameMetrics;
+    readonly aiAudioTranscribe: ObservableNameMetrics;
+    readonly aiAudioCreateSpeech: ObservableNameMetrics;
+    readonly discoverGraphQLConnectionSchema: ObservableNameMetrics;
+    readonly discoverOpenApiSchema: ObservableNameMetrics;
+    readonly discoverOpenApiSchemaFromFile: ObservableNameMetrics;
+    readonly graphqlQuery: ObservableNameMetrics;
+    readonly testGraphQLConnection: ObservableNameMetrics;
+    readonly graphql: ObservableNameMetrics;
+};
+export type ObservableName = keyof typeof ObservableNames;
+export interface MetricEvent {
+    appId: AppId;
+    name: MetricName;
+    tags: Record<string, string>;
+    timestamp: Date;
+    value: number;
+    isExposedToUser: boolean;
+}
+export interface LogEvent {
+    message: string;
+    level: string;
+    tags: Record<string, string>;
+    timestamp: Date;
+    isExposedToUser: boolean;
+    host: string;
+    source?: string;
+    service?: string;
+}
+/** Tag for metric events. Value: '0' - not an error, '1' - is an error. */
+export declare const O11Y_TAG_IS_ERROR = "isError";
+/** Tag for log events. Metrics have an explicit appId field. */
+export declare const O11Y_TAG_APP_ID = "appId";
+/** Tag for metric and log events. */
+export declare const O11Y_TAG_INTEGRATION_ID = "integrationId";
+/** Tag for AI events. */
+export declare const O11Y_TAG_AI_MODEL = "aiModel";
+export declare const O11Y_TAG_AI_PROFILE = "aiProfile";
+export declare const O11Y_TAG_API_KEY_SOURCE = "apiKeySource";
+/** Tag for metric and log events. Value: '0' - not a tenant originated, '1' - is a tenant originated. */
+export declare const O11Y_TAG_IS_TENANT_ORIGINATED = "isTenantOriginated";
+/** Contains a full (with a service name) function name for backend functions. */
+export declare const O11Y_TAG_FUNCTION_NAME = "functionName";
+/** Contains a type of the function name for backend functions (See ExecuteFunctionAnnotationType.). */
+export declare const O11Y_TAG_FUNCTION_TYPE = "functionType";
+export declare function getBooleanMetricTagValue(value: boolean): string;
+export declare const COUNT_METRIC_SUFFIXES: string[];
+export declare const GAUGE_METRIC_SUFFIXES: string[];

package/dist/internal-common/src/utils/metrics.types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Type suffixes defines the type of the metric and can be used for
+ * metric value validation for incoming metrics.
+ */
+export declare const SQUID_METRIC_TYPE_SUFFIXES: readonly ["_count", "_time", "_size", "_entries", "_value"];
+/** Returns true if the given metric has a valid metric type. */
+export declare function hasValidMetricTypeSuffix(metricName: string): boolean;

package/dist/typescript-client/src/ai-agent-client.d.ts

@@ -1,4 +1,4 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse } from './public-types';
+import { AiProfileId, AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse } from './public-types';
 import { Observable } from 'rxjs';
 export interface TranscribeAndChatResponse {
     transcribedPrompt: string;
@@ -49,12 +49,12 @@ export declare class AiAgentClient {
     /**
      * Sends a prompt to the specified profile id and returns the response as a Promise of string.
      *
-     * @param profileId - The profile id.
+     * @param agentId - The agent id (profile id).
      * @param prompt - The prompt.
      * @param options - The options to send to the chat model.
      * @returns A promise that resolves when the chat is complete. The resolved value is the entire response.
      */
-    ask(profileId: string, prompt: string, options?: AskOptionsWithoutVoice): Promise<string>;
+    ask(agentId: AiProfileId, prompt: string, options?: AskOptionsWithoutVoice): Promise<string>;
     transcribeAndAsk(profileId: string, fileToTranscribe: File, options?: AskOptionsWithoutVoice): Promise<AiTranscribeAndAskResponse>;
     transcribeAndAskWithVoiceResponse(profileId: string, fileToTranscribe: File, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<TranscribeAndAskWithVoiceResponse>;
     askWithVoiceResponse(profileId: string, prompt: string, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<AskWithVoiceResponse>;

package/dist/typescript-client/src/ai-image-client.d.ts

@@ -2,4 +2,5 @@ import { AiGenerateImageOptions } from './public-types';
 export declare class AiImageClient {
     private readonly rpcManager;
     generate(prompt: string, options: AiGenerateImageOptions): Promise<string>;
+    removeBackground(file: File): Promise<string>;
 }

package/dist/typescript-client/src/collection-reference.d.ts

@@ -20,7 +20,7 @@ export interface DocIdAndData<T extends DocumentData> {
  * collection in a NoSQL database.
  *
  * Read more about collection references in the
- * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
+ * {@link https://docs.getsquid.ai/docs/database/collection-reference documentation}.
  * @typeParam T The type of the document data.
  */
 export declare class CollectionReference<T extends DocumentData> {

package/dist/typescript-client/src/document-reference.d.ts

@@ -9,7 +9,7 @@ import { DeepRecord, Paths } from '../../internal-common/src/public-types/typesc
  * use to create a new document.
  *
  * Read more about document references in the
- * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/document-reference documentation}.
+ * {@link https://docs.getsquid.ai/docs/database/document-reference documentation}.
  * @typeParam T The type of the document data.
  */
 export declare class DocumentReference<T extends DocumentData = any> {

package/dist/typescript-client/src/query/join-query-builder.factory.d.ts

@@ -40,7 +40,7 @@ interface HasGrouped {
 /**
  * A query builder that can participate in a join.
  * To learn more about join queries, see the
- * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/queries#joining-data-across-collections-and-integrations documentation}.
+ * {@link https://docs.getsquid.ai/docs/database/queries#joining-data-across-collections-and-integrations documentation}.
  */
 export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, LatestAlias extends Alias, RootAlias extends Alias> extends BaseQueryBuilder<ReturnType> implements SnapshotEmitter<WithDocumentReferences<ReturnType>>, HasGrouped, HasDereference {
     private readonly collectionName;

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

@@ -5,8 +5,26 @@ export declare class SecretClient {
     getAll(): Promise<Record<SecretKey, SecretEntry>>;
     upsert(key: SecretKey, value: SecretValue): Promise<SecretEntry>;
     upsertMany(entries: Array<SetSecretRequestEntry>): Promise<Array<SecretEntry>>;
-    delete(key: SecretKey): Promise<void>;
-    deleteMany(keys: Array<SecretKey>): Promise<void>;
+    /**
+     * Deletes a specified secret key.
+     * If the secret is missing, it will be ignored, and the operation will proceed without failure.
+     *
+     * @param key - The secret key to delete.
+     * @param force - If set to true, forces deletion regardless of the secret's usage status across any enabled
+     *   integrations. Default is false.
+     * @returns A promise that resolves when the deletion request is complete.
+     */
+    delete(key: SecretKey, force?: boolean): Promise<void>;
+    /**
+     * Deletes a list of specified secret keys.
+     * If any secret in the list is missing, it will be ignored, and the operation will proceed without failure.
+     *
+     * @param keys - An array of secret keys to delete.
+     * @param force - If set to true, forces deletion regardless of the secret's usage status across any enabled
+     *   integrations. Default is false.
+     * @returns A promise that resolves when the deletion request is complete.
+     */
+    deleteMany(keys: Array<SecretKey>, force?: boolean): Promise<void>;
     get apiKeys(): ApiKeysSecretClient;
 }
 export declare class ApiKeysSecretClient {

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

@@ -142,7 +142,7 @@ export declare class Squid {
      * If the integrationId is not provided, the `built_in_db` integration id will be used.
      *
      * For more information on the CollectionReference object, please refer to the
-     * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
+     * {@link https://docs.getsquid.ai/docs/database/collection-reference documentation}.
      *
      * @param collectionName The name of the collection.
      * @param integrationId The id of the integration, default to `built_in_db`.
@@ -155,7 +155,7 @@ export declare class Squid {
      * will be atomic. Note that mutations for different integrations will not be atomic.
      *
      * For more information about transactions in Squid, please refer to the
-     * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/transactions documentation}.
+     * {@link https://docs.getsquid.ai/docs/database/transactions documentation}.
      *
      * @param fn The callback to run as an atomic change. The function receives a transactionId that should be used for
      * all the mutations that should be atomic. The function should return a promise.
@@ -167,7 +167,7 @@ export declare class Squid {
      * Executes the given backend function with the given parameters and returns a promise with the result.
      *
      * For more information about backend functions in Squid, please refer to the
-     * {@link https://docs.squid.cloud/docs/development-tools/backend/executables documentation}.
+     * {@link https://docs.getsquid.ai/docs/backend/executables/ documentation}.
      *
      * @param functionName The name of the function to execute on the server.
      * @param params The parameters to pass to the function.
@@ -177,7 +177,7 @@ export declare class Squid {
     executeFunction<T = any>(functionName: string, ...params: any[]): Promise<T>;
     /**
      * Executes a native relational query with the given parameters and returns a promise with the result.
-     * See https://docs.squid.cloud/docs/development-tools/backend/native-queries#native-relational-queries.
+     * See https://docs.getsquid.ai/docs/database/native-queries.
      *
      * @param integrationId The id of the integration that the query is associated with.
      * @param query The raw SQL or other database-specific query to execute.
@@ -188,7 +188,7 @@ export declare class Squid {
     executeNativeRelationalQuery<T = any>(integrationId: IntegrationId, query: string, params?: Record<string, any>): Promise<Array<T>>;
     /**
      * Executes a native Mongo/built-in-db query with the given pipeline and returns a promise with the result.
-     * See https://docs.squid.cloud/docs/development-tools/backend/native-queries#native-mongodb-queries.
+     * See https://docs.getsquid.ai/docs/database/native-queries#native-mongodb-queries.
      *
      * @param integrationId The id of the integration that the query is associated with.
      * @param collectionName The collection to query.

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.284";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.286";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.284",
+  "version": "1.0.286",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",