@squidcloud/client 1.0.317 → 1.0.319

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_aiIntegrationApi_count", "squid_aiIntegrationApi_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_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_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"];
+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-agent.public-types.d.ts

@@ -234,9 +234,9 @@ export interface AiSearchRequest {
 }
 export type AiMutationType = 'insert' | 'update' | 'delete' | 'append' | 'feedback';
 export type AiResourceType = 'instruction' | 'profile' | 'context' | 'contexts';
-export type AiAgentContextType = 'text' | 'url' | 'file';
-export interface AiAgentContextBase {
-    type: AiAgentContextType;
+export type AiContextType = 'text' | 'url' | 'file';
+export interface AiContextBase {
+    type: AiContextType;
     data: string;
     metadata?: AiContextMetadata;
     password?: string;
@@ -249,16 +249,16 @@ export interface AiSearchResultChunk {
     metadata?: AiContextMetadata;
     score: number;
 }
-export interface AiAgentTextContext extends AiAgentContextBase {
+export interface AiTextContext extends AiContextBase {
     type: 'text';
 }
-export interface AiAgentUrlContext extends AiAgentContextBase {
+export interface AiUrlContext extends AiContextBase {
     type: 'url';
     extractImages?: boolean;
     minImageWidth?: number;
     minImageHeight?: number;
 }
-export interface AiAgentFileContext extends AiAgentContextBase {
+export interface AiFileContext extends AiContextBase {
     type: 'file';
     extractImages?: boolean;
     minImageWidth?: number;
@@ -266,11 +266,15 @@ export interface AiAgentFileContext extends AiAgentContextBase {
     fullPageAsImage?: boolean;
     extractionModel?: AiChatModelName;
 }
-export declare class AiAgentChatContext {
+/**
+ * Provides context to the security rules of an AI Agent for each new user prompt.
+ * Refer to the `@secureAiChatbotChat` annotation for more details.
+ */
+export declare class AiChatContext {
     readonly prompt?: string;
     readonly profileId: AiAgentId;
 }
-export type AiAgentContext = AiAgentTextContext | AiAgentUrlContext | AiAgentFileContext;
+export type AiContext = AiTextContext | AiUrlContext | AiFileContext;
 export type AiContextMetadataValue = number | string | boolean | undefined;
 export type AiContextMetadataValueArray = AiContextMetadataValue[];
 export interface AiContextMetadataEqFilter {

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

@@ -7,8 +7,8 @@ export type StorageActionType = 'read' | 'write' | 'update' | 'insert' | 'delete
 export type TopicActionType = 'read' | 'write' | 'all';
 /** The different type of actions for metrics. */
 export type MetricActionType = 'write' | 'all';
-/** The different types of actions that can be performed on an AI chatbot. */
-export type AiChatbotActionType = 'chat' | 'mutate' | 'all';
+/** Types of actions that can be performed on an AI chatbot. */
+export type AiActionType = 'chat' | 'mutate' | 'all';
 export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';
 export interface AiFunctionParam {
     name: string;

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

@@ -0,0 +1,21 @@
+import { ApiEndpointId, HttpMethod } from '../public-types/integrations/api.public-types';
+import { IntegrationId } from '../public-types/communication.public-types';
+import { ApiOptions } from '../public-types/api-client.public-types';
+/** The headers of an API call. */
+export type ApiHeaders = Record<string, string | number | boolean>;
+/** The context of an API call. */
+export declare class ApiCallContext {
+    readonly integrationId: IntegrationId;
+    readonly endpointId: ApiEndpointId;
+    readonly url: string;
+    readonly method: HttpMethod;
+    readonly body: unknown;
+    readonly options: ApiOptions;
+}
+export interface CallApiRequest<BodyType = any> {
+    integrationId: IntegrationId;
+    endpointId: ApiEndpointId;
+    body?: BodyType;
+    overrideMethod?: HttpMethod;
+    options: ApiOptions;
+}

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

@@ -0,0 +1,18 @@
+import { IntegrationId } from '../public-types/communication.public-types';
+export type NativeQueryRequestType = 'relational' | 'mongo';
+interface BaseNativeQueryContext {
+    type: NativeQueryRequestType;
+    integrationId: IntegrationId;
+}
+export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
+    type: 'relational';
+    query: string;
+    params: Record<string, any>;
+}
+export interface MongoNativeQueryContext extends BaseNativeQueryContext {
+    type: 'mongo';
+    collectionName: string;
+    aggregationPipeline: Array<any | undefined>;
+}
+export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext;
+export {};

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

@@ -0,0 +1,127 @@
+import { FieldSort, Operator, Query, SimpleCondition } from '../public-types/query.public-types';
+import { DeepRecord, FieldOf, PartialBy, Paths } from '../public-types/typescript.public-types';
+import { CollectionName, DocumentData } from '../public-types/document.public-types';
+import { IntegrationId } from '../public-types/communication.public-types';
+/**
+ * Represents the Squid query context.
+ * Passed to methods that require query details, such as those annotated with the `@secureCollection` annotation.
+ */
+export declare class QueryContext<T extends DocumentData = any> {
+    readonly query: Query<T>;
+    /**
+     * The ID of the integration being queried.
+     */
+    get integrationId(): IntegrationId;
+    /**
+     * The name of the collection being queried.
+     */
+    get collectionName(): CollectionName;
+    /**
+     * The query limit if one exists, -1 otherwise.
+     */
+    get limit(): number;
+    /**
+     * Verifies that the query's sort order aligns with the provided field sorts. The fields specified in the `sorts`
+     * parameter must appear in the exact order at the beginning of the query's sort sequence. The query can include
+     * additional fields in its sort order, but only after the specified sorts.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts matches the provided field sorts.
+     */
+    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query's sort order exactly matches the provided field sorts. The fields specified in the
+     * `sorts` parameter must appear in the exact order in the query's sort sequence. No additional sorts may be present
+     * in the query.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts exactly match the provided field sorts.
+     */
+    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param fieldName The name of the field for the condition.
+     * @param operator The operator of the condition.
+     * @param value The value of the condition.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOf<F extends Paths<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param condition The condition to validate.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOfCondition(condition: GeneralCondition<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified conditions. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent conditions. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param conditions The conditions to validate.
+     * @returns Whether the query includes subquery of the parent conditions.
+     */
+    isSubqueryOfConditions(conditions: GeneralConditions<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified query. A subquery is defined as a query that evaluates
+     * to a subset of the results that obtained for the parent query, including sorts and limits.
+     *
+     * @param query The query to validate.
+     * @returns Whether the query is a subquery of the parent query.
+     */
+    isSubqueryOfQuery(query: Query<T>): boolean;
+    /**
+     * Returns all conditions that apply to any of the specified field names. This method
+     * provides a convenient way to retrieve all conditions that involve a specific set of fields.
+     *
+     * @param fieldNames The field names for which to retrieve conditions.
+     * @returns An array of conditions that involve any of the specified field names.
+     */
+    getConditionsFor<K extends Paths<T>>(...fieldNames: Array<K>): ContextConditions<T, K>;
+    /**
+     * Returns all conditions that apply to the specified field name. This method provides
+     * a convenient way to retrieve all conditions that involve a specific field.
+     *
+     * @param fieldName The field name for which to retrieve conditions.
+     * @returns An array of conditions that involve the specified field name.
+     */
+    getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
+    /**
+     * Returns true if the given document can be a result of the query.
+     * The method does not account for limit and sort order.
+     */
+    documentMatchesQuery(doc: DocumentData): boolean;
+}
+/** A list of context conditions */
+export type ContextConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<ContextCondition<Doc, F>>;
+/** A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'. */
+export type ContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
+export interface InContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'in'> {
+    operator: 'in';
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+export interface NotInContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'not in'> {
+    operator: 'not in';
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+export interface OtherContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, Exclude<ContextOperator, 'in' | 'not in'>> {
+    operator: Exclude<ContextOperator, 'in' | 'not in'>;
+    value: FieldOf<DeepRecord<Doc>, Paths<Doc>> | any;
+}
+/** A condition that includes the 'in' and 'not in' operators. */
+export interface GeneralCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, AllOperators> {
+    operator: AllOperators;
+    value: any;
+}
+/** A list of general conditions. */
+export type GeneralConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<GeneralCondition<Doc, F>>;
+export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
+type AllOperators = Operator | 'in' | 'not in';
+/** A generic value that can exist in a query. */
+export type GenericValue<Doc = any, F extends Paths<Doc> = Paths<Doc>, O extends AllOperators = any> = O extends 'in' ? Array<DeepRecord<Doc>[F]> | null : O extends 'not in' ? Array<DeepRecord<Doc>[F]> | null : DeepRecord<Doc>[F] | null;
+export {};

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

@@ -0,0 +1,29 @@
+import { AiChatPromptQuotas, AiConnectedAgentMetadata, AiConnectedIntegrationMetadata, AiFileUrl } from '../public-types/ai-agent.public-types';
+import { AiAgentId } from '../public-types/communication.public-types';
+import { FunctionName, FunctionNameWithContext } from '../public-types/bundle-data.public-types';
+export type AiChatResponseFormat = 'text' | 'json_object';
+export interface AiChatOptions {
+    maxTokens: number;
+    responseFormat: AiChatResponseFormat;
+    temperature: number;
+    topP: number;
+    instructions: Array<string>;
+    clientId: string;
+    fileUrls: Array<AiFileUrl>;
+    /** Constrains effort on reasoning for reasoning models. o1 models only. */
+    reasoningEffort?: 'low' | 'medium' | 'high';
+    /** Current AI profile ID (AI agent ID). */
+    agentId?: AiAgentId;
+    /** A unique chat ID for the conversation. */
+    chatId?: string;
+    /** Global per-agent context passed to all AI functions. Must be a serializable JSON. */
+    agentContext?: Record<string, unknown>;
+    /** List of AI functions available for the agent. Overrides the stored list.*/
+    functions?: Array<FunctionName | FunctionNameWithContext>;
+    /** List of connected AI agents can be called by the current agent. Overrides the stored list.*/
+    connectedAgents?: Array<AiConnectedAgentMetadata>;
+    /** List of connected integrations. Overrides the stored list. */
+    connectedIntegrations?: Array<AiConnectedIntegrationMetadata>;
+    /** Current budget for nested or recursive AI chat calls per single prompt. */
+    quotas?: AiChatPromptQuotas;
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,40 @@
+import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../public-types/ai-matchmaking.types';
+export interface MmCreateMatchMakerRequest {
+    matchMaker: MmMatchMaker;
+}
+export interface MmDeleteEntityRequest {
+    matchMakerId: string;
+    entityId: string;
+}
+export interface MmInsertEntityRequest {
+    matchMakerId: string;
+    entity: MmEntity;
+}
+export interface MmInsertEntitiesRequest {
+    matchMakerId: string;
+    entities: Array<MmEntity>;
+}
+export interface MmFindMatchesRequest {
+    matchMakerId: string;
+    entityId: string;
+    options: MmFindMatchesOptions;
+}
+export interface MmFindMatchesResponse {
+    matches: Array<MmEntityMatch>;
+}
+export interface MmFindMatchesForEntityRequest {
+    matchMakerId: string;
+    entity: Omit<MmEntity, 'metadata' | 'id'>;
+    options: MmFindMatchesOptions;
+}
+export interface MmFindMatchesForEntityResponse {
+    matches: Array<MmEntityMatch>;
+}
+export interface MmListEntitiesRequest {
+    matchMakerId: string;
+    categoryId: string;
+    options: MmListEntitiesOptions;
+}
+export interface MmDeleteMatchMakerRequest {
+    matchMakerId: string;
+}

package/dist/internal-common/src/types/backend-function.types.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export type ChatId = string;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,71 @@
+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;
+}
+export declare const AUDIT_LOG_EVENT_NAMES: readonly ["ai_agent_prompt"];
+export type AuditLogEventName = (typeof AUDIT_LOG_EVENT_NAMES)[number];
+export interface AuditLogEvent {
+    appId: AppId;
+    name: AuditLogEventName;
+    timestamp: Date;
+    context: {
+        clientId?: string;
+        userId: string;
+    };
+    tags: Record<string, 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/types/query.types.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generates the regex pattern, handling special characters as follows:
+ *  - `_` is replaced with a `.`
+ *  - `%` is replaced with `[\s\S]*`.
+ *  - The above characters can be escaped with \, eg. `\_` is replaced with `_` and `\%` with `%`.
+ *  - All special characters in regex (-, /, \, ^, $, *, +, ?, ., (, ), |, [, ], {, }) get escaped with \
+ *
+ *  Exported for testing purposes.
+ * */
+export declare function replaceSpecialCharacters(input: string): string;

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

@@ -0,0 +1,2 @@
+export declare const BACKEND_API_KEY = "_BACKEND_API_KEY";
+export declare const APP_API_KEY = "APP_API_KEY";

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

@@ -0,0 +1 @@
+export declare const SOCKET_RECONNECT_TIMEOUT: number;

package/dist/internal-common/src/types/time-units.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/utils/e2e-test-utils.d.ts

@@ -0,0 +1,2 @@
+/** Returns true if the application is run by a Playwright test. */
+export declare function isPlaywrightTestMode(): boolean | undefined;

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

@@ -0,0 +1 @@
+export declare function isTimestampEnabled(): boolean;

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

@@ -0,0 +1 @@
+export declare function getApplicationUrl(regionPrefix: string, appId: string, path: string): string;

package/dist/internal-common/src/utils/lock.manager.d.ts

@@ -0,0 +1,14 @@
+type LockMutex = string;
+/**
+ * A simple lock manager that locks a list of mutexes.
+ * When locking a list of mutexes, the lock will start only when all the mutexes are available - preventing partial lock
+ * and potential deadlocks.
+ */
+export declare class LockManager {
+    private readonly locks;
+    lock(...mutexes: LockMutex[]): Promise<void>;
+    release(...mutexes: LockMutex[]): void;
+    canGetLock(...mutexes: LockMutex[]): boolean;
+    lockSync(...mutexes: LockMutex[]): void;
+}
+export {};

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

@@ -0,0 +1,4 @@
+import { QueryMetricsRequestCommon, QueryMetricsResultGroup } from '../public-types/metric.public-types';
+export type QueryMetricsRequestIntervals = Required<Pick<QueryMetricsRequestCommon, 'fillValue' | 'fn' | 'groupByTags' | 'periodEndSeconds' | 'periodStartSeconds' | 'pointIntervalAlignment' | 'pointIntervalSeconds' | 'tagDomains' | 'noDataBehavior'>>;
+/** Adds missed known tag domain groups and fills all missed points with a request.fillValue. */
+export declare function fillMissedPoints(request: QueryMetricsRequestIntervals, resultGroups: Array<QueryMetricsResultGroup>): void;

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/internal-common/src/utils/object.d.ts

@@ -0,0 +1,49 @@
+/** Returns a value by the `path`. Works with array indexes, like a.b[0]. */
+export declare function getInPath(obj: unknown, path: string): any;
+export declare function isDateObject(value: unknown): value is Date;
+/** Sets a value by path . Does not support array indexes. */
+export declare function setInPath(obj: object, path: string, value: unknown, delimiter?: string): void;
+export declare function deleteInPath(obj: object, path: string, delimiter?: string): void;
+export declare function replaceKeyInMap<K, T>(map: Map<K, T | undefined>, a: K, b: K): void;
+export declare function replaceKeyInRecord<K extends keyof any, T>(record: Record<K, T>, a: K, b: K): void;
+export declare function isNil(obj: unknown): obj is null | undefined;
+export declare function isEqual(a: unknown, b: unknown): boolean;
+export declare function isEmpty(a: unknown): boolean;
+export declare function omit<T extends object, K extends PropertyKey[]>(object: T | null | undefined, ...fieldsToRemove: K): Pick<T, Exclude<keyof T, K[number]>>;
+export type CloneCustomizer = (value: unknown) => unknown | undefined;
+/**
+ * Creates a deep copy of the specified object, including all nested objects and specifically handling Date, Map, and
+ * Set fields.
+ *
+ * The customizer function can modify the cloning process for the object and its fields. If the customizer
+ * returns 'undefined' for any input, the function falls back to the standard cloning logic.
+ *
+ * The cloning process is recursive, ensuring deep cloning of all objects.
+ *
+ * Note: This function does not support cloning objects with circular dependencies and will throw a system stack
+ * overflow error if encountered.
+ */
+export declare function cloneDeep<R = unknown>(value: R, customizer?: CloneCustomizer): R;
+/** Creates a shallow clone of the object. */
+export declare function cloneShallow<T>(value: T): T;
+export declare function deepMerge<T extends object, U extends object>(target: T, source: U): T & U;
+/** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
+export declare function compareValues(v1: unknown, v2: unknown): number;
+/** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
+export declare function mapValues<ResultType extends object = Record<string, unknown>, InputType extends Record<string, unknown> = Record<string, unknown>>(obj: InputType, valueMapperFn: (value: any, key: keyof InputType, obj: InputType) => unknown): ResultType;
+/** Groups elements of the array by key. See _.groupBy for details. */
+export declare function groupBy<T, K extends PropertyKey>(array: T[], getKey: (item: T) => K): Record<K, T[]>;
+/**
+ * Picks selected fields from the object and returns a new object with the fields selected.
+ * The selected fields are assigned by reference (there is no cloning).
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: ReadonlyArray<K>): Pick<T, K>;
+/** Inverts the record: swaps keys and values. */
+export declare function invert<K extends string | number, V extends string | number>(record: Record<K, V>): Record<V, K>;
+/**
+ * Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end.
+ * If end is less than start a zero-length range is created unless a negative step is specified.
+ *
+ * Same as lodash range but with an additional parameter: `maximumNumberOfItems`.
+ */
+export declare function range(start: number, end: number, step: number, maximumNumberOfItems?: number): number[];

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

@@ -0,0 +1,5 @@
+export declare function normalizeJsonAsString(json: unknown): string;
+export declare function serializeObj(obj: unknown): string;
+export declare function deserializeObj<T = any>(str: string): T;
+export declare function encodeValueForMapping(value: unknown): string;
+export declare function decodeValueForMapping(encodedString: string): any;

package/dist/internal-common/src/utils/squid.constants.d.ts

@@ -0,0 +1 @@
+export declare const SQUID_SUPPORT_EMAIL = "support@getsquid.ai";

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

@@ -0,0 +1,20 @@
+import { HttpStatus } from '../public-types/http-status.enum';
+export type StatusCode = HttpStatus.BAD_REQUEST | HttpStatus.NOT_FOUND | HttpStatus.FORBIDDEN | HttpStatus.UNAUTHORIZED | HttpStatus.CONFLICT | HttpStatus.INTERNAL_SERVER_ERROR;
+export declare class ValidationError extends Error {
+    readonly statusCode: StatusCode;
+    readonly details?: any;
+    constructor(error: string, statusCode: StatusCode, details?: Record<string, any>);
+}
+export declare function isValidId(id: unknown, maxLength?: number): boolean;
+export declare function validateFieldSort(fieldSort: unknown): void;
+export declare function validateQueryLimit(limit: unknown): void;
+/**
+ * All type names returned by 'typeof' supported by JavaScript:
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof}.
+ * and a few other supported types.
+ */
+export type JavascriptTypeName = 'undefined' | 'object' | 'boolean' | 'number' | 'bigint' | 'string' | 'symbol' | 'function';
+/** Returns true if 'typeof' of the 'value' is 'type' or 'type[]'. */
+export declare function isRightType(value: unknown, type: JavascriptTypeName): boolean;
+/** Returns true if 'obj' has only keys listed in the 'keys'. Object can't be an array. */
+export declare function hasOnlyKeys(obj: object, keys: string[]): boolean;

package/dist/internal-common/src/websocket.impl.d.ts

@@ -0,0 +1,26 @@
+interface Options {
+    maxAttempts?: number;
+    protocols?: string[];
+    onmessage?: (event: any) => void;
+    onopen?: (event: any) => void;
+    onclose?: (event: any) => void;
+    onerror?: (event: any) => void;
+    onreconnect?: (event: any) => void;
+    onmaximum?: (event: any) => void;
+    timeoutMillis?: number;
+}
+export interface WebSocketWrapper {
+    open: () => void;
+    reconnect: (e: any) => void;
+    json: (x: any) => void;
+    send: (x: string) => void;
+    close: (x?: number, y?: string) => void;
+    connected: boolean;
+    /**
+     * Websocket is explicitly closed by calling socket.close().
+     * Used to ignore errors after socket.closed() is called.
+     */
+    closeCalled: boolean;
+}
+export declare function createWebSocketWrapper(url: string, opts?: Options): WebSocketWrapper;
+export {};

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

@@ -1,4 +1,4 @@
-import { AiAgentChatOptions, AiAgentContext, AiAgentId, AiAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResponse, AiStatusMessage, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse, MUTABLE_AI_AGENT_METADATA_FIELDS } from './public-types';
+import { AiAgentChatOptions, AiContext, AiAgentId, AiAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResponse, AiStatusMessage, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse, MUTABLE_AI_AGENT_METADATA_FIELDS } from './public-types';
 import { Observable } from 'rxjs';
 import { BlobAndFilename } from './types';
 export interface TranscribeAndChatResponse {
@@ -67,13 +67,13 @@ export declare class AiAgentClient {
 }
 export interface AiChatBotContextData {
     title: string;
-    context: AiAgentContext;
+    context: AiContext;
 }
 export interface AiChatBotContextDataWithId extends AiChatBotContextData {
     id?: string;
 }
 export type AiAgentData = Pick<AiAgentMetadata, (typeof MUTABLE_AI_AGENT_METADATA_FIELDS)[number]>;
-export interface InstructionData {
+export interface AiInstructionData {
     instruction: string;
 }
 export declare class AiAgentReference {
@@ -208,7 +208,7 @@ export declare class AiAgentInstructionReference {
      * @param data.instruction - The instruction data.
      * @returns A promise that resolves when the instruction entry is successfully created.
      */
-    insert(data: InstructionData): Promise<void>;
+    insert(data: AiInstructionData): Promise<void>;
     /**
      * Updates an existing instruction entry for the agent.
      * Throws an error if an entry with the specified instruction ID does not exist.
@@ -217,7 +217,7 @@ export declare class AiAgentInstructionReference {
      * @param data.instruction - The instruction data.
      * @returns A promise that resolves when the instruction entry is successfully updated.
      */
-    update(data: InstructionData): Promise<void>;
+    update(data: AiInstructionData): Promise<void>;
     /**
      * Deletes an existing instruction entry for the agent.
      * Throws an error if an entry with the specified instruction ID does not exist.
@@ -226,11 +226,3 @@ export declare class AiAgentInstructionReference {
      */
     delete(): Promise<void>;
 }
-export declare class AiChatbotProfileReference extends AiAgentReference {
-}
-export declare class AiChatbotClient extends AiAgentClient {
-}
-export declare class AiChatbotContextReference extends AiAgentContextReference {
-}
-export declare class AiChatbotInstructionReference extends AiAgentInstructionReference {
-}