GQL Json RTE content to HTML support added

Author: uttamukkoji

.talismanrc

@@ -2,4 +2,16 @@ fileignoreconfig:
 - filename: README.md
   allowed_patterns: [API_KEY, DELIVERY_TOKEN, ENVIRONMENT]
 - filename: ContentstackUtils.xcodeproj/project.pbxproj
-  checksum: 5b62a76622fed7df9967d8646467bd2f04c221df2c95eddce7541fd8ab448078
+  checksum: bc8adda12b44f1b59bb8ff59c8b5135533c024e1d5d3dd8f90ebf83921b13acc
+- filename: Sources/ContentstackUtils/JSONNodes.swift
+  checksum: 46364e65d2303da49c331ef2f3b7ab5792bc8a38091c7e1672a7a9878341f1b4
+- filename: Sources/ContentstackUtils/GQLEmbededEntry.swift
+  checksum: 7f110d0ec5681966c9be5dcf0d3c6080d2a1c0edb12cdb041e81faccaa73436c
+- filename: Sources/ContentstackUtils/Edges.swift
+  checksum: f97583d4ad7fc78230f600ef766254f720c0be9320604f4ca3de6ca340b87357
+- filename: Sources/ContentstackUtils/JSONNode.swift
+  checksum: a6ba5be58ff452ca1eb5549c45dfab3b73caeb0820f24a395568c1bdffb31039
+- filename: Sources/ContentstackUtils/ConnectionNode.swift
+  checksum: 16acd4ea1aa33414082b10b8a1415d2abb6edb0b6280f922c5afa4d699333f7f
+- filename: Sources/ContentstackUtils/GQLEmbededAsset.swift
+  checksum: 12089cea20bec0300bf3293cfdb03279d1fc9fb1f30dc4549ac0b81dac0dfe14

ContentstackUtils.xcodeproj/project.pbxproj

@@ -21,6 +21,14 @@
 /* End PBXAggregateTarget section */
 
 /* Begin PBXBuildFile section */
+		0F00785926A59D6600FC4925 /* GQLJsonRTE.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00785826A59D6600FC4925 /* GQLJsonRTE.swift */; };
+		0F00785B26A5A0EB00FC4925 /* GQLJsonToHtml.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00785A26A5A0EB00FC4925 /* GQLJsonToHtml.swift */; };
+		0F00785D26A6ACBF00FC4925 /* GQLEmbededEntry.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00785C26A6ACBF00FC4925 /* GQLEmbededEntry.swift */; };
+		0F00785F26A6ACDC00FC4925 /* GQLEmbededAsset.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00785E26A6ACDC00FC4925 /* GQLEmbededAsset.swift */; };
+		0F00786126A6AD0100FC4925 /* JSONNode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00786026A6AD0100FC4925 /* JSONNode.swift */; };
+		0F00786326A6AD2100FC4925 /* JSONNodes.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00786226A6AD2100FC4925 /* JSONNodes.swift */; };
+		0F00786526A6AD3E00FC4925 /* Edges.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00786426A6AD3E00FC4925 /* Edges.swift */; };
+		0F00786726A6AD6800FC4925 /* ConnectionNode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F00786626A6AD6800FC4925 /* ConnectionNode.swift */; };
 		0F01BA4B25237725005A3EE0 /* String+Extension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F01BA4A25237725005A3EE0 /* String+Extension.swift */; };
 		0F07E62F25244DB5003E0BD1 /* StringExtensionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F07E62E25244DB5003E0BD1 /* StringExtensionTests.swift */; };
 		0F57953B266A50710082815C /* Decodable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F57953A266A50710082815C /* Decodable.swift */; };
@@ -81,6 +89,14 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		0F00785826A59D6600FC4925 /* GQLJsonRTE.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GQLJsonRTE.swift; sourceTree = "<group>"; };
+		0F00785A26A5A0EB00FC4925 /* GQLJsonToHtml.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GQLJsonToHtml.swift; sourceTree = "<group>"; };
+		0F00785C26A6ACBF00FC4925 /* GQLEmbededEntry.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GQLEmbededEntry.swift; sourceTree = "<group>"; };
+		0F00785E26A6ACDC00FC4925 /* GQLEmbededAsset.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GQLEmbededAsset.swift; sourceTree = "<group>"; };
+		0F00786026A6AD0100FC4925 /* JSONNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JSONNode.swift; sourceTree = "<group>"; };
+		0F00786226A6AD2100FC4925 /* JSONNodes.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JSONNodes.swift; sourceTree = "<group>"; };
+		0F00786426A6AD3E00FC4925 /* Edges.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Edges.swift; sourceTree = "<group>"; };
+		0F00786626A6AD6800FC4925 /* ConnectionNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConnectionNode.swift; sourceTree = "<group>"; };
 		0F01BA4A25237725005A3EE0 /* String+Extension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "String+Extension.swift"; sourceTree = "<group>"; };
 		0F07E62E25244DB5003E0BD1 /* StringExtensionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StringExtensionTests.swift; sourceTree = "<group>"; };
 		0F57953A266A50710082815C /* Decodable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Decodable.swift; sourceTree = "<group>"; };
@@ -147,6 +163,14 @@
 /* End PBXFrameworksBuildPhase section */
 
 /* Begin PBXGroup section */
+		0F00785726A59D3B00FC4925 /* GQLJsonToHtmlMock */ = {
+			isa = PBXGroup;
+			children = (
+				0F00785826A59D6600FC4925 /* GQLJsonRTE.swift */,
+			);
+			name = GQLJsonToHtmlMock;
+			sourceTree = "<group>";
+		};
 		0F01BA49252376E5005A3EE0 /* Extensions */ = {
 			isa = PBXGroup;
 			children = (
@@ -159,6 +183,12 @@
 			isa = PBXGroup;
 			children = (
 				0FEC37AF254FFF6E00B1EFDD /* Metadata.swift */,
+				0F00785C26A6ACBF00FC4925 /* GQLEmbededEntry.swift */,
+				0F00785E26A6ACDC00FC4925 /* GQLEmbededAsset.swift */,
+				0F00786026A6AD0100FC4925 /* JSONNode.swift */,
+				0F00786226A6AD2100FC4925 /* JSONNodes.swift */,
+				0F00786426A6AD3E00FC4925 /* Edges.swift */,
+				0F00786626A6AD6800FC4925 /* ConnectionNode.swift */,
 			);
 			name = Models;
 			sourceTree = "<group>";
@@ -190,6 +220,7 @@
 		0FA3D58B252208B100E58179 /* Mock */ = {
 			isa = PBXGroup;
 			children = (
+				0F00785726A59D3B00FC4925 /* GQLJsonToHtmlMock */,
 				0FFD88DD266DDDCF00BA5919 /* RenderMock */,
 				0FFD88DC266DDDB900BA5919 /* JsonToHtmMock */,
 				0FEC37B925503E5000B1EFDD /* CustomRenderOptionMock.swift */,
@@ -293,6 +324,7 @@
 				0F579540266A50D40082815C /* MarkTypeTest.swift */,
 				0F579546266A50E30082815C /* NodeTypeTest.swift */,
 				0FFD88D6266DDD1900BA5919 /* ContentstackUtilsJsonToHtmlTest.swift */,
+				0F00785A26A5A0EB00FC4925 /* GQLJsonToHtml.swift */,
 			);
 			name = ContentstackUtilsTests;
 			path = Tests/ContentstackUtilsTests;
@@ -468,21 +500,27 @@
 			files = (
 				0FFD8903266DEC0D00BA5919 /* TextNode.swift in Sources */,
 				0FEC37B0254FFF6E00B1EFDD /* Metadata.swift in Sources */,
+				0F00785F26A6ACDC00FC4925 /* GQLEmbededAsset.swift in Sources */,
 				0FEC0B1F254FE0B2008D4E66 /* Kanna.swift in Sources */,
 				0FEC37B82550394F00B1EFDD /* EmbedItemType.swift in Sources */,
 				0FFF2F2A2668FC54003E9DBF /* NodeType.swift in Sources */,
 				0FEC0B1E254FE0B2008D4E66 /* Deprecated.swift in Sources */,
 				0FA3D5842521F21300E58179 /* StyleType.swift in Sources */,
+				0F00786526A6AD3E00FC4925 /* Edges.swift in Sources */,
 				0FA3D57F2521F1D400E58179 /* Option.swift in Sources */,
 				0FEC0B1A254FE0B2008D4E66 /* libxmlHTMLNode.swift in Sources */,
 				0FEC0B1C254FE0B2008D4E66 /* libxmlHTMLDocument.swift in Sources */,
+				0F00786126A6AD0100FC4925 /* JSONNode.swift in Sources */,
+				0F00786726A6AD6800FC4925 /* ConnectionNode.swift in Sources */,
 				0FA3D5852521F21300E58179 /* EntryEmbedded.swift in Sources */,
 				0FEC0B1B254FE0B2008D4E66 /* CSS.swift in Sources */,
 				0FFF2F382668FE85003E9DBF /* Node.swift in Sources */,
 				0F57953B266A50710082815C /* Decodable.swift in Sources */,
 				0FFF2F242668FB6F003E9DBF /* MarkType.swift in Sources */,
 				0F01BA4B25237725005A3EE0 /* String+Extension.swift in Sources */,
 				0FEC0B1D254FE0B2008D4E66 /* libxmlParserOption.swift in Sources */,
+				0F00786326A6AD2100FC4925 /* JSONNodes.swift in Sources */,
+				0F00785D26A6ACBF00FC4925 /* GQLEmbededEntry.swift in Sources */,
 				OBJ_22 /* ContentstackUtils.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -515,6 +553,8 @@
 				0F7142C425514A6F00C18A61 /* ContentstackUtilsArrayTest.swift in Sources */,
 				0FFD88EE266DE1A600BA5919 /* NodeParser.swift in Sources */,
 				0FFD88F7266DE1FB00BA5919 /* JsonNodes.swift in Sources */,
+				0F00785B26A5A0EB00FC4925 /* GQLJsonToHtml.swift in Sources */,
+				0F00785926A59D6600FC4925 /* GQLJsonRTE.swift in Sources */,
 				OBJ_41 /* XCTestManifests.swift in Sources */,
 				0F7142C62551684600C18A61 /* ContentstackUtilsCustomRendertest.swift in Sources */,
 				0F5E48452525BECA0038C16B /* Constants.swift in Sources */,

README.md

@@ -225,3 +225,35 @@ stack.contentType(uid: contentTypeUID)
         }  
     }
 ```
+
+### GraphQL implementation
+After fetching the entries from the content type pass the JSON RTE to `ContentstackUtils.GQL.jsonToHtml` function as shown below:
+
+```swift
+import ContentstackUtils  
+import Apollo
+...
+let graphQLClient: ApolloClient
+...
+
+graphQLClient.fetch (query: ProductsQuery(), cachePolicy: CachePolicy.fetchIgnoringCacheData, queue: DispatchQueue.main) {[weak self] (result: Result<GraphQLResult<ProductsQuery.Data>, Error>) in
+    guard let slf = self else {
+                   return
+               }
+    switch result {
+    case .success(let graphQLResult):
+        guard let data = graphQLResult.data, let products = data.allAbcd?.items else {
+           return
+        }
+
+        for product in products {
+            if let rte = product.superchargedRte {
+               let result = try? ContentstackUtils.GQL.jsonToHtml(rte: rte.resultMap)
+            }
+        }
+    case .failure(let error):
+      print("Failure! Error: \(error)")
+    }
+}
+```
+

Sources/ContentstackUtils/ConnectionNode.swift

@@ -0,0 +1,42 @@
+//
+//  ConnectionNode.swift
+//  ContentstackUtils
+//
+//  Created by Uttam Ukkoji on 20/07/21.
+//
+
+
+internal class ConnectionNode: Decodable {
+    var node: EmbeddedObject?
+    public enum FieldKeys: String, CodingKey {
+        case node
+    }
+    public required init(from decoder: Decoder) throws {
+        let container   = try decoder.container(keyedBy: ConnectionNode.FieldKeys.self)
+        let containerFields   = try decoder.container(keyedBy: JSONCodingKeys.self)
+        let fields = try containerFields.decode(Dictionary<String, Any>.self)
+        if let nodes = fields["node"] as? [String: Any],
+           let system = nodes["system"] as? [String: Any],
+           let contentType = system["content_type_uid"] as? String {
+            if contentType == "sys_assets" {
+                node = try container.decode(GQLEmbededAsset.self, forKey: .node)
+            } else {
+                node = try container.decode(GQLEmbededEntry.self, forKey: .node)
+            }
+        }
+    }
+    
+    static func initWith(container nodes: inout UnkeyedDecodingContainer) throws -> [EmbeddedObject] {
+        var nodesArray = nodes
+
+        var object: [EmbeddedObject] = []
+        while !nodes.isAtEnd {
+            _ = try nodes.nestedContainer(keyedBy: ConnectionNode.FieldKeys.self)
+            let connectionNode = try nodesArray.decode(ConnectionNode.self)
+            if let item = connectionNode.node {
+                object.append(item)
+            }
+        }
+        return object
+    }
+}

Sources/ContentstackUtils/ContentstackUtils.swift

@@ -1,5 +1,30 @@
+import Foundation
+
 public struct ContentstackUtils {
 
+//    public struct JsonNode {
+//        public var json: Node
+//        public var embeddedObject: 
+//    }
+    public struct GQL {
+        public static func jsonToHtml(rte document: [String: Any?], _ option: Option = Option()) throws -> Any {
+            do {
+                let data = try JSONSerialization.data(withJSONObject: document, options: JSONSerialization.WritingOptions.fragmentsAllowed)
+                if (document["json"] as? [[String: Any?]]) != nil {
+                    let rte = try JSONDecoder().decode(JSONNodes.self, from: data)
+                    option.embdeddedItems = rte.embeddedItemsConnection?.edges
+                    return ContentstackUtils.jsonToHtml(node: rte.json, option)
+                }else {
+                    let rte = try JSONDecoder().decode(JSONNode.self, from: data)
+                    option.embdeddedItems = rte.embeddedItemsConnection?.edges
+                    return ContentstackUtils.jsonToHtml(node: rte.json, option)
+                }
+            } catch (let error) {
+                throw error
+            }
+        }
+    }
+
     public static func render(content: String, _ option: Option) throws -> String {
         do {
             let appendContent = content.appendFrame()
@@ -40,7 +65,6 @@ public struct ContentstackUtils {
         }
     }
 
-    
     public static func jsonToHtml(node documents: [Node], _ option: Option = Option()) -> [String] {
         var resultContents: [String] = []
         documents.forEach { (document) in
@@ -103,6 +127,13 @@ public struct ContentstackUtils {
         if let entry = option.entry,
            let embeddedObject = findObject(metadata, entry: entry) {
             return option.renderItem(embeddedObject: embeddedObject, metadata: metadata) ?? ""
+        } else if let embdeddedItems = option.embdeddedItems {
+            let embedModel = embdeddedItems.filter { (item: EmbeddedObject) -> Bool in
+                return item.uid == metadata.itemUid && item.contentTypeUID == metadata.contentTypeUid
+            }
+            if !embedModel.isEmpty {
+                return option.renderItem(embeddedObject: embedModel.first!, metadata: metadata) ?? ""
+            }
         }
         return ""
     }

Sources/ContentstackUtils/Decodable.swift

@@ -52,7 +52,7 @@ internal extension KeyedDecodingContainer {
                 dictionary[key.stringValue] = intValue
             } else if let doubleValue = try? decode(Double.self, forKey: key) {
                 dictionary[key.stringValue] = doubleValue
-            } else if let nestedDictionary = try? decode(Dictionary<String, Any>.self, forKey: key) {
+            }  else if let nestedDictionary = try? decode(Dictionary<String, Any>.self, forKey: key) {
                 dictionary[key.stringValue] = nestedDictionary
             } else if let nestedArray = try? decode(Array<Any>.self, forKey: key) {
                 dictionary[key.stringValue] = nestedArray

Sources/ContentstackUtils/Edges.swift

@@ -0,0 +1,20 @@
+//
+//  Edges.swift
+//  ContentstackUtils
+//
+//  Created by Uttam Ukkoji on 20/07/21.
+//
+
+
+internal class Edges: Decodable {
+    var edges: [EmbeddedObject]?
+    public enum FieldKeys: String, CodingKey {
+        case edges
+    }
+    public required init(from decoder: Decoder) throws {
+        let container   = try decoder.container(keyedBy: FieldKeys.self)
+        if var nodes = try? container.nestedUnkeyedContainer(forKey: .edges) {
+            edges = try ConnectionNode.initWith(container: &nodes)
+        }
+    }
+}

Sources/ContentstackUtils/EntryEmbedded.swift

@@ -1,7 +1,8 @@
-public protocol EmbeddedObject: class {
+public protocol EmbeddedObject: AnyObject {
 /// The `unique identifier` of the entity.
     var uid: String { get }
     var contentTypeUID: String {get}
+    var fields: [String: Any]? {get}
 }
 
 public protocol EmbeddedContentTypeUid: EmbeddedObject {

Sources/ContentstackUtils/GQLEmbededAsset.swift

@@ -0,0 +1,48 @@
+//
+//  GQLEmbededAsset.swift
+//  ContentstackUtils
+//
+//  Created by Uttam Ukkoji on 20/07/21.
+//
+
+internal class GQLEmbededAsset: Decodable, EmbeddedAsset {
+    static var contentTypeUid: String = "sys_asset"
+
+    var uid: String
+    
+    var url: String
+    
+    var title: String
+
+    var filename: String
+
+    var contentTypeUID: String
+    
+    public var fields: [String: Any]?
+    public enum FieldKeys: String, CodingKey {
+        case title, uid, url, filename
+        case contentTypeUID = "content_type_uid"
+    }
+
+    public required init(from decoder: Decoder) throws {
+        let container   = try decoder.container(keyedBy: FieldKeys.self)
+        uid = ""
+        url = try container.decodeIfPresent(String.self, forKey: .url) ?? ""
+        title = try container.decodeIfPresent(String.self, forKey: .title) ?? ""
+        filename = try container.decodeIfPresent(String.self, forKey: .filename) ?? ""
+        contentTypeUID = ""
+
+        let containerFields   = try decoder.container(keyedBy: JSONCodingKeys.self)
+        fields = try containerFields.decode(Dictionary<String, Any>.self)
+        
+        if let allfields = fields, let system = allfields["system"] as? [String: Any] {
+            if let val = system["uid"] as? String {
+                uid = val
+            }
+            
+            if let contentType = system["content_type_uid"] as? String {
+                contentTypeUID = contentType
+            }
+        }
+    }
+}

Sources/ContentstackUtils/GQLEmbededEntry.swift

@@ -0,0 +1,43 @@
+//
+//  GQLEmbededEntry.swift
+//  ContentstackUtils
+//
+//  Created by Uttam Ukkoji on 20/07/21.
+//
+
+internal class GQLEmbededEntry: Decodable, EmbeddedEntry {
+    static var contentTypeUid: String = "GQL"
+
+    var title: String
+    
+    var uid: String
+    
+    var contentTypeUID: String
+    
+    public var fields: [String: Any]?
+
+    public enum FieldKeys: String, CodingKey {
+        case title, uid
+        case contentTypeUID = "content_type_uid"
+    }
+
+    public required init(from decoder: Decoder) throws {
+        let container   = try decoder.container(keyedBy: FieldKeys.self)
+        uid = ""
+        contentTypeUID = ""
+        title = try container.decodeIfPresent(String.self, forKey: .title) ?? ""
+       
+        let containerFields   = try decoder.container(keyedBy: JSONCodingKeys.self)
+        fields = try containerFields.decode(Dictionary<String, Any>.self)
+        
+        if let allfields = fields, let system = allfields["system"] as? [String: Any] {
+            if let val = system["uid"] as? String {
+                uid = val
+            }
+            
+            if let contentType = system["content_type_uid"] as? String {
+                contentTypeUID = contentType
+            }
+        }
+    }
+}