@stamhoofd/models 2.64.0 → 2.65.1

package/src/models/OrganizationRegistrationPeriod.ts

@@ -1,10 +1,11 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { Group as GroupStruct, OrganizationRegistrationPeriodSettings, OrganizationRegistrationPeriod as OrganizationRegistrationPeriodStruct, SetupSteps } from '@stamhoofd/structures';
 import { Formatter } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
 import { Group, RegistrationPeriod } from '.';
 
-export class OrganizationRegistrationPeriod extends Model {
+export class OrganizationRegistrationPeriod extends QueryableModel {
     static table = 'organization_registration_periods';
 
     @column({

package/src/models/PasswordToken.ts

@@ -1,5 +1,6 @@
-import { column, Database, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, Database, ManyToOneRelation } from '@simonbackx/simple-database';
 import { I18n } from '@stamhoofd/backend-i18n';
+import { QueryableModel } from '@stamhoofd/sql';
 import basex from 'base-x';
 import crypto from 'crypto';
 
@@ -21,7 +22,7 @@ async function randomBytes(size: number): Promise<Buffer> {
     });
 }
 
-export class PasswordToken extends Model {
+export class PasswordToken extends QueryableModel {
     static table = 'password_tokens';
 
     // Columns

package/src/models/PayconiqPayment.ts

@@ -1,5 +1,6 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
 import { SimpleError } from '@simonbackx/simple-errors';
+import { QueryableModel } from '@stamhoofd/sql';
 import { PayconiqAccount, PaymentStatus, Version } from '@stamhoofd/structures';
 import { IncomingMessage } from 'http';
 import https from 'https';
@@ -7,7 +8,7 @@ import { v4 as uuidv4 } from 'uuid';
 
 import { Organization, Payment } from './';
 
-export class PayconiqPayment extends Model {
+export class PayconiqPayment extends QueryableModel {
     static table = 'payconiq_payments';
 
     @column({

package/src/models/Payment.ts

@@ -1,12 +1,12 @@
-import { column, Model, SQLResultNamespacedRow } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
 import { BalanceItemDetailed, BalanceItemPaymentDetailed, PaymentCustomer, PaymentGeneral, PaymentMethod, PaymentProvider, PaymentStatus, Settlement, TransferSettings, BaseOrganization, PaymentType } from '@stamhoofd/structures';
 import { Formatter } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
 
 import { Organization } from './';
-import { SQL, SQLSelect } from '@stamhoofd/sql';
+import { QueryableModel } from '@stamhoofd/sql';
 
-export class Payment extends Model {
+export class Payment extends QueryableModel {
     static table = 'payments';
 
     @column({
@@ -245,22 +245,4 @@ export class Payment extends Model {
 
         return { registrations, orders };
     }
-
-    /**
-     * Experimental: needs to move to library
-     */
-    static select() {
-        const transformer = (row: SQLResultNamespacedRow): Payment => {
-            const d = (this as typeof Payment & typeof Model).fromRow(row[this.table] as any) as Payment | undefined;
-
-            if (!d) {
-                throw new Error('EmailTemplate not found');
-            }
-
-            return d;
-        };
-
-        const select = new SQLSelect(transformer, SQL.wildcard(this.table));
-        return select.from(SQL.table(this.table));
-    }
 }

package/src/models/Platform.ts

@@ -1,10 +1,11 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
 import { QueueHandler } from '@stamhoofd/queues';
-import { Platform as PlatformStruct, PlatformConfig, PlatformPrivateConfig } from '@stamhoofd/structures';
+import { QueryableModel } from '@stamhoofd/sql';
+import { PlatformConfig, PlatformPrivateConfig, Platform as PlatformStruct } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 import { RegistrationPeriod } from './RegistrationPeriod';
 
-export class Platform extends Model {
+export class Platform extends QueryableModel {
     static table = 'platform';
 
     @column({

package/src/models/RegisterCode.ts

@@ -1,4 +1,5 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import basex from 'base-x';
 import crypto from 'crypto';
 
@@ -17,7 +18,7 @@ async function randomBytes(size: number): Promise<Buffer> {
     });
 }
 
-export class RegisterCode extends Model {
+export class RegisterCode extends QueryableModel {
     static table = 'register_codes';
 
     @column({ type: 'string', primary: true })

package/src/models/Registration.ts

@@ -1,13 +1,14 @@
-import { column, Database, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, Database, ManyToOneRelation } from '@simonbackx/simple-database';
 import { EmailTemplateType, GroupPrice, PaymentMethod, PaymentMethodHelper, Recipient, RecordAnswer, RecordAnswerDecoder, RegisterItemOption, Registration as RegistrationStructure, Replacement, StockReservation } from '@stamhoofd/structures';
 import { Formatter } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
 
 import { ArrayDecoder, MapDecoder, StringDecoder } from '@simonbackx/simple-encoding';
+import { QueryableModel } from '@stamhoofd/sql';
 import { sendEmailTemplate } from '../helpers/EmailBuilder';
 import { Group, Organization, User } from './';
 
-export class Registration extends Model {
+export class Registration extends QueryableModel {
     static table = 'registrations';
 
     @column({
@@ -179,14 +180,6 @@ export class Registration extends Model {
             email: user.email,
             userId: user.id,
             replacements: [
-                Replacement.create({
-                    token: 'firstName',
-                    value: member.details.firstName,
-                }),
-                Replacement.create({
-                    token: 'lastName',
-                    value: member.details.lastName,
-                }),
                 Replacement.create({
                     token: 'firstNameMember',
                     value: member.details.firstName,
@@ -195,27 +188,14 @@ export class Registration extends Model {
                     token: 'lastNameMember',
                     value: member.details.lastName,
                 }),
-                Replacement.create({
-                    token: 'email',
-                    value: user.email,
-                }),
                 Replacement.create({
                     token: 'registerUrl',
                     value: 'https://' + organization.getHost(),
                 }),
-                Replacement.create({
-                    token: 'organizationName',
-                    value: organization.name,
-                }),
                 Replacement.create({
                     token: 'groupName',
                     value: group.settings.name,
                 }),
-                Replacement.create({
-                    token: 'loginDetails',
-                    value: '',
-                    html: user.hasAccount() ? `<p class="description"><em>Je kan op het ledenportaal inloggen met <strong>${Formatter.escapeHtml(user.email)}</strong></em></p>` : `<p class="description"><em>Je kan op het ledenportaal een nieuw account aanmaken met het e-mailadres <strong>${Formatter.escapeHtml(user.email)}</strong>, dan krijg je automatisch toegang tot alle bestaande gegevens.</em></p>`,
-                }),
             ],
         }));
     }
@@ -310,11 +290,6 @@ export class Registration extends Model {
                         token: 'organizationName',
                         value: organization.name,
                     }),
-                    Replacement.create({
-                        token: 'loginDetails',
-                        value: '',
-                        html: user.hasAccount() ? `<p class="description"><em>Je kan op het ledenportaal inloggen met <strong>${Formatter.escapeHtml(user.email)}</strong></em></p>` : `<p class="description"><em>Je kan op het ledenportaal een nieuw account aanmaken met het e-mailadres <strong>${Formatter.escapeHtml(user.email)}</strong>, dan krijg je automatisch toegang tot alle bestaande gegevens.</em></p>`,
-                    }),
                 ],
             }),
         ];

package/src/models/RegistrationPeriod.ts

@@ -1,9 +1,9 @@
-import { column, Model, SQLResultNamespacedRow } from '@simonbackx/simple-database';
-import { SQL, SQLSelect, SQLWhereSign } from '@stamhoofd/sql';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel, SQL, SQLWhereSign } from '@stamhoofd/sql';
 import { RegistrationPeriodBase, RegistrationPeriodSettings, RegistrationPeriod as RegistrationPeriodStruct } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
-export class RegistrationPeriod extends Model {
+export class RegistrationPeriod extends QueryableModel {
     static table = 'registration_periods';
 
     @column({
@@ -97,22 +97,4 @@ export class RegistrationPeriod extends Model {
 
         this.previousPeriodId = previousPeriod?.id ?? null;
     }
-
-    /**
-     * Experimental: needs to move to library
-     */
-    static select() {
-        const transformer = (row: SQLResultNamespacedRow): RegistrationPeriod => {
-            const d = (this as typeof RegistrationPeriod & typeof Model).fromRow(row[this.table] as any) as RegistrationPeriod | undefined;
-
-            if (!d) {
-                throw new Error('MemberPlatformMembership not found');
-            }
-
-            return d;
-        };
-
-        const select = new SQLSelect(transformer, SQL.wildcard());
-        return select.from(SQL.table(this.table));
-    }
 }

package/src/models/STCredit.ts

@@ -1,7 +1,8 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { v4 as uuidv4 } from 'uuid';
 
-export class STCredit extends Model {
+export class STCredit extends QueryableModel {
     static table = 'stamhoofd_credits';
 
     // Columns

package/src/models/STInvoice.ts

@@ -1,10 +1,11 @@
-import { column, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, ManyToOneRelation } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { STInvoiceMeta } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
 import { Organization, Payment } from './';
 
-export class STInvoice extends Model {
+export class STInvoice extends QueryableModel {
     static table = 'stamhoofd_invoices';
 
     private static numberCache: number | null = null;

package/src/models/STPackage.ts

@@ -1,5 +1,6 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
 import { SimpleError } from '@simonbackx/simple-errors';
+import { QueryableModel } from '@stamhoofd/sql';
 import { EmailTemplateType, Recipient, Replacement, STPackageMeta, STPackageStatus, STPackageType } from '@stamhoofd/structures';
 import { Formatter } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
@@ -8,7 +9,7 @@ import { sendEmailTemplate } from '../helpers/EmailBuilder';
 import { GroupBuilder } from '../helpers/GroupBuilder';
 import { Organization } from './';
 
-export class STPackage extends Model {
+export class STPackage extends QueryableModel {
     static table = 'stamhoofd_packages';
 
     // Columns

package/src/models/STPendingInvoice.ts

@@ -1,4 +1,5 @@
-import { column, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, ManyToOneRelation } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { STInvoiceMeta } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
@@ -15,7 +16,7 @@ import { Organization } from './';
  *
  * So please make sure you don't edit existing items, unless you change the id
  */
-export class STPendingInvoice extends Model {
+export class STPendingInvoice extends QueryableModel {
     static table = 'stamhoofd_pending_invoices';
 
     // Columns

package/src/models/StripeAccount.ts

@@ -1,12 +1,13 @@
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { Requirements, StripeBusinessProfile, StripeCompany, StripeMetaAccountDashboardSettings, StripeMetaAccountSettings, StripeMetaData } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
 /**
  * Keeps track of how much a member/user owes or needs to be reimbursed.
  */
-export class StripeAccount extends Model {
+export class StripeAccount extends QueryableModel {
     static table = 'stripe_accounts';
 
     @column({

package/src/models/StripeCheckoutSession.ts

@@ -1,7 +1,8 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { v4 as uuidv4 } from 'uuid';
 
-export class StripeCheckoutSession extends Model {
+export class StripeCheckoutSession extends QueryableModel {
     static table = 'stripe_checkout_sessions';
 
     @column({

package/src/models/StripePaymentIntent.ts

@@ -1,7 +1,8 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { v4 as uuidv4 } from 'uuid';
 
-export class StripePaymentIntent extends Model {
+export class StripePaymentIntent extends QueryableModel {
     static table = 'stripe_payment_intents';
 
     @column({

package/src/models/Ticket.ts

@@ -1,4 +1,5 @@
-import { column, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, ManyToOneRelation } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { CartReservedSeat } from '@stamhoofd/structures';
 import basex from 'base-x';
 import crypto from 'crypto';
@@ -27,7 +28,7 @@ async function randomBytes(size: number): Promise<Buffer> {
  * This avoids the select in the database, saving some bytes in network communication
  * (especially needed when clients requests all the changed tickets)
  */
-export class Ticket extends Model {
+export class Ticket extends QueryableModel {
     static table = 'webshop_tickets';
 
     // Columns

package/src/models/Token.ts

@@ -1,4 +1,5 @@
-import { column, Database, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, Database, ManyToOneRelation } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { ApiUser } from '@stamhoofd/structures';
 import crypto from 'crypto';
 
@@ -44,7 +45,7 @@ export const apiUserRateLimiter = new RateLimiter({
     ],
 });
 
-export class Token extends Model {
+export class Token extends QueryableModel {
     static table = 'tokens';
     static MAX_DEVICES = 15;
 

package/src/models/UsedRegisterCode.ts

@@ -1,7 +1,8 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { v4 as uuidv4 } from 'uuid';
 
-export class UsedRegisterCode extends Model {
+export class UsedRegisterCode extends QueryableModel {
     static table = 'used_register_codes';
 
     @column({

package/src/models/User.ts

@@ -1,12 +1,14 @@
-import { column, Database, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, Database, ManyToOneRelation } from '@simonbackx/simple-database';
 import { EmailInterfaceRecipient } from '@stamhoofd/email';
+import { QueryableModel } from '@stamhoofd/sql';
 import { LoginProviderType, NewUser, Permissions, Recipient, Replacement, UserMeta, UserPermissions, User as UserStruct } from '@stamhoofd/structures';
 import argon2 from 'argon2';
 import { v4 as uuidv4 } from 'uuid';
 
 import { Organization } from './';
+import { QueueHandler } from '@stamhoofd/queues';
 
-export class User extends Model {
+export class User extends QueryableModel {
     static table = 'users';
 
     // Columns
@@ -140,7 +142,7 @@ export class User extends Model {
         }
 
         return (
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+
             await User.where(query)
         ).filter(a => !a.isApiUser);
     }
@@ -479,4 +481,30 @@ export class User extends Model {
             },
         ];
     }
+
+    /**
+     * Get internal system user that can be used on places that require a user object but the system is the actor
+     */
+    static async getSystem(): Promise<User> {
+        return QueueHandler.schedule('User.getSystem', async () => {
+            // Build a new one
+            let model = await this.getByID('1');
+            if (!model) {
+                // Create a new platform
+                model = new User();
+                model.id = '1';
+                model.firstName = 'System';
+                model.email = 'webmaster@stamhoofd.be';
+                model.verified = true;
+                model.permissions = UserPermissions.create({
+                    globalPermissions: Permissions.full,
+                });
+                model.organizationId = null;
+
+                await model.save();
+            }
+
+            return model;
+        });
+    }
 }

package/src/models/UserPermissions.ts

@@ -1,10 +1,11 @@
-import { column, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, ManyToOneRelation } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { Permissions } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
 import { Organization, User } from './';
 
-export class UserPermissions extends Model {
+export class UserPermissions extends QueryableModel {
     static table = 'user_permissions';
 
     // Columns

package/src/models/Webshop.ts

@@ -1,12 +1,13 @@
-import { column, Database, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, Database, ManyToOneRelation } from '@simonbackx/simple-database';
 import { ArrayDecoder } from '@simonbackx/simple-encoding';
+import { QueryableModel } from '@stamhoofd/sql';
 import { Category, DNSRecordStatus, Product, WebshopMetaData, WebshopPrivateMetaData, WebshopServerMetaData } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 import { validateDNSRecords } from '../helpers/DNSValidator';
 
 import { Organization } from './';
 
-export class Webshop extends Model {
+export class Webshop extends QueryableModel {
     static table = 'webshops';
 
     // Columns

package/src/models/WebshopDiscountCode.ts

@@ -1,9 +1,10 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
 import { ArrayDecoder } from '@simonbackx/simple-encoding';
+import { QueryableModel } from '@stamhoofd/sql';
 import { Discount, DiscountCode } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
-export class WebshopDiscountCode extends Model {
+export class WebshopDiscountCode extends QueryableModel {
     static table = 'webshop_discount_codes';
 
     // Columns

package/src/models/addresses/City.ts

@@ -1,10 +1,11 @@
-import { column, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, ManyToOneRelation } from '@simonbackx/simple-database';
 import { Country } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
+import { QueryableModel } from '@stamhoofd/sql';
 import { Province } from './Province';
 
-export class City extends Model {
+export class City extends QueryableModel {
     static table = 'cities';
 
     @column({

package/src/models/addresses/PostalCode.ts

@@ -1,12 +1,13 @@
-import { column, Database, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, Database, ManyToOneRelation } from '@simonbackx/simple-database';
 import { SimpleError } from '@simonbackx/simple-errors';
+import { QueryableModel } from '@stamhoofd/sql';
 import { Country } from '@stamhoofd/structures';
 import { Formatter, StringCompare } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
 
 import { City } from './City';
 
-export class PostalCode extends Model {
+export class PostalCode extends QueryableModel {
     static table = 'postal_codes';
 
     @column({

package/src/models/addresses/Province.ts

@@ -1,8 +1,9 @@
-import { column, Model } from '@simonbackx/simple-database';
+import { column } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { Country } from '@stamhoofd/structures';
 import { v4 as uuidv4 } from 'uuid';
 
-export class Province extends Model {
+export class Province extends QueryableModel {
     static table = 'provinces';
 
     @column({

package/src/models/addresses/Street.ts

@@ -1,9 +1,10 @@
-import { column, ManyToOneRelation, Model } from '@simonbackx/simple-database';
+import { column, ManyToOneRelation } from '@simonbackx/simple-database';
+import { QueryableModel } from '@stamhoofd/sql';
 import { v4 as uuidv4 } from 'uuid';
 
 import { City } from './City';
 
-export class Street extends Model {
+export class Street extends QueryableModel {
     static table = 'streets';
 
     @column({

package/src/models/index.ts

@@ -53,3 +53,4 @@ export * from './EmailRecipient';
 export * from './Event';
 export * from './CachedBalance';
 export * from './AuditLog';
+export * from './MemberUser';