profile-details-shared

Type Aliases

BaseField<T>

type BaseField<T> = {
  default?: BaseProfile[string];
  id: string;
};

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

Type Parameters

Type Parameter	Default type
T extends BaseProfile[string]	BaseProfile[string]

Properties

Property	Type	Defined in
default?	BaseProfile[string]	supertokens-plugins/packages/profile-details-shared/src/types.ts:5
id	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:4

BaseFormField<T>

type BaseFormField<T> = BaseField<T> & {
  label: string;
  options?: {
     label: string;
     value: T;
  }[];
  order?: number;
  placeholder?: string;
  required?: boolean;
  type:   | "string"
     | "text"
     | "number"
     | "boolean"
     | "email"
     | "phone"
     | "date"
     | "select"
     | "multiselect"
     | "password"
     | "url"
     | "image-url"
     | "toggle";
};

Defined in: supertokens-plugins/packages/profile-details-shared/src/types.ts:8

Type Declaration

Name	Type	Defined in
label	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:9
options?	{ label: string; value: T; }[]	supertokens-plugins/packages/profile-details-shared/src/types.ts:26
order?	number	supertokens-plugins/packages/profile-details-shared/src/types.ts:27
placeholder?	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:10
required?	boolean	supertokens-plugins/packages/profile-details-shared/src/types.ts:11
type	| "string" | "text" | "number" | "boolean" | "email" | "phone" | "date" | "select" | "multiselect" | "password" | "url" | "image-url" | "toggle"	supertokens-plugins/packages/profile-details-shared/src/types.ts:12

Type Parameters

Type Parameter	Default type
T extends BaseProfile[string]	BaseProfile[string]

BaseFormFieldPayload<T>

type BaseFormFieldPayload<T> = {
  fieldId: string;
  sectionId: string;
  value: T;
};

Defined in: supertokens-plugins/packages/profile-details-shared/src/types.ts:39

Type Parameters

Type Parameter	Default type
T extends BaseProfile[string]	BaseProfile[string]

Properties

Property	Type	Defined in
fieldId	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:41
sectionId	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:40
value	T	supertokens-plugins/packages/profile-details-shared/src/types.ts:42

BaseFormFieldSet

type BaseFormFieldSet = Record<string, Omit<BaseFormField, "id">>;

Defined in: supertokens-plugins/packages/profile-details-shared/src/types.ts:37

BaseFormSection

type BaseFormSection = {
  description?: string;
  fields: BaseFormField[];
  id: string;
  label: string;
};

Defined in: supertokens-plugins/packages/profile-details-shared/src/types.ts:30

Properties

Property	Type	Defined in
description?	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:33
fields	BaseFormField[]	supertokens-plugins/packages/profile-details-shared/src/types.ts:34
id	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:31
label	string	supertokens-plugins/packages/profile-details-shared/src/types.ts:32

BaseProfile

type BaseProfile = Record<string, string | number | boolean | null | undefined | string[]>;

Defined in: supertokens-plugins/packages/profile-details-shared/src/types.ts:1

Variables

BASE_FORM_SECTIONS

const BASE_FORM_SECTIONS: BaseFormSection[];

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