improve(types): readable result types (#1183)

Author: jasonkuhrt

src/layers/2_Select/SelectAlias.ts

@@ -4,7 +4,12 @@ export type SelectAlias<$SelectionSet = AnyExceptAlias> =
   | SelectAliasOne<$SelectionSet>
   | SelectAliasMultiple<$SelectionSet>
 
-export type SelectAliasOne<$SelectionSet = AnyExceptAlias> = [alias: string, selectionSet: $SelectionSet]
+// dprint-ignore
+export type SelectAliasOne<$SelectionSet = AnyExceptAlias> =
+  [
+    alias: string,
+    selectionSet: $SelectionSet
+  ]
 
 export type SelectAliasMultiple<$SelectionSet = AnyExceptAlias> = [
   ...SelectAliasOne<$SelectionSet>[],

src/layers/2_Select/selectionSet.ts

@@ -4,14 +4,14 @@ import type { Indicator } from './Indicator/__.js'
 import { type SelectAlias } from './SelectAlias.js'
 
 export type AnySelectionSet = {
-  [k: string]: FieldValue
-} & SpecialFields
-
-interface SpecialFields extends Directive.$Fields {
-  // todo - this requires having the schema at runtime to know which fields to select.
-  // $scalars?: SelectionSet.Indicator
-  $?: ArgsObject
-}
+  [k: string]: FieldValue | ArgsObject
+} // & SpecialFields
+
+// interface SpecialFields extends Directive.$Fields {
+//   // todo - this requires having the schema at runtime to know which fields to select.
+//   // $scalars?: SelectionSet.Indicator
+//   // $?: any // ArgsObject
+// }
 
 export type FieldValue = AnySelectionSet | Indicator.Indicator
 

src/layers/3_InferResult/Alias.ts

@@ -36,7 +36,7 @@ type InferSelectAlias<
 > =
   $SelectAlias extends Select.SelectAlias.SelectAliasOne      ? InferSelectAliasOne<$SelectAlias, $FieldName, $Schema, $Node> :
   $SelectAlias extends Select.SelectAlias.SelectAliasMultiple ? InferSelectAliasMultiple<$SelectAlias, $FieldName, $Schema, $Node> :
-                                                                            never
+                                                                never
 
 type InferSelectAliasMultiple<
   $SelectAliasMultiple extends Select.SelectAlias.SelectAliasMultiple,

src/layers/3_InferResult/__.test-d.ts

@@ -84,8 +84,12 @@ AssertEqual<$<{ interfaceWithArgs: { $:{id:'abc'}; id: true }}>, { interfaceWith
 // todo alias on interfaces, interface fragments
 // Alias
 // scalar
-AssertEqual<$<{ id: ['id2', true] }>, { id2: null | string }>()
-AssertEqual<$<{ idNonNull: ['id2', true] }>, { id2: string }>()
+AssertEqual<$<{ id: ['x', true] }>, { x: null | string }>()
+AssertEqual<$<{ idNonNull: ['x', true] }>, { x: string }>()
+// object
+AssertEqual<$<{ object: ['x', { id: true }] }>, { x: { id: null|string } | null }>()
+// argument
+AssertEqual<$<{objectWithArgs: ['x', { $: {id:''}; id:true }]}>, { x: { id: null|string } | null }>()
 // multi
 AssertEqual<$<{ id: [['id1', true],['id2', true]] }>, { id1: null | string; id2: null | string }>()
 // AssertEqual<RS<{ id_as: true }>, { id_as: InferResult.Errors.UnknownFieldName<'id_as', Schema.Root.Query> }>()