@tldraw/sync-core 5.3.0-next.2fa9c61a8de6 → 5.3.0-next.6c821af8959b

package/src/lib/TLSyncStorage.ts

@@ -92,6 +92,13 @@ export interface TLSyncStorage<R extends UnknownRecord> {
 	 * `RoomSnapshot['documents']` so a lane can be persisted and re-seeded via a merged snapshot.
 	 */
 	getObjectsSnapshot?(): RoomSnapshot['documents']
+
+	/**
+	 * The same entries for the given ids, for callers that need a handful of records rather than the
+	 * whole (parsed) lane. Ids with no object-lane record are omitted — document-lane ids included —
+	 * and duplicates yield one entry.
+	 */
+	getObjectsByIds?(ids: Iterable<string>): RoomSnapshot['documents']
 }
 
 /**

package/src/test/storageContractSuite.ts

@@ -128,6 +128,28 @@ export function registerStorageContractTests(factory: StorageContractFactory) {
 				})
 			})
 
+			it('returns targeted object-lane entries by id from getObjectsByIds', () => {
+				const storage = createPartitioned(makeContractSnapshot(contractRecords))
+				const newPage = makePage('lane')
+				storage.transaction((txn) => txn.set(newPage.id, newPage))
+
+				const pageId = contractRecords[1].id
+				const entries = storage.getObjectsByIds!([newPage.id, pageId])
+				expect(entries.map((d) => d.state.id).sort()).toEqual([newPage.id, pageId].sort())
+				// same entry shape as getObjectsSnapshot: state + lastChangedClock
+				const laneEntry = entries.find((d) => d.state.id === newPage.id)!
+				expect(laneEntry.state).toEqual(newPage)
+				expect(laneEntry.lastChangedClock).toBe(storage.getClock())
+
+				// unknown ids and document-lane ids are omitted; duplicates yield one entry
+				expect(storage.getObjectsByIds!(['page:nope', TLDOCUMENT_ID])).toEqual([])
+				expect(storage.getObjectsByIds!([newPage.id, newPage.id]).length).toBe(1)
+
+				// a deleted record stops being returned
+				storage.transaction((txn) => txn.delete(newPage.id))
+				expect(storage.getObjectsByIds!([newPage.id])).toEqual([])
+			})
+
 			it('round-trips through a merged snapshot (persist lanes separately, re-seed together)', () => {
 				const storage = createPartitioned(makeContractSnapshot(contractRecords))
 				const merged = {