Merge pull request #25 from ForgeRock/develop

Ping SDK 1.0.0 Release

README.md

@@ -18,65 +18,16 @@ This SDK is support Browser, iOS and Android platforms.
     ├── foundation                            # Foundation module
     │   ├── android                           # Android Common
     │   ├── davinci-plugin                    # For module that integrated with davinci
-    │   ├── device                            # Device module
-    │   │   ├── device-id                     # Generate and manage Device Id
-    │   │   └── device-integrity              # Device and App Integriry
-    │   ├── fido                              # WebAuthn integration
-    │   ├── journey-plugin                    # For module that integrated with journey
+    │   ├── journey-plugin*                   # For module that integrated with journey
     │   ├── logger                            # Provide Logging interface and common loggers
-    │   ├── network                           # Provide Networking interface
-    │   ├── oidc                              # Provide OIDC interface
-    │   └── storage                           # Provide Storage interface
+    │   ├── oidc*                             # Provide OIDC interface
+    │   ├── orchestrate                       # Orchestrating authentication flow framework
+    │   ├── storage                           # Provide Storage interface
+    │   └── utils                             # Provide common utilities function
     ├── davinci                               # Orchestrate authentication with PingOne Davinci
-    ├── journey                               # Orchestrate authentication with Journey
-    ├── mfa                                   # Provide interface to build Authenticator App
-    ├── protect                               # Provide PingOne Protect integration
-    ├── external-idp                          # Provide Native Google, Facebook, Apple SocialLogin
-    ├── verify                                # Provide PingOne Verify integration
-    ├── wallet                                # Provide PingOne Neo integration
+    ├── journey*                              # Orchestrate authentication with Journey
+    ├── external-idp*                          # Provide Native Google, Facebook, Apple SocialLogin
     ├── ...
     └── ...
 
-## Add dependency to your project
-
-The Ping SDK for Android project emphasizes modularity, allowing you to select and include only the necessary SDKs for your app, instead of including the entire SDK.
-For example:
-
-### Scenario 1:
-
-An application with Centralized Login
-
-```kotlin
-dependencies {
-    implementation("com.pingidentity.sdks:oidc:$ping_version")
-}
-```
-
-### Scenario 2:
-
-An Orchestrate authentication with PingOne Davinci, and in the flow, I would like to enable PingOne Protect
-
-```kotlin
-dependencies {
-    implementation("com.pingidentity.sdks:davinci:$ping_version")
-    implementation("com.pingidentity.sdks:protect:$ping_version")
-}
-```
-
-### Scenario 3:
-
-An Orchestrate authentication with Journey, and in the authentication journey, I would like to have Google Social Login,
-enable PingOne Protect and PingOne Verify
-
-```kotlin
-dependencies {
-    implementation("com.pingidentity.sdks:journey:$ping_version")
-    implementation("com.pingidentity.sdks:protect:$ping_version")
-    implementation("com.pingidentity.sdks:verify:$ping_version")
-    implementation("com.pingidentity.sdks:social-login:$ping_version")
-}
-```
-
-As you can see, the `protect` module is included in both scenarios. 
-This is because the `protect` module is a dependency of the `davinci` and `journey` modules.
-Similarly, the `verify` and other modules can be shared across the `journey` and `davinci` modules.
+***Note***: * Module under development and experimental

foundation/oidc/README.md

@@ -5,6 +5,8 @@
   <hr/>
 </p>
 
+# This Module is currently under development, do not apply this module directly to your project.
+
 `oidc` module provides OIDC client for PingOne and ForgeRock platform.
 
 The `oidc` module follows the [OIDC](https://openid.net/specs/openid-connect-core-1_0.html) specification and
@@ -33,9 +35,9 @@ to receive the redirect from the browser.
 ```xml
 
 <activity
-        android:name="net.openid.appauth.RedirectUriReceiverActivity"
-        android:exported="true"
-        tools:node="replace">
+    android:name="net.openid.appauth.RedirectUriReceiverActivity"
+    android:exported="true"
+    tools:node="replace">
     <intent-filter>
         <action android:name="android.intent.action.VIEW"/>
 
@@ -55,7 +57,7 @@ Basic Configuration, use `discoveryEndpoint` to lookup OIDC endpoints
 ```kotlin
 val ping = OidcClient {
     discoveryEndpoint =
-            "https://auth.pingone.ca/02fb4743-189a-4bc7-9d6c-a919edfe6447/as/.well-known/openid-configuration"
+        "https://auth.pingone.ca/02fb4743-189a-4bc7-9d6c-a919edfe6447/as/.well-known/openid-configuration"
     clientId = "c12743f9-08e8-4420-a624-71bbb08e9fe1"
     redirectUri = "org.forgerock.demo://oauth2redirect"
     scopes = mutableSetOf("openid", "email", "address", "profile", "phone")
@@ -116,7 +118,7 @@ the [customTab property](https://developer.android.com/reference/androidx/browse
 val ping = OidcClient {
 
     agent(browser) {
-        
+
         // Customize the CustomTab
         customTab = {
             setColorScheme(CustomTabsIntent.COLOR_SCHEME_DARK)