@squidcloud/client 1.0.337 → 1.0.339

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

@@ -1,9 +1,24 @@
 import { AiGenerateImageOptions } from './public-types';
 /**
- * AiImageClient provides methods for AI-powered image processing.
+ * AiImageClient provides methods for AI-powered image processing,
+ * such as generating images from text prompts and removing backgrounds.
+ * @category AI
  */
 export declare class AiImageClient {
     private readonly rpcManager;
+    /**
+     * Generates an image based on a given text prompt and options.
+     *
+     * @param prompt - A natural language description of the desired image.
+     * @param options - Configuration options for image generation (e.g., size, style).
+     * @returns A Promise that resolves to a base64-encoded image string.
+     */
     generate(prompt: string, options: AiGenerateImageOptions): Promise<string>;
+    /**
+     * Removes the background from an image file.
+     *
+     * @param file - The image file to process.
+     * @returns A Promise that resolves to a base64-encoded image string with the background removed.
+     */
     removeBackground(file: File): Promise<string>;
 }

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

@@ -2,51 +2,97 @@ import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, M
 /**
  * Client for the AI Matchmaking service. This service allows you to create matchmakers and insert entities into them.
  * The service will then find matches for the entities.
+ * @category AI
  */
 export declare class AiMatchMakingClient {
     private readonly rpcManager;
     /**
-     * Creates a new matchmaker with the given id, description, and categories.
-     * @param matchMaker The matchmaker to create.
+     * Creates a new matchmaker with the given metadata.
+     *
+     * @param matchMaker - Object describing the matchmaker including ID, description (used as AI instructions), and categories.
+     * @returns A MatchMaker instance to perform entity-level operations.
      */
     createMatchMaker(matchMaker: MmMatchMaker): Promise<MatchMaker>;
     /**
      * Retrieves an existing matchmaker by its ID.
+     *
+     * @param matchMakerId - ID of the matchmaker to retrieve.
+     * @returns A MatchMaker instance if found, otherwise undefined.
      */
     getMatchMaker(matchMakerId: string): Promise<MatchMaker | undefined>;
+    /**
+     * Lists all existing matchmakers.
+     */
     listMatchMakers(): Promise<Array<MmMatchMaker>>;
 }
 /**
  * Represents a matchmaker. You can insert entities into the matchmaker and find matches for them.
+ *
+ * A matchmaker has one or more categories. When inserting an entity, it is assigned to a category.
+ * When finding matches, you can specify which categories to use for source and target.
+ *
+ * The matchmaker description is used as a prompt or instruction to the AI to guide the matchmaking behavior.
+ * @category AI
  */
 export declare class MatchMaker {
     private readonly matchMaker;
     private readonly rpcManager;
     readonly id: string;
-    /** Adds a new entity to the matchmaker - replaces existing entity with the same ID if exists. */
+    /**
+     * Adds a new entity to the matchmaker, replacing existing entity with the same ID if it exists.
+     *
+     * @param entity - The entity to insert.
+     */
     insertEntity(entity: MmEntity): Promise<void>;
     /**
-     * Adds a new entities to the matchmaker - replaces existing entities with the same ID if exists.
-     * This method is more efficient than calling insertEntity multiple times.
+     * Inserts multiple entities into the matchmaker. Replaces existing entities with matching IDs.
+     *
+     * @param entities - Array of entities to insert.
      */
     insertManyEntities(entities: Array<MmEntity>): Promise<void>;
+    /**
+     * Deletes the matchmaker and all its associated data.
+     */
     delete(): Promise<void>;
+    /**
+     * Deletes a specific entity from the matchmaker.
+     *
+     * @param entityId - The ID of the entity to delete.
+     */
     deleteEntity(entityId: string): Promise<void>;
-    /** Finds matches for the given entity id. */
+    /**
+     * Finds matches for an entity already inserted into the matchmaker.
+     *
+     * @param entityId - ID of the entity to match.
+     * @param options - Optional filters and controls for matching.
+     * @returns Array of entity matches.
+     */
     findMatches(entityId: string, options?: MmFindMatchesOptions): Promise<Array<MmEntityMatch>>;
-    /** Finds matches for the given entity. */
+    /**
+     * Finds matches for an entity not yet inserted into the matchmaker.
+     *
+     * @param entity - The entity object (excluding ID and metadata).
+     * @param options - Optional filters and controls for matching.
+     * @returns Array of entity matches.
+     */
     findMatchesForEntity(entity: Omit<MmEntity, 'metadata' | 'id'>, options?: MmFindMatchesOptions): Promise<Array<MmEntityMatch>>;
     /**
-     * Lists entities in the matchmaker that match the given category ID and the provided options.
-     * The results are ordered by the entity id.
+     * Lists entities currently in the matchmaker that belong to the specified category.
+     *
+     * @param categoryId - The category to filter entities by.
+     * @param options - Pagination and filtering options.
+     * @returns Array of entities in the category.
      */
     listEntities(categoryId: string, options?: MmListEntitiesOptions): Promise<Array<MmEntity>>;
     /**
-     * Returns the entity with the given ID.
+     * Retrieves a single entity from the matchmaker by its ID.
+     *
+     * @param entityId - ID of the entity to retrieve.
+     * @returns The entity if found, or undefined.
      */
     getEntity(entityId: string): Promise<MmEntity | undefined>;
     /**
-     * Returns an object with the matchmaker details.
+     * Returns the matchmaker metadata including description, categories, and ID.
      */
     getMatchMakerDetails(): MmMatchMaker;
 }

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

@@ -1,59 +1,112 @@
 import { AiChatModelName, ApiOptions, IntegrationId } from './public-types';
+/**
+ * Request to execute an AI query using a specific integration.
+ * Supports additional query execution options.
+ * @category AI
+ */
 export interface ExecuteAiQueryRequest {
+    /** ID of the integration to execute the AI query. */
     integrationId: IntegrationId;
+    /** User-provided prompt for the AI query. */
     prompt: string;
+    /** Additional options for query execution. */
     options?: ExecuteAiQueryOptions;
 }
-export interface ExecuteAiQueryMultiRequest {
-    integrationIds: Array<IntegrationId>;
-    prompt: string;
-    options?: ExecuteAiQueryOptions;
-}
-export interface ExecuteAiApiRequest {
-    integrationId: IntegrationId;
-    prompt: string;
-    allowedEndpoints?: string[];
-    provideExplanation?: boolean;
-}
+/**
+ * Options for configuring AI query execution.
+ * Includes instructions, model overrides, and additional execution settings.
+ * @category AI
+ */
 export interface ExecuteAiQueryOptions {
+    /** Custom instructions to modify AI query behavior. */
     instructions?: string;
+    /** List of collections to use in the AI query. */
     collectionsToUse?: Array<string>;
+    /** Whether to enable raw results output. */
     enableRawResults?: boolean;
+    /** Whether to enable code interpreter for query execution. */
     enableCodeInterpreter?: boolean;
+    /** Specific AI model override for the query execution. */
     overrideModel?: AiChatModelName;
+    /** Whether to generate a step-by-step walkthrough for the response. */
     generateWalkthrough?: boolean;
 }
+/**
+ * Response from an AI query execution.
+ * Contains the generated answer, optional explanation, and executed query details.
+ * @category AI
+ */
 export interface ExecuteAiQueryResponse {
+    /** AI-generated answer for the query. */
     answer: string;
+    /** Optional explanation for the AI-generated answer. */
     explanation?: string;
+    /** Query executed by the AI, if applicable. */
     executedQuery?: string;
+    /** Markdown format type of the executed query response. */
     queryMarkdownType?: string;
+    /** URL to access raw results from the query execution. */
     rawResultsUrl?: string;
+    /** Indicates whether the query execution was successful. */
     success: boolean;
 }
-interface ExecutedQuery {
+/**
+ * Details of an executed query, including the query text and result type.
+ * @category AI
+ */
+export interface ExecutedQuery {
+    /** Text of the executed query. */
     query: string;
+    /** The markdown type of the result (sql, mongo, etc.). */
     markdownType: string;
+    /** URL to access raw results from the query execution. */
     rawResultsUrl?: string;
 }
+/**
+ * Response from executing an AI query across multiple integrations.
+ * Includes answers and explanations for each executed query.
+ * @category AI
+ */
 export interface ExecuteAiQueryMultiResponse {
+    /** AI-generated answer for the multi-integration query. */
     answer: string;
+    /** Optional explanation for the AI-generated response. */
     explanation?: string;
+    /** List of executed queries with details. */
     executedQueries: Array<ExecutedQuery>;
+    /** Indicates whether the query execution was successful. */
     success: boolean;
 }
-interface ApiResult {
+/**
+ * The AI API call response
+ * @category AI
+ */
+export interface AiApiResult {
+    /** ID of the executed API endpoint. */
     endpointId: string;
+    /** Name of the executed API endpoint. */
     responseBody: string;
+    /** Status code of the executed API request. */
     responseStatusCode: number;
+    /** Request body of the executed API request. */
     requestBody: any;
+    /** Request options of the executed API request. */
     requestOptions: ApiOptions;
 }
+/**
+ * Response from executing an AI-powered API request.
+ * Includes the AI-generated answer and details of executed API calls.
+ * @category AI
+ */
 export interface ExecuteAiApiResponse {
+    /** AI-generated answer for the API request. */
     answer: string;
+    /** Optional explanation for the AI-generated API response. */
     explanation?: string;
-    executedApis?: Array<ApiResult>;
+    /** List of executed API requests and their results. */
+    executedApis?: Array<AiApiResult>;
+    /** Markdown format type of the executed query response. */
     queryMarkdownType?: string;
+    /** Indicates whether the API request execution was successful. */
     success: boolean;
 }
-export {};

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

@@ -5,6 +5,7 @@ import { ApiOptions } from '../../internal-common/src/public-types/api-client.pu
 /**
  * ApiClient facilitates making HTTP API requests to external integrations,
  * supporting various HTTP methods such as GET, POST, PUT, PATCH, and DELETE.
+ * @category Platform
  */
 export declare class ApiClient {
     private readonly rpcManager;

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

@@ -1,6 +1,11 @@
 import { IntegrationId } from './public-types';
-/** Holds authentication token for the specified integration. */
+/**
+ * Holds authentication token for the specified integration.
+ * @category Auth
+ */
 export interface AuthData {
+    /** Authentication token for the specified integration. */
     token: string | undefined;
+    /** Optional integration ID associated with the authentication. */
     integrationId?: IntegrationId;
 }

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

@@ -9,9 +9,12 @@ import { SnapshotEmitter } from './query/snapshot-emitter';
  * Read more about docId in the
  * {@link https://docs.squid.cloud/docs/api-reference/client-sdk-reference/classes/CollectionReference#doc
  * documentation}.
+ * @category Database
  */
 export interface DocIdAndData<T extends DocumentData> {
+    /** Optional document ID. If not provided, it may be generated by the server. */
     id?: DocIdOrDocIdObj;
+    /** Data associated with the document. */
     data: T;
 }
 /**
@@ -22,6 +25,7 @@ export interface DocIdAndData<T extends DocumentData> {
  * Read more about collection references in the
  * {@link https://docs.getsquid.ai/docs/client-sdk/database/collection-reference documentation}.
  * @typeParam T The type of the document data.
+ * @category Database
  */
 export declare class CollectionReference<T extends DocumentData> {
     private readonly collectionName;

package/dist/typescript-client/src/connection-details.d.ts

@@ -2,6 +2,7 @@ import { Observable } from 'rxjs';
 import { ClientId } from '../../internal-common/src/public-types/communication.public-types';
 /**
  * Provides information about the connection to the Squid Server.
+ * @category Platform
  */
 export declare class ConnectionDetails {
     private readonly clientIdService;

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

@@ -1,5 +1 @@
-import { DocTimestamp } from './public-types';
-export interface DocTimestampMetadata {
-    timestamp: DocTimestamp;
-    expireTimestamp?: number;
-}
+export {};

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

@@ -1,17 +1 @@
-import { Observable } from 'rxjs';
-export type DestructorFn = () => Promise<void> | void;
-/**
- * DestructManager handles the execution of pre-destruction and destruction
- * tasks, ensuring proper cleanup of resources in an orderly manner.
- */
-export declare class DestructManager {
-    private readonly preDestructors;
-    private readonly destructors;
-    private readonly isDestructedSubject;
-    get isDestructing(): boolean;
-    observeIsDestructing(): Observable<void>;
-    onPreDestruct(fn: DestructorFn): void;
-    onDestruct(fn: DestructorFn): void;
-    destruct(): Promise<void>;
-    reportDestructed(): void;
-}
+export {};

package/dist/typescript-client/src/distributed-lock.manager.d.ts

@@ -1,5 +1,8 @@
 import { Observable } from 'rxjs';
-/** A handler for a distributed lock that can be released. */
+/**
+ * A handler for a distributed lock that can be released.
+ * @category Platform
+ */
 export interface DistributedLock {
     /** Releases the lock. */
     release(): void;

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

@@ -11,6 +11,7 @@ import { DeepRecord, Paths } from '../../internal-common/src/public-types/typesc
  * Read more about document references in the
  * {@link https://docs.getsquid.ai/docs/client-sdk/database/document-reference documentation}.
  * @typeParam T The type of the document data.
+ * @category Database
  */
 export declare class DocumentReference<T extends DocumentData = any> {
     private _squidDocId;

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

@@ -1,17 +1 @@
-import { Query, SquidDocId, SquidDocument } from './public-types';
-/**
- * DocumentStore manages the storage, retrieval, sorting, and migration
- * of documents, ensuring efficient access and manipulation of stored data.
- */
-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;
-    private compareSquidDocs;
-    group(sortedDocs: SquidDocument[], sortFieldNames: string[]): SquidDocument[][];
-    sortAndLimitDocs(docIdSet: Set<SquidDocId>, query: Query): Array<SquidDocument>;
-    private removeInternalProperties;
-    migrateDocId(squidDocId: SquidDocId, newSquidDocId: SquidDocId): void;
-}
+export {};

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

@@ -2,6 +2,7 @@ import { DocumentTextDataResponse, ExtractDataFromDocumentFileOptions } from '..
 /**
  * ExtractionClient provides methods for extracting structured data
  * from document files using AI-driven processing.
+ * @category Platform
  */
 export declare class ExtractionClient {
     private readonly rpcManager;

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

@@ -2,6 +2,7 @@ import { IntegrationId, IntegrationInfo, IntegrationType } from './public-types'
 /**
  * IntegrationClient manages integrations within an application,
  * providing methods for listing, retrieving, updating, and deleting integrations.
+ * @category Platform
  */
 export declare class IntegrationClient {
     private readonly rpcManager;

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

@@ -1,5 +1,8 @@
 import { QueryMetricsRequest, QueryMetricsResponse } from '../../internal-common/src/public-types/metric.public-types';
-/** A client for reporting user metrics and querying both application-related Squid and user metrics. */
+/**
+ * A client for reporting user metrics and querying both application-related Squid and user metrics.
+ * @category Platform
+ */
 export declare class ObservabilityClient {
     private readonly rpcManager;
     private pendingPromises;
@@ -35,5 +38,6 @@ export interface Metric<MetricNameType = string> {
 /**
  * MetricReport represents a single metric event with some optional fields.
  * These optional fields are automatically populated by Squid with default values.
+ * @category Platform
  */
 export type MetricReport<MetricNameType = string> = Omit<Metric<MetricNameType>, 'tags' | 'timestamp'> & Partial<Pick<Metric, 'tags' | 'timestamp'>>;

package/dist/typescript-client/src/personal-storage-client.d.ts

@@ -1,21 +1,41 @@
 import { AiContextMetadata } from '../../internal-common/src/public-types/ai-agent.public-types';
 import { DocumentTextDataResponse } from '../../internal-common/src/public-types/extraction.public-types';
-interface PsGetAccessTokenResponse {
+/**
+ * Response to a request to get the access token for a personal storage service.
+ * @category Personal Storage
+ */
+export interface PsGetAccessTokenResponse {
+    /** The access token for the personal storage service. */
     accessToken: string;
+    /** The expiration time of the access token. */
     expirationTime: Date;
 }
-type PsDocumentType = 'file' | 'folder';
-interface PsIndexedDocument {
+/**
+ * The type of a document in personal storage.
+ * @category Personal Storage
+ */
+export type PsDocumentType = 'file' | 'folder';
+/**
+ * A document indexed for AI processing (as part of the personal storage connector).
+ * @category Personal Storage
+ */
+export interface PsIndexedDocument {
+    /** The ID of the document. */
     id: string;
+    /** The name of the document. */
     name: string;
+    /** The type of the document (file or folder). */
     type: PsDocumentType;
+    /** Metadata stored about the document */
     metadata: AiContextMetadata;
+    /** The ID of the parent folder of the document. */
     folderDocumentId?: string;
 }
 /**
  * Client to handle personal storage integrations such as Google Drive or Microsoft OneDrive.
  * Provides methods for saving authentication tokens, indexing documents or folders for AI processing,
  * and unindexing documents from AI processing.
+ * @category Personal Storage
  */
 export declare class PersonalStorageClient {
     private readonly integrationId;
@@ -63,4 +83,3 @@ export declare class PersonalStorageClient {
      */
     unindexDocument(documentId: string, identifier: string, agentId: string): Promise<void>;
 }
-export {};

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

@@ -1,8 +1,6 @@
 export * from '../../internal-common/src/public-types/ai-assistant.public-types';
 export * from '../../internal-common/src/public-types/ai-agent.public-types';
 export * from '../../internal-common/src/public-types/api-client.public-types';
-export * from '../../internal-common/src/public-types/application.public-types';
-export * from '../../internal-common/src/public-types/bundle-data.public-types';
 export * from '../../internal-common/src/public-types/code-executor.public-types';
 export * from '../../internal-common/src/public-types/communication.public-types';
 export * from '../../internal-common/src/public-types/context.public-types';
@@ -11,7 +9,6 @@ export * from '../../internal-common/src/public-types/http-status.enum';
 export * from '../../internal-common/src/public-types/integration.public-types';
 export * from '../../internal-common/src/public-types/integrations/api.public-types';
 export * from '../../internal-common/src/public-types/metric.public-types';
-export * from '../../internal-common/src/public-types/mutation.public-types';
 export * from '../../internal-common/src/public-types/openapi.public-types';
 export * from '../../internal-common/src/public-types/query.public-types';
 export * from '../../internal-common/src/public-types/regions.public-types';
@@ -20,7 +17,7 @@ export * from '../../internal-common/src/public-types/secret.public-types';
 export * from '../../internal-common/src/public-types/serialized-query.public-types';
 export * from '../../internal-common/src/public-types/scheduler.public-types';
 export * from '../../internal-common/src/public-types/socket.public-types';
-export * from '../../internal-common/src/public-types/storage.types';
 export * from '../../internal-common/src/public-types/typescript.public-types';
 export * from '../../internal-common/src/public-types/extraction.public-types';
 export * from '../../internal-common/src/public-types/ai-matchmaking.types';
+export * from '../../internal-common/src/public-types/backend.public-types';

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

@@ -5,5 +5,6 @@ import { SnapshotEmitter } from './snapshot-emitter';
  * Deserialize a serialized query into a snapshot emitter.
  * @param squid - The Squid instance.
  * @param serializedQuery - The serialized query.
+ * @category Database
  */
 export declare function deserializeQuery<ReturnType = any>(squid: Squid, serializedQuery: SerializedQuery): SnapshotEmitter<ReturnType>;

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

@@ -4,20 +4,51 @@ import { BaseQueryBuilder, HasDereference, QueryBuilder } from './query-builder.
 import { Alias, DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query, SerializedJoinQuery, SimpleCondition } from '../public-types';
 import { Pagination, PaginationOptions } from './pagination';
 import { SnapshotEmitter } from './snapshot-emitter';
-type WithDocumentReferences<T extends Record<any, DocumentData>> = {
+/**
+ * Represents the result of a join query where each property is a document reference,
+ * grouped by alias instead of containing DocumentData.
+ * @category Database
+ */
+export type WithDocumentReferences<T extends Record<any, DocumentData>> = {
     [k in keyof T]: DocumentReference<Required<T>[k]>;
 };
+/**
+ * Defines the fields used for joining two collections in a query.
+ * Specifies the left and right fields that establish the join relationship.
+ * @category Database
+ */
 export interface JoinFields<ReturnType> {
+    /** Field from the left collection to be used in the join. */
     left: FieldName;
+    /** Field from the right collection to be used in the join. */
     right: keyof ReturnType & FieldName;
 }
+/**
+ * Options for configuring a join query.
+ * Specifies aliasing and whether the join is inner or outer.
+ * @category Database
+ */
 export interface JoinOptions {
+    /** Alias for the left collection in the join. */
     leftAlias: Alias;
+    /** Whether the join should be an inner join (default is outer join). */
     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 {
+/**
+ * A join query result that has been grouped by alias.
+ * @category Database
+ */
+export 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]>;
+/**
+ * A helper type for Groups.
+ * @category Database
+ */
+export 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>;
+/**
+ * A join query result that has been grouped by alias.
+ * @category Database
+ */
+export interface HasGrouped {
     /**
      * Transforms this join query result to a nested data structure. For example, a join between teachers and students
      * normally returns a result of the form:
@@ -42,6 +73,7 @@ interface HasGrouped {
  * To learn more about join queries, see the
  * {@link https://docs.getsquid.ai/docs/client-sdk/database/queries#joining-data-across-collections-and-integrations
  * documentation}.
+ * @category Database
  */
 export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, LatestAlias extends Alias, RootAlias extends Alias> extends BaseQueryBuilder<ReturnType> implements SnapshotEmitter<WithDocumentReferences<ReturnType>>, HasGrouped, HasDereference {
     private readonly collectionName;
@@ -124,9 +156,12 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
     paginate(options?: Partial<PaginationOptions>): Pagination<WithDocumentReferences<ReturnType>>;
     hasIsInner(): boolean;
 }
-declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, RootAlias extends Alias, LatestAlias extends Alias> implements SnapshotEmitter<ReturnType>, HasGrouped {
+/**
+ * A join query result that has been grouped by alias and returns the DocumentData.
+ * @category Database
+ */
+export declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, RootAlias extends Alias, LatestAlias extends Alias> implements SnapshotEmitter<ReturnType>, HasGrouped {
     private readonly joinQueryBuilder;
-    constructor(joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>);
     /** @inheritDoc */
     grouped(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
     /** @inheritDoc */
@@ -145,7 +180,11 @@ declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, ReturnTyp
     paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
     serialize(): SerializedJoinQuery;
 }
-declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, RootAlias extends Alias, LatestAlias extends Alias> implements SnapshotEmitter<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>, HasDereference {
+/**
+ * A join query result that has been grouped by alias.
+ * @category Database
+ */
+export declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, RootAlias extends Alias, LatestAlias extends Alias> implements SnapshotEmitter<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>, HasDereference {
     readonly joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
     /** internal */
     constructor(joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>);
@@ -168,4 +207,3 @@ declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType ext
     serialize(): SerializedJoinQuery;
     paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
 }
-export {};

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

@@ -1,5 +1,8 @@
 import { Observable } from 'rxjs';
-/** The state of a pagination. */
+/**
+ * The state of a pagination.
+ * @category Database
+ */
 export interface PaginationState<ReturnType> {
     /** The page data. */
     data: Array<ReturnType>;
@@ -8,22 +11,20 @@ export interface PaginationState<ReturnType> {
     /** Whether there is a previous page. */
     hasPrev: boolean;
 }
-/** Pagination options */
+/**
+ * Pagination options.
+ * @category Database
+ */
 export interface PaginationOptions {
     /** Whether to show real-time updates. Defaults to true. */
     subscribe: boolean;
     /** The number of items in a page. Defaults to 100. */
     pageSize: number;
 }
-interface InternalState<ReturnType> {
-    data: ReturnType[];
-    extractedData: any[];
-    numBefore: number;
-    numAfter: number;
-}
 /**
  * Pagination provides a paginated view over a dataset, supporting navigation
  * through pages, real-time updates, and sorting based on predefined criteria.
+ * @category Database
  */
 export declare class Pagination<ReturnType> {
     private readonly paginateOptions;
@@ -43,7 +44,7 @@ export declare class Pagination<ReturnType> {
     private internalStateToState;
     /** Unsubscribes from the pagination. */
     unsubscribe(): void;
-    prevInternal(internalState: InternalState<ReturnType>): void;
+    private prevInternal;
     /** Returns a promise that resolves when the previous page of data is available. */
     prev(): Promise<PaginationState<ReturnType>>;
     /** Returns a promise that resolves when the next page of data is available. */
@@ -62,4 +63,3 @@ export declare class Pagination<ReturnType> {
      */
     last(): Promise<PaginationState<ReturnType>>;
 }
-export {};