@stevenkellner/team-conduct-api 1.0.36 → 2.0.1

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

@@ -1,24 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PersonAddFunction = void 0;
+exports.PersonAddFunctionBase = 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 checkAuthentication_1 = require("../../checkAuthentication");
-const Firestore_1 = require("../../Firestore");
-class PersonAddFunction extends firebase_function_1.FirebaseFunction {
+class PersonAddFunctionBase extends firebase_function_1.FirebaseFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
         teamId: types_1.Team.Id.builder,
         id: types_1.Person.Id.builder,
         properties: types_1.PersonPrivateProperties.builder
     });
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
-    async execute(parameters) {
-        await (0, checkAuthentication_1.checkAuthentication)(this.userId, parameters.teamId, 'person-manager');
-        const personSnapshot = await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.id).snapshot();
-        if (personSnapshot.exists)
-            throw new firebase_function_1.FunctionsError('already-exists', 'Person already exists');
-        await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.id).set(new types_1.Person(parameters.id, parameters.properties));
-    }
 }
-exports.PersonAddFunction = PersonAddFunction;
+exports.PersonAddFunctionBase = PersonAddFunctionBase;

package/lib/src/functions/person/delete.d.ts

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

package/lib/src/functions/person/delete.js

@@ -1,25 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PersonDeleteFunction = void 0;
+exports.PersonDeleteFunctionBase = 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 checkAuthentication_1 = require("../../checkAuthentication");
-const Firestore_1 = require("../../Firestore");
-class PersonDeleteFunction extends firebase_function_1.FirebaseFunction {
+class PersonDeleteFunctionBase extends firebase_function_1.FirebaseFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
         teamId: types_1.Team.Id.builder,
         id: types_1.Person.Id.builder
     });
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
-    async execute(parameters) {
-        await (0, checkAuthentication_1.checkAuthentication)(this.userId, parameters.teamId, 'person-manager');
-        const personSnapshot = await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.id).snapshot();
-        if (!personSnapshot.exists)
-            throw new firebase_function_1.FunctionsError('not-found', 'Person not found');
-        if (personSnapshot.data.signInProperties !== null)
-            throw new firebase_function_1.FunctionsError('failed-precondition', 'Person is signed in');
-        await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.id).remove();
-    }
 }
-exports.PersonDeleteFunction = PersonDeleteFunction;
+exports.PersonDeleteFunctionBase = PersonDeleteFunctionBase;

package/lib/src/functions/person/update.d.ts

@@ -1,14 +1,12 @@
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
 import { Person, PersonPrivateProperties, Team } from '../../types';
 import { ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-export declare namespace PersonUpdateFunction {
-    type Parameters = {
-        teamId: Team.Id;
-        id: Person.Id;
-        properties: PersonPrivateProperties;
-    };
-}
-export declare class PersonUpdateFunction extends FirebaseFunction<PersonUpdateFunction.Parameters, void> {
+export type PersonUpdateFunctionParameters = {
+    teamId: Team.Id;
+    id: Person.Id;
+    properties: PersonPrivateProperties;
+};
+export declare abstract class PersonUpdateFunctionBase extends FirebaseFunction<PersonUpdateFunctionParameters, void> {
     parametersBuilder: ObjectTypeBuilder<{
         teamId: string;
         id: string;
@@ -16,7 +14,6 @@ export declare class PersonUpdateFunction extends FirebaseFunction<PersonUpdateF
             firstName: string;
             lastName: string | null;
         };
-    }, PersonUpdateFunction.Parameters>;
+    }, PersonUpdateFunctionParameters>;
     returnTypeBuilder: ValueTypeBuilder<void>;
-    execute(parameters: PersonUpdateFunction.Parameters): Promise<void>;
 }

package/lib/src/functions/person/update.js

@@ -1,25 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PersonUpdateFunction = void 0;
+exports.PersonUpdateFunctionBase = 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 checkAuthentication_1 = require("../../checkAuthentication");
-const Firestore_1 = require("../../Firestore");
-class PersonUpdateFunction extends firebase_function_1.FirebaseFunction {
+class PersonUpdateFunctionBase extends firebase_function_1.FirebaseFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
         teamId: types_1.Team.Id.builder,
         id: types_1.Person.Id.builder,
         properties: types_1.PersonPrivateProperties.builder
     });
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
-    async execute(parameters) {
-        await (0, checkAuthentication_1.checkAuthentication)(this.userId, parameters.teamId, 'person-manager');
-        const personSnapshot = await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.id).snapshot();
-        if (!personSnapshot.exists)
-            throw new firebase_function_1.FunctionsError('not-found', 'Person not found');
-        const person = types_1.Person.builder.build(personSnapshot.data);
-        await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.id).set(new types_1.Person(parameters.id, parameters.properties, person.fineIds, person.signInProperties));
-    }
 }
-exports.PersonUpdateFunction = PersonUpdateFunction;
+exports.PersonUpdateFunctionBase = PersonUpdateFunctionBase;

package/lib/src/functions/team/new.d.ts

@@ -1,16 +1,14 @@
 import { ObjectTypeBuilder } from '@stevenkellner/typescript-common-functionality';
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
 import { Person, PersonPrivateProperties, User, Team } from '../../types';
-export declare namespace TeamNewFunction {
-    type Parameters = {
-        id: Team.Id;
-        name: string;
-        paypalMeLink: string | null;
-        personId: Person.Id;
-        personProperties: PersonPrivateProperties;
-    };
-}
-export declare class TeamNewFunction extends FirebaseFunction<TeamNewFunction.Parameters, User> {
+export type TeamNewFunctionParameters = {
+    id: Team.Id;
+    name: string;
+    paypalMeLink: string | null;
+    personId: Person.Id;
+    personProperties: PersonPrivateProperties;
+};
+export declare abstract class TeamNewFunctionBase extends FirebaseFunction<TeamNewFunctionParameters, User> {
     parametersBuilder: ObjectTypeBuilder<{
         id: string;
         name: string;
@@ -20,7 +18,6 @@ export declare class TeamNewFunction extends FirebaseFunction<TeamNewFunction.Pa
             firstName: string;
             lastName: string | null;
         };
-    }, TeamNewFunction.Parameters>;
+    }, TeamNewFunctionParameters>;
     returnTypeBuilder: User.TypeBuilder;
-    execute(parameters: TeamNewFunction.Parameters): Promise<User>;
 }

package/lib/src/functions/team/new.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TeamNewFunction = void 0;
+exports.TeamNewFunctionBase = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
 const firebase_function_1 = require("@stevenkellner/firebase-function");
 const types_1 = require("../../types");
-const Firestore_1 = require("../../Firestore");
-class TeamNewFunction extends firebase_function_1.FirebaseFunction {
+class TeamNewFunctionBase extends firebase_function_1.FirebaseFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
         id: types_1.Team.Id.builder,
         name: new typescript_common_functionality_1.ValueTypeBuilder(),
@@ -14,23 +13,5 @@ class TeamNewFunction extends firebase_function_1.FirebaseFunction {
         personProperties: types_1.PersonPrivateProperties.builder
     });
     returnTypeBuilder = types_1.User.builder;
-    async execute(parameters) {
-        if (this.userId === null)
-            throw new firebase_function_1.FunctionsError('permission-denied', 'User is not authenticated');
-        const userId = types_1.User.Id.builder.build(this.userId);
-        const teamSnapshot = await Firestore_1.Firestore.shared.team(parameters.id).snapshot();
-        if (teamSnapshot.exists)
-            throw new firebase_function_1.FunctionsError('already-exists', 'Team already exists');
-        const userSnapshot = await Firestore_1.Firestore.shared.user(userId).snapshot();
-        let user = new types_1.User(userId);
-        if (userSnapshot.exists)
-            user = types_1.User.builder.build(userSnapshot.data);
-        user.teams.set(parameters.id, new types_1.User.TeamProperties(parameters.name, parameters.personId));
-        await Firestore_1.Firestore.shared.user(userId).set(user);
-        await Firestore_1.Firestore.shared.team(parameters.id).set(new types_1.Team(parameters.id, parameters.name, parameters.paypalMeLink));
-        const signInProperties = new types_1.PersonSignInProperties(userId, typescript_common_functionality_1.UtcDate.now, new types_1.NotificationProperties(), types_1.UserRole.all);
-        await Firestore_1.Firestore.shared.person(parameters.id, parameters.personId).set(new types_1.Person(parameters.personId, parameters.personProperties, [], signInProperties));
-        return user;
-    }
 }
-exports.TeamNewFunction = TeamNewFunction;
+exports.TeamNewFunctionBase = TeamNewFunctionBase;

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

@@ -1,17 +1,14 @@
 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> {
+export type UserKickoutFunctionParameters = {
+    teamId: Team.Id;
+    userId: User.Id;
+};
+export declare abstract class UserKickoutFunctionBase extends FirebaseFunction<UserKickoutFunctionParameters, void> {
     parametersBuilder: ObjectTypeBuilder<{
         teamId: string;
         userId: string;
-    }, UserKickoutFunction.Parameters>;
+    }, UserKickoutFunctionParameters>;
     returnTypeBuilder: ValueTypeBuilder<void>;
-    execute(parameters: UserKickoutFunction.Parameters): Promise<void>;
 }

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

@@ -1,36 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserKickoutFunction = void 0;
+exports.UserKickoutFunctionBase = 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 {
+class UserKickoutFunctionBase 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.value === parameters.userId.value)
-            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.');
-        const personSnapshot = await Firestore_1.Firestore.shared.person(parameters.teamId, userTeamProperties.personId).snapshot();
-        if (!personSnapshot.exists)
-            throw new firebase_function_1.FunctionsError('not-found', 'Person not found.');
-        const person = types_1.Person.builder.build(personSnapshot.data);
-        person.signInProperties = null;
-        await Firestore_1.Firestore.shared.person(parameters.teamId, userTeamProperties.personId).set(person);
-        user.teams.delete(parameters.teamId);
-        await Firestore_1.Firestore.shared.user(parameters.userId).set(user);
-    }
 }
-exports.UserKickoutFunction = UserKickoutFunction;
+exports.UserKickoutFunctionBase = UserKickoutFunctionBase;

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

@@ -1,8 +1,7 @@
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
 import { User } from '../../types';
 import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-export declare class UserLoginFunction extends FirebaseFunction<null, User> {
+export declare abstract class UserLoginFunctionBase extends FirebaseFunction<null, User> {
     parametersBuilder: ValueTypeBuilder<null>;
     returnTypeBuilder: User.TypeBuilder;
-    execute(): Promise<User>;
 }

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

@@ -1,21 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserLoginFunction = void 0;
+exports.UserLoginFunctionBase = 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");
-class UserLoginFunction extends firebase_function_1.FirebaseFunction {
+class UserLoginFunctionBase extends firebase_function_1.FirebaseFunction {
     parametersBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
     returnTypeBuilder = types_1.User.builder;
-    async execute() {
-        if (this.userId === null)
-            throw new firebase_function_1.FunctionsError('unauthenticated', 'User is not authenticated.');
-        const userId = types_1.User.Id.builder.build(this.userId);
-        const userSnapshot = await Firestore_1.Firestore.shared.user(userId).snapshot();
-        if (!userSnapshot.exists)
-            throw new firebase_function_1.FunctionsError('not-found', 'User not found.');
-        return types_1.User.builder.build(userSnapshot.data);
-    }
 }
-exports.UserLoginFunction = UserLoginFunction;
+exports.UserLoginFunctionBase = UserLoginFunctionBase;

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

@@ -1,19 +1,16 @@
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
 import { Person, Team, UserRole } from '../../types';
 import { ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-export declare namespace UserRoleEditFunction {
-    type Parameters = {
-        teamId: Team.Id;
-        personId: Person.Id;
-        roles: UserRole[];
-    };
-}
-export declare class UserRoleEditFunction extends FirebaseFunction<UserRoleEditFunction.Parameters, void> {
+export type UserRoleEditFunctionParameters = {
+    teamId: Team.Id;
+    personId: Person.Id;
+    roles: UserRole[];
+};
+export declare abstract class UserRoleEditFunctionBase extends FirebaseFunction<UserRoleEditFunctionParameters, void> {
     parametersBuilder: ObjectTypeBuilder<{
         teamId: string;
         personId: string;
-        roles: UserRole[];
-    }, UserRoleEditFunction.Parameters>;
+        roles: ("person-manager" | "fineTemplate-manager" | "fine-manager" | "fine-can-add" | "team-manager")[];
+    }, UserRoleEditFunctionParameters>;
     returnTypeBuilder: ValueTypeBuilder<void>;
-    execute(parameters: UserRoleEditFunction.Parameters): Promise<void>;
 }

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

@@ -1,30 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserRoleEditFunction = void 0;
+exports.UserRoleEditFunctionBase = void 0;
 const firebase_function_1 = require("@stevenkellner/firebase-function");
-const checkAuthentication_1 = require("../../checkAuthentication");
 const types_1 = require("../../types");
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const Firestore_1 = require("../../Firestore");
-class UserRoleEditFunction extends firebase_function_1.FirebaseFunction {
+class UserRoleEditFunctionBase extends firebase_function_1.FirebaseFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
         teamId: types_1.Team.Id.builder,
         personId: types_1.Person.Id.builder,
         roles: new typescript_common_functionality_1.ArrayTypeBuilder(new typescript_common_functionality_1.ValueTypeBuilder())
     });
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
-    async execute(parameters) {
-        const userId = await (0, checkAuthentication_1.checkAuthentication)(this.userId, parameters.teamId, 'team-manager');
-        const personSnapshot = await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.personId).snapshot();
-        if (!personSnapshot.exists)
-            throw new firebase_function_1.FunctionsError('not-found', 'User does not exist');
-        const person = types_1.Person.builder.build(personSnapshot.data);
-        if (person.signInProperties === null)
-            throw new firebase_function_1.FunctionsError('permission-denied', 'User is not signed in');
-        if (person.signInProperties.userId.value === userId.value && !parameters.roles.includes('team-manager'))
-            throw new firebase_function_1.FunctionsError('unavailable', 'User cannot remove their own team-manager role');
-        person.signInProperties.roles = parameters.roles;
-        await Firestore_1.Firestore.shared.person(parameters.teamId, parameters.personId).set(person);
-    }
 }
-exports.UserRoleEditFunction = UserRoleEditFunction;
+exports.UserRoleEditFunctionBase = UserRoleEditFunctionBase;

package/lib/src/index.d.ts

@@ -1,8 +1,3 @@
 export * from './firebase';
 export * from './functions';
 export * from './types';
-export * from './checkAuthentication';
-export * from './firebaseFunctionsContext';
-export * from './Firestore';
-export * from './FirestoreScheme';
-export * from './pushNotification';

package/lib/src/index.js

@@ -17,8 +17,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./firebase"), exports);
 __exportStar(require("./functions"), exports);
 __exportStar(require("./types"), exports);
-__exportStar(require("./checkAuthentication"), exports);
-__exportStar(require("./firebaseFunctionsContext"), exports);
-__exportStar(require("./Firestore"), exports);
-__exportStar(require("./FirestoreScheme"), exports);
-__exportStar(require("./pushNotification"), exports);

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

@@ -1,67 +1,10 @@
-import { Pluralization } from '../types/Pluralization';
-export declare const localizationDE: {
-    notification: {
-        fine: {
-            new: {
-                title: string;
-                body: string;
-            };
-            reminder: {
-                title: string;
-                body: string;
-            };
-            stateChange: {
-                title: string;
-                bodyPayed: string;
-                bodyUnpayed: string;
-                bodyDeleted: string;
-            };
-        };
-    };
-    fineAmount: {
-        item: {
-            type: {
-                crateOfBeer: {
-                    name: string;
-                    withCount: Pluralization;
-                    withoutCount: Pluralization;
-                };
-            };
-        };
-    };
-    fineTemplateRepetition: {
-        item: {
-            minute: {
-                name: string;
-                withCount: Pluralization;
-                withoutCount: Pluralization;
-            };
-            day: {
-                name: string;
-                withCount: Pluralization;
-                withoutCount: Pluralization;
-            };
-            item: {
-                name: string;
-                withCount: Pluralization;
-                withoutCount: Pluralization;
-            };
-            count: {
-                name: string;
-                withCount: Pluralization;
-                withoutCount: Pluralization;
-            };
-        };
-    };
-    payedState: {
-        payed: string;
-        notPayed: string;
-    };
-    userRole: {
-        personManager: string;
-        fineTemplateManager: string;
-        fineManager: string;
-        fineCanAdd: string;
-        teamManager: string;
-    };
-};
+import { LocalizationDict } from '../types/Localization';
+/**
+ * German (de) localization strings for the application.
+ * Contains translations for notifications, fine amounts, fine template repetitions,
+ * payment states, and user roles.
+ *
+ * Supports template variables using {{variableName}} syntax that will be replaced
+ * at runtime with actual values.
+ */
+export declare const localizationDE: LocalizationDict;

package/lib/src/locales/de.js

@@ -2,6 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.localizationDE = void 0;
 const Pluralization_1 = require("../types/Pluralization");
+/**
+ * German (de) localization strings for the application.
+ * Contains translations for notifications, fine amounts, fine template repetitions,
+ * payment states, and user roles.
+ *
+ * Supports template variables using {{variableName}} syntax that will be replaced
+ * at runtime with actual values.
+ */
 exports.localizationDE = {
     notification: {
         fine: {

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

@@ -1,4 +1,14 @@
 import { Pluralization } from '../types/Pluralization';
+/**
+ * English (en) localization strings for the application.
+ * Contains translations for notifications, fine amounts, fine template repetitions,
+ * payment states, and user roles.
+ *
+ * Supports template variables using {{variableName}} syntax that will be replaced
+ * at runtime with actual values.
+ *
+ * This serves as the base localization - other locales should match this structure.
+ */
 export declare const localizationEN: {
     notification: {
         fine: {

package/lib/src/locales/en.js

@@ -2,7 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.localizationEN = void 0;
 const Pluralization_1 = require("../types/Pluralization");
-exports.localizationEN = {
+/**
+ * Helper function to ensure a value satisfies the Localization structure
+ * while preserving its concrete type (as const) for type inference.
+ * @param value - The localization object to validate
+ * @returns The same value with its inferred type preserved
+ */
+const satisfiesLocalization = (value) => value;
+/**
+ * English (en) localization strings for the application.
+ * Contains translations for notifications, fine amounts, fine template repetitions,
+ * payment states, and user roles.
+ *
+ * Supports template variables using {{variableName}} syntax that will be replaced
+ * at runtime with actual values.
+ *
+ * This serves as the base localization - other locales should match this structure.
+ */
+exports.localizationEN = satisfiesLocalization({
     notification: {
         fine: {
             new: {
@@ -97,4 +114,4 @@ exports.localizationEN = {
         fineCanAdd: 'Can add fines',
         teamManager: 'Team Manager'
     }
-};
+});

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

@@ -1,28 +1,46 @@
-import { localizations } from './Localization';
-import { Flattable, ITypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
+import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functionality';
+import { Currency } from './Currency';
+import { Locale } from './Locale';
+/**
+ * Represents the configuration settings that will be passed to the functions parameters.
+ * Contains currency and locale preferences.
+ */
 export declare class Configuration implements Flattable<Configuration.Flatten> {
-    currency: Configuration.Currency;
-    locale: Configuration.Locale;
-    constructor(currency: Configuration.Currency, locale: Configuration.Locale);
+    currency: Currency;
+    locale: Locale;
+    /**
+     * Creates a new Configuration instance.
+     * @param currency - The currency to use for monetary values (EUR, USD, ...)
+     * @param locale - The locale for localization (language/region)
+     */
+    constructor(currency: Currency, locale: Locale);
+    /**
+     * Returns the flattened representation of the configuration.
+     * @returns The flattened configuration object
+     */
     get flatten(): Configuration.Flatten;
 }
 export declare namespace Configuration {
-    type Currency = 'EUR' | 'USD';
-    namespace Currency {
-        const all: Currency[];
-        const builder: ValueTypeBuilder<Currency>;
-    }
-    type Locale = keyof typeof localizations;
-    namespace Locale {
-        const all: Locale[];
-        const builder: ValueTypeBuilder<"en" | "de">;
-    }
+    /**
+     * Flattened representation of Configuration for serialization.
+     */
     type Flatten = {
         currency: Currency;
         locale: Locale;
     };
+    /**
+     * TypeBuilder for constructing Configuration instances from flattened data.
+     */
     class TypeBuilder implements ITypeBuilder<Flatten, Configuration> {
+        /**
+         * Builds a Configuration instance from flattened data.
+         * @param flatten - The flattened configuration data
+         * @returns A new Configuration instance
+         */
         build(flatten: Flatten): Configuration;
     }
+    /**
+     * Singleton builder instance for Configuration.
+     */
     const builder: TypeBuilder;
 }