@stevenkellner/team-conduct-api 2.0.18 → 2.0.19

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

@@ -1,62 +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 declare class Team implements Flattable<Team.Flatten> {
-    id: Team.Id;
-    name: string;
-    paypalMeLink: string | null;
-    /**
-     * 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)
-     */
-    constructor(id: Team.Id, name: string, paypalMeLink: string | null);
-    /**
-     * 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">;
-    }
-    /**
-     * Flattened representation of a Team for serialization.
-     */
-    type Flatten = {
-        id: Id.Flatten;
-        name: string;
-        paypalMeLink: string | null;
-    };
-    /**
-     * 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.js

@@ -1,64 +0,0 @@
-"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.
- * Teams can optionally have a PayPal.Me link for simplified payment collection.
- */
-class Team {
-    id;
-    name;
-    paypalMeLink;
-    /**
-     * 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)
-     */
-    constructor(id, name, paypalMeLink) {
-        this.id = id;
-        this.name = name;
-        this.paypalMeLink = paypalMeLink;
-    }
-    /**
-     * Gets the flattened representation of this team for serialization.
-     */
-    get flatten() {
-        return {
-            id: this.id.flatten,
-            name: this.name,
-            paypalMeLink: this.paypalMeLink
-        };
-    }
-}
-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 = {}));
-    /**
-     * 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.paypalMeLink);
-        }
-    }
-    Team.TypeBuilder = TypeBuilder;
-    /**
-     * Singleton builder instance for Team.
-     */
-    Team.builder = new TypeBuilder();
-})(Team || (exports.Team = Team = {}));

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

@@ -1,221 +0,0 @@
-import { Dictionary, Flattable, ITypeBuilder, Tagged, UtcDate } 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 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, signInDate: UtcDate, signInType: User.SignInType, teams?: Dictionary<Team.Id, User.TeamProperties>);
-    /**
-     * Gets the flattened representation of this user for serialization.
-     */
-    get flatten(): User.Flatten;
-}
-export declare namespace User {
-    /**
-     * Tagged type for user identifiers to prevent mixing with other string IDs.
-     */
-    type Id = Tagged<string, 'user'>;
-    namespace Id {
-        /**
-         * Flattened representation of a user ID (plain string).
-         */
-        type Flatten = string;
-        /**
-         * Builder for constructing User.Id instances from strings.
-         */
-        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.
-     */
-    class TeamProperties implements Flattable<TeamProperties.Flatten> {
-        teamId: Team.Id;
-        teamName: string;
-        personId: Person.Id;
-        /**
-         * 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
-         */
-        constructor(teamId: Team.Id, teamName: string, personId: Person.Id);
-        /**
-         * Gets the flattened representation of these team properties.
-         */
-        get flatten(): TeamProperties.Flatten;
-    }
-    namespace TeamProperties {
-        /**
-         * Flattened representation of team properties for serialization.
-         */
-        type Flatten = {
-            teamId: Team.Id.Flatten;
-            teamName: string;
-            personId: Person.Id.Flatten;
-        };
-        /**
-         * Builder for constructing TeamProperties from flattened data.
-         */
-        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
-             */
-            build(value: Flatten): TeamProperties;
-        }
-        /**
-         * Singleton builder instance for TeamProperties.
-         */
-        const builder: TypeBuilder;
-    }
-    /**
-     * Flattened representation of a User for serialization.
-     */
-    type Flatten = {
-        id: Id.Flatten;
-        signInDate: string;
-        signInType: SignInType.Flatten;
-        teams: Dictionary.Flatten<TeamProperties>;
-    };
-    /**
-     * Builder for constructing User instances from flattened data.
-     */
-    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
-         */
-        build(value: Flatten): User;
-    }
-    /**
-     * Singleton builder instance for User.
-     */
-    const builder: TypeBuilder;
-}

package/lib/src/types/User.js

@@ -1,235 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.User = void 0;
-const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const Team_1 = require("./Team");
-const Person_1 = require("./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).
- */
-class User {
-    id;
-    signInDate;
-    signInType;
-    teams;
-    /**
-     * 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, signInDate, signInType, teams = new typescript_common_functionality_1.Dictionary(Team_1.Team.Id.builder)) {
-        this.id = id;
-        this.signInDate = signInDate;
-        this.signInType = signInType;
-        this.teams = teams;
-    }
-    /**
-     * Gets the flattened representation of this user for serialization.
-     */
-    get flatten() {
-        return {
-            id: this.id.flatten,
-            signInDate: this.signInDate.flatten,
-            signInType: this.signInType.flatten,
-            teams: this.teams.flatten
-        };
-    }
-}
-exports.User = User;
-(function (User) {
-    let Id;
-    (function (Id) {
-        /**
-         * Builder for constructing User.Id instances from strings.
-         */
-        Id.builder = typescript_common_functionality_1.Tagged.builder('user', new typescript_common_functionality_1.ValueTypeBuilder());
-    })(Id = User.Id || (User.Id = {}));
-    /**
-     * Represents email-based authentication sign-in type.
-     *
-     * Used when a user signs in using their email address.
-     */
-    class SignInTypeEmail {
-        email;
-        /**
-         * Creates a new email sign-in type.
-         * @param email - The email address used for authentication
-         */
-        constructor(email) {
-            this.email = email;
-        }
-        /**
-         * Gets the flattened representation for serialization.
-         */
-        get flatten() {
-            return {
-                type: 'email',
-                email: this.email
-            };
-        }
-    }
-    User.SignInTypeEmail = SignInTypeEmail;
-    (function (SignInTypeEmail) {
-        /**
-         * Builder for constructing SignInTypeEmail instances from flattened data.
-         */
-        class TypeBuilder {
-            /**
-             * Builds a SignInTypeEmail instance from flattened data.
-             * @param value - The flattened email sign-in type data
-             * @returns A new SignInTypeEmail instance
-             */
-            build(value) {
-                return new SignInTypeEmail(value.email);
-            }
-        }
-        SignInTypeEmail.TypeBuilder = TypeBuilder;
-        /**
-         * Singleton builder instance for SignInTypeEmail.
-         */
-        SignInTypeEmail.builder = new TypeBuilder();
-    })(SignInTypeEmail = User.SignInTypeEmail || (User.SignInTypeEmail = {}));
-    /**
-     * Represents OAuth-based authentication sign-in type.
-     *
-     * Used when a user signs in using an OAuth provider (Google or Apple).
-     */
-    class SignInTypeOAuth {
-        provider;
-        /**
-         * Creates a new OAuth sign-in type.
-         * @param provider - The OAuth provider used for authentication ('google' or 'apple')
-         */
-        constructor(provider) {
-            this.provider = provider;
-        }
-        /**
-         * Gets the flattened representation for serialization.
-         */
-        get flatten() {
-            return {
-                type: this.provider
-            };
-        }
-    }
-    User.SignInTypeOAuth = SignInTypeOAuth;
-    (function (SignInTypeOAuth) {
-        /**
-         * Builder for constructing SignInTypeOAuth instances from flattened data.
-         */
-        class TypeBuilder {
-            /**
-             * Builds a SignInTypeOAuth instance from flattened data.
-             * @param value - The flattened OAuth sign-in type data
-             * @returns A new SignInTypeOAuth instance
-             */
-            build(value) {
-                return new SignInTypeOAuth(value.type);
-            }
-        }
-        SignInTypeOAuth.TypeBuilder = TypeBuilder;
-        /**
-         * Singleton builder instance for SignInTypeOAuth.
-         */
-        SignInTypeOAuth.builder = new TypeBuilder();
-    })(SignInTypeOAuth = User.SignInTypeOAuth || (User.SignInTypeOAuth = {}));
-    let SignInType;
-    (function (SignInType) {
-        /**
-         * Builder for constructing SignInType instances from flattened data.
-         *
-         * Automatically determines the correct type based on the 'type' field.
-         */
-        class TypeBuilder {
-            /**
-             * 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) {
-                if (value.type === 'email')
-                    return SignInTypeEmail.builder.build(value);
-                else
-                    return SignInTypeOAuth.builder.build(value);
-            }
-        }
-        SignInType.TypeBuilder = TypeBuilder;
-        /**
-         * Singleton builder instance for SignInType.
-         */
-        SignInType.builder = new TypeBuilder();
-    })(SignInType = User.SignInType || (User.SignInType = {}));
-    /**
-     * Properties that are specific to a user's membership in a particular team.
-     */
-    class TeamProperties {
-        teamId;
-        teamName;
-        personId;
-        /**
-         * 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
-         */
-        constructor(teamId, teamName, personId) {
-            this.teamId = teamId;
-            this.teamName = teamName;
-            this.personId = personId;
-        }
-        /**
-         * Gets the flattened representation of these team properties.
-         */
-        get flatten() {
-            return {
-                teamId: this.teamId.flatten,
-                teamName: this.teamName,
-                personId: this.personId.flatten
-            };
-        }
-    }
-    User.TeamProperties = TeamProperties;
-    (function (TeamProperties) {
-        /**
-         * Builder for constructing TeamProperties from flattened data.
-         */
-        class TypeBuilder {
-            /**
-             * Builds a TeamProperties instance from flattened data.
-             * @param value - The flattened team properties data
-             * @returns A new TeamProperties instance
-             */
-            build(value) {
-                return new TeamProperties(Team_1.Team.Id.builder.build(value.teamId), value.teamName, Person_1.Person.Id.builder.build(value.personId));
-            }
-        }
-        TeamProperties.TypeBuilder = TypeBuilder;
-        /**
-         * Singleton builder instance for TeamProperties.
-         */
-        TeamProperties.builder = new TypeBuilder();
-    })(TeamProperties = User.TeamProperties || (User.TeamProperties = {}));
-    /**
-     * Builder for constructing User instances from flattened data.
-     */
-    class TypeBuilder {
-        /**
-         * Builds a User instance from flattened data.
-         * @param value - The flattened user data
-         * @returns A new User instance with all teams reconstructed
-         */
-        build(value) {
-            return new User(Id.builder.build(value.id), typescript_common_functionality_1.UtcDate.builder.build(value.signInDate), SignInType.builder.build(value.signInType), typescript_common_functionality_1.Dictionary.builder(Team_1.Team.Id.builder, User.TeamProperties.builder).build(value.teams));
-        }
-    }
-    User.TypeBuilder = TypeBuilder;
-    /**
-     * Singleton builder instance for User.
-     */
-    User.builder = new TypeBuilder();
-})(User || (exports.User = User = {}));

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

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

package/lib/test/firebase/FirebaseConfiguration.test.d.ts

@@ -1 +0,0 @@
-export {};