Deployed the page to Github Pages.

This commit is contained in:
Batuhan Berk Başoğlu 2024-11-03 21:30:09 -05:00
parent 1d79754e93
commit 2c89899458
Signed by: batuhan-basoglu
SSH key fingerprint: SHA256:kEsnuHX+qbwhxSAXPUQ4ox535wFHu/hIRaa53FzxRpo
62797 changed files with 6551425 additions and 15279 deletions

View file

@ -0,0 +1,74 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseApp } from '@firebase/app-types';
import { FirebaseService } from '@firebase/app-types/private';
import { forceLongPolling, forceWebSockets, Database as ModularDatabase } from '@firebase/database';
import { Compat, EmulatorMockTokenOptions } from '@firebase/util';
import { Reference } from './Reference';
/**
* Class representing a firebase database.
*/
export declare class Database implements FirebaseService, Compat<ModularDatabase> {
readonly _delegate: ModularDatabase;
readonly app: FirebaseApp;
static readonly ServerValue: {
TIMESTAMP: object;
increment: (delta: number) => object;
};
/**
* The constructor should not be called by users of our public API.
*/
constructor(_delegate: ModularDatabase, app: FirebaseApp);
INTERNAL: {
delete: () => Promise<void>;
forceWebSockets: typeof forceWebSockets;
forceLongPolling: typeof forceLongPolling;
};
/**
* Modify this instance to communicate with the Realtime Database emulator.
*
* <p>Note: This method must be called before performing any other operation.
*
* @param host - the emulator host (ex: localhost)
* @param port - the emulator port (ex: 8080)
* @param options.mockUserToken - the mock auth token to use for unit testing Security Rules
*/
useEmulator(host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions;
}): void;
/**
* Returns a reference to the root or to the path specified in the provided
* argument.
*
* @param path - The relative string path or an existing Reference to a database
* location.
* @throws If a Reference is provided, throws if it does not belong to the
* same project.
* @returns Firebase reference.
*/
ref(path?: string): Reference;
ref(path?: Reference): Reference;
/**
* Returns a reference to the root or the path specified in url.
* We throw a exception if the url is not in the same domain as the
* current repo.
* @returns Firebase reference.
*/
refFromURL(url: string): Reference;
goOffline(): void;
goOnline(): void;
}

View file

@ -0,0 +1,207 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DataSnapshot as ModularDataSnapshot, Query as ExpQuery, DatabaseReference as ModularReference } from '@firebase/database';
import { Compat } from '@firebase/util';
import { Database } from './Database';
import { OnDisconnect } from './onDisconnect';
import { TransactionResult } from './TransactionResult';
/**
* Class representing a firebase data snapshot. It wraps a SnapshotNode and
* surfaces the public methods (val, forEach, etc.) we want to expose.
*/
export declare class DataSnapshot implements Compat<ModularDataSnapshot> {
readonly _database: Database;
readonly _delegate: ModularDataSnapshot;
constructor(_database: Database, _delegate: ModularDataSnapshot);
/**
* Retrieves the snapshot contents as JSON. Returns null if the snapshot is
* empty.
*
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
val(): unknown;
/**
* Returns the snapshot contents as JSON, including priorities of node. Suitable for exporting
* the entire node contents.
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
exportVal(): unknown;
toJSON(): unknown;
/**
* Returns whether the snapshot contains a non-null value.
*
* @returns Whether the snapshot contains a non-null value, or is empty.
*/
exists(): boolean;
/**
* Returns a DataSnapshot of the specified child node's contents.
*
* @param path - Path to a child.
* @returns DataSnapshot for child node.
*/
child(path: string): DataSnapshot;
/**
* Returns whether the snapshot contains a child at the specified path.
*
* @param path - Path to a child.
* @returns Whether the child exists.
*/
hasChild(path: string): boolean;
/**
* Returns the priority of the object, or null if no priority was set.
*
* @returns The priority.
*/
getPriority(): string | number | null;
/**
* Iterates through child nodes and calls the specified action for each one.
*
* @param action - Callback function to be called
* for each child.
* @returns True if forEach was canceled by action returning true for
* one of the child nodes.
*/
forEach(action: (snapshot: IteratedDataSnapshot) => boolean | void): boolean;
/**
* Returns whether this DataSnapshot has children.
* @returns True if the DataSnapshot contains 1 or more child nodes.
*/
hasChildren(): boolean;
get key(): string;
/**
* Returns the number of children for this DataSnapshot.
* @returns The number of children that this DataSnapshot contains.
*/
numChildren(): number;
/**
* @returns The Firebase reference for the location this snapshot's data came
* from.
*/
getRef(): Reference;
get ref(): Reference;
}
/**
* Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
*/
export interface IteratedDataSnapshot extends DataSnapshot {
key: string;
}
export interface SnapshotCallback {
(dataSnapshot: DataSnapshot, previousChildName?: string | null): unknown;
}
/**
* A Query represents a filter to be applied to a firebase location. This object purely represents the
* query expression (and exposes our public API to build the query). The actual query logic is in ViewBase.js.
*
* Since every Firebase reference is a query, Firebase inherits from this object.
*/
export declare class Query implements Compat<ExpQuery> {
readonly database: Database;
readonly _delegate: ExpQuery;
constructor(database: Database, _delegate: ExpQuery);
on(eventType: string, callback: SnapshotCallback, cancelCallbackOrContext?: ((a: Error) => unknown) | object | null, context?: object | null): SnapshotCallback;
off(eventType?: string, callback?: SnapshotCallback, context?: object | null): void;
/**
* Get the server-value for this query, or return a cached value if not connected.
*/
get(): Promise<DataSnapshot>;
/**
* Attaches a listener, waits for the first event, and then removes the listener
*/
once(eventType: string, callback?: SnapshotCallback, failureCallbackOrContext?: ((a: Error) => void) | object | null, context?: object | null): Promise<DataSnapshot>;
/**
* Set a limit and anchor it to the start of the window.
*/
limitToFirst(limit: number): Query;
/**
* Set a limit and anchor it to the end of the window.
*/
limitToLast(limit: number): Query;
/**
* Given a child path, return a new query ordered by the specified grandchild path.
*/
orderByChild(path: string): Query;
/**
* Return a new query ordered by the KeyIndex
*/
orderByKey(): Query;
/**
* Return a new query ordered by the PriorityIndex
*/
orderByPriority(): Query;
/**
* Return a new query ordered by the ValueIndex
*/
orderByValue(): Query;
startAt(value?: number | string | boolean | null, name?: string | null): Query;
startAfter(value?: number | string | boolean | null, name?: string | null): Query;
endAt(value?: number | string | boolean | null, name?: string | null): Query;
endBefore(value?: number | string | boolean | null, name?: string | null): Query;
/**
* Load the selection of children with exactly the specified value, and, optionally,
* the specified name.
*/
equalTo(value: number | string | boolean | null, name?: string): Query;
/**
* @returns URL for this location.
*/
toString(): string;
toJSON(): string;
/**
* Return true if this query and the provided query are equivalent; otherwise, return false.
*/
isEqual(other: Query): boolean;
/**
* Helper used by .on and .once to extract the context and or cancel arguments.
* @param fnName - The function name (on or once)
*
*/
private static getCancelAndContextArgs_;
get ref(): Reference;
}
export declare class Reference extends Query implements Compat<ModularReference> {
readonly database: Database;
readonly _delegate: ModularReference;
then: Promise<Reference>['then'];
catch: Promise<Reference>['catch'];
/**
* Call options:
* new Reference(Repo, Path) or
* new Reference(url: string, string|RepoManager)
*
* Externally - this is the firebase.database.Reference type.
*/
constructor(database: Database, _delegate: ModularReference);
/** @returns {?string} */
getKey(): string | null;
child(pathString: string): Reference;
/** @returns {?Reference} */
getParent(): Reference | null;
/** @returns {!Reference} */
getRoot(): Reference;
set(newVal: unknown, onComplete?: (error: Error | null) => void): Promise<void>;
update(values: object, onComplete?: (a: Error | null) => void): Promise<void>;
setWithPriority(newVal: unknown, newPriority: string | number | null, onComplete?: (a: Error | null) => void): Promise<void>;
remove(onComplete?: (a: Error | null) => void): Promise<void>;
transaction(transactionUpdate: (currentData: unknown) => unknown, onComplete?: (error: Error | null, committed: boolean, dataSnapshot: DataSnapshot | null) => void, applyLocally?: boolean): Promise<TransactionResult>;
setPriority(priority: string | number | null, onComplete?: (a: Error | null) => void): Promise<void>;
push(value?: unknown, onComplete?: (a: Error | null) => void): Reference;
onDisconnect(): OnDisconnect;
get key(): string | null;
get parent(): Reference | null;
get root(): Reference;
}

View file

@ -0,0 +1,26 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DataSnapshot } from './Reference';
export declare class TransactionResult {
committed: boolean;
snapshot: DataSnapshot;
/**
* A type for the resolve value of Firebase.transaction.
*/
constructor(committed: boolean, snapshot: DataSnapshot);
toJSON(): object;
}

View file

@ -0,0 +1,41 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
import { FirebaseApp } from '@firebase/app-types';
import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
import * as types from '@firebase/database-types';
/**
* Used by console to create a database based on the app,
* passed database URL and a custom auth implementation.
*
* @param app - A valid FirebaseApp-like object
* @param url - A valid Firebase databaseURL
* @param version - custom version e.g. firebase-admin version
* @param customAuthImpl - custom auth implementation
*/
export declare function initStandalone<T>({ app, url, version, customAuthImpl, customAppCheckImpl, namespace, nodeAdmin }: {
app: FirebaseApp;
url: string;
version: string;
customAuthImpl: FirebaseAuthInternal;
customAppCheckImpl?: FirebaseAppCheckInternal;
namespace: T;
nodeAdmin?: boolean;
}): {
instance: types.Database;
namespace: T;
};

View file

@ -0,0 +1,27 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OnDisconnect as ModularOnDisconnect } from '@firebase/database';
import { Compat } from '@firebase/util';
export declare class OnDisconnect implements Compat<ModularOnDisconnect> {
readonly _delegate: ModularOnDisconnect;
constructor(_delegate: ModularOnDisconnect);
cancel(onComplete?: (a: Error | null) => void): Promise<void>;
remove(onComplete?: (a: Error | null) => void): Promise<void>;
set(value: unknown, onComplete?: (a: Error | null) => void): Promise<void>;
setWithPriority(value: unknown, priority: number | string | null, onComplete?: (a: Error | null) => void): Promise<void>;
update(objectToMerge: Record<string, unknown>, onComplete?: (a: Error | null) => void): Promise<void>;
}

View file

@ -0,0 +1,72 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseNamespace } from '@firebase/app-compat';
import * as types from '@firebase/database-types';
export declare function registerDatabase(instance: FirebaseNamespace): void;
declare module '@firebase/app-compat' {
interface FirebaseNamespace {
database?: {
(app?: FirebaseApp): types.FirebaseDatabase;
enableLogging: typeof types.enableLogging;
ServerValue: types.ServerValue;
Database: typeof types.FirebaseDatabase;
};
}
interface FirebaseApp {
database?(databaseURL?: string): types.FirebaseDatabase;
}
}
import { FirebaseApp as FirebaseAppCompat } from "@firebase/app-compat";
import { type DatabaseReference, type EmulatorMockTokenOptions, type DataSnapshot, type Database, type EventType, type Unsubscribe, type ListenOptions, type OnDisconnect, type ThenableReference, type QueryConstraint, type Query, type TransactionOptions, type TransactionResult } from "@firebase/database";
declare module "@firebase/database" {
function child(parent: types.Reference, path: string): DatabaseReference;
function connectDatabaseEmulator(db: types.FirebaseDatabase, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
function get(query: types.Query): Promise<DataSnapshot>;
function getDatabase(app?: FirebaseAppCompat, url?: string): Database;
function goOffline(db: types.FirebaseDatabase): void;
function goOnline(db: types.FirebaseDatabase): void;
function off(query: types.Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;
function onChildAdded(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
function onChildAdded(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
function onChildAdded(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
function onChildChanged(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
function onChildChanged(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
function onChildChanged(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
function onChildMoved(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
function onChildMoved(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
function onChildMoved(query: types.Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
function onChildRemoved(query: types.Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
function onChildRemoved(query: types.Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
function onChildRemoved(query: types.Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
function onDisconnect(ref: types.Reference): OnDisconnect;
function onValue(query: types.Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
function onValue(query: types.Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
function onValue(query: types.Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
function push(parent: types.Reference, value?: unknown): ThenableReference;
function query(query: types.Query, ...queryConstraints: QueryConstraint[]): Query;
function ref(db: types.FirebaseDatabase, path?: string): DatabaseReference;
function refFromURL(db: types.FirebaseDatabase, url: string): DatabaseReference;
function remove(ref: types.Reference): Promise<void>;
function runTransaction(ref: types.Reference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
function set(ref: types.Reference, value: unknown): Promise<void>;
function setPriority(ref: types.Reference, priority: string | number | null): Promise<void>;
function setWithPriority(ref: types.Reference, value: unknown, priority: string | number | null): Promise<void>;
function update(ref: types.Reference, values: object): Promise<void>;
}

View file

@ -0,0 +1,30 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as types from '@firebase/database-types';
declare module '@firebase/app-compat' {
interface FirebaseNamespace {
database?: {
(app?: FirebaseApp): types.FirebaseDatabase;
enableLogging: typeof types.enableLogging;
ServerValue: types.ServerValue;
Database: typeof types.FirebaseDatabase;
};
}
interface FirebaseApp {
database?(): types.FirebaseDatabase;
}
}

View file

@ -0,0 +1,52 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseApp } from '@firebase/app-types';
import { enableLogging } from '@firebase/database';
import { Database } from './api/Database';
import * as INTERNAL from './api/internal';
import { DataSnapshot, Query, Reference } from './api/Reference';
declare const ServerValue: {
TIMESTAMP: object;
increment: (delta: number) => object;
};
/**
* A one off register function which returns a database based on the app and
* passed database URL. (Used by the Admin SDK)
*
* @param app - A valid FirebaseApp-like object
* @param url - A valid Firebase databaseURL
* @param version - custom version e.g. firebase-admin version
* @param nodeAdmin - true if the SDK is being initialized from Firebase Admin.
*/
export declare function initStandalone(app: FirebaseApp, url: string, version: string, nodeAdmin?: boolean): {
instance: import("@firebase/database-types").Database;
namespace: {
Reference: typeof Reference;
Query: typeof Query;
Database: typeof Database;
DataSnapshot: typeof DataSnapshot;
enableLogging: typeof enableLogging;
INTERNAL: typeof INTERNAL;
ServerValue: {
TIMESTAMP: object;
increment: (delta: number) => object;
};
};
};
export { Database, Query, Reference, enableLogging, ServerValue };
export { OnDisconnect } from '@firebase/database';
export { DataSnapshot } from './api/Reference';

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export declare const warn: (msg: string) => void;

View file

@ -0,0 +1,18 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export declare const validateBoolean: (fnName: string, argumentName: string, bool: unknown, optional: boolean) => void;
export declare const validateEventType: (fnName: string, eventType: string, optional: boolean) => void;

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../src/index';

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,34 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A set of functions to clean up event handlers.
*/
export declare let eventCleanupHandlers: any[];
/** Clean up outstanding event handlers */
export declare function eventCleanup(): void;
/**
* Creates a struct which waits for many events.
* @param pathAndEvents - an array of tuples of [Firebase, [event type strings]]
*/
export declare function eventTestHelper(pathAndEvents: any, helperName?: any): {
promise: Promise<unknown>;
initPromise: Promise<unknown>;
waiter: () => boolean;
watchesInitializedWaiter: () => boolean;
unregister: () => void;
addExpectedEvents(moreEvents: any): void;
};

View file

@ -0,0 +1,42 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../../src/index';
import { Path } from '../../../database/src/core/util/Path';
import { Query, Reference } from '../../src/api/Reference';
export declare const TEST_PROJECT: any;
export declare const DATABASE_ADDRESS: any;
export declare const DATABASE_URL: any;
export declare function createTestApp(): import("@firebase/app-compat").FirebaseApp;
/**
* Gets or creates a root node to the test namespace. All calls sharing the
* value of opt_i will share an app context.
*/
export declare function getRootNode(i?: number, ref?: string): any;
/**
* Create multiple refs to the same top level
* push key - each on its own Firebase.Context.
*/
export declare function getRandomNode(numNodes?: any): Reference | Reference[];
export declare function getQueryValue(query: Query): Promise<unknown>;
export declare function pause(milliseconds: number): Promise<void>;
export declare function getPath(query: Query): string;
export declare function shuffle(arr: any, randFn?: () => number): void;
export declare function getFreshRepo(path: Path): any;
export declare function getFreshRepoFromReference(ref: any): any;
export declare function getSnap(path: any): any;
export declare function getVal(path: any): any;
export declare function canCreateExtraConnections(): boolean;

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../src/index';

View file

@ -0,0 +1,861 @@
import firebase from '@firebase/app-compat';
import { ComponentContainer, Provider, Component } from '@firebase/component';
import { _validatePathString, onChildMoved, onChildChanged, onChildRemoved, onChildAdded, onValue, off, get, query, limitToFirst, limitToLast, orderByChild, orderByKey, orderByPriority, orderByValue, startAt, startAfter, endAt, endBefore, equalTo, _ReferenceImpl, _QueryImpl, _QueryParams, child, set, _validateWritablePath, update, setWithPriority, remove, runTransaction, setPriority, push, OnDisconnect as OnDisconnect$1, forceWebSockets, forceLongPolling, connectDatabaseEmulator, refFromURL, ref, goOffline, goOnline, serverTimestamp, increment, _setSDKVersion, _repoManagerDatabaseFromApp, enableLogging } from '@firebase/database';
import { errorPrefix, validateArgCount, validateCallback, validateContextObject, Deferred } from '@firebase/util';
import { Logger } from '@firebase/logger';
const name = "@firebase/database-compat";
const version = "2.0.0";
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const logClient = new Logger('@firebase/database-compat');
const warn = function (msg) {
const message = 'FIREBASE WARNING: ' + msg;
logClient.warn(message);
};
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const validateBoolean = function (fnName, argumentName, bool, optional) {
if (optional && bool === undefined) {
return;
}
if (typeof bool !== 'boolean') {
throw new Error(errorPrefix(fnName, argumentName) + 'must be a boolean.');
}
};
const validateEventType = function (fnName, eventType, optional) {
if (optional && eventType === undefined) {
return;
}
switch (eventType) {
case 'value':
case 'child_added':
case 'child_removed':
case 'child_changed':
case 'child_moved':
break;
default:
throw new Error(errorPrefix(fnName, 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
};
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class OnDisconnect {
constructor(_delegate) {
this._delegate = _delegate;
}
cancel(onComplete) {
validateArgCount('OnDisconnect.cancel', 0, 1, arguments.length);
validateCallback('OnDisconnect.cancel', 'onComplete', onComplete, true);
const result = this._delegate.cancel();
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
remove(onComplete) {
validateArgCount('OnDisconnect.remove', 0, 1, arguments.length);
validateCallback('OnDisconnect.remove', 'onComplete', onComplete, true);
const result = this._delegate.remove();
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
set(value, onComplete) {
validateArgCount('OnDisconnect.set', 1, 2, arguments.length);
validateCallback('OnDisconnect.set', 'onComplete', onComplete, true);
const result = this._delegate.set(value);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
setWithPriority(value, priority, onComplete) {
validateArgCount('OnDisconnect.setWithPriority', 2, 3, arguments.length);
validateCallback('OnDisconnect.setWithPriority', 'onComplete', onComplete, true);
const result = this._delegate.setWithPriority(value, priority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
update(objectToMerge, onComplete) {
validateArgCount('OnDisconnect.update', 1, 2, arguments.length);
if (Array.isArray(objectToMerge)) {
const newObjectToMerge = {};
for (let i = 0; i < objectToMerge.length; ++i) {
newObjectToMerge['' + i] = objectToMerge[i];
}
objectToMerge = newObjectToMerge;
warn('Passing an Array to firebase.database.onDisconnect().update() is deprecated. Use set() if you want to overwrite the ' +
'existing data, or an Object with integer keys if you really do want to only update some of the children.');
}
validateCallback('OnDisconnect.update', 'onComplete', onComplete, true);
const result = this._delegate.update(objectToMerge);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class TransactionResult {
/**
* A type for the resolve value of Firebase.transaction.
*/
constructor(committed, snapshot) {
this.committed = committed;
this.snapshot = snapshot;
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON() {
validateArgCount('TransactionResult.toJSON', 0, 1, arguments.length);
return { committed: this.committed, snapshot: this.snapshot.toJSON() };
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Class representing a firebase data snapshot. It wraps a SnapshotNode and
* surfaces the public methods (val, forEach, etc.) we want to expose.
*/
class DataSnapshot {
constructor(_database, _delegate) {
this._database = _database;
this._delegate = _delegate;
}
/**
* Retrieves the snapshot contents as JSON. Returns null if the snapshot is
* empty.
*
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
val() {
validateArgCount('DataSnapshot.val', 0, 0, arguments.length);
return this._delegate.val();
}
/**
* Returns the snapshot contents as JSON, including priorities of node. Suitable for exporting
* the entire node contents.
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
exportVal() {
validateArgCount('DataSnapshot.exportVal', 0, 0, arguments.length);
return this._delegate.exportVal();
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON() {
// Optional spacer argument is unnecessary because we're depending on recursion rather than stringifying the content
validateArgCount('DataSnapshot.toJSON', 0, 1, arguments.length);
return this._delegate.toJSON();
}
/**
* Returns whether the snapshot contains a non-null value.
*
* @returns Whether the snapshot contains a non-null value, or is empty.
*/
exists() {
validateArgCount('DataSnapshot.exists', 0, 0, arguments.length);
return this._delegate.exists();
}
/**
* Returns a DataSnapshot of the specified child node's contents.
*
* @param path - Path to a child.
* @returns DataSnapshot for child node.
*/
child(path) {
validateArgCount('DataSnapshot.child', 0, 1, arguments.length);
// Ensure the childPath is a string (can be a number)
path = String(path);
_validatePathString('DataSnapshot.child', 'path', path, false);
return new DataSnapshot(this._database, this._delegate.child(path));
}
/**
* Returns whether the snapshot contains a child at the specified path.
*
* @param path - Path to a child.
* @returns Whether the child exists.
*/
hasChild(path) {
validateArgCount('DataSnapshot.hasChild', 1, 1, arguments.length);
_validatePathString('DataSnapshot.hasChild', 'path', path, false);
return this._delegate.hasChild(path);
}
/**
* Returns the priority of the object, or null if no priority was set.
*
* @returns The priority.
*/
getPriority() {
validateArgCount('DataSnapshot.getPriority', 0, 0, arguments.length);
return this._delegate.priority;
}
/**
* Iterates through child nodes and calls the specified action for each one.
*
* @param action - Callback function to be called
* for each child.
* @returns True if forEach was canceled by action returning true for
* one of the child nodes.
*/
forEach(action) {
validateArgCount('DataSnapshot.forEach', 1, 1, arguments.length);
validateCallback('DataSnapshot.forEach', 'action', action, false);
return this._delegate.forEach(expDataSnapshot => action(new DataSnapshot(this._database, expDataSnapshot)));
}
/**
* Returns whether this DataSnapshot has children.
* @returns True if the DataSnapshot contains 1 or more child nodes.
*/
hasChildren() {
validateArgCount('DataSnapshot.hasChildren', 0, 0, arguments.length);
return this._delegate.hasChildren();
}
get key() {
return this._delegate.key;
}
/**
* Returns the number of children for this DataSnapshot.
* @returns The number of children that this DataSnapshot contains.
*/
numChildren() {
validateArgCount('DataSnapshot.numChildren', 0, 0, arguments.length);
return this._delegate.size;
}
/**
* @returns The Firebase reference for the location this snapshot's data came
* from.
*/
getRef() {
validateArgCount('DataSnapshot.ref', 0, 0, arguments.length);
return new Reference(this._database, this._delegate.ref);
}
get ref() {
return this.getRef();
}
}
/**
* A Query represents a filter to be applied to a firebase location. This object purely represents the
* query expression (and exposes our public API to build the query). The actual query logic is in ViewBase.js.
*
* Since every Firebase reference is a query, Firebase inherits from this object.
*/
class Query {
constructor(database, _delegate) {
this.database = database;
this._delegate = _delegate;
}
on(eventType, callback, cancelCallbackOrContext, context) {
var _a;
validateArgCount('Query.on', 2, 4, arguments.length);
validateCallback('Query.on', 'callback', callback, false);
const ret = Query.getCancelAndContextArgs_('Query.on', cancelCallbackOrContext, context);
const valueCallback = (expSnapshot, previousChildName) => {
callback.call(ret.context, new DataSnapshot(this.database, expSnapshot), previousChildName);
};
valueCallback.userCallback = callback;
valueCallback.context = ret.context;
const cancelCallback = (_a = ret.cancel) === null || _a === void 0 ? void 0 : _a.bind(ret.context);
switch (eventType) {
case 'value':
onValue(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_added':
onChildAdded(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_removed':
onChildRemoved(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_changed':
onChildChanged(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_moved':
onChildMoved(this._delegate, valueCallback, cancelCallback);
return callback;
default:
throw new Error(errorPrefix('Query.on', 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
}
off(eventType, callback, context) {
validateArgCount('Query.off', 0, 3, arguments.length);
validateEventType('Query.off', eventType, true);
validateCallback('Query.off', 'callback', callback, true);
validateContextObject('Query.off', 'context', context, true);
if (callback) {
const valueCallback = () => { };
valueCallback.userCallback = callback;
valueCallback.context = context;
off(this._delegate, eventType, valueCallback);
}
else {
off(this._delegate, eventType);
}
}
/**
* Get the server-value for this query, or return a cached value if not connected.
*/
get() {
return get(this._delegate).then(expSnapshot => {
return new DataSnapshot(this.database, expSnapshot);
});
}
/**
* Attaches a listener, waits for the first event, and then removes the listener
*/
once(eventType, callback, failureCallbackOrContext, context) {
validateArgCount('Query.once', 1, 4, arguments.length);
validateCallback('Query.once', 'callback', callback, true);
const ret = Query.getCancelAndContextArgs_('Query.once', failureCallbackOrContext, context);
const deferred = new Deferred();
const valueCallback = (expSnapshot, previousChildName) => {
const result = new DataSnapshot(this.database, expSnapshot);
if (callback) {
callback.call(ret.context, result, previousChildName);
}
deferred.resolve(result);
};
valueCallback.userCallback = callback;
valueCallback.context = ret.context;
const cancelCallback = (error) => {
if (ret.cancel) {
ret.cancel.call(ret.context, error);
}
deferred.reject(error);
};
switch (eventType) {
case 'value':
onValue(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_added':
onChildAdded(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_removed':
onChildRemoved(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_changed':
onChildChanged(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_moved':
onChildMoved(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
default:
throw new Error(errorPrefix('Query.once', 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
return deferred.promise;
}
/**
* Set a limit and anchor it to the start of the window.
*/
limitToFirst(limit) {
validateArgCount('Query.limitToFirst', 1, 1, arguments.length);
return new Query(this.database, query(this._delegate, limitToFirst(limit)));
}
/**
* Set a limit and anchor it to the end of the window.
*/
limitToLast(limit) {
validateArgCount('Query.limitToLast', 1, 1, arguments.length);
return new Query(this.database, query(this._delegate, limitToLast(limit)));
}
/**
* Given a child path, return a new query ordered by the specified grandchild path.
*/
orderByChild(path) {
validateArgCount('Query.orderByChild', 1, 1, arguments.length);
return new Query(this.database, query(this._delegate, orderByChild(path)));
}
/**
* Return a new query ordered by the KeyIndex
*/
orderByKey() {
validateArgCount('Query.orderByKey', 0, 0, arguments.length);
return new Query(this.database, query(this._delegate, orderByKey()));
}
/**
* Return a new query ordered by the PriorityIndex
*/
orderByPriority() {
validateArgCount('Query.orderByPriority', 0, 0, arguments.length);
return new Query(this.database, query(this._delegate, orderByPriority()));
}
/**
* Return a new query ordered by the ValueIndex
*/
orderByValue() {
validateArgCount('Query.orderByValue', 0, 0, arguments.length);
return new Query(this.database, query(this._delegate, orderByValue()));
}
startAt(value = null, name) {
validateArgCount('Query.startAt', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, startAt(value, name)));
}
startAfter(value = null, name) {
validateArgCount('Query.startAfter', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, startAfter(value, name)));
}
endAt(value = null, name) {
validateArgCount('Query.endAt', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, endAt(value, name)));
}
endBefore(value = null, name) {
validateArgCount('Query.endBefore', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, endBefore(value, name)));
}
/**
* Load the selection of children with exactly the specified value, and, optionally,
* the specified name.
*/
equalTo(value, name) {
validateArgCount('Query.equalTo', 1, 2, arguments.length);
return new Query(this.database, query(this._delegate, equalTo(value, name)));
}
/**
* @returns URL for this location.
*/
toString() {
validateArgCount('Query.toString', 0, 0, arguments.length);
return this._delegate.toString();
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users.
toJSON() {
// An optional spacer argument is unnecessary for a string.
validateArgCount('Query.toJSON', 0, 1, arguments.length);
return this._delegate.toJSON();
}
/**
* Return true if this query and the provided query are equivalent; otherwise, return false.
*/
isEqual(other) {
validateArgCount('Query.isEqual', 1, 1, arguments.length);
if (!(other instanceof Query)) {
const error = 'Query.isEqual failed: First argument must be an instance of firebase.database.Query.';
throw new Error(error);
}
return this._delegate.isEqual(other._delegate);
}
/**
* Helper used by .on and .once to extract the context and or cancel arguments.
* @param fnName - The function name (on or once)
*
*/
static getCancelAndContextArgs_(fnName, cancelOrContext, context) {
const ret = { cancel: undefined, context: undefined };
if (cancelOrContext && context) {
ret.cancel = cancelOrContext;
validateCallback(fnName, 'cancel', ret.cancel, true);
ret.context = context;
validateContextObject(fnName, 'context', ret.context, true);
}
else if (cancelOrContext) {
// we have either a cancel callback or a context.
if (typeof cancelOrContext === 'object' && cancelOrContext !== null) {
// it's a context!
ret.context = cancelOrContext;
}
else if (typeof cancelOrContext === 'function') {
ret.cancel = cancelOrContext;
}
else {
throw new Error(errorPrefix(fnName, 'cancelOrContext') +
' must either be a cancel callback or a context object.');
}
}
return ret;
}
get ref() {
return new Reference(this.database, new _ReferenceImpl(this._delegate._repo, this._delegate._path));
}
}
class Reference extends Query {
/**
* Call options:
* new Reference(Repo, Path) or
* new Reference(url: string, string|RepoManager)
*
* Externally - this is the firebase.database.Reference type.
*/
constructor(database, _delegate) {
super(database, new _QueryImpl(_delegate._repo, _delegate._path, new _QueryParams(), false));
this.database = database;
this._delegate = _delegate;
}
/** @returns {?string} */
getKey() {
validateArgCount('Reference.key', 0, 0, arguments.length);
return this._delegate.key;
}
child(pathString) {
validateArgCount('Reference.child', 1, 1, arguments.length);
if (typeof pathString === 'number') {
pathString = String(pathString);
}
return new Reference(this.database, child(this._delegate, pathString));
}
/** @returns {?Reference} */
getParent() {
validateArgCount('Reference.parent', 0, 0, arguments.length);
const parent = this._delegate.parent;
return parent ? new Reference(this.database, parent) : null;
}
/** @returns {!Reference} */
getRoot() {
validateArgCount('Reference.root', 0, 0, arguments.length);
return new Reference(this.database, this._delegate.root);
}
set(newVal, onComplete) {
validateArgCount('Reference.set', 1, 2, arguments.length);
validateCallback('Reference.set', 'onComplete', onComplete, true);
const result = set(this._delegate, newVal);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
update(values, onComplete) {
validateArgCount('Reference.update', 1, 2, arguments.length);
if (Array.isArray(values)) {
const newObjectToMerge = {};
for (let i = 0; i < values.length; ++i) {
newObjectToMerge['' + i] = values[i];
}
values = newObjectToMerge;
warn('Passing an Array to Firebase.update() is deprecated. ' +
'Use set() if you want to overwrite the existing data, or ' +
'an Object with integer keys if you really do want to ' +
'only update some of the children.');
}
_validateWritablePath('Reference.update', this._delegate._path);
validateCallback('Reference.update', 'onComplete', onComplete, true);
const result = update(this._delegate, values);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
setWithPriority(newVal, newPriority, onComplete) {
validateArgCount('Reference.setWithPriority', 2, 3, arguments.length);
validateCallback('Reference.setWithPriority', 'onComplete', onComplete, true);
const result = setWithPriority(this._delegate, newVal, newPriority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
remove(onComplete) {
validateArgCount('Reference.remove', 0, 1, arguments.length);
validateCallback('Reference.remove', 'onComplete', onComplete, true);
const result = remove(this._delegate);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
transaction(transactionUpdate, onComplete, applyLocally) {
validateArgCount('Reference.transaction', 1, 3, arguments.length);
validateCallback('Reference.transaction', 'transactionUpdate', transactionUpdate, false);
validateCallback('Reference.transaction', 'onComplete', onComplete, true);
validateBoolean('Reference.transaction', 'applyLocally', applyLocally, true);
const result = runTransaction(this._delegate, transactionUpdate, {
applyLocally
}).then(transactionResult => new TransactionResult(transactionResult.committed, new DataSnapshot(this.database, transactionResult.snapshot)));
if (onComplete) {
result.then(transactionResult => onComplete(null, transactionResult.committed, transactionResult.snapshot), error => onComplete(error, false, null));
}
return result;
}
setPriority(priority, onComplete) {
validateArgCount('Reference.setPriority', 1, 2, arguments.length);
validateCallback('Reference.setPriority', 'onComplete', onComplete, true);
const result = setPriority(this._delegate, priority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
push(value, onComplete) {
validateArgCount('Reference.push', 0, 2, arguments.length);
validateCallback('Reference.push', 'onComplete', onComplete, true);
const expPromise = push(this._delegate, value);
const promise = expPromise.then(expRef => new Reference(this.database, expRef));
if (onComplete) {
promise.then(() => onComplete(null), error => onComplete(error));
}
const result = new Reference(this.database, expPromise);
result.then = promise.then.bind(promise);
result.catch = promise.catch.bind(promise, undefined);
return result;
}
onDisconnect() {
_validateWritablePath('Reference.onDisconnect', this._delegate._path);
return new OnDisconnect(new OnDisconnect$1(this._delegate._repo, this._delegate._path));
}
get key() {
return this.getKey();
}
get parent() {
return this.getParent();
}
get root() {
return this.getRoot();
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Class representing a firebase database.
*/
class Database {
/**
* The constructor should not be called by users of our public API.
*/
constructor(_delegate, app) {
this._delegate = _delegate;
this.app = app;
this.INTERNAL = {
delete: () => this._delegate._delete(),
forceWebSockets,
forceLongPolling
};
}
/**
* Modify this instance to communicate with the Realtime Database emulator.
*
* <p>Note: This method must be called before performing any other operation.
*
* @param host - the emulator host (ex: localhost)
* @param port - the emulator port (ex: 8080)
* @param options.mockUserToken - the mock auth token to use for unit testing Security Rules
*/
useEmulator(host, port, options = {}) {
connectDatabaseEmulator(this._delegate, host, port, options);
}
ref(path) {
validateArgCount('database.ref', 0, 1, arguments.length);
if (path instanceof Reference) {
const childRef = refFromURL(this._delegate, path.toString());
return new Reference(this, childRef);
}
else {
const childRef = ref(this._delegate, path);
return new Reference(this, childRef);
}
}
/**
* Returns a reference to the root or the path specified in url.
* We throw a exception if the url is not in the same domain as the
* current repo.
* @returns Firebase reference.
*/
refFromURL(url) {
const apiName = 'database.refFromURL';
validateArgCount(apiName, 1, 1, arguments.length);
const childRef = refFromURL(this._delegate, url);
return new Reference(this, childRef);
}
// Make individual repo go offline.
goOffline() {
validateArgCount('database.goOffline', 0, 0, arguments.length);
return goOffline(this._delegate);
}
goOnline() {
validateArgCount('database.goOnline', 0, 0, arguments.length);
return goOnline(this._delegate);
}
}
Database.ServerValue = {
TIMESTAMP: serverTimestamp(),
increment: (delta) => increment(delta)
};
/**
* Used by console to create a database based on the app,
* passed database URL and a custom auth implementation.
*
* @param app - A valid FirebaseApp-like object
* @param url - A valid Firebase databaseURL
* @param version - custom version e.g. firebase-admin version
* @param customAuthImpl - custom auth implementation
*/
function initStandalone({ app, url, version, customAuthImpl, customAppCheckImpl, namespace, nodeAdmin = false }) {
_setSDKVersion(version);
const container = new ComponentContainer('database-standalone');
/**
* ComponentContainer('database-standalone') is just a placeholder that doesn't perform
* any actual function.
*/
const authProvider = new Provider('auth-internal', container);
authProvider.setComponent(new Component('auth-internal', () => customAuthImpl, "PRIVATE" /* ComponentType.PRIVATE */));
let appCheckProvider = undefined;
if (customAppCheckImpl) {
appCheckProvider = new Provider('app-check-internal', container);
appCheckProvider.setComponent(new Component('app-check-internal', () => customAppCheckImpl, "PRIVATE" /* ComponentType.PRIVATE */));
}
return {
instance: new Database(_repoManagerDatabaseFromApp(app, authProvider, appCheckProvider, url, nodeAdmin), app),
namespace
};
}
var INTERNAL = /*#__PURE__*/Object.freeze({
__proto__: null,
initStandalone: initStandalone
});
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const ServerValue = Database.ServerValue;
function registerDatabase(instance) {
// Register the Database Service with the 'firebase' namespace.
instance.INTERNAL.registerComponent(new Component('database-compat', (container, { instanceIdentifier: url }) => {
/* Dependencies */
// getImmediate for FirebaseApp will always succeed
const app = container.getProvider('app-compat').getImmediate();
const databaseExp = container
.getProvider('database')
.getImmediate({ identifier: url });
return new Database(databaseExp, app);
}, "PUBLIC" /* ComponentType.PUBLIC */)
.setServiceProps(
// firebase.database namespace properties
{
Reference,
Query,
Database,
DataSnapshot,
enableLogging,
INTERNAL,
ServerValue
})
.setMultipleInstances(true));
instance.registerVersion(name, version);
}
registerDatabase(firebase);
export { registerDatabase };
//# sourceMappingURL=index.esm2017.js.map

File diff suppressed because one or more lines are too long

865
node_modules/@firebase/database-compat/dist/index.js generated vendored Normal file
View file

@ -0,0 +1,865 @@
'use strict';
var firebase = require('@firebase/app-compat');
var component = require('@firebase/component');
var database = require('@firebase/database');
var util = require('@firebase/util');
var logger = require('@firebase/logger');
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
var firebase__default = /*#__PURE__*/_interopDefaultLegacy(firebase);
const name = "@firebase/database-compat";
const version = "2.0.0";
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const logClient = new logger.Logger('@firebase/database-compat');
const warn = function (msg) {
const message = 'FIREBASE WARNING: ' + msg;
logClient.warn(message);
};
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const validateBoolean = function (fnName, argumentName, bool, optional) {
if (optional && bool === undefined) {
return;
}
if (typeof bool !== 'boolean') {
throw new Error(util.errorPrefix(fnName, argumentName) + 'must be a boolean.');
}
};
const validateEventType = function (fnName, eventType, optional) {
if (optional && eventType === undefined) {
return;
}
switch (eventType) {
case 'value':
case 'child_added':
case 'child_removed':
case 'child_changed':
case 'child_moved':
break;
default:
throw new Error(util.errorPrefix(fnName, 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
};
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class OnDisconnect {
constructor(_delegate) {
this._delegate = _delegate;
}
cancel(onComplete) {
util.validateArgCount('OnDisconnect.cancel', 0, 1, arguments.length);
util.validateCallback('OnDisconnect.cancel', 'onComplete', onComplete, true);
const result = this._delegate.cancel();
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
remove(onComplete) {
util.validateArgCount('OnDisconnect.remove', 0, 1, arguments.length);
util.validateCallback('OnDisconnect.remove', 'onComplete', onComplete, true);
const result = this._delegate.remove();
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
set(value, onComplete) {
util.validateArgCount('OnDisconnect.set', 1, 2, arguments.length);
util.validateCallback('OnDisconnect.set', 'onComplete', onComplete, true);
const result = this._delegate.set(value);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
setWithPriority(value, priority, onComplete) {
util.validateArgCount('OnDisconnect.setWithPriority', 2, 3, arguments.length);
util.validateCallback('OnDisconnect.setWithPriority', 'onComplete', onComplete, true);
const result = this._delegate.setWithPriority(value, priority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
update(objectToMerge, onComplete) {
util.validateArgCount('OnDisconnect.update', 1, 2, arguments.length);
if (Array.isArray(objectToMerge)) {
const newObjectToMerge = {};
for (let i = 0; i < objectToMerge.length; ++i) {
newObjectToMerge['' + i] = objectToMerge[i];
}
objectToMerge = newObjectToMerge;
warn('Passing an Array to firebase.database.onDisconnect().update() is deprecated. Use set() if you want to overwrite the ' +
'existing data, or an Object with integer keys if you really do want to only update some of the children.');
}
util.validateCallback('OnDisconnect.update', 'onComplete', onComplete, true);
const result = this._delegate.update(objectToMerge);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class TransactionResult {
/**
* A type for the resolve value of Firebase.transaction.
*/
constructor(committed, snapshot) {
this.committed = committed;
this.snapshot = snapshot;
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON() {
util.validateArgCount('TransactionResult.toJSON', 0, 1, arguments.length);
return { committed: this.committed, snapshot: this.snapshot.toJSON() };
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Class representing a firebase data snapshot. It wraps a SnapshotNode and
* surfaces the public methods (val, forEach, etc.) we want to expose.
*/
class DataSnapshot {
constructor(_database, _delegate) {
this._database = _database;
this._delegate = _delegate;
}
/**
* Retrieves the snapshot contents as JSON. Returns null if the snapshot is
* empty.
*
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
val() {
util.validateArgCount('DataSnapshot.val', 0, 0, arguments.length);
return this._delegate.val();
}
/**
* Returns the snapshot contents as JSON, including priorities of node. Suitable for exporting
* the entire node contents.
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
exportVal() {
util.validateArgCount('DataSnapshot.exportVal', 0, 0, arguments.length);
return this._delegate.exportVal();
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON() {
// Optional spacer argument is unnecessary because we're depending on recursion rather than stringifying the content
util.validateArgCount('DataSnapshot.toJSON', 0, 1, arguments.length);
return this._delegate.toJSON();
}
/**
* Returns whether the snapshot contains a non-null value.
*
* @returns Whether the snapshot contains a non-null value, or is empty.
*/
exists() {
util.validateArgCount('DataSnapshot.exists', 0, 0, arguments.length);
return this._delegate.exists();
}
/**
* Returns a DataSnapshot of the specified child node's contents.
*
* @param path - Path to a child.
* @returns DataSnapshot for child node.
*/
child(path) {
util.validateArgCount('DataSnapshot.child', 0, 1, arguments.length);
// Ensure the childPath is a string (can be a number)
path = String(path);
database._validatePathString('DataSnapshot.child', 'path', path, false);
return new DataSnapshot(this._database, this._delegate.child(path));
}
/**
* Returns whether the snapshot contains a child at the specified path.
*
* @param path - Path to a child.
* @returns Whether the child exists.
*/
hasChild(path) {
util.validateArgCount('DataSnapshot.hasChild', 1, 1, arguments.length);
database._validatePathString('DataSnapshot.hasChild', 'path', path, false);
return this._delegate.hasChild(path);
}
/**
* Returns the priority of the object, or null if no priority was set.
*
* @returns The priority.
*/
getPriority() {
util.validateArgCount('DataSnapshot.getPriority', 0, 0, arguments.length);
return this._delegate.priority;
}
/**
* Iterates through child nodes and calls the specified action for each one.
*
* @param action - Callback function to be called
* for each child.
* @returns True if forEach was canceled by action returning true for
* one of the child nodes.
*/
forEach(action) {
util.validateArgCount('DataSnapshot.forEach', 1, 1, arguments.length);
util.validateCallback('DataSnapshot.forEach', 'action', action, false);
return this._delegate.forEach(expDataSnapshot => action(new DataSnapshot(this._database, expDataSnapshot)));
}
/**
* Returns whether this DataSnapshot has children.
* @returns True if the DataSnapshot contains 1 or more child nodes.
*/
hasChildren() {
util.validateArgCount('DataSnapshot.hasChildren', 0, 0, arguments.length);
return this._delegate.hasChildren();
}
get key() {
return this._delegate.key;
}
/**
* Returns the number of children for this DataSnapshot.
* @returns The number of children that this DataSnapshot contains.
*/
numChildren() {
util.validateArgCount('DataSnapshot.numChildren', 0, 0, arguments.length);
return this._delegate.size;
}
/**
* @returns The Firebase reference for the location this snapshot's data came
* from.
*/
getRef() {
util.validateArgCount('DataSnapshot.ref', 0, 0, arguments.length);
return new Reference(this._database, this._delegate.ref);
}
get ref() {
return this.getRef();
}
}
/**
* A Query represents a filter to be applied to a firebase location. This object purely represents the
* query expression (and exposes our public API to build the query). The actual query logic is in ViewBase.js.
*
* Since every Firebase reference is a query, Firebase inherits from this object.
*/
class Query {
constructor(database, _delegate) {
this.database = database;
this._delegate = _delegate;
}
on(eventType, callback, cancelCallbackOrContext, context) {
var _a;
util.validateArgCount('Query.on', 2, 4, arguments.length);
util.validateCallback('Query.on', 'callback', callback, false);
const ret = Query.getCancelAndContextArgs_('Query.on', cancelCallbackOrContext, context);
const valueCallback = (expSnapshot, previousChildName) => {
callback.call(ret.context, new DataSnapshot(this.database, expSnapshot), previousChildName);
};
valueCallback.userCallback = callback;
valueCallback.context = ret.context;
const cancelCallback = (_a = ret.cancel) === null || _a === void 0 ? void 0 : _a.bind(ret.context);
switch (eventType) {
case 'value':
database.onValue(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_added':
database.onChildAdded(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_removed':
database.onChildRemoved(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_changed':
database.onChildChanged(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_moved':
database.onChildMoved(this._delegate, valueCallback, cancelCallback);
return callback;
default:
throw new Error(util.errorPrefix('Query.on', 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
}
off(eventType, callback, context) {
util.validateArgCount('Query.off', 0, 3, arguments.length);
validateEventType('Query.off', eventType, true);
util.validateCallback('Query.off', 'callback', callback, true);
util.validateContextObject('Query.off', 'context', context, true);
if (callback) {
const valueCallback = () => { };
valueCallback.userCallback = callback;
valueCallback.context = context;
database.off(this._delegate, eventType, valueCallback);
}
else {
database.off(this._delegate, eventType);
}
}
/**
* Get the server-value for this query, or return a cached value if not connected.
*/
get() {
return database.get(this._delegate).then(expSnapshot => {
return new DataSnapshot(this.database, expSnapshot);
});
}
/**
* Attaches a listener, waits for the first event, and then removes the listener
*/
once(eventType, callback, failureCallbackOrContext, context) {
util.validateArgCount('Query.once', 1, 4, arguments.length);
util.validateCallback('Query.once', 'callback', callback, true);
const ret = Query.getCancelAndContextArgs_('Query.once', failureCallbackOrContext, context);
const deferred = new util.Deferred();
const valueCallback = (expSnapshot, previousChildName) => {
const result = new DataSnapshot(this.database, expSnapshot);
if (callback) {
callback.call(ret.context, result, previousChildName);
}
deferred.resolve(result);
};
valueCallback.userCallback = callback;
valueCallback.context = ret.context;
const cancelCallback = (error) => {
if (ret.cancel) {
ret.cancel.call(ret.context, error);
}
deferred.reject(error);
};
switch (eventType) {
case 'value':
database.onValue(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_added':
database.onChildAdded(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_removed':
database.onChildRemoved(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_changed':
database.onChildChanged(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_moved':
database.onChildMoved(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
default:
throw new Error(util.errorPrefix('Query.once', 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
return deferred.promise;
}
/**
* Set a limit and anchor it to the start of the window.
*/
limitToFirst(limit) {
util.validateArgCount('Query.limitToFirst', 1, 1, arguments.length);
return new Query(this.database, database.query(this._delegate, database.limitToFirst(limit)));
}
/**
* Set a limit and anchor it to the end of the window.
*/
limitToLast(limit) {
util.validateArgCount('Query.limitToLast', 1, 1, arguments.length);
return new Query(this.database, database.query(this._delegate, database.limitToLast(limit)));
}
/**
* Given a child path, return a new query ordered by the specified grandchild path.
*/
orderByChild(path) {
util.validateArgCount('Query.orderByChild', 1, 1, arguments.length);
return new Query(this.database, database.query(this._delegate, database.orderByChild(path)));
}
/**
* Return a new query ordered by the KeyIndex
*/
orderByKey() {
util.validateArgCount('Query.orderByKey', 0, 0, arguments.length);
return new Query(this.database, database.query(this._delegate, database.orderByKey()));
}
/**
* Return a new query ordered by the PriorityIndex
*/
orderByPriority() {
util.validateArgCount('Query.orderByPriority', 0, 0, arguments.length);
return new Query(this.database, database.query(this._delegate, database.orderByPriority()));
}
/**
* Return a new query ordered by the ValueIndex
*/
orderByValue() {
util.validateArgCount('Query.orderByValue', 0, 0, arguments.length);
return new Query(this.database, database.query(this._delegate, database.orderByValue()));
}
startAt(value = null, name) {
util.validateArgCount('Query.startAt', 0, 2, arguments.length);
return new Query(this.database, database.query(this._delegate, database.startAt(value, name)));
}
startAfter(value = null, name) {
util.validateArgCount('Query.startAfter', 0, 2, arguments.length);
return new Query(this.database, database.query(this._delegate, database.startAfter(value, name)));
}
endAt(value = null, name) {
util.validateArgCount('Query.endAt', 0, 2, arguments.length);
return new Query(this.database, database.query(this._delegate, database.endAt(value, name)));
}
endBefore(value = null, name) {
util.validateArgCount('Query.endBefore', 0, 2, arguments.length);
return new Query(this.database, database.query(this._delegate, database.endBefore(value, name)));
}
/**
* Load the selection of children with exactly the specified value, and, optionally,
* the specified name.
*/
equalTo(value, name) {
util.validateArgCount('Query.equalTo', 1, 2, arguments.length);
return new Query(this.database, database.query(this._delegate, database.equalTo(value, name)));
}
/**
* @returns URL for this location.
*/
toString() {
util.validateArgCount('Query.toString', 0, 0, arguments.length);
return this._delegate.toString();
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users.
toJSON() {
// An optional spacer argument is unnecessary for a string.
util.validateArgCount('Query.toJSON', 0, 1, arguments.length);
return this._delegate.toJSON();
}
/**
* Return true if this query and the provided query are equivalent; otherwise, return false.
*/
isEqual(other) {
util.validateArgCount('Query.isEqual', 1, 1, arguments.length);
if (!(other instanceof Query)) {
const error = 'Query.isEqual failed: First argument must be an instance of firebase.database.Query.';
throw new Error(error);
}
return this._delegate.isEqual(other._delegate);
}
/**
* Helper used by .on and .once to extract the context and or cancel arguments.
* @param fnName - The function name (on or once)
*
*/
static getCancelAndContextArgs_(fnName, cancelOrContext, context) {
const ret = { cancel: undefined, context: undefined };
if (cancelOrContext && context) {
ret.cancel = cancelOrContext;
util.validateCallback(fnName, 'cancel', ret.cancel, true);
ret.context = context;
util.validateContextObject(fnName, 'context', ret.context, true);
}
else if (cancelOrContext) {
// we have either a cancel callback or a context.
if (typeof cancelOrContext === 'object' && cancelOrContext !== null) {
// it's a context!
ret.context = cancelOrContext;
}
else if (typeof cancelOrContext === 'function') {
ret.cancel = cancelOrContext;
}
else {
throw new Error(util.errorPrefix(fnName, 'cancelOrContext') +
' must either be a cancel callback or a context object.');
}
}
return ret;
}
get ref() {
return new Reference(this.database, new database._ReferenceImpl(this._delegate._repo, this._delegate._path));
}
}
class Reference extends Query {
/**
* Call options:
* new Reference(Repo, Path) or
* new Reference(url: string, string|RepoManager)
*
* Externally - this is the firebase.database.Reference type.
*/
constructor(database$1, _delegate) {
super(database$1, new database._QueryImpl(_delegate._repo, _delegate._path, new database._QueryParams(), false));
this.database = database$1;
this._delegate = _delegate;
}
/** @returns {?string} */
getKey() {
util.validateArgCount('Reference.key', 0, 0, arguments.length);
return this._delegate.key;
}
child(pathString) {
util.validateArgCount('Reference.child', 1, 1, arguments.length);
if (typeof pathString === 'number') {
pathString = String(pathString);
}
return new Reference(this.database, database.child(this._delegate, pathString));
}
/** @returns {?Reference} */
getParent() {
util.validateArgCount('Reference.parent', 0, 0, arguments.length);
const parent = this._delegate.parent;
return parent ? new Reference(this.database, parent) : null;
}
/** @returns {!Reference} */
getRoot() {
util.validateArgCount('Reference.root', 0, 0, arguments.length);
return new Reference(this.database, this._delegate.root);
}
set(newVal, onComplete) {
util.validateArgCount('Reference.set', 1, 2, arguments.length);
util.validateCallback('Reference.set', 'onComplete', onComplete, true);
const result = database.set(this._delegate, newVal);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
update(values, onComplete) {
util.validateArgCount('Reference.update', 1, 2, arguments.length);
if (Array.isArray(values)) {
const newObjectToMerge = {};
for (let i = 0; i < values.length; ++i) {
newObjectToMerge['' + i] = values[i];
}
values = newObjectToMerge;
warn('Passing an Array to Firebase.update() is deprecated. ' +
'Use set() if you want to overwrite the existing data, or ' +
'an Object with integer keys if you really do want to ' +
'only update some of the children.');
}
database._validateWritablePath('Reference.update', this._delegate._path);
util.validateCallback('Reference.update', 'onComplete', onComplete, true);
const result = database.update(this._delegate, values);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
setWithPriority(newVal, newPriority, onComplete) {
util.validateArgCount('Reference.setWithPriority', 2, 3, arguments.length);
util.validateCallback('Reference.setWithPriority', 'onComplete', onComplete, true);
const result = database.setWithPriority(this._delegate, newVal, newPriority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
remove(onComplete) {
util.validateArgCount('Reference.remove', 0, 1, arguments.length);
util.validateCallback('Reference.remove', 'onComplete', onComplete, true);
const result = database.remove(this._delegate);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
transaction(transactionUpdate, onComplete, applyLocally) {
util.validateArgCount('Reference.transaction', 1, 3, arguments.length);
util.validateCallback('Reference.transaction', 'transactionUpdate', transactionUpdate, false);
util.validateCallback('Reference.transaction', 'onComplete', onComplete, true);
validateBoolean('Reference.transaction', 'applyLocally', applyLocally, true);
const result = database.runTransaction(this._delegate, transactionUpdate, {
applyLocally
}).then(transactionResult => new TransactionResult(transactionResult.committed, new DataSnapshot(this.database, transactionResult.snapshot)));
if (onComplete) {
result.then(transactionResult => onComplete(null, transactionResult.committed, transactionResult.snapshot), error => onComplete(error, false, null));
}
return result;
}
setPriority(priority, onComplete) {
util.validateArgCount('Reference.setPriority', 1, 2, arguments.length);
util.validateCallback('Reference.setPriority', 'onComplete', onComplete, true);
const result = database.setPriority(this._delegate, priority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
push(value, onComplete) {
util.validateArgCount('Reference.push', 0, 2, arguments.length);
util.validateCallback('Reference.push', 'onComplete', onComplete, true);
const expPromise = database.push(this._delegate, value);
const promise = expPromise.then(expRef => new Reference(this.database, expRef));
if (onComplete) {
promise.then(() => onComplete(null), error => onComplete(error));
}
const result = new Reference(this.database, expPromise);
result.then = promise.then.bind(promise);
result.catch = promise.catch.bind(promise, undefined);
return result;
}
onDisconnect() {
database._validateWritablePath('Reference.onDisconnect', this._delegate._path);
return new OnDisconnect(new database.OnDisconnect(this._delegate._repo, this._delegate._path));
}
get key() {
return this.getKey();
}
get parent() {
return this.getParent();
}
get root() {
return this.getRoot();
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Class representing a firebase database.
*/
class Database {
/**
* The constructor should not be called by users of our public API.
*/
constructor(_delegate, app) {
this._delegate = _delegate;
this.app = app;
this.INTERNAL = {
delete: () => this._delegate._delete(),
forceWebSockets: database.forceWebSockets,
forceLongPolling: database.forceLongPolling
};
}
/**
* Modify this instance to communicate with the Realtime Database emulator.
*
* <p>Note: This method must be called before performing any other operation.
*
* @param host - the emulator host (ex: localhost)
* @param port - the emulator port (ex: 8080)
* @param options.mockUserToken - the mock auth token to use for unit testing Security Rules
*/
useEmulator(host, port, options = {}) {
database.connectDatabaseEmulator(this._delegate, host, port, options);
}
ref(path) {
util.validateArgCount('database.ref', 0, 1, arguments.length);
if (path instanceof Reference) {
const childRef = database.refFromURL(this._delegate, path.toString());
return new Reference(this, childRef);
}
else {
const childRef = database.ref(this._delegate, path);
return new Reference(this, childRef);
}
}
/**
* Returns a reference to the root or the path specified in url.
* We throw a exception if the url is not in the same domain as the
* current repo.
* @returns Firebase reference.
*/
refFromURL(url) {
const apiName = 'database.refFromURL';
util.validateArgCount(apiName, 1, 1, arguments.length);
const childRef = database.refFromURL(this._delegate, url);
return new Reference(this, childRef);
}
// Make individual repo go offline.
goOffline() {
util.validateArgCount('database.goOffline', 0, 0, arguments.length);
return database.goOffline(this._delegate);
}
goOnline() {
util.validateArgCount('database.goOnline', 0, 0, arguments.length);
return database.goOnline(this._delegate);
}
}
Database.ServerValue = {
TIMESTAMP: database.serverTimestamp(),
increment: (delta) => database.increment(delta)
};
/**
* Used by console to create a database based on the app,
* passed database URL and a custom auth implementation.
*
* @param app - A valid FirebaseApp-like object
* @param url - A valid Firebase databaseURL
* @param version - custom version e.g. firebase-admin version
* @param customAuthImpl - custom auth implementation
*/
function initStandalone({ app, url, version, customAuthImpl, customAppCheckImpl, namespace, nodeAdmin = false }) {
database._setSDKVersion(version);
const container = new component.ComponentContainer('database-standalone');
/**
* ComponentContainer('database-standalone') is just a placeholder that doesn't perform
* any actual function.
*/
const authProvider = new component.Provider('auth-internal', container);
authProvider.setComponent(new component.Component('auth-internal', () => customAuthImpl, "PRIVATE" /* ComponentType.PRIVATE */));
let appCheckProvider = undefined;
if (customAppCheckImpl) {
appCheckProvider = new component.Provider('app-check-internal', container);
appCheckProvider.setComponent(new component.Component('app-check-internal', () => customAppCheckImpl, "PRIVATE" /* ComponentType.PRIVATE */));
}
return {
instance: new Database(database._repoManagerDatabaseFromApp(app, authProvider, appCheckProvider, url, nodeAdmin), app),
namespace
};
}
var INTERNAL = /*#__PURE__*/Object.freeze({
__proto__: null,
initStandalone: initStandalone
});
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const ServerValue = Database.ServerValue;
function registerDatabase(instance) {
// Register the Database Service with the 'firebase' namespace.
instance.INTERNAL.registerComponent(new component.Component('database-compat', (container, { instanceIdentifier: url }) => {
/* Dependencies */
// getImmediate for FirebaseApp will always succeed
const app = container.getProvider('app-compat').getImmediate();
const databaseExp = container
.getProvider('database')
.getImmediate({ identifier: url });
return new Database(databaseExp, app);
}, "PUBLIC" /* ComponentType.PUBLIC */)
.setServiceProps(
// firebase.database namespace properties
{
Reference,
Query,
Database,
DataSnapshot,
enableLogging: database.enableLogging,
INTERNAL,
ServerValue
})
.setMultipleInstances(true));
instance.registerVersion(name, version, 'node');
}
registerDatabase(firebase__default["default"]);
//# sourceMappingURL=index.js.map

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,74 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseApp } from '@firebase/app-types';
import { FirebaseService } from '@firebase/app-types/private';
import { forceLongPolling, forceWebSockets, Database as ModularDatabase } from '@firebase/database';
import { Compat, EmulatorMockTokenOptions } from '@firebase/util';
import { Reference } from './Reference';
/**
* Class representing a firebase database.
*/
export declare class Database implements FirebaseService, Compat<ModularDatabase> {
readonly _delegate: ModularDatabase;
readonly app: FirebaseApp;
static readonly ServerValue: {
TIMESTAMP: object;
increment: (delta: number) => object;
};
/**
* The constructor should not be called by users of our public API.
*/
constructor(_delegate: ModularDatabase, app: FirebaseApp);
INTERNAL: {
delete: () => Promise<void>;
forceWebSockets: typeof forceWebSockets;
forceLongPolling: typeof forceLongPolling;
};
/**
* Modify this instance to communicate with the Realtime Database emulator.
*
* <p>Note: This method must be called before performing any other operation.
*
* @param host - the emulator host (ex: localhost)
* @param port - the emulator port (ex: 8080)
* @param options.mockUserToken - the mock auth token to use for unit testing Security Rules
*/
useEmulator(host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions;
}): void;
/**
* Returns a reference to the root or to the path specified in the provided
* argument.
*
* @param path - The relative string path or an existing Reference to a database
* location.
* @throws If a Reference is provided, throws if it does not belong to the
* same project.
* @returns Firebase reference.
*/
ref(path?: string): Reference;
ref(path?: Reference): Reference;
/**
* Returns a reference to the root or the path specified in url.
* We throw a exception if the url is not in the same domain as the
* current repo.
* @returns Firebase reference.
*/
refFromURL(url: string): Reference;
goOffline(): void;
goOnline(): void;
}

View file

@ -0,0 +1,207 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DataSnapshot as ModularDataSnapshot, Query as ExpQuery, DatabaseReference as ModularReference } from '@firebase/database';
import { Compat } from '@firebase/util';
import { Database } from './Database';
import { OnDisconnect } from './onDisconnect';
import { TransactionResult } from './TransactionResult';
/**
* Class representing a firebase data snapshot. It wraps a SnapshotNode and
* surfaces the public methods (val, forEach, etc.) we want to expose.
*/
export declare class DataSnapshot implements Compat<ModularDataSnapshot> {
readonly _database: Database;
readonly _delegate: ModularDataSnapshot;
constructor(_database: Database, _delegate: ModularDataSnapshot);
/**
* Retrieves the snapshot contents as JSON. Returns null if the snapshot is
* empty.
*
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
val(): unknown;
/**
* Returns the snapshot contents as JSON, including priorities of node. Suitable for exporting
* the entire node contents.
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
exportVal(): unknown;
toJSON(): unknown;
/**
* Returns whether the snapshot contains a non-null value.
*
* @returns Whether the snapshot contains a non-null value, or is empty.
*/
exists(): boolean;
/**
* Returns a DataSnapshot of the specified child node's contents.
*
* @param path - Path to a child.
* @returns DataSnapshot for child node.
*/
child(path: string): DataSnapshot;
/**
* Returns whether the snapshot contains a child at the specified path.
*
* @param path - Path to a child.
* @returns Whether the child exists.
*/
hasChild(path: string): boolean;
/**
* Returns the priority of the object, or null if no priority was set.
*
* @returns The priority.
*/
getPriority(): string | number | null;
/**
* Iterates through child nodes and calls the specified action for each one.
*
* @param action - Callback function to be called
* for each child.
* @returns True if forEach was canceled by action returning true for
* one of the child nodes.
*/
forEach(action: (snapshot: IteratedDataSnapshot) => boolean | void): boolean;
/**
* Returns whether this DataSnapshot has children.
* @returns True if the DataSnapshot contains 1 or more child nodes.
*/
hasChildren(): boolean;
get key(): string;
/**
* Returns the number of children for this DataSnapshot.
* @returns The number of children that this DataSnapshot contains.
*/
numChildren(): number;
/**
* @returns The Firebase reference for the location this snapshot's data came
* from.
*/
getRef(): Reference;
get ref(): Reference;
}
/**
* Represents a child snapshot of a `Reference` that is being iterated over. The key will never be undefined.
*/
export interface IteratedDataSnapshot extends DataSnapshot {
key: string;
}
export interface SnapshotCallback {
(dataSnapshot: DataSnapshot, previousChildName?: string | null): unknown;
}
/**
* A Query represents a filter to be applied to a firebase location. This object purely represents the
* query expression (and exposes our public API to build the query). The actual query logic is in ViewBase.js.
*
* Since every Firebase reference is a query, Firebase inherits from this object.
*/
export declare class Query implements Compat<ExpQuery> {
readonly database: Database;
readonly _delegate: ExpQuery;
constructor(database: Database, _delegate: ExpQuery);
on(eventType: string, callback: SnapshotCallback, cancelCallbackOrContext?: ((a: Error) => unknown) | object | null, context?: object | null): SnapshotCallback;
off(eventType?: string, callback?: SnapshotCallback, context?: object | null): void;
/**
* Get the server-value for this query, or return a cached value if not connected.
*/
get(): Promise<DataSnapshot>;
/**
* Attaches a listener, waits for the first event, and then removes the listener
*/
once(eventType: string, callback?: SnapshotCallback, failureCallbackOrContext?: ((a: Error) => void) | object | null, context?: object | null): Promise<DataSnapshot>;
/**
* Set a limit and anchor it to the start of the window.
*/
limitToFirst(limit: number): Query;
/**
* Set a limit and anchor it to the end of the window.
*/
limitToLast(limit: number): Query;
/**
* Given a child path, return a new query ordered by the specified grandchild path.
*/
orderByChild(path: string): Query;
/**
* Return a new query ordered by the KeyIndex
*/
orderByKey(): Query;
/**
* Return a new query ordered by the PriorityIndex
*/
orderByPriority(): Query;
/**
* Return a new query ordered by the ValueIndex
*/
orderByValue(): Query;
startAt(value?: number | string | boolean | null, name?: string | null): Query;
startAfter(value?: number | string | boolean | null, name?: string | null): Query;
endAt(value?: number | string | boolean | null, name?: string | null): Query;
endBefore(value?: number | string | boolean | null, name?: string | null): Query;
/**
* Load the selection of children with exactly the specified value, and, optionally,
* the specified name.
*/
equalTo(value: number | string | boolean | null, name?: string): Query;
/**
* @returns URL for this location.
*/
toString(): string;
toJSON(): string;
/**
* Return true if this query and the provided query are equivalent; otherwise, return false.
*/
isEqual(other: Query): boolean;
/**
* Helper used by .on and .once to extract the context and or cancel arguments.
* @param fnName - The function name (on or once)
*
*/
private static getCancelAndContextArgs_;
get ref(): Reference;
}
export declare class Reference extends Query implements Compat<ModularReference> {
readonly database: Database;
readonly _delegate: ModularReference;
then: Promise<Reference>['then'];
catch: Promise<Reference>['catch'];
/**
* Call options:
* new Reference(Repo, Path) or
* new Reference(url: string, string|RepoManager)
*
* Externally - this is the firebase.database.Reference type.
*/
constructor(database: Database, _delegate: ModularReference);
/** @returns {?string} */
getKey(): string | null;
child(pathString: string): Reference;
/** @returns {?Reference} */
getParent(): Reference | null;
/** @returns {!Reference} */
getRoot(): Reference;
set(newVal: unknown, onComplete?: (error: Error | null) => void): Promise<void>;
update(values: object, onComplete?: (a: Error | null) => void): Promise<void>;
setWithPriority(newVal: unknown, newPriority: string | number | null, onComplete?: (a: Error | null) => void): Promise<void>;
remove(onComplete?: (a: Error | null) => void): Promise<void>;
transaction(transactionUpdate: (currentData: unknown) => unknown, onComplete?: (error: Error | null, committed: boolean, dataSnapshot: DataSnapshot | null) => void, applyLocally?: boolean): Promise<TransactionResult>;
setPriority(priority: string | number | null, onComplete?: (a: Error | null) => void): Promise<void>;
push(value?: unknown, onComplete?: (a: Error | null) => void): Reference;
onDisconnect(): OnDisconnect;
get key(): string | null;
get parent(): Reference | null;
get root(): Reference;
}

View file

@ -0,0 +1,26 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DataSnapshot } from './Reference';
export declare class TransactionResult {
committed: boolean;
snapshot: DataSnapshot;
/**
* A type for the resolve value of Firebase.transaction.
*/
constructor(committed: boolean, snapshot: DataSnapshot);
toJSON(): object;
}

View file

@ -0,0 +1,41 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
import { FirebaseApp } from '@firebase/app-types';
import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
import * as types from '@firebase/database-types';
/**
* Used by console to create a database based on the app,
* passed database URL and a custom auth implementation.
*
* @param app - A valid FirebaseApp-like object
* @param url - A valid Firebase databaseURL
* @param version - custom version e.g. firebase-admin version
* @param customAuthImpl - custom auth implementation
*/
export declare function initStandalone<T>({ app, url, version, customAuthImpl, customAppCheckImpl, namespace, nodeAdmin }: {
app: FirebaseApp;
url: string;
version: string;
customAuthImpl: FirebaseAuthInternal;
customAppCheckImpl?: FirebaseAppCheckInternal;
namespace: T;
nodeAdmin?: boolean;
}): {
instance: types.Database;
namespace: T;
};

View file

@ -0,0 +1,27 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OnDisconnect as ModularOnDisconnect } from '@firebase/database';
import { Compat } from '@firebase/util';
export declare class OnDisconnect implements Compat<ModularOnDisconnect> {
readonly _delegate: ModularOnDisconnect;
constructor(_delegate: ModularOnDisconnect);
cancel(onComplete?: (a: Error | null) => void): Promise<void>;
remove(onComplete?: (a: Error | null) => void): Promise<void>;
set(value: unknown, onComplete?: (a: Error | null) => void): Promise<void>;
setWithPriority(value: unknown, priority: number | string | null, onComplete?: (a: Error | null) => void): Promise<void>;
update(objectToMerge: Record<string, unknown>, onComplete?: (a: Error | null) => void): Promise<void>;
}

View file

@ -0,0 +1,32 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseNamespace } from '@firebase/app-compat';
import * as types from '@firebase/database-types';
export declare function registerDatabase(instance: FirebaseNamespace): void;
declare module '@firebase/app-compat' {
interface FirebaseNamespace {
database?: {
(app?: FirebaseApp): types.FirebaseDatabase;
enableLogging: typeof types.enableLogging;
ServerValue: types.ServerValue;
Database: typeof types.FirebaseDatabase;
};
}
interface FirebaseApp {
database?(databaseURL?: string): types.FirebaseDatabase;
}
}

View file

@ -0,0 +1,30 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as types from '@firebase/database-types';
declare module '@firebase/app-compat' {
interface FirebaseNamespace {
database?: {
(app?: FirebaseApp): types.FirebaseDatabase;
enableLogging: typeof types.enableLogging;
ServerValue: types.ServerValue;
Database: typeof types.FirebaseDatabase;
};
}
interface FirebaseApp {
database?(): types.FirebaseDatabase;
}
}

View file

@ -0,0 +1,52 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { FirebaseApp } from '@firebase/app-types';
import { enableLogging } from '@firebase/database';
import { Database } from './api/Database';
import * as INTERNAL from './api/internal';
import { DataSnapshot, Query, Reference } from './api/Reference';
declare const ServerValue: {
TIMESTAMP: object;
increment: (delta: number) => object;
};
/**
* A one off register function which returns a database based on the app and
* passed database URL. (Used by the Admin SDK)
*
* @param app - A valid FirebaseApp-like object
* @param url - A valid Firebase databaseURL
* @param version - custom version e.g. firebase-admin version
* @param nodeAdmin - true if the SDK is being initialized from Firebase Admin.
*/
export declare function initStandalone(app: FirebaseApp, url: string, version: string, nodeAdmin?: boolean): {
instance: import("@firebase/database-types").Database;
namespace: {
Reference: typeof Reference;
Query: typeof Query;
Database: typeof Database;
DataSnapshot: typeof DataSnapshot;
enableLogging: typeof enableLogging;
INTERNAL: typeof INTERNAL;
ServerValue: {
TIMESTAMP: object;
increment: (delta: number) => object;
};
};
};
export { Database, Query, Reference, enableLogging, ServerValue };
export { OnDisconnect } from '@firebase/database';
export { DataSnapshot } from './api/Reference';

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export declare const warn: (msg: string) => void;

View file

@ -0,0 +1,18 @@
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export declare const validateBoolean: (fnName: string, argumentName: string, bool: unknown, optional: boolean) => void;
export declare const validateEventType: (fnName: string, eventType: string, optional: boolean) => void;

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../src/index';

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,34 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A set of functions to clean up event handlers.
*/
export declare let eventCleanupHandlers: any[];
/** Clean up outstanding event handlers */
export declare function eventCleanup(): void;
/**
* Creates a struct which waits for many events.
* @param pathAndEvents - an array of tuples of [Firebase, [event type strings]]
*/
export declare function eventTestHelper(pathAndEvents: any, helperName?: any): {
promise: Promise<unknown>;
initPromise: Promise<unknown>;
waiter: () => boolean;
watchesInitializedWaiter: () => boolean;
unregister: () => void;
addExpectedEvents(moreEvents: any): void;
};

View file

@ -0,0 +1,42 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../../src/index';
import { Path } from '../../../database/src/core/util/Path';
import { Query, Reference } from '../../src/api/Reference';
export declare const TEST_PROJECT: any;
export declare const DATABASE_ADDRESS: any;
export declare const DATABASE_URL: any;
export declare function createTestApp(): import("@firebase/app-compat").FirebaseApp;
/**
* Gets or creates a root node to the test namespace. All calls sharing the
* value of opt_i will share an app context.
*/
export declare function getRootNode(i?: number, ref?: string): any;
/**
* Create multiple refs to the same top level
* push key - each on its own Firebase.Context.
*/
export declare function getRandomNode(numNodes?: any): Reference | Reference[];
export declare function getQueryValue(query: Query): Promise<unknown>;
export declare function pause(milliseconds: number): Promise<void>;
export declare function getPath(query: Query): string;
export declare function shuffle(arr: any, randFn?: () => number): void;
export declare function getFreshRepo(path: Path): any;
export declare function getFreshRepoFromReference(ref: any): any;
export declare function getSnap(path: any): any;
export declare function getVal(path: any): any;
export declare function canCreateExtraConnections(): boolean;

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

View file

@ -0,0 +1,17 @@
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import '../src/index';

View file

@ -0,0 +1,859 @@
import firebase from '@firebase/app-compat';
import { ComponentContainer, Provider, Component } from '@firebase/component';
import { _validatePathString, onChildMoved, onChildChanged, onChildRemoved, onChildAdded, onValue, off, get, query, limitToFirst, limitToLast, orderByChild, orderByKey, orderByPriority, orderByValue, startAt, startAfter, endAt, endBefore, equalTo, _ReferenceImpl, _QueryImpl, _QueryParams, child, set, _validateWritablePath, update, setWithPriority, remove, runTransaction, setPriority, push, OnDisconnect as OnDisconnect$1, forceWebSockets, forceLongPolling, connectDatabaseEmulator, refFromURL, ref, goOffline, goOnline, serverTimestamp, increment, _setSDKVersion, _repoManagerDatabaseFromApp, enableLogging } from '@firebase/database';
import { errorPrefix, validateArgCount, validateCallback, validateContextObject, Deferred } from '@firebase/util';
import { Logger } from '@firebase/logger';
const name = "@firebase/database-compat";
const version = "2.0.0";
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const logClient = new Logger('@firebase/database-compat');
const warn = function (msg) {
const message = 'FIREBASE WARNING: ' + msg;
logClient.warn(message);
};
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const validateBoolean = function (fnName, argumentName, bool, optional) {
if (optional && bool === undefined) {
return;
}
if (typeof bool !== 'boolean') {
throw new Error(errorPrefix(fnName, argumentName) + 'must be a boolean.');
}
};
const validateEventType = function (fnName, eventType, optional) {
if (optional && eventType === undefined) {
return;
}
switch (eventType) {
case 'value':
case 'child_added':
case 'child_removed':
case 'child_changed':
case 'child_moved':
break;
default:
throw new Error(errorPrefix(fnName, 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
};
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class OnDisconnect {
constructor(_delegate) {
this._delegate = _delegate;
}
cancel(onComplete) {
validateArgCount('OnDisconnect.cancel', 0, 1, arguments.length);
validateCallback('OnDisconnect.cancel', 'onComplete', onComplete, true);
const result = this._delegate.cancel();
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
remove(onComplete) {
validateArgCount('OnDisconnect.remove', 0, 1, arguments.length);
validateCallback('OnDisconnect.remove', 'onComplete', onComplete, true);
const result = this._delegate.remove();
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
set(value, onComplete) {
validateArgCount('OnDisconnect.set', 1, 2, arguments.length);
validateCallback('OnDisconnect.set', 'onComplete', onComplete, true);
const result = this._delegate.set(value);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
setWithPriority(value, priority, onComplete) {
validateArgCount('OnDisconnect.setWithPriority', 2, 3, arguments.length);
validateCallback('OnDisconnect.setWithPriority', 'onComplete', onComplete, true);
const result = this._delegate.setWithPriority(value, priority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
update(objectToMerge, onComplete) {
validateArgCount('OnDisconnect.update', 1, 2, arguments.length);
if (Array.isArray(objectToMerge)) {
const newObjectToMerge = {};
for (let i = 0; i < objectToMerge.length; ++i) {
newObjectToMerge['' + i] = objectToMerge[i];
}
objectToMerge = newObjectToMerge;
warn('Passing an Array to firebase.database.onDisconnect().update() is deprecated. Use set() if you want to overwrite the ' +
'existing data, or an Object with integer keys if you really do want to only update some of the children.');
}
validateCallback('OnDisconnect.update', 'onComplete', onComplete, true);
const result = this._delegate.update(objectToMerge);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class TransactionResult {
/**
* A type for the resolve value of Firebase.transaction.
*/
constructor(committed, snapshot) {
this.committed = committed;
this.snapshot = snapshot;
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON() {
validateArgCount('TransactionResult.toJSON', 0, 1, arguments.length);
return { committed: this.committed, snapshot: this.snapshot.toJSON() };
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Class representing a firebase data snapshot. It wraps a SnapshotNode and
* surfaces the public methods (val, forEach, etc.) we want to expose.
*/
class DataSnapshot {
constructor(_database, _delegate) {
this._database = _database;
this._delegate = _delegate;
}
/**
* Retrieves the snapshot contents as JSON. Returns null if the snapshot is
* empty.
*
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
val() {
validateArgCount('DataSnapshot.val', 0, 0, arguments.length);
return this._delegate.val();
}
/**
* Returns the snapshot contents as JSON, including priorities of node. Suitable for exporting
* the entire node contents.
* @returns JSON representation of the DataSnapshot contents, or null if empty.
*/
exportVal() {
validateArgCount('DataSnapshot.exportVal', 0, 0, arguments.length);
return this._delegate.exportVal();
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users
toJSON() {
// Optional spacer argument is unnecessary because we're depending on recursion rather than stringifying the content
validateArgCount('DataSnapshot.toJSON', 0, 1, arguments.length);
return this._delegate.toJSON();
}
/**
* Returns whether the snapshot contains a non-null value.
*
* @returns Whether the snapshot contains a non-null value, or is empty.
*/
exists() {
validateArgCount('DataSnapshot.exists', 0, 0, arguments.length);
return this._delegate.exists();
}
/**
* Returns a DataSnapshot of the specified child node's contents.
*
* @param path - Path to a child.
* @returns DataSnapshot for child node.
*/
child(path) {
validateArgCount('DataSnapshot.child', 0, 1, arguments.length);
// Ensure the childPath is a string (can be a number)
path = String(path);
_validatePathString('DataSnapshot.child', 'path', path, false);
return new DataSnapshot(this._database, this._delegate.child(path));
}
/**
* Returns whether the snapshot contains a child at the specified path.
*
* @param path - Path to a child.
* @returns Whether the child exists.
*/
hasChild(path) {
validateArgCount('DataSnapshot.hasChild', 1, 1, arguments.length);
_validatePathString('DataSnapshot.hasChild', 'path', path, false);
return this._delegate.hasChild(path);
}
/**
* Returns the priority of the object, or null if no priority was set.
*
* @returns The priority.
*/
getPriority() {
validateArgCount('DataSnapshot.getPriority', 0, 0, arguments.length);
return this._delegate.priority;
}
/**
* Iterates through child nodes and calls the specified action for each one.
*
* @param action - Callback function to be called
* for each child.
* @returns True if forEach was canceled by action returning true for
* one of the child nodes.
*/
forEach(action) {
validateArgCount('DataSnapshot.forEach', 1, 1, arguments.length);
validateCallback('DataSnapshot.forEach', 'action', action, false);
return this._delegate.forEach(expDataSnapshot => action(new DataSnapshot(this._database, expDataSnapshot)));
}
/**
* Returns whether this DataSnapshot has children.
* @returns True if the DataSnapshot contains 1 or more child nodes.
*/
hasChildren() {
validateArgCount('DataSnapshot.hasChildren', 0, 0, arguments.length);
return this._delegate.hasChildren();
}
get key() {
return this._delegate.key;
}
/**
* Returns the number of children for this DataSnapshot.
* @returns The number of children that this DataSnapshot contains.
*/
numChildren() {
validateArgCount('DataSnapshot.numChildren', 0, 0, arguments.length);
return this._delegate.size;
}
/**
* @returns The Firebase reference for the location this snapshot's data came
* from.
*/
getRef() {
validateArgCount('DataSnapshot.ref', 0, 0, arguments.length);
return new Reference(this._database, this._delegate.ref);
}
get ref() {
return this.getRef();
}
}
/**
* A Query represents a filter to be applied to a firebase location. This object purely represents the
* query expression (and exposes our public API to build the query). The actual query logic is in ViewBase.js.
*
* Since every Firebase reference is a query, Firebase inherits from this object.
*/
class Query {
constructor(database, _delegate) {
this.database = database;
this._delegate = _delegate;
}
on(eventType, callback, cancelCallbackOrContext, context) {
var _a;
validateArgCount('Query.on', 2, 4, arguments.length);
validateCallback('Query.on', 'callback', callback, false);
const ret = Query.getCancelAndContextArgs_('Query.on', cancelCallbackOrContext, context);
const valueCallback = (expSnapshot, previousChildName) => {
callback.call(ret.context, new DataSnapshot(this.database, expSnapshot), previousChildName);
};
valueCallback.userCallback = callback;
valueCallback.context = ret.context;
const cancelCallback = (_a = ret.cancel) === null || _a === void 0 ? void 0 : _a.bind(ret.context);
switch (eventType) {
case 'value':
onValue(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_added':
onChildAdded(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_removed':
onChildRemoved(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_changed':
onChildChanged(this._delegate, valueCallback, cancelCallback);
return callback;
case 'child_moved':
onChildMoved(this._delegate, valueCallback, cancelCallback);
return callback;
default:
throw new Error(errorPrefix('Query.on', 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
}
off(eventType, callback, context) {
validateArgCount('Query.off', 0, 3, arguments.length);
validateEventType('Query.off', eventType, true);
validateCallback('Query.off', 'callback', callback, true);
validateContextObject('Query.off', 'context', context, true);
if (callback) {
const valueCallback = () => { };
valueCallback.userCallback = callback;
valueCallback.context = context;
off(this._delegate, eventType, valueCallback);
}
else {
off(this._delegate, eventType);
}
}
/**
* Get the server-value for this query, or return a cached value if not connected.
*/
get() {
return get(this._delegate).then(expSnapshot => {
return new DataSnapshot(this.database, expSnapshot);
});
}
/**
* Attaches a listener, waits for the first event, and then removes the listener
*/
once(eventType, callback, failureCallbackOrContext, context) {
validateArgCount('Query.once', 1, 4, arguments.length);
validateCallback('Query.once', 'callback', callback, true);
const ret = Query.getCancelAndContextArgs_('Query.once', failureCallbackOrContext, context);
const deferred = new Deferred();
const valueCallback = (expSnapshot, previousChildName) => {
const result = new DataSnapshot(this.database, expSnapshot);
if (callback) {
callback.call(ret.context, result, previousChildName);
}
deferred.resolve(result);
};
valueCallback.userCallback = callback;
valueCallback.context = ret.context;
const cancelCallback = (error) => {
if (ret.cancel) {
ret.cancel.call(ret.context, error);
}
deferred.reject(error);
};
switch (eventType) {
case 'value':
onValue(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_added':
onChildAdded(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_removed':
onChildRemoved(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_changed':
onChildChanged(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
case 'child_moved':
onChildMoved(this._delegate, valueCallback, cancelCallback, {
onlyOnce: true
});
break;
default:
throw new Error(errorPrefix('Query.once', 'eventType') +
'must be a valid event type = "value", "child_added", "child_removed", ' +
'"child_changed", or "child_moved".');
}
return deferred.promise;
}
/**
* Set a limit and anchor it to the start of the window.
*/
limitToFirst(limit) {
validateArgCount('Query.limitToFirst', 1, 1, arguments.length);
return new Query(this.database, query(this._delegate, limitToFirst(limit)));
}
/**
* Set a limit and anchor it to the end of the window.
*/
limitToLast(limit) {
validateArgCount('Query.limitToLast', 1, 1, arguments.length);
return new Query(this.database, query(this._delegate, limitToLast(limit)));
}
/**
* Given a child path, return a new query ordered by the specified grandchild path.
*/
orderByChild(path) {
validateArgCount('Query.orderByChild', 1, 1, arguments.length);
return new Query(this.database, query(this._delegate, orderByChild(path)));
}
/**
* Return a new query ordered by the KeyIndex
*/
orderByKey() {
validateArgCount('Query.orderByKey', 0, 0, arguments.length);
return new Query(this.database, query(this._delegate, orderByKey()));
}
/**
* Return a new query ordered by the PriorityIndex
*/
orderByPriority() {
validateArgCount('Query.orderByPriority', 0, 0, arguments.length);
return new Query(this.database, query(this._delegate, orderByPriority()));
}
/**
* Return a new query ordered by the ValueIndex
*/
orderByValue() {
validateArgCount('Query.orderByValue', 0, 0, arguments.length);
return new Query(this.database, query(this._delegate, orderByValue()));
}
startAt(value = null, name) {
validateArgCount('Query.startAt', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, startAt(value, name)));
}
startAfter(value = null, name) {
validateArgCount('Query.startAfter', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, startAfter(value, name)));
}
endAt(value = null, name) {
validateArgCount('Query.endAt', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, endAt(value, name)));
}
endBefore(value = null, name) {
validateArgCount('Query.endBefore', 0, 2, arguments.length);
return new Query(this.database, query(this._delegate, endBefore(value, name)));
}
/**
* Load the selection of children with exactly the specified value, and, optionally,
* the specified name.
*/
equalTo(value, name) {
validateArgCount('Query.equalTo', 1, 2, arguments.length);
return new Query(this.database, query(this._delegate, equalTo(value, name)));
}
/**
* @returns URL for this location.
*/
toString() {
validateArgCount('Query.toString', 0, 0, arguments.length);
return this._delegate.toString();
}
// Do not create public documentation. This is intended to make JSON serialization work but is otherwise unnecessary
// for end-users.
toJSON() {
// An optional spacer argument is unnecessary for a string.
validateArgCount('Query.toJSON', 0, 1, arguments.length);
return this._delegate.toJSON();
}
/**
* Return true if this query and the provided query are equivalent; otherwise, return false.
*/
isEqual(other) {
validateArgCount('Query.isEqual', 1, 1, arguments.length);
if (!(other instanceof Query)) {
const error = 'Query.isEqual failed: First argument must be an instance of firebase.database.Query.';
throw new Error(error);
}
return this._delegate.isEqual(other._delegate);
}
/**
* Helper used by .on and .once to extract the context and or cancel arguments.
* @param fnName - The function name (on or once)
*
*/
static getCancelAndContextArgs_(fnName, cancelOrContext, context) {
const ret = { cancel: undefined, context: undefined };
if (cancelOrContext && context) {
ret.cancel = cancelOrContext;
validateCallback(fnName, 'cancel', ret.cancel, true);
ret.context = context;
validateContextObject(fnName, 'context', ret.context, true);
}
else if (cancelOrContext) {
// we have either a cancel callback or a context.
if (typeof cancelOrContext === 'object' && cancelOrContext !== null) {
// it's a context!
ret.context = cancelOrContext;
}
else if (typeof cancelOrContext === 'function') {
ret.cancel = cancelOrContext;
}
else {
throw new Error(errorPrefix(fnName, 'cancelOrContext') +
' must either be a cancel callback or a context object.');
}
}
return ret;
}
get ref() {
return new Reference(this.database, new _ReferenceImpl(this._delegate._repo, this._delegate._path));
}
}
class Reference extends Query {
/**
* Call options:
* new Reference(Repo, Path) or
* new Reference(url: string, string|RepoManager)
*
* Externally - this is the firebase.database.Reference type.
*/
constructor(database, _delegate) {
super(database, new _QueryImpl(_delegate._repo, _delegate._path, new _QueryParams(), false));
this.database = database;
this._delegate = _delegate;
}
/** @returns {?string} */
getKey() {
validateArgCount('Reference.key', 0, 0, arguments.length);
return this._delegate.key;
}
child(pathString) {
validateArgCount('Reference.child', 1, 1, arguments.length);
if (typeof pathString === 'number') {
pathString = String(pathString);
}
return new Reference(this.database, child(this._delegate, pathString));
}
/** @returns {?Reference} */
getParent() {
validateArgCount('Reference.parent', 0, 0, arguments.length);
const parent = this._delegate.parent;
return parent ? new Reference(this.database, parent) : null;
}
/** @returns {!Reference} */
getRoot() {
validateArgCount('Reference.root', 0, 0, arguments.length);
return new Reference(this.database, this._delegate.root);
}
set(newVal, onComplete) {
validateArgCount('Reference.set', 1, 2, arguments.length);
validateCallback('Reference.set', 'onComplete', onComplete, true);
const result = set(this._delegate, newVal);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
update(values, onComplete) {
validateArgCount('Reference.update', 1, 2, arguments.length);
if (Array.isArray(values)) {
const newObjectToMerge = {};
for (let i = 0; i < values.length; ++i) {
newObjectToMerge['' + i] = values[i];
}
values = newObjectToMerge;
warn('Passing an Array to Firebase.update() is deprecated. ' +
'Use set() if you want to overwrite the existing data, or ' +
'an Object with integer keys if you really do want to ' +
'only update some of the children.');
}
_validateWritablePath('Reference.update', this._delegate._path);
validateCallback('Reference.update', 'onComplete', onComplete, true);
const result = update(this._delegate, values);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
setWithPriority(newVal, newPriority, onComplete) {
validateArgCount('Reference.setWithPriority', 2, 3, arguments.length);
validateCallback('Reference.setWithPriority', 'onComplete', onComplete, true);
const result = setWithPriority(this._delegate, newVal, newPriority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
remove(onComplete) {
validateArgCount('Reference.remove', 0, 1, arguments.length);
validateCallback('Reference.remove', 'onComplete', onComplete, true);
const result = remove(this._delegate);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
transaction(transactionUpdate, onComplete, applyLocally) {
validateArgCount('Reference.transaction', 1, 3, arguments.length);
validateCallback('Reference.transaction', 'transactionUpdate', transactionUpdate, false);
validateCallback('Reference.transaction', 'onComplete', onComplete, true);
validateBoolean('Reference.transaction', 'applyLocally', applyLocally, true);
const result = runTransaction(this._delegate, transactionUpdate, {
applyLocally
}).then(transactionResult => new TransactionResult(transactionResult.committed, new DataSnapshot(this.database, transactionResult.snapshot)));
if (onComplete) {
result.then(transactionResult => onComplete(null, transactionResult.committed, transactionResult.snapshot), error => onComplete(error, false, null));
}
return result;
}
setPriority(priority, onComplete) {
validateArgCount('Reference.setPriority', 1, 2, arguments.length);
validateCallback('Reference.setPriority', 'onComplete', onComplete, true);
const result = setPriority(this._delegate, priority);
if (onComplete) {
result.then(() => onComplete(null), error => onComplete(error));
}
return result;
}
push(value, onComplete) {
validateArgCount('Reference.push', 0, 2, arguments.length);
validateCallback('Reference.push', 'onComplete', onComplete, true);
const expPromise = push(this._delegate, value);
const promise = expPromise.then(expRef => new Reference(this.database, expRef));
if (onComplete) {
promise.then(() => onComplete(null), error => onComplete(error));
}
const result = new Reference(this.database, expPromise);
result.then = promise.then.bind(promise);
result.catch = promise.catch.bind(promise, undefined);
return result;
}
onDisconnect() {
_validateWritablePath('Reference.onDisconnect', this._delegate._path);
return new OnDisconnect(new OnDisconnect$1(this._delegate._repo, this._delegate._path));
}
get key() {
return this.getKey();
}
get parent() {
return this.getParent();
}
get root() {
return this.getRoot();
}
}
/**
* @license
* Copyright 2017 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Class representing a firebase database.
*/
class Database {
/**
* The constructor should not be called by users of our public API.
*/
constructor(_delegate, app) {
this._delegate = _delegate;
this.app = app;
this.INTERNAL = {
delete: () => this._delegate._delete(),
forceWebSockets,
forceLongPolling
};
}
/**
* Modify this instance to communicate with the Realtime Database emulator.
*
* <p>Note: This method must be called before performing any other operation.
*
* @param host - the emulator host (ex: localhost)
* @param port - the emulator port (ex: 8080)
* @param options.mockUserToken - the mock auth token to use for unit testing Security Rules
*/
useEmulator(host, port, options = {}) {
connectDatabaseEmulator(this._delegate, host, port, options);
}
ref(path) {
validateArgCount('database.ref', 0, 1, arguments.length);
if (path instanceof Reference) {
const childRef = refFromURL(this._delegate, path.toString());
return new Reference(this, childRef);
}
else {
const childRef = ref(this._delegate, path);
return new Reference(this, childRef);
}
}
/**
* Returns a reference to the root or the path specified in url.
* We throw a exception if the url is not in the same domain as the
* current repo.
* @returns Firebase reference.
*/
refFromURL(url) {
const apiName = 'database.refFromURL';
validateArgCount(apiName, 1, 1, arguments.length);
const childRef = refFromURL(this._delegate, url);
return new Reference(this, childRef);
}
// Make individual repo go offline.
goOffline() {
validateArgCount('database.goOffline', 0, 0, arguments.length);
return goOffline(this._delegate);
}
goOnline() {
validateArgCount('database.goOnline', 0, 0, arguments.length);
return goOnline(this._delegate);
}
}
Database.ServerValue = {
TIMESTAMP: serverTimestamp(),
increment: (delta) => increment(delta)
};
/**
* Used by console to create a database based on the app,
* passed database URL and a custom auth implementation.
*
* @param app - A valid FirebaseApp-like object
* @param url - A valid Firebase databaseURL
* @param version - custom version e.g. firebase-admin version
* @param customAuthImpl - custom auth implementation
*/
function initStandalone({ app, url, version, customAuthImpl, customAppCheckImpl, namespace, nodeAdmin = false }) {
_setSDKVersion(version);
const container = new ComponentContainer('database-standalone');
/**
* ComponentContainer('database-standalone') is just a placeholder that doesn't perform
* any actual function.
*/
const authProvider = new Provider('auth-internal', container);
authProvider.setComponent(new Component('auth-internal', () => customAuthImpl, "PRIVATE" /* ComponentType.PRIVATE */));
let appCheckProvider = undefined;
if (customAppCheckImpl) {
appCheckProvider = new Provider('app-check-internal', container);
appCheckProvider.setComponent(new Component('app-check-internal', () => customAppCheckImpl, "PRIVATE" /* ComponentType.PRIVATE */));
}
return {
instance: new Database(_repoManagerDatabaseFromApp(app, authProvider, appCheckProvider, url, nodeAdmin), app),
namespace
};
}
var INTERNAL = /*#__PURE__*/Object.freeze({
__proto__: null,
initStandalone: initStandalone
});
/**
* @license
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const ServerValue = Database.ServerValue;
function registerDatabase(instance) {
// Register the Database Service with the 'firebase' namespace.
instance.INTERNAL.registerComponent(new Component('database-compat', (container, { instanceIdentifier: url }) => {
/* Dependencies */
// getImmediate for FirebaseApp will always succeed
const app = container.getProvider('app-compat').getImmediate();
const databaseExp = container
.getProvider('database')
.getImmediate({ identifier: url });
return new Database(databaseExp, app);
}, "PUBLIC" /* ComponentType.PUBLIC */)
.setServiceProps(
// firebase.database namespace properties
{
Reference,
Query,
Database,
DataSnapshot,
enableLogging,
INTERNAL,
ServerValue
})
.setMultipleInstances(true));
instance.registerVersion(name, version, 'node');
}
registerDatabase(firebase);
//# sourceMappingURL=index.js.map

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1 @@
{"type":"module"}