feat: add return fields for list backups and support ordering

Author: gkampitakis

src/backup/index.ts

@@ -7,6 +7,7 @@ import BackupRestorer from './backupRestorer.js';
 export type Backend = 'filesystem' | 's3' | 'gcs' | 'azure';
 export type BackupStatus = 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'SUCCESS' | 'FAILED';
 export type BackupCompressionLevel = 'DefaultCompression' | 'BestSpeed' | 'BestCompression';
+export type BackupListOrder = 'asc' | 'desc';
 
 export interface Backup {
   creator: () => BackupCreator;

src/collections/backup/client.ts

@@ -2,6 +2,7 @@ import {
   Backend,
   BackupCreateStatusGetter,
   BackupCreator,
+  BackupListOrder,
   BackupRestoreStatusGetter,
   BackupRestorer,
 } from '../../backup/index.js';
@@ -205,8 +206,12 @@ export const backup = (connection: Connection): Backup => {
           }
         : parseResponse(res);
     },
-    list: (backend: Backend): Promise<BackupReturn[]> => {
-      return connection.get<BackupReturn[]>(`/backups/${backend}`);
+    list: (backend: Backend, order?: BackupListOrder): Promise<BackupReturn[]> => {
+      let url = `/backups/${backend}`;
+      if (order) {
+        url += `?order=${order}`;
+      }
+      return connection.get<BackupReturn[]>(url);
     },
   };
 };
@@ -261,7 +266,8 @@ export interface Backup {
   /** List existing backups (completed and in-progress) created in a given backend.
    *
    * @param {Backend} backend Backend whence to list backups.
+   * @param {BackupListOrder} [order] Order in which to list backups.
    * @returns {Promise<BackupReturn[]>} The response from Weaviate.
    * */
-  list(backend: Backend): Promise<BackupReturn[]>;
+  list(backend: Backend, order?: BackupListOrder): Promise<BackupReturn[]>;
 }

src/collections/backup/types.ts

@@ -21,6 +21,12 @@ export type BackupReturn = BackupStatusReturn & {
   backend: Backend;
   /** The collections that were included in the backup */
   collections: string[];
+  /** Timestamp when the backup process started  */
+  startedAt?: Date;
+  /** Timestamp when the backup process completed (successfully or with failure) */
+  completedAt?: Date;
+  /** Size of the backup in Gibs */
+  size?: number;
 };
 
 /** Configuration options available when creating a backup */