@stevenkellner/team-conduct-api 1.0.36 → 2.0.1

package/lib/src/types/NotificationProperties.js

@@ -2,13 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotificationProperties = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
+/**
+ * Represents notification properties for a user including device tokens and subscription preferences.
+ *
+ * Manages push notification device tokens (identified by hashed token IDs for security)
+ * and user preferences for which types of notifications they want to receive.
+ */
 class NotificationProperties {
     tokens;
     subscriptions;
+    /**
+     * Creates new notification properties.
+     * @param tokens - Dictionary mapping token IDs to device tokens for push notifications (defaults to empty)
+     * @param subscriptions - Array of notification types the user is subscribed to (defaults to empty)
+     */
     constructor(tokens = new typescript_common_functionality_1.Dictionary(NotificationProperties.TokenId.builder), subscriptions = []) {
         this.tokens = tokens;
         this.subscriptions = subscriptions;
     }
+    /**
+     * Gets the flattened representation of these notification properties for serialization.
+     */
     get flatten() {
         return {
             tokens: this.tokens.flatten,
@@ -20,6 +34,12 @@ exports.NotificationProperties = NotificationProperties;
 (function (NotificationProperties) {
     let TokenId;
     (function (TokenId) {
+        /**
+         * Creates a token ID from a device token by hashing it with SHA-512.
+         * Only the first 16 characters of the hash are used as the identifier.
+         * @param token - The device push notification token
+         * @returns A hashed token ID for secure storage and lookup
+         */
         function create(token) {
             const hasher = new typescript_common_functionality_1.Sha512();
             const tokenBytes = typescript_common_functionality_1.BytesCoder.fromUtf8(token);
@@ -29,22 +49,46 @@ exports.NotificationProperties = NotificationProperties;
             return new typescript_common_functionality_1.Tagged(rawId, 'notificationToken');
         }
         TokenId.create = create;
+        /**
+         * Builder for constructing TokenId instances from strings.
+         */
         TokenId.builder = typescript_common_functionality_1.Tagged.builder('notificationToken', new typescript_common_functionality_1.ValueTypeBuilder());
     })(TokenId = NotificationProperties.TokenId || (NotificationProperties.TokenId = {}));
+    /**
+     * Available notification subscription types.
+     */
+    const subscriptions = [
+        'new-fine',
+        'fine-reminder',
+        'fine-state-change'
+    ];
     let Subscription;
     (function (Subscription) {
-        Subscription.all = [
-            'new-fine',
-            'fine-reminder',
-            'fine-state-change'
-        ];
+        /**
+         * Readonly array of all available subscription types.
+         */
+        Subscription.all = subscriptions;
+        /**
+         * Builder for constructing Subscription values from strings.
+         */
         Subscription.builder = new typescript_common_functionality_1.ValueTypeBuilder();
     })(Subscription = NotificationProperties.Subscription || (NotificationProperties.Subscription = {}));
+    /**
+     * Builder for constructing NotificationProperties from flattened data.
+     */
     class TypeBuilder {
+        /**
+         * Builds a NotificationProperties instance from flattened data.
+         * @param value - The flattened notification properties data
+         * @returns A new NotificationProperties instance
+         */
         build(value) {
             return new NotificationProperties(typescript_common_functionality_1.Dictionary.builder(TokenId.builder, new typescript_common_functionality_1.ValueTypeBuilder()).build(value.tokens), value.subscriptions);
         }
     }
     NotificationProperties.TypeBuilder = TypeBuilder;
+    /**
+     * Singleton builder instance for NotificationProperties.
+     */
     NotificationProperties.builder = new TypeBuilder();
 })(NotificationProperties || (exports.NotificationProperties = NotificationProperties = {}));

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

@@ -1,12 +1,28 @@
 import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-export type PayedState = 'payed' | 'notPayed';
+import { Locale } from './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).
+ */
+export type PayedState = typeof payedStates[number];
 export declare namespace PayedState {
-    const all: PayedState[];
-    function formatted(state: PayedState): string;
-    function toggled(state: PayedState): PayedState;
-    function payedTag(state: PayedState): {
-        value: string;
-        severity: 'secondary' | 'danger';
-    };
-    const builder: ValueTypeBuilder<PayedState>;
+    /**
+     * Array containing all possible payment states.
+     */
+    const all: readonly PayedState[];
+    /**
+     * Returns the localized display string for a payment state.
+     *
+     * @param state - The payment state to format
+     * @param locale - The locale to use for formatting
+     * @returns Localized string representation of the payment state
+     */
+    function formatted(state: PayedState, locale: Locale): string;
+    /**
+     * Type builder for PayedState serialization/deserialization.
+     */
+    const builder: ValueTypeBuilder<"payed" | "notPayed">;
 }
+export {};

package/lib/src/types/PayedState.js

@@ -3,36 +3,26 @@ 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");
+const payedStates = ['payed', 'notPayed'];
 var PayedState;
 (function (PayedState) {
-    PayedState.all = ['payed', 'notPayed'];
-    function formatted(state) {
-        return Localization_1.Localization.shared.payedState[state].value();
+    /**
+     * Array containing all possible payment states.
+     */
+    PayedState.all = payedStates;
+    /**
+     * Returns the localized display string for a payment state.
+     *
+     * @param state - The payment state to format
+     * @param locale - The locale to use for formatting
+     * @returns Localized string representation of the payment state
+     */
+    function formatted(state, locale) {
+        return Localization_1.Localization.shared(locale).payedState[state].value();
     }
     PayedState.formatted = formatted;
-    function toggled(state) {
-        switch (state) {
-            case 'payed':
-                return 'notPayed';
-            case 'notPayed':
-                return 'payed';
-        }
-    }
-    PayedState.toggled = toggled;
-    function payedTag(state) {
-        switch (state) {
-            case 'payed':
-                return {
-                    value: formatted(state),
-                    severity: 'secondary'
-                };
-            case 'notPayed':
-                return {
-                    value: formatted(state),
-                    severity: 'danger'
-                };
-        }
-    }
-    PayedState.payedTag = payedTag;
+    /**
+     * Type builder for PayedState serialization/deserialization.
+     */
     PayedState.builder = new typescript_common_functionality_1.ValueTypeBuilder();
 })(PayedState || (exports.PayedState = PayedState = {}));

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

@@ -2,29 +2,74 @@ import { PersonPrivateProperties } from './PersonPrivateProperties';
 import { PersonSignInProperties } from './PersonSignInProperties';
 import { Fine } from './Fine';
 import { Flattable, Guid, ITypeBuilder, Tagged } from '@stevenkellner/typescript-common-functionality';
+/**
+ * Represents a person within a team, including their personal details, assigned fines, and optional sign-in properties.
+ *
+ * A person can have multiple fines assigned to them and may or may not be signed in (have sign-in properties).
+ */
 export declare class Person implements Flattable<Person.Flatten> {
     id: Person.Id;
     properties: PersonPrivateProperties;
     fineIds: Fine.Id[];
     signInProperties: PersonSignInProperties | null;
+    /**
+     * Creates a new Person instance.
+     *
+     * @param id - Unique identifier for the person (GUID)
+     * @param properties - Private properties including first name and optional last name
+     * @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);
+    /**
+     * Returns the flattened representation of the person for serialization.
+     */
     get flatten(): Person.Flatten;
+    /**
+     * Returns the person's full name.
+     *
+     * If lastName is null, returns only firstName. Otherwise returns "firstName lastName".
+     */
     get name(): string;
 }
 export declare namespace Person {
+    /**
+     * Tagged GUID type for person identifiers.
+     */
     type Id = Tagged<Guid, 'person'>;
     namespace Id {
+        /**
+         * Flattened representation of a person ID (GUID string).
+         */
         type Flatten = string;
+        /**
+         * Type builder for Person.Id serialization/deserialization.
+         */
         const builder: Tagged.TypeBuilder<Guid, "person">;
     }
+    /**
+     * Flattened representation of a Person for serialization.
+     */
     type Flatten = {
         id: Id.Flatten;
         properties: PersonPrivateProperties.Flatten;
         fineIds: Fine.Id.Flatten[];
         signInProperties: PersonSignInProperties.Flatten | null;
     };
+    /**
+     * Type builder for Person serialization/deserialization.
+     */
     class TypeBuilder implements ITypeBuilder<Flatten, Person> {
+        /**
+         * Builds a Person instance from flattened data.
+         *
+         * @param value - Flattened person data
+         * @returns Person instance
+         */
         build(value: Flatten): Person;
     }
+    /**
+     * Singleton instance of TypeBuilder for Person.
+     */
     const builder: TypeBuilder;
 }

package/lib/src/types/Person.js

@@ -5,17 +5,33 @@ const PersonPrivateProperties_1 = require("./PersonPrivateProperties");
 const PersonSignInProperties_1 = require("./PersonSignInProperties");
 const Fine_1 = require("./Fine");
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
+/**
+ * Represents a person within a team, including their personal details, assigned fines, and optional sign-in properties.
+ *
+ * A person can have multiple fines assigned to them and may or may not be signed in (have sign-in properties).
+ */
 class Person {
     id;
     properties;
     fineIds;
     signInProperties;
+    /**
+     * Creates a new Person instance.
+     *
+     * @param id - Unique identifier for the person (GUID)
+     * @param properties - Private properties including first name and optional last name
+     * @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, properties, fineIds = [], signInProperties = null) {
         this.id = id;
         this.properties = properties;
         this.fineIds = fineIds;
         this.signInProperties = signInProperties;
     }
+    /**
+     * Returns the flattened representation of the person for serialization.
+     */
     get flatten() {
         return {
             id: this.id.flatten,
@@ -24,6 +40,11 @@ class Person {
             signInProperties: this.signInProperties?.flatten ?? null
         };
     }
+    /**
+     * Returns the person's full name.
+     *
+     * If lastName is null, returns only firstName. Otherwise returns "firstName lastName".
+     */
     get name() {
         if (this.properties.lastName === null)
             return this.properties.firstName;
@@ -34,13 +55,28 @@ exports.Person = Person;
 (function (Person) {
     let Id;
     (function (Id) {
+        /**
+         * Type builder for Person.Id serialization/deserialization.
+         */
         Id.builder = typescript_common_functionality_1.Tagged.builder('person', typescript_common_functionality_1.Guid.builder);
     })(Id = Person.Id || (Person.Id = {}));
+    /**
+     * Type builder for Person serialization/deserialization.
+     */
     class TypeBuilder {
+        /**
+         * Builds a Person instance from flattened data.
+         *
+         * @param value - Flattened person data
+         * @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);
         }
     }
     Person.TypeBuilder = TypeBuilder;
+    /**
+     * Singleton instance of TypeBuilder for Person.
+     */
     Person.builder = new TypeBuilder();
 })(Person || (exports.Person = Person = {}));

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

@@ -1,17 +1,45 @@
 import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functionality';
+/**
+ * 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.
+ */
 export declare class PersonPrivateProperties implements Flattable<PersonPrivateProperties.Flatten> {
     firstName: string;
     lastName: string | null;
+    /**
+     * Creates new person private 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);
+    /**
+     * Gets the flattened representation of these properties for serialization.
+     */
     get flatten(): PersonPrivateProperties.Flatten;
 }
 export declare namespace PersonPrivateProperties {
+    /**
+     * Flattened representation of person private properties for serialization.
+     */
     type Flatten = {
         firstName: string;
         lastName: string | null;
     };
+    /**
+     * Builder for constructing PersonPrivateProperties from flattened data.
+     */
     class TypeBuilder implements ITypeBuilder<Flatten, PersonPrivateProperties> {
+        /**
+         * Builds a PersonPrivateProperties instance from flattened data.
+         * @param value - The flattened person private properties data
+         * @returns A new PersonPrivateProperties instance
+         */
         build(value: Flatten): PersonPrivateProperties;
     }
+    /**
+     * Singleton builder instance for PersonPrivateProperties.
+     */
     const builder: TypeBuilder;
 }

package/lib/src/types/PersonPrivateProperties.js

@@ -1,13 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PersonPrivateProperties = 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 {
     firstName;
     lastName;
+    /**
+     * Creates new person private properties.
+     * @param firstName - The first name of the person
+     * @param lastName - The last name of the person (null if not provided)
+     */
     constructor(firstName, lastName) {
         this.firstName = firstName;
         this.lastName = lastName;
     }
+    /**
+     * Gets the flattened representation of these properties for serialization.
+     */
     get flatten() {
         return {
             firstName: this.firstName,
@@ -17,11 +31,22 @@ class PersonPrivateProperties {
 }
 exports.PersonPrivateProperties = PersonPrivateProperties;
 (function (PersonPrivateProperties) {
+    /**
+     * Builder for constructing PersonPrivateProperties from flattened data.
+     */
     class TypeBuilder {
+        /**
+         * Builds a PersonPrivateProperties instance from flattened data.
+         * @param value - The flattened person private properties data
+         * @returns A new PersonPrivateProperties instance
+         */
         build(value) {
             return new PersonPrivateProperties(value.firstName, value.lastName);
         }
     }
     PersonPrivateProperties.TypeBuilder = TypeBuilder;
+    /**
+     * Singleton builder instance for PersonPrivateProperties.
+     */
     PersonPrivateProperties.builder = new TypeBuilder();
 })(PersonPrivateProperties || (exports.PersonPrivateProperties = PersonPrivateProperties = {}));

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

@@ -2,23 +2,53 @@ import { Flattable, ITypeBuilder, UtcDate } from '@stevenkellner/typescript-comm
 import { NotificationProperties } from './NotificationProperties';
 import { User } from './User';
 import { UserRole } from './UserRole';
+/**
+ * Represents the sign-in properties for a person in the system.
+ *
+ * Contains authentication-related information including user ID, sign-in timestamp,
+ * notification preferences, and assigned user roles for access control.
+ */
 export declare class PersonSignInProperties implements Flattable<PersonSignInProperties.Flatten> {
     userId: User.Id;
     signInDate: 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 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[]);
+    /**
+     * Gets the flattened representation of these sign-in properties for serialization.
+     */
     get flatten(): PersonSignInProperties.Flatten;
 }
 export declare namespace PersonSignInProperties {
+    /**
+     * Flattened representation of person sign-in properties for serialization.
+     */
     type Flatten = {
         userId: User.Id.Flatten;
         signInDate: UtcDate.Flatten;
         notificationProperties: NotificationProperties.Flatten;
         roles: UserRole[];
     };
+    /**
+     * Builder for constructing PersonSignInProperties from flattened data.
+     */
     class TypeBuilder implements ITypeBuilder<Flatten, PersonSignInProperties> {
+        /**
+         * Builds a PersonSignInProperties instance from flattened data.
+         * @param value - The flattened sign-in properties data
+         * @returns A new PersonSignInProperties instance
+         */
         build(value: Flatten): PersonSignInProperties;
     }
+    /**
+     * Singleton builder instance for PersonSignInProperties.
+     */
     const builder: TypeBuilder;
 }

package/lib/src/types/PersonSignInProperties.js

@@ -4,17 +4,33 @@ exports.PersonSignInProperties = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
 const NotificationProperties_1 = require("./NotificationProperties");
 const User_1 = require("./User");
+/**
+ * Represents the sign-in properties for a person in the system.
+ *
+ * Contains authentication-related information including user ID, sign-in timestamp,
+ * notification preferences, and assigned user roles for access control.
+ */
 class PersonSignInProperties {
     userId;
     signInDate;
     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 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 = []) {
         this.userId = userId;
         this.signInDate = signInDate;
         this.notificationProperties = notificationProperties;
         this.roles = roles;
     }
+    /**
+     * Gets the flattened representation of these sign-in properties for serialization.
+     */
     get flatten() {
         return {
             userId: this.userId.flatten,
@@ -26,11 +42,22 @@ class PersonSignInProperties {
 }
 exports.PersonSignInProperties = PersonSignInProperties;
 (function (PersonSignInProperties) {
+    /**
+     * Builder for constructing PersonSignInProperties from flattened data.
+     */
     class TypeBuilder {
+        /**
+         * Builds a PersonSignInProperties instance from flattened data.
+         * @param value - The flattened sign-in properties data
+         * @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);
         }
     }
     PersonSignInProperties.TypeBuilder = TypeBuilder;
+    /**
+     * Singleton builder instance for PersonSignInProperties.
+     */
     PersonSignInProperties.builder = new TypeBuilder();
 })(PersonSignInProperties || (exports.PersonSignInProperties = PersonSignInProperties = {}));

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

@@ -1,10 +1,43 @@
+/**
+ * Handles pluralization of strings based on count values.
+ * Supports different plural forms for various count categories (zero, one, two, few, many, other).
+ * This follows the Unicode CLDR plural rules for internationalization.
+ */
 export declare class Pluralization {
+    /**
+     * Plural form for count = 0 (optional).
+     */
     private readonly zero;
+    /**
+     * Plural form for count = 1 (optional).
+     */
     private readonly one;
+    /**
+     * Plural form for count = 2 (optional).
+     */
     private readonly two;
+    /**
+     * Plural form for count > 1 and < 5 (optional).
+     */
     private readonly few;
+    /**
+     * Plural form for count >= 5 and <= 20 (optional).
+     */
     private readonly many;
+    /**
+     * Default plural form used when no other category matches (required).
+     */
     private readonly other;
+    /**
+     * Creates a new Pluralization instance with specified plural forms.
+     * @param countLocals - Object containing plural forms for different count categories
+     * @param countLocals.zero - Optional form for zero items
+     * @param countLocals.one - Optional form for one item
+     * @param countLocals.two - Optional form for two items
+     * @param countLocals.few - Optional form for a few items (2-4)
+     * @param countLocals.many - Optional form for many items (5-20)
+     * @param countLocals.other - Required default form for all other counts
+     */
     constructor(countLocals: {
         zero?: string;
         one?: string;
@@ -13,5 +46,18 @@ export declare class Pluralization {
         many?: string;
         other: string;
     });
+    /**
+     * Returns the appropriate plural form for the given count.
+     * Applies the following rules in order:
+     * - count = 0: returns 'zero' form if defined
+     * - count = 1: returns 'one' form if defined
+     * - count = 2: returns 'two' form if defined
+     * - 1 < count < 5: returns 'few' form if defined
+     * - 5 <= count <= 20: returns 'many' form if defined
+     * - Otherwise: returns 'other' form
+     *
+     * @param count - The number to determine the plural form for
+     * @returns The appropriate plural form string for the given count
+     */
     get(count: number): string;
 }

package/lib/src/types/Pluralization.js

@@ -1,13 +1,46 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Pluralization = void 0;
+/**
+ * Handles pluralization of strings based on count values.
+ * Supports different plural forms for various count categories (zero, one, two, few, many, other).
+ * This follows the Unicode CLDR plural rules for internationalization.
+ */
 class Pluralization {
+    /**
+     * Plural form for count = 0 (optional).
+     */
     zero;
+    /**
+     * Plural form for count = 1 (optional).
+     */
     one;
+    /**
+     * Plural form for count = 2 (optional).
+     */
     two;
+    /**
+     * Plural form for count > 1 and < 5 (optional).
+     */
     few;
+    /**
+     * Plural form for count >= 5 and <= 20 (optional).
+     */
     many;
+    /**
+     * Default plural form used when no other category matches (required).
+     */
     other;
+    /**
+     * Creates a new Pluralization instance with specified plural forms.
+     * @param countLocals - Object containing plural forms for different count categories
+     * @param countLocals.zero - Optional form for zero items
+     * @param countLocals.one - Optional form for one item
+     * @param countLocals.two - Optional form for two items
+     * @param countLocals.few - Optional form for a few items (2-4)
+     * @param countLocals.many - Optional form for many items (5-20)
+     * @param countLocals.other - Required default form for all other counts
+     */
     constructor(countLocals) {
         this.zero = countLocals.zero ?? null;
         this.one = countLocals.one ?? null;
@@ -16,6 +49,19 @@ class Pluralization {
         this.many = countLocals.many ?? null;
         this.other = countLocals.other;
     }
+    /**
+     * Returns the appropriate plural form for the given count.
+     * Applies the following rules in order:
+     * - count = 0: returns 'zero' form if defined
+     * - count = 1: returns 'one' form if defined
+     * - count = 2: returns 'two' form if defined
+     * - 1 < count < 5: returns 'few' form if defined
+     * - 5 <= count <= 20: returns 'many' form if defined
+     * - Otherwise: returns 'other' form
+     *
+     * @param count - The number to determine the plural form for
+     * @returns The appropriate plural form string for the given count
+     */
     get(count) {
         if (count === 0 && this.zero)
             return this.zero;