-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added grantFullAccessIfAuthUserRelated()
- fixed typings of fullAccessRoleMap
- Loading branch information
Showing
5 changed files
with
127 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
112 changes: 112 additions & 0 deletions
112
packages/firebase/src/lib/common/model/permission/permission.service.grant.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| import { fullAccessRoleMap, GrantedRoleMap, noAccessRoleMap } from '@dereekb/model'; | ||
| import { AsyncDecisionFunction, Getter, GetterOrValue, getValueFromGetter, Maybe, PromiseOrValue } from '@dereekb/util'; | ||
| import { FirebaseModelContext } from '../context'; | ||
| import { UserRelated } from '../../../model/user'; | ||
|
|
||
| // MARK: Admin | ||
| /** | ||
| * Convenience function that checks the input context if the user is an admin or grants all roles. | ||
| */ | ||
| export const grantFullAccessIfAdmin: GeneralGrantRolesIfFunction = grantModelRolesIfAdminFunction(fullAccessRoleMap); | ||
|
|
||
| export function grantModelRolesIfAdmin<R extends string = string>(context: FirebaseModelContext, rolesToGrantToAdmin: GetterOrValue<GrantedRoleMap<R>>, otherwise?: GrantRolesOtherwiseFunction<R>): PromiseOrValue<GrantedRoleMap<R>> { | ||
| return grantModelRolesIfAdminFunction(rolesToGrantToAdmin)(context, otherwise); | ||
| } | ||
|
|
||
| /** | ||
| * Convenience function that checks the input context if the user is an admin or not and grants pre-set admin roles if they are. | ||
| * | ||
| * @param context | ||
| * @param rolesToGrantToAdmin | ||
| * @param otherwise | ||
| * @returns | ||
| */ | ||
| export function grantModelRolesIfAdminFunction<R extends string = string>(rolesToGrantToAdmin: GetterOrValue<GrantedRoleMap<R>>): GrantRolesIfFunction<FirebaseModelContext, R> { | ||
| return grantModelRolesIfFunction(isAdminInFirebaseModelContext, rolesToGrantToAdmin); | ||
| } | ||
|
|
||
| /** | ||
| * DecisionFunction for a FirebaseModelContext that checks if the current user is an admin. | ||
| * | ||
| * @param context | ||
| * @returns | ||
| */ | ||
| export const isAdminInFirebaseModelContext: AsyncDecisionFunction<FirebaseModelContext> = (context: FirebaseModelContext) => context.auth?.isAdmin() ?? false; | ||
|
|
||
| // MARK: User Related | ||
| export type UserRelatedModelFirebaseModelContext<T extends UserRelated = UserRelated> = { | ||
| model: T; | ||
| context: FirebaseModelContext; | ||
| }; | ||
|
|
||
| /** | ||
| * Convenience function that checks the input context if the user is related to the model by uid. | ||
| */ | ||
| export const grantFullAccessIfAuthUserRelated: GeneralGrantRolesIfFunction = grantModelRolesIfAdminFunction(fullAccessRoleMap); | ||
|
|
||
| /** | ||
| * Creates a GrantRolesIfFunction that grants roles if the user is related to the model by uid. | ||
| * | ||
| * @param context | ||
| * @param rolesToGrant | ||
| * @param otherwise | ||
| * @returns | ||
| */ | ||
| export function grantModelRolesIfAuthUserRelatedModelFunction<T extends UserRelated, R extends string = string>(rolesToGrant: GetterOrValue<GrantedRoleMap<R>>): GrantRolesIfFunction<UserRelatedModelFirebaseModelContext<T>, R> { | ||
| return grantModelRolesIfFunction(isOwnerOfUserRelatedModelInFirebaseModelContext, rolesToGrant); | ||
| } | ||
|
|
||
| /** | ||
| * DecisionFunction for a FirebaseModelContext that checks if the user is related to the model by uid. | ||
| * | ||
| * @param context | ||
| * @returns | ||
| */ | ||
| export const isOwnerOfUserRelatedModelInFirebaseModelContext: AsyncDecisionFunction<UserRelatedModelFirebaseModelContext<UserRelated>> = ({ context, model }: UserRelatedModelFirebaseModelContext) => context.auth?.uid === model.uid; | ||
|
|
||
| // MARK: Grant Roles | ||
| /** | ||
| * Grants the configured roles if the decision is made about the context. Otherwise, returns a NoAccessRoleMap. | ||
| */ | ||
| export type GrantRolesOnlyIfFunction<C, R extends string = string> = (context: C) => Promise<GrantedRoleMap<R>>; | ||
| export type GeneralGrantRolesOnlyIfFunction = <C, R extends string = string>(context: C) => Promise<GrantedRoleMap<R>>; | ||
|
|
||
| /** | ||
| * Creates a GrantRolesOnlyIfFunction | ||
| * | ||
| * @param grantIf | ||
| * @param grantedRoles | ||
| * @returns | ||
| */ | ||
| export function grantModelRolesOnlyIfFunction<C, R extends string = string>(grantIf: AsyncDecisionFunction<C>, grantedRoles: GetterOrValue<GrantedRoleMap<R>>): GrantRolesOnlyIfFunction<C, R> { | ||
| const fn = grantModelRolesIfFunction<C, R>(grantIf, grantedRoles); | ||
| return (context: C) => fn(context); | ||
| } | ||
|
|
||
| /** | ||
| * Grants the configured roles if the decision is made about the context. Otherwise, invokes the otherwise function if available, or returns a NoAccessRoleMap. | ||
| */ | ||
| export type GrantRolesIfFunction<C, R extends string = string> = (context: C, otherwise?: GrantRolesOtherwiseFunction<R>) => Promise<GrantedRoleMap<R>>; | ||
| export type GeneralGrantRolesIfFunction = <C, R extends string = string>(context: C, otherwise?: GrantRolesOtherwiseFunction<R>) => Promise<GrantedRoleMap<R>>; | ||
|
|
||
| /** | ||
| * Used as the "else" statement for grantModelRolesIfFunction. | ||
| * | ||
| * If no roles are returned, the grantModelRolesIfFunction() will return a NoAccessRoleMap. | ||
| */ | ||
| export type GrantRolesOtherwiseFunction<R extends string = string> = Getter<Maybe<PromiseOrValue<GrantedRoleMap<R>>>>; | ||
|
|
||
| /** | ||
| * Creates a GrantRolesIfFunction. | ||
| * | ||
| * @param grantIf | ||
| * @param grantedRoles | ||
| * @returns | ||
| */ | ||
| export function grantModelRolesIfFunction<C, R extends string = string>(grantIf: AsyncDecisionFunction<C>, grantedRoles: GetterOrValue<GrantedRoleMap<R>>): GrantRolesIfFunction<C, R> { | ||
| return async (context: C, otherwise: GrantRolesOtherwiseFunction<R> = noAccessRoleMap) => { | ||
| const decision = await grantIf(context); | ||
| const results = decision ? await getValueFromGetter(grantedRoles) : (await otherwise()) ?? noAccessRoleMap(); | ||
| return results; | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters