Add hasIncompleteResults to completion (#3051)

coda · Aug 30, 2024 · fde1bf3 · fde1bf3
1 parent 2cfa187
commit fde1bf3
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ This changelog keeps track of all changes to the Packs SDK. We follow convention
 
 ## [Unreleased]
 
+### Added
+
+- Internal change to completion
+
 ## [1.7.13] - 2024-08-29
 
 ### Changed
@@ -748,5 +752,4 @@ await myHelper(context);
 [1.7.12]: https://github.com/coda/packs-sdk/compare/v1.7.8...v1.7.12
 [1.7.11]: https://github.com/coda/packs-sdk/compare/v1.7.8...v1.7.11
 [1.7.10]: https://github.com/coda/packs-sdk/compare/v1.7.8...v1.7.10
-
 [1.7.13]: https://github.com/coda/packs-sdk/compare/v1.7.8...v1.7.13
diff --git a/api.ts b/api.ts
@@ -1035,7 +1035,7 @@ export interface SyncFormulaResult<K extends string, L extends string, SchemaT e
 
   /**
    * Return the list of deleted item ids for incremental sync deletion.
-   * 
+   *
    * TODO(ebo): Unhide this
    * @hidden
    */

diff --git a/api_types.ts b/api_types.ts
@@ -1024,4 +1024,14 @@ export interface SyncCompletionMetadata {
    * next sync execution.
    */
   incrementalContinuation?: Continuation;
+
+  /**
+   * Returned by an incremental sync if the results are incomplete. Will be ignored during a full sync.
+   *
+   * This will trigger a full sync so that complete results can be obtained.
+   *
+   * TODO(sam): Unhide this
+   * @hidden
+   */
+  hasIncompleteResults?: boolean;
 }
diff --git a/dist/api_types.d.ts b/dist/api_types.d.ts
diff --git a/dist/bundle.d.ts b/dist/bundle.d.ts
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@codahq/packs-sdk",
-  "version": "1.7.13",
+  "version": "1.7.14-prerelease.1",
   "license": "MIT",
   "workspaces": [
     "dev/eslint"
-Original file line number
+Diff line change
@@ Expand Up @@
       /**
        * Return the list of deleted item ids for incremental sync deletion.
-       *
+       *
        * TODO(ebo): Unhide this
        * @hidden
        */
@@ Expand Down @@