Class OrgUserDataService

Description

Service for creating and managing organization users

Index

Constructors

Methods

deleteOrganizationUser expandOrganizationUsers getAllOrganizationUsers getUserOrganizationRole isOrganizationAdmin isOrganizationGuest isOrganizationLastOwner isOrganizationMember isOrganizationOwner isUserInOrganization listPaginatedOrganizationUsers setLogger upsertOrganizationUsers

Properties

db logger orgRepository userAPI COLLECTION_ORGANIZATION

Constructors

constructor

new OrgUserDataService(dependencies): OrgUserDataService
Parameters
- dependencies: {
  db: Db;
  userAPI: UserDefaultAdapterAPI;
  }
  - db: Db
  - userAPI: UserDefaultAdapterAPI
Returns OrgUserDataService
- Defined in adapter/default/dataServices/orgUser.dataService.ts:31

Methods

deleteOrganizationUser

deleteOrganizationUser(orgId, userId): Promise<boolean>
Delete a user from an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<boolean>
true if the operation is successful
- Defined in adapter/default/dataServices/orgUser.dataService.ts:172

expandOrganizationUsers

expandOrganizationUsers(userList, expandExpression?): Promise<(Partial<UserResponse> & OrganizationUser)[]>
Expand organization users with user information from the user service
Parameters
- userList: OrganizationUser[]
  list of organization users
- Optional expandExpression: Expand
  expand expression (list of expands to apply)
Returns Promise<(Partial<UserResponse> & OrganizationUser)[]>
- Defined in adapter/default/dataServices/orgUser.dataService.ts:128

getAllOrganizationUsers

getAllOrganizationUsers(orgId): Promise<{
id: string;
role: "owner" | "admin" | "member" | "guest";
}[]>
Read all users of an organization. As this data is not in a seprate collection, we need to read the organization and get the users from it.
Parameters
- orgId: string
  organization id
Returns Promise<{
id: string;
role: "owner" | "admin" | "member" | "guest";
}[]>
all users of the organization
- Defined in adapter/default/dataServices/orgUser.dataService.ts:89

getUserOrganizationRole

getUserOrganizationRole(orgId, userId): Promise<undefined | string>
Get a user's role in an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<undefined | string>
user's role in the organization, or undefined if not found
- Defined in adapter/default/dataServices/orgUser.dataService.ts:198

isOrganizationAdmin

isOrganizationAdmin(orgId, userId): Promise<boolean>
Test if user is an admin of an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<boolean>
true if user has the admin role in the organization
- Defined in adapter/default/dataServices/orgUser.dataService.ts:256

isOrganizationGuest

isOrganizationGuest(orgId, userId): Promise<boolean>
Test if user is a guest of an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<boolean>
true if user has the guest role in the organization
- Defined in adapter/default/dataServices/orgUser.dataService.ts:286

isOrganizationLastOwner

isOrganizationLastOwner(orgId, userId): Promise<boolean>
Test if user is the last owner of an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<boolean>
true if the organization only has one owner, and it is the user
- Defined in adapter/default/dataServices/orgUser.dataService.ts:301

isOrganizationMember

isOrganizationMember(orgId, userId): Promise<boolean>
Test if user is a member of an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<boolean>
true if user has the member role in the organization
- Defined in adapter/default/dataServices/orgUser.dataService.ts:271

isOrganizationOwner

isOrganizationOwner(orgId, userId): Promise<boolean>
Test if user is the owner of an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<boolean>
true if user has the owner role in the organization
- Defined in adapter/default/dataServices/orgUser.dataService.ts:241

isUserInOrganization

isUserInOrganization(orgId, userId): Promise<boolean>
Test if user belongs to an organization
Parameters
- orgId: string
  organization id
- userId: string
  user id
Returns Promise<boolean>
true if user belongs to the organization
- Defined in adapter/default/dataServices/orgUser.dataService.ts:226

listPaginatedOrganizationUsers

listPaginatedOrganizationUsers(orgId, offset, limit): Promise<{
    count: number;
    result: OrganizationUser[];
    total: number;
}>
List all users of an organization with a mock pagination. This is a mock pagination as the data is not stored in a separate collection, and the API is not truly paginated nor supports filtering.
Parameters
- orgId: string
  organization id
- offset: number
  offset for pagination
- limit: number
  limit for pagination
Returns Promise<{
    count: number;
    result: OrganizationUser[];
    total: number;
}>
all users of the organization
- Defined in adapter/default/dataServices/orgUser.dataService.ts:105

setLogger

setLogger(logger): void
Set logger for the service
Parameters
- logger: Logger
  logger
Returns void
- Defined in adapter/default/dataServices/orgUser.dataService.ts:45

upsertOrganizationUsers

upsertOrganizationUsers(orgId, users): Promise<boolean>
Insert or update organization users for an organization. If the user already exists, the role will be updated.
Parameters
- orgId: string
  organization id
- users: OrganizationUser[]
  users to be added or updated
Returns Promise<boolean>
true if the operation is successful
- Defined in adapter/default/dataServices/orgUser.dataService.ts:56

Properties

`Private` db

db: Db

`Private` logger

logger: null | Logger

`Private` orgRepository

orgRepository: MongoRepository<OrganizationEntity>

`Private` userAPI

userAPI: UserDefaultAdapterAPI

`Static` `Private` `Readonly` COLLECTION_ORGANIZATION

COLLECTION_ORGANIZATION: "organizations" = 'organizations'

Class OrgUserDataService

Description

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

dependencies: { db: Db; userAPI: UserDefaultAdapterAPI; }

db: Db

userAPI: UserDefaultAdapterAPI

Returns OrgUserDataService

Methods

deleteOrganizationUser

Parameters

orgId: string

userId: string

Returns Promise<boolean>

expandOrganizationUsers

Parameters

userList: OrganizationUser[]

Optional expandExpression: Expand

Returns Promise<(Partial<UserResponse> & OrganizationUser)[]>

getAllOrganizationUsers

Parameters

orgId: string

Returns Promise<{ id: string; role: "owner" | "admin" | "member" | "guest"; }[]>

getUserOrganizationRole

Parameters

orgId: string

userId: string

Returns Promise<undefined | string>

isOrganizationAdmin

Parameters

orgId: string

userId: string

Returns Promise<boolean>

isOrganizationGuest

Parameters

orgId: string

userId: string

Returns Promise<boolean>

isOrganizationLastOwner

Parameters

orgId: string

userId: string

Returns Promise<boolean>

isOrganizationMember

Parameters

orgId: string

userId: string

Returns Promise<boolean>

isOrganizationOwner

Parameters

orgId: string

userId: string

Returns Promise<boolean>

isUserInOrganization

Parameters

orgId: string

userId: string

Returns Promise<boolean>

listPaginatedOrganizationUsers

Parameters

orgId: string

offset: number

limit: number

Returns Promise<{ count: number; result: OrganizationUser[]; total: number; }>

setLogger

Parameters

logger: Logger

Returns void

upsertOrganizationUsers

Parameters

orgId: string

users: OrganizationUser[]

Returns Promise<boolean>

Properties

Private db

dependencies: {
db: Db;
userAPI: UserDefaultAdapterAPI;
}

`Optional` expandExpression: Expand

Returns Promise<{
id: string;
role: "owner" | "admin" | "member" | "guest";
}[]>

Returns Promise<{
count: number;
result: OrganizationUser[];
total: number;
}>

`Private` db

`Private` logger

`Private` orgRepository

`Private` userAPI

`Static` `Private` `Readonly` COLLECTION_ORGANIZATION