Class User

A user data model.

Written by Hunter Perrin for SciActive.

Author

Hunter Perrin [email protected]

Copyright

SciActive Inc

See

http://nymph.io/

Hierarchy

Constructors

constructor

Properties

$allowlistData? $allowlistTags? $clientEnabledMethods $data $dataHandler $dataStore $descendantGroups? $gatekeeperCache? $isASleepingReference $nymph $originalEmail? $privateData $protectedData $protectedTags $sdata $skipAcWhenSaving $sleepingReference $wakePromise cdate guid mdate tags DEFAULT_ALLOWLIST_DATA DEFAULT_CLIENT_ENABLED_METHODS DEFAULT_PRIVATE_DATA ETYPE afterLoginCallbacks afterLogoutCallbacks afterRegisterCallbacks beforeLoginCallbacks beforeLogoutCallbacks beforeRegisterCallbacks checkUsernameCallbacks class clientEnabledStaticMethods nymph pubSubEnabled restEnabled searchRestrictedData

Methods

$addGroup $addTag $arraySearch $asleep $changePassword $check $checkEmail $checkPassword $checkPhone $checkTOTPCode $checkUsername $clearCache $delGroup $delete $equals $gatekeeper $getAcFullIds $getAcGid $getAcReadIds $getAcUid $getAcWriteIds $getAvatar $getClientEnabledMethods $getCurrentAcValues $getData $getDescendantGroups $getGatekeeperCache $getGid $getGids $getNewTOTPSecret $getOriginalAcValues $getSData $getTags $getUniques $getValidatable $grant $hasTOTPSecret $hasTag $inArray $inGroup $is $isDescendant $jsonAcceptData $jsonAcceptPatch $login $logout $password $putData $referenceSleep $refresh $register $removeTOTPSecret $removeTag $revoke $revokeCurrentTokens $save $saveSkipAC $saveTOTPSecret $sendEmailVerification $switchUser $tilmeldSaveSkipAC $toReference $updateDataProtection $updateGroupDataProtection $useSkipAc $wake $wakeAll toJSON alterOptions? current factory factoryReference factorySync factoryUsername getClientConfig getUniques loginUser off on recover sendRecovery

Constructors

constructor

Properties

Protected Optional $allowlistData

$allowlistData?: string[] = ...

If this is defined, then it lists the only properties that will be accepted from incoming JSON. Any other properties will be ignored.

If you use an allowlist, you don't need to use protectedData, since you can simply leave those entries out of allowlistData.

Protected Optional $allowlistTags

$allowlistTags?: string[] = []

If this is defined, then it lists the only tags that will be accepted from incoming JSON. Any other tags will be ignored.

Protected $clientEnabledMethods

$clientEnabledMethods: string[] = ...

The names of methods allowed to be called by the frontend with serverCall.

Protected $data

$data: UserData

The data proxy object.

Protected $dataHandler

$dataHandler: Object

The data proxy handler.

Protected $dataStore

$dataStore: UserData

The actual data store.

Private Optional $descendantGroups

$descendantGroups?: (Group & GroupData)[]

The user's group descendants.

Private Optional $gatekeeperCache

$gatekeeperCache?: {
    [k: string]: true;
}

Gatekeeper ability cache.

Gatekeeper will cache the user's abilities that it calculates, so it can check faster if that user has been checked before.

Type declaration

  • [k: string]: true

Protected $isASleepingReference

$isASleepingReference: boolean

Whether this instance is a sleeping reference.

$nymph

$nymph: Nymph

The instance of Nymph to use for queries.

Optional $originalEmail

$originalEmail?: string

Used to save the current email address to send verification if it changes from the frontend.

If you are changing a user's email address and want to bypass email verification, don't set this.

Protected $privateData

$privateData: string[] = ...

Properties that will not be serialized into JSON with toJSON(). This can be considered a denylist, because these properties will not be set with incoming JSON.

Clients CAN still determine what is in these properties, unless they are also listed in searchRestrictedData.

Protected $protectedData

$protectedData: string[]

Properties that can only be modified by server side code. They will still be visible on the frontend, unlike $privateData, but any changes to them that come from the frontend will be ignored.

In addition to what's listed here, all of the access control properties will be included when Tilmeld is being used. These are:

  • acUser
  • acGroup
  • acOther
  • acRead
  • acWrite
  • acFull
  • user
  • group

You should modify these through client enabled methods or the $save method instead, for safety.

Protected $protectedTags

$protectedTags: string[]

Tags that can only be added/removed by server side code. They will still be visible on the frontend, but any changes to them that come from the frontend will be ignored.

Protected $sdata

$sdata: SerializedEntityData

The actual sdata store.

Private $skipAcWhenSaving

$skipAcWhenSaving: boolean = false

This is explicitly used only during the registration proccess.

Protected $sleepingReference

$sleepingReference: null | EntityReference

The reference to use to wake.

Protected $wakePromise

$wakePromise: null | Promise<Entity<UserData>>

A promise that resolved when the entity's data is wake.

cdate

cdate: null | number

The creation date of the entity as a Unix timestamp in milliseconds.

guid

guid: null | string

The entity's Globally Unique ID.

This is a 12 byte number represented as a lower case HEX string (24 characters).

mdate

mdate: null | number

The modified date of the entity as a Unix timestamp in milliseconds.

tags

tags: string[]

Array of the entity's tags.

Private Static DEFAULT_ALLOWLIST_DATA

DEFAULT_ALLOWLIST_DATA: string[] = []

Private Static DEFAULT_CLIENT_ENABLED_METHODS

DEFAULT_CLIENT_ENABLED_METHODS: string[] = ...

Private Static DEFAULT_PRIVATE_DATA

DEFAULT_PRIVATE_DATA: string[] = ...

Static ETYPE

ETYPE: string = 'tilmeld_user'

The instance of Tilmeld to use for queries.

Private Static afterLoginCallbacks

afterLoginCallbacks: TilmeldAfterLoginCallback[] = []

Private Static afterLogoutCallbacks

afterLogoutCallbacks: TilmeldAfterLogoutCallback[] = []

Private Static afterRegisterCallbacks

afterRegisterCallbacks: TilmeldAfterRegisterCallback[] = []

Private Static beforeLoginCallbacks

beforeLoginCallbacks: TilmeldBeforeLoginCallback[] = []

Private Static beforeLogoutCallbacks

beforeLogoutCallbacks: TilmeldBeforeLogoutCallback[] = []

Private Static beforeRegisterCallbacks

beforeRegisterCallbacks: TilmeldBeforeRegisterCallback[] = []

Private Static checkUsernameCallbacks

checkUsernameCallbacks: TilmeldCheckUsernameCallback[] = []

Static class

class: string = 'User'

The lookup name for this entity.

This is used for reference arrays (and sleeping references) and client requests.

Static clientEnabledStaticMethods

clientEnabledStaticMethods: string[] = ...

The names of static methods allowed to be called by the frontend with serverCallStatic.

Static nymph

nymph: Nymph

The instance of Nymph to use for queries.

Static pubSubEnabled

pubSubEnabled: boolean

Whether this entity should publish changes to PubSub servers.

Static restEnabled

restEnabled: boolean

Whether this entity should be accessible on the frontend through the REST server.

If this is false, any request from the client that attempts to use this entity will fail.

Static searchRestrictedData

searchRestrictedData: string[] = ...

Properties that will not be searchable from the frontend. If the frontend includes any of these properties in any of their clauses, they will be filtered out before the search is executed.

Methods

$addGroup

$addTag

  • $addTag(...tags): void

  • Add one or more tags.

    Parameters

    • Rest ...tags: string[]

      List of tags.

    Returns void

$arraySearch

  • $arraySearch(array, strict?): number

  • Search the array for this object and return the corresponding index.

    If strict is false, is() is used to compare. If strict is true, equals() is used.

    Parameters

    • array: any[]

      The array to search.

    • Optional strict: boolean

      Whether to use stronger comparison.

    Returns number

    The index if the object is in the array, -1 if it isn't.

$asleep

  • $asleep(): boolean

  • Check if this is a sleeping reference.

    Returns boolean

$changePassword

  • $changePassword(data): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to change the user's password.

    Parameters

    • data: {
          currentPassword: string;
          newPassword: string;
          revokeCurrentTokens?: boolean;
      }

      The input data from the client.

      • currentPassword: string
      • newPassword: string
      • Optional revokeCurrentTokens?: boolean

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

Protected $check

  • $check(): void

  • Check if this is a sleeping reference and throw an error if so.

    Returns void

$checkEmail

  • $checkEmail(): Promise<{
        message: string;
        result: boolean;
    }>

  • Check that an email is unique.

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

$checkPassword

  • $checkPassword(password): boolean

  • Check the given password against the user's.

    Parameters

    • password: string

      The password in question.

    Returns boolean

    True if the passwords match, otherwise false.

$checkPhone

  • $checkPhone(): Promise<{
        message: string;
        result: boolean;
    }>

  • Check that a phone number is unique.

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

$checkTOTPCode

  • $checkTOTPCode(code): boolean

  • Check the given code against the user's TOTP secret.

    Parameters

    • code: string

      The code in question.

    Returns boolean

    True if the code is valid, otherwise false.

$checkUsername

  • $checkUsername(): Promise<{
        message: string;
        result: boolean;
    }>

  • Check that a username is valid.

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

$clearCache

  • $clearCache(): void

  • Replace any referenced entities in the data with sleeping references.

    Calling this function ensures that the next time a referenced entity is accessed, it will be retrieved from the DB (unless it is in Nymph's cache).

    Returns void

$delGroup

$delete

$equals

  • $equals(object): boolean

  • Perform a more strict comparison of this object to another.

    Parameters

    • object: any

      The object to compare.

    Returns boolean

    True or false.

$gatekeeper

  • $gatekeeper(ability?): Promise<boolean>

  • Check to see if a user has an ability.

    This function will check both user and group abilities, if the user is marked to inherit the abilities of its group.

    If ability is undefined, it will check to see if the user is currently logged in.

    If the user has the "system/admin" ability, this function will return true.

    Parameters

    • Optional ability: string

      The ability.

    Returns Promise<boolean>

    True or false.

$getAcFullIds

  • $getAcFullIds(): null | (null | string)[]

  • Returns null | (null | string)[]

$getAcGid

  • $getAcGid(): null | string

  • Returns null | string

$getAcReadIds

  • $getAcReadIds(): null | (null | string)[]

  • Returns null | (null | string)[]

$getAcUid

  • $getAcUid(): null | string

  • Returns null | string

$getAcWriteIds

  • $getAcWriteIds(): null | (null | string)[]

  • Returns null | (null | string)[]

$getAvatar

$getClientEnabledMethods

  • $getClientEnabledMethods(): string[]

  • Get the client enabled methods.

    Returns string[]

    The names of methods allowed to be called by the frontend with serverCall.

$getCurrentAcValues

$getData

  • $getData(includeSData?): any

  • Used to retrieve the data object.

    This should only be used by Nymph to save the data into storage.

    Parameters

    • Optional includeSData: boolean

      Whether to include the serialized data as well.

    Returns any

    The entity's data object.

$getDescendantGroups

$getGatekeeperCache

  • $getGatekeeperCache(): Promise<{
        [k: string]: T;
    }>

  • Build a gatekeeper cache object.

    Returns Promise<{
        [k: string]: T;
    }>

$getGid

$getGids

$getNewTOTPSecret

  • $getNewTOTPSecret(): Promise<{
        qrcode: string;
        secret: string;
        uri: string;
    }>

  • A frontend accessible method to generate a new TOTP secret.

    Returns Promise<{
        qrcode: string;
        secret: string;
        uri: string;
    }>

    An object with 'uri', 'qrcode', and 'secret'.

$getOriginalAcValues

$getSData

  • $getSData(): SerializedEntityData

  • Used to retrieve the serialized data object.

    This should only be used by Nymph to save the data object into storage.

    This method is used by Nymph to avoid unserializing data that hasn't been requested yet.

    It should always be called after getData().

    Returns SerializedEntityData

    The entity's serialized data object.

$getTags

  • $getTags(): string[]

  • Get the entity's tags.

    Using this instead of accessing the tags prop directly will wake sleeping references.

    Returns string[]

    The entity's tags.

$getUniques

  • $getUniques(): Promise<string[]>

  • Get an array of strings that must be unique across the current etype.

    When you try to save another entity with any of the same unique strings, Nymph will throw an error.

    The default implementation of this method returns an empty array, meaning there are no uniqueness constraints applied to its etype.

    Returns Promise<string[]>

    Resolves to an array of entity's unique constraint strings.

$getValidatable

  • $getValidatable(): any

  • Get an object that holds the same data as the entity.

    This provides an object that can be validated.

    Returns any

    A pure object representation of the entity.

$grant

$hasTOTPSecret

$hasTag

  • $hasTag(...tags): boolean

  • Check that the entity has all of the given tags.

    Parameters

    • Rest ...tags: string[]

      List of tags.

    Returns boolean

    True or false.

$inArray

  • $inArray(array, strict?): boolean

  • Check whether this object is in an array.

    If strict is false, is() is used to compare. If strict is true, equals() is used.

    Parameters

    • array: any[]

      The array to search.

    • Optional strict: boolean

      Whether to use stronger comparison.

    Returns boolean

    True if the object is in the array, false if it isn't.

$inGroup

  • $inGroup(group): Promise<boolean>

  • Check whether the user is in a (primary or secondary) group.

    Parameters

    Returns Promise<boolean>

    True or false.

$is

  • $is(object): boolean

  • Perform a less strict comparison of this object to another.

    Parameters

    • object: any

      The object to compare.

    Returns boolean

    True or false.

$isDescendant

  • $isDescendant(group): Promise<boolean>

  • Check whether the user is a descendant of a group.

    Parameters

    Returns Promise<boolean>

    True or false.

$jsonAcceptData

  • $jsonAcceptData(input, allowConflict?): void

  • Accept JSON data from the client.

    This function uses the security protection lists:

    • $protectedTags
    • $protectedData
    • $allowlistTags
    • $allowlistData

    Parameters

    • input: EntityJson

      The input data. Please note, this will be modified (destroyed).

    • allowConflict: boolean = false

      Allow to accept data that is older than the current data.

    Returns void

$jsonAcceptPatch

  • $jsonAcceptPatch(patch, allowConflict?): void

  • Accept JSON patch from the client.

    This function uses the security protection lists:

    • $protectedTags
    • $protectedData
    • $allowlistTags
    • $allowlistData

    Parameters

    • patch: EntityPatch

      The patch data. Please note, this will be modified (destroyed).

    • allowConflict: boolean = false

      Allow to accept data that is older than the current data.

    Returns void

$login

  • $login(data): Promise<{
        message: string;
        needTOTP: boolean;
        result: boolean;
    } | {
        message: any;
        needTOTP?: undefined;
        result: boolean;
    }>

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          code?: string;
          password: string;
          username: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • Optional code?: string
      • password: string
      • username: string

    Returns Promise<{
        message: string;
        needTOTP: boolean;
        result: boolean;
    } | {
        message: any;
        needTOTP?: undefined;
        result: boolean;
    }>

$logout

  • $logout(): Promise<{
        message: any;
        result: boolean;
    }>

  • Log a user out of the system.

    Returns Promise<{
        message: any;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

$password

  • $password(password): string

  • Change the user's password.

    Parameters

    • password: string

      The new password.

    Returns string

    The resulting password or hash which is stored in the entity.

$putData

Protected $referenceSleep

$refresh

  • $refresh(): Promise<boolean | 0>

  • Refresh the object from storage. (Bypasses Nymph's cache.)

    If the object has been deleted from storage, the database cannot be reached, or a database error occurs, refresh() will return 0.

    Returns Promise<boolean | 0>

    False if the data has not been saved, 0 if it can't be refreshed, true on success.

$register

  • $register(data): Promise<{
        loggedin: boolean;
        message: string;
        result: boolean;
    }>

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          password: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • password: string

    Returns Promise<{
        loggedin: boolean;
        message: string;
        result: boolean;
    }>

$removeTOTPSecret

  • $removeTOTPSecret(data?): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to remove the TOTP secret from the user's account.

    Parameters

    • Optional data: {
          code: string;
          password: string;
      }

      The input data from the client.

      • code: string
      • password: string

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

$removeTag

  • $removeTag(...tags): void

  • Remove one or more tags.

    Parameters

    • Rest ...tags: string[]

      List of tags.

    Returns void

$revoke

$revokeCurrentTokens

  • $revokeCurrentTokens(data): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to revoke all currently issued tokens.

    Parameters

    • data: {
          password: string;
      }

      The input data from the client.

      • password: string

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

$save

$saveSkipAC

$saveTOTPSecret

  • $saveTOTPSecret(data): Promise<{
        message: string;
        result: boolean;
    }>

  • A frontend accessible method to save a TOTP secret into the user's account.

    Parameters

    • data: {
          code: string;
          password: string;
          secret: string;
      }

      The input data from the client.

      • code: string
      • password: string
      • secret: string

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

$sendEmailVerification

  • $sendEmailVerification(): Promise<boolean>

  • Send the user email verification/change/cancellation links.

    Returns Promise<boolean>

    True on success, false on failure.

$switchUser

  • $switchUser(data?): Promise<{
        message: any;
        result: boolean;
    }>

  • Parameters

    • Optional data: {
          additionalData?: {
              [k: string]: any;
          };
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any

    Returns Promise<{
        message: any;
        result: boolean;
    }>

$tilmeldSaveSkipAC

$toReference

  • $toReference(): User | EntityReference

  • Return a Nymph Entity Reference for this entity.

    If the entity hasn't been saved yet (and has no GUID), it will be returned instead.

    Returns User | EntityReference

    A Nymph Entity Reference array as an unsaved entity.

$updateDataProtection

  • $updateDataProtection(givenUser?): void

  • Update the data protection arrays for a user.

    Parameters

    • Optional givenUser: User & UserData

      User to update protection for. If undefined, will use the currently logged in user.

    Returns void

$updateGroupDataProtection

$useSkipAc

  • $useSkipAc(skipAc): void

  • Set whether to use "skipAc" when accessing entity references.

    Parameters

    • skipAc: boolean

      True or false, whether to use it.

    Returns void

$wake

$wakeAll

toJSON

Static Optional alterOptions

  • Alter the options for a query for this entity.

    Type Parameters

    Parameters

    • options: T

      The current options.

    Returns T

    The altered options.

Static current

Static factory

  • Create or retrieve a new entity instance.

    Note that this will always return an entity, even if the GUID is not found.

    Type Parameters

    Parameters

    • this: (new () => E)
        • new (): E

        • Returns E

    • Optional guid: string

      An optional GUID to retrieve.

    Returns Promise<E & EntityDataType<E>>

Static factoryReference

  • Create a new sleeping reference instance.

    Sleeping references won't retrieve their data from the database until they are readied with $wake() or a parent's $wakeAll().

    Type Parameters

    Parameters

    • this: (new () => E)
        • new (): E

        • Returns E

    • reference: EntityReference

      The Nymph Entity Reference to use to wake.

    Returns E & EntityDataType<E>

    The new instance.

Static factorySync

Static factoryUsername

Static getClientConfig

  • Returns {
        allowRegistration: boolean;
        allowUsernameChange: boolean;
        emailUsernames: boolean;
        pwRecovery: boolean;
        regFields: string[];
        unverifiedAccess: boolean;
        userFields: string[];
        verifyEmail: boolean;
    }

    • allowRegistration: boolean
    • allowUsernameChange: boolean
    • emailUsernames: boolean
    • pwRecovery: boolean
    • regFields: string[]
    • unverifiedAccess: boolean
    • userFields: string[]
    • verifyEmail: boolean

Static getUniques

  • Get an array of strings that must be unique across the current etype.

    When you try to save another entity with any of the same unique strings, Nymph will throw an error.

    The default implementation of this static method instantiates the entity, assigns all of the given data, then calls $getUniques and returns its output. This can have a performance impact if a lot of extra processing happens during any of these steps. You can override this method to calculate the unique strings faster, but you must return the same strings that would be returned by $getUniques.

    Parameters

    • __namedParameters: {
          cdate?: number;
          data: EntityData;
          guid?: string;
          mdate?: number;
          sdata?: SerializedEntityData;
          tags: string[];
      }

    Returns Promise<string[]>

    Resolves to an array of entity's unique constraint strings.

Static loginUser

  • Parameters

    • data: {
          additionalData?: {
              [k: string]: any;
          };
          code?: string;
          password: string;
          username: string;
      }
      • Optional additionalData?: {
            [k: string]: any;
        }
        • [k: string]: any
      • Optional code?: string
      • password: string
      • username: string

    Returns Promise<{
        message: string;
        result: boolean;
        user?: User & UserData;
    }>

Static off

Static on

Static recover

  • Recover account details.

    Parameters

    • data: {
          password: string;
          secret: string;
          username: string;
      }

      The input data from the client.

      • password: string
      • secret: string
      • username: string

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

Static sendRecovery

  • Send an account recovery link.

    Parameters

    • data: {
          account: string;
          recoveryType: "password" | "username";
      }

      The input data from the client.

      • account: string
      • recoveryType: "password" | "username"

    Returns Promise<{
        message: string;
        result: boolean;
    }>

    An object with a boolean 'result' entry and a 'message' entry.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc