Dashboard Types

Type Aliases

APIFunction()

type APIFunction = (apiImplementation, tenantId, options, userContext) => Promise<any>;

Defined in: recipe/dashboard/types.ts:68

Parameters

Parameter	Type
apiImplementation	APIInterface
tenantId	string
options	APIOptions
userContext	UserContext

Returns

Promise<any>

APIInterface

type APIInterface = object;

Defined in: recipe/dashboard/types.ts:64

Properties

Property	Type	Defined in
dashboardGET	undefined | (input) => Promise<string>	recipe/dashboard/types.ts:65

APIOptions

type APIOptions = object;

Defined in: recipe/dashboard/types.ts:54

Properties

Property	Type	Defined in
appInfo	NormalisedAppinfo	recipe/dashboard/types.ts:61
config	TypeNormalisedInput	recipe/dashboard/types.ts:56
isInServerlessEnv	boolean	recipe/dashboard/types.ts:60
recipeId	string	recipe/dashboard/types.ts:57
recipeImplementation	RecipeInterface	recipe/dashboard/types.ts:55
req	BaseRequest	recipe/dashboard/types.ts:58
res	BaseResponse	recipe/dashboard/types.ts:59

AuthMode

type AuthMode = "api-key" | "email-password";

Defined in: recipe/dashboard/types.ts:77

CoreConfigFieldInfo

type CoreConfigFieldInfo = object;

Defined in: recipe/dashboard/types.ts:84

Properties

Property	Type	Defined in
defaultValue	string | number | boolean | null	recipe/dashboard/types.ts:92
description	string	recipe/dashboard/types.ts:88
isDifferentAcrossTenants	boolean	recipe/dashboard/types.ts:89
isNullable	boolean	recipe/dashboard/types.ts:91
isPluginProperty	boolean	recipe/dashboard/types.ts:93
isPluginPropertyEditable	boolean	recipe/dashboard/types.ts:94
key	string	recipe/dashboard/types.ts:85
possibleValues?	string[]	recipe/dashboard/types.ts:90
value	string | number | boolean | null	recipe/dashboard/types.ts:87
valueType	"string" | "boolean" | "number"	recipe/dashboard/types.ts:86

RecipeIdForUser

type RecipeIdForUser = "emailpassword" | "thirdparty" | "passwordless" | "webauthn";

Defined in: recipe/dashboard/types.ts:75

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/dashboard/types.ts:45

Methods

getDashboardBundleLocation()

getDashboardBundleLocation(input): Promise<string>;

Defined in: recipe/dashboard/types.ts:46

Parameters

Parameter	Type
input	{ userContext: UserContext; }
input.userContext	UserContext

Returns

Promise<string>

shouldAllowAccess()

shouldAllowAccess(input): Promise<boolean>;

Defined in: recipe/dashboard/types.ts:47

Parameters

Parameter	Type
input	{ config: TypeNormalisedInput; req: BaseRequest; userContext: UserContext; }
input.config	TypeNormalisedInput
input.req	BaseRequest
input.userContext	UserContext

Returns

Promise<boolean>

TypeInput

type TypeInput = object;

Defined in: recipe/dashboard/types.ts:20

Properties

Property	Type	Defined in
admins?	string[]	recipe/dashboard/types.ts:22
apiKey?	string	recipe/dashboard/types.ts:21
override?	object	recipe/dashboard/types.ts:23
override.apis?	(originalImplementation, builder) => APIInterface	recipe/dashboard/types.ts:28
override.functions?	(originalImplementation, builder) => RecipeInterface	recipe/dashboard/types.ts:24

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/dashboard/types.ts:32

Properties

Property	Type	Defined in
admins?	string[]	recipe/dashboard/types.ts:34
apiKey?	string	recipe/dashboard/types.ts:33
authMode	AuthMode	recipe/dashboard/types.ts:35
override	object	recipe/dashboard/types.ts:36
override.apis	(originalImplementation, builder) => APIInterface	recipe/dashboard/types.ts:41
override.functions	(originalImplementation, builder) => RecipeInterface	recipe/dashboard/types.ts:37

UserWithFirstAndLastName

type UserWithFirstAndLastName = User & object;

Defined in: recipe/dashboard/types.ts:79

Type Declaration

Name	Type	Defined in
firstName?	string	recipe/dashboard/types.ts:80
lastName?	string	recipe/dashboard/types.ts:81