@squidcloud/client 1.0.364 → 1.0.365

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

@@ -1,6 +1,15 @@
 import { AiAgentId, AiContextId, IntegrationId } from './communication.public-types';
 import { IntegrationType } from './integration.public-types';
 import { AiFunctionId, AiFunctionIdWithContext } from './backend.public-types';
+import { SecretKey } from './secret.public-types';
+/** List of available AI provider types. See AiProviderType. */
+export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "flux", "gemini", "openai", "squid", "stability", "voyage"];
+/**
+ * Type of the AI provider.
+ * References a single AI service, regardless of the model or other AI function it provides (like
+ * chat/search/transcribe etc...).
+ */
+export type AiProviderType = (typeof AI_PROVIDER_TYPES)[number];
 /**
  * The supported OpenAI models.
  * @category AI
@@ -787,4 +796,9 @@ export interface AiTranscribeAndAskResponse {
     /** The transcribed text from the audio input. */
     transcribedPrompt: string;
 }
+/** Per application AI settings. */
+export interface ApplicationAiSettings {
+    /** Maps AI provider name to API key secret name that must be used for any request made by the application. */
+    apiKeys: Partial<Record<AiProviderType, SecretKey>>;
+}
 export {};

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

@@ -1,5 +1,5 @@
 import { AiAssistantClient } from './ai-assistant-client';
-import { AiAgent, AiAgentId, IntegrationId } from './public-types';
+import { AiAgent, AiAgentId, AiProviderType, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
 import { AiImageClient } from './ai-image-client';
 import { AiAudioClient } from './ai-audio-client';
 import { AiMatchMakingClient } from './ai-matchmaking-client';
@@ -83,4 +83,18 @@ export declare class AiClient {
      * Allows specifying allowed endpoints and whether to provide an explanation.
      */
     executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean): Promise<ExecuteAiApiResponse>;
+    /**
+     * Returns name of the secret that stores API key for the given AI provider type.
+     * This API key is used for all requests to the AI provider done from the application.
+     */
+    getApplicationAiSettings(): Promise<ApplicationAiSettings>;
+    /** Sets new application AI settings. Overwrites the existing value. */
+    setApplicationAiSettings(settings: ApplicationAiSettings): Promise<void>;
+    /**
+     * Sets the name of the secret that stores API key for the given AI provider type.
+     * This API key is used for all requests to the AI provider done from the application.
+     * To delete the existing secret key use 'undefined' for the name of the secret.
+     * Returns the updated state of the AI application settings.
+     */
+    setAiProviderApiKeySecret(providerType: AiProviderType, secretKey: SecretKey | undefined): Promise<ApplicationAiSettings>;
 }

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

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

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.getsquid.ai/docs/client-sdk/database/document-reference documentation}.
+ * {@link https://docs.getsquid.ai/docs/sdk/client-sdk/database/document-reference documentation}.
  * @typeParam T The type of the document data.
  * @category Database
  */

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

@@ -25,6 +25,8 @@ export declare class ExtractionClient {
     /**
      * Creates a PDF document from the provided request parameters.
      * @param request - The request containing details for PDF creation, such as content or url.
+     * @return A promise that resolves with the response containing the URL of the created PDF. The url will expire after
+     *   1 hour.
      */
     createPdf(request: CreatePdfRequest): Promise<CreatePdfResponse>;
 }

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

@@ -71,7 +71,7 @@ export interface HasGrouped {
 /**
  * A query builder that can participate in a join.
  * To learn more about join queries, see the
- * {@link https://docs.getsquid.ai/docs/client-sdk/database/queries#joining-data-across-collections-and-integrations
+ * {@link https://docs.getsquid.ai/docs/sdk/client-sdk/database/queries#joining-data-across-collections-and-connectors
  * documentation}.
  * @category Database
  */

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

@@ -89,7 +89,6 @@ export interface SquidAuthProvider {
 export declare class Squid {
     readonly options: SquidOptions;
     private readonly socketManager;
-    private readonly rpcManager;
     private readonly dataManager;
     private readonly documentReferenceFactory;
     private readonly documentStore;
@@ -153,7 +152,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.getsquid.ai/docs/client-sdk/database/collection-reference documentation}.
+     * {@link https://docs.getsquid.ai/docs/sdk/client-sdk/database/collection-reference documentation}.
      *
      * @param collectionName The name of the collection.
      * @param integrationId The id of the integration, default to `built_in_db`.
@@ -166,7 +165,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.getsquid.ai/docs/client-sdk/database/transactions documentation}.
+     * {@link https://docs.getsquid.ai/docs/sdk/client-sdk/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.
@@ -179,7 +178,7 @@ export declare class Squid {
      * the result.
      *
      * For detailed information on backend functions in Squid, see the
-     * {@link https://docs.getsquid.ai/docs/backend/executables/ documentation}.
+     * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/executables documentation}.
      *
      * Files support:
      * - To send a file to the backend, simply include it as one of the parameters; it will be received as a `SquidFile`
@@ -195,7 +194,7 @@ export declare class Squid {
     executeFunction<T = any>(functionNameOrOptions: string | ExecuteFunctionOptions<T>, ...params: Array<any | File>): Promise<T>;
     /**
      * Executes a native relational query with the given parameters and returns a promise with the result.
-     * See https://docs.getsquid.ai/docs/client-sdk/database/native-queries.
+     * See https://docs.getsquid.ai/docs/sdk/client-sdk/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.
@@ -205,7 +204,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.getsquid.ai/docs/client-sdk/database/native-queries#native-mongodb-queries.
+     * See https://docs.getsquid.ai/docs/sdk/client-sdk/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.
@@ -215,7 +214,7 @@ export declare class Squid {
     executeNativeMongoQuery<T = any>(integrationId: IntegrationId, collectionName: string, aggregationPipeline: Array<any | undefined>): Promise<Array<T>>;
     /**
      * Executes a native Elasticsearch query against the given index and endpoint.
-     * See https://docs.getsquid.ai/docs/client-sdk/database/native-queries#native-elasticsearch-queries.
+     * See https://docs.getsquid.ai/docs/sdk/client-sdk/database/native-queries.
      *
      * @param integrationId  The id of the integration that the query is associated with.
      * @param index          The Elasticsearch index to query.

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

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.364";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.365";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.364",
+  "version": "1.0.365",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

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

@@ -1,9 +0,0 @@
-/**
- * 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_aiContextUpsert_count", "squid_aiContextDelete_count", "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-backend/api-call.public-context.d.ts

@@ -1,30 +0,0 @@
-import { ApiEndpointId, HttpMethod } from '../public-types/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;
-}
-/**
- * Represents a request to call an API through a specified integration and endpoint.
- * Includes optional method override and additional request options.
- */
-export interface CallApiRequest<BodyType = any> {
-    /** The identifier of the integration through which the API is called. */
-    integrationId: IntegrationId;
-    /** Target API endpoint to invoke. */
-    endpointId: ApiEndpointId;
-    /** Optional request payload. */
-    body?: BodyType;
-    /** Optional HTTP method override. Default is POST. */
-    overrideMethod?: HttpMethod;
-    /** Additional request options. */
-    options: ApiOptions;
-}

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

@@ -1,148 +0,0 @@
-import { Paths } from '../public-types/typescript.public-types';
-import { SquidDocIdObj, SquidDocument } from '../public-types/document.public-types';
-/**
- * The mutation type.
- * @category Database
- */
-export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
-/**
- * @category Database
- */
-export type MutationType = (typeof MUTATION_TYPES)[number];
-interface BaseMutation {
-    type: MutationType;
-    squidDocIdObj: SquidDocIdObj;
-}
-/**
- * A mutation on a document.
- * @category Database
- */
-export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
-/**
- * Represents a delete mutation on a document.
- * @category Database
- */
-export interface DeleteMutation extends BaseMutation {
-    /** Specifies that the mutation is a deletion. */
-    type: 'delete';
-}
-/**
- * Represents an update mutation on a document.
- * @category Database
- */
-export interface UpdateMutation<T = any> extends BaseMutation {
-    /** Specifies that the mutation is an update. */
-    type: 'update';
-    /** The updated properties */
-    properties: {
-        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
-    };
-}
-/**
- * Represents an insert mutation on a document.
- * @category Database
- */
-export interface InsertMutation<T = any> extends BaseMutation {
-    /** Specifies that the mutation is an insertion. */
-    type: 'insert';
-    /** The inserted document */
-    properties: T;
-}
-/**
- * A representation of a single property update.
- * @category Database
- */
-export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
-/**
- * A value update property mutation.
- * @category Database
- */
-export interface ValueUpdatePropertyMutation<Value = any> {
-    /** Specifies that the mutation updates a value. */
-    type: 'update';
-    /** New value to be set. */
-    value: Value;
-}
-/**
- * Applying a numeric function to a property.
- * @category Database
- */
-export interface ApplyNumericFnPropertyMutation {
-    /** Specifies that the mutation applies a numeric function. */
-    type: 'applyNumericFn';
-    /** Numeric function to apply. */
-    fn: 'increment';
-    /** Value to use in the numeric function. */
-    value: number;
-}
-/**
- * A property update that removes a property from a document.
- * @category Database
- */
-export interface RemovePropertyMutation {
-    /** Specifies that the mutation removes a property. */
-    type: 'removeProperty';
-}
-interface ApplyExtendString {
-    /** Specifies that the mutation applies a string function. */
-    type: 'applyStringFn';
-    /** String function to extend the existing string. */
-    fn: 'extendString';
-    /** String value to append. */
-    value: string;
-}
-interface ApplyTrimString {
-    /** Specifies that the mutation applies a string function. */
-    type: 'applyStringFn';
-    /** String function to trim the existing string. */
-    fn: 'trim';
-}
-/**
- * A property mutation that modifies a string.
- * @category Database
- */
-export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
-/**
- * The before and after documents of a document change.
- * @category Database
- */
-export interface BeforeAndAfterDocs<T = SquidDocument> {
-    /** Document state before the mutation. */
-    before: T | undefined;
-    /** Document state after the mutation. */
-    after: T | undefined;
-}
-/**
- * The mutation context that will be provided to the security function.
- * @category Database
- */
-export declare class MutationContext<T = any> {
-    readonly mutation: Mutation<T>;
-    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
-    readonly serverTimeStamp: Date;
-    /**
-     * Returns the type of the mutation (insert, update, or delete).
-     */
-    getMutationType(): MutationType;
-    /**
-     * Returns the state of the document before the mutation was applied.
-     */
-    get before(): T | undefined;
-    /**
-     * Returns the state of the document after the mutation was applied.
-     */
-    get after(): T | undefined;
-    /** Returns true if the mutation affects the provided path. */
-    affectsPath(path: Paths<T>): boolean;
-    /**
-     * Find all affected paths starting from a root path.
-     *
-     * @example
-     * doc before - { a: { b: 1, c: 2 }, d: 3 }
-     * doc after - { a: { b: 1, c: 3 }, d: 4 }
-     * doc.affectedPaths('a') // ['a.c']
-     */
-    affectedPaths(startingRoot?: Paths<T> | string): Array<Paths<T>>;
-    private checkPath;
-}
-export {};

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

@@ -1,60 +0,0 @@
-import { IntegrationId } from '../public-types/communication.public-types';
-/**
- * Represents the type of native query request, either relational or MongoDB.
- * @category Database
- */
-export type NativeQueryRequestType = 'relational' | 'mongo';
-interface BaseNativeQueryContext {
-    /** Type of the native query request. */
-    type: NativeQueryRequestType;
-    /** Identifier for the integration. */
-    integrationId: IntegrationId;
-}
-/**
- * Context for executing a relational database query.
- * @category Database
- */
-export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
-    /** Specifies that the query is for a relational database. */
-    type: 'relational';
-    /** SQL query string to be executed. */
-    query: string;
-    /** Parameters to be used in the query. */
-    params: Record<string, any>;
-}
-/**
- * Context for executing a MongoDB query.
- * @category Database
- */
-export interface MongoNativeQueryContext extends BaseNativeQueryContext {
-    /** Specifies that the query is for a Mongo database. */
-    type: 'mongo';
-    /** Name of the MongoDB collection to query. */
-    collectionName: string;
-    /** Array of aggregation pipeline stages. */
-    aggregationPipeline: Array<any | undefined>;
-}
-/**
- * Context for executing an Elasticsearch query.
- * @category Database
- */
-export interface ElasticsearchNativeQueryContext {
-    /** Specifies that the query is for an Elasticsearch database. */
-    type: 'elasticsearch';
-    /** Elasticsearch index to query. */
-    index: string;
-    /** Elasticsearch query string. */
-    endpoint?: string;
-    /** HTTP method to use for the request. */
-    method?: 'GET' | 'POST';
-    /** Body of the request. */
-    body: Record<string, any>;
-    /** Headers to include in the request. */
-    integrationId: IntegrationId;
-}
-/**
- * Union type representing either a relational or MongoDB native query context.
- * @category Database
- */
-export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext;
-export {};

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

@@ -1,166 +0,0 @@
-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.
- * @category Database
- */
-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.
- * @category Database
- */
-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'.
- * @category Database
- */
-export type ContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
-/**
- * A condition using the 'in' operator to match values within a set.
- * @category Database
- */
-export interface InContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'in'> {
-    /** Specifies the 'in' operator to check if a value exists within an array. */
-    operator: 'in';
-    /** An array of values to match against the field. */
-    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
-}
-/**
- * A condition using the 'not in' operator to exclude values within a set.
- * @category Database
- */
-export interface NotInContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'not in'> {
-    /** Specifies the 'not in' operator to check if a value does not exist within an array. */
-    operator: 'not in';
-    /** An array of values to exclude from the field. */
-    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
-}
-/**
- * A condition using operators other than 'in' or 'not in' for field comparisons.
- * @category Database
- */
-export interface OtherContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, Exclude<ContextOperator, 'in' | 'not in'>> {
-    /** The operator to use for the comparison, excluding 'in' and 'not in'. */
-    operator: Exclude<ContextOperator, 'in' | 'not in'>;
-    /** The value to compare against the field. */
-    value: FieldOf<DeepRecord<Doc>, Paths<Doc>> | any;
-}
-/**
- * A condition that includes all operators, including 'in' and 'not in', for general use.
- * @category Database
- */
-export interface GeneralCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, AllOperators> {
-    /** The operator to apply to the condition, including all possible operators. */
-    operator: AllOperators;
-    /** The value to use in the condition comparison. */
-    value: any;
-}
-/**
- * A list of general conditions.
- * @category Database
- */
-export type GeneralConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<GeneralCondition<Doc, F>>;
-/**
- * @category Database
- */
-export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
-type AllOperators = Operator | 'in' | 'not in';
-/**
- * A generic value that can exist in a query.
- * @category Database
- */
-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 {};