@squidcloud/client 1.0.299 → 1.0.301

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

@@ -1,5 +1,6 @@
 import { FunctionName, FunctionNameWithContext } from './bundle-data.public-types';
 import { IntegrationId } from './communication.public-types';
+import { AiChatPromptQuotas, AiConnectedAgentMetadata } from '../types/ai-chatbot.types';
 /** The supported OpenAI models */
 export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1-preview", "o1-mini"];
 export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-1.5-pro", "gemini-1.5-flash"];
@@ -146,6 +147,10 @@ export interface AiChatbotChatOptions {
     contextMetadataFilter?: AiContextMetadataFilter;
     /** The options to use for the response in voice. */
     voiceOptions?: AiAudioCreateSpeechOptions;
+    /** List of connected AI agents can be called by the current agent. */
+    connectedAgents?: Array<AiConnectedAgentMetadata>;
+    /** Current budget for nested or recursive AI chat calls per single prompt. */
+    quotas?: AiChatPromptQuotas;
 }
 export interface AiAskResponse {
     responseString: string;

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

@@ -1,5 +1,6 @@
 import { AiChatModelName, AiEmbeddingsModelName, VectorDbType } from '../ai-chatbot.public-types';
 import { FunctionName } from '../bundle-data.public-types';
+import { AiConnectedAgentMetadata } from '../../types/ai-chatbot.types';
 export type AiChatbotConfiguration = {
     apiKey?: string;
 };
@@ -15,6 +16,8 @@ export type AiChatbotProfileMetadata = {
     vectorDbType?: VectorDbType;
     /** List of AI functions attached to the profile by default. */
     functions?: Array<FunctionName>;
+    /** List of child AI profiles (agents) that can be used by the current agent. */
+    connectedProfiles?: Array<AiConnectedAgentMetadata>;
     auditLog?: boolean;
 };
 export type AiChatbotContextMetadata = {
@@ -23,3 +26,6 @@ export type AiChatbotContextMetadata = {
     preview: boolean;
     sizeBytes?: number;
 };
+export type MutableAiChatbotProfileMetadataFieldsType = keyof Pick<AiChatbotProfileMetadata, 'modelName' | 'isPublic' | 'functions' | 'connectedProfiles'>;
+/** List of fields that can be updated in runtime via API. */
+export declare const MUTABLE_AI_CHATBOT_PROFILE_METADATA_FIELDS: Array<MutableAiChatbotProfileMetadataFieldsType>;

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

@@ -35,9 +35,10 @@ export interface CompositeCondition<Doc extends DocumentData = any> {
 }
 export declare function isSimpleCondition(condition: Condition): condition is SimpleCondition;
 type CompositeConditionOperator = '>=' | '<=' | '>' | '<';
+export declare const ARRAY_OPERATORS: Array<string>;
+export declare const ALL_OPERATORS: Array<string>;
 /** An operator in a query condition. */
-export type Operator = '==' | '!=' | CompositeConditionOperator | 'like' | 'not like' | 'like_cs' | 'not like_cs' | 'array_includes_some' | 'array_includes_all' | 'array_not_includes';
-export declare const ALL_OPERATORS: Array<Operator>;
+export type Operator = (typeof ALL_OPERATORS)[number];
 /** A definition of a sort by a filed. */
 export interface FieldSort<Doc> {
     fieldName: FieldName<Doc>;

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

@@ -16,4 +16,27 @@ export interface AiChatOptions {
     agentContext?: Record<string, unknown>;
     /** List of AI functions available for the chatbot. */
     functions?: Array<FunctionName | FunctionNameWithContext>;
+    /** List of connected AI agents can be called by the current agent. */
+    connectedAgents?: Array<AiConnectedAgentMetadata>;
+    /** Current budget for nested or recursive AI chat calls per single prompt. */
+    quotas?: AiChatPromptQuotas;
+}
+export interface AiConnectedAgentMetadata {
+    agentId: AiAgentId;
+    /**
+     * Description of the connected agent for the parent agent context.
+     * Works as AI function description.
+     */
+    description: string;
+}
+/** Quotas for a single AI chat prompt (`ask()` method call). */
+export interface AiChatPromptQuotas {
+    /**
+     * Maximum depth of AI call recursion allowed.
+     * Recursion occurs when one AI agent calls another.
+     * Note that, for simplicity of implementation, this option guarantees only the maximum recursion depth,
+     * not the total number of nested AI calls.
+     * Default: 5.
+     */
+    maxAiCallStackSize: number;
 }

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

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

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

@@ -1,4 +1,4 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiProfileId, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse } from './public-types';
+import { AiChatbotChatOptions, AiChatbotContext, AiChatbotProfileMetadata, AiProfileId, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse, MUTABLE_AI_CHATBOT_PROFILE_METADATA_FIELDS } from './public-types';
 import { Observable } from 'rxjs';
 import { BlobAndFilename } from './types';
 export interface TranscribeAndChatResponse {
@@ -66,11 +66,7 @@ export interface AiChatBotContextData {
     title: string;
     context: AiChatbotContext;
 }
-export interface ProfileData {
-    modelName: AiChatModelName;
-    /** If the profile is public, there is no need to write a security rule to access the chat functionality. This can be dangerous, use with caution. */
-    isPublic: boolean;
-}
+export type AiProfileData = Pick<AiChatbotProfileMetadata, (typeof MUTABLE_AI_CHATBOT_PROFILE_METADATA_FIELDS)[number]>;
 export interface InstructionData {
     instruction: string;
 }
@@ -125,7 +121,7 @@ export declare class AiAgentReference {
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully created.
      */
-    insert(data: ProfileData): Promise<void>;
+    insert(data: AiProfileData): Promise<void>;
     /**
      * Updates an existing chatbot profile. This will result in an error if a profile has not yet been created for the
      * current profile id.
@@ -136,7 +132,7 @@ export declare class AiAgentReference {
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully updated.
      */
-    update(data: Partial<ProfileData>): Promise<void>;
+    update(data: Partial<AiProfileData>): Promise<void>;
     /**
      * Deletes an existing chatbot profile. This will result in an error if a profile has not yet been created for the
      * current profile id.

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

@@ -22,6 +22,7 @@ export * from './mutation/mutation-sender';
 export * from './native-query-manager';
 export * from './public-types';
 export * from './public-utils';
+export * from './query-utils';
 export * from './query/deserializer';
 export * from './query/join-query-builder.factory';
 export * from './query/local-query-manager';

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

@@ -87,7 +87,9 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * A shortcut for where(fieldName, 'like', pattern).
      *
      * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one
+     *   character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%',
+     *   '_', or '\' is invalid.
      * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */
@@ -96,7 +98,9 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * A shortcut for where(fieldName, 'not like', pattern).
      *
      * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one
+     *   character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%',
+     *   '_', or '\' is invalid.
      * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */
@@ -153,7 +157,7 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     private readonly documentIdentityService;
     private forceFetchFromServer;
     /** @inheritDoc */
-    where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator, value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /** @inheritDoc */
     limit(limit: number): this;
     getLimit(): number;

package/dist/typescript-client/src/query-utils.d.ts

@@ -0,0 +1,14 @@
+import { DocumentData } from '../../internal-common/src/public-types/document.public-types';
+import { QueryBuilder } from './query/query-builder.factory';
+/** Result of the `visitQueryResults` function. */
+export interface VisitQueryResultsStats {
+    /** Count of documents visited. */
+    count: number;
+    /** Time in millis spent in the function. */
+    time: number;
+}
+/**
+ * Reads all objects from the query in a safe way (with pagination) and calls callback() on every object.
+ * The iteration is interrupted if error is thrown.
+ */
+export declare function visitQueryResults<T extends DocumentData>(query: QueryBuilder<T>, callback: (t: T) => Promise<unknown>, pageSize?: number): Promise<VisitQueryResultsStats>;

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.299";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.301";

package/package.json

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