@isograph/react 0.1.0 → 0.2.0

package/src/index.tsx

@@ -1,651 +0,0 @@
-import {
-  getOrCreateCacheForArtifact,
-  onNextChange,
-  getParentRecordKey,
-  subscribe,
-} from './cache';
-import { useLazyDisposableState } from '@isograph/react-disposable-state';
-import { type PromiseWrapper } from './PromiseWrapper';
-import { getOrCreateCachedComponent } from './componentCache';
-import {
-  DataId,
-  DataTypeValue,
-  IsographEnvironment,
-  Link,
-  ROOT_ID,
-  StoreRecord,
-  useIsographEnvironment,
-} from './IsographEnvironment';
-import { useEffect, useState } from 'react';
-
-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';
-
-// This type should be treated as an opaque type.
-export type IsographEntrypoint<
-  TReadFromStore extends Object,
-  TResolverProps,
-  TResolverResult,
-> = {
-  kind: 'Entrypoint';
-  queryText: string;
-  normalizationAst: NormalizationAst;
-  readerArtifact: ReaderArtifact<
-    TReadFromStore,
-    TResolverProps,
-    TResolverResult
-  >;
-  nestedRefetchQueries: RefetchQueryArtifactWrapper[];
-};
-
-export type ReaderArtifact<
-  TReadFromStore extends Object,
-  TResolverProps,
-  TResolverResult,
-> = {
-  kind: 'ReaderArtifact';
-  readerAst: ReaderAst<TReadFromStore>;
-  resolver: (data: TResolverProps) => TResolverResult;
-  variant: ReaderResolverVariant;
-};
-
-export type ReaderAstNode =
-  | ReaderScalarField
-  | ReaderLinkedField
-  | ReaderResolverField
-  | ReaderRefetchField
-  | ReaderMutationField;
-
-// @ts-ignore
-export type ReaderAst<TReadFromStore> = ReaderAstNode[];
-
-export type ReaderScalarField = {
-  kind: 'Scalar';
-  fieldName: string;
-  alias: string | null;
-  arguments: Arguments | null;
-};
-export type ReaderLinkedField = {
-  kind: 'Linked';
-  fieldName: string;
-  alias: string | null;
-  selections: ReaderAst<unknown>;
-  arguments: Arguments | null;
-};
-
-export type ReaderResolverVariant =
-  | { kind: 'Eager' }
-  // componentName is the component's cacheKey for getRefReaderByName
-  // and is the type + field concatenated
-  | { kind: 'Component'; componentName: string };
-
-export type ReaderResolverField = {
-  kind: 'Resolver';
-  alias: string;
-  readerArtifact: ReaderArtifact<any, any, any>;
-  arguments: Arguments | null;
-  usedRefetchQueries: number[];
-};
-
-export type ReaderRefetchField = {
-  kind: 'RefetchField';
-  alias: string;
-  // TODO this bad modeling. A refetch field cannot have variant: "Component" (I think)
-  readerArtifact: ReaderArtifact<any, any, any>;
-  refetchQuery: number;
-};
-
-export type ReaderMutationField = {
-  kind: 'MutationField';
-  alias: string;
-  // TODO this bad modeling. A mutation field cannot have variant: "Component" (I think)
-  readerArtifact: ReaderArtifact<any, any, any>;
-  refetchQuery: number;
-  allowedVariables: string[];
-};
-
-export type NormalizationAstNode =
-  | NormalizationScalarField
-  | NormalizationLinkedField;
-// @ts-ignore
-export type NormalizationAst = NormalizationAstNode[];
-
-export type NormalizationScalarField = {
-  kind: 'Scalar';
-  fieldName: string;
-  arguments: Arguments | null;
-};
-
-export type NormalizationLinkedField = {
-  kind: 'Linked';
-  fieldName: string;
-  arguments: Arguments | null;
-  selections: NormalizationAst;
-};
-
-// This is more like an entrypoint, but one specifically for a refetch query/mutation
-export type RefetchQueryArtifact = {
-  kind: 'RefetchQuery';
-  queryText: string;
-  normalizationAst: NormalizationAst;
-};
-
-// TODO rename
-export type RefetchQueryArtifactWrapper = {
-  artifact: RefetchQueryArtifact;
-  allowedVariables: string[];
-};
-
-export type Arguments = Argument[];
-export type Argument = [ArgumentName, ArgumentValue];
-export type ArgumentName = string;
-export type ArgumentValue =
-  | {
-      kind: 'Variable';
-      name: string;
-    }
-  | {
-      kind: 'Literal';
-      value: any;
-    };
-
-// TODO type this better
-type Variable = any;
-
-export type FragmentReference<
-  TReadFromStore extends Object,
-  TResolverProps,
-  TResolverResult,
-> = {
-  kind: 'FragmentReference';
-  readerArtifact: ReaderArtifact<
-    TReadFromStore,
-    TResolverProps,
-    TResolverResult
-  >;
-  root: DataId;
-  variables: { [index: string]: Variable } | null;
-  // TODO: We should instead have ReaderAst<TResolverProps>
-  nestedRefetchQueries: RefetchQueryArtifactWrapper[];
-};
-
-function assertIsEntrypoint<
-  TReadFromStore extends Object,
-  TResolverProps,
-  TResolverResult,
->(
-  value:
-    | IsographEntrypoint<TReadFromStore, TResolverProps, TResolverResult>
-    | ((_: 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,
-  TResolverResult
-> {
-  if (typeof value === 'function') throw new Error('Not a string');
-}
-
-type ExtractReadFromStore<Type> =
-  Type extends IsographEntrypoint<infer X, any, any> ? X : never;
-type ExtractResolverProps<Type> =
-  Type extends IsographEntrypoint<any, infer X, any> ? X : never;
-type ExtractResolverResult<Type> =
-  Type extends IsographEntrypoint<any, any, infer X> ? X : never;
-// 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
-// any actual Entrypoint we pass will not be valid.
-export function useLazyReference<TEntrypoint>(
-  entrypoint:
-    | TEntrypoint
-    // Temporarily, we need to allow useLazyReference to take the result of calling
-    // iso`...`. At runtime, we confirm that the passed-in `iso` literal is actually
-    // an entrypoint.
-    | ((_: any) => any),
-  variables: { [key: string]: Variable },
-): {
-  queryReference: FragmentReference<
-    ExtractReadFromStore<TEntrypoint>,
-    ExtractResolverProps<TEntrypoint>,
-    ExtractResolverResult<TEntrypoint>
-  >;
-} {
-  const environment = useIsographEnvironment();
-  assertIsEntrypoint<
-    ExtractReadFromStore<TEntrypoint>,
-    ExtractResolverProps<TEntrypoint>,
-    ExtractResolverResult<TEntrypoint>
-  >(entrypoint);
-  const cache = getOrCreateCacheForArtifact<ExtractResolverResult<TEntrypoint>>(
-    environment,
-    entrypoint,
-    variables,
-  );
-
-  // TODO add comment explaining why we never use this value
-  // @ts-ignore
-  const data =
-    useLazyDisposableState<PromiseWrapper<ExtractResolverResult<TEntrypoint>>>(
-      cache,
-    ).state;
-
-  return {
-    queryReference: {
-      kind: 'FragmentReference',
-      readerArtifact: entrypoint.readerArtifact,
-      root: ROOT_ID,
-      variables,
-      nestedRefetchQueries: entrypoint.nestedRefetchQueries,
-    },
-  };
-}
-
-export function useResult<
-  TReadFromStore extends Object,
-  TResolverProps,
-  TResolverResult,
->(
-  fragmentReference: FragmentReference<
-    TReadFromStore,
-    TResolverProps,
-    TResolverResult
-  >,
-): TResolverResult {
-  const environment = useIsographEnvironment();
-
-  const [, setState] = useState<object | void>();
-  useEffect(() => {
-    return subscribe(environment, () => {
-      return setState({});
-    });
-  }, []);
-
-  return read(environment, fragmentReference);
-}
-
-export function read<
-  TReadFromStore extends Object,
-  TResolverProps,
-  TResolverResult,
->(
-  environment: IsographEnvironment,
-  fragmentReference: FragmentReference<
-    TReadFromStore,
-    TResolverProps,
-    TResolverResult
-  >,
-): TResolverResult {
-  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(environment);
-    } else {
-      // @ts-expect-error This not properly typed yet
-      return fragmentReference.readerArtifact.resolver(data.data);
-    }
-  } else if (variant.kind === 'Component') {
-    // @ts-ignore
-    return getOrCreateCachedComponent(
-      environment,
-      fragmentReference.root,
-      variant.componentName,
-      fragmentReference.readerArtifact,
-      fragmentReference.variables ?? {},
-      fragmentReference.nestedRefetchQueries,
-    );
-  }
-  // Why can't Typescript realize that this is unreachable??
-  throw new Error('This is unreachable');
-}
-
-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 ?? {},
-    reference.nestedRefetchQueries,
-  );
-  if (typeof window !== 'undefined' && window.__LOG) {
-    console.log('done reading', { response });
-  }
-  if (response.kind === 'MissingData') {
-    throw onNextChange(environment);
-  } else {
-    return response.data;
-  }
-}
-
-type ReadDataResult<TReadFromStore> =
-  | {
-      kind: 'Success';
-      data: TReadFromStore;
-    }
-  | {
-      kind: 'MissingData';
-      reason: string;
-      nestedReason?: ReadDataResult<unknown>;
-    };
-
-function readData<TReadFromStore>(
-  environment: IsographEnvironment,
-  ast: ReaderAst<TReadFromStore>,
-  root: DataId,
-  variables: { [index: string]: string },
-  nestedRefetchQueries: RefetchQueryArtifactWrapper[],
-): ReadDataResult<TReadFromStore> {
-  let storeRecord = environment.store[root];
-  if (storeRecord === undefined) {
-    return { kind: 'MissingData', reason: 'No record for root ' + root };
-  }
-
-  if (storeRecord === null) {
-    return { kind: 'Success', data: null as any };
-  }
-
-  let target: { [index: string]: any } = {};
-
-  for (const field of ast) {
-    switch (field.kind) {
-      case 'Scalar': {
-        const storeRecordName = getParentRecordKey(field, variables);
-        const value = storeRecord[storeRecordName];
-        // TODO consider making scalars into discriminated unions. This probably has
-        // to happen for when we handle errors.
-        if (value === undefined) {
-          return {
-            kind: 'MissingData',
-            reason: 'No value for ' + storeRecordName + ' on root ' + root,
-          };
-        }
-        target[field.alias ?? field.fieldName] = value;
-        break;
-      }
-      case 'Linked': {
-        const storeRecordName = getParentRecordKey(field, variables);
-        const value = storeRecord[storeRecordName];
-        if (Array.isArray(value)) {
-          const results = [];
-          for (const item of value) {
-            const link = assertLink(item);
-            if (link === undefined) {
-              return {
-                kind: 'MissingData',
-                reason:
-                  'No link for ' +
-                  storeRecordName +
-                  ' on root ' +
-                  root +
-                  '. Link is ' +
-                  JSON.stringify(item),
-              };
-            } else if (link === null) {
-              results.push(null);
-              continue;
-            }
-            const result = readData(
-              environment,
-              field.selections,
-              link.__link,
-              variables,
-              nestedRefetchQueries,
-            );
-            if (result.kind === 'MissingData') {
-              return {
-                kind: 'MissingData',
-                reason:
-                  'Missing data for ' +
-                  storeRecordName +
-                  ' on root ' +
-                  root +
-                  '. Link is ' +
-                  JSON.stringify(item),
-                nestedReason: result,
-              };
-            }
-            results.push(result.data);
-          }
-          target[field.alias ?? field.fieldName] = results;
-          break;
-        }
-        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,
-            field.fieldName,
-            field.arguments,
-            variables,
-          );
-          if (altLink === undefined) {
-            return {
-              kind: 'MissingData',
-              reason:
-                'No link for ' +
-                storeRecordName +
-                ' on root ' +
-                root +
-                '. Link is ' +
-                JSON.stringify(value),
-            };
-          } else {
-            link = altLink;
-          }
-        } else if (link === null) {
-          target[field.alias ?? field.fieldName] = null;
-          break;
-        }
-        const targetId = link.__link;
-        const data = readData(
-          environment,
-          field.selections,
-          targetId,
-          variables,
-          nestedRefetchQueries,
-        );
-        if (data.kind === 'MissingData') {
-          return {
-            kind: 'MissingData',
-            reason: 'Missing data for ' + storeRecordName + ' on root ' + root,
-            nestedReason: data,
-          };
-        }
-        target[field.alias ?? field.fieldName] = data.data;
-        break;
-      }
-      case 'RefetchField': {
-        const data = readData(
-          environment,
-          field.readerArtifact.readerAst,
-          root,
-          variables,
-          // Refetch fields just read the id, and don't need refetch query artifacts
-          [],
-        );
-        if (typeof window !== 'undefined' && window.__LOG) {
-          console.log('refetch field data', data, field);
-        }
-        if (data.kind === 'MissingData') {
-          return {
-            kind: 'MissingData',
-            reason: 'Missing data for ' + field.alias + ' on root ' + root,
-            nestedReason: data,
-          };
-        } else {
-          const refetchQueryIndex = field.refetchQuery;
-          if (refetchQueryIndex == null) {
-            throw new Error('refetchQuery is null in RefetchField');
-          }
-          const refetchQuery = nestedRefetchQueries[refetchQueryIndex];
-          const refetchQueryArtifact = refetchQuery.artifact;
-          const allowedVariables = refetchQuery.allowedVariables;
-
-          target[field.alias] = field.readerArtifact.resolver(
-            environment,
-            // resolvers for refetch fields take 3 args, and this is not reflected in types
-            // @ts-expect-error
-            refetchQueryArtifact,
-            {
-              ...data.data,
-              // TODO continue from here
-              // variables need to be filtered for what we need just for the refetch query
-              ...filterVariables(variables, allowedVariables),
-            },
-          );
-        }
-        break;
-      }
-      case 'MutationField': {
-        const data = readData(
-          environment,
-          field.readerArtifact.readerAst,
-          root,
-          variables,
-          // Refetch fields just read the id, and don't need refetch query artifacts
-          [],
-        );
-        if (typeof window !== 'undefined' && window.__LOG) {
-          console.log('refetch field data', data, field);
-        }
-        if (data.kind === 'MissingData') {
-          return {
-            kind: 'MissingData',
-            reason: 'Missing data for ' + field.alias + ' on root ' + root,
-            nestedReason: data,
-          };
-        } else {
-          const refetchQueryIndex = field.refetchQuery;
-          if (refetchQueryIndex == null) {
-            throw new Error('refetchQuery is null in MutationField');
-          }
-          const refetchQuery = nestedRefetchQueries[refetchQueryIndex];
-          const refetchQueryArtifact = refetchQuery.artifact;
-          const allowedVariables = refetchQuery.allowedVariables;
-
-          target[field.alias] = field.readerArtifact.resolver(
-            environment,
-            // @ts-expect-error
-            refetchQueryArtifact,
-            data.data,
-            filterVariables(variables, allowedVariables),
-          );
-        }
-        break;
-      }
-      case 'Resolver': {
-        const usedRefetchQueries = field.usedRefetchQueries;
-        const resolverRefetchQueries = usedRefetchQueries.map(
-          (index) => nestedRefetchQueries[index],
-        );
-
-        const variant = field.readerArtifact.variant;
-        if (variant.kind === 'Eager') {
-          const data = readData(
-            environment,
-            field.readerArtifact.readerAst,
-            root,
-            variables,
-            resolverRefetchQueries,
-          );
-          if (data.kind === 'MissingData') {
-            return {
-              kind: 'MissingData',
-              reason: 'Missing data for ' + field.alias + ' on root ' + root,
-              nestedReason: data,
-            };
-          } else {
-            target[field.alias] = field.readerArtifact.resolver(data.data);
-          }
-        } else if (variant.kind === 'Component') {
-          target[field.alias] = getOrCreateCachedComponent(
-            environment,
-            root,
-            variant.componentName,
-            field.readerArtifact,
-            variables,
-            resolverRefetchQueries,
-          );
-        }
-        break;
-      }
-    }
-  }
-  return { kind: 'Success', data: target as any };
-}
-
-export function defaultMissingFieldHandler(
-  _storeRecord: StoreRecord,
-  _root: DataId,
-  fieldName: string,
-  arguments_: { [index: string]: any } | null,
-  variables: { [index: string]: any } | null,
-): Link | undefined {
-  if (fieldName === 'node' || fieldName === 'user') {
-    const variable = arguments_?.['id'];
-    const value = variables?.[variable];
-
-    // TODO can we handle explicit nulls here too? Probably, after wrapping in objects
-    if (value != null) {
-      return { __link: value };
-    }
-  }
-}
-
-function assertLink(link: DataTypeValue): Link | undefined | null {
-  if (Array.isArray(link)) {
-    throw new Error('Unexpected array');
-  }
-  if (typeof link === 'object') {
-    return link;
-  }
-  if (link === undefined) {
-    return undefined;
-  }
-  throw new Error('Invalid link');
-}
-
-export type IsographComponentProps<TDataType, TOtherProps = Object> = {
-  data: TDataType;
-} & TOtherProps;
-
-function filterVariables(
-  variables: { [index: string]: string },
-  allowedVariables: string[],
-): { [index: string]: string } {
-  const result: { [index: string]: string } = {};
-  for (const key of allowedVariables) {
-    result[key] = variables[key];
-  }
-  return result;
-}