Skip to content

Commit cc8ff0e

Browse files
Undo Api Report
1 parent 2106dd6 commit cc8ff0e

File tree

4 files changed

+91
-13
lines changed

4 files changed

+91
-13
lines changed

common/api-review/firestore-exp.api.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
5353
get path(): string;
5454
// (undocumented)
5555
readonly type = "collection";
56-
withConverter(converter: null): CollectionReference<DocumentData>;
57-
// (undocumented)
5856
withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
5957
}
6058

@@ -103,8 +101,6 @@ export class DocumentReference<T = DocumentData> {
103101
get parent(): CollectionReference<T>;
104102
get path(): string;
105103
readonly type = "document";
106-
withConverter(converter: null): DocumentReference<DocumentData>;
107-
// (undocumented)
108104
withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
109105
}
110106

@@ -322,8 +318,6 @@ export class Query<T = DocumentData> {
322318
protected constructor();
323319
readonly firestore: FirebaseFirestore;
324320
readonly type: 'query' | 'collection';
325-
withConverter(converter: null): Query<DocumentData>;
326-
// (undocumented)
327321
withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
328322
}
329323

common/api-review/firestore-lite.api.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
4747
get path(): string;
4848
// (undocumented)
4949
readonly type = "collection";
50-
withConverter(converter: null): CollectionReference<DocumentData>;
51-
// (undocumented)
5250
withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
5351
}
5452

@@ -83,8 +81,6 @@ export class DocumentReference<T = DocumentData> {
8381
get parent(): CollectionReference<T>;
8482
get path(): string;
8583
readonly type = "document";
86-
withConverter(converter: null): DocumentReference<DocumentData>;
87-
// (undocumented)
8884
withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
8985
}
9086

@@ -199,8 +195,6 @@ export class Query<T = DocumentData> {
199195
protected constructor();
200196
readonly firestore: FirebaseFirestore;
201197
readonly type: 'query' | 'collection';
202-
withConverter(converter: null): Query<DocumentData>;
203-
// (undocumented)
204198
withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
205199
}
206200

common/api-review/messaging-exp.api.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ export interface NotificationPayload {
6262
title?: string;
6363
}
6464

65+
// Warning: (ae-internal-missing-underscore) The name "onBackgroundMessage" should be prefixed with an underscore because the declaration is marked as @internal
66+
//
67+
// @internal
68+
export function onBackgroundMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
69+
6570
// @public
6671
export function onMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
6772

common/api-review/storage.api.md

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,32 @@
66

77
import { CompleteFn } from '@firebase/util';
88
import { FirebaseApp } from '@firebase/app';
9+
import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
910
import { FirebaseError } from '@firebase/util';
11+
import { _FirebaseService } from '@firebase/app';
1012
import { NextFn } from '@firebase/util';
13+
import { Provider } from '@firebase/component';
1114
import { Subscribe } from '@firebase/util';
1215
import { Unsubscribe } from '@firebase/util';
1316

1417
// @public
1518
export function deleteObject(ref: StorageReference): Promise<void>;
1619

20+
// @internal (undocumented)
21+
export class _FbsBlob {
22+
constructor(data: Blob | Uint8Array | ArrayBuffer, elideCopy?: boolean);
23+
// (undocumented)
24+
static getBlob(...args: Array<string | _FbsBlob>): _FbsBlob | null;
25+
// (undocumented)
26+
size(): number;
27+
// (undocumented)
28+
slice(startByte: number, endByte: number): _FbsBlob | null;
29+
// (undocumented)
30+
type(): string;
31+
// (undocumented)
32+
uploadData(): Blob | Uint8Array;
33+
}
34+
1735
// @public
1836
export interface FirebaseStorageError extends FirebaseError {
1937
serverResponse: string | null;
@@ -33,6 +51,9 @@ export interface FullMetadata extends UploadMetadata {
3351
updated: string;
3452
}
3553

54+
// @internal (undocumented)
55+
export function _getChild(ref: StorageReference, childPath: string): _Reference;
56+
3657
// @public
3758
export function getDownloadURL(ref: StorageReference): Promise<string>;
3859

@@ -61,12 +82,50 @@ export interface ListResult {
6182
prefixes: StorageReference[];
6283
}
6384

85+
// @internal
86+
export class _Location {
87+
constructor(bucket: string, path: string);
88+
// (undocumented)
89+
readonly bucket: string;
90+
// (undocumented)
91+
bucketOnlyServerUrl(): string;
92+
// (undocumented)
93+
fullServerUrl(): string;
94+
// (undocumented)
95+
get isRoot(): boolean;
96+
// (undocumented)
97+
static makeFromBucketSpec(bucketString: string): _Location;
98+
// (undocumented)
99+
static makeFromUrl(url: string): _Location;
100+
// (undocumented)
101+
get path(): string;
102+
}
103+
64104
// @public
65105
export function ref(storage: StorageService, url?: string): StorageReference;
66106

67107
// @public
68108
export function ref(storageOrRef: StorageService | StorageReference, path?: string): StorageReference;
69109

110+
// @internal
111+
export class _Reference {
112+
// Warning: (ae-forgotten-export) The symbol "StorageService" needs to be exported by the entry point index.d.ts
113+
constructor(_service: StorageService_2, location: string | _Location);
114+
get bucket(): string;
115+
get fullPath(): string;
116+
// (undocumented)
117+
_location: _Location;
118+
get name(): string;
119+
// (undocumented)
120+
protected _newRef(service: StorageService_2, location: _Location): _Reference;
121+
get parent(): _Reference | null;
122+
get root(): _Reference;
123+
get storage(): StorageService_2;
124+
_throwIfRoot(name: string): void;
125+
// @override
126+
toString(): string;
127+
}
128+
70129
// @public
71130
export interface SettableMetadata {
72131
cacheControl?: string | undefined;
@@ -101,7 +160,7 @@ export interface StorageReference {
101160
}
102161

103162
// @public
104-
export interface StorageService {
163+
export interface StorageService extends _FirebaseService {
105164
readonly app: FirebaseApp;
106165
maxOperationRetryTime: number;
107166
maxUploadRetryTime: number;
@@ -158,6 +217,32 @@ export interface UploadTask {
158217
then(onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null, onRejected?: ((error: FirebaseStorageError) => unknown) | null): Promise<unknown>;
159218
}
160219

220+
// @internal
221+
export class _UploadTask {
222+
constructor(ref: _Reference, blob: _FbsBlob, metadata?: Metadata | null);
223+
_blob: _FbsBlob;
224+
cancel(): boolean;
225+
catch<T>(onRejected: (p1: FirebaseStorageError_2) => T | Promise<T>): Promise<T>;
226+
// Warning: (ae-forgotten-export) The symbol "Metadata" needs to be exported by the entry point index.d.ts
227+
_metadata: Metadata | null;
228+
// Warning: (ae-forgotten-export) The symbol "TaskEvent" needs to be exported by the entry point index.d.ts
229+
// Warning: (ae-forgotten-export) The symbol "StorageObserver" needs to be exported by the entry point index.d.ts
230+
// Warning: (ae-forgotten-export) The symbol "ErrorFn" needs to be exported by the entry point index.d.ts
231+
// Warning: (ae-forgotten-export) The symbol "CompleteFn" needs to be exported by the entry point index.d.ts
232+
// Warning: (ae-forgotten-export) The symbol "Unsubscribe" needs to be exported by the entry point index.d.ts
233+
// Warning: (ae-forgotten-export) The symbol "Subscribe" needs to be exported by the entry point index.d.ts
234+
on(type: TaskEvent_2, nextOrObserver?: StorageObserver_2<UploadTaskSnapshot_2> | ((a: UploadTaskSnapshot_2) => unknown), error?: ErrorFn, completed?: CompleteFn_2): Unsubscribe_2 | Subscribe_2<UploadTaskSnapshot_2>;
235+
pause(): boolean;
236+
resume(): boolean;
237+
// Warning: (ae-forgotten-export) The symbol "UploadTaskSnapshot" needs to be exported by the entry point index.d.ts
238+
get snapshot(): UploadTaskSnapshot_2;
239+
// Warning: (ae-forgotten-export) The symbol "InternalTaskState" needs to be exported by the entry point index.d.ts
240+
_state: InternalTaskState;
241+
// Warning: (ae-forgotten-export) The symbol "FirebaseStorageError" needs to be exported by the entry point index.d.ts
242+
then<U>(onFulfilled?: ((value: UploadTaskSnapshot_2) => U | Promise<U>) | null, onRejected?: ((error: FirebaseStorageError_2) => U | Promise<U>) | null): Promise<U>;
243+
_transferred: number;
244+
}
245+
161246
// @public
162247
export interface UploadTaskSnapshot {
163248
bytesTransferred: number;

0 commit comments

Comments
 (0)