@stevenkellner/team-conduct-api 2.0.18 → 2.0.19

package/lib/src/firebase/pushNotification.d.ts

@@ -1,39 +0,0 @@
-import { NotificationProperties, Person, Team } from '../types';
-import { Notification } from '.';
-/**
- * Sends a push notification to a person if they are subscribed to the topic.
- *
- * Retrieves the person's notification properties, checks their subscription status,
- * sends the notification to all their registered device tokens, and updates their
- * token list to remove any failed tokens.
- *
- * @param teamId - The unique identifier of the team
- * @param personId - The unique identifier of the person
- * @param topic - The notification subscription topic (e.g., 'new-fine', 'fine-reminder', 'fine-state-change')
- * @param notification - The notification content to send
- *
- * @returns A promise that resolves when the notification is sent and person data is updated
- *
- * @remarks
- * The function will silently return without sending if:
- * - The person does not exist in the database
- * - The person is not signed in (signInProperties is null)
- * - The person is not subscribed to the specified topic
- *
- * After sending, the person's token list is automatically updated to remove
- * any tokens that are invalid or unregistered, maintaining clean notification data.
- *
- * @example
- * ```typescript
- * await pushNotification(
- *   teamId,
- *   personId,
- *   'new-fine',
- *   {
- *     title: 'New Fine',
- *     body: 'You have received a new fine'
- *   }
- * );
- * ```
- */
-export declare function pushNotification(teamId: Team.Id, personId: Person.Id, topic: NotificationProperties.Subscription, notification: Notification): Promise<void>;

package/lib/src/firebase/pushNotification.js

@@ -1,88 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pushNotification = pushNotification;
-const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const Firestore_1 = require("./Firestore");
-const types_1 = require("../types");
-const _1 = require(".");
-/**
- * Filters successful tokens from a Firebase Cloud Messaging batch response.
- *
- * Removes tokens that failed due to invalid or unregistered registration tokens,
- * keeping only the tokens that successfully received the notification.
- *
- * @param response - The batch response from Firebase Cloud Messaging
- * @param tokens - The array of device tokens that were sent the notification
- * @returns A dictionary mapping token IDs to their corresponding device tokens for successful deliveries
- *
- * @remarks
- * Filters out tokens with the following error codes:
- * - `messaging/invalid-registration-token`: The token format is invalid
- * - `messaging/registration-token-not-registered`: The token is no longer registered
- *
- * @private
- */
-function successfulTokens(response, tokens) {
-    const successfulTokens = response.responses
-        .map((response, index) => ({
-        failed: response.error?.code === 'messaging/invalid-registration-token' || response.error?.code === 'messaging/registration-token-not-registered',
-        token: tokens[index]
-    }))
-        .filter(response => !response.failed)
-        .map(response => response.token);
-    const tokenDict = new typescript_common_functionality_1.Dictionary(types_1.NotificationProperties.TokenId.builder);
-    for (const token of successfulTokens)
-        tokenDict.set(types_1.NotificationProperties.TokenId.create(token), token);
-    return tokenDict;
-}
-/**
- * Sends a push notification to a person if they are subscribed to the topic.
- *
- * Retrieves the person's notification properties, checks their subscription status,
- * sends the notification to all their registered device tokens, and updates their
- * token list to remove any failed tokens.
- *
- * @param teamId - The unique identifier of the team
- * @param personId - The unique identifier of the person
- * @param topic - The notification subscription topic (e.g., 'new-fine', 'fine-reminder', 'fine-state-change')
- * @param notification - The notification content to send
- *
- * @returns A promise that resolves when the notification is sent and person data is updated
- *
- * @remarks
- * The function will silently return without sending if:
- * - The person does not exist in the database
- * - The person is not signed in (signInProperties is null)
- * - The person is not subscribed to the specified topic
- *
- * After sending, the person's token list is automatically updated to remove
- * any tokens that are invalid or unregistered, maintaining clean notification data.
- *
- * @example
- * ```typescript
- * await pushNotification(
- *   teamId,
- *   personId,
- *   'new-fine',
- *   {
- *     title: 'New Fine',
- *     body: 'You have received a new fine'
- *   }
- * );
- * ```
- */
-async function pushNotification(teamId, personId, topic, notification) {
-    const personSnapshot = await Firestore_1.Firestore.shared.person(teamId, personId).snapshot();
-    if (!personSnapshot.exists)
-        return;
-    const person = types_1.Person.builder.build(personSnapshot.data);
-    if (person.signInProperties === null || !person.signInProperties.notificationProperties.subscriptions.includes(topic))
-        return;
-    const tokens = person.signInProperties.notificationProperties.tokens.values;
-    const response = await _1.FirebaseConfiguration.shared.messaging.sendEachForMulticast({
-        tokens: tokens,
-        notification: notification
-    });
-    person.signInProperties.notificationProperties.tokens = successfulTokens(response, tokens);
-    await Firestore_1.Firestore.shared.person(teamId, personId).set(person);
-}

package/lib/src/functions/notification/subscribe.d.ts

@@ -1,18 +0,0 @@
-import { FirebaseFunction } from '@stevenkellner/firebase-function';
-import { NotificationProperties, Person, Team } from '../../types';
-import { ObjectTypeBuilder, ValueTypeBuilder } from '@stevenkellner/typescript-common-functionality';
-export declare namespace NotificationSubscribeFunction {
-    type Parameters = {
-        teamId: Team.Id;
-        personId: Person.Id;
-        subscriptions: NotificationProperties.Subscription[];
-    };
-}
-export declare class NotificationSubscribeFunction implements FirebaseFunction<NotificationSubscribeFunction.Parameters, void> {
-    parametersBuilder: ObjectTypeBuilder<{
-        teamId: string;
-        personId: string;
-        subscriptions: ("new-fine" | "fine-reminder" | "fine-state-change")[];
-    }, NotificationSubscribeFunction.Parameters>;
-    returnTypeBuilder: ValueTypeBuilder<void>;
-}

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

@@ -1,46 +0,0 @@
-import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { Currency } from './Currency';
-import { Locale } from './Locale';
-/**
- * Represents the configuration settings that will be passed to the functions parameters.
- * Contains currency and locale preferences.
- */
-export declare class Configuration implements Flattable<Configuration.Flatten> {
-    currency: Currency;
-    locale: Locale;
-    /**
-     * Creates a new Configuration instance.
-     * @param currency - The currency to use for monetary values (EUR, USD, ...)
-     * @param locale - The locale for localization (language/region)
-     */
-    constructor(currency: Currency, locale: Locale);
-    /**
-     * Returns the flattened representation of the configuration.
-     * @returns The flattened configuration object
-     */
-    get flatten(): Configuration.Flatten;
-}
-export declare namespace Configuration {
-    /**
-     * Flattened representation of Configuration for serialization.
-     */
-    type Flatten = {
-        currency: Currency;
-        locale: Locale;
-    };
-    /**
-     * TypeBuilder for constructing Configuration instances from flattened data.
-     */
-    class TypeBuilder implements ITypeBuilder<Flatten, Configuration> {
-        /**
-         * Builds a Configuration instance from flattened data.
-         * @param flatten - The flattened configuration data
-         * @returns A new Configuration instance
-         */
-        build(flatten: Flatten): Configuration;
-    }
-    /**
-     * Singleton builder instance for Configuration.
-     */
-    const builder: TypeBuilder;
-}

package/lib/src/types/Configuration.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = void 0;
-/**
- * Represents the configuration settings that will be passed to the functions parameters.
- * Contains currency and locale preferences.
- */
-class Configuration {
-    currency;
-    locale;
-    /**
-     * Creates a new Configuration instance.
-     * @param currency - The currency to use for monetary values (EUR, USD, ...)
-     * @param locale - The locale for localization (language/region)
-     */
-    constructor(currency, locale) {
-        this.currency = currency;
-        this.locale = locale;
-    }
-    /**
-     * Returns the flattened representation of the configuration.
-     * @returns The flattened configuration object
-     */
-    get flatten() {
-        return {
-            currency: this.currency,
-            locale: this.locale
-        };
-    }
-}
-exports.Configuration = Configuration;
-(function (Configuration) {
-    /**
-     * TypeBuilder for constructing Configuration instances from flattened data.
-     */
-    class TypeBuilder {
-        /**
-         * Builds a Configuration instance from flattened data.
-         * @param flatten - The flattened configuration data
-         * @returns A new Configuration instance
-         */
-        build(flatten) {
-            return new Configuration(flatten.currency, flatten.locale);
-        }
-    }
-    Configuration.TypeBuilder = TypeBuilder;
-    /**
-     * Singleton builder instance for Configuration.
-     */
-    Configuration.builder = new TypeBuilder();
-})(Configuration || (exports.Configuration = Configuration = {}));

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

@@ -1,71 +0,0 @@
-import { Flattable, Guid, ITypeBuilder, Tagged, UtcDate } from '@stevenkellner/typescript-common-functionality';
-import { FineAmount } from './FineAmount';
-import { PayedState } from './PayedState';
-/**
- * Represents a fine assigned to a person in a team.
- *
- * Contains information about the fine's payment status, date, reason, and monetary amount.
- */
-export declare class Fine implements Flattable<Fine.Flatten> {
-    id: Fine.Id;
-    payedState: PayedState;
-    date: UtcDate;
-    reason: string;
-    amount: FineAmount;
-    /**
-     * Creates a new Fine instance.
-     *
-     * @param id - Unique identifier for the fine (GUID)
-     * @param payedState - Payment status ('payed' or 'notPayed')
-     * @param date - Date when the fine was issued
-     * @param reason - Description or reason for the fine
-     * @param amount - Monetary amount of the fine
-     */
-    constructor(id: Fine.Id, payedState: PayedState, date: UtcDate, reason: string, amount: FineAmount);
-    /**
-     * Returns the flattened representation for serialization.
-     */
-    get flatten(): Fine.Flatten;
-}
-export declare namespace Fine {
-    /**
-     * Tagged GUID type for fine identifiers.
-     */
-    type Id = Tagged<Guid, 'fine'>;
-    namespace Id {
-        /**
-         * Flattened representation of a fine ID (GUID string).
-         */
-        type Flatten = string;
-        /**
-         * Type builder for Fine.Id serialization/deserialization.
-         */
-        const builder: Tagged.TypeBuilder<Guid, "fine">;
-    }
-    /**
-     * Flattened representation of a Fine for serialization.
-     */
-    type Flatten = {
-        id: Id.Flatten;
-        payedState: PayedState;
-        date: UtcDate.Flatten;
-        reason: string;
-        amount: FineAmount.Flatten;
-    };
-    /**
-     * Type builder for Fine serialization/deserialization.
-     */
-    class TypeBuilder implements ITypeBuilder<Flatten, Fine> {
-        /**
-         * Builds a Fine instance from flattened data.
-         *
-         * @param value - Flattened fine data
-         * @returns Fine instance
-         */
-        build(value: Flatten): Fine;
-    }
-    /**
-     * Singleton instance of TypeBuilder for Fine.
-     */
-    const builder: TypeBuilder;
-}

package/lib/src/types/Fine.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Fine = void 0;
-const typescript_common_functionality_1 = require("@stevenkellner/typescript-common-functionality");
-const FineAmount_1 = require("./FineAmount");
-/**
- * Represents a fine assigned to a person in a team.
- *
- * Contains information about the fine's payment status, date, reason, and monetary amount.
- */
-class Fine {
-    id;
-    payedState;
-    date;
-    reason;
-    amount;
-    /**
-     * Creates a new Fine instance.
-     *
-     * @param id - Unique identifier for the fine (GUID)
-     * @param payedState - Payment status ('payed' or 'notPayed')
-     * @param date - Date when the fine was issued
-     * @param reason - Description or reason for the fine
-     * @param amount - Monetary amount of the fine
-     */
-    constructor(id, payedState, date, reason, amount) {
-        this.id = id;
-        this.payedState = payedState;
-        this.date = date;
-        this.reason = reason;
-        this.amount = amount;
-    }
-    /**
-     * Returns the flattened representation for serialization.
-     */
-    get flatten() {
-        return {
-            id: this.id.flatten,
-            payedState: this.payedState,
-            date: this.date.flatten,
-            reason: this.reason,
-            amount: this.amount.flatten
-        };
-    }
-}
-exports.Fine = Fine;
-(function (Fine) {
-    let Id;
-    (function (Id) {
-        /**
-         * Type builder for Fine.Id serialization/deserialization.
-         */
-        Id.builder = typescript_common_functionality_1.Tagged.builder('fine', typescript_common_functionality_1.Guid.builder);
-    })(Id = Fine.Id || (Fine.Id = {}));
-    /**
-     * Type builder for Fine serialization/deserialization.
-     */
-    class TypeBuilder {
-        /**
-         * Builds a Fine instance from flattened data.
-         *
-         * @param value - Flattened fine data
-         * @returns Fine instance
-         */
-        build(value) {
-            return new Fine(Id.builder.build(value.id), value.payedState, typescript_common_functionality_1.UtcDate.builder.build(value.date), value.reason, FineAmount_1.FineAmount.builder.build(value.amount));
-        }
-    }
-    Fine.TypeBuilder = TypeBuilder;
-    /**
-     * Singleton instance of TypeBuilder for Fine.
-     */
-    Fine.builder = new TypeBuilder();
-})(Fine || (exports.Fine = Fine = {}));

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

@@ -1,207 +0,0 @@
-import { Flattable, ITypeBuilder } from '@stevenkellner/typescript-common-functionality';
-import { MoneyAmount } from './MoneyAmount';
-import { Configuration } from './Configuration';
-import { Locale } from './Locale';
-/**
- * Represents the amount of a fine, either as a monetary value or as items.
- *
- * Can be either FineAmount.Money (e.g., $10) or FineAmount.Item (e.g., 2 crates of beer).
- */
-export type FineAmount = FineAmount.Money | FineAmount.Item;
-export declare namespace FineAmount {
-    /**
-     * Represents a fine amount as a monetary value.
-     */
-    class Money implements Flattable<Money.Flatten> {
-        amount: MoneyAmount;
-        /**
-         * Creates a new Money fine amount.
-         *
-         * @param amount - The monetary amount
-         */
-        constructor(amount: MoneyAmount);
-        /**
-         * 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: Configuration): string;
-        /**
-         * 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: number): Money;
-        /**
-         * Returns the flattened representation for serialization.
-         */
-        get flatten(): Money.Flatten;
-    }
-    namespace Money {
-        /**
-         * Flattened representation of Money for serialization.
-         */
-        type Flatten = {
-            type: 'money';
-            amount: MoneyAmount.Flatten;
-        };
-        /**
-         * Type builder for Money serialization/deserialization.
-         */
-        class TypeBuilder implements ITypeBuilder<Flatten, Money> {
-            /**
-             * Builds a Money instance from flattened data.
-             *
-             * @param value - Flattened money data
-             * @returns Money instance
-             */
-            build(value: Flatten): Money;
-        }
-        /**
-         * Singleton instance of TypeBuilder for Money.
-         */
-        const builder: TypeBuilder;
-    }
-    /**
-     * Represents a fine amount as a quantity of items.
-     */
-    class Item implements Flattable<Item.Flatten> {
-        item: Item.Type;
-        count: number;
-        /**
-         * Creates a new Item fine amount.
-         *
-         * @param item - The item type (e.g., 'crateOfBeer')
-         * @param count - The number of items
-         */
-        constructor(item: Item.Type, count: number);
-        /**
-         * Returns a formatted string representation including count.
-         *
-         * @param locale - The locale for formatting
-         * @returns Formatted string (e.g., "2 crates of beer")
-         */
-        formatted(locale: Locale): string;
-        /**
-         * Returns a formatted string representation including count.
-         *
-         * @param configuration - Configuration containing locale
-         * @returns Formatted string (e.g., "2 crates of beer")
-         */
-        formatted(configuration: Configuration): string;
-        /**
-         * Returns a formatted string representation without explicitly showing count.
-         *
-         * @param locale - The locale for formatting
-         * @returns Formatted string without count display
-         */
-        formattedWithoutCount(locale: Locale): string;
-        /**
-         * 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: number): Item;
-        /**
-         * Returns the flattened representation for serialization.
-         */
-        get flatten(): Item.Flatten;
-    }
-    namespace Item {
-        const itemTypes: readonly ["crateOfBeer"];
-        /**
-         * Item type: currently only 'crateOfBeer'.
-         */
-        export type Type = typeof itemTypes[number];
-        export namespace Type {
-            /**
-             * Array containing all possible item types.
-             */
-            const all: readonly Type[];
-            /**
-             * 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: Type, locale: Locale): string;
-        }
-        /**
-         * Flattened representation of Item for serialization.
-         */
-        export type Flatten = {
-            type: 'item';
-            item: Item.Type;
-            count: number;
-        };
-        /**
-         * Type builder for Item serialization/deserialization.
-         */
-        export class TypeBuilder implements ITypeBuilder<Flatten, Item> {
-            /**
-             * Builds an Item instance from flattened data.
-             *
-             * @param value - Flattened item data
-             * @returns Item instance
-             */
-            build(value: Flatten): Item;
-        }
-        /**
-         * Singleton instance of TypeBuilder for Item.
-         */
-        export const builder: TypeBuilder;
-        export {};
-    }
-    /**
-     * Creates a Money fine amount.
-     *
-     * @param MoneyAmount - The monetary amount
-     * @returns Money instance
-     */
-    function money(MoneyAmount: MoneyAmount): Money;
-    /**
-     * Creates an Item fine amount.
-     *
-     * @param item - The item type
-     * @param count - The number of items
-     * @returns Item instance
-     */
-    function item(item: Item.Type, count: number): 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: FineAmount, rhs: FineAmount): 'less' | 'equal' | 'greater';
-    /**
-     * Flattened representation of FineAmount (union of Money.Flatten and Item.Flatten).
-     */
-    type Flatten = Money.Flatten | Item.Flatten;
-    /**
-     * Type builder for FineAmount serialization/deserialization.
-     */
-    class TypeBuilder implements ITypeBuilder<Flatten, FineAmount> {
-        /**
-         * 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: Flatten): FineAmount;
-    }
-    /**
-     * Singleton instance of TypeBuilder for FineAmount.
-     */
-    const builder: TypeBuilder;
-}