@firebase/data-connect 0.0.1-dataconnect-preview.f2ddc3d7b

package/dist/node-esm/src/index.node.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2024 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 * from './api';
+export * from './api.node';

package/dist/node-esm/src/logger.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2024 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 { LogLevelString } from "@firebase/logger";
+export declare function setLogLevel(logLevel: LogLevelString): void;
+export declare function logDebug(msg: string): void;
+export declare function logError(msg: string): void;

package/dist/node-esm/src/network/fetch.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2024 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 function initializeFetch(fetchImpl: typeof fetch): void;
+export declare function dcFetch<T, U>(url: string, body: U, { signal }: AbortController, accessToken: string | null): Promise<{
+    data: T;
+    errors: Error[];
+}>;

package/dist/node-esm/src/network/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 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 * from './transport';

package/dist/node-esm/src/network/transport/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright 2024 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 { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
+import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
+export interface DataConnectTransport {
+    invokeQuery<T, U>(queryName: string, body?: U): PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
+    invokeMutation<T, U>(queryName: string, body?: U): PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
+    useEmulator(host: string, port?: number, sslEnabled?: boolean): void;
+    onTokenChanged: (token: string | null) => void;
+}
+export interface CancellableOperation<T> extends PromiseLike<{
+    data: T;
+}> {
+    cancel: () => void;
+}
+export interface QueryResponse<T> extends CancellableOperation<T> {
+}
+export interface MutationResponse<T> extends CancellableOperation<T> {
+}
+export interface Sender<T> {
+    abort: () => void;
+    send: () => Promise<T>;
+}
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+export * from '../../core/FirebaseAuthProvider';

package/dist/node-esm/src/network/transport/rest.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license
+ * Copyright 2024 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 { DataConnectTransport } from '.';
+import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
+import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
+export declare class RESTTransport implements DataConnectTransport {
+    private apiKey?;
+    private authProvider?;
+    private host;
+    private port;
+    private location;
+    private connectorName;
+    private secure;
+    private project;
+    private serviceName;
+    private accessToken;
+    private authInitialized_;
+    constructor(options: DataConnectOptions, apiKey?: string | undefined, authProvider?: AuthTokenProvider | undefined, transportOptions?: TransportOptions | undefined);
+    get endpointUrl(): string;
+    useEmulator(host: string, port?: number, isSecure?: boolean): void;
+    onTokenChanged(newToken: string | null): void;
+    getWithAuth(): Promise<string | null>;
+    invokeQuery: <T, U = unknown>(queryName: string, body: U) => {
+        then: <TResult1 = {
+            data: T;
+            errors: Error[];
+        }, TResult2 = never>(onfulfilled?: ((value: {
+            data: T;
+            errors: Error[];
+        }) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined) => Promise<TResult1 | TResult2>;
+    };
+    invokeMutation: <T, U = unknown>(mutationName: string, body: U) => {
+        then: <TResult1 = {
+            data: T;
+            errors: Error[];
+        }, TResult2 = never>(onfulfilled?: ((value: {
+            data: T;
+            errors: Error[];
+        }) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined) => Promise<TResult1 | TResult2>;
+        cancel: () => void;
+    };
+}

package/dist/node-esm/src/register.d.ts

@@ -0,0 +1 @@
+export declare function registerDataConnect(variant?: string): void;

package/dist/node-esm/src/util/encoder.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2024 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 type HmacImpl = (obj: unknown) => string;
+export declare let encoderImpl: HmacImpl;
+export declare function setEncoder(encoder: HmacImpl): void;

package/dist/node-esm/src/util/map.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 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 function setIfNotExists<T>(map: Map<string, T>, key: string, val: T): void;

package/dist/node-esm/src/util/url.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2024 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 { ProjectOptions, TransportOptions } from '../api/DataConnect';
+export declare function urlBuilder(projectConfig: ProjectOptions, transportOptions: TransportOptions): string;
+export declare function addToken(url: string, apiKey?: string): string;

package/dist/node-esm/test/emulatorSeeder.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2024 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 { ReferenceType } from '../src';
+export interface SeedInfo {
+    type: ReferenceType;
+    name: string;
+}
+export declare function setupQueries(schema: string, seedInfoArray: SeedInfo[], skipSchema?: boolean): Promise<import("node-fetch").Response>;

package/dist/node-esm/test/queries.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 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 {};

package/dist/node-esm/test/util.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2024 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 { ConnectorConfig } from '../src';
+export declare const USE_EMULATOR = true;
+export declare const EMULATOR_PORT: string | undefined;
+export declare const CONNECTOR_NAME = "c";
+export declare const LOCATION_NAME = "l";
+export declare const SERVICE_NAME = "l";
+export declare const PROJECT_ID = "p";
+export declare function getConnectionConfig(): ConnectorConfig;
+export declare const app: import("@firebase/app").FirebaseApp;
+export declare function initDatabase(): import("../src").DataConnect;

package/dist/private.d.ts

@@ -0,0 +1,291 @@
+/**
+ * Firebase Data Connect
+ *
+ * @packageDocumentation
+ */
+
+import { FirebaseApp } from '@firebase/app';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
+import { FirebaseError } from '@firebase/util';
+import { FirebaseOptions } from '@firebase/app';
+import { LogLevelString } from '@firebase/logger';
+import { Provider } from '@firebase/component';
+
+export declare type AuthTokenListener = (token: string | null) => void;
+
+export declare interface AuthTokenProvider {
+    getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null>;
+    addTokenChangeListener(listener: AuthTokenListener): void;
+}
+
+export declare interface CancellableOperation<T> extends PromiseLike<{
+    data: T;
+}> {
+    cancel: () => void;
+}
+
+export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
+
+export declare interface ConnectorConfig {
+    location: string;
+    connector: string;
+    service: string;
+}
+
+export declare class DataConnect {
+    readonly app: FirebaseApp;
+    private readonly dataConnectOptions;
+    private readonly authProvider;
+    _queryManager: QueryManager;
+    _mutationManager: MutationManager;
+    isEmulator: boolean;
+    initialized: boolean;
+    private _transport;
+    private transportClass;
+    private transportOptions?;
+    private authTokenProvider?;
+    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, authProvider: Provider<FirebaseAuthInternalName>);
+    _delete(): Promise<void>;
+    getSettings(): ConnectorConfig;
+    setInitialized(): void;
+    enableEmulator(transportOptions: TransportOptions): void;
+}
+
+/** An error returned by a DataConnect operation. */
+declare class DataConnectError extends FirebaseError {
+    /**
+     * The backend error code associated with this error.
+     */
+    readonly code: DataConnectErrorCode;
+    /**
+     * A custom error description.
+     */
+    readonly message: string;
+    /** The stack of the error. */
+    readonly stack?: string;
+    /** @hideconstructor */
+    constructor(
+    /**
+     * The backend error code associated with this error.
+     */
+    code: DataConnectErrorCode, 
+    /**
+     * A custom error description.
+     */
+    message: string);
+}
+
+declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error';
+
+export declare interface DataConnectOptions extends ConnectorConfig {
+    projectId: string;
+}
+
+export declare interface DataConnectResult<Data, Variables> extends OpResult<Data> {
+    ref: OperationRef<Data, Variables>;
+}
+
+export declare interface DataConnectSubscription<Data, Variables> {
+    userCallback: OnResultSubscription<Data, Variables>;
+    errCallback?: (e?: DataConnectError) => void;
+    unsubscribe: () => void;
+}
+
+export declare interface DataConnectTransport {
+    invokeQuery<T, U>(queryName: string, body?: U): PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
+    invokeMutation<T, U>(queryName: string, body?: U): PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
+    useEmulator(host: string, port?: number, sslEnabled?: boolean): void;
+    onTokenChanged: (token: string | null) => void;
+}
+
+export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
+
+export declare class EmulatorTokenProvider implements AuthTokenProvider {
+    private accessToken;
+    /** A string that is treated as an admin access token by the RTDB emulator. Used by Admin SDK. */
+    static OWNER: string;
+    constructor(accessToken: string);
+    getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData>;
+    addTokenChangeListener(listener: AuthTokenListener): void;
+    removeTokenChangeListener(listener: (token: string | null) => void): void;
+    notifyForInvalidToken(): void;
+}
+
+export declare function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
+
+export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+
+export declare const FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = "FIREBASE_DATA_CONNECT_EMULATOR_HOST";
+
+export declare class FirebaseAuthProvider implements AuthTokenProvider {
+    private appName;
+    private options;
+    private authProvider_;
+    private auth_;
+    constructor(appName: string, options: FirebaseOptions, authProvider_: Provider<FirebaseAuthInternalName>);
+    getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null>;
+    addTokenChangeListener(listener: AuthTokenListener): void;
+    removeTokenChangeListener(listener: (token: string | null) => void): void;
+}
+
+export declare function getDataConnect(options: ConnectorConfig): DataConnect;
+
+export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+
+export declare class MutationManager {
+    private transport;
+    private _inflight;
+    constructor(transport: DataConnectTransport);
+    executeMutation<Response, Variables>(mutationRef: MutationRef<Response, Variables>): MutationPromise<Response, Variables>;
+}
+
+export declare interface MutationPromise<Data, Variables> extends PromiseLike<MutationResult<Data, Variables>> {
+}
+
+export declare interface MutationRef<Response, Variables> extends OperationRef<Response, Variables> {
+    refType: typeof MutationStr;
+}
+
+export declare function mutationRef<Response>(dcInstance: DataConnect, queryName: string): MutationRef<Response, undefined>;
+
+export declare function mutationRef<Response, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): MutationRef<Response, Variables>;
+
+export declare interface MutationResponse<T> extends CancellableOperation<T> {
+}
+
+export declare interface MutationResult<Data, Variables> extends DataConnectResult<Data, Variables> {
+    ref: MutationRef<Data, Variables>;
+}
+
+export declare const MutationStr = "mutation";
+
+export declare type OnCompleteSubscription = () => void;
+
+export declare type OnErrorSubscription = (err?: DataConnectError) => void;
+
+export declare type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
+
+export declare interface OperationRef<_Data, Variables> {
+    name: string;
+    variables: Variables;
+    refType: ReferenceType;
+    dataConnect: DataConnect;
+}
+
+export declare interface OpResult<Data> {
+    data: Data;
+    source: DataSource;
+    fetchTime: string;
+}
+
+/* Excluded from this release type: parseOptions */
+
+export declare interface ProjectOptions {
+    location: string;
+    connector: string;
+    service: string;
+    projectId: string;
+}
+
+declare class QueryManager {
+    private transport;
+    _queries: Map<string, TrackedQuery<unknown, unknown>>;
+    constructor(transport: DataConnectTransport);
+    track<Response, Variables>(queryName: string, variables: Variables, initialCache?: OpResult<Response>): TrackedQuery<unknown, unknown> | undefined;
+    addSubscription<Response, Variables>(queryRef: OperationRef<Response, Variables>, onResultCallback: OnResultSubscription<Response, Variables>, onErrorCallback?: OnErrorSubscription, initialCache?: OpResult<Response>): () => void;
+    executeQuery<Response, Variables>(queryRef: QueryRef<Response, Variables>): QueryPromise<Response, Variables>;
+    enableEmulator(host: string, port: number): void;
+}
+
+export declare interface QueryPromise<Data, Variables> extends PromiseLike<QueryResult<Data, Variables>> {
+}
+
+export declare interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
+    refType: typeof QueryStr;
+}
+
+export declare function queryRef<Data>(dcInstance: DataConnect, queryName: string): QueryRef<Data, undefined>;
+
+export declare function queryRef<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
+
+export declare interface QueryResponse<T> extends CancellableOperation<T> {
+}
+
+export declare interface QueryResult<Data, Variables> extends DataConnectResult<Data, Variables> {
+    ref: QueryRef<Data, Variables>;
+    toJSON: () => SerializedRef<Data, Variables>;
+}
+
+export declare const QueryStr = "query";
+
+export declare type QueryUnsubscribe = () => void;
+
+export declare type ReferenceType = typeof QueryStr | typeof MutationStr;
+
+export declare interface RefInfo<Variables> {
+    name: string;
+    variables: Variables;
+    connectorConfig: DataConnectOptions;
+}
+
+export declare interface Sender<T> {
+    abort: () => void;
+    send: () => Promise<T>;
+}
+
+export declare interface SerializedRef<Data, Variables> extends OpResult<Data> {
+    refInfo: RefInfo<Variables>;
+}
+
+export declare function setLogLevel(logLevel: LogLevelString): void;
+
+export declare const SOURCE_CACHE = "CACHE";
+
+export declare const SOURCE_SERVER = "SERVER";
+
+/**
+ *
+ * @public
+ * @param queryRef
+ * @param onResult
+ * @param onErr
+ * @param initialCache
+ * @returns
+ */
+export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, observer: SubscriptionOptions<Data, Variables>): QueryUnsubscribe;
+
+export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, onNext: OnResultSubscription<Data, Variables>, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe;
+
+export declare interface SubscriptionOptions<Data, Variables> {
+    onNext?: OnResultSubscription<Data, Variables>;
+    onErr?: OnErrorSubscription;
+    onComplete?: OnCompleteSubscription;
+}
+
+export declare function terminate(dataConnect: DataConnect): void;
+
+export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
+
+declare interface TrackedQuery<Response, Variables> {
+    ref: Omit<OperationRef<Response, Variables>, 'dataConnect'>;
+    subscriptions: Array<DataConnectSubscription<Response, Variables>>;
+    currentCache: OpResult<Response> | null;
+    lastError: DataConnectError | null;
+}
+
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+
+export declare interface TransportOptions {
+    host: string;
+    sslEnabled?: boolean;
+    port?: number;
+}
+
+export { }