@stamhoofd/models 2.39.0 → 2.40.0

package/src/models/Webshop.ts

@@ -1,105 +1,104 @@
-import { column, Database, ManyToOneRelation, Model } from "@simonbackx/simple-database";
+import { column, Database, ManyToOneRelation, Model } from '@simonbackx/simple-database';
 import { ArrayDecoder } from '@simonbackx/simple-encoding';
 import { Category, DNSRecordStatus, Product, WebshopMetaData, WebshopPrivateMetaData, WebshopServerMetaData } from '@stamhoofd/structures';
-import { v4 as uuidv4 } from "uuid";
-import { validateDNSRecords } from "../helpers/DNSValidator";
+import { v4 as uuidv4 } from 'uuid';
+import { validateDNSRecords } from '../helpers/DNSValidator';
 
 import { Organization } from './';
 
 export class Webshop extends Model {
-    static table = "webshops";
+    static table = 'webshops';
 
     // Columns
     @column({
-        primary: true, type: "string", beforeSave(value) {
+        primary: true, type: 'string', beforeSave(value) {
             return value ?? uuidv4();
-        }
+        },
     })
     id!: string;
 
-    @column({ foreignKey: Webshop.organization, type: "string" })
+    @column({ foreignKey: Webshop.organization, type: 'string' })
     organizationId: string;
-    
+
     // A custom domain name that is used to host the webshop application (should be unique)
     // E.g. webshop.scoutswetteren.be
-    @column({ type: "string", nullable: true })
+    @column({ type: 'string', nullable: true })
     domain: string | null = null;
 
     // If a domain is used, the optional suffix on that domain
     // E.g. webshop.scoutswetteren.be/wafelbak
-    @column({ type: "string", nullable: true })
+    @column({ type: 'string', nullable: true })
     domainUri: string | null = null;
 
     // Unique representation of this webshop from a string, that is used to provide the default domains
     // in shop.stamhoofd.be/uri, and stamhoofd.be/shop/uri
-    @column({ type: "string" })
+    @column({ type: 'string' })
     uri: string;
 
     // Old uri format, which was only unique on a per-organization basis
     // in org.stamhoofd.shop/legacyUri
-    @column({ type: "string", nullable: true })
+    @column({ type: 'string', nullable: true })
     legacyUri: string | null = null;
 
     /**
      * Public meta data
      */
-    @column({ type: "json", decoder: WebshopMetaData })
-    meta: WebshopMetaData = WebshopMetaData.create({})
+    @column({ type: 'json', decoder: WebshopMetaData })
+    meta: WebshopMetaData = WebshopMetaData.create({});
 
     /**
      * Data only accessible by the owners / users with special permissions
      */
-    @column({ type: "json", decoder: WebshopPrivateMetaData })
-    privateMeta: WebshopPrivateMetaData = WebshopPrivateMetaData.create({})
+    @column({ type: 'json', decoder: WebshopPrivateMetaData })
+    privateMeta: WebshopPrivateMetaData = WebshopPrivateMetaData.create({});
 
     /**
      * Data only accessible by the server
      */
-    @column({ type: "json", decoder: WebshopServerMetaData })
-    serverMeta: WebshopServerMetaData = WebshopServerMetaData.create({})
-
+    @column({ type: 'json', decoder: WebshopServerMetaData })
+    serverMeta: WebshopServerMetaData = WebshopServerMetaData.create({});
 
     /**
      * Contains all the products
      */
-    @column({ type: "json", decoder: new ArrayDecoder(Product) })
+    @column({ type: 'json', decoder: new ArrayDecoder(Product) })
     products: Product[] = [];
 
     /**
      * Contains all the categories in the right order
      */
-    @column({ type: "json", decoder: new ArrayDecoder(Category) })
+    @column({ type: 'json', decoder: new ArrayDecoder(Category) })
     categories: Category[] = [];
 
     @column({
-        type: "datetime", beforeSave(old?: any) {
+        type: 'datetime', beforeSave(old?: any) {
             if (old !== undefined) {
                 return old;
             }
-            const date = new Date()
-            date.setMilliseconds(0)
-            return date
-        }
+            const date = new Date();
+            date.setMilliseconds(0);
+            return date;
+        },
     })
-    createdAt: Date
+    createdAt: Date;
 
     @column({
-        type: "datetime", beforeSave() {
-            const date = new Date()
-            date.setMilliseconds(0)
-            return date
+        type: 'datetime', beforeSave() {
+            const date = new Date();
+            date.setMilliseconds(0);
+            return date;
         },
-        skipUpdate: true
+        skipUpdate: true,
     })
-    updatedAt: Date
+    updatedAt: Date;
 
-    static organization = new ManyToOneRelation(Organization, "organization");
+    static organization = new ManyToOneRelation(Organization, 'organization');
 
     // Methods
     static async getByLegacyURI(organizationId: string, uri: string): Promise<Webshop | undefined> {
         const [rows] = await Database.select(
             `SELECT ${this.getDefaultSelect()} FROM ${this.table} WHERE \`organizationId\` = ? AND \`legacyUri\` = ? LIMIT 1`,
-            [organizationId, uri]
+            [organizationId, uri],
         );
 
         if (rows.length == 0) {
@@ -114,7 +113,7 @@ export class Webshop extends Model {
     static async getByURI(uri: string): Promise<Webshop | undefined> {
         const [rows] = await Database.select(
             `SELECT ${this.getDefaultSelect()} FROM ${this.table} WHERE \`uri\` = ? LIMIT 1`,
-            [uri]
+            [uri],
         );
 
         if (rows.length == 0) {
@@ -129,7 +128,7 @@ export class Webshop extends Model {
     static async getByDomainOnly(host: string): Promise<Webshop[]> {
         const [rows] = await Database.select(
             `SELECT ${this.getDefaultSelect()} FROM ${this.table} WHERE \`domain\` = ? LIMIT 200`,
-            [host]
+            [host],
         );
 
         // Read member + address from first row
@@ -141,7 +140,7 @@ export class Webshop extends Model {
         if (uri === null || uri.length == 0) {
             const [rows] = await Database.select(
                 `SELECT ${this.getDefaultSelect()} FROM ${this.table} WHERE \`domain\` = ? AND (\`domainUri\` is null OR \`domainUri\` = "") LIMIT 1`,
-                [host]
+                [host],
             );
 
             if (rows.length == 0) {
@@ -153,7 +152,7 @@ export class Webshop extends Model {
         }
         const [rows] = await Database.select(
             `SELECT ${this.getDefaultSelect()} FROM ${this.table} WHERE \`domain\` = ? AND \`domainUri\` = ? LIMIT 1`,
-            [host, uri]
+            [host, uri],
         );
 
         if (rows.length == 0) {
@@ -168,28 +167,28 @@ export class Webshop extends Model {
     getHost(this: Webshop & { organization: Organization }) {
         if (this.domain && this.meta.domainActive) {
             if (this.domainUri) {
-                return this.domain+"/"+this.domainUri
+                return this.domain + '/' + this.domainUri;
             }
-            return this.domain
+            return this.domain;
         }
 
-        const domain = STAMHOOFD.domains.webshop[this.organization.address.country] ?? STAMHOOFD.domains.webshop[""];
-        return domain+"/"+this.uri
+        const domain = STAMHOOFD.domains.webshop[this.organization.address.country] ?? STAMHOOFD.domains.webshop[''];
+        return domain + '/' + this.uri;
     }
 
     async updateDNSRecords(background = false) {
         // Check initial status
-        let isValidRecords = true
+        let isValidRecords = true;
         for (const record of this.privateMeta.dnsRecords) {
-            if (record.status != DNSRecordStatus.Valid) {
-                isValidRecords = false
+            if (record.status !== DNSRecordStatus.Valid) {
+                isValidRecords = false;
             }
         }
 
-        let { allValid } = await validateDNSRecords(this.privateMeta.dnsRecords)
+        let { allValid } = await validateDNSRecords(this.privateMeta.dnsRecords);
 
-        if (STAMHOOFD.environment === "development" || STAMHOOFD.environment === "staging") {
-            allValid = true
+        if (STAMHOOFD.environment === 'development' || STAMHOOFD.environment === 'staging') {
+            allValid = true;
         }
 
         if (allValid) {
@@ -197,10 +196,11 @@ export class Webshop extends Model {
                 // TODO: send an email
                 // + prevent ping pong emails when the dns is not workign properly
             }
-            this.meta.domainActive = true
-        } else {
-            this.meta.domainActive = false
+            this.meta.domainActive = true;
+        }
+        else {
+            this.meta.domainActive = false;
         }
-        await this.save()
+        await this.save();
     }
 }

package/src/models/WebshopDiscountCode.ts

@@ -1,64 +1,64 @@
-import { column, Model } from "@simonbackx/simple-database";
+import { column, Model } from '@simonbackx/simple-database';
 import { ArrayDecoder } from '@simonbackx/simple-encoding';
 import { Discount, DiscountCode } from '@stamhoofd/structures';
-import { v4 as uuidv4 } from "uuid";
+import { v4 as uuidv4 } from 'uuid';
 
 export class WebshopDiscountCode extends Model {
-    static table = "webshop_discount_codes";
+    static table = 'webshop_discount_codes';
 
     // Columns
     @column({
-        primary: true, type: "string", beforeSave(value) {
+        primary: true, type: 'string', beforeSave(value) {
             return value ?? uuidv4();
-        }
+        },
     })
     id!: string;
 
-    @column({ type: "string" })
+    @column({ type: 'string' })
     organizationId: string;
 
-    @column({ type: "string" })
+    @column({ type: 'string' })
     webshopId: string;
 
-    @column({ type: "string" })
+    @column({ type: 'string' })
     code: string;
 
-    @column({ type: "string" })
-    description = ''
-    
-    @column({ type: "json", decoder: new ArrayDecoder(Discount) })
-    discounts: Discount[] = []
+    @column({ type: 'string' })
+    description = '';
+
+    @column({ type: 'json', decoder: new ArrayDecoder(Discount) })
+    discounts: Discount[] = [];
 
-    @column({ type: "integer" })
-    usageCount = 0
+    @column({ type: 'integer' })
+    usageCount = 0;
 
-    @column({ type: "integer", nullable: true })
-    maximumUsage: number|null = null
+    @column({ type: 'integer', nullable: true })
+    maximumUsage: number | null = null;
 
     @column({
-        type: "datetime", beforeSave(old?: any) {
+        type: 'datetime', beforeSave(old?: any) {
             if (old !== undefined) {
                 return old;
             }
-            const date = new Date()
-            date.setMilliseconds(0)
-            return date
-        }
+            const date = new Date();
+            date.setMilliseconds(0);
+            return date;
+        },
     })
-    createdAt: Date
+    createdAt: Date;
 
     @column({
-        type: "datetime", beforeSave() {
-            const date = new Date()
-            date.setMilliseconds(0)
-            return date
+        type: 'datetime', beforeSave() {
+            const date = new Date();
+            date.setMilliseconds(0);
+            return date;
         },
-        skipUpdate: true
+        skipUpdate: true,
     })
-    updatedAt: Date
+    updatedAt: Date;
 
     getStructure(): DiscountCode {
-        return DiscountCode.create(this)
+        return DiscountCode.create(this);
     }
 
     static async getActiveCodes(webshopId: string, codes: string[]) {
@@ -70,12 +70,12 @@ export class WebshopDiscountCode extends Model {
             webshopId,
             code: {
                 sign: 'IN',
-                value: codes
-            }
+                value: codes,
+            },
         });
 
         // Remove used discount codes
-        models = models.filter(c => c.maximumUsage === null || c.maximumUsage > c.usageCount)
+        models = models.filter(c => c.maximumUsage === null || c.maximumUsage > c.usageCount);
         return models;
     }
 }

package/src/models/addresses/City.ts

@@ -1,31 +1,31 @@
-import { column,ManyToOneRelation,Model } from '@simonbackx/simple-database';
+import { column, ManyToOneRelation, Model } from '@simonbackx/simple-database';
 import { Country } from '@stamhoofd/structures';
-import { v4 as uuidv4 } from "uuid";
+import { v4 as uuidv4 } from 'uuid';
 
 import { Province } from './Province';
 
 export class City extends Model {
-    static table = "cities"
+    static table = 'cities';
 
     @column({
-        primary: true, type: "string", beforeSave(value) {
+        primary: true, type: 'string', beforeSave(value) {
             return value ?? uuidv4();
-        }
+        },
     })
     id!: string;
 
-    @column({ type: "string" })
+    @column({ type: 'string' })
     name: string;
 
-    @column({ type: "string", foreignKey: City.province })
+    @column({ type: 'string', foreignKey: City.province })
     provinceId: string;
 
-    @column({ type: "string", foreignKey: City.parentCity, nullable: true })
+    @column({ type: 'string', foreignKey: City.parentCity, nullable: true })
     parentCityId: string | null = null;
 
-    @column({ type: "string" })
+    @column({ type: 'string' })
     country: Country;
 
-    static parentCity = new ManyToOneRelation(City, "parentCity")
-    static province = new ManyToOneRelation(Province, "province")
-}
+    static parentCity = new ManyToOneRelation(City, 'parentCity');
+    static province = new ManyToOneRelation(Province, 'province');
+}

package/src/models/addresses/PostalCode.test.ts

@@ -1,11 +1,10 @@
-import { Country } from "@stamhoofd/structures";
+import { Country } from '@stamhoofd/structures';
 
-import { City } from "./City";
+import { City } from './City';
 import { PostalCode } from './PostalCode';
 import { Province } from './Province';
 
-
-describe("Model.PostalCode", () => {
+describe('Model.PostalCode', () => {
     let oostVlaanderen!: Province;
     let gent!: City;
     let mariakerke!: City;
@@ -20,98 +19,98 @@ describe("Model.PostalCode", () => {
     let massemenZip!: PostalCode;
 
     beforeAll(async () => {
-        oostVlaanderen = new Province()
-        oostVlaanderen.name = "Oost-Vlaanderen"
-        oostVlaanderen.country = Country.Belgium
-        await oostVlaanderen.save()
+        oostVlaanderen = new Province();
+        oostVlaanderen.name = 'Oost-Vlaanderen';
+        oostVlaanderen.country = Country.Belgium;
+        await oostVlaanderen.save();
 
         // Create some cities
-        gent = new City()
-        gent.name = "Gent"
-        gent.provinceId = oostVlaanderen.id
-        gent.country = Country.Belgium
-        await gent.save()
+        gent = new City();
+        gent.name = 'Gent';
+        gent.provinceId = oostVlaanderen.id;
+        gent.country = Country.Belgium;
+        await gent.save();
 
         // Create some cities
-        mariakerke = new City()
-        mariakerke.name = "Mariakerke"
-        mariakerke.provinceId = oostVlaanderen.id
-        mariakerke.parentCityId = gent.id
-        mariakerke.country = Country.Belgium
-        await mariakerke.save()
+        mariakerke = new City();
+        mariakerke.name = 'Mariakerke';
+        mariakerke.provinceId = oostVlaanderen.id;
+        mariakerke.parentCityId = gent.id;
+        mariakerke.country = Country.Belgium;
+        await mariakerke.save();
 
         // Create some cities
-        wetteren = new City()
-        wetteren.name = "Wetteren"
-        wetteren.provinceId = oostVlaanderen.id
-        wetteren.country = Country.Belgium
-        await wetteren.save()
+        wetteren = new City();
+        wetteren.name = 'Wetteren';
+        wetteren.provinceId = oostVlaanderen.id;
+        wetteren.country = Country.Belgium;
+        await wetteren.save();
 
         // Create some cities
-        massemen = new City()
-        massemen.name = "Massemen"
-        massemen.provinceId = oostVlaanderen.id
-        massemen.parentCityId = wetteren.id
-        massemen.country = Country.Belgium
-        await massemen.save()
+        massemen = new City();
+        massemen.name = 'Massemen';
+        massemen.provinceId = oostVlaanderen.id;
+        massemen.parentCityId = wetteren.id;
+        massemen.country = Country.Belgium;
+        await massemen.save();
 
         // Create postal codes
-        gentZip = new PostalCode()
-        gentZip.postalCode = "9000"
-        gentZip.cityId = gent.id
-        gentZip.country = Country.Belgium
-        await gentZip.save()
+        gentZip = new PostalCode();
+        gentZip.postalCode = '9000';
+        gentZip.cityId = gent.id;
+        gentZip.country = Country.Belgium;
+        await gentZip.save();
 
         // Create postal codes
-        mariakerkeZip = new PostalCode()
-        mariakerkeZip.postalCode = "9030"
-        mariakerkeZip.cityId = mariakerke.id
-        mariakerkeZip.country = Country.Belgium
-        await mariakerkeZip.save()
+        mariakerkeZip = new PostalCode();
+        mariakerkeZip.postalCode = '9030';
+        mariakerkeZip.cityId = mariakerke.id;
+        mariakerkeZip.country = Country.Belgium;
+        await mariakerkeZip.save();
 
         // Create postal codes
-        wetterenZip = new PostalCode()
-        wetterenZip.postalCode = "9230"
-        wetterenZip.cityId = wetteren.id
-        wetterenZip.country = Country.Belgium
-        await wetterenZip.save()
+        wetterenZip = new PostalCode();
+        wetterenZip.postalCode = '9230';
+        wetterenZip.cityId = wetteren.id;
+        wetterenZip.country = Country.Belgium;
+        await wetterenZip.save();
 
         // Create postal codes
-        massemenZip = new PostalCode()
-        massemenZip.postalCode = "9230"
-        massemenZip.cityId = massemen.id
-        massemenZip.country = Country.Belgium
-        await massemenZip.save()
+        massemenZip = new PostalCode();
+        massemenZip.postalCode = '9230';
+        massemenZip.cityId = massemen.id;
+        massemenZip.country = Country.Belgium;
+        await massemenZip.save();
     });
 
-    test("Normal flow", async () => {
-        const test = await PostalCode.getCity("9000", "Gent", Country.Belgium);
-        expect(test).toMatchObject(gent)
+    test('Normal flow', async () => {
+        const test = await PostalCode.getCity('9000', 'Gent', Country.Belgium);
+        expect(test).toMatchObject(gent);
     });
 
-    test("Entering the postal code of the parent city works", async () => {
-        const test = await PostalCode.getCity("9000", "Mariakerke", Country.Belgium);
-        expect(test).toMatchObject(gent)
+    test('Entering the postal code of the parent city works', async () => {
+        const test = await PostalCode.getCity('9000', 'Mariakerke', Country.Belgium);
+        expect(test).toMatchObject(gent);
     });
 
-     test("Entering the postal code of a child city works", async () => {
-        const test = await PostalCode.getCity("9030", "Gent", Country.Belgium);
-        expect(test).toMatchObject(mariakerke)
+    test('Entering the postal code of a child city works', async () => {
+        const test = await PostalCode.getCity('9030', 'Gent', Country.Belgium);
+        expect(test).toMatchObject(mariakerke);
     });
 
-    test("Search normal", async () => {
-        const test = await PostalCode.getCity("9230", "Wetteren", Country.Belgium);
-        expect(test).toMatchObject(wetteren)
+    test('Search normal', async () => {
+        const test = await PostalCode.getCity('9230', 'Wetteren', Country.Belgium);
+        expect(test).toMatchObject(wetteren);
 
-        const test2 = await PostalCode.getCity("9230", "Massemen", Country.Belgium);
-        expect(test2).toMatchObject(massemen)
+        const test2 = await PostalCode.getCity('9230', 'Massemen', Country.Belgium);
+        expect(test2).toMatchObject(massemen);
     });
 
-    test("Allow typo", async () => {
-        const test = await PostalCode.getCity("9230", "Wettern", Country.Belgium);
-        expect(test).toMatchObject(wetteren)
+    test('Allow typo', async () => {
+        const test = await PostalCode.getCity('9230', 'Wettern', Country.Belgium);
+        expect(test).toMatchObject(wetteren);
 
-        const test2 = await PostalCode.getCity("9230", "Masemen", Country.Belgium);
-        expect(test2).toMatchObject(massemen)
+        const test2 = await PostalCode.getCity('9230', 'Masemen', Country.Belgium);
+        expect(test2).toMatchObject(massemen);
     });
 });