@squidcloud/client 1.0.64 → 1.0.66

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

@@ -1,134 +1,134 @@
-import { DocumentData, Paths } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { TransactionId } from './types';
-/**
- * Holds a reference to a document. A document reference is a reference to a specific record in a collection. You can
- * use it to read or write data to the document. A document can refer to a row in a table in a relational database or a
- * document in a NoSQL database. Additionally, a document reference can refer to a non-existent document, which you can
- * use to create a new document.
- *
- * Read more about document references in the
- * [documentation]{@link https://docs.squid.cloud/docs/client-sdk/document-reference}.
- * @typeParam T The type of the document data.
- */
-export declare class DocumentReference<T extends DocumentData = any> {
-    private _squidDocId;
-    private readonly dataManager;
-    private readonly queryBuilderFactory;
-    /** A string that uniquely identifies this document reference. */
-    refId: string;
-    /**
-     * Returns the document data. Throws an error if the document does not exist.
-     *
-     * @returns The document data.
-     * @throws Error if the document does not exist.
-     */
-    get data(): T;
-    /**
-     * Returns whether data has been populated for this document reference. Data
-     * will not present if a document has not been queried, does not exist, or
-     * has been deleted.
-     *
-     * @returns Whether the document has data.
-     */
-    get hasData(): boolean;
-    /**
-     * Returns a document reference with the latest data from the server or undefined if the document does not exist on
-     * the server.
-     *
-     * @returns A document reference with the latest data from the server or undefined if the document does not exist on
-     * the server.
-     */
-    snapshot(): Promise<DocumentReference<T> | undefined>;
-    /**
-     * Returns an observable that emits a document reference with the latest data from the server or undefined if the
-     * document is deleted or does not exist on the server.
-     *
-     * @returns An observable that emits a document reference with the latest data from the server or undefined if the
-     * document is deleted or does not exist on the server.
-     */
-    snapshots(): Observable<DocumentReference<T> | undefined>;
-    /**
-     * Returns whether the locally available version of the document may not be the latest version on the server.
-     *
-     * @returns Whether the locally available version of the document may not be the latest version on the server.
-     */
-    isDirty(): boolean;
-    private isTracked;
-    /**
-     * Updates the document with the given data.
-     * The `update` will be reflected optimistically locally and will be applied to the server later.
-     * If a transactionId is provided, the `update` will be applied to the server as an atomic operation together with
-     * the rest of the operations in the transaction and the `update` will not reflect locally until the transaction is
-     * completed locally.
-     *
-     * The returned promise will resolve once the `update` has been applied to the server or immediately if the `update`
-     * is part of a transaction.
-     *
-     * @param data The data to update - can be partial.
-     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
-     *   immediately.
-     */
-    update(data: Partial<Record<Paths<T>, any>>, transactionId?: TransactionId): Promise<void>;
-    /**
-     * Similar to {@link update}, but only updates the given path.
-     * @param path The path to update.
-     * @param value The value to set at the given path.
-     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
-     *   immediately.
-     */
-    setInPath(path: Paths<T>, value: any, transactionId?: TransactionId): Promise<void>;
-    /**
-     * Similar to `update`, but only deletes the given path.
-     * @param path The path to delete.
-     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
-     *   immediately.
-     */
-    deleteInPath(path: Paths<T>, transactionId?: TransactionId): Promise<void>;
-    /**
-     * Increments the value at the given path by the given value. The value may be both positive and negative.
-     * @param path The path to the value to increment.
-     * @param value The value to increment by.
-     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
-     *   immediately.
-     */
-    incrementInPath(path: Paths<T>, value: number, transactionId?: TransactionId): Promise<void>;
-    /**
-     * Decrements the value at the given path by the given value. The value may be both positive and negative.
-     * @param path The path to the value to decrement.
-     * @param value The value to decrement by.
-     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
-     *   immediately.
-     */
-    decrementInPath(path: Paths<T>, value: number, transactionId?: TransactionId): Promise<void>;
-    /**
-     * Inserts the document with the given data. If the document already exists, the operation will be treated as
-     * `upsert`. The `insert` will be reflected optimistically locally and will be applied to the server later. If a
-     * transactionId is provided, the `insert` will be applied to the server as an atomic operation together with the
-     * rest
-     * of the operations in the transaction and the `insert` will not reflect locally until the transaction is completed
-     * locally.
-     *
-     * The returned promise will resolve once the `insert` has been applied to the server or immediately if the `insert`
-     * is part of a transaction.
-     *
-     * @param data The data to insert.
-     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
-     *   immediately.
-     */
-    insert(data: T, transactionId?: TransactionId): Promise<void>;
-    /**
-     * Deletes the document.
-     * The `delete` will be reflected optimistically locally and will be applied to the server later.
-     * If a transactionId is provided, the `delete` will be applied to the server as an atomic operation together with
-     * the rest of the operations in the transaction and the `delete` will not reflect locally until the transaction is
-     * completed locally.
-     *
-     * The returned promise will resolve once the `delete` has been applied to the server or immediately if the `delete`
-     * is part of a transaction.
-     *
-     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
-     *   immediately.
-     */
-    delete(transactionId?: TransactionId): Promise<void>;
-}
+import { DocumentData, Paths } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { TransactionId } from './types';
+/**
+ * Holds a reference to a document. A document reference is a reference to a specific record in a collection. You can
+ * use it to read or write data to the document. A document can refer to a row in a table in a relational database or a
+ * document in a NoSQL database. Additionally, a document reference can refer to a non-existent document, which you can
+ * use to create a new document.
+ *
+ * Read more about document references in the
+ * [documentation]{@link https://docs.squid.cloud/docs/client-sdk/document-reference}.
+ * @typeParam T The type of the document data.
+ */
+export declare class DocumentReference<T extends DocumentData = any> {
+    private _squidDocId;
+    private readonly dataManager;
+    private readonly queryBuilderFactory;
+    /** A string that uniquely identifies this document reference. */
+    refId: string;
+    /**
+     * Returns the document data. Throws an error if the document does not exist.
+     *
+     * @returns The document data.
+     * @throws Error if the document does not exist.
+     */
+    get data(): T;
+    /**
+     * Returns whether data has been populated for this document reference. Data
+     * will not present if a document has not been queried, does not exist, or
+     * has been deleted.
+     *
+     * @returns Whether the document has data.
+     */
+    get hasData(): boolean;
+    /**
+     * Returns a document reference with the latest data from the server or undefined if the document does not exist on
+     * the server.
+     *
+     * @returns A document reference with the latest data from the server or undefined if the document does not exist on
+     * the server.
+     */
+    snapshot(): Promise<DocumentReference<T> | undefined>;
+    /**
+     * Returns an observable that emits a document reference with the latest data from the server or undefined if the
+     * document is deleted or does not exist on the server.
+     *
+     * @returns An observable that emits a document reference with the latest data from the server or undefined if the
+     * document is deleted or does not exist on the server.
+     */
+    snapshots(): Observable<DocumentReference<T> | undefined>;
+    /**
+     * Returns whether the locally available version of the document may not be the latest version on the server.
+     *
+     * @returns Whether the locally available version of the document may not be the latest version on the server.
+     */
+    isDirty(): boolean;
+    private isTracked;
+    /**
+     * Updates the document with the given data.
+     * The `update` will be reflected optimistically locally and will be applied to the server later.
+     * If a transactionId is provided, the `update` will be applied to the server as an atomic operation together with
+     * the rest of the operations in the transaction and the `update` will not reflect locally until the transaction is
+     * completed locally.
+     *
+     * The returned promise will resolve once the `update` has been applied to the server or immediately if the `update`
+     * is part of a transaction.
+     *
+     * @param data The data to update - can be partial.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    update(data: Partial<Record<Paths<T>, any>>, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Similar to {@link update}, but only updates the given path.
+     * @param path The path to update.
+     * @param value The value to set at the given path.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    setInPath(path: Paths<T>, value: any, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Similar to `update`, but only deletes the given path.
+     * @param path The path to delete.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    deleteInPath(path: Paths<T>, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Increments the value at the given path by the given value. The value may be both positive and negative.
+     * @param path The path to the value to increment.
+     * @param value The value to increment by.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    incrementInPath(path: Paths<T>, value: number, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Decrements the value at the given path by the given value. The value may be both positive and negative.
+     * @param path The path to the value to decrement.
+     * @param value The value to decrement by.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    decrementInPath(path: Paths<T>, value: number, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Inserts the document with the given data. If the document already exists, the operation will be treated as
+     * `upsert`. The `insert` will be reflected optimistically locally and will be applied to the server later. If a
+     * transactionId is provided, the `insert` will be applied to the server as an atomic operation together with the
+     * rest
+     * of the operations in the transaction and the `insert` will not reflect locally until the transaction is completed
+     * locally.
+     *
+     * The returned promise will resolve once the `insert` has been applied to the server or immediately if the `insert`
+     * is part of a transaction.
+     *
+     * @param data The data to insert.
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    insert(data: T, transactionId?: TransactionId): Promise<void>;
+    /**
+     * Deletes the document.
+     * The `delete` will be reflected optimistically locally and will be applied to the server later.
+     * If a transactionId is provided, the `delete` will be applied to the server as an atomic operation together with
+     * the rest of the operations in the transaction and the `delete` will not reflect locally until the transaction is
+     * completed locally.
+     *
+     * The returned promise will resolve once the `delete` has been applied to the server or immediately if the `delete`
+     * is part of a transaction.
+     *
+     * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
+     *   immediately.
+     */
+    delete(transactionId?: TransactionId): Promise<void>;
+}

package/dist/typescript-client/src/document-reference.factory.d.ts

@@ -1,9 +1,9 @@
-import { SquidDocId } from '@squidcloud/common';
-import { DataManager } from './data.manager';
-import { DocumentReference } from './document-reference';
-import { QueryBuilderFactory } from './query/query-builder.factory';
-export declare class DocumentReferenceFactory {
-    private dataManager;
-    create(squidDocId: SquidDocId, queryBuilderFactory: QueryBuilderFactory): DocumentReference;
-    setDataManager(dataManager: DataManager): void;
-}
+import { SquidDocId } from '@squidcloud/common';
+import { DataManager } from './data.manager';
+import { DocumentReference } from './document-reference';
+import { QueryBuilderFactory } from './query/query-builder.factory';
+export declare class DocumentReferenceFactory {
+    private dataManager;
+    create(squidDocId: SquidDocId, queryBuilderFactory: QueryBuilderFactory): DocumentReference;
+    setDataManager(dataManager: DataManager): void;
+}

package/dist/typescript-client/src/document-store.d.ts

@@ -1,11 +1,11 @@
-import { Query, SquidDocId, SquidDocument } from '@squidcloud/common';
-export declare class DocumentStore {
-    private readonly squidDocIdToDoc;
-    saveDocument(squidDocId: SquidDocId, properties: SquidDocument | undefined): SquidDocument | undefined;
-    hasData(squidDocId: SquidDocId): boolean;
-    getDocument(squidDocId: SquidDocId): SquidDocument;
-    getDocumentOrUndefined(squidDocId: SquidDocId): SquidDocument | undefined;
-    sortAndLimitDocs(docIdSet: Set<SquidDocId> | undefined, query: Query): Array<SquidDocument>;
-    private removeInternalProperties;
-    migrateDocId(squidDocId: SquidDocId, newSquidDocId: SquidDocId): void;
-}
+import { Query, SquidDocId, SquidDocument } from '@squidcloud/common';
+export declare class DocumentStore {
+    private readonly squidDocIdToDoc;
+    saveDocument(squidDocId: SquidDocId, properties: SquidDocument | undefined): SquidDocument | undefined;
+    hasData(squidDocId: SquidDocId): boolean;
+    getDocument(squidDocId: SquidDocId): SquidDocument;
+    getDocumentOrUndefined(squidDocId: SquidDocId): SquidDocument | undefined;
+    sortAndLimitDocs(docIdSet: Set<SquidDocId> | undefined, query: Query): Array<SquidDocument>;
+    private removeInternalProperties;
+    migrateDocId(squidDocId: SquidDocId, newSquidDocId: SquidDocId): void;
+}

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

@@ -1,12 +1,12 @@
-import { GraphQLRequest, IntegrationId } from '@squidcloud/common';
-import { RpcManager } from './rpc.manager';
-/** A GraphQL client that can be used to query and mutate data. */
-export declare class GraphQLClient {
-    private readonly rpcManager;
-    private readonly client;
-    constructor(rpcManager: RpcManager, integrationId: IntegrationId);
-    /** Executes a GraphQL query and returns a promise with the result. */
-    query<T = any>(request: GraphQLRequest): Promise<T>;
-    /** Executes a GraphQL mutation and returns a promise with the result. */
-    mutate<T = Record<string, any>>(request: GraphQLRequest): Promise<T | null | undefined>;
-}
+import { GraphQLRequest, IntegrationId } from '@squidcloud/common';
+import { RpcManager } from './rpc.manager';
+/** A GraphQL client that can be used to query and mutate data. */
+export declare class GraphQLClient {
+    private readonly rpcManager;
+    private readonly client;
+    constructor(rpcManager: RpcManager, integrationId: IntegrationId);
+    /** Executes a GraphQL query and returns a promise with the result. */
+    query<T = any>(request: GraphQLRequest): Promise<T>;
+    /** Executes a GraphQL mutation and returns a promise with the result. */
+    mutate<T = Record<string, any>>(request: GraphQLRequest): Promise<T | null | undefined>;
+}

package/dist/typescript-client/src/graphql-client.factory.d.ts

@@ -1,9 +1,9 @@
-import { IntegrationId } from '@squidcloud/common';
-import { GraphQLClient } from './graphql-client';
-import { RpcManager } from './rpc.manager';
-export declare class GraphQLClientFactory {
-    private readonly rpcManager;
-    private readonly clientsMap;
-    constructor(rpcManager: RpcManager);
-    get(integrationId: IntegrationId): GraphQLClient;
-}
+import { IntegrationId } from '@squidcloud/common';
+import { GraphQLClient } from './graphql-client';
+import { RpcManager } from './rpc.manager';
+export declare class GraphQLClientFactory {
+    private readonly rpcManager;
+    private readonly clientsMap;
+    constructor(rpcManager: RpcManager);
+    get(integrationId: IntegrationId): GraphQLClient;
+}

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

@@ -1,8 +1,8 @@
-export { CollectionReference } from './collection-reference';
-export { DocumentReference } from './document-reference';
-export { JoinQueryBuilder } from './query/join-query-builder.factory';
-export { Changes, QueryBuilder } from './query/query-builder.factory';
-export { Alias, JoinCondition } from './query/query.types';
-export { Squid, SquidOptions } from './squid';
-export { TransactionId } from './types';
-export { GraphQLClient } from './graphql-client';
+export { CollectionReference } from './collection-reference';
+export { DocumentReference } from './document-reference';
+export { JoinQueryBuilder } from './query/join-query-builder.factory';
+export { Changes, QueryBuilder } from './query/query-builder.factory';
+export { Alias, JoinCondition } from './query/query.types';
+export { Squid, SquidOptions } from './squid';
+export { TransactionId } from './types';
+export { GraphQLClient } from './graphql-client';

package/dist/typescript-client/src/mutation/mutation-sender.d.ts

@@ -1,12 +1,12 @@
-import { IntegrationId, LockManager, MutateResponse, Mutation } from '@squidcloud/common';
-import { QuerySubscriptionManager } from '../query/query-subscription.manager';
-import { RpcManager } from '../rpc.manager';
-import { ClientIdService } from '../client-id.service';
-export declare class MutationSender {
-    private readonly clientIdService;
-    private readonly rpcManager;
-    private readonly lockManager;
-    private readonly querySubscriptionManager;
-    constructor(clientIdService: ClientIdService, rpcManager: RpcManager, lockManager: LockManager, querySubscriptionManager: QuerySubscriptionManager);
-    sendMutations(mutations: Array<Mutation>, integrationId: IntegrationId): Promise<MutateResponse>;
-}
+import { IntegrationId, LockManager, MutateResponse, Mutation } from '@squidcloud/common';
+import { QuerySubscriptionManager } from '../query/query-subscription.manager';
+import { RpcManager } from '../rpc.manager';
+import { ClientIdService } from '../client-id.service';
+export declare class MutationSender {
+    private readonly clientIdService;
+    private readonly rpcManager;
+    private readonly lockManager;
+    private readonly querySubscriptionManager;
+    constructor(clientIdService: ClientIdService, rpcManager: RpcManager, lockManager: LockManager, querySubscriptionManager: QuerySubscriptionManager);
+    sendMutations(mutations: Array<Mutation>, integrationId: IntegrationId): Promise<MutateResponse>;
+}

package/dist/typescript-client/src/named-query.manager.d.ts

@@ -1,14 +1,14 @@
-import { IntegrationId, QueryName } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { SocketManager } from './socket.manager';
-import { ClientIdService } from './client-id.service';
-export declare class NamedQueryManager {
-    private readonly clientIdService;
-    private readonly rpcManager;
-    private readonly socketManager;
-    private readonly ongoingNamedQueryExecutions;
-    constructor(clientIdService: ClientIdService, rpcManager: RpcManager, socketManager: SocketManager);
-    executeNamedQueryAndSubscribe<T>(integrationId: IntegrationId, queryName: QueryName, params: Record<string, any>): Observable<T>;
-    private handleNamedQueryResponse;
-}
+import { IntegrationId, QueryName } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { RpcManager } from './rpc.manager';
+import { SocketManager } from './socket.manager';
+import { ClientIdService } from './client-id.service';
+export declare class NamedQueryManager {
+    private readonly clientIdService;
+    private readonly rpcManager;
+    private readonly socketManager;
+    private readonly ongoingNamedQueryExecutions;
+    constructor(clientIdService: ClientIdService, rpcManager: RpcManager, socketManager: SocketManager);
+    executeNamedQueryAndSubscribe<T>(integrationId: IntegrationId, queryName: QueryName, params: Record<string, any>): Observable<T>;
+    private handleNamedQueryResponse;
+}

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

@@ -1,72 +1,72 @@
-import { DocumentData, FieldName, Operator, PrimitiveFieldType } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { DocumentReference } from '../document-reference';
-import { Alias } from './query.types';
-/**
- * A query builder that can participate in a join.
- * To learn more about join queries, see
- * {@link https://docs.squid.cloud/docs/client-sdk/queries#joining-data-across-collections-and-integrations}.
- */
-export declare class JoinQueryBuilder<DocumentType extends DocumentData, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<DocumentType> | undefined>> {
-    private readonly collectionName;
-    private readonly integrationId;
-    private readonly querySubscriptionManager;
-    private readonly documentReferenceFactory;
-    private readonly alias;
-    private readonly joinQueryBuilderFactory;
-    private readonly queryBuilderFactory;
-    private readonly simpleQueryBuilder;
-    private readonly joins;
-    /** Record that maps the right alias to the left condition */
-    private readonly joinConditions;
-    /**
-     * 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 DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): 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 maximum number of results to return
-     * @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 DocumentType & FieldName, asc?: boolean): this;
-    /**
-     * Joins this query with another join query and return a new query builder that can be used to query the joined
-     * documents.
-     * @param queryBuilder The query builder to join with
-     * @param leftFieldName The name of the field on the left side of the join
-     * @param rightFieldName The name of the field on the right side of the join
-     * @returns A new query builder that can be used to query the joined documents
-     */
-    join<J extends DocumentData, RightAlias extends Alias, RightReturnType extends Record<RightAlias, DocumentReference<J> | undefined>>(queryBuilder: JoinQueryBuilder<J, RightAlias, RightReturnType>, leftFieldName: keyof DocumentType & FieldName, rightFieldName: keyof J & FieldName): JoinQueryBuilder<DocumentType, MyAlias, ReturnType & Partial<RightReturnType>>;
-    /**
-     * 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 the query. Defaults to true.
-     * @returns An observable for the query results
-     */
-    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
-}
+import { DocumentData, FieldName, Operator, PrimitiveFieldType } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { DocumentReference } from '../document-reference';
+import { Alias } from './query.types';
+/**
+ * A query builder that can participate in a join.
+ * To learn more about join queries, see
+ * {@link https://docs.squid.cloud/docs/client-sdk/queries#joining-data-across-collections-and-integrations}.
+ */
+export declare class JoinQueryBuilder<DocumentType extends DocumentData, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<DocumentType> | undefined>> {
+    private readonly collectionName;
+    private readonly integrationId;
+    private readonly querySubscriptionManager;
+    private readonly documentReferenceFactory;
+    private readonly alias;
+    private readonly joinQueryBuilderFactory;
+    private readonly queryBuilderFactory;
+    private readonly simpleQueryBuilder;
+    private readonly joins;
+    /** Record that maps the right alias to the left condition */
+    private readonly joinConditions;
+    /**
+     * 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 DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): 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 maximum number of results to return
+     * @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 DocumentType & FieldName, asc?: boolean): this;
+    /**
+     * Joins this query with another join query and return a new query builder that can be used to query the joined
+     * documents.
+     * @param queryBuilder The query builder to join with
+     * @param leftFieldName The name of the field on the left side of the join
+     * @param rightFieldName The name of the field on the right side of the join
+     * @returns A new query builder that can be used to query the joined documents
+     */
+    join<J extends DocumentData, RightAlias extends Alias, RightReturnType extends Record<RightAlias, DocumentReference<J> | undefined>>(queryBuilder: JoinQueryBuilder<J, RightAlias, RightReturnType>, leftFieldName: keyof DocumentType & FieldName, rightFieldName: keyof J & FieldName): JoinQueryBuilder<DocumentType, MyAlias, ReturnType & Partial<RightReturnType>>;
+    /**
+     * 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 the query. Defaults to true.
+     * @returns An observable for the query results
+     */
+    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+}