Merge pull request #3 from contentstack/development

uttamukkoji · web-flow · commit 6dcc2051292a · 2020-12-05T21:39:58.000+05:30
Publish content fallback
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,7 +30,7 @@ jobs:
       DEVELOPER_DIR: /Applications/Xcode_11.4.app/Contents/Developer
     strategy:
       matrix:
-        destination: ["OS=13.4,name=iPhone 11 Pro"]
+        destination: ["OS=13.4.1,name=iPhone 11 Pro"]
     steps:
     - uses: actions/checkout@v1
       with:
diff --git a/Config.xcconfig b/Config.xcconfig
@@ -1 +1 @@
-CONTENTSTACK_SDK_VERSION = 1.0.0
+CONTENTSTACK_SDK_VERSION = 1.1.0
diff --git a/Contentstack.xcodeproj/project.pbxproj b/Contentstack.xcodeproj/project.pbxproj
@@ -57,6 +57,11 @@
 		0F2DB7E82451D353007B9815 /* ImageOperations.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F2DB7E62451D353007B9815 /* ImageOperations.swift */; };
 		0F2DB7E92451D353007B9815 /* ImageOperations.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F2DB7E62451D353007B9815 /* ImageOperations.swift */; };
 		0F2DB7EA2451D353007B9815 /* ImageOperations.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F2DB7E62451D353007B9815 /* ImageOperations.swift */; };
+		0F359991257BE29B00B3DB89 /* Asset.json in Resources */ = {isa = PBXBuildFile; fileRef = 0FFBB4462446F9A4000D2795 /* Asset.json */; };
+		0F359992257BE2A700B3DB89 /* ContentType.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F244F9C244062B4003C3F26 /* ContentType.json */; };
+		0F359993257BE2D100B3DB89 /* Entry.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F796C512449EA8700EA04D5 /* Entry.json */; };
+		0F359994257BE2EE00B3DB89 /* QueryOn.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F50EA15244ED7F500E5D705 /* QueryOn.json */; };
+		0F359995257BE30A00B3DB89 /* SyncTest.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F1DCC77243D9BBF00EED404 /* SyncTest.json */; };
 		0F38D7E0242C7C9E00232D7F /* Product.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F38D7DF242C7C9E00232D7F /* Product.swift */; };
 		0F38D7E1242C7C9E00232D7F /* Product.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F38D7DF242C7C9E00232D7F /* Product.swift */; };
 		0F38D7E2242C7C9E00232D7F /* Product.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F38D7DF242C7C9E00232D7F /* Product.swift */; };
@@ -158,11 +163,6 @@
 		0F796C502449EA6000EA04D5 /* EntryAPITest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0F6D3A84243F064900FCFEBC /* EntryAPITest.swift */; };
 		0F796C532449EA8700EA04D5 /* Entry.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F796C512449EA8700EA04D5 /* Entry.json */; };
 		0F796C542449EA8700EA04D5 /* Entry.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F796C512449EA8700EA04D5 /* Entry.json */; };
-		0FB118B024596D16007662E7 /* Entry.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F796C512449EA8700EA04D5 /* Entry.json */; };
-		0FB118B124596D16007662E7 /* QueryOn.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F50EA15244ED7F500E5D705 /* QueryOn.json */; };
-		0FB118B224596D16007662E7 /* Asset.json in Resources */ = {isa = PBXBuildFile; fileRef = 0FFBB4462446F9A4000D2795 /* Asset.json */; };
-		0FB118B324596D16007662E7 /* ContentType.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F244F9C244062B4003C3F26 /* ContentType.json */; };
-		0FB118B424596D16007662E7 /* SyncTest.json in Resources */ = {isa = PBXBuildFile; fileRef = 0F1DCC77243D9BBF00EED404 /* SyncTest.json */; };
 		0FB4CAC924332C5200A385B1 /* ImageOperation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0FB4CAC824332C5200A385B1 /* ImageOperation.swift */; };
 		0FB4CACA24332C5200A385B1 /* ImageOperation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0FB4CAC824332C5200A385B1 /* ImageOperation.swift */; };
 		0FB4CACB24332C5200A385B1 /* ImageOperation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0FB4CAC824332C5200A385B1 /* ImageOperation.swift */; };
@@ -939,11 +939,11 @@
 			isa = PBXResourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
-				0FB118B424596D16007662E7 /* SyncTest.json in Resources */,
-				0FB118B124596D16007662E7 /* QueryOn.json in Resources */,
-				0FB118B324596D16007662E7 /* ContentType.json in Resources */,
-				0FB118B024596D16007662E7 /* Entry.json in Resources */,
-				0FB118B224596D16007662E7 /* Asset.json in Resources */,
+				0F359995257BE30A00B3DB89 /* SyncTest.json in Resources */,
+				0F359993257BE2D100B3DB89 /* Entry.json in Resources */,
+				0F359994257BE2EE00B3DB89 /* QueryOn.json in Resources */,
+				0F359991257BE29B00B3DB89 /* Asset.json in Resources */,
+				0F359992257BE2A700B3DB89 /* ContentType.json in Resources */,
 				0F4C0A87243C6990006604B7 /* config.json in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
diff --git a/Sources/Asset.swift b/Sources/Asset.swift
@@ -23,6 +23,33 @@ public class Asset: CachePolicyAccessible {
         self.stack = stack
     }
 
+    /// Instance method to fetch `Asset` for specific locale.
+    /// - Parameter locale: The code for fetching entry for locale.
+    ///
+    /// - Returns: A `Asset` to enable chaining.
+    ///
+    /// Example usage:
+    /// ```
+    /// let stack = Contentstack.stack(apiKey: apiKey,
+    ///             deliveryToken: deliveryToken,
+    ///             environment: environment)
+    ///
+    /// // To retrive single asset with specific locale
+    /// stack.asset(uid: assetUID).locale("en-us")
+    /// .fetch { (result: Result<AssetModel, Error>, response: ResponseType) in
+    ///    switch result {
+    ///    case .success(let model):
+    ///          //Model retrive from API
+    ///    case .failure(let error):
+    ///          //Error Message
+    ///    }
+    /// }
+    /// ```
+    public func locale(_ locale: String) -> Self {
+        self.parameters["locale"] = locale
+        return self
+    }
+    
     /// To include the relative URLs of the assets in the response.
     /// - Returns: A `Asset` to enable chaining.
     ///
@@ -48,6 +75,31 @@ public class Asset: CachePolicyAccessible {
         return self
     }
 
+    /// To include the fallback published content if specified locale content is not publish.
+    /// - Returns: A `Asset` to enable chaining.
+    ///
+    /// Example usage:
+    /// ```
+    /// let stack = Contentstack.stack(apiKey: apiKey,
+    ///             deliveryToken: deliveryToken,
+    ///             environment: environment)
+    ///
+    /// // To retrive single asset with relative URL
+    /// let asset = stack.asset(uid: assetUID).includeFallback()
+    /// .fetch { (result: Result<AssetModel, Error>, response: ResponseType) in
+    ///    switch result {
+    ///    case .success(let model):
+    ///          //Model retrive from API
+    ///    case .failure(let error):
+    ///          //Error Message
+    ///    }
+    /// }
+    /// ```
+    public func includeFallback() -> Asset {
+        self.parameters[QueryParameter.includeFallback] = true
+        return self
+    }
+    
     /// To include the dimensions (height and width) of the image in the response.
     /// - Precondition: Supported image types: `JPG`, `GIF`, `PNG`, `WebP`, `BMP`, `TIFF`, `SVG`, and `PSD`.
     /// - Returns: A `Asset` to enable chaining.
diff --git a/Sources/AssetModel.swift b/Sources/AssetModel.swift
@@ -29,6 +29,8 @@ public final class AssetModel: AssetDecodable {
 
     public var url: String
 
+    public var fields: [String: Any]?
+
     public enum FieldKeys: String, CodingKey {
         case title, uid, url, dimension
         case fileName = "filename"
@@ -77,6 +79,9 @@ public final class AssetModel: AssetDecodable {
         createdBy = try container.decode(String.self, forKey: .createdBy)
         updatedAt = try container.decode(Date.self, forKey: .updatedAt)
         updatedBy = try container.decode(String.self, forKey: .updatedBy)
+        
+        let containerFields   = try decoder.container(keyedBy: JSONCodingKeys.self)
+        fields = try containerFields.decode(Dictionary<String, Any>.self)
     }
 
     public enum QueryableCodingKey: String, CodingKey {
diff --git a/Sources/ContentType.swift b/Sources/ContentType.swift
@@ -51,6 +51,7 @@ public class ContentType: CachePolicyAccessible {
 
     /// To include Global Fields schema in ContentType response.
     /// - Returns: A `ContentType` to enable chaining.
+    ///
     /// Example usage:
     /// ```
     /// let stack = Contentstack.stack(apiKey: apiKey,
diff --git a/Sources/EntryModel.swift b/Sources/EntryModel.swift
@@ -7,8 +7,6 @@
 
 import Foundation
 
-public protocol EntryDecodable: EntryFields, FieldKeysQueryable, EndpointAccessible, Decodable {}
-
 public protocol ContentTypeIncludable {
     var contentType: ContentTypeModel? { get set}
 }
diff --git a/Sources/EntryQuaryable.swift b/Sources/EntryQuaryable.swift
@@ -141,7 +141,7 @@ extension EntryQueryable {
     ///    }
     /// }
     /// ```
-    
+
     public func include(params: Query.Include) -> Self {
         if params.contains(Query.Include.count) {
             self.parameters[QueryParameter.includeCount] = true
@@ -157,6 +157,9 @@ extension EntryQueryable {
         if params.contains(Query.Include.refContentTypeUID) {
             self.parameters[QueryParameter.includeRefContentTypeUID] = true
         }
+        if params.contains(Query.Include.fallback) {
+            self.parameters[QueryParameter.includeFallback] = true
+        }
         return self
     }
 
diff --git a/Sources/Query.swift b/Sources/Query.swift
@@ -445,6 +445,33 @@ public final class AssetQuery: BaseQuery {
         self.cachePolicy = stack.cachePolicy
     }
 
+    /// Instance method to fetch `Assets` for specific locale.
+    /// - Parameter locale: The code for fetching entry for locale.
+    ///
+    /// - Returns: A `AssetQuery` to enable chaining.
+    ///
+    /// Example usage:
+    /// ```
+    /// let stack = Contentstack.stack(apiKey: apiKey,
+    ///             deliveryToken: deliveryToken,
+    ///             environment: environment)
+    ///
+    /// // To retrive single asset with specific locale
+    /// stack.asset().query().locale("en-us")
+    /// .fetch { (result: Result<AssetModel, Error>, response: ResponseType) in
+    ///    switch result {
+    ///    case .success(let model):
+    ///          //Model retrive from API
+    ///    case .failure(let error):
+    ///          //Error Message
+    ///    }
+    /// }
+    /// ```
+    public func locale(_ locale: String) -> Self {
+        self.parameters["locale"] = locale
+        return self
+    }
+
     /// Use this method to do a search on `Assets` which enables
     /// searching for entries based on value's for members of referenced entries.
     ///
@@ -506,6 +533,9 @@ public final class AssetQuery: BaseQuery {
         if params.contains(.dimension) {
             self.parameters[QueryParameter.includeDimension] = true
         }
+        if params.contains(.fallback) {
+            self.parameters[QueryParameter.includeFallback] = true
+        }
         return self
     }
 }
diff --git a/Sources/QueryParameter.swift b/Sources/QueryParameter.swift
@@ -60,6 +60,8 @@ internal enum QueryParameter {
     internal static let includeContentType        = "include_content_type"
 
     internal static let includeRefContentTypeUID  = "include_reference_content_type_uid"
+    
+    internal static let includeFallback  = "include_fallback"
 }
 
 extension Query {
@@ -88,12 +90,15 @@ extension Query {
         public static let globalField: Include = Include(rawValue: 1 << 3)
         /// To include Reference ContentType Uid in reference field in Entry response,
         public static let refContentTypeUID: Include = Include(rawValue: 1 << 4)
+        /// Retrieve the published content of the fallback locale if an entry is not localized in specified locale.
+        public static let fallback: Include = Include(rawValue: 1 << 5)
         /// To inclide all `Query.Include` values.
         public static let all: Include = [.count,
                                           .unpublished,
                                           .contentType,
                                           .globalField,
-                                          .refContentTypeUID]
+                                          .refContentTypeUID,
+                                          .fallback]
     }
 }
 
@@ -143,9 +148,12 @@ extension AssetQuery {
         /// To include the dimensions (height and width) of the image in the response.
         /// Supported image types: JPG, GIF, PNG, WebP, BMP, TIFF, SVG, and PSD.
         public static let dimension: Include = Include(rawValue: 1 << 2)
+        /// Retrieve the published content of the fallback locale if an entry is not localized in specified locale.
+        public static let fallback: Include = Include(rawValue: 1 << 3)
         /// To inclide all `AssetQuery.Include` values.
         public static let all: Include = [.count,
                                           .relativeURL,
-                                          .dimension]
+                                          .dimension,
+                                          .fallback]
     }
 }
diff --git a/Sources/SystemFields.swift b/Sources/SystemFields.swift
@@ -61,3 +61,131 @@ public protocol FieldKeysQueryable {
 public protocol EndpointAccessible {
     static var endpoint: Endpoint { get }
 }
+
+/// Decodable is a powerful Swift standard library feature that developers can use to
+/// decode custom types from external representation, such as JSON.
+///
+/// `EntryDecodable` is an extension of the decodable protocol that you can use to decode the response to a
+/// specific model.
+/// By using this protocol, you can define types that will be mapped from your entries of the content type.
+///
+/// In this guide, we will discuss how we can use the EntryDecodable Protocol in your Swift SDK.
+///
+/// EntryDecodable Example Usage
+///
+/// Let's understand how to use this protocol with the help of a few examples.
+///
+/// Standard Usage
+///
+/// We have a content type named `Session` and to fetch entries of our `Session` content type from the Swift SDK,
+/// we need to create a class named `Session` that implements the `EntryDecodable` protocol as follows:
+///
+/// Example usage:
+/// ```
+/// class Session: EntryDecodable {
+///    public enum FieldKeys: String, CodingKey {
+///        case title, uid, locale, type, speakers
+///        case createdAt = "created_at"
+///        case updatedAt = "updated_at"
+///        case createdBy = "created_by"
+///        case updatedBy = "updated_by"
+///        case sessionId = "session_id"
+///        case desc = "description"
+///        case sessionTime = "session_time"
+///    }
+///
+///    var locale: String
+///    var title: String
+///    var uid: String
+///    var createdAt: Date?
+///    var updatedAt: Date?
+///    var createdBy: String?
+///    var updatedBy: String?
+///    var sessionId: Int
+///    var desc: String
+///    var type: String
+///    var sessionTime: SessionTime
+///    var speakers: [Speaker]?
+///    public required init(from decoder: Decoder) throws {
+///        let container   = try decoder.container(keyedBy: FieldKeys.self)
+///        uid = try container.decode(String.self, forKey: .uid)
+///        title = try container.decode(String.self, forKey: .title)
+///        createdBy = try? container.decode(String.self, forKey: .createdBy)
+///        updatedBy = try? container.decode(String.self, forKey: .updatedBy)
+///        createdAt = try? container.decode(Date.self, forKey: .createdAt)
+///        updatedAt = try? container.decode(Date.self, forKey: .updatedAt)
+///        locale = try container.decode(String.self, forKey: .locale)
+///        sessionId = try container.decode(Int.self, forKey: .sessionId)
+///        desc = try container.decode(String.self, forKey: .desc)
+///        type = try container.decode(String.self, forKey: .type)
+///        sessionTime = try container.decode(DateTime.self, forKey: .sessionTime)
+///        speakers = try container.decode([Speaker].self, forKey: .speakers)
+///    }
+/// }
+/// ```
+/// Usage in Referencing
+///
+/// Let's say there is another content type in our Stack named `Speaker`
+/// that is referenced in our `Session` Content Type.
+///
+/// For this case, we will create a class named `Speaker` that implements the `EntryDecodable` protocol as follows:
+/// Example usage:
+/// ```
+/// class Speaker: EntryDecodable {
+///    public enum FieldKeys: String, CodingKey {
+///        case title, uid, name, locale
+///        case createdAt = "created_at"
+///        case updatedAt = "updated_at"
+///        case createdBy = "created_by"
+///        case updatedBy = "updated_by"
+///        case desc = "description"
+///    }
+///
+///    var locale: String
+///    var title: String
+///    var uid: String
+///    var createdAt: Date?
+///    var updatedAt: Date?
+///    var createdBy: String?
+///    var updatedBy: String?
+///    var sessionId: Int
+///    var desc: String
+///    var name: String
+///    public required init(from decoder: Decoder) throws {
+///        let container   = try decoder.container(keyedBy: FieldKeys.self)
+///        uid = try container.decode(String.self, forKey: .uid)
+///        title = try container.decode(String.self, forKey: .title)
+///        createdBy = try? container.decode(String.self, forKey: .createdBy)
+///        updatedBy = try? container.decode(String.self, forKey: .updatedBy)
+///        createdAt = try? container.decode(Date.self, forKey: .createdAt)
+///        updatedAt = try? container.decode(Date.self, forKey: .updatedAt)
+///        locale = try container.decode(String.self, forKey: .locale)
+///        name = try container.decode(String.self, forKey: .name)
+///        desc = try container.decode(String.self, forKey: .desc)
+///    }
+/// }
+///```
+///
+/// In the `Session` class, we have a ‘session_time’ `Global Field`. To parse it, we need to create
+/// a class named `SessionTime` that implements the `Decodable` protocol as follows.
+///
+/// Example:
+/// ```
+/// class SessionTime: Decodable {
+///    var startTime: Date?
+///    var endTime: Date?
+///
+///    public enum CodingKeys: String, CodingKey {
+///        case startTime = "start_time"
+///        case endTime = "end_time"
+///    }
+///    public required init(from decoder: Decoder) throws {
+///        let container   = try decoder.container(keyedBy: CodingKeys.self)
+///        startTime = try? container.decode(Date.self, forKey: .startTime)
+///        endTime = try? container.decode(Date.self, forKey: .endTime)
+///    }
+/// }
+/// ```
+/// `Note`: If we have fields with `Modular block`, `JSON`, or an `array of JSON`
+/// in our content type, we can create a class that implements `Decodable`.
+public protocol EntryDecodable: EntryFields, FieldKeysQueryable, EndpointAccessible, Decodable {}

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-CONTENTSTACK_SDK_VERSION = 1.0.0`
	`1`	`+CONTENTSTACK_SDK_VERSION = 1.1.0`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,6 @@`
`7`	`7`
`8`	`8`	`import Foundation`
`9`	`9`
`10`		`-public protocol EntryDecodable: EntryFields, FieldKeysQueryable, EndpointAccessible, Decodable {}`
`11`		`-`
`12`	`10`	`public protocol ContentTypeIncludable {`
`13`	`11`	`var contentType: ContentTypeModel? { get set}`
`14`	`12`	`}`