NK-588 Add storage index listing pagination support (#161)

heroiclabs · Oct 21, 2024 · c7b5486 · c7b5486
1 parent f48ddb5
commit c7b5486
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,9 @@ All notable changes to this project are documented below.
 The format is based on [keep a changelog](http://keepachangelog.com) and this project uses [semantic versioning](http://semver.org).
 
 ## [Unreleased]
+### Changed
+- Added pagination support to storage index listing.
+
 ### Added
 - New runtime function to list user notifications.
 

diff --git a/index.d.ts b/index.d.ts
@@ -3126,6 +3126,11 @@ declare namespace nkruntime {
         status?: string
     }
 
+    export interface StorageIndexResult {
+      objects: StorageObject[]
+      cursor: string | null
+    }
+
     export interface EnvelopeStatusUpdate {
         statusUpdate: StatusUpdateMessage
     }
@@ -4990,7 +4995,7 @@ declare namespace nkruntime {
          * @returns A list of storage objects matching the query criteria.
          * @throws {TypeError, GoError}
          */
-        storageIndexList(indexName: string, query: string, limit: number, order?: string[], callerId?: string | void): StorageObject[];
+        storageIndexList(indexName: string, query: string, limit: number, order?: string[], callerId?: string | void, cursor?: string): StorageIndexResult;
 
         /**
          * Get Satori object.

diff --git a/runtime/runtime.go b/runtime/runtime.go
@@ -1118,7 +1118,7 @@ type NakamaModule interface {
 	StorageRead(ctx context.Context, reads []*StorageRead) ([]*api.StorageObject, error)
 	StorageWrite(ctx context.Context, writes []*StorageWrite) ([]*api.StorageObjectAck, error)
 	StorageDelete(ctx context.Context, deletes []*StorageDelete) error
-	StorageIndexList(ctx context.Context, callerID, indexName, query string, limit int, order []string) (*api.StorageObjects, error)
+	StorageIndexList(ctx context.Context, callerID, indexName, query string, limit int, order []string, cursor string) (*api.StorageObjects, string, error)
 
 	MultiUpdate(ctx context.Context, accountUpdates []*AccountUpdate, storageWrites []*StorageWrite, storageDeletes []*StorageDelete, walletUpdates []*WalletUpdate, updateLedger bool) ([]*api.StorageObjectAck, []*WalletUpdateResult, error)