@stevenkellner/team-conduct-api 2.0.20 → 2.0.22

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

@@ -14,7 +14,12 @@ export declare class FineAddFunction implements FirebaseFunction<FineAddFunction
         personId: string;
         fine: {
             id: Fine.Id.Flatten;
-            payedState: import("../../types").PayedState;
+            payedState: {
+                type: "payed";
+                payedDate: import("@stevenkellner/typescript-common-functionality").UtcDate.Flatten;
+            } | {
+                type: "notPayed";
+            };
             date: import("@stevenkellner/typescript-common-functionality").UtcDate.Flatten;
             reason: string;
             amount: {

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

@@ -14,7 +14,12 @@ export declare class FineUpdateFunction implements FirebaseFunction<FineUpdateFu
         personId: string;
         fine: {
             id: Fine.Id.Flatten;
-            payedState: import("../../types").PayedState;
+            payedState: {
+                type: "payed";
+                payedDate: import("@stevenkellner/typescript-common-functionality").UtcDate.Flatten;
+            } | {
+                type: "notPayed";
+            };
             date: import("@stevenkellner/typescript-common-functionality").UtcDate.Flatten;
             reason: string;
             amount: {

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

@@ -14,7 +14,7 @@ export declare class PersonAddFunction implements FirebaseFunction<PersonAddFunc
         id: string;
         properties: {
             firstName: string;
-            lastName: string | null;
+            lastName: string;
         };
     }, PersonAddFunction.Parameters>;
     returnTypeBuilder: ValueTypeBuilder<void>;

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

@@ -14,7 +14,7 @@ export declare class PersonUpdateFunction implements FirebaseFunction<PersonUpda
         id: string;
         properties: {
             firstName: string;
-            lastName: string | null;
+            lastName: string;
         };
     }, PersonUpdateFunction.Parameters>;
     returnTypeBuilder: ValueTypeBuilder<void>;

package/lib/src/types/fine/Fine.d.ts

@@ -18,7 +18,7 @@ export declare class Fine implements Flattable<Fine.Flatten> {
      * Creates a new Fine instance.
      *
      * @param id - Unique identifier for the fine (GUID)
-     * @param payedState - Payment status ('payed' or 'notPayed')
+     * @param payedState - Payment status (Payed with date, or NotPayed)
      * @param date - Date when the fine was issued
      * @param reason - Description or reason for the fine
      * @param amount - Monetary amount of the fine
@@ -251,7 +251,7 @@ export declare namespace Fine {
      */
     type Flatten = {
         id: Id.Flatten;
-        payedState: PayedState;
+        payedState: PayedState.Flatten;
         date: UtcDate.Flatten;
         reason: string;
         amount: Amount.Flatten;

package/lib/src/types/fine/Fine.js

@@ -4,6 +4,7 @@ exports.Fine = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
 const Money_1 = require("../Money");
 const Localization_1 = require("../localization/Localization");
+const PayedState_1 = require("./PayedState");
 /**
  * Represents a fine assigned to a person in a team.
  *
@@ -19,7 +20,7 @@ class Fine {
      * Creates a new Fine instance.
      *
      * @param id - Unique identifier for the fine (GUID)
-     * @param payedState - Payment status ('payed' or 'notPayed')
+     * @param payedState - Payment status (Payed with date, or NotPayed)
      * @param date - Date when the fine was issued
      * @param reason - Description or reason for the fine
      * @param amount - Monetary amount of the fine
@@ -37,7 +38,7 @@ class Fine {
     get flatten() {
         return {
             id: this.id.flatten,
-            payedState: this.payedState,
+            payedState: this.payedState.flatten,
             date: this.date.flatten,
             reason: this.reason,
             amount: this.amount.flatten
@@ -307,7 +308,7 @@ exports.Fine = Fine;
          * @returns Fine instance
          */
         build(value) {
-            return new Fine(Id.builder.build(value.id), value.payedState, typescript_common_functionality_1.UtcDate.builder.build(value.date), value.reason, Amount.builder.build(value.amount));
+            return new Fine(Id.builder.build(value.id), PayedState_1.PayedState.builder.build(value.payedState), typescript_common_functionality_1.UtcDate.builder.build(value.date), value.reason, Amount.builder.build(value.amount));
         }
     }
     Fine.TypeBuilder = TypeBuilder;

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

@@ -1,17 +1,58 @@
-import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
+import { Flattable, ITypeBuilder, UtcDate } from '@stevenkellner/typescript-common-functionality';
 import { Locale } from '../localization/Locale';
-declare const payedStates: readonly ["payed", "notPayed"];
 /**
  * Represents the payment status of a fine.
  *
- * Can be either 'payed' (fine has been paid) or 'notPayed' (fine is unpaid).
+ * Can be either Payed (with the date it was paid) or NotPayed.
  */
-export type PayedState = typeof payedStates[number];
+export type PayedState = PayedState.Payed | PayedState.NotPayed;
 export declare namespace PayedState {
     /**
-     * Array containing all possible payment states.
+     * Represents a fine that has been paid, including the date of payment.
      */
-    const all: readonly PayedState[];
+    class Payed implements Flattable<Payed.Flatten> {
+        payedDate: UtcDate;
+        readonly type: "payed";
+        constructor(payedDate: UtcDate);
+        get flatten(): Payed.Flatten;
+    }
+    namespace Payed {
+        type Flatten = {
+            type: 'payed';
+            payedDate: UtcDate.Flatten;
+        };
+        class TypeBuilder implements ITypeBuilder<Flatten, Payed> {
+            build(value: Flatten): Payed;
+        }
+        const builder: TypeBuilder;
+    }
+    /**
+     * Represents a fine that has not yet been paid.
+     */
+    class NotPayed implements Flattable<NotPayed.Flatten> {
+        readonly type: "notPayed";
+        get flatten(): NotPayed.Flatten;
+    }
+    namespace NotPayed {
+        type Flatten = {
+            type: 'notPayed';
+        };
+        class TypeBuilder implements ITypeBuilder<Flatten, NotPayed> {
+            build(_value: Flatten): NotPayed;
+        }
+        const builder: TypeBuilder;
+    }
+    /**
+     * Flattened representation of PayedState for serialization.
+     */
+    type Flatten = Payed.Flatten | NotPayed.Flatten;
+    /**
+     * Type builder for PayedState serialization/deserialization.
+     */
+    class TypeBuilder implements ITypeBuilder<Flatten, PayedState> {
+        build(value: Flatten): PayedState;
+    }
+    const builder: TypeBuilder;
     /**
      * Returns the localized display string for a payment state.
      *
@@ -21,15 +62,18 @@ export declare namespace PayedState {
      */
     function formatted(state: PayedState, locale: Locale): string;
     /**
-     * Toggles the payment state between 'payed' and 'notPayed'.
+     * Toggles the payment state. Toggling to 'payed' uses the current date.
      *
      * @param state - The current payment state
      * @returns The toggled payment state
      */
     function toggled(state: PayedState): PayedState;
     /**
-     * Type builder for PayedState serialization/deserialization.
+     * Creates a payed state with the given date.
+     */
+    function payed(payedDate: UtcDate): Payed;
+    /**
+     * Creates a notPayed state.
      */
-    const builder: ValueTypeBuilder<"payed" | "notPayed">;
+    function notPayed(): NotPayed;
 }
-export {};

package/lib/src/types/fine/PayedState.js

@@ -3,13 +3,69 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PayedState = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
 const Localization_1 = require("../localization/Localization");
-const payedStates = ['payed', 'notPayed'];
 var PayedState;
 (function (PayedState) {
     /**
-     * Array containing all possible payment states.
+     * Represents a fine that has been paid, including the date of payment.
      */
-    PayedState.all = payedStates;
+    class Payed {
+        payedDate;
+        type = 'payed';
+        constructor(payedDate) {
+            this.payedDate = payedDate;
+        }
+        get flatten() {
+            return {
+                type: 'payed',
+                payedDate: this.payedDate.flatten
+            };
+        }
+    }
+    PayedState.Payed = Payed;
+    (function (Payed) {
+        class TypeBuilder {
+            build(value) {
+                return new Payed(typescript_common_functionality_1.UtcDate.builder.build(value.payedDate));
+            }
+        }
+        Payed.TypeBuilder = TypeBuilder;
+        Payed.builder = new TypeBuilder();
+    })(Payed = PayedState.Payed || (PayedState.Payed = {}));
+    /**
+     * Represents a fine that has not yet been paid.
+     */
+    class NotPayed {
+        type = 'notPayed';
+        get flatten() {
+            return { type: 'notPayed' };
+        }
+    }
+    PayedState.NotPayed = NotPayed;
+    (function (NotPayed) {
+        class TypeBuilder {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            build(_value) {
+                return new NotPayed();
+            }
+        }
+        NotPayed.TypeBuilder = TypeBuilder;
+        NotPayed.builder = new TypeBuilder();
+    })(NotPayed = PayedState.NotPayed || (PayedState.NotPayed = {}));
+    /**
+     * Type builder for PayedState serialization/deserialization.
+     */
+    class TypeBuilder {
+        build(value) {
+            switch (value.type) {
+                case 'payed':
+                    return Payed.builder.build(value);
+                case 'notPayed':
+                    return NotPayed.builder.build(value);
+            }
+        }
+    }
+    PayedState.TypeBuilder = TypeBuilder;
+    PayedState.builder = new TypeBuilder();
     /**
      * Returns the localized display string for a payment state.
      *
@@ -18,26 +74,36 @@ var PayedState;
      * @returns Localized string representation of the payment state
      */
     function formatted(state, locale) {
-        return Localization_1.Localization.shared(locale).payedState[state].value();
+        return Localization_1.Localization.shared(locale).payedState[state.type].value();
     }
     PayedState.formatted = formatted;
     /**
-     * Toggles the payment state between 'payed' and 'notPayed'.
+     * Toggles the payment state. Toggling to 'payed' uses the current date.
      *
      * @param state - The current payment state
      * @returns The toggled payment state
      */
     function toggled(state) {
-        switch (state) {
+        switch (state.type) {
             case 'payed':
-                return 'notPayed';
+                return new NotPayed();
             case 'notPayed':
-                return 'payed';
+                return new Payed(typescript_common_functionality_1.UtcDate.now);
         }
     }
     PayedState.toggled = toggled;
     /**
-     * Type builder for PayedState serialization/deserialization.
+     * Creates a payed state with the given date.
      */
-    PayedState.builder = new typescript_common_functionality_1.ValueTypeBuilder();
+    function payed(payedDate) {
+        return new Payed(payedDate);
+    }
+    PayedState.payed = payed;
+    /**
+     * Creates a notPayed state.
+     */
+    function notPayed() {
+        return new NotPayed();
+    }
+    PayedState.notPayed = notPayed;
 })(PayedState || (exports.PayedState = PayedState = {}));

package/lib/src/types/person/PersonProperties.d.ts

@@ -6,14 +6,14 @@ import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functi
  */
 export declare class PersonProperties implements Flattable<PersonProperties.Flatten> {
     firstName: string;
-    lastName: string | null;
+    lastName: string;
     /**
      * Creates new person properties.
      *
      * @param firstName - The first name of the person
      * @param lastName - The last name of the person (null if not provided)
      */
-    constructor(firstName: string, lastName?: string | null);
+    constructor(firstName: string, lastName: string);
     /**
      * Gets the flattened representation of these properties for serialization.
      */
@@ -25,7 +25,7 @@ export declare namespace PersonProperties {
      */
     type Flatten = {
         firstName: string;
-        lastName: string | null;
+        lastName: string;
     };
     /**
      * Builder for constructing PersonProperties from flattened data.

package/lib/src/types/person/PersonProperties.js

@@ -15,7 +15,7 @@ class PersonProperties {
      * @param firstName - The first name of the person
      * @param lastName - The last name of the person (null if not provided)
      */
-    constructor(firstName, lastName = null) {
+    constructor(firstName, lastName) {
         this.firstName = firstName;
         this.lastName = lastName;
     }

package/package.json

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

package/src/types/fine/Fine.ts

@@ -16,7 +16,7 @@ export class Fine implements Flattable<Fine.Flatten> {
      * Creates a new Fine instance.
      *
      * @param id - Unique identifier for the fine (GUID)
-     * @param payedState - Payment status ('payed' or 'notPayed')
+     * @param payedState - Payment status (Payed with date, or NotPayed)
      * @param date - Date when the fine was issued
      * @param reason - Description or reason for the fine
      * @param amount - Monetary amount of the fine
@@ -35,7 +35,7 @@ export class Fine implements Flattable<Fine.Flatten> {
     public get flatten(): Fine.Flatten {
         return {
             id: this.id.flatten,
-            payedState: this.payedState,
+            payedState: this.payedState.flatten,
             date: this.date.flatten,
             reason: this.reason,
             amount: this.amount.flatten
@@ -364,7 +364,7 @@ export namespace Fine {
      */
     export type Flatten = {
         id: Id.Flatten,
-        payedState: PayedState,
+        payedState: PayedState.Flatten,
         date: UtcDate.Flatten,
         reason: string,
         amount: Amount.Flatten
@@ -384,7 +384,7 @@ export namespace Fine {
         public build(value: Flatten): Fine {
             return new Fine(
                 Id.builder.build(value.id),
-                value.payedState,
+                PayedState.builder.build(value.payedState),
                 UtcDate.builder.build(value.date),
                 value.reason,
                 Amount.builder.build(value.amount)

package/src/types/fine/PayedState.ts

@@ -1,22 +1,101 @@
-import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
+import { Flattable, ITypeBuilder, UtcDate } from '@stevenkellner/typescript-common-functionality';
 import { Localization } from '../localization/Localization';
 import { Locale } from '../localization/Locale';
 
-const payedStates = ['payed', 'notPayed'] as const;
-
 /**
  * Represents the payment status of a fine.
  *
- * Can be either 'payed' (fine has been paid) or 'notPayed' (fine is unpaid).
+ * Can be either Payed (with the date it was paid) or NotPayed.
  */
-export type PayedState = typeof payedStates[number];
+export type PayedState =
+    | PayedState.Payed
+    | PayedState.NotPayed;
 
 export namespace PayedState {
 
     /**
-     * Array containing all possible payment states.
+     * Represents a fine that has been paid, including the date of payment.
      */
-    export const all: readonly PayedState[] = payedStates;
+    export class Payed implements Flattable<Payed.Flatten> {
+
+        public readonly type = 'payed' as const;
+
+        public constructor(
+            public payedDate: UtcDate
+        ) {}
+
+        public get flatten(): Payed.Flatten {
+            return {
+                type: 'payed',
+                payedDate: this.payedDate.flatten
+            };
+        }
+    }
+
+    export namespace Payed {
+
+        export type Flatten = {
+            type: 'payed',
+            payedDate: UtcDate.Flatten
+        };
+
+        export class TypeBuilder implements ITypeBuilder<Flatten, Payed> {
+            public build(value: Flatten): Payed {
+                return new Payed(UtcDate.builder.build(value.payedDate));
+            }
+        }
+
+        export const builder = new TypeBuilder();
+    }
+
+    /**
+     * Represents a fine that has not yet been paid.
+     */
+    export class NotPayed implements Flattable<NotPayed.Flatten> {
+
+        public readonly type = 'notPayed' as const;
+
+        public get flatten(): NotPayed.Flatten {
+            return { type: 'notPayed' };
+        }
+    }
+
+    export namespace NotPayed {
+
+        export type Flatten = {
+            type: 'notPayed'
+        };
+
+        export class TypeBuilder implements ITypeBuilder<Flatten, NotPayed> {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            public build(_value: Flatten): NotPayed {
+                return new NotPayed();
+            }
+        }
+
+        export const builder = new TypeBuilder();
+    }
+
+    /**
+     * Flattened representation of PayedState for serialization.
+     */
+    export type Flatten = Payed.Flatten | NotPayed.Flatten;
+
+    /**
+     * Type builder for PayedState serialization/deserialization.
+     */
+    export class TypeBuilder implements ITypeBuilder<Flatten, PayedState> {
+        public build(value: Flatten): PayedState {
+            switch (value.type) {
+            case 'payed':
+                return Payed.builder.build(value);
+            case 'notPayed':
+                return NotPayed.builder.build(value);
+            }
+        }
+    }
+
+    export const builder = new TypeBuilder();
 
     /**
      * Returns the localized display string for a payment state.
@@ -26,26 +105,35 @@ export namespace PayedState {
      * @returns Localized string representation of the payment state
      */
     export function formatted(state: PayedState, locale: Locale): string {
-        return Localization.shared(locale).payedState[state].value();
+        return Localization.shared(locale).payedState[state.type].value();
     }
 
     /**
-     * Toggles the payment state between 'payed' and 'notPayed'.
+     * Toggles the payment state. Toggling to 'payed' uses the current date.
      *
      * @param state - The current payment state
      * @returns The toggled payment state
      */
     export function toggled(state: PayedState): PayedState {
-        switch (state) {
+        switch (state.type) {
         case 'payed':
-            return 'notPayed';
+            return new NotPayed();
         case 'notPayed':
-            return 'payed';
+            return new Payed(UtcDate.now);
         }
     }
 
     /**
-     * Type builder for PayedState serialization/deserialization.
+     * Creates a payed state with the given date.
      */
-    export const builder = new ValueTypeBuilder<PayedState>();
+    export function payed(payedDate: UtcDate): Payed {
+        return new Payed(payedDate);
+    }
+
+    /**
+     * Creates a notPayed state.
+     */
+    export function notPayed(): NotPayed {
+        return new NotPayed();
+    }
 }

package/src/types/person/PersonProperties.ts

@@ -15,7 +15,7 @@ export class PersonProperties implements Flattable<PersonProperties.Flatten> {
      */
     constructor(
         public firstName: string,
-        public lastName: string | null = null
+        public lastName: string
     ) {}
 
     /**
@@ -36,7 +36,7 @@ export namespace PersonProperties {
      */
     export type Flatten = {
         firstName: string;
-        lastName: string | null;
+        lastName: string;
     }
 
     /**