@stamhoofd/models 2.19.0 → 2.21.0

package/src/helpers/EmailBuilder.ts

@@ -1,14 +1,14 @@
-import { EmailAddress, EmailBuilder } from "@stamhoofd/email";
-import { EmailTemplateType, Recipient, Replacement } from "@stamhoofd/structures";
+import { Email, EmailAddress, EmailBuilder } from "@stamhoofd/email";
+import { EmailTemplateType, OrganizationEmail, Recipient, Replacement } from "@stamhoofd/structures";
 import { Formatter } from "@stamhoofd/utility";
 
 import { SimpleError } from "@simonbackx/simple-errors";
-import { EmailTemplate, Organization, Platform, User } from "../models";
+import { EmailTemplate, Group, Organization, Platform, User, Webshop } from "../models";
 
 export type EmailTemplateOptions = {
     type: EmailTemplateType,
-    webshopId?: string | null,
-    groupId?: string | null,
+    webshop?: Webshop | null,
+    group?: Group | null,
     organizationId?: string | null
 }
 
@@ -17,22 +17,22 @@ export async function getEmailTemplate(data: EmailTemplateOptions) {
     const q = EmailTemplate.select()
         .where('type', data.type)
 
-    if (data.groupId) {
-        q.where('groupId', data.groupId)
+    if (data.group) {
+        q.where('groupId', data.group.id)
     }
 
     if (data.organizationId) {
         q.where('organizationId', data.organizationId)
     }
 
-    if (data.webshopId) {
-        q.where('webshopId', data.webshopId)
+    if (data.webshop) {
+        q.where('webshopId', data.webshop.id)
     }
 
     let templates = await q.limit(1).fetch()
     
     // Specific for organization
-    if (templates.length == 0 && (data.groupId || data.webshopId) && data.organizationId) {
+    if (templates.length == 0 && (data.group?.id || data.webshop?.id) && data.organizationId) {
         templates = await EmailTemplate.select()
             .where('type', data.type)
             .where('organizationId', data.organizationId)
@@ -43,7 +43,7 @@ export async function getEmailTemplate(data: EmailTemplateOptions) {
     }
 
     // Default for platform
-    if (templates.length == 0 && (data.groupId || data.webshopId || data.organizationId)) {
+    if (templates.length == 0 && (data.group?.id || data.webshop?.id || data.organizationId)) {
         templates = await EmailTemplate.select()
             .where('type', data.type)
             .where('organizationId', null)
@@ -61,6 +61,105 @@ export async function getEmailTemplate(data: EmailTemplateOptions) {
     return templates[0]
 }
 
+export async function getDefaultEmailFrom(organization: Organization|null, options: Pick<EmailBuilderOptions, "type"> & { template: Omit<EmailTemplateOptions, "organizationId"> }) {
+    // When choosing sending domain, prefer using the one with the highest reputation
+    const preferStrong = options.type === 'transactional'
+
+    let preferEmailId: string | null = null;
+
+    if (options.template.group) {
+        preferEmailId = options.template.group.privateSettings.defaultEmailId
+    }
+
+    if (options.template.webshop) {
+        preferEmailId = options.template.webshop.privateMeta.defaultEmailId
+    }
+    
+    if (organization) {
+        // Send confirmation e-mail
+        let from = preferStrong ? organization.getStrongEmail(organization.i18n, false) : organization.uri+"@stamhoofd.email";
+        const sender: OrganizationEmail | undefined = (preferEmailId ? organization.privateMeta.emails.find(e => e.id === preferEmailId) : null) ?? organization.privateMeta.emails.find(e => e.default) ?? organization.privateMeta.emails[0];
+        let replyTo: string | undefined = undefined
+
+        if (sender) {
+            replyTo = sender.email
+
+            // Can we send from this e-mail or reply-to?
+            if (replyTo && organization.privateMeta.mailDomain && organization.privateMeta.mailDomainActive && sender.email.endsWith("@"+organization.privateMeta.mailDomain)) {
+                from = sender.email
+                replyTo = undefined
+            }
+
+            // Include name in form field
+            if (sender.name) {
+                from = '"'+sender.name.replaceAll("\"", "\\\"")+"\" <"+from+">" 
+            }  else {
+                from = '"'+organization.name.replaceAll("\"", "\\\"")+"\" <"+from+">" 
+            }
+
+            if (replyTo) {
+                if (sender.name) {
+                    replyTo = '"'+sender.name.replaceAll("\"", "\\\"")+"\" <"+replyTo+">" 
+                }  else {
+                    replyTo = '"'+organization.name.replaceAll("\"", "\\\"")+"\" <"+replyTo+">" 
+                }
+            }
+        } else {
+            from = '"'+organization.name.replaceAll("\"", "\\\"")+"\" <"+from+">" 
+        }
+
+        return {
+            from, replyTo
+        }
+    }
+
+    const platform = await Platform.getSharedPrivateStruct()
+
+    // Platform
+    // TODO: read from config
+    let from = 'hallo@stamhoofd.be'
+    const sender: OrganizationEmail | undefined = (preferEmailId ? platform.privateConfig.emails.find(e => e.id === preferEmailId) : null) ?? platform.privateConfig.emails.find(e => e.default) ?? platform.privateConfig.emails[0];
+    let replyTo: string | undefined = undefined
+
+    if (sender) {
+        replyTo = sender.email
+
+        // Include name in form field
+        if (sender.name) {
+            from = '"'+sender.name.replaceAll("\"", "\\\"")+"\" <"+from+">" 
+        }  else {
+            from = '"'+platform.config.name.replaceAll("\"", "\\\"")+"\" <"+from+">" 
+        }
+
+        if (replyTo) {
+            if (sender.name) {
+                replyTo = '"'+sender.name.replaceAll("\"", "\\\"")+"\" <"+replyTo+">" 
+            }  else {
+                replyTo = '"'+platform.config.name.replaceAll("\"", "\\\"")+"\" <"+replyTo+">" 
+            }
+        }
+    } else {
+        from = '"'+platform.config.name.replaceAll("\"", "\\\"")+"\" <"+from+">" 
+    }
+
+    return {
+        from, replyTo
+    }
+}
+
+
+export async function sendEmailTemplate(organization: Organization|null, options: Omit<EmailBuilderOptions, "subject" | "html" | "from" | "replyTo"> & { template: Omit<EmailTemplateOptions, "organizationId"> }) {
+    if (options.template.webshop) {
+        options.defaultReplacements = [...(options.defaultReplacements ?? []), ...options.template.webshop.meta.getEmailReplacements()]
+    }
+    const builder = await getEmailBuilderForTemplate(organization, {
+        ...options,
+        ...(await getDefaultEmailFrom(organization, options))
+    });
+    if (builder) {
+        Email.schedule(builder)
+    }
+}
 
 export async function getEmailBuilderForTemplate(organization: Organization|null, options: Omit<EmailBuilderOptions, "subject" | "html"> & { template: Omit<EmailTemplateOptions, "organizationId"> }) {
     const template = await getEmailTemplate({
@@ -162,6 +261,8 @@ export async function getEmailBuilder(organization: Organization|null, email: Em
             recipient.replacements.push(...email.defaultReplacements)
         }
 
+        recipient.replacements.push(...recipient.getDefaultReplacements())
+
         if (organization) {
             const extra = organization.meta.getEmailReplacements()
             recipient.replacements.push(...extra)

package/src/models/Member.ts

@@ -359,11 +359,11 @@ export class Member extends Model {
             .from(Member.table)
             .join(
                 SQL
-                .leftJoin('_members_users')
-                .where(
-                    SQL.column('_members_users', 'membersId'),
-                    SQL.column(Member.table, 'id'),
-                )
+                    .leftJoin('_members_users')
+                    .where(
+                        SQL.column('_members_users', 'membersId'),
+                        SQL.column(Member.table, 'id'),
+                    )
             ).where(
                 SQL.column('_members_users', 'usersId'),
                 user.id,

package/src/models/MemberResponsibilityRecord.ts

@@ -1,6 +1,7 @@
-import { column, Model } from '@simonbackx/simple-database';
-import { v4 as uuidv4 } from "uuid";
+import { column, Model, SQLResultNamespacedRow } from '@simonbackx/simple-database';
+import { SQL, SQLSelect } from '@stamhoofd/sql';
 import { MemberResponsibilityRecord as MemberResponsibilityRecordStruct } from '@stamhoofd/structures';
+import { v4 as uuidv4 } from "uuid";
 
 export class MemberResponsibilityRecord extends Model {
     static table = "member_responsibility_records"
@@ -43,4 +44,22 @@ export class MemberResponsibilityRecord extends Model {
     getStructure() {
         return MemberResponsibilityRecordStruct.create(this)
     }
+
+    /**
+     * Experimental: needs to move to library
+     */
+    static select() {
+        const transformer = (row: SQLResultNamespacedRow): MemberResponsibilityRecord => {
+            const d = (this as typeof MemberResponsibilityRecord & typeof Model).fromRow(row[this.table] as any) as MemberResponsibilityRecord|undefined
+    
+            if (!d) {
+                throw new Error("MemberResponsibilityRecord not found")
+            }
+
+            return d;
+        }
+        
+        const select = new SQLSelect(transformer, SQL.wildcard())
+        return select.from(SQL.table(this.table))
+    }
 }

package/src/models/Order.ts

@@ -6,7 +6,7 @@ import { BalanceItemPaymentWithPayment, BalanceItemPaymentWithPrivatePayment, Ba
 import { Formatter } from "@stamhoofd/utility";
 import { v4 as uuidv4 } from "uuid";
 
-import { getEmailBuilderForTemplate } from "../helpers/EmailBuilder";
+import { getEmailBuilderForTemplate, sendEmailTemplate } from "../helpers/EmailBuilder";
 import { WebshopCounter } from '../helpers/WebshopCounter';
 import { BalanceItem, Organization, Payment, Ticket, Webshop, WebshopDiscountCode } from './';
 
@@ -875,22 +875,14 @@ export class Order extends Model {
         }
 
         // Create e-mail builder
-        const builder = await getEmailBuilderForTemplate(this.webshop.organization, {
+        await sendEmailTemplate(this.webshop.organization, {
             recipients: [recipient],
             template: {
                 type: data.type,
-                webshopId: this.id
+                webshop: this.webshop
             },
-            // text: template.text,
-            from: data.from,
-            replyTo: data.replyTo,
             type: 'transactional',
-            defaultReplacements: this.webshop.meta.getEmailReplacements()
         })
-
-        if (builder) {
-            Email.schedule(builder)
-        }
     }
 
     /**

package/src/models/Organization.ts

@@ -220,6 +220,14 @@ export class Organization extends Model {
                 message: "No organization known for host " + host,
             });
         }
+
+        if (!organization.active) {
+            throw new SimpleError({
+                code: "archived",
+                message: "This organization is archived",
+                human: 'Deze groep is gearchiveerd'
+            });
+        }
         return organization;
     }
 
@@ -264,7 +272,13 @@ export class Organization extends Model {
         return this.id+"." + defaultDomain;
     }
 
+    private _cachedPeriod?: OrganizationRegistrationPeriod
+
     async getPeriod() {
+        if (this._cachedPeriod) {
+            return this._cachedPeriod;
+        }
+
         const oPeriods = await OrganizationRegistrationPeriod.where({ periodId: this.periodId, organizationId: this.id }, {limit: 1})
         
         let oPeriod: OrganizationRegistrationPeriod;
@@ -289,12 +303,14 @@ export class Organization extends Model {
             oPeriod = oPeriods[0];
         }
 
+        this._cachedPeriod = oPeriod
         return oPeriod
     }
 
     getBaseStructure(): OrganizationStruct {
         return OrganizationStruct.create({
             id: this.id,
+            active: this.active,
             name: this.name,
             meta: this.meta,
             address: this.address,
@@ -792,13 +808,17 @@ export class Organization extends Model {
         return await this.getAdminToEmails()
     }
 
+    async getAdmins() {
+        // Circular reference fix
+        const User = (await import('./User')).User;
+        return await User.getAdmins([this.id], {verified: true});
+    }
+
     /**
      * These email addresess are private
      */
     async getFullAdmins() {
-        // Circular reference fix
-        const User = (await import('./User')).User;
-        const admins = await User.getAdmins([this.id], {verified: true})
+        const admins = await this.getAdmins();
 
         // Only full access
         return admins.filter(a => a.permissions && a.permissions.forOrganization(this)?.hasFullAccess())
@@ -842,18 +862,6 @@ export class Organization extends Model {
                 lastName: f.lastName,
                 email: f.email,
                 replacements: [
-                    Replacement.create({
-                        token: "firstName",
-                        value: f.firstName ?? ""
-                    }),
-                    Replacement.create({
-                        token: "lastName",
-                        value: f.lastName ?? ""
-                    }),
-                    Replacement.create({
-                        token: "email",
-                        value: f.email
-                    }),
                     Replacement.create({
                         token: "organizationName",
                         value: this.name

package/src/models/Platform.ts

@@ -30,7 +30,7 @@ export class Platform extends Model {
     static sharedStruct: PlatformStruct | null = null;
 
     static async getSharedStruct(): Promise<PlatformStruct> {
-        const struct = await this.getSharedPrivateStruct();
+        const struct: PlatformStruct = await this.getSharedPrivateStruct();
         const clone = struct.clone();
         clone.privateConfig = null;
         clone.setShared();
@@ -38,9 +38,9 @@ export class Platform extends Model {
         return clone;
     }
 
-    static async getSharedPrivateStruct(): Promise<PlatformStruct> {
+    static async getSharedPrivateStruct(): Promise<PlatformStruct & {privateConfig: PlatformPrivateConfig}> {
         if (this.sharedStruct && this.sharedStruct.privateConfig) {
-            return this.sharedStruct;
+            return this.sharedStruct as any;
         }
 
         return await QueueHandler.schedule('Platform.getSharedStruct', async () => {
@@ -52,7 +52,7 @@ export class Platform extends Model {
             });
             this.sharedStruct = struct;
 
-            return struct;
+            return struct as any;
         });
     }
 

package/src/models/RegisterCode.ts

@@ -1,12 +1,7 @@
 import { column, Model } from "@simonbackx/simple-database";
-import { SimpleError } from "@simonbackx/simple-errors";
-import { EmailInterfaceBase } from "@stamhoofd/email";
 import basex from "base-x";
 import crypto from "crypto";
 
-import { Organization } from "./Organization";
-import { STCredit } from "./STCredit";
-import { UsedRegisterCode } from "./UsedRegisterCode";
 const ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
 const bs58 = basex(ALPHABET)
 
@@ -71,94 +66,4 @@ export class RegisterCode extends Model {
     async generateCode() {
         this.code = bs58.encode(await randomBytes(8)).toUpperCase();
     }
-
-    /**
-     * Prepares a register code for usage.
-     * Returns the models to save and the emails to send when succesful
-     */
-    static async applyRegisterCode(organization: Organization, codeString: string): Promise<{models: Model[], emails: EmailInterfaceBase[]}> {
-        const alreadyUsed = await UsedRegisterCode.getFor(organization.id)
-        if (alreadyUsed) {
-            throw new SimpleError({
-                code: "invalid_field",
-                message: "Invalid register code",
-                human: "Je hebt al een doorverwijzingscode gebruikt",
-                field: "registerCode",
-            });
-        }
-
-        const code = await RegisterCode.getByID(codeString)
-        if (!code) {
-            throw new SimpleError({
-                code: "invalid_field",
-                message: "Invalid register code",
-                human: "De doorverwijzingscode die je hebt opgegeven is niet langer geldig",
-                field: "registerCode",
-            });
-        }
-
-        const otherOrganization = code.organizationId ? await Organization.getByID(code.organizationId) : undefined
-        
-        const delayEmails: EmailInterfaceBase[] = []
-        let credit: STCredit | undefined = undefined
-        let usedCode: UsedRegisterCode | undefined = undefined
-
-        if (code.value > 0) {
-            // Create initial credit
-            credit = new STCredit()
-            credit.organizationId = organization.id
-            credit.change = code.value
-            credit.description = otherOrganization ? ("Tegoed gekregen van "+otherOrganization.name) : code.description
-
-            // Expire in one year (will get extended for every purchase or activation)
-            credit.expireAt = new Date()
-            credit.expireAt.setFullYear(credit.expireAt.getFullYear() + 1)
-            credit.expireAt.setMilliseconds(0)
-
-            // Save later
-        }
-
-        if (otherOrganization) {
-            const admins = await otherOrganization.getAdminToEmails()
-            if (admins) {
-                if (code.invoiceValue) {
-                    // Delay email until everything is validated and saved
-                    delayEmails.push({
-                        to: admins,
-                        bcc: "simon@stamhoofd.be",
-                        subject: organization.name+" heeft jullie doorverwijzingslink gebruikt 🥳",
-                        type: "transactional",
-                        text: "Dag "+otherOrganization.name+",\n\nGoed nieuws! "+organization.name+" heeft jullie doorverwijzingslink gebruikt om zich op Stamhoofd te registreren.\n\n— Stamhoofd"
-                    })
-                } else {
-                    // Delay email until everything is validated and saved
-                    delayEmails.push({
-                        to: admins,
-                        bcc: "simon@stamhoofd.be",
-                        subject: organization.name+" heeft jullie doorverwijzingslink gebruikt 🥳",
-                        type: "transactional",
-                        text: "Dag "+otherOrganization.name+",\n\nGoed nieuws! "+organization.name+" heeft jullie doorverwijzingslink gebruikt om zich op Stamhoofd te registreren. Als zij minstens 1 euro op Stamhoofd uitgeven ontvangen jullie een tegoed dat kan oplopen tot 100 euro per vereniging (zie daarvoor Stamhoofd > Instellingen). Lees zeker onze tips na om nog een groter bedrag te verzamelen 😉\n\n— Stamhoofd"
-                    })
-                }
-            }
-        } else {
-            delayEmails.push({
-                to: 'hallo@stamhoofd.be',
-                subject: organization.name+" heeft jullie doorverwijzingslink gebruikt 🥳",
-                type: "transactional",
-                text: "Dag Stamhoofd,\n\nGoed nieuws! "+organization.name+" heeft jullie doorverwijzingslink "+code.code+" gebruikt om zich op Stamhoofd te registreren. \n\n— Stamhoofd"
-            })
-        }
-
-        // Save that we used this code (so we can reward the other organization)
-        usedCode = new UsedRegisterCode()
-        usedCode.organizationId = organization.id
-        usedCode.code = code.code
-        
-        // Save later
-        return {
-            models: credit ? [credit, usedCode] : [usedCode],
-            emails: delayEmails
-        }
-    }
 }

package/src/models/Registration.ts

@@ -6,7 +6,7 @@ import { v4 as uuidv4 } from "uuid";
 
 import { ArrayDecoder } from '@simonbackx/simple-encoding';
 import { QueueHandler } from '@stamhoofd/queues';
-import { getEmailBuilderForTemplate } from '../helpers/EmailBuilder';
+import { sendEmailTemplate } from '../helpers/EmailBuilder';
 import { Document, Group, Organization, User } from './';
 
 export class Registration extends Model {
@@ -251,6 +251,14 @@ export class Registration extends Model {
                     token: "lastName",
                     value: member.details.lastName,
                 }),
+                Replacement.create({
+                    token: "firstNameMember",
+                    value: member.details.firstName,
+                }),
+                Replacement.create({
+                    token: "lastNameMember",
+                    value: member.details.lastName,
+                }),
                 Replacement.create({
                     token: "email",
                     value: user.email
@@ -293,29 +301,18 @@ export class Registration extends Model {
 
         const recipients = await this.getRecipients(organization, group)
 
-        const {from, replyTo} = organization.getGroupEmail(group)
-
         // Create e-mail builder
-        const builder = await getEmailBuilderForTemplate(organization, {
+        await sendEmailTemplate(organization, {
             template: {
                 type: data.type, 
-                groupId: this.groupId
+                group
             },
             recipients,
-            from,
             type: "transactional",
-            replyTo
         })
-
-        if (builder) {
-            Email.schedule(builder)
-        }
     }
 
     static async sendTransferEmail(user: User, organization: Organization, payment: import('./').Payment) {
-        const data = {
-            type: EmailTemplateType.RegistrationTransferDetails
-        };
         const paymentGeneral = await payment.getGeneralStructure();
         const groupIds = paymentGeneral.groupIds;
 
@@ -386,31 +383,21 @@ export class Registration extends Model {
             })
         ];
 
-        let {from, replyTo} = organization.getDefaultEmail()
+        let group: Group|undefined|null = null;
 
         if (groupIds.length == 1) {
             const Group = (await import('./')).Group
-            const group = await Group.getByID(groupIds[0]);
-            if (group) {
-                const groupEmail = organization.getGroupEmail(group)
-                from = groupEmail.from
-                replyTo = groupEmail.replyTo
-            }
+            group = await Group.getByID(groupIds[0]);
         }
 
         // Create e-mail builder
-        const builder = await getEmailBuilderForTemplate(organization, {
+        await sendEmailTemplate(organization, {
             template: {
-                type: EmailTemplateType.RegistrationTransferDetails
+                type: EmailTemplateType.RegistrationTransferDetails,
+                group
             },
-            recipients,
-            from,
-            replyTo
+            recipients
         })
-
-        if (builder) {
-            Email.schedule(builder)
-        }
     }
 
     shouldIncludeStock() {

package/src/models/STCredit.ts

@@ -1,8 +1,6 @@
 import { column, Model } from "@simonbackx/simple-database";
-import { STInvoiceItem } from "@stamhoofd/structures";
 import { v4 as uuidv4 } from "uuid";
 
-import { STInvoice } from "./";
 
 export class STCredit extends Model {
     static table = "stamhoofd_credits";
@@ -51,84 +49,4 @@ export class STCredit extends Model {
         skipUpdate: true
     })
     updatedAt: Date
-
-    static async getForOrganization(organizationId: string) {
-        return await STCredit.where({ organizationId }, { 
-            sort: [{
-                column: "createdAt",
-                direction: "DESC"
-            }]
-        })
-    }
-
-    static async getBalance(organizationId: string) {
-        const now = new Date()
-        const credits = await this.getForOrganization(organizationId)
-        credits.reverse()
-        let balance = 0
-        let balanceTransactions = 0
-
-        for (const credit of credits) {
-            if (credit.expireAt !== null && credit.expireAt <= now) {
-                continue
-            }
-            // TODO: we can expire credits here
-            balance += credit.change
-            if (balance < 0) {
-                // This is needed to make deleting credit and expiring credit work.
-                // At no point in time, the credits can get negative.
-                // E.g. Getting credits, using them, and later expiring 'getting the credits' won't have impact on future credits
-                balance = 0
-            }
-
-            if (credit.allowTransactions || credit.change < 0) {
-                balanceTransactions += credit.change
-
-                // No point in time we can have more balance for transactions
-                balanceTransactions = Math.min(Math.max(balanceTransactions, 0), balance)
-            }
-        }
-
-        return {balance: balance - balanceTransactions, balanceTransactions}
-    }
-
-    static async applyCredits(organizationId: string, invoice: STInvoice, dryRun: boolean) {
-        // Apply credits
-        const {balance, balanceTransactions} = await STCredit.getBalance(organizationId)
-        if (balance > 0 || balanceTransactions > 0) {
-            // Loop all items where you can use credits for
-            const maxCredits = invoice.meta.items.filter(i => i.canUseCredits).reduce((price, item) => price + item.price, 0)
-            let applyValue = Math.min(maxCredits, balance)
-
-            if (balanceTransactions > 0) {
-                // Can apply to all items
-                const maxTransactionsCredits = invoice.meta.items.reduce((price, item) => price + item.price, 0) - applyValue
-                applyValue += Math.min(maxTransactionsCredits, balanceTransactions)
-            }
-
-            if (applyValue > 0) {
-                invoice.meta.items.push(STInvoiceItem.create({
-                    name: "Gebruikt tegoed",
-                    unitPrice: -applyValue,
-                    amount: 1,
-                    date: new Date()
-                }))
-
-                if (!dryRun) {
-                    const credit = new STCredit()
-                    credit.organizationId = organizationId
-                    credit.change = -applyValue
-                    credit.description = "Tijdelijk vrijgehouden voor lopende betaling"
-
-                    // Reserve for one week (direct debit can take a while)
-                    credit.expireAt = new Date()
-                    credit.expireAt.setDate(credit.expireAt.getDate() + 7)
-                    credit.expireAt.setMilliseconds(0)
-
-                    await credit.save()
-                    invoice.creditId = credit.id
-                }
-            }
-        }
-    }
 }