Skip to content

Commit 2c14d80

Browse files
committed
Merge branch 'master' into fei-9-rerelease
2 parents 7e1dbc2 + 3d99709 commit 2c14d80

File tree

1,043 files changed

+10566
-12607
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,043 files changed

+10566
-12607
lines changed

.changeset/chatty-cooks-drop.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/happy-planets-lick.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/stale-zebras-hug.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

.changeset/thick-ties-hang.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/tricky-seahorses-look.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
import { FirebaseApp } from '@firebase/app-exp';
88

9-
// @public (undocumented)
9+
// @public
1010
export interface Analytics {
1111
app: FirebaseApp;
1212
}
@@ -28,7 +28,7 @@ export interface ControlParams {
2828
send_to?: string | string[];
2929
}
3030

31-
// @public (undocumented)
31+
// @public
3232
export type Currency = string | number;
3333

3434
// @public
@@ -108,12 +108,12 @@ export interface EventParams {
108108
}
109109

110110
// @public
111-
export function getAnalytics(app: FirebaseApp): Analytics;
111+
export function getAnalytics(app?: FirebaseApp): Analytics;
112112

113113
// @public
114114
export function isSupported(): Promise<boolean>;
115115

116-
// @public (undocumented)
116+
// @public
117117
export interface Item {
118118
// (undocumented)
119119
affiliation?: string;
@@ -351,7 +351,7 @@ export function logEvent<T extends string>(analyticsInstance: Analytics, eventNa
351351
[key: string]: any;
352352
}, options?: AnalyticsCallOptions): void;
353353

354-
// @public @deprecated (undocumented)
354+
// @public @deprecated
355355
export interface Promotion {
356356
// (undocumented)
357357
creative_name?: string;
@@ -385,6 +385,4 @@ export function setUserId(analyticsInstance: Analytics, id: string, options?: An
385385
export function setUserProperties(analyticsInstance: Analytics, properties: CustomParams, options?: AnalyticsCallOptions): void;
386386

387387

388-
// (No @packageDocumentation comment for this package)
389-
390388
```

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

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,21 +58,13 @@ export interface _FirebaseAppInternal extends FirebaseApp {
5858

5959
// @public
6060
export interface FirebaseOptions {
61-
// (undocumented)
6261
apiKey?: string;
63-
// (undocumented)
6462
appId?: string;
65-
// (undocumented)
6663
authDomain?: string;
67-
// (undocumented)
6864
databaseURL?: string;
69-
// (undocumented)
7065
measurementId?: string;
71-
// (undocumented)
7266
messagingSenderId?: string;
73-
// (undocumented)
7467
projectId?: string;
75-
// (undocumented)
7668
storageBucket?: string;
7769
}
7870

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,7 @@ export class PhoneAuthCredential extends AuthCredential {
456456
export class PhoneAuthProvider {
457457
constructor(auth: Auth);
458458
static credential(verificationId: string, verificationCode: string): PhoneAuthCredential;
459+
static credentialFromError(error: FirebaseError): AuthCredential | null;
459460
static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
460461
static readonly PHONE_SIGN_IN_METHOD = SignInMethod.PHONE;
461462
static readonly PROVIDER_ID = ProviderId.PHONE;
@@ -707,6 +708,4 @@ export function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCode
707708
export function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;
708709

709710

710-
// (No @packageDocumentation comment for this package)
711-
712711
```

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

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
## API Report File for "@firebase/database-exp"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { FirebaseApp } from '@firebase/app';
8+
9+
// @public (undocumented)
10+
export function child(parent: Reference, path: string): Reference;
11+
12+
// @public
13+
export class DataSnapshot {
14+
child(path: string): DataSnapshot;
15+
exists(): boolean;
16+
exportVal(): any;
17+
forEach(action: (child: DataSnapshot) => boolean | void): boolean;
18+
hasChild(path: string): boolean;
19+
hasChildren(): boolean;
20+
get key(): string | null;
21+
get priority(): string | number | null;
22+
readonly ref: Reference;
23+
get size(): number;
24+
toJSON(): object | null;
25+
val(): any;
26+
}
27+
28+
// @public
29+
export function enableLogging(enabled: boolean, persistent?: boolean): any;
30+
31+
// @public
32+
export function enableLogging(logger: (message: string) => unknown): any;
33+
34+
// @public
35+
export function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;
36+
37+
// @public
38+
export function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;
39+
40+
// @public
41+
export function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;
42+
43+
// @public
44+
export type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
45+
46+
// @public
47+
export class FirebaseDatabase {
48+
readonly app: FirebaseApp;
49+
readonly 'type' = "database";
50+
}
51+
52+
// @public
53+
export function get(query: Query): Promise<DataSnapshot>;
54+
55+
// @public
56+
export function getDatabase(app?: FirebaseApp, url?: string): FirebaseDatabase;
57+
58+
// @public
59+
export function goOffline(db: FirebaseDatabase): void;
60+
61+
// @public
62+
export function goOnline(db: FirebaseDatabase): void;
63+
64+
// @public
65+
export function increment(delta: number): object;
66+
67+
// @public
68+
export function limitToFirst(limit: number): QueryConstraint;
69+
70+
// @public
71+
export function limitToLast(limit: number): QueryConstraint;
72+
73+
// @public
74+
export interface ListenOptions {
75+
readonly onlyOnce?: boolean;
76+
}
77+
78+
// @public
79+
export function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;
80+
81+
// @public
82+
export function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
83+
84+
// @public
85+
export function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
86+
87+
// @public
88+
export function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
89+
90+
// @public
91+
export function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
92+
93+
// @public
94+
export function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
95+
96+
// @public
97+
export function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
98+
99+
// @public
100+
export function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
101+
102+
// @public
103+
export function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
104+
105+
// @public
106+
export function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
107+
108+
// @public
109+
export function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
110+
111+
// @public
112+
export function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
113+
114+
// @public
115+
export function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
116+
117+
// @public
118+
export class OnDisconnect {
119+
cancel(): Promise<void>;
120+
remove(): Promise<void>;
121+
set(value: unknown): Promise<void>;
122+
setWithPriority(value: unknown, priority: number | string | null): Promise<void>;
123+
update(values: object): Promise<void>;
124+
}
125+
126+
// @public
127+
export function onDisconnect(ref: Reference): OnDisconnect;
128+
129+
// @public
130+
export function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
131+
132+
// @public
133+
export function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
134+
135+
// @public
136+
export function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
137+
138+
// @public
139+
export function orderByChild(path: string): QueryConstraint;
140+
141+
// @public
142+
export function orderByKey(): QueryConstraint;
143+
144+
// @public
145+
export function orderByPriority(): QueryConstraint;
146+
147+
// @public
148+
export function orderByValue(): QueryConstraint;
149+
150+
// @public
151+
export function push(parent: Reference, value?: unknown): ThenableReference;
152+
153+
// @public
154+
export interface Query {
155+
isEqual(other: Query | null): boolean;
156+
readonly ref: Reference;
157+
toJSON(): string;
158+
toString(): string;
159+
}
160+
161+
// @public
162+
export function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;
163+
164+
// @public
165+
export abstract class QueryConstraint {
166+
abstract readonly type: QueryConstraintType;
167+
}
168+
169+
// @public
170+
export type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
171+
172+
// @public
173+
export function ref(db: FirebaseDatabase, path?: string): Reference;
174+
175+
// @public
176+
export interface Reference extends Query {
177+
readonly key: string | null;
178+
readonly parent: Reference | null;
179+
readonly root: Reference;
180+
}
181+
182+
// @public
183+
export function refFromURL(db: FirebaseDatabase, url: string): Reference;
184+
185+
// @public
186+
export function remove(ref: Reference): Promise<void>;
187+
188+
// @public
189+
export function runTransaction(ref: Reference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
190+
191+
// @public
192+
export function serverTimestamp(): object;
193+
194+
// @public
195+
export function set(ref: Reference, value: unknown): Promise<void>;
196+
197+
// @public
198+
export function setPriority(ref: Reference, priority: string | number | null): Promise<void>;
199+
200+
// @public
201+
export function setWithPriority(ref: Reference, value: unknown, priority: string | number | null): Promise<void>;
202+
203+
// @public
204+
export function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
205+
206+
// @public
207+
export function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
208+
209+
// @public
210+
export interface ThenableReference extends Reference, Pick<Promise<Reference>, 'then' | 'catch'> {
211+
}
212+
213+
// @public
214+
export interface TransactionOptions {
215+
readonly applyLocally?: boolean;
216+
}
217+
218+
// @public
219+
export class TransactionResult {
220+
readonly committed: boolean;
221+
readonly snapshot: DataSnapshot;
222+
toJSON(): object;
223+
}
224+
225+
// @public
226+
export type Unsubscribe = () => void;
227+
228+
// @public
229+
export function update(ref: Reference, values: object): Promise<void>;
230+
231+
// @public
232+
export function useDatabaseEmulator(db: FirebaseDatabase, host: string, port: number): void;
233+
234+
235+
```

0 commit comments

Comments
 (0)