@squidcloud/client 1.0.79 → 1.0.81

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

@@ -1,8 +1,26 @@
-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> {
+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.
@@ -102,16 +120,3 @@ export declare abstract class BaseQueryBuilderInterface<MyDocType extends Docume
      */
     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;
-}

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

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

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

@@ -1,25 +1,92 @@
 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 { 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;
-    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;
+    /**
+     * 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.