supabase / supabase-flutter / 32956264435
89%

DEFAULT BRANCH: main
Ran
Jobs 10
Files 120
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 88.552%. Remained the same
32956264435

push

github

web-flow 
docs(storage_client): enable public_member_api_docs (#1776)

## Summary
Enables `public_member_api_docs` for `supabase_storage` and documents
its public API:

- `Bucket`, `AnalyticsBucket`, `FileObject`/`FileObjectV2`
- The `*Options` and `Paginated*` types (`BucketOptions`,
`ListBucketsOptions`, `FileOptions`, `SearchOptions`, `SortBy`,
`FileSort`, `PaginatedSearchOptions`, `PaginatedFile`,
`PaginatedFolder`, `PaginatedListResult`)
- `SignedUrl` and its result types (`SignedUrlResult`,
`SignedUrlSuccess`, `SignedUrlFailure`, `UploadResponse`,
`SignedUploadURLResponse`)
- The storage exceptions,
`ResizeMode`/`RequestImageFormat`/`DownloadBehavior`
- The vector API types (`VectorDataType`, `DistanceMetric`,
`VectorBucket`, `VectorIndex`, `Vector`, `VectorMatch`, and their list
results)
- The remaining API namespace constructors (`StorageBucketApi`,
`StorageFileApi`, `SupabaseStorageClient`, `SupabaseVectorsClient`,
`StorageVectorBucketApi`, `StorageVectorIndexApi`)

This is the last package from
[SDK-1449](https://linear.app/supabase/issue/SDK-1449/enable-public-member-api-docs-and-document-the-public-api)'s
original measurement, so all of the ticket's proposed scope is now
covered across separate PRs (#1767–#1776).

## Test plan
- [x] `dart analyze` reports no issues
- [x] `dart format .` produces no diff
- [x] `dart test` passes (271 tests)
- [x] Dependent packages `supabase` and `supabase_flutter` still analyze
cleanly

6049 of 6831 relevant lines covered (88.55%)

4.57 hits per line

Coverage Regressions

Lines Coverage ∆ File
31
72.65
 0.0% packages/supabase_auth/lib/src/types/mfa.dart
14
76.67
 0.0% packages/supabase_auth/lib/src/types/jwt.dart
11
84.41
 0.0% packages/supabase_auth/lib/src/auth_client.dart
5
73.58
 0.0% packages/supabase_auth/lib/src/types/user_attributes.dart
4
90.48
 0.0% packages/supabase_auth/lib/src/types/auth_exception.dart
4
92.73
 0.0% packages/supabase_auth/lib/src/types/types.dart
3
96.97
 0.0% packages/supabase_auth/lib/src/auth_admin_api.dart
3
0.0
 0.0% packages/supabase_auth/lib/src/types/error_code.dart
3
95.71
 0.0% packages/supabase_auth/lib/src/types/session.dart
2
97.83
 0.0% packages/supabase_auth/lib/src/auth_mfa_api.dart
2
91.67
 0.0% packages/supabase_auth/lib/src/types/auth_response.dart
Jobs
ID Job ID Ran Files Coverage
3 supabase_auth - 32956264435.3 30
90.57
 GitHub Action Run
4 supabase_storage - 32956264435.4 9
97.35
 GitHub Action Run
5 supabase_functions - 32956264435.5 4
93.81
 GitHub Action Run
6 supabase_realtime - 32956264435.6 13
90.27
 GitHub Action Run
7 iceberg - 32956264435.7 6
68.52
 GitHub Action Run
8 supabase_flutter - 32956264435.8 11
82.22
 GitHub Action Run
9 postgrest - 32956264435.9 11
84.59
 GitHub Action Run
10 supabase - 32956264435.10 14
93.49
 GitHub Action Run
10 yet_another_json_isolate - 32948304016.10 1
98.44
 GitHub Action Run
9 supabase_common - 32951661159.9 21
86.96
 GitHub Action Run
Source Files on build 32956264435