@squidcloud/client 1.0.342 → 1.0.344

package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts

@@ -19,15 +19,19 @@ interface BaseMutation {
  */
 export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
 /**
+ * Represents a delete mutation on a document.
  * @category Database
  */
 export interface DeleteMutation extends BaseMutation {
+    /** Specifies that the mutation is a deletion. */
     type: 'delete';
 }
 /**
+ * Represents an update mutation on a document.
  * @category Database
  */
 export interface UpdateMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an update. */
     type: 'update';
     /** The updated properties */
     properties: {
@@ -35,9 +39,11 @@ export interface UpdateMutation<T = any> extends BaseMutation {
     };
 }
 /**
+ * Represents an insert mutation on a document.
  * @category Database
  */
 export interface InsertMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an insertion. */
     type: 'insert';
     /** The inserted document */
     properties: T;
@@ -52,7 +58,9 @@ export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | App
  * @category Database
  */
 export interface ValueUpdatePropertyMutation<Value = any> {
+    /** Specifies that the mutation updates a value. */
     type: 'update';
+    /** New value to be set. */
     value: Value;
 }
 /**
@@ -60,8 +68,11 @@ export interface ValueUpdatePropertyMutation<Value = any> {
  * @category Database
  */
 export interface ApplyNumericFnPropertyMutation {
+    /** Specifies that the mutation applies a numeric function. */
     type: 'applyNumericFn';
+    /** Numeric function to apply. */
     fn: 'increment';
+    /** Value to use in the numeric function. */
     value: number;
 }
 /**
@@ -69,15 +80,21 @@ export interface ApplyNumericFnPropertyMutation {
  * @category Database
  */
 export interface RemovePropertyMutation {
+    /** Specifies that the mutation removes a property. */
     type: 'removeProperty';
 }
 interface ApplyExtendString {
+    /** Specifies that the mutation applies a string function. */
     type: 'applyStringFn';
+    /** String function to extend the existing string. */
     fn: 'extendString';
+    /** String value to append. */
     value: string;
 }
 interface ApplyTrimString {
+    /** Specifies that the mutation applies a string function. */
     type: 'applyStringFn';
+    /** String function to trim the existing string. */
     fn: 'trim';
 }
 /**
@@ -90,7 +107,9 @@ export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
  * @category Database
  */
 export interface BeforeAndAfterDocs<T = SquidDocument> {
+    /** Document state before the mutation. */
     before: T | undefined;
+    /** Document state after the mutation. */
     after: T | undefined;
 }
 /**
@@ -101,8 +120,17 @@ export declare class MutationContext<T = any> {
     readonly mutation: Mutation<T>;
     readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
     readonly serverTimeStamp: Date;
+    /**
+     * Returns the type of the mutation (insert, update, or delete).
+     */
     getMutationType(): MutationType;
+    /**
+     * Returns the state of the document before the mutation was applied.
+     */
     get before(): T | undefined;
+    /**
+     * Returns the state of the document after the mutation was applied.
+     */
     get after(): T | undefined;
     /** Returns true if the mutation affects the provided path. */
     affectsPath(path: Paths<T>): boolean;

package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts

@@ -1,29 +1,41 @@
 import { IntegrationId } from '../public-types/communication.public-types';
 /**
+ * Represents the type of native query request, either relational or MongoDB.
  * @category Database
  */
 export type NativeQueryRequestType = 'relational' | 'mongo';
 interface BaseNativeQueryContext {
+    /** Type of the native query request. */
     type: NativeQueryRequestType;
+    /** Identifier for the integration. */
     integrationId: IntegrationId;
 }
 /**
+ * Context for executing a relational database query.
  * @category Database
  */
 export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a relational database. */
     type: 'relational';
+    /** SQL query string to be executed. */
     query: string;
+    /** Parameters to be used in the query. */
     params: Record<string, any>;
 }
 /**
+ * Context for executing a MongoDB query.
  * @category Database
  */
 export interface MongoNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a Mongo database. */
     type: 'mongo';
+    /** Name of the MongoDB collection to query. */
     collectionName: string;
+    /** Array of aggregation pipeline stages. */
     aggregationPipeline: Array<any | undefined>;
 }
 /**
+ * Union type representing either a relational or MongoDB native query context.
  * @category Database
  */
 export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext;

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

@@ -109,32 +109,43 @@ export type ContextConditions<Doc extends DocumentData = any, F extends Paths<Do
  */
 export type ContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
 /**
+ * A condition using the 'in' operator to match values within a set.
  * @category Database
  */
 export interface InContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'in'> {
+    /** Specifies the 'in' operator to check if a value exists within an array. */
     operator: 'in';
+    /** An array of values to match against the field. */
     value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
 }
 /**
+ * A condition using the 'not in' operator to exclude values within a set.
  * @category Database
  */
 export interface NotInContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'not in'> {
+    /** Specifies the 'not in' operator to check if a value does not exist within an array. */
     operator: 'not in';
+    /** An array of values to exclude from the field. */
     value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
 }
 /**
+ * A condition using operators other than 'in' or 'not in' for field comparisons.
  * @category Database
  */
 export interface OtherContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, Exclude<ContextOperator, 'in' | 'not in'>> {
+    /** The operator to use for the comparison, excluding 'in' and 'not in'. */
     operator: Exclude<ContextOperator, 'in' | 'not in'>;
+    /** The value to compare against the field. */
     value: FieldOf<DeepRecord<Doc>, Paths<Doc>> | any;
 }
 /**
- * A condition that includes the 'in' and 'not in' operators.
+ * A condition that includes all operators, including 'in' and 'not in', for general use.
  * @category Database
  */
 export interface GeneralCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, AllOperators> {
+    /** The operator to apply to the condition, including all possible operators. */
     operator: AllOperators;
+    /** The value to use in the condition comparison. */
     value: any;
 }
 /**

package/dist/internal-common/src/types/ai-matchmaking.types.d.ts

@@ -39,11 +39,17 @@ export interface MmFindMatchesForEntityRequest {
 export interface MmFindMatchesForEntityResponse {
     matches: Array<MmEntityMatch>;
 }
+export interface MmListMatchMakersResponse {
+    matchMakers: Array<MmMatchMaker>;
+}
 export interface MmListEntitiesRequest {
     matchMakerId: string;
     categoryId: string;
     options: MmListEntitiesOptions;
 }
+export interface MmListEntitiesResponse {
+    entities: Array<MmEntity>;
+}
 export interface MmGetEntityRequest {
     matchMakerId: string;
     entityId: string;

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

@@ -0,0 +1,6 @@
+export interface Base64File {
+    filename: string;
+    mimetype: string;
+    base64: string;
+    __isSquidBase64File__: true;
+}

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

@@ -11,6 +11,12 @@ export declare class AdminClient {
     private readonly appId;
     private readonly integrationClient;
     private readonly secretClient;
+    /**
+     * Returns the IntegrationClient for managing integrations.
+     */
     integrations(): IntegrationClient;
+    /**
+     * Returns the SecretClient for managing secrets.
+     */
     secrets(): SecretClient;
 }

package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts

@@ -75,8 +75,17 @@ export declare class AiAgentReference {
      * Resets any feedback previously provided to the agent.
      */
     resetFeedback(): Promise<void>;
+    /**
+     * Updates the agent's guardrails with the provided options.
+     */
     updateGuardrails(guardrails: GuardrailsOptions): Promise<void>;
+    /**
+     * Updates the agent's custom guardrails with the provided custom guardrail.
+     */
     updateCustomGuardrails(customGuardrail: string): Promise<void>;
+    /**
+     * Deletes the custom guardrails for the agent.
+     */
     deleteCustomGuardrail(): Promise<void>;
     /**
      * Sends a prompt to the agent and receives streamed text responses.

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

@@ -11,7 +11,15 @@ export declare class AiAgentClient {
     private readonly socketManager;
     private readonly ongoingChatSequences;
     private readonly statusUpdates;
+    /**
+     * Retrieves an instance of AiAgentReference for a specific agent ID.
+     * This reference provides methods for interacting with the agent.
+     */
     agent(id: AiAgentId): AiAgentReference;
+    /**
+     * Lists all agents available in the system.
+     * @returns A promise that resolves to an array of AiAgent instances.
+     */
     listAgents(): Promise<Array<AiAgent>>;
     private handleChatResponse;
     private handleStatusMessage;

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

@@ -16,7 +16,14 @@ export declare class AiClient {
     private readonly rpcManager;
     private readonly aiAssistantClient;
     private aiAgentClient?;
+    /**
+     * Returns a reference to the specified AI agent.
+     * If no ID is provided, the built-in agent is used by default.
+     */
     agent(agentId?: AiAgentId): AiAgentReference;
+    /**
+     * Lists all available AI agents.
+     */
     listAgents(): Promise<Array<AiAgent>>;
     /**
      * Retrieves the AI assistant client.
@@ -61,6 +68,15 @@ export declare class AiClient {
      * {@link https://docs.squid.cloud/docs/ai}.
      */
     executeAiQuery(integrationId: IntegrationId, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryResponse>;
+    /**
+     * Executes an AI query across multiple database integrations and returns their responses.
+     * Useful when querying multiple sources with the same prompt.
+     *
+     * @param integrationIds The list of integration IDs to query.
+     * @param prompt The prompt to send to the AI.
+     * @param options Optional query execution parameters.
+     * @returns A promise resolving to the responses from all queried integrations.
+     */
     executeAiQueryMulti(integrationIds: Array<IntegrationId>, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryMultiResponse>;
     /**
      * Request to execute an AI-powered API call.

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

@@ -7,11 +7,12 @@ import { AiGenerateImageOptions } from './public-types';
 export declare class AiImageClient {
     private readonly rpcManager;
     /**
-     * Generates an image based on a given text prompt and options.
+     * Generates an image based on a given text prompt and options and returns a url to the generated image.
+     * The url will be valid for one hour.
      *
      * @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.
+     * @returns A Promise that resolves to a url with the image.
      */
     generate(prompt: string, options: AiGenerateImageOptions): Promise<string>;
     /**

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

@@ -9,10 +9,54 @@ import { ApiOptions } from '../../internal-common/src/public-types/api-client.pu
  */
 export declare class ApiClient {
     private readonly rpcManager;
+    /**
+     * Sends a GET request to the specified integration endpoint.
+     *
+     * @param integrationId The integration to send the request to.
+     * @param endpointId The API endpoint to call.
+     * @param options Optional API request options (headers, query params, etc).
+     * @returns A promise resolving to the HTTP response.
+     */
     get<ResponseBodyType = unknown>(integrationId: IntegrationId, endpointId: ApiEndpointId, options?: ApiOptions): Promise<HttpResponse<ResponseBodyType>>;
+    /**
+     * Sends a POST request to the specified integration endpoint.
+     *
+     * @param integrationId The integration to send the request to.
+     * @param endpointId The API endpoint to call.
+     * @param body Optional request body to send.
+     * @param options Optional API request options (headers, query params, etc).
+     * @returns A promise resolving to the HTTP response.
+     */
     post<ResponseBodyType = unknown, RequestBodyType = unknown>(integrationId: IntegrationId, endpointId: ApiEndpointId, body?: RequestBodyType, options?: ApiOptions): Promise<HttpResponse<ResponseBodyType>>;
+    /**
+     * Sends a DELETE request to the specified integration endpoint.
+     *
+     * @param integrationId The integration to send the request to.
+     * @param endpointId The API endpoint to call.
+     * @param body Optional request body to send.
+     * @param options Optional API request options (headers, query params, etc).
+     * @returns A promise resolving to the HTTP response.
+     */
     delete<ResponseBodyType = unknown, RequestBodyType = unknown>(integrationId: IntegrationId, endpointId: ApiEndpointId, body?: RequestBodyType, options?: ApiOptions): Promise<HttpResponse<ResponseBodyType>>;
+    /**
+     * Sends a PATCH request to the specified integration endpoint.
+     *
+     * @param integrationId The integration to send the request to.
+     * @param endpointId The API endpoint to call.
+     * @param body Optional request body to send.
+     * @param options Optional API request options (headers, query params, etc).
+     * @returns A promise resolving to the HTTP response.
+     */
     patch<ResponseBodyType = unknown, RequestBodyType = unknown>(integrationId: IntegrationId, endpointId: ApiEndpointId, body?: RequestBodyType, options?: ApiOptions): Promise<HttpResponse<ResponseBodyType>>;
+    /**
+     * Sends a PUT request to the specified integration endpoint.
+     *
+     * @param integrationId The integration to send the request to.
+     * @param endpointId The API endpoint to call.
+     * @param body Optional request body to send.
+     * @param options Optional API request options (headers, query params, etc).
+     * @returns A promise resolving to the HTTP response.
+     */
     put<ResponseBodyType = unknown, RequestBodyType = unknown>(integrationId: IntegrationId, endpointId: ApiEndpointId, body?: RequestBodyType, options?: ApiOptions): Promise<HttpResponse<ResponseBodyType>>;
     /**
      * Performs an HTTP API request to the given integration ID and endpoint ID.

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

@@ -6,5 +6,12 @@ import { DocumentTextDataResponse, ExtractDataFromDocumentFileOptions } from '..
  */
 export declare class ExtractionClient {
     private readonly rpcManager;
+    /**
+     * Extracts structured text data from a document file using AI.
+     *
+     * @param file - The document file to extract data from.
+     * @param options - (Optional) Extraction options such as parsing hints or preprocessing flags.
+     * @returns A promise that resolves with the extracted document data.
+     */
     extractDataFromDocumentFile(file: File, options?: ExtractDataFromDocumentFileOptions): Promise<DocumentTextDataResponse>;
 }

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

@@ -7,9 +7,39 @@ import { IntegrationId, IntegrationInfo, IntegrationType } from './public-types'
 export declare class IntegrationClient {
     private readonly rpcManager;
     private readonly iacBaseUrl;
+    /**
+     * Lists all integrations for the current application.
+     *
+     * @param type - (Optional) Filter by integration type.
+     * @returns A promise that resolves with a list of integrations.
+     */
     list<ConfigurationType = Record<string, any>>(type?: IntegrationType): Promise<Array<IntegrationInfo<ConfigurationType>>>;
+    /**
+     * Retrieves the integration by its ID.
+     *
+     * @param integrationId - The ID of the integration to retrieve.
+     * @returns A promise that resolves with the integration info, or `undefined` if not found.
+     */
     get<ConfigurationType = Record<string, any>>(integrationId: IntegrationId): Promise<IntegrationInfo<ConfigurationType> | undefined>;
+    /**
+     * Deletes the integration with the given ID.
+     *
+     * @param integrationId - The ID of the integration to delete.
+     * @returns A promise that resolves when the integration has been deleted.
+     */
     delete(integrationId: IntegrationId): Promise<void>;
+    /**
+     * Deletes multiple integrations by their IDs.
+     *
+     * @param integrationIds - An array of integration IDs to delete.
+     * @returns A promise that resolves when all deletions are complete.
+     */
     deleteMany(integrationIds: Array<IntegrationId>): Promise<void>;
+    /**
+     * Creates or updates an integration.
+     *
+     * @param integration - The integration information to upsert.
+     * @returns A promise that resolves when the operation is complete.
+     */
     upsertIntegration<ConfigurationType = Record<string, any>>(integration: IntegrationInfo<ConfigurationType>): Promise<void>;
 }

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

@@ -72,6 +72,14 @@ export declare class PersonalStorageClient {
      * @returns A promise that resolves when the document or folder is successfully indexed.
      */
     indexDocumentOrFolder(documentOrFolderId: string, identifier: string, agentId: string, metadata?: AiContextMetadata): Promise<void>;
+    /**
+     * Lists all documents or folders that have been indexed for AI processing.
+     *
+     * @param identifier - A user-provided identifier (usually a user ID) associated with the indexed documents.
+     * @param agentId - The AI agent ID used when indexing the documents.
+     * @param type - (Optional) The type of items to list: `'file'` or `'folder'`. If omitted, returns both.
+     * @returns A promise that resolves with an array of indexed documents or folders.
+     */
     listIndexedDocuments(identifier: string, agentId: string, type?: PsDocumentType): Promise<Array<PsIndexedDocument>>;
     /**
      * Unindexes a previously indexed document, removing it from AI processing.

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

@@ -102,7 +102,6 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
      * @returns The query builder
      */
     limit(limit: number): this;
-    getLimit(): number;
     /**
      * 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.
@@ -112,13 +111,19 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
      */
     sortBy(fieldName: (keyof ReturnType[RootAlias] & FieldName) | string, 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 alias TODO
-     * @param joinFields TODO
-     * @param options TODO
-     * @returns A new query builder that can be used to query the joined documents
+     * Joins this query with another collection using a specified alias from the left side of the join,
+     * allowing you to build complex multi-level joins. The join is defined by specifying which fields
+     * to use on both sides of the relationship.
+     *
+     * @param queryBuilder - The query builder for the collection you want to join with.
+     * @param alias - A unique alias for the joined collection. Must not conflict with existing aliases.
+     * @param joinFields - The join condition specifying which fields to join: `left` is from the `leftAlias` collection,
+     *   `right` is from the joined collection.
+     * @param options - Configuration for the join:
+     *    - `leftAlias`: the alias of the collection on the left-hand side of the join.
+     *    - `isInner`: whether this should be an inner join (default is outer join).
+     * @returns A new `JoinQueryBuilder` instance including the joined collection, allowing you to continue building the
+     *   query.
      */
     join<NewAlias extends string, NewReturnType extends DocumentData, LeftAlias extends Extract<keyof ReturnType, Alias>, IsInner extends boolean = false>(queryBuilder: QueryBuilder<NewReturnType>, alias: Exclude<NewAlias, keyof ReturnType>, joinFields: {
         left: keyof Required<ReturnType>[LeftAlias] & FieldName;
@@ -127,6 +132,15 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
         leftAlias: LeftAlias;
         isInner?: IsInner;
     }): Omit<JoinQueryBuilder<Omit<Aliases, LeftAlias> & Record<LeftAlias, [...Aliases[LeftAlias], NewAlias]> & Record<NewAlias, []>, ReturnType & (IsInner extends true ? Record<NewAlias, NewReturnType> : Partial<Record<NewAlias, NewReturnType>>), NewAlias, RootAlias>, 'limit' | 'getLimit'>;
+    /**
+     * Joins this query with another collection using a specified alias from the left side.
+     *
+     * @param queryBuilder - The query builder for the collection to be joined.
+     * @param alias - A unique alias for the joined collection.
+     * @param joinFields - Fields that define the join relationship (`left` and `right`).
+     * @param options - Options including the left alias to join from and whether the join is inner.
+     * @returns A new `JoinQueryBuilder` including the joined collection.
+     */
     join<NewAlias extends string, NewReturnType extends DocumentData, IsInner extends boolean = false>(queryBuilder: QueryBuilder<NewReturnType>, alias: Exclude<NewAlias, keyof ReturnType>, joinFields: {
         left: keyof Required<ReturnType>[LatestAlias] & FieldName;
         right: keyof NewReturnType & FieldName;
@@ -147,13 +161,56 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
     dereference(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
     /** @inheritDoc */
     build(): Query;
+    /**
+     * Gets the list of sort orders applied to the query.
+     *
+     * @returns An array of field sort configurations.
+     */
     getSortOrders(): Array<FieldSort<any>>;
+    /**
+     * Creates a deep copy of the current query builder.
+     *
+     * @returns A cloned instance of the query builder.
+     */
     clone(): JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
+    /**
+     * Adds a composite condition (AND of multiple conditions) to the query.
+     *
+     * @param conditions An array of simple conditions to apply.
+     * @returns The updated query builder.
+     */
     addCompositeCondition(conditions: Array<SimpleCondition>): JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
+    /**
+     * Reverses the current sort order(s) of the query.
+     *
+     * @returns The updated query builder with reversed sort order(s).
+     */
     flipSortOrder(): JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
+    /**
+     * Extracts the root document's data from a join query result.
+     *
+     * @param data A result object with document references.
+     * @returns The root alias's document reference data.
+     */
     extractData(data: WithDocumentReferences<ReturnType>): Required<ReturnType>[RootAlias];
+    /**
+     * Serializes the join query into a plain object.
+     *
+     * @returns A serialized representation of the query, suitable for transport or logging.
+     */
     serialize(): SerializedJoinQuery;
+    /**
+     * Enables pagination for the join query results.
+     *
+     * @param options Optional pagination configuration such as page size and cursor.
+     * @returns A {@link Pagination} object for fetching paginated results.
+     */
     paginate(options?: Partial<PaginationOptions>): Pagination<WithDocumentReferences<ReturnType>>;
+    /**
+     * Checks whether the join query contains any inner joins.
+     *
+     * @returns `true` if at least one join is inner; otherwise `false`.
+     */
     hasIsInner(): boolean;
 }
 /**
@@ -172,12 +229,50 @@ export declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, Re
      * @inheritDoc
      */
     peek(): Array<ReturnType>;
+    /**
+     * Returns the current sort orders applied to the query.
+     *
+     * @returns An array of field sort definitions.
+     */
     getSortOrders(): Array<FieldSort<any>>;
+    /**
+     * Clones the current join query builder instance.
+     *
+     * @returns A deep copy of the join query builder.
+     */
     clone(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    /**
+     * Adds multiple conditions that are combined with an AND operator.
+     *
+     * @param conditions An array of conditions to be applied together.
+     * @returns The updated query builder.
+     */
     addCompositeCondition(conditions: Array<SimpleCondition>): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    /**
+     * Reverses the direction of all currently applied sort orders.
+     *
+     * @returns The updated query builder.
+     */
     flipSortOrder(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    /**
+     * Extracts the root document's data from the given join result.
+     *
+     * @param data A record containing document references.
+     * @returns The root document's data.
+     */
     extractData(data: ReturnType): any;
+    /**
+     * Enables pagination for the join query results.
+     *
+     * @param options Optional pagination configuration such as page size and cursor.
+     * @returns A {@link Pagination} object for fetching paginated results.
+     */
     paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
+    /**
+     * Serializes the join query into a plain object.
+     *
+     * @returns A serialized representation of the query, suitable for transport or logging.
+     */
     serialize(): SerializedJoinQuery;
 }
 /**
@@ -199,11 +294,23 @@ export declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnT
     /** @inheritDoc */
     dereference(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
     private groupData;
+    /** @inheritDoc */
     getSortOrders(): Array<FieldSort<any>>;
+    /** @inheritDoc */
     clone(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    /** @inheritDoc */
     addCompositeCondition(conditions: Array<SimpleCondition>): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    /** @inheritDoc */
     flipSortOrder(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    /** @inheritDoc */
     extractData(data: Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>): any;
+    /** @inheritDoc */
     serialize(): SerializedJoinQuery;
+    /**
+     * Enables pagination for the join query results.
+     *
+     * @param options Optional pagination configuration such as page size and cursor.
+     * @returns A {@link Pagination} object for fetching paginated results.
+     */
     paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
 }

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

@@ -6,8 +6,25 @@ import { SchedulerInfo } from './public-types';
  */
 export declare class SchedulerClient {
     private readonly rpcManager;
+    /**
+     * Lists all configured schedulers.
+     *
+     * @returns A promise resolving to an array of scheduler metadata.
+     */
     list(): Promise<SchedulerInfo[]>;
+    /**
+     * Enables one or more schedulers by their IDs.
+     *
+     * @param schedulerId A single scheduler ID or an array of scheduler IDs to enable.
+     * @returns A promise that resolves once the update is complete.
+     */
     enable(schedulerId: string | string[]): Promise<void>;
+    /**
+     * Disables one or more schedulers by their IDs.
+     *
+     * @param schedulerId A single scheduler ID or an array of scheduler IDs to disable.
+     * @returns A promise that resolves once the update is complete.
+     */
     disable(schedulerId: string | string[]): Promise<void>;
     private update;
     private createUpdateSchedulerOptions;