Skip to content

fix(storage, web): More explicit interop types #17828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+17 −50
Open

fix(storage, web): More explicit interop types #17828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0e95de
fix(storage, web): More explicit interop types
MichaelVerdon Oct 29, 2025
e59d4e2
fix: lint and unneccesary casts
MichaelVerdon Oct 29, 2025
1fa3f89
chore: format
MichaelVerdon Oct 29, 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
7 changes: 3 additions & 4 deletions packages/firebase_storage/firebase_storage_web/lib/src/interop/storage.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,7 @@ class StorageReference
/// Returns a [FullMetadata] from this reference at actual location.
Future<FullMetadata> getMetadata() async {
final data = await storage_interop.getMetadata(jsObject).toDart;
return FullMetadata.getInstance(
data! as storage_interop.FullMetadataJsImpl);
return FullMetadata.getInstance(data);
}

/// List items (files) and prefixes (folders) under this storage reference.
Expand All @@ -157,7 +156,7 @@ class StorageReference
/// [list()] may fail if there are too many unsupported objects in the bucket.
Future<ListResult> list(ListOptions? options) async {
final data = await storage_interop.list(jsObject, options?.jsObject).toDart;
return ListResult.getInstance(data! as storage_interop.ListResultJsImpl);
return ListResult.getInstance(data);
}

/// List all items (files) and prefixes (folders) under this storage reference.
Expand All @@ -173,7 +172,7 @@ class StorageReference
/// too many results.
Future<ListResult> listAll() async {
final data = await storage_interop.listAll(jsObject).toDart;
return ListResult.getInstance(data! as storage_interop.ListResultJsImpl);
return ListResult.getInstance(data);
}

/// Uploads data [blob] to the actual location with optional [metadata].
Expand Down
60 changes: 14 additions & 46 deletions packages/firebase_storage/firebase_storage_web/lib/src/interop/storage_interop.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ external JSPromise<JSString> getDownloadURL(ReferenceJsImpl ref);

@JS()
@staticInterop
external JSPromise /* FullMetadataJsImpl */ getMetadata(ReferenceJsImpl ref);
external JSPromise<FullMetadataJsImpl> getMetadata(ReferenceJsImpl ref);

@JS()
@staticInterop
external JSPromise /* ListResultJsImpl */ list(ReferenceJsImpl ref,
external JSPromise<ListResultJsImpl> list(ReferenceJsImpl ref,
[ListOptionsJsImpl? listOptions]);

@JS()
@staticInterop
external JSPromise /* ListResultJsImpl */ listAll(ReferenceJsImpl ref);
external JSPromise<ListResultJsImpl> listAll(ReferenceJsImpl ref);

@JS()
@staticInterop
Expand All @@ -61,7 +61,7 @@ external ReferenceJsImpl ref(JSAny storageOrRef, [JSString? urlOrPath]);

@JS()
@staticInterop
external JSPromise /* FullMetadataJsImpl */ updateMetadata(
external JSPromise<FullMetadataJsImpl> updateMetadata(
ReferenceJsImpl ref, SettableMetadataJsImpl settableMetadata);

@JS()
Expand All @@ -81,11 +81,7 @@ extension EmulatorOptionsJsImplX on EmulatorOptions {
external JSString? get mockUserToken;
}

@JS('FirebaseStorage')
@staticInterop
abstract class StorageJsImpl {}

extension StorageJsImplX on StorageJsImpl {
extension type StorageJsImpl._(JSObject _) implements JSObject {
external AppJsImpl get app;
external set app(AppJsImpl a);
external JSNumber get maxOperationRetryTime;
Expand All @@ -94,11 +90,7 @@ extension StorageJsImplX on StorageJsImpl {
external set maxUploadRetryTime(JSNumber t);
}

@JS('StorageReference')
@staticInterop
abstract class ReferenceJsImpl {}

extension ReferenceJsImplX on ReferenceJsImpl {
extension type ReferenceJsImpl._(JSObject _) implements JSObject {
external JSString get bucket;
external set bucket(JSString s);
external JSString get fullPath;
Expand All @@ -114,9 +106,8 @@ extension ReferenceJsImplX on ReferenceJsImpl {
}

@JS('FullMetadata')
@staticInterop
@anonymous
class FullMetadataJsImpl extends UploadMetadataJsImpl {
extension type FullMetadataJsImpl._(JSObject _)
implements UploadMetadataJsImpl, JSObject {
external factory FullMetadataJsImpl({
JSString bucket,
JSArray? downloadTokens,
Expand All @@ -136,9 +127,7 @@ class FullMetadataJsImpl extends UploadMetadataJsImpl {
JSString? contentType,
JSAny? customMetadata,
});
}

extension FullMetadataJsImplX on FullMetadataJsImpl {
external JSString get bucket;
// TODO - new API.
external JSArray? get downloadTokens;
Expand All @@ -154,9 +143,8 @@ extension FullMetadataJsImplX on FullMetadataJsImpl {
}

@JS('UploadMetadata')
@staticInterop
@anonymous
class UploadMetadataJsImpl extends SettableMetadataJsImpl {
extension type UploadMetadataJsImpl._(JSObject _)
implements SettableMetadataJsImpl, JSObject {
external factory UploadMetadataJsImpl(
{JSString? md5Hash,
JSString? cacheControl,
Expand All @@ -165,18 +153,12 @@ class UploadMetadataJsImpl extends SettableMetadataJsImpl {
JSString? contentLanguage,
JSString? contentType,
JSAny? customMetadata});
}

extension UploadMetadataJsImplX on UploadMetadataJsImpl {
external JSString? get md5Hash;
external set md5Hash(JSString? s);
}

@JS('UploadTask')
@staticInterop
abstract class UploadTaskJsImpl {}

extension UploadTaskJsImplX on UploadTaskJsImpl {
extension type UploadTaskJsImpl._(JSObject _) implements JSObject {
external UploadTaskSnapshotJsImpl get snapshot;
external set snapshot(UploadTaskSnapshotJsImpl t);
external JSBoolean cancel();
Expand All @@ -188,12 +170,7 @@ extension UploadTaskJsImplX on UploadTaskJsImpl {
[JSFunction? onResolve, JSFunction? onReject]);
}

@JS('UploadTaskSnapshot')
@staticInterop
@anonymous
abstract class UploadTaskSnapshotJsImpl {}

extension UploadTaskSnapshotJsImplX on UploadTaskSnapshotJsImpl {
extension type UploadTaskSnapshotJsImpl._(JSObject _) implements JSObject {
external JSNumber get bytesTransferred;
external FullMetadataJsImpl get metadata;
external ReferenceJsImpl get ref;
Expand All @@ -203,19 +180,15 @@ extension UploadTaskSnapshotJsImplX on UploadTaskSnapshotJsImpl {
}

@JS('SettableMetadata')
@staticInterop
@anonymous
class SettableMetadataJsImpl {
extension type SettableMetadataJsImpl._(JSObject _) implements JSObject {
external factory SettableMetadataJsImpl(
{JSString? cacheControl,
JSString? contentDisposition,
JSString? contentEncoding,
JSString? contentLanguage,
JSString? contentType,
JSAny? customMetadata});
}

extension SettableMetadataJsImplX on SettableMetadataJsImpl {
external JSString? get cacheControl;
external set cacheControl(JSString? s);
external JSString? get contentDisposition;
Expand Down Expand Up @@ -244,12 +217,7 @@ extension ListOptionsJsImplX on ListOptionsJsImpl {
external JSString? get pageToken;
}

@JS('ListResult')
@staticInterop
@anonymous
class ListResultJsImpl {}

extension ListResultJsImplX on ListResultJsImpl {
extension type ListResultJsImpl._(JSObject _) implements JSObject {
external JSArray /* ReferenceJsImpl */ get items;
external JSString? get nextPageToken;
external JSArray /* ReferenceJsImpl */ get prefixes;
Expand Down
Loading