feat: Added APIs for Passport in Blueprint and C++, with samples

Author: bphelan

.gitignore

@@ -72,3 +72,9 @@ Plugins/*/Intermediate/*
 
 # Cache files for the editor to use
 DerivedDataCache/*
+
+.vsconfig
+
+.idea/
+
+node_modules/

Content/BlueprintSampleContent/PassportBlueprintSampleLevel1.umap

@@ -0,0 +1,31 @@
+{
+	"FileVersion": 3,
+	"Version": 1,
+	"VersionName": "1.0",
+	"FriendlyName": "Immutable",
+	"Description": "",
+	"Category": "Other",
+	"CreatedBy": "",
+	"CreatedByURL": "",
+	"DocsURL": "",
+	"MarketplaceURL": "",
+	"SupportURL": "",
+	"CanContainContent": true,
+	"IsBetaVersion": true,
+	"IsExperimentalVersion": true,
+	"Installed": true,
+	"EnabledByDefault": true,
+	"Modules": [
+		{
+			"Name": "Immutable",
+			"Type": "Runtime",
+			"LoadingPhase": "Default"
+		}
+	],
+	"Plugins": [
+		{
+			"Name": "WebBrowserWidget",
+			"Enabled": true
+		}
+	]
+}

Content/BlueprintSampleContent/PassportBlueprintSampleLevel2.umap

@@ -1 +1,45 @@
-# ImmutableSDK-Unreal
+# Immutable SDK for Unreal 
+
+## User Guide
+
+### Installation
+
+To install the plugin download it into your project's `Plugins` folder, e.g.: `MyGame/Plugins/unreal-immutable-sdk`.
+
+### Setup
+
+#### Blueprint
+
+See the included sample widgets in `All`->`Plugins`->`Immutable Content` in the Unreal Editor content browser for examples of how to use the plugin in Blueprint.  If you don't see a `Plugins` folder under `All` you may need to enable `Show Plugin Content` in the content browser's `Settings` menu.
+
+#### C++
+
+See `ImmutablePassport.h` for the C++ Passport API.  Follow the same sequence of steps as the Blueprint widget example to initialise and connect Passport and retrieve account data.
+
+
+## Plugin Maintainers' Guide
+
+### Getting Started
+
+See user docs to install the plugin, with one caveat:  If you want to open the project and plugin in an IDE you'll need to create your Unreal project as a C++ project.  If you've already accidentally created your Unreal project as BluePrint-only you can convert it to a BluePrint-and-C++ project by adding any C++ class from the `Add New C++ Class` option in the Unreal Editor's `File` menu.
+
+### Debugging the Embedded Browser
+
+#### Embedded Browser Logs
+
+See `Saved/Logs/cef3.log` in your Unreal project.
+
+#### JS Console Output
+
+In Unreal Engine 5.1+ the project is set up so that `console.log()` will pass all the way through to the Unreal console.  This isn't available in UE5.0 and earlier but you can still use Chromium's remote debugging (see below).
+
+#### Remote Debugging
+
+To set up Chromium remote debugging, edit project build/launch configurations in your IDE to add the following program command line argument to the appropriate configurations: `cefdebug=9222`
+
+Next, launch the game and then open a separate Chrome/Chromium browser and navigate to `chrome://inspect` where your app should be listed, sometimes intermittently or after a delay, under the `Remote Target #localhost` section.  Click `inspect` to launch the remote debugging session.
+
+#### Displaying the Browser
+
+**TODO**
+

Content/BlueprintSampleContent/PassportSampleLevelWidget.uasset

@@ -0,0 +1,61 @@
+// Copyright Epic Games, Inc. All Rights Reserved.
+
+using UnrealBuildTool;
+
+public class Immutable : ModuleRules
+{
+	public Immutable(ReadOnlyTargetRules Target) : base(Target)
+	{
+		PCHUsage = ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs;
+
+		PublicIncludePaths.AddRange(
+			new string[]
+			{
+				// ... add public include paths required here ...
+			}
+		);
+
+
+		PrivateIncludePaths.AddRange(
+			new string[]
+			{
+				// ... add other private include paths required here ...
+			}
+		);
+
+
+		PublicDependencyModuleNames.AddRange(
+			new string[]
+			{
+				"Core",
+				"WebBrowserWidget",
+				// ... add other public dependencies that you statically link with here ...
+			}
+		);
+
+
+		PrivateDependencyModuleNames.AddRange(
+			new string[]
+			{
+				"CoreUObject",
+				"Engine",
+				"Slate",
+				"SlateCore",
+				"Json",
+				"JsonUtilities",
+				"WebBrowser",
+				"UMG",
+				"Projects",
+				// ... add private dependencies that you statically link with here ...
+			}
+		);
+
+
+		DynamicallyLoadedModuleNames.AddRange(
+			new string[]
+			{
+				// ... add any modules that your module loads dynamically here ...
+			}
+		);
+	}
+}

Content/BlueprintSampleContent/PassportSampleMenuWidget.uasset

@@ -0,0 +1,13 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+
+#include "Actions/ImtblBlueprintAsyncAction.h"
+
+
+UImmutableSubsystem* UImtblBlueprintAsyncAction::GetSubsystem() const
+{
+    if (!WorldContextObject || !WorldContextObject->GetWorld())
+        return nullptr;
+    return WorldContextObject->GetWorld()->GetGameInstance()->GetSubsystem<UImmutableSubsystem>();
+}
+

Content/PassportBlueprintSample.umap

@@ -0,0 +1,55 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+
+#include "Actions/ImtblPassportConfirmCodeAsyncAction.h"
+
+#include "ImmutablePassport.h"
+#include "ImmutableSubsystem.h"
+#include "ImtblLogging.h"
+
+
+UImtblPassportConfirmCodeAsyncAction* UImtblPassportConfirmCodeAsyncAction::ConfirmCode(UObject* WorldContextObject, const FString& DeviceCode)
+{
+    UImtblPassportConfirmCodeAsyncAction* BlueprintNode = NewObject<UImtblPassportConfirmCodeAsyncAction>();
+    BlueprintNode->WorldContextObject = WorldContextObject;
+    BlueprintNode->DeviceCode = DeviceCode;
+    return BlueprintNode;
+}
+
+
+void UImtblPassportConfirmCodeAsyncAction::Activate()
+{
+    if (!WorldContextObject || !WorldContextObject->GetWorld())
+    {
+        FString Err = "ConfirmCode failed due to missing world or world context object.";
+        IMTBL_WARN("%s", *Err)
+        Failed.Broadcast(Err);
+        return;
+    }
+
+    GetSubsystem()->WhenReady(this, &UImtblPassportConfirmCodeAsyncAction::DoConfirmCode);//, /* timoutSec */ 15.0f);
+}
+
+
+void UImtblPassportConfirmCodeAsyncAction::DoConfirmCode(TWeakObjectPtr<UImtblJSConnector> JSConfirmConnector)
+{
+    // Get Passport
+    auto Passport = GetSubsystem()->GetPassport();
+    // Run ConfirmCode
+    Passport->ConfirmCode(DeviceCode, UImmutablePassport::FImtblPassportResponseDelegate::CreateUObject(this, &UImtblPassportConfirmCodeAsyncAction::OnConfirmCodeCodeResponse));
+}
+
+
+void UImtblPassportConfirmCodeAsyncAction::OnConfirmCodeCodeResponse(FImmutablePassportResult Result)
+{
+    if (Result.Success)
+    {
+        CodeConfirmed.Broadcast(TEXT(""));
+    }
+    else
+    {
+        Failed.Broadcast(Result.Message);
+    }
+}
+
+

Content/index.html

@@ -0,0 +1,63 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+
+#include "Actions/ImtblPassportConnectAsyncAction.h"
+
+#include "ImmutablePassport.h"
+#include "ImmutableSubsystem.h"
+#include "ImtblLogging.h"
+
+
+UImtblPassportConnectAsyncAction* UImtblPassportConnectAsyncAction::Connect(UObject* WorldContextObject)
+{
+    UImtblPassportConnectAsyncAction* PassportInitBlueprintNode = NewObject<UImtblPassportConnectAsyncAction>();
+    PassportInitBlueprintNode->WorldContextObject = WorldContextObject;
+    return PassportInitBlueprintNode;
+}
+
+
+void UImtblPassportConnectAsyncAction::Activate()
+{
+    if (!WorldContextObject || !WorldContextObject->GetWorld())
+    {
+        FString Err = "Connect failed due to missing world or world context object.";
+        IMTBL_WARN("%s", *Err)
+        Failed.Broadcast(Err, TEXT(""), TEXT(""), TEXT(""));
+        return;
+    }
+
+    GetSubsystem()->WhenReady(this, &UImtblPassportConnectAsyncAction::DoConnect);//, /* timoutSec */ 15.0f);
+}
+
+
+void UImtblPassportConnectAsyncAction::DoConnect(TWeakObjectPtr<UImtblJSConnector> JSConnector)
+{
+    // Get Passport
+    auto Passport = GetSubsystem()->GetPassport();
+    // Run Connect
+    Passport->Connect(UImmutablePassport::FImtblPassportResponseDelegate::CreateUObject(this, &UImtblPassportConnectAsyncAction::OnConnectCodeReady));
+}
+
+
+void UImtblPassportConnectAsyncAction::OnConnectCodeReady(FImmutablePassportResult Result)
+{
+    if (Result.Success)
+    {
+        if (auto Data = FImmutablePassportConnectData::FromString(Result.Message))
+        {
+            ConnectData = Data.GetValue();
+            
+            CodeReady.Broadcast(TEXT(""), ConnectData.code, ConnectData.deviceCode, ConnectData.url);
+        }
+        else
+        {
+            IMTBL_WARN("Could not deserialize connect data.")
+            Failed.Broadcast(Result.Message, TEXT(""), TEXT(""), TEXT(""));
+        }
+    }
+    else
+    {
+        Failed.Broadcast(Result.Message, TEXT(""), TEXT(""), TEXT(""));
+    }
+}
+

Immutable.uplugin

@@ -0,0 +1,53 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+
+#include "Actions/ImtblPassportGetAddressAsyncAction.h"
+
+#include "ImmutablePassport.h"
+#include "ImmutableSubsystem.h"
+#include "ImtblLogging.h"
+
+
+UImtblPassportGetAddressAsyncAction* UImtblPassportGetAddressAsyncAction::GetAddress(UObject* WorldContextObject)
+{
+    UImtblPassportGetAddressAsyncAction* PassportInitBlueprintNode = NewObject<UImtblPassportGetAddressAsyncAction>();
+    PassportInitBlueprintNode->WorldContextObject = WorldContextObject;
+    return PassportInitBlueprintNode;
+}
+
+
+void UImtblPassportGetAddressAsyncAction::Activate()
+{
+    if (!WorldContextObject || !WorldContextObject->GetWorld())
+    {
+        FString Err = "GetAddress failed due to missing world or world context object.";
+        IMTBL_WARN("%s", *Err)
+        Failed.Broadcast(Err, TEXT(""));
+        return;
+    }
+
+    GetSubsystem()->WhenReady(this, &UImtblPassportGetAddressAsyncAction::DoGetAddress);//, /* timoutSec */ 15.0f);
+}
+
+
+void UImtblPassportGetAddressAsyncAction::DoGetAddress(TWeakObjectPtr<UImtblJSConnector> JSConnector)
+{
+    // Get Passport
+    auto Passport = GetSubsystem()->GetPassport();
+    // Run GetAddress
+    Passport->GetAddress(UImmutablePassport::FImtblPassportResponseDelegate::CreateUObject(this, &UImtblPassportGetAddressAsyncAction::OnGetAddressResponse));
+}
+
+
+void UImtblPassportGetAddressAsyncAction::OnGetAddressResponse(FImmutablePassportResult Result)
+{
+    if (Result.Success)
+    {
+        GotAddress.Broadcast(TEXT(""), Result.Message);
+    }
+    else
+    {
+        Failed.Broadcast(Result.Message, TEXT(""));
+    }
+}
+

README.md

@@ -0,0 +1,53 @@
+// Fill out your copyright notice in the Description page of Project Settings.
+
+
+#include "Actions/ImtblPassportGetEmailAsyncAction.h"
+
+#include "ImmutablePassport.h"
+#include "ImmutableSubsystem.h"
+#include "ImtblLogging.h"
+
+
+UImtblPassportGetEmailAsyncAction* UImtblPassportGetEmailAsyncAction::GetEmail(UObject* WorldContextObject)
+{
+    UImtblPassportGetEmailAsyncAction* PassportInitBlueprintNode = NewObject<UImtblPassportGetEmailAsyncAction>();
+    PassportInitBlueprintNode->WorldContextObject = WorldContextObject;
+    return PassportInitBlueprintNode;
+}
+
+
+void UImtblPassportGetEmailAsyncAction::Activate()
+{
+    if (!WorldContextObject || !WorldContextObject->GetWorld())
+    {
+        FString Err = "GetEmail failed due to missing world or world context object.";
+        IMTBL_WARN("%s", *Err)
+        Failed.Broadcast(Err, TEXT(""));
+        return;
+    }
+
+    GetSubsystem()->WhenReady(this, &UImtblPassportGetEmailAsyncAction::DoGetEmail);//, /* timoutSec */ 15.0f);
+}
+
+
+void UImtblPassportGetEmailAsyncAction::DoGetEmail(TWeakObjectPtr<UImtblJSConnector> JSConnector)
+{
+    // Get Passport
+    auto Passport = GetSubsystem()->GetPassport();
+    // Run GetEmail
+    Passport->GetEmail(UImmutablePassport::FImtblPassportResponseDelegate::CreateUObject(this, &UImtblPassportGetEmailAsyncAction::OnGetEmailResponse));
+}
+
+
+void UImtblPassportGetEmailAsyncAction::OnGetEmailResponse(FImmutablePassportResult Result)
+{
+    if (Result.Success)
+    {
+        GotEmail.Broadcast(TEXT(""), Result.Message);
+    }
+    else
+    {
+        Failed.Broadcast(Result.Message, TEXT(""));
+    }
+}
+