@isograph/react 0.0.0-main-4b202045 → 0.0.0-main-05aaa6a2

package/dist/FragmentReference.d.ts

@@ -2,9 +2,9 @@ import { DataId } from './IsographEnvironment';
 import { RefetchQueryArtifactWrapper } from './entrypoint';
 import { ReaderArtifact } from './reader';
 export type Variable = any;
-export type FragmentReference<TReadFromStore extends Object, TResolverResult> = {
+export type FragmentReference<TReadFromStore extends Object, TClientFieldValue> = {
     kind: 'FragmentReference';
-    readerArtifact: ReaderArtifact<TReadFromStore, TResolverResult>;
+    readerArtifact: ReaderArtifact<TReadFromStore, TClientFieldValue>;
     root: DataId;
     variables: {
         [index: string]: Variable;

package/dist/IsographEnvironment.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { ParentCache } from '@isograph/isograph-react-disposable-state';
+import { ParentCache } from '@isograph/react-disposable-state';
 import { RetainedQuery } from './garbageCollection';
 type ComponentName = string;
 type StringifiedArgs = string;
@@ -54,5 +54,5 @@ export declare function defaultMissingFieldHandler(_storeRecord: StoreRecord, _r
 } | null, variables: {
     [index: string]: any;
 } | null): Link | undefined;
-export declare function assertLink(link: DataTypeValue): Link | null;
+export declare function assertLink(link: DataTypeValue): Link | null | undefined;
 export {};

package/dist/IsographEnvironment.js

@@ -39,7 +39,7 @@ function assertLink(link) {
         throw new Error('Unexpected array');
     }
     if (link == null) {
-        return null;
+        return link;
     }
     if (typeof link === 'object') {
         return link;

package/dist/entrypoint.d.ts

@@ -1,10 +1,10 @@
 import { ReaderArtifact } from './reader';
 import { Arguments } from './util';
-export type IsographEntrypoint<TReadFromStore extends Object, TResolverResult> = {
+export type IsographEntrypoint<TReadFromStore extends Object, TClientFieldValue> = {
     kind: 'Entrypoint';
     queryText: string;
     normalizationAst: NormalizationAst;
-    readerArtifact: ReaderArtifact<TReadFromStore, TResolverResult>;
+    readerArtifact: ReaderArtifact<TReadFromStore, TClientFieldValue>;
     nestedRefetchQueries: RefetchQueryArtifactWrapper[];
 };
 export type NormalizationAstNode = NormalizationScalarField | NormalizationLinkedField;
@@ -29,6 +29,6 @@ export type RefetchQueryArtifactWrapper = {
     artifact: RefetchQueryArtifact;
     allowedVariables: string[];
 };
-export declare function assertIsEntrypoint<TReadFromStore extends Object, TResolverResult>(value: IsographEntrypoint<TReadFromStore, TResolverResult> | ((_: any) => any) | any): asserts value is IsographEntrypoint<TReadFromStore, TResolverResult>;
+export declare function assertIsEntrypoint<TReadFromStore extends Object, TClientFieldValue>(value: IsographEntrypoint<TReadFromStore, TClientFieldValue> | ((_: any) => any) | any): asserts value is IsographEntrypoint<TReadFromStore, TClientFieldValue>;
 export type ExtractReadFromStore<Type> = Type extends IsographEntrypoint<infer X, any> ? X : never;
 export type ExtractResolverResult<Type> = Type extends IsographEntrypoint<any, infer X> ? X : never;

package/dist/read.d.ts

@@ -1,4 +1,4 @@
 import { FragmentReference } from './FragmentReference';
 import { IsographEnvironment } from './IsographEnvironment';
-export declare function read<TReadFromStore extends Object, TResolverResult>(environment: IsographEnvironment, fragmentReference: FragmentReference<TReadFromStore, TResolverResult>): TResolverResult;
+export declare function read<TReadFromStore extends Object, TClientFieldValue>(environment: IsographEnvironment, fragmentReference: FragmentReference<TReadFromStore, TClientFieldValue>): TClientFieldValue;
 export declare function readButDoNotEvaluate<TReadFromStore extends Object>(environment: IsographEnvironment, reference: FragmentReference<TReadFromStore, unknown>): TReadFromStore;

package/dist/reader.d.ts

@@ -1,8 +1,8 @@
 import { Arguments } from './util';
-export type ReaderArtifact<TReadFromStore extends Object, TResolverResult> = {
+export type ReaderArtifact<TReadFromStore extends Object, TClientFieldValue> = {
     kind: 'ReaderArtifact';
     readerAst: ReaderAst<TReadFromStore>;
-    resolver: (data: TReadFromStore, runtimeProps: any) => TResolverResult;
+    resolver: (data: TReadFromStore, runtimeProps: any) => TClientFieldValue;
     variant: ReaderResolverVariant;
 };
 export type ReaderAstNode = ReaderScalarField | ReaderLinkedField | ReaderResolverField | ReaderRefetchField | ReaderMutationField;

package/dist/reader.js

@@ -1,3 +1,2 @@
 "use strict";
-// TODO this should probably be at least three distinct types, for @component,
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/useLazyReference.js

@@ -5,7 +5,7 @@ const IsographEnvironmentProvider_1 = require("./IsographEnvironmentProvider");
 const IsographEnvironment_1 = require("./IsographEnvironment");
 const entrypoint_1 = require("./entrypoint");
 const cache_1 = require("./cache");
-const isograph_react_disposable_state_1 = require("@isograph/isograph-react-disposable-state");
+const react_disposable_state_1 = require("@isograph/react-disposable-state");
 // Note: we cannot write TEntrypoint extends IsographEntrypoint<any, any, any>, or else
 // if we do not explicitly pass a type, the read out type will be any.
 // We cannot write TEntrypoint extends IsographEntrypoint<never, never, never>, or else
@@ -16,7 +16,7 @@ function useLazyReference(entrypoint, variables) {
     const cache = (0, cache_1.getOrCreateCacheForArtifact)(environment, entrypoint, variables);
     // TODO add comment explaining why we never use this value
     // @ts-ignore
-    const data = (0, isograph_react_disposable_state_1.useLazyDisposableState)(cache).state;
+    const data = (0, react_disposable_state_1.useLazyDisposableState)(cache).state;
     return {
         queryReference: {
             kind: 'FragmentReference',

package/dist/useResult.d.ts

@@ -1,2 +1,2 @@
 import { FragmentReference } from './FragmentReference';
-export declare function useResult<TReadFromStore extends Object, TResolverResult>(fragmentReference: FragmentReference<TReadFromStore, TResolverResult>): TResolverResult;
+export declare function useResult<TReadFromStore extends Object, TClientFieldValue>(fragmentReference: FragmentReference<TReadFromStore, TClientFieldValue>): TClientFieldValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isograph/react",
-  "version": "0.0.0-main-4b202045",
+  "version": "0.0.0-main-05aaa6a2",
   "description": "Use Isograph with React",
   "homepage": "https://isograph.dev",
   "main": "dist/index.js",
@@ -16,8 +16,8 @@
     "prepack": "yarn run test && yarn run compile"
   },
   "dependencies": {
-    "@isograph/disposable-types": "0.0.0-main-4b202045",
-    "@isograph/react-disposable-state": "0.0.0-main-4b202045",
+    "@isograph/disposable-types": "0.0.0-main-05aaa6a2",
+    "@isograph/react-disposable-state": "0.0.0-main-05aaa6a2",
     "react": "^18.2.0"
   },
   "devDependencies": {

package/src/FragmentReference.ts

@@ -7,10 +7,10 @@ export type Variable = any;
 
 export type FragmentReference<
   TReadFromStore extends Object,
-  TResolverResult,
+  TClientFieldValue,
 > = {
   kind: 'FragmentReference';
-  readerArtifact: ReaderArtifact<TReadFromStore, TResolverResult>;
+  readerArtifact: ReaderArtifact<TReadFromStore, TClientFieldValue>;
   root: DataId;
   variables: { [index: string]: Variable } | null;
   // TODO: We should instead have ReaderAst<TResolverProps>

package/src/IsographEnvironment.tsx

@@ -1,4 +1,4 @@
-import { ParentCache } from '@isograph/isograph-react-disposable-state';
+import { ParentCache } from '@isograph/react-disposable-state';
 import { RetainedQuery } from './garbageCollection';
 
 type ComponentName = string;
@@ -114,12 +114,12 @@ export function defaultMissingFieldHandler(
   }
 }
 
-export function assertLink(link: DataTypeValue): Link | null {
+export function assertLink(link: DataTypeValue): Link | null | undefined {
   if (Array.isArray(link)) {
     throw new Error('Unexpected array');
   }
   if (link == null) {
-    return null;
+    return link;
   }
   if (typeof link === 'object') {
     return link;

package/src/entrypoint.ts

@@ -4,12 +4,12 @@ import { Arguments } from './util';
 // This type should be treated as an opaque type.
 export type IsographEntrypoint<
   TReadFromStore extends Object,
-  TResolverResult,
+  TClientFieldValue,
 > = {
   kind: 'Entrypoint';
   queryText: string;
   normalizationAst: NormalizationAst;
-  readerArtifact: ReaderArtifact<TReadFromStore, TResolverResult>;
+  readerArtifact: ReaderArtifact<TReadFromStore, TClientFieldValue>;
   nestedRefetchQueries: RefetchQueryArtifactWrapper[];
 };
 
@@ -46,15 +46,15 @@ export type RefetchQueryArtifactWrapper = {
 
 export function assertIsEntrypoint<
   TReadFromStore extends Object,
-  TResolverResult,
+  TClientFieldValue,
 >(
   value:
-    | IsographEntrypoint<TReadFromStore, TResolverResult>
+    | IsographEntrypoint<TReadFromStore, TClientFieldValue>
     | ((_: 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, TResolverResult> {
+): asserts value is IsographEntrypoint<TReadFromStore, TClientFieldValue> {
   if (typeof value === 'function') throw new Error('Not a string');
 }
 

package/src/read.ts

@@ -10,10 +10,10 @@ import {
 } from './IsographEnvironment';
 import { ReaderAst } from './reader';
 
-export function read<TReadFromStore extends Object, TResolverResult>(
+export function read<TReadFromStore extends Object, TClientFieldValue>(
   environment: IsographEnvironment,
-  fragmentReference: FragmentReference<TReadFromStore, TResolverResult>,
-): TResolverResult {
+  fragmentReference: FragmentReference<TReadFromStore, TClientFieldValue>,
+): TClientFieldValue {
   const variant = fragmentReference.readerArtifact.variant;
   if (variant.kind === 'Eager') {
     const data = readData(

package/src/reader.ts

@@ -1,12 +1,11 @@
-// TODO this should probably be at least three distinct types, for @component,
-
 import { Arguments } from './util';
 
+// TODO this should probably be at least three distinct types, for @component,
 // non-@component and refetch resolvers
-export type ReaderArtifact<TReadFromStore extends Object, TResolverResult> = {
+export type ReaderArtifact<TReadFromStore extends Object, TClientFieldValue> = {
   kind: 'ReaderArtifact';
   readerAst: ReaderAst<TReadFromStore>;
-  resolver: (data: TReadFromStore, runtimeProps: any) => TResolverResult;
+  resolver: (data: TReadFromStore, runtimeProps: any) => TClientFieldValue;
   variant: ReaderResolverVariant;
 };
 

package/src/useLazyReference.ts

@@ -7,7 +7,7 @@ import {
   assertIsEntrypoint,
 } from './entrypoint';
 import { getOrCreateCacheForArtifact } from './cache';
-import { useLazyDisposableState } from '@isograph/isograph-react-disposable-state';
+import { useLazyDisposableState } from '@isograph/react-disposable-state';
 import { type PromiseWrapper } from './PromiseWrapper';
 
 // Note: we cannot write TEntrypoint extends IsographEntrypoint<any, any, any>, or else

package/src/useResult.ts

@@ -4,9 +4,9 @@ import { subscribe } from './cache';
 import { read } from './read';
 import { FragmentReference } from './FragmentReference';
 
-export function useResult<TReadFromStore extends Object, TResolverResult>(
-  fragmentReference: FragmentReference<TReadFromStore, TResolverResult>,
-): TResolverResult {
+export function useResult<TReadFromStore extends Object, TClientFieldValue>(
+  fragmentReference: FragmentReference<TReadFromStore, TClientFieldValue>,
+): TClientFieldValue {
   const environment = useIsographEnvironment();
 
   const [, setState] = useState<object | void>();