Client provider subscription support

.gitignore

@@ -195,3 +195,6 @@ docs/content/release-notes.md
 .fake
 docs/tools/FSharp.Formatting.svclog
 project.lock.json
+
+# Ionide folder
+.ionide

build.fsx

@@ -151,6 +151,7 @@ Target.create "AssemblyInfo" (fun _ ->
         | f when f.EndsWith "FSharp.Data.GraphQL.Shared.fsproj" -> 
             [ AssemblyInfo.InternalsVisibleTo "FSharp.Data.GraphQL.Server"
               AssemblyInfo.InternalsVisibleTo "FSharp.Data.GraphQL.Client"
+              AssemblyInfo.InternalsVisibleTo "FSharp.Data.GraphQL.Client.DesignTime"
               AssemblyInfo.InternalsVisibleTo "FSharp.Data.GraphQL.Tests" ]
         | f when f.EndsWith "FSharp.Data.GraphQL.Server.fsproj" -> 
             [ AssemblyInfo.InternalsVisibleTo "FSharp.Data.GraphQL.Benchmarks"

paket.dependencies

@@ -18,8 +18,8 @@ group Common
 
   # Those are needed for the client type provider.
   nuget NETStandard.Library.NETFramework
-  github fsprojects/FSharp.TypeProviders.SDK src/ProvidedTypes.fsi
-  github fsprojects/FSharp.TypeProviders.SDK src/ProvidedTypes.fs
+  github fsprojects/FSharp.TypeProviders.SDK:c8fc89b0e8bac34e321372b004de76d600651cda src/ProvidedTypes.fsi
+  github fsprojects/FSharp.TypeProviders.SDK:c8fc89b0e8bac34e321372b004de76d600651cda src/ProvidedTypes.fs
 
 group TestsAndSamples
   source https://api.nuget.org/v3/index.json

src/FSharp.Data.GraphQL.Client.DesignTime/FSharp.Data.GraphQL.Client.DesignTime.fsproj

@@ -26,6 +26,7 @@
     <Compile Include="..\FSharp.Data.GraphQL.Client\Schema.fs" />
     <Compile Include="..\FSharp.Data.GraphQL.Client\ReflectionPatterns.fs" />
     <Compile Include="..\FSharp.Data.GraphQL.Client\Serialization.fs" />
+    <Compile Include="..\FSharp.Data.GraphQL.Client\Subscriptions.fs" />
     <Compile Include="..\FSharp.Data.GraphQL.Client\GraphQLClient.fs" />
     <Compile Include="..\FSharp.Data.GraphQL.Client\GraphQLProviderRuntimeContext.fs" />
     <Compile Include="..\FSharp.Data.GraphQL.Client\Locations.fs" />

src/FSharp.Data.GraphQL.Client.DesignTime/paket.references

@@ -1,4 +1,5 @@
 group Common
 FSharp.Core
+System.Reactive
 File:ProvidedTypes.fsi
 File:ProvidedTypes.fs

src/FSharp.Data.GraphQL.Client/BaseTypes.fs

@@ -10,8 +10,9 @@ open FSharp.Data.GraphQL.Client
 open FSharp.Data.GraphQL.Client.ReflectionPatterns
 open FSharp.Data.GraphQL.Types.Introspection
 open System.Text
-open FSharp.Data.GraphQL.Ast.Extensions
 open System.ComponentModel
+open System.Collections
+open System.Collections.Generic
 
 /// Contains information about a field on the query.
 type SchemaFieldInfo =
@@ -25,6 +26,31 @@ type SchemaFieldInfo =
 /// A type alias to represent a Type name.
 type TypeName = string
 
+/// A representation of a Path item.
+type PathItem =
+    /// Indicates that this path item refers to an index of another item inside a list field.
+    | Index of int
+    /// Indicates that this path item refers to a field or type name.
+    | Name of string
+
+/// A representation for a path field type inside a GraphQL deferred result.
+type Path (items : PathItem seq) =
+    let items = Array.ofSeq items
+
+    new (items : obj seq) =
+        let mapper (x : obj) =
+            match x with
+            | :? int as x -> Index x
+            | :? string as x -> Name x
+            | _ -> failwith "Error mapping item array to path. One of the items is neither a System.Int32 or a System.String."
+        Path(Seq.map mapper items)
+
+    interface IEnumerable<PathItem> with
+        member __.GetEnumerator() = (items :> IEnumerable<PathItem>).GetEnumerator()
+
+    interface IEnumerable with
+        member __.GetEnumerator() = items.GetEnumerator()
+
 /// Contains data about a GQL operation error.
 type OperationError =
       /// The description of the error that happened in the operation.
@@ -368,7 +394,17 @@ module internal JsonValueHelper =
             | other -> failwithf "Error parsing response errors. Expected error to be a Record type, but it is %s." (other.ToString())
         Array.map errorMapper errors
 
+    let getResponsePath (responseJson : JsonValue) =
+        match getResponseFields responseJson |> Array.tryFind (fun (name, _) -> name = "path") with
+        | Some (_, path) ->
+            match path with
+            | JsonValue.Array items -> Some items
+            | JsonValue.Null -> None
+            | _ -> failwithf "Expected path field of root to be a Record type, but type is %A." path
+        | None -> None
+
 /// The base type for all GraphQLProvider operation result provided types.
+[<NoEquality; NoComparison>]
 type OperationResultBase (responseJson : JsonValue, operationFields : SchemaFieldInfo [], operationTypeName : string) =
     let rawData = 
         let data = JsonValueHelper.getResponseDataFields responseJson
@@ -389,8 +425,6 @@ type OperationResultBase (responseJson : JsonValue, operationFields : SchemaFiel
         JsonValueHelper.getResponseCustomFields responseJson
         |> Serialization.deserializeMap
 
-    member private __.ResponseJson = responseJson
-
     /// [omit]
     [<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
     [<CompilerMessageAttribute("This property is intended for use in generated code only.", 10001, IsHidden=true, IsError=false)>]
@@ -402,17 +436,34 @@ type OperationResultBase (responseJson : JsonValue, operationFields : SchemaFiel
     /// Gets all the custom data returned by the operation on server as a map of names and values.
     member __.CustomData = customData
 
-    member x.Equals(other : OperationResultBase) =
-        x.ResponseJson = other.ResponseJson
-
-    override x.Equals(other : obj) =
-        match other with
-        | :? OperationResultBase as other -> x.Equals(other)
-        | _ -> false
-
-    override x.GetHashCode() = x.ResponseJson.GetHashCode()
-
 /// The base type for al GraphQLProvider operation provided types.
 type OperationBase (query : string) =
     /// Gets the query string of the operation.
-    member __.Query = query
+    member __.Query = query
+
+/// The base type for all GraphQLProvider deferred operation result provided types.
+[<NoEquality; NoComparison>]
+type DeferredResultBase (responseJson : JsonValue, operationFields : SchemaFieldInfo [], operationTypeName : string) =
+    inherit OperationResultBase (responseJson, operationFields, operationTypeName)
+
+    let path = 
+        let path = JsonValueHelper.getResponsePath responseJson
+        let mapper (x : JsonValue) =
+            match x with
+            | JsonValue.Integer x -> Index x
+            | JsonValue.String x -> Name x
+            | _ -> failwith "Error parsing response path. One of the path items is neither an Integer value or a String value."
+        match path with
+        | Some [||] | None -> None
+        | Some path -> path |> Array.map mapper |> Path |> Some
+
+    /// Gets the path referring to the current deferred result.
+    member __.Path = path
+
+/// The base type for all GraphQLProvider subscription result provided types.
+[<NoEquality; NoComparison>]
+type SubscriptionResultBase (responseJson : JsonValue, deferredResponseJson : IObservable<JsonValue>, operationFields : SchemaFieldInfo [], operationTypeName : string) =
+    inherit OperationResultBase (responseJson, operationFields, operationTypeName)
+
+    /// Gets the deferred results of the subscription operation as an observable.
+    member __.RawDeferred = deferredResponseJson |> Observable.map (fun responseJson -> DeferredResultBase(responseJson, operationFields, operationTypeName))

src/FSharp.Data.GraphQL.Client/FSharp.Data.GraphQL.Client.fsproj

@@ -19,6 +19,7 @@
     <Compile Include="GraphQLClient.fs" />
     <Compile Include="GraphQLProviderRuntimeContext.fs" />
     <Compile Include="Locations.fs" />
+    <Compile Include="Subscriptions.fs" />
     <Compile Include="BaseTypes.fs" />
     <Compile Include="GraphQLProvider.Runtime.fs" />
     <None Include="FSharp.Data.GraphQL.Client.fsproj.paket.template" />