@isograph/react 0.0.0-main-b393b172 → 0.0.0-main-ce52cee9

package/dist/FragmentReference.d.ts

@@ -1,9 +1,9 @@
 import { DataId } from './IsographEnvironment';
 import { RefetchQueryNormalizationArtifactWrapper } from './entrypoint';
 import { TopLevelReaderArtifact } from './reader';
-export type Variable = any;
+export type VariableValue = string | number | boolean | null | object;
 export type Variables = {
-    readonly [index: string]: Variable;
+    readonly [index: string]: VariableValue;
 };
 export type FragmentReference<TReadFromStore extends Object, TClientFieldValue> = {
     readonly kind: 'FragmentReference';

package/dist/IsographEnvironment.d.ts

@@ -2,7 +2,7 @@
 import { ParentCache } from '@isograph/react-disposable-state';
 import { RetainedQuery } from './garbageCollection';
 import { WithEncounteredRecords } from './read';
-import { FragmentReference } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 export type ComponentOrFieldName = string;
 export type StringifiedArgs = string;
 type ComponentCache = {
@@ -41,10 +41,8 @@ export type IsographEnvironment = {
 };
 export type MissingFieldHandler = (storeRecord: StoreRecord, root: DataId, fieldName: string, arguments_: {
     [index: string]: any;
-} | null, variables: {
-    [index: string]: any;
-} | null) => Link | undefined;
-export type IsographNetworkFunction = (queryText: string, variables: object) => Promise<any>;
+} | null, variables: Variables | null) => Link | undefined;
+export type IsographNetworkFunction = (queryText: string, variables: Variables) => Promise<any>;
 export type Link = {
     readonly __link: DataId;
 };
@@ -65,9 +63,7 @@ export declare function createIsographStore(): {
 };
 export declare function defaultMissingFieldHandler(_storeRecord: StoreRecord, _root: DataId, fieldName: string, arguments_: {
     [index: string]: any;
-} | null, variables: {
-    [index: string]: any;
-} | null): Link | undefined;
+} | null, variables: Variables | null): Link | undefined;
 export declare function assertLink(link: DataTypeValue): Link | null | undefined;
 export declare function getLink(maybeLink: DataTypeValue): Link | null;
 export {};

package/dist/IsographEnvironment.js

@@ -29,6 +29,7 @@ function defaultMissingFieldHandler(_storeRecord, _root, fieldName, arguments_,
         const value = variables === null || variables === void 0 ? void 0 : variables[variable];
         // TODO can we handle explicit nulls here too? Probably, after wrapping in objects
         if (value != null) {
+            // @ts-expect-error
             return { __link: value };
         }
     }

package/dist/cache.d.ts

@@ -4,7 +4,7 @@ import { type IsographEnvironment } from './IsographEnvironment';
 import { IsographEntrypoint, NormalizationLinkedField, NormalizationScalarField, RefetchQueryNormalizationArtifact } from './entrypoint';
 import { ReaderLinkedField, ReaderScalarField } from './reader';
 import { WithEncounteredRecords } from './read';
-import { FragmentReference } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 declare global {
     interface Window {
         __LOG: boolean;
@@ -16,13 +16,11 @@ declare global {
  * results.
  */
 export declare function stableCopy<T>(value: T): T;
-export declare function getOrCreateCacheForArtifact<TReadFromStore extends Object, TClientFieldValue>(environment: IsographEnvironment, artifact: IsographEntrypoint<TReadFromStore, TClientFieldValue>, variables: object): ParentCache<PromiseWrapper<TClientFieldValue>>;
-export declare function makeNetworkRequest<T>(environment: IsographEnvironment, artifact: RefetchQueryNormalizationArtifact | IsographEntrypoint<any, any>, variables: object): ItemCleanupPair<PromiseWrapper<T>>;
+export declare function getOrCreateCacheForArtifact<TReadFromStore extends Object, TClientFieldValue>(environment: IsographEnvironment, artifact: IsographEntrypoint<TReadFromStore, TClientFieldValue>, variables: Variables): ParentCache<PromiseWrapper<TClientFieldValue>>;
+export declare function makeNetworkRequest<T>(environment: IsographEnvironment, artifact: RefetchQueryNormalizationArtifact | IsographEntrypoint<any, any>, variables: Variables): ItemCleanupPair<PromiseWrapper<T>>;
 export declare function subscribeToAnyChange(environment: IsographEnvironment, callback: () => void): () => void;
 export declare function subscribe<TReadFromStore extends Object>(environment: IsographEnvironment, encounteredDataAndRecords: WithEncounteredRecords<TReadFromStore>, fragmentReference: FragmentReference<TReadFromStore, any>, callback: (newEncounteredDataAndRecords: WithEncounteredRecords<TReadFromStore>) => void): () => void;
 export declare function onNextChange(environment: IsographEnvironment): Promise<void>;
-export declare function getParentRecordKey(astNode: NormalizationLinkedField | NormalizationScalarField | ReaderLinkedField | ReaderScalarField, variables: {
-    [index: string]: string;
-}): string;
+export declare function getParentRecordKey(astNode: NormalizationLinkedField | NormalizationScalarField | ReaderLinkedField | ReaderScalarField, variables: Variables): string;
 export declare const FIRST_SPLIT_KEY = "____";
 export declare const SECOND_SPLIT_KEY = "___";

package/dist/read.js

@@ -219,6 +219,7 @@ function readData(environment, ast, root, variables, nestedRefetchQueries, mutab
 function filterVariables(variables, allowedVariables) {
     const result = {};
     for (const key of allowedVariables) {
+        // @ts-expect-error
         result[key] = variables[key];
     }
     return result;

package/dist/useImperativeReference.d.ts

@@ -1,9 +1,7 @@
 import { UnassignedState } from '@isograph/react-disposable-state';
 import { IsographEntrypoint } from './entrypoint';
-import { FragmentReference } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 export declare function useImperativeReference<TReadFromStore extends Object, TClientFieldValue>(entrypoint: IsographEntrypoint<TReadFromStore, TClientFieldValue>): {
     queryReference: FragmentReference<TReadFromStore, TClientFieldValue> | UnassignedState;
-    loadQueryReference: (variables: {
-        [index: string]: string;
-    }) => void;
+    loadQueryReference: (variables: Variables) => void;
 };

package/dist/useLazyReference.d.ts

@@ -1,7 +1,5 @@
-import { FragmentReference, Variable } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 import { IsographEntrypoint } from './entrypoint';
-export declare function useLazyReference<TReadFromStore extends Object, TClientFieldValue>(entrypoint: IsographEntrypoint<TReadFromStore, TClientFieldValue>, variables: {
-    [key: string]: Variable;
-}): {
+export declare function useLazyReference<TReadFromStore extends Object, TClientFieldValue>(entrypoint: IsographEntrypoint<TReadFromStore, TClientFieldValue>, variables: Variables): {
     queryReference: FragmentReference<TReadFromStore, TClientFieldValue>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isograph/react",
-  "version": "0.0.0-main-b393b172",
+  "version": "0.0.0-main-ce52cee9",
   "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-b393b172",
-    "@isograph/react-disposable-state": "0.0.0-main-b393b172",
+    "@isograph/disposable-types": "0.0.0-main-ce52cee9",
+    "@isograph/react-disposable-state": "0.0.0-main-ce52cee9",
     "react": "^18.2.0"
   },
   "devDependencies": {

package/src/FragmentReference.ts

@@ -3,9 +3,9 @@ import { RefetchQueryNormalizationArtifactWrapper } from './entrypoint';
 import { TopLevelReaderArtifact } from './reader';
 
 // TODO type this better
-export type Variable = any;
+export type VariableValue = string | number | boolean | null | object;
 
-export type Variables = { readonly [index: string]: Variable };
+export type Variables = { readonly [index: string]: VariableValue };
 
 export type FragmentReference<
   TReadFromStore extends Object,

package/src/IsographEnvironment.tsx

@@ -1,7 +1,7 @@
 import { ParentCache } from '@isograph/react-disposable-state';
 import { RetainedQuery } from './garbageCollection';
 import { WithEncounteredRecords } from './read';
-import { FragmentReference } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 
 export type ComponentOrFieldName = string;
 export type StringifiedArgs = string;
@@ -46,12 +46,12 @@ export type MissingFieldHandler = (
   root: DataId,
   fieldName: string,
   arguments_: { [index: string]: any } | null,
-  variables: { [index: string]: any } | null,
+  variables: Variables | null,
 ) => Link | undefined;
 
 export type IsographNetworkFunction = (
   queryText: string,
-  variables: object,
+  variables: Variables,
 ) => Promise<any>;
 
 export type Link = {
@@ -118,7 +118,7 @@ export function defaultMissingFieldHandler(
   _root: DataId,
   fieldName: string,
   arguments_: { [index: string]: any } | null,
-  variables: { [index: string]: any } | null,
+  variables: Variables | null,
 ): Link | undefined {
   if (fieldName === 'node' || fieldName === 'user') {
     const variable = arguments_?.['id'];
@@ -126,6 +126,7 @@ export function defaultMissingFieldHandler(
 
     // TODO can we handle explicit nulls here too? Probably, after wrapping in objects
     if (value != null) {
+      // @ts-expect-error
       return { __link: value };
     }
   }

package/src/cache.ts

@@ -30,7 +30,7 @@ import {
 import { ReaderLinkedField, ReaderScalarField } from './reader';
 import { Argument, ArgumentValue } from './util';
 import { WithEncounteredRecords, readButDoNotEvaluate } from './read';
-import { FragmentReference } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 import { areEqualObjectsWithDeepComparison } from './areEqualWithDeepComparison';
 
 declare global {
@@ -86,7 +86,7 @@ export function getOrCreateCacheForArtifact<
 >(
   environment: IsographEnvironment,
   artifact: IsographEntrypoint<TReadFromStore, TClientFieldValue>,
-  variables: object,
+  variables: Variables,
 ): ParentCache<PromiseWrapper<TClientFieldValue>> {
   const cacheKey = artifact.queryText + JSON.stringify(stableCopy(variables));
   const factory: Factory<PromiseWrapper<TClientFieldValue>> = () =>
@@ -113,7 +113,7 @@ type NetworkRequestStatus =
 export function makeNetworkRequest<T>(
   environment: IsographEnvironment,
   artifact: RefetchQueryNormalizationArtifact | IsographEntrypoint<any, any>,
-  variables: object,
+  variables: Variables,
 ): ItemCleanupPair<PromiseWrapper<T>> {
   if (typeof window !== 'undefined' && window.__LOG) {
     console.log('make network request', artifact, variables);
@@ -191,7 +191,7 @@ function normalizeData(
   environment: IsographEnvironment,
   normalizationAst: NormalizationAst,
   networkResponse: NetworkResponseObject,
-  variables: Object,
+  variables: Variables,
   nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[],
 ): Set<DataId> {
   const encounteredIds = new Set<DataId>();
@@ -342,7 +342,7 @@ function normalizeDataIntoRecord(
   networkResponseParentRecord: NetworkResponseObject,
   targetParentRecord: StoreRecord,
   targetParentRecordId: DataId,
-  variables: { [index: string]: string },
+  variables: Variables,
   nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[],
   mutableEncounteredIds: Set<DataId>,
 ) {
@@ -387,7 +387,7 @@ function normalizeScalarField(
   astNode: NormalizationScalarField,
   networkResponseParentRecord: NetworkResponseObject,
   targetStoreRecord: StoreRecord,
-  variables: { [index: string]: string },
+  variables: Variables,
 ): RecordHasBeenUpdated {
   const networkResponseKey = getNetworkResponseKey(astNode);
   const networkResponseData = networkResponseParentRecord[networkResponseKey];
@@ -414,7 +414,7 @@ function normalizeLinkedField(
   networkResponseParentRecord: NetworkResponseObject,
   targetParentRecord: StoreRecord,
   targetParentRecordId: DataId,
-  variables: { [index: string]: string },
+  variables: Variables,
   nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[],
   mutableEncounteredIds: Set<DataId>,
 ): RecordHasBeenUpdated {
@@ -501,7 +501,7 @@ function normalizeNetworkResponseObject(
   astNode: NormalizationLinkedField,
   networkResponseData: NetworkResponseObject,
   targetParentRecordId: string,
-  variables: { [index: string]: string },
+  variables: Variables,
   index: number | null,
   nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[],
   mutableEncounteredIds: Set<DataId>,
@@ -570,7 +570,7 @@ export function getParentRecordKey(
     | NormalizationScalarField
     | ReaderLinkedField
     | ReaderScalarField,
-  variables: { [index: string]: string },
+  variables: Variables,
 ): string {
   let parentRecordKey = astNode.fieldName;
   const fieldParameters = astNode.arguments;
@@ -585,7 +585,7 @@ export function getParentRecordKey(
 
 function getStoreKeyChunkForArgumentValue(
   argumentValue: ArgumentValue,
-  variables: { [index: string]: string },
+  variables: Variables,
 ) {
   switch (argumentValue.kind) {
     case 'Literal': {
@@ -603,10 +603,7 @@ function getStoreKeyChunkForArgumentValue(
   }
 }
 
-function getStoreKeyChunkForArgument(
-  argument: Argument,
-  variables: { [index: string]: string },
-) {
+function getStoreKeyChunkForArgument(argument: Argument, variables: Variables) {
   const chunk = getStoreKeyChunkForArgumentValue(argument[1], variables);
   return `${FIRST_SPLIT_KEY}${argument[0]}${SECOND_SPLIT_KEY}${chunk}`;
 }
@@ -650,7 +647,7 @@ function getDataIdOfNetworkResponse(
   parentRecordId: DataId,
   dataToNormalize: NetworkResponseObject,
   astNode: NormalizationLinkedField | NormalizationScalarField,
-  variables: { [index: string]: string },
+  variables: Variables,
   index: number | null,
 ): DataId {
   // Check whether the dataToNormalize has an id field. If so, that is the key.

package/src/garbageCollection.ts

@@ -1,3 +1,4 @@
+import { Variables } from './FragmentReference';
 import {
   DataId,
   IsographEnvironment,
@@ -76,7 +77,7 @@ function recordReachableIdsFromRecord(
   currentRecord: StoreRecord,
   mutableRetainedIds: Set<DataId>,
   selections: NormalizationAst,
-  variables: { [index: string]: string } | null,
+  variables: Variables | null,
 ) {
   for (const selection of selections) {
     switch (selection.kind) {

package/src/read.ts

@@ -1,7 +1,7 @@
 import { getParentRecordKey, onNextChange } from './cache';
 import { getOrCreateCachedComponent } from './componentCache';
 import { RefetchQueryNormalizationArtifactWrapper } from './entrypoint';
-import { FragmentReference } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 import {
   assertLink,
   DataId,
@@ -57,7 +57,7 @@ function readData<TReadFromStore>(
   environment: IsographEnvironment,
   ast: ReaderAst<TReadFromStore>,
   root: DataId,
-  variables: { [index: string]: string },
+  variables: Variables,
   nestedRefetchQueries: RefetchQueryNormalizationArtifactWrapper[],
   mutableEncounteredRecords: Set<DataId>,
 ): ReadDataResult<TReadFromStore> {
@@ -315,11 +315,12 @@ function readData<TReadFromStore>(
 }
 
 function filterVariables(
-  variables: { [index: string]: string },
+  variables: Variables,
   allowedVariables: string[],
-): { [index: string]: string } {
-  const result: { [index: string]: string } = {};
+): Variables {
+  const result: Variables = {};
   for (const key of allowedVariables) {
+    // @ts-expect-error
     result[key] = variables[key];
   }
   return result;

package/src/useImperativeReference.ts

@@ -3,7 +3,7 @@ import {
   useUpdatableDisposableState,
 } from '@isograph/react-disposable-state';
 import { IsographEntrypoint } from './entrypoint';
-import { FragmentReference } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 import { useIsographEnvironment } from './IsographEnvironmentProvider';
 import { makeNetworkRequest } from './cache';
 import { ROOT_ID } from './IsographEnvironment';
@@ -17,7 +17,7 @@ export function useImperativeReference<
   queryReference:
     | FragmentReference<TReadFromStore, TClientFieldValue>
     | UnassignedState;
-  loadQueryReference: (variables: { [index: string]: string }) => void;
+  loadQueryReference: (variables: Variables) => void;
 } {
   const { state, setState } =
     useUpdatableDisposableState<
@@ -26,7 +26,7 @@ export function useImperativeReference<
   const environment = useIsographEnvironment();
   return {
     queryReference: state,
-    loadQueryReference: (variables: { [index: string]: string }) => {
+    loadQueryReference: (variables: Variables) => {
       const [_networkRequest, disposeNetworkRequest] = makeNetworkRequest(
         environment,
         entrypoint,

package/src/useLazyReference.ts

@@ -1,4 +1,4 @@
-import { FragmentReference, Variable } from './FragmentReference';
+import { FragmentReference, Variables } from './FragmentReference';
 import { useIsographEnvironment } from './IsographEnvironmentProvider';
 import { ROOT_ID } from './IsographEnvironment';
 import { IsographEntrypoint } from './entrypoint';
@@ -10,7 +10,7 @@ export function useLazyReference<
   TClientFieldValue,
 >(
   entrypoint: IsographEntrypoint<TReadFromStore, TClientFieldValue>,
-  variables: { [key: string]: Variable },
+  variables: Variables,
 ): {
   queryReference: FragmentReference<TReadFromStore, TClientFieldValue>;
 } {