@supertokens-plugins/tenant-discovery-react
Interfaces
TenantDetails
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:32
Properties
TenantList
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:37
Properties
Type Aliases
FromEmailReturnType
type FromEmailReturnType =
| {
status: "OK";
tenant: string;
}
| {
message: string;
status: "NOT_ALLOWED";
}
| {
message: string;
status: "ERROR";
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:17
OverrideableTenantFunctionImplementation
type OverrideableTenantFunctionImplementation = {
determineTenantFromSubdomain: () => string | undefined;
determineTenantFromURL: () => Promise<string | undefined>;
getEmailId: () => string | undefined;
getTenantIdFromQuery: () => string | undefined;
parseTenantId: () => ParseTenantIdReturnType;
removeEmailId: () => void;
setEmailId: (emailId: string) => void;
setTenantId: (tenantId: string) => void;
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:21
Properties
ParseTenantIdReturnType
type ParseTenantIdReturnType =
| {
doTenantDiscovery: false;
tenantId: string;
}
| {
doTenantDiscovery: true;
tenantId: null;
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:13
SuperTokensPluginTenantDiscoveryPluginConfig
type SuperTokensPluginTenantDiscoveryPluginConfig = {
extractTenantIdFromDomain?: boolean;
showTenantSelector?: boolean;
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:3
Properties
SuperTokensPluginTenantDiscoveryPluginNormalisedConfig
type SuperTokensPluginTenantDiscoveryPluginNormalisedConfig = {
extractTenantIdFromDomain?: boolean;
showTenantSelector?: boolean;
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:8
Properties
TranslationKeys
type TranslationKeys = keyof typeof defaultTranslationsTenantDiscovery["en"];
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/types.ts:41
Variables
API_PATH
const API_PATH: "plugin/supertokens-plugin-tenant-discovery";
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:3
default
default: {
init: any;
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/index.ts:4
Type Declaration
defaultTranslationsTenantDiscovery
const defaultTranslationsTenantDiscovery: {
en: {
PL_TD_AVAILABLE_TENANTS: "Available Tenants";
PL_TD_DEFAULT_OPTION: "-- Select a tenant --";
PL_TD_EMAIL_DISCOVERY_CONTINUE_BUTTON: "CONTINUE";
PL_TD_EMAIL_DISCOVERY_HEADER_TEXT: "Enter email to continue";
PL_TD_LOADING: "Loading...";
PL_TD_NO_TENANT_AVAILABLE: "No tenants available";
PL_TD_SELECT_TENANT_HEADING: "Select Tenant";
PL_TD_SELECT_TENANT_SUBHEADING: "Choose a tenant to continue";
};
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/translations.ts:1
Type Declaration
enableDebugLogs
enableDebugLogs: any;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/logger.ts:5
init
const init: any;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/plugin.tsx:40
logDebugMessage
logDebugMessage: any;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/logger.ts:5
PLUGIN_ID
const PLUGIN_ID: "supertokens-plugin-tenant-discovery" = "supertokens-plugin-tenant-discovery";
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:1
PLUGIN_VERSION
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:2
ST_EMAIL_VALUE_STORAGE_KEY
const ST_EMAIL_VALUE_STORAGE_KEY: "supertokens--email-input-value" = "supertokens--email-input-value";
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/constants.ts:5
usePluginContext
usePluginContext: any;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/plugin.tsx:28
Functions
getApi()
function getApi(querier: any): {
fetchTenants: () => Promise<any>;
tenantIdFromEmail: (email: string) => Promise<any>;
};
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/api.ts:5
Parameters
Returns
{
fetchTenants: () => Promise<any>;
tenantIdFromEmail: (email: string) => Promise<any>;
}
getOverrideableTenantFunctionImplementation()
function getOverrideableTenantFunctionImplementation(config: SuperTokensPluginTenantDiscoveryPluginConfig): OverrideableTenantFunctionImplementation;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/pluginImplementation.ts:11
Parameters
Returns
OverrideableTenantFunctionImplementation
populateEmailFromStorage()
function populateEmailFromStorage(implementation: OverrideableTenantFunctionImplementation): void;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/util.ts:31
Parameters
Returns
void
SelectTenantPage()
function SelectTenantPage(): Element;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/pages/SelectTenantPage.tsx:163
Returns
Element
setInputValue()
function setInputValue(input: HTMLInputElement, val: string): void;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/util.ts:4
Parameters
Returns
void
updateSignInSubmitBtn()
function updateSignInSubmitBtn(btnText: string): void;
Defined in: supertokens-plugins/packages/tenant-discovery-react/src/util.ts:13
Parameters
Returns
void