@stevenkellner/team-conduct-api 2.0.18 → 2.0.19

package/src/types/FineTemplateRepetition.ts

@@ -1,125 +0,0 @@
-import { Flattable, ITypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { Localization } from './Localization';
-import { Locale } from './Locale';
-
-/**
- * Represents how a fine template repeats over time.
- *
- * Defines the repetition unit (minute, day, item, count) and optional maximum count for repetitions.
- */
-export class FineTemplateRepetition implements Flattable<FineTemplateRepetition.Flatten> {
-
-    /**
-     * Creates a new FineTemplateRepetition instance.
-     *
-     * @param item - The repetition unit type (minute, day, item, count)
-     * @param maxCount - Optional maximum number of repetitions (null for unlimited)
-     */
-    public constructor(
-        public item: FineTemplateRepetition.Item,
-        public maxCount: number | null
-    ) {}
-
-    /**
-     * Returns a localized formatted string including the count value.
-     *
-     * @param count - The number of repetitions
-     * @param locale - The locale to use for formatting
-     * @returns Formatted string (e.g., "every 5 minutes")
-     */
-    public formatted(count: number, locale: Locale): string {
-        return Localization.shared(locale).fineTemplateRepetition.item[this.item].withCount.value(count);
-    }
-
-    /**
-     * Returns a localized formatted string without explicitly showing the count.
-     *
-     * @param count - The number of repetitions
-     * @param locale - The locale to use for formatting
-     * @returns Formatted string without count display
-     */
-    public formattedWithoutCount(count: number, locale: Locale): string {
-        return Localization.shared(locale).fineTemplateRepetition.item[this.item].withoutCount.value(count);
-    }
-
-    /**
-     * Returns the flattened representation for serialization.
-     */
-    public get flatten(): FineTemplateRepetition.Flatten {
-        return {
-            item: this.item,
-            maxCount: this.maxCount
-        };
-    }
-}
-
-export namespace FineTemplateRepetition {
-
-    const repetitionItems = [
-        'minute',
-        'day',
-        'item',
-        'count'
-    ] as const;
-
-    /**
-     * Repetition unit type: 'minute', 'day', 'item', or 'count'.
-     */
-    export type Item = typeof repetitionItems[number];
-
-    export namespace Item {
-
-        /**
-         * Array containing all possible repetition item types.
-         */
-        export const all: readonly Item[] = repetitionItems;
-
-        /**
-         * Returns the localized name for a repetition item type.
-         *
-         * @param item - The repetition item type
-         * @param locale - The locale to use for formatting
-         * @returns Localized name string
-         */
-        export function formatted(item: Item, locale: Locale): string {
-            return Localization.shared(locale).fineTemplateRepetition.item[item].name.value();
-        }
-
-        /**
-         * Type builder for Item serialization/deserialization.
-         */
-        export const builder = new ValueTypeBuilder<Item>();
-    }
-
-    /**
-     * Flattened representation of FineTemplateRepetition for serialization.
-     */
-    export type Flatten = {
-        item: Item,
-        maxCount: number | null
-    }
-
-    /**
-     * Type builder for FineTemplateRepetition serialization/deserialization.
-     */
-    export class TypeBuilder implements ITypeBuilder<Flatten, FineTemplateRepetition> {
-
-        /**
-         * Builds a FineTemplateRepetition instance from flattened data.
-         *
-         * @param flatten - Flattened repetition data
-         * @returns FineTemplateRepetition instance
-         */
-        public build(flatten: Flatten): FineTemplateRepetition {
-            return new FineTemplateRepetition(
-                flatten.item,
-                flatten.maxCount
-            );
-        }
-    }
-
-    /**
-     * Singleton instance of TypeBuilder for FineTemplateRepetition.
-     */
-    export const builder = new TypeBuilder();
-}

package/src/types/Team.ts

@@ -1,87 +0,0 @@
-import { Flattable, Guid, ITypeBuilder, Tagged } from '@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.
- * Teams can optionally have a PayPal.Me link for simplified payment collection.
- */
-export class Team implements Flattable<Team.Flatten> {
-
-    /**
-     * Creates a new Team instance.
-     * @param id - The unique identifier for this team
-     * @param name - The display name of the team
-     * @param paypalMeLink - Optional PayPal.Me link for payment collection (null if not set)
-     */
-    public constructor(
-        public id: Team.Id,
-        public name: string,
-        public paypalMeLink: string | null
-    ) {}
-
-    /**
-     * Gets the flattened representation of this team for serialization.
-     */
-    public get flatten(): Team.Flatten {
-        return {
-            id: this.id.flatten,
-            name: this.name,
-            paypalMeLink: this.paypalMeLink
-        };
-    }
-}
-
-export namespace Team {
-
-    /**
-     * Tagged type for team identifiers to prevent mixing with other GUID types.
-     */
-    export type Id = Tagged<Guid, 'team'>;
-
-    export namespace Id {
-
-        /**
-         * Flattened representation of a team ID (plain GUID string).
-         */
-        export type Flatten = string;
-
-        /**
-         * Builder for constructing Team.Id instances from GUID strings.
-         */
-        export const builder = Tagged.builder('team' as const, Guid.builder);
-    }
-
-    /**
-     * Flattened representation of a Team for serialization.
-     */
-    export type Flatten = {
-        id: Id.Flatten,
-        name: string,
-        paypalMeLink: string | null
-    }
-
-    /**
-     * Builder for constructing Team instances from flattened data.
-     */
-    export class TypeBuilder implements ITypeBuilder<Flatten, Team> {
-
-        /**
-         * Builds a Team instance from flattened data.
-         * @param value - The flattened team data
-         * @returns A new Team instance
-         */
-        public build(value: Flatten): Team {
-            return new Team(
-                Id.builder.build(value.id),
-                value.name,
-                value.paypalMeLink
-            );
-        }
-    }
-
-    /**
-     * Singleton builder instance for Team.
-     */
-    export const builder = new TypeBuilder();
-}

package/src/types/User.ts

@@ -1,302 +0,0 @@
-import { Dictionary, Flattable, ITypeBuilder, Tagged, UtcDate, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { Team } from './Team';
-import { Person } from './Person';
-
-/**
- * Represents a user in the system with associated team memberships.
- *
- * A user can be a member of multiple teams, and for each team, they have
- * specific properties (team name and associated person ID).
- */
-export class User implements Flattable<User.Flatten> {
-
-    /**
-     * Creates a new User instance.
-     * @param id - The unique identifier for this user
-     * @param teams - Dictionary mapping team IDs to team-specific user properties
-     */
-    public constructor(
-        public id: User.Id,
-        public signInDate: UtcDate,
-        public signInType: User.SignInType,
-        public teams: Dictionary<Team.Id, User.TeamProperties> = new Dictionary(Team.Id.builder)
-    ) {}
-
-    /**
-     * Gets the flattened representation of this user for serialization.
-     */
-    public get flatten(): User.Flatten {
-        return {
-            id: this.id.flatten,
-            signInDate: this.signInDate.flatten,
-            signInType: this.signInType.flatten,
-            teams: this.teams.flatten
-        };
-    }
-}
-
-export namespace User {
-
-    /**
-     * Tagged type for user identifiers to prevent mixing with other string IDs.
-     */
-    export type Id = Tagged<string, 'user'>;
-
-    export namespace Id {
-
-        /**
-         * Flattened representation of a user ID (plain string).
-         */
-        export type Flatten = string;
-
-        /**
-         * Builder for constructing User.Id instances from strings.
-         */
-        export const builder = Tagged.builder('user' as const, new ValueTypeBuilder<string>());
-    }
-
-    /**
-     * Represents email-based authentication sign-in type.
-     *
-     * Used when a user signs in using their email address.
-     */
-    export class SignInTypeEmail implements Flattable<SignInTypeEmail.Flatten> {
-
-        /**
-         * Creates a new email sign-in type.
-         * @param email - The email address used for authentication
-         */
-        public constructor(
-            public email: string
-        ) {}
-
-        /**
-         * Gets the flattened representation for serialization.
-         */
-        public get flatten(): SignInTypeEmail.Flatten {
-            return {
-                type: 'email',
-                email: this.email
-            };
-        }
-    }
-
-    export namespace SignInTypeEmail {
-
-        /**
-         * Flattened representation of email sign-in type for serialization.
-         */
-        export type Flatten = {
-            type: 'email',
-            email: string
-        };
-
-        /**
-         * Builder for constructing SignInTypeEmail instances from flattened data.
-         */
-        export 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
-             */
-            public build(value: Flatten): SignInTypeEmail {
-                return new SignInTypeEmail(value.email);
-            }
-        }
-
-        /**
-         * Singleton builder instance for SignInTypeEmail.
-         */
-        export const builder = new TypeBuilder();
-    }
-
-    /**
-     * Represents OAuth-based authentication sign-in type.
-     *
-     * Used when a user signs in using an OAuth provider (Google or Apple).
-     */
-    export class SignInTypeOAuth implements Flattable<SignInTypeOAuth.Flatten> {
-
-        /**
-         * Creates a new OAuth sign-in type.
-         * @param provider - The OAuth provider used for authentication ('google' or 'apple')
-         */
-        public constructor(
-            public provider: 'google' | 'apple'
-        ) {}
-
-        /**
-         * Gets the flattened representation for serialization.
-         */
-        public get flatten(): SignInTypeOAuth.Flatten {
-            return {
-                type: this.provider
-            };
-        }
-    }
-
-    export namespace SignInTypeOAuth {
-
-        /**
-         * Flattened representation of OAuth sign-in type for serialization.
-         */
-        export type Flatten = {
-            type: 'google' | 'apple'
-        };
-
-        /**
-         * Builder for constructing SignInTypeOAuth instances from flattened data.
-         */
-        export 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
-             */
-            public build(value: Flatten): SignInTypeOAuth {
-                return new SignInTypeOAuth(value.type);
-            }
-        }
-
-        /**
-         * Singleton builder instance for SignInTypeOAuth.
-         */
-        export const builder = new TypeBuilder();
-    }
-
-    /**
-     * Union type representing any sign-in method.
-     *
-     * Can be either email-based or OAuth-based authentication.
-     */
-    export type SignInType = SignInTypeEmail | SignInTypeOAuth;
-
-    export namespace SignInType {
-
-        /**
-         * Flattened representation of any sign-in type for serialization.
-         */
-        export type Flatten = SignInTypeEmail.Flatten | SignInTypeOAuth.Flatten;
-
-        /**
-         * Builder for constructing SignInType instances from flattened data.
-         *
-         * Automatically determines the correct type based on the 'type' field.
-         */
-        export 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
-             */
-            public build(value: Flatten): SignInType {
-                if (value.type === 'email')
-                    return SignInTypeEmail.builder.build(value);
-                else
-                    return SignInTypeOAuth.builder.build(value);
-            }
-        }
-
-        /**
-         * Singleton builder instance for SignInType.
-         */
-        export const builder = new TypeBuilder();
-    }
-
-    /**
-     * Properties that are specific to a user's membership in a particular team.
-     */
-    export class TeamProperties implements Flattable<TeamProperties.Flatten> {
-
-        /**
-         * Creates new team-specific user properties.
-         * @param teamId - The ID of the team
-         * @param teamName - The display name of the team
-         * @param personId - The ID of the person associated with this user in this team
-         */
-        public constructor(
-            public teamId: Team.Id,
-            public teamName: string,
-            public personId: Person.Id
-        ) {}
-
-        /**
-         * Gets the flattened representation of these team properties.
-         */
-        public get flatten(): TeamProperties.Flatten {
-            return {
-                teamId: this.teamId.flatten,
-                teamName: this.teamName,
-                personId: this.personId.flatten
-            };
-        }
-    }
-
-    export namespace TeamProperties {
-
-        /**
-         * Flattened representation of team properties for serialization.
-         */
-        export type Flatten = {
-            teamId: Team.Id.Flatten,
-            teamName: string,
-            personId: Person.Id.Flatten
-        };
-
-        /**
-         * Builder for constructing TeamProperties from flattened data.
-         */
-        export class TypeBuilder implements ITypeBuilder<Flatten, TeamProperties> {
-
-            /**
-             * Builds a TeamProperties instance from flattened data.
-             * @param value - The flattened team properties data
-             * @returns A new TeamProperties instance
-             */
-            public build(value: Flatten): TeamProperties {
-                return new TeamProperties(Team.Id.builder.build(value.teamId), value.teamName, Person.Id.builder.build(value.personId));
-            }
-        }
-
-        /**
-         * Singleton builder instance for TeamProperties.
-         */
-        export const builder = new TypeBuilder();
-    }
-
-    /**
-     * Flattened representation of a User for serialization.
-     */
-    export type Flatten = {
-        id: Id.Flatten,
-        signInDate: string,
-        signInType: SignInType.Flatten,
-        teams: Dictionary.Flatten<TeamProperties>
-    }
-
-    /**
-     * Builder for constructing User instances from flattened data.
-     */
-    export class TypeBuilder implements ITypeBuilder<Flatten, User> {
-
-        /**
-         * Builds a User instance from flattened data.
-         * @param value - The flattened user data
-         * @returns A new User instance with all teams reconstructed
-         */
-        public build(value: Flatten): User {
-            return new User(Id.builder.build(value.id), UtcDate.builder.build(value.signInDate), SignInType.builder.build(value.signInType), Dictionary.builder(Team.Id.builder, User.TeamProperties.builder).build(value.teams));
-        }
-    }
-
-    /**
-     * Singleton builder instance for User.
-     */
-    export const builder = new TypeBuilder();
-}