@squidcloud/client 1.0.145 → 1.0.146-beta

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

@@ -0,0 +1,25 @@
+import { AiGenerateImageOptions } from './public-types';
+/**
+ * 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 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 url with the image.
+     */
+    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-knowledge-base/ai-knowledge-base-client-reference.d.ts

@@ -0,0 +1,86 @@
+import { AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
+import { AiContextId } from '../../../internal-common/src/public-types/communication.public-types';
+/**
+ * Parameters for creating or updating an AI agent.
+ * Excludes the `id` field, as it is derived from the agent instance.
+ * @category AI
+ */
+export type UpsertKnowledgeBaseRequestParams = Omit<AiKnowledgeBase, 'id'>;
+/**
+ * A reference to an AI knowledge base.
+ */
+export declare class AiKnowledgeBaseReference {
+    private readonly knowledgeBaseId;
+    private readonly rpcManager;
+    private readonly jobClient;
+    /**
+     * Returns the AI knowledge base.
+     * @returns A promise that resolves to the AI knowledge base or undefined if not found.
+     */
+    getKnowledgeBase(): Promise<AiKnowledgeBase | undefined>;
+    /**
+     * Returns all AI knowledge bases.
+     * @returns A promise that resolves to an array of AI Knowledge Bases
+     */
+    listKnowledgeBases(): Promise<Array<AiKnowledgeBase>>;
+    /**
+     * Upserts the AI knowledge base.
+     * @param knowledgeBase
+     */
+    upsertKnowledgeBase(knowledgeBase: Omit<AiKnowledgeBaseWithOptionalChatModel, 'id' | 'appId' | 'updatedAt'>): Promise<void>;
+    /**
+     * Deletes the AI knowledge base.
+     * @returns A promise that resolves when the deletion is complete.
+     */
+    delete(): Promise<void>;
+    /**
+     * Lists all contexts associated with the knowledge base.
+     */
+    listContexts(truncateTextAfter?: number): Promise<Array<AiKnowledgeBaseContext>>;
+    /**
+     * Lists the ids for all contexts associated with the knowledge base.
+     */
+    listContextIds(): Promise<Array<AiContextId>>;
+    /**
+     * Retrieves a specific context by its ID.
+     */
+    getContext(contextId: string): Promise<AiKnowledgeBaseContext | undefined>;
+    /**
+     * Deletes a specific context by its ID.
+     */
+    deleteContext(contextId: string): Promise<void>;
+    /**
+     * Deletes multiple contexts.
+     */
+    deleteContexts(contextIds: Array<string>): Promise<void>;
+    /**
+     * Adds or updates a single context.
+     */
+    upsertContext(contextRequest: AiKnowledgeBaseContextRequest, file?: File): Promise<UpsertKnowledgeBaseContextResponse>;
+    /**
+     * Adds or updates multiple contexts.
+     */
+    upsertContexts(contextRequests: Array<AiKnowledgeBaseContextRequest>, files?: Array<File>): Promise<UpsertKnowledgeBaseContextsResponse>;
+    /**
+     * Performs a semantic search in the knowledge base and returns chunks from the different contexts.
+     */
+    search(options: AiKnowledgeBaseChatOptions & {
+        prompt: string;
+    }): Promise<Array<AiKnowledgeBaseSearchResultChunk>>;
+    /**
+     * Performs a semantic search in the knowledge base and returns contexts with reasoning.
+     * Can be used for matchmaking or similarity search.
+     */
+    searchContextsWithPrompt(request: Omit<AiKnowledgeBaseSearchContextsWithPromptRequest, 'knowledgeBaseId'>): Promise<Array<AiKnowledgeBaseContextWithReasoning>>;
+    /**
+     * Performs a semantic search in the knowledge base and returns contexts with reasoning.
+     * Can be used for matchmaking or similarity search.
+     */
+    searchContextsWithContextId(request: Omit<AiKnowledgeBaseSearchContextsWithContextIdRequest, 'knowledgeBaseId'>): Promise<Array<AiKnowledgeBaseContextWithReasoning>>;
+    /**
+     * Gets the download URL for the requested context.
+     *
+     * @return Object with temporary URL to download the requested context. Will be `undefined` if file is unavailable.
+     */
+    downloadContext(contextId: string): Promise<AiKnowledgeBaseDownloadContextResponse>;
+}

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

@@ -0,0 +1,28 @@
+import { AiKnowledgeBase } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
+import { AiKnowledgeBaseId } from '../../../internal-common/src/public-types/communication.public-types';
+import { AiKnowledgeBaseReference } from './ai-knowledge-base-client-reference';
+/**
+ * AiKnowledgeBaseClient manages AI knowledgebase interactions, including
+ * listing knowledgebases.
+ *
+ * @category AI
+ */
+export declare class AiKnowledgeBaseClient {
+    private readonly rpcManager;
+    private readonly jobClient;
+    /**
+     * Retrieves an instance of AiKnowledeBaseReference for a specific kb ID.
+     * This reference provides methods for interacting with the knowledgebase.
+     */
+    knowledgeBase(id: AiKnowledgeBaseId): AiKnowledgeBaseReference;
+    /**
+     * Lists all knowledgebases available in the system.
+     * @returns A promise that resolves to an array of AiKnowledgeBase instances.
+     */
+    listKnowledgeBases(): Promise<Array<AiKnowledgeBase>>;
+    /**
+     * Deletes the AI knowledge base.
+     * @returns A promise that resolves when the deletion is complete.
+     */
+    delete(id: AiKnowledgeBaseId): Promise<void>;
+}

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

@@ -0,0 +1,99 @@
+import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../../internal-common/src/public-types/ai-matchmaking.public-types';
+/**
+ * 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
+ * @deprecated - Use `knowledgebase('kbId').searchContextsWith*()` instead.
+ */
+export declare class AiMatchMakingClient {
+    private readonly rpcManager;
+    /**
+     * 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, replacing existing entity with the same ID if it exists.
+     *
+     * @param entity - The entity to insert.
+     */
+    insertEntity(entity: MmEntity): Promise<void>;
+    /**
+     * 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 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 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 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>>;
+    /**
+     * 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 the matchmaker metadata including description, categories, and ID.
+     */
+    getMatchMakerDetails(): MmMatchMaker;
+}

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

@@ -0,0 +1,69 @@
+import { ApiOptions } from '../../internal-common/src/public-types/api-client.public-types';
+import { ApiEndpointId, HttpMethod } from '../../internal-common/src/public-types/api.public-types';
+import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
+import { HttpResponse } from './squid-http-client';
+/**
+ * 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;
+    /**
+     * 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.
+     * The provided options will be merged with the default options.
+     * In case of error (status code >= 400 or other error), the promise will be rejected with an RpcError.
+     */
+    request<ResponseBodyType = unknown, RequestBodyType = unknown>(integrationId: IntegrationId, endpointId: ApiEndpointId, body?: RequestBodyType, options?: ApiOptions, method?: HttpMethod): Promise<HttpResponse<ResponseBodyType>>;
+    private convertOptionsToStrings;
+    private convertToStrings;
+}

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

@@ -1,26 +1,11 @@
-import { ApiKey, AuthToken, IntegrationId } from '@squidcloud/common';
-import { SquidAuthProvider } from './squid';
-/** 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>;
-    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>;
-}
+import { IntegrationId } from './public-types';
+/**
+ * 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/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: any[]): Observable<T>;
-}
+export {};

package/dist/typescript-client/src/client-customization.utils.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,27 +1 @@
-import { Observable } from 'rxjs';
-import { ClientId } from '@squidcloud/common';
-import { DestructManager } from './destruct.manager';
-/**
- * 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;
-    notifyClientReadyToBeRegenerated(): void;
-    observeClientReadyToBeRegenerated(): Observable<void>;
-    getClientId(): ClientId;
-    isClientTooOld(): boolean;
-    private generateClientId;
-}
+export {};

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

@@ -1,80 +1,105 @@
-import { Alias, DocId, DocIdObj, DocumentData, SnapshotEmitter } from '@squidcloud/common';
-import { DocumentReference } from './document-reference';
-import { JoinQueryBuilder } from './query/join-query-builder.factory';
-import { QueryBuilder } from './query/query-builder.factory';
-/**
- *  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
- * collection in a NoSQL database.
- *
- * Read more about collection references in the
- * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
- * @typeParam T The type of the document data.
- */
-export declare class CollectionReference<T extends DocumentData> {
-    private readonly collectionName;
-    private integrationId;
-    private readonly documentReferenceFactory;
-    private readonly queryBuilderFactory;
-    private readonly querySubscriptionManager;
-    /** A string that uniquely identifies this collection reference. */
-    refId: string;
-    /**
-     * Returns a document reference for the given document id.
-     * The document id is an object that maps the primary keys of the collection (as defined in the Squid Cloud Console)
-     * to their values. There are a few exceptions:
-     * 1 - String document id is only supported for the `built_in_db` when a schema was not defined.
-     * 2 - Not all the fields in the document id are required. If a field is not provided, it will be generated on the
-     *     server once the document is created (if the integration supports it).
-     * 3 - When a document id is not provided, it will be treated as an empty object or empty string.
-     * 4 - When the document id is just a `string` and not provided (applies only for the `built_in_db`), it will be
-     *    generated on the server.
-     * 5 - If the collection in the `built_in_db` does not have a schema, the document id must be provided as a string.
-     *
-     * Examples:
-     * ```typescript
-     * // For a collection in the built_in_db that does not have a schema
-     * const docRef = collectionRef.doc('my-doc-id');
-     * const docRef = collectionRef.doc({id: my-doc-id'});
-     *
-     * // For a collection with a single primary key field called "id"
-     * const docRef = collectionRef.doc({id: 'my-doc-id'});
-     *
-     * // For a collection with a composite primary key
-     * const docRef = collectionRef.doc({id1: 'my-doc-id1', id2: 'my-doc-id2'});
-     * const docRef = collectionRef.doc({id1: 'my-doc-id1'}); // id2 will be generated on the server if the integration
-     * supports it
-     *
-     * // For a collection from the `built_in_db` without a defined schema when an id is not provided
-     *  const docRef = collectionRef.doc(); // The id will be generated on the server
-     * ```
-     *
-     * @param docId The document id as an object for the different fields in the primary key or a string.
-     * @returns A document reference for the given document id.
-     */
-    doc(docId?: DocId | DocIdObj): DocumentReference<T>;
-    /**
-     * Creates a `QueryBuilder` that can be used to query the collection.
-     *
-     * @returns A `QueryBuilder` that can be used to query the collection.
-     */
-    query(): QueryBuilder<T>;
-    /**
-     * Creates a `JoinQueryBuilder` that can be used to query the collection
-     * Note that when using a join query, you have to provide an alias for the query and for every other query
-     * participating in the join.
-     *
-     * @param alias The alias for the query.
-     * @returns A `JoinQueryBuilder` that can be used to query the collection and joins with other queries.
-     */
-    joinQuery<A extends Alias>(alias: A): JoinQueryBuilder<Record<A, []>, Record<A, T>, A, A>;
-    /**
-     * Performs `or` on a list of queries. All the queries need to be on the same collection.
-     * The result will be a merge of all the queries sorted by the same sort condition of the first query.
-     * Duplicate items will be removed.
-     * @param builders The list of query builders to merge. (A query builder can be returned from the {@link query}
-     *   method).
-     * @returns A query builder that can be used to perform the `or` operation.
-     */
-    or(...builders: QueryBuilder<T>[]): SnapshotEmitter<DocumentReference<T>>;
-}
+import { DocumentReference } from './document-reference';
+import { Alias, DocIdOrDocIdObj, DocumentData } from './public-types';
+import { JoinQueryBuilder } from './query/join-query-builder.factory';
+import { QueryBuilder } from './query/query-builder.factory';
+import { SnapshotEmitter } from './query/snapshot-emitter';
+/**
+ * Represents a docId and the data to be inserted.
+ * If the docId is not provided, it will be generated on the server in case the integration supports it.
+ * 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;
+}
+/**
+ *  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
+ * collection in a NoSQL database.
+ *
+ * Read more about collection references in the
+ * {@link https://docs.getsquid.ai/docs/sdk/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;
+    private integrationId;
+    private readonly documentReferenceFactory;
+    private readonly queryBuilderFactory;
+    private readonly querySubscriptionManager;
+    private readonly dataManager;
+    /** A string that uniquely identifies this collection reference. */
+    refId: string;
+    /**
+     * Returns a document reference for the given document id.
+     * The document id is an object that maps the primary keys of the collection (as defined in the Squid Console)
+     * to their values. There are a few exceptions:
+     * 1 - String document id is only supported for the `built_in_db` when a schema was not defined.
+     * 2 - Not all the fields in the document id are required. If a field is not provided, it will be generated on the
+     *     server once the document is created (if the integration supports it).
+     * 3 - When a document id is not provided, it will be treated as an empty object or empty string.
+     * 4 - When the document id is just a `string` and not provided (applies only for the `built_in_db`), it will be
+     *    generated on the server.
+     * 5 - If the collection in the `built_in_db` does not have a schema, the document id must be provided as a string.
+     *
+     * Examples:
+     * ```typescript
+     * // For a collection in the built_in_db that does not have a schema
+     * const docRef = collectionRef.doc('my-doc-id');
+     * const docRef = collectionRef.doc({id: my-doc-id'});
+     *
+     * // For a collection with a single primary key field called "id"
+     * const docRef = collectionRef.doc({id: 'my-doc-id'});
+     *
+     * // For a collection with a composite primary key
+     * const docRef = collectionRef.doc({id1: 'my-doc-id1', id2: 'my-doc-id2'});
+     * const docRef = collectionRef.doc({id1: 'my-doc-id1'}); // id2 will be generated on the server if the integration
+     * supports it
+     *
+     * // For a collection from the `built_in_db` without a defined schema when an id is not provided
+     *  const docRef = collectionRef.doc(); // The id will be generated on the server
+     * ```
+     *
+     * @param docId The document id as an object for the different fields in the primary key or a string.
+     * @returns A document reference for the given document id.
+     */
+    doc(docId?: DocIdOrDocIdObj): DocumentReference<T>;
+    /**
+     * Inserts multiple documents into the collection.
+     */
+    insertMany(docs: Array<DocIdAndData<T>>, txId?: string): Promise<void>;
+    /**
+     * Deletes multiple documents from the collection.
+     */
+    deleteMany(docIdsOrReferences: Array<DocIdOrDocIdObj | DocumentReference<T>>, txId?: string): Promise<void>;
+    /**
+     * Creates a `QueryBuilder` that can be used to query the collection.
+     *
+     * @returns A `QueryBuilder` that can be used to query the collection.
+     */
+    query(): QueryBuilder<T>;
+    /**
+     * Creates a `JoinQueryBuilder` that can be used to query the collection
+     * Note that when using a join query, you have to provide an alias for the query and for every other query
+     * participating in the join.
+     *
+     * @param alias The alias for the query.
+     * @returns A `JoinQueryBuilder` that can be used to query the collection and joins with other queries.
+     */
+    joinQuery<A extends Alias>(alias: A): JoinQueryBuilder<Record<A, []>, Record<A, T>, A, A>;
+    /**
+     * Performs `or` on a list of queries. All the queries need to be on the same collection.
+     * The result will be a merge of all the queries sorted by the same sort condition of the first query.
+     * Duplicate items will be removed.
+     * @param builders The list of query builders to merge. (A query builder can be returned from the {@link query}
+     *   method).
+     * @returns A query builder that can be used to perform the `or` operation.
+     */
+    or(...builders: QueryBuilder<T>[]): SnapshotEmitter<DocumentReference<T>>;
+}

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

@@ -1,13 +1 @@
-import { CollectionName, DocumentData, IntegrationId } from '@squidcloud/common';
-import { CollectionReference } from './collection-reference';
-import { DocumentReferenceFactory } from './document-reference.factory';
-import { QueryBuilderFactory } from './query/query-builder.factory';
-import { QuerySubscriptionManager } from './query/query-subscription.manager';
-export declare class CollectionReferenceFactory {
-    private readonly documentReferenceFactory;
-    private readonly queryBuilderFactory;
-    private readonly querySubscriptionManager;
-    private readonly collections;
-    constructor(documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory, querySubscriptionManager: QuerySubscriptionManager);
-    get<T extends DocumentData>(collectionName: CollectionName, integrationId: IntegrationId): CollectionReference<T>;
-}
+export {};