@squidcloud/client 1.0.78 → 1.0.80

package/dist/common/src/integrations/index.d.ts

@@ -1,101 +1,101 @@
-export * from './ai_assistant.types';
-export * from './api.types';
-export * from './auth.types';
-export * from './database.types';
-export * from './observability.types';
-import { IntegrationId } from '../communication.types';
-import { AiAssistantIntegrationConfig } from './ai_assistant.types';
-import { GraphQLIntegrationConfig, HttpApiIntegrationConfig, TestGraphQLDataConnectionRequest } from './api.types';
-import { Auth0IntegrationConfig, CognitoIntegrationConfig, JwtHmacIntegrationConfig, JwtRsaIntegrationConfig, OktaIntegrationConfig } from './auth.types';
-import { BaseDatabaseIntegrationConfig, CockroachIntegrationConfig, InternalIntegrationConfig, MongoIntegrationConfig, MssqlIntegrationConfig, MySqlIntegrationConfig, OracleIntegrationConfig, PostgresIntegrationConfig, SnowflakeIntegrationConfig, TestDataConnectionRequest } from './database.types';
-import { DatadogIntegrationConfig, NewRelicIntegrationConfig } from './observability.types';
-export declare enum IntegrationCategory {
-    'database' = "database",
-    'api' = "api",
-    'observability' = "observability",
-    'crm' = "crm",
-    'auth' = "auth",
-    'ai' = "ai"
-}
-export declare enum IntegrationType {
-    'built_in_db' = "built_in_db",
-    'mongo' = "mongo",
-    'mysql' = "mysql",
-    'mssql' = "mssql",
-    'postgres' = "postgres",
-    'cockroach' = "cockroach",
-    'api' = "api",
-    'graphql' = "graphql",
-    'snowflake' = "snowflake",
-    'datadog' = "datadog",
-    'newrelic' = "newrelic",
-    'auth0' = "auth0",
-    'jwt_rsa' = "jwt_rsa",
-    'jwt_hmac' = "jwt_hmac",
-    'ai_assistant' = "ai_assistant",
-    'cognito' = "cognito",
-    'okta' = "okta",
-    'algolia' = "algolia",
-    'elastic_observability' = "elastic_observability",
-    'elastic_search' = "elastic_search",
-    'elastic_enterprise_search' = "elastic_enterprise_search",
-    'sentry' = "sentry",
-    'sap_hana' = "sap_hana",
-    'salesforce_crm' = "salesforce_crm",
-    'documentdb' = "documentdb",
-    'dynamodb' = "dynamodb",
-    'cassandra' = "cassandra",
-    'clickhouse' = "clickhouse",
-    'alloydb' = "alloydb",
-    'spanner' = "spanner",
-    'db2' = "db2",
-    'mariadb' = "mariadb",
-    'oracledb' = "oracledb",
-    'redis' = "redis",
-    'xata' = "xata",
-    'azure_sql' = "azure_sql"
-}
-export interface IntegrationConfigTypes {
-    [IntegrationType.built_in_db]: InternalIntegrationConfig;
-    [IntegrationType.mongo]: MongoIntegrationConfig;
-    [IntegrationType.mysql]: MySqlIntegrationConfig;
-    [IntegrationType.oracledb]: OracleIntegrationConfig;
-    [IntegrationType.mssql]: MssqlIntegrationConfig;
-    [IntegrationType.postgres]: PostgresIntegrationConfig;
-    [IntegrationType.cockroach]: CockroachIntegrationConfig;
-    [IntegrationType.snowflake]: SnowflakeIntegrationConfig;
-    [IntegrationType.api]: HttpApiIntegrationConfig;
-    [IntegrationType.graphql]: GraphQLIntegrationConfig;
-    [IntegrationType.datadog]: DatadogIntegrationConfig;
-    [IntegrationType.newrelic]: NewRelicIntegrationConfig;
-    [IntegrationType.auth0]: Auth0IntegrationConfig;
-    [IntegrationType.jwt_rsa]: JwtRsaIntegrationConfig;
-    [IntegrationType.jwt_hmac]: JwtHmacIntegrationConfig;
-    [IntegrationType.ai_assistant]: AiAssistantIntegrationConfig;
-    [IntegrationType.cognito]: CognitoIntegrationConfig;
-    [IntegrationType.okta]: OktaIntegrationConfig;
-}
-export declare const DatabaseIntegrationTypes: readonly [IntegrationType.built_in_db, IntegrationType.mongo, IntegrationType.mysql, IntegrationType.mssql, IntegrationType.postgres, IntegrationType.cockroach, IntegrationType.snowflake, IntegrationType.oracledb];
-export type DatabaseIntegrationType = (typeof DatabaseIntegrationTypes)[number];
-export type DatabaseIntegrationConfig = IntegrationConfigTypes[DatabaseIntegrationType];
-export declare const ApiIntegrationTypes: readonly [IntegrationType.api, IntegrationType.graphql];
-export declare const ObservabilityIntegrationTypes: readonly [IntegrationType.datadog, IntegrationType.newrelic];
-export declare const AuthIntegrationTypes: readonly [IntegrationType.auth0, IntegrationType.jwt_rsa, IntegrationType.jwt_hmac, IntegrationType.cognito, IntegrationType.okta];
-export type ApiIntegrationType = (typeof ApiIntegrationTypes)[number];
-export type ApiIntegrationConfig = IntegrationConfigTypes[ApiIntegrationType];
-export type ObservabilityIntegrationType = (typeof ObservabilityIntegrationTypes)[number];
-export type ObservabilityIntegrationConfig = IntegrationConfigTypes[ObservabilityIntegrationType];
-export type AuthIntegrationType = (typeof AuthIntegrationTypes)[number];
-export type AuthIntegrationConfig = IntegrationConfigTypes[AuthIntegrationType];
-export declare function isDataIntegrationType(type: IntegrationType): type is DatabaseIntegrationType;
-export declare function isDataIntegration(integration: any): integration is BaseDatabaseIntegrationConfig;
-export declare function isAuthIntegrationType(type: IntegrationType): type is AuthIntegrationType;
-export declare function isAuthIntegration(integration: any): integration is AuthIntegrationConfig;
-export type IntegrationConfig = DatabaseIntegrationConfig | ApiIntegrationConfig | ObservabilityIntegrationConfig | AuthIntegrationConfig | AiAssistantIntegrationConfig;
-export interface BaseIntegrationConfig {
-    id: IntegrationId;
-    type: IntegrationType;
-    creationDate: Date;
-    updateDate: Date;
-}
-export type TestConnectionRequest = TestDataConnectionRequest | TestGraphQLDataConnectionRequest;
+export * from './ai_assistant.types';
+export * from './api.types';
+export * from './auth.types';
+export * from './database.types';
+export * from './observability.types';
+import { IntegrationId } from '../communication.types';
+import { AiAssistantIntegrationConfig } from './ai_assistant.types';
+import { GraphQLIntegrationConfig, HttpApiIntegrationConfig, TestGraphQLDataConnectionRequest } from './api.types';
+import { Auth0IntegrationConfig, CognitoIntegrationConfig, JwtHmacIntegrationConfig, JwtRsaIntegrationConfig, OktaIntegrationConfig } from './auth.types';
+import { BaseDatabaseIntegrationConfig, CockroachIntegrationConfig, InternalIntegrationConfig, MongoIntegrationConfig, MssqlIntegrationConfig, MySqlIntegrationConfig, OracleIntegrationConfig, PostgresIntegrationConfig, SnowflakeIntegrationConfig, TestDataConnectionRequest } from './database.types';
+import { DatadogIntegrationConfig, NewRelicIntegrationConfig } from './observability.types';
+export declare enum IntegrationCategory {
+    'database' = "database",
+    'api' = "api",
+    'observability' = "observability",
+    'crm' = "crm",
+    'auth' = "auth",
+    'ai' = "ai"
+}
+export declare enum IntegrationType {
+    'built_in_db' = "built_in_db",
+    'mongo' = "mongo",
+    'mysql' = "mysql",
+    'mssql' = "mssql",
+    'postgres' = "postgres",
+    'cockroach' = "cockroach",
+    'api' = "api",
+    'graphql' = "graphql",
+    'snowflake' = "snowflake",
+    'datadog' = "datadog",
+    'newrelic' = "newrelic",
+    'auth0' = "auth0",
+    'jwt_rsa' = "jwt_rsa",
+    'jwt_hmac' = "jwt_hmac",
+    'ai_assistant' = "ai_assistant",
+    'cognito' = "cognito",
+    'okta' = "okta",
+    'algolia' = "algolia",
+    'elastic_observability' = "elastic_observability",
+    'elastic_search' = "elastic_search",
+    'elastic_enterprise_search' = "elastic_enterprise_search",
+    'sentry' = "sentry",
+    'sap_hana' = "sap_hana",
+    'salesforce_crm' = "salesforce_crm",
+    'documentdb' = "documentdb",
+    'dynamodb' = "dynamodb",
+    'cassandra' = "cassandra",
+    'clickhouse' = "clickhouse",
+    'alloydb' = "alloydb",
+    'spanner' = "spanner",
+    'db2' = "db2",
+    'mariadb' = "mariadb",
+    'oracledb' = "oracledb",
+    'redis' = "redis",
+    'xata' = "xata",
+    'azure_sql' = "azure_sql"
+}
+export interface IntegrationConfigTypes {
+    [IntegrationType.built_in_db]: InternalIntegrationConfig;
+    [IntegrationType.mongo]: MongoIntegrationConfig;
+    [IntegrationType.mysql]: MySqlIntegrationConfig;
+    [IntegrationType.oracledb]: OracleIntegrationConfig;
+    [IntegrationType.mssql]: MssqlIntegrationConfig;
+    [IntegrationType.postgres]: PostgresIntegrationConfig;
+    [IntegrationType.cockroach]: CockroachIntegrationConfig;
+    [IntegrationType.snowflake]: SnowflakeIntegrationConfig;
+    [IntegrationType.api]: HttpApiIntegrationConfig;
+    [IntegrationType.graphql]: GraphQLIntegrationConfig;
+    [IntegrationType.datadog]: DatadogIntegrationConfig;
+    [IntegrationType.newrelic]: NewRelicIntegrationConfig;
+    [IntegrationType.auth0]: Auth0IntegrationConfig;
+    [IntegrationType.jwt_rsa]: JwtRsaIntegrationConfig;
+    [IntegrationType.jwt_hmac]: JwtHmacIntegrationConfig;
+    [IntegrationType.ai_assistant]: AiAssistantIntegrationConfig;
+    [IntegrationType.cognito]: CognitoIntegrationConfig;
+    [IntegrationType.okta]: OktaIntegrationConfig;
+}
+export declare const DatabaseIntegrationTypes: readonly [IntegrationType.built_in_db, IntegrationType.mongo, IntegrationType.mysql, IntegrationType.mssql, IntegrationType.postgres, IntegrationType.cockroach, IntegrationType.snowflake, IntegrationType.oracledb];
+export type DatabaseIntegrationType = (typeof DatabaseIntegrationTypes)[number];
+export type DatabaseIntegrationConfig = IntegrationConfigTypes[DatabaseIntegrationType];
+export declare const ApiIntegrationTypes: readonly [IntegrationType.api, IntegrationType.graphql];
+export declare const ObservabilityIntegrationTypes: readonly [IntegrationType.datadog, IntegrationType.newrelic];
+export declare const AuthIntegrationTypes: readonly [IntegrationType.auth0, IntegrationType.jwt_rsa, IntegrationType.jwt_hmac, IntegrationType.cognito, IntegrationType.okta];
+export type ApiIntegrationType = (typeof ApiIntegrationTypes)[number];
+export type ApiIntegrationConfig = IntegrationConfigTypes[ApiIntegrationType];
+export type ObservabilityIntegrationType = (typeof ObservabilityIntegrationTypes)[number];
+export type ObservabilityIntegrationConfig = IntegrationConfigTypes[ObservabilityIntegrationType];
+export type AuthIntegrationType = (typeof AuthIntegrationTypes)[number];
+export type AuthIntegrationConfig = IntegrationConfigTypes[AuthIntegrationType];
+export declare function isDataIntegrationType(type: IntegrationType): type is DatabaseIntegrationType;
+export declare function isDataIntegration(integration: any): integration is BaseDatabaseIntegrationConfig;
+export declare function isAuthIntegrationType(type: IntegrationType): type is AuthIntegrationType;
+export declare function isAuthIntegration(integration: any): integration is AuthIntegrationConfig;
+export type IntegrationConfig = DatabaseIntegrationConfig | ApiIntegrationConfig | ObservabilityIntegrationConfig | AuthIntegrationConfig | AiAssistantIntegrationConfig;
+export interface BaseIntegrationConfig {
+    id: IntegrationId;
+    type: IntegrationType;
+    creationDate: Date;
+    updateDate: Date;
+}
+export type TestConnectionRequest = TestDataConnectionRequest | TestGraphQLDataConnectionRequest;

package/dist/common/src/integrations/observability.types.d.ts

@@ -1,23 +1,23 @@
-import { BaseIntegrationConfig, IntegrationType } from './index';
-export interface DatadogIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.datadog;
-    configuration: DatadogIntegrationConfiguration;
-}
-export interface NewRelicIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.newrelic;
-    configuration: NewRelicIntegrationConfiguration;
-}
-export type DatadogRegion = 'us1' | 'us3' | 'us5' | 'eu1' | 'us1-fed' | 'ap1';
-export declare const datadogRegionMap: Record<DatadogRegion, string>;
-export declare const datadogLogsUrlMap: Record<DatadogRegion, string>;
-export interface DatadogIntegrationConfiguration {
-    apiKey: string;
-    appKey: string;
-    datadogRegion: DatadogRegion;
-}
-export type NewRelicRegion = 'worldwide' | 'eu';
-export declare const newRelicRegionMap: Record<NewRelicRegion, string>;
-export interface NewRelicIntegrationConfiguration {
-    apiKey: string;
-    newRelicRegion: NewRelicRegion;
-}
+import { BaseIntegrationConfig, IntegrationType } from './index';
+export interface DatadogIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.datadog;
+    configuration: DatadogIntegrationConfiguration;
+}
+export interface NewRelicIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.newrelic;
+    configuration: NewRelicIntegrationConfiguration;
+}
+export type DatadogRegion = 'us1' | 'us3' | 'us5' | 'eu1' | 'us1-fed' | 'ap1';
+export declare const datadogRegionMap: Record<DatadogRegion, string>;
+export declare const datadogLogsUrlMap: Record<DatadogRegion, string>;
+export interface DatadogIntegrationConfiguration {
+    apiKey: string;
+    appKey: string;
+    datadogRegion: DatadogRegion;
+}
+export type NewRelicRegion = 'worldwide' | 'eu';
+export declare const newRelicRegionMap: Record<NewRelicRegion, string>;
+export interface NewRelicIntegrationConfiguration {
+    apiKey: string;
+    newRelicRegion: NewRelicRegion;
+}

package/dist/common/src/logger.types.d.ts

@@ -1,21 +1,21 @@
-export type LoggerContext = Record<string, any>;
-export interface Logger {
-    trace(message: string, context?: LoggerContext): void;
-    debug(message: string, context?: LoggerContext): void;
-    info(message: string, context?: LoggerContext): void;
-    warn(message: string, context?: LoggerContext): void;
-    error(message: string, context?: LoggerContext): void;
-    log(record: LogRecord): void;
-}
-export declare enum LogLevel {
-    TRACE = "trace",
-    DEBUG = "debug",
-    INFO = "info",
-    WARN = "warn",
-    ERROR = "error"
-}
-export interface LogRecord {
-    level?: LogLevel;
-    message?: string;
-    [key: string]: any;
-}
+export type LoggerContext = Record<string, any>;
+export interface Logger {
+    trace(message: string, context?: LoggerContext): void;
+    debug(message: string, context?: LoggerContext): void;
+    info(message: string, context?: LoggerContext): void;
+    warn(message: string, context?: LoggerContext): void;
+    error(message: string, context?: LoggerContext): void;
+    log(record: LogRecord): void;
+}
+export declare enum LogLevel {
+    TRACE = "trace",
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error"
+}
+export interface LogRecord {
+    level?: LogLevel;
+    message?: string;
+    [key: string]: any;
+}

package/dist/common/src/metrics.types.d.ts

@@ -1 +1 @@
-export type MetricType = 'count' | 'gauge';
+export type MetricType = 'count' | 'gauge';

package/dist/common/src/mutation.context.d.ts

@@ -1,14 +1,14 @@
-import { BeforeAndAfterDocs } from './document.types';
-import { Mutation, MutationType } from './mutation.types';
-import { Paths } from './types';
-/** The mutation context that will be provided to the security function. */
-export declare class MutationContext<T = any> {
-    readonly mutation: Mutation<T>;
-    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
-    readonly serverTimeStamp: Date;
-    getMutationType(): MutationType;
-    get before(): T | undefined;
-    get after(): T | undefined;
-    /** Returns true if the mutation affects the provided path. */
-    affectsPath(path: Paths<T>): boolean;
-}
+import { BeforeAndAfterDocs } from './document.types';
+import { Mutation, MutationType } from './mutation.types';
+import { Paths } from './types';
+/** The mutation context that will be provided to the security function. */
+export declare class MutationContext<T = any> {
+    readonly mutation: Mutation<T>;
+    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
+    readonly serverTimeStamp: Date;
+    getMutationType(): MutationType;
+    get before(): T | undefined;
+    get after(): T | undefined;
+    /** Returns true if the mutation affects the provided path. */
+    affectsPath(path: Paths<T>): boolean;
+}

package/dist/common/src/mutation.schemas.d.ts

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

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

@@ -1,53 +1,53 @@
-import { SquidDocIdObj } from './document.types';
-/** A mutation on a document. */
-export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
-/** The mutation type. */
-export type MutationType = 'insert' | 'update' | 'delete';
-interface BaseMutation {
-    type: MutationType;
-    squidDocIdObj: SquidDocIdObj;
-}
-export interface DeleteMutation extends BaseMutation {
-    type: 'delete';
-}
-export interface UpdateMutation<T = any> extends BaseMutation {
-    type: 'update';
-    /** The updated properties */
-    properties: {
-        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
-    };
-}
-export interface InsertMutation<T = any> extends BaseMutation {
-    type: 'insert';
-    /** The inserted document */
-    properties: T;
-}
-/** A representation of a single property update */
-export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
-/** A value update property mutation */
-export interface ValueUpdatePropertyMutation<Value = any> {
-    type: 'update';
-    value: Value;
-}
-/** Applying a numeric function to a property */
-export interface ApplyNumericFnPropertyMutation {
-    type: 'applyNumericFn';
-    fn: 'increment';
-    value: number;
-}
-/** A property update that removes a property from a document */
-export interface RemovePropertyMutation {
-    type: 'removeProperty';
-}
-interface ApplyExtendString {
-    type: 'applyStringFn';
-    fn: 'extendString';
-    value: string;
-}
-interface ApplyTrimString {
-    type: 'applyStringFn';
-    fn: 'trim';
-}
-/** A property mutation that modifies a string */
-export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
-export {};
+import { SquidDocIdObj } from './document.types';
+/** A mutation on a document. */
+export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
+/** The mutation type. */
+export type MutationType = 'insert' | 'update' | 'delete';
+interface BaseMutation {
+    type: MutationType;
+    squidDocIdObj: SquidDocIdObj;
+}
+export interface DeleteMutation extends BaseMutation {
+    type: 'delete';
+}
+export interface UpdateMutation<T = any> extends BaseMutation {
+    type: 'update';
+    /** The updated properties */
+    properties: {
+        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
+    };
+}
+export interface InsertMutation<T = any> extends BaseMutation {
+    type: 'insert';
+    /** The inserted document */
+    properties: T;
+}
+/** A representation of a single property update */
+export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
+/** A value update property mutation */
+export interface ValueUpdatePropertyMutation<Value = any> {
+    type: 'update';
+    value: Value;
+}
+/** Applying a numeric function to a property */
+export interface ApplyNumericFnPropertyMutation {
+    type: 'applyNumericFn';
+    fn: 'increment';
+    value: number;
+}
+/** A property update that removes a property from a document */
+export interface RemovePropertyMutation {
+    type: 'removeProperty';
+}
+interface ApplyExtendString {
+    type: 'applyStringFn';
+    fn: 'extendString';
+    value: string;
+}
+interface ApplyTrimString {
+    type: 'applyStringFn';
+    fn: 'trim';
+}
+/** A property mutation that modifies a string */
+export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
+export {};

package/dist/common/src/named-query.context.d.ts

@@ -1,4 +1,4 @@
-/** The context provided to the secure named query function. */
-export declare class NamedQueryContext {
-    readonly params: Record<string, any>;
-}
+/** The context provided to the secure named query function. */
+export declare class NamedQueryContext {
+    readonly params: Record<string, any>;
+}

package/dist/common/src/named-query.schemas.d.ts

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

package/dist/common/src/named-query.types.d.ts

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

package/dist/common/src/query/index.d.ts

@@ -1,2 +1,2 @@
-export * from './query-context';
-export * from './simple-query-builder';
+export * from './query-context';
+export * from './simple-query-builder';

package/dist/common/src/query/query-context.d.ts

@@ -1,42 +1,109 @@
-import { IntegrationId } from '../communication.types';
-import { CollectionName, DocumentData, FieldName } from '../document.types';
-import { AllOperators, ContextCondition, ContextConditions, FieldSort, GeneralCondition, GeneralConditions, GenericValue, Query } from '../query.types';
-import { PartialBy, Paths } from '../types';
-export declare class QueryContext<T = any> {
-    readonly query: Query<T>;
-    private readonly parsedConditions;
-    get integrationId(): IntegrationId;
-    get collectionName(): CollectionName;
-    get limit(): number;
-    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
-    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
-    includes<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O>): boolean;
-    includesCondition(condition: ContextCondition<T>): boolean;
-    includesConditions(conditions: GeneralConditions<T>): boolean;
-    matchesConditions(conditions: GeneralConditions<T>): boolean;
-    matchesQuery(query: Query<T>): boolean;
-    isSubsetOf<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
-    isSubsetOfCondition(condition: GeneralCondition<T>): boolean;
-    isSubsetOfConditions(conditions: GeneralConditions<T>): boolean;
-    isSubsetOfQuery(query: Query<T>): boolean;
-    getConditionsFor<K extends FieldName<T>>(...fieldNames: K[]): ContextConditions<T, K>;
-    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;
-    /**
-     * Compares a condition against a given operator and value to determine if the
-     * provided condition is a subset of the operator and value. A condition is
-     * considered a subset if all values that satisfy (return true for) the
-     * condition also satisfy the operator and value.
-     *
-     * This is done using the underlying CompareTable, which provides a comparison
-     * function for each operator pair, or undefined if the comparison would
-     * always be false, regardless of the values.
-     */
-    private evaluateSubset;
-    private evaluateIncludes;
-    private parseConditions;
-}
+import { IntegrationId } from '../communication.types';
+import { CollectionName, DocumentData, FieldName } from '../document.types';
+import { AllOperators, ContextConditions, FieldSort, GeneralCondition, GeneralConditions, GenericValue, Query } from '../query.types';
+import { PartialBy, Paths } from '../types';
+export declare class QueryContext<T = any> {
+    readonly query: Query<T>;
+    private readonly parsedConditions;
+    /**
+     * 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 FieldName<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 FieldName<T>>(...fieldNames: 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;
+    /**
+     * Compares a condition against a given operator and value to determine if the
+     * provided condition is a subset of the operator and value. A condition is
+     * considered a subset if all values that satisfy (return true for) the
+     * condition also satisfy the operator and value.
+     *
+     * This is done using the underlying CompareTable, which provides a comparison
+     * function for each operator pair, or undefined if the comparison would
+     * always be false, regardless of the values.
+     */
+    private evaluateSubset;
+    private evaluateIncludes;
+    private parseConditions;
+}