@squidcloud/client 1.0.46 → 1.0.48

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

@@ -0,0 +1,19 @@
+import { Observable } from 'rxjs';
+/** A handler for a distributed lock that can be released. */
+export interface DistributedLock {
+    /**
+     * Releases the lock.
+     * @returns A promise that resolves when the lock is released.
+     */
+    release(): Promise<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-reference.d.ts

@@ -66,14 +66,41 @@ export declare class DocumentReference<T extends DocumentData = any> {
      * 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<Record<Paths<T>, any>>, 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(path: Paths<T>, value: any, transactionId?: TransactionId): Promise<void>;
-    /** Similar to `update`, but only deletes the given path. */
+    /**
+     * 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
@@ -84,6 +111,10 @@ export declare class DocumentReference<T extends DocumentData = any> {
      *
      * 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>;
     /**
@@ -95,6 +126,9 @@ export declare class DocumentReference<T extends DocumentData = any> {
      *
      * 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/socket.manager.d.ts

@@ -2,7 +2,7 @@ import { ClientId, MessageFromClient, MessageToClient } from '@squidcloud/common
 import { Observable } from 'rxjs';
 import { DestructManager } from './destruct.manager';
 export interface SocketManagerInterface {
-    observeNotifications(): Observable<MessageToClient>;
+    observeNotifications<T extends MessageToClient>(): Observable<T>;
     observeConnectionReady(): Observable<boolean>;
     sendMessage(message: MessageFromClient): void;
 }
@@ -18,7 +18,7 @@ export declare class SocketManager implements SocketManagerInterface {
     private socket;
     private firstConnection;
     constructor(clientId: ClientId, socketIoEndpoint: string, messageNotificationWrapper: (fn: () => any) => any, destructManager: DestructManager, extraHeaders?: Record<string, string>);
-    observeNotifications(): Observable<MessageToClient>;
+    observeNotifications<T extends MessageToClient>(): Observable<T>;
     observeConnectionReady(): Observable<boolean>;
     sendMessage(message: MessageFromClient): void;
     private connect;

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

@@ -3,6 +3,7 @@ import { Observable } from 'rxjs';
 import { CollectionReference } from './collection-reference';
 import { GraphQLClient } from './graphql-client';
 import { TransactionId } from './types';
+import { DistributedLock } from './distributed-lock.manager';
 /** The different options that can be used to initialize a Squid instance. */
 export interface SquidOptions {
     /**
@@ -56,6 +57,7 @@ export declare class Squid {
     private readonly graphqlClientFactory;
     private readonly destructManager;
     private readonly documentIdentityService;
+    private readonly distributedLockManager;
     private static readonly squidInstancesMap;
     /**
      * Creates a new instance of Squid with the given options.
@@ -162,6 +164,16 @@ export declare class Squid {
      * @returns A GraphQL client for the given integration.
      */
     graphql: (integrationId: IntegrationId) => GraphQLClient;
+    /**
+     * Returns a distributed lock for the given mutex. The lock can be used to synchronize access to a shared resource.
+     * The lock will be released when the release method on the returned object is invoked or whenever the connection
+     * with the server is lost.
+     * @param mutex A string that uniquely identifies the lock.
+     * @param exclusive Whether the lock should be exclusive or not. If the lock is exclusive, only one client can hold
+     *   the lock.
+     * @returns A promise that resolves with the lock object. The promise will reject if failed to acquire the lock.
+     */
+    distributedLock: (mutex: string, exclusive?: boolean) => Promise<DistributedLock>;
     /**
      * Destructs the Squid Client. Unsubscribes from all ongoing queries or requests, and clears the local data.
      * After invoking this method, the Squid client will not be usable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.46",
+  "version": "1.0.48",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/index.js",
   "types": "dist/typescript-client/src/index.d.ts",

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

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

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

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

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

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

package/dist/typescript-client/src/testing/fake-rpc.manager.d.ts

@@ -1,20 +0,0 @@
-import { ClientRequestId } from '@squidcloud/common';
-import { DestructManager } from '../destruct.manager';
-import { RpcManager } from '../rpc.manager';
-import { FakeSocketManager } from './fake-socket.manager';
-export declare class FakeRpcManager extends RpcManager {
-    lastQueryClientRequestId: ClientRequestId | undefined;
-    lastPostRequest?: {
-        path: string;
-        message: any;
-    };
-    allPostRequests: Array<{
-        path: string;
-        message: any;
-    }>;
-    errorResponses: Array<any>;
-    constructor(socketManager: FakeSocketManager, destructManager: DestructManager);
-    setStaticHeader(key: string, value: string): void;
-    deleteStaticHeader(key: string): void;
-    post<T>(path: string, message: any): Promise<T>;
-}

package/dist/typescript-client/src/testing/fake-socket.manager.d.ts

@@ -1,9 +0,0 @@
-import { MessageFromClient, MessageToClient } from '@squidcloud/common';
-import { Observable, Subject } from 'rxjs';
-import { SocketManagerInterface } from '../socket.manager';
-export declare class FakeSocketManager implements SocketManagerInterface {
-    messagesToClient: Subject<MessageToClient>;
-    observeConnectionReady(): Observable<boolean>;
-    observeNotifications(): Observable<MessageToClient>;
-    sendMessage(message: MessageFromClient): void;
-}

package/dist/typescript-client/src/testing/squid-env-setup.d.ts

@@ -1,79 +0,0 @@
-import { ClientRequestId, CollectionName, DocId, IntegrationId, LockManager, MutationType, SquidDocument } from '@squidcloud/common';
-import { Subject, Subscription } from 'rxjs';
-import { CollectionReference } from '../collection-reference';
-import { CollectionReferenceFactory } from '../collection-reference.factory';
-import { DataManager } from '../data.manager';
-import { DestructManager } from '../destruct.manager';
-import DocumentIdentityService from '../document-identity.service';
-import { DocumentReferenceFactory } from '../document-reference.factory';
-import { DocumentStore } from '../document-store';
-import { MutationSender } from '../mutation/mutation-sender';
-import { JoinQueryBuilderFactory } from '../query/join-query-builder.factory';
-import { QueryBuilderFactory } from '../query/query-builder.factory';
-import { QuerySubscriptionManager } from '../query/query-subscription.manager';
-import { FakeRpcManager } from './fake-rpc.manager';
-import { FakeSocketManager } from './fake-socket.manager';
-export type TestDocTypeA = {
-    a: number;
-    b?: {
-        c: number;
-    };
-};
-export type TestDocTypeB = {
-    b: number;
-    c?: {
-        d: number;
-    };
-};
-export type QueryResponse = {
-    resCount: number;
-    results: Array<TestDocTypeA> | undefined;
-    receivedSubject: Subject<void>;
-};
-export type JoinQueryResponse = {
-    resCount: number;
-    results: Array<{
-        a: TestDocTypeA;
-        b: TestDocTypeB | undefined;
-    }> | undefined;
-    receivedSubject: Subject<void>;
-    subscription: Subscription;
-};
-export declare class SquidEnvSetup {
-    readonly querySubscriptionManager: QuerySubscriptionManager;
-    readonly socketManager: FakeSocketManager;
-    readonly rpcManager: FakeRpcManager;
-    readonly documentStore: DocumentStore;
-    readonly documentReferenceFactory: DocumentReferenceFactory;
-    readonly collectionReferenceFactory: CollectionReferenceFactory;
-    readonly queryBuilderFactory: QueryBuilderFactory;
-    readonly joinQueryBuilderFactory: JoinQueryBuilderFactory;
-    readonly lockManager: LockManager;
-    readonly mutationSender: MutationSender;
-    readonly dataManager: DataManager;
-    readonly clientId = "fakeClientId";
-    readonly destructManager: DestructManager;
-    readonly documentIdentityService: DocumentIdentityService;
-    readonly collectionA: CollectionReference<TestDocTypeA>;
-    readonly collectionB: CollectionReference<TestDocTypeB>;
-    constructor();
-    simulateQueryResponse(docs: Array<Partial<SquidDocument>>, collectionName: CollectionName, integrationId?: IntegrationId, clientRequestId?: ClientRequestId): void;
-    simulateMutationsResponse(updates: Array<{
-        mutationType: MutationType;
-        collectionName: CollectionName;
-        integrationId?: IntegrationId;
-        clientRequestId?: ClientRequestId;
-        doc: Partial<SquidDocument> & {
-            __docId__: DocId;
-        };
-    }>, mutationsTimestamp?: number): Promise<void>;
-    simulateErrorResponse(message: string): void;
-    runAsync(fn: () => any): Promise<void>;
-    getBuiltInDocId(idValue: string): string;
-    executeQueryOnCollectionA(subscribe?: boolean): QueryResponse;
-    executeJoinQuery(subscribe?: boolean): JoinQueryResponse;
-    simulateResponseForCollectionA(id?: string, a?: number): void;
-    simulateResponseForCollectionB(id: string, b: number): void;
-}
-export declare let squidEnvSetup: SquidEnvSetup;
-export declare function squidEnvSetupBeforeEach(): void;