@supertokens-plugins/profile-details-nodejs

Classes

Implementation

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:13

Constructors

Constructor

new Implementation(pluginConfig: SuperTokensPluginProfileDetailsNormalisedConfig): Implementation;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:39

Parameters

Parameter	Type
pluginConfig	SuperTokensPluginProfileDetailsNormalisedConfig

Returns

Implementation

Properties

Property	Modifier	Type	Default value	Defined in
buildFormData	public	(this: Implementation, profile: BaseProfile, session: SessionContainerInterface, userContext?: Record<string, any>) => BaseFormFieldPayload[]	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:172
buildProfile	public	(this: Implementation, formData: BaseFormFieldPayload[], existingProfile: BaseProfile, session: SessionContainerInterface, userContext?: Record<string, any>) => BaseProfile	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:153
defaultStorageHandlerGet	public	(this: Implementation, userId: string, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<{ profile: Record<string, BaseFormSection>; }>	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:43
defaultStorageHandlerSet	public	(this: Implementation, userId: string, payload: { profile: Record<string, BaseFormSection>; }, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:57
getFieldValueFromThirdPartyUserInfo	public	(this: Implementation, providerId: string, field: any, rawUserInfoFromProvider: any, profile: BaseProfile) => BaseProfile	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:84
getPluginFormFields	public	(this: Implementation, session: SessionContainerInterface, userContext?: Record<string, any>) => any[]	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:72
getProfile	public	(this: Implementation, userId: string, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<BaseProfile>	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:114
getSections	public	(this: Implementation, session: SessionContainerInterface, userContext?: Record<string, any>) => BaseFormSection[]	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:185
sections	protected	BaseFormSection[]	[]	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:16
updateProfile	public	(this: Implementation, userId: string, payload: BaseFormFieldPayload[], session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:130
instance	static	Implementation	undefined	supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:14

Methods

getInstanceOrThrow()

static getInstanceOrThrow(): Implementation;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:27

Returns

Implementation

init()

static init(pluginConfig: SuperTokensPluginProfileDetailsNormalisedConfig): Implementation;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:18

Parameters

Parameter	Type
pluginConfig	SuperTokensPluginProfileDetailsNormalisedConfig

Returns

Implementation

reset()

static reset(): void;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/implementation.ts:35

Returns

void

Type Aliases

BaseFormSection

type BaseFormSection = any;

SuperTokensPluginProfileDetailsConfig

type SuperTokensPluginProfileDetailsConfig = 
  | {
  registerSectionsForProgressiveProfiling?: boolean;
  sections?: BaseFormSection[];
}
  | undefined;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/types.ts:3

SuperTokensPluginProfileDetailsImplementation

type SuperTokensPluginProfileDetailsImplementation = {
  thirdPartyFieldMap: (originalImplementation: ThirdPartyFieldMap) => ThirdPartyFieldMap;
};

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/types.ts:10

Properties

Property	Type	Defined in
thirdPartyFieldMap	(originalImplementation: ThirdPartyFieldMap) => ThirdPartyFieldMap	supertokens-plugins/packages/profile-details-nodejs/src/types.ts:11

SuperTokensPluginProfileDetailsNormalisedConfig

type SuperTokensPluginProfileDetailsNormalisedConfig = {
  registerSectionsForProgressiveProfiling: boolean;
  sections: BaseFormSection[];
};

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/types.ts:14

Properties

Property	Type	Defined in
registerSectionsForProgressiveProfiling	boolean	supertokens-plugins/packages/profile-details-nodejs/src/types.ts:16
sections	BaseFormSection[]	supertokens-plugins/packages/profile-details-nodejs/src/types.ts:15

ThirdPartyFieldMap()

type ThirdPartyFieldMap = (providerId: string, field: BaseFormSection & {
  sectionId: string;
}, rawUserInfoFromProvider: any, profile: BaseFormSection) => BaseFormSection[string];

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/types.ts:19

Parameters

Parameter	Type
providerId	string
field	BaseFormSection & { sectionId: string; }
rawUserInfoFromProvider	any
profile	BaseFormSection

Returns

BaseFormSection[string]

Variables

default

default: {
  getProfile: (userId: string, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<BaseProfile>;
  getSections: (session: SessionContainerInterface, userContext?: Record<string, any>) => BaseFormSection[];
  init: any;
  PLUGIN_ID: string;
  PLUGIN_VERSION: string;
  updateProfile: (userId: string, profile: BaseFormFieldPayload[], session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>;
};

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27

Type Declaration

Name	Type	Defined in
getProfile()	(userId: string, session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<BaseProfile>	supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27
getSections()	(session: SessionContainerInterface, userContext?: Record<string, any>) => BaseFormSection[]	supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27
init	any	supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27
PLUGIN_ID	string	supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27
PLUGIN_VERSION	string	supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27
updateProfile()	(userId: string, profile: BaseFormFieldPayload[], session: SessionContainerInterface, userContext?: Record<string, any>) => Promise<void>	supertokens-plugins/packages/profile-details-nodejs/src/index.ts:27

DEFAULT_REGISTER_SECTIONS_FOR_PROGRESSIVE_PROFILING

const DEFAULT_REGISTER_SECTIONS_FOR_PROGRESSIVE_PROFILING: true = true;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:12

enableDebugLogs

enableDebugLogs: any;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/logger.ts:4

HANDLE_BASE_PATH

const HANDLE_BASE_PATH: "/plugin/supertokens-plugin-profile-details";

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:5

init

const init: any;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/plugin.ts:20

logDebugMessage

logDebugMessage: any;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/logger.ts:4

METADATA_KEY

const METADATA_KEY: "supertokens-plugin-profile-details";

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:7

METADATA_PROFILE_KEY

const METADATA_PROFILE_KEY: "st-profile" = "st-profile";

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:8

PLUGIN_ID

const PLUGIN_ID: "supertokens-plugin-profile-details" = "supertokens-plugin-profile-details";

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:1

PLUGIN_SDK_VERSION

const PLUGIN_SDK_VERSION: string[];

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:3

PLUGIN_VERSION

const PLUGIN_VERSION: "0.0.1" = "0.0.1";

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:2

SUPERTOKENS_PLUGIN_PROGRESSIVE_PROFILING_ID

const SUPERTOKENS_PLUGIN_PROGRESSIVE_PROFILING_ID: "supertokens-plugin-progressive-profiling" = "supertokens-plugin-progressive-profiling";

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/constants.ts:10

Functions

getProfile()

function getProfile(
   userId: string, 
   session: SessionContainerInterface, 
userContext?: Record<string, any>): Promise<BaseProfile>;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/index.ts:10

Parameters

Parameter	Type
userId	string
session	SessionContainerInterface
userContext?	Record<string, any>

Returns

Promise<BaseProfile>

getSections()

function getSections(session: SessionContainerInterface, userContext?: Record<string, any>): BaseFormSection[];

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/index.ts:23

Parameters

Parameter	Type
session	SessionContainerInterface
userContext?	Record<string, any>

Returns

BaseFormSection[]

updateProfile()

function updateProfile(
   userId: string, 
   profile: BaseFormFieldPayload[], 
   session: SessionContainerInterface, 
userContext?: Record<string, any>): Promise<void>;

Defined in: supertokens-plugins/packages/profile-details-nodejs/src/index.ts:14

Parameters

Parameter	Type
userId	string
profile	BaseFormFieldPayload[]
session	SessionContainerInterface
userContext?	Record<string, any>

Returns

Promise<void>