@squidcloud/client 1.0.62 → 1.0.64

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

@@ -1,83 +1,83 @@
-import { CollectionName, DocumentData, FieldSort, IntegrationId, SimpleQueryBuilder, SquidDocId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import DocumentIdentityService from '../document-identity.service';
-import { DocumentReference } from '../document-reference';
-import { DocumentReferenceFactory } from '../document-reference.factory';
-import { QuerySubscriptionManager } from './query-subscription.manager';
-export declare class QueryBuilderFactory {
-    private readonly querySubscriptionManager;
-    private readonly documentReferenceFactory;
-    private readonly documentIdentityService;
-    constructor(querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, documentIdentityService: DocumentIdentityService);
-    getForDocument<DocumentType extends DocumentData>(squidDocId: SquidDocId): QueryBuilder<DocumentType>;
-    get<DocumentType extends DocumentData>(collectionName: CollectionName, integrationId: IntegrationId): QueryBuilder<DocumentType>;
-}
-/** An interface for the different actions that can be performed on a query. */
-export interface QueryActions<DocumentType extends DocumentData> {
-    /**
-     * Returns a promise that resolves to the query results.
-     *
-     * @returns A promise that resolves to the query results.
-     */
-    snapshot(): Promise<Array<DocumentReference<DocumentType>>>;
-    /**
-     * Returns an observable that emits the query results and updates whenever the query results change unless
-     * `subscribe=false` is provided.
-     *
-     * Important: Make sure to unsubscribe from the observable when you are done with it.
-     *
-     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
-     * @returns An observable for the query results.
-     */
-    snapshots(subscribe?: boolean): Observable<Array<DocumentReference<DocumentType>>>;
-    /**
-     * Similar to `snapshots` but returns an observable that emits the changes to the query results. The first result
-     * will contain only inserts.
-     *
-     * @returns An observable for the query changes.
-     */
-    changes(): Observable<Changes<DocumentType>>;
-}
-/** A query builder that can be used to build a query that returns a list of documents. */
-export declare class QueryBuilder<DocumentType extends DocumentData> extends SimpleQueryBuilder<DocumentType> implements QueryActions<DocumentType> {
-    private readonly querySubscriptionManager;
-    private readonly documentReferenceFactory;
-    private readonly queryBuilderFactory;
-    private readonly documentIdentityService;
-    getSortOrder(): FieldSort<DocumentType>[];
-    /**
-     * @inheritDoc
-     */
-    snapshot(): Promise<Array<DocumentReference<DocumentType>>>;
-    /**
-     * @inheritDoc
-     */
-    snapshots(subscribe?: boolean): Observable<Array<DocumentReference<DocumentType>>>;
-    /**
-     * @inheritDoc
-     */
-    changes(): Observable<Changes<DocumentType>>;
-    /**
-     * A unique hash for the query. Identical queries should return the same hash
-     * value.
-     *
-     * @returns The query's hash string.
-     */
-    get hash(): string;
-}
-/** Describes the changes to a query result. */
-export declare class Changes<DocumentType extends DocumentData> {
-    /** The newly inserted documents to the query result */
-    readonly inserts: Array<DocumentReference<DocumentType>>;
-    /** The documents that were updated in the query result */
-    readonly updates: Array<DocumentReference<DocumentType>>;
-    /** The actual document data that was deleted from the query result */
-    readonly deletes: Array<DocumentType>;
-    constructor(
-    /** The newly inserted documents to the query result */
-    inserts: Array<DocumentReference<DocumentType>>, 
-    /** The documents that were updated in the query result */
-    updates: Array<DocumentReference<DocumentType>>, 
-    /** The actual document data that was deleted from the query result */
-    deletes: Array<DocumentType>);
-}
+import { CollectionName, DocumentData, FieldSort, IntegrationId, SimpleQueryBuilder, SquidDocId } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import DocumentIdentityService from '../document-identity.service';
+import { DocumentReference } from '../document-reference';
+import { DocumentReferenceFactory } from '../document-reference.factory';
+import { QuerySubscriptionManager } from './query-subscription.manager';
+export declare class QueryBuilderFactory {
+    private readonly querySubscriptionManager;
+    private readonly documentReferenceFactory;
+    private readonly documentIdentityService;
+    constructor(querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, documentIdentityService: DocumentIdentityService);
+    getForDocument<DocumentType extends DocumentData>(squidDocId: SquidDocId): QueryBuilder<DocumentType>;
+    get<DocumentType extends DocumentData>(collectionName: CollectionName, integrationId: IntegrationId): QueryBuilder<DocumentType>;
+}
+/** An interface for the different actions that can be performed on a query. */
+export interface QueryActions<DocumentType extends DocumentData> {
+    /**
+     * Returns a promise that resolves to the query results.
+     *
+     * @returns A promise that resolves to the query results.
+     */
+    snapshot(): Promise<Array<DocumentReference<DocumentType>>>;
+    /**
+     * Returns an observable that emits the query results and updates whenever the query results change unless
+     * `subscribe=false` is provided.
+     *
+     * Important: Make sure to unsubscribe from the observable when you are done with it.
+     *
+     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
+     * @returns An observable for the query results.
+     */
+    snapshots(subscribe?: boolean): Observable<Array<DocumentReference<DocumentType>>>;
+    /**
+     * Similar to `snapshots` but returns an observable that emits the changes to the query results. The first result
+     * will contain only inserts.
+     *
+     * @returns An observable for the query changes.
+     */
+    changes(): Observable<Changes<DocumentType>>;
+}
+/** A query builder that can be used to build a query that returns a list of documents. */
+export declare class QueryBuilder<DocumentType extends DocumentData> extends SimpleQueryBuilder<DocumentType> implements QueryActions<DocumentType> {
+    private readonly querySubscriptionManager;
+    private readonly documentReferenceFactory;
+    private readonly queryBuilderFactory;
+    private readonly documentIdentityService;
+    getSortOrder(): FieldSort<DocumentType>[];
+    /**
+     * @inheritDoc
+     */
+    snapshot(): Promise<Array<DocumentReference<DocumentType>>>;
+    /**
+     * @inheritDoc
+     */
+    snapshots(subscribe?: boolean): Observable<Array<DocumentReference<DocumentType>>>;
+    /**
+     * @inheritDoc
+     */
+    changes(): Observable<Changes<DocumentType>>;
+    /**
+     * A unique hash for the query. Identical queries should return the same hash
+     * value.
+     *
+     * @returns The query's hash string.
+     */
+    get hash(): string;
+}
+/** Describes the changes to a query result. */
+export declare class Changes<DocumentType extends DocumentData> {
+    /** The newly inserted documents to the query result */
+    readonly inserts: Array<DocumentReference<DocumentType>>;
+    /** The documents that were updated in the query result */
+    readonly updates: Array<DocumentReference<DocumentType>>;
+    /** The actual document data that was deleted from the query result */
+    readonly deletes: Array<DocumentType>;
+    constructor(
+    /** The newly inserted documents to the query result */
+    inserts: Array<DocumentReference<DocumentType>>, 
+    /** The documents that were updated in the query result */
+    updates: Array<DocumentReference<DocumentType>>, 
+    /** The actual document data that was deleted from the query result */
+    deletes: Array<DocumentType>);
+}

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

@@ -1,64 +1,64 @@
-import { ClientRequestId, Query, QuerySubscriptionId, SquidDocId, SquidDocument } from '@squidcloud/common';
-import { BehaviorSubject, Observable, Subject } from 'rxjs';
-import { DestructManager } from '../destruct.manager';
-import DocumentIdentityService from '../document-identity.service';
-import { DocumentStore } from '../document-store';
-import { RpcManager } from '../rpc.manager';
-import { Alias, JoinCondition } from './query.types';
-import { ClientIdService } from '../client-id.service';
-export declare class QuerySubscriptionManager {
-    private readonly rpcManager;
-    private readonly clientIdService;
-    private readonly documentStore;
-    private readonly destructManager;
-    private readonly documentIdentityService;
-    readonly safeToSendQueriesToServer: BehaviorSubject<boolean>;
-    onOrphanDocuments: Subject<string[]>;
-    private readonly ongoingQueries;
-    private readonly inflightQueriesCount;
-    /**
-     * The two maps below maintain the relation between document ids we know about locally to clientRequestIds (queries).
-     * This relation is used for determining whether a document can be safely removed.
-     */
-    private readonly clientRequestIdToLocalDocuments;
-    private readonly localDocumentToClientRequestIds;
-    private readonly queryMappingManager;
-    constructor(rpcManager: RpcManager, clientIdService: ClientIdService, documentStore: DocumentStore, destructManager: DestructManager, documentIdentityService: DocumentIdentityService);
-    hasOngoingQuery(clientRequestId: ClientRequestId): boolean;
-    getQuery(clientRequestId: ClientRequestId): Query;
-    setGotResponseFromServer(clientRequestId: ClientRequestId): void;
-    findQueriesForDocument(doc: SquidDocument, squidDocId: SquidDocId): Array<QuerySubscriptionId>;
-    /**
-     * Given the new document's properties, finds all the queries that should be notified with the new properties and
-     * updates the internal mappings (squidDocId --> client request Ids and, clientRequestId --> squidDocIds).
-     * Returns an array with all the previous and current client request ids (basically all the client request ids that
-     * will need to be notified due to the change of properties).
-     */
-    setClientRequestIdsForLocalDoc(squidDocId: SquidDocId, properties: SquidDocument | undefined): Array<ClientRequestId>;
-    errorOutAllQueries(squidDocId: SquidDocId, err: any): void;
-    notifyAllSubscriptions(clientRequestIds: ClientRequestId[]): void;
-    processQuery(query: Query, rootAlias: Alias, joins: Record<string, Query>, joinConditions: Record<Alias, JoinCondition>, subscribe: boolean): Observable<Array<Record<Alias, SquidDocument | undefined>>>;
-    hasOngoingQueryForDocId(squidDocId: string): boolean;
-    private removeClientRequestIdMapping;
-    waitForAllQueriesToFinish(): Promise<void>;
-    private registerQueryFinalizer;
-    /** Creates a graph of ongoing queries and returns the root of the graph. */
-    private createOngoingQueryGraph;
-    private collectAllObservables;
-    private joinResults;
-    private join;
-    private getOngoingQueriesBfs;
-    private updateOngoingQueryWithNewDataFromSupportingQuery;
-    private allOngoingQueriesGotServerResult;
-    private completeAllSupportedQueries;
-    private predestruct;
-    unsubscribe(): void;
-    hasSubscription(clientRequestId: ClientRequestId): boolean;
-    /** Sends the query request to the server and makes sure to unsubscribe once the subject completes. */
-    private sendQueryToServer;
-    /**
-     * naive way to refresh queries/subscriptions when we have a new client id
-     */
-    private refreshOngoingQueries;
-    private migrateDocIds;
-}
+import { ClientRequestId, Query, QuerySubscriptionId, SquidDocId, SquidDocument } from '@squidcloud/common';
+import { BehaviorSubject, Observable, Subject } from 'rxjs';
+import { DestructManager } from '../destruct.manager';
+import DocumentIdentityService from '../document-identity.service';
+import { DocumentStore } from '../document-store';
+import { RpcManager } from '../rpc.manager';
+import { Alias, JoinCondition } from './query.types';
+import { ClientIdService } from '../client-id.service';
+export declare class QuerySubscriptionManager {
+    private readonly rpcManager;
+    private readonly clientIdService;
+    private readonly documentStore;
+    private readonly destructManager;
+    private readonly documentIdentityService;
+    readonly safeToSendQueriesToServer: BehaviorSubject<boolean>;
+    onOrphanDocuments: Subject<string[]>;
+    private readonly ongoingQueries;
+    private readonly inflightQueriesCount;
+    /**
+     * The two maps below maintain the relation between document ids we know about locally to clientRequestIds (queries).
+     * This relation is used for determining whether a document can be safely removed.
+     */
+    private readonly clientRequestIdToLocalDocuments;
+    private readonly localDocumentToClientRequestIds;
+    private readonly queryMappingManager;
+    constructor(rpcManager: RpcManager, clientIdService: ClientIdService, documentStore: DocumentStore, destructManager: DestructManager, documentIdentityService: DocumentIdentityService);
+    hasOngoingQuery(clientRequestId: ClientRequestId): boolean;
+    getQuery(clientRequestId: ClientRequestId): Query;
+    setGotResponseFromServer(clientRequestId: ClientRequestId): void;
+    findQueriesForDocument(doc: SquidDocument, squidDocId: SquidDocId): Array<QuerySubscriptionId>;
+    /**
+     * Given the new document's properties, finds all the queries that should be notified with the new properties and
+     * updates the internal mappings (squidDocId --> client request Ids and, clientRequestId --> squidDocIds).
+     * Returns an array with all the previous and current client request ids (basically all the client request ids that
+     * will need to be notified due to the change of properties).
+     */
+    setClientRequestIdsForLocalDoc(squidDocId: SquidDocId, properties: SquidDocument | undefined): Array<ClientRequestId>;
+    errorOutAllQueries(squidDocId: SquidDocId, err: any): void;
+    notifyAllSubscriptions(clientRequestIds: ClientRequestId[]): void;
+    processQuery(query: Query, rootAlias: Alias, joins: Record<string, Query>, joinConditions: Record<Alias, JoinCondition>, subscribe: boolean): Observable<Array<Record<Alias, SquidDocument | undefined>>>;
+    hasOngoingQueryForDocId(squidDocId: string): boolean;
+    private removeClientRequestIdMapping;
+    waitForAllQueriesToFinish(): Promise<void>;
+    private registerQueryFinalizer;
+    /** Creates a graph of ongoing queries and returns the root of the graph. */
+    private createOngoingQueryGraph;
+    private collectAllObservables;
+    private joinResults;
+    private join;
+    private getOngoingQueriesBfs;
+    private updateOngoingQueryWithNewDataFromSupportingQuery;
+    private allOngoingQueriesGotServerResult;
+    private completeAllSupportedQueries;
+    private predestruct;
+    unsubscribe(): void;
+    hasSubscription(clientRequestId: ClientRequestId): boolean;
+    /** Sends the query request to the server and makes sure to unsubscribe once the subject completes. */
+    private sendQueryToServer;
+    /**
+     * naive way to refresh queries/subscriptions when we have a new client id
+     */
+    private refreshOngoingQueries;
+    private migrateDocIds;
+}

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

@@ -1,14 +1,14 @@
-import { FieldName } from '@squidcloud/common';
-/**
- * An alias for a join result. This is used to disambiguate fields in the result.
- */
-export type Alias = string;
-/**
- * A join condition.
- * The join conditions defines the alias for the left side of the join and the field names to join on.
- */
-export interface JoinCondition {
-    leftAlias: Alias;
-    leftFieldName: FieldName;
-    rightFieldName: FieldName;
-}
+import { FieldName } from '@squidcloud/common';
+/**
+ * An alias for a join result. This is used to disambiguate fields in the result.
+ */
+export type Alias = string;
+/**
+ * A join condition.
+ * The join conditions defines the alias for the left side of the join and the field names to join on.
+ */
+export interface JoinCondition {
+    leftAlias: Alias;
+    leftFieldName: FieldName;
+    rightFieldName: FieldName;
+}

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

@@ -1,28 +1,28 @@
-import { AuthManager } from './auth.manager';
-import { ClientIdService } from './client-id.service';
-import { DestructManager } from './destruct.manager';
-import { SocketManager } from './socket.manager';
-export declare class RpcManager {
-    private readonly rpcEndpoint;
-    private readonly socketManager;
-    private readonly destructManager;
-    private readonly headers;
-    private readonly authManager;
-    private readonly clientIdService;
-    private readonly staticHeaders;
-    private readonly onGoingRpcCounter;
-    constructor(rpcEndpoint: string, socketManager: SocketManager, destructManager: DestructManager, headers: Record<string, string>, authManager: AuthManager, clientIdService: ClientIdService);
-    awaitAllSettled(): Promise<void>;
-    setStaticHeader(key: string, value: string): void;
-    deleteStaticHeader(key: string): void;
-    getEndpoint(): string;
-    getStaticHeaders(): Record<string, string>;
-    post<T>(path: string, message: any): Promise<T>;
-}
-export declare class RpcError extends Error {
-    readonly statusCode: number;
-    readonly statusText: string;
-    readonly headers: Headers;
-    readonly url: string;
-    constructor(statusCode: number, statusText: string, headers: Headers, url: string, message?: string);
-}
+import { AuthManager } from './auth.manager';
+import { ClientIdService } from './client-id.service';
+import { DestructManager } from './destruct.manager';
+import { SocketManager } from './socket.manager';
+export declare class RpcManager {
+    private readonly rpcEndpoint;
+    private readonly socketManager;
+    private readonly destructManager;
+    private readonly headers;
+    private readonly authManager;
+    private readonly clientIdService;
+    private readonly staticHeaders;
+    private readonly onGoingRpcCounter;
+    constructor(rpcEndpoint: string, socketManager: SocketManager, destructManager: DestructManager, headers: Record<string, string>, authManager: AuthManager, clientIdService: ClientIdService);
+    awaitAllSettled(): Promise<void>;
+    setStaticHeader(key: string, value: string): void;
+    deleteStaticHeader(key: string): void;
+    getEndpoint(): string;
+    getStaticHeaders(): Record<string, string>;
+    post<T>(path: string, message: any): Promise<T>;
+}
+export declare class RpcError extends Error {
+    readonly statusCode: number;
+    readonly statusText: string;
+    readonly headers: Headers;
+    readonly url: string;
+    constructor(statusCode: number, statusText: string, headers: Headers, url: string, message?: string);
+}

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

@@ -1,32 +1,32 @@
-import { MessageFromClient, MessageToClient } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { DestructManager } from './destruct.manager';
-import { AuthManager } from './auth.manager';
-import { ClientIdService } from './client-id.service';
-export declare class SocketManager {
-    private readonly clientIdService;
-    private readonly socketIoEndpoint;
-    private readonly messageNotificationWrapper;
-    private readonly destructManager;
-    private readonly authManager;
-    private readonly webSocketObserver;
-    private readonly allMessagesObserver;
-    private readonly connectionReady;
-    private readonly seenMessageIds;
-    private socket;
-    private firstConnection;
-    /**
-     * On a client disconnecting, we wait for a bit to see if the client reconnects,
-     * if no reconnect happens within the timeout, we consider the client to be too old.
-     * This value means we wait for 5 minutes before considering the client to be too old.
-     * Note: we make this a function so that we can easily override it in tests.
-     */
-    private clientTooOldThreshold;
-    constructor(clientIdService: ClientIdService, socketIoEndpoint: string, messageNotificationWrapper: (fn: () => any) => any, destructManager: DestructManager, extraHeaders: Record<string, string> | undefined, authManager: AuthManager);
-    observeNotifications<T extends MessageToClient>(): Observable<T>;
-    observeConnectionReady(): Observable<boolean>;
-    sendMessage(message: MessageFromClient): void;
-    private connect;
-    private setupMessageAcknowledgments;
-    private destruct;
-}
+import { MessageFromClient, MessageToClient } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { DestructManager } from './destruct.manager';
+import { AuthManager } from './auth.manager';
+import { ClientIdService } from './client-id.service';
+export declare class SocketManager {
+    private readonly clientIdService;
+    private readonly socketIoEndpoint;
+    private readonly messageNotificationWrapper;
+    private readonly destructManager;
+    private readonly authManager;
+    private readonly webSocketObserver;
+    private readonly allMessagesObserver;
+    private readonly connectionReady;
+    private readonly seenMessageIds;
+    private socket;
+    private firstConnection;
+    /**
+     * On a client disconnecting, we wait for a bit to see if the client reconnects,
+     * if no reconnect happens within the timeout, we consider the client to be too old.
+     * This value means we wait for 5 minutes before considering the client to be too old.
+     * Note: we make this a function so that we can easily override it in tests.
+     */
+    private clientTooOldThreshold;
+    constructor(clientIdService: ClientIdService, socketIoEndpoint: string, messageNotificationWrapper: (fn: () => any) => any, destructManager: DestructManager, extraHeaders: Record<string, string> | undefined, authManager: AuthManager);
+    observeNotifications<T extends MessageToClient>(): Observable<T>;
+    observeConnectionReady(): Observable<boolean>;
+    sendMessage(message: MessageFromClient): void;
+    private connect;
+    private setupMessageAcknowledgments;
+    private destruct;
+}