@firebase/data-connect 0.3.12 → 0.4.0-canary.78384d32c

package/dist/src/cache/cacheUtils.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2026 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 { OpResult } from '../api/Reference';
+import { DataConnectExtension } from '../network';
+export declare function parseEntityIds<T>(result: OpResult<T>): Record<string, unknown>;
+export declare function populatePath(path: Array<string | number>, toUpdate: Record<string | number, unknown>, extension: DataConnectExtension): void;

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

@@ -15,11 +15,12 @@
  * limitations under the License.
  */
 import { FirebaseOptions } from '@firebase/app-types';
-import { FirebaseAuthInternalName, FirebaseAuthTokenData } from '@firebase/auth-interop-types';
+import { FirebaseAuthInternal, FirebaseAuthInternalName, FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
 export interface AuthTokenProvider {
     getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null>;
     addTokenChangeListener(listener: AuthTokenListener): void;
+    getAuth(): FirebaseAuthInternal;
 }
 export type AuthTokenListener = (token: string | null) => void;
 export declare class FirebaseAuthProvider implements AuthTokenProvider {
@@ -28,6 +29,7 @@ export declare class FirebaseAuthProvider implements AuthTokenProvider {
     private _authProvider;
     private _auth;
     constructor(_appName: string, _options: FirebaseOptions, _authProvider: Provider<FirebaseAuthInternalName>);
+    getAuth(): FirebaseAuthInternal;
     getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null>;
     addTokenChangeListener(listener: AuthTokenListener): void;
     removeTokenChangeListener(listener: (token: string | null) => void): void;

package/dist/src/core/query/QueryManager.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @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 { type DataConnect } from '../../api/DataConnect';
+import { QueryRef, QueryResult } from '../../api/query';
+import { SerializedRef, DataSource } from '../../api/Reference';
+import { DataConnectCache } from '../../cache/Cache';
+import { DataConnectTransport } from '../../network';
+import { DataConnectExtensionWithMaxAge } from '../../network/transport';
+import { OnCompleteSubscription, OnErrorSubscription, OnResultSubscription } from './subscribe';
+export declare function getRefSerializer<Data, Variables>(queryRef: QueryRef<Data, Variables>, data: Data, source: DataSource, fetchTime: string): () => SerializedRef<Data, Variables>;
+export declare class QueryManager {
+    private transport;
+    private dc;
+    private cache?;
+    preferCacheResults<Data, Variables>(queryRef: QueryRef<Data, Variables>, allowStale?: boolean): Promise<QueryResult<Data, Variables>>;
+    private callbacks;
+    private subscriptionCache;
+    constructor(transport: DataConnectTransport, dc: DataConnect, cache?: DataConnectCache | undefined);
+    private queue;
+    waitForQueuedWrites(): Promise<void>;
+    updateSSR<Data, Variables>(updatedData: QueryResult<Data, Variables>): void;
+    updateCache<Data, Variables>(result: QueryResult<Data, Variables>, extensions?: DataConnectExtensionWithMaxAge[]): Promise<string[]>;
+    addSubscription<Data, Variables>(queryRef: QueryRef<Data, Variables>, onResultCallback: OnResultSubscription<Data, Variables>, onCompleteCallback?: OnCompleteSubscription, onErrorCallback?: OnErrorSubscription, initialCache?: QueryResult<Data, Variables>): () => void;
+    fetchServerResults<Data, Variables>(queryRef: QueryRef<Data, Variables>): Promise<QueryResult<Data, Variables>>;
+    fetchCacheResults<Data, Variables>(queryRef: QueryRef<Data, Variables>, allowStale?: boolean): Promise<QueryResult<Data, Variables>>;
+    publishErrorToSubscribers(key: string, err: unknown): void;
+    getFromResultTreeCache<Data, Variables>(queryRef: QueryRef<Data, Variables>, allowStale?: boolean): Promise<QueryResult<Data, Variables> | null>;
+    getFromSubscriberCache<Data, Variables>(queryRef: QueryRef<Data, Variables>): Promise<QueryResult<Data, Variables> | undefined>;
+    publishDataToSubscribers(key: string, queryResult: QueryResult<unknown, unknown>): void;
+    publishCacheResultsToSubscribers(impactedQueries: string[], fetchTime: string): Promise<void>;
+    enableEmulator(host: string, port: number): void;
+}
+export declare function getMaxAgeFromExtensions(extensions: DataConnectExtensionWithMaxAge[] | undefined): number | undefined;

package/dist/src/core/query/queryOptions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2025 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 QueryFetchPolicy: {
+    readonly PREFER_CACHE: "PREFER_CACHE";
+    readonly CACHE_ONLY: "CACHE_ONLY";
+    readonly SERVER_ONLY: "SERVER_ONLY";
+};
+export type QueryFetchPolicy = (typeof QueryFetchPolicy)[keyof typeof QueryFetchPolicy];
+export interface ExecuteQueryOptions {
+    fetchPolicy: QueryFetchPolicy;
+}

package/dist/src/core/query/subscribe.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @license
+ * Copyright 2025 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 { QueryRef, QueryResult } from '../../api/query';
+import { SerializedRef } from '../../api/Reference';
+import { DataConnectError } from '../error';
+/**
+ * `OnCompleteSubscription`
+ */
+export type OnCompleteSubscription = () => void;
+/**
+ * Representation of full observer options in `subscribe`
+ */
+export interface SubscriptionOptions<Data, Variables> {
+    onNext?: OnResultSubscription<Data, Variables>;
+    onErr?: OnErrorSubscription;
+    onComplete?: OnCompleteSubscription;
+}
+/**
+ * Signature for `OnResultSubscription` for `subscribe`
+ */
+export type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
+/**
+ * Signature for `OnErrorSubscription` for `subscribe`
+ */
+export type OnErrorSubscription = (err?: DataConnectError) => void;
+/**
+ * Signature for unsubscribe from `subscribe`
+ */
+export type QueryUnsubscribe = () => void;
+/**
+ * Representation of user provided subscription options.
+ */
+export interface DataConnectSubscription<Data, Variables> {
+    userCallback: OnResultSubscription<Data, Variables>;
+    errCallback?: (e?: DataConnectError) => void;
+    unsubscribe: () => void;
+}
+/**
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param observer observer object to use for subscribing.
+ * @returns `SubscriptionOptions`
+ */
+export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, observer: SubscriptionOptions<Data, Variables>): QueryUnsubscribe;
+/**
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param onNext Callback to call when result comes back.
+ * @param onError Callback to call when error gets thrown.
+ * @param onComplete Called when subscription completes.
+ * @returns `SubscriptionOptions`
+ */
+export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, onNext: OnResultSubscription<Data, Variables>, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe;

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

@@ -14,14 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { CallerSdkType } from './transport';
+import { CallerSdkType, DataConnectResponse } from './transport';
 export declare function initializeFetch(fetchImpl: typeof fetch): void;
 export interface DataConnectFetchBody<T> {
     name: string;
     operationName: string;
     variables: T;
 }
-export declare function dcFetch<T, U>(url: string, body: DataConnectFetchBody<U>, { signal }: AbortController, appId: string | null | undefined, accessToken: string | null, appCheckToken: string | null | undefined, _isUsingGen: boolean, _callerSdkType: CallerSdkType, _isUsingEmulator: boolean): Promise<{
-    data: T;
-    errors: Error[];
-}>;
+export declare function dcFetch<T, U>(url: string, body: DataConnectFetchBody<U>, { signal }: AbortController, appId: string | null | undefined, accessToken: string | null, appCheckToken: string | null | undefined, _isUsingGen: boolean, _callerSdkType: CallerSdkType, _isUsingEmulator: boolean): Promise<DataConnectResponse<T>>;

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

@@ -14,4 +14,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './transport';
+export { CallerSdkType, CallerSdkTypeEnum, DataConnectTransport, DataConnectEntityArray, DataConnectSingleEntity, DataConnectExtension, Extensions, TransportClass } from './transport';

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

@@ -30,18 +30,47 @@ export declare const CallerSdkTypeEnum: {
     readonly TanstackAngularCore: "TanstackAngularCore";
     readonly GeneratedAngular: "GeneratedAngular";
 };
+export interface DataConnectEntityArray {
+    entityIds: string[];
+}
+export interface DataConnectSingleEntity {
+    entityId: string;
+}
+export type DataConnectExtension = {
+    path: Array<string | number>;
+} & (DataConnectEntityArray | DataConnectSingleEntity);
+/** @internal */
+export interface DataConnectMaxAge {
+    maxAge: string;
+}
+/** @internal */
+export type DataConnectExtensionWithMaxAge = {
+    path: Array<string | number>;
+} & (DataConnectEntityArray | DataConnectSingleEntity | DataConnectMaxAge);
+export interface Extensions {
+    dataConnect?: DataConnectExtension[];
+}
+/** @internal */
+export interface ExtensionsWithMaxAge {
+    dataConnect?: DataConnectExtensionWithMaxAge[];
+}
+export interface DataConnectResponse<T> {
+    data: T;
+    errors: Error[];
+    extensions: Extensions;
+}
+/** @internal */
+export interface DataConnectResponseWithMaxAge<T> {
+    data: T;
+    errors: Error[];
+    extensions: ExtensionsWithMaxAge;
+}
 /**
  * @internal
  */
 export interface DataConnectTransport {
-    invokeQuery<T, U>(queryName: string, body?: U): Promise<{
-        data: T;
-        errors: Error[];
-    }>;
-    invokeMutation<T, U>(queryName: string, body?: U): Promise<{
-        data: T;
-        errors: Error[];
-    }>;
+    invokeQuery<T, U>(queryName: string, body?: U): Promise<DataConnectResponseWithMaxAge<T>>;
+    invokeMutation<T, U>(queryName: string, body?: U): Promise<DataConnectResponse<T>>;
     useEmulator(host: string, port?: number, sslEnabled?: boolean): void;
     onTokenChanged: (token: string | null) => void;
     _setCallerSdkType(callerSdkType: CallerSdkType): void;

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

@@ -17,7 +17,7 @@
 import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
 import { AppCheckTokenProvider } from '../../core/AppCheckTokenProvider';
 import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
-import { CallerSdkType, DataConnectTransport } from '.';
+import { CallerSdkType, DataConnectResponse, DataConnectTransport } from '.';
 export declare class RESTTransport implements DataConnectTransport {
     private apiKey?;
     private appId?;
@@ -36,26 +36,14 @@ export declare class RESTTransport implements DataConnectTransport {
     private _appCheckToken;
     private _lastToken;
     private _isUsingEmulator;
-    constructor(options: DataConnectOptions, apiKey?: string | undefined, appId?: string | undefined, authProvider?: AuthTokenProvider | undefined, appCheckProvider?: AppCheckTokenProvider | undefined, transportOptions?: TransportOptions | undefined, _isUsingGen?: boolean, _callerSdkType?: CallerSdkType);
+    constructor(options: DataConnectOptions, apiKey?: string | undefined, appId?: (string | null) | undefined, authProvider?: AuthTokenProvider | undefined, appCheckProvider?: AppCheckTokenProvider | undefined, transportOptions?: TransportOptions | undefined, _isUsingGen?: boolean, _callerSdkType?: CallerSdkType);
     get endpointUrl(): string;
     useEmulator(host: string, port?: number, isSecure?: boolean): void;
     onTokenChanged(newToken: string | null): void;
     getWithAuth(forceToken?: boolean): Promise<string | null>;
     _setLastToken(lastToken: string | null): void;
-    withRetry<T>(promiseFactory: () => Promise<{
-        data: T;
-        errors: Error[];
-    }>, retry?: boolean): Promise<{
-        data: T;
-        errors: Error[];
-    }>;
-    invokeQuery: <T, U>(queryName: string, body?: U) => Promise<{
-        data: T;
-        errors: Error[];
-    }>;
-    invokeMutation: <T, U>(queryName: string, body?: U) => Promise<{
-        data: T;
-        errors: Error[];
-    }>;
+    withRetry<T>(promiseFactory: () => Promise<DataConnectResponse<T>>, retry?: boolean): Promise<DataConnectResponse<T>>;
+    invokeQuery: <T, U>(queryName: string, body?: U) => Promise<DataConnectResponse<T>>;
+    invokeMutation: <T, U>(queryName: string, body?: U) => Promise<DataConnectResponse<T>>;
     _setCallerSdkType(callerSdkType: CallerSdkType): void;
 }

package/dist/src/util/encoder.d.ts

@@ -14,6 +14,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export type HmacImpl = (obj: unknown) => string;
+export type HmacImpl = (obj: Record<string, unknown>) => string;
 export declare let encoderImpl: HmacImpl;
+export type DecodeHmacImpl = (s: string) => Record<string, unknown>;
+export declare let decoderImpl: DecodeHmacImpl;
 export declare function setEncoder(encoder: HmacImpl): void;
+export declare function setDecoder(decoder: DecodeHmacImpl): void;

package/dist/src/util/url.d.ts

@@ -15,5 +15,6 @@
  * limitations under the License.
  */
 import { DataConnectOptions, TransportOptions } from '../api/DataConnect';
+export declare const PROD_HOST = "firebasedataconnect.googleapis.com";
 export declare function urlBuilder(projectConfig: DataConnectOptions, transportOptions: TransportOptions): string;
 export declare function addToken(url: string, apiKey?: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/data-connect",
-  "version": "0.3.12",
+  "version": "0.4.0-canary.78384d32c",
   "description": "",
   "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
   "main": "dist/index.node.cjs.js",
@@ -45,17 +45,17 @@
   },
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@firebase/app": "0.x"
+    "@firebase/app": "0.14.9-canary.78384d32c"
   },
   "dependencies": {
-    "@firebase/auth-interop-types": "0.2.4",
-    "@firebase/component": "0.7.0",
-    "@firebase/logger": "0.5.0",
-    "@firebase/util": "1.13.0",
+    "@firebase/auth-interop-types": "0.2.4-canary.78384d32c",
+    "@firebase/component": "0.7.1-canary.78384d32c",
+    "@firebase/logger": "0.5.0-canary.78384d32c",
+    "@firebase/util": "1.14.0-canary.78384d32c",
     "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@firebase/app": "0.14.6",
+    "@firebase/app": "0.14.9-canary.78384d32c",
     "rollup": "2.79.2",
     "rollup-plugin-typescript2": "0.36.0",
     "typescript": "5.5.4"

package/dist/node-esm/src/core/QueryManager.d.ts

@@ -1,45 +0,0 @@
-/**
- * @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 { OnCompleteSubscription, OnErrorSubscription, OnResultSubscription, QueryPromise, QueryRef } from '../api/query';
-import { OperationRef, OpResult } from '../api/Reference';
-import { DataConnectTransport } from '../network';
-import { DataConnectError } from './error';
-/**
- * Representation of user provided subscription options.
- */
-interface DataConnectSubscription<Data, Variables> {
-    userCallback: OnResultSubscription<Data, Variables>;
-    errCallback?: (e?: DataConnectError) => void;
-    onCompleteCallback?: () => void;
-    unsubscribe: () => void;
-}
-interface TrackedQuery<Data, Variables> {
-    ref: Omit<OperationRef<Data, Variables>, 'dataConnect'>;
-    subscriptions: Array<DataConnectSubscription<Data, Variables>>;
-    currentCache: OpResult<Data> | null;
-    lastError: DataConnectError | null;
-}
-export declare class QueryManager {
-    private transport;
-    _queries: Map<string, TrackedQuery<unknown, unknown>>;
-    constructor(transport: DataConnectTransport);
-    track<Data, Variables>(queryName: string, variables: Variables, initialCache?: OpResult<Data>): TrackedQuery<Data, Variables>;
-    addSubscription<Data, Variables>(queryRef: OperationRef<Data, Variables>, onResultCallback: OnResultSubscription<Data, Variables>, onCompleteCallback?: OnCompleteSubscription, onErrorCallback?: OnErrorSubscription, initialCache?: OpResult<Data>): () => void;
-    executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
-    enableEmulator(host: string, port: number): void;
-}
-export {};

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

@@ -1,45 +0,0 @@
-/**
- * @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 { OnCompleteSubscription, OnErrorSubscription, OnResultSubscription, QueryPromise, QueryRef } from '../api/query';
-import { OperationRef, OpResult } from '../api/Reference';
-import { DataConnectTransport } from '../network';
-import { DataConnectError } from './error';
-/**
- * Representation of user provided subscription options.
- */
-interface DataConnectSubscription<Data, Variables> {
-    userCallback: OnResultSubscription<Data, Variables>;
-    errCallback?: (e?: DataConnectError) => void;
-    onCompleteCallback?: () => void;
-    unsubscribe: () => void;
-}
-interface TrackedQuery<Data, Variables> {
-    ref: Omit<OperationRef<Data, Variables>, 'dataConnect'>;
-    subscriptions: Array<DataConnectSubscription<Data, Variables>>;
-    currentCache: OpResult<Data> | null;
-    lastError: DataConnectError | null;
-}
-export declare class QueryManager {
-    private transport;
-    _queries: Map<string, TrackedQuery<unknown, unknown>>;
-    constructor(transport: DataConnectTransport);
-    track<Data, Variables>(queryName: string, variables: Variables, initialCache?: OpResult<Data>): TrackedQuery<Data, Variables>;
-    addSubscription<Data, Variables>(queryRef: OperationRef<Data, Variables>, onResultCallback: OnResultSubscription<Data, Variables>, onCompleteCallback?: OnCompleteSubscription, onErrorCallback?: OnErrorSubscription, initialCache?: OpResult<Data>): () => void;
-    executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
-    enableEmulator(host: string, port: number): void;
-}
-export {};