Do not edit this file. It is a report generated by API Extractor.
/// <reference types="react" />
import type { ASTNode } from 'graphql';
import type { DocumentNode } from 'graphql';
import type { ExecutionResult } from 'graphql';
import type { FieldNode } from 'graphql';
import type { FragmentDefinitionNode } from 'graphql';
import type { GraphQLError } from 'graphql';
import type { GraphQLErrorExtensions } from 'graphql';
import { Observable } from 'zen-observable-ts';
import type { Observer } from 'zen-observable-ts';
import * as PropTypes from 'prop-types';
import type { Subscriber } from 'zen-observable-ts';
import type { Subscription as Subscription_2 } from 'zen-observable-ts';
import { TypedDocumentNode } from '@graphql-typed-document-node/core';
// Warning: (ae-forgotten-export) The symbol "Modifier" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "StoreObjectValueMaybeReference" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type AllFieldsModifier<Entity extends Record<string, any>> = Modifier<Entity[keyof Entity] extends infer Value ? StoreObjectValueMaybeReference<Exclude<Value, undefined>> : never>;
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
abstract class ApolloCache<TSerialized> implements DataProxy {
// (undocumented)
readonly assumeImmutableResults: boolean;
// (undocumented)
batch<U>(options: Cache_2.BatchOptions<this, U>): U;
// (undocumented)
abstract diff<T>(query: Cache_2.DiffOptions): Cache_2.DiffResult<T>;
// (undocumented)
abstract evict(options: Cache_2.EvictOptions): boolean;
// (undocumented)
abstract extract(optimistic?: boolean): TSerialized;
// (undocumented)
gc(): string[];
// Warning: (ae-forgotten-export) The symbol "StoreObject" needs to be exported by the entry point index.d.ts
//
// (undocumented)
identify(object: StoreObject | Reference): string | undefined;
// (undocumented)
modify<Entity extends Record<string, any> = Record<string, any>>(options: Cache_2.ModifyOptions<Entity>): boolean;
// Warning: (ae-forgotten-export) The symbol "Transaction" needs to be exported by the entry point index.d.ts
//
// (undocumented)
abstract performTransaction(transaction: Transaction<TSerialized>, optimisticId?: string | null): void;
// Warning: (ae-forgotten-export) The symbol "Cache_2" needs to be exported by the entry point index.d.ts
//
// (undocumented)
abstract read<TData = any, TVariables = any>(query: Cache_2.ReadOptions<TVariables, TData>): TData | null;
// (undocumented)
readFragment<FragmentType, TVariables = any>(options: Cache_2.ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): FragmentType | null;
// (undocumented)
readQuery<QueryType, TVariables = any>(options: Cache_2.ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): QueryType | null;
// (undocumented)
recordOptimisticTransaction(transaction: Transaction<TSerialized>, optimisticId: string): void;
// (undocumented)
abstract removeOptimistic(id: string): void;
// (undocumented)
abstract reset(options?: Cache_2.ResetOptions): Promise<void>;
// (undocumented)
abstract restore(serializedState: TSerialized): ApolloCache<TSerialized>;
// (undocumented)
transformDocument(document: DocumentNode): DocumentNode;
// (undocumented)
transformForLink(document: DocumentNode): DocumentNode;
// (undocumented)
updateFragment<TData = any, TVariables = any>(options: Cache_2.UpdateFragmentOptions<TData, TVariables>, update: (data: TData | null) => TData | null | void): TData | null;
// (undocumented)
updateQuery<TData = any, TVariables = any>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: TData | null) => TData | null | void): TData | null;
// (undocumented)
abstract watch<TData = any, TVariables = any>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
// Warning: (ae-forgotten-export) The symbol "Reference" needs to be exported by the entry point index.d.ts
//
// (undocumented)
abstract write<TData = any, TVariables = any>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
// (undocumented)
writeFragment<TData = any, TVariables = any>({ id, data, fragment, fragmentName, ...options }: Cache_2.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
// (undocumented)
writeQuery<TData = any, TVariables = any>({ id, data, ...options }: Cache_2.WriteQueryOptions<TData, TVariables>): Reference | undefined;
}
// @public (undocumented)
class ApolloClient<TCacheShape> implements DataProxy {
// (undocumented)
__actionHookForDevTools(cb: () => any): void;
constructor(options: ApolloClientOptions<TCacheShape>);
// Warning: (ae-forgotten-export) The symbol "GraphQLRequest" needs to be exported by the entry point index.d.ts
//
// (undocumented)
__requestRaw(payload: GraphQLRequest): Observable<ExecutionResult>;
// Warning: (ae-forgotten-export) The symbol "Resolvers" needs to be exported by the entry point index.d.ts
//
// (undocumented)
addResolvers(resolvers: Resolvers | Resolvers[]): void;
// Warning: (ae-forgotten-export) The symbol "ApolloCache" needs to be exported by the entry point index.d.ts
//
// (undocumented)
cache: ApolloCache<TCacheShape>;
// (undocumented)
clearStore(): Promise<any[]>;
// (undocumented)
defaultOptions: DefaultOptions;
// (undocumented)
disableNetworkFetches: boolean;
// Warning: (ae-forgotten-export) The symbol "DocumentTransform" needs to be exported by the entry point index.d.ts
//
// (undocumented)
get documentTransform(): DocumentTransform;
// (undocumented)
extract(optimistic?: boolean): TCacheShape;
// Warning: (ae-forgotten-export) The symbol "RefetchQueriesInclude" needs to be exported by the entry point index.d.ts
//
// (undocumented)
getObservableQueries(include?: RefetchQueriesInclude): Map<string, ObservableQuery<any>>;
// (undocumented)
getResolvers(): Resolvers;
// Warning: (ae-forgotten-export) The symbol "ApolloLink" needs to be exported by the entry point index.d.ts
//
// (undocumented)
link: ApolloLink;
// Warning: (ae-forgotten-export) The symbol "DefaultContext" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "MutationOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "FetchResult" needs to be exported by the entry point index.d.ts
//
// (undocumented)
mutate<TData = any, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>>(options: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<TData>>;
// (undocumented)
onClearStore(cb: () => Promise<any>): () => void;
// (undocumented)
onResetStore(cb: () => Promise<any>): () => void;
// Warning: (ae-forgotten-export) The symbol "QueryOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ApolloQueryResult" needs to be exported by the entry point index.d.ts
//
// (undocumented)
query<T = any, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<TVariables, T>): Promise<ApolloQueryResult<T>>;
// (undocumented)
queryDeduplication: boolean;
// (undocumented)
readFragment<T = any, TVariables = OperationVariables>(options: DataProxy.Fragment<TVariables, T>, optimistic?: boolean): T | null;
// (undocumented)
readQuery<T = any, TVariables = OperationVariables>(options: DataProxy.Query<TVariables, T>, optimistic?: boolean): T | null;
// (undocumented)
reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>;
// Warning: (ae-forgotten-export) The symbol "RefetchQueriesOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "RefetchQueriesResult" needs to be exported by the entry point index.d.ts
//
// (undocumented)
refetchQueries<TCache extends ApolloCache<any> = ApolloCache<TCacheShape>, TResult = Promise<ApolloQueryResult<any>>>(options: RefetchQueriesOptions<TCache, TResult>): RefetchQueriesResult<TResult>;
// (undocumented)
resetStore(): Promise<ApolloQueryResult<any>[] | null>;
// (undocumented)
restore(serializedState: TCacheShape): ApolloCache<TCacheShape>;
// (undocumented)
setLink(newLink: ApolloLink): void;
// Warning: (ae-forgotten-export) The symbol "FragmentMatcher" needs to be exported by the entry point index.d.ts
//
// (undocumented)
setLocalStateFragmentMatcher(fragmentMatcher: FragmentMatcher): void;
// (undocumented)
setResolvers(resolvers: Resolvers | Resolvers[]): void;
// (undocumented)
stop(): void;
// Warning: (ae-forgotten-export) The symbol "SubscriptionOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
subscribe<T = any, TVariables extends OperationVariables = OperationVariables>(options: SubscriptionOptions<TVariables, T>): Observable<FetchResult<T>>;
// Warning: (ae-forgotten-export) The symbol "ApolloClientOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly typeDefs: ApolloClientOptions<TCacheShape>["typeDefs"];
// (undocumented)
version: string;
// Warning: (ae-forgotten-export) The symbol "OperationVariables" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "WatchQueryOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ObservableQuery" needs to be exported by the entry point index.d.ts
//
// (undocumented)
watchQuery<T = any, TVariables extends OperationVariables = OperationVariables>(options: WatchQueryOptions<TVariables, T>): ObservableQuery<T, TVariables>;
// (undocumented)
writeFragment<TData = any, TVariables = OperationVariables>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
// (undocumented)
writeQuery<TData = any, TVariables = OperationVariables>(options: DataProxy.WriteQueryOptions<TData, TVariables>): Reference | undefined;
}
// @public (undocumented)
type ApolloClientOptions<TCacheShape> = {
uri?: string | UriFunction;
credentials?: string;
headers?: Record<string, string>;
link?: ApolloLink;
cache: ApolloCache<TCacheShape>;
ssrForceFetchDelay?: number;
ssrMode?: boolean;
connectToDevTools?: boolean;
queryDeduplication?: boolean;
defaultOptions?: DefaultOptions;
assumeImmutableResults?: boolean;
resolvers?: Resolvers | Resolvers[];
typeDefs?: string | string[] | DocumentNode | DocumentNode[];
fragmentMatcher?: FragmentMatcher;
name?: string;
version?: string;
documentTransform?: DocumentTransform;
};
// @public (undocumented)
class ApolloError extends Error {
// Warning: (ae-forgotten-export) The symbol "ApolloErrorOptions" needs to be exported by the entry point index.d.ts
constructor({ graphQLErrors, protocolErrors, clientErrors, networkError, errorMessage, extraInfo, }: ApolloErrorOptions);
// (undocumented)
clientErrors: ReadonlyArray<Error>;
// (undocumented)
extraInfo: any;
// Warning: (ae-forgotten-export) The symbol "GraphQLErrors" needs to be exported by the entry point index.d.ts
//
// (undocumented)
graphQLErrors: GraphQLErrors;
// (undocumented)
message: string;
// (undocumented)
name: string;
// Warning: (ae-forgotten-export) The symbol "ServerParseError" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ServerError" needs to be exported by the entry point index.d.ts
//
// (undocumented)
networkError: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
}
// @public (undocumented)
interface ApolloErrorOptions {
// (undocumented)
clientErrors?: ReadonlyArray<Error>;
// (undocumented)
errorMessage?: string;
// (undocumented)
extraInfo?: any;
// (undocumented)
graphQLErrors?: ReadonlyArray<GraphQLError>;
// (undocumented)
networkError?: Error | ServerParseError | ServerError | null;
// (undocumented)
protocolErrors?: ReadonlyArray<{
message: string;
extensions?: GraphQLErrorExtensions[];
}>;
}
// @public (undocumented)
class ApolloLink {
constructor(request?: RequestHandler);
// (undocumented)
static concat(first: ApolloLink | RequestHandler, second: ApolloLink | RequestHandler): ApolloLink;
// (undocumented)
concat(next: ApolloLink | RequestHandler): ApolloLink;
// (undocumented)
static empty(): ApolloLink;
// (undocumented)
static execute(link: ApolloLink, operation: GraphQLRequest): Observable<FetchResult>;
// Warning: (ae-forgotten-export) The symbol "RequestHandler" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static from(links: (ApolloLink | RequestHandler)[]): ApolloLink;
// (undocumented)
protected onError(error: any, observer?: Observer<FetchResult>): false | void;
// Warning: (ae-forgotten-export) The symbol "NextLink" needs to be exported by the entry point index.d.ts
//
// (undocumented)
request(operation: Operation, forward?: NextLink): Observable<FetchResult> | null;
// (undocumented)
setOnError(fn: ApolloLink["onError"]): this;
// Warning: (ae-forgotten-export) The symbol "Operation" needs to be exported by the entry point index.d.ts
//
// (undocumented)
static split(test: (op: Operation) => boolean, left: ApolloLink | RequestHandler, right?: ApolloLink | RequestHandler): ApolloLink;
// (undocumented)
split(test: (op: Operation) => boolean, left: ApolloLink | RequestHandler, right?: ApolloLink | RequestHandler): ApolloLink;
}
// @public (undocumented)
type ApolloQueryResult<T> = {
data: T;
errors?: ReadonlyArray<GraphQLError>;
error?: ApolloError;
loading: boolean;
networkStatus: NetworkStatus;
partial?: boolean;
};
// @public (undocumented)
type AsStoreObject<T extends {
__typename?: string;
}> = {
[K in keyof T]: T[K];
};
// @public (undocumented)
interface BaseMutationOptions<TData = any, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>> extends Omit<MutationOptions<TData, TVariables, TContext, TCache>, "mutation"> {
// Warning: (ae-forgotten-export) The symbol "ApolloClient" needs to be exported by the entry point index.d.ts
//
// (undocumented)
client?: ApolloClient<object>;
// (undocumented)
ignoreResults?: boolean;
// (undocumented)
notifyOnNetworkStatusChange?: boolean;
// (undocumented)
onCompleted?: (data: TData, clientOptions?: BaseMutationOptions) => void;
// (undocumented)
onError?: (error: ApolloError, clientOptions?: BaseMutationOptions) => void;
}
// @public (undocumented)
interface BaseQueryOptions<TVariables extends OperationVariables = OperationVariables> extends Omit<WatchQueryOptions<TVariables>, "query"> {
// (undocumented)
client?: ApolloClient<any>;
// (undocumented)
context?: DefaultContext;
// (undocumented)
ssr?: boolean;
}
// @public (undocumented)
interface BaseSubscriptionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> {
// (undocumented)
client?: ApolloClient<object>;
// (undocumented)
context?: DefaultContext;
// Warning: (ae-forgotten-export) The symbol "FetchPolicy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
fetchPolicy?: FetchPolicy;
// (undocumented)
onComplete?: () => void;
// Warning: (ae-forgotten-export) The symbol "OnDataOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
onData?: (options: OnDataOptions<TData>) => any;
// (undocumented)
onError?: (error: ApolloError) => void;
// (undocumented)
onSubscriptionComplete?: () => void;
// Warning: (ae-forgotten-export) The symbol "OnSubscriptionDataOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
onSubscriptionData?: (options: OnSubscriptionDataOptions<TData>) => any;
// (undocumented)
shouldResubscribe?: boolean | ((options: BaseSubscriptionOptions<TData, TVariables>) => boolean);
// (undocumented)
skip?: boolean;
// (undocumented)
variables?: TVariables;
}
// @public (undocumented)
namespace Cache_2 {
// (undocumented)
interface BatchOptions<TCache extends ApolloCache<any>, TUpdateResult = void> {
// (undocumented)
onWatchUpdated?: (this: TCache, watch: Cache_2.WatchOptions, diff: Cache_2.DiffResult<any>, lastDiff?: Cache_2.DiffResult<any> | undefined) => any;
// (undocumented)
optimistic?: string | boolean;
// (undocumented)
removeOptimistic?: string;
// (undocumented)
update(cache: TCache): TUpdateResult;
}
// Warning: (ae-forgotten-export) The symbol "Cache_2" needs to be exported by the entry point index.d.ts
//
// (undocumented)
interface DiffOptions<TData = any, TVariables = any> extends Omit<ReadOptions<TVariables, TData>, "rootId"> {
}
// (undocumented)
interface EvictOptions {
// (undocumented)
args?: Record<string, any>;
// (undocumented)
broadcast?: boolean;
// (undocumented)
fieldName?: string;
// (undocumented)
id?: string;
}
// (undocumented)
interface ModifyOptions<Entity extends Record<string, any> = Record<string, any>> {
// (undocumented)
broadcast?: boolean;
// Warning: (ae-forgotten-export) The symbol "Modifiers" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "AllFieldsModifier" needs to be exported by the entry point index.d.ts
//
// (undocumented)
fields: Modifiers<Entity> | AllFieldsModifier<Entity>;
// (undocumented)
id?: string;
// (undocumented)
optimistic?: boolean;
}
// (undocumented)
interface ReadOptions<TVariables = any, TData = any> extends DataProxy.Query<TVariables, TData> {
// (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic: boolean;
// (undocumented)
previousResult?: any;
// (undocumented)
returnPartialData?: boolean;
// (undocumented)
rootId?: string;
}
// (undocumented)
interface ResetOptions {
// (undocumented)
discardWatches?: boolean;
}
// (undocumented)
type WatchCallback<TData = any> = (diff: Cache_2.DiffResult<TData>, lastDiff?: Cache_2.DiffResult<TData>) => void;
// Warning: (ae-forgotten-export) The symbol "Cache_2" needs to be exported by the entry point index.d.ts
//
// (undocumented)
interface WatchOptions<TData = any, TVariables = any> extends DiffOptions<TData, TVariables> {
// Warning: (ae-forgotten-export) The symbol "Cache_2" needs to be exported by the entry point index.d.ts
//
// (undocumented)
callback: WatchCallback<TData>;
// (undocumented)
immediate?: boolean;
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
lastDiff?: DiffResult<TData>;
// (undocumented)
watcher?: object;
}
// (undocumented)
interface WriteOptions<TResult = any, TVariables = any> extends Omit<DataProxy.Query<TVariables, TResult>, "id">, Omit<DataProxy.WriteOptions<TResult>, "data"> {
// (undocumented)
dataId?: string;
// (undocumented)
result: TResult;
}
import DiffResult = DataProxy.DiffResult;
import ReadQueryOptions = DataProxy.ReadQueryOptions;
import ReadFragmentOptions = DataProxy.ReadFragmentOptions;
import WriteQueryOptions = DataProxy.WriteQueryOptions;
import WriteFragmentOptions = DataProxy.WriteFragmentOptions;
import UpdateQueryOptions = DataProxy.UpdateQueryOptions;
import UpdateFragmentOptions = DataProxy.UpdateFragmentOptions;
import Fragment = DataProxy.Fragment;
}
// @public (undocumented)
const enum CacheWriteBehavior {
// (undocumented)
FORBID = 0,
// (undocumented)
MERGE = 2,
// (undocumented)
OVERWRITE = 1
}
// Warning: (ae-forgotten-export) The symbol "StoreValue" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type CanReadFunction = (value: StoreValue) => boolean;
// @public (undocumented)
class Concast<T> extends Observable<T> {
// Warning: (ae-forgotten-export) The symbol "MaybeAsync" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ConcastSourcesIterable" needs to be exported by the entry point index.d.ts
constructor(sources: MaybeAsync<ConcastSourcesIterable<T>> | Subscriber<T>);
// (undocumented)
addObserver(observer: Observer<T>): void;
// Warning: (ae-forgotten-export) The symbol "NextResultListener" needs to be exported by the entry point index.d.ts
//
// (undocumented)
beforeNext(callback: NextResultListener): void;
// (undocumented)
cancel: (reason: any) => void;
// (undocumented)
readonly promise: Promise<T | undefined>;
// (undocumented)
removeObserver(observer: Observer<T>): void;
}
// Warning: (ae-forgotten-export) The symbol "Source" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type ConcastSourcesIterable<T> = Iterable<Source<T>>;
// @public (undocumented)
namespace DataProxy {
// (undocumented)
type DiffResult<T> = {
result?: T;
complete?: boolean;
missing?: MissingFieldError[];
fromOptimisticTransaction?: boolean;
};
// (undocumented)
interface Fragment<TVariables, TData> {
// (undocumented)
fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
// (undocumented)
fragmentName?: string;
// (undocumented)
id?: string;
// (undocumented)
variables?: TVariables;
}
// (undocumented)
interface Query<TVariables, TData> {
// (undocumented)
id?: string;
// (undocumented)
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
// (undocumented)
variables?: TVariables;
}
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
// (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic?: boolean;
// (undocumented)
returnPartialData?: boolean;
}
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
// (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic?: boolean;
// (undocumented)
returnPartialData?: boolean;
}
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
interface UpdateFragmentOptions<TData, TVariables> extends Omit<ReadFragmentOptions<TData, TVariables> & WriteFragmentOptions<TData, TVariables>, "data"> {
}
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
interface UpdateQueryOptions<TData, TVariables> extends Omit<ReadQueryOptions<TData, TVariables> & WriteQueryOptions<TData, TVariables>, "data"> {
}
// (undocumented)
interface WriteFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData>, WriteOptions<TData> {
}
// (undocumented)
interface WriteOptions<TData> {
// (undocumented)
broadcast?: boolean;
// (undocumented)
data: TData;
// (undocumented)
overwrite?: boolean;
}
// Warning: (ae-forgotten-export) The symbol "DataProxy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
interface WriteQueryOptions<TData, TVariables> extends Query<TVariables, TData>, WriteOptions<TData> {
}
}
// @public (undocumented)
interface DataProxy {
// (undocumented)
readFragment<FragmentType, TVariables = any>(options: DataProxy.ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): FragmentType | null;
// (undocumented)
readQuery<QueryType, TVariables = any>(options: DataProxy.ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): QueryType | null;
// (undocumented)
writeFragment<TData = any, TVariables = any>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
// (undocumented)
writeQuery<TData = any, TVariables = any>(options: DataProxy.WriteQueryOptions<TData, TVariables>): Reference | undefined;
}
// @public (undocumented)
interface DefaultContext extends Record<string, any> {
}
// @public (undocumented)
interface DefaultOptions {
// (undocumented)
mutate?: Partial<MutationOptions<any, any, any>>;
// (undocumented)
query?: Partial<QueryOptions<any, any>>;
// (undocumented)
watchQuery?: Partial<WatchQueryOptions<any, any>>;
}
// @public (undocumented)
interface DeleteModifier {
// (undocumented)
[_deleteModifier]: true;
}
// @public (undocumented)
const _deleteModifier: unique symbol;
// @public (undocumented)
class DocumentTransform {
// Warning: (ae-forgotten-export) The symbol "TransformFn" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DocumentTransformOptions" needs to be exported by the entry point index.d.ts
constructor(transform: TransformFn, options?: DocumentTransformOptions);
// (undocumented)
concat(otherTransform: DocumentTransform): DocumentTransform;
// (undocumented)
getStableCacheEntry(document: DocumentNode): {
key: DocumentTransformCacheKey;
value?: DocumentNode | undefined;
} | undefined;
// (undocumented)
static identity(): DocumentTransform;
// (undocumented)
static split(predicate: (document: DocumentNode) => boolean, left: DocumentTransform, right?: DocumentTransform): DocumentTransform;
// (undocumented)
transformDocument(document: DocumentNode): DocumentNode;
}
// @public (undocumented)
type DocumentTransformCacheKey = ReadonlyArray<unknown>;
// @public (undocumented)
interface DocumentTransformOptions {
// (undocumented)
cache?: boolean;
// (undocumented)
getCacheKey?: (document: DocumentNode) => DocumentTransformCacheKey | undefined;
}
// @public (undocumented)
type ErrorPolicy = "none" | "ignore" | "all";
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchResultBase" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
interface ExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
// (undocumented)
data?: never;
// (undocumented)
errors?: never;
// (undocumented)
extensions?: never;
// Warning: (ae-forgotten-export) The symbol "IncrementalPayload" needs to be exported by the entry point index.d.ts
//
// (undocumented)
incremental?: IncrementalPayload<TData, TExtensions>[];
}
// @public (undocumented)
interface ExecutionPatchInitialResult<TData = Record<string, any>, TExtensions = Record<string, any>> extends ExecutionPatchResultBase {
// (undocumented)
data: TData | null | undefined;
// (undocumented)
errors?: ReadonlyArray<GraphQLError>;
// (undocumented)
extensions?: TExtensions;
// (undocumented)
incremental?: never;
}
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchInitialResult" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchIncrementalResult" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type ExecutionPatchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = ExecutionPatchInitialResult<TData, TExtensions> | ExecutionPatchIncrementalResult<TData, TExtensions>;
// @public (undocumented)
interface ExecutionPatchResultBase {
// (undocumented)
hasNext?: boolean;
}
// @public (undocumented)
interface FetchMoreQueryOptions<TVariables, TData = any> {
// (undocumented)
context?: DefaultContext;
// (undocumented)
query?: DocumentNode | TypedDocumentNode<TData, TVariables>;
// (undocumented)
variables?: Partial<TVariables>;
}
// @public (undocumented)
type FetchPolicy = "cache-first" | "network-only" | "cache-only" | "no-cache" | "standby";
// Warning: (ae-forgotten-export) The symbol "SingleExecutionResult" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "ExecutionPatchResult" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type FetchResult<TData = Record<string, any>, TContext = Record<string, any>, TExtensions = Record<string, any>> = SingleExecutionResult<TData, TContext, TExtensions> | ExecutionPatchResult<TData, TExtensions>;
// @public (undocumented)
interface FieldSpecifier {
// (undocumented)
args?: Record<string, any>;
// (undocumented)
field?: FieldNode;
// (undocumented)
fieldName: string;
// (undocumented)
typename?: string;
// (undocumented)
variables?: Record<string, any>;
}
// @public (undocumented)
interface FragmentMap {
// (undocumented)
[fragmentName: string]: FragmentDefinitionNode;
}
// @public (undocumented)
type FragmentMatcher = (rootValue: any, typeCondition: string, context: any) => boolean;
// @public (undocumented)
type GraphQLErrors = ReadonlyArray<GraphQLError>;
// @public (undocumented)
interface GraphQLRequest<TVariables = Record<string, any>> {
// (undocumented)
context?: DefaultContext;
// (undocumented)
extensions?: Record<string, any>;
// (undocumented)
operationName?: string;
// (undocumented)
query: DocumentNode;
// (undocumented)
variables?: TVariables;
}
// @public (undocumented)
interface IncrementalPayload<TData, TExtensions> {
// (undocumented)
data: TData | null;
// (undocumented)
errors?: ReadonlyArray<GraphQLError>;
// (undocumented)
extensions?: TExtensions;
// (undocumented)
label?: string;
// Warning: (ae-forgotten-export) The symbol "Path" needs to be exported by the entry point index.d.ts
//
// (undocumented)
path: Path;
}
// Warning: (ae-forgotten-export) The symbol "InternalRefetchQueryDescriptor" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "RefetchQueriesIncludeShorthand" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type InternalRefetchQueriesInclude = InternalRefetchQueryDescriptor[] | RefetchQueriesIncludeShorthand;
// Warning: (ae-forgotten-export) The symbol "InternalRefetchQueriesResult" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type InternalRefetchQueriesMap<TResult> = Map<ObservableQuery<any>, InternalRefetchQueriesResult<TResult>>;
// @public (undocumented)
interface InternalRefetchQueriesOptions<TCache extends ApolloCache<any>, TResult> extends Omit<RefetchQueriesOptions<TCache, TResult>, "include"> {
// Warning: (ae-forgotten-export) The symbol "InternalRefetchQueriesInclude" needs to be exported by the entry point index.d.ts
//
// (undocumented)
include?: InternalRefetchQueriesInclude;
// (undocumented)
removeOptimistic?: string;
}
// @public (undocumented)
type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Promise<ApolloQueryResult<any>> : TResult;
// Warning: (ae-forgotten-export) The symbol "RefetchQueryDescriptor" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type InternalRefetchQueryDescriptor = RefetchQueryDescriptor | QueryOptions;
// @public (undocumented)
interface InvalidateModifier {
// (undocumented)
[_invalidateModifier]: true;
}
// @public (undocumented)
const _invalidateModifier: unique symbol;
// @public (undocumented)
function isReference(obj: any): obj is Reference;
// Warning: (ae-forgotten-export) The symbol "UnionToIntersection" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "UnionForAny" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type IsStrictlyAny<T> = UnionToIntersection<UnionForAny<T>> extends never ? true : false;
// @public (undocumented)
class LocalState<TCacheShape> {
// Warning: (ae-forgotten-export) The symbol "LocalStateOptions" needs to be exported by the entry point index.d.ts
constructor({ cache, client, resolvers, fragmentMatcher, }: LocalStateOptions<TCacheShape>);
// (undocumented)
addExportedVariables<TVars extends OperationVariables>(document: DocumentNode, variables?: TVars, context?: {}): Promise<TVars>;
// (undocumented)
addResolvers(resolvers: Resolvers | Resolvers[]): void;
// (undocumented)
clientQuery(document: DocumentNode): DocumentNode | null;
// (undocumented)
getFragmentMatcher(): FragmentMatcher | undefined;
// (undocumented)
getResolvers(): Resolvers;
// (undocumented)
prepareContext(context?: Record<string, any>): {
cache: ApolloCache<TCacheShape>;
getCacheKey(obj: StoreObject): string | undefined;
};
// (undocumented)
runResolvers<TData>({ document, remoteResult, context, variables, onlyRunForcedResolvers, }: {
document: DocumentNode | null;
remoteResult: FetchResult<TData>;
context?: Record<string, any>;
variables?: Record<string, any>;
onlyRunForcedResolvers?: boolean;
}): Promise<FetchResult<TData>>;
// (undocumented)
serverQuery(document: DocumentNode): DocumentNode | null;
// (undocumented)
setFragmentMatcher(fragmentMatcher: FragmentMatcher): void;
// (undocumented)
setResolvers(resolvers: Resolvers | Resolvers[]): void;
// (undocumented)
shouldForceResolvers(document: ASTNode): boolean;
}
// @public (undocumented)
type LocalStateOptions<TCacheShape> = {
cache: ApolloCache<TCacheShape>;
client?: ApolloClient<TCacheShape>;
resolvers?: Resolvers | Resolvers[];
fragmentMatcher?: FragmentMatcher;
};
// @public (undocumented)
type MaybeAsync<T> = T | PromiseLike<T>;
// @public (undocumented)
class MissingFieldError extends Error {
constructor(message: string, path: MissingTree | Array<string | number>, query: DocumentNode, variables?: Record<string, any> | undefined);
// (undocumented)
readonly message: string;
// (undocumented)
readonly missing: MissingTree;
// Warning: (ae-forgotten-export) The symbol "MissingTree" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly path: MissingTree | Array<string | number>;
// (undocumented)
readonly query: DocumentNode;
// (undocumented)
readonly variables?: Record<string, any> | undefined;
}
// @public (undocumented)
type MissingTree = string | {
readonly [key: string]: MissingTree;
};
// Warning: (ae-forgotten-export) The symbol "ModifierDetails" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DeleteModifier" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "InvalidateModifier" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type Modifier<T> = (value: T, details: ModifierDetails) => T | DeleteModifier | InvalidateModifier;
// @public (undocumented)
type ModifierDetails = {
DELETE: DeleteModifier;
INVALIDATE: InvalidateModifier;
fieldName: string;
storeFieldName: string;
readField: ReadFieldFunction;
canRead: CanReadFunction;
isReference: typeof isReference;
toReference: ToReferenceFunction;
storage: StorageType;
};
// @public (undocumented)
type Modifiers<T extends Record<string, any> = Record<string, unknown>> = Partial<{
[FieldName in keyof T]: Modifier<StoreObjectValueMaybeReference<Exclude<T[FieldName], undefined>>>;
}>;
// @public (undocumented)
export function Mutation<TData = any, TVariables = OperationVariables>(props: MutationComponentOptions<TData, TVariables>): JSX.Element | null;
// @public (undocumented)
export namespace Mutation {
var // (undocumented)
propTypes: PropTypes.InferProps<MutationComponentOptions<any, any, DefaultContext, ApolloCache<any>>>;
}
// @public (undocumented)
export interface Mutation<TData, TVariables> {
// (undocumented)
propTypes: PropTypes.InferProps<MutationComponentOptions<TData, TVariables>>;
}
// @public (undocumented)
interface MutationBaseOptions<TData = any, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>> {
// (undocumented)
awaitRefetchQueries?: boolean;
// (undocumented)
context?: TContext;
// Warning: (ae-forgotten-export) The symbol "ErrorPolicy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
errorPolicy?: ErrorPolicy;
// Warning: (ae-forgotten-export) The symbol "OnQueryUpdated" needs to be exported by the entry point index.d.ts
//
// (undocumented)
onQueryUpdated?: OnQueryUpdated<any>;
// (undocumented)
optimisticResponse?: TData | ((vars: TVariables) => TData);
// (undocumented)
refetchQueries?: ((result: FetchResult<TData>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
// Warning: (ae-forgotten-export) The symbol "MutationUpdaterFunction" needs to be exported by the entry point index.d.ts
//
// (undocumented)
update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
// Warning: (ae-forgotten-export) The symbol "MutationQueryReducersMap" needs to be exported by the entry point index.d.ts
//
// (undocumented)
updateQueries?: MutationQueryReducersMap<TData>;
// (undocumented)
variables?: TVariables;
}
// Warning: (ae-forgotten-export) The symbol "BaseMutationOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export interface MutationComponentOptions<TData = any, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>> extends BaseMutationOptions<TData, TVariables, TContext, TCache> {
// Warning: (ae-forgotten-export) The symbol "MutationFunction" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "MutationResult" needs to be exported by the entry point index.d.ts
//
// (undocumented)
children: (mutateFunction: MutationFunction<TData, TVariables, TContext>, result: MutationResult<TData>) => JSX.Element | null;
// (undocumented)
mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
// @public (undocumented)
type MutationFetchPolicy = Extract<FetchPolicy, "network-only" | "no-cache">;
// Warning: (ae-forgotten-export) The symbol "MutationFunctionOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type MutationFunction<TData = any, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>> = (options?: MutationFunctionOptions<TData, TVariables, TContext, TCache>) => Promise<FetchResult<TData>>;
// @public (undocumented)
interface MutationFunctionOptions<TData = any, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>> extends BaseMutationOptions<TData, TVariables, TContext, TCache> {
// (undocumented)
mutation?: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
// Warning: (ae-forgotten-export) The symbol "MutationBaseOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
interface MutationOptions<TData = any, TVariables = OperationVariables, TContext = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>> extends MutationBaseOptions<TData, TVariables, TContext, TCache> {
// Warning: (ae-forgotten-export) The symbol "MutationFetchPolicy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
fetchPolicy?: MutationFetchPolicy;
// (undocumented)
keepRootFields?: boolean;
// (undocumented)
mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
// @public (undocumented)
type MutationQueryReducer<T> = (previousResult: Record<string, any>, options: {
mutationResult: FetchResult<T>;
queryName: string | undefined;
queryVariables: Record<string, any>;
}) => Record<string, any>;
// @public (undocumented)
type MutationQueryReducersMap<T = {
[key: string]: any;
}> = {
[queryName: string]: MutationQueryReducer<T>;
};
// @public (undocumented)
interface MutationResult<TData = any> {
// (undocumented)
called: boolean;
// (undocumented)
client: ApolloClient<object>;
// (undocumented)
data?: TData | null;
// (undocumented)
error?: ApolloError;
// (undocumented)
loading: boolean;
// (undocumented)
reset(): void;
}
// @public (undocumented)
interface MutationStoreValue {
// (undocumented)
error: Error | null;
// (undocumented)
loading: boolean;
// (undocumented)
mutation: DocumentNode;
// (undocumented)
variables: Record<string, any>;
}
// @public (undocumented)
type MutationUpdaterFunction<TData, TVariables, TContext, TCache extends ApolloCache<any>> = (cache: TCache, result: Omit<FetchResult<TData>, "context">, options: {
context?: TContext;
variables?: TVariables;
}) => void;
// @public (undocumented)
enum NetworkStatus {
// (undocumented)
error = 8,
// (undocumented)
fetchMore = 3,
// (undocumented)
loading = 1,
// (undocumented)
poll = 6,
// (undocumented)
ready = 7,
// (undocumented)
refetch = 4,
// (undocumented)
setVariables = 2
}
// @public (undocumented)
interface NextFetchPolicyContext<TData, TVariables extends OperationVariables> {
// Warning: (ae-forgotten-export) The symbol "WatchQueryFetchPolicy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
initialFetchPolicy: WatchQueryFetchPolicy;
// (undocumented)
observable: ObservableQuery<TData, TVariables>;
// (undocumented)
options: WatchQueryOptions<TVariables, TData>;
// (undocumented)
reason: "after-fetch" | "variables-changed";
}
// @public (undocumented)
type NextLink = (operation: Operation) => Observable<FetchResult>;
// @public (undocumented)
type NextResultListener = (method: "next" | "error" | "complete", arg?: any) => any;
// @public (undocumented)
class ObservableQuery<TData = any, TVariables extends OperationVariables = OperationVariables> extends Observable<ApolloQueryResult<TData>> {
constructor({ queryManager, queryInfo, options, }: {
queryManager: QueryManager<any>;
queryInfo: QueryInfo;
options: WatchQueryOptions<TVariables, TData>;
});
// Warning: (ae-forgotten-export) The symbol "FetchMoreQueryOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
fetchMore<TFetchData = TData, TFetchVars extends OperationVariables = TVariables>(fetchMoreOptions: FetchMoreQueryOptions<TFetchVars, TFetchData> & {
updateQuery?: (previousQueryResult: TData, options: {
fetchMoreResult: TFetchData;
variables: TFetchVars;
}) => TData;
}): Promise<ApolloQueryResult<TFetchData>>;
// (undocumented)
getCurrentResult(saveAsLastResult?: boolean): ApolloQueryResult<TData>;
// (undocumented)
getLastError(variablesMustMatch?: boolean): ApolloError | undefined;
// (undocumented)
getLastResult(variablesMustMatch?: boolean): ApolloQueryResult<TData> | undefined;
// (undocumented)
hasObservers(): boolean;
// (undocumented)
isDifferentFromLastResult(newResult: ApolloQueryResult<TData>, variables?: TVariables): boolean | undefined;
// (undocumented)
readonly options: WatchQueryOptions<TVariables, TData>;
// (undocumented)
get query(): TypedDocumentNode<TData, TVariables>;
// (undocumented)
readonly queryId: string;
// (undocumented)
readonly queryName?: string;
// (undocumented)
refetch(variables?: Partial<TVariables>): Promise<ApolloQueryResult<TData>>;
// (undocumented)
reobserve(newOptions?: Partial<WatchQueryOptions<TVariables, TData>>, newNetworkStatus?: NetworkStatus): Promise<ApolloQueryResult<TData>>;
// Warning: (ae-forgotten-export) The symbol "Concast" needs to be exported by the entry point index.d.ts
//
// (undocumented)
reobserveAsConcast(newOptions?: Partial<WatchQueryOptions<TVariables, TData>>, newNetworkStatus?: NetworkStatus): Concast<ApolloQueryResult<TData>>;
// (undocumented)
resetLastResults(): void;
// (undocumented)
resetQueryStoreErrors(): void;
// (undocumented)
resubscribeAfterError(onNext: (value: ApolloQueryResult<TData>) => void, onError?: (error: any) => void, onComplete?: () => void): Subscription_2;
// (undocumented)
resubscribeAfterError(observer: Observer<ApolloQueryResult<TData>>): Subscription_2;
// (undocumented)
result(): Promise<ApolloQueryResult<TData>>;
// (undocumented)
setOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): Promise<ApolloQueryResult<TData>>;
// (undocumented)
setVariables(variables: TVariables): Promise<ApolloQueryResult<TData> | void>;
// (undocumented)
silentSetOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): void;
// (undocumented)
startPolling(pollInterval: number): void;
// (undocumented)
stopPolling(): void;
// Warning: (ae-forgotten-export) The symbol "SubscribeToMoreOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
subscribeToMore<TSubscriptionData = TData, TSubscriptionVariables extends OperationVariables = TVariables>(options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData>): () => void;
// (undocumented)
updateQuery<TVars extends OperationVariables = TVariables>(mapFn: (previousQueryResult: TData, options: Pick<WatchQueryOptions<TVars, TData>, "variables">) => TData): void;
// (undocumented)
get variables(): TVariables | undefined;
}
// @public (undocumented)
type ObservableQueryFields<TData, TVariables extends OperationVariables> = Pick<ObservableQuery<TData, TVariables>, "startPolling" | "stopPolling" | "subscribeToMore" | "updateQuery" | "refetch" | "reobserve" | "variables" | "fetchMore">;
// @public (undocumented)
interface OnDataOptions<TData = any> {
// (undocumented)
client: ApolloClient<object>;
// Warning: (ae-forgotten-export) The symbol "SubscriptionResult" needs to be exported by the entry point index.d.ts
//
// (undocumented)
data: SubscriptionResult<TData>;
}
// @public (undocumented)
type OnQueryUpdated<TResult> = (observableQuery: ObservableQuery<any>, diff: Cache_2.DiffResult<any>, lastDiff: Cache_2.DiffResult<any> | undefined) => boolean | TResult;
// @public (undocumented)
interface OnSubscriptionDataOptions<TData = any> {
// (undocumented)
client: ApolloClient<object>;
// (undocumented)
subscriptionData: SubscriptionResult<TData>;
}
// @public (undocumented)
interface Operation {
// (undocumented)
extensions: Record<string, any>;
// (undocumented)
getContext: () => DefaultContext;
// (undocumented)
operationName: string;
// (undocumented)
query: DocumentNode;
// (undocumented)
setContext: (context: DefaultContext) => DefaultContext;
// (undocumented)
variables: Record<string, any>;
}
// @public (undocumented)
type OperationVariables = Record<string, any>;
// @public (undocumented)
type Path = ReadonlyArray<string | number>;
// @public (undocumented)
export function Query<TData = any, TVariables extends OperationVariables = OperationVariables>(props: QueryComponentOptions<TData, TVariables>): JSX.Element | null;
// @public (undocumented)
export namespace Query {
var // (undocumented)
propTypes: PropTypes.InferProps<QueryComponentOptions<any, any>>;
}
// @public (undocumented)
export interface Query<TData, TVariables extends OperationVariables> {
// (undocumented)
propTypes: PropTypes.InferProps<QueryComponentOptions<TData, TVariables>>;
}
// Warning: (ae-forgotten-export) The symbol "QueryFunctionOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export interface QueryComponentOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends QueryFunctionOptions<TData, TVariables> {
// Warning: (ae-forgotten-export) The symbol "QueryResult" needs to be exported by the entry point index.d.ts
//
// (undocumented)
children: (result: QueryResult<TData, TVariables>) => JSX.Element | null;
// (undocumented)
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
// Warning: (ae-forgotten-export) The symbol "BaseQueryOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
interface QueryFunctionOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseQueryOptions<TVariables> {
// (undocumented)
defaultOptions?: Partial<WatchQueryOptions<TVariables, TData>>;
// (undocumented)
onCompleted?: (data: TData) => void;
// (undocumented)
onError?: (error: ApolloError) => void;
// (undocumented)
skip?: boolean;
}
// @public (undocumented)
class QueryInfo {
constructor(queryManager: QueryManager<any>, queryId?: string);
// (undocumented)
document: DocumentNode | null;
// (undocumented)
getDiff(): Cache_2.DiffResult<any>;
// (undocumented)
graphQLErrors?: ReadonlyArray<GraphQLError>;
// (undocumented)
init(query: {
document: DocumentNode;
variables: Record<string, any> | undefined;
networkStatus?: NetworkStatus;
observableQuery?: ObservableQuery<any, any>;
lastRequestId?: number;
}): this;
// (undocumented)
lastRequestId: number;
// Warning: (ae-forgotten-export) The symbol "QueryListener" needs to be exported by the entry point index.d.ts
//
// (undocumented)
listeners: Set<QueryListener>;
// (undocumented)
markError(error: ApolloError): ApolloError;
// (undocumented)
markReady(): NetworkStatus;
// Warning: (ae-forgotten-export) The symbol "CacheWriteBehavior" needs to be exported by the entry point index.d.ts
//
// (undocumented)
markResult<T>(result: FetchResult<T>, document: DocumentNode, options: Pick<WatchQueryOptions, "variables" | "fetchPolicy" | "errorPolicy">, cacheWriteBehavior: CacheWriteBehavior): void;
// (undocumented)
networkError?: Error | null;
// (undocumented)
networkStatus?: NetworkStatus;
// (undocumented)
notify(): void;
// (undocumented)
readonly observableQuery: ObservableQuery<any, any> | null;
// (undocumented)
readonly queryId: string;
// (undocumented)
reset(): void;
// (undocumented)
resetLastWrite(): void;
// (undocumented)
setDiff(diff: Cache_2.DiffResult<any> | null): void;
// (undocumented)
setObservableQuery(oq: ObservableQuery<any, any> | null): void;
// (undocumented)
stop(): void;
// (undocumented)
stopped: boolean;
// (undocumented)
variables?: Record<string, any>;
}
// @public (undocumented)
type QueryListener = (queryInfo: QueryInfo) => void;
// @public (undocumented)
class QueryManager<TStore> {
constructor({ cache, link, defaultOptions, documentTransform, queryDeduplication, onBroadcast, ssrMode, clientAwareness, localState, assumeImmutableResults, }: {
cache: ApolloCache<TStore>;
link: ApolloLink;
defaultOptions?: DefaultOptions;
documentTransform?: DocumentTransform;
queryDeduplication?: boolean;
onBroadcast?: () => void;
ssrMode?: boolean;
clientAwareness?: Record<string, string>;
localState?: LocalState<TStore>;
assumeImmutableResults?: boolean;
});
// (undocumented)
readonly assumeImmutableResults: boolean;
// (undocumented)
broadcastQueries(): void;
// (undocumented)
cache: ApolloCache<TStore>;
// (undocumented)
clearStore(options?: Cache_2.ResetOptions): Promise<void>;
// Warning: (ae-forgotten-export) The symbol "DefaultOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
defaultOptions: DefaultOptions;
// (undocumented)
readonly documentTransform: DocumentTransform;
// (undocumented)
protected fetchCancelFns: Map<string, (error: any) => any>;
// (undocumented)
fetchQuery<TData, TVars extends OperationVariables>(queryId: string, options: WatchQueryOptions<TVars, TData>, networkStatus?: NetworkStatus): Promise<ApolloQueryResult<TData>>;
// (undocumented)
generateMutationId(): string;
// (undocumented)
generateQueryId(): string;
// (undocumented)
generateRequestId(): number;
// Warning: (ae-forgotten-export) The symbol "TransformCacheEntry" needs to be exported by the entry point index.d.ts
//
// (undocumented)
getDocumentInfo(document: DocumentNode): TransformCacheEntry;
// (undocumented)
getLocalState(): LocalState<TStore>;
// (undocumented)
getObservableQueries(include?: InternalRefetchQueriesInclude): Map<string, ObservableQuery<any, OperationVariables>>;
// Warning: (ae-forgotten-export) The symbol "QueryStoreValue" needs to be exported by the entry point index.d.ts
//
// (undocumented)
getQueryStore(): Record<string, QueryStoreValue>;
// (undocumented)
protected inFlightLinkObservables: Map<string, Map<string, Observable<FetchResult>>>;
// (undocumented)
link: ApolloLink;
// (undocumented)
markMutationOptimistic<TData, TVariables, TContext, TCache extends ApolloCache<any>>(optimisticResponse: any, mutation: {
mutationId: string;
document: DocumentNode;
variables?: TVariables;
fetchPolicy?: MutationFetchPolicy;
errorPolicy: ErrorPolicy;
context?: TContext;
updateQueries: UpdateQueries<TData>;
update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
keepRootFields?: boolean;
}): void;
// (undocumented)
markMutationResult<TData, TVariables, TContext, TCache extends ApolloCache<any>>(mutation: {
mutationId: string;
result: FetchResult<TData>;
document: DocumentNode;
variables?: TVariables;
fetchPolicy?: MutationFetchPolicy;
errorPolicy: ErrorPolicy;
context?: TContext;
updateQueries: UpdateQueries<TData>;
update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;
awaitRefetchQueries?: boolean;
refetchQueries?: InternalRefetchQueriesInclude;
removeOptimistic?: string;
onQueryUpdated?: OnQueryUpdated<any>;
keepRootFields?: boolean;
}, cache?: ApolloCache<TStore>): Promise<FetchResult<TData>>;
// (undocumented)
mutate<TData, TVariables extends OperationVariables, TContext extends Record<string, any>, TCache extends ApolloCache<any>>({ mutation, variables, optimisticResponse, updateQueries, refetchQueries, awaitRefetchQueries, update: updateWithProxyFn, onQueryUpdated, fetchPolicy, errorPolicy, keepRootFields, context, }: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<TData>>;
// (undocumented)
mutationStore?: {
[mutationId: string]: MutationStoreValue;
};
// (undocumented)
query<TData, TVars extends OperationVariables = OperationVariables>(options: QueryOptions<TVars, TData>, queryId?: string): Promise<ApolloQueryResult<TData>>;
// (undocumented)
reFetchObservableQueries(includeStandby?: boolean): Promise<ApolloQueryResult<any>[]>;
// Warning: (ae-forgotten-export) The symbol "InternalRefetchQueriesOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "InternalRefetchQueriesMap" needs to be exported by the entry point index.d.ts
//
// (undocumented)
refetchQueries<TResult>({ updateCache, include, optimistic, removeOptimistic, onQueryUpdated, }: InternalRefetchQueriesOptions<ApolloCache<TStore>, TResult>): InternalRefetchQueriesMap<TResult>;
// (undocumented)
removeQuery(queryId: string): void;
// (undocumented)
resetErrors(queryId: string): void;
// (undocumented)
setObservableQuery(observableQuery: ObservableQuery<any, any>): void;
// (undocumented)
readonly ssrMode: boolean;
// (undocumented)
startGraphQLSubscription<T = any>({ query, fetchPolicy, errorPolicy, variables, context, }: SubscriptionOptions): Observable<FetchResult<T>>;
// (undocumented)
stop(): void;
// (undocumented)
stopQuery(queryId: string): void;
// (undocumented)
stopQueryInStore(queryId: string): void;
// (undocumented)
transform(document: DocumentNode): DocumentNode;
// (undocumented)
watchQuery<T, TVariables extends OperationVariables = OperationVariables>(options: WatchQueryOptions<TVariables, T>): ObservableQuery<T, TVariables>;
}
// @public (undocumented)
interface QueryOptions<TVariables = OperationVariables, TData = any> {
// (undocumented)
canonizeResults?: boolean;
// (undocumented)
context?: DefaultContext;
// (undocumented)
errorPolicy?: ErrorPolicy;
// (undocumented)
fetchPolicy?: FetchPolicy;
// (undocumented)
notifyOnNetworkStatusChange?: boolean;
// (undocumented)
partialRefetch?: boolean;
// (undocumented)
pollInterval?: number;
// (undocumented)
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
// (undocumented)
returnPartialData?: boolean;
// (undocumented)
variables?: TVariables;
}
// Warning: (ae-forgotten-export) The symbol "ObservableQueryFields" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
interface QueryResult<TData = any, TVariables extends OperationVariables = OperationVariables> extends ObservableQueryFields<TData, TVariables> {
// (undocumented)
called: boolean;
// (undocumented)
client: ApolloClient<any>;
// (undocumented)
data: TData | undefined;
// (undocumented)
error?: ApolloError;
// (undocumented)
loading: boolean;
// (undocumented)
networkStatus: NetworkStatus;
// (undocumented)
observable: ObservableQuery<TData, TVariables>;
// (undocumented)
previousData?: TData;
}
// @public (undocumented)
type QueryStoreValue = Pick<QueryInfo, "variables" | "networkStatus" | "networkError" | "graphQLErrors">;
// @public (undocumented)
interface ReadFieldFunction {
// Warning: (ae-forgotten-export) The symbol "ReadFieldOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "SafeReadonly" needs to be exported by the entry point index.d.ts
//
// (undocumented)
<V = StoreValue>(options: ReadFieldOptions): SafeReadonly<V> | undefined;
// (undocumented)
<V = StoreValue>(fieldName: string, from?: StoreObject | Reference): SafeReadonly<V> | undefined;
}
// Warning: (ae-forgotten-export) The symbol "FieldSpecifier" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
interface ReadFieldOptions extends FieldSpecifier {
// (undocumented)
from?: StoreObject | Reference;
}
// @public (undocumented)
interface Reference {
// (undocumented)
readonly __ref: string;
}
// @public (undocumented)
type RefetchQueriesInclude = RefetchQueryDescriptor[] | RefetchQueriesIncludeShorthand;
// @public (undocumented)
type RefetchQueriesIncludeShorthand = "all" | "active";
// @public (undocumented)
interface RefetchQueriesOptions<TCache extends ApolloCache<any>, TResult> {
// (undocumented)
include?: RefetchQueriesInclude;
// (undocumented)
onQueryUpdated?: OnQueryUpdated<TResult> | null;
// (undocumented)
optimistic?: boolean;
// (undocumented)
updateCache?: (cache: TCache) => void;
}
// Warning: (ae-forgotten-export) The symbol "IsStrictlyAny" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type RefetchQueriesPromiseResults<TResult> = IsStrictlyAny<TResult> extends true ? any[] : TResult extends boolean ? ApolloQueryResult<any>[] : TResult extends PromiseLike<infer U> ? U[] : TResult[];
// Warning: (ae-forgotten-export) The symbol "RefetchQueriesPromiseResults" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
interface RefetchQueriesResult<TResult> extends Promise<RefetchQueriesPromiseResults<TResult>> {
// (undocumented)
queries: ObservableQuery<any>[];
// (undocumented)
results: InternalRefetchQueriesResult<TResult>[];
}
// @public (undocumented)
type RefetchQueryDescriptor = string | DocumentNode;
// @public (undocumented)
type RefetchWritePolicy = "merge" | "overwrite";
// @public (undocumented)
type RequestHandler = (operation: Operation, forward: NextLink) => Observable<FetchResult> | null;
// @public (undocumented)
type Resolver = (rootValue?: any, args?: any, context?: any, info?: {
field: FieldNode;
fragmentMap: FragmentMap;
}) => any;
// @public (undocumented)
interface Resolvers {
// (undocumented)
[key: string]: {
[field: string]: Resolver;
};
}
// @public (undocumented)
type SafeReadonly<T> = T extends object ? Readonly<T> : T;
// @public (undocumented)
type ServerError = Error & {
response: Response;
result: Record<string, any> | string;
statusCode: number;
};
// @public (undocumented)
type ServerParseError = Error & {
response: Response;
statusCode: number;
bodyText: string;
};
// @public (undocumented)
interface SingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> extends ExecutionResult<TData, TExtensions> {
// (undocumented)
context?: TContext;
// (undocumented)
data?: TData | null;
}
// @public (undocumented)
type Source<T> = MaybeAsync<Observable<T>>;
// @public (undocumented)
type StorageType = Record<string, any>;
// @public (undocumented)
interface StoreObject {
// (undocumented)
[storeFieldName: string]: StoreValue;
// (undocumented)
__typename?: string;
}
// Warning: (ae-forgotten-export) The symbol "AsStoreObject" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type StoreObjectValueMaybeReference<StoreVal> = StoreVal extends Array<Record<string, any>> ? StoreVal extends Array<infer Item> ? Item extends Record<string, any> ? ReadonlyArray<AsStoreObject<Item> | Reference> : never : never : StoreVal extends Record<string, any> ? AsStoreObject<StoreVal> | Reference : StoreVal;
// @public (undocumented)
type StoreValue = number | string | string[] | Reference | Reference[] | null | undefined | void | Object;
// @public (undocumented)
type SubscribeToMoreOptions<TData = any, TSubscriptionVariables = OperationVariables, TSubscriptionData = TData> = {
document: DocumentNode | TypedDocumentNode<TSubscriptionData, TSubscriptionVariables>;
variables?: TSubscriptionVariables;
updateQuery?: UpdateQueryFn<TData, TSubscriptionVariables, TSubscriptionData>;
onError?: (error: Error) => void;
context?: DefaultContext;
};
// @public (undocumented)
export function Subscription<TData = any, TVariables extends OperationVariables = OperationVariables>(props: SubscriptionComponentOptions<TData, TVariables>): JSX.Element | null;
// @public (undocumented)
export namespace Subscription {
var // (undocumented)
propTypes: PropTypes.InferProps<SubscriptionComponentOptions<any, any>>;
}
// @public (undocumented)
export interface Subscription<TData, TVariables extends OperationVariables> {
// (undocumented)
propTypes: PropTypes.InferProps<SubscriptionComponentOptions<TData, TVariables>>;
}
// Warning: (ae-forgotten-export) The symbol "BaseSubscriptionOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export interface SubscriptionComponentOptions<TData = any, TVariables extends OperationVariables = OperationVariables> extends BaseSubscriptionOptions<TData, TVariables> {
// (undocumented)
children?: null | ((result: SubscriptionResult<TData>) => JSX.Element | null);
// (undocumented)
subscription: DocumentNode | TypedDocumentNode<TData, TVariables>;
}
// @public (undocumented)
interface SubscriptionOptions<TVariables = OperationVariables, TData = any> {
// (undocumented)
context?: DefaultContext;
// (undocumented)
errorPolicy?: ErrorPolicy;
// (undocumented)
fetchPolicy?: FetchPolicy;
// (undocumented)
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
// (undocumented)
variables?: TVariables;
}
// @public (undocumented)
interface SubscriptionResult<TData = any, TVariables = any> {
// (undocumented)
data?: TData;
// (undocumented)
error?: ApolloError;
// (undocumented)
loading: boolean;
// (undocumented)
variables?: TVariables;
}
// @public (undocumented)
type ToReferenceFunction = (objOrIdOrRef: StoreObject | string | Reference, mergeIntoStore?: boolean) => Reference | undefined;
// @public (undocumented)
type Transaction<T> = (c: ApolloCache<T>) => void;
// @public (undocumented)
interface TransformCacheEntry {
// (undocumented)
asQuery: DocumentNode;
// (undocumented)
clientQuery: DocumentNode | null;
// (undocumented)
defaultVars: OperationVariables;
// (undocumented)
hasClientExports: boolean;
// (undocumented)
hasForcedResolvers: boolean;
// (undocumented)
hasNonreactiveDirective: boolean;
// (undocumented)
serverQuery: DocumentNode | null;
}
// @public (undocumented)
type TransformFn = (document: DocumentNode) => DocumentNode;
// @public (undocumented)
type UnionForAny<T> = T extends never ? "a" : 1;
// @public (undocumented)
type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
// @public (undocumented)
type UpdateQueries<TData> = MutationOptions<TData, any, any>["updateQueries"];
// @public (undocumented)
type UpdateQueryFn<TData = any, TSubscriptionVariables = OperationVariables, TSubscriptionData = TData> = (previousQueryResult: TData, options: {
subscriptionData: {
data: TSubscriptionData;
};
variables?: TSubscriptionVariables;
}) => TData;
// @public (undocumented)
interface UriFunction {
// (undocumented)
(operation: Operation): string;
}
// @public (undocumented)
type WatchQueryFetchPolicy = FetchPolicy | "cache-and-network";
// @public (undocumented)
interface WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = any> extends Omit<QueryOptions<TVariables, TData>, "fetchPolicy"> {
// (undocumented)
fetchPolicy?: WatchQueryFetchPolicy;
// (undocumented)
initialFetchPolicy?: WatchQueryFetchPolicy;
// Warning: (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
//
// (undocumented)
nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TVariables, TData>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
// Warning: (ae-forgotten-export) The symbol "RefetchWritePolicy" needs to be exported by the entry point index.d.ts
//
// (undocumented)
refetchWritePolicy?: RefetchWritePolicy;
}
// Warnings were encountered during analysis:
//
// src/cache/core/types/DataProxy.ts:141:5 - (ae-forgotten-export) The symbol "MissingFieldError" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:96:3 - (ae-forgotten-export) The symbol "ReadFieldFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:97:3 - (ae-forgotten-export) The symbol "CanReadFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:98:3 - (ae-forgotten-export) The symbol "isReference" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:99:3 - (ae-forgotten-export) The symbol "ToReferenceFunction" needs to be exported by the entry point index.d.ts
// src/cache/core/types/common.ts:100:3 - (ae-forgotten-export) The symbol "StorageType" needs to be exported by the entry point index.d.ts
// src/core/ApolloClient.ts:47:3 - (ae-forgotten-export) The symbol "UriFunction" needs to be exported by the entry point index.d.ts
// src/core/LocalState.ts:46:5 - (ae-forgotten-export) The symbol "FragmentMap" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:113:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:114:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:117:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:150:5 - (ae-forgotten-export) The symbol "LocalState" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:379:7 - (ae-forgotten-export) The symbol "UpdateQueries" needs to be exported by the entry point index.d.ts
// src/core/types.ts:158:3 - (ae-forgotten-export) The symbol "ApolloError" needs to be exported by the entry point index.d.ts
// src/core/types.ts:160:3 - (ae-forgotten-export) The symbol "NetworkStatus" needs to be exported by the entry point index.d.ts
// src/core/types.ts:178:3 - (ae-forgotten-export) The symbol "MutationQueryReducer" needs to be exported by the entry point index.d.ts
// src/core/types.ts:205:5 - (ae-forgotten-export) The symbol "Resolver" needs to be exported by the entry point index.d.ts
// src/core/watchQueryOptions.ts:191:3 - (ae-forgotten-export) The symbol "UpdateQueryFn" needs to be exported by the entry point index.d.ts
// src/utilities/graphql/DocumentTransform.ts:122:7 - (ae-forgotten-export) The symbol "DocumentTransformCacheKey" needs to be exported by the entry point index.d.ts
// (No @packageDocumentation comment for this package)