Skip to content

Commit 2650e76

Browse files
jerelmillerjerelmiller
committed
Update api report
1 parent bfcfc90 commit 2650e76

6 files changed

Lines changed: 73 additions & 91 deletions

File tree

‎.api-reports/api-report-cache.api.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import type { StoreObject } from '@apollo/client/utilities';
3030
import type { StoreValue } from '@apollo/client/utilities';
3131
import { Trie } from '@wry/trie';
3232
import type { TypedDocumentNode } from '@apollo/client';
33-
import type { Unmask } from '@apollo/client/masking';
33+
import type { Unmasked } from '@apollo/client/masking';
3434

3535
// Warning: (ae-forgotten-export) The symbol "StoreObjectValueMaybeReference" needs to be exported by the entry point index.d.ts
3636
//
@@ -80,14 +80,14 @@ export abstract class ApolloCache {
8080
// (undocumented)
8181
abstract performTransaction(transaction: Transaction, optimisticId?: string | null): void;
8282
// (undocumented)
83-
abstract read<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache_2.ReadOptions<TData, TVariables>): Unmask<TData> | null;
84-
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ fragment, variables, fragmentName, id, optimistic, returnPartialData, }: Cache_2.ReadFragmentOptions<TData, TVariables>): Unmask<TData> | null;
83+
abstract read<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache_2.ReadOptions<TData, TVariables>): Unmasked<TData> | null;
84+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ fragment, variables, fragmentName, id, optimistic, returnPartialData, }: Cache_2.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
8585
// (undocumented)
8686
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.ReadFragmentOptions<TData, TVariables>,
87-
optimistic: boolean): Unmask<TData> | null;
88-
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ query, variables, id, optimistic, returnPartialData, }: Cache_2.ReadQueryOptions<TData, TVariables>): Unmask<TData> | null;
87+
optimistic: boolean): Unmasked<TData> | null;
88+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ query, variables, id, optimistic, returnPartialData, }: Cache_2.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
8989
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.ReadQueryOptions<TData, TVariables>,
90-
optimistic: boolean): Unmask<TData> | null;
90+
optimistic: boolean): Unmasked<TData> | null;
9191
// (undocumented)
9292
recordOptimisticTransaction(transaction: Transaction, optimisticId: string): void;
9393
// (undocumented)
@@ -100,12 +100,12 @@ export abstract class ApolloCache {
100100
// (undocumented)
101101
transformForLink(document: DocumentNode): DocumentNode;
102102
// (undocumented)
103-
updateFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.UpdateFragmentOptions<TData, TVariables>, update: (data: Unmask<TData> | null) => Unmask<TData> | null | void): Unmask<TData> | null;
103+
updateFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.UpdateFragmentOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
104104
// (undocumented)
105-
updateQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: Unmask<TData> | null) => Unmask<TData> | null | void): Unmask<TData> | null;
105+
updateQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
106106
// (undocumented)
107107
abstract watch<TData = unknown, TVariables extends OperationVariables = OperationVariables>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
108-
watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables>): Observable<ApolloCache.WatchFragmentResult<Unmask<TData>>>;
108+
watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables>): Observable<ApolloCache.WatchFragmentResult<Unmasked<TData>>>;
109109
// (undocumented)
110110
abstract write<TData = unknown, TVariables extends OperationVariables = OperationVariables>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
111111
writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ data, fragment, fragmentName, variables, overwrite, id, broadcast, }: Cache_2.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
@@ -230,7 +230,7 @@ namespace Cache_2 {
230230
// (undocumented)
231231
interface WriteFragmentOptions<TData, TVariables extends OperationVariables> {
232232
broadcast?: boolean;
233-
data: Unmask<TData>;
233+
data: Unmasked<TData>;
234234
fragment: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
235235
fragmentName?: string;
236236
id?: string;
@@ -245,13 +245,13 @@ namespace Cache_2 {
245245
overwrite?: boolean;
246246
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
247247
// (undocumented)
248-
result: Unmask<TData>;
248+
result: Unmasked<TData>;
249249
variables?: TVariables;
250250
}
251251
// (undocumented)
252252
interface WriteQueryOptions<TData, TVariables extends OperationVariables> {
253253
broadcast?: boolean;
254-
data: Unmask<TData>;
254+
data: Unmasked<TData>;
255255
id?: string;
256256
overwrite?: boolean;
257257
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;

‎.api-reports/api-report-core.api.md‎

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ import { LinkError } from '@apollo/client/errors';
5858
import type { LocalState } from '@apollo/client/local-state';
5959
import { LocalStateError } from '@apollo/client/errors';
6060
import { makeVar } from '@apollo/client/cache';
61-
import { Mask } from '@apollo/client/masking';
6261
import { MaybeMasked } from '@apollo/client/masking';
6362
import { MergeInfo } from '@apollo/client/cache';
6463
import { MergeTree } from '@apollo/client/cache';
@@ -100,7 +99,6 @@ import { TypedDocumentNode } from '@graphql-typed-document-node/core';
10099
import { TypePolicies } from '@apollo/client/cache';
101100
import { TypePolicy } from '@apollo/client/cache';
102101
import { UnconventionalError } from '@apollo/client/errors';
103-
import { Unmask } from '@apollo/client/masking';
104102
import { Unmasked } from '@apollo/client/masking';
105103
import type { VariablesOption } from '@apollo/client/utilities/internal';
106104
import { WatchFragmentOptions } from '@apollo/client/cache';
@@ -136,7 +134,7 @@ export namespace ApolloClient {
136134
// (undocumented)
137135
export interface WriteQueryOptions<TData, TVariables extends OperationVariables> {
138136
broadcast?: boolean;
139-
data: Unmask<TData>;
137+
data: Unmasked<TData>;
140138
id?: string;
141139
overwrite?: boolean;
142140
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
@@ -147,7 +145,7 @@ export namespace ApolloClient {
147145
// (undocumented)
148146
export interface WriteFragmentOptions<TData, TVariables extends OperationVariables> {
149147
broadcast?: boolean;
150-
data: Unmask<TData>;
148+
data: Unmasked<TData>;
151149
fragment: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
152150
fragmentName?: string;
153151
id?: string;
@@ -198,11 +196,11 @@ export namespace ApolloClient {
198196
}
199197
// (undocumented)
200198
export type MutateOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = {
201-
optimisticResponse?: Unmask<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
199+
optimisticResponse?: Unmasked<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
202200
IGNORE: IgnoreModifier;
203-
}) => Unmask<NoInfer<TData>> | IgnoreModifier);
201+
}) => Unmasked<NoInfer<TData>> | IgnoreModifier);
204202
updateQueries?: MutationQueryReducersMap<TData>;
205-
refetchQueries?: ((result: NormalizedExecutionResult<Unmask<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
203+
refetchQueries?: ((result: NormalizedExecutionResult<Unmasked<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
206204
awaitRefetchQueries?: boolean;
207205
update?: MutationUpdaterFunction<TData, TVariables, TCache>;
208206
onQueryUpdated?: OnQueryUpdated<any>;
@@ -343,13 +341,13 @@ export class ApolloClient {
343341
query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.QueryOptions<TData, TVariables>): Promise<ApolloClient.QueryResult<MaybeMasked<TData>>>;
344342
// (undocumented)
345343
queryDeduplication: boolean;
346-
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>): Unmask<TData> | null;
344+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
347345
// @deprecated
348-
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>, optimistic: boolean): Unmask<TData> | null;
349-
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>): Unmask<TData> | null;
346+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>, optimistic: boolean): Unmasked<TData> | null;
347+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
350348
// @deprecated
351349
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>,
352-
optimistic: boolean): Unmask<TData> | null;
350+
optimistic: boolean): Unmasked<TData> | null;
353351
// @deprecated
354352
reFetchObservableQueries: (includeStandby?: boolean) => Promise<ApolloClient.QueryResult<any>[]>;
355353
refetchObservableQueries(includeStandby?: boolean): Promise<ApolloClient.QueryResult<any>[]>;
@@ -545,8 +543,6 @@ export { LocalStateError }
545543

546544
export { makeVar }
547545

548-
export { Mask }
549-
550546
// @public (undocumented)
551547
interface MaskFragmentOptions<TData> {
552548
// (undocumented)
@@ -587,7 +583,7 @@ export type MutationOptions<TData = unknown, TVariables extends OperationVariabl
587583

588584
// @public (undocumented)
589585
export type MutationQueryReducer<T> = (previousResult: Record<string, any>, options: {
590-
mutationResult: NormalizedExecutionResult<Unmask<T>>;
586+
mutationResult: NormalizedExecutionResult<Unmasked<T>>;
591587
queryName: string | undefined;
592588
queryVariables: Record<string, any>;
593589
}) => Record<string, any>;
@@ -612,7 +608,7 @@ interface MutationStoreValue {
612608
}
613609

614610
// @public (undocumented)
615-
export type MutationUpdaterFunction<TData, TVariables extends OperationVariables, TCache extends ApolloCache> = (cache: TCache, result: FormattedExecutionResult<Unmask<TData>>, options: {
611+
export type MutationUpdaterFunction<TData, TVariables extends OperationVariables, TCache extends ApolloCache> = (cache: TCache, result: FormattedExecutionResult<Unmasked<TData>>, options: {
616612
context?: DefaultContext;
617613
variables?: TVariables;
618614
}) => void;
@@ -683,10 +679,10 @@ export namespace ObservableQuery {
683679
variables?: Partial<NoInfer<TFetchVars>>;
684680
errorPolicy?: ErrorPolicy;
685681
context?: DefaultContext;
686-
updateQuery?: (previousQueryResult: Unmask<TData>, options: {
687-
fetchMoreResult: Unmask<TFetchData>;
682+
updateQuery?: (previousQueryResult: Unmasked<TData>, options: {
683+
fetchMoreResult: Unmasked<TFetchData>;
688684
variables: TFetchVars;
689-
}) => Unmask<TData>;
685+
}) => Unmasked<TData>;
690686
};
691687
// (undocumented)
692688
export type Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
@@ -1049,11 +1045,11 @@ export type SubscribeToMoreOptions<TData = unknown, TSubscriptionVariables exten
10491045
// @public (undocumented)
10501046
export type SubscribeToMoreUpdateQueryFn<TData = unknown, TVariables extends OperationVariables = OperationVariables, TSubscriptionData = TData> = {
10511047
(
1052-
unsafePreviousData: DeepPartial<Unmask<TData>>, options: UpdateQueryOptions<TData, TVariables> & {
1048+
unsafePreviousData: DeepPartial<Unmasked<TData>>, options: UpdateQueryOptions<TData, TVariables> & {
10531049
subscriptionData: {
1054-
data: Unmask<TSubscriptionData>;
1050+
data: Unmasked<TSubscriptionData>;
10551051
};
1056-
}): Unmask<TData> | void;
1052+
}): Unmasked<TData> | void;
10571053
};
10581054

10591055
// @public
@@ -1104,26 +1100,24 @@ export { TypePolicy }
11041100

11051101
export { UnconventionalError }
11061102

1107-
export { Unmask }
1108-
11091103
export { Unmasked }
11101104

11111105
// @public (undocumented)
11121106
export interface UpdateQueryMapFn<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
11131107
// (undocumented)
11141108
(
1115-
unsafePreviousData: DeepPartial<Unmask<TData>>, options: UpdateQueryOptions<TData, TVariables>): Unmask<TData> | void;
1109+
unsafePreviousData: DeepPartial<Unmasked<TData>>, options: UpdateQueryOptions<TData, TVariables>): Unmasked<TData> | void;
11161110
}
11171111

11181112
// @public (undocumented)
11191113
export type UpdateQueryOptions<TData, TVariables extends OperationVariables> = {
11201114
variables?: TVariables;
11211115
} & ({
11221116
complete: true;
1123-
previousData: Unmask<TData>;
1117+
previousData: Unmasked<TData>;
11241118
} | {
11251119
complete: false;
1126-
previousData: DeepPartial<Unmask<TData>> | undefined;
1120+
previousData: DeepPartial<Unmasked<TData>> | undefined;
11271121
});
11281122

11291123
// @public (undocumented)

‎.api-reports/api-report-masking.api.md‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,17 +121,14 @@ export namespace GraphQLCodegenDataMasking {
121121
export type Unmask<TData> = true extends IsAny<TData> ? TData : TData extends object ? true extends ContainsFragmentsRefs<TData> ? UnwrapFragmentRefs<RemoveFragmentName<TData>> : TData : TData;
122122
}
123123

124-
// @public
125-
export type Mask<TData> = ApplyHKTImplementationWithDefault<TypeOverrides, "Mask", PreserveTypes.Implementation, TData>;
126-
127124
// @internal @deprecated (undocumented)
128125
export function maskFragment<TData = unknown>(data: TData, document: TypedDocumentNode<TData> | DocumentNode, cache: ApolloCache, fragmentName?: string): TData;
129126

130127
// @internal @deprecated (undocumented)
131128
export function maskOperation<TData = unknown>(data: TData, document: DocumentNode | TypedDocumentNode<TData>, cache: ApolloCache): TData;
132129

133130
// @public
134-
export type MaybeMasked<TData> = Mask<TData>;
131+
export type MaybeMasked<TData> = ApplyHKTImplementationWithDefault<TypeOverrides, "Mask", PreserveTypes.Implementation, TData>;
135132

136133
// Warning: (ae-forgotten-export) The symbol "CombineIntersection" needs to be exported by the entry point index.d.ts
137134
//
@@ -219,10 +216,7 @@ type takeOneFromUnion<T> = unionToIntersection<T extends T ? (x: T) => 0 : never
219216
type unionToIntersection<T> = (T extends unknown ? (x: T) => unknown : never) extends ((x: infer U) => unknown) ? U : never;
220217

221218
// @public
222-
export type Unmask<TData> = ApplyHKTImplementationWithDefault<TypeOverrides, "Unmask", PreserveTypes.Implementation, TData>;
223-
224-
// @public @deprecated (undocumented)
225-
export type Unmasked<TData> = Unmask<TData>;
219+
export type Unmasked<TData> = ApplyHKTImplementationWithDefault<TypeOverrides, "Unmask", PreserveTypes.Implementation, TData>;
226220

227221
// @public (undocumented)
228222
type UnwrapFragmentRefs<TData> = true extends IsAny<TData> ? TData : TData extends any ? TData extends Primitive ? TData : string extends keyof TData ? TData : keyof TData extends never ? TData : TData extends {

‎.api-reports/api-report-react.api.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import type { StoreObject as StoreObject_2 } from '@apollo/client';
4848
import type { SubscribeToMoreFunction } from '@apollo/client';
4949
import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
5050
import type { TypedDocumentNode as TypedDocumentNode_2 } from '@apollo/client';
51-
import type { Unmask } from '@apollo/client';
51+
import type { Unmasked } from '@apollo/client';
5252
import type { UpdateQueryMapFn } from '@apollo/client';
5353
import type { VariablesOption } from '@apollo/client/utilities/internal';
5454
import type { WatchQueryFetchPolicy } from '@apollo/client';
@@ -645,10 +645,10 @@ export namespace useMutation {
645645
onCompleted?: (data: MaybeMasked<TData>, clientOptions?: Options<TData, TVariables, TCache>) => void;
646646
onError?: (error: ErrorLike, clientOptions?: Options<TData, TVariables, TCache>) => void;
647647
onQueryUpdated?: OnQueryUpdated<any>;
648-
optimisticResponse?: Unmask<NoInfer_2<TData>> | ((vars: TVariables, { IGNORE }: {
648+
optimisticResponse?: Unmasked<NoInfer_2<TData>> | ((vars: TVariables, { IGNORE }: {
649649
IGNORE: IgnoreModifier;
650-
}) => Unmask<NoInfer_2<TData>> | IgnoreModifier);
651-
refetchQueries?: ((result: NormalizedExecutionResult<Unmask<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
650+
}) => Unmasked<NoInfer_2<TData>> | IgnoreModifier);
651+
refetchQueries?: ((result: NormalizedExecutionResult<Unmasked<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
652652
update?: MutationUpdaterFunction<TData, TVariables, TCache>;
653653
updateQueries?: MutationQueryReducersMap<TData>;
654654
variables?: TConfiguredVariables;

‎.api-reports/api-report-testing.api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { ApolloLink } from '@apollo/client/link';
88
import type { DocumentNode } from 'graphql';
99
import { Observable } from 'rxjs';
1010
import type { OperationVariables } from '@apollo/client';
11-
import type { Unmask } from '@apollo/client/masking';
11+
import type { Unmasked } from '@apollo/client/masking';
1212

1313
// @internal @deprecated (undocumented)
1414
type CovariantUnaryFunction<out Arg, out Ret> = {
@@ -52,7 +52,7 @@ export namespace MockLink {
5252
// (undocumented)
5353
request: MockedRequest<TVariables>;
5454
// (undocumented)
55-
result?: ApolloLink.Result<Unmask<TData>> | ResultFunction<ApolloLink.Result<Unmask<TData>>, TVariables>;
55+
result?: ApolloLink.Result<Unmasked<TData>> | ResultFunction<ApolloLink.Result<Unmasked<TData>>, TVariables>;
5656
}
5757
// (undocumented)
5858
export interface Options {

0 commit comments

Comments
 (0)