@stevenkellner/team-conduct-api 2.0.18 → 2.0.19

package/lib/src/types/{Invitation.js → team/Invitation.js}

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Invitation = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
 const Team_1 = require("./Team");
-const Person_1 = require("./Person");
+const Person_1 = require("../person/Person");
 /**
  * Represents an invitation to join a team.
  *

package/lib/src/types/team/Team.d.ts

@@ -0,0 +1,144 @@
+import { Flattable, Guid, ITypeBuilder, Tagged } from '@stevenkellner/typescript-common-functionality';
+import { Locale } from '../localization/Locale';
+import { Currency } from '../Currency';
+/**
+ * Represents a team in the system with its basic information.
+ *
+ * A team is a group of people who can track fines and payments together.
+ */
+export declare class Team implements Flattable<Team.Flatten> {
+    id: Team.Id;
+    name: string;
+    logoUrl: string | null;
+    sportCategory: string | null;
+    description: string | null;
+    settings: Team.Settings;
+    /**
+     * Creates a new Team instance.
+     *
+     * @param id - The unique identifier for this team
+     * @param name - The display name of the team
+     * @param logoUrl - Optional URL for the team's logo (null if not set)
+     * @param sportCategory - Optional sport category label (null if not set)
+     * @param description - Optional description of the team (null if not set)
+     * @param settings - Team configuration settings
+     */
+    constructor(id: Team.Id, name: string, logoUrl: string | null, sportCategory: string | null, description: string | null, settings: Team.Settings);
+    /**
+     * Gets the flattened representation of this team for serialization.
+     */
+    get flatten(): Team.Flatten;
+}
+export declare namespace Team {
+    /**
+     * Tagged type for team identifiers to prevent mixing with other GUID types.
+     */
+    type Id = Tagged<Guid, 'team'>;
+    namespace Id {
+        /**
+         * Flattened representation of a team ID (plain GUID string).
+         */
+        type Flatten = string;
+        /**
+         * Builder for constructing Team.Id instances from GUID strings.
+         */
+        const builder: Tagged.TypeBuilder<Guid, "team">;
+    }
+    /**
+     * Configurable settings for a team.
+     */
+    class Settings implements Flattable<Settings.Flatten> {
+        paypalMeLink: string | null;
+        allowMembersToAddFines: boolean;
+        fineVisibility: Settings.FineVisibility;
+        joinRequestType: Settings.JoinRequestType;
+        currency: Currency;
+        locale: Locale;
+        /**
+         * Creates new team settings.
+         *
+         * @param paypalMeLink - Optional PayPal.Me link for payment collection (null if not set)
+         * @param allowMembersToAddFines - Whether regular members can add fines
+         * @param fineVisibility - Controls which fines are visible to members
+         * @param joinRequestType - Controls how new members can join the team
+         * @param currency - The currency used for monetary fines
+         * @param locale - The locale for localized output
+         */
+        constructor(paypalMeLink: string | null, allowMembersToAddFines: boolean, fineVisibility: Settings.FineVisibility, joinRequestType: Settings.JoinRequestType, currency: Currency, locale: Locale);
+        /**
+         * Gets the flattened representation of these settings for serialization.
+         */
+        get flatten(): Settings.Flatten;
+    }
+    namespace Settings {
+        /**
+         * Controls which fines are visible to team members.
+         *
+         * - 'only-own-fines': Members can only see their own fines
+         * - 'all-fines': Members can see all fines in the team
+         */
+        type FineVisibility = 'only-own-fines' | 'all-fines';
+        /**
+         * Controls how new members can join the team.
+         *
+         * - 'public-link-without-approval': Anyone with the link can join directly
+         * - 'public-link-with-approval': Anyone with the link can request to join (requires approval)
+         * - 'invite-only': Only invited people can join
+         */
+        type JoinRequestType = 'public-link-without-approval' | 'public-link-with-approval' | 'invite-only';
+        /**
+         * Flattened representation of team settings for serialization.
+         */
+        type Flatten = {
+            paypalMeLink: string | null;
+            allowMembersToAddFines: boolean;
+            fineVisibility: FineVisibility;
+            joinRequestType: JoinRequestType;
+            currency: Currency;
+            locale: Locale;
+        };
+        /**
+         * Builder for constructing Settings instances from flattened data.
+         */
+        class TypeBuilder implements ITypeBuilder<Flatten, Settings> {
+            /**
+             * Builds a Settings instance from flattened data.
+             *
+             * @param value - The flattened team settings data
+             * @returns A new Settings instance
+             */
+            build(value: Flatten): Settings;
+        }
+        /**
+         * Singleton builder instance for Settings.
+         */
+        const builder: TypeBuilder;
+    }
+    /**
+     * Flattened representation of a Team for serialization.
+     */
+    type Flatten = {
+        id: Id.Flatten;
+        name: string;
+        logoUrl: string | null;
+        sportCategory: string | null;
+        description: string | null;
+        settings: Settings.Flatten;
+    };
+    /**
+     * Builder for constructing Team instances from flattened data.
+     */
+    class TypeBuilder implements ITypeBuilder<Flatten, Team> {
+        /**
+         * Builds a Team instance from flattened data.
+         *
+         * @param value - The flattened team data
+         * @returns A new Team instance
+         */
+        build(value: Flatten): Team;
+    }
+    /**
+     * Singleton builder instance for Team.
+     */
+    const builder: TypeBuilder;
+}

package/lib/src/types/team/Team.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Team = void 0;
+const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
+/**
+ * Represents a team in the system with its basic information.
+ *
+ * A team is a group of people who can track fines and payments together.
+ */
+class Team {
+    id;
+    name;
+    logoUrl;
+    sportCategory;
+    description;
+    settings;
+    /**
+     * Creates a new Team instance.
+     *
+     * @param id - The unique identifier for this team
+     * @param name - The display name of the team
+     * @param logoUrl - Optional URL for the team's logo (null if not set)
+     * @param sportCategory - Optional sport category label (null if not set)
+     * @param description - Optional description of the team (null if not set)
+     * @param settings - Team configuration settings
+     */
+    constructor(id, name, logoUrl, sportCategory, description, settings) {
+        this.id = id;
+        this.name = name;
+        this.logoUrl = logoUrl;
+        this.sportCategory = sportCategory;
+        this.description = description;
+        this.settings = settings;
+    }
+    /**
+     * Gets the flattened representation of this team for serialization.
+     */
+    get flatten() {
+        return {
+            id: this.id.flatten,
+            name: this.name,
+            logoUrl: this.logoUrl,
+            sportCategory: this.sportCategory,
+            description: this.description,
+            settings: this.settings.flatten
+        };
+    }
+}
+exports.Team = Team;
+(function (Team) {
+    let Id;
+    (function (Id) {
+        /**
+         * Builder for constructing Team.Id instances from GUID strings.
+         */
+        Id.builder = typescript_common_functionality_1.Tagged.builder('team', typescript_common_functionality_1.Guid.builder);
+    })(Id = Team.Id || (Team.Id = {}));
+    /**
+     * Configurable settings for a team.
+     */
+    class Settings {
+        paypalMeLink;
+        allowMembersToAddFines;
+        fineVisibility;
+        joinRequestType;
+        currency;
+        locale;
+        /**
+         * Creates new team settings.
+         *
+         * @param paypalMeLink - Optional PayPal.Me link for payment collection (null if not set)
+         * @param allowMembersToAddFines - Whether regular members can add fines
+         * @param fineVisibility - Controls which fines are visible to members
+         * @param joinRequestType - Controls how new members can join the team
+         * @param currency - The currency used for monetary fines
+         * @param locale - The locale for localized output
+         */
+        constructor(paypalMeLink, allowMembersToAddFines, fineVisibility, joinRequestType, currency, locale) {
+            this.paypalMeLink = paypalMeLink;
+            this.allowMembersToAddFines = allowMembersToAddFines;
+            this.fineVisibility = fineVisibility;
+            this.joinRequestType = joinRequestType;
+            this.currency = currency;
+            this.locale = locale;
+        }
+        /**
+         * Gets the flattened representation of these settings for serialization.
+         */
+        get flatten() {
+            return {
+                paypalMeLink: this.paypalMeLink,
+                allowMembersToAddFines: this.allowMembersToAddFines,
+                fineVisibility: this.fineVisibility,
+                joinRequestType: this.joinRequestType,
+                currency: this.currency,
+                locale: this.locale
+            };
+        }
+    }
+    Team.Settings = Settings;
+    (function (Settings) {
+        /**
+         * Builder for constructing Settings instances from flattened data.
+         */
+        class TypeBuilder {
+            /**
+             * Builds a Settings instance from flattened data.
+             *
+             * @param value - The flattened team settings data
+             * @returns A new Settings instance
+             */
+            build(value) {
+                return new Settings(value.paypalMeLink, value.allowMembersToAddFines, value.fineVisibility, value.joinRequestType, value.currency, value.locale);
+            }
+        }
+        Settings.TypeBuilder = TypeBuilder;
+        /**
+         * Singleton builder instance for Settings.
+         */
+        Settings.builder = new TypeBuilder();
+    })(Settings = Team.Settings || (Team.Settings = {}));
+    /**
+     * Builder for constructing Team instances from flattened data.
+     */
+    class TypeBuilder {
+        /**
+         * Builds a Team instance from flattened data.
+         *
+         * @param value - The flattened team data
+         * @returns A new Team instance
+         */
+        build(value) {
+            return new Team(Id.builder.build(value.id), value.name, value.logoUrl, value.sportCategory, value.description, Settings.builder.build(value.settings));
+        }
+    }
+    Team.TypeBuilder = TypeBuilder;
+    /**
+     * Singleton builder instance for Team.
+     */
+    Team.builder = new TypeBuilder();
+})(Team || (exports.Team = Team = {}));

package/lib/src/types/team/TeamRole.d.ts

@@ -0,0 +1,30 @@
+import { ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
+import { Locale } from '../localization/Locale';
+/**
+ * Array of all available team roles.
+ */
+declare const teamRoles: readonly ["person-manager", "fineTemplate-manager", "fine-manager", "fine-can-add", "team-manager"];
+/**
+ * Represents team roles in the application.
+ * Defines different levels of permissions for team members.
+ */
+export type TeamRole = typeof teamRoles[number];
+export declare namespace TeamRole {
+    /**
+     * Array of all available team roles.
+     */
+    const all: readonly TeamRole[];
+    /**
+     * Returns the localized, human-readable name for a team role.
+     *
+     * @param role - The team role to format
+     * @param locale - The locale to use for localization
+     * @returns The localized role name
+     */
+    function formatted(role: TeamRole, locale: Locale): string;
+    /**
+     * Builder for constructing TeamRole values.
+     */
+    const builder: ValueTypeBuilder<"person-manager" | "fineTemplate-manager" | "fine-manager" | "fine-can-add" | "team-manager">;
+}
+export {};

package/lib/src/types/{UserRole.js → team/TeamRole.js}

@@ -1,27 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserRole = void 0;
+exports.TeamRole = void 0;
 const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const Localization_1 = require("./Localization");
+const Localization_1 = require("../localization/Localization");
 /**
- * Array of all available user roles.
+ * Array of all available team roles.
  */
-const userRoles = [
+const teamRoles = [
     'person-manager', // Can manage persons, i.e. add/edit/remove persons of the team
     'fineTemplate-manager', // Can manage fine templates, i.e. add/edit/remove fine templates
     'fine-manager', // Can manage fines, i.e. add/edit/remove fines
     'fine-can-add', // Can add fines, but not edit or remove them
     'team-manager' // Can manage team settings, i.e. invite/remove team members, change team name, etc.
 ];
-var UserRole;
-(function (UserRole) {
+var TeamRole;
+(function (TeamRole) {
     /**
-     * Array of all available user roles.
+     * Array of all available team roles.
      */
-    UserRole.all = userRoles;
+    TeamRole.all = teamRoles;
     /**
-     * Returns the localized, human-readable name for a user role.
-     * @param role - The user role to format
+     * Returns the localized, human-readable name for a team role.
+     *
+     * @param role - The team role to format
      * @param locale - The locale to use for localization
      * @returns The localized role name
      */
@@ -33,11 +34,11 @@ var UserRole;
             'fine-can-add': 'fineCanAdd',
             'team-manager': 'teamManager'
         };
-        return Localization_1.Localization.shared(locale).userRole[localizationKeyMap[role]].value();
+        return Localization_1.Localization.shared(locale).teamRole[localizationKeyMap[role]].value();
     }
-    UserRole.formatted = formatted;
+    TeamRole.formatted = formatted;
     /**
-     * Builder for constructing UserRole values.
+     * Builder for constructing TeamRole values.
      */
-    UserRole.builder = new typescript_common_functionality_1.ValueTypeBuilder();
-})(UserRole || (exports.UserRole = UserRole = {}));
+    TeamRole.builder = new typescript_common_functionality_1.ValueTypeBuilder();
+})(TeamRole || (exports.TeamRole = TeamRole = {}));

package/lib/src/types/team/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Invitation';
+export * from './Team';
+export * from './TeamRole';

package/lib/src/types/team/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Invitation"), exports);
+__exportStar(require("./Team"), exports);
+__exportStar(require("./TeamRole"), exports);

package/lib/src/types/{NotificationProperties.d.ts → user/NotificationProperties.d.ts}

@@ -10,6 +10,7 @@ export declare class NotificationProperties implements Flattable<NotificationPro
     subscriptions: NotificationProperties.Subscription[];
     /**
      * 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)
      */
@@ -29,6 +30,7 @@ export declare namespace NotificationProperties {
         /**
          * 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
          */
@@ -45,12 +47,14 @@ export declare namespace NotificationProperties {
     /**
      * Available notification subscription types.
      */
-    const subscriptions: readonly ["new-fine", "fine-reminder", "fine-state-change"];
+    const subscriptions: readonly ["new-fine", "fine-changed", "fine-reminder", "fine-state-change"];
     /**
      * Type representing the available notification subscription options.
+     *
      * - new-fine: Notifications when a new fine is created
+     * - fine-changed: Notifications when a fine is updated (non-payed-state change)
      * - fine-reminder: Reminder notifications for unpaid fines
-     * - fine-state-change: Notifications when a fine's status changes
+     * - fine-state-change: Notifications when a fine's payed status changes or is deleted
      */
     export type Subscription = typeof subscriptions[number];
     export namespace Subscription {
@@ -61,7 +65,7 @@ export declare namespace NotificationProperties {
         /**
          * Builder for constructing Subscription values from strings.
          */
-        const builder: ValueTypeBuilder<"new-fine" | "fine-reminder" | "fine-state-change">;
+        const builder: ValueTypeBuilder<"new-fine" | "fine-changed" | "fine-reminder" | "fine-state-change">;
     }
     /**
      * Flattened representation of notification properties for serialization.
@@ -76,6 +80,7 @@ export declare namespace NotificationProperties {
     export class TypeBuilder implements ITypeBuilder<Flatten, NotificationProperties> {
         /**
          * Builds a NotificationProperties instance from flattened data.
+         *
          * @param value - The flattened notification properties data
          * @returns A new NotificationProperties instance
          */

package/lib/src/types/{NotificationProperties.js → user/NotificationProperties.js}

@@ -13,6 +13,7 @@ class NotificationProperties {
     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)
      */
@@ -37,6 +38,7 @@ exports.NotificationProperties = NotificationProperties;
         /**
          * 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
          */
@@ -59,6 +61,7 @@ exports.NotificationProperties = NotificationProperties;
      */
     const subscriptions = [
         'new-fine',
+        'fine-changed',
         'fine-reminder',
         'fine-state-change'
     ];
@@ -79,6 +82,7 @@ exports.NotificationProperties = NotificationProperties;
     class TypeBuilder {
         /**
          * Builds a NotificationProperties instance from flattened data.
+         *
          * @param value - The flattened notification properties data
          * @returns A new NotificationProperties instance
          */