Make config and api key optional in dashboard init

Author: nkshah2

.gitignore

@@ -20,4 +20,5 @@ gin/
 
 apiPassword
 releasePassword
-.vscode/
+.vscode/
+.idea/

recipe/dashboard/dashboardmodels/models.go

@@ -16,12 +16,20 @@
 package dashboardmodels
 
 type TypeInput struct {
-	ApiKey   string
+	ApiKey   *string
 	Override *OverrideStruct
 }
 
+type TypeAuthMode string
+
+const (
+	AuthModeEmailPassword TypeAuthMode = "email-password"
+	AuthModeAPIKey        TypeAuthMode = "api-key"
+)
+
 type TypeNormalisedInput struct {
-	ApiKey   string
+	ApiKey   *string
+	AuthMode TypeAuthMode
 	Override OverrideStruct
 }
 
@@ -36,11 +44,11 @@ type ThirdParty struct {
 }
 
 type UserType struct {
-	Id         string     `json:"id,omitempty"`
-	TimeJoined uint64     `json:"timeJoined,omitempty"`
-	FirstName  string     `json:"firstName,omitempty"`
-	LastName   string     `json:"lastName,omitempty"`
-	Email      string     `json:"email,omitempty"`
+	Id         string      `json:"id,omitempty"`
+	TimeJoined uint64      `json:"timeJoined,omitempty"`
+	FirstName  string      `json:"firstName,omitempty"`
+	LastName   string      `json:"lastName,omitempty"`
+	Email      string      `json:"email,omitempty"`
 	ThirdParty *ThirdParty `json:"thirdParty,omitempty"`
-	Phone      string     `json:"phoneNumber,omitempty"`
+	Phone      string      `json:"phoneNumber,omitempty"`
 }

recipe/dashboard/main.go

@@ -20,6 +20,6 @@ import (
 	"github.com/supertokens/supertokens-golang/supertokens"
 )
 
-func Init(config dashboardmodels.TypeInput) supertokens.Recipe {
+func Init(config *dashboardmodels.TypeInput) supertokens.Recipe {
 	return recipeInit(config)
 }

recipe/dashboard/recipe.go

@@ -36,7 +36,7 @@ type Recipe struct {
 
 var singletonInstance *Recipe
 
-func MakeRecipe(recipeId string, appInfo supertokens.NormalisedAppinfo, config dashboardmodels.TypeInput, onSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)) (Recipe, error) {
+func MakeRecipe(recipeId string, appInfo supertokens.NormalisedAppinfo, config *dashboardmodels.TypeInput, onSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)) (Recipe, error) {
 	r := &Recipe{}
 	verifiedConfig := validateAndNormaliseUserInput(appInfo, config)
 	r.Config = verifiedConfig
@@ -52,7 +52,7 @@ func MakeRecipe(recipeId string, appInfo supertokens.NormalisedAppinfo, config d
 	return *r, nil
 }
 
-func recipeInit(config dashboardmodels.TypeInput) supertokens.Recipe {
+func recipeInit(config *dashboardmodels.TypeInput) supertokens.Recipe {
 	return func(appInfo supertokens.NormalisedAppinfo, onSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)) (*supertokens.RecipeModule, error) {
 		if singletonInstance == nil {
 			recipe, err := MakeRecipe(RECIPE_ID, appInfo, config, onSuperTokensAPIError)

recipe/dashboard/recipeimplementation.go

@@ -31,6 +31,11 @@ func makeRecipeImplementation() dashboardmodels.RecipeInterface {
 	}
 
 	shouldAllowAccess := func(req *http.Request, config dashboardmodels.TypeNormalisedInput, userContext supertokens.UserContext) (bool, error) {
+		if config.ApiKey == nil {
+			// TODO Handle sign in logic here
+			return false, nil
+		}
+
 		apiKeyHeaderValue := req.Header.Get("authorization")
 
 		// We receieve the api key as `Bearer API_KEY`, this retrieves just the key
@@ -41,7 +46,7 @@ func makeRecipeImplementation() dashboardmodels.RecipeInterface {
 			return false, nil
 		}
 
-		return apiKeyHeaderValue == config.ApiKey, nil
+		return apiKeyHeaderValue == *config.ApiKey, nil
 	}
 
 	return dashboardmodels.RecipeInterface{

recipe/dashboard/utils.go

@@ -23,15 +23,14 @@ import (
 	"github.com/supertokens/supertokens-golang/supertokens"
 )
 
-func validateAndNormaliseUserInput(appInfo supertokens.NormalisedAppinfo, config dashboardmodels.TypeInput) dashboardmodels.TypeNormalisedInput {
+func validateAndNormaliseUserInput(appInfo supertokens.NormalisedAppinfo, config *dashboardmodels.TypeInput) dashboardmodels.TypeNormalisedInput {
 	typeNormalisedInput := makeTypeNormalisedInput(appInfo)
 
-	if strings.Trim(config.ApiKey, " ") == "" {
-		panic("ApiKey provided to Dashboard recipe cannot be empty")
+	if config.ApiKey != nil {
+		typeNormalisedInput.ApiKey = config.ApiKey
+		typeNormalisedInput.AuthMode = dashboardmodels.AuthModeAPIKey
 	}
 
-	typeNormalisedInput.ApiKey = config.ApiKey
-
 	if config.Override != nil {
 		if config.Override.Functions != nil {
 			typeNormalisedInput.Override.Functions = config.Override.Functions
@@ -46,6 +45,7 @@ func validateAndNormaliseUserInput(appInfo supertokens.NormalisedAppinfo, config
 
 func makeTypeNormalisedInput(appInfo supertokens.NormalisedAppinfo) dashboardmodels.TypeNormalisedInput {
 	return dashboardmodels.TypeNormalisedInput{
+		AuthMode: dashboardmodels.AuthModeEmailPassword,
 		Override: dashboardmodels.OverrideStruct{
 			Functions: func(originalImplementation dashboardmodels.RecipeInterface) dashboardmodels.RecipeInterface {
 				return originalImplementation