Add parameters to public methods (#2492)

* add parametreized interface

* Unit test for parameters

* deprecated get access token

* UserAccountResult tests

* added tests for SignInAfter states

* Objective C/SAmple app public

* Update MSAL/src/native_auth/public/MSALNativeAuthPublicClientApplication.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/parameters/MSALNativeAuthGetAccessTokenParameters.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/parameters/MSALNativeAuthSignInAfterSignUpParameters.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/parameters/MSALNativeAuthSignInParameters.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/parameters/MSALNativeAuthSignUpParameters.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/parameters/MSALNativeAuthResetPasswordParameters.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/parameters/MSALNativeAuthSignInAfterResetPasswordParameters .swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/parameters/MSALNativeAuthSignInParameters.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/MSALNativeAuthUserAccountResult.swift

Co-authored-by: Danilo Raspa <[email protected]>

* Update MSAL/src/native_auth/public/state_machine/state/SignInAfterResetPasswordState.swift

Co-authored-by: Danilo Raspa <[email protected]>

* PR Comments

* PR Changes

* Homogenized wording to flow

* Add default value for force refresh

* PR comments

* Update changelog

* Update changelog

* Updated version

* latest ic

---------

Co-authored-by: Danilo Raspa <[email protected]>

Author: spetrescu84

CHANGELOG.md

@@ -1,3 +1,6 @@
+## [1.7.0]
+* Move native auth public methods to parameter class
+
 ## [1.6.3]
 * Merge 1.6.1-hotfix
 

MSAL/MSAL.xcodeproj/project.pbxproj

@@ -24,7 +24,7 @@
 
 @_implementationOnly import MSAL_Private
 
-class MSALNativeAuthSignInParameters {
+class MSALNativeAuthInternalSignInParameters {
     let username: String
     let password: String?
     let context: MSALNativeAuthRequestContext

MSAL/src/native_auth/controllers/sign_in/MSALNativeAuthSignInParameters.swift renamed to MSAL/src/native_auth/controllers/sign_in/MSALNativeAuthInternalSignInParameters.swift

@@ -74,7 +74,7 @@ final class MSALNativeAuthSignInController: MSALNativeAuthTokenController, MSALN
 
     // MARK: - Internal
 
-    func signIn(params: MSALNativeAuthSignInParameters) async -> SignInControllerResponse {
+    func signIn(params: MSALNativeAuthInternalSignInParameters) async -> SignInControllerResponse {
         let eventId: MSALNativeAuthTelemetryApiId =
         params.password == nil ? .telemetryApiIdSignInWithCodeStart : .telemetryApiIdSignInWithPasswordStart
         MSALLogger.log(level: .info, context: params.context, format: "SignIn started")
@@ -737,7 +737,7 @@ final class MSALNativeAuthSignInController: MSALNativeAuthTokenController, MSALN
     // swiftlint:disable:next function_body_length
     private func handleChallengeResponse(
         _ validatedResponse: MSALNativeAuthSignInChallengeValidatedResponse,
-        params: MSALNativeAuthSignInParameters,
+        params: MSALNativeAuthInternalSignInParameters,
         telemetryInfo: TelemetryInfo
     ) async -> SignInControllerResponse {
         let scopes = joinScopes(params.scopes)

MSAL/src/native_auth/controllers/sign_in/MSALNativeAuthSignInController.swift

@@ -33,7 +33,7 @@ protocol MSALNativeAuthSignInControlling {
     typealias SignInSubmitPasswordControllerResponse = MSALNativeAuthControllerTelemetryWrapper<SignInPasswordRequiredResult>
     typealias SignInResendCodeControllerResponse = MSALNativeAuthControllerTelemetryWrapper<SignInResendCodeResult>
 
-    func signIn(params: MSALNativeAuthSignInParameters) async -> SignInControllerResponse
+    func signIn(params: MSALNativeAuthInternalSignInParameters) async -> SignInControllerResponse
 
     func signIn(
         username: String,

MSAL/src/native_auth/controllers/sign_in/MSALNativeAuthSignInControlling.swift

@@ -73,7 +73,7 @@ extension MSALNativeAuthPublicClientApplication {
 
         let controller = controllerFactory.makeSignInController(cacheAccessor: cacheAccessor)
 
-        let params = MSALNativeAuthSignInParameters(
+        let params = MSALNativeAuthInternalSignInParameters(
             username: username,
             password: password,
             context: context,

MSAL/src/native_auth/public/MSALNativeAuthPublicClientApplication+Internal.swift

@@ -149,26 +149,20 @@ public final class MSALNativeAuthPublicClientApplication: MSALPublicClientApplic
 
     // MARK: delegate methods
 
-    /// Sign up a user with a given username and password.
+    /// Sign up a user using parameters.
     /// - Parameters:
-    ///   - username: Username for the new account.
-    ///   - password: Optional. Password to be used for the new account.
-    ///   - attributes: Optional. User attributes to be used during account creation.
-    ///   - correlationId: Optional. UUID to correlate this request with the server for debugging.
+    ///   - parameters: Parameters used for the Sign Up flow.
     ///   - delegate: Delegate that receives callbacks for the Sign Up flow.
     public func signUp(
-        username: String,
-        password: String? = nil,
-        attributes: [String: Any]? = nil,
-        correlationId: UUID? = nil,
+        parameters: MSALNativeAuthSignUpParameters,
         delegate: SignUpStartDelegate
     ) {
         Task {
             let controllerResponse = await signUpInternal(
-                username: username,
-                password: password,
-                attributes: attributes,
-                correlationId: correlationId
+                username: parameters.username,
+                password: parameters.password,
+                attributes: parameters.attributes,
+                correlationId: parameters.correlationId
             )
 
             let delegateDispatcher = SignUpStartDelegateDispatcher(delegate: delegate, telemetryUpdate: controllerResponse.telemetryUpdate)
@@ -190,26 +184,47 @@ public final class MSALNativeAuthPublicClientApplication: MSALPublicClientApplic
         }
     }
 
-    /// Sign in a user with a given username and password.
+    /// Sign up a user with a given username and password.
     /// - Parameters:
-    ///   - username: Username for the account
-    ///   - password: Optional. Password for the account.
-    ///   - scopes: Optional. Permissions you want included in the access token received after sign in flow has completed.
+    ///   - username: Username for the new account.
+    ///   - password: Optional. Password to be used for the new account.
+    ///   - attributes: Optional. User attributes to be used during account creation.
     ///   - correlationId: Optional. UUID to correlate this request with the server for debugging.
-    ///   - delegate: Delegate that receives callbacks for the Sign In flow.
-    public func signIn(
+    ///   - delegate: Delegate that receives callbacks for the Sign Up flow.
+    @available(*, deprecated, message: "This method is now deprecated. Use the method 'signUp(parameters:)' instead.")
+    public func signUp(
         username: String,
         password: String? = nil,
-        scopes: [String]? = nil,
+        attributes: [String: Any]? = nil,
         correlationId: UUID? = nil,
+        delegate: SignUpStartDelegate
+    ) {
+        Task {
+            let parameters = MSALNativeAuthSignUpParameters(username: username)
+            parameters.password = password
+            parameters.attributes = attributes
+            parameters.correlationId = correlationId
+            signUp(
+                parameters: parameters,
+                delegate: delegate
+            )
+        }
+    }
+
+    /// Sign in a user using parameters.
+    /// - Parameters:
+    ///   - parameters: Parameters used for the Sign In flow.
+    ///   - delegate: Delegate that receives callbacks for the Sign In flow.
+    public func signIn(
+        parameters: MSALNativeAuthSignInParameters,
         delegate: SignInStartDelegate
     ) {
         Task {
             let controllerResponse = await signInInternal(
-                username: username,
-                password: password,
-                scopes: scopes,
-                correlationId: correlationId
+                username: parameters.username,
+                password: parameters.password,
+                scopes: parameters.scopes,
+                correlationId: parameters.correlationId
             )
 
             let delegateDispatcher = SignInStartDelegateDispatcher(delegate: delegate, telemetryUpdate: controllerResponse.telemetryUpdate)
@@ -235,18 +250,42 @@ public final class MSALNativeAuthPublicClientApplication: MSALPublicClientApplic
         }
     }
 
-    /// Reset the password for a given username.
+    /// Sign in a user with a given username and password.
     /// - Parameters:
-    ///   - username: Username for the account.
+    ///   - username: Username for the account
+    ///   - password: Optional. Password for the account.
+    ///   - scopes: Optional. Permissions you want included in the access token received after sign in flow has completed.
     ///   - correlationId: Optional. UUID to correlate this request with the server for debugging.
-    ///   - delegate: Delegate that receives callbacks for the Reset Password flow.
-    public func resetPassword(
+    ///   - delegate: Delegate that receives callbacks for the Sign In flow.
+    @available(*, deprecated, message: "This method is now deprecated. Use the method 'signIn(parameters:)' instead.")
+    public func signIn(
         username: String,
+        password: String? = nil,
+        scopes: [String]? = nil,
         correlationId: UUID? = nil,
+        delegate: SignInStartDelegate
+    ) {
+        let parameters = MSALNativeAuthSignInParameters(username: username)
+        parameters.password = password
+        parameters.scopes = scopes
+        parameters.correlationId = correlationId
+        signIn(
+            parameters: parameters,
+            delegate: delegate
+        )
+    }
+
+    /// Reset the password using parameters
+    /// - Parameters:
+    ///   - parameters: Parameters used for the Reset Password flow.
+    ///   - delegate: Delegate that receives callbacks for the Reset Password flow.
+    public func resetPassword(
+        parameters: MSALNativeAuthResetPasswordParameters,
         delegate: ResetPasswordStartDelegate
     ) {
         Task {
-            let controllerResponse = await resetPasswordInternal(username: username, correlationId: correlationId)
+            let controllerResponse = await resetPasswordInternal(username: parameters.username,
+                                                                 correlationId: parameters.correlationId)
 
             let delegateDispatcher = ResetPasswordStartDelegateDispatcher(delegate: delegate, telemetryUpdate: controllerResponse.telemetryUpdate)
 
@@ -265,6 +304,25 @@ public final class MSALNativeAuthPublicClientApplication: MSALPublicClientApplic
         }
     }
 
+    /// Reset the password for a given username.
+    /// - Parameters:
+    ///   - username: Username for the account.
+    ///   - correlationId: Optional. UUID to correlate this request with the server for debugging.
+    ///   - delegate: Delegate that receives callbacks for the Reset Password flow.
+    @available(*, deprecated, message: "This method is now deprecated. Use the method 'resetPassword(parameters:)' instead.")
+    public func resetPassword(
+        username: String,
+        correlationId: UUID? = nil,
+        delegate: ResetPasswordStartDelegate
+    ) {
+        let parameters = MSALNativeAuthResetPasswordParameters(username: username)
+        parameters.correlationId = correlationId
+        resetPassword(
+            parameters: parameters,
+            delegate: delegate
+        )
+    }
+
     /// Retrieve the current signed in account from the cache.
     /// - Parameter correlationId: Optional. UUID to correlate this request with the server for debugging.
     /// - Returns: An object representing the account information if present in the local cache.

MSAL/src/native_auth/public/MSALNativeAuthPublicClientApplication.swift

@@ -105,7 +105,7 @@ extension MSALNativeAuthUserAccountResult {
         let mfaRequiredErrorCode = 50076
         return errorCodes.contains(mfaRequiredErrorCode)
     }
-    
+
     private func isResetPasswordRequiredError(errorCodes: [Int]) -> Bool {
         return errorCodes.contains(MSALNativeAuthESTSApiErrorCodes.resetPasswordRequired.rawValue)
     }

MSAL/src/native_auth/public/MSALNativeAuthUserAccountResult+Internal.swift

@@ -76,11 +76,32 @@ import Foundation
         }
     }
 
+    // Retrieves the access token for the currently signed in account from the cache for the provided parameters.
+    /// - Parameters:
+    ///   - parameters: Parameters used for the Get Access Token flow.
+    ///   - delegate: Delegate that receives callbacks for the Get Access Token flow.
+    ///
+    @objc public func getAccessToken(parameters: MSALNativeAuthGetAccessTokenParameters,
+                                     delegate: CredentialsDelegate) {
+
+        MSALLogger.log(
+            level: .info,
+            context: nil,
+            format: "Retrieving access token with parameters started."
+        )
+
+        getAccessTokenInternal(forceRefresh: parameters.forceRefresh ?? false,
+                               scopes: parameters.scopes ?? [],
+                               correlationId: parameters.correlationId,
+                               delegate: delegate)
+    }
+
     /// Retrieves the access token for the default OIDC(openid, offline_access, profile) scopes from the cache.
     /// - Parameters:
     ///   - forceRefresh: Optional. Ignore any existing access token in the cache and force MSAL to get a new access token from the service.
     ///   - correlationId: Optional. UUID to correlate this request with the server for debugging.
     ///   - delegate: Delegate that receives callbacks for the Get Access Token flow.
+    @available(*, deprecated, message: "This method is now deprecated. Use the method 'getAccessToken(parameters:)' instead.")
     @objc public func getAccessToken(forceRefresh: Bool = false,
                                      correlationId: UUID? = nil,
                                      delegate: CredentialsDelegate) {
@@ -104,6 +125,7 @@ import Foundation
     ///   - forceRefresh: Optional. Ignore any existing access token in the cache and force MSAL to get a new access token from the service.
     ///   - correlationId: Optional. UUID to correlate this request with the server for debugging.
     ///   - delegate: Delegate that receives callbacks for the Get Access Token flow.
+    @available(*, deprecated, message: "This method is now deprecated. Use the method 'getAccessToken(parameters:)' instead.")
     public func getAccessToken(scopes: [String],
                                forceRefresh: Bool = false,
                                correlationId: UUID? = nil,

MSAL/src/native_auth/public/MSALNativeAuthUserAccountResult.swift

@@ -0,0 +1,38 @@
+//
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.  
+
+/// Encapsulates the parameters passed to the getAccessToken method of MSALNativeAuthUserAccountResult
+@objcMembers
+public class MSALNativeAuthGetAccessTokenParameters: NSObject {
+
+    /// Set to true to ignore any existing access token in the cache and force MSAL to get a new access token from the service.
+    public var forceRefresh: Bool = false
+
+    /// Permissions you want included in the access token received.
+    /// Not all scopes are guaranteed to be included in the access token returned.
+    public var scopes: [String]?
+
+    /// UUID to correlate this request with the server for debugging.
+    public var correlationId: UUID?
+}