@stamhoofd/backend 2.120.6 → 2.122.0

package/src/helpers/AuthenticatedStructures.ts

@@ -1,8 +1,9 @@
 import { SimpleError } from '@simonbackx/simple-errors';
-import type { AuditLog, Document, EventNotification, MemberWithUsersRegistrationsAndGroups, Order, Ticket} from '@stamhoofd/models';
-import { BalanceItem, CachedBalance, Event, Group, Invoice, Member, MemberPlatformMembership, MemberResponsibilityRecord, Organization, OrganizationRegistrationPeriod, Payment, Registration, RegistrationPeriod, User, Webshop } from '@stamhoofd/models';
-import type { PaymentGeneral} from '@stamhoofd/structures';
-import { AuditLogReplacement, AuditLogReplacementType, AuditLog as AuditLogStruct, DetailedReceivableBalance, Document as DocumentStruct, EventNotification as EventNotificationStruct, Event as EventStruct, GenericBalance, Group as GroupStruct, GroupType, InvoicedBalanceItem, InvoiceStruct, MemberPlatformMembership as MemberPlatformMembershipStruct, MembersBlob, MemberWithRegistrationsBlob, NamedObject, OrganizationRegistrationPeriod as OrganizationRegistrationPeriodStruct, Organization as OrganizationStruct, PaymentCustomer, PermissionLevel, Platform, PrivateOrder, PrivateWebshop, ReceivableBalanceObject, ReceivableBalanceObjectContact, ReceivableBalance as ReceivableBalanceStruct, ReceivableBalanceType, RegistrationsBlob, RegistrationWithMemberBlob, TicketPrivate, UserWithMembers, WebshopPreview, Webshop as WebshopStruct, BalanceItem as BalanceItemStruct } from '@stamhoofd/structures';
+import type { AuditLog, Document, EventNotification, MemberWithUsersRegistrationsAndGroups, Order, Ticket } from '@stamhoofd/models';
+import { BalanceItem, CachedBalance, Event, Group, Invoice, Member, MemberPlatformMembership, MemberResponsibilityRecord, Organization, OrganizationRegistrationPeriod, Payment, Registration, RegistrationInvitation, RegistrationPeriod, User, Webshop } from '@stamhoofd/models';
+import type { PaymentGeneral } from '@stamhoofd/structures';
+import { BaseOrganization, getAppHost } from '@stamhoofd/structures';
+import { Payment as PaymentStruct, AuditLogReplacement, AuditLogReplacementType, AuditLog as AuditLogStruct, BalanceItem as BalanceItemStruct, DetailedReceivableBalance, Document as DocumentStruct, EventNotification as EventNotificationStruct, Event as EventStruct, GenericBalance, Group as GroupStruct, GroupType, InvitationGroupData, InvitationMemberData, InvoicedBalanceItem, InvoiceStruct, MemberPlatformMembership as MemberPlatformMembershipStruct, MemberRegistrationInvitation, MembersBlob, MemberWithRegistrationsBlob, NamedObject, OrganizationRegistrationPeriod as OrganizationRegistrationPeriodStruct, Organization as OrganizationStruct, PaymentCustomer, PermissionLevel, Platform, PrivateOrder, PrivateWebshop, ReceivableBalanceObject, ReceivableBalanceObjectContact, ReceivableBalance as ReceivableBalanceStruct, ReceivableBalanceType, RegistrationInvitation as RegistrationInvitationStruct, RegistrationsBlob, RegistrationWithMemberBlob, TicketPrivate, UserWithMembers, WebshopPreview, Webshop as WebshopStruct } from '@stamhoofd/structures';
 import { Sorter } from '@stamhoofd/utility';
 
 import { SQL } from '@stamhoofd/sql';
@@ -34,7 +35,7 @@ export class AuthenticatedStructures {
             const { registrations, orders } = await Payment.loadBalanceItemRelations(balanceItems);
 
             // Note: permission checking is moved here for performacne to avoid loading the data multiple times
-            if (!(await Context.auth.canAccessBalanceItems(balanceItems, PermissionLevel.Read, { registrations, orders }))) {
+            if (!(await Context.optionalAuth?.canAccessBalanceItems(balanceItems, PermissionLevel.Read, { registrations, orders }))) {
                 throw new SimpleError({
                     code: 'permission_denied',
                     message: 'Permission denied',
@@ -43,7 +44,7 @@ export class AuthenticatedStructures {
             }
         }
 
-        const includeSettlements = checkPermissions && !!Context.user && !!Context.user.permissions;
+        const includeSettlements = checkPermissions && !!Context.user && !!Context.user.permissions && payments.every(p => !!Context.optionalAuth?.checkScope(p.organizationId));
 
         const { payingOrganizations } = await Payment.loadPayingOrganizations(payments);
 
@@ -55,6 +56,22 @@ export class AuthenticatedStructures {
         }, includeSettlements);
     }
 
+    /**
+     *
+     * @param payments
+     * @param checkPermissions Only set to undefined when not returned in the API + not for public use
+     * @returns
+     */
+    static async payments(payments: Payment[]): Promise<PaymentStruct[]> {
+        if (payments.length === 0) {
+            return [];
+        }
+
+        return payments.map((p) => {
+            return PaymentStruct.create(p);
+        });
+    }
+
     static async invoices(invoices: Invoice[]): Promise<InvoiceStruct[]> {
         if (invoices.length === 0) {
             return [];
@@ -92,8 +109,7 @@ export class AuthenticatedStructures {
 
             if (existingGroup) {
                 waitingLists.push(existingGroup);
-            }
-            else {
+            } else {
                 waitingListsToFetch.push(waitingListId);
             }
         }
@@ -159,13 +175,11 @@ export class AuthenticatedStructures {
                     .where(whereGroupIds)
                     .orWhere(whereWaitingList)
                     .fetch();
-            }
-            else {
+            } else {
                 groups = await Group.select()
                     .where(whereGroupIds).fetch();
             }
-        }
-        else if (organizationIds.length && periodIds.length) {
+        } else if (organizationIds.length && periodIds.length) {
             groups = await Group.select()
                 .where(whereWaitingList)
                 .fetch();
@@ -222,6 +236,16 @@ export class AuthenticatedStructures {
         return WebshopPreview.create(webshop);
     }
 
+    static async baseOrganizations(organizations: Organization[]): Promise<BaseOrganization[]> {
+        if (organizations.length === 0) {
+            return [];
+        }
+
+        return organizations.map((o) => {
+            return BaseOrganization.create(o);
+        });
+    }
+
     static async organizations(organizations: Organization[]): Promise<OrganizationStruct[]> {
         if (organizations.length === 0) {
             return [];
@@ -235,8 +259,7 @@ export class AuthenticatedStructures {
             const array = periodIdOrganizationsMap.get(periodId);
             if (array !== undefined) {
                 array.push(organization);
-            }
-            else {
+            } else {
                 periodIdOrganizationsMap.set(periodId, [organization]);
             }
         }
@@ -287,8 +310,7 @@ export class AuthenticatedStructures {
                         organizationIdsToGetWebshopsFor.push(organization.id);
                     }
                     organizationData.set(organizationId, { organizationRegistrationPeriod, canAccessPrivateData });
-                }
-                else {
+                } else {
                     // Should never happen
                     throw new Error('Organization registration period model not found for organization id ' + organizationId + ' and period id ' + periodId);
                 }
@@ -298,14 +320,14 @@ export class AuthenticatedStructures {
         // Get webshop previews
         const webshops = organizationIdsToGetWebshopsFor.length > 0
             ? await Webshop.where(
-                {
-                    organizationId: {
-                        sign: 'IN',
-                        value: organizationIdsToGetWebshopsFor,
+                    {
+                        organizationId: {
+                            sign: 'IN',
+                            value: organizationIdsToGetWebshopsFor,
+                        },
                     },
-                },
-                { select: Webshop.selectColumnsWithout(undefined, 'products', 'categories') },
-            )
+                    { select: Webshop.selectColumnsWithout(undefined, 'products', 'categories') },
+                )
             : [];
 
         const webshopPreviews = new Map<string, WebshopPreview[]>();
@@ -321,8 +343,7 @@ export class AuthenticatedStructures {
 
             if (array) {
                 array.push(preview);
-            }
-            else {
+            } else {
                 webshopPreviews.set(organizationId, [preview]);
             }
         }
@@ -356,8 +377,7 @@ export class AuthenticatedStructures {
                     privateMeta: organization.privateMeta.removedPrivateKeys,
                     webshops: webshopPreviews.get(organization.id)?.sort((a, b) => Sorter.byDateValue(b.createdAt, a.createdAt)),
                 });
-            }
-            else {
+            } else {
                 result = OrganizationStruct.create({
                     ...baseStruct,
                     period,
@@ -447,18 +467,25 @@ export class AuthenticatedStructures {
         // Load responsibilities
         const responsibilities = members.length > 0
             ? await MemberResponsibilityRecord.select()
-                .where('memberId', members.map(m => m.id))
-                .where(SQL.where('endDate', null).or('endDate', '>', new Date()))
-                .fetch()
+                    .where('memberId', members.map(m => m.id))
+                    .where(SQL.where('endDate', null).or('endDate', '>', new Date()))
+                    .fetch()
             : [];
         const platformMemberships = members.length > 0
             ? await MemberPlatformMembership.select()
-                .where('memberId', members.map(m => m.id))
-                .where('deletedAt', null)
-                .where('periodId', relevantPeriodIds)
-                .fetch()
+                    .where('memberId', members.map(m => m.id))
+                    .where('deletedAt', null)
+                    .where('periodId', relevantPeriodIds)
+                    .fetch()
+            : [];
+        const registrationInvitations = members.length > 0
+            ? await RegistrationInvitation.select()
+                    .where('memberId', members.map(m => m.id))
+                    .fetch()
             : [];
 
+        const memberRegistrationInvitations: Map<string, MemberRegistrationInvitation[]> = registrationInvitations.length > 0 ? await this.memberRegistrationInvitations(registrationInvitations) : new Map();
+
         // Load organizations
         const organizationIds = responsibilities.map(r => r.organizationId)
             .concat(
@@ -640,8 +667,7 @@ export class AuthenticatedStructures {
                         const g = allGroups.get(r.groupId);
                         if (g) {
                             base.group = g;
-                        }
-                        else {
+                        } else {
                             console.error('Group not preloaded for registration', r.id, r.groupId);
                         }
 
@@ -663,6 +689,7 @@ export class AuthenticatedStructures {
                 return r.getStructure(group);
             });
             blob.platformMemberships = platformMemberships.filter(r => r.memberId == blob.id).map(r => MemberPlatformMembershipStruct.create(r));
+            blob.registrationInvitations = memberRegistrationInvitations.get(blob.id) ?? [];
         }
 
         return MembersBlob.create({
@@ -775,8 +802,7 @@ export class AuthenticatedStructures {
             const array = eventIdsMapping.get(notificationId);
             if (array) {
                 array.push(eventId);
-            }
-            else {
+            } else {
                 eventIdsMapping.set(notificationId, [eventId]);
             }
 
@@ -935,7 +961,7 @@ export class AuthenticatedStructures {
         return (await this.receivableBalancesHelper(balances)).map(({ balance, object }) => ReceivableBalanceStruct.create({ ...balance, object }));
     }
 
-    private static async receivableBalancesHelper(balances: CachedBalance[]): Promise< { balance: CachedBalance; object: ReceivableBalanceObject }[]> {
+    private static async receivableBalancesHelper(balances: CachedBalance[]): Promise<{ balance: CachedBalance; object: ReceivableBalanceObject }[]> {
         if (balances.length === 0) {
             return [];
         }
@@ -972,7 +998,7 @@ export class AuthenticatedStructures {
         const result: { balance: CachedBalance; object: ReceivableBalanceObject }[] = [];
 
         function getMemberContacts(member: Member, balance: CachedBalance) {
-            const url = Context.organization && Context.organization.id === balance.organizationId ? 'https://' + Context.organization.getHost() : '';
+            const url = Context.organization && Context.organization.id === balance.organizationId ? 'https://' + getAppHost('registration', Context.organization, false) : '';
             return [
                 ...(member.details.getMemberEmails().length
                     ? [
@@ -1065,8 +1091,7 @@ export class AuthenticatedStructures {
                         })),
                     });
                 }
-            }
-            else if (balance.objectType === ReceivableBalanceType.member) {
+            } else if (balance.objectType === ReceivableBalanceType.member) {
                 const member = members.find(m => m.id === balance.objectId) ?? null;
                 if (member) {
                     object = ReceivableBalanceObject.create({
@@ -1076,8 +1101,7 @@ export class AuthenticatedStructures {
                         contacts: getMemberContacts(member, balance),
                     });
                 }
-            }
-            else if (balance.objectType === ReceivableBalanceType.registration) {
+            } else if (balance.objectType === ReceivableBalanceType.registration) {
                 const registration = registrations.find(r => r.id === balance.objectId) ?? null;
                 if (!registration) {
                     continue;
@@ -1091,11 +1115,10 @@ export class AuthenticatedStructures {
                         contacts: getMemberContacts(member, balance),
                     });
                 }
-            }
-            else if (balance.objectType === ReceivableBalanceType.user || balance.objectType === ReceivableBalanceType.userWithoutMembers) {
+            } else if (balance.objectType === ReceivableBalanceType.user || balance.objectType === ReceivableBalanceType.userWithoutMembers) {
                 const user = users.find(m => m.id === balance.objectId) ?? null;
                 if (user) {
-                    const url = Context.organization && Context.organization.id === balance.organizationId ? 'https://' + Context.organization.getHost() : '';
+                    const url = Context.organization && Context.organization.id === balance.organizationId ? 'https://' + getAppHost('registration', Context.organization, user.permissions?.forOrganization(Context.organization)?.isEmpty === false) : '';
                     object = ReceivableBalanceObject.create({
                         id: balance.objectId,
                         name: user.name || user.email,
@@ -1169,15 +1192,13 @@ export class AuthenticatedStructures {
                             id: '',
                             name: $t(`%wi`) + ' ' + Platform.shared.config.name,
                         });
-                    }
-                    else {
+                    } else {
                         userStruct = NamedObject.create({
                             id: '',
                             name: $t(`%Gr`),
                         });
                     }
-                }
-                else {
+                } else {
                     userStruct = NamedObject.create({
                         id: user.id,
                         name: (user.firstName || user.lastName) ? (user.firstName + ' ' + user.lastName) : user.email,
@@ -1220,4 +1241,85 @@ export class AuthenticatedStructures {
     static async balanceItemsWithPayments(balanceItems: BalanceItem[]) {
         return await BalanceItem.getStructureWithPayments(balanceItems);
     }
+
+    static async memberRegistrationInvitations(invitations: RegistrationInvitation[]): Promise<Map<string, MemberRegistrationInvitation[]>> {
+        const results = new Map<string, MemberRegistrationInvitation[]>();
+        const groups = await Group.getByIDs(...invitations.map(i => i.groupId));
+
+        for (const invitation of invitations) {
+            const group = groups.find(g => g.id === invitation.groupId);
+            if (!group) {
+                throw new SimpleError({
+                    code: 'group_not_found',
+                    message: 'Group not found',
+                    human: $t(`%1SM`),
+                });
+            }
+
+            const result = MemberRegistrationInvitation.create({
+                id: invitation.id,
+                group: InvitationGroupData.create({
+                    id: invitation.groupId,
+                    name: group.settings.name,
+                    type: group.type,
+                    periodId: group.periodId,
+                }),
+                organizationId: invitation.organizationId,
+                createdAt: invitation.createdAt,
+            });
+
+            let array = results.get(invitation.memberId);
+            if (!array) {
+                array = [result];
+                results.set(invitation.memberId, array);
+            } else {
+                array.push(result);
+            }
+        }
+
+        return results;
+    }
+
+    static async registrationInvitations(invitations: RegistrationInvitation[]): Promise<RegistrationInvitationStruct[]> {
+        const members = await Member.getByIDs(...invitations.map(i => i.memberId));
+        const groups = await Group.getByIDs(...invitations.map(i => i.groupId));
+
+        return invitations.map((invitation) => {
+            const member = members.find(m => m.id === invitation.memberId);
+            if (!member) {
+                throw new SimpleError({
+                    code: 'member_not_found',
+                    message: 'Member not found',
+                    human: $t(`%EO`),
+                });
+            }
+
+            const group = groups.find(g => g.id === invitation.groupId);
+            if (!group) {
+                throw new SimpleError({
+                    code: 'group_not_found',
+                    message: 'Group not found',
+                    human: $t(`%1SM`),
+                });
+            }
+
+            return RegistrationInvitationStruct.create({
+                id: invitation.id,
+                group: InvitationGroupData.create({
+                    id: group.id,
+                    name: group.settings.name,
+                    type: group.type,
+                    periodId: group.periodId,
+                }),
+                organizationId: invitation.organizationId,
+                member: InvitationMemberData.create({
+                    id: member.id,
+                    firstName: member.firstName,
+                    lastName: member.lastName,
+                    birthDay: member.details.birthDay,
+                }),
+                createdAt: invitation.createdAt,
+            });
+        });
+    }
 }

package/src/helpers/BalanceItemRelationsBackfiller.test.ts

@@ -0,0 +1,174 @@
+import type { Organization, RegistrationPeriod, Webshop } from '@stamhoofd/models';
+import { BalanceItem, BalanceItemFactory, GroupFactory, MemberFactory, OrganizationFactory, OrganizationRegistrationPeriodFactory, Order, RegistrationFactory, RegistrationPeriodFactory, WebshopFactory } from '@stamhoofd/models';
+import { BalanceItemRelation, BalanceItemRelationType, BalanceItemType, OrderData, ReduceablePrice, TranslatedString } from '@stamhoofd/structures';
+import { TestUtils } from '@stamhoofd/test-utils';
+import { v4 as uuidv4 } from 'uuid';
+import { backfillBalanceItemRelations } from './BalanceItemRelationsBackfiller.js';
+
+describe('helper.BalanceItemRelationsBackfiller', () => {
+    let period: RegistrationPeriod;
+
+    beforeAll(async () => {
+        period = await new RegistrationPeriodFactory({
+            startDate: new Date(2023, 0, 1),
+            endDate: new Date(2030, 11, 31),
+        }).create();
+    });
+
+    beforeEach(() => {
+        TestUtils.setEnvironment('userMode', 'platform');
+    });
+
+    async function createOrder(organization: Organization, webshop: Webshop) {
+        const order = new Order();
+        order.organizationId = organization.id;
+        order.webshopId = webshop.id;
+        order.data = OrderData.create({});
+        await order.save();
+        return order;
+    }
+
+    it('fills member, group and group price relations for registration balance items', async () => {
+        const organization = await new OrganizationFactory({ period }).create();
+        await new OrganizationRegistrationPeriodFactory({ organization, period }).create();
+
+        const member = await new MemberFactory({ organization, firstName: 'John', lastName: 'Doe' }).create();
+        const group = await new GroupFactory({ organization, period }).create();
+        const registration = await new RegistrationFactory({ member, group }).create();
+
+        const balanceItem = await new BalanceItemFactory({
+            organizationId: organization.id,
+            memberId: member.id,
+            registrationId: registration.id,
+            type: BalanceItemType.Registration,
+            amount: 1,
+            unitPrice: 25_00,
+        }).create();
+
+        expect(balanceItem.relations.size).toBe(0);
+
+        await backfillBalanceItemRelations();
+
+        const updated = await BalanceItem.getByID(balanceItem.id);
+        expect(updated?.relations.get(BalanceItemRelationType.Member)).toMatchObject({ id: member.id });
+        expect(updated?.relations.get(BalanceItemRelationType.Member)?.name.toString()).toBe('John Doe');
+        expect(updated?.relations.get(BalanceItemRelationType.Group)).toMatchObject({ id: group.id });
+        // Only one price configured, so no group price relation
+        expect(updated?.relations.has(BalanceItemRelationType.GroupPrice)).toBe(false);
+    });
+
+    it('fills the group price relation when the group has multiple prices', async () => {
+        const organization = await new OrganizationFactory({ period }).create();
+        await new OrganizationRegistrationPeriodFactory({ organization, period }).create();
+
+        const member = await new MemberFactory({ organization }).create();
+        const group = await new GroupFactory({ organization, period }).create();
+
+        // Add a second price so the relation should be filled
+        group.settings.prices.push(group.settings.prices[0].clone());
+        group.settings.prices[1].id = uuidv4();
+        group.settings.prices[1].name = new TranslatedString('Late price');
+        group.settings.prices[1].price = ReduceablePrice.create({ price: 30_00 });
+        await group.save();
+
+        const registration = await new RegistrationFactory({ member, group, groupPrice: group.settings.prices[1] }).create();
+
+        const balanceItem = await new BalanceItemFactory({
+            organizationId: organization.id,
+            memberId: member.id,
+            registrationId: registration.id,
+            type: BalanceItemType.Registration,
+            amount: 1,
+            unitPrice: 30_00,
+        }).create();
+
+        await backfillBalanceItemRelations();
+
+        const updated = await BalanceItem.getByID(balanceItem.id);
+        expect(updated?.relations.get(BalanceItemRelationType.GroupPrice)).toMatchObject({ id: group.settings.prices[1].id });
+    });
+
+    it('copies the registration period dates onto the balance item', async () => {
+        const organization = await new OrganizationFactory({ period }).create();
+        await new OrganizationRegistrationPeriodFactory({ organization, period }).create();
+
+        const member = await new MemberFactory({ organization }).create();
+        const group = await new GroupFactory({ organization, period }).create();
+        const registration = await new RegistrationFactory({ member, group }).create();
+
+        const startDate = new Date(2024, 7, 1);
+        const endDate = new Date(2025, 6, 31);
+        registration.startDate = startDate;
+        registration.endDate = endDate;
+        await registration.save();
+
+        const balanceItem = await new BalanceItemFactory({
+            organizationId: organization.id,
+            memberId: member.id,
+            registrationId: registration.id,
+            type: BalanceItemType.Registration,
+            amount: 1,
+            unitPrice: 25_00,
+        }).create();
+
+        await backfillBalanceItemRelations();
+
+        const updated = await BalanceItem.getByID(balanceItem.id);
+        expect(updated?.startDate?.getTime()).toBe(startDate.getTime());
+        expect(updated?.endDate?.getTime()).toBe(endDate.getTime());
+    });
+
+    it('fills the webshop relation for order balance items', async () => {
+        const organization = await new OrganizationFactory({ period }).create();
+        const webshop = await new WebshopFactory({ organizationId: organization.id, name: 'My webshop' }).create();
+        const order = await createOrder(organization, webshop);
+
+        const balanceItem = await new BalanceItemFactory({
+            organizationId: organization.id,
+            orderId: order.id,
+            type: BalanceItemType.Order,
+            amount: 1,
+            unitPrice: 12_00,
+        }).create();
+
+        expect(balanceItem.relations.size).toBe(0);
+
+        await backfillBalanceItemRelations();
+
+        const updated = await BalanceItem.getByID(balanceItem.id);
+        expect(updated?.relations.get(BalanceItemRelationType.Webshop)).toMatchObject({ id: webshop.id });
+        expect(updated?.relations.get(BalanceItemRelationType.Webshop)?.name.toString()).toBe('My webshop');
+    });
+
+    it('does not overwrite existing relations', async () => {
+        const organization = await new OrganizationFactory({ period }).create();
+        await new OrganizationRegistrationPeriodFactory({ organization, period }).create();
+
+        const member = await new MemberFactory({ organization }).create();
+        const group = await new GroupFactory({ organization, period }).create();
+        const registration = await new RegistrationFactory({ member, group }).create();
+
+        const existingRelations = new Map([
+            [
+                BalanceItemRelationType.Member,
+                BalanceItemRelation.create({ id: member.id, name: new TranslatedString('Custom name') }),
+            ],
+        ]);
+
+        const balanceItem = await new BalanceItemFactory({
+            organizationId: organization.id,
+            memberId: member.id,
+            registrationId: registration.id,
+            type: BalanceItemType.Registration,
+            amount: 1,
+            unitPrice: 25_00,
+            relations: existingRelations,
+        }).create();
+
+        await backfillBalanceItemRelations();
+
+        const updated = await BalanceItem.getByID(balanceItem.id);
+        expect(updated?.relations.size).toBe(1);
+        expect(updated?.relations.get(BalanceItemRelationType.Member)?.name.toString()).toBe('Custom name');
+    });
+});