diff --git a/classes/services_auth_auth_lib._internal_.AuthInfo.html b/classes/services_auth_auth_lib._internal_.AuthInfo.html index 29cc9cd9..6cf0d228 100644 --- a/classes/services_auth_auth_lib._internal_.AuthInfo.html +++ b/classes/services_auth_auth_lib._internal_.AuthInfo.html @@ -1,5 +1,5 @@ -AuthInfo | adonix

Class AuthInfo

Constructors

constructor +AuthInfo | adonix

Class AuthInfo

Constructors

constructor

Properties

provider roles userId -

Constructors

constructor

Properties

provider

provider: string

roles

roles: string[]

userId

userId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

provider

provider: string

roles

roles: string[]

userId

userId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/services_event_event_lib._internal_.Event.html b/classes/services_event_event_lib._internal_.Event.html index 9f59d32a..303d16ad 100644 --- a/classes/services_event_event_lib._internal_.Event.html +++ b/classes/services_event_event_lib._internal_.Event.html @@ -1,4 +1,4 @@ -Event | adonix

Class Event

Constructors

constructor +Event | adonix

Class Event

Constructors

constructor

Properties

description displayOnStaffCheckIn? endTime @@ -15,4 +15,4 @@ points? sponsor? startTime -

Constructors

constructor

Properties

description

description: string

Optional displayOnStaffCheckIn

displayOnStaffCheckIn?: boolean

endTime

endTime: number

eventId

eventId: string

eventType

eventType: string

Optional exp

exp?: number

isAsync

isAsync: boolean

Optional isPrivate

isPrivate?: boolean

Optional isPro

isPro?: boolean

isStaff

isStaff: boolean

locations

locations: Location[]

Optional mapImageUrl

mapImageUrl?: string

name

name: string

Optional points

points?: number

Optional sponsor

sponsor?: string

startTime

startTime: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

description

description: string

Optional displayOnStaffCheckIn

displayOnStaffCheckIn?: boolean

endTime

endTime: number

eventId

eventId: string

eventType

eventType: string

Optional exp

exp?: number

isAsync

isAsync: boolean

Optional isPrivate

isPrivate?: boolean

Optional isPro

isPro?: boolean

isStaff

isStaff: boolean

locations

locations: Location[]

Optional mapImageUrl

mapImageUrl?: string

name

name: string

Optional points

points?: number

Optional sponsor

sponsor?: string

startTime

startTime: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/services_event_event_lib._internal_.Location.html b/classes/services_event_event_lib._internal_.Location.html index bc5cf50a..b382a998 100644 --- a/classes/services_event_event_lib._internal_.Location.html +++ b/classes/services_event_event_lib._internal_.Location.html @@ -1,6 +1,6 @@ -Location | adonix

Class Location

Constructors

constructor +Location | adonix

Class Location

Constructors

constructor

Properties

description latitude longitude tags -

Constructors

constructor

Properties

description

description: string

latitude

latitude: number

longitude

longitude: number

tags

tags: string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

description

description: string

latitude

latitude: number

longitude

longitude: number

tags

tags: string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/services_profile_profile_lib._internal_.AttendeeProfile.html b/classes/services_profile_profile_lib._internal_.AttendeeProfile.html index 19e22512..e8e4e0ca 100644 --- a/classes/services_profile_profile_lib._internal_.AttendeeProfile.html +++ b/classes/services_profile_profile_lib._internal_.AttendeeProfile.html @@ -1,4 +1,4 @@ -AttendeeProfile | adonix

Class AttendeeProfile

Constructors

constructor +AttendeeProfile | adonix

Class AttendeeProfile

Constructors

constructor

Properties

avatarUrl coins discordTag @@ -6,4 +6,4 @@ foodWave points userId -

Constructors

constructor

Properties

avatarUrl

avatarUrl: string

coins

coins: number

discordTag

discordTag: string

displayName

displayName: string

foodWave

foodWave: number

points

points: number

userId

userId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

avatarUrl

avatarUrl: string

coins

coins: number

discordTag

discordTag: string

displayName

displayName: string

foodWave

foodWave: number

points

points: number

userId

userId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/services_auth_auth_lib._internal_.Provider.html b/enums/services_auth_auth_lib._internal_.Provider.html index 94ceb4cb..082a4930 100644 --- a/enums/services_auth_auth_lib._internal_.Provider.html +++ b/enums/services_auth_auth_lib._internal_.Provider.html @@ -1,3 +1,3 @@ -Provider | adonix

Enumeration Provider

Enumeration Members

GITHUB +Provider | adonix

Enumeration Provider

Enumeration Members

GITHUB GOOGLE -

Enumeration Members

GITHUB

GITHUB: "github"

GOOGLE

GOOGLE: "google"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

GITHUB

GITHUB: "github"

GOOGLE

GOOGLE: "google"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/services_auth_auth_lib._internal_.Role.html b/enums/services_auth_auth_lib._internal_.Role.html index ce698653..9466293d 100644 --- a/enums/services_auth_auth_lib._internal_.Role.html +++ b/enums/services_auth_auth_lib._internal_.Role.html @@ -1,4 +1,4 @@ -Role | adonix

Enumeration Role

Enumeration Members

ADMIN +Role | adonix

Enumeration Role

Enumeration Members

ADMIN APPLICANT ATTENDEE BLOBSTORE @@ -7,4 +7,4 @@ SPONSOR STAFF USER -

Enumeration Members

ADMIN

ADMIN: "ADMIN"

APPLICANT

APPLICANT: "APPLICANT"

ATTENDEE

ATTENDEE: "ATTENDEE"

BLOBSTORE

BLOBSTORE: "BLOBSTORE"

MENTOR

MENTOR: "MENTOR"

PRO

PRO: "PRO"

SPONSOR

SPONSOR: "SPONSOR"

STAFF

STAFF: "STAFF"

USER

USER: "USER"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ADMIN

ADMIN: "ADMIN"

APPLICANT

APPLICANT: "APPLICANT"

ATTENDEE

ATTENDEE: "ATTENDEE"

BLOBSTORE

BLOBSTORE: "BLOBSTORE"

MENTOR

MENTOR: "MENTOR"

PRO

PRO: "PRO"

SPONSOR

SPONSOR: "SPONSOR"

STAFF

STAFF: "STAFF"

USER

USER: "USER"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/services_auth_auth_lib._internal_.RoleOperation.html b/enums/services_auth_auth_lib._internal_.RoleOperation.html index 1a052fa9..bdeaac9b 100644 --- a/enums/services_auth_auth_lib._internal_.RoleOperation.html +++ b/enums/services_auth_auth_lib._internal_.RoleOperation.html @@ -1,3 +1,3 @@ -RoleOperation | adonix

Enumeration RoleOperation

Enumeration Members

ADD +RoleOperation | adonix

Enumeration RoleOperation

Enumeration Members

ADD REMOVE -

Enumeration Members

ADD

ADD: "add"

REMOVE

REMOVE: "remove"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ADD

ADD: "add"

REMOVE

REMOVE: "remove"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/services_event_event_lib._internal_.PUBLIC_EVENT_TYPE.html b/enums/services_event_event_lib._internal_.PUBLIC_EVENT_TYPE.html index fdad2f3d..790484c1 100644 --- a/enums/services_event_event_lib._internal_.PUBLIC_EVENT_TYPE.html +++ b/enums/services_event_event_lib._internal_.PUBLIC_EVENT_TYPE.html @@ -1,7 +1,7 @@ -PUBLIC_EVENT_TYPE | adonix

Enumeration PUBLIC_EVENT_TYPE

Enumeration Members

MEAL +PUBLIC_EVENT_TYPE | adonix

Enumeration PUBLIC_EVENT_TYPE

Enumeration Members

MEAL MINIEVENT OTHER QNA SPEAKER WORKSHOP -

Enumeration Members

MEAL

MEAL: "MEAL"

MINIEVENT

MINIEVENT: "MINIEVENT"

OTHER

OTHER: "OTHER"

QNA

QNA: "QNA"

SPEAKER

SPEAKER: "SPEAKER"

WORKSHOP

WORKSHOP: "WORKSHOP"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

MEAL

MEAL: "MEAL"

MINIEVENT

MINIEVENT: "MINIEVENT"

OTHER

OTHER: "OTHER"

QNA

QNA: "QNA"

SPEAKER

SPEAKER: "SPEAKER"

WORKSHOP

WORKSHOP: "WORKSHOP"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/app.default.html b/functions/app.default.html index 559e053e..366d7458 100644 --- a/functions/app.default.html +++ b/functions/app.default.html @@ -1,3 +1,3 @@ default | adonix

Function default

  • default(req, res): any

  • Express instance itself is a request handler, which could be invoked without third argument.

    -

    Parameters

    • req: IncomingMessage | Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: ServerResponse<IncomingMessage> | Response<any, Record<string, any>, number>

    Returns any

  • default(req, res, next): void

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>, number>
    • next: NextFunction

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns any

  • default(req, res, next): void

  • Parameters

    Returns void

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/app.startServer.html b/functions/app.startServer.html index 46b718b1..05f22363 100644 --- a/functions/app.startServer.html +++ b/functions/app.startServer.html @@ -1 +1 @@ -startServer | adonix

    Function startServer

    • startServer(): Promise<Express.Application>

    • Returns Promise<Express.Application>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +startServer | adonix

    Function startServer

    • startServer(): Promise<Express.Application>

    • Returns Promise<Express.Application>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/middleware_select_auth.SelectAuthProvider.html b/functions/middleware_select_auth.SelectAuthProvider.html index ec7b9ec6..b166b2b3 100644 --- a/functions/middleware_select_auth.SelectAuthProvider.html +++ b/functions/middleware_select_auth.SelectAuthProvider.html @@ -2,4 +2,4 @@

    Parameters

    Returns RequestHandler

    RequestHandler middleware, that's pre-configured for the provider

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/middleware_verify_jwt.strongJwtVerification.html b/functions/middleware_verify_jwt.strongJwtVerification.html index e3a964c2..199591b9 100644 --- a/functions/middleware_verify_jwt.strongJwtVerification.html +++ b/functions/middleware_verify_jwt.strongJwtVerification.html @@ -9,4 +9,4 @@

    Api Error

    (500: Internal Error) {string} InternalError Server error.<

    Api Error Example

    Example Error Response: HTTP/1.1 400 Bad Request {"error": "NoToken"}

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/middleware_verify_jwt.weakJwtVerification.html b/functions/middleware_verify_jwt.weakJwtVerification.html index a0af2e32..ce8a4cc7 100644 --- a/functions/middleware_verify_jwt.weakJwtVerification.html +++ b/functions/middleware_verify_jwt.weakJwtVerification.html @@ -2,4 +2,4 @@

    Api Header

    Authorization JWT token.

    Api Header Example

    Example Headers: {"Authorization": "loremipsumdolorsitamet"}

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.authenticateFunction.html b/functions/services_auth_auth_lib.authenticateFunction.html index b8f45949..453f414d 100644 --- a/functions/services_auth_auth_lib.authenticateFunction.html +++ b/functions/services_auth_auth_lib.authenticateFunction.html @@ -3,4 +3,4 @@

    Parameters

    Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

    Passport middleware that is used to perform authentication

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.decodeJwtToken.html b/functions/services_auth_auth_lib.decodeJwtToken.html index 541ffbf7..79e2643b 100644 --- a/functions/services_auth_auth_lib.decodeJwtToken.html +++ b/functions/services_auth_auth_lib.decodeJwtToken.html @@ -1,4 +1,4 @@ decodeJwtToken | adonix

    Function decodeJwtToken

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.generateJwtToken.html b/functions/services_auth_auth_lib.generateJwtToken.html index a3dc423a..9ec8edd9 100644 --- a/functions/services_auth_auth_lib.generateJwtToken.html +++ b/functions/services_auth_auth_lib.generateJwtToken.html @@ -2,4 +2,4 @@

    Parameters

    Returns string

    Signed JWT token, to be returned to the user.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.getAuthInfo.html b/functions/services_auth_auth_lib.getAuthInfo.html index baece4d7..3be949d3 100644 --- a/functions/services_auth_auth_lib.getAuthInfo.html +++ b/functions/services_auth_auth_lib.getAuthInfo.html @@ -1,4 +1,4 @@ getAuthInfo | adonix

    Function getAuthInfo

    • getAuthInfo(id): Promise<AuthInfo>

    • Get auth database information for a given user

      Parameters

      • id: string

        UserID of the user to return the info for

      Returns Promise<AuthInfo>

      Promise containing user, provider, email, and roles if valid. If invalid, error containing why.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.getJwtPayloadFromDB.html b/functions/services_auth_auth_lib.getJwtPayloadFromDB.html index 526b4580..db42cf6b 100644 --- a/functions/services_auth_auth_lib.getJwtPayloadFromDB.html +++ b/functions/services_auth_auth_lib.getJwtPayloadFromDB.html @@ -1,4 +1,4 @@ getJwtPayloadFromDB | adonix

    Function getJwtPayloadFromDB

    • getJwtPayloadFromDB(targetUser): Promise<JwtPayload>

    • Get a JWT payload for a user, from database. Perform an auth query and an users query, which are used in an implicit join.

      Parameters

      • targetUser: string

        UserID of the user to return a JWT payload for.

      Returns Promise<JwtPayload>

      Promise, containing either JWT payload or reason for failure

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.getJwtPayloadFromProfile.html b/functions/services_auth_auth_lib.getJwtPayloadFromProfile.html index e2b84f00..84e502fd 100644 --- a/functions/services_auth_auth_lib.getJwtPayloadFromProfile.html +++ b/functions/services_auth_auth_lib.getJwtPayloadFromProfile.html @@ -3,4 +3,4 @@
  • data: ProfileData

    ProfileData, returned from passport post-authentication step

  • rawId: boolean

    boolean, true if the id in data needs to be prepended by the provider, false if not

    • Returns Promise<JwtPayload>

    JwtPayload, which gets sent back to the user in the next step

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.getRoles.html b/functions/services_auth_auth_lib.getRoles.html index 80fc0c3b..325e4de5 100644 --- a/functions/services_auth_auth_lib.getRoles.html +++ b/functions/services_auth_auth_lib.getRoles.html @@ -1,4 +1,4 @@ getRoles | adonix

    Function getRoles

    • getRoles(id): Promise<Role[] | undefined>

    • Calls the getAuthInfo function to get roles for a user. If the user does not exist, we return an empty array as opposed to an error.

      Parameters

      • id: string

        UserID of the user to return the info for

      Returns Promise<Role[] | undefined>

      Promise, containing array of roles for the user.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.getUsersWithRole.html b/functions/services_auth_auth_lib.getUsersWithRole.html index 02d9df2d..d403224e 100644 --- a/functions/services_auth_auth_lib.getUsersWithRole.html +++ b/functions/services_auth_auth_lib.getUsersWithRole.html @@ -1,4 +1,4 @@ getUsersWithRole | adonix

    Function getUsersWithRole

    • getUsersWithRole(role): Promise<string[]>

    • Get all id of users that have a particular role within the database.

      Parameters

      • role: string

        role that we want to filter for

      Returns Promise<string[]>

      Promise<string[]> - if valid, then contains array of user w/ role. If invalid, then contains "Unknown Error".

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.hasAdminPerms.html b/functions/services_auth_auth_lib.hasAdminPerms.html index b7a8e1b8..78d7c7bb 100644 --- a/functions/services_auth_auth_lib.hasAdminPerms.html +++ b/functions/services_auth_auth_lib.hasAdminPerms.html @@ -1,4 +1,4 @@ hasAdminPerms | adonix

    Function hasAdminPerms

    • hasAdminPerms(payload?): boolean

    • Check if a user has permissions to perform admin operations

      Parameters

      • Optional payload: JwtPayload

        Payload of user performing the actual request

      Returns boolean

      True if the user is an ADMIN, else false

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.hasElevatedPerms.html b/functions/services_auth_auth_lib.hasElevatedPerms.html index 9c2506ff..c6d92bda 100644 --- a/functions/services_auth_auth_lib.hasElevatedPerms.html +++ b/functions/services_auth_auth_lib.hasElevatedPerms.html @@ -1,4 +1,4 @@ hasElevatedPerms | adonix

    Function hasElevatedPerms

    • hasElevatedPerms(payload): boolean

    • Catch-all function to check if a user should have permissions to perform operations on attendees

      Parameters

      • payload: JwtPayload

        Payload of user performing the actual request

      Returns boolean

      True if the user is an ADMIN or a STAFF, else false

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.hasStaffPerms.html b/functions/services_auth_auth_lib.hasStaffPerms.html index a23d9c7f..9d094f3f 100644 --- a/functions/services_auth_auth_lib.hasStaffPerms.html +++ b/functions/services_auth_auth_lib.hasStaffPerms.html @@ -1,4 +1,4 @@ hasStaffPerms | adonix

    Function hasStaffPerms

    • hasStaffPerms(payload?): boolean

    • Check if a user has permissions to perform staff operations

      Parameters

      • Optional payload: JwtPayload

        Payload of user performing the actual request

      Returns boolean

      True if the user is a STAFF, else false

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.initializeUserRoles.html b/functions/services_auth_auth_lib.initializeUserRoles.html index 90e208c1..6e29b19f 100644 --- a/functions/services_auth_auth_lib.initializeUserRoles.html +++ b/functions/services_auth_auth_lib.initializeUserRoles.html @@ -2,4 +2,4 @@

    Parameters

    Returns Role[]

    List of roles that the uer containss

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.isAttendee.html b/functions/services_auth_auth_lib.isAttendee.html index e158deaa..1944613a 100644 --- a/functions/services_auth_auth_lib.isAttendee.html +++ b/functions/services_auth_auth_lib.isAttendee.html @@ -1 +1 @@ -isAttendee | adonix

    Function isAttendee

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +isAttendee | adonix

    Function isAttendee

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.isPro.html b/functions/services_auth_auth_lib.isPro.html index aea87d19..bc2d2fb5 100644 --- a/functions/services_auth_auth_lib.isPro.html +++ b/functions/services_auth_auth_lib.isPro.html @@ -1,4 +1,4 @@ isPro | adonix

    Function isPro

    • isPro(payload?): boolean

    • Check if a user has PRO permissions

      Parameters

      • Optional payload: JwtPayload

        Payload of user performing the actual request

      Returns boolean

      True if the user has PRO, else false

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.updateRoles.html b/functions/services_auth_auth_lib.updateRoles.html index 9f2c2a79..6002a87c 100644 --- a/functions/services_auth_auth_lib.updateRoles.html +++ b/functions/services_auth_auth_lib.updateRoles.html @@ -3,4 +3,4 @@
  • role: Role

    Role to add/remove

  • operation: RoleOperation

    Operation to perform

    • Returns Promise<Role[]>

    Promise - if valid, then update operation worked. If invalid, then contains why.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.updateUserRoles.html b/functions/services_auth_auth_lib.updateUserRoles.html index 0f0f0911..407808be 100644 --- a/functions/services_auth_auth_lib.updateUserRoles.html +++ b/functions/services_auth_auth_lib.updateUserRoles.html @@ -3,4 +3,4 @@
  • provider: Provider

    Provider being used to create this entry

  • roles: Role[]

    Array of roles that belong to the given user

    • Returns Promise<void>

    Promise, containing nothing if valid. If invalid, error containing why.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_auth_auth_lib.verifyFunction.html b/functions/services_auth_auth_lib.verifyFunction.html index 79812dc9..50e561c5 100644 --- a/functions/services_auth_auth_lib.verifyFunction.html +++ b/functions/services_auth_auth_lib.verifyFunction.html @@ -1,3 +1,3 @@ verifyFunction | adonix

    Function verifyFunction

    • verifyFunction(accessToken, refreshToken, profile, done): void

    • Simple function, used to verify that authentication actually happens correctly.

      Parameters

      • accessToken: string
      • refreshToken: string
      • profile: Profile
      • done: VerifyCallback

      Returns void

      Results of the callback function, after it's been called with the user

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_event_event_lib.createFilteredEventView.html b/functions/services_event_event_lib.createFilteredEventView.html index 34c1dc35..15d5340e 100644 --- a/functions/services_event_event_lib.createFilteredEventView.html +++ b/functions/services_event_event_lib.createFilteredEventView.html @@ -2,4 +2,4 @@ the 'isPrivate', 'displayOnStaffCheckIn', and 'isStaff' properties.

    Parameters

    Returns FilteredEventView

    The truncated ExternalEvent object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_profile_profile_lib.castLeaderboardEntries.html b/functions/services_profile_profile_lib.castLeaderboardEntries.html index 2cd9b035..4248278a 100644 --- a/functions/services_profile_profile_lib.castLeaderboardEntries.html +++ b/functions/services_profile_profile_lib.castLeaderboardEntries.html @@ -1,4 +1,4 @@ castLeaderboardEntries | adonix

    Function castLeaderboardEntries

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_profile_profile_lib.getCoins.html b/functions/services_profile_profile_lib.getCoins.html index 7f3ff2d6..a1a44199 100644 --- a/functions/services_profile_profile_lib.getCoins.html +++ b/functions/services_profile_profile_lib.getCoins.html @@ -1,4 +1,4 @@ getCoins | adonix

    Function getCoins

    • getCoins(userId): Promise<number | null>

    • Get user's current coin balance.

      Parameters

      • userId: string

        ID of target user

      Returns Promise<number | null>

      Coin amount (number)

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_profile_profile_lib.isValidLimit.html b/functions/services_profile_profile_lib.isValidLimit.html index 7e9b6bdd..fb5f1c47 100644 --- a/functions/services_profile_profile_lib.isValidLimit.html +++ b/functions/services_profile_profile_lib.isValidLimit.html @@ -1,4 +1,4 @@ isValidLimit | adonix

    Function isValidLimit

    • isValidLimit(limit): boolean

    • Check if the limit is valid or not

      Parameters

      • limit: number

        Initial value to check

      Returns boolean

      True if limit is non-negative, else false

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_profile_profile_lib.updateCoins.html b/functions/services_profile_profile_lib.updateCoins.html index aa45bced..fa5e0b8b 100644 --- a/functions/services_profile_profile_lib.updateCoins.html +++ b/functions/services_profile_profile_lib.updateCoins.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<AttendeeProfile | null>

    Promise containing the new user, or the actual attendee profile

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_profile_profile_lib.updatePoints.html b/functions/services_profile_profile_lib.updatePoints.html index a6544dab..2a8de6d9 100644 --- a/functions/services_profile_profile_lib.updatePoints.html +++ b/functions/services_profile_profile_lib.updatePoints.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<AttendeeProfile | null>

    Promise containing the new user, or the actual attendee profile

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_auth_auth_lib._internal_.JwtPayload.html b/interfaces/services_auth_auth_lib._internal_.JwtPayload.html index f8d48521..e4af9ee8 100644 --- a/interfaces/services_auth_auth_lib._internal_.JwtPayload.html +++ b/interfaces/services_auth_auth_lib._internal_.JwtPayload.html @@ -1,6 +1,6 @@ -JwtPayload | adonix

    Interface JwtPayload

    interface JwtPayload {
        email: string;
        exp?: number;
        id: string;
        provider: string;
        roles: Role[];
    }

    Properties

    email +JwtPayload | adonix

    Interface JwtPayload

    interface JwtPayload {
        email: string;
        exp?: number;
        id: string;
        provider: string;
        roles: Role[];
    }

    Properties

    email exp? id provider roles -

    Properties

    email

    email: string

    Optional exp

    exp?: number

    id

    id: string

    provider

    provider: string

    roles

    roles: Role[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    email

    email: string

    Optional exp

    exp?: number

    id

    id: string

    provider

    provider: string

    roles

    roles: Role[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_auth_auth_lib._internal_.ProfileData.html b/interfaces/services_auth_auth_lib._internal_.ProfileData.html index 70b056d2..7b860981 100644 --- a/interfaces/services_auth_auth_lib._internal_.ProfileData.html +++ b/interfaces/services_auth_auth_lib._internal_.ProfileData.html @@ -1,6 +1,6 @@ -ProfileData | adonix

    Interface ProfileData

    interface ProfileData {
        displayName?: string;
        email: string;
        id?: string;
        login?: string;
        name?: string;
    }

    Properties

    displayName? +ProfileData | adonix

    Interface ProfileData

    interface ProfileData {
        displayName?: string;
        email: string;
        id?: string;
        login?: string;
        name?: string;
    }

    Properties

    displayName? email id? login? name? -

    Properties

    Optional displayName

    displayName?: string

    email

    email: string

    Optional id

    id?: string

    Optional login

    login?: string

    Optional name

    name?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional displayName

    displayName?: string

    email

    email: string

    Optional id

    id?: string

    Optional login

    login?: string

    Optional name

    name?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_event_event_lib._internal_.FilteredEventView.html b/interfaces/services_event_event_lib._internal_.FilteredEventView.html index ce886c2c..6c4db198 100644 --- a/interfaces/services_event_event_lib._internal_.FilteredEventView.html +++ b/interfaces/services_event_event_lib._internal_.FilteredEventView.html @@ -1,4 +1,4 @@ -FilteredEventView | adonix

    Interface FilteredEventView

    interface FilteredEventView {
        description: string;
        endTime: number;
        eventId: string;
        eventType: PUBLIC_EVENT_TYPE;
        isAsync: boolean;
        isPro: boolean;
        locations: Location[];
        mapImageUrl?: string;
        name: string;
        points: number;
        sponsor?: string;
        startTime: number;
    }

    Properties

    description +FilteredEventView | adonix

    Interface FilteredEventView

    interface FilteredEventView {
        description: string;
        endTime: number;
        eventId: string;
        eventType: PUBLIC_EVENT_TYPE;
        isAsync: boolean;
        isPro: boolean;
        locations: Location[];
        mapImageUrl?: string;
        name: string;
        points: number;
        sponsor?: string;
        startTime: number;
    }

    Properties

    description endTime eventId eventType @@ -10,4 +10,4 @@ points sponsor? startTime -

    Properties

    description

    description: string

    endTime

    endTime: number

    eventId

    eventId: string

    eventType

    eventType: PUBLIC_EVENT_TYPE

    isAsync

    isAsync: boolean

    isPro

    isPro: boolean

    locations

    locations: Location[]

    Optional mapImageUrl

    mapImageUrl?: string

    name

    name: string

    points

    points: number

    Optional sponsor

    sponsor?: string

    startTime

    startTime: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    description

    description: string

    endTime

    endTime: number

    eventId

    eventId: string

    eventType

    eventType: PUBLIC_EVENT_TYPE

    isAsync

    isAsync: boolean

    isPro

    isPro: boolean

    locations

    locations: Location[]

    Optional mapImageUrl

    mapImageUrl?: string

    name

    name: string

    points

    points: number

    Optional sponsor

    sponsor?: string

    startTime

    startTime: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_profile_profile_lib._internal_.LeaderboardEntry.html b/interfaces/services_profile_profile_lib._internal_.LeaderboardEntry.html index c28fae0b..e00c4af6 100644 --- a/interfaces/services_profile_profile_lib._internal_.LeaderboardEntry.html +++ b/interfaces/services_profile_profile_lib._internal_.LeaderboardEntry.html @@ -1,3 +1,3 @@ -LeaderboardEntry | adonix

    Interface LeaderboardEntry

    interface LeaderboardEntry {
        displayName: string;
        points: number;
    }

    Properties

    displayName +LeaderboardEntry | adonix

    Interface LeaderboardEntry

    interface LeaderboardEntry {
        displayName: string;
        points: number;
    }

    Properties

    displayName points -

    Properties

    displayName

    displayName: string

    points

    points: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    displayName

    displayName: string

    points

    points: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/app.html b/modules/app.html index 9396b93e..2b498b1d 100644 --- a/modules/app.html +++ b/modules/app.html @@ -1,3 +1,3 @@ -app | adonix

    Module app

    Index

    Functions

    default +app | adonix

    Module app

    Index

    Functions

    default startServer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/middleware_select_auth.html b/modules/middleware_select_auth.html index db9dc526..6f5ce56f 100644 --- a/modules/middleware_select_auth.html +++ b/modules/middleware_select_auth.html @@ -1,2 +1,2 @@ -middleware/select-auth | adonix

    Module middleware/select-auth

    Index

    Functions

    SelectAuthProvider +middleware/select-auth | adonix

    Module middleware/select-auth

    Index

    Functions

    SelectAuthProvider

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/middleware_verify_jwt.html b/modules/middleware_verify_jwt.html index 86d1a12d..9b21a353 100644 --- a/modules/middleware_verify_jwt.html +++ b/modules/middleware_verify_jwt.html @@ -1,3 +1,3 @@ -middleware/verify-jwt | adonix

    Module middleware/verify-jwt

    Index

    Functions

    strongJwtVerification +middleware/verify-jwt | adonix

    Module middleware/verify-jwt

    Index

    Functions

    strongJwtVerification weakJwtVerification

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/services_auth_auth_lib.html b/modules/services_auth_auth_lib.html index 3b45a810..ccef37a5 100644 --- a/modules/services_auth_auth_lib.html +++ b/modules/services_auth_auth_lib.html @@ -1,4 +1,4 @@ -services/auth/auth-lib | adonix

    Module services/auth/auth-lib

    Index

    Modules

    <internal> +services/auth/auth-lib | adonix

    Module services/auth/auth-lib

    Index

    Modules

    <internal>

    Functions

    authenticateFunction decodeJwtToken generateJwtToken diff --git a/modules/services_event_event_lib.html b/modules/services_event_event_lib.html index d3b2a112..a4de10c6 100644 --- a/modules/services_event_event_lib.html +++ b/modules/services_event_event_lib.html @@ -1,3 +1,3 @@ -services/event/event-lib | adonix

    Module services/event/event-lib

    Index

    Modules

    <internal> +services/event/event-lib | adonix

    Module services/event/event-lib

    Index

    Modules

    <internal>

    Functions

    createFilteredEventView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/services_profile_profile_lib.html b/modules/services_profile_profile_lib.html index ab590b37..78d4effd 100644 --- a/modules/services_profile_profile_lib.html +++ b/modules/services_profile_profile_lib.html @@ -1,4 +1,4 @@ -services/profile/profile-lib | adonix

    Module services/profile/profile-lib

    Index

    Modules

    <internal> +services/profile/profile-lib | adonix

    Module services/profile/profile-lib

    Index

    Modules

    <internal>

    Functions

    castLeaderboardEntries getCoins isValidLimit diff --git a/types/services_auth_auth_lib._internal_.VerifyCallback.html b/types/services_auth_auth_lib._internal_.VerifyCallback.html index 5ea00309..97c70634 100644 --- a/types/services_auth_auth_lib._internal_.VerifyCallback.html +++ b/types/services_auth_auth_lib._internal_.VerifyCallback.html @@ -1 +1 @@ -VerifyCallback | adonix

    Type alias VerifyCallback

    VerifyCallback: ((err, user?, info?) => void)

    Type declaration

      • (err, user?, info?): void

      • Parameters

        • err: Error | null
        • Optional user: Profile | false
        • Optional info: object

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +VerifyCallback | adonix

    Type alias VerifyCallback

    VerifyCallback: ((err, user?, info?) => void)

    Type declaration

      • (err, user?, info?): void

      • Parameters

        • err: Error | null
        • Optional user: Profile | false
        • Optional info: object

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file