@isograph/react 0.0.0-main-e524ebe1 → 0.0.0-main-a8d365e0

package/src/core/makeNetworkRequest.ts

@@ -8,7 +8,11 @@ import {
   type NormalizationAst,
   type NormalizationAstLoader,
 } from './entrypoint';
-import { ExtractParameters, type FragmentReference } from './FragmentReference';
+import {
+  ExtractParameters,
+  type FragmentReference,
+  type UnknownTReadFromStore,
+} from './FragmentReference';
 import {
   garbageCollectEnvironment,
   RetainedQuery,
@@ -24,17 +28,12 @@ import {
   wrapResolvedValue,
 } from './PromiseWrapper';
 import { readButDoNotEvaluate } from './read';
-import type { StartUpdate } from './reader';
 import { startUpdate } from './startUpdate';
 
 let networkRequestId = 0;
 
 export function maybeMakeNetworkRequest<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
   TNormalizationAst extends NormalizationAst | NormalizationAstLoader,
 >(
@@ -99,11 +98,7 @@ function loadNormalizationAst(
 }
 
 export function makeNetworkRequest<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
   TNormalizationAst extends NormalizationAst | NormalizationAstLoader,
 >(
@@ -241,11 +236,7 @@ type NetworkRequestStatus =
     };
 
 function readDataForOnComplete<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
   TNormalizationAst extends NormalizationAst | NormalizationAstLoader,
 >(

package/src/core/read.ts

@@ -16,6 +16,7 @@ import {
   ExtractParameters,
   FragmentReference,
   Variables,
+  type UnknownTReadFromStore,
 } from './FragmentReference';
 import {
   assertLink,
@@ -33,7 +34,7 @@ import {
   wrapPromise,
   wrapResolvedValue,
 } from './PromiseWrapper';
-import { ReaderAst, type StartUpdate } from './reader';
+import { ReaderAst } from './reader';
 import { startUpdate } from './startUpdate';
 import { Arguments } from './util';
 
@@ -43,11 +44,7 @@ export type WithEncounteredRecords<T> = {
 };
 
 export function readButDoNotEvaluate<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
 >(
   environment: IsographEnvironment,
   fragmentReference: FragmentReference<TReadFromStore, unknown>,

package/src/core/reader.ts

@@ -11,6 +11,7 @@ import {
   ExtractParameters,
   FragmentReference,
   type ExtractStartUpdate,
+  type UnknownTReadFromStore,
 } from './FragmentReference';
 import {
   ComponentOrFieldName,
@@ -20,11 +21,7 @@ import {
 import { Arguments } from './util';
 
 export type TopLevelReaderArtifact<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
   TComponentProps extends Record<PropertyKey, never>,
 > =
@@ -32,11 +29,7 @@ export type TopLevelReaderArtifact<
   | ComponentReaderArtifact<TReadFromStore, TComponentProps>;
 
 export type EagerReaderArtifact<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
 > = {
   readonly kind: 'EagerReaderArtifact';
@@ -48,11 +41,7 @@ export type EagerReaderArtifact<
 };
 
 export type ComponentReaderArtifact<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TComponentProps extends Record<string, unknown> = Record<PropertyKey, never>,
 > = {
   readonly kind: 'ComponentReaderArtifact';
@@ -66,11 +55,7 @@ export type ComponentReaderArtifact<
 };
 
 export type ResolverFirstParameter<
-  TReadFromStore extends {
-    data: object;
-    parameters: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
 > = {
   data: ExtractData<TReadFromStore>;
   parameters: ExtractParameters<TReadFromStore>;
@@ -167,7 +152,7 @@ export type ReaderLoadableField = {
     | IsographEntrypointLoader<any, any>;
 };
 
-type StableId = string;
+export type StableId = string;
 /// Why is LoadableField the way it is? Let's work backwards.
 ///
 /// We ultimately need a stable id (for deduplication) and a way to produce a
@@ -178,11 +163,7 @@ type StableId = string;
 /// except to stringify the args or whatnot. Calling the factory can be
 /// expensive. For example, doing so will probably trigger a network request.
 export type LoadableField<
-  TReadFromStore extends {
-    data: object;
-    parameters: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TResult,
   TArgs = ExtractParameters<TReadFromStore>,
 > = (

package/src/core/startUpdate.ts

@@ -1,14 +1,11 @@
-import type { ExtractData, ExtractStartUpdate } from './FragmentReference';
+import type {
+  ExtractData,
+  ExtractStartUpdate,
+  UnknownTReadFromStore,
+} from './FragmentReference';
 import type { IsographEnvironment } from './IsographEnvironment';
-import type { StartUpdate } from './reader';
 
-export function startUpdate<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
->(
+export function startUpdate<TReadFromStore extends UnknownTReadFromStore>(
   _environment: IsographEnvironment,
   _data: ExtractData<TReadFromStore>,
 ): ExtractStartUpdate<TReadFromStore> {

package/src/index.ts

@@ -3,6 +3,7 @@ export {
   unretainQuery,
   type RetainedQuery,
   garbageCollectEnvironment,
+  type DidUnretainSomeQuery,
 } from './core/garbageCollection';
 export {
   type PromiseWrapper,
@@ -10,8 +11,20 @@ export {
   getPromiseState,
   wrapResolvedValue,
   wrapPromise,
+  type PromiseState,
+  type Result,
+  type AnyError,
+  type NotSet,
+  NOT_SET,
 } from './core/PromiseWrapper';
-export { subscribe, normalizeData } from './core/cache';
+export {
+  subscribe,
+  normalizeData,
+  type NetworkResponseObject,
+  type NetworkResponseValue,
+  type NetworkResponseScalarValue,
+  type EncounteredIds,
+} from './core/cache';
 export { makeNetworkRequest } from './core/makeNetworkRequest';
 export {
   ROOT_ID,
@@ -20,10 +33,21 @@ export {
   type IsographEnvironment,
   type IsographNetworkFunction,
   type IsographStore,
+  type MissingFieldHandler,
   type Link,
   type StoreRecord,
+  type CacheMap,
   createIsographEnvironment,
   createIsographStore,
+  type ComponentCache,
+  type Subscriptions,
+  type Subscription,
+  type TypeName,
+  type FragmentSubscription,
+  type AnyChangesToRecordSubscription,
+  type AnyRecordSubscription,
+  type ComponentOrFieldName,
+  type StringifiedArgs,
 } from './core/IsographEnvironment';
 export {
   type EagerReaderArtifact,
@@ -36,11 +60,17 @@ export {
   type ReaderScalarField,
   type TopLevelReaderArtifact,
   type LoadableField,
+  type StableId,
   type ResolverFirstParameter,
+  type ReaderImperativelyLoadedField,
+  type ReaderLoadableField,
+  type ReaderLinkeField,
+  type StartUpdate,
 } from './core/reader';
 export {
   type NormalizationAst,
   type NormalizationAstNode,
+  type NormalizationAstNodes,
   type NormalizationAstLoader,
   type NormalizationLinkedField,
   type NormalizationScalarField,
@@ -52,10 +82,15 @@ export {
   type ExtractReadFromStore,
   type ExtractResolverResult,
   type NetworkRequestInfo,
+  type NormalizationInlineFragment,
+  type ReaderWithRefetchQueries,
+  type IsographEntrypointLoader,
 } from './core/entrypoint';
 export {
   readButDoNotEvaluate,
+  type WithEncounteredRecords,
   type NetworkRequestReaderOptions,
+  type ReadDataResult,
 } from './core/read';
 export {
   type ExtractSecondParam,
@@ -70,23 +105,40 @@ export {
   type Variables,
   type ExtractParameters,
   type ExtractData,
+  type UnknownTReadFromStore,
   stableIdForFragmentReference,
+  type ExtractStartUpdate,
+  type VariableValue,
 } from './core/FragmentReference';
 export {
   type LogMessage,
   type LogFunction,
+  type WrappedLogFunction,
   logMessage,
   registerLogger,
 } from './core/logging';
-export { check, CheckResult, FetchOptions, ShouldFetch } from './core/check';
+export {
+  check,
+  type CheckResult,
+  type FetchOptions,
+  type RequiredFetchOptions,
+  type ShouldFetch,
+  type RequiredShouldFetch,
+} from './core/check';
 
 export {
   IsographEnvironmentProvider,
   useIsographEnvironment,
   type IsographEnvironmentProviderProps,
 } from './react/IsographEnvironmentProvider';
-export { useImperativeReference } from './react/useImperativeReference';
-export { FragmentReader } from './react/FragmentReader';
+export {
+  useImperativeReference,
+  type UseImperativeReferenceResult,
+} from './react/useImperativeReference';
+export {
+  FragmentReader,
+  type IsExactlyIntrinsicAttributes,
+} from './react/FragmentReader';
 export { useResult } from './react/useResult';
 export {
   useReadAndSubscribe,
@@ -97,7 +149,23 @@ export { useRerenderOnChange } from './react/useRerenderOnChange';
 export { RenderAfterCommit__DO_NOT_USE } from './react/RenderAfterCommit__DO_NOT_USE';
 
 export { useClientSideDefer } from './loadable-hooks/useClientSideDefer';
-export { useImperativeExposedMutationField } from './loadable-hooks/useImperativeExposedMutationField';
-export { useSkipLimitPagination } from './loadable-hooks/useSkipLimitPagination';
-export { useConnectionSpecPagination } from './loadable-hooks/useConnectionSpecPagination';
-export { useImperativeLoadableField } from './loadable-hooks/useImperativeLoadableField';
+export {
+  useImperativeExposedMutationField,
+  type UseImperativeLoadableFieldReturn as UseImperativeExposedMutationFieldReturn,
+} from './loadable-hooks/useImperativeExposedMutationField';
+export {
+  useSkipLimitPagination,
+  type UseSkipLimitPaginationArgs,
+  type UseSkipLimitReturnValue,
+} from './loadable-hooks/useSkipLimitPagination';
+export {
+  useConnectionSpecPagination,
+  type Connection,
+  type PageInfo,
+  type UseConnectionSpecPaginationArgs,
+  type UsePaginationReturnValue,
+} from './loadable-hooks/useConnectionSpecPagination';
+export {
+  useImperativeLoadableField,
+  type UseImperativeLoadableFieldReturn,
+} from './loadable-hooks/useImperativeLoadableField';

package/src/loadable-hooks/useClientSideDefer.ts

@@ -4,16 +4,13 @@ import { FetchOptions } from '../core/check';
 import {
   ExtractParameters,
   FragmentReference,
+  type UnknownTReadFromStore,
 } from '../core/FragmentReference';
-import { LoadableField, type StartUpdate } from '../core/reader';
+import { LoadableField } from '../core/reader';
 import { useIsographEnvironment } from '../react/IsographEnvironmentProvider';
 
 export function useClientSideDefer<
-  TReadFromStore extends {
-    data: object;
-    parameters: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TResult,
 >(
   loadableField: LoadableField<
@@ -26,11 +23,7 @@ export function useClientSideDefer<
 ): { fragmentReference: FragmentReference<TReadFromStore, TResult> };
 
 export function useClientSideDefer<
-  TReadFromStore extends {
-    data: object;
-    parameters: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TResult,
   TProvidedArgs extends object,
 >(
@@ -44,11 +37,7 @@ export function useClientSideDefer<
 ): { fragmentReference: FragmentReference<TReadFromStore, TResult> };
 
 export function useClientSideDefer<
-  TReadFromStore extends {
-    data: object;
-    parameters: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TResult,
   TProvidedArgs extends object,
 >(

package/src/loadable-hooks/useConnectionSpecPagination.ts

@@ -10,28 +10,23 @@ import {
 import { useState } from 'react';
 import { subscribeToAnyChange } from '../core/cache';
 import { FetchOptions } from '../core/check';
-import { FragmentReference } from '../core/FragmentReference';
+import {
+  FragmentReference,
+  type UnknownTReadFromStore,
+} from '../core/FragmentReference';
 import { getPromiseState, readPromise } from '../core/PromiseWrapper';
 import {
   readButDoNotEvaluate,
   type WithEncounteredRecords,
 } from '../core/read';
-import {
-  LoadableField,
-  type ReaderAst,
-  type StartUpdate,
-} from '../core/reader';
+import { LoadableField, type ReaderAst } from '../core/reader';
 import { startUpdate } from '../core/startUpdate';
 import { useIsographEnvironment } from '../react/IsographEnvironmentProvider';
 import { useSubscribeToMultiple } from '../react/useReadAndSubscribe';
 import { maybeUnwrapNetworkRequest } from '../react/useResult';
 
-type UsePaginationReturnValue<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+export type UsePaginationReturnValue<
+  TReadFromStore extends UnknownTReadFromStore,
   TItem,
 > =
   | {
@@ -71,12 +66,12 @@ function flatten<T>(arr: ReadonlyArray<ReadonlyArray<T>>): ReadonlyArray<T> {
   return outArray;
 }
 
-type PageInfo = {
+export type PageInfo = {
   readonly hasNextPage: boolean;
   readonly endCursor: string | null;
 };
 
-type Connection<T> = {
+export type Connection<T> = {
   readonly edges: ReadonlyArray<T> | null;
   readonly pageInfo: PageInfo;
 };
@@ -86,17 +81,13 @@ type NonNullConnection<T> = {
   readonly pageInfo: PageInfo;
 };
 
-type UseConnectionSpecPaginationArgs = {
+export type UseConnectionSpecPaginationArgs = {
   first: number;
   after: string | null;
 };
 
 export function useConnectionSpecPagination<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TItem,
 >(
   loadableField: LoadableField<

package/src/loadable-hooks/useImperativeExposedMutationField.ts

@@ -1,4 +1,4 @@
-type UseImperativeLoadableFieldReturn<TArgs> = {
+export type UseImperativeLoadableFieldReturn<TArgs> = {
   loadField: (args: TArgs) => void;
 };
 

package/src/loadable-hooks/useImperativeLoadableField.ts

@@ -9,7 +9,7 @@ import {
 } from '../core/FragmentReference';
 import { LoadableField } from '../core/reader';
 
-type UseImperativeLoadableFieldReturn<
+export type UseImperativeLoadableFieldReturn<
   TReadFromStore extends { data: object; parameters: object },
   TResult,
   TProvidedArgs extends object,

package/src/loadable-hooks/useSkipLimitPagination.ts

@@ -10,28 +10,23 @@ import {
 import { useState } from 'react';
 import { subscribeToAnyChange } from '../core/cache';
 import { FetchOptions } from '../core/check';
-import { FragmentReference } from '../core/FragmentReference';
+import {
+  FragmentReference,
+  type UnknownTReadFromStore,
+} from '../core/FragmentReference';
 import { getPromiseState, readPromise } from '../core/PromiseWrapper';
 import {
   readButDoNotEvaluate,
   type WithEncounteredRecords,
 } from '../core/read';
-import {
-  LoadableField,
-  type ReaderAst,
-  type StartUpdate,
-} from '../core/reader';
+import { LoadableField, type ReaderAst } from '../core/reader';
 import { startUpdate } from '../core/startUpdate';
 import { useIsographEnvironment } from '../react/IsographEnvironmentProvider';
 import { useSubscribeToMultiple } from '../react/useReadAndSubscribe';
 import { maybeUnwrapNetworkRequest } from '../react/useResult';
 
-type UseSkipLimitReturnValue<
-  TReadFromStore extends {
-    data: object;
-    parameters: object;
-    startUpdate?: StartUpdate<object>;
-  },
+export type UseSkipLimitReturnValue<
+  TReadFromStore extends UnknownTReadFromStore,
   TItem,
 > =
   | {
@@ -52,11 +47,7 @@ type UseSkipLimitReturnValue<
     };
 
 type ArrayFragmentReference<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TItem,
 > = FragmentReference<TReadFromStore, ReadonlyArray<TItem>>;
 
@@ -82,18 +73,14 @@ function flatten<T>(arr: ReadonlyArray<ReadonlyArray<T>>): ReadonlyArray<T> {
   return outArray;
 }
 
-type UseSkipLimitPaginationArgs = {
+export type UseSkipLimitPaginationArgs = {
   skip: number;
   limit: number;
 };
 
 export function useSkipLimitPagination<
   TItem,
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
 >(
   loadableField: LoadableField<
     TReadFromStore,

package/src/react/FragmentReader.tsx

@@ -4,7 +4,7 @@ import { FragmentReference } from '../core/FragmentReference';
 import { NetworkRequestReaderOptions } from '../core/read';
 import { useResult } from './useResult';
 
-type IsExactlyIntrinsicAttributes<T> = T extends JSX.IntrinsicAttributes
+export type IsExactlyIntrinsicAttributes<T> = T extends JSX.IntrinsicAttributes
   ? JSX.IntrinsicAttributes extends T
     ? true
     : false

package/src/react/useImperativeReference.ts

@@ -11,19 +11,15 @@ import {
 import {
   ExtractParameters,
   FragmentReference,
+  type UnknownTReadFromStore,
 } from '../core/FragmentReference';
 import { ROOT_ID } from '../core/IsographEnvironment';
 import { maybeMakeNetworkRequest } from '../core/makeNetworkRequest';
 import { wrapResolvedValue } from '../core/PromiseWrapper';
-import type { StartUpdate } from '../core/reader';
 import { useIsographEnvironment } from './IsographEnvironmentProvider';
 
-type UseImperativeReferenceResult<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+export type UseImperativeReferenceResult<
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
   TNormalizationAst extends NormalizationAst | NormalizationAstLoader,
 > = {
@@ -40,11 +36,7 @@ type UseImperativeReferenceResult<
 };
 
 export function useImperativeReference<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
   TNormalizationAst extends NormalizationAst | NormalizationAstLoader,
 >(

package/src/react/useLazyReference.ts

@@ -9,17 +9,13 @@ import {
 import {
   ExtractParameters,
   FragmentReference,
+  type UnknownTReadFromStore,
 } from '../core/FragmentReference';
 import { logMessage } from '../core/logging';
-import type { StartUpdate } from '../core/reader';
 import { useIsographEnvironment } from './IsographEnvironmentProvider';
 
 export function useLazyReference<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
   TNormalizationAst extends NormalizationAst | NormalizationAstLoader,
 >(

package/src/react/useReadAndSubscribe.ts

@@ -4,13 +4,14 @@ import {
   ExtractData,
   FragmentReference,
   stableIdForFragmentReference,
+  type UnknownTReadFromStore,
 } from '../core/FragmentReference';
 import {
   NetworkRequestReaderOptions,
   readButDoNotEvaluate,
   WithEncounteredRecords,
 } from '../core/read';
-import type { ReaderAst, StartUpdate } from '../core/reader';
+import type { ReaderAst } from '../core/reader';
 import { useIsographEnvironment } from './IsographEnvironmentProvider';
 import { useRerenderOnChange } from './useRerenderOnChange';
 
@@ -18,11 +19,7 @@ import { useRerenderOnChange } from './useRerenderOnChange';
  * Read the data from a fragment reference and subscribe to updates.
  */
 export function useReadAndSubscribe<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
 >(
   fragmentReference: FragmentReference<TReadFromStore, any>,
   networkRequestOptions: NetworkRequestReaderOptions,
@@ -42,11 +39,7 @@ export function useReadAndSubscribe<
 }
 
 export function useSubscribeToMultiple<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
 >(
   items: ReadonlyArray<{
     records: WithEncounteredRecords<TReadFromStore>;

package/src/react/useResult.ts

@@ -1,5 +1,8 @@
 import { getOrCreateCachedComponent } from '../core/componentCache';
-import { FragmentReference } from '../core/FragmentReference';
+import {
+  FragmentReference,
+  type UnknownTReadFromStore,
+} from '../core/FragmentReference';
 import {
   getPromiseState,
   PromiseWrapper,
@@ -9,17 +12,12 @@ import {
   getNetworkRequestOptionsWithDefaults,
   NetworkRequestReaderOptions,
 } from '../core/read';
-import type { StartUpdate } from '../core/reader';
 import { startUpdate } from '../core/startUpdate';
 import { useIsographEnvironment } from '../react/IsographEnvironmentProvider';
 import { useReadAndSubscribe } from './useReadAndSubscribe';
 
 export function useResult<
-  TReadFromStore extends {
-    parameters: object;
-    data: object;
-    startUpdate?: StartUpdate<object>;
-  },
+  TReadFromStore extends UnknownTReadFromStore,
   TClientFieldValue,
 >(
   fragmentReference: FragmentReference<TReadFromStore, TClientFieldValue>,