Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

feat(list): Add ability to sort using flat attributes (sort_by and sort_order) #249

Closed
raulb wants to merge 9 commits into from
Closed

feat(list): Add ability to sort using flat attributes (sort_by and sort_order) #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4028d6c
fix imports
raulb Aug 29, 2025
ea46146
feat(list): flatten options to sort by
raulb Aug 29, 2025
289f2d8
add tests and create a storage client for testing
raulb Aug 29, 2025
8ac617c
see if this fixes it
raulb Aug 29, 2025
e8b6a3c
add some more tests
raulb Aug 29, 2025
1ea4713
Revert "add some more tests"
raulb Aug 29, 2025
a64b88c
add tests and create a storage client for testing
raulb Aug 29, 2025
f7f58bf
Merge branch 'raulb/feat/update-list-params' of github.com:supabase/s…
raulb Aug 29, 2025
b4c0c9a
undo snake case attrs
raulb Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/StorageClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import StorageFileApi from './packages/StorageFileApi'
import StorageBucketApi from './packages/StorageBucketApi'
import { Fetch } from './lib/fetch'
import StorageBucketApi from './packages/StorageBucketApi'
import StorageFileApi from './packages/StorageFileApi'

export interface StorageClientOptions {
useNewHostname?: boolean
Expand Down
31 changes: 31 additions & 0 deletions test/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { StorageClient } from '../src/index'

export const STORAGE_URL = 'http://localhost:8000/storage/v1'

export const TEST_KEY = 'test-api-key'

export const JWT_KEY =
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYXV0aGVudGljYXRlZCIsInN1YiI6IjMxN2VhZGNlLTYzMWEtNDQyOS1hMGJiLWYxOWE3YTUxN2I0YSIsImlhdCI6MTcxMzQzMzgwMCwiZXhwIjoyMDI5MDA5ODAwfQ.jVFIR-MB7rNfUuJaUH-_CyDFZEHezzXiqcRcdrGd29o'

export function createStorageClient(options?: {
apikey?: string
jwt?: boolean
customUrl?: string
}) {
const { apikey = TEST_KEY, jwt = false, customUrl } = options || {}
const url = customUrl || STORAGE_URL

if (jwt) {
return new StorageClient(url, { Authorization: `Bearer ${JWT_KEY}` })
}

return new StorageClient(url, { apikey })
}

export function createJWTStorageClient(customUrl?: string) {
return createStorageClient({ jwt: true, customUrl })
}

export function createTestStorageClient(customUrl?: string) {
return createStorageClient({ customUrl })
}
9 changes: 2 additions & 7 deletions test/storageApi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
import { StorageClient } from '../src/index'
import { createJWTStorageClient } from './config'

// TODO: need to setup storage-api server for this test
const URL = 'http://localhost:8000/storage/v1'
const KEY =
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYXV0aGVudGljYXRlZCIsInN1YiI6IjMxN2VhZGNlLTYzMWEtNDQyOS1hMGJiLWYxOWE3YTUxN2I0YSIsImlhdCI6MTcxMzQzMzgwMCwiZXhwIjoyMDI5MDA5ODAwfQ.jVFIR-MB7rNfUuJaUH-_CyDFZEHezzXiqcRcdrGd29o'

const storage = new StorageClient(URL, { Authorization: `Bearer ${KEY}` })
const storage = createJWTStorageClient()
const newBucketName = `my-new-bucket-${Date.now()}`

describe('bucket api', () => {
Expand Down
68 changes: 23 additions & 45 deletions test/storageBucketApi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,6 @@
import { StorageClient } from '../src/index'
import { StorageError, StorageUnknownError } from '../src/lib/errors'

// Create a simple Response implementation for testing
class MockResponse {
ok: boolean
status: number
statusText: string
private body: string

constructor(body: string, options: { status: number; statusText: string }) {
this.body = body
this.status = options.status
this.statusText = options.statusText
this.ok = this.status >= 200 && this.status < 300
}

json() {
return Promise.resolve(JSON.parse(this.body))
}
}

// Mock URL and credentials for testing
const URL = 'http://localhost:8000/storage/v1'
const KEY = 'test-api-key'
import { StorageUnknownError } from '../src/lib/errors'
import { STORAGE_URL, createTestStorageClient, TEST_KEY } from './config'

describe('Bucket API Error Handling', () => {
beforeEach(() => {
Expand Down Expand Up @@ -64,13 +42,13 @@ describe('Bucket API Error Handling', () => {

urlTestCases.forEach(([inputUrl, expectUrl, description]) => {
it('should ' + description + ' if useNewHostname is true', () => {
const storage = new StorageClient(inputUrl, { apikey: KEY }, undefined, {
const storage = new StorageClient(inputUrl, { apikey: TEST_KEY }, undefined, {
useNewHostname: true,
})
expect(storage['url']).toBe(expectUrl)
})
it('should not modify host if useNewHostname is false', () => {
const storage = new StorageClient(inputUrl, { apikey: KEY }, undefined, {
const storage = new StorageClient(inputUrl, { apikey: TEST_KEY }, undefined, {
useNewHostname: false,
})
expect(storage['url']).toBe(inputUrl)
Expand All @@ -80,7 +58,7 @@ describe('Bucket API Error Handling', () => {

describe('listBuckets', () => {
it('handles missing authorization errors if header is not provided', async () => {
const storage = new StorageClient(URL)
const storage = new StorageClient(STORAGE_URL)
const { data, error } = await storage.listBuckets()
expect(data).toBeNull()
expect(error).not.toBeNull()
Expand All @@ -90,7 +68,7 @@ describe('Bucket API Error Handling', () => {
it('handles network errors', async () => {
const mockError = new Error('Network failure')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(mockError))
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.listBuckets()
expect(data).toBeNull()
Expand All @@ -103,7 +81,7 @@ describe('Bucket API Error Handling', () => {
const nonResponseError = new TypeError('Invalid argument')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(nonResponseError))

const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

// Check that the error is wrapped in a StorageUnknownError
const { data, error } = await storage.listBuckets()
Expand All @@ -114,7 +92,7 @@ describe('Bucket API Error Handling', () => {

it('throws non-StorageError exceptions', async () => {
// Create a storage client
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

// Create a spy on the get method that will throw a non-StorageError
const mockFn = jest.spyOn(require('../src/lib/fetch'), 'get').mockImplementationOnce(() => {
Expand All @@ -136,7 +114,7 @@ describe('Bucket API Error Handling', () => {
it('handles network errors', async () => {
const mockError = new Error('Network failure')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(mockError))
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.getBucket('non-existent-bucket')
expect(data).toBeNull()
Expand All @@ -148,7 +126,7 @@ describe('Bucket API Error Handling', () => {
const nonResponseError = new TypeError('Invalid bucket format')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(nonResponseError))

const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.getBucket('test-bucket')
expect(data).toBeNull()
Expand All @@ -158,7 +136,7 @@ describe('Bucket API Error Handling', () => {

it('throws non-StorageError exceptions', async () => {
// Create a storage client
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

// Create a spy on the get method that will throw a non-StorageError
const mockFn = jest.spyOn(require('../src/lib/fetch'), 'get').mockImplementationOnce(() => {
Expand All @@ -182,7 +160,7 @@ describe('Bucket API Error Handling', () => {
it('handles network errors', async () => {
const mockError = new Error('Network failure')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(mockError))
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.createBucket('new-bucket')
expect(data).toBeNull()
Expand All @@ -194,7 +172,7 @@ describe('Bucket API Error Handling', () => {
const nonResponseError = new TypeError('Invalid bucket configuration')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(nonResponseError))

const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.createBucket('test-bucket')
expect(data).toBeNull()
Expand All @@ -204,7 +182,7 @@ describe('Bucket API Error Handling', () => {

it('throws non-StorageError exceptions', async () => {
// Create a storage client
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

// Create a spy on the post method that will throw a non-StorageError
const mockFn = jest.spyOn(require('../src/lib/fetch'), 'post').mockImplementationOnce(() => {
Expand All @@ -228,7 +206,7 @@ describe('Bucket API Error Handling', () => {
it('handles network errors', async () => {
const mockError = new Error('Network failure')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(mockError))
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.updateBucket('existing-bucket', { public: true })
expect(data).toBeNull()
Expand All @@ -240,7 +218,7 @@ describe('Bucket API Error Handling', () => {
const nonResponseError = new TypeError('Invalid update options')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(nonResponseError))

const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.updateBucket('test-bucket', { public: true })
expect(data).toBeNull()
Expand All @@ -250,7 +228,7 @@ describe('Bucket API Error Handling', () => {

it('throws non-StorageError exceptions', async () => {
// Create a storage client
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

// Create a spy on the put method that will throw a non-StorageError
const mockFn = jest.spyOn(require('../src/lib/fetch'), 'put').mockImplementationOnce(() => {
Expand All @@ -274,7 +252,7 @@ describe('Bucket API Error Handling', () => {
it('handles network errors', async () => {
const mockError = new Error('Network failure')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(mockError))
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.emptyBucket('existing-bucket')
expect(data).toBeNull()
Expand All @@ -286,7 +264,7 @@ describe('Bucket API Error Handling', () => {
const nonResponseError = new TypeError('Operation not supported')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(nonResponseError))

const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.emptyBucket('test-bucket')
expect(data).toBeNull()
Expand All @@ -296,7 +274,7 @@ describe('Bucket API Error Handling', () => {

it('throws non-StorageError exceptions', async () => {
// Create a storage client
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

// Create a spy on the post method that will throw a non-StorageError
const mockFn = jest.spyOn(require('../src/lib/fetch'), 'post').mockImplementationOnce(() => {
Expand All @@ -320,7 +298,7 @@ describe('Bucket API Error Handling', () => {
it('handles network errors', async () => {
const mockError = new Error('Network failure')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(mockError))
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.deleteBucket('existing-bucket')
expect(data).toBeNull()
Expand All @@ -332,7 +310,7 @@ describe('Bucket API Error Handling', () => {
const nonResponseError = new TypeError('Invalid delete operation')
global.fetch = jest.fn().mockImplementation(() => Promise.reject(nonResponseError))

const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

const { data, error } = await storage.deleteBucket('test-bucket')
expect(data).toBeNull()
Expand All @@ -342,7 +320,7 @@ describe('Bucket API Error Handling', () => {

it('throws non-StorageError exceptions', async () => {
// Create a storage client
const storage = new StorageClient(URL, { apikey: KEY })
const storage = createTestStorageClient()

// Create a spy on the remove method that will throw a non-StorageError
const mockFn = jest
Expand Down
Loading