@stevenkellner/team-conduct-api 2.0.18 → 2.0.19

package/lib/src/types/FineAmount.js

@@ -1,238 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FineAmount = void 0;
-const MoneyAmount_1 = require("./MoneyAmount");
-const Configuration_1 = require("./Configuration");
-const Localization_1 = require("./Localization");
-var FineAmount;
-(function (FineAmount) {
-    /**
-     * Represents a fine amount as a monetary value.
-     */
-    class Money {
-        amount;
-        /**
-         * Creates a new Money fine amount.
-         *
-         * @param amount - The monetary amount
-         */
-        constructor(amount) {
-            this.amount = amount;
-        }
-        /**
-         * Returns a formatted string representation of the amount.
-         *
-         * @param configuration - Configuration containing currency and locale
-         * @returns Formatted currency string (e.g., "$10.50")
-         */
-        formatted(configuration) {
-            return this.amount.formatted(configuration.currency, configuration);
-        }
-        /**
-         * Returns a new Money instance with the amount multiplied by a factor.
-         *
-         * @param factor - The multiplication factor
-         * @returns New Money instance with multiplied amount
-         */
-        multiplied(factor) {
-            return new Money(this.amount.multiplied(factor));
-        }
-        /**
-         * Returns the flattened representation for serialization.
-         */
-        get flatten() {
-            return {
-                type: 'money',
-                amount: this.amount.flatten
-            };
-        }
-    }
-    FineAmount.Money = Money;
-    (function (Money) {
-        /**
-         * Type builder for Money serialization/deserialization.
-         */
-        class TypeBuilder {
-            /**
-             * Builds a Money instance from flattened data.
-             *
-             * @param value - Flattened money data
-             * @returns Money instance
-             */
-            build(value) {
-                return new Money(MoneyAmount_1.MoneyAmount.builder.build(value.amount));
-            }
-        }
-        Money.TypeBuilder = TypeBuilder;
-        /**
-         * Singleton instance of TypeBuilder for Money.
-         */
-        Money.builder = new TypeBuilder();
-    })(Money = FineAmount.Money || (FineAmount.Money = {}));
-    /**
-     * Represents a fine amount as a quantity of items.
-     */
-    class Item {
-        item;
-        count;
-        /**
-         * Creates a new Item fine amount.
-         *
-         * @param item - The item type (e.g., 'crateOfBeer')
-         * @param count - The number of items
-         */
-        constructor(item, count) {
-            this.item = item;
-            this.count = count;
-        }
-        formatted(configurationOrLocale) {
-            const locale = configurationOrLocale instanceof Configuration_1.Configuration ? configurationOrLocale.locale : configurationOrLocale;
-            return Localization_1.Localization.shared(locale).fineAmount.item.type[this.item].withCount.value(this.count);
-        }
-        /**
-         * Returns a formatted string representation without explicitly showing count.
-         *
-         * @param locale - The locale for formatting
-         * @returns Formatted string without count display
-         */
-        formattedWithoutCount(locale) {
-            return Localization_1.Localization.shared(locale).fineAmount.item.type[this.item].withoutCount.value(this.count);
-        }
-        /**
-         * Returns a new Item instance with the count multiplied by a factor.
-         *
-         * @param factor - The multiplication factor
-         * @returns New Item instance with multiplied count
-         */
-        multiplied(factor) {
-            return new Item(this.item, this.count * factor);
-        }
-        /**
-         * Returns the flattened representation for serialization.
-         */
-        get flatten() {
-            return {
-                type: 'item',
-                item: this.item,
-                count: this.count
-            };
-        }
-    }
-    FineAmount.Item = Item;
-    (function (Item) {
-        const itemTypes = ['crateOfBeer'];
-        let Type;
-        (function (Type) {
-            /**
-             * Array containing all possible item types.
-             */
-            Type.all = itemTypes;
-            /**
-             * Returns the localized name for an item type.
-             *
-             * @param type - The item type
-             * @param locale - The locale to use for formatting
-             * @returns Localized item name
-             */
-            function formatted(type, locale) {
-                return Localization_1.Localization.shared(locale).fineAmount.item.type[type].name.value();
-            }
-            Type.formatted = formatted;
-        })(Type = Item.Type || (Item.Type = {}));
-        /**
-         * Type builder for Item serialization/deserialization.
-         */
-        class TypeBuilder {
-            /**
-             * Builds an Item instance from flattened data.
-             *
-             * @param value - Flattened item data
-             * @returns Item instance
-             */
-            build(value) {
-                return new Item(value.item, value.count);
-            }
-        }
-        Item.TypeBuilder = TypeBuilder;
-        /**
-         * Singleton instance of TypeBuilder for Item.
-         */
-        Item.builder = new TypeBuilder();
-    })(Item = FineAmount.Item || (FineAmount.Item = {}));
-    /**
-     * Creates a Money fine amount.
-     *
-     * @param MoneyAmount - The monetary amount
-     * @returns Money instance
-     */
-    function money(MoneyAmount) {
-        return new Money(MoneyAmount);
-    }
-    FineAmount.money = money;
-    /**
-     * Creates an Item fine amount.
-     *
-     * @param item - The item type
-     * @param count - The number of items
-     * @returns Item instance
-     */
-    function item(item, count) {
-        return new Item(item, count);
-    }
-    FineAmount.item = item;
-    /**
-     * Compares two fine amounts and returns their relative ordering.
-     *
-     * Money amounts are considered greater than Item amounts.
-     * Within the same type, values are compared numerically.
-     *
-     * @param lhs - First fine amount to compare
-     * @param rhs - Second fine amount to compare
-     * @returns 'less' if lhs < rhs, 'equal' if lhs === rhs, 'greater' if lhs > rhs
-     */
-    function compare(lhs, rhs) {
-        if (lhs instanceof Money) {
-            if (!(rhs instanceof Money))
-                return 'greater';
-            const lhsAmount = lhs.amount.completeValue;
-            const rhsAmount = rhs.amount.completeValue;
-            if (lhsAmount !== rhsAmount)
-                return lhsAmount < rhsAmount ? 'less' : 'greater';
-        }
-        if (lhs instanceof Item) {
-            if (!(rhs instanceof Item))
-                return 'less';
-            if (lhs.count === rhs.count)
-                return 'equal';
-            return lhs.count < rhs.count ? 'less' : 'greater';
-        }
-        return 'equal';
-    }
-    FineAmount.compare = compare;
-    /**
-     * Type builder for FineAmount serialization/deserialization.
-     */
-    class TypeBuilder {
-        /**
-         * Builds a FineAmount instance from flattened data.
-         *
-         * Determines the type based on the 'type' discriminator field.
-         *
-         * @param value - Flattened fine amount data
-         * @returns FineAmount instance (Money or Item)
-         */
-        build(value) {
-            switch (value.type) {
-                case 'money':
-                    return Money.builder.build(value);
-                case 'item':
-                    return Item.builder.build(value);
-            }
-        }
-    }
-    FineAmount.TypeBuilder = TypeBuilder;
-    /**
-     * Singleton instance of TypeBuilder for FineAmount.
-     */
-    FineAmount.builder = new TypeBuilder();
-})(FineAmount || (exports.FineAmount = FineAmount = {}));

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

@@ -1,69 +0,0 @@
-import { Flattable, Guid, ITypeBuilder, Tagged } from '@stevenkellner/typescript-common-functionality';
-import { FineAmount } from './FineAmount';
-import { FineTemplateRepetition } from './FineTemplateRepetition';
-/**
- * Represents a template for creating fines with predefined reason, amount, and optional repetition rules.
- *
- * Fine templates allow teams to quickly create recurring or standard fines without entering
- * the same information repeatedly.
- */
-export declare class FineTemplate implements Flattable<FineTemplate.Flatten> {
-    id: FineTemplate.Id;
-    reason: string;
-    amount: FineAmount;
-    repetition: FineTemplateRepetition | null;
-    /**
-     * Creates a new FineTemplate instance.
-     *
-     * @param id - Unique identifier for the fine template (GUID)
-     * @param reason - The reason or description for the fine
-     * @param amount - The monetary or item-based amount of the fine
-     * @param repetition - Optional repetition rules (null for non-recurring templates)
-     */
-    constructor(id: FineTemplate.Id, reason: string, amount: FineAmount, repetition: FineTemplateRepetition | null);
-    /**
-     * Returns the flattened representation for serialization.
-     */
-    get flatten(): FineTemplate.Flatten;
-}
-export declare namespace FineTemplate {
-    /**
-     * Tagged GUID type for fine template identifiers.
-     */
-    type Id = Tagged<Guid, 'fineTemplate'>;
-    namespace Id {
-        /**
-         * Flattened representation of a fine template ID (GUID string).
-         */
-        type Flatten = string;
-        /**
-         * Type builder for FineTemplate.Id serialization/deserialization.
-         */
-        const builder: Tagged.TypeBuilder<Guid, "fineTemplate">;
-    }
-    /**
-     * Flattened representation of a FineTemplate for serialization.
-     */
-    type Flatten = {
-        id: Id.Flatten;
-        reason: string;
-        amount: FineAmount.Flatten;
-        repetition: FineTemplateRepetition.Flatten | null;
-    };
-    /**
-     * Type builder for FineTemplate serialization/deserialization.
-     */
-    class TypeBuilder implements ITypeBuilder<Flatten, FineTemplate> {
-        /**
-         * Builds a FineTemplate instance from flattened data.
-         *
-         * @param value - Flattened fine template data
-         * @returns FineTemplate instance
-         */
-        build(value: Flatten): FineTemplate;
-    }
-    /**
-     * Singleton instance of TypeBuilder for FineTemplate.
-     */
-    const builder: TypeBuilder;
-}

package/lib/src/types/FineTemplate.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FineTemplate = void 0;
-const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const FineAmount_1 = require("./FineAmount");
-const FineTemplateRepetition_1 = require("./FineTemplateRepetition");
-/**
- * Represents a template for creating fines with predefined reason, amount, and optional repetition rules.
- *
- * Fine templates allow teams to quickly create recurring or standard fines without entering
- * the same information repeatedly.
- */
-class FineTemplate {
-    id;
-    reason;
-    amount;
-    repetition;
-    /**
-     * Creates a new FineTemplate instance.
-     *
-     * @param id - Unique identifier for the fine template (GUID)
-     * @param reason - The reason or description for the fine
-     * @param amount - The monetary or item-based amount of the fine
-     * @param repetition - Optional repetition rules (null for non-recurring templates)
-     */
-    constructor(id, reason, amount, repetition) {
-        this.id = id;
-        this.reason = reason;
-        this.amount = amount;
-        this.repetition = repetition;
-    }
-    /**
-     * Returns the flattened representation for serialization.
-     */
-    get flatten() {
-        return {
-            id: this.id.flatten,
-            reason: this.reason,
-            amount: this.amount.flatten,
-            repetition: this.repetition === null ? null : this.repetition.flatten
-        };
-    }
-}
-exports.FineTemplate = FineTemplate;
-(function (FineTemplate) {
-    let Id;
-    (function (Id) {
-        /**
-         * Type builder for FineTemplate.Id serialization/deserialization.
-         */
-        Id.builder = typescript_common_functionality_1.Tagged.builder('fineTemplate', typescript_common_functionality_1.Guid.builder);
-    })(Id = FineTemplate.Id || (FineTemplate.Id = {}));
-    /**
-     * Type builder for FineTemplate serialization/deserialization.
-     */
-    class TypeBuilder {
-        /**
-         * Builds a FineTemplate instance from flattened data.
-         *
-         * @param value - Flattened fine template data
-         * @returns FineTemplate instance
-         */
-        build(value) {
-            return new FineTemplate(Id.builder.build(value.id), value.reason, FineAmount_1.FineAmount.builder.build(value.amount), value.repetition === null ? null : FineTemplateRepetition_1.FineTemplateRepetition.builder.build(value.repetition));
-        }
-    }
-    FineTemplate.TypeBuilder = TypeBuilder;
-    /**
-     * Singleton instance of TypeBuilder for FineTemplate.
-     */
-    FineTemplate.builder = new TypeBuilder();
-})(FineTemplate || (exports.FineTemplate = FineTemplate = {}));

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

@@ -1,87 +0,0 @@
-import { Flattable, ITypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-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 declare class FineTemplateRepetition implements Flattable<FineTemplateRepetition.Flatten> {
-    item: FineTemplateRepetition.Item;
-    maxCount: number | null;
-    /**
-     * 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)
-     */
-    constructor(item: FineTemplateRepetition.Item, 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")
-     */
-    formatted(count: number, locale: Locale): string;
-    /**
-     * 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
-     */
-    formattedWithoutCount(count: number, locale: Locale): string;
-    /**
-     * Returns the flattened representation for serialization.
-     */
-    get flatten(): FineTemplateRepetition.Flatten;
-}
-export declare namespace FineTemplateRepetition {
-    const repetitionItems: readonly ["minute", "day", "item", "count"];
-    /**
-     * Repetition unit type: 'minute', 'day', 'item', or 'count'.
-     */
-    export type Item = typeof repetitionItems[number];
-    export namespace Item {
-        /**
-         * Array containing all possible repetition item types.
-         */
-        const all: readonly Item[];
-        /**
-         * 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
-         */
-        function formatted(item: Item, locale: Locale): string;
-        /**
-         * Type builder for Item serialization/deserialization.
-         */
-        const builder: ValueTypeBuilder<"item" | "minute" | "day" | "count">;
-    }
-    /**
-     * 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
-         */
-        build(flatten: Flatten): FineTemplateRepetition;
-    }
-    /**
-     * Singleton instance of TypeBuilder for FineTemplateRepetition.
-     */
-    export const builder: TypeBuilder;
-    export {};
-}

package/lib/src/types/FineTemplateRepetition.js

@@ -1,103 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FineTemplateRepetition = void 0;
-const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const Localization_1 = require("./Localization");
-/**
- * Represents how a fine template repeats over time.
- *
- * Defines the repetition unit (minute, day, item, count) and optional maximum count for repetitions.
- */
-class FineTemplateRepetition {
-    item;
-    maxCount;
-    /**
-     * 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)
-     */
-    constructor(item, maxCount) {
-        this.item = item;
-        this.maxCount = maxCount;
-    }
-    /**
-     * 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")
-     */
-    formatted(count, locale) {
-        return Localization_1.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
-     */
-    formattedWithoutCount(count, locale) {
-        return Localization_1.Localization.shared(locale).fineTemplateRepetition.item[this.item].withoutCount.value(count);
-    }
-    /**
-     * Returns the flattened representation for serialization.
-     */
-    get flatten() {
-        return {
-            item: this.item,
-            maxCount: this.maxCount
-        };
-    }
-}
-exports.FineTemplateRepetition = FineTemplateRepetition;
-(function (FineTemplateRepetition) {
-    const repetitionItems = [
-        'minute',
-        'day',
-        'item',
-        'count'
-    ];
-    let Item;
-    (function (Item) {
-        /**
-         * Array containing all possible repetition item types.
-         */
-        Item.all = 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
-         */
-        function formatted(item, locale) {
-            return Localization_1.Localization.shared(locale).fineTemplateRepetition.item[item].name.value();
-        }
-        Item.formatted = formatted;
-        /**
-         * Type builder for Item serialization/deserialization.
-         */
-        Item.builder = new typescript_common_functionality_1.ValueTypeBuilder();
-    })(Item = FineTemplateRepetition.Item || (FineTemplateRepetition.Item = {}));
-    /**
-     * Type builder for FineTemplateRepetition serialization/deserialization.
-     */
-    class TypeBuilder {
-        /**
-         * Builds a FineTemplateRepetition instance from flattened data.
-         *
-         * @param flatten - Flattened repetition data
-         * @returns FineTemplateRepetition instance
-         */
-        build(flatten) {
-            return new FineTemplateRepetition(flatten.item, flatten.maxCount);
-        }
-    }
-    FineTemplateRepetition.TypeBuilder = TypeBuilder;
-    /**
-     * Singleton instance of TypeBuilder for FineTemplateRepetition.
-     */
-    FineTemplateRepetition.builder = new TypeBuilder();
-})(FineTemplateRepetition || (exports.FineTemplateRepetition = FineTemplateRepetition = {}));

package/lib/src/types/Localization.js

@@ -1,115 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluralLocalization = exports.ValueLocalization = exports.Localization = exports.localizations = void 0;
-const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const en_1 = require("../locales/en");
-const de_1 = require("../locales/de");
-const Pluralization_1 = require("./Pluralization");
-/**
- * Helper function to ensure a record satisfies the localization structure
- * while preserving its concrete type.
- */
-const satisfiesLocalizationRecord = (value) => value;
-/**
- * Record of all available localizations keyed by locale.
- * Each localization must match the structure of LocalizationDict.
- */
-exports.localizations = satisfiesLocalizationRecord({
-    en: en_1.localizationEN,
-    de: de_1.localizationDE
-});
-/**
- * Main localization class that provides access to localized strings.
- * Transforms raw localization data into type-safe localization objects.
- */
-class Localization {
-    /**
-     * Returns the localization structure for the specified locale.
-     * Transforms the raw localization data into ValueLocalization and PluralLocalization instances.
-     * @param locale - The locale to retrieve localizations for
-     * @returns The complete localization structure with type-safe access
-     */
-    static shared(locale) {
-        return Localization.mapSubLocalization(exports.localizations[locale]);
-    }
-    /**
-     * Recursively maps raw localization data to localization class instances.
-     * @param localization - The raw localization value to transform
-     * @returns The transformed localization with proper class instances
-     */
-    static mapSubLocalization(localization) {
-        if (typeof localization === 'object' && !(localization instanceof Pluralization_1.Pluralization))
-            return (0, typescript_common_functionality_1.mapRecord)(localization, subLocalization => Localization.mapSubLocalization(subLocalization));
-        if (typeof localization === 'string')
-            return new ValueLocalization(localization);
-        if (localization instanceof Pluralization_1.Pluralization)
-            return new PluralLocalization(localization);
-        throw new Error('Invalid localization structure');
-    }
-}
-exports.Localization = Localization;
-/**
- * Handles localization strings with template variable substitution.
- * Supports {{variableName}} syntax for runtime value replacement.
- */
-class ValueLocalization {
-    rawValue;
-    /**
-     * Creates a new ValueLocalization instance.
-     * @param rawValue - The template string with {{variable}} placeholders
-     */
-    constructor(rawValue) {
-        this.rawValue = rawValue;
-    }
-    /**
-     * Returns the localized string with variables substituted.
-     * Template variables in the format {{key}} are replaced with provided argument values.
-     * @param args - Record of variable names to their replacement values
-     * @returns The localized string with all variables replaced
-     * @throws Error if a required template variable is not provided in args
-     */
-    value(args = {}) {
-        let rawValue = this.rawValue;
-        const regex = /\{\{(?<key>.*?)\}\}/;
-        while (true) {
-            const match = regex.exec(rawValue);
-            if (!match)
-                break;
-            const key = match.groups.key;
-            if (!(key in args))
-                throw new Error(`Missing argument for key: ${key}`);
-            rawValue = rawValue.replace(match[0], args[key]);
-        }
-        return rawValue;
-    }
-}
-exports.ValueLocalization = ValueLocalization;
-/**
- * Handles pluralized localization strings that vary based on count.
- * Combines Pluralization logic with template variable substitution.
- */
-class PluralLocalization {
-    pluralization;
-    /**
-     * Creates a new PluralLocalization instance.
-     * @param pluralization - The Pluralization instance containing plural forms
-     */
-    constructor(pluralization) {
-        this.pluralization = pluralization;
-    }
-    /**
-     * Returns the appropriate pluralized string for the given count with variables substituted.
-     * Automatically includes 'count' in the template variables.
-     * @param count - The count to determine which plural form to use
-     * @param args - Additional template variables to substitute (count is added automatically)
-     * @returns The localized plural string with all variables replaced
-     */
-    value(count, args = {}) {
-        const valueLocalization = new ValueLocalization(this.pluralization.get(count));
-        return valueLocalization.value({
-            count: `${count}`,
-            ...args
-        });
-    }
-}
-exports.PluralLocalization = PluralLocalization;