@firebase/data-connect 0.3.12 → 0.4.0-canary.22476e1bc

package/dist/public.d.ts

@@ -11,6 +11,13 @@ import { LogLevelString } from '@firebase/logger';
 import { FirebaseError } from '@firebase/util';
 
 
+export declare interface CacheProvider<T extends StorageType> {
+    type: T;
+}
+export declare interface CacheSettings {
+    cacheProvider: CacheProvider<StorageType>;
+    maxAgeSeconds?: number;
+}
 /**
  * enum representing different flavors of the SDK used by developers
  * use the CallerSdkType for type-checking, and the CallerSdkTypeEnum for value-checking/assigning
@@ -57,17 +64,27 @@ export declare class DataConnect {
     readonly app: FirebaseApp;
     private readonly dataConnectOptions;
     isEmulator: boolean;
+    /* Excluded from this release type: cache */
     constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
     getSettings(): ConnectorConfig;
+    /* Excluded from this release type: setCacheSettings */
     setInitialized(): void;
     enableEmulator(transportOptions: TransportOptions): void;
 }
+export declare interface DataConnectEntityArray {
+    entityIds: string[];
+}
 /** An error returned by a DataConnect operation. */
 export declare class DataConnectError extends FirebaseError {
     /* Excluded from this release type: name */
     constructor(code: Code, message: string);
 }
 export declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized';
+export declare type DataConnectExtension = {
+    path: Array<string | number>;
+} & (DataConnectEntityArray | DataConnectSingleEntity);
+/* Excluded from this release type: DataConnectExtensionWithMaxAge */
+/* Excluded from this release type: DataConnectMaxAge */
 /** An error returned by a DataConnect operation. */
 export declare class DataConnectOperationError extends DataConnectError {
     /* Excluded from this release type: name */
@@ -89,9 +106,24 @@ export declare interface DataConnectOperationFailureResponseErrorInfo {
 export declare interface DataConnectOptions extends ConnectorConfig {
     projectId: string;
 }
+/* Excluded from this release type: DataConnectResponseWithMaxAge */
 export declare interface DataConnectResult<Data, Variables> extends OpResult<Data> {
     ref: OperationRef<Data, Variables>;
 }
+export declare interface DataConnectSettings {
+    cacheSettings?: CacheSettings;
+}
+export declare interface DataConnectSingleEntity {
+    entityId: string;
+}
+/**
+ * Representation of user provided subscription options.
+ */
+export declare interface DataConnectSubscription<Data, Variables> {
+    userCallback: OnResultSubscription<Data, Variables>;
+    errCallback?: (e?: DataConnectError) => void;
+    unsubscribe: () => void;
+}
 /* Excluded from this release type: DataConnectTransport */
 export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
 /**
@@ -105,18 +137,33 @@ export declare function executeMutation<Data, Variables>(mutationRef: MutationRe
  * @param queryRef query to execute.
  * @returns `QueryPromise`
  */
-export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>, options?: ExecuteQueryOptions): QueryPromise<Data, Variables>;
+export declare interface ExecuteQueryOptions {
+    fetchPolicy: QueryFetchPolicy;
+}
+export declare interface Extensions {
+    dataConnect?: DataConnectExtension[];
+}
 /**
  * Initialize DataConnect instance
  * @param options ConnectorConfig
  */
+export declare function getDataConnect(options: ConnectorConfig, settings?: DataConnectSettings): DataConnect;
 export declare function getDataConnect(options: ConnectorConfig): DataConnect;
 /**
  * Initialize DataConnect instance
  * @param app FirebaseApp to initialize to.
- * @param options ConnectorConfig
+ * @param connectorConfig ConnectorConfig
  */
-export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+export declare function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig): DataConnect;
+/**
+ * Initialize DataConnect instance
+ * @param app FirebaseApp to initialize to.
+ * @param connectorConfig ConnectorConfig
+ */
+export declare function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig, settings: DataConnectSettings): DataConnect;
+/* Excluded from this release type: InternalQueryResult */
+export declare function makeMemoryCacheProvider(): CacheProvider<'MEMORY'>;
 export declare const MUTATION_STR = "mutation";
 /* Excluded from this release type: MutationManager */
 /**
@@ -168,9 +215,32 @@ export declare interface OpResult<Data> {
     data: Data;
     source: DataSource;
     fetchTime: string;
+    extensions?: Extensions;
 }
 /* Excluded from this release type: parseOptions */
 export declare const QUERY_STR = "query";
+/**
+ * @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 declare type QueryFetchPolicy = (typeof QueryFetchPolicy)[keyof typeof QueryFetchPolicy];
 /**
  * Promise returned from `executeQuery`
  */
@@ -226,6 +296,10 @@ export declare interface SerializedRef<Data, Variables> extends OpResult<Data> {
 export declare function setLogLevel(logLevel: LogLevelString): void;
 export declare const SOURCE_CACHE = "CACHE";
 export declare const SOURCE_SERVER = "SERVER";
+export declare const StorageType: {
+    readonly MEMORY: "MEMORY";
+};
+export declare type StorageType = (typeof StorageType)[keyof typeof StorageType];
 /**
  * Subscribe to a `QueryRef`
  * @param queryRefOrSerializedResult query ref or serialized result.

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

@@ -18,7 +18,9 @@ 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';
+import { DataConnectCache } from '../cache/Cache';
+import { InternalCacheProvider } from '../cache/CacheProvider';
+import { QueryManager } from '../core/query/QueryManager';
 import { CallerSdkType } from '../network';
 import { MutationManager } from './Mutation';
 /**
@@ -69,11 +71,24 @@ export declare class DataConnect {
     _isUsingGeneratedSdk: boolean;
     _callerSdkType: CallerSdkType;
     private _appCheckTokenProvider?;
+    private _cacheSettings?;
+    /**
+     * @internal
+     */
+    private cache?;
     constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
+    /**
+     * @internal
+     */
+    getCache(): DataConnectCache | undefined;
     _useGeneratedSdk(): void;
     _setCallerSdkType(callerSdkType: CallerSdkType): void;
     _delete(): Promise<void>;
     getSettings(): ConnectorConfig;
+    /**
+     * @internal
+     */
+    setCacheSettings(cacheSettings: CacheSettings): void;
     setInitialized(): void;
     enableEmulator(transportOptions: TransportOptions): void;
 }
@@ -92,17 +107,27 @@ export declare function areTransportOptionsEqual(transportOptions1: TransportOpt
  * @param sslEnabled use https
  */
 export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
+export interface DataConnectSettings {
+    cacheSettings?: CacheSettings;
+}
 /**
  * Initialize DataConnect instance
  * @param options ConnectorConfig
  */
+export declare function getDataConnect(options: ConnectorConfig, settings?: DataConnectSettings): DataConnect;
 export declare function getDataConnect(options: ConnectorConfig): DataConnect;
 /**
  * Initialize DataConnect instance
  * @param app FirebaseApp to initialize to.
- * @param options ConnectorConfig
+ * @param connectorConfig ConnectorConfig
+ */
+export declare function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig): DataConnect;
+/**
+ * Initialize DataConnect instance
+ * @param app FirebaseApp to initialize to.
+ * @param connectorConfig ConnectorConfig
  */
-export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+export declare function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig, settings: DataConnectSettings): DataConnect;
 /**
  *
  * @param dcOptions
@@ -116,3 +141,19 @@ export declare function validateDCOptions(dcOptions: ConnectorConfig): boolean;
  * @returns
  */
 export declare function terminate(dataConnect: DataConnect): Promise<void>;
+export declare const StorageType: {
+    readonly MEMORY: "MEMORY";
+};
+export type StorageType = (typeof StorageType)[keyof typeof StorageType];
+export interface CacheSettings {
+    cacheProvider: CacheProvider<StorageType>;
+    maxAgeSeconds?: number;
+}
+export interface CacheProvider<T extends StorageType> {
+    type: T;
+    /**
+     * @internal
+     */
+    initialize(cacheId: string): InternalCacheProvider;
+}
+export declare function makeMemoryCacheProvider(): CacheProvider<'MEMORY'>;

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

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Extensions } from '../network';
 import { DataConnect, DataConnectOptions } from './DataConnect';
 export declare const QUERY_STR = "query";
 export declare const MUTATION_STR = "mutation";
@@ -25,6 +26,7 @@ export interface OpResult<Data> {
     data: Data;
     source: DataSource;
     fetchTime: string;
+    extensions?: Extensions;
 }
 export interface OperationRef<_Data, Variables> {
     name: string;

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

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 export * from '../network';
-export * from './DataConnect';
+export { ExecuteQueryOptions, QueryFetchPolicy } from '../core/query/queryOptions';
+export { CacheSettings, validateDCOptions, ConnectorConfig, DataConnect, DataConnectOptions, DataConnectSettings, StorageType, TransportOptions, areTransportOptionsEqual, connectDataConnectEmulator, getDataConnect, parseOptions, terminate } from './DataConnect';
 export * from './Reference';
 export * from './Mutation';
 export * from './query';

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

@@ -14,27 +14,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { DataConnectError } from '../core/error';
+import { ExecuteQueryOptions } from '../core/query/queryOptions';
+import { DataConnectExtensionWithMaxAge } from '../network/transport';
 import { DataConnect } from './DataConnect';
 import { OperationRef, QUERY_STR, DataConnectResult, SerializedRef } from './Reference';
-/**
- * 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;
 /**
  * QueryRef object
  */
 export interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
     refType: typeof QUERY_STR;
 }
+/** @internal */
+export type InternalQueryResult<Data, Variables> = QueryResult<Data, Variables> & Omit<DataConnectResult<Data, Variables>, 'extensions'> & {
+    extensions?: {
+        dataConnect?: DataConnectExtensionWithMaxAge[];
+    };
+};
 /**
  * Result of `executeQuery`
  */
@@ -52,7 +47,7 @@ export interface QueryPromise<Data, Variables> extends Promise<QueryResult<Data,
  * @param queryRef query to execute.
  * @returns `QueryPromise`
  */
-export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>, options?: ExecuteQueryOptions): QueryPromise<Data, Variables>;
 /**
  * Execute Query
  * @param dcInstance Data Connect instance to use.
@@ -74,15 +69,3 @@ export declare function queryRef<Data, Variables>(dcInstance: DataConnect, query
  * @returns `QueryRef`
  */
 export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<Data, Variables>;
-/**
- * `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;
-}

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

@@ -14,21 +14,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { OnCompleteSubscription, OnErrorSubscription, OnResultSubscription, QueryRef, QueryUnsubscribe, SubscriptionOptions } from './api/query';
-import { SerializedRef } from './api/Reference';
-/**
- * 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;
+export * from './core/query/subscribe';
+export { makeMemoryCacheProvider, CacheProvider } from './api/DataConnect';

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

@@ -14,4 +14,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { subscribe } from './api.browser';
+export * from './core/query/subscribe';
+export { makeMemoryCacheProvider, CacheProvider } from './api/DataConnect';

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

@@ -0,0 +1,53 @@
+/**
+ * @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 { CacheProvider, CacheSettings, type ConnectorConfig } from '../api/DataConnect';
+import { type AuthTokenProvider } from '../core/FirebaseAuthProvider';
+import { InternalCacheProvider } from './CacheProvider';
+import { InMemoryCacheProvider } from './InMemoryCacheProvider';
+import { ResultTree } from './ResultTree';
+export declare const Memory = "memory";
+export type DataConnectStorage = typeof Memory;
+/**
+ * ServerValues
+ */
+export interface ServerValues extends Record<string, unknown> {
+    maxAge?: number;
+}
+export declare class DataConnectCache {
+    private authProvider;
+    private projectId;
+    private connectorConfig;
+    private host;
+    cacheSettings: CacheSettings;
+    private cacheProvider;
+    private uid;
+    constructor(authProvider: AuthTokenProvider, projectId: string, connectorConfig: ConnectorConfig, host: string, cacheSettings: CacheSettings);
+    initialize(): Promise<void>;
+    getIdentifier(uid: string | null): Promise<string>;
+    initializeNewProviders(identifier: string): InternalCacheProvider;
+    containsResultTree(queryId: string): Promise<boolean>;
+    getResultTree(queryId: string): Promise<ResultTree | undefined>;
+    getResultJSON(queryId: string): Promise<Record<string, unknown>>;
+    update(queryId: string, serverValues: ServerValues, entityIds: Record<string, unknown>): Promise<string[]>;
+}
+export declare class MemoryStub implements CacheProvider<'MEMORY'> {
+    type: 'MEMORY';
+    /**
+     * @internal
+     */
+    initialize(cacheId: string): InMemoryCacheProvider;
+}

package/dist/src/cache/CacheProvider.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.
+ */
+import { EntityDataObject } from './EntityDataObject';
+import { ResultTree } from './ResultTree';
+export interface InternalCacheProvider {
+    getEntityData(globalId: string): Promise<EntityDataObject>;
+    updateEntityData(entityData: EntityDataObject): Promise<void>;
+    getResultTree(queryId: string): Promise<ResultTree | undefined>;
+    setResultTree(queryId: string, resultTree: ResultTree): Promise<void>;
+    close(): void;
+}

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

@@ -0,0 +1,37 @@
+/**
+ * @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 type FDCScalarValue = string | number | boolean | undefined | null | Record<string, unknown> | FDCScalarValue[];
+export interface EntityDataObjectJson {
+    map: {
+        [key: string]: FDCScalarValue;
+    };
+    referencedFrom: string[];
+    globalID: string;
+}
+export declare class EntityDataObject {
+    readonly globalID: string;
+    getServerValue(key: string): unknown;
+    private serverValues;
+    private referencedFrom;
+    constructor(globalID: string);
+    getServerValues(): {
+        [key: string]: FDCScalarValue;
+    };
+    toJSON(): EntityDataObjectJson;
+    static fromJSON(json: EntityDataObjectJson): EntityDataObject;
+    updateServerValue(key: string, value: FDCScalarValue, requestedFrom: string): string[];
+}

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

@@ -0,0 +1,56 @@
+/**
+ * @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 { InternalCacheProvider } from './CacheProvider';
+import { EntityDataObject, EntityDataObjectJson, FDCScalarValue } from './EntityDataObject';
+import { ImpactedQueryRefsAccumulator } from './ImpactedQueryRefsAccumulator';
+export declare const GLOBAL_ID_KEY = "_id";
+export declare const OBJECT_LISTS_KEY = "_objectLists";
+export declare const REFERENCES_KEY = "_references";
+export declare const SCALARS_KEY = "_scalars";
+export declare const ENTITY_DATA_KEYS_KEY = "_entity_data_keys";
+export declare class EntityNode {
+    entityData?: EntityDataObject;
+    scalars: Record<string, FDCScalarValue>;
+    references: {
+        [key: string]: EntityNode;
+    };
+    objectLists: {
+        [key: string]: EntityNode[];
+    };
+    globalId?: string;
+    entityDataKeys: Set<string>;
+    loadData(queryId: string, values: FDCScalarValue, entityIds: Record<string, unknown> | undefined, acc: ImpactedQueryRefsAccumulator, cacheProvider: InternalCacheProvider): Promise<void>;
+    toJSON(mode: EncodingMode): Record<string, unknown>;
+    static fromJson(obj: DehydratedStubDataObject): EntityNode;
+}
+export interface DehydratedStubDataObject {
+    backingData?: EntityDataObjectJson;
+    globalID?: string;
+    scalars: {
+        [key: string]: FDCScalarValue;
+    };
+    references: {
+        [key: string]: DehydratedStubDataObject;
+    };
+    objectLists: {
+        [key: string]: DehydratedStubDataObject[];
+    };
+}
+export declare enum EncodingMode {
+    hydrated = 0,
+    dehydrated = 1
+}

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

@@ -0,0 +1,23 @@
+/**
+ * @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 class ImpactedQueryRefsAccumulator {
+    private queryId;
+    impacted: Set<string>;
+    constructor(queryId: string);
+    add(impacted: string[]): void;
+    consumeEvents(): string[];
+}

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

@@ -0,0 +1,30 @@
+/**
+ * @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 { InternalCacheProvider } from './CacheProvider';
+import { EntityDataObject } from './EntityDataObject';
+import { ResultTree } from './ResultTree';
+export declare class InMemoryCacheProvider implements InternalCacheProvider {
+    private _keyId;
+    private edos;
+    private resultTrees;
+    constructor(_keyId: string);
+    setResultTree(queryId: string, rt: ResultTree): Promise<void>;
+    getResultTree(queryId: string): Promise<ResultTree | undefined>;
+    updateEntityData(entityData: EntityDataObject): Promise<void>;
+    getEntityData(globalId: string): Promise<EntityDataObject>;
+    close(): Promise<void>;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * @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 { EntityNode, DehydratedStubDataObject } from './EntityNode';
+export declare class ResultTree {
+    private rootStub;
+    private maxAge;
+    readonly cachedAt: Date;
+    private _lastAccessed;
+    /**
+     * Create a {@link ResultTree} from a dehydrated JSON object.
+     * @param value The dehydrated JSON object.
+     * @returns The {@link ResultTree}.
+     */
+    static fromJson(value: DehydratedResultTreeJson): ResultTree;
+    constructor(rootStub: EntityNode, maxAge: number, cachedAt: Date, _lastAccessed: Date);
+    isStale(): boolean;
+    updateMaxAge(maxAgeInSeconds: number): void;
+    updateAccessed(): void;
+    get lastAccessed(): Date;
+    getRootStub(): EntityNode;
+}
+interface DehydratedResultTreeJson {
+    rootStub: DehydratedStubDataObject;
+    maxAge: number;
+    cachedAt: Date;
+    lastAccessed: Date;
+}
+export {};

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

@@ -0,0 +1,40 @@
+/**
+ * @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 { InternalCacheProvider } from './CacheProvider';
+import { EntityNode } from './EntityNode';
+interface DehydratedResults {
+    entityNode: EntityNode;
+    impacted: string[];
+}
+export declare class ResultTreeProcessor {
+    /**
+     * Hydrate the EntityNode into a JSON object so that it can be returned to the user.
+     * @param rootStubObject
+     * @returns {string}
+     */
+    hydrateResults(rootStubObject: EntityNode): Record<string, unknown>;
+    /**
+     * Dehydrate results so that they can be stored in the cache.
+     * @param json
+     * @param entityIds
+     * @param cacheProvider
+     * @param queryId
+     * @returns {Promise<DehydratedResults>}
+     */
+    dehydrateResults(json: Record<string, unknown>, entityIds: Record<string, unknown>, cacheProvider: InternalCacheProvider, queryId: string): Promise<DehydratedResults>;
+}
+export {};