feat: list-v2 endpoint

Author: fenos

infra/docker-compose.yml

@@ -49,15 +49,9 @@ services:
       context: ./postgres
     ports:
       - 5432:5432
-    command:
-      - postgres
-      - -c
-      - wal_level=logical
+    command: postgres -c config_file=/etc/postgresql/postgresql.conf
     environment:
-      POSTGRES_DB: postgres
-      POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
-      POSTGRES_PORT: 5432
     healthcheck:
       test: [ "CMD-SHELL", "pg_isready" ]
       interval: 10s

infra/postgres/Dockerfile

@@ -1,19 +1,10 @@
-FROM supabase/postgres:0.13.0
-
-COPY 00-initial-schema.sql /docker-entrypoint-initdb.d/00-initial-schema.sql
-COPY auth-schema.sql /docker-entrypoint-initdb.d/01-auth-schema.sql
-COPY storage-schema.sql /docker-entrypoint-initdb.d/02-storage-schema.sql
+FROM supabase/postgres:15.8.1.044
+#
+#COPY 00-initial-schema.sql /docker-entrypoint-initdb.d/00-initial-schema.sql
+#COPY auth-schema.sql /docker-entrypoint-initdb.d/01-auth-schema.sql
+#COPY storage-schema.sql /docker-entrypoint-initdb.d/02-storage-schema.sql
 
 # Build time defaults
-ARG build_POSTGRES_DB=postgres
-ARG build_POSTGRES_USER=postgres
-ARG build_POSTGRES_PASSWORD=postgres
-ARG build_POSTGRES_PORT=5432
 
-# Run time values
-ENV POSTGRES_DB=$build_POSTGRES_DB
-ENV POSTGRES_USER=$build_POSTGRES_USER
-ENV POSTGRES_PASSWORD=$build_POSTGRES_PASSWORD
-ENV POSTGRES_PORT=$build_POSTGRES_PORT
 
 EXPOSE 5432

infra/postgres/storage-schema.sql

@@ -5,7 +5,6 @@ alter default privileges in schema storage grant all on tables to postgres, anon
 alter default privileges in schema storage grant all on functions to postgres, anon, authenticated, service_role;
 alter default privileges in schema storage grant all on sequences to postgres, anon, authenticated, service_role;
 
-DROP TABLE IF EXISTS "storage"."buckets";
 CREATE TABLE "storage"."buckets" (
     "id" text not NULL,
     "name" text NOT NULL,
@@ -17,7 +16,6 @@ CREATE TABLE "storage"."buckets" (
 );
 CREATE UNIQUE INDEX "bname" ON "storage"."buckets" USING BTREE ("name");
 
-DROP TABLE IF EXISTS "storage"."objects";
 CREATE TABLE "storage"."objects" (
     "id" uuid NOT NULL DEFAULT extensions.uuid_generate_v4(),
     "bucket_id" text,

infra/storage/Dockerfile

@@ -1,3 +1,3 @@
-FROM supabase/storage-api:v1.8.2
+FROM supabase/storage-api:v1.19.1
 
 RUN apk add curl --no-cache

src/lib/types.ts

@@ -97,6 +97,18 @@ export interface SearchOptions {
   search?: string
 }
 
+export interface SearchV2Options {
+  limit?: number
+  prefix?: string
+  cursor?: string
+  with_delimiter?: boolean
+}
+
+export interface SearchV2Result {
+  folders: { name: string }[]
+  objects: FileObject[]
+}
+
 export interface FetchParameters {
   /**
    * Pass in an AbortController's signal to cancel the request.

src/packages/StorageFileApi.ts

@@ -10,6 +10,8 @@ import {
   DestinationOptions,
   FileObjectV2,
   Camelize,
+  SearchV2Options,
+  SearchV2Result,
 } from '../lib/types'
 
 const DEFAULT_SEARCH_OPTIONS = {
@@ -788,6 +790,43 @@ export default class StorageFileApi {
     }
   }
 
+  /**
+   * @experimental this method signature might change in the future
+   * @param options search options
+   * @param parameters
+   */
+  async listV2(
+    options?: SearchV2Options,
+    parameters?: FetchParameters
+  ): Promise<
+    | {
+        data: SearchV2Result[]
+        error: null
+      }
+    | {
+        data: null
+        error: StorageError
+      }
+  > {
+    try {
+      const body = { ...options }
+      const data = await post(
+        this.fetch,
+        `${this.url}/object/list-v2/${this.bucketId}`,
+        body,
+        { headers: this.headers },
+        parameters
+      )
+      return { data, error: null }
+    } catch (error) {
+      if (isStorageError(error)) {
+        return { data: null, error }
+      }
+
+      throw error
+    }
+  }
+
   protected encodeMetadata(metadata: Record<string, any>) {
     return JSON.stringify(metadata)
   }

test/storageFileApi.test.ts

@@ -319,6 +319,22 @@ describe('Object API', () => {
       ])
     })
 
+    test('list objects V2', async () => {
+      await storage.from(bucketName).upload(uploadPath, file)
+      const res = await storage.from(bucketName).listV2({
+        prefix: 'testpath',
+      })
+
+      expect(res.error).toBeNull()
+      expect(res.data).toEqual(
+        expect.objectContaining({
+          hasNext: false,
+          folders: [],
+          objects: expect.arrayContaining([expect.objectContaining({ name: uploadPath })]),
+        })
+      )
+    })
+
     test('move object to different path', async () => {
       const newPath = `testpath/file-moved-${Date.now()}.txt`
       await storage.from(bucketName).upload(uploadPath, file)