@squidcloud/client 1.0.80 → 1.0.82

package/dist/common/src/query/{simple-query-builder.d.ts → base-query-builder.d.ts}

@@ -1,117 +1,122 @@
-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 declare abstract class 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.
-     */
-    abstract 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.
-     */
-    abstract 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.
-     */
-    abstract 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> extends 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 */
-    limit(limit: number): this;
-    /** @inheritDoc */
-    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
-    private mergeConditions;
-}
+import { DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
+import { Operator } from '../query.types';
+import { Observable } from 'rxjs';
+export interface SnapshotEmitter<ReturnType> {
+    /**
+     * Returns a promise that resolves to the query results.
+     *
+     * @returns A promise that resolves to the query results.
+     */
+    snapshot(): Promise<Array<ReturnType>>;
+    /**
+     * Returns an observable that emits the query results and updates whenever the query results change unless
+     * `subscribe=false` is provided.
+     *
+     * Important: Make sure to unsubscribe from the observable when you are done with it.
+     *
+     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
+     * @returns An observable for the query results.
+     */
+    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+}
+/** Query builder base class. */
+export declare abstract class BaseQueryBuilder<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.
+     */
+    abstract 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.
+     */
+    abstract 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.
+     */
+    abstract sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+}

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 './base-query-builder';

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

@@ -1,109 +1,109 @@
-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;
-}
+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;
+}

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

@@ -1,3 +1,3 @@
-import { JSONSchemaType } from 'ajv';
-import { QueryRegisterRequest } from './query.types';
-export declare const QueryRegisterRequestSchema: JSONSchemaType<QueryRegisterRequest>;
+import { JSONSchemaType } from 'ajv';
+import { QueryRegisterRequest } from './query.types';
+export declare const QueryRegisterRequestSchema: JSONSchemaType<QueryRegisterRequest>;

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

@@ -1,57 +1,57 @@
-import { ClientRequestId } from './communication.types';
-import { CollectionName, FieldName } from './document.types';
-/** A list of query conditions. */
-export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
-/** A single query condition. */
-export interface Condition<Doc = any, F extends FieldName<Doc> = any> {
-    fieldName: F;
-    operator: Operator;
-    value: Doc[F] | null;
-}
-/** An operator in a query condition. */
-export type Operator = '==' | '>=' | '<=' | '>' | '<' | '!=' | 'like' | 'not like' | 'like_cs' | 'not like_cs';
-/** A list of context conditions */
-export type ContextConditions<Doc = any, F extends FieldName<Doc> = any> = Array<ContextCondition<Doc, F>>;
-/** A generic value that can exist in a query. */
-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;
-/** A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'. */
-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]>;
-}
-export interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
-    operator: Exclude<ContextOperator, 'in' | 'not in'>;
-}
-/** A condition that includes the 'in' and 'not in' operators. */
-export interface GeneralCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
-    operator: AllOperators;
-    value: any;
-}
-/** A list of general conditions. */
-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';
-/** A definition of a sort by a filed. */
-export interface FieldSort<Doc> {
-    fieldName: FieldName<Doc>;
-    asc: boolean;
-}
-/** A query object. */
-export interface Query<Doc = any> {
-    collectionName: CollectionName;
-    integrationId: string;
-    conditions: Conditions<Doc>;
-    sortOrder: Array<FieldSort<Doc>>;
-    limit: number;
-}
-export interface QueryRegisterRequest {
-    clientRequestId: ClientRequestId;
-    query: Query;
-    parentClientRequestId: ClientRequestId;
-}
-export {};
+import { ClientRequestId } from './communication.types';
+import { CollectionName, FieldName } from './document.types';
+/** A list of query conditions. */
+export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
+/** A single query condition. */
+export interface Condition<Doc = any, F extends FieldName<Doc> = any> {
+    fieldName: F;
+    operator: Operator;
+    value: Doc[F] | null;
+}
+/** An operator in a query condition. */
+export type Operator = '==' | '>=' | '<=' | '>' | '<' | '!=' | 'like' | 'not like' | 'like_cs' | 'not like_cs';
+/** A list of context conditions */
+export type ContextConditions<Doc = any, F extends FieldName<Doc> = any> = Array<ContextCondition<Doc, F>>;
+/** A generic value that can exist in a query. */
+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;
+/** A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'. */
+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]>;
+}
+export interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
+    operator: Exclude<ContextOperator, 'in' | 'not in'>;
+}
+/** A condition that includes the 'in' and 'not in' operators. */
+export interface GeneralCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator' | 'value'> {
+    operator: AllOperators;
+    value: any;
+}
+/** A list of general conditions. */
+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';
+/** A definition of a sort by a filed. */
+export interface FieldSort<Doc> {
+    fieldName: FieldName<Doc>;
+    asc: boolean;
+}
+/** A query object. */
+export interface Query<Doc = any> {
+    collectionName: CollectionName;
+    integrationId: string;
+    conditions: Conditions<Doc>;
+    sortOrder: Array<FieldSort<Doc>>;
+    limit: number;
+}
+export interface QueryRegisterRequest {
+    clientRequestId: ClientRequestId;
+    query: Query;
+    parentClientRequestId: ClientRequestId;
+}
+export {};

package/dist/common/src/regions.d.ts

@@ -1 +1 @@
-export type SupportedSquidRegion = (typeof SupportedSquidRegions)[number];
+export type SupportedSquidRegion = (typeof SupportedSquidRegions)[number];