@glissandoo/lib 1.116.0 → 1.118.0

package/models/Group/Payment/index.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("./types");
+/**
+ * Plain-object model for a `group_payment` row. Mirrors the previous
+ * Firestore-backed model API so dashboard components keep working with
+ * `payment.foo` getters. Build with `new GroupPayment(rowData)` where
+ * `rowData` is the deserialized DB record (or a snapshot built from a
+ * realtime callback).
+ *
+ * Timestamp getters return native `Date` objects so consumers can call
+ * `.getTime()` / format them with `date-fns`/`dayjs` directly.
+ */
+class GroupPayment {
+    constructor(data) {
+        this.id = data.id;
+        this._data = data;
+        this.exists = true;
+    }
+    get data() {
+        return this._data;
+    }
+    get groupId() {
+        return this._data.groupId;
+    }
+    get type() {
+        return this._data.type;
+    }
+    get isIncome() {
+        return this.type === types_1.GroupPaymentType.Income;
+    }
+    get isExpense() {
+        return this.type === types_1.GroupPaymentType.Expense;
+    }
+    get eventId() {
+        return this._data.eventId || null;
+    }
+    get playerId() {
+        return this._data.playerId || null;
+    }
+    get concept() {
+        return this._data.concept || '';
+    }
+    get assignedTo() {
+        return this._data.assignedTo || '';
+    }
+    get totalAmount() {
+        return this._data.totalAmount;
+    }
+    get baseAmount() {
+        return this._data.baseAmount ?? this._data.totalAmount;
+    }
+    get appliedRules() {
+        return this._data.appliedRules || [];
+    }
+    get currency() {
+        return this._data.currency || 'EUR';
+    }
+    get displayTotal() {
+        if (this.totalAmount === null)
+            return '— €';
+        const sign = this.isExpense ? '-' : '';
+        return `${sign}${this.totalAmount} €`;
+    }
+    get status() {
+        return this._data.status;
+    }
+    get isPending() {
+        return this.status === types_1.GroupPaymentStatus.Pending;
+    }
+    get isPaid() {
+        return this.status === types_1.GroupPaymentStatus.Paid;
+    }
+    get isCancelled() {
+        return this.status === types_1.GroupPaymentStatus.Cancelled;
+    }
+    get paymentMethod() {
+        return this._data.paymentMethod || null;
+    }
+    get history() {
+        return this._data.history || [];
+    }
+    get historyOrdered() {
+        return this.history
+            .slice()
+            .sort((a, b) => new Date(a.changedAt).getTime() < new Date(b.changedAt).getTime() ? 1 : -1);
+    }
+    get paidAt() {
+        return this._data.paidAt ? new Date(this._data.paidAt) : null;
+    }
+    get paidBy() {
+        return this._data.paidBy || null;
+    }
+    get note() {
+        return this._data.note || null;
+    }
+    get createdAt() {
+        return new Date(this._data.createdAt);
+    }
+    get createdBy() {
+        return this._data.createdBy;
+    }
+    get editedAt() {
+        return this._data.editedAt ? new Date(this._data.editedAt) : null;
+    }
+    get editedBy() {
+        return this._data.editedBy || null;
+    }
+}
+exports.default = GroupPayment;

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

@@ -0,0 +1,16 @@
+import { Database } from '../../../types/supabase';
+import { GroupPaymentData, GroupPaymentHistoryItem } from './types';
+export type GroupPaymentRow = Database['public']['Tables']['group_payment']['Row'];
+export type GroupPaymentInsert = Database['public']['Tables']['group_payment']['Insert'];
+export type GroupPaymentUpdate = Database['public']['Tables']['group_payment']['Update'];
+export type GroupPaymentHistoryRow = Database['public']['Tables']['group_payment_history']['Row'];
+export type GroupPaymentHistoryInsert = Database['public']['Tables']['group_payment_history']['Insert'];
+export declare const GROUP_PAYMENT_TABLE: "group_payment";
+export declare const GROUP_PAYMENT_HISTORY_TABLE: "group_payment_history";
+/**
+ * Convert a raw `group_payment` DB row into the canonical `GroupPaymentData`
+ * shape consumed by the `GroupPayment` model. `history` defaults to an empty
+ * array; hydrate it from the history table when needed.
+ */
+export declare function rowToGroupPaymentData(row: GroupPaymentRow, history?: GroupPaymentHistoryItem[]): GroupPaymentData;
+export declare function historyRowToItem(row: GroupPaymentHistoryRow): GroupPaymentHistoryItem;

package/models/Group/Payment/supabase.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.historyRowToItem = exports.rowToGroupPaymentData = exports.GROUP_PAYMENT_HISTORY_TABLE = exports.GROUP_PAYMENT_TABLE = void 0;
+exports.GROUP_PAYMENT_TABLE = 'group_payment';
+exports.GROUP_PAYMENT_HISTORY_TABLE = 'group_payment_history';
+/**
+ * Convert a raw `group_payment` DB row into the canonical `GroupPaymentData`
+ * shape consumed by the `GroupPayment` model. `history` defaults to an empty
+ * array; hydrate it from the history table when needed.
+ */
+function rowToGroupPaymentData(row, history = []) {
+    return {
+        id: row.id,
+        groupId: row.groupId,
+        type: row.type,
+        eventId: row.eventId,
+        playerId: row.playerId,
+        concept: row.concept,
+        assignedTo: row.assignedTo,
+        totalAmount: row.totalAmount === null ? null : Number(row.totalAmount),
+        baseAmount: row.baseAmount === null ? null : Number(row.baseAmount),
+        appliedRules: row.appliedRules ?? [],
+        currency: row.currency,
+        status: row.status,
+        history,
+        paymentMethod: row.paymentMethod ?? null,
+        paidAt: row.paidAt,
+        paidBy: row.paidBy,
+        note: row.note,
+        createdAt: row.createdAt,
+        createdBy: row.createdBy,
+        editedAt: row.updatedAt,
+        editedBy: row.editedBy,
+    };
+}
+exports.rowToGroupPaymentData = rowToGroupPaymentData;
+function historyRowToItem(row) {
+    return {
+        action: row.action,
+        oldValue: row.old_value,
+        newValue: row.new_value,
+        changedAt: row.changed_at,
+        changedBy: row.changed_by,
+    };
+}
+exports.historyRowToItem = historyRowToItem;

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

@@ -0,0 +1,96 @@
+import { AppliedRuleEntry } from '../../../helpers/payoutRules';
+export declare enum GroupPaymentType {
+    Income = "income",
+    Expense = "expense"
+}
+export declare enum GroupPaymentStatus {
+    Pending = "pending",
+    Paid = "paid",
+    Cancelled = "cancelled"
+}
+export declare enum GroupPaymentMethod {
+    Cash = "cash",
+    Transfer = "transfer"
+}
+export declare enum GroupPaymentHistoryAction {
+    Status = "status",
+    Amount = "amount",
+    Concept = "concept",
+    Method = "method"
+}
+/**
+ * Unified audit entry for a payment. Each entry records one change to a
+ * single field (status, amount, concept or method) with the previous and
+ * new values, who performed it and when.
+ *
+ * For the very first entry (creation), `oldValue` is `null` and `newValue`
+ * holds the initial status.
+ *
+ * Timestamps are ISO 8601 strings (Postgres `timestamptz` representation).
+ */
+export interface GroupPaymentHistoryItem {
+    action: GroupPaymentHistoryAction;
+    oldValue: string | number | null;
+    newValue: string | number | null;
+    changedAt: string;
+    changedBy: string;
+}
+/**
+ * Flat payment record at the group level — represents both incomes
+ * (e.g. event payout owed to a musician) and expenses (e.g. fuel reimbursement,
+ * supplier invoice). Persisted in Postgres (`public.group_payment`).
+ *
+ * `totalAmount` is always positive; the sign is encoded by `type`.
+ *
+ * `assignedTo` is a free-form string: it may be a userId (a player), a groupId
+ * (the band itself), or any free string (external supplier name).
+ *
+ * `playerId` is only set when the payment originates from rollcall — it links
+ * the payment back to the attendee via `eventPlayer.paymentId`.
+ *
+ * Timestamps are ISO 8601 strings.
+ */
+export interface GroupPaymentData {
+    id: string;
+    groupId: string;
+    type: GroupPaymentType;
+    eventId: string | null;
+    playerId: string | null;
+    concept: string;
+    assignedTo: string;
+    /**
+     * Positive amount. `null` only while the payment is Pending (e.g. payouts
+     * waiting for the admin to fix a per-member share). Transitioning to Paid
+     * requires a concrete number.
+     */
+    totalAmount: number | null;
+    /**
+     * `importByMember` at the moment the payment was created/recomputed.
+     * Equals `totalAmount` when no rules apply. `null` mirrors `totalAmount`
+     * when the per-member share is "to be determined".
+     */
+    baseAmount: number | null;
+    /**
+     * Snapshot of the event payout rules that affected this player, ordered
+     * by `order`. Empty array when no rules matched. Used for traceability
+     * and to drive the breakdown tooltip in the UI.
+     */
+    appliedRules: AppliedRuleEntry[];
+    currency: string;
+    status: GroupPaymentStatus;
+    /**
+     * In-memory audit trail loaded from `group_payment_history`. Empty `[]`
+     * when not hydrated. Use the model's `historyOrdered` getter for a desc
+     * view.
+     */
+    history: GroupPaymentHistoryItem[];
+    paymentMethod: GroupPaymentMethod | null;
+    paidAt: string | null;
+    paidBy: string | null;
+    note: string | null;
+    createdAt: string;
+    createdBy: string;
+    editedAt: string | null;
+    editedBy: string | null;
+}
+export type AGroupPaymentData = GroupPaymentData;

package/models/Group/Payment/types.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupPaymentHistoryAction = exports.GroupPaymentMethod = exports.GroupPaymentStatus = exports.GroupPaymentType = void 0;
+var GroupPaymentType;
+(function (GroupPaymentType) {
+    GroupPaymentType["Income"] = "income";
+    GroupPaymentType["Expense"] = "expense";
+})(GroupPaymentType = exports.GroupPaymentType || (exports.GroupPaymentType = {}));
+var GroupPaymentStatus;
+(function (GroupPaymentStatus) {
+    GroupPaymentStatus["Pending"] = "pending";
+    GroupPaymentStatus["Paid"] = "paid";
+    GroupPaymentStatus["Cancelled"] = "cancelled";
+})(GroupPaymentStatus = exports.GroupPaymentStatus || (exports.GroupPaymentStatus = {}));
+var GroupPaymentMethod;
+(function (GroupPaymentMethod) {
+    GroupPaymentMethod["Cash"] = "cash";
+    GroupPaymentMethod["Transfer"] = "transfer";
+})(GroupPaymentMethod = exports.GroupPaymentMethod || (exports.GroupPaymentMethod = {}));
+var GroupPaymentHistoryAction;
+(function (GroupPaymentHistoryAction) {
+    GroupPaymentHistoryAction["Status"] = "status";
+    GroupPaymentHistoryAction["Amount"] = "amount";
+    GroupPaymentHistoryAction["Concept"] = "concept";
+    GroupPaymentHistoryAction["Method"] = "method";
+})(GroupPaymentHistoryAction = exports.GroupPaymentHistoryAction || (exports.GroupPaymentHistoryAction = {}));

package/models/Group/index.d.ts

@@ -1,10 +1,11 @@
 import { DocumentReference } from '@google-cloud/firestore';
 import { PlansGroup } from '../../helpers/plans';
 import { LanguagesTypes } from '../../lang';
+import { GroupPayoutRuleEntry } from '../../types/payoutRule';
 import { EventPlayerStatus } from '../Evento/Player/types';
 import { DocumentModel } from '../Model';
 import GroupBasic from './basic';
-import { AGroupCustomField, AGroupInstrument, AdminPermissions, CustomGroupInstrument, GroupConfigShowAttendanceToMembers, GroupData, GroupStatus, SocialNetwork } from './types';
+import { AGroupCustomField, AGroupInstrument, AdminPermissions, CustomGroupInstrument, GroupConfigShowAttendanceToMembers, GroupData, GroupModuleData, GroupModuleId, GroupModules, GroupStatus, SocialNetwork } from './types';
 export default class Group extends GroupBasic<GroupData> {
     constructor(doc: DocumentModel, lang?: LanguagesTypes);
     get owner(): DocumentReference;
@@ -32,6 +33,8 @@ export default class Group extends GroupBasic<GroupData> {
     get eventTotalCount(): number;
     get communicationCount(): number;
     get country(): string;
+    get currency(): string;
+    get currencySymbol(): string;
     get activePlayers(): string[];
     get playersList(): {
         id: string;
@@ -130,4 +133,8 @@ export default class Group extends GroupBasic<GroupData> {
     get customFieldsList(): AGroupCustomField[];
     get inventoryId(): string;
     get coverURL(): string | null;
+    get modules(): GroupModules;
+    getModule(id: GroupModuleId): GroupModuleData | null;
+    isModuleEnabled(id: GroupModuleId): boolean;
+    get payoutRules(): GroupPayoutRuleEntry[];
 }

package/models/Group/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const date_fns_1 = require("date-fns");
 const lodash_1 = require("lodash");
 const collections_1 = require("../../helpers/collections");
+const currency_1 = require("../../helpers/currency");
 const glissandooAdmin_1 = require("../../helpers/glissandooAdmin");
 const orders_1 = require("../../helpers/instruments/orders");
 const objects_1 = require("../../helpers/objects");
@@ -108,6 +109,12 @@ class Group extends basic_1.default {
     get country() {
         return this.data.country || 'ES';
     }
+    get currency() {
+        return this.data.currency || currency_1.DEFAULT_CURRENCY;
+    }
+    get currencySymbol() {
+        return (0, currency_1.getCurrencySymbol)(this.currency, this.lang);
+    }
     get activePlayers() {
         return Object.keys(this.players);
     }
@@ -301,5 +308,17 @@ class Group extends basic_1.default {
     get coverURL() {
         return this.data.coverURL || null;
     }
+    get modules() {
+        return this.data.modules || {};
+    }
+    getModule(id) {
+        return this.modules[id] || null;
+    }
+    isModuleEnabled(id) {
+        return !!this.getModule(id)?.enabled;
+    }
+    get payoutRules() {
+        return this.data.payoutRules || [];
+    }
 }
 exports.default = Group;

package/models/Group/types.d.ts

@@ -3,6 +3,7 @@ import { CustomInstrumentId, DefaultInstrumentId } from '../../helpers/instrumen
 import { MusicStyleType } from '../../helpers/musicStyles';
 import { PlansGroup } from '../../helpers/plans';
 import { CreatedOn } from '../../helpers/types';
+import { GroupPayoutRuleEntry } from '../../types/payoutRule';
 import { EventPlayerStatus } from '../Evento/Player/types';
 import { EventType } from '../Evento/types';
 import { PlayerBasicData } from '../Player/types';
@@ -97,6 +98,32 @@ export declare enum GroupStatus {
     Inactive = "inactive",
     Deleted = "deleted"
 }
+export declare enum GroupModuleId {
+    Payout = "payout",
+    Inventory = "inventory",
+    Vacancies = "vacancies",
+    Partnership = "partnership",
+    MusicSchool = "musicSchool"
+}
+export declare enum GroupModulePlan {
+    Free = "free",
+    Paid = "paid"
+}
+export interface GroupModuleData {
+    enabled: boolean;
+    activatedAt: Timestamp | null;
+    activatedBy: string | null;
+    disabledAt: Timestamp | null;
+    disabledBy: string | null;
+    plan: GroupModulePlan;
+    /**
+     * Reserved for future Stripe integration. Not used yet.
+     */
+    subscriptionId: string | null;
+    stripeCustomerId: string | null;
+    stripeSubscriptionId: string | null;
+}
+export type GroupModules = Partial<Record<GroupModuleId, GroupModuleData>>;
 export declare enum SocialNetwork {
     Facebook = "facebook",
     Twitter = "twitter",
@@ -242,6 +269,7 @@ export interface GroupData extends GroupBasicData {
     eventCount: Record<EventType, number>;
     communicationCount: number;
     country: string;
+    currency: string;
     instruments: GroupInstruments;
     metadata: Record<string, string>;
     firstAnswerAt: Timestamp | null;
@@ -254,6 +282,8 @@ export interface GroupData extends GroupBasicData {
     customFields: Record<string, GroupCustomField>;
     inventoryId: string;
     coverURL: string | null;
+    modules: GroupModules;
+    payoutRules: GroupPayoutRuleEntry[];
     readonly createdOn: CreatedOn;
     readonly owner: DocumentReference;
     readonly createdAt: Timestamp;

package/models/Group/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GroupRepertoireTagDefault = exports.GroupRepertoireTagReserved = exports.SocialNetwork = exports.GroupStatus = exports.GroupConfigShowAttendanceToMembers = exports.GroupConfigSitesKey = exports.GroupConfigKey = exports.AdminPermissions = exports.GroupCustomFieldType = exports.GroupHistoryAction = void 0;
+exports.GroupRepertoireTagDefault = exports.GroupRepertoireTagReserved = exports.SocialNetwork = exports.GroupModulePlan = exports.GroupModuleId = exports.GroupStatus = exports.GroupConfigShowAttendanceToMembers = exports.GroupConfigSitesKey = exports.GroupConfigKey = exports.AdminPermissions = exports.GroupCustomFieldType = exports.GroupHistoryAction = void 0;
 var GroupHistoryAction;
 (function (GroupHistoryAction) {
     GroupHistoryAction["Created"] = "created";
@@ -74,6 +74,19 @@ var GroupStatus;
     GroupStatus["Inactive"] = "inactive";
     GroupStatus["Deleted"] = "deleted";
 })(GroupStatus = exports.GroupStatus || (exports.GroupStatus = {}));
+var GroupModuleId;
+(function (GroupModuleId) {
+    GroupModuleId["Payout"] = "payout";
+    GroupModuleId["Inventory"] = "inventory";
+    GroupModuleId["Vacancies"] = "vacancies";
+    GroupModuleId["Partnership"] = "partnership";
+    GroupModuleId["MusicSchool"] = "musicSchool";
+})(GroupModuleId = exports.GroupModuleId || (exports.GroupModuleId = {}));
+var GroupModulePlan;
+(function (GroupModulePlan) {
+    GroupModulePlan["Free"] = "free";
+    GroupModulePlan["Paid"] = "paid";
+})(GroupModulePlan = exports.GroupModulePlan || (exports.GroupModulePlan = {}));
 var SocialNetwork;
 (function (SocialNetwork) {
     SocialNetwork["Facebook"] = "facebook";

package/models/Notification/types.d.ts

@@ -148,7 +148,10 @@ export declare enum NotificationActions {
     GroupOnboardingEvent = "group.onboarding.event",
     OfferApplicantAdd = "offer.applicant.add",
     OfferSelectApplicant = "offer.select.applicant",
-    OfferAlarm = "offer.alarm"
+    OfferAlarm = "offer.alarm",
+    GroupPaymentPaid = "groupPayment.paid",
+    GroupPaymentCancelled = "groupPayment.cancelled",
+    GroupPaymentAmountChanged = "groupPayment.amountChanged"
 }
 export declare enum NotificationActionsFilter {
     EventCreated = "eventCreated",

package/models/Notification/types.js

@@ -146,6 +146,9 @@ var NotificationActions;
     NotificationActions["OfferApplicantAdd"] = "offer.applicant.add";
     NotificationActions["OfferSelectApplicant"] = "offer.select.applicant";
     NotificationActions["OfferAlarm"] = "offer.alarm";
+    NotificationActions["GroupPaymentPaid"] = "groupPayment.paid";
+    NotificationActions["GroupPaymentCancelled"] = "groupPayment.cancelled";
+    NotificationActions["GroupPaymentAmountChanged"] = "groupPayment.amountChanged";
 })(NotificationActions = exports.NotificationActions || (exports.NotificationActions = {}));
 var NotificationActionsFilter;
 (function (NotificationActionsFilter) {

package/package.json

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

package/types/payoutRule.d.ts

@@ -0,0 +1,126 @@
+import { Timestamp } from '@google-cloud/firestore';
+/**
+ * Shared types for the payout rules engine.
+ * Rules live at two levels:
+ *  - Group level (templates, can be `pinned` to auto-apply to new events)
+ *  - Event level (snapshot copied from the group when payout is initialized)
+ */
+export declare enum PayoutRuleType {
+    EntityShare = "entityShare",
+    DefaultExpense = "defaultExpense",
+    PlayerMultiplier = "playerMultiplier",
+    PlayerBonus = "playerBonus",
+    PlayerFixed = "playerFixed",
+    PlayerExclude = "playerExclude"
+}
+export declare enum PayoutRuleConditionOperator {
+    Eq = "eq",
+    Neq = "neq",
+    Gt = "gt",
+    Gte = "gte",
+    Lt = "lt",
+    Lte = "lte",
+    In = "in",
+    Nin = "nin"
+}
+export type PayoutRuleConditionFieldKind = 'mainInstrument' | 'isGuest' | `custom.${string}`;
+export type PayoutRuleConditionValue = string | number | boolean | string[] | number[] | null;
+export interface PayoutRuleCondition {
+    field: PayoutRuleConditionFieldKind;
+    operator: PayoutRuleConditionOperator;
+    value: PayoutRuleConditionValue;
+}
+export declare enum PayoutRuleEntityShareMode {
+    Fixed = "fixed",
+    Percentage = "percentage"
+}
+export interface PayoutRuleEntityShareEffect {
+    mode: PayoutRuleEntityShareMode;
+    value: number;
+}
+export interface PayoutRuleDefaultExpenseEffect {
+    concept: string;
+    amount: number;
+    /**
+     * `null` = expense remains general (reduces the shared pot).
+     * Future: could materialize per-attendee expenses.
+     */
+    assignTo: null;
+}
+export interface PayoutRulePlayerMultiplierEffect {
+    multiplier: number;
+}
+export interface PayoutRulePlayerBonusEffect {
+    amount: number;
+}
+export interface PayoutRulePlayerFixedEffect {
+    amount: number;
+}
+export type PayoutRulePlayerExcludeEffect = Record<string, never>;
+export type PayoutRuleEffect = {
+    type: PayoutRuleType.EntityShare;
+    data: PayoutRuleEntityShareEffect;
+} | {
+    type: PayoutRuleType.DefaultExpense;
+    data: PayoutRuleDefaultExpenseEffect;
+} | {
+    type: PayoutRuleType.PlayerMultiplier;
+    data: PayoutRulePlayerMultiplierEffect;
+} | {
+    type: PayoutRuleType.PlayerBonus;
+    data: PayoutRulePlayerBonusEffect;
+} | {
+    type: PayoutRuleType.PlayerFixed;
+    data: PayoutRulePlayerFixedEffect;
+} | {
+    type: PayoutRuleType.PlayerExclude;
+    data: PayoutRulePlayerExcludeEffect;
+};
+/**
+ * Common shape stored in both group templates and event snapshots.
+ */
+export interface PayoutRuleBaseData {
+    name: string;
+    description: string | null;
+    order: number;
+    conditions: PayoutRuleCondition[];
+    effect: PayoutRuleEffect;
+    createdAt: Timestamp;
+    createdBy: string;
+    editedAt: Timestamp | null;
+    editedBy: string | null;
+}
+/**
+ * Helper used by the pure rules engine. Holds the minimal data
+ * required to evaluate conditions against a player.
+ */
+export interface PayoutRulePlayerInput {
+    id: string;
+    mainInstrument: string;
+    isGuest: boolean;
+    customFields: Record<string, string | number | boolean | null>;
+}
+export interface GroupPayoutRuleEntry {
+    id: string;
+    name: string;
+    order: number;
+    pinned: boolean;
+    conditions: PayoutRuleCondition[];
+    effect: PayoutRuleEffect;
+    createdAt: Timestamp;
+    createdBy: string;
+    editedAt: Timestamp | null;
+    editedBy: string | null;
+}
+export interface EventoPayoutRuleEntry {
+    id: string;
+    name: string;
+    order: number;
+    sourceGroupRuleId: string | null;
+    conditions: PayoutRuleCondition[];
+    effect: PayoutRuleEffect;
+    createdAt: Timestamp;
+    createdBy: string;
+    editedAt: Timestamp | null;
+    editedBy: string | null;
+}

package/types/payoutRule.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayoutRuleEntityShareMode = exports.PayoutRuleConditionOperator = exports.PayoutRuleType = void 0;
+/**
+ * Shared types for the payout rules engine.
+ * Rules live at two levels:
+ *  - Group level (templates, can be `pinned` to auto-apply to new events)
+ *  - Event level (snapshot copied from the group when payout is initialized)
+ */
+var PayoutRuleType;
+(function (PayoutRuleType) {
+    PayoutRuleType["EntityShare"] = "entityShare";
+    PayoutRuleType["DefaultExpense"] = "defaultExpense";
+    PayoutRuleType["PlayerMultiplier"] = "playerMultiplier";
+    PayoutRuleType["PlayerBonus"] = "playerBonus";
+    PayoutRuleType["PlayerFixed"] = "playerFixed";
+    PayoutRuleType["PlayerExclude"] = "playerExclude";
+})(PayoutRuleType = exports.PayoutRuleType || (exports.PayoutRuleType = {}));
+var PayoutRuleConditionOperator;
+(function (PayoutRuleConditionOperator) {
+    PayoutRuleConditionOperator["Eq"] = "eq";
+    PayoutRuleConditionOperator["Neq"] = "neq";
+    PayoutRuleConditionOperator["Gt"] = "gt";
+    PayoutRuleConditionOperator["Gte"] = "gte";
+    PayoutRuleConditionOperator["Lt"] = "lt";
+    PayoutRuleConditionOperator["Lte"] = "lte";
+    PayoutRuleConditionOperator["In"] = "in";
+    PayoutRuleConditionOperator["Nin"] = "nin";
+})(PayoutRuleConditionOperator = exports.PayoutRuleConditionOperator || (exports.PayoutRuleConditionOperator = {}));
+var PayoutRuleEntityShareMode;
+(function (PayoutRuleEntityShareMode) {
+    PayoutRuleEntityShareMode["Fixed"] = "fixed";
+    PayoutRuleEntityShareMode["Percentage"] = "percentage";
+})(PayoutRuleEntityShareMode = exports.PayoutRuleEntityShareMode || (exports.PayoutRuleEntityShareMode = {}));