@squidcloud/client 1.0.188 → 1.0.190

package/dist/internal-common/src/public-types/bundle-api.public-types.d.ts

@@ -1,7 +1,7 @@
 import { MutationContext } from './mutation.public-context';
 import { ApiCallContext } from './api-call.public-context';
 import { QueryContext } from './query.public-context';
-import { AiChatbotActionType, DatabaseActionType, TopicActionType } from './bundle-data.public-types';
+import { AiChatbotActionType, DatabaseActionType, StorageActionType, TopicActionType } from './bundle-data.public-types';
 import { ClientConnectionState } from './socket.public-types';
 import { DocumentData } from './document.public-types';
 import { MutationType } from './mutation.public-types';
@@ -11,7 +11,9 @@ import { NativeQueryContext } from './native-query.public-context';
 import { DistributedLockContext } from './distributed-lock.public-context';
 import { GraphqlContext } from './graphql.public-context';
 import { AiChatbotChatContext, AiChatbotMutationContext } from './ai-chatbot.public-context';
+import { SecureStorageRequest } from './storage.types';
 export type SecureDatabaseAction<T extends DatabaseActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: QueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: MutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureStorageAction<T extends StorageActionType> = T extends 'all' ? () => boolean | Promise<boolean> : (request: SecureStorageRequest) => boolean | Promise<boolean>;
 export type SecureTopicAction<T extends TopicActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: TopicReadContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: TopicWriteContext<T>) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
 export type SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
 export type SecureNativeQueryAction = ((context: NativeQueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);

package/dist/internal-common/src/public-types/bundle-data.public-types.d.ts

@@ -1,5 +1,7 @@
 /** The different types of actions that can be performed on a database. */
 export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
+/** The different types of actions that can be performed for storage. */
+export type StorageActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
 /** The different types of actions that can be performed on a topic. */
 export type TopicActionType = 'read' | 'write' | 'all';
 /** The different types of actions that can be performed on an AI chatbot. */

package/dist/internal-common/src/public-types/integration.public-types.d.ts

@@ -1,12 +1,3 @@
-export declare enum IntegrationCategory {
-    'database' = "database",
-    'queue' = "queue",
-    'api' = "api",
-    'observability' = "observability",
-    'crm' = "crm",
-    'auth' = "auth",
-    'ai' = "ai"
-}
 export declare enum IntegrationType {
     'built_in_db' = "built_in_db",
     'mongo' = "mongo",
@@ -30,6 +21,8 @@ export declare enum IntegrationType {
     'kafka' = "kafka",
     'confluent' = "confluent",
     'built_in_queue' = "built_in_queue",
+    's3' = "s3",
+    'built_in_s3' = "built_in_s3",
     'algolia' = "algolia",
     'elastic_observability' = "elastic_observability",
     'elastic_search' = "elastic_search",

package/dist/internal-common/src/public-types/integrations/api.public-types.d.ts

@@ -39,3 +39,6 @@ export interface DiscoverOpenApiSchemaRequest {
     integrationType: IntegrationType.api;
     discoveryOptions: OpenApiDiscoveryOptions;
 }
+export interface DiscoverOpenApiSchemaFromFileRequest {
+    integrationType: IntegrationType.api;
+}

package/dist/internal-common/src/public-types/storage.types.d.ts

@@ -0,0 +1,9 @@
+import { IntegrationId } from './communication.public-types';
+import { StorageActionType } from './bundle-data.public-types';
+export type StorageFunctionality = 'fileUpload';
+export interface SecureStorageRequest {
+    integrationId: IntegrationId;
+    pathsInBucket: Array<string>;
+    action: StorageActionType;
+    functionality: StorageFunctionality;
+}

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

@@ -1 +1,10 @@
-export {};
+/**
+ * Generates the regex pattern, handling special characters as follows:
+ *  - `_` is replaced with a `.`
+ *  - `%` is replaced with `[\s\S]*`.
+ *  - The above characters can be escaped with \, eg. `\_` is replaced with `_` and `\%` with `%`.
+ *  - All special characters in regex (-, /, \, ^, $, *, +, ?, ., (, ), |, [, ], {, }) get escaped with \
+ *
+ *  Exported for testing purposes.
+ * */
+export declare function replaceSpecialCharacters(input: string): string;

package/dist/internal-common/src/utils/object.d.ts

@@ -9,8 +9,12 @@ export declare function replaceKeyInRecord<K extends keyof any, T>(record: Recor
 export declare function isNil(obj: unknown): obj is null | undefined;
 export declare function isEqual(a: unknown, b: unknown): boolean;
 export declare function isEmpty(a: unknown): boolean;
-export declare function omit<T extends object, K extends (string | number | symbol)[]>(object: T | null | undefined, ...paths: K): Pick<T, Exclude<keyof T, K[number]>>;
+export declare function omit<T extends object, K extends PropertyKey[]>(object: T | null | undefined, ...fieldsToRemove: K): Pick<T, Exclude<keyof T, K[number]>>;
 /** Creates a deep copy of the object. Copies all Date, Map, Set fields. */
 export declare function cloneDeep<T>(value: T): T;
 /** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
-export declare function compareValues(a: any, b: any): number;
+export declare function compareValues(v1: unknown, v2: unknown): number;
+/** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
+export declare function mapValues<ResultType extends object = Record<string, unknown>, InputType extends Record<string, unknown> = Record<string, unknown>>(obj: InputType, valueMapperFn: (value: any, key: keyof InputType, obj: InputType) => unknown): ResultType;
+/** Groups elements of the array by key. See _.groupBy for details. */
+export declare function groupBy<T, K extends PropertyKey>(array: T[], getKey: (item: T) => K): Record<K, T[]>;

package/dist/typescript-client/src/ai-assistant-client.d.ts

@@ -1,5 +1,4 @@
 import { AssistantToolType, FunctionName } from './public-types';
-import { RpcManager } from './rpc.manager';
 import { BlobAndFilename } from './types';
 /**
  * Client class for interacting with an AI Assistant server.
@@ -8,7 +7,6 @@ import { BlobAndFilename } from './types';
  */
 export declare class AiAssistantClient {
     private readonly rpcManager;
-    constructor(rpcManager: RpcManager);
     /**
      * Creates a new AI assistant with specified characteristics.
      * @param name - The name of the assistant.

package/dist/typescript-client/src/ai-chatbot-client.d.ts

@@ -26,6 +26,18 @@ export declare class AiChatbotClient {
     chat(profileId: string, prompt: string, options?: AiChatbotChatOptions): Observable<string>;
     private handleChatResponse;
 }
+export interface AiChatBotContextData {
+    title: string;
+    context: AiChatbotContext;
+}
+export interface ProfileData {
+    modelName: AiModelName;
+    /** If the profile is public, there is no need to write a security rule to access the chat functionality. This can be dangerous, use with caution. */
+    isPublic: boolean;
+}
+export interface InstructionData {
+    instruction: string;
+}
 export declare class AiChatbotProfileReference {
     private readonly client;
     private readonly integrationId;
@@ -65,10 +77,7 @@ export declare class AiChatbotProfileReference {
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully created.
      */
-    insert(data: {
-        modelName: AiModelName;
-        isPublic: boolean;
-    }): Promise<void>;
+    insert(data: ProfileData): Promise<void>;
     /**
      * Updates an existing chatbot profile. This will result in an error if a profile has not yet been created for the
      * current profile id.
@@ -78,10 +87,7 @@ export declare class AiChatbotProfileReference {
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully updated.
      */
-    update(data: {
-        modelName?: AiModelName;
-        isPublic?: boolean;
-    }): Promise<void>;
+    update(data: Partial<ProfileData>): Promise<void>;
     /**
      * Deletes an existing chatbot profile. This will result in an error if a profile has not yet been created for the
      * current profile id.
@@ -90,7 +96,7 @@ export declare class AiChatbotProfileReference {
      */
     delete(): Promise<void>;
 }
-declare class AiChatbotContextReference {
+export declare class AiChatbotContextReference {
     private readonly client;
     private readonly integrationId;
     private readonly profileId;
@@ -105,10 +111,7 @@ declare class AiChatbotContextReference {
      * @param file - The file to insert.
      * @returns A promise that resolves when the context is successfully created.
      */
-    insert(data: {
-        title: string;
-        context: AiChatbotContext;
-    }, file?: File): Promise<void>;
+    insert(data: AiChatBotContextData, file?: File): Promise<void>;
     /**
      * Updates an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
      * been created for the current context id.
@@ -118,10 +121,7 @@ declare class AiChatbotContextReference {
      * @param data.context - The context data.
      * @returns A promise that resolves when the context is successfully updated.
      */
-    update(data: {
-        title?: string;
-        context?: AiChatbotContext;
-    }): Promise<void>;
+    update(data: Partial<AiChatBotContextData>): Promise<void>;
     /**
      * Deletes an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
      * been created for the current context id.
@@ -130,7 +130,7 @@ declare class AiChatbotContextReference {
      */
     delete(): Promise<void>;
 }
-declare class AiChatbotInstructionReference {
+export declare class AiChatbotInstructionReference {
     private readonly client;
     private readonly integrationId;
     private readonly profileId;
@@ -143,9 +143,7 @@ declare class AiChatbotInstructionReference {
      * @param data.instruction - The instruction data.
      * @returns A promise that resolves when the instruction is successfully created.
      */
-    insert(data: {
-        instruction: string;
-    }): Promise<void>;
+    insert(data: InstructionData): Promise<void>;
     /**
      * Updates an existing instruction entry on the chatbot profile. This will result in an error if an entry has not
      * yet been created for the current instruction id.
@@ -154,9 +152,7 @@ declare class AiChatbotInstructionReference {
      * @param data.instruction - The instruction data.
      * @returns A promise that resolves when the instruction is successfully updated.
      */
-    update(data: {
-        instruction: string;
-    }): Promise<void>;
+    update(data: InstructionData): Promise<void>;
     /**
      * Deletes an existing instruction entry on the chatbot profile. This will result in an error if an entry has not
      * yet been created for the current instruction id.
@@ -165,4 +161,3 @@ declare class AiChatbotInstructionReference {
      */
     delete(): Promise<void>;
 }
-export {};

package/dist/typescript-client/src/api.manager.d.ts

@@ -1,10 +1 @@
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { ClientIdService } from './client-id.service';
-import { ApiEndpointId, CallApiOptions, IntegrationId } from './public-types';
-export declare class ApiManager {
-    private readonly clientIdService;
-    private readonly rpcManager;
-    constructor(clientIdService: ClientIdService, rpcManager: RpcManager);
-    callApiAndSubscribe<T>(integrationId: IntegrationId, endpointId: ApiEndpointId, request: Record<string, any>, options: CallApiOptions): Observable<T>;
-}
+export {};

package/dist/typescript-client/src/auth.manager.d.ts

@@ -1,27 +1,6 @@
-import { SquidAuthProvider } from './squid';
-import { ApiKey, AuthToken, IntegrationId } from './public-types';
+import { IntegrationId } from './public-types';
 /** Holds authentication token for the specified integration. */
 export interface AuthData {
     token: string | undefined;
     integrationId?: IntegrationId;
 }
-export declare class AuthManager {
-    private readonly apiKey;
-    private authProvider?;
-    constructor(apiKey: ApiKey | undefined, authProvider?: SquidAuthProvider | undefined);
-    /**
-     * Sets a new auth-token provider to Squid.
-     * All future squid backend requests will use this token provider.
-     * Exising in-flight requests won't be affected.
-     */
-    setAuthProvider(authProvider: SquidAuthProvider): void;
-    getAuthData(): Promise<AuthData>;
-    private getTokenFromAuthProvider;
-    getApiKey(): ApiKey | undefined;
-    /**
-     * Returns a valid AuthToken.
-     * Tries to use `apiKey` first if set up.
-     * Falls back to `await authTokenProvider()` result.
-     */
-    getToken(): Promise<AuthToken | undefined>;
-}

package/dist/typescript-client/src/backend-function.manager.d.ts

@@ -1,9 +1 @@
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { ClientIdService } from './client-id.service';
-export declare class BackendFunctionManager {
-    private readonly clientIdService;
-    private readonly rpcManager;
-    constructor(clientIdService: ClientIdService, rpcManager: RpcManager);
-    executeFunctionAndSubscribe<T>(functionName: string, ...params: unknown[]): Observable<T>;
-}
+export {};

package/dist/typescript-client/src/client-id.service.d.ts

@@ -1,27 +1 @@
-import { Observable } from 'rxjs';
-import { DestructManager } from './destruct.manager';
-import { ClientId } from '../../internal-common/src/public-types/communication.public-types';
-/**
- * Whenever a squid client is created, it assigns itself a client id.
- * Later on, if the squid client disconnects for a specified time interval, it will generate itself a new client id.
- * The client id is generated before the socket is reconnected, so it is possible that the new client id is generated,
- * but the socket has not connected yet.
- *
- * Short-term disconnects/reconnects of the socket do not cause the client id to be regenerated.
- */
-export declare class ClientIdService {
-    private readonly destructManager;
-    private readonly clientTooOldSubject;
-    private readonly clientIdSubject;
-    private readonly isTenant;
-    constructor(destructManager: DestructManager);
-    observeClientId(): Observable<ClientId>;
-    observeClientTooOld(): Observable<void>;
-    /**  there was a long-term disconnection of the socket */
-    notifyClientTooOld(): void;
-    notifyClientNotTooOld(): void;
-    observeClientReadyToBeRegenerated(): Observable<void>;
-    getClientId(): ClientId;
-    isClientTooOld(): boolean;
-    private generateClientId;
-}
+export {};

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

@@ -1,7 +1,8 @@
-import { Alias, DocId, DocIdObj, DocumentData, SnapshotEmitter } from './public-types';
+import { Alias, DocId, DocIdObj, DocumentData } from './public-types';
 import { DocumentReference } from './document-reference';
 import { JoinQueryBuilder } from './query/join-query-builder.factory';
 import { QueryBuilder } from './query/query-builder.factory';
+import { SnapshotEmitter } from './query/snapshot-emitter';
 /**
  *  Holds a reference to a data collection. A collection reference is a reference to a collection in a database. You
  * can use it to read or write data to the collection. A collection can refer to a table in a relational database or a

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

@@ -1,12 +1,10 @@
-import { RpcManager } from './rpc.manager';
-import { GraphQLRequest, IntegrationId, SquidRegion } from './public-types';
+import { GraphQLRequest } from './public-types';
 /** A GraphQL client that can be used to query and mutate data. */
 export declare class GraphQLClient {
     private readonly rpcManager;
     private readonly region;
     private readonly appId;
     private readonly client;
-    constructor(rpcManager: RpcManager, integrationId: IntegrationId, region: SquidRegion, appId: string);
     /** 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. */

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

@@ -1,11 +1 @@
-import { GraphQLClient } from './graphql-client';
-import { RpcManager } from './rpc.manager';
-import { IntegrationId, SquidRegion } from './public-types';
-export declare class GraphQLClientFactory {
-    private readonly rpcManager;
-    private readonly region;
-    private readonly appId;
-    private readonly clientsMap;
-    constructor(rpcManager: RpcManager, region: SquidRegion, appId: string);
-    get(integrationId: IntegrationId): GraphQLClient;
-}
+export {};

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

@@ -1,12 +1,43 @@
-export { AiChatbotProfileReference } from './ai-chatbot-client';
-export { CollectionReference } from './collection-reference';
-export { DocumentReference } from './document-reference';
-export { GraphQLClient } from './graphql-client';
+export * from './ai-assistant-client';
+export * from './ai-chatbot-client.factory';
+export * from './ai-chatbot-client';
+export * from './ai.types';
+export * from './api-client';
+export * from './api.manager';
+export * from './auth.manager';
+export * from './backend-function.manager';
+export * from './client-id.service';
+export * from './collection-reference.factory';
+export * from './collection-reference';
+export * from './connection-details';
+export * from './data.manager';
+export * from './destruct.manager';
+export * from './distributed-lock.manager';
+export * from './document-identity.service';
+export * from './document-reference.factory';
+export * from './document-reference';
+export * from './document-store';
+export * from './graphql-client.factory';
+export * from './graphql-client';
+export * from './mutation/mutation-sender';
+export * from './native-query-manager';
 export * from './public-types';
 export * from './public-utils';
-export { deserializeQuery } from './query/deserializer';
-export { JoinQueryBuilder } from './query/join-query-builder.factory';
-export { Changes, QueryBuilder } from './query/query-builder.factory';
-export { QueueManager } from './queue.manager';
-export { Squid, SquidOptions } from './squid';
-export { TransactionId } from './types';
+export * from './query/deserializer';
+export * from './query/join-query-builder.factory';
+export * from './query/local-query-manager';
+export * from './query/query-builder.factory';
+export * from './query/query-sender';
+export * from './query/query-subscription.manager';
+export * from './query/query.types';
+export * from './query/pagination';
+export * from './query/snapshot-emitter';
+export * from './queue.manager';
+export * from './rate-limiter';
+export * from './rpc.manager';
+export * from './secret.client';
+export * from './socket.manager';
+export * from './squid-http-client';
+export * from './squid';
+export * from './types';
+export * from './storage-client';

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

@@ -1,7 +1 @@
-import { RpcManager } from './rpc.manager';
-import { IntegrationId, NativeQueryRequest } from './public-types';
-export declare class NativeQueryManager {
-    private readonly rpcManager;
-    constructor(rpcManager: RpcManager);
-    executeNativeQuery<T>(integrationId: IntegrationId, request: NativeQueryRequest): Promise<T>;
-}
+export {};

package/dist/typescript-client/src/public-types.d.ts

@@ -3,7 +3,6 @@ export * from '../../internal-common/src/public-types/ai-chatbot.public-context'
 export * from '../../internal-common/src/public-types/ai-chatbot.public-types';
 export * from '../../internal-common/src/public-types/api-call.public-context';
 export * from '../../internal-common/src/public-types/application.public-types';
-export * from '../../internal-common/src/public-types/base-query-builder.public-types';
 export * from '../../internal-common/src/public-types/bundle-api.public-types';
 export * from '../../internal-common/src/public-types/bundle-data.public-types';
 export * from '../../internal-common/src/public-types/communication.public-types';
@@ -21,7 +20,6 @@ export * from '../../internal-common/src/public-types/mutation.public-types';
 export * from '../../internal-common/src/public-types/native-query.public-context';
 export * from '../../internal-common/src/public-types/native-query.public-types';
 export * from '../../internal-common/src/public-types/openapi.public-types';
-export * from '../../internal-common/src/public-types/pagination.public-types';
 export * from '../../internal-common/src/public-types/query.public-context';
 export * from '../../internal-common/src/public-types/query.public-types';
 export * from '../../internal-common/src/public-types/regions.public-types';
@@ -31,3 +29,4 @@ export * from '../../internal-common/src/public-types/serialized-query.public-ty
 export * from '../../internal-common/src/public-types/socket.public-types';
 export * from '../../internal-common/src/public-types/topic.public-context';
 export * from '../../internal-common/src/public-types/typescript.public-types';
+export * from '../../internal-common/src/public-types/storage.types';

package/dist/typescript-client/src/query/deserializer.d.ts

@@ -1,3 +1,4 @@
 import { Squid } from '../squid';
-import { SerializedQuery, SnapshotEmitter } from '../public-types';
+import { SerializedQuery } from '../public-types';
+import { SnapshotEmitter } from './snapshot-emitter';
 export declare function deserializeQuery<ReturnType = any>(squid: Squid, serializedQuery: SerializedQuery): SnapshotEmitter<ReturnType>;

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

@@ -1,10 +1,20 @@
 import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
-import { QueryBuilder } from './query-builder.factory';
-import { Alias, BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, SerializedJoinQuery, SimpleCondition, SnapshotEmitter } from '../public-types';
+import { BaseQueryBuilder, HasDereference, QueryBuilder } from './query-builder.factory';
+import { Alias, DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, SerializedJoinQuery, SimpleCondition } from '../public-types';
+import { Pagination, PaginationOptions } from './pagination';
+import { SnapshotEmitter } from './snapshot-emitter';
 type WithDocumentReferences<T extends Record<any, DocumentData>> = {
     [k in keyof T]: DocumentReference<Required<T>[k]>;
 };
+export interface JoinFields<ReturnType> {
+    left: FieldName;
+    right: keyof ReturnType & FieldName;
+}
+export interface JoinOptions {
+    leftAlias: Alias;
+    isInner?: boolean;
+}
 type Grouped<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, any>, RootAlias extends Alias> = Aliases[RootAlias] extends [] ? Required<ReturnType>[RootAlias] : Record<RootAlias, Required<ReturnType>[RootAlias]> & OtherGroups<Aliases, ReturnType, Aliases[RootAlias]>;
 type OtherGroups<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, any>, ManyRootAliases extends Alias[]> = ManyRootAliases extends [infer First extends Alias, ...infer Rest extends Alias[]] ? Record<First, Array<Grouped<Aliases, ReturnType, First>>> & OtherGroups<Aliases, ReturnType, Rest> : Record<Alias, never>;
 interface HasGrouped {

package/dist/{internal-common/src/public-types/pagination.public-types.d.ts → typescript-client/src/query/pagination.d.ts}

@@ -22,7 +22,7 @@ interface InternalState<ReturnType> {
     numAfter: number;
 }
 export declare class Pagination<ReturnType> {
-    private readonly options;
+    private readonly paginateOptions;
     private internalStateObserver;
     private firstElement;
     private readonly isDestroyed;

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

@@ -1,6 +1,123 @@
 import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
-import { BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, SerializedSimpleQuery, SimpleCondition, SnapshotEmitter } from '../public-types';
+import { DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, SimpleCondition } from '../public-types';
+import { Pagination, PaginationOptions } from './pagination';
+import { SnapshotEmitter } from './snapshot-emitter';
+/**
+ * Interface used solely for @inheritDoc
+ */
+export interface HasDereference {
+    /**
+     * Dereferences the document references in the result of this query. For example, collection.query().snapshot()
+     * returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of
+     * the actual document data.
+     */
+    dereference(): any;
+}
+/**
+ *  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. '%' matches 0 or more wildcard characters. '_' matches exactly one wildcard character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @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. '%' matches 0 or more wildcard characters. '_' matches exactly one wildcard character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @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;
+    throwIfInvalidLikePattern(pattern: string): void;
+    /**
+     * 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 QueryBuilder<DocumentType extends DocumentData> extends BaseQueryBuilder<DocumentType> implements SnapshotEmitter<DocumentReference<DocumentType>>, HasDereference {
     private readonly collectionName;
@@ -55,8 +172,6 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     clone(): QueryBuilder<DocumentType>;
     addCompositeCondition(conditions: Array<SimpleCondition>): QueryBuilder<DocumentType>;
     flipSortOrder(): QueryBuilder<DocumentType>;
-    serialize(): SerializedSimpleQuery;
-    extractData(data: DocumentReference<DocumentType>): DocumentType;
     paginate(options?: Partial<PaginationOptions>): Pagination<DocumentReference<DocumentType>>;
 }
 /** Describes the changes to a query result. */
@@ -67,11 +182,4 @@ export declare class Changes<DocumentType extends DocumentData> {
     readonly updates: Array<DocumentReference<DocumentType>>;
     /** The actual document data that was deleted from the query result */
     readonly deletes: Array<DocumentType>;
-    constructor(
-    /** The newly inserted documents to the query result */
-    inserts: Array<DocumentReference<DocumentType>>, 
-    /** The documents that were updated in the query result */
-    updates: Array<DocumentReference<DocumentType>>, 
-    /** The actual document data that was deleted from the query result */
-    deletes: Array<DocumentType>);
 }