@supertokens-plugins/tentants-react
Type Aliases
AddInvitationProps
type AddInvitationProps = {
onCreate: (email: string, role: string) => Promise<void>;
};
Defined in: supertokens-plugins/packages/tenants-react/src/components/invitations/AddInvitation.tsx:12
Properties
InvitedUsersProps
type InvitedUsersProps = {
invitations: BaseFormSection[];
onRemove: (email: string) => Promise<void>;
tenantId: string;
};
Defined in: supertokens-plugins/packages/tenants-react/src/components/invitations/InvitedUsers.tsx:15
Properties
SuperTokensPluginTenantsPluginConfig
type SuperTokensPluginTenantsPluginConfig = {
redirectToUrlOnJoiningTenant?: string | () => void;
requireTenantCreation?: boolean;
};
Defined in: supertokens-plugins/packages/tenants-react/src/types.ts:5
Properties
SuperTokensPluginTenantsPluginNormalisedConfig
type SuperTokensPluginTenantsPluginNormalisedConfig = {
redirectOnJoiningTenantFn: () => void;
requireTenantCreation?: boolean;
};
Defined in: supertokens-plugins/packages/tenants-react/src/types.ts:10
Properties
TranslationKeys
type TranslationKeys = keyof typeof defaultTranslationsTenants["en"];
Defined in: supertokens-plugins/packages/tenants-react/src/types.ts:15
UserWithRole
type UserWithRole = {
roles: string[];
} & BaseFormSection;
Defined in: supertokens-plugins/packages/tenants-react/src/types.ts:17
Type Declaration
Variables
Action
const Action: React.FC<ActionProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/requests/Action.tsx:15
AddInvitation
const AddInvitation: React.FC<AddInvitationProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/invitations/AddInvitation.tsx:16
API_PATH
const API_PATH: "plugin/supertokens-plugin-tenants";
Defined in: supertokens-plugins/packages/tenants-react/src/constants.ts:3
AwaitingApprovalMessage
const AwaitingApprovalMessage: React.FC<AwaitingApprovalMessageProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/tenant-card/awaiting-approval.tsx:15
Code
const Code: React.FC<CodeProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/invitations/Code.tsx:18
Copy
const Copy: React.FC<CopyProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/icons/Copy.tsx:7
default
default: {
init: any;
PLUGIN_ID: string;
};
Defined in: supertokens-plugins/packages/tenants-react/src/index.ts:5
Type Declaration
defaultTranslationsTenants
const defaultTranslationsTenants: {
en: {
PL_TB_ACCESS_BLOCKED_DESCRIPTION_MESSAGE: "You do not have enough permissions to access the tenant, please reach out to an admin if you think this is a mistake";
PL_TB_ACCESS_BLOCKED_HEADER_MESSAGE: "You cannot access this tenant";
PL_TB_ADD_INVITE_BUTTON_TEXT: "+ Invite";
PL_TB_CREATE_TENANT_AWAITING_APPROVAL_HEADER: "Awaiting app admin approval";
PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE: "It is essential to await the app administrator's approval before proceeding with the";
PL_TB_CREATE_TENANT_AWAITING_APPROVAL_MESSAGE_HIGHLIGHT: "creation of the new tenant";
PL_TB_CREATE_TENANT_BUTTON_TEXT: "Create and Join";
PL_TB_CREATE_TENANT_ENTER_NAME_LABEL: "Enter name of your tenant";
PL_TB_CREATE_TENANT_LABEL: "Create Tenant";
PL_TB_INVITATIONS_ACCEPT_INVITATION_MESSAGE: "Accept Invitation";
PL_TB_INVITATIONS_AUTHENTICATE_AND_ACCEPT_MESSAGE: "Authenticate and accept invitation";
PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_POSTFIX: "tenant. Click the button below to accept the invitation.";
PL_TB_INVITATIONS_DESCRIPTION_MESSAGE_PREFIX: "You have been invited to join";
PL_TB_INVITATIONS_INVALID_INVITATION_MESSAGE: "Invalid invitation";
PL_TB_INVITATIONS_INVALID_INVITATION_REDIRECTING_TO_DASHBOARD_MESSAGE: "No invitation code found. Redirecting to dashboard...";
PL_TB_INVITATIONS_INVITATION_CODE_LABEL: "Invitation Code: ";
PL_TB_INVITATIONS_TAB_LABEL: "Invitations";
PL_TB_INVITE_ACCEPT_AUTHENTICATION_HEADER_MESSAGE: "If you authenticate, invitation will be accepted automatically.";
PL_TB_LOGOUT_TEXT: "Log Out";
PL_TB_NO_INVITATIONS_FOUND_TEXT: "There are currently no pending invites.";
PL_TB_NO_USERS_FOUND_TEXT: "No users have been found linked to this tenant.";
PL_TB_REQUESTS_TAB_LABEL: "Requests";
PL_TB_TENANT_REQUESTS_CREATION_DESCRIPTION: "List of requests to create new tenant in your app.";
PL_TB_TENANT_REQUESTS_CREATION_TAB_LABEL: "Tenant Creation";
PL_TB_TENANT_REQUESTS_ONBOARDING_TAB_LABEL: "Tenant Onboarding";
PL_TB_TENANT_USERS_COMBINED_DESCRIPTION: "List of users, invitations and requests for your tenant";
PL_TB_TENANTS_LOADING_MESSAGE: "Loading...";
PL_TB_TENANTS_REQUESTS_ACCEPT_BUTTON_TEXT: "Accept";
PL_TB_TENANTS_REQUESTS_DECLINE_BUTTON_TEXT: "Decline";
PL_TB_USERS_TAB_LABEL: "Users";
PL_TB_VIEW_CODE_TEXT: "Code";
};
};
Defined in: supertokens-plugins/packages/tenants-react/src/translations.ts:1
Type Declaration
enableDebugLogs
enableDebugLogs: any;
Defined in: supertokens-plugins/packages/tenants-react/src/logger.ts:5
Eye
const Eye: React.FC<EyeProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/icons/Eye.tsx:7
init
const init: any;
Defined in: supertokens-plugins/packages/tenants-react/src/plugin.tsx:42
InvitedUsers
const InvitedUsers: React.FC<InvitedUsersProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/invitations/InvitedUsers.tsx:21
logDebugMessage
logDebugMessage: any;
Defined in: supertokens-plugins/packages/tenants-react/src/logger.ts:5
NoUsers
const NoUsers: React.FC<NoUsersProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/users/NoUsers.tsx:11
OnboardingRequests
const OnboardingRequests: React.FC<OnboardingRequestsProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/requests/OnboardingRequests.tsx:16
PLUGIN_ID
const PLUGIN_ID: "supertokens-plugin-tenants" = "supertokens-plugin-tenants";
Defined in: supertokens-plugins/packages/tenants-react/src/constants.ts:1
PLUGIN_VERSION
const PLUGIN_VERSION: "0.0.1" = "0.0.1";
Defined in: supertokens-plugins/packages/tenants-react/src/constants.ts:2
RemoveInvitation
const RemoveInvitation: React.FC<RemoveInvitationProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/invitations/RemoveInvitation.tsx:10
TenantTab
const TenantTab: React.FC<TenantTabProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/tab/TenantTab.tsx:15
TenantUsers
const TenantUsers: React.FC<TenantUsersProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/users/TenantUsers.tsx:31
TenantUsersCombined
const TenantUsersCombined: React.FC<TenantUsersCombinedProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/tenant-management/tenant-users-combined.tsx:25
TenantUsersTable
const TenantUsersTable: React.FC<TableProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/table/TenantTable.tsx:19
Trash
const Trash: React.FC<TrashProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/icons/Trash.tsx:7
usePluginContext
usePluginContext: any;
Defined in: supertokens-plugins/packages/tenants-react/src/plugin.tsx:31
UserDetails
const UserDetails: React.FC<UserDetailsProps>;
Defined in: supertokens-plugins/packages/tenants-react/src/components/users/UserDetails.tsx:31
Functions
AcceptInvitation()
function AcceptInvitation(__namedParameters: {
onAccept: (code: string, tenantId: string) => Promise<
| {
status: "OK";
}
| {
message: string;
status: "ERROR";
}>;
}): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/components/invitations/accept.tsx:13
Parameters
Returns
Element
AccessBlockedContainer()
function AccessBlockedContainer(): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/access-blocked/AccessBlocked.tsx:8
Returns
Element
AccessBlockedPage()
function AccessBlockedPage(): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/access-blocked/AccessBlocked.tsx:19
Returns
Element
CreationRequests()
function CreationRequests(): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/components/requests/CreationRequests.tsx:16
Returns
Element
default()
function default(): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/select-tenant/TenantWrapper.tsx:98
Returns
Element
getApi()
function getApi(querier: any): {
acceptCreationRequest: (requestId: string) => Promise<any>;
acceptInvitation: (code: string, tenantId: string) => Promise<any>;
acceptOnboardingRequest: (userId: string) => Promise<any>;
addInvitation: (email: string, role: string) => Promise<any>;
changeRole: (userId: string, role: string) => Promise<any>;
createTenant: (data: TenantCreateData) => Promise<any>;
declineCreationRequest: (requestId: string) => Promise<any>;
declineOnboardingRequest: (userId: string) => Promise<any>;
doesUserHaveExistingCreationRequest: () => Promise<any>;
fetchTenants: () => Promise<any>;
getCreationRequests: () => Promise<any>;
getInvitations: () => Promise<any>;
getOnboardingRequests: () => Promise<any>;
getUsers: () => Promise<any>;
joinTenant: (data: TenantJoinData) => Promise<any>;
removeInvitation: (email: string) => Promise<any>;
removeUserFromTenant: (userId: string) => Promise<any>;
switchTenant: (tenantId: string) => Promise<any>;
};
Defined in: supertokens-plugins/packages/tenants-react/src/api.ts:14
Parameters
Returns
InvitationAcceptWrapper()
function InvitationAcceptWrapper(): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/InvitationAcceptPage.tsx:7
Returns
Element
PageWrapper()
function PageWrapper(__namedParameters: {
children: ReactNode;
style?: CSSProperties;
}): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/components/page-wrapper/page-wrapper.tsx:4
Parameters
Returns
Element
SelectTenantPage()
function SelectTenantPage(): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/select-tenant/SelectTenantPage.tsx:8
Returns
Element
TenantCard()
function TenantCard(__namedParameters: TenantCardProps): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/components/tenant-card/tenant-card.tsx:20
Parameters
Returns
Element
TenantCreationRequests()
function TenantCreationRequests(props: any): Element;
Parameters
Returns
Element
TenantManagement()
function TenantManagement(props: any): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/tenant-management/tenant-management.tsx:91
Parameters
Returns
Element
TenantManagementWithoutToastWrapper()
function TenantManagementWithoutToastWrapper(__namedParameters: {
section: FormSection;
}): Element;
Defined in: supertokens-plugins/packages/tenants-react/src/pages/tenant-management/tenant-management.tsx:16
Parameters
Returns
Element