Hiding all ObjC types behind Swift wrappers

wrappers/swift/CMakeLists.txt

@@ -24,6 +24,8 @@ set(SWIFT_MODULE_PATH "${CMAKE_BINARY_DIR}/${PROJECT_NAME}/${LOWER_BUILD_TYPE}")
 set(SWIFT_OBJECT_OUTPUT_FOLDER "${SWIFT_MODULE_PATH}/${PROJECT_NAME}.build") # Swift object file output path: debug/OneDSSwift.build/*.o
 set(SWIFT_STATIC_LIB "${CMAKE_BINARY_DIR}/StaticLibs/libonedsswift.a") # Putting newly created static libs in this folder
 set(OBJC_MODULE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/Modules")
+
+# Set build and path related variables
 set(INSTALLED_LIB_PATH "/usr/local/lib")
 
 PROJECT(${PROJECT_NAME})
@@ -99,7 +101,9 @@ file(GLOB SWIFT_FILES "${CMAKE_CURRENT_SOURCE_DIR}/Sample/*.swift")
 set(INCLUDE_LIBS
     ${MAT_LIB} # libmat.a contains ObjC symbols
     ${SWIFT_STATIC_LIB} # libonedsswift.a contains swift wrapper symbols
+    ${SQLITE3_LIB}
     "-lC++"
+    "-lZ"
 )
 
 # Collect all the modules to be included
@@ -108,6 +112,14 @@ set(INCLUDE_MODULES
     "-I${SWIFT_MODULE_PATH}" # Swift wrappers module OneDSSwift, generated after the build
 )
 
+# Collect all frameworks to be included
+set(INCLUDE_FRAMEWORKS
+    -framework Network
+    -framework SystemConfiguration
+)
+
+get_filename_component(FRAMEWORK_DIR ${SYSTEM_CONFIGURATION} DIRECTORY)
+
 # Invoke swiftc to create the exe
 message("\nRunning swiftc...")
 execute_process(
@@ -116,10 +128,12 @@ execute_process(
     ${SWIFT_FILES} # Files to compile
     ${INCLUDE_MODULES} # Modules to include
     ${INCLUDE_LIBS} # Static libs to link
+    -F ${FRAMEWORK_DIR} # Set Framework search directory
+    ${INCLUDE_FRAMEWORKS} # Frameworks to include
     RESULT_VARIABLE SWIFTC_RESULT
 )
 
-if(EXISTS ${CMAKE_BINARY_DIR}/sample_app)
+if((SWIFT_BUILD_RESULT EQUAL 0) AND (EXISTS ${CMAKE_BINARY_DIR}/sample_app))
     message("Executable is created at: ${CMAKE_BINARY_DIR}/sample_app")
 else()
     message(FATALError, "Executable creation failed.")

wrappers/swift/Headers/ObjCModule-Bridging-Header.h

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
-// Contains all the Obj-C header files which are exposed to Swift
+// Contains all the Obj-C header files which are exposed to Swift.
 
 #import <Foundation/Foundation.h>
 

wrappers/swift/Modules/module.modulemap

@@ -1,3 +1,5 @@
+/// Module exporting headers declared in ObjC. Imported by Swift package to have access to the ObjC types.
+
 module ObjCModule {
     header "../Headers/ObjCModule-Bridging-Header.h"
     export *

wrappers/swift/Sources/OneDSSwift/CommonDataContext.swift

@@ -0,0 +1,102 @@
+//
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import ObjCModule
+
+/// Wrapper over ODWCommonDataContext class.
+public final class CommonDataContext {
+    /// ObjC variable which is wrapped by swift.
+    var odwCommonDataContext: ODWCommonDataContext
+
+    /// Contructor initialized with ObjC wrapped object.
+    init(odwCommonDataContext: ODWCommonDataContext) {
+        self.odwCommonDataContext = odwCommonDataContext
+    }
+
+    /// Default constructor.
+    public init() {
+        odwCommonDataContext = ODWCommonDataContext()
+    }
+
+    /// Domain Name for the current machine.
+    public var domainName:String {
+        get {
+            odwCommonDataContext.domainName
+        }
+        set {
+            odwCommonDataContext.domainName = newValue
+        }
+    }
+
+    /// Friendly Machine Name
+    public var machineName:String {
+        get {
+            odwCommonDataContext.machineName
+        }
+        set {
+            odwCommonDataContext.machineName = newValue
+        }
+    }
+
+    /// User Name such as the Login Name.
+    public var userNames:[Any] {
+        get {
+            odwCommonDataContext.userNames as? [Any] ?? []
+        }
+        set {
+            odwCommonDataContext.userNames = NSMutableArray(array: newValue)
+        }
+    }
+
+    /// User Alias, if different that UserName.
+    public var userAliases:[Any] {
+        get {
+            odwCommonDataContext.userAliases as? [Any] ?? []
+        }
+        set {
+            odwCommonDataContext.userAliases = NSMutableArray(array: newValue)
+        }
+    }
+
+    /// IP Addresses for local network ports such as IPv4, IPv6, etc.
+    public var IPAddresses:[Any] {
+        get {
+            odwCommonDataContext.ipAddresses as? [Any] ?? []
+        }
+        set {
+            odwCommonDataContext.ipAddresses = NSMutableArray(array: newValue)
+        }
+    }
+
+    /// Collection of Language Identifiers.
+    public var languageIdentifiers:[Any] {
+        get {
+            odwCommonDataContext.languageIdentifiers as? [Any] ?? []
+        }
+        set {
+            odwCommonDataContext.languageIdentifiers = NSMutableArray(array: newValue)
+        }
+    }
+
+    /// Collection of Machine Identifies such as Machine Name, Motherboard ID, MAC Address, etc.
+    public var machineIDs:[Any] {
+        get {
+            odwCommonDataContext.machineIds as? [Any] ?? []
+        }
+        set {
+            odwCommonDataContext.machineIds = NSMutableArray(array: newValue)
+        }
+    }
+
+    /// Collection of Out-of-Scope identifiers such as Client ID, etc.
+    public var outOfScopeIdentifiers:[Any] {
+        get {
+            odwCommonDataContext.outOfScopeIdentifiers as? [Any] ?? []
+        }
+        set {
+            odwCommonDataContext.outOfScopeIdentifiers = NSMutableArray(array: newValue)
+        }
+    }
+}

wrappers/swift/Sources/OneDSSwift/EventProperties.swift

@@ -45,21 +45,6 @@ public final class EventProperties {
         odwEventProperties = ODWEventProperties(name: name, properties: properties, piiTags: piiTags)
     }
 
-    /// Returns ODWEventProperties object, around which the Swift class is wrapped.
-    public func getODWEventPropertiesObject() -> ODWEventProperties {
-        return odwEventProperties
-    }
-
-    /// Returns all the properties as dictionary
-    public func properties() -> [String: Any] {
-        return odwEventProperties.properties
-    }
-
-    /// Returns all the piiTags as dictionary
-    public func piiTags() -> [String: Any] {
-        return odwEventProperties.piiTags
-    }
-
     /**
     Sets the base type of the event, populated in Records.Type.
 
@@ -87,9 +72,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: Value of the property.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withValue value: Any, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withValue value: Any, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withValue: value, with: piiKind)
     }
 
@@ -110,9 +95,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: A Double that contains the property value.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withDoubleValue value: Double, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withDoubleValue value: Double, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withDoubleValue: value, with: piiKind)
     }
 
@@ -133,9 +118,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: An integer that contains the property value.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withInt64Value value: Int64, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withInt64Value value: Int64, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withInt64Value: value, with: piiKind)
     }
 
@@ -156,9 +141,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: An integer that contains the property value.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withUInt8Value value: UInt8, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withUInt8Value value: UInt8, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withUInt8Value: value, with: piiKind)
     }
 
@@ -179,9 +164,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: An integer that contains the property value.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withUInt64Value value: UInt64, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withUInt64Value value: UInt64, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withUInt64Value: value, with: piiKind)
     }
 
@@ -202,9 +187,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: A `Bool` that contains the property value.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withBoolValue value: Bool, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withBoolValue value: Bool, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withBoolValue: value, with: piiKind)
     }
 
@@ -225,9 +210,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: A "UUID" that contains the property value.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withUUIDValue value: UUID, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withUUIDValue value: UUID, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withUUIDValue: value, with: piiKind)
     }
 
@@ -248,9 +233,9 @@ public final class EventProperties {
     - Parameters:
         - name: Name of the property.
         - value: A `Date` that contains the property value.
-        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::ODWPiiKind enum values.
+        - piiKind: The kind of Personal Identifieable Information (PII), one from the ::PIIKind enum values.
     */
-    public func setProperty(_ name: String, withDateValue value: Date, withPiiKind piiKind: ODWPiiKind) {
+    public func setProperty(_ name: String, withDateValue value: Date, withPiiKind piiKind: PIIKind) {
         odwEventProperties.setProperty(name, withDateValue: value, with: piiKind)
     }
 
@@ -261,8 +246,13 @@ public final class EventProperties {
         - privTags: Privacy data type of the event.
         - privLevel: Privacy diagnostic level of the event.
     */
-    public func setPrivacyMetadata(_ privTags: ODWPrivacyDataType, withdWDiagLevel privLevel: ODWDiagLevel) {
+    public func setPrivacyMetadata(_ privTags: PrivacyDataType, withdWDiagLevel privLevel: DiagnosticLevel) {
         odwEventProperties.setProperty("EventInfo.PrivTags", withUInt64Value: UInt64(privTags.rawValue))
         odwEventProperties.setProperty("EventInfo.Level", withUInt8Value: UInt8(privLevel.rawValue))
     }
+
+    /// Returns ODWEventProperties object, around which the Swift class is wrapped.
+    func getODWEventPropertiesObject() -> ODWEventProperties {
+        return odwEventProperties
+    }
 }

wrappers/swift/Sources/OneDSSwift/LogConfiguration.swift

@@ -7,22 +7,27 @@ import ObjCModule
 
 /// Class wrapping `ODWLogConfiguration` ObjC class object, representing configuration related to events.
 public final class LogConfiguration {
-    private var odwLogConfiguration: ODWLogConfiguration
+    private var _odwLogConfiguration: ODWLogConfiguration
+    var odwLogConfiguration:ODWLogConfiguration {
+        get {
+            odwLogConfiguration
+        }
+    }
 
     /**
     Constructs `self` with provided config as `ODWLogConfiguration` object.
 
     - Parameters:
         - config: `ODWLogConfiguration` object which would be wrapped to.
     */
-    public init(config: ODWLogConfiguration) {
-        self.odwLogConfiguration = config
+    init(config: ODWLogConfiguration) {
+        self._odwLogConfiguration = config
     }
 
     /// Return a copy of the default configuration
     public static func getLogConfigurationCopy() -> LogConfiguration? {
-        if let odwLogConfiguration = ODWLogConfiguration.getCopy() {
-            return LogConfiguration(config: odwLogConfiguration)
+        if let _odwLogConfiguration = ODWLogConfiguration.getCopy() {
+            return LogConfiguration(config: _odwLogConfiguration)
         } else {
             return nil
         }
@@ -191,12 +196,12 @@ public final class LogConfiguration {
         - value: A value as a `String`.
     */
     public func set(_ key: String, havingValue value: String) {
-        self.odwLogConfiguration.set(key, withValue: value)
+        _odwLogConfiguration.set(key, withValue: value)
     }
 
     /// Returns the value as `String` for the given `String` key.
     public func value(forKey key: String) -> String? {
-        return self.odwLogConfiguration.value(forKey: key)
+        return _odwLogConfiguration.value(forKey: key)
     }
 
     /**
@@ -206,11 +211,11 @@ public final class LogConfiguration {
         - host: A host value as `String`.
     */
     public func setHost(_ host: String) {
-        self.odwLogConfiguration.setHost(host)
+        _odwLogConfiguration.setHost(host)
     }
 
     /// Returns the host value as `String`.
     public func host() -> String? {
-        return self.odwLogConfiguration.host()
+        return _odwLogConfiguration.host()
     }
 }