@isograph/react 0.0.0-main-f524690b → 0.0.0-main-38d73d29

package/src/index.tsx

@@ -1,27 +1,38 @@
 import {
-  DataId,
-  StoreRecord,
-  DataTypeValue,
-  Link,
-  ROOT_ID,
   getOrCreateCacheForArtifact,
   onNextChange,
-  getStore,
   getParentRecordKey,
 } from './cache';
 import { useLazyDisposableState } from '@isograph/react-disposable-state';
 import { type PromiseWrapper } from './PromiseWrapper';
 import { getOrCreateCachedComponent } from './componentCache';
-
-export {
-  setNetwork,
-  makeNetworkRequest,
-  subscribe,
+import {
   DataId,
+  DataTypeValue,
+  IsographEnvironment,
   Link,
+  ROOT_ID,
   StoreRecord,
-  clearStore,
-} from './cache';
+  useIsographEnvironment,
+} from './IsographEnvironment';
+
+export { makeNetworkRequest, subscribe } from './cache';
+export {
+  IsographEnvironmentContext,
+  ROOT_ID,
+  type DataId,
+  type DataTypeValue,
+  type IsographEnvironment,
+  IsographEnvironmentProvider,
+  type IsographEnvironmentProviderProps,
+  type IsographNetworkFunction,
+  type IsographStore,
+  type Link,
+  type StoreRecord,
+  useIsographEnvironment,
+  createIsographEnvironment,
+  createIsographStore,
+} from './IsographEnvironment';
 
 export { iso } from './iso';
 
@@ -177,7 +188,10 @@ function assertIsEntrypoint<
 >(
   value:
     | IsographEntrypoint<TReadFromStore, TResolverProps, TResolverResult>
-    | typeof iso,
+    | ((_: any) => any)
+    // Temporarily, allow any here. Once we automatically provide
+    // types to entrypoints, we probably don't need this.
+    | any,
 ): asserts value is IsographEntrypoint<
   TReadFromStore,
   TResolverProps,
@@ -211,9 +225,11 @@ export function useLazyReference<TEntrypoint>(
     ExtractResolverResult<TEntrypoint>
   >;
 } {
+  const environment = useIsographEnvironment();
   assertIsEntrypoint(entrypoint);
   // Typechecking fails here... TODO investigate
   const cache = getOrCreateCacheForArtifact<ExtractResolverResult<TEntrypoint>>(
+    environment,
     entrypoint,
     variables,
   );
@@ -234,11 +250,27 @@ export function useLazyReference<TEntrypoint>(
   };
 }
 
+export function useRead<
+  TReadFromStore extends Object,
+  TResolverProps,
+  TResolverResult,
+>(
+  fragmentReference: FragmentReference<
+    TReadFromStore,
+    TResolverProps,
+    TResolverResult
+  >,
+): TResolverResult {
+  const environment = useIsographEnvironment();
+  return read(environment, fragmentReference);
+}
+
 export function read<
   TReadFromStore extends Object,
   TResolverProps,
   TResolverResult,
 >(
+  environment: IsographEnvironment,
   fragmentReference: FragmentReference<
     TReadFromStore,
     TResolverProps,
@@ -248,19 +280,21 @@ export function read<
   const variant = fragmentReference.readerArtifact.variant;
   if (variant.kind === 'Eager') {
     const data = readData(
+      environment,
       fragmentReference.readerArtifact.readerAst,
       fragmentReference.root,
       fragmentReference.variables ?? {},
       fragmentReference.nestedRefetchQueries,
     );
     if (data.kind === 'MissingData') {
-      throw onNextChange();
+      throw onNextChange(environment);
     } else {
       return fragmentReference.readerArtifact.resolver(data.data);
     }
   } else if (variant.kind === 'Component') {
     // @ts-ignore
     return getOrCreateCachedComponent(
+      environment,
       fragmentReference.root,
       variant.componentName,
       fragmentReference.readerArtifact,
@@ -273,9 +307,11 @@ export function read<
 }
 
 export function readButDoNotEvaluate<TReadFromStore extends Object>(
+  environment: IsographEnvironment,
   reference: FragmentReference<TReadFromStore, unknown, unknown>,
 ): TReadFromStore {
   const response = readData(
+    environment,
     reference.readerArtifact.readerAst,
     reference.root,
     reference.variables ?? {},
@@ -285,7 +321,7 @@ export function readButDoNotEvaluate<TReadFromStore extends Object>(
     console.log('done reading', { response });
   }
   if (response.kind === 'MissingData') {
-    throw onNextChange();
+    throw onNextChange(environment);
   } else {
     return response.data;
   }
@@ -303,12 +339,13 @@ type ReadDataResult<TReadFromStore> =
     };
 
 function readData<TReadFromStore>(
+  environment: IsographEnvironment,
   ast: ReaderAst<TReadFromStore>,
   root: DataId,
   variables: { [index: string]: string },
   nestedRefetchQueries: RefetchQueryArtifactWrapper[],
 ): ReadDataResult<TReadFromStore> {
-  let storeRecord = getStore()[root];
+  let storeRecord = environment.store[root];
   if (storeRecord === undefined) {
     return { kind: 'MissingData', reason: 'No record for root ' + root };
   }
@@ -358,6 +395,7 @@ function readData<TReadFromStore>(
               continue;
             }
             const result = readData(
+              environment,
               field.selections,
               link.__link,
               variables,
@@ -384,6 +422,8 @@ function readData<TReadFromStore>(
         let link = assertLink(value);
         if (link === undefined) {
           // TODO make this configurable, and also generated and derived from the schema
+          const missingFieldHandler =
+            environment.missingFieldHandler ?? defaultMissingFieldHandler;
           const altLink = missingFieldHandler(
             storeRecord,
             root,
@@ -411,6 +451,7 @@ function readData<TReadFromStore>(
         }
         const targetId = link.__link;
         const data = readData(
+          environment,
           field.selections,
           targetId,
           variables,
@@ -428,6 +469,7 @@ function readData<TReadFromStore>(
       }
       case 'RefetchField': {
         const data = readData(
+          environment,
           field.readerArtifact.readerAst,
           root,
           variables,
@@ -453,6 +495,7 @@ function readData<TReadFromStore>(
           const allowedVariables = refetchQuery.allowedVariables;
 
           target[field.alias] = field.readerArtifact.resolver(
+            environment,
             refetchQueryArtifact,
             {
               ...data.data,
@@ -466,6 +509,7 @@ function readData<TReadFromStore>(
       }
       case 'MutationField': {
         const data = readData(
+          environment,
           field.readerArtifact.readerAst,
           root,
           variables,
@@ -491,6 +535,7 @@ function readData<TReadFromStore>(
           const allowedVariables = refetchQuery.allowedVariables;
 
           target[field.alias] = field.readerArtifact.resolver(
+            environment,
             refetchQueryArtifact,
             data.data,
             filterVariables(variables, allowedVariables),
@@ -507,6 +552,7 @@ function readData<TReadFromStore>(
         const variant = field.readerArtifact.variant;
         if (variant.kind === 'Eager') {
           const data = readData(
+            environment,
             field.readerArtifact.readerAst,
             root,
             variables,
@@ -523,6 +569,7 @@ function readData<TReadFromStore>(
           }
         } else if (variant.kind === 'Component') {
           target[field.alias] = getOrCreateCachedComponent(
+            environment,
             root,
             variant.componentName,
             field.readerArtifact,
@@ -537,37 +584,9 @@ function readData<TReadFromStore>(
   return { kind: 'Success', data: target as any };
 }
 
-let customMissingFieldHandler: typeof defaultMissingFieldHandler | null = null;
-
-function missingFieldHandler(
-  storeRecord: StoreRecord,
-  root: DataId,
-  fieldName: string,
-  arguments_: { [index: string]: any } | null,
-  variables: { [index: string]: any } | null,
-): Link | undefined {
-  if (customMissingFieldHandler != null) {
-    return customMissingFieldHandler(
-      storeRecord,
-      root,
-      fieldName,
-      arguments_,
-      variables,
-    );
-  } else {
-    return defaultMissingFieldHandler(
-      storeRecord,
-      root,
-      fieldName,
-      arguments_,
-      variables,
-    );
-  }
-}
-
 export function defaultMissingFieldHandler(
-  storeRecord: StoreRecord,
-  root: DataId,
+  _storeRecord: StoreRecord,
+  _root: DataId,
   fieldName: string,
   arguments_: { [index: string]: any } | null,
   variables: { [index: string]: any } | null,
@@ -583,12 +602,6 @@ export function defaultMissingFieldHandler(
   }
 }
 
-export function setMissingFieldHandler(
-  handler: typeof defaultMissingFieldHandler,
-) {
-  customMissingFieldHandler = handler;
-}
-
 function assertLink(link: DataTypeValue): Link | undefined | null {
   if (Array.isArray(link)) {
     throw new Error('Unexpected array');