@squidcloud/client 1.0.61 → 1.0.62

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

@@ -1,37 +1,37 @@
-import { IntegrationId } from '../communication.types';
-import { CollectionName, 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>;
-    /**
-     * 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, 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>;
+    /**
+     * 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;
+}

package/dist/common/src/query/simple-query-builder.d.ts

@@ -1,137 +1,137 @@
-import { IntegrationId } from '../communication.types';
-import { CollectionName, DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
-import { Operator, Query } from '../query.types';
-/** Base interface for a query builder. */
-export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
-    /**
-     * Adds a condition to the query.
-     * @param fieldName The name of the field to query.
-     * @param operator The operator to use.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '==', value)
-     *
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '!=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, 'in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, 'not in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '>', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '>=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, 'like', pattern).
-     *
-     * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
-     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
-     * @returns The query builder.
-     */
-    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /**
-     * A shortcut for where(fieldName, 'not like', pattern).
-     *
-     * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
-     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
-     * @returns The query builder.
-     */
-    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /**
-     * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
-     * if none is provided.
-     * @param limit The limit to set.
-     * @returns The query builder.
-     */
-    limit(limit: number): this;
-    /**
-     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
-     * determines the order in which they are applied.
-     * @param fieldName The name of the field to sort by.
-     * @param asc Whether to sort in ascending order. Defaults to true.
-     * @returns The query builder.
-     */
-    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
-}
-/** A query builder that can be used to build a query that returns a list of documents. */
-export declare class SimpleQueryBuilder<MyDocType extends DocumentData> implements BaseQueryBuilderInterface<MyDocType> {
-    protected readonly collectionName: CollectionName;
-    protected readonly integrationId: IntegrationId;
-    protected readonly query: Query<MyDocType>;
-    /** @inheritDoc */
-    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /** @inheritDoc */
-    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /** @inheritDoc */
-    limit(limit: number): this;
-    /** @inheritDoc */
-    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
-    private mergeConditions;
-}
+import { IntegrationId } from '../communication.types';
+import { CollectionName, DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
+import { Operator, Query } from '../query.types';
+/** Base interface for a query builder. */
+export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
+    /**
+     * Adds a condition to the query.
+     * @param fieldName The name of the field to query.
+     * @param operator The operator to use.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '==', value)
+     *
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '!=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, 'not in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '>', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '>=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * A shortcut for where(fieldName, 'not like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
+     * if none is provided.
+     * @param limit The limit to set.
+     * @returns The query builder.
+     */
+    limit(limit: number): this;
+    /**
+     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
+     * determines the order in which they are applied.
+     * @param fieldName The name of the field to sort by.
+     * @param asc Whether to sort in ascending order. Defaults to true.
+     * @returns The query builder.
+     */
+    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+}
+/** A query builder that can be used to build a query that returns a list of documents. */
+export declare class SimpleQueryBuilder<MyDocType extends DocumentData> implements BaseQueryBuilderInterface<MyDocType> {
+    protected readonly collectionName: CollectionName;
+    protected readonly integrationId: IntegrationId;
+    protected readonly query: Query<MyDocType>;
+    /** @inheritDoc */
+    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    /** @inheritDoc */
+    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /** @inheritDoc */
+    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /** @inheritDoc */
+    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /** @inheritDoc */
+    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /** @inheritDoc */
+    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /** @inheritDoc */
+    limit(limit: number): this;
+    /** @inheritDoc */
+    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+    private mergeConditions;
+}

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

@@ -1,5 +1,5 @@
-import { JSONSchemaType } from 'ajv';
-import { Query, QueryRequest, QueryUnsubscribeRequest } from './query.types';
-export declare const QuerySchema: JSONSchemaType<Query>;
-export declare const QueryRequestSchema: JSONSchemaType<QueryRequest>;
-export declare const QueryUnsubscribeRequestSchema: JSONSchemaType<QueryUnsubscribeRequest>;
+import { JSONSchemaType } from 'ajv';
+import { Query, QueryRequest, QueryUnsubscribeRequest } from './query.types';
+export declare const QuerySchema: JSONSchemaType<Query>;
+export declare const QueryRequestSchema: JSONSchemaType<QueryRequest>;
+export declare const QueryUnsubscribeRequestSchema: JSONSchemaType<QueryUnsubscribeRequest>;

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

@@ -1,118 +1,118 @@
-import { TriggerId } from './application.types';
-import { AppId, ClientId, ClientRequestId, IntegrationId } from './communication.types';
-import { CollectionName, FieldName, PrimitiveFieldType, SquidDocument } from './document.types';
-export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
-export interface Condition<Doc = any, F extends FieldName<Doc> = any> {
-    fieldName: F;
-    operator: Operator;
-    value: Doc[F] | null;
-}
-export type Operator = '==' | '>=' | '<=' | '>' | '<' | '!=' | 'like' | 'not like' | 'like_cs' | 'not like_cs';
-export type ContextConditions<Doc = any, F extends FieldName<Doc> = any> = Array<ContextCondition<Doc, F>>;
-export type GenericValue<Doc = any, F extends FieldName<Doc> = any, O extends AllOperators = any> = O extends 'in' ? Array<Doc[F]> | null : O extends 'not in' ? Array<Doc[F]> | null : Doc[F] | null;
-export type ContextCondition<Doc = any, F extends FieldName<Doc> = any> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
-interface InContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
-    operator: 'in';
-    value: Array<Doc[F]>;
-}
-interface NotInContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
-    operator: 'not in';
-    value: Array<Doc[F]>;
-}
-interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
-    operator: Exclude<ContextOperator, 'in' | 'not in'>;
-}
-export interface GeneralCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
-    operator: AllOperators;
-    value: any;
-}
-export type GeneralConditions<Doc = any, F extends FieldName<Doc> = any> = Array<GeneralCondition<Doc, F>>;
-export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
-export type AllOperators = Operator | 'in' | 'not in';
-export interface FieldSort<Doc> {
-    fieldName: FieldName<Doc>;
-    asc: boolean;
-}
-interface RegularQueryKey {
-    queryType: 'query';
-    clientId: string;
-    clientRequestId: string;
-}
-interface TriggerKey {
-    queryType: 'trigger';
-    triggerId: TriggerId;
-}
-export type QueryKey = RegularQueryKey | TriggerKey;
-export interface Query<Doc = any> {
-    collectionName: CollectionName;
-    integrationId: string;
-    conditions: Conditions<Doc>;
-    sortOrder: Array<FieldSort<Doc>>;
-    limit: number;
-}
-export type QuerySubscriptionId = `${ClientId}_${ClientRequestId}`;
-export interface QueryRequest {
-    clientId: ClientId;
-    clientRequestId: ClientRequestId;
-    query: Query;
-    subscribe: boolean;
-}
-export interface QueryUnsubscribeRequest {
-    clientId: ClientId;
-    clientRequestId: ClientRequestId;
-}
-interface QueryMetadata {
-    condCount: number;
-}
-/**
- * Example query mapping:
- * {
- *   unconditional: ['cid_123'],
- *   conditional: {
- *     age: {
- *       '==': {
- *         10: ['cid2_321'],
- *         11: ['cid2_321'],
- *         12: ['cid2_321'],
- *       },
- *       '>': {
- *         20: ['cid_456']
- *       }
- *     }
- *   },
- *   queriesMetadata: {
- *     'cid_123': {
- *       condCount: 0
- *     },
- *     'cid2_321': {
- *       condCount: 1
- *     },
- *     'cid2_456': {
- *       condCount: 1
- *     }
- *   }
- * }
- */
-export type QueryMapping<T extends string> = {
-    unconditional: Array<T>;
-    conditional: Record<FieldName, Record<Operator, Record<PrimitiveFieldType & string, Array<T>>>>;
-    queriesMetadata: Record<T, QueryMetadata>;
-};
-export declare abstract class QueryMappingManager<T> {
-    abstract addQuery(appId: AppId, query: Query, key: T): Promise<void>;
-    abstract removeQuery(appId: AppId, key: T): Promise<Query | undefined>;
-    abstract findQueriesForDocument(appId: AppId, doc: SquidDocument, collectionName: CollectionName, integrationId: IntegrationId): Promise<Array<T> | undefined>;
-}
-export declare abstract class SimpleQueryMappingManager<T extends string> extends QueryMappingManager<T> {
-    abstract getMapping(appId: AppId, collectionName: CollectionName, integrationId: IntegrationId): Promise<QueryMapping<T> | undefined> | (QueryMapping<T> | undefined);
-    findQueriesForDocument(appId: AppId, doc: SquidDocument, collectionName: CollectionName, integrationId: IntegrationId): Promise<Array<T>>;
-}
-export declare function findQueriesForDocumentSync<T extends string>(mapping: QueryMapping<T>, doc: SquidDocument): Array<T>;
-export declare function compareOperator(conditionValue: PrimitiveFieldType, valueInDocument: PrimitiveFieldType, operator: Operator): boolean;
-/** Returns a unique identifier for the query which includes both the client id and the client request id. */
-export declare function getQuerySubscriptionId(clientId: string, clientRequestId: string): QuerySubscriptionId;
-export declare function parseQuerySubscriptionId(querySubscriptionId: QuerySubscriptionId): {
-    clientId: string;
-    clientRequestId: string;
-};
-export {};
+import { TriggerId } from './application.types';
+import { AppId, ClientId, ClientRequestId, IntegrationId } from './communication.types';
+import { CollectionName, FieldName, PrimitiveFieldType, SquidDocument } from './document.types';
+export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
+export interface Condition<Doc = any, F extends FieldName<Doc> = any> {
+    fieldName: F;
+    operator: Operator;
+    value: Doc[F] | null;
+}
+export type Operator = '==' | '>=' | '<=' | '>' | '<' | '!=' | 'like' | 'not like' | 'like_cs' | 'not like_cs';
+export type ContextConditions<Doc = any, F extends FieldName<Doc> = any> = Array<ContextCondition<Doc, F>>;
+export type GenericValue<Doc = any, F extends FieldName<Doc> = any, O extends AllOperators = any> = O extends 'in' ? Array<Doc[F]> | null : O extends 'not in' ? Array<Doc[F]> | null : Doc[F] | null;
+export type ContextCondition<Doc = any, F extends FieldName<Doc> = any> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
+interface InContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
+    operator: 'in';
+    value: Array<Doc[F]>;
+}
+interface NotInContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
+    operator: 'not in';
+    value: Array<Doc[F]>;
+}
+interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
+    operator: Exclude<ContextOperator, 'in' | 'not in'>;
+}
+export interface GeneralCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
+    operator: AllOperators;
+    value: any;
+}
+export type GeneralConditions<Doc = any, F extends FieldName<Doc> = any> = Array<GeneralCondition<Doc, F>>;
+export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
+export type AllOperators = Operator | 'in' | 'not in';
+export interface FieldSort<Doc> {
+    fieldName: FieldName<Doc>;
+    asc: boolean;
+}
+interface RegularQueryKey {
+    queryType: 'query';
+    clientId: string;
+    clientRequestId: string;
+}
+interface TriggerKey {
+    queryType: 'trigger';
+    triggerId: TriggerId;
+}
+export type QueryKey = RegularQueryKey | TriggerKey;
+export interface Query<Doc = any> {
+    collectionName: CollectionName;
+    integrationId: string;
+    conditions: Conditions<Doc>;
+    sortOrder: Array<FieldSort<Doc>>;
+    limit: number;
+}
+export type QuerySubscriptionId = `${ClientId}_${ClientRequestId}`;
+export interface QueryRequest {
+    clientId: ClientId;
+    clientRequestId: ClientRequestId;
+    query: Query;
+    subscribe: boolean;
+}
+export interface QueryUnsubscribeRequest {
+    clientId: ClientId;
+    clientRequestId: ClientRequestId;
+}
+interface QueryMetadata {
+    condCount: number;
+}
+/**
+ * Example query mapping:
+ * {
+ *   unconditional: ['cid_123'],
+ *   conditional: {
+ *     age: {
+ *       '==': {
+ *         10: ['cid2_321'],
+ *         11: ['cid2_321'],
+ *         12: ['cid2_321'],
+ *       },
+ *       '>': {
+ *         20: ['cid_456']
+ *       }
+ *     }
+ *   },
+ *   queriesMetadata: {
+ *     'cid_123': {
+ *       condCount: 0
+ *     },
+ *     'cid2_321': {
+ *       condCount: 1
+ *     },
+ *     'cid2_456': {
+ *       condCount: 1
+ *     }
+ *   }
+ * }
+ */
+export type QueryMapping<T extends string> = {
+    unconditional: Array<T>;
+    conditional: Record<FieldName, Record<Operator, Record<PrimitiveFieldType & string, Array<T>>>>;
+    queriesMetadata: Record<T, QueryMetadata>;
+};
+export declare abstract class QueryMappingManager<T> {
+    abstract addQuery(appId: AppId, query: Query, key: T): Promise<void>;
+    abstract removeQuery(appId: AppId, key: T): Promise<Query | undefined>;
+    abstract findQueriesForDocument(appId: AppId, doc: SquidDocument, collectionName: CollectionName, integrationId: IntegrationId): Promise<Array<T> | undefined>;
+}
+export declare abstract class SimpleQueryMappingManager<T extends string> extends QueryMappingManager<T> {
+    abstract getMapping(appId: AppId, collectionName: CollectionName, integrationId: IntegrationId): Promise<QueryMapping<T> | undefined> | (QueryMapping<T> | undefined);
+    findQueriesForDocument(appId: AppId, doc: SquidDocument, collectionName: CollectionName, integrationId: IntegrationId): Promise<Array<T>>;
+}
+export declare function findQueriesForDocumentSync<T extends string>(mapping: QueryMapping<T>, doc: SquidDocument): Array<T>;
+export declare function compareOperator(conditionValue: PrimitiveFieldType, valueInDocument: PrimitiveFieldType, operator: Operator): boolean;
+/** Returns a unique identifier for the query which includes both the client id and the client request id. */
+export declare function getQuerySubscriptionId(clientId: string, clientRequestId: string): QuerySubscriptionId;
+export declare function parseQuerySubscriptionId(querySubscriptionId: QuerySubscriptionId): {
+    clientId: string;
+    clientRequestId: string;
+};
+export {};