@firebase/data-connect 0.0.3-dataconnect-preview.d986d4bf2 → 0.1.0

package/dist/private.d.ts

@@ -4,17 +4,21 @@
  * @packageDocumentation
  */
 
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { AppCheckTokenListener } from '@firebase/app-check-interop-types';
+import { AppCheckTokenResult } from '@firebase/app-check-interop-types';
 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-types';
 import { LogLevelString } from '@firebase/logger';
 import { Provider } from '@firebase/component';
 
-export declare type AuthTokenListener = (token: string | null) => void;
+/* Excluded from this release type: AppCheckTokenProvider */
 
-export declare interface AuthTokenProvider {
+declare type AuthTokenListener = (token: string | null) => void;
+
+declare interface AuthTokenProvider {
     getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null>;
     addTokenChangeListener(listener: AuthTokenListener): void;
 }
@@ -50,16 +54,18 @@ export declare class DataConnect {
     readonly app: FirebaseApp;
     private readonly dataConnectOptions;
     private readonly _authProvider;
+    private readonly _appCheckProvider;
     _queryManager: QueryManager;
     _mutationManager: MutationManager;
     isEmulator: boolean;
-    initialized: boolean;
+    _initialized: boolean;
     private _transport;
     private _transportClass;
     private _transportOptions?;
     private _authTokenProvider?;
     _isUsingGeneratedSdk: boolean;
-    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>);
+    private _appCheckTokenProvider?;
+    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
     _useGeneratedSdk(): void;
     _delete(): Promise<void>;
     getSettings(): ConnectorConfig;
@@ -113,18 +119,7 @@ export declare interface DataConnectSubscription<Data, Variables> {
     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;
-}
+/* Excluded from this release type: DataConnectTransport */
 
 export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
 
@@ -142,19 +137,6 @@ export declare function executeMutation<Data, Variables>(mutationRef: MutationRe
  */
 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;
-}
-
 /**
  * Initialize DataConnect instance
  * @param options ConnectorConfig
@@ -197,9 +179,6 @@ export declare function mutationRef<Data>(dcInstance: DataConnect, mutationName:
  */
 export declare function mutationRef<Data, Variables>(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef<Data, Variables>;
 
-export declare interface MutationResponse<T> extends CancellableOperation<T> {
-}
-
 /**
  * Mutation Result from `executeMutation`
  */
@@ -284,9 +263,6 @@ export declare function queryRef<Data>(dcInstance: DataConnect, queryName: strin
  */
 export declare function queryRef<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
 
-export declare interface QueryResponse<T> extends CancellableOperation<T> {
-}
-
 /**
  * Result of `executeQuery`
  */
@@ -311,11 +287,6 @@ export declare interface RefInfo<Variables> {
     connectorConfig: DataConnectOptions;
 }
 
-export declare interface Sender<T> {
-    abort: () => void;
-    send: () => Promise<T>;
-}
-
 /**
  * Serialized Ref as a result of `QueryResult.toJSON()`
  */
@@ -377,7 +348,7 @@ declare interface TrackedQuery<Data, Variables> {
     lastError: DataConnectError | null;
 }
 
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
+/* Excluded from this release type: TransportClass */
 
 /**
  * Options to connect to emulator

package/dist/public.d.ts

@@ -4,18 +4,13 @@
  * @packageDocumentation
  */
 import { FirebaseApp } from '@firebase/app';
-import { FirebaseOptions } from '@firebase/app-types';
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
-import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
 import { LogLevelString } from '@firebase/logger';
 import { FirebaseError } from '@firebase/util';
 
-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;
 }> {
@@ -44,8 +39,7 @@ export declare class DataConnect {
     readonly app: FirebaseApp;
     private readonly dataConnectOptions;
     isEmulator: boolean;
-    initialized: boolean;
-    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>);
+    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
     getSettings(): ConnectorConfig;
     setInitialized(): void;
     enableEmulator(transportOptions: TransportOptions): void;
@@ -67,18 +61,7 @@ export declare interface DataConnectSubscription<Data, Variables> {
     errCallback?: (e?: FirebaseError) => 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;
-}
+/* Excluded from this release type: DataConnectTransport */
 export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
 /**
  * Execute Mutation
@@ -92,13 +75,6 @@ export declare function executeMutation<Data, Variables>(mutationRef: MutationRe
  * @returns `QueryPromise`
  */
 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 {
-    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;
-}
 /**
  * Initialize DataConnect instance
  * @param options ConnectorConfig
@@ -133,8 +109,6 @@ export declare function mutationRef<Data>(dcInstance: DataConnect, mutationName:
  * @param variables variables to send with mutation
  */
 export declare function mutationRef<Data, Variables>(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef<Data, Variables>;
-export declare interface MutationResponse<T> extends CancellableOperation<T> {
-}
 /**
  * Mutation Result from `executeMutation`
  */
@@ -192,8 +166,6 @@ export declare function queryRef<Data>(dcInstance: DataConnect, queryName: strin
  * @returns `QueryRef`
  */
 export declare function queryRef<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
-export declare interface QueryResponse<T> extends CancellableOperation<T> {
-}
 /**
  * Result of `executeQuery`
  */
@@ -214,10 +186,6 @@ export declare interface RefInfo<Variables> {
     variables: Variables;
     connectorConfig: DataConnectOptions;
 }
-export declare interface Sender<T> {
-    abort: () => void;
-    send: () => Promise<T>;
-}
 /**
  * Serialized Ref as a result of `QueryResult.toJSON()`
  */
@@ -263,7 +231,7 @@ export declare function terminate(dataConnect: DataConnect): Promise<void>;
  * @returns `QueryRef`
  */
 export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
-export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
+/* Excluded from this release type: TransportClass */
 /**
  * Options to connect to emulator
  */

package/dist/src/api/DataConnect.d.ts

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 import { FirebaseApp } from '@firebase/app';
+import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
 import { QueryManager } from '../core/QueryManager';
@@ -35,7 +36,6 @@ export interface TransportOptions {
     sslEnabled?: boolean;
     port?: number;
 }
-export declare const FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = "FIREBASE_DATA_CONNECT_EMULATOR_HOST";
 /**
  *
  * @param fullHost
@@ -56,16 +56,18 @@ export declare class DataConnect {
     readonly app: FirebaseApp;
     private readonly dataConnectOptions;
     private readonly _authProvider;
+    private readonly _appCheckProvider;
     _queryManager: QueryManager;
     _mutationManager: MutationManager;
     isEmulator: boolean;
-    initialized: boolean;
+    _initialized: boolean;
     private _transport;
     private _transportClass;
     private _transportOptions?;
     private _authTokenProvider?;
     _isUsingGeneratedSdk: boolean;
-    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>);
+    private _appCheckTokenProvider?;
+    constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
     _useGeneratedSdk(): void;
     _delete(): Promise<void>;
     getSettings(): ConnectorConfig;

package/dist/src/core/AppCheckTokenProvider.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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 { AppCheckInternalComponentName, AppCheckTokenListener, AppCheckTokenResult } from '@firebase/app-check-interop-types';
+import { Provider } from '@firebase/component';
+/**
+ * @internal
+ * Abstraction around AppCheck's token fetching capabilities.
+ */
+export declare class AppCheckTokenProvider {
+    private appName_;
+    private appCheckProvider?;
+    private appCheck?;
+    constructor(appName_: string, appCheckProvider?: Provider<AppCheckInternalComponentName>);
+    getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
+    addTokenChangeListener(listener: AppCheckTokenListener): void;
+}

package/dist/src/network/fetch.d.ts

@@ -15,7 +15,7 @@
  * 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, _isUsingGen: boolean): Promise<{
+export declare function dcFetch<T, U>(url: string, body: U, { signal }: AbortController, appId: string | null, accessToken: string | null, appCheckToken: string | null, _isUsingGen: boolean): Promise<{
     data: T;
     errors: Error[];
 }>;

package/dist/src/network/transport/index.d.ts

@@ -15,7 +15,11 @@
  * limitations under the License.
  */
 import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
+import { AppCheckTokenProvider } from '../../core/AppCheckTokenProvider';
 import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
+/**
+ * @internal
+ */
 export interface DataConnectTransport {
     invokeQuery<T, U>(queryName: string, body?: U): PromiseLike<{
         data: T;
@@ -33,13 +37,7 @@ export interface CancellableOperation<T> extends PromiseLike<{
 }> {
     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, _isUsingGen?: boolean) => DataConnectTransport;
-export * from '../../core/FirebaseAuthProvider';
+/**
+ * @internal
+ */
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, appId?: string, authProvider?: AuthTokenProvider, appCheckProvider?: AppCheckTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;

package/dist/src/network/transport/rest.d.ts

@@ -15,11 +15,14 @@
  * limitations under the License.
  */
 import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
+import { AppCheckTokenProvider } from '../../core/AppCheckTokenProvider';
 import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
 import { DataConnectTransport } from '.';
 export declare class RESTTransport implements DataConnectTransport {
     private apiKey?;
+    private appId?;
     private authProvider?;
+    private appCheckProvider?;
     private _isUsingGen;
     private _host;
     private _port;
@@ -29,9 +32,9 @@ export declare class RESTTransport implements DataConnectTransport {
     private _project;
     private _serviceName;
     private _accessToken;
-    private _authInitialized;
+    private _appCheckToken;
     private _lastToken;
-    constructor(options: DataConnectOptions, apiKey?: string | undefined, authProvider?: AuthTokenProvider | undefined, transportOptions?: TransportOptions | undefined, _isUsingGen?: boolean);
+    constructor(options: DataConnectOptions, apiKey?: string | undefined, appId?: string, authProvider?: AuthTokenProvider | undefined, appCheckProvider?: AppCheckTokenProvider | undefined, transportOptions?: TransportOptions | undefined, _isUsingGen?: boolean);
     get endpointUrl(): string;
     useEmulator(host: string, port?: number, isSecure?: boolean): void;
     onTokenChanged(newToken: string | null): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/data-connect",
-  "version": "0.0.3-dataconnect-preview.d986d4bf2",
+  "version": "0.1.0",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -35,7 +35,7 @@
     "dev": "rollup -c -w",
     "test": "run-p --npm-path npm test:emulator",
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:emulator",
-    "test:all": "npm run test:node",
+    "test:all": "run-p --npm-path npm lint test:unit",
     "test:browser": "karma start --single-run",
     "test:node": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js",
     "test:unit": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/unit/**/*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js",
@@ -47,17 +47,17 @@
   },
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@firebase/app": "0.10.7-dataconnect-preview.d986d4bf2"
+    "@firebase/app": "0.x"
   },
   "dependencies": {
-    "@firebase/auth-interop-types": "0.2.3-dataconnect-preview.d986d4bf2",
-    "@firebase/component": "0.6.8-dataconnect-preview.d986d4bf2",
-    "@firebase/logger": "0.4.2-dataconnect-preview.d986d4bf2",
-    "@firebase/util": "1.9.7-dataconnect-preview.d986d4bf2",
+    "@firebase/auth-interop-types": "0.2.3",
+    "@firebase/component": "0.6.9",
+    "@firebase/logger": "0.4.2",
+    "@firebase/util": "1.10.0",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.10.7-dataconnect-preview.d986d4bf2",
+    "@firebase/app": "0.10.12",
     "rollup": "2.79.1",
     "rollup-plugin-typescript2": "0.31.2",
     "typescript": "4.7.4"