client: expose shape|stream.lastOffset.

electric-sql · Nov 18, 2024 · 9a6eaf8 · 9a6eaf8
1 parent 640fc04
commit 9a6eaf8
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/packages/typescript-client/src/client.ts b/packages/typescript-client/src/client.ts
@@ -144,6 +144,7 @@ export interface ShapeStreamInterface<T extends Row<unknown> = Row> {
   isConnected(): boolean
 
   isUpToDate: boolean
+  lastOffset: Offset
   shapeHandle?: string
 }
 
@@ -249,6 +250,10 @@ export class ShapeStream<T extends Row<unknown> = Row>
     return this.#isUpToDate
   }
 
+  get lastOffset() {
+    return this.#lastOffset
+  }
+
   get error() {
     return this.#error
   }

diff --git a/packages/typescript-client/src/shape.ts b/packages/typescript-client/src/shape.ts
@@ -70,6 +70,10 @@ export class Shape<T extends Row<unknown> = Row> {
     return this.#stream.isUpToDate
   }
 
+  get lastOffset(): boolean {
+    return this.#stream.lastOffset
+  }
+
   get rows(): Promise<T[]> {
     return this.value.then((v) => Array.from(v.values()))
   }

diff --git a/packages/typescript-client/test/client.test.ts b/packages/typescript-client/test/client.test.ts
@@ -339,6 +339,23 @@ describe(`Shape`, () => {
     expect(shapeStream.isLoading()).false
   })
 
+  it(`should expose lastOffset`, async ({ issuesTableUrl }) => {
+    const shapeStream = new ShapeStream({
+      url: `${BASE_URL}/v1/shape`,
+      table: issuesTableUrl,
+      fetchClient: async (input, init) => {
+        await sleep(20)
+        return fetch(input, init)
+      },
+    })
+    const shape = new Shape(shapeStream)
+
+    expect(shapeStream.lastOffset).toBe("-1")
+    expect(shape.lastOffset).toBe(shapeStream.lastOffset)
+
+    shape.unsubscribeAll()
+  })
+
   it(`should honour replica: full`, async ({
     insertIssues,
     updateIssue,