@stevenkellner/team-conduct-api 1.0.27 → 1.0.28

package/lib/src/checkAuthentication.d.ts

@@ -1,2 +1,6 @@
 import { Team, User, UserRole } from './types';
-export declare function checkAuthentication(rawUserId: string | null, teamId: Team.Id, ...roles: UserRole[]): Promise<User.Id>;
+type ExpectedUserRoles = UserRole | ExpectedUserRoles[] | {
+    anyOf: ExpectedUserRoles[];
+};
+export declare function checkAuthentication(rawUserId: string | null, teamId: Team.Id, roles: ExpectedUserRoles): Promise<User.Id>;
+export {};

package/lib/src/checkAuthentication.js

@@ -4,10 +4,15 @@ exports.checkAuthentication = checkAuthentication;
 const firebase_function_1 = require("@stevenkellner/firebase-function");
 const types_1 = require("./types");
 const Firestore_1 = require("./Firestore");
-function includesAll(array, ...values) {
-    return values.every(value => array.includes(value));
+function hasUserRoles(userRoles, expectedRoles) {
+    if (Array.isArray(expectedRoles))
+        return expectedRoles.every(expectedRole => hasUserRoles(userRoles, expectedRole));
+    else if (typeof expectedRoles === 'object' && 'anyOf' in expectedRoles)
+        return expectedRoles.anyOf.some(role => hasUserRoles(userRoles, role));
+    else
+        return userRoles.includes(expectedRoles);
 }
-async function checkAuthentication(rawUserId, teamId, ...roles) {
+async function checkAuthentication(rawUserId, teamId, roles) {
     if (rawUserId === null)
         throw new firebase_function_1.FunctionsError('unauthenticated', 'User is not authenticated');
     const userId = types_1.User.Id.builder.build(rawUserId);
@@ -24,7 +29,7 @@ async function checkAuthentication(rawUserId, teamId, ...roles) {
     const person = types_1.Person.builder.build(personSnapshot.data);
     if (person.signInProperties === null)
         throw new firebase_function_1.FunctionsError('permission-denied', 'Person is not signed in');
-    const userHasRoles = includesAll(person.signInProperties.roles, ...roles);
+    const userHasRoles = hasUserRoles(person.signInProperties.roles, roles);
     if (!userHasRoles)
         throw new firebase_function_1.FunctionsError('permission-denied', 'User does not have the required roles');
     return userId;

package/lib/src/functions/fine/add.js

@@ -16,7 +16,9 @@ class FineAddFunction extends firebase_function_1.FirebaseFunction {
     });
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
     async execute(parameters) {
-        await (0, checkAuthentication_1.checkAuthentication)(this.userId, parameters.teamId, 'fine-manager');
+        await (0, checkAuthentication_1.checkAuthentication)(this.userId, parameters.teamId, {
+            anyOf: ['fine-manager', 'fine-can-add']
+        });
         const fineSnapshot = await Firestore_1.Firestore.shared.fine(parameters.teamId, parameters.fine.id).snapshot();
         if (fineSnapshot.exists)
             throw new firebase_function_1.FunctionsError('already-exists', 'Fine already exists');

package/lib/src/locales/de.d.ts

@@ -61,6 +61,7 @@ export declare const localizationDE: {
         personManager: string;
         fineTemplateManager: string;
         fineManager: string;
+        fineCanAdd: string;
         teamManager: string;
     };
 };

package/lib/src/locales/de.js

@@ -94,6 +94,7 @@ exports.localizationDE = {
         personManager: 'Personenmanager',
         fineTemplateManager: 'Strafvorlagenmanager',
         fineManager: 'Strafenmanager',
+        fineCanAdd: 'Kann Strafen hinzufügen',
         teamManager: 'Teammanager'
     }
 };

package/lib/src/locales/en.d.ts

@@ -61,6 +61,7 @@ export declare const localizationEN: {
         personManager: string;
         fineTemplateManager: string;
         fineManager: string;
+        fineCanAdd: string;
         teamManager: string;
     };
 };

package/lib/src/locales/en.js

@@ -94,6 +94,7 @@ exports.localizationEN = {
         personManager: 'Person Manager',
         fineTemplateManager: 'Fine Template Manager',
         fineManager: 'Fine Manager',
+        fineCanAdd: 'Can add fines',
         teamManager: 'Team Manager'
     }
 };

package/lib/src/types/Localization.d.ts

@@ -62,6 +62,7 @@ export declare const localizations: {
             personManager: string;
             fineTemplateManager: string;
             fineManager: string;
+            fineCanAdd: string;
             teamManager: string;
         };
     };
@@ -127,6 +128,7 @@ export declare const localizations: {
             personManager: string;
             fineTemplateManager: string;
             fineManager: string;
+            fineCanAdd: string;
             teamManager: string;
         };
     };
@@ -213,6 +215,7 @@ export declare class Localization {
             personManager: ValueLocalization;
             fineTemplateManager: ValueLocalization;
             fineManager: ValueLocalization;
+            fineCanAdd: ValueLocalization;
             teamManager: ValueLocalization;
         };
     };

package/lib/src/types/UserRole.d.ts

@@ -1,5 +1,5 @@
 import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-export type UserRole = 'person-manager' | 'fineTemplate-manager' | 'fine-manager' | 'team-manager';
+export type UserRole = 'person-manager' | 'fineTemplate-manager' | 'fine-manager' | 'fine-can-add' | 'team-manager';
 export declare namespace UserRole {
     const all: UserRole[];
     function formatted(role: UserRole): string;

package/lib/src/types/UserRole.js

@@ -9,6 +9,7 @@ var UserRole;
         'person-manager',
         'fineTemplate-manager',
         'fine-manager',
+        'fine-can-add',
         'team-manager'
     ];
     function formatted(role) {
@@ -16,6 +17,7 @@ var UserRole;
             'person-manager': 'personManager',
             'fineTemplate-manager': 'fineTemplateManager',
             'fine-manager': 'fineManager',
+            'fine-can-add': 'fineCanAdd',
             'team-manager': 'teamManager'
         };
         return Localization_1.Localization.shared.userRole[localizationKeyMap[role]].value();

package/lib/test/localization.de.test.js

@@ -135,6 +135,12 @@ describe('Localization for de', () => {
         it('userRole.fineManager should be formatted correctly', () => {
             (0, core_1.expect)(types_1.UserRole.formatted('fine-manager')).toBeEqual('Strafenmanager');
         });
+        it('userRole.fineCanAdd should be tested', () => {
+            (0, core_1.expect)(types_1.Localization.shared.userRole.fineCanAdd.value()).toBeEqual('Kann Strafen hinzufügen');
+        });
+        it('userRole.fineCanAdd should be formatted correctly', () => {
+            (0, core_1.expect)(types_1.UserRole.formatted('fine-can-add')).toBeEqual('Kann Strafen hinzufügen');
+        });
         it('userRole.teamManager should be tested', () => {
             (0, core_1.expect)(types_1.Localization.shared.userRole.teamManager.value()).toBeEqual('Teammanager');
         });

package/lib/test/localization.en.test.js

@@ -129,6 +129,12 @@ describe('Localization for en', () => {
         it('userRole.fineManager should be formatted correctly', () => {
             (0, core_1.expect)(types_1.UserRole.formatted('fine-manager')).toBeEqual('Fine Manager');
         });
+        it('userRole.fineCanAdd should be tested', () => {
+            (0, core_1.expect)(types_1.Localization.shared.userRole.fineCanAdd.value()).toBeEqual('Can add fines');
+        });
+        it('userRole.fineCanAdd should be formatted correctly', () => {
+            (0, core_1.expect)(types_1.UserRole.formatted('fine-can-add')).toBeEqual('Can add fines');
+        });
         it('userRole.teamManager should be tested', () => {
             (0, core_1.expect)(types_1.Localization.shared.userRole.teamManager.value()).toBeEqual('Team Manager');
         });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stevenkellner/team-conduct-api",
-    "version": "1.0.27",
+    "version": "1.0.28",
     "description": "Firebase API for Team Conduct",
     "license": "MIT",
     "author": "Steven Kellner",

package/src/checkAuthentication.ts

@@ -2,11 +2,24 @@ import { FunctionsError } from '@stevenkellner/firebase-function';
 import { Person, Team, User, UserRole } from './types';
 import { Firestore } from './Firestore';
 
-function includesAll<T>(array: T[], ...values: T[]): boolean {
-    return values.every(value => array.includes(value));
+type ExpectedUserRoles =
+    | UserRole
+    | ExpectedUserRoles[]
+    | {
+        anyOf: ExpectedUserRoles[];
+    }
+
+function hasUserRoles(userRoles: UserRole[], expectedRoles: ExpectedUserRoles): boolean {
+    if (Array.isArray(expectedRoles))
+        return expectedRoles.every(expectedRole => hasUserRoles(userRoles, expectedRole));
+    else if (typeof expectedRoles === 'object' && 'anyOf' in expectedRoles)
+        return expectedRoles.anyOf.some(role => hasUserRoles(userRoles, role));
+    else
+        return userRoles.includes(expectedRoles);
+
 }
 
-export async function checkAuthentication(rawUserId: string | null, teamId: Team.Id, ...roles: UserRole[]): Promise<User.Id> {
+export async function checkAuthentication(rawUserId: string | null, teamId: Team.Id, roles: ExpectedUserRoles): Promise<User.Id> {
     if (rawUserId === null)
         throw new FunctionsError('unauthenticated', 'User is not authenticated');
     const userId = User.Id.builder.build(rawUserId);
@@ -28,7 +41,7 @@ export async function checkAuthentication(rawUserId: string | null, teamId: Team
     if (person.signInProperties === null)
         throw new FunctionsError('permission-denied', 'Person is not signed in');
 
-    const userHasRoles = includesAll(person.signInProperties.roles, ...roles);
+    const userHasRoles = hasUserRoles(person.signInProperties.roles, roles);
     if (!userHasRoles)
         throw new FunctionsError('permission-denied', 'User does not have the required roles');
 

package/src/functions/fine/add.ts

@@ -29,7 +29,9 @@ export class FineAddFunction extends FirebaseFunction<FineAddFunction.Parameters
 
     public async execute(parameters: FineAddFunction.Parameters): Promise<void> {
 
-        await checkAuthentication(this.userId, parameters.teamId, 'fine-manager');
+        await checkAuthentication(this.userId, parameters.teamId, {
+            anyOf: ['fine-manager', 'fine-can-add']
+        });
 
         const fineSnapshot = await Firestore.shared.fine(parameters.teamId, parameters.fine.id).snapshot();
         if (fineSnapshot.exists)

package/src/locales/de.ts

@@ -92,6 +92,7 @@ export const localizationDE = {
         personManager: 'Personenmanager',
         fineTemplateManager: 'Strafvorlagenmanager',
         fineManager: 'Strafenmanager',
+        fineCanAdd: 'Kann Strafen hinzufügen',
         teamManager: 'Teammanager'
     }
 }

package/src/locales/en.ts

@@ -92,6 +92,7 @@ export const localizationEN = {
         personManager: 'Person Manager',
         fineTemplateManager: 'Fine Template Manager',
         fineManager: 'Fine Manager',
+        fineCanAdd: 'Can add fines',
         teamManager: 'Team Manager'
     }
 }

package/src/types/UserRole.ts

@@ -5,6 +5,7 @@ export type UserRole =
     | 'person-manager'
     | 'fineTemplate-manager'
     | 'fine-manager'
+    | 'fine-can-add'
     | 'team-manager';
 
 export namespace UserRole {
@@ -13,6 +14,7 @@ export namespace UserRole {
         'person-manager',
         'fineTemplate-manager',
         'fine-manager',
+        'fine-can-add',
         'team-manager'
     ];
 
@@ -21,6 +23,7 @@ export namespace UserRole {
             'person-manager': 'personManager',
             'fineTemplate-manager': 'fineTemplateManager',
             'fine-manager': 'fineManager',
+            'fine-can-add': 'fineCanAdd',
             'team-manager': 'teamManager'
         }
         return Localization.shared.userRole[localizationKeyMap[role]].value();