@stamhoofd/models 2.120.6 → 2.122.0

package/src/migrations/1763216320-bigint-balance-items.sql

@@ -0,0 +1,5 @@
+ALTER TABLE `balance_items`
+CHANGE `unitPrice` `unitPrice` bigint NOT NULL DEFAULT '0',
+CHANGE `pricePaid` `pricePaid` bigint NOT NULL DEFAULT '0',
+CHANGE `pricePending` `pricePending` bigint NOT NULL DEFAULT '0',
+CHANGE `priceOpen` `priceOpen` bigint NOT NULL DEFAULT '0';

package/src/migrations/1763216320-bigint-orders.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `webshop_orders`
+CHANGE `totalPrice` `totalPrice` bigint NULL;

package/src/migrations/1763216320-bigint-payments.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `payments`
+CHANGE `price` `price` bigint NOT NULL DEFAULT '0';

package/src/migrations/1763216332-bigint-balance-item-price-total.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `balance_items`
+CHANGE `priceTotal` `priceTotal` bigint NOT NULL DEFAULT '0';

package/src/migrations/1769087808-corrected-invoice-user-agent.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `invoices`
+CHANGE `userAgent` `userAgent` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL;

package/src/migrations/1769087809-payments-invoice-id.sql

@@ -1,3 +1,5 @@
+SET FOREIGN_KEY_CHECKS=0;
 ALTER TABLE `payments`
 ADD COLUMN `invoiceId` varchar(36) NULL AFTER `customer`,
 ADD FOREIGN KEY (`invoiceId`) REFERENCES `invoices` (`id`) ON UPDATE CASCADE ON DELETE SET NULL;
+SET FOREIGN_KEY_CHECKS=1;

package/src/migrations/1772033555-balance-item-package-id.sql

@@ -1,3 +1,5 @@
+SET FOREIGN_KEY_CHECKS=0;
 ALTER TABLE `balance_items`
 ADD COLUMN `packageId` varchar(36) NULL AFTER `memberId`,
 ADD FOREIGN KEY (`packageId`) REFERENCES `stamhoofd_packages` (`id`) ON UPDATE CASCADE ON DELETE SET NULL;
+SET FOREIGN_KEY_CHECKS=1;

package/src/migrations/1776873089-create-registration-invitations-table.sql

@@ -0,0 +1,13 @@
+CREATE TABLE `registration_invitations` (
+	`id` varchar(36) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
+	`memberId` varchar(36) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
+	`groupId` varchar(36) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
+	`organizationId` varchar(36) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
+	`createdAt` datetime NOT NULL,
+	PRIMARY KEY (`id`),
+    UNIQUE KEY `uk_member_group` (`memberId`, `groupId`),
+    KEY `idx_memberId` (`memberId`) USING BTREE,
+	CONSTRAINT `registration_invitations_ibfk_1` FOREIGN KEY (`memberId`) REFERENCES `members` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
+	CONSTRAINT `registration_invitations_ibfk_2` FOREIGN KEY (`groupId`) REFERENCES `groups` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
+    CONSTRAINT `registration_invitations_ibfk_3` FOREIGN KEY (`organizationId`) REFERENCES `organizations` (`id`) ON UPDATE CASCADE ON DELETE CASCADE
+) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci;

package/src/migrations/1778657958-payments-create-mandate.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `payments`
+ADD COLUMN `createMandate` json NULL AFTER `stripeAccountId`;

package/src/migrations/1778657959-payments-mandate-id.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `payments`
+ADD COLUMN `mandateId` varchar(36) NULL AFTER `stripeAccountId`;

package/src/migrations/1778796615-payments-reversing-payment-id.sql

@@ -0,0 +1,5 @@
+SET FOREIGN_KEY_CHECKS=0;
+ALTER TABLE `payments`
+ADD COLUMN `reversingPaymentId` varchar(36) NULL AFTER `invoiceId`,
+ADD FOREIGN KEY (`reversingPaymentId`) REFERENCES `payments` (`id`) ON UPDATE CASCADE ON DELETE SET NULL;
+SET FOREIGN_KEY_CHECKS=1;

package/src/migrations/1778950642-price-invoiced.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `balance_items`
+ADD COLUMN `priceInvoiced` int NOT NULL DEFAULT '0' AFTER `priceOpen`;

package/src/migrations/1779443446-transfer-fees.sql

@@ -0,0 +1,3 @@
+ALTER TABLE `payments`
+ADD COLUMN `transferFeeManual` int NOT NULL DEFAULT '0' AFTER `transferFee`,
+ADD COLUMN `transferFeeManualCharged` int NOT NULL DEFAULT '0' AFTER `transferFeeManual`;

package/src/migrations/1779709174-used-register-code-balance-item-id.sql

@@ -0,0 +1,5 @@
+SET FOREIGN_KEY_CHECKS=0;
+ALTER TABLE `used_register_codes`
+ADD COLUMN `balanceItemId` varchar(36) NULL AFTER `code`,
+ADD FOREIGN KEY (`balanceItemId`) REFERENCES `balance_items` (`id`) ON UPDATE CASCADE ON DELETE SET NULL;
+SET FOREIGN_KEY_CHECKS=1;

package/src/migrations/1779968328-payments-admin-user-id.sql

@@ -0,0 +1,5 @@
+SET FOREIGN_KEY_CHECKS=0;
+ALTER TABLE `payments`
+ADD COLUMN `adminUserId` varchar(36) NULL AFTER `organizationId`,
+ADD FOREIGN KEY (`adminUserId`) REFERENCES `users` (`id`) ON UPDATE CASCADE ON DELETE SET NULL;
+SET FOREIGN_KEY_CHECKS=1;

package/src/migrations/1779970611-payments-refunded-amount.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `payments`
+ADD COLUMN `refundedAmount` bigint NOT NULL DEFAULT '0' AFTER `price`;

package/src/migrations/1779972640-balance-items-failed-at.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `balance_items`
+ADD COLUMN `failedAt` datetime NULL AFTER `paidAt`;

package/src/migrations/1780328285-document-template-locked.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `document_templates`
+ADD COLUMN `isLocked` tinyint(1) NOT NULL DEFAULT '0' AFTER `publishedAt`;

package/src/migrations/1780328286-document-locked.sql

@@ -0,0 +1,2 @@
+ALTER TABLE `documents`
+ADD COLUMN `isLocked` tinyint(1) NOT NULL DEFAULT '0' AFTER `number`;

package/src/migrations/1780412083-documents-set-locked.ts

@@ -0,0 +1,18 @@
+import { Database, Migration } from '@simonbackx/simple-database';
+
+export default new Migration(async () => {
+    process.stdout.write('\n');
+
+    if (STAMHOOFD.userMode === 'platform') {
+        console.log('Skipped set documents locked for userMode platform.');
+        return Promise.resolve();
+    }
+
+    console.log('Start locking document templates.');
+    await Database.statement(`update document_templates set isLocked = 1 where status = 'Published';`);
+
+    console.log('Start locking documents.');
+    await Database.statement(`update documents set isLocked = 1 where status = 'Published';`);
+
+    return Promise.resolve();
+});

package/src/migrations/1780928401-v1-groups-migration-data.ts

@@ -0,0 +1,50 @@
+import { Database, Migration } from '@simonbackx/simple-database';
+export default new Migration(async () => {
+    if (STAMHOOFD.environment === 'test') {
+        console.log('skipped in tests');
+        return;
+    }
+
+    if (STAMHOOFD.userMode === 'platform') {
+        console.log('skipped for userMode platform');
+        return;
+    }
+
+    console.log('start create v1_groups_migration_data table');
+
+    // create table to keep track of which combination of group id and cycle has been migrated to a new group after the migration from Stamhoofd v1 to v2
+    const groupsQuery = `CREATE TABLE \`v1_groups_migration_data\` (
+        \`newGroupId\` varchar(36) NOT NULL,
+        \`oldGroupId\` varchar(36) NOT NULL,
+        \`oldCycle\` int NOT NULL DEFAULT '0',
+    PRIMARY KEY (\`newGroupId\`),
+    UNIQUE KEY \`oldKey\` (\`oldGroupId\`,\`oldCycle\`) USING BTREE,
+    CONSTRAINT \`v1_groups_migration_data_ibfk_1\` FOREIGN KEY (\`newGroupId\`) REFERENCES \`groups\` (\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;`;
+
+    await Database.statement(groupsQuery);
+    console.log('finished create v1_groups_migration_data table');
+
+    console.log('start create v1_waiting_list_migration_data table');
+    // create table to keep track of which combination of waiting list group id and cycle has been migrated to a new group after the migration from Stamhoofd v1 to v2
+    const waitingListsQuery = `CREATE TABLE \`v1_waiting_list_migration_data\` (
+        \`newGroupId\` varchar(36) NOT NULL,
+        \`oldGroupId\` varchar(36) NOT NULL,
+        \`oldCycle\` int NOT NULL DEFAULT '0',
+    PRIMARY KEY (\`newGroupId\`),
+    UNIQUE KEY \`oldKey\` (\`oldGroupId\`,\`oldCycle\`) USING BTREE,
+    CONSTRAINT \`v1_waiting_list_migration_data_ibfk_1\` FOREIGN KEY (\`newGroupId\`) REFERENCES \`groups\` (\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;`;
+    await Database.statement(waitingListsQuery);
+
+    console.log('finished create v1_waiting_list_migration_data table');
+});
+
+// CREATE TABLE `v1_groups_migration_data` (
+//     `newGroupId` varchar(36) NOT NULL,
+//     `oldGroupId` varchar(36) NOT NULL,
+//     `oldCycle` int NOT NULL DEFAULT '0',
+//   PRIMARY KEY (`newGroupId`),
+//   UNIQUE KEY `oldKey` (`oldGroupId`,`oldCycle`) USING BTREE,
+//   CONSTRAINT `groups_ibfk_1` FOREIGN KEY (`newGroupId`) REFERENCES `groups` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
+// ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

package/src/models/BalanceItem.ts

@@ -5,7 +5,8 @@ import { Formatter, STMath } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
 
 import { EnumDecoder, MapDecoder } from '@simonbackx/simple-encoding';
-import { QueryableModel } from '@stamhoofd/sql';
+import { SimpleError } from '@simonbackx/simple-errors';
+import { QueryableModel, SQL } from '@stamhoofd/sql';
 import { Payment } from './Payment.js';
 
 /**
@@ -186,6 +187,12 @@ export class BalanceItem extends QueryableModel {
     })
     priceOpen = 0;
 
+    /**
+     * Cached value, for optimizations
+     */
+    @column({ type: 'integer' })
+    priceInvoiced = 0;
+
     /**
      * todo: deprecate ('pending' and 'paid') + 'hidden' status and replace with 'due' + 'hidden'
      * -> maybe add 'due' (due if dueAt is null or <= now), 'hidden' (never due), 'future' (= not due until dueAt - but not possible to pay earlier)
@@ -206,6 +213,12 @@ export class BalanceItem extends QueryableModel {
     @column({ type: 'datetime', nullable: true })
     paidAt: Date | null = null;
 
+    /**
+     * Marking a balance item as 'failed' can have side effects. To prevent executing these side effects multiple times, we store it in here.
+     */
+    @column({ type: 'datetime', nullable: true })
+    failedAt: Date | null = null;
+
     @column({
         type: 'datetime', beforeSave(old?: any) {
             if (old !== undefined) {
@@ -544,6 +557,49 @@ export class BalanceItem extends QueryableModel {
         await Database.update(query, params);
     }
 
+    /**
+     * Update the outstanding balance of multiple members in one go (or all members)
+     */
+    static async updateInvoiced(balanceItemIds: string[] | 'all') {
+        if (balanceItemIds !== 'all' && balanceItemIds.length === 0) {
+            return 0;
+        }
+
+        const params: any[] = [];
+        let firstWhere = '';
+        let secondWhere = '';
+
+        if (balanceItemIds !== 'all') {
+            firstWhere = ` AND balanceItemId IN (?)`;
+            params.push(balanceItemIds);
+            params.push(balanceItemIds);
+
+            secondWhere = `WHERE balance_items.id IN (?)`;
+            params.push(balanceItemIds);
+        }
+
+        // Note: this query only works in MySQL because of the SET assignment behaviour allowing to reference newly set values
+        const query = `
+        UPDATE
+            balance_items
+        LEFT JOIN (
+            SELECT
+                balanceItemId,
+                sum(invoiced_balance_items.balanceInvoicedAmount) AS invoiced
+            FROM
+                invoiced_balance_items
+                LEFT JOIN invoices ON invoices.id = invoiced_balance_items.invoiceId
+            WHERE
+                invoices.number is not null${firstWhere}
+            GROUP BY
+                balanceItemId
+            ) invoiced ON invoiced.balanceItemId = balance_items.id
+        SET balance_items.priceInvoiced = coalesce(invoiced.invoiced, 0)
+        ${secondWhere}`;
+
+        return (await Database.update(query, params))[0].affectedRows;
+    }
+
     static async loadPayments(items: (BalanceItem | { id: string })[]) {
         if (items.length == 0) {
             return { balanceItemPayments: [], payments: [] };
@@ -613,61 +669,60 @@ export class BalanceItem extends QueryableModel {
     }
 
     static async balanceItemsForUsersAndMembers(organizationId: string | null, userIds: string[], memberIds: string[]): Promise<BalanceItem[]> {
-        if (memberIds.length == 0 && userIds.length == 0) {
+        if (memberIds.length === 0 && userIds.length === 0) {
             return [];
         }
 
-        const params: any[] = [];
-        const where: string[] = [];
+        const base = BalanceItem.select()
+            .whereNot('status', BalanceItemStatus.Hidden);
 
-        if (memberIds.length) {
-            if (memberIds.length == 1) {
-                where.push(`memberId = ?`);
-                params.push(memberIds[0]);
-            }
-            else {
-                where.push(`memberId IN (?)`);
-                params.push(memberIds);
-            }
+        if (organizationId) {
+            base.andWhere('organizationId', organizationId);
         }
 
-        // Note here, we don't search for memberId IS NULL restriction in MySQL because it slows down the query too much (500ms)
-        // Better if we do it in code here
-        if (userIds.length) {
-            if (userIds.length == 1) {
-                where.push('userId = ?');
-                params.push(userIds[0]);
-            }
-            else {
-                where.push('userId IN (?)');
-                params.push(userIds);
-            }
+        if (memberIds.length && userIds.length) {
+            // Don't include other members than the provided members
+            base.andWhere(
+                SQL.where('memberId', memberIds)
+                // Include null member
+                    .or(
+                    // Don't include balances of other members, even when userId matches
+                    // this allows removing access for a member
+                        SQL.where('userId', userIds)
+                            .and('memberId', null),
+                    ),
+            );
+        } else if (memberIds.length) {
+            base.andWhere('memberId', memberIds);
+        } else if (userIds.length) {
+            base.andWhere('userId', userIds);
         }
 
-        const requiredWhere: string[] = [];
-
-        if (organizationId) {
-            requiredWhere.push('organizationId = ?');
-            params.push(organizationId);
-        }
+        base.andWhere('priceOpen', '!=', 0);
 
-        const query = `SELECT ${BalanceItem.getDefaultSelect()} FROM ${BalanceItem.table} WHERE (${where.join(' OR ')}) ${requiredWhere.length ? (' AND ' + requiredWhere.join(' AND ')) : ''} AND ${BalanceItem.table}.status != ?`;
-        params.push(BalanceItemStatus.Hidden);
+        return await base.fetch();
+    }
 
-        const [rows] = await Database.select(query, params);
-        const balanceItems = BalanceItem.fromRows(rows, BalanceItem.table);
+    static async balanceItemsForOrganization(payingOrganizationId: string, organizationId?: string): Promise<BalanceItem[]> {
+        const base = BalanceItem.select()
+            .where('payingOrganizationId', payingOrganizationId)
+            .whereNot('status', BalanceItemStatus.Hidden);
 
-        // Filter out items of other members
-        if (memberIds.length) {
-            return balanceItems.filter(b => !b.memberId || memberIds.includes(b.memberId));
+        if (organizationId) {
+            base.where('organizationId', organizationId);
         }
-        return balanceItems;
+
+        return await base.fetch();
     }
 
-    static async balanceItemsForOrganization(organizationId: string): Promise<BalanceItem[]> {
-        return await BalanceItem.select()
-            .where('payingOrganizationId', organizationId)
-            .whereNot('status', BalanceItemStatus.Hidden)
-            .fetch();
+    override save(...args: Parameters<QueryableModel['save']>): Promise<boolean> {
+        if (this.unitPrice % 100 !== 0) {
+            throw new SimpleError({
+                statusCode: 500,
+                code: 'unrounded_balance_item',
+                message: 'Balance item unitPrices should be rounded up to 1 cent',
+            });
+        }
+        return super.save(...args);
     }
 }