Take LoadingType into account in types

HoudiniGraphql · Nov 11, 2024 · c9d3466 · c9d3466
1 parent 7287f24
commit c9d3466
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 7 deletions.
diff --git a/.changeset/sour-starfishes-push.md b/.changeset/sour-starfishes-push.md
@@ -0,0 +1,6 @@
+---
+'houdini': minor
+'houdini-svelte': patch
+---
+
+Add new types GraphQLLoadedValue and GraphQLLoadedObject, and include LoadingType in GraphQLValue
diff --git a/packages/houdini-svelte/src/runtime/stores/subscription.ts b/packages/houdini-svelte/src/runtime/stores/subscription.ts
@@ -1,18 +1,18 @@
 import type {
+	GraphQLLoadedObject,
 	GraphQLVariables,
 	QueryResult,
 	SubscriptionArtifact,
 } from '$houdini/runtime/lib/types'
 import { CompiledSubscriptionKind } from '$houdini/runtime/lib/types'
-import type { GraphQLObject } from 'houdini'
 import { derived, writable, type Subscriber, type Writable } from 'svelte/store'
 
 import { initClient } from '../client'
 import { getSession } from '../session'
 import { BaseStore } from './base'
 
 export class SubscriptionStore<
-	_Data extends GraphQLObject,
+	_Data extends GraphQLLoadedObject,
 	_Input extends GraphQLVariables
 > extends BaseStore<_Data, _Input, SubscriptionArtifact> {
 	kind = CompiledSubscriptionKind

diff --git a/packages/houdini/src/runtime/cache/cache.ts b/packages/houdini/src/runtime/cache/cache.ts
@@ -1,10 +1,12 @@
 import { computeKey, PendingValue } from '../lib'
 import type { ConfigFile } from '../lib/config'
-import { computeID, defaultConfigValues, keyFieldsForType, getCurrentConfig } from '../lib/config'
+import { computeID, defaultConfigValues, getCurrentConfig, keyFieldsForType } from '../lib/config'
 import { deepEquals } from '../lib/deepEquals'
 import { flatten } from '../lib/flatten'
 import { getFieldsForType } from '../lib/selection'
 import type {
+	GraphQLLoadedObject,
+	GraphQLLoadedValue,
 	GraphQLObject,
 	GraphQLValue,
 	NestedList,
@@ -1535,7 +1537,7 @@ class CacheInternal {
 	}
 }
 
-export function evaluateVariables(variables: ValueMap, args: GraphQLObject) {
+export function evaluateVariables(variables: ValueMap, args: GraphQLLoadedObject) {
 	return Object.fromEntries(
 		Object.entries(variables).map(([key, value]) => [key, variableValue(value, args)])
 	)
@@ -1548,7 +1550,7 @@ function wrapInLists<T>(target: T, count: number = 0): T | NestedList<T> {
 	return wrapInLists([target], count - 1)
 }
 
-export function variableValue(value: ValueNode, args: GraphQLObject): GraphQLValue {
+export function variableValue(value: ValueNode, args: GraphQLLoadedObject): GraphQLLoadedValue {
 	if (value.kind === 'StringValue') {
 		return value.value
 	}
@@ -1607,7 +1609,7 @@ export function defaultComponentField({
 	cache: Cache
 	component: Required<Required<SubscriptionSelection>['fields'][string]>['component']
 	loading?: boolean
-	variables: Record<string, GraphQLValue> | undefined | null
+	variables: Record<string, GraphQLLoadedValue> | undefined | null
 	parent: string
 }) {
 	return (props: any) => {

diff --git a/packages/houdini/src/runtime/lib/types.ts b/packages/houdini/src/runtime/lib/types.ts
@@ -173,9 +173,26 @@ export type MutationOperation = {
 
 export type GraphQLObject = { [key: string]: GraphQLValue }
 
+export type GraphQLLoadedObject = {
+	[key: string]: GraphQLLoadedValue
+}
+
 export type GraphQLDefaultScalar = string | number | boolean
 
-export type GraphQLValue = GraphQLDefaultScalar | null | GraphQLObject | GraphQLValue[] | undefined
+export type GraphQLLoadedValue =
+	| GraphQLDefaultScalar
+	| null
+	| GraphQLLoadedObject
+	| GraphQLLoadedValue[]
+	| undefined
+
+export type GraphQLValue =
+	| LoadingType
+	| GraphQLDefaultScalar
+	| null
+	| GraphQLObject
+	| GraphQLValue[]
+	| undefined
 
 export type GraphQLVariables = { [key: string]: any } | null