feat(data-connect): Caching for FDC (#9439)

Author: maneesht

.changeset/fast-cherries-fold.md

@@ -0,0 +1,7 @@
+---
+"@firebase/data-connect": minor
+"@firebase/util": minor
+"firebase": minor
+---
+
+Add Memory-Based caching to Queries in Firebase Data Connect.

common/api-review/data-connect.api.md

@@ -11,6 +11,20 @@ import { FirebaseError } from '@firebase/util';
 import { LogLevelString } from '@firebase/logger';
 import { Provider } from '@firebase/component';
 
+// @public (undocumented)
+export interface CacheProvider<T extends StorageType> {
+    // (undocumented)
+    type: T;
+}
+
+// @public (undocumented)
+export interface CacheSettings {
+    // (undocumented)
+    cacheProvider: CacheProvider<StorageType>;
+    // (undocumented)
+    maxAgeSeconds?: number;
+}
+
 // @public
 export type CallerSdkType = 'Base' | 'Generated' | 'TanstackReactCore' | 'GeneratedReact' | 'TanstackAngularCore' | 'GeneratedAngular';
 
@@ -66,6 +80,12 @@ export class DataConnect {
     setInitialized(): void;
 }
 
+// @public (undocumented)
+export interface DataConnectEntityArray {
+    // (undocumented)
+    entityIds: string[];
+}
+
 // @public
 export class DataConnectError extends FirebaseError {
     /* Excluded from this release type: name */
@@ -75,6 +95,11 @@ export class DataConnectError extends FirebaseError {
 // @public (undocumented)
 export type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized';
 
+// @public (undocumented)
+export type DataConnectExtension = {
+    path: Array<string | number>;
+} & (DataConnectEntityArray | DataConnectSingleEntity);
+
 // @public
 export class DataConnectOperationError extends DataConnectError {
     /* Excluded from this release type: name */
@@ -109,20 +134,63 @@ export interface DataConnectResult<Data, Variables> extends OpResult<Data> {
     ref: OperationRef<Data, Variables>;
 }
 
+// @public (undocumented)
+export interface DataConnectSettings {
+    // (undocumented)
+    cacheSettings?: CacheSettings;
+}
+
+// @public (undocumented)
+export interface DataConnectSingleEntity {
+    // (undocumented)
+    entityId: string;
+}
+
+// @public
+export interface DataConnectSubscription<Data, Variables> {
+    // (undocumented)
+    errCallback?: (e?: DataConnectError) => void;
+    // (undocumented)
+    unsubscribe: () => void;
+    // (undocumented)
+    userCallback: OnResultSubscription<Data, Variables>;
+}
+
 // @public (undocumented)
 export type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
 
 // @public
 export function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
 
 // @public
-export function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+export function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>, options?: ExecuteQueryOptions): QueryPromise<Data, Variables>;
+
+// @public (undocumented)
+export interface ExecuteQueryOptions {
+    // (undocumented)
+    fetchPolicy: QueryFetchPolicy;
+}
+
+// @public (undocumented)
+export interface Extensions {
+    // (undocumented)
+    dataConnect?: DataConnectExtension[];
+}
 
 // @public
+export function getDataConnect(options: ConnectorConfig, settings?: DataConnectSettings): DataConnect;
+
+// @public (undocumented)
 export function getDataConnect(options: ConnectorConfig): DataConnect;
 
 // @public
-export function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+export function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig): DataConnect;
+
+// @public
+export function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig, settings: DataConnectSettings): DataConnect;
+
+// @public (undocumented)
+export function makeMemoryCacheProvider(): CacheProvider<'MEMORY'>;
 
 // @public (undocumented)
 export const MUTATION_STR = "mutation";
@@ -175,6 +243,8 @@ export interface OpResult<Data> {
     // (undocumented)
     data: Data;
     // (undocumented)
+    extensions?: Extensions;
+    // (undocumented)
     fetchTime: string;
     // (undocumented)
     source: DataSource;
@@ -183,6 +253,16 @@ export interface OpResult<Data> {
 // @public (undocumented)
 export const QUERY_STR = "query";
 
+// @public
+export const QueryFetchPolicy: {
+    readonly PREFER_CACHE: "PREFER_CACHE";
+    readonly CACHE_ONLY: "CACHE_ONLY";
+    readonly SERVER_ONLY: "SERVER_ONLY";
+};
+
+// @public (undocumented)
+export type QueryFetchPolicy = (typeof QueryFetchPolicy)[keyof typeof QueryFetchPolicy];
+
 // @public
 export interface QueryPromise<Data, Variables> extends Promise<QueryResult<Data, Variables>> {
 }
@@ -238,6 +318,14 @@ export const SOURCE_CACHE = "CACHE";
 // @public (undocumented)
 export const SOURCE_SERVER = "SERVER";
 
+// @public (undocumented)
+export const StorageType: {
+    readonly MEMORY: "MEMORY";
+};
+
+// @public (undocumented)
+export type StorageType = (typeof StorageType)[keyof typeof StorageType];
+
 // @public
 export function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, observer: SubscriptionOptions<Data, Variables>): QueryUnsubscribe;
 

common/api-review/util.api.md

@@ -221,6 +221,9 @@ export class FirebaseError extends Error {
 // @public
 export type FirebaseSignInProvider = 'custom' | 'email' | 'password' | 'phone' | 'anonymous' | 'google.com' | 'facebook.com' | 'github.com' | 'twitter.com' | 'microsoft.com' | 'apple.com';
 
+// @public
+export function generateSHA256Hash(input: string): Promise<string>;
+
 // @public
 export const getDefaultAppConfig: () => Record<string, string> | undefined;
 

e2e/data-connect/dataconnect-generated/js/default-connector/.guides/config.json

@@ -0,0 +1,9 @@
+{
+  "description": "A set of guides for interacting with the generated firebase dataconnect sdk",
+  "mcpServers": {
+    "firebase": {
+      "command": "npx",
+      "args": ["-y", "firebase-tools@latest", "experimental:mcp"]
+    }
+  }
+}

e2e/data-connect/dataconnect-generated/js/default-connector/.guides/setup.md

@@ -0,0 +1,20 @@
+# Setup
+
+If the user hasn't already installed the SDK, always run the user's node package manager of choice, and install the package in the directory ../package.json.
+For more information on where the library is located, look at the connector.yaml file.
+
+```ts
+import { initializeApp } from 'firebase/app';
+
+initializeApp({
+  // fill in your project config here using the values from your Firebase project or from the `firebase_get_sdk_config` tool from the Firebase MCP server.
+});
+```
+
+Then, you can run the SDK as needed.
+```ts
+import { ... } from '@firebasegen/default-connector';
+```
+
+
+

e2e/data-connect/dataconnect-generated/js/default-connector/.guides/usage.md

@@ -0,0 +1,27 @@
+# Basic Usage
+
+Always prioritize using a supported framework over using the generated SDK
+directly. Supported frameworks simplify the developer experience and help ensure
+best practices are followed.
+
+
+
+
+
+## Advanced Usage
+If a user is not using a supported framework, they can use the generated SDK directly.
+
+Here's an example of how to use it with the first 5 operations:
+
+```js
+import { createMovie, listMovies } from '@firebasegen/default-connector';
+
+
+// Operation CreateMovie:  For variables, look at type CreateMovieVars in ../index.d.ts
+const { data } = await CreateMovie(dataConnect, createMovieVars);
+
+// Operation ListMovies: 
+const { data } = await ListMovies(dataConnect);
+
+
+```