@squidcloud/client 1.0.148 → 1.0.150

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

@@ -1,11 +1,11 @@
-import { ApiEndpointId, IntegrationId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { ClientIdService } from './client-id.service';
-export declare class ApiManager {
-    private readonly clientIdService;
-    private readonly rpcManager;
-    private readonly apiServerUrlOverrideMapping;
-    constructor(clientIdService: ClientIdService, rpcManager: RpcManager, apiServerUrlOverrideMapping?: Record<IntegrationId, string>);
-    callApiAndSubscribe<T>(integrationId: IntegrationId, endpointId: ApiEndpointId, request: Record<string, any>): Observable<T>;
-}
+import { ApiEndpointId, IntegrationId } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { RpcManager } from './rpc.manager';
+import { ClientIdService } from './client-id.service';
+export declare class ApiManager {
+    private readonly clientIdService;
+    private readonly rpcManager;
+    private readonly apiServerUrlOverrideMapping;
+    constructor(clientIdService: ClientIdService, rpcManager: RpcManager, apiServerUrlOverrideMapping?: Record<IntegrationId, string>);
+    callApiAndSubscribe<T>(integrationId: IntegrationId, endpointId: ApiEndpointId, request: Record<string, any>): Observable<T>;
+}

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

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

package/dist/typescript-client/src/backend-function.manager.d.ts

@@ -1,9 +1,9 @@
-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: unknown[]): Observable<T>;
-}
+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: unknown[]): Observable<T>;
+}

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

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

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

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

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

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

package/dist/typescript-client/src/connection-details.d.ts

@@ -1,23 +1,23 @@
-import { ClientId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-/**
- * Provides information about the connection to the Squid Server.
- */
-export declare class ConnectionDetails {
-    private readonly clientIdService;
-    private readonly socketManager;
-    private isConnected;
-    /** Whether the Squid Client SDK is currently connected to the Squid Server. */
-    get connected(): boolean;
-    /**
-     * A unique client ID that is assigned to the client. This client ID is also available to the different backend
-     * function in the context object.
-     * Note: The client ID may change after a long disconnect.
-     */
-    get clientId(): ClientId;
-    /**
-     * Returns an observable that emits true when the client is connected to the server and false when the client is
-     * disconnected from the server.
-     */
-    observeConnected(): Observable<boolean>;
-}
+import { ClientId } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+/**
+ * Provides information about the connection to the Squid Server.
+ */
+export declare class ConnectionDetails {
+    private readonly clientIdService;
+    private readonly socketManager;
+    private isConnected;
+    /** Whether the Squid Client SDK is currently connected to the Squid Server. */
+    get connected(): boolean;
+    /**
+     * A unique client ID that is assigned to the client. This client ID is also available to the different backend
+     * function in the context object.
+     * Note: The client ID may change after a long disconnect.
+     */
+    get clientId(): ClientId;
+    /**
+     * Returns an observable that emits true when the client is connected to the server and false when the client is
+     * disconnected from the server.
+     */
+    observeConnected(): Observable<boolean>;
+}