@stevenkellner/team-conduct-api 1.0.28 → 1.0.30

package/lib/src/Firestore.d.ts

@@ -1,6 +1,6 @@
 import { FirestoreDocument } from '@stevenkellner/firebase-function';
 import { FirestoreScheme } from './FirestoreScheme';
-import { Fine, FineTemplate, Invitation, Person, User, Team } from './types';
+import { Fine, FineTemplate, UserInvitation, Person, User, Team } from './types';
 export declare class Firestore {
     protected base: FirestoreScheme;
     protected constructor();
@@ -8,7 +8,7 @@ export declare class Firestore {
     static get shared(): Firestore;
     team(id: Team.Id): FirestoreDocument<Team>;
     user(id: User.Id): FirestoreDocument<User>;
-    invitation(id: Invitation.Id): FirestoreDocument<Invitation>;
+    userInvitation(id: UserInvitation.Id): FirestoreDocument<UserInvitation>;
     person(teamId: Team.Id, id: Person.Id): FirestoreDocument<Person>;
     fineTemplate(teamId: Team.Id, id: FineTemplate.Id): FirestoreDocument<FineTemplate>;
     fine(teamId: Team.Id, id: Fine.Id): FirestoreDocument<Fine>;

package/lib/src/Firestore.js

@@ -23,9 +23,9 @@ class Firestore {
             .collection('users')
             .document(id.value);
     }
-    invitation(id) {
+    userInvitation(id) {
         return this.base
-            .collection('invitations')
+            .collection('userInvitations')
             .document(id.value);
     }
     person(teamId, id) {

package/lib/src/FirestoreScheme.d.ts

@@ -1,11 +1,11 @@
 import { FirestoreCollection, FirestoreDocument } from '@stevenkellner/firebase-function';
-import { Fine, FineTemplate, Invitation, Person, Team, User } from './types';
+import { Fine, FineTemplate, UserInvitation, Person, Team, User } from './types';
 export type FirestoreScheme = FirestoreDocument<never, {
     users: FirestoreCollection<{
         [UserId in string]: FirestoreDocument<User>;
     }>;
-    invitations: FirestoreCollection<{
-        [InvitationId in string]: FirestoreDocument<Invitation>;
+    userInvitations: FirestoreCollection<{
+        [UserInvitationId in string]: FirestoreDocument<UserInvitation>;
     }>;
     teams: FirestoreCollection<{
         [TeamId in string]: FirestoreDocument<Team, {

package/lib/src/firebaseFunctionsContext.d.ts

@@ -1,9 +1,10 @@
-import { TeamNewFunction, UserRoleEditFunction, PaypalMeEditFunction, NotificationRegisterFunction, NotificationSubscribeFunction, PersonAddFunction, PersonDeleteFunction, PersonUpdateFunction, FineTemplateAddFunction, FineTemplateDeleteFunction, FineTemplateUpdateFunction, FineAddFunction, FineDeleteFunction, FineUpdateFunction } from './functions';
+import { TeamNewFunction, UserKickoutFunction, UserRoleEditFunction, PaypalMeEditFunction, NotificationRegisterFunction, NotificationSubscribeFunction, PersonAddFunction, PersonDeleteFunction, PersonUpdateFunction, FineTemplateAddFunction, FineTemplateDeleteFunction, FineTemplateUpdateFunction, FineAddFunction, FineDeleteFunction, FineUpdateFunction } from './functions';
 export declare const firebaseFunctionsContext: {
     team: {
         new: import("@stevenkellner/firebase-function").FirebaseFunctionContext<TeamNewFunction.Parameters, import("./types").User>;
     };
     user: {
+        kickout: import("@stevenkellner/firebase-function").FirebaseFunctionContext<UserKickoutFunction.Parameters, void>;
         login: import("@stevenkellner/firebase-function").FirebaseFunctionContext<null, import("./types").User>;
         roleEdit: import("@stevenkellner/firebase-function").FirebaseFunctionContext<UserRoleEditFunction.Parameters, void>;
     };
@@ -14,10 +15,10 @@ export declare const firebaseFunctionsContext: {
         register: import("@stevenkellner/firebase-function").FirebaseFunctionContext<NotificationRegisterFunction.Parameters, void>;
         subscribe: import("@stevenkellner/firebase-function").FirebaseFunctionContext<NotificationSubscribeFunction.Parameters, void>;
     };
-    invitation: {
-        invite: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("./types").Invitation, import("./types").Invitation.Id>;
-        withdraw: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("./types").Invitation, void>;
-        register: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("./types").Invitation.Id, import("./types").User>;
+    userInvitation: {
+        invite: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("./types").UserInvitation, import("./types").UserInvitation.Id>;
+        withdraw: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("./types").UserInvitation, void>;
+        register: import("@stevenkellner/firebase-function").FirebaseFunctionContext<import("./types").UserInvitation.Id, import("./types").User>;
     };
     person: {
         add: import("@stevenkellner/firebase-function").FirebaseFunctionContext<PersonAddFunction.Parameters, void>;

package/lib/src/firebaseFunctionsContext.js

@@ -8,6 +8,7 @@ exports.firebaseFunctionsContext = firebase_function_1.FirebaseFunctionsContext.
         new: builder.function(functions_1.TeamNewFunction)
     },
     user: {
+        kickout: builder.function(functions_1.UserKickoutFunction),
         login: builder.function(functions_1.UserLoginFunction),
         roleEdit: builder.function(functions_1.UserRoleEditFunction)
     },
@@ -18,10 +19,10 @@ exports.firebaseFunctionsContext = firebase_function_1.FirebaseFunctionsContext.
         register: builder.function(functions_1.NotificationRegisterFunction),
         subscribe: builder.function(functions_1.NotificationSubscribeFunction)
     },
-    invitation: {
-        invite: builder.function(functions_1.InvitationInviteFunction),
-        withdraw: builder.function(functions_1.InvitationWithdrawFunction),
-        register: builder.function(functions_1.InvitationRegisterFunction)
+    userInvitation: {
+        invite: builder.function(functions_1.UserInvitationInviteFunction),
+        withdraw: builder.function(functions_1.UserInvitationWithdrawFunction),
+        register: builder.function(functions_1.UserInvitationRegisterFunction)
     },
     person: {
         add: builder.function(functions_1.PersonAddFunction),

package/lib/src/functions/index.d.ts

@@ -1,12 +1,13 @@
 export * from './team/new';
 export * from './user/login';
 export * from './user/roleEdit';
+export * from './user/kickout';
 export * from './paypalMe/edit';
 export * from './notification/register';
 export * from './notification/subscribe';
-export * from './invitation/invite';
-export * from './invitation/withdraw';
-export * from './invitation/register';
+export * from './userInvitation/invite';
+export * from './userInvitation/withdraw';
+export * from './userInvitation/register';
 export * from './person/add';
 export * from './person/update';
 export * from './person/delete';

package/lib/src/functions/index.js

@@ -17,12 +17,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./team/new"), exports);
 __exportStar(require("./user/login"), exports);
 __exportStar(require("./user/roleEdit"), exports);
+__exportStar(require("./user/kickout"), exports);
 __exportStar(require("./paypalMe/edit"), exports);
 __exportStar(require("./notification/register"), exports);
 __exportStar(require("./notification/subscribe"), exports);
-__exportStar(require("./invitation/invite"), exports);
-__exportStar(require("./invitation/withdraw"), exports);
-__exportStar(require("./invitation/register"), exports);
+__exportStar(require("./userInvitation/invite"), exports);
+__exportStar(require("./userInvitation/withdraw"), exports);
+__exportStar(require("./userInvitation/register"), exports);
 __exportStar(require("./person/add"), exports);
 __exportStar(require("./person/update"), exports);
 __exportStar(require("./person/delete"), exports);

package/lib/src/functions/user/kickout.d.ts

@@ -0,0 +1,17 @@
+import { FirebaseFunction } from '@stevenkellner/firebase-function';
+import { Team, User } from '../../types';
+import { ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
+export declare namespace UserKickoutFunction {
+    type Parameters = {
+        teamId: Team.Id;
+        userId: User.Id;
+    };
+}
+export declare class UserKickoutFunction extends FirebaseFunction<UserKickoutFunction.Parameters, void> {
+    parametersBuilder: ObjectTypeBuilder<{
+        teamId: string;
+        userId: string;
+    }, UserKickoutFunction.Parameters>;
+    returnTypeBuilder: ValueTypeBuilder<void>;
+    execute(parameters: UserKickoutFunction.Parameters): Promise<void>;
+}

package/lib/src/functions/user/kickout.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserKickoutFunction = void 0;
+const firebase_function_1 = require("@stevenkellner/firebase-function");
+const types_1 = require("../../types");
+const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
+const Firestore_1 = require("../../Firestore");
+const checkAuthentication_1 = require("../../checkAuthentication");
+class UserKickoutFunction extends firebase_function_1.FirebaseFunction {
+    parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
+        teamId: types_1.Team.Id.builder,
+        userId: types_1.User.Id.builder
+    });
+    returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
+    async execute(parameters) {
+        const userId = await (0, checkAuthentication_1.checkAuthentication)(this.userId, parameters.teamId, 'team-manager');
+        if (userId.guidString === parameters.userId.guidString)
+            throw new firebase_function_1.FunctionsError('invalid-argument', 'You cannot kick yourself out of a team.');
+        const userSnapshot = await Firestore_1.Firestore.shared.user(parameters.userId).snapshot();
+        if (!userSnapshot.exists)
+            throw new firebase_function_1.FunctionsError('not-found', 'User not found.');
+        const user = types_1.User.builder.build(userSnapshot.data);
+        const userTeamProperties = user.teams.getOptional(parameters.teamId);
+        if (userTeamProperties === null)
+            throw new firebase_function_1.FunctionsError('not-found', 'User is not a member of the team.');
+        await Firestore_1.Firestore.shared.person(parameters.teamId, userTeamProperties.personId).remove();
+    }
+}
+exports.UserKickoutFunction = UserKickoutFunction;

package/lib/src/functions/userInvitation/invite.d.ts

@@ -0,0 +1,7 @@
+import { FirebaseFunction } from '@stevenkellner/firebase-function';
+import { UserInvitation } from '../../types';
+export declare class UserInvitationInviteFunction extends FirebaseFunction<UserInvitation, UserInvitation.Id> {
+    parametersBuilder: UserInvitation.TypeBuilder;
+    returnTypeBuilder: import("@stevenkellner/typescript-common-functionality").Tagged.TypeBuilder<string, "userInvitation">;
+    execute(invitation: UserInvitation): Promise<UserInvitation.Id>;
+}

package/lib/src/functions/{invitation → userInvitation}/invite.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvitationInviteFunction = void 0;
+exports.UserInvitationInviteFunction = void 0;
 const firebase_function_1 = require("@stevenkellner/firebase-function");
 const types_1 = require("../../types");
 const checkAuthentication_1 = require("../../checkAuthentication");
 const Firestore_1 = require("../../Firestore");
-class InvitationInviteFunction extends firebase_function_1.FirebaseFunction {
-    parametersBuilder = types_1.Invitation.builder;
-    returnTypeBuilder = types_1.Invitation.Id.builder;
+class UserInvitationInviteFunction extends firebase_function_1.FirebaseFunction {
+    parametersBuilder = types_1.UserInvitation.builder;
+    returnTypeBuilder = types_1.UserInvitation.Id.builder;
     async execute(invitation) {
         await (0, checkAuthentication_1.checkAuthentication)(this.userId, invitation.teamId, 'team-manager');
         const personSnapshot = await Firestore_1.Firestore.shared.person(invitation.teamId, invitation.personId).snapshot();
@@ -16,8 +16,8 @@ class InvitationInviteFunction extends firebase_function_1.FirebaseFunction {
         if (personSnapshot.data.signInProperties !== null)
             throw new firebase_function_1.FunctionsError('already-exists', 'Person already has an account');
         const invitationId = invitation.createId();
-        await Firestore_1.Firestore.shared.invitation(invitationId).set(invitation);
+        await Firestore_1.Firestore.shared.userInvitation(invitationId).set(invitation);
         return invitationId;
     }
 }
-exports.InvitationInviteFunction = InvitationInviteFunction;
+exports.UserInvitationInviteFunction = UserInvitationInviteFunction;

package/lib/src/functions/userInvitation/register.d.ts

@@ -0,0 +1,7 @@
+import { FirebaseFunction } from '@stevenkellner/firebase-function';
+import { UserInvitation, User } from '../../types';
+export declare class UserInvitationRegisterFunction extends FirebaseFunction<UserInvitation.Id, User> {
+    parametersBuilder: import("@stevenkellner/typescript-common-functionality").Tagged.TypeBuilder<string, "userInvitation">;
+    returnTypeBuilder: User.TypeBuilder;
+    execute(invitationId: UserInvitation.Id): Promise<User>;
+}

package/lib/src/functions/{invitation → userInvitation}/register.js

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvitationRegisterFunction = void 0;
+exports.UserInvitationRegisterFunction = void 0;
 const firebase_function_1 = require("@stevenkellner/firebase-function");
 const types_1 = require("../../types");
 const Firestore_1 = require("../../Firestore");
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-class InvitationRegisterFunction extends firebase_function_1.FirebaseFunction {
-    parametersBuilder = types_1.Invitation.Id.builder;
+class UserInvitationRegisterFunction extends firebase_function_1.FirebaseFunction {
+    parametersBuilder = types_1.UserInvitation.Id.builder;
     returnTypeBuilder = types_1.User.builder;
     async execute(invitationId) {
         if (this.userId === null)
             throw new firebase_function_1.FunctionsError('unauthenticated', 'User not authenticated');
         const userId = types_1.User.Id.builder.build(this.userId);
-        const invitationSnapshot = await Firestore_1.Firestore.shared.invitation(invitationId).snapshot();
+        const invitationSnapshot = await Firestore_1.Firestore.shared.userInvitation(invitationId).snapshot();
         if (!invitationSnapshot.exists)
             throw new firebase_function_1.FunctionsError('not-found', 'Invitation not found');
-        const invitation = types_1.Invitation.builder.build(invitationSnapshot.data);
+        const invitation = types_1.UserInvitation.builder.build(invitationSnapshot.data);
         const userSnapshot = await Firestore_1.Firestore.shared.user(userId).snapshot();
         let user = new types_1.User(userId);
         if (userSnapshot.exists)
@@ -32,7 +32,7 @@ class InvitationRegisterFunction extends firebase_function_1.FirebaseFunction {
         const person = types_1.Person.builder.build(personSnapshot.data);
         if (person.signInProperties !== null)
             throw new firebase_function_1.FunctionsError('already-exists', 'Person already registered');
-        await Firestore_1.Firestore.shared.invitation(invitationId).remove();
+        await Firestore_1.Firestore.shared.userInvitation(invitationId).remove();
         user.teams.set(invitation.teamId, new types_1.User.TeamProperties(team.name, invitation.personId));
         await Firestore_1.Firestore.shared.user(userId).set(user);
         person.signInProperties = new types_1.PersonSignInProperties(userId, typescript_common_functionality_1.UtcDate.now);
@@ -40,4 +40,4 @@ class InvitationRegisterFunction extends firebase_function_1.FirebaseFunction {
         return user;
     }
 }
-exports.InvitationRegisterFunction = InvitationRegisterFunction;
+exports.UserInvitationRegisterFunction = UserInvitationRegisterFunction;

package/lib/src/functions/userInvitation/withdraw.d.ts

@@ -0,0 +1,8 @@
+import { FirebaseFunction } from '@stevenkellner/firebase-function';
+import { UserInvitation } from '../../types';
+import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
+export declare class UserInvitationWithdrawFunction extends FirebaseFunction<UserInvitation, void> {
+    parametersBuilder: UserInvitation.TypeBuilder;
+    returnTypeBuilder: ValueTypeBuilder<void>;
+    execute(invitation: UserInvitation): Promise<void>;
+}

package/lib/src/functions/{invitation → userInvitation}/withdraw.js

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvitationWithdrawFunction = void 0;
+exports.UserInvitationWithdrawFunction = void 0;
 const firebase_function_1 = require("@stevenkellner/firebase-function");
 const types_1 = require("../../types");
 const checkAuthentication_1 = require("../../checkAuthentication");
 const Firestore_1 = require("../../Firestore");
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-class InvitationWithdrawFunction extends firebase_function_1.FirebaseFunction {
-    parametersBuilder = types_1.Invitation.builder;
+class UserInvitationWithdrawFunction extends firebase_function_1.FirebaseFunction {
+    parametersBuilder = types_1.UserInvitation.builder;
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
     async execute(invitation) {
         await (0, checkAuthentication_1.checkAuthentication)(this.userId, invitation.teamId, 'team-manager');
         const invitationId = invitation.createId();
-        const invitationSnapshot = await Firestore_1.Firestore.shared.invitation(invitationId).snapshot();
+        const invitationSnapshot = await Firestore_1.Firestore.shared.userInvitation(invitationId).snapshot();
         if (!invitationSnapshot.exists)
             throw new firebase_function_1.FunctionsError('not-found', 'Invitation not found');
-        await Firestore_1.Firestore.shared.invitation(invitationId).remove();
+        await Firestore_1.Firestore.shared.userInvitation(invitationId).remove();
     }
 }
-exports.InvitationWithdrawFunction = InvitationWithdrawFunction;
+exports.UserInvitationWithdrawFunction = UserInvitationWithdrawFunction;

package/lib/src/types/{Invitation.d.ts → UserInvitation.d.ts}

@@ -1,25 +1,25 @@
 import { Flattable, ITypeBuilder, Tagged } from '@stevenkellner/typescript-common-functionality';
 import { Team } from './Team';
 import { Person } from './Person';
-export declare class Invitation implements Flattable<Invitation.Flatten> {
+export declare class UserInvitation implements Flattable<UserInvitation.Flatten> {
     teamId: Team.Id;
     personId: Person.Id;
     constructor(teamId: Team.Id, personId: Person.Id);
-    createId(): Invitation.Id;
-    get flatten(): Invitation.Flatten;
+    createId(): UserInvitation.Id;
+    get flatten(): UserInvitation.Flatten;
 }
-export declare namespace Invitation {
-    type Id = Tagged<string, 'invitation'>;
+export declare namespace UserInvitation {
+    type Id = Tagged<string, 'userInvitation'>;
     namespace Id {
         type Flatten = string;
-        const builder: Tagged.TypeBuilder<string, "invitation">;
+        const builder: Tagged.TypeBuilder<string, "userInvitation">;
     }
     type Flatten = {
         teamId: Team.Id.Flatten;
         personId: Person.Id.Flatten;
     };
-    class TypeBuilder implements ITypeBuilder<Flatten, Invitation> {
-        build(value: Flatten): Invitation;
+    class TypeBuilder implements ITypeBuilder<Flatten, UserInvitation> {
+        build(value: Flatten): UserInvitation;
     }
     const builder: TypeBuilder;
 }

package/lib/src/types/{Invitation.js → UserInvitation.js}

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Invitation = void 0;
+exports.UserInvitation = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
 const Team_1 = require("./Team");
 const Person_1 = require("./Person");
-class Invitation {
+class UserInvitation {
     teamId;
     personId;
     constructor(teamId, personId) {
@@ -17,7 +17,7 @@ class Invitation {
         const personIdBytes = typescript_common_functionality_1.BytesCoder.fromUtf8(this.personId.guidString);
         const hashedInvitationBytes = hasher.hash(new Uint8Array([...teamIdBytes, ...personIdBytes]));
         const rawId = typescript_common_functionality_1.BytesCoder.toHex(hashedInvitationBytes).slice(0, 12);
-        return new typescript_common_functionality_1.Tagged(rawId, 'invitation');
+        return new typescript_common_functionality_1.Tagged(rawId, 'userInvitation');
     }
     get flatten() {
         return {
@@ -26,17 +26,17 @@ class Invitation {
         };
     }
 }
-exports.Invitation = Invitation;
-(function (Invitation) {
+exports.UserInvitation = UserInvitation;
+(function (UserInvitation) {
     let Id;
     (function (Id) {
-        Id.builder = typescript_common_functionality_1.Tagged.builder('invitation', new typescript_common_functionality_1.ValueTypeBuilder());
-    })(Id = Invitation.Id || (Invitation.Id = {}));
+        Id.builder = typescript_common_functionality_1.Tagged.builder('userInvitation', new typescript_common_functionality_1.ValueTypeBuilder());
+    })(Id = UserInvitation.Id || (UserInvitation.Id = {}));
     class TypeBuilder {
         build(value) {
-            return new Invitation(Team_1.Team.Id.builder.build(value.teamId), Person_1.Person.Id.builder.build(value.personId));
+            return new UserInvitation(Team_1.Team.Id.builder.build(value.teamId), Person_1.Person.Id.builder.build(value.personId));
         }
     }
-    Invitation.TypeBuilder = TypeBuilder;
-    Invitation.builder = new TypeBuilder();
-})(Invitation || (exports.Invitation = Invitation = {}));
+    UserInvitation.TypeBuilder = TypeBuilder;
+    UserInvitation.builder = new TypeBuilder();
+})(UserInvitation || (exports.UserInvitation = UserInvitation = {}));

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

@@ -3,7 +3,7 @@ export * from './Fine';
 export * from './FineAmount';
 export * from './FineTemplate';
 export * from './FineTemplateRepetition';
-export * from './Invitation';
+export * from './UserInvitation';
 export * from './Localization';
 export * from './MoneyAmount';
 export * from './NotificationProperties';

package/lib/src/types/index.js

@@ -19,7 +19,7 @@ __exportStar(require("./Fine"), exports);
 __exportStar(require("./FineAmount"), exports);
 __exportStar(require("./FineTemplate"), exports);
 __exportStar(require("./FineTemplateRepetition"), exports);
-__exportStar(require("./Invitation"), exports);
+__exportStar(require("./UserInvitation"), exports);
 __exportStar(require("./Localization"), exports);
 __exportStar(require("./MoneyAmount"), exports);
 __exportStar(require("./NotificationProperties"), exports);

package/lib/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../index.ts","../src/Firestore.ts","../src/FirestoreScheme.ts","../src/checkAuthentication.ts","../src/firebaseFunctionsContext.ts","../src/index.ts","../src/pushNotification.ts","../src/firebase/FirebaseConfiguration.ts","../src/firebase/Messaging.ts","../src/firebase/index.ts","../src/functions/index.ts","../src/functions/fine/add.ts","../src/functions/fine/delete.ts","../src/functions/fine/update.ts","../src/functions/fineTemplate/add.ts","../src/functions/fineTemplate/delete.ts","../src/functions/fineTemplate/update.ts","../src/functions/invitation/invite.ts","../src/functions/invitation/register.ts","../src/functions/invitation/withdraw.ts","../src/functions/notification/register.ts","../src/functions/notification/subscribe.ts","../src/functions/paypalMe/edit.ts","../src/functions/person/add.ts","../src/functions/person/delete.ts","../src/functions/person/update.ts","../src/functions/team/new.ts","../src/functions/user/login.ts","../src/functions/user/roleEdit.ts","../src/locales/de.ts","../src/locales/en.ts","../src/types/Configuration.ts","../src/types/Fine.ts","../src/types/FineAmount.ts","../src/types/FineTemplate.ts","../src/types/FineTemplateRepetition.ts","../src/types/Invitation.ts","../src/types/Localization.ts","../src/types/MoneyAmount.ts","../src/types/NotificationProperties.ts","../src/types/PayedState.ts","../src/types/Person.ts","../src/types/PersonPrivateProperties.ts","../src/types/PersonSignInProperties.ts","../src/types/Pluralization.ts","../src/types/Team.ts","../src/types/User.ts","../src/types/UserRole.ts","../src/types/index.ts","../test/localization-utils.ts","../test/localization.de.test.ts","../test/localization.en.test.ts"],"version":"5.8.3"}
+{"root":["../index.ts","../src/Firestore.ts","../src/FirestoreScheme.ts","../src/checkAuthentication.ts","../src/firebaseFunctionsContext.ts","../src/index.ts","../src/pushNotification.ts","../src/firebase/FirebaseConfiguration.ts","../src/firebase/Messaging.ts","../src/firebase/index.ts","../src/functions/index.ts","../src/functions/fine/add.ts","../src/functions/fine/delete.ts","../src/functions/fine/update.ts","../src/functions/fineTemplate/add.ts","../src/functions/fineTemplate/delete.ts","../src/functions/fineTemplate/update.ts","../src/functions/notification/register.ts","../src/functions/notification/subscribe.ts","../src/functions/paypalMe/edit.ts","../src/functions/person/add.ts","../src/functions/person/delete.ts","../src/functions/person/update.ts","../src/functions/team/new.ts","../src/functions/user/kickout.ts","../src/functions/user/login.ts","../src/functions/user/roleEdit.ts","../src/functions/userInvitation/invite.ts","../src/functions/userInvitation/register.ts","../src/functions/userInvitation/withdraw.ts","../src/locales/de.ts","../src/locales/en.ts","../src/types/Configuration.ts","../src/types/Fine.ts","../src/types/FineAmount.ts","../src/types/FineTemplate.ts","../src/types/FineTemplateRepetition.ts","../src/types/Localization.ts","../src/types/MoneyAmount.ts","../src/types/NotificationProperties.ts","../src/types/PayedState.ts","../src/types/Person.ts","../src/types/PersonPrivateProperties.ts","../src/types/PersonSignInProperties.ts","../src/types/Pluralization.ts","../src/types/Team.ts","../src/types/User.ts","../src/types/UserInvitation.ts","../src/types/UserRole.ts","../src/types/index.ts","../test/localization-utils.ts","../test/localization.de.test.ts","../test/localization.en.test.ts"],"version":"5.8.3"}

package/package.json

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

package/src/Firestore.ts

@@ -1,6 +1,6 @@
 import { FirestoreDocument } from '@stevenkellner/firebase-function';
 import { FirestoreScheme } from './FirestoreScheme';
-import { Fine, FineTemplate, Invitation, Person, User, Team } from './types';
+import { Fine, FineTemplate, UserInvitation, Person, User, Team } from './types';
 import { FirebaseConfiguration } from './firebase';
 
 export class Firestore {
@@ -31,9 +31,9 @@ export class Firestore {
             .document(id.value);
     }
 
-    public invitation(id: Invitation.Id): FirestoreDocument<Invitation> {
+    public userInvitation(id: UserInvitation.Id): FirestoreDocument<UserInvitation> {
         return this.base
-            .collection('invitations')
+            .collection('userInvitations')
             .document(id.value);
     }
 

package/src/FirestoreScheme.ts

@@ -1,12 +1,12 @@
 import { FirestoreCollection, FirestoreDocument } from '@stevenkellner/firebase-function';
-import { Fine, FineTemplate, Invitation, Person, Team, User } from './types';
+import { Fine, FineTemplate, UserInvitation, Person, Team, User } from './types';
 
 export type FirestoreScheme = FirestoreDocument<never, {
     users: FirestoreCollection<{
         [UserId in string]: FirestoreDocument<User>
     }>
-    invitations: FirestoreCollection<{
-        [InvitationId in string]: FirestoreDocument<Invitation>
+    userInvitations: FirestoreCollection<{
+        [UserInvitationId in string]: FirestoreDocument<UserInvitation>
     }>
     teams: FirestoreCollection<{
         [TeamId in string]: FirestoreDocument<Team, {

package/src/firebaseFunctionsContext.ts

@@ -1,7 +1,8 @@
 import { FirebaseFunctionsContext } from '@stevenkellner/firebase-function';
-import { TeamNewFunction, UserLoginFunction, UserRoleEditFunction,
+import { TeamNewFunction,
+    UserKickoutFunction, UserLoginFunction, UserRoleEditFunction,
     PaypalMeEditFunction, NotificationRegisterFunction, NotificationSubscribeFunction,
-    InvitationInviteFunction, InvitationRegisterFunction, InvitationWithdrawFunction,
+    UserInvitationInviteFunction, UserInvitationRegisterFunction, UserInvitationWithdrawFunction,
     PersonAddFunction, PersonDeleteFunction, PersonUpdateFunction,
     FineTemplateAddFunction, FineTemplateDeleteFunction, FineTemplateUpdateFunction,
     FineAddFunction, FineDeleteFunction, FineUpdateFunction
@@ -12,6 +13,7 @@ export const firebaseFunctionsContext = FirebaseFunctionsContext.build(builder =
         new: builder.function(TeamNewFunction)
     },
     user: {
+        kickout: builder.function(UserKickoutFunction),
         login: builder.function(UserLoginFunction),
         roleEdit: builder.function(UserRoleEditFunction)
     },
@@ -22,10 +24,10 @@ export const firebaseFunctionsContext = FirebaseFunctionsContext.build(builder =
         register: builder.function(NotificationRegisterFunction),
         subscribe: builder.function(NotificationSubscribeFunction)
     },
-    invitation: {
-        invite: builder.function(InvitationInviteFunction),
-        withdraw: builder.function(InvitationWithdrawFunction),
-        register: builder.function(InvitationRegisterFunction)
+    userInvitation: {
+        invite: builder.function(UserInvitationInviteFunction),
+        withdraw: builder.function(UserInvitationWithdrawFunction),
+        register: builder.function(UserInvitationRegisterFunction)
     },
     person: {
         add: builder.function(PersonAddFunction),

package/src/functions/index.ts

@@ -2,12 +2,13 @@
 export * from './team/new';
 export * from './user/login';
 export * from './user/roleEdit';
+export * from './user/kickout';
 export * from './paypalMe/edit';
 export * from './notification/register';
 export * from './notification/subscribe';
-export * from './invitation/invite';
-export * from './invitation/withdraw';
-export * from './invitation/register';
+export * from './userInvitation/invite';
+export * from './userInvitation/withdraw';
+export * from './userInvitation/register';
 export * from './person/add';
 export * from './person/update';
 export * from './person/delete';

package/src/functions/user/kickout.ts

@@ -0,0 +1,42 @@
+import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
+import { Team, User } from '../../types';
+import { Flattable, ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
+import { Firestore } from '../../Firestore';
+import { checkAuthentication } from '../../checkAuthentication';
+
+export namespace UserKickoutFunction {
+
+    export type Parameters = {
+        teamId: Team.Id
+        userId: User.Id
+    };
+}
+
+export class UserKickoutFunction extends FirebaseFunction<UserKickoutFunction.Parameters, void> {
+
+    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<UserKickoutFunction.Parameters>, UserKickoutFunction.Parameters>({
+        teamId: Team.Id.builder,
+        userId: User.Id.builder
+    });
+
+    public returnTypeBuilder = new ValueTypeBuilder<void>();
+
+    public async execute(parameters: UserKickoutFunction.Parameters): Promise<void> {
+
+        const userId = await checkAuthentication(this.userId, parameters.teamId, 'team-manager');
+
+        if (userId.guidString === parameters.userId.guidString)
+            throw new FunctionsError('invalid-argument', 'You cannot kick yourself out of a team.');
+
+        const userSnapshot = await Firestore.shared.user(parameters.userId).snapshot();
+        if (!userSnapshot.exists)
+            throw new FunctionsError('not-found', 'User not found.');
+        const user = User.builder.build(userSnapshot.data);
+
+        const userTeamProperties = user.teams.getOptional(parameters.teamId);
+        if (userTeamProperties === null)
+            throw new FunctionsError('not-found', 'User is not a member of the team.');
+
+        await Firestore.shared.person(parameters.teamId, userTeamProperties.personId).remove();
+    }
+}

package/src/functions/user/login.ts

@@ -7,7 +7,6 @@ export class UserLoginFunction extends FirebaseFunction<null, User> {
 
     public parametersBuilder = new ValueTypeBuilder<null>();
 
-
     public returnTypeBuilder = User.builder;
 
     public async execute(): Promise<User> {

package/src/functions/{invitation → userInvitation}/invite.ts

@@ -1,15 +1,15 @@
 import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Invitation } from '../../types';
+import { UserInvitation } from '../../types';
 import { checkAuthentication } from '../../checkAuthentication';
 import { Firestore } from '../../Firestore';
 
-export class InvitationInviteFunction extends FirebaseFunction<Invitation, Invitation.Id> {
+export class UserInvitationInviteFunction extends FirebaseFunction<UserInvitation, UserInvitation.Id> {
 
-    public parametersBuilder = Invitation.builder;
+    public parametersBuilder = UserInvitation.builder;
 
-    public returnTypeBuilder = Invitation.Id.builder;
+    public returnTypeBuilder = UserInvitation.Id.builder;
 
-    public async execute(invitation: Invitation): Promise<Invitation.Id> {
+    public async execute(invitation: UserInvitation): Promise<UserInvitation.Id> {
 
         await checkAuthentication(this.userId, invitation.teamId, 'team-manager');
 
@@ -21,7 +21,7 @@ export class InvitationInviteFunction extends FirebaseFunction<Invitation, Invit
             throw new FunctionsError('already-exists', 'Person already has an account');
 
         const invitationId = invitation.createId();
-        await Firestore.shared.invitation(invitationId).set(invitation);
+        await Firestore.shared.userInvitation(invitationId).set(invitation);
 
         return invitationId;
     }

package/src/functions/{invitation → userInvitation}/register.ts

@@ -1,24 +1,24 @@
 import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Invitation, Person, PersonSignInProperties, Team, User } from '../../types';
+import { UserInvitation, Person, PersonSignInProperties, Team, User } from '../../types';
 import { Firestore } from '../../Firestore';
 import { UtcDate } from '@stevenkellner/typescript-common-functionality';
 
-export class InvitationRegisterFunction extends FirebaseFunction<Invitation.Id, User> {
+export class UserInvitationRegisterFunction extends FirebaseFunction<UserInvitation.Id, User> {
 
-    public parametersBuilder = Invitation.Id.builder;
+    public parametersBuilder = UserInvitation.Id.builder;
 
     public returnTypeBuilder = User.builder;
 
-    public async execute(invitationId: Invitation.Id): Promise<User> {
+    public async execute(invitationId: UserInvitation.Id): Promise<User> {
 
         if (this.userId === null)
             throw new FunctionsError('unauthenticated', 'User not authenticated');
         const userId = User.Id.builder.build(this.userId);
 
-        const invitationSnapshot = await Firestore.shared.invitation(invitationId).snapshot();
+        const invitationSnapshot = await Firestore.shared.userInvitation(invitationId).snapshot();
         if (!invitationSnapshot.exists)
             throw new FunctionsError('not-found', 'Invitation not found');
-        const invitation = Invitation.builder.build(invitationSnapshot.data);
+        const invitation = UserInvitation.builder.build(invitationSnapshot.data);
 
         const userSnapshot = await Firestore.shared.user(userId).snapshot();
         let user = new User(userId);
@@ -41,7 +41,7 @@ export class InvitationRegisterFunction extends FirebaseFunction<Invitation.Id,
         if (person.signInProperties !== null)
             throw new FunctionsError('already-exists', 'Person already registered');
 
-        await Firestore.shared.invitation(invitationId).remove();
+        await Firestore.shared.userInvitation(invitationId).remove();
 
         user.teams.set(invitation.teamId, new User.TeamProperties(team.name, invitation.personId));
         await Firestore.shared.user(userId).set(user);

package/src/functions/{invitation → userInvitation}/withdraw.ts

@@ -1,24 +1,24 @@
 import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Invitation } from '../../types';
+import { UserInvitation } from '../../types';
 import { checkAuthentication } from '../../checkAuthentication';
 import { Firestore } from '../../Firestore';
 import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
 
-export class InvitationWithdrawFunction extends FirebaseFunction<Invitation, void> {
+export class UserInvitationWithdrawFunction extends FirebaseFunction<UserInvitation, void> {
 
-    public parametersBuilder = Invitation.builder;
+    public parametersBuilder = UserInvitation.builder;
 
     public returnTypeBuilder = new ValueTypeBuilder<void>();
 
-    public async execute(invitation: Invitation): Promise<void> {
+    public async execute(invitation: UserInvitation): Promise<void> {
 
         await checkAuthentication(this.userId, invitation.teamId, 'team-manager');
 
         const invitationId = invitation.createId();
-        const invitationSnapshot = await Firestore.shared.invitation(invitationId).snapshot();
+        const invitationSnapshot = await Firestore.shared.userInvitation(invitationId).snapshot();
         if (!invitationSnapshot.exists)
             throw new FunctionsError('not-found', 'Invitation not found');
 
-        await Firestore.shared.invitation(invitationId).remove();
+        await Firestore.shared.userInvitation(invitationId).remove();
     }
 }

package/src/types/{Invitation.ts → UserInvitation.ts}

@@ -2,23 +2,23 @@ import { BytesCoder, Flattable, ITypeBuilder, Sha512, Tagged, ValueTypeBuilder }
 import { Team } from './Team';
 import { Person } from './Person';
 
-export class Invitation implements Flattable<Invitation.Flatten> {
+export class UserInvitation implements Flattable<UserInvitation.Flatten> {
 
     constructor(
         public teamId: Team.Id,
         public personId: Person.Id
     ) {}
 
-    public createId(): Invitation.Id {
+    public createId(): UserInvitation.Id {
         const hasher = new Sha512();
         const teamIdBytes = BytesCoder.fromUtf8(this.teamId.guidString);
         const personIdBytes = BytesCoder.fromUtf8(this.personId.guidString);
         const hashedInvitationBytes = hasher.hash(new Uint8Array([...teamIdBytes, ...personIdBytes]));
         const rawId = BytesCoder.toHex(hashedInvitationBytes).slice(0, 12);
-        return new Tagged(rawId, 'invitation');
+        return new Tagged(rawId, 'userInvitation');
     }
 
-    public get flatten(): Invitation.Flatten {
+    public get flatten(): UserInvitation.Flatten {
         return {
             teamId: this.teamId.flatten,
             personId: this.personId.flatten
@@ -26,15 +26,15 @@ export class Invitation implements Flattable<Invitation.Flatten> {
     }
 }
 
-export namespace Invitation {
+export namespace UserInvitation {
 
-    export type Id = Tagged<string, 'invitation'>;
+    export type Id = Tagged<string, 'userInvitation'>;
 
     export namespace Id {
 
         export type Flatten = string;
 
-        export const builder = Tagged.builder('invitation' as const, new ValueTypeBuilder<string>());
+        export const builder = Tagged.builder('userInvitation' as const, new ValueTypeBuilder<string>());
     }
 
     export type Flatten = {
@@ -42,10 +42,10 @@ export namespace Invitation {
         personId: Person.Id.Flatten
     };
 
-    export class TypeBuilder implements ITypeBuilder<Flatten, Invitation> {
+    export class TypeBuilder implements ITypeBuilder<Flatten, UserInvitation> {
 
-        public build(value: Flatten): Invitation {
-            return new Invitation(
+        public build(value: Flatten): UserInvitation {
+            return new UserInvitation(
                 Team.Id.builder.build(value.teamId),
                 Person.Id.builder.build(value.personId)
             );

package/src/types/index.ts

@@ -3,7 +3,7 @@ export * from './Fine';
 export * from './FineAmount';
 export * from './FineTemplate';
 export * from './FineTemplateRepetition';
-export * from './Invitation';
+export * from './UserInvitation';
 export * from './Localization';
 export * from './MoneyAmount';
 export * from './NotificationProperties';

package/lib/src/functions/invitation/invite.d.ts

@@ -1,7 +0,0 @@
-import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { Invitation } from '../../types';
-export declare class InvitationInviteFunction extends FirebaseFunction<Invitation, Invitation.Id> {
-    parametersBuilder: Invitation.TypeBuilder;
-    returnTypeBuilder: import("@stevenkellner/typescript-common-functionality").Tagged.TypeBuilder<string, "invitation">;
-    execute(invitation: Invitation): Promise<Invitation.Id>;
-}

package/lib/src/functions/invitation/register.d.ts

@@ -1,7 +0,0 @@
-import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { Invitation, User } from '../../types';
-export declare class InvitationRegisterFunction extends FirebaseFunction<Invitation.Id, User> {
-    parametersBuilder: import("@stevenkellner/typescript-common-functionality").Tagged.TypeBuilder<string, "invitation">;
-    returnTypeBuilder: User.TypeBuilder;
-    execute(invitationId: Invitation.Id): Promise<User>;
-}

package/lib/src/functions/invitation/withdraw.d.ts

@@ -1,8 +0,0 @@
-import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { Invitation } from '../../types';
-import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-export declare class InvitationWithdrawFunction extends FirebaseFunction<Invitation, void> {
-    parametersBuilder: Invitation.TypeBuilder;
-    returnTypeBuilder: ValueTypeBuilder<void>;
-    execute(invitation: Invitation): Promise<void>;
-}