@squidcloud/client 1.0.166 → 1.0.168

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

@@ -1,175 +0,0 @@
-import { DocTimestamp, Mutation, SquidDocId, SquidDocument } from './public-types';
-import { DestructManager } from './destruct.manager';
-import DocumentIdentityService from './document-identity.service';
-import { DocumentStore } from './document-store';
-import { MutationSender } from './mutation/mutation-sender';
-import { QueryBuilderFactory } from './query/query-builder.factory';
-import { QuerySender } from './query/query-sender';
-import { QuerySubscriptionManager } from './query/query-subscription.manager';
-import { SocketManager } from './socket.manager';
-import { TransactionId } from './types';
-import { LockManager } from '../../internal-common/src/utils/lock.manager';
-export interface DocTimestampMetadata {
-    timestamp: DocTimestamp;
-    expireTimestamp?: number;
-}
-export declare class DataManager {
-    private readonly documentStore;
-    private readonly mutationSender;
-    private readonly socketManager;
-    private readonly querySubscriptionManager;
-    private readonly queryBuilderFactory;
-    private readonly lockManager;
-    private readonly destructManager;
-    private readonly documentIdentityService;
-    private readonly querySender;
-    private readonly docIdToLocalTimestamp;
-    private currentTransactionId;
-    /**
-     * During a batch, any update to a document that may trigger an update to a query is collected here and once the batch
-     * ends, the relevant subscribes to these queries will be updated.
-     */
-    private readonly batchClientRequestIds;
-    /**
-     * In this map we save timestamps for documents that are available locally or recently deleted but need to remain
-     * here so if a mutation comes from the server we know whether to apply it or not based on the timestamp. For
-     * example, if a document is removed locally and immediately after, an update is received from the server - In that
-     * case, it may be the update pre-dates the data that was available locally a second ago. For that reason, the
-     * timestamp needs to be kept and even for removed documents it will be kept for ~20 seconds more.
-     *
-     * Eventually, this map is used as a gatekeeper for preventing old versions of a document (based on timestamp) to
-     * appear on the client.
-     */
-    private readonly docIdToServerTimestamp;
-    /**
-     * In the case of a local change (outgoing change) without a server timestamp, an incoming server update cannot be
-     * applied and needs to be queued until the local state allows it. In this case the incoming update will be queued in
-     * this map. Any future incoming server update to the same document will override the previous update in case it has
-     * a later timestamp.
-     */
-    private readonly pendingIncomingUpdates;
-    /**
-     * A mutation sent to the server will be stored in this map until it receives a timestamp from the server. These
-     * mutations were already applied locally and were sent to the server or about to be sent if sentToServer=false
-     * (or are queued in the MutationSender due to a lock). The existence of these pending mutations indicates the data
-     * manager to:
-     * 1 - Not apply any incoming server mutation while there are outgoing mutations without a timestamp
-     * 2 - Not delete the local document even if there are no queries related to this document - there is a chance
-     *     that there will be a future query that will need this document and the query needs to return the local version
-     *     of the document.
-     * 3 - Even when all outgoing mutations have a timestamp, it may be that there is a pending query in flight that will
-     *     need to return the document. In this case, the local document may be different from the server. Hence, it
-     *     cannot accept the server change and will wait for another update from the server. For this purpose, timestamp
-     *     will be stored in docsToTimestamp for ~20 more seconds.
-     *
-     * Note: Only one entry per squidDocId can be with sentToServer=false. This is true since all updates to the same doc
-     *       in the same batch are appended (and reduced) to the same outgoing mutation object.
-     */
-    private readonly pendingOutgoingMutations;
-    private readonly pendingOutgoingMutationsChanged;
-    /**
-     * A subject for whether there are outgoing mutations. If there are outgoing mutations, any incoming update from the
-     * server will be delayed until all the outgoing mutations will be acknowledged by the server.
-     * This mechanism is needed to avoid this case:
-     *
-     * collection.docRef('a').delete();
-     * collection.snapshots().subscribe((res) => {
-     *   // The result here may include doc with id='a' since the delete mutation was not acknowledged.
-     * });
-     *
-     * If we wait for the acknowledgment message, we will have a server timestamp and will be able to ignore the incoming
-     * result for document with id='a'.
-     */
-    private readonly outgoingMutationsEmpty;
-    /**
-     * When applying an outgoing mutation, there may be a short time that the mutation is not yet inserted into the
-     * pending outgoing mutations map. In this case, we mark the document id as known to be dirty and remove it from the
-     * set once the pending outgoing mutations map is updated.
-     */
-    private readonly knownDirtyDocs;
-    private readonly failedDocsToResync;
-    private readonly refreshDocIdToTimestamp;
-    private deleteExpiredTimestampsInterval;
-    private handleIncomingMessagesForTests;
-    constructor(documentStore: DocumentStore, mutationSender: MutationSender, socketManager: SocketManager, querySubscriptionManager: QuerySubscriptionManager, queryBuilderFactory: QueryBuilderFactory, lockManager: LockManager, destructManager: DestructManager, documentIdentityService: DocumentIdentityService, querySender: QuerySender);
-    getProperties(squidDocId: SquidDocId): SquidDocument | undefined;
-    /** Whether a document has changes that are out of sync with the server. */
-    isDirty(squidDocId: SquidDocId): boolean;
-    /**
-     * Runs the provided function without sending mutations to the server while collecting the updates to the different
-     * queries. Local updates will still be applied. Once the batch finishes, all the updates will be sent to the server
-     * and the different queries will be notified. runInTransaction may be invoked inside another runInTransaction, only
-     * the top level batch will trigger updates to the server.
-     */
-    runInTransaction<T = any>(fn: (transactionId: TransactionId) => Promise<T>, transactionId?: TransactionId): Promise<T>;
-    /** Applies a mutation done from the client (from DocumentReference) and sends it to the server. */
-    applyOutgoingMutation(mutation: Mutation, transactionId: TransactionId | undefined): Promise<void>;
-    /** Same as runInTransaction with the exception that the passed function runs synchronously. */
-    private runInTransactionSync;
-    /** Remove properties from the document record that should not be sent to the server. */
-    private removeInternalProperties;
-    /** Listens and handles mutations and snapshots notifications from the socketManager. */
-    private handleNotifications;
-    private handleIncomingMutations;
-    private handleIncomingQuerySnapshots;
-    /**
-     * Returns a boolean for whether some updates were ignored because the client knows of a later timestamp for those
-     * documents.
-     */
-    private applyIncomingUpdates;
-    private maybeApplyIncomingUpdate;
-    private refreshQueryMapping;
-    private destruct;
-    private stopDeleteExpiredTimestampsJob;
-    /**
-     * Removes entries from the docToTimestamp map for all the documents that are no longer relevant for this client.
-     * If a document is currently tracked, we forget it.
-     * Cases a document is considered not relevant anymore:
-     * 1 - There are no outgoing or incoming updates for this document AND:
-     *   a - The document was deleted on the server and this client already received a notification about it OR
-     *   b - The document no longer has a query that will keep it up-to-date
-     */
-    private startDeleteExpiredTimestampsJob;
-    /**
-     * Whether the document is tracked by any pending mutations or ongoing queries.
-     */
-    isTracked(squidDocId: string): boolean;
-    /**
-     * Whether a document exists locally, but is no longer tracked by any mutations or queries. This is often the case
-     * for in-memory DocumentReferences that are not part of any query.
-     */
-    isForgotten(squidDocId: SquidDocId): boolean;
-    /**
-     * Whether a document only exists locally. This means that the document has never by sent to or received from the
-     * server.
-     */
-    isLocalOnly(squidDocId: SquidDocId): boolean;
-    /**
-     * Whether the document has even been acknowledged by the server. Acknowledgements occur when an incoming query or
-     * mutation is received, and when an outgoing mutation is acknowledged.
-     */
-    hasBeenAcknowledged(squidDocId: SquidDocId): boolean;
-    /**
-     * Updates the document with the new properties, returns true if an update was done or false in case the doc did not
-     * change.
-     */
-    private updateDocumentFromSnapshot;
-    private finishTransaction;
-    private sendAllUnsentOutgoingMutations;
-    private sendMutationsForIntegration;
-    private removeOutgoingMutation;
-    private resyncFailedUpdates;
-    private refreshUpdatedDocuments;
-    private groupOutgoingMutationsByIntegrationId;
-    /**
-     * Handles the case that due to some change (an incoming or outgoing change to a document), a document becomes orphan.
-     * That is, there are no ongoing queries that will keep it up-to-date.
-     * An orphan document should not stay locally since it may be stale after some time.
-     */
-    private handleOrphanDocs;
-    private acknowledgeDocument;
-    private setExpiration;
-    private forgetDocument;
-    private migrateDocIds;
-    private hasPendingSentMutations;
-}

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

@@ -1,13 +0,0 @@
-import { Observable } from 'rxjs';
-export type DestructorFn = () => Promise<void> | void;
-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;
-}

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

@@ -1,16 +0,0 @@
-import { Observable } from 'rxjs';
-/** A handler for a distributed lock that can be released. */
-export interface DistributedLock {
-    /** Releases the lock. */
-    release(): void;
-    /**
-     * Whether the lock has been released.
-     * @returns True if the lock has been released.
-     */
-    isReleased(): boolean;
-    /**
-     * Observes when the lock is released (It may be released due to a connection issue)
-     * @returns An observable that emits when the lock is released.
-     */
-    observeRelease(): Observable<void>;
-}

package/dist/typescript-client/src/document-identity.service.d.ts

@@ -1,12 +0,0 @@
-import { Observable } from 'rxjs';
-import { DestructManager } from './destruct.manager';
-import { DocumentStore } from './document-store';
-import { IdResolutionMap } from '../../internal-common/src/types/mutation.types';
-export default class DocumentIdentityService {
-    private readonly documentStore;
-    private readonly destructManager;
-    private readonly changeNotifier;
-    constructor(documentStore: DocumentStore, destructManager: DestructManager);
-    migrate(idResolutionMap: IdResolutionMap): void;
-    observeChanges(): Observable<IdResolutionMap>;
-}

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

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

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

@@ -1,13 +0,0 @@
-import { SquidDocId } from './public-types';
-import { DataManager } from './data.manager';
-import DocumentIdentityService from './document-identity.service';
-import { DocumentReference } from './document-reference';
-import { QueryBuilderFactory } from './query/query-builder.factory';
-export declare class DocumentReferenceFactory {
-    private readonly documentIdentityService;
-    private dataManager;
-    constructor(documentIdentityService: DocumentIdentityService);
-    create(squidDocId: SquidDocId, queryBuilderFactory: QueryBuilderFactory): DocumentReference;
-    setDataManager(dataManager: DataManager): void;
-    private getCollectionKey;
-}

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

@@ -1,14 +0,0 @@
-import { FieldType, Query, SquidDocId, SquidDocument } from './public-types';
-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;
-    compareValues(a: FieldType | undefined, b: FieldType | undefined): number;
-    compareSquidDocs(a: SquidDocument, b: SquidDocument, sortFieldNames: string[], sortOrders: ('asc' | 'desc')[]): number;
-    group(sortedDocs: SquidDocument[], sortFieldNames: string[]): SquidDocument[][];
-    sortAndLimitDocs(docIdSet: Set<SquidDocId>, query: Query): Array<SquidDocument>;
-    private removeInternalProperties;
-    migrateDocId(squidDocId: SquidDocId, newSquidDocId: SquidDocId): void;
-}

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

@@ -1,14 +0,0 @@
-import { RpcManager } from './rpc.manager';
-import { GraphQLRequest, IntegrationId, SupportedSquidRegion } 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: SupportedSquidRegion, 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. */
-    mutate<T = Record<string, any>>(request: GraphQLRequest): Promise<T | null | undefined>;
-}

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

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

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

@@ -1,11 +0,0 @@
-export * from './public-types';
-export * from './public-utils';
-export { AiChatbotProfileReference } from './ai-chatbot-client';
-export { Changes, QueryBuilder } from './query/query-builder.factory';
-export { CollectionReference } from './collection-reference';
-export { DocumentReference } from './document-reference';
-export { GraphQLClient } from './graphql-client';
-export { JoinQueryBuilder } from './query/join-query-builder.factory';
-export { Squid, SquidOptions } from './squid';
-export { TransactionId } from './types';
-export { deserializeQuery } from './query/deserializer';

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

@@ -1,12 +0,0 @@
-import { RpcManager } from '../rpc.manager';
-import { QuerySender } from '../query/query-sender';
-import { LockManager } from '../../../internal-common/src/utils/lock.manager';
-import { IntegrationId, Mutation } from '../public-types';
-import { MutateResponse } from '../../../internal-common/src/types/mutation.types';
-export declare class MutationSender {
-    private readonly rpcManager;
-    private readonly lockManager;
-    private readonly querySender;
-    constructor(rpcManager: RpcManager, lockManager: LockManager, querySender: QuerySender);
-    sendMutations(mutations: Array<Mutation>, integrationId: IntegrationId): Promise<MutateResponse>;
-}

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

@@ -1,7 +0,0 @@
-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>;
-}

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

@@ -1,37 +0,0 @@
-export * from '../../internal-common/src/public-types/ai-assistant.public-types';
-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';
-export * from '../../internal-common/src/public-types/context.public-types';
-export * from '../../internal-common/src/public-types/distributed-lock.public-context';
-export * from '../../internal-common/src/public-types/document.public-types';
-export * from '../../internal-common/src/public-types/graphql.public-context';
-export * from '../../internal-common/src/public-types/graphql.public-types';
-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/ai_chatbot.types';
-export * from '../../internal-common/src/public-types/integrations/api.types';
-export * from '../../internal-common/src/public-types/integrations/auth.types';
-export * from '../../internal-common/src/public-types/integrations/database.types';
-export * from '../../internal-common/src/public-types/integrations/observability.types';
-export * from '../../internal-common/src/public-types/integrations/queue-types';
-export * from '../../internal-common/src/public-types/integrations/schemas';
-export * from '../../internal-common/src/public-types/mutation.public-context';
-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/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';
-export * from '../../internal-common/src/public-types/schema.public-types';
-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/socket.public-types';
-export * from '../../internal-common/src/public-types/topic.public-context';
-export * from '../../internal-common/src/public-types/typescript.public-types';

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

@@ -1 +0,0 @@
-export * from '../../internal-common/src/public-utils/id-utils';

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

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