Introduce a MaskedDocumentNode type and handle masking types (#12064)

Author: jerelmiller

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

@@ -45,12 +45,14 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
  modify<Entity extends Record<string, any> = Record<string, any>>(options: Cache_2.ModifyOptions<Entity>): boolean;
  // (undocumented)
  abstract performTransaction(transaction: Transaction<TSerialized>, optimisticId?: string | null): void;
+ // Warning: (ae-forgotten-export) The symbol "Unmasked" 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;
+ abstract read<TData = any, TVariables = any>(query: Cache_2.ReadOptions<TVariables, TData>): Unmasked<TData> | null;
  // (undocumented)
- readFragment<FragmentType, TVariables = any>(options: Cache_2.ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): FragmentType | null;
+ readFragment<FragmentType, TVariables = any>(options: Cache_2.ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): Unmasked<FragmentType> | null;
  // (undocumented)
- readQuery<QueryType, TVariables = any>(options: Cache_2.ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): QueryType | null;
+ readQuery<QueryType, TVariables = any>(options: Cache_2.ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): Unmasked<QueryType> | null;
  // (undocumented)
  recordOptimisticTransaction(transaction: Transaction<TSerialized>, optimisticId: string): void;
  // (undocumented)
@@ -63,9 +65,9 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
  // (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;
+ updateFragment<TData = any, TVariables = any>(options: Cache_2.UpdateFragmentOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
  // (undocumented)
- updateQuery<TData = any, TVariables = any>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: TData | null) => TData | null | void): TData | null;
+ updateQuery<TData = any, TVariables = any>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
  // (undocumented)
  abstract watch<TData = any, TVariables = any>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
  // Warning: (ae-forgotten-export) The symbol "OperationVariables" needs to be exported by the entry point index.d.ts
@@ -170,7 +172,7 @@ namespace Cache_2 {
  // (undocumented)
  dataId?: string;
  // (undocumented)
- result: TResult;
+ result: Unmasked<TResult>;
  }
  import DiffResult = DataProxy.DiffResult;
  import ReadQueryOptions = DataProxy.ReadQueryOptions;
@@ -214,9 +216,22 @@ export const canonicalStringify: ((value: any) => string) & {
 // @public (undocumented)
 type CanReadFunction = (value: StoreValue) => boolean;
 
+// Warning: (ae-forgotten-export) The symbol "UnionToIntersection" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "UnwrapFragmentRefs" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "RemoveFragmentName" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+type CombineFragmentRefs<FragmentRefs extends Record<string, any>> = UnionToIntersection<{
+ [K in keyof FragmentRefs]-?: UnwrapFragmentRefs<RemoveFragmentName<FragmentRefs[K]>>;
+}[keyof FragmentRefs]>;
+
 // @public (undocumented)
 export function createFragmentRegistry(...fragments: DocumentNode[]): FragmentRegistryAPI;
 
+// @public (undocumented)
+interface DataMasking {
+}
+
 // @public (undocumented)
 export namespace DataProxy {
  // (undocumented)
@@ -265,7 +280,7 @@ export namespace DataProxy {
  // (undocumented)
  export interface WriteOptions<TData> {
  broadcast?: boolean;
- data: TData;
+ data: Unmasked<TData>;
  overwrite?: boolean;
  }
  // (undocumented)
@@ -275,8 +290,8 @@ export namespace DataProxy {
 
 // @public
 export interface DataProxy {
- readFragment<FragmentType, TVariables = any>(options: DataProxy.ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): FragmentType | null;
- readQuery<QueryType, TVariables = any>(options: DataProxy.ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): QueryType | null;
+ readFragment<FragmentType, TVariables = any>(options: DataProxy.ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): Unmasked<FragmentType> | null;
+ readQuery<QueryType, TVariables = any>(options: DataProxy.ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): Unmasked<QueryType> | null;
  writeFragment<TData = any, TVariables = any>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
  writeQuery<TData = any, TVariables = any>(options: DataProxy.WriteQueryOptions<TData, TVariables>): Reference | undefined;
 }
@@ -521,6 +536,17 @@ export interface FragmentRegistryAPI {
  transform<D extends DocumentNode>(document: D): D;
 }
 
+// @public (undocumented)
+type FragmentType<TData> = [
+TData
+] extends [{
+ " $fragmentName"?: infer TKey;
+}] ? TKey extends string ? {
+ " $fragmentRefs"?: {
+ [key in TKey]: TData;
+ };
+} : never : never;
+
 // @internal
 const getApolloCacheMemoryInternals: (() => {
  cache: {
@@ -704,6 +730,17 @@ export function makeReference(id: string): Reference;
 // @public (undocumented)
 export function makeVar<T>(value: T): ReactiveVar<T>;
 
+// Warning: (ae-forgotten-export) The symbol "Prettify" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "RemoveMaskedMarker" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "DataMasking" needs to be exported by the entry point index.d.ts
+//
+// @public
+type MaybeMasked<TData> = TData extends {
+ __masked?: true;
+} ? Prettify<RemoveMaskedMarker<TData>> : DataMasking extends {
+ enabled: true;
+} ? TData : Unmasked<TData>;
+
 // @public (undocumented)
 export interface MergeInfo {
  // (undocumented)
@@ -769,6 +806,9 @@ export type Modifiers<T extends Record<string, any> = Record<string, unknown>> =
  [FieldName in keyof T]: Modifier<StoreObjectValueMaybeReference<Exclude<T[FieldName], undefined>>>;
 }>;
 
+// @public
+type NoInfer_2<T> = [T][T extends any ? 0 : never];
+
 // @public
 export interface NormalizedCache {
  // (undocumented)
@@ -867,6 +907,11 @@ export type PossibleTypesMap = {
  [supertype: string]: string[];
 };
 
+// @public (undocumented)
+type Prettify<T> = {
+ [K in keyof T]: T[K];
+} & {};
+
 // @public (undocumented)
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 
@@ -928,6 +973,12 @@ export interface Reference {
  readonly __ref: string;
 }
 
+// @public (undocumented)
+type RemoveFragmentName<T> = T extends any ? Omit<T, " $fragmentName"> : T;
+
+// @public (undocumented)
+type RemoveMaskedMarker<T> = Omit<T, "__masked">;
+
 // @public (undocumented)
 type SafeReadonly<T> = T extends object ? Readonly<T> : T;
 
@@ -984,22 +1035,41 @@ export type TypePolicy = {
  };
 };
 
+// @public (undocumented)
+type UnionToIntersection<U> = (U extends any ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
+
+// @public
+type Unmasked<TData> = TData extends object ? UnwrapFragmentRefs<RemoveMaskedMarker<RemoveFragmentName<TData>>> : TData;
+
+// Warning: (ae-forgotten-export) The symbol "CombineFragmentRefs" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+type UnwrapFragmentRefs<TData> = string extends keyof NonNullable<TData> ? TData : " $fragmentRefs" extends keyof NonNullable<TData> ? TData extends {
+ " $fragmentRefs"?: infer FragmentRefs extends object;
+} ? Prettify<{
+ [K in keyof TData as K extends " $fragmentRefs" ? never : K]: UnwrapFragmentRefs<TData[K]>;
+} & CombineFragmentRefs<FragmentRefs>> : never : TData extends object ? {
+ [K in keyof TData]: UnwrapFragmentRefs<TData[K]>;
+} : TData;
+
 // @public
 export interface WatchFragmentOptions<TData, TVars> {
  fragment: DocumentNode | TypedDocumentNode<TData, TVars>;
  fragmentName?: string;
- from: StoreObject | Reference | string;
+ // Warning: (ae-forgotten-export) The symbol "FragmentType" needs to be exported by the entry point index.d.ts
+ // Warning: (ae-forgotten-export) The symbol "NoInfer_2" needs to be exported by the entry point index.d.ts
+ from: StoreObject | Reference | FragmentType<NoInfer_2<TData>> | string;
  optimistic?: boolean;
  variables?: TVars;
 }
 
 // @public
 export type WatchFragmentResult<TData> = {
- data: TData;
+ data: MaybeMasked<TData>;
  complete: true;
  missing?: never;
 } | {
- data: DeepPartial<TData>;
+ data: DeepPartial<MaybeMasked<TData>>;
  complete: false;
  missing: MissingTree;
 };
@@ -1038,6 +1108,7 @@ interface WriteContext extends ReadMergeModifyContext {
 
 // Warnings were encountered during analysis:
 //
+// src/cache/core/cache.ts:92:7 - (ae-forgotten-export) The symbol "MaybeMasked" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:92:3 - (ae-forgotten-export) The symbol "FragmentMap" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:161:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
 // src/cache/inmemory/policies.ts:161:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts