From ea852ba9a0d255fa8614031c01df02d4afdda7e5 Mon Sep 17 00:00:00 2001 From: lasyaneti Date: Sun, 12 Nov 2023 18:26:46 +0000 Subject: [PATCH] deploy: HackIllinois/adonix@ca7f3fed6100b756ec3cb72043e53f822d4c289b --- classes/services_auth_auth_lib._internal_.AuthInfo.html | 4 ++-- classes/services_event_event_lib._internal_.BaseEvent.html | 4 ++-- classes/services_event_event_lib._internal_.Location.html | 4 ++-- classes/services_event_event_lib._internal_.PublicEvent.html | 4 ++-- ...rvices_profile_profile_lib._internal_.AttendeeProfile.html | 4 ++-- enums/database.Database.html | 4 ++-- enums/services_auth_auth_lib._internal_.Provider.html | 4 ++-- enums/services_auth_auth_lib._internal_.Role.html | 4 ++-- enums/services_auth_auth_lib._internal_.RoleOperation.html | 4 ++-- ...services_event_event_lib._internal_.PUBLIC_EVENT_TYPE.html | 4 ++-- .../services_event_event_lib._internal_.STAFF_EVENT_TYPE.html | 4 ++-- functions/app.setupServer.html | 2 +- functions/app.startServer.html | 2 +- functions/database.connectToMongoose.html | 2 +- functions/database.generateConfig.html | 2 +- functions/middleware_select_auth.SelectAuthProvider.html | 2 +- functions/middleware_verify_jwt.strongJwtVerification.html | 2 +- functions/middleware_verify_jwt.weakJwtVerification.html | 2 +- functions/services_auth_auth_lib.authenticateFunction.html | 2 +- functions/services_auth_auth_lib.decodeJwtToken.html | 2 +- functions/services_auth_auth_lib.generateJwtToken.html | 2 +- functions/services_auth_auth_lib.getAuthInfo.html | 2 +- functions/services_auth_auth_lib.getJwtPayloadFromDB.html | 2 +- .../services_auth_auth_lib.getJwtPayloadFromProfile.html | 2 +- functions/services_auth_auth_lib.getRoles.html | 2 +- functions/services_auth_auth_lib.getUsersWithRole.html | 2 +- functions/services_auth_auth_lib.hasAdminPerms.html | 2 +- functions/services_auth_auth_lib.hasElevatedPerms.html | 2 +- functions/services_auth_auth_lib.hasStaffPerms.html | 2 +- functions/services_auth_auth_lib.initializeUserRoles.html | 2 +- functions/services_auth_auth_lib.updateRoles.html | 2 +- functions/services_auth_auth_lib.updateUserRoles.html | 2 +- functions/services_auth_auth_lib.verifyFunction.html | 2 +- .../services_event_event_lib.createFilteredEventView.html | 2 +- functions/services_newsletter_newsletter_lib.regexPasses.html | 2 +- .../services_profile_profile_lib.castLeaderboardEntries.html | 2 +- functions/services_profile_profile_lib.isValidLimit.html | 2 +- functions/services_profile_profile_lib.updatePoints.html | 2 +- interfaces/services_auth_auth_lib._internal_.JwtPayload.html | 4 ++-- interfaces/services_auth_auth_lib._internal_.ProfileData.html | 4 ++-- .../services_event_event_lib._internal_.BaseEventFormat.html | 4 ++-- ...services_event_event_lib._internal_.FilteredEventView.html | 4 ++-- ...ervices_event_event_lib._internal_.GenericEventFormat.html | 4 ++-- ...services_event_event_lib._internal_.PublicEventFormat.html | 4 ++-- .../services_event_event_lib._internal_.StaffEventFormat.html | 4 ++-- ...vices_profile_profile_lib._internal_.LeaderboardEntry.html | 4 ++-- modules/app.html | 2 +- modules/database.html | 2 +- modules/middleware_select_auth.html | 2 +- modules/middleware_verify_jwt.html | 2 +- modules/services_auth_auth_lib.html | 2 +- modules/services_event_event_lib.html | 2 +- modules/services_newsletter_newsletter_lib.html | 2 +- modules/services_profile_profile_lib.html | 2 +- types/services_auth_auth_lib._internal_.VerifyCallback.html | 2 +- 55 files changed, 74 insertions(+), 74 deletions(-) diff --git a/classes/services_auth_auth_lib._internal_.AuthInfo.html b/classes/services_auth_auth_lib._internal_.AuthInfo.html index 1f83bdd0..0d3da010 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

Hierarchy

  • AuthInfo

Constructors

constructor +AuthInfo | adonix

Hierarchy

  • AuthInfo

Constructors

Properties

Constructors

Properties

provider: string
roles: string[]
userId: string

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

provider: string
roles: string[]
userId: string

Generated using TypeDoc

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

Hierarchy

Constructors

constructor +BaseEvent | adonix

Hierarchy

Constructors

Properties

Constructors

Properties

description: string
endTime: number
eventId: string
eventType: string
isAsync: boolean
locations: Location[]
name: string
startTime: number

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

description: string
endTime: number
eventId: string
eventType: string
isAsync: boolean
locations: Location[]
name: string
startTime: number

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 e0ea3136..48131367 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

Hierarchy

  • Location

Constructors

constructor +Location | adonix

Hierarchy

  • Location

Constructors

Properties

description: string
latitude: number
longitude: number
tags: string[]

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

description: string
latitude: number
longitude: number
tags: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/services_event_event_lib._internal_.PublicEvent.html b/classes/services_event_event_lib._internal_.PublicEvent.html index 353b467e..7571b3c9 100644 --- a/classes/services_event_event_lib._internal_.PublicEvent.html +++ b/classes/services_event_event_lib._internal_.PublicEvent.html @@ -1,4 +1,4 @@ -PublicEvent | adonix

Hierarchy

Constructors

constructor +PublicEvent | adonix

Hierarchy

Constructors

Properties

Constructors

Properties

description: string
displayOnStaffCheckIn: boolean
endTime: number
eventId: string
eventType: string
isAsync: boolean
isPrivate: boolean
locations: Location[]
name: string
points: number
sponsor: string
startTime: number

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

description: string
displayOnStaffCheckIn: boolean
endTime: number
eventId: string
eventType: string
isAsync: boolean
isPrivate: boolean
locations: Location[]
name: string
points: number
sponsor: string
startTime: number

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 f86bfcf2..45bb7da6 100644 --- a/classes/services_profile_profile_lib._internal_.AttendeeProfile.html +++ b/classes/services_profile_profile_lib._internal_.AttendeeProfile.html @@ -1,7 +1,7 @@ -AttendeeProfile | adonix

Hierarchy

  • AttendeeProfile

Constructors

constructor +AttendeeProfile | adonix

Hierarchy

  • AttendeeProfile

Constructors

Properties

avatarUrl: string
discordTag: string
displayName: string
points: number
userId: string

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

avatarUrl: string
discordTag: string
displayName: string
points: number
userId: string

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/database.Database.html b/enums/database.Database.html index af602084..1ad62fda 100644 --- a/enums/database.Database.html +++ b/enums/database.Database.html @@ -1,8 +1,8 @@ -Database | adonix

Enumeration Database

Enumeration Members

ADMISSION +Database | adonix

Enumeration Database

Enumeration Members

ADMISSION: "admission"
ATTENDEE: "attendee"
AUTH: "auth"
EVENT: "event"
NEWSLETTER: "newsletter"
REGISTRATION: "registration"
USER: "user"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ADMISSION: "admission"
ATTENDEE: "attendee"
AUTH: "auth"
EVENT: "event"
NEWSLETTER: "newsletter"
REGISTRATION: "registration"
USER: "user"

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 3a3323eb..5177ef2b 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 Members

GITHUB +Provider | adonix

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

GITHUB: "github"
GOOGLE: "google"

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 8d5fd0da..76c4b2a8 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 Members

ADMIN +Role | adonix

Enumeration Members

Enumeration Members

ADMIN: "ADMIN"
APPLICANT: "APPLICANT"
ATTENDEE: "ATTENDEE"
BLOBSTORE: "BLOBSTORE"
MENTOR: "MENTOR"
SPONSOR: "SPONSOR"
STAFF: "STAFF"
USER: "USER"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ADMIN: "ADMIN"
APPLICANT: "APPLICANT"
ATTENDEE: "ATTENDEE"
BLOBSTORE: "BLOBSTORE"
MENTOR: "MENTOR"
SPONSOR: "SPONSOR"
STAFF: "STAFF"
USER: "USER"

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 01c2292a..dd36da3a 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 Members

ADD +RoleOperation | adonix

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ADD: "add"
REMOVE: "remove"

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 b71bd345..a1b8528a 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 Members

MEAL +PUBLIC_EVENT_TYPE | adonix

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

MEAL: "MEAL"
MINIEVENT: "MINIEVENT"
OTHER: "OTHER"
QNA: "QNA"
SPEAKER: "SPEAKER"
WORKSHOP: "WORKSHOP"

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/services_event_event_lib._internal_.STAFF_EVENT_TYPE.html b/enums/services_event_event_lib._internal_.STAFF_EVENT_TYPE.html index 7d7da923..b484a7cb 100644 --- a/enums/services_event_event_lib._internal_.STAFF_EVENT_TYPE.html +++ b/enums/services_event_event_lib._internal_.STAFF_EVENT_TYPE.html @@ -1,4 +1,4 @@ -STAFF_EVENT_TYPE | adonix

Enumeration Members

MEETING +STAFF_EVENT_TYPE | adonix

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

MEETING: "MEETING"
OTHER: "OTHER"
STAFF_SHIFT: "STAFFSHIFT"

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/app.setupServer.html b/functions/app.setupServer.html index 06b8488e..4da340e0 100644 --- a/functions/app.setupServer.html +++ b/functions/app.setupServer.html @@ -1 +1 @@ -setupServer | adonix

Function setupServer

Generated using TypeDoc

\ No newline at end of file +setupServer | adonix

Function setupServer

Generated using TypeDoc

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

Function startServer

  • Returns Promise<Express.Application>

Generated using TypeDoc

\ No newline at end of file +startServer | adonix

Function startServer

  • Returns Promise<Express.Application>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/database.connectToMongoose.html b/functions/database.connectToMongoose.html index ba3d558a..843e6841 100644 --- a/functions/database.connectToMongoose.html +++ b/functions/database.connectToMongoose.html @@ -1 +1 @@ -connectToMongoose | adonix

Function connectToMongoose

  • Parameters

    • dbName: string

    Returns mongoose.Connection

Generated using TypeDoc

\ No newline at end of file +connectToMongoose | adonix

Function connectToMongoose

  • Parameters

    • dbName: string

    Returns mongoose.Connection

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/database.generateConfig.html b/functions/database.generateConfig.html index 9323af61..994052d7 100644 --- a/functions/database.generateConfig.html +++ b/functions/database.generateConfig.html @@ -1 +1 @@ -generateConfig | adonix

Function generateConfig

  • Parameters

    • database: string
    • collection: string

    Returns IModelOptions

Generated using TypeDoc

\ No newline at end of file +generateConfig | adonix

Function generateConfig

  • Parameters

    • database: string
    • collection: string

    Returns IModelOptions

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 4e102aab..4cdd0f0e 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

-

Generated using TypeDoc

\ No newline at end of file +

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 dfa2522d..f49b194f 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"}

-

Generated using TypeDoc

\ No newline at end of file +

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 08358c5f..da9d3310 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"}

-

Generated using TypeDoc

\ No newline at end of file +

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 580ca3c6..e7cd8e8b 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

-

Generated using TypeDoc

\ No newline at end of file +

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 d810fbb5..9234eb09 100644 --- a/functions/services_auth_auth_lib.decodeJwtToken.html +++ b/functions/services_auth_auth_lib.decodeJwtToken.html @@ -1,4 +1,4 @@ decodeJwtToken | adonix

Generated using TypeDoc

\ No newline at end of file +

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 918eae35..91b2092e 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.

-

Generated using TypeDoc

\ No newline at end of file +

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 e55e2428..dea51d6d 100644 --- a/functions/services_auth_auth_lib.getAuthInfo.html +++ b/functions/services_auth_auth_lib.getAuthInfo.html @@ -1,4 +1,4 @@ getAuthInfo | adonix
  • 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.

    -

Generated using TypeDoc

\ No newline at end of file +

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 a3fdb115..85243f3f 100644 --- a/functions/services_auth_auth_lib.getJwtPayloadFromDB.html +++ b/functions/services_auth_auth_lib.getJwtPayloadFromDB.html @@ -1,4 +1,4 @@ getJwtPayloadFromDB | adonix
  • 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

    -

Generated using TypeDoc

\ No newline at end of file +

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 d776fdac..f6c59856 100644 --- a/functions/services_auth_auth_lib.getJwtPayloadFromProfile.html +++ b/functions/services_auth_auth_lib.getJwtPayloadFromProfile.html @@ -2,4 +2,4 @@

Parameters

Returns Promise<JwtPayload>

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

-

Generated using TypeDoc

\ No newline at end of file +

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 fc4ccf8e..7461fd5f 100644 --- a/functions/services_auth_auth_lib.getRoles.html +++ b/functions/services_auth_auth_lib.getRoles.html @@ -1,4 +1,4 @@ getRoles | adonix
  • 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[]>

    Promise, containing array of roles for the user.

    -

Generated using TypeDoc

\ No newline at end of file +

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 7e08f5b4..9454b7cf 100644 --- a/functions/services_auth_auth_lib.getUsersWithRole.html +++ b/functions/services_auth_auth_lib.getUsersWithRole.html @@ -1,4 +1,4 @@ getUsersWithRole | adonix
  • 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".

    -

Generated using TypeDoc

\ No newline at end of file +

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 b17bb770..1db1a169 100644 --- a/functions/services_auth_auth_lib.hasAdminPerms.html +++ b/functions/services_auth_auth_lib.hasAdminPerms.html @@ -1,4 +1,4 @@ hasAdminPerms | adonix
  • 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

    -

Generated using TypeDoc

\ No newline at end of file +

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 c99bbda8..82de0137 100644 --- a/functions/services_auth_auth_lib.hasElevatedPerms.html +++ b/functions/services_auth_auth_lib.hasElevatedPerms.html @@ -1,4 +1,4 @@ hasElevatedPerms | adonix
  • 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

    -

Generated using TypeDoc

\ No newline at end of file +

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 e82aa953..b7b649fc 100644 --- a/functions/services_auth_auth_lib.hasStaffPerms.html +++ b/functions/services_auth_auth_lib.hasStaffPerms.html @@ -1,4 +1,4 @@ hasStaffPerms | adonix
  • 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

    -

Generated using TypeDoc

\ No newline at end of file +

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 542a6f95..ca31b289 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

-

Generated using TypeDoc

\ No newline at end of file +

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 8b6abde0..7ee613ef 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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    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 e699a69f..0bc5db48 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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    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 407b62d3..cd3e6703 100644 --- a/functions/services_auth_auth_lib.verifyFunction.html +++ b/functions/services_auth_auth_lib.verifyFunction.html @@ -1,3 +1,3 @@ verifyFunction | adonix
    • 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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    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 e1b0ada3..3c7f1239 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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/services_newsletter_newsletter_lib.regexPasses.html b/functions/services_newsletter_newsletter_lib.regexPasses.html index 6cdf79ff..79e6dfcd 100644 --- a/functions/services_newsletter_newsletter_lib.regexPasses.html +++ b/functions/services_newsletter_newsletter_lib.regexPasses.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    Whether or not the string fits AT LEAST one of the patterns

    -

    Generated using TypeDoc

    \ No newline at end of file +

    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 c93dc514..0dca7a6b 100644 --- a/functions/services_profile_profile_lib.castLeaderboardEntries.html +++ b/functions/services_profile_profile_lib.castLeaderboardEntries.html @@ -1,4 +1,4 @@ castLeaderboardEntries | adonix

    Generated using TypeDoc

    \ No newline at end of file +

    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 48a85220..0b45288c 100644 --- a/functions/services_profile_profile_lib.isValidLimit.html +++ b/functions/services_profile_profile_lib.isValidLimit.html @@ -1,4 +1,4 @@ isValidLimit | adonix
    • 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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    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 f400496d..3caed723 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    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 b153fd6d..020a33ae 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

    Hierarchy

    • JwtPayload

    Properties

    email +JwtPayload | adonix

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    email: string
    exp?: number
    id: string
    provider: string
    roles: Role[]

    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 80abdec1..11e0f929 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

    Hierarchy

    • ProfileData

    Properties

    displayName? +ProfileData | adonix

    Hierarchy

    • ProfileData

    Properties

    displayName?: string
    email: string
    id?: string
    login?: string
    name?: string

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    displayName?: string
    email: string
    id?: string
    login?: string
    name?: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_event_event_lib._internal_.BaseEventFormat.html b/interfaces/services_event_event_lib._internal_.BaseEventFormat.html index ca529db1..97a1004a 100644 --- a/interfaces/services_event_event_lib._internal_.BaseEventFormat.html +++ b/interfaces/services_event_event_lib._internal_.BaseEventFormat.html @@ -1,4 +1,4 @@ -BaseEventFormat | adonix

    Hierarchy

    Properties

    _id? +BaseEventFormat | adonix

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    _id?: string
    description: string
    endTime: number
    eventId: string
    isAsync: boolean
    isStaff: boolean
    locations: Location[]
    name: string
    startTime: number

    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 fc340c09..579e01ca 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

    Hierarchy

    • FilteredEventView

    Properties

    description +FilteredEventView | adonix

    Hierarchy

    • FilteredEventView

    Properties

    description: string
    endTime: number
    eventId: string
    isAsync: boolean
    locations: Location[]
    name: string
    points: number
    sponsor?: string
    startTime: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    description: string
    endTime: number
    eventId: string
    isAsync: boolean
    locations: Location[]
    name: string
    points: number
    sponsor?: string
    startTime: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_event_event_lib._internal_.GenericEventFormat.html b/interfaces/services_event_event_lib._internal_.GenericEventFormat.html index d17efe08..5d2c3877 100644 --- a/interfaces/services_event_event_lib._internal_.GenericEventFormat.html +++ b/interfaces/services_event_event_lib._internal_.GenericEventFormat.html @@ -1,4 +1,4 @@ -GenericEventFormat | adonix

    Hierarchy

    Properties

    _id? +GenericEventFormat | adonix

    Hierarchy

    Properties

    _id?: string
    description: string
    displayOnStaffCheckIn: boolean
    endTime: number
    eventId: string
    isAsync: boolean
    isPrivate: boolean
    isStaff: boolean
    locations: Location[]
    name: string
    points: number
    publicEventType: PUBLIC_EVENT_TYPE
    sponsor: string
    staffEventType: STAFF_EVENT_TYPE
    startTime: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    _id?: string
    description: string
    displayOnStaffCheckIn: boolean
    endTime: number
    eventId: string
    isAsync: boolean
    isPrivate: boolean
    isStaff: boolean
    locations: Location[]
    name: string
    points: number
    publicEventType: PUBLIC_EVENT_TYPE
    sponsor: string
    staffEventType: STAFF_EVENT_TYPE
    startTime: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_event_event_lib._internal_.PublicEventFormat.html b/interfaces/services_event_event_lib._internal_.PublicEventFormat.html index 5554fb5d..1303f586 100644 --- a/interfaces/services_event_event_lib._internal_.PublicEventFormat.html +++ b/interfaces/services_event_event_lib._internal_.PublicEventFormat.html @@ -1,4 +1,4 @@ -PublicEventFormat | adonix

    Hierarchy

    Properties

    _id? +PublicEventFormat | adonix

    Hierarchy

    Properties

    _id?: string
    description: string
    displayOnStaffCheckIn: boolean
    endTime: number
    eventId: string
    isAsync: boolean
    isPrivate: boolean
    isStaff: boolean
    locations: Location[]
    name: string
    points: number
    publicEventType: PUBLIC_EVENT_TYPE
    sponsor: string
    startTime: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    _id?: string
    description: string
    displayOnStaffCheckIn: boolean
    endTime: number
    eventId: string
    isAsync: boolean
    isPrivate: boolean
    isStaff: boolean
    locations: Location[]
    name: string
    points: number
    publicEventType: PUBLIC_EVENT_TYPE
    sponsor: string
    startTime: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/services_event_event_lib._internal_.StaffEventFormat.html b/interfaces/services_event_event_lib._internal_.StaffEventFormat.html index e7fded8c..76fb8377 100644 --- a/interfaces/services_event_event_lib._internal_.StaffEventFormat.html +++ b/interfaces/services_event_event_lib._internal_.StaffEventFormat.html @@ -1,4 +1,4 @@ -StaffEventFormat | adonix

    Hierarchy

    Properties

    _id? +StaffEventFormat | adonix

    Hierarchy

    Properties

    _id?: string
    description: string
    endTime: number
    eventId: string
    isAsync: boolean
    isStaff: boolean
    locations: Location[]
    name: string
    staffEventType: STAFF_EVENT_TYPE
    startTime: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    _id?: string
    description: string
    endTime: number
    eventId: string
    isAsync: boolean
    isStaff: boolean
    locations: Location[]
    name: string
    staffEventType: STAFF_EVENT_TYPE
    startTime: number

    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 4a6d92c6..f3761246 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

    Hierarchy

    • LeaderboardEntry

    Properties

    displayName +LeaderboardEntry | adonix

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    displayName: string
    points: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/app.html b/modules/app.html index 5c270e5a..b688f6c1 100644 --- a/modules/app.html +++ b/modules/app.html @@ -1,4 +1,4 @@ -app | adonix

    Module app

    Index

    Functions

    default +app | adonix

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/database.html b/modules/database.html index 16fa96fd..051d7bae 100644 --- a/modules/database.html +++ b/modules/database.html @@ -1,4 +1,4 @@ -database | adonix

    Module database

    Index

    Enumerations

    Database +database | adonix

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/middleware_select_auth.html b/modules/middleware_select_auth.html index 7f2802b1..f8f7b8d4 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/middleware_verify_jwt.html b/modules/middleware_verify_jwt.html index 799b43e0..da7d7674 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

    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 2f021e2e..f9ffeed2 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

    Functions

    authenticateFunction decodeJwtToken generateJwtToken diff --git a/modules/services_event_event_lib.html b/modules/services_event_event_lib.html index 0746ea08..700abbcd 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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/services_newsletter_newsletter_lib.html b/modules/services_newsletter_newsletter_lib.html index 0f091fce..ed498b22 100644 --- a/modules/services_newsletter_newsletter_lib.html +++ b/modules/services_newsletter_newsletter_lib.html @@ -1,2 +1,2 @@ -services/newsletter/newsletter-lib | adonix

    Module services/newsletter/newsletter-lib

    Index

    Functions

    regexPasses +services/newsletter/newsletter-lib | adonix

    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 517705a7..6335ebc6 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

    Functions

    castLeaderboardEntries isValidLimit updatePoints diff --git a/types/services_auth_auth_lib._internal_.VerifyCallback.html b/types/services_auth_auth_lib._internal_.VerifyCallback.html index d0deb05b..8abad92e 100644 --- a/types/services_auth_auth_lib._internal_.VerifyCallback.html +++ b/types/services_auth_auth_lib._internal_.VerifyCallback.html @@ -1 +1 @@ -VerifyCallback | adonix
    VerifyCallback: ((err, user?, info?) => void)

    Type declaration

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

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

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +VerifyCallback | adonix
    VerifyCallback: ((err, user?, info?) => void)

    Type declaration

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

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

        Returns void

    Generated using TypeDoc

    \ No newline at end of file