@stevenkellner/team-conduct-api 1.0.4 → 1.0.5

package/src/functions/notification/subscribe.ts

@@ -1,38 +0,0 @@
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { NotificationProperties, Person, Team } from '../../types';
-import { ArrayTypeBuilder, Flattable, ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { Firestore } from '../../Firestore';
-
-export namespace NotificationSubscribeFunction {
-
-    export type Parameters = {
-        teamId: Team.Id,
-        personId: Person.Id,
-        subscriptions: NotificationProperties.Subscription[]
-    }
-}
-
-export class NotificationSubscribeFunction extends FirebaseFunction<NotificationSubscribeFunction.Parameters, void> {
-
-    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<NotificationSubscribeFunction.Parameters>, NotificationSubscribeFunction.Parameters>({
-        teamId: Team.Id.builder,
-        personId: Person.Id.builder,
-        subscriptions: new ArrayTypeBuilder(new ValueTypeBuilder())
-    });
-
-    public returnTypeBuilder = new ValueTypeBuilder<void>();
-
-    public async execute(parameters: NotificationSubscribeFunction.Parameters): Promise<void> {
-
-        const personSnapshot = await Firestore.shared.person(parameters.teamId, parameters.personId).snapshot();
-        if (!personSnapshot.exists)
-            throw new FunctionsError('not-found', 'Person not found');
-        const person = Person.builder.build(personSnapshot.data);
-
-        if (person.signInProperties === null)
-            throw new FunctionsError('unauthenticated', 'Person not signed in');
-
-        person.signInProperties.notificationProperties.subscriptions = parameters.subscriptions;
-        await Firestore.shared.person(parameters.teamId, parameters.personId).set(person);
-    }
-}

package/src/functions/paypalMe/edit.ts

@@ -1,36 +0,0 @@
-import { Flattable, ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Team } from '../../types';
-import { checkAuthentication } from '../../checkAuthentication';
-import { Firestore } from '../../Firestore';
-
-export namespace PaypalMeEditFunction {
-
-    export type Parameters = {
-        teamId: Team.Id;
-        paypalMeLink: string | null;
-    };
-}
-
-export class PaypalMeEditFunction extends FirebaseFunction<PaypalMeEditFunction.Parameters, void> {
-
-    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<PaypalMeEditFunction.Parameters>, PaypalMeEditFunction.Parameters>({
-        teamId: Team.Id.builder,
-        paypalMeLink: new ValueTypeBuilder()
-    });
-
-    public returnTypeBuilder = new ValueTypeBuilder<void>();
-
-    public async execute(parameters: PaypalMeEditFunction.Parameters): Promise<void> {
-
-        await checkAuthentication(this.userId, parameters.teamId, 'team-manager');
-
-        const teamSnapshot = await Firestore.shared.team(parameters.teamId).snapshot();
-        if (!teamSnapshot.exists)
-            throw new FunctionsError('not-found', 'Team not found');
-        const team = Team.builder.build(teamSnapshot.data);
-
-        team.paypalMeLink = parameters.paypalMeLink;
-        await Firestore.shared.team(parameters.teamId).set(team);
-    }
-}

package/src/functions/person/add.ts

@@ -1,36 +0,0 @@
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Person, PersonPrivateProperties, Team } from '../../types';
-import { Flattable, ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { checkAuthentication } from '../../checkAuthentication';
-import { Firestore } from '../../Firestore';
-
-export namespace PersonAddFunction {
-
-    export type Parameters = {
-        teamId: Team.Id
-        id: Person.Id,
-        properties: PersonPrivateProperties
-    };
-}
-
-export class PersonAddFunction extends FirebaseFunction<PersonAddFunction.Parameters, void> {
-
-    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<PersonAddFunction.Parameters>, PersonAddFunction.Parameters>({
-        teamId: Team.Id.builder,
-        id: Person.Id.builder,
-        properties: PersonPrivateProperties.builder
-    });
-
-    public returnTypeBuilder = new ValueTypeBuilder<void>();
-
-    public async execute(parameters: PersonAddFunction.Parameters): Promise<void> {
-
-        await checkAuthentication(this.userId, parameters.teamId, 'person-manager');
-
-        const personSnapshot = await Firestore.shared.person(parameters.teamId, parameters.id).snapshot();
-        if (personSnapshot.exists)
-            throw new FunctionsError('already-exists', 'Person already exists');
-
-        await Firestore.shared.person(parameters.teamId, parameters.id).set(new Person(parameters.id, parameters.properties));
-    }
-}

package/src/functions/person/delete.ts

@@ -1,37 +0,0 @@
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Person, Team } from '../../types';
-import { Flattable, ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { checkAuthentication } from '../../checkAuthentication';
-import { Firestore } from '../../Firestore';
-
-export namespace PersonDeleteFunction {
-
-    export type Parameters = {
-        teamId: Team.Id,
-        id: Person.Id
-    }
-}
-
-export class PersonDeleteFunction extends FirebaseFunction<PersonDeleteFunction.Parameters, void> {
-
-    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<PersonDeleteFunction.Parameters>, PersonDeleteFunction.Parameters>({
-        teamId: Team.Id.builder,
-        id: Person.Id.builder
-    });
-
-    public returnTypeBuilder = new ValueTypeBuilder<void>();
-
-    public async execute(parameters: PersonDeleteFunction.Parameters): Promise<void> {
-
-        await checkAuthentication(this.userId, parameters.teamId, 'person-manager');
-
-        const personSnapshot = await Firestore.shared.person(parameters.teamId, parameters.id).snapshot();
-        if (!personSnapshot.exists)
-            throw new FunctionsError('not-found', 'Person not found');
-
-        if (personSnapshot.data.signInProperties !== null)
-            throw new FunctionsError('failed-precondition', 'Person is signed in');
-
-        await Firestore.shared.person(parameters.teamId, parameters.id).remove();
-    }
-}

package/src/functions/person/update.ts

@@ -1,37 +0,0 @@
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Person, PersonPrivateProperties, Team } from '../../types';
-import { Flattable, ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { checkAuthentication } from '../../checkAuthentication';
-import { Firestore } from '../../Firestore';
-
-export namespace PersonUpdateFunction {
-
-    export type Parameters = {
-        teamId: Team.Id,
-        id: Person.Id,
-        properties: PersonPrivateProperties
-    };
-}
-
-export class PersonUpdateFunction extends FirebaseFunction<PersonUpdateFunction.Parameters, void> {
-
-    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<PersonUpdateFunction.Parameters>, PersonUpdateFunction.Parameters>({
-        teamId: Team.Id.builder,
-        id: Person.Id.builder,
-        properties: PersonPrivateProperties.builder
-    });
-
-    public returnTypeBuilder = new ValueTypeBuilder<void>();
-
-    public async execute(parameters: PersonUpdateFunction.Parameters): Promise<void> {
-
-        await checkAuthentication(this.userId, parameters.teamId, 'person-manager');
-
-        const personSnapshot = await Firestore.shared.person(parameters.teamId, parameters.id).snapshot();
-        if (!personSnapshot.exists)
-            throw new FunctionsError('not-found', 'Person not found');
-        const person = Person.builder.build(personSnapshot.data);
-
-        await Firestore.shared.person(parameters.teamId, parameters.id).set(new Person(parameters.id, parameters.properties, person.fineIds, person.signInProperties));
-    }
-}

package/src/functions/team/new.ts

@@ -1,54 +0,0 @@
-import { Flattable, ObjectTypeBuilder, UtcDate, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { Person, PersonPrivateProperties, PersonSignInProperties, User, UserRole, Team, NotificationProperties } from '../../types';
-import { Firestore } from '../../Firestore';
-
-export namespace TeamNewFunction {
-
-    export type Parameters = {
-        id: Team.Id
-        name: string
-        paypalMeLink: string | null
-        personId: Person.Id
-        personProperties: PersonPrivateProperties
-    }
-}
-
-export class TeamNewFunction extends FirebaseFunction<TeamNewFunction.Parameters, User> {
-
-    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<TeamNewFunction.Parameters>, TeamNewFunction.Parameters>({
-        id: Team.Id.builder,
-        name: new ValueTypeBuilder(),
-        paypalMeLink: new ValueTypeBuilder(),
-        personId: Person.Id.builder,
-        personProperties: PersonPrivateProperties.builder
-    });
-
-    public returnTypeBuilder = User.builder;
-
-    public async execute(parameters: TeamNewFunction.Parameters): Promise<User> {
-
-        if (this.userId === null)
-            throw new FunctionsError('permission-denied', 'User is not authenticated');
-        const userId = User.Id.builder.build(this.userId);
-
-        const teamSnapshot = await Firestore.shared.team(parameters.id).snapshot();
-        if (teamSnapshot.exists)
-            throw new FunctionsError('already-exists', 'Team already exists');
-
-        const userSnapshot = await Firestore.shared.user(userId).snapshot();
-        let user = new User(userId);
-        if (userSnapshot.exists)
-            user = User.builder.build(userSnapshot.data);
-
-        user.teams.set(parameters.id, new User.TeamProperties(parameters.name, parameters.personId));
-        await Firestore.shared.user(userId).set(user);
-
-        await Firestore.shared.team(parameters.id).set(new Team(parameters.id, parameters.name, parameters.paypalMeLink));
-
-        const signInProperties = new PersonSignInProperties(userId, UtcDate.now, new NotificationProperties(), UserRole.all);
-        await Firestore.shared.person(parameters.id, parameters.personId).set(new Person(parameters.personId, parameters.personProperties, [], signInProperties));
-
-        return user;
-    }
-}

package/src/functions/user/login.ts

@@ -1,25 +0,0 @@
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { User } from '../../types';
-import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { Firestore } from '../../Firestore';
-
-export class UserLoginFunction extends FirebaseFunction<null, User> {
-
-    public parametersBuilder = new ValueTypeBuilder<null>();
-
-
-    public returnTypeBuilder = User.builder;
-
-    public async execute(): Promise<User> {
-
-        if (this.userId === null)
-            throw new FunctionsError('unauthenticated', 'User is not authenticated.');
-        const userId = User.Id.builder.build(this.userId);
-
-        const userSnapshot = await Firestore.shared.user(userId).snapshot();
-        if (!userSnapshot.exists)
-            throw new FunctionsError('not-found', 'User not found.');
-
-        return User.builder.build(userSnapshot.data);
-    }
-}

package/src/functions/user/roleEdit.ts

@@ -1,44 +0,0 @@
-import { FirebaseFunction, FunctionsError } from '@stevenkellner/firebase-function';
-import { checkAuthentication } from '../../checkAuthentication';
-import { Person, Team, UserRole } from '../../types';
-import { ArrayTypeBuilder, Flattable, ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { Firestore } from '../../Firestore';
-
-export namespace UserRoleEditFunction {
-
-    export type Parameters = {
-        teamId: Team.Id
-        personId: Person.Id
-        roles: UserRole[]
-    };
-}
-
-export class UserRoleEditFunction extends FirebaseFunction<UserRoleEditFunction.Parameters, void> {
-
-    public parametersBuilder = new ObjectTypeBuilder<Flattable.Flatten<UserRoleEditFunction.Parameters>, UserRoleEditFunction.Parameters>({
-        teamId: Team.Id.builder,
-        personId: Person.Id.builder,
-        roles: new ArrayTypeBuilder(new ValueTypeBuilder())
-    });
-
-    public returnTypeBuilder = new ValueTypeBuilder<void>();
-
-    public async execute(parameters: UserRoleEditFunction.Parameters): Promise<void> {
-
-        const userId = await checkAuthentication(this.userId, parameters.teamId, 'team-manager');
-
-        const personSnapshot = await Firestore.shared.person(parameters.teamId, parameters.personId).snapshot();
-        if (!personSnapshot.exists)
-            throw new FunctionsError('not-found', 'User does not exist');
-        const person = Person.builder.build(personSnapshot.data);
-
-        if (person.signInProperties === null)
-            throw new FunctionsError('permission-denied', 'User is not signed in');
-
-        if (person.signInProperties.userId.value === userId.value && !parameters.roles.includes('team-manager'))
-            throw new FunctionsError('unavailable', 'User cannot remove their own team-manager role');
-
-        person.signInProperties.roles = parameters.roles;
-        await Firestore.shared.person(parameters.teamId, parameters.personId).set(person);
-    }
-}

package/src/locales/de.json

@@ -1,30 +0,0 @@
-{
-    "notification": {
-        "fine": {
-            "new": {
-                "title": "%s",
-                "body": "Du hast eine neue Strafe von %s. Bitte so schnell wie möglich zahlen."
-            },
-            "reminder": {
-                "title": "Du hast noch offene Strafen",
-                "body": "Bei dir sind noch %s offen. Bitte so schnell wie möglich zahlen."
-            },
-            "state-change": {
-                "title": "Eine deiner Strafen hat sich geändert",
-                "body-payed": "Du hast eine Strafe von %1$s bezahlt (%2$s).",
-                "body-unpayed": "%1$s, %2$s ist noch offen.",
-                "body-deleted": "%1$s, %2$s wurde gelöscht."
-            }
-        }
-    },
-    "FineAmount": {
-        "Item": {
-            "Type": {
-                "crateOfBeer": {
-                    "singular": "Ein Kasten Bier",
-                    "plural": "%s Kästen Bier"
-                }
-            }
-        }
-    }
-}

package/src/locales/en.json

@@ -1,30 +0,0 @@
-{
-    "notification": {
-        "fine": {
-            "new": {
-                "title": "%s",
-                "body": "You have a new fine of %s. Please pay it as soon as possible."
-            },
-            "reminder": {
-                "title": "You still have outstanding penalties",
-                "body": "You still have %s outstanding. Please pay as soon as possible."
-            },
-            "state-change": {
-                "title": "One of your penalties has changed",
-                "body-paid": "You have paid a penalty of %1$s (%2$s).",
-                "body-unpayed": "%1$s, %2$s are still outstanding.",
-                "body-deleted": "%1$s, %2$s has been deleted."
-            }
-        }
-    },
-    "FineAmount": {
-        "Item": {
-            "Type": {
-                "crateOfBeer": {
-                    "singular": "One Crate of Beer",
-                    "plural": "%s Crates of Beer"
-                }
-            }
-        }
-    }
-}

package/src/pushNotification.ts

@@ -1,37 +0,0 @@
-import { Dictionary } from '@stevenkellner/typescript-common-functionality';
-import { Firestore } from './Firestore';
-import { NotificationProperties, Person, Team } from './types';
-import { FirebaseConfiguration, BatchResponse, Notification } from './firebase';
-
-function successfulTokens(response: BatchResponse, tokens: string[]): Dictionary<NotificationProperties.TokenId, string> {
-    const successfulTokens = response.responses
-        .map((response, index) => ({
-            failed: response.error?.code ==='messaging/invalid-registration-token' || response.error?.code === 'messaging/registration-token-not-registered',
-            token: tokens[index]
-        }))
-        .filter(response => !response.failed)
-        .map(response => response.token);
-    const tokenDict = new Dictionary<NotificationProperties.TokenId, string>(NotificationProperties.TokenId.builder);
-    for (const token of successfulTokens)
-        tokenDict.set(NotificationProperties.TokenId.create(token), token);
-    return tokenDict;
-}
-
-export async function pushNotification(teamId: Team.Id, personId: Person.Id, topic: NotificationProperties.Subscription, notification: Notification): Promise<void> {
-
-    const personSnapshot = await Firestore.shared.person(teamId, personId).snapshot();
-    if (!personSnapshot.exists)
-        return;
-    const person = Person.builder.build(personSnapshot.data);
-
-    if (person.signInProperties === null || !person.signInProperties.notificationProperties.subscriptions.includes(topic))
-        return;
-
-    const tokens = person.signInProperties.notificationProperties.tokens.values;
-    const response = await FirebaseConfiguration.shared.messaging.sendEachForMulticast({
-        tokens: tokens,
-        notification: notification
-    });
-    person.signInProperties.notificationProperties.tokens = successfulTokens(response, tokens);
-    await Firestore.shared.person(teamId, personId).set(person);
-}

package/src/types/Configuration.ts

@@ -1,54 +0,0 @@
-import { Flattable, ITypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-
-export class Configuration implements Flattable<Configuration.Flatten> {
-
-    public constructor(
-        public currency: Configuration.Currency,
-        public locale: Configuration.Locale
-    ) {}
-
-    public get flatten(): Configuration.Flatten {
-        return {
-            currency: this.currency,
-            locale: this.locale
-        };
-    }
-}
-
-export namespace Configuration {
-
-    export type Currency = 'EUR' | 'USD';
-
-    export namespace Currency {
-
-        export const all: Currency[] = ['EUR', 'USD'];
-
-        export const builder = new ValueTypeBuilder<Currency>();
-    }
-
-    export type Locale = 'de' | 'en';
-
-    export namespace Locale {
-
-        export const all: Locale[] = ['de', 'en'];
-
-        export const builder = new ValueTypeBuilder<Locale>();
-    }
-
-    export type Flatten = {
-        currency: Currency,
-        locale: Locale
-    };
-
-    export class TypeBuilder implements ITypeBuilder<Flatten, Configuration> {
-
-        public build(flatten: Flatten): Configuration {
-            return new Configuration(
-                flatten.currency,
-                flatten.locale
-            );
-        }
-    }
-
-    export const builder = new TypeBuilder();
-}

package/src/types/Fine.ts

@@ -1,59 +0,0 @@
-import { Flattable, Guid, ITypeBuilder, Tagged, UtcDate } from '@stevenkellner/typescript-common-functionality';
-import { FineAmount } from './FineAmount';
-import { PayedState } from './PayedState';
-
-export class Fine implements Flattable<Fine.Flatten> {
-
-    public constructor(
-        public id: Fine.Id,
-        public payedState: PayedState,
-        public date: UtcDate,
-        public reason: string,
-        public amount: FineAmount
-    ) {}
-
-    public get flatten(): Fine.Flatten {
-        return {
-            id: this.id.flatten,
-            payedState: this.payedState,
-            date: this.date.flatten,
-            reason: this.reason,
-            amount: this.amount.flatten
-        };
-    }
-}
-
-export namespace Fine {
-
-    export type Id = Tagged<Guid, 'fine'>;
-
-    export namespace Id {
-
-        export type Flatten = string;
-
-        export const builder = Tagged.builder('fine' as const, Guid.builder);
-    }
-
-    export type Flatten = {
-        id: Id.Flatten,
-        payedState: PayedState,
-        date: UtcDate.Flatten,
-        reason: string,
-        amount: FineAmount.Flatten
-    };
-
-    export class TypeBuilder implements ITypeBuilder<Flatten, Fine> {
-
-        public build(value: Flatten): Fine {
-            return new Fine(
-                Id.builder.build(value.id),
-                value.payedState,
-                UtcDate.builder.build(value.date),
-                value.reason,
-                FineAmount.builder.build(value.amount)
-            );
-        }
-    }
-
-    export const builder = new TypeBuilder();
-}

package/src/types/FineAmount.ts

@@ -1,123 +0,0 @@
-import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { MoneyAmount } from './MoneyAmount';
-import * as i18n from 'i18n';
-import { Configuration } from './Configuration';
-
-export type FineAmount =
-    | FineAmount.Money
-    | FineAmount.Item;
-
-export namespace FineAmount {
-
-    export class Money implements Flattable<Money.Flatten> {
-
-        public constructor(
-            public amount: MoneyAmount
-        ) {}
-
-        public formatted(configuration: Configuration): string {
-            return this.amount.formatted(configuration.currency);
-        }
-
-        public get flatten(): Money.Flatten {
-            return {
-                type: 'money',
-                amount: this.amount.flatten
-            };
-        }
-    }
-
-    export namespace Money {
-
-        export type Flatten = {
-            type: 'money',
-            amount: MoneyAmount.Flatten
-        }
-
-        export class TypeBuilder implements ITypeBuilder<Flatten, Money> {
-
-            public build(value: Flatten): Money {
-                return new Money(MoneyAmount.builder.build(value.amount));
-            }
-        }
-
-        export const builder = new TypeBuilder();
-    }
-
-    export class Item implements Flattable<Item.Flatten> {
-
-        public constructor(
-            public item: Item.Type,
-            public count: number
-        ) {}
-
-        public formatted(configuration: Configuration): string {
-            const numberFormat = Intl.NumberFormat(configuration.locale, {
-                minimumFractionDigits: 0,
-                maximumFractionDigits: 0
-            });
-            if (this.count === 1)
-                return i18n.__(`FineAmount.Item.Type.${this.item}.singular`, numberFormat.format(this.count));
-            return i18n.__(`FineAmount.Item.Type.${this.item}.plural`, numberFormat.format(this.count));
-        }
-
-        public get flatten(): Item.Flatten {
-            return {
-                type: 'item',
-                item: this.item,
-                count: this.count
-            };
-        }
-    }
-
-    export namespace Item {
-
-        export type Type =
-            | 'crateOfBeer';
-
-        export namespace Type {
-
-            export const all: Type[] = ['crateOfBeer'];
-        }
-
-        export type Flatten = {
-            type: 'item',
-            item: Item.Type,
-            count: number
-        }
-
-        export class TypeBuilder implements ITypeBuilder<Flatten, Item> {
-
-            public build(value: Flatten): Item {
-                return new Item(value.item, value.count);
-            }
-        }
-
-        export const builder = new TypeBuilder();
-    }
-
-
-    export function money(MoneyAmount: MoneyAmount): Money {
-        return new Money(MoneyAmount);
-    }
-
-    export function item(item: Item.Type, count: number): Item {
-        return new Item(item, count);
-    }
-
-    export type Flatten = Money.Flatten | Item.Flatten;
-
-    export class TypeBuilder implements ITypeBuilder<Flatten, FineAmount> {
-
-        public build(value: Flatten): FineAmount {
-            switch (value.type) {
-            case 'money':
-                return Money.builder.build(value);
-            case 'item':
-                return Item.builder.build(value);
-            }
-        }
-    }
-
-    export const builder = new TypeBuilder();
-}