@stevenkellner/team-conduct-api 2.0.3 → 2.0.5

package/lib/src/firebase/FirestoreScheme.d.ts

@@ -15,6 +15,9 @@ import { Fine, FineTemplate, Invitation, Person, Team, User } from '../types';
  * throughout the application.
  */
 export type FirestoreScheme = FirestoreDocument<never, {
+    userAuthentications: FirestoreCollection<{
+        [UserAuthId in string]: FirestoreDocument<User.Id>;
+    }>;
     users: FirestoreCollection<{
         [UserId in string]: FirestoreDocument<User>;
     }>;

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

@@ -1,5 +1,5 @@
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { Invitation, Person, PersonPrivateProperties, Team } from '../../types';
+import { Invitation, Person, PersonProperties, Team } from '../../types';
 import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functionality';
 export declare class InvitationGetInvitationFunction implements FirebaseFunction<Invitation.Id, InvitationGetInvitationFunction.ReturnType> {
     parametersBuilder: import("@stevenkellner/typescript-common-functionality").Tagged.TypeBuilder<string, "invitation">;
@@ -11,7 +11,7 @@ export declare namespace InvitationGetInvitationFunction {
     } | {
         persons: {
             id: Person.Id;
-            properties: PersonPrivateProperties;
+            properties: PersonProperties;
         }[];
     };
     namespace PersonIdOrPersons {
@@ -20,7 +20,7 @@ export declare namespace InvitationGetInvitationFunction {
         } | {
             persons: {
                 id: Person.Id.Flatten;
-                properties: PersonPrivateProperties.Flatten;
+                properties: PersonProperties.Flatten;
             }[];
         };
     }
@@ -32,12 +32,12 @@ export declare namespace InvitationGetInvitationFunction {
         static from(teamId: Team.Id, teamName: string, personId: Person.Id): ReturnType;
         static from(teamId: Team.Id, teamName: string, persons: {
             id: Person.Id;
-            properties: PersonPrivateProperties;
+            properties: PersonProperties;
         }[]): ReturnType;
         get personId(): Person.Id | null;
         get persons(): {
             id: Person.Id;
-            properties: PersonPrivateProperties;
+            properties: PersonProperties;
         }[] | null;
         get flatten(): ReturnType.Flatten;
     }

package/lib/src/functions/invitation/getInvitation.js

@@ -64,7 +64,7 @@ exports.InvitationGetInvitationFunction = InvitationGetInvitationFunction;
                 }
                 return ReturnType.from(types_1.Team.Id.builder.build(value.teamId), value.teamName, value.persons.map(person => ({
                     id: types_1.Person.Id.builder.build(person.id),
-                    properties: types_1.PersonPrivateProperties.builder.build(person.properties)
+                    properties: types_1.PersonProperties.builder.build(person.properties)
                 })));
             }
         }

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

@@ -1,11 +1,11 @@
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { Person, PersonPrivateProperties, Team } from '../../types';
+import { Person, PersonProperties, Team } from '../../types';
 import { ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
 export declare namespace PersonAddFunction {
     type Parameters = {
         teamId: Team.Id;
         id: Person.Id;
-        properties: PersonPrivateProperties;
+        properties: PersonProperties;
     };
 }
 export declare class PersonAddFunction implements FirebaseFunction<PersonAddFunction.Parameters, void> {

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

@@ -7,7 +7,7 @@ class PersonAddFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
         teamId: types_1.Team.Id.builder,
         id: types_1.Person.Id.builder,
-        properties: types_1.PersonPrivateProperties.builder
+        properties: types_1.PersonProperties.builder
     });
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
 }

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

@@ -1,11 +1,11 @@
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { Person, PersonPrivateProperties, Team } from '../../types';
+import { Person, PersonProperties, 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;
+        properties: PersonProperties;
     };
 }
 export declare class PersonUpdateFunction implements FirebaseFunction<PersonUpdateFunction.Parameters, void> {

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

@@ -7,7 +7,7 @@ class PersonUpdateFunction {
     parametersBuilder = new typescript_common_functionality_1.ObjectTypeBuilder({
         teamId: types_1.Team.Id.builder,
         id: types_1.Person.Id.builder,
-        properties: types_1.PersonPrivateProperties.builder
+        properties: types_1.PersonProperties.builder
     });
     returnTypeBuilder = new typescript_common_functionality_1.ValueTypeBuilder();
 }

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

@@ -1,13 +1,13 @@
 import { ObjectTypeBuilder } from '@stevenkellner/typescript-common-functionality';
 import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { Person, PersonPrivateProperties, User, Team } from '../../types';
+import { Person, PersonProperties, User, Team } from '../../types';
 export declare namespace TeamNewFunction {
     type Parameters = {
         id: Team.Id;
         name: string;
         paypalMeLink: string | null;
         personId: Person.Id;
-        personProperties: PersonPrivateProperties;
+        personProperties: PersonProperties;
     };
 }
 export declare class TeamNewFunction implements FirebaseFunction<TeamNewFunction.Parameters, User> {

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

@@ -9,7 +9,7 @@ class TeamNewFunction {
         name: new typescript_common_functionality_1.ValueTypeBuilder(),
         paypalMeLink: new typescript_common_functionality_1.ValueTypeBuilder(),
         personId: types_1.Person.Id.builder,
-        personProperties: types_1.PersonPrivateProperties.builder
+        personProperties: types_1.PersonProperties.builder
     });
     returnTypeBuilder = types_1.User.builder;
 }

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

@@ -20,6 +20,13 @@ export declare namespace PayedState {
      * @returns Localized string representation of the payment state
      */
     function formatted(state: PayedState, locale: Locale): string;
+    /**
+     * Toggles the payment state between 'payed' and 'notPayed'.
+     *
+     * @param state - The current payment state
+     * @returns The toggled payment state
+     */
+    function toggled(state: PayedState): PayedState;
     /**
      * Type builder for PayedState serialization/deserialization.
      */

package/lib/src/types/PayedState.js

@@ -21,6 +21,21 @@ var PayedState;
         return Localization_1.Localization.shared(locale).payedState[state].value();
     }
     PayedState.formatted = formatted;
+    /**
+     * Toggles the payment state between 'payed' and 'notPayed'.
+     *
+     * @param state - The current payment state
+     * @returns The toggled payment state
+     */
+    function toggled(state) {
+        switch (state) {
+            case 'payed':
+                return 'notPayed';
+            case 'notPayed':
+                return 'payed';
+        }
+    }
+    PayedState.toggled = toggled;
     /**
      * Type builder for PayedState serialization/deserialization.
      */

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

@@ -1,4 +1,4 @@
-import { PersonPrivateProperties } from './PersonPrivateProperties';
+import { PersonProperties } from './PersonProperties';
 import { PersonSignInProperties } from './PersonSignInProperties';
 import { Fine } from './Fine';
 import { Flattable, Guid, ITypeBuilder, Tagged } from '@stevenkellner/typescript-common-functionality';
@@ -9,7 +9,7 @@ import { Flattable, Guid, ITypeBuilder, Tagged } from '@stevenkellner/typescript
  */
 export declare class Person implements Flattable<Person.Flatten> {
     id: Person.Id;
-    properties: PersonPrivateProperties;
+    properties: PersonProperties;
     fineIds: Fine.Id[];
     signInProperties: PersonSignInProperties | null;
     /**
@@ -20,7 +20,7 @@ export declare class Person implements Flattable<Person.Flatten> {
      * @param fineIds - Array of fine IDs assigned to this person (defaults to empty array)
      * @param signInProperties - Optional sign-in properties if the person has signed in (defaults to null)
      */
-    constructor(id: Person.Id, properties: PersonPrivateProperties, fineIds?: Fine.Id[], signInProperties?: PersonSignInProperties | null);
+    constructor(id: Person.Id, properties: PersonProperties, fineIds?: Fine.Id[], signInProperties?: PersonSignInProperties | null);
     /**
      * Returns the flattened representation of the person for serialization.
      */
@@ -52,7 +52,7 @@ export declare namespace Person {
      */
     type Flatten = {
         id: Id.Flatten;
-        properties: PersonPrivateProperties.Flatten;
+        properties: PersonProperties.Flatten;
         fineIds: Fine.Id.Flatten[];
         signInProperties: PersonSignInProperties.Flatten | null;
     };

package/lib/src/types/Person.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Person = void 0;
-const PersonPrivateProperties_1 = require("./PersonPrivateProperties");
+const PersonProperties_1 = require("./PersonProperties");
 const PersonSignInProperties_1 = require("./PersonSignInProperties");
 const Fine_1 = require("./Fine");
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
@@ -71,7 +71,7 @@ exports.Person = Person;
          * @returns Person instance
          */
         build(value) {
-            return new Person(Id.builder.build(value.id), PersonPrivateProperties_1.PersonPrivateProperties.builder.build(value.properties), value.fineIds.map(fineId => Fine_1.Fine.Id.builder.build(fineId)), value.signInProperties ? PersonSignInProperties_1.PersonSignInProperties.builder.build(value.signInProperties) : null);
+            return new Person(Id.builder.build(value.id), PersonProperties_1.PersonProperties.builder.build(value.properties), value.fineIds.map(fineId => Fine_1.Fine.Id.builder.build(fineId)), value.signInProperties ? PersonSignInProperties_1.PersonSignInProperties.builder.build(value.signInProperties) : null);
         }
     }
     Person.TypeBuilder = TypeBuilder;

package/lib/src/types/{PersonPrivateProperties.d.ts → PersonProperties.d.ts}

@@ -5,7 +5,7 @@ import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functi
  * Contains personal information that is private to the person,
  * such as their name. The last name is optional.
  */
-export declare class PersonPrivateProperties implements Flattable<PersonPrivateProperties.Flatten> {
+export declare class PersonProperties implements Flattable<PersonProperties.Flatten> {
     firstName: string;
     lastName: string | null;
     /**
@@ -17,9 +17,9 @@ export declare class PersonPrivateProperties implements Flattable<PersonPrivateP
     /**
      * Gets the flattened representation of these properties for serialization.
      */
-    get flatten(): PersonPrivateProperties.Flatten;
+    get flatten(): PersonProperties.Flatten;
 }
-export declare namespace PersonPrivateProperties {
+export declare namespace PersonProperties {
     /**
      * Flattened representation of person private properties for serialization.
      */
@@ -28,18 +28,18 @@ export declare namespace PersonPrivateProperties {
         lastName: string | null;
     };
     /**
-     * Builder for constructing PersonPrivateProperties from flattened data.
+     * Builder for constructing PersonProperties from flattened data.
      */
-    class TypeBuilder implements ITypeBuilder<Flatten, PersonPrivateProperties> {
+    class TypeBuilder implements ITypeBuilder<Flatten, PersonProperties> {
         /**
-         * Builds a PersonPrivateProperties instance from flattened data.
+         * Builds a PersonProperties instance from flattened data.
          * @param value - The flattened person private properties data
-         * @returns A new PersonPrivateProperties instance
+         * @returns A new PersonProperties instance
          */
-        build(value: Flatten): PersonPrivateProperties;
+        build(value: Flatten): PersonProperties;
     }
     /**
-     * Singleton builder instance for PersonPrivateProperties.
+     * Singleton builder instance for PersonProperties.
      */
     const builder: TypeBuilder;
 }

package/lib/src/types/{PersonPrivateProperties.js → PersonProperties.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PersonPrivateProperties = void 0;
+exports.PersonProperties = void 0;
 /**
  * Represents the private properties of a person.
  *
  * Contains personal information that is private to the person,
  * such as their name. The last name is optional.
  */
-class PersonPrivateProperties {
+class PersonProperties {
     firstName;
     lastName;
     /**
@@ -29,24 +29,24 @@ class PersonPrivateProperties {
         };
     }
 }
-exports.PersonPrivateProperties = PersonPrivateProperties;
-(function (PersonPrivateProperties) {
+exports.PersonProperties = PersonProperties;
+(function (PersonProperties) {
     /**
-     * Builder for constructing PersonPrivateProperties from flattened data.
+     * Builder for constructing PersonProperties from flattened data.
      */
     class TypeBuilder {
         /**
-         * Builds a PersonPrivateProperties instance from flattened data.
+         * Builds a PersonProperties instance from flattened data.
          * @param value - The flattened person private properties data
-         * @returns A new PersonPrivateProperties instance
+         * @returns A new PersonProperties instance
          */
         build(value) {
-            return new PersonPrivateProperties(value.firstName, value.lastName);
+            return new PersonProperties(value.firstName, value.lastName);
         }
     }
-    PersonPrivateProperties.TypeBuilder = TypeBuilder;
+    PersonProperties.TypeBuilder = TypeBuilder;
     /**
-     * Singleton builder instance for PersonPrivateProperties.
+     * Singleton builder instance for PersonProperties.
      */
-    PersonPrivateProperties.builder = new TypeBuilder();
-})(PersonPrivateProperties || (exports.PersonPrivateProperties = PersonPrivateProperties = {}));
+    PersonProperties.builder = new TypeBuilder();
+})(PersonProperties || (exports.PersonProperties = PersonProperties = {}));

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

@@ -10,17 +10,17 @@ import { UserRole } from './UserRole';
  */
 export declare class PersonSignInProperties implements Flattable<PersonSignInProperties.Flatten> {
     userId: User.Id;
-    signInDate: UtcDate;
+    joinDate: UtcDate;
     notificationProperties: NotificationProperties;
     roles: UserRole[];
     /**
      * Creates new person sign-in properties.
      * @param userId - The unique identifier of the user associated with this person
-     * @param signInDate - The timestamp when the person signed in
+     * @param joinDate - The timestamp when the person joined the team
      * @param notificationProperties - Optional notification preferences (defaults to new NotificationProperties)
      * @param roles - Optional array of user roles for access control (defaults to empty array)
      */
-    constructor(userId: User.Id, signInDate: UtcDate, notificationProperties?: NotificationProperties, roles?: UserRole[]);
+    constructor(userId: User.Id, joinDate: UtcDate, notificationProperties?: NotificationProperties, roles?: UserRole[]);
     /**
      * Gets the flattened representation of these sign-in properties for serialization.
      */
@@ -32,7 +32,7 @@ export declare namespace PersonSignInProperties {
      */
     type Flatten = {
         userId: User.Id.Flatten;
-        signInDate: UtcDate.Flatten;
+        joinDate: UtcDate.Flatten;
         notificationProperties: NotificationProperties.Flatten;
         roles: UserRole[];
     };

package/lib/src/types/PersonSignInProperties.js

@@ -12,19 +12,19 @@ const User_1 = require("./User");
  */
 class PersonSignInProperties {
     userId;
-    signInDate;
+    joinDate;
     notificationProperties;
     roles;
     /**
      * Creates new person sign-in properties.
      * @param userId - The unique identifier of the user associated with this person
-     * @param signInDate - The timestamp when the person signed in
+     * @param joinDate - The timestamp when the person joined the team
      * @param notificationProperties - Optional notification preferences (defaults to new NotificationProperties)
      * @param roles - Optional array of user roles for access control (defaults to empty array)
      */
-    constructor(userId, signInDate, notificationProperties = new NotificationProperties_1.NotificationProperties(), roles = []) {
+    constructor(userId, joinDate, notificationProperties = new NotificationProperties_1.NotificationProperties(), roles = []) {
         this.userId = userId;
-        this.signInDate = signInDate;
+        this.joinDate = joinDate;
         this.notificationProperties = notificationProperties;
         this.roles = roles;
     }
@@ -34,7 +34,7 @@ class PersonSignInProperties {
     get flatten() {
         return {
             userId: this.userId.flatten,
-            signInDate: this.signInDate.flatten,
+            joinDate: this.joinDate.flatten,
             notificationProperties: this.notificationProperties.flatten,
             roles: this.roles
         };
@@ -52,7 +52,7 @@ exports.PersonSignInProperties = PersonSignInProperties;
          * @returns A new PersonSignInProperties instance
          */
         build(value) {
-            return new PersonSignInProperties(User_1.User.Id.builder.build(value.userId), typescript_common_functionality_1.UtcDate.builder.build(value.signInDate), NotificationProperties_1.NotificationProperties.builder.build(value.notificationProperties), value.roles);
+            return new PersonSignInProperties(User_1.User.Id.builder.build(value.userId), typescript_common_functionality_1.UtcDate.builder.build(value.joinDate), NotificationProperties_1.NotificationProperties.builder.build(value.notificationProperties), value.roles);
         }
     }
     PersonSignInProperties.TypeBuilder = TypeBuilder;

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

@@ -1,4 +1,4 @@
-import { Dictionary, Flattable, ITypeBuilder, Tagged } from '@stevenkellner/typescript-common-functionality';
+import { Dictionary, Flattable, ITypeBuilder, Tagged, UtcDate } from '@stevenkellner/typescript-common-functionality';
 import { Team } from './Team';
 import { Person } from './Person';
 /**
@@ -9,13 +9,15 @@ import { Person } from './Person';
  */
 export declare class User implements Flattable<User.Flatten> {
     id: User.Id;
+    signInDate: UtcDate;
+    signInType: User.SignInType;
     teams: Dictionary<Team.Id, User.TeamProperties>;
     /**
      * Creates a new User instance.
      * @param id - The unique identifier for this user
      * @param teams - Dictionary mapping team IDs to team-specific user properties
      */
-    constructor(id: User.Id, teams?: Dictionary<Team.Id, User.TeamProperties>);
+    constructor(id: User.Id, signInDate: UtcDate, signInType: User.SignInType, teams?: Dictionary<Team.Id, User.TeamProperties>);
     /**
      * Gets the flattened representation of this user for serialization.
      */
@@ -36,6 +38,118 @@ export declare namespace User {
          */
         const builder: Tagged.TypeBuilder<string, "user">;
     }
+    /**
+     * Represents email-based authentication sign-in type.
+     *
+     * Used when a user signs in using their email address.
+     */
+    class SignInTypeEmail implements Flattable<SignInTypeEmail.Flatten> {
+        email: string;
+        /**
+         * Creates a new email sign-in type.
+         * @param email - The email address used for authentication
+         */
+        constructor(email: string);
+        /**
+         * Gets the flattened representation for serialization.
+         */
+        get flatten(): SignInTypeEmail.Flatten;
+    }
+    namespace SignInTypeEmail {
+        /**
+         * Flattened representation of email sign-in type for serialization.
+         */
+        type Flatten = {
+            type: 'email';
+            email: string;
+        };
+        /**
+         * Builder for constructing SignInTypeEmail instances from flattened data.
+         */
+        class TypeBuilder implements ITypeBuilder<Flatten, SignInTypeEmail> {
+            /**
+             * Builds a SignInTypeEmail instance from flattened data.
+             * @param value - The flattened email sign-in type data
+             * @returns A new SignInTypeEmail instance
+             */
+            build(value: Flatten): SignInTypeEmail;
+        }
+        /**
+         * Singleton builder instance for SignInTypeEmail.
+         */
+        const builder: TypeBuilder;
+    }
+    /**
+     * Represents OAuth-based authentication sign-in type.
+     *
+     * Used when a user signs in using an OAuth provider (Google or Apple).
+     */
+    class SignInTypeOAuth implements Flattable<SignInTypeOAuth.Flatten> {
+        provider: 'google' | 'apple';
+        /**
+         * Creates a new OAuth sign-in type.
+         * @param provider - The OAuth provider used for authentication ('google' or 'apple')
+         */
+        constructor(provider: 'google' | 'apple');
+        /**
+         * Gets the flattened representation for serialization.
+         */
+        get flatten(): SignInTypeOAuth.Flatten;
+    }
+    namespace SignInTypeOAuth {
+        /**
+         * Flattened representation of OAuth sign-in type for serialization.
+         */
+        type Flatten = {
+            type: 'google' | 'apple';
+        };
+        /**
+         * Builder for constructing SignInTypeOAuth instances from flattened data.
+         */
+        class TypeBuilder implements ITypeBuilder<Flatten, SignInTypeOAuth> {
+            /**
+             * Builds a SignInTypeOAuth instance from flattened data.
+             * @param value - The flattened OAuth sign-in type data
+             * @returns A new SignInTypeOAuth instance
+             */
+            build(value: Flatten): SignInTypeOAuth;
+        }
+        /**
+         * Singleton builder instance for SignInTypeOAuth.
+         */
+        const builder: TypeBuilder;
+    }
+    /**
+     * Union type representing any sign-in method.
+     *
+     * Can be either email-based or OAuth-based authentication.
+     */
+    type SignInType = SignInTypeEmail | SignInTypeOAuth;
+    namespace SignInType {
+        /**
+         * Flattened representation of any sign-in type for serialization.
+         */
+        type Flatten = SignInTypeEmail.Flatten | SignInTypeOAuth.Flatten;
+        /**
+         * Builder for constructing SignInType instances from flattened data.
+         *
+         * Automatically determines the correct type based on the 'type' field.
+         */
+        class TypeBuilder implements ITypeBuilder<Flatten, SignInType> {
+            /**
+             * Builds a SignInType instance from flattened data.
+             *
+             * Routes to the appropriate builder based on the type field.
+             * @param value - The flattened sign-in type data
+             * @returns Either a SignInTypeEmail or SignInTypeOAuth instance
+             */
+            build(value: Flatten): SignInType;
+        }
+        /**
+         * Singleton builder instance for SignInType.
+         */
+        const builder: TypeBuilder;
+    }
     /**
      * Properties that are specific to a user's membership in a particular team.
      */
@@ -85,6 +199,8 @@ export declare namespace User {
      */
     type Flatten = {
         id: Id.Flatten;
+        signInDate: string;
+        signInType: SignInType.Flatten;
         teams: Dictionary.Flatten<TeamProperties>;
     };
     /**