Refactor: Move DataStore Model schema to Internal directory (#563)

* Move Model schema related to Internal directory structure

* Move AnyModel to AWSPluginsCore

* PR comment and move AnyModel unit tests

* comment update

* adding warning comment to all public symbols in Internal directory

* remove old comment

* move Model and ModelName out of Internal

Author: lawmicha

Amplify.xcodeproj/project.pbxproj

@@ -13,6 +13,8 @@ import Foundation
 /// `embedded(type:)` or `embeddedCollection(of:)` must comform to the `Embeddable` protocol except for Swift's Basic
 /// types embedded as a collection. A collection of String can be embedded in the `Model` as
 /// `embeddedCollection(of: String.self)` without needing to conform to Embeddable.
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public protocol Embeddable: Codable {
 
     /// A reference to the `ModelSchema` associated with this embedded type.

Amplify/Categories/DataStore/Model/Embedded.swift renamed to Amplify/Categories/DataStore/Model/Internal/Embedded.swift

@@ -9,6 +9,8 @@ import Foundation
 
 extension Array where Element: Model {
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public func unique() throws -> Element? {
         guard (0 ... 1).contains(count) else {
             throw DataStoreError.nonUniqueResult(model: Element.modelName, count: count)
@@ -18,6 +20,9 @@ extension Array where Element: Model {
 }
 
 extension Array where Element == Model {
+
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public func unique() throws -> Element? {
         guard (0 ... 1).contains(count) else {
             let firstModelName = self[0].modelName

Amplify/Categories/DataStore/Model/Model+Array.swift renamed to Amplify/Categories/DataStore/Model/Internal/Model+Array.swift

@@ -20,6 +20,8 @@ extension Model where Self: Codable {
     /// - Returns: an instance of the concrete type conforming to `Model`
     /// - Throws: `DecodingError.dataCorrupted` in case data is not a valid JSON or any
     /// other decoding specific error that `JSONDecoder.decode()` might throw.
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public static func from(json: String,
                             decoder: JSONDecoder? = nil) throws -> Self {
         let resolvedDecoder: JSONDecoder
@@ -46,6 +48,8 @@ extension Model where Self: Codable {
     /// - Returns: an instance of the concrete type conforming to `Model`
     /// - Throws: `DecodingError.dataCorrupted` in case data is not a valid JSON or any
     /// other decoding specific error that `JSONDecoder.decode()` might throw.
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public static func from(dictionary: [String: Any]) throws -> Self {
         let data = try JSONSerialization.data(withJSONObject: dictionary)
         let decoder = JSONDecoder(dateDecodingStrategy: ModelDateFormatting.decodingStrategy)
@@ -58,6 +62,8 @@ extension Model where Self: Codable {
     ///     custom date formatter that encodes ISO8601 dates with fractional seconds
     /// - Returns: the JSON representation of the `Model`
     /// - seealso: https://developer.apple.com/documentation/foundation/jsonencoder/2895034-encode
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public func toJSON(encoder: JSONEncoder? = nil) throws -> String {
         let resolvedEncoder: JSONEncoder
         if let encoder = encoder {

Amplify/Categories/DataStore/Model/Model+Codable.swift renamed to Amplify/Categories/DataStore/Model/Internal/Model+Codable.swift

@@ -7,6 +7,8 @@
 
 import Foundation
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public struct ModelDateFormatting {
 
     public static let decodingStrategy: JSONDecoder.DateDecodingStrategy = {
@@ -31,13 +33,19 @@ public struct ModelDateFormatting {
 }
 
 public extension JSONDecoder {
+
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     convenience init(dateDecodingStrategy: JSONDecoder.DateDecodingStrategy) {
         self.init()
         self.dateDecodingStrategy = dateDecodingStrategy
     }
 }
 
 public extension JSONEncoder {
+
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     convenience init(dateEncodingStrategy: JSONEncoder.DateEncodingStrategy) {
         self.init()
         self.dateEncodingStrategy = dateEncodingStrategy

Amplify/Categories/DataStore/Model/Model+DateFormatting.swift renamed to Amplify/Categories/DataStore/Model/Internal/Model+DateFormatting.swift

@@ -10,8 +10,7 @@ import Foundation
 /// Protocol that represents a `Codable` Enum that can be persisted and easily
 /// integrate with remote APIs since it must have a raw `String` value.
 ///
-/// That means only simple enums (i.e. the ones that don't have arguments) can be used
-/// as model properties.
+/// That means only enums without associated values can be used as model properties.
 ///
 /// - Example:
 ///
@@ -21,6 +20,8 @@ import Foundation
 ///     case published
 /// }
 /// ```
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public protocol EnumPersistable: Codable {
 
     var rawValue: String { get }

Amplify/Categories/DataStore/Model/Model+Enum.swift renamed to Amplify/Categories/DataStore/Model/Internal/Model+Enum.swift

@@ -11,6 +11,9 @@
 /// let id = model["id"]
 /// ```
 extension Model {
+
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public subscript(_ key: String) -> Any?? {
         let mirror = Mirror(reflecting: self)
         let firstChild = mirror.children.first { $0.label == key }

Amplify/Categories/DataStore/Model/Model+Subscript.swift renamed to Amplify/Categories/DataStore/Model/Internal/Model+Subscript.swift

@@ -6,6 +6,9 @@
 //
 
 public extension ModelRegistry {
+
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     static var hasSyncableModels: Bool {
         if #available(iOS 13.0, *) {
             return models.contains { !$0.schema.isSystem }

Amplify/Categories/DataStore/Model/ModelRegistry+Syncable.swift renamed to Amplify/Categories/DataStore/Model/Internal/ModelRegistry+Syncable.swift

@@ -7,6 +7,8 @@
 
 import Foundation
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public struct ModelRegistry {
     private static let concurrencyQueue = DispatchQueue(label: "com.amazonaws.ModelRegistry.concurrency",
                                                         target: DispatchQueue.global())

Amplify/Categories/DataStore/Model/ModelRegistry.swift renamed to Amplify/Categories/DataStore/Model/Internal/ModelRegistry.swift

@@ -18,6 +18,8 @@ import Foundation
 /// - `Temporal.Date`
 /// - `Temporal.DateTime`
 /// - `Temporal.Time`
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public protocol Persistable {}
 
 extension Bool: Persistable {}
@@ -40,6 +42,8 @@ struct PersistableHelper {
     ///   - lhs: a reference to a Persistable object
     ///   - rhs: another reference
     /// - Returns: `true` in case both values are equal or `false` otherwise
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public static func isEqual(_ lhs: Persistable?, _ rhs: Persistable?) -> Bool {
         if lhs == nil && rhs == nil {
             return true

Amplify/Categories/DataStore/Model/Persistable.swift renamed to Amplify/Categories/DataStore/Model/Internal/Persistable.swift

@@ -5,22 +5,30 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum AuthStrategy {
     case owner
     case groups
     case `private`
     case `public`
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum ModelOperation {
     case create
     case update
     case delete
     case read
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public typealias AuthRules = [AuthRule]
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public struct AuthRule {
     public let allow: AuthStrategy
     public let ownerField: String?

Amplify/Categories/DataStore/Model/Schema/AuthRule.swift renamed to Amplify/Categories/DataStore/Model/Internal/Schema/AuthRule.swift

@@ -9,11 +9,15 @@ import Foundation
 
 extension Model {
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public static var schema: ModelSchema {
         // TODO load schema from JSON when this it not overridden by specific models
         ModelSchema(name: modelName, fields: [:])
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var schema: ModelSchema {
         type(of: self).schema
     }
@@ -36,6 +40,8 @@ extension Model {
     ///   - attributes: model attributes (aka "directives" or "annotations")
     ///   - define: the closure used to define the model attributes and fields
     /// - Returns: a valid `ModelSchema` instance
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public static func defineSchema(name: String? = nil,
                                     attributes: ModelAttribute...,
                                     define: (inout ModelSchemaDefinition) -> Void) -> ModelSchema {
@@ -45,6 +51,8 @@ extension Model {
         return definition.build()
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public static func rule(allow: AuthStrategy,
                             ownerField: String? = nil,
                             identityClaim: String? = nil,

Amplify/Categories/DataStore/Model/Schema/Model+Schema.swift renamed to Amplify/Categories/DataStore/Model/Internal/Schema/Model+Schema.swift

@@ -84,6 +84,8 @@ import Foundation
 /// }
 /// ```
 ///
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum ModelAssociation {
     case hasMany(associatedWith: CodingKey?)
     case hasOne(associatedWith: CodingKey?)
@@ -99,13 +101,17 @@ public enum ModelAssociation {
 
 extension ModelField {
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var hasAssociation: Bool {
         return association != nil
     }
 
     /// If the field represents an association returns the `Model.Type`.
     /// - seealso: `ModelFieldType`
     /// - seealso: `ModelFieldAssociation`
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var associatedModel: Model.Type? {
         switch type {
         case .model(let type), .collection(let type):
@@ -122,6 +128,8 @@ extension ModelField {
     ///
     /// - Note: as a maintainer, make sure you use this computed property only when context
     /// allows (i.e. the field is a valid relationship, such as foreign keys).
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var requiredAssociatedModel: Model.Type {
         guard let modelType = associatedModel else {
             preconditionFailure("""
@@ -132,13 +140,17 @@ extension ModelField {
         return modelType
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var isAssociationOwner: Bool {
         guard case .belongsTo = association else {
             return false
         }
         return true
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var associatedField: ModelField? {
         if hasAssociation {
             let associatedModel = requiredAssociatedModel
@@ -159,6 +171,8 @@ extension ModelField {
         return nil
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var isOneToOne: Bool {
         if case .hasOne = association {
             return true
@@ -169,20 +183,26 @@ extension ModelField {
         return false
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var isOneToMany: Bool {
         if case .hasMany = association, case .belongsTo = associatedField?.association {
             return true
         }
         return false
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var isManyToOne: Bool {
         if case .belongsTo = association, case .hasMany = associatedField?.association {
             return true
         }
         return false
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var embeddedType: Embeddable.Type? {
         switch type {
         case .embedded(let type), .embeddedCollection(let type):
@@ -195,6 +215,8 @@ extension ModelField {
         }
     }
 
+    /// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+    ///   by host applications. The behavior of this may change without warning.
     public var isEmbeddedType: Bool {
         switch type {
         case .embedded, .embeddedCollection:

Amplify/Categories/DataStore/Model/Schema/ModelField+Association.swift renamed to Amplify/Categories/DataStore/Model/Internal/Schema/ModelField+Association.swift

@@ -8,6 +8,8 @@
 import Foundation
 
 /// Defines the type of a `Model` field.
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum ModelFieldType {
 
     case string
@@ -79,6 +81,8 @@ public enum ModelFieldType {
     }
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum ModelFieldNullability {
     case optional
     case required
@@ -93,6 +97,8 @@ public enum ModelFieldNullability {
     }
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public struct ModelSchemaDefinition {
 
     internal let name: String
@@ -132,6 +138,8 @@ public struct ModelSchemaDefinition {
     }
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum ModelFieldDefinition {
 
     case field(name: String,

Amplify/Categories/DataStore/Model/Schema/ModelSchema+Attributes.swift renamed to Amplify/Categories/DataStore/Model/Internal/Schema/ModelSchema+Attributes.swift

@@ -5,6 +5,8 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum ModelAttribute {
 
     /// Represents a database index, often used for frequent query optimizations.
@@ -14,10 +16,14 @@ public enum ModelAttribute {
     case isSystem
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public enum ModelFieldAttribute {
     case primaryKey
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public struct ModelField {
 
     public let name: String
@@ -49,8 +55,12 @@ public struct ModelField {
     }
 }
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public typealias ModelFields = [String: ModelField]
 
+/// - Warning: Although this has `public` access, it is intended for internal use and should not be used directly
+///   by host applications. The behavior of this may change without warning.
 public struct ModelSchema {
 
     public let name: String