@glissandoo/lib 1.121.0 → 1.122.0

package/functions/eventoPayout.d.ts

@@ -1,9 +1,10 @@
 import { EventPayoutConfig } from '../models/Evento/types';
+import { EventPaymentItem } from '../models/Group/Payment/types';
 import { PayoutRuleCondition, PayoutRuleEffect } from '../types/payoutRule';
 export declare namespace EventoPayoutFbFunctionsTypes {
     interface InitializeParams {
         eventId: string;
-        grossAmount: number;
+        grossAmount: number | null;
         importByMember: number | null;
         currency: string;
         fixedExpenses?: {
@@ -19,11 +20,23 @@ export declare namespace EventoPayoutFbFunctionsTypes {
     }
     interface UpdateConfigParams {
         eventId: string;
-        grossAmount?: number;
+        grossAmount?: number | null;
         importByMember?: number | null;
         currency?: string;
     }
     type UpdateConfigResult = void;
+    interface PaymentsParams {
+        eventId: string;
+    }
+    interface PaymentsResult {
+        items: EventPaymentItem[];
+    }
+    interface MyPaymentsParams {
+        eventId: string;
+    }
+    interface MyPaymentsResult {
+        items: EventPaymentItem[];
+    }
 }
 export declare namespace EventoPayoutRuleFbFunctionsTypes {
     interface CreateParams {

package/functions/groupPayment.d.ts

@@ -10,6 +10,12 @@ export declare namespace GroupPaymentFbFunctionsTypes {
         totalAmount: number | null;
         currency: string;
         note?: string | null;
+        /**
+         * Marks the payment as a fixed event expense (created from the event
+         * payout edit drawer). When `true` and `eventId` is set, the created
+         * payment id is appended to the event payout's `expenses` array.
+         */
+        fixedExpense?: boolean;
     }
     interface CreateResult {
         id: string;

package/functions/index.d.ts

@@ -45,6 +45,8 @@ export declare enum FbFunctionName {
     EventoPayoutInitialize = "event-payoutInitialize",
     EventoPayoutUpdateConfig = "event-payoutUpdateConfig",
     EventoPayoutRuleSet = "event-payoutRuleSet",
+    EventoPayments = "event-payments",
+    EventoMyPayments = "event-myPayments",
     EventPublish = "event-publish",
     EventRemove = "event-remove",
     EventRepertoryDownload = "eventRepertory-download",

package/functions/index.js

@@ -49,6 +49,8 @@ var FbFunctionName;
     FbFunctionName["EventoPayoutInitialize"] = "event-payoutInitialize";
     FbFunctionName["EventoPayoutUpdateConfig"] = "event-payoutUpdateConfig";
     FbFunctionName["EventoPayoutRuleSet"] = "event-payoutRuleSet";
+    FbFunctionName["EventoPayments"] = "event-payments";
+    FbFunctionName["EventoMyPayments"] = "event-myPayments";
     FbFunctionName["EventPublish"] = "event-publish";
     FbFunctionName["EventRemove"] = "event-remove";
     FbFunctionName["EventRepertoryDownload"] = "eventRepertory-download";

package/functions/regions.js

@@ -56,6 +56,8 @@ const regionByFunctions = {
     [index_1.FbFunctionName.EventoPayoutInitialize]: GCloudRegions.EuropeWest6,
     [index_1.FbFunctionName.EventoPayoutUpdateConfig]: GCloudRegions.EuropeWest6,
     [index_1.FbFunctionName.EventoPayoutRuleSet]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.EventoPayments]: GCloudRegions.EuropeWest6,
+    [index_1.FbFunctionName.EventoMyPayments]: GCloudRegions.EuropeWest6,
     [index_1.FbFunctionName.EventPublish]: GCloudRegions.UsCentral1,
     [index_1.FbFunctionName.EventRemove]: GCloudRegions.UsCentral1,
     [index_1.FbFunctionName.EventRepertoryDownload]: GCloudRegions.EuropeWest6,

package/helpers/paymentForecast.d.ts

@@ -14,24 +14,30 @@ export interface EventPaymentForecastEntry {
 export interface BuildEventPaymentForecastInput {
     players: AEventPlayerBasicData[];
     payout: EventPayoutConfig | null;
-    /** Set of player ids that already have at least one payment for this event (any status). */
-    playerIdsWithPayment: ReadonlySet<string>;
+    /**
+     * Set of player ids that already have a real payment for this event whose id
+     * is NOT part of `payout.expenses`. The forecast is hidden for these players.
+     */
+    playerIdsWithNonExpensePayment: ReadonlySet<string>;
     selectionMode: EventSelectionMode | null;
-    /** When true (event already roll-called) the forecast is no longer relevant. */
-    isRollCalled: boolean;
+    /**
+     * Custom field values per player id, used to evaluate `custom.<field>` payout
+     * rules. When omitted (or a player is missing), an empty object is used.
+     */
+    customFieldsByPlayerId?: ReadonlyMap<string, Record<string, string | number | boolean | null>>;
 }
 /**
  * Computes the simulated ("forecast") payment rows shown in the event payments
  * tab for players that don't yet have a real payment.
  *
  * Exclusion rules per player:
- *  - There is already a payment for the player on this event.
- *  - `status === Declined`.
+ *  - The player already has a real payment whose id is NOT in `payout.expenses`
+ *    (`playerIdsWithNonExpensePayment`).
+ *  - `status === Declined` or `rollcall === Declined`.
  *  - When `selectionMode === Closed`, require `selected === true` (rejects
  *    `false` and `null`).
  *  - The payout rules engine returns `excluded` (PlayerExclude rule).
  *
- * Returns an empty array when no `payout` is configured for the event or when
- * the event has already been roll-called (`isRollCalled`).
+ * Returns an empty array when no `payout` is configured for the event.
  */
-export declare function buildEventPaymentForecast({ players, payout, playerIdsWithPayment, selectionMode, isRollCalled, }: BuildEventPaymentForecastInput): EventPaymentForecastEntry[];
+export declare function buildEventPaymentForecast({ players, payout, playerIdsWithNonExpensePayment, selectionMode, customFieldsByPlayerId, }: BuildEventPaymentForecastInput): EventPaymentForecastEntry[];

package/helpers/paymentForecast.js

@@ -9,34 +9,34 @@ const payoutRules_1 = require("./payoutRules");
  * tab for players that don't yet have a real payment.
  *
  * Exclusion rules per player:
- *  - There is already a payment for the player on this event.
- *  - `status === Declined`.
+ *  - The player already has a real payment whose id is NOT in `payout.expenses`
+ *    (`playerIdsWithNonExpensePayment`).
+ *  - `status === Declined` or `rollcall === Declined`.
  *  - When `selectionMode === Closed`, require `selected === true` (rejects
  *    `false` and `null`).
  *  - The payout rules engine returns `excluded` (PlayerExclude rule).
  *
- * Returns an empty array when no `payout` is configured for the event or when
- * the event has already been roll-called (`isRollCalled`).
+ * Returns an empty array when no `payout` is configured for the event.
  */
-function buildEventPaymentForecast({ players, payout, playerIdsWithPayment, selectionMode, isRollCalled, }) {
+function buildEventPaymentForecast({ players, payout, playerIdsWithNonExpensePayment, selectionMode, customFieldsByPlayerId, }) {
     if (!payout)
         return [];
-    if (isRollCalled)
-        return [];
     const requireSelected = selectionMode === types_2.EventSelectionMode.Closed;
     const result = [];
     for (const player of players) {
-        if (playerIdsWithPayment.has(player.id))
+        if (playerIdsWithNonExpensePayment.has(player.id))
             continue;
         if (player.status === types_1.EventPlayerStatus.Declined)
             continue;
+        if (player.rollcall === types_1.EventPlayerStatus.Declined)
+            continue;
         if (requireSelected && player.selected !== true)
             continue;
         const input = {
             id: player.id,
             mainInstrument: player.mainInstrument ?? '',
             isGuest: player.isGuest,
-            customFields: {},
+            customFields: customFieldsByPlayerId?.get(player.id) ?? {},
         };
         const evaluation = (0, payoutRules_1.evaluateRulesForPlayer)(input, payout.rules ?? [], payout.importByMember);
         if (evaluation.excluded)

package/models/Evento/types.d.ts

@@ -188,9 +188,21 @@ export interface EventData extends EventPromoterData {
     readonly createdOn: CreatedOn;
 }
 export interface EventPayoutConfig {
-    grossAmount: number;
+    /**
+     * Event budget. `null` means "to be determined" (an Income payment is still
+     * generated, with `totalAmount: null`). `0` means no budget (no Income
+     * payment is generated). `> 0` is a concrete amount.
+     */
+    grossAmount: number | null;
     currency: string;
     importByMember: number | null;
     rules: EventoPayoutRuleEntry[];
     expenses: string[];
+    /**
+     * Id of the auto-generated `Income` GroupPayment that materializes the
+     * event budget (`grossAmount`), assigned to the group itself. `null` when
+     * the budget is `0` or for legacy events created before incomes were
+     * tracked.
+     */
+    incomeId?: string | null;
 }

package/models/Group/Payment/types.d.ts

@@ -94,3 +94,51 @@ export interface GroupPaymentData {
     editedBy: string | null;
 }
 export type AGroupPaymentData = GroupPaymentData;
+/**
+ * Estados visibles en la lista unificada de pagos de un evento.
+ * Reutiliza los valores de `GroupPaymentStatus` y añade el sintético
+ * `forecast` para las filas de previsión (no persistidas en Postgres).
+ */
+export declare enum EventPaymentStatus {
+    Pending = "pending",
+    Paid = "paid",
+    Cancelled = "cancelled",
+    Forecast = "forecast"
+}
+/**
+ * Item unificado devuelto por la callable `event-payments`.
+ *
+ * Comparte la forma de `GroupPaymentData`. Las filas reales mantienen su
+ * `status` persistido; las de previsión usan `status === EventPaymentStatus.Forecast`
+ * como discriminador y dejan en `null` los campos no aplicables
+ * (`createdAt`, `createdBy`, `paymentMethod`, etc.).
+ */
+export interface EventPaymentItem {
+    /** Real: UUID del row. Previsión: sintético `forecast-<playerId>`. */
+    id: string;
+    groupId: string;
+    type: GroupPaymentType;
+    eventId: string | null;
+    playerId: string | null;
+    concept: string;
+    assignedTo: string;
+    totalAmount: number | null;
+    baseAmount: number | null;
+    appliedRules: AppliedRuleEntry[];
+    currency: string;
+    status: EventPaymentStatus;
+    /** Siempre `[]` en este resultado (history se carga on-demand). */
+    history: GroupPaymentHistoryItem[];
+    paymentMethod: GroupPaymentMethod | null;
+    paidAt: string | null;
+    paidBy: string | null;
+    note: string | null;
+    /**
+     * Real: fecha de creación del row. Previsión: fecha de creación del evento.
+     */
+    createdAt: string;
+    /** Real: userId creador. Previsión: `SYSTEM`. */
+    createdBy: string;
+    editedAt: string | null;
+    editedBy: string | null;
+}

package/models/Group/Payment/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GroupPaymentHistoryAction = exports.GroupPaymentMethod = exports.GroupPaymentStatus = exports.GroupPaymentType = void 0;
+exports.EventPaymentStatus = exports.GroupPaymentHistoryAction = exports.GroupPaymentMethod = exports.GroupPaymentStatus = exports.GroupPaymentType = void 0;
 var GroupPaymentType;
 (function (GroupPaymentType) {
     GroupPaymentType["Income"] = "income";
@@ -24,3 +24,15 @@ var GroupPaymentHistoryAction;
     GroupPaymentHistoryAction["Concept"] = "concept";
     GroupPaymentHistoryAction["Method"] = "method";
 })(GroupPaymentHistoryAction = exports.GroupPaymentHistoryAction || (exports.GroupPaymentHistoryAction = {}));
+/**
+ * Estados visibles en la lista unificada de pagos de un evento.
+ * Reutiliza los valores de `GroupPaymentStatus` y añade el sintético
+ * `forecast` para las filas de previsión (no persistidas en Postgres).
+ */
+var EventPaymentStatus;
+(function (EventPaymentStatus) {
+    EventPaymentStatus["Pending"] = "pending";
+    EventPaymentStatus["Paid"] = "paid";
+    EventPaymentStatus["Cancelled"] = "cancelled";
+    EventPaymentStatus["Forecast"] = "forecast";
+})(EventPaymentStatus = exports.EventPaymentStatus || (exports.EventPaymentStatus = {}));

package/models/Group/index.js

@@ -159,31 +159,33 @@ class Group extends basic_1.default {
         return null;
     }
     get config() {
+        const config = this.data.config || {};
         return {
-            [types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined]: types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined in this.data.config
-                ? this.data.config[types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined]
+            [types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined]: types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined in config
+                ? config[types_1.GroupConfigKey.IncludesMembersToEventsWhenJoined]
                 : true,
-            [types_1.GroupConfigKey.AllowEditInstruments]: types_1.GroupConfigKey.AllowEditInstruments in this.data.config
-                ? this.data.config[types_1.GroupConfigKey.AllowEditInstruments]
+            [types_1.GroupConfigKey.AllowEditInstruments]: types_1.GroupConfigKey.AllowEditInstruments in config
+                ? config[types_1.GroupConfigKey.AllowEditInstruments]
                 : true,
-            [types_1.GroupConfigKey.ShowAttendanceToMembers]: types_1.GroupConfigKey.ShowAttendanceToMembers in this.data.config
-                ? this.data.config[types_1.GroupConfigKey.ShowAttendanceToMembers]
+            [types_1.GroupConfigKey.ShowAttendanceToMembers]: types_1.GroupConfigKey.ShowAttendanceToMembers in config
+                ? config[types_1.GroupConfigKey.ShowAttendanceToMembers]
                 : types_1.GroupConfigShowAttendanceToMembers.None,
-            [types_1.GroupConfigKey.AllowVerifyGeoLoc]: types_1.GroupConfigKey.AllowVerifyGeoLoc in this.data.config
-                ? this.data.config[types_1.GroupConfigKey.AllowVerifyGeoLoc]
+            [types_1.GroupConfigKey.AllowVerifyGeoLoc]: types_1.GroupConfigKey.AllowVerifyGeoLoc in config
+                ? config[types_1.GroupConfigKey.AllowVerifyGeoLoc]
                 : false,
         };
     }
     get configSites() {
+        const configSites = this.data.configSites || {};
         return {
-            [types_1.GroupConfigSitesKey.Active]: types_1.GroupConfigSitesKey.Active in this.data.configSites
-                ? this.data.configSites[types_1.GroupConfigSitesKey.Active]
+            [types_1.GroupConfigSitesKey.Active]: types_1.GroupConfigSitesKey.Active in configSites
+                ? configSites[types_1.GroupConfigSitesKey.Active]
                 : false,
-            [types_1.GroupConfigSitesKey.ShowEvents]: types_1.GroupConfigSitesKey.ShowEvents in this.data.configSites
-                ? this.data.configSites[types_1.GroupConfigSitesKey.ShowEvents]
+            [types_1.GroupConfigSitesKey.ShowEvents]: types_1.GroupConfigSitesKey.ShowEvents in configSites
+                ? configSites[types_1.GroupConfigSitesKey.ShowEvents]
                 : false,
-            [types_1.GroupConfigSitesKey.ShowMembers]: types_1.GroupConfigSitesKey.ShowMembers in this.data.configSites
-                ? this.data.configSites[types_1.GroupConfigSitesKey.ShowMembers]
+            [types_1.GroupConfigSitesKey.ShowMembers]: types_1.GroupConfigSitesKey.ShowMembers in configSites
+                ? configSites[types_1.GroupConfigSitesKey.ShowMembers]
                 : false,
         };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@glissandoo/lib",
-	"version": "1.121.0",
+	"version": "1.122.0",
 	"description": "Glissandoo library js",
 	"main": "./index.js",
 	"types": "./index.d.ts",