@isograph/react 0.0.0-main-2fbc0faf → 0.0.0-main-0b32e705

package/dist/EntrypointReader.d.ts

@@ -1,7 +1,10 @@
 import * as React from 'react';
 import { ExtractReadFromStore, IsographEntrypoint } from './entrypoint';
 import { FragmentReference } from './FragmentReference';
-export declare function EntrypointReader<TProps extends Record<any, any>, TEntrypoint extends IsographEntrypoint<any, React.FC<TProps>>>(props: {
+export declare function EntrypointReader<TProps extends Record<any, any>, TEntrypoint extends IsographEntrypoint<any, React.FC<TProps>>>(props: TProps extends Record<string, never> ? {
+    queryReference: FragmentReference<ExtractReadFromStore<TEntrypoint>, React.FC<TProps>>;
+    additionalProps?: TProps;
+} : {
     queryReference: FragmentReference<ExtractReadFromStore<TEntrypoint>, React.FC<TProps>>;
     additionalProps: TProps;
 }): React.ReactNode;

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/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/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-2fbc0faf",
+  "version": "0.0.0-main-0b32e705",
   "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-2fbc0faf",
-    "@isograph/react-disposable-state": "0.0.0-main-2fbc0faf",
+    "@isograph/disposable-types": "0.0.0-main-0b32e705",
+    "@isograph/react-disposable-state": "0.0.0-main-0b32e705",
     "react": "^18.2.0"
   },
   "devDependencies": {

package/src/EntrypointReader.tsx

@@ -6,15 +6,23 @@ import { useResult } from './useResult';
 export function EntrypointReader<
   TProps extends Record<any, any>,
   TEntrypoint extends IsographEntrypoint<any, React.FC<TProps>>,
->(props: {
-  queryReference: FragmentReference<
-    ExtractReadFromStore<TEntrypoint>,
-    React.FC<TProps>
-  >;
-  // TODO make additionalProps optional if TProps extends Record<string, never>
-  // perhaps with a type overload
-  additionalProps: TProps;
-}): React.ReactNode {
+>(
+  props: TProps extends Record<string, never>
+    ? {
+        queryReference: FragmentReference<
+          ExtractReadFromStore<TEntrypoint>,
+          React.FC<TProps>
+        >;
+        additionalProps?: TProps;
+      }
+    : {
+        queryReference: FragmentReference<
+          ExtractReadFromStore<TEntrypoint>,
+          React.FC<TProps>
+        >;
+        additionalProps: TProps;
+      },
+): React.ReactNode {
   const Component = useResult(props.queryReference);
   return <Component {...props.additionalProps} />;
 }

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/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/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>();