@supertokens-plugins/user-banning-nodejs

Classes

UserBanningService

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:17

Constructors

Constructor

new UserBanningService(pluginConfig: SuperTokensPluginUserBanningPluginNormalisedConfig): UserBanningService;

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:21

Parameters

Parameter	Type
pluginConfig	SuperTokensPluginUserBanningPluginNormalisedConfig

Returns

UserBanningService

Properties

Property	Modifier	Type	Default value	Defined in
addBanToCache	public	(this: UserBanningService, tenantId: string, userId: string) => Promise<void>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:30
cache	protected	Map<string, boolean>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:18
cachePreLoadPromise	protected	Promise<void>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:19
checkAndAddBannedUserRoleIfNeeded	public	(this: UserBanningService, userContext?: UserContext) => Promise< | { message: string; status: string; } | { message?: undefined; status: string; }>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:65
getBanStatus	public	(this: UserBanningService, tenantId: string, userId: string, userContext?: UserContext) => Promise< | { banned: boolean; status: "OK"; } | { message: string; status: "UNKNOWN_ERROR"; }>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:90
getBanStatusFromCache	public	(this: UserBanningService, tenantId: string, userId: string) => Promise<boolean>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:38
pluginConfig	protected	SuperTokensPluginUserBanningPluginNormalisedConfig	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:21
preLoadCache	public	(this: UserBanningService, userContext?: UserContext) => Promise<void>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:42
preLoadCacheIfNeeded	public	(this: UserBanningService, userContext?: UserContext) => Promise<void>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:23
removeBanFromCache	public	(this: UserBanningService, tenantId: string, userId: string) => Promise<void>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:34
setBanStatusAndUpdateSessions	public	(this: UserBanningService, tenantId: string, userId: string, isBanned: boolean, userContext?: UserContext) => Promise< | { status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; } | { status: "USER_NOT_FOUND"; }>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:129
updateSessions	public	(this: UserBanningService, userId: string, tenantId: string, isBanned: boolean, userContext?: UserContext) => Promise<void>	undefined	supertokens-plugins/packages/user-banning-nodejs/src/userBanningService.ts:112

Type Aliases

SuperTokensPluginUserBanningPluginConfig

type SuperTokensPluginUserBanningPluginConfig = {
  bannedUserRole?: string;
  globalBanning?: boolean;
  userBanningPermission?: string;
};

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/types.ts:1

Properties

Property	Type	Defined in
bannedUserRole?	string	supertokens-plugins/packages/user-banning-nodejs/src/types.ts:3
globalBanning?	boolean	supertokens-plugins/packages/user-banning-nodejs/src/types.ts:4
userBanningPermission?	string	supertokens-plugins/packages/user-banning-nodejs/src/types.ts:2

SuperTokensPluginUserBanningPluginNormalisedConfig

type SuperTokensPluginUserBanningPluginNormalisedConfig = {
  bannedUserRole: string;
  globalBanning: boolean;
  userBanningPermission: string;
};

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/types.ts:7

Properties

Property	Type	Defined in
bannedUserRole	string	supertokens-plugins/packages/user-banning-nodejs/src/types.ts:9
globalBanning	boolean	supertokens-plugins/packages/user-banning-nodejs/src/types.ts:10
userBanningPermission	string	supertokens-plugins/packages/user-banning-nodejs/src/types.ts:8

Variables

default

default: {
  init: any;
};

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/index.ts:4

Type Declaration

Name	Type	Defined in
init	any	supertokens-plugins/packages/user-banning-nodejs/src/index.ts:4

DEFAULT_BANNED_USER_ROLE

const DEFAULT_BANNED_USER_ROLE: "banned" = "banned";

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:9

DEFAULT_GLOBAL_BANNING

const DEFAULT_GLOBAL_BANNING: true = true;

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:10

DEFAULT_PERMISSION_NAME

const DEFAULT_PERMISSION_NAME: "ban-user" = "ban-user";

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:8

enableDebugLogs

enableDebugLogs: any;

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/logger.ts:4

HANDLE_BASE_PATH

const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-user-banning";

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:6

init

const init: any;

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/plugin.ts:20

logDebugMessage

logDebugMessage: any;

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/logger.ts:4

PLUGIN_ERROR_NAME

const PLUGIN_ERROR_NAME: "supertokens-plugin-user-banning-error";

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:12

PLUGIN_ID

const PLUGIN_ID: "supertokens-plugin-user-banning" = "supertokens-plugin-user-banning";

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:1

PLUGIN_SDK_VERSION

const PLUGIN_SDK_VERSION: string[];

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:4

PLUGIN_VERSION

const PLUGIN_VERSION: "0.0.1" = "0.0.1";

Defined in: supertokens-plugins/packages/user-banning-nodejs/src/constants.ts:2