@squidcloud/client 1.0.99 → 1.0.101

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

@@ -9,7 +9,7 @@ import { QueryBuilder } from './query/query-builder.factory';
  *  collection in a NoSQL database.
  *
  * Read more about collection references in the
- * [documentation]{@link https://docs.squid.cloud/docs/client-sdk/collection-reference}.
+ * [documentation]{@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference}.
  * @typeParam T The type of the document data.
  */
 export declare class CollectionReference<T extends DocumentData> {

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

@@ -8,7 +8,7 @@ import { TransactionId } from './types';
  * use to create a new document.
  *
  * Read more about document references in the
- * [documentation]{@link https://docs.squid.cloud/docs/client-sdk/document-reference}.
+ * [documentation]{@link https://docs.squid.cloud/docs/development-tools/client-sdk/document-reference}.
  * @typeParam T The type of the document data.
  */
 export declare class DocumentReference<T extends DocumentData = any> {

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

@@ -5,7 +5,7 @@ export declare class DocumentStore {
     hasData(squidDocId: SquidDocId): boolean;
     getDocument(squidDocId: SquidDocId): SquidDocument;
     getDocumentOrUndefined(squidDocId: SquidDocId): SquidDocument | undefined;
-    sortAndLimitDocs(docIdSet: Set<SquidDocId> | undefined, query: Query): Array<SquidDocument>;
+    sortAndLimitDocs(docIdSet: Set<SquidDocId>, query: Query): Array<SquidDocument>;
     private removeInternalProperties;
     migrateDocId(squidDocId: SquidDocId, newSquidDocId: SquidDocId): void;
 }

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

@@ -30,7 +30,7 @@ interface HasGrouped {
 /**
  * A query builder that can participate in a join.
  * To learn more about join queries, see
- * {@link https://docs.squid.cloud/docs/client-sdk/queries#joining-data-across-collections-and-integrations}.
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/queries#joining-data-across-collections-and-integrations}.
  */
 export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, LatestAlias extends Alias, RootAlias extends Alias> extends BaseQueryBuilder<ReturnType> implements SnapshotEmitter<WithDocumentReferences<ReturnType>>, HasGrouped, HasDereference {
     private readonly collectionName;

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

@@ -5,6 +5,8 @@ import DocumentIdentityService from '../document-identity.service';
 import { DocumentStore } from '../document-store';
 import { RpcManager } from '../rpc.manager';
 import { ClientIdService } from '../client-id.service';
+export declare const FETCH_BEYOND_LIMIT = 100;
+export declare const LIMIT_UNDERFLOW_TRIGGER = 20;
 interface OngoingQuery {
     clientRequestId: ClientRequestId;
     query: Query;
@@ -33,6 +35,20 @@ interface OngoingQuery {
     done: boolean;
     isInFlight: boolean;
     forceFetchFromServer: boolean;
+    /**
+     * If there's a limit, we request `limit + FETCH_BEYOND_LIMIT` documents from the server.
+     * If we got that many documents, that means there may be even more. In that case, if our result set goes below
+     * `limit + LIMIT_UNDERFLOW_TRIGGER` documents (due to local or remote deletions), we need to resend the query to the
+     * server to potentially get more documents.
+     * If the number of documents is less than `limit + FETCH_BEYOND_LIMIT`, that means there are not that many documents
+     * on the server, so we don't need to resend the query regardless of how small our result size is or becomes.
+     */
+    limitUnderflowState: LimitUnderflowState;
+}
+declare enum LimitUnderflowState {
+    UNKNOWN = 0,
+    DISABLED = 1,
+    ENABLED = 2
 }
 interface DocsAndAlias {
     docs: Array<SquidDocument>;

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

@@ -108,7 +108,7 @@ export declare class Squid {
      * If the integrationId is not provided, the `built_in_db` integration id will be used.
      *
      * For more information on the CollectionReference object, please refer to the
-     * documentation at {@link https://docs.squid.cloud/docs/client-sdk/collection-reference}.
+     * documentation at {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference}.
      *
      * @param collectionName The name of the collection.
      * @param integrationId The id of the integration, default to `built_in_db`.
@@ -121,7 +121,7 @@ export declare class Squid {
      * will be atomic. Note that mutations for different integrations will not be atomic.
      *
      * For more information about transactions in Squid, please refer to the
-     * documentation at {@link https://docs.squid.cloud/docs/client-sdk/transactions}.
+     * documentation at {@link https://docs.squid.cloud/docs/development-tools/client-sdk/transactions}.
      *
      * @param fn The callback to run as an atomic change. The function receives a transactionId that should be used for
      * all the mutations that should be atomic. The function should return a promise.
@@ -133,7 +133,7 @@ export declare class Squid {
      * Executes the given backend function with the given parameters and returns a promise with the result.
      *
      * For more information about backend functions in Squid, please refer to the
-     * documentation at {@link https://docs.squid.cloud/docs/backend/executables}.
+     * documentation at {@link https://docs.squid.cloud/docs/development-tools/backend/executables}.
      *
      * @param functionName The name of the function to execute on the server.
      * @param params The parameters to pass to the function.
@@ -145,7 +145,7 @@ export declare class Squid {
      * Executes the given named query with the given parameters and returns a promise with the result.
      *
      * For more information about named queries in Squid, please refer to the
-     * documentation at {@link https://docs.squid.cloud/docs/backend/named-queries}.
+     * documentation at {@link https://docs.squid.cloud/docs/development-tools/backend/named-queries}.
      *
      * @param integrationId The id of the integration that the named query is defined with.
      * @param queryName The name of the named query.
@@ -188,7 +188,7 @@ export declare class Squid {
         /**
          * Returns an AI Assistant client for the given integration. The AI Assistant client can be used to build and chat
          * with custom AI profiles. For more information about the AI Assistant in Squid, please refer to the documentation
-         * at {@link https://docs.squid.cloud/docs/integrations/ai/ai-assistant}.
+         * at {@link https://docs.squid.cloud/docs/ai/ai-assistant}.
          *
          * @param integrationId The id of the AI Assistant integration.
          * @returns An AI Assistant client.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.99",
+  "version": "1.0.101",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",