@stamhoofd/backend 2.9.0 → 2.13.0

package/src/endpoints/organization/dashboard/payments/GetPaymentsEndpoint.ts

@@ -1,54 +1,160 @@
-import { AutoEncoder, DateDecoder, EnumDecoder, field, IntegerDecoder, StringDecoder } from "@simonbackx/simple-encoding";
-import { DecodedRequest, Endpoint, Request, Response } from "@simonbackx/simple-endpoints";
-import { Organization, Payment } from "@stamhoofd/models";
-import { PaymentGeneral, PaymentMethod, PaymentProvider, PaymentStatus } from "@stamhoofd/structures";
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+import { Decoder } from '@simonbackx/simple-encoding';
+import { DecodedRequest, Endpoint, Request, Response } from '@simonbackx/simple-endpoints';
+import { SimpleError } from '@simonbackx/simple-errors';
+import { Payment } from '@stamhoofd/models';
+import { SQLJsonUnquote, SQL, SQLConcat, SQLFilterDefinitions, SQLOrderBy, SQLOrderByDirection, SQLScalar, SQLSortDefinitions, baseSQLFilterCompilers, compileToSQLFilter, compileToSQLSorter, createSQLColumnFilterCompiler, createSQLExpressionFilterCompiler, createSQLFilterNamespace, createSQLRelationFilterCompiler, SQLCast } from "@stamhoofd/sql";
+import { CountFilteredRequest, LimitedFilteredRequest, PaginatedResponse, PaymentGeneral, StamhoofdFilter, getSortFilter } from '@stamhoofd/structures';
+import { Formatter } from '@stamhoofd/utility';
 
-import { StringArrayDecoder } from "../../../../decoders/StringArrayDecoder";
-import { AuthenticatedStructures } from "../../../../helpers/AuthenticatedStructures";
-import { Context } from "../../../../helpers/Context";
-import { StringNullableDecoder } from "../../../../decoders/StringNullableDecoder";
+import { AuthenticatedStructures } from '../../../../helpers/AuthenticatedStructures';
+import { Context } from '../../../../helpers/Context';
 
 type Params = Record<string, never>;
-type Body = undefined
-type ResponseBody = PaymentGeneral[]
+type Query = LimitedFilteredRequest;
+type Body = undefined;
+type ResponseBody = PaginatedResponse<PaymentGeneral[], LimitedFilteredRequest>
 
+const balanceItemPaymentsCompilers: SQLFilterDefinitions = {
+    ...baseSQLFilterCompilers,
+    "id": createSQLColumnFilterCompiler(SQL.column('balance_item_payments', 'id')),
+    "price": createSQLColumnFilterCompiler(SQL.column('balance_item_payments', 'price')),
+    
+    "balanceItem": createSQLFilterNamespace({
+        ...baseSQLFilterCompilers,
+        id: createSQLColumnFilterCompiler(SQL.column('balance_items', 'id')),
+        description: createSQLColumnFilterCompiler(SQL.column('balance_items', 'description')),
+    })
+}
 
-class Query extends AutoEncoder {
-    /**
-     * Usage in combination with paidSince is special!
-     */
-    @field({ decoder: StringDecoder, optional: true })
-    afterId?: string
-
-    /**
-     * Return all payments that were paid after (and including) this date. 
-     * Only returns orders **equal** to this date if afterId is not provided or if the id of those payments is also higher.
-     */
-    @field({ decoder: DateDecoder, optional: true })
-    paidSince?: Date
-
-    @field({ decoder: DateDecoder, optional: true })
-    paidBefore?: Date
-
-    @field({ decoder: IntegerDecoder, optional: true })
-    limit?: number
-
-    @field({ decoder: new StringArrayDecoder(new EnumDecoder(PaymentMethod)), optional: true })
-    methods?: PaymentMethod[]
+const filterCompilers: SQLFilterDefinitions = {
+    ...baseSQLFilterCompilers,
+    id: createSQLColumnFilterCompiler('id'),
+    method: createSQLColumnFilterCompiler('method'),
+    status: createSQLColumnFilterCompiler('status'),
+    organizationId: createSQLColumnFilterCompiler('organizationId'),
+    createdAt: createSQLColumnFilterCompiler('createdAt'),
+    paidAt: createSQLColumnFilterCompiler('paidAt', {nullable: true}),
+    price: createSQLColumnFilterCompiler('price'),
+    provider: createSQLColumnFilterCompiler('provider', {nullable: true}),
+    customer: createSQLFilterNamespace({
+        ...baseSQLFilterCompilers,
+        email: createSQLExpressionFilterCompiler(
+            SQL.jsonValue(SQL.column('customer'), '$.value.email'),
+            {isJSONValue: true}
+        ),
+        firstName: createSQLExpressionFilterCompiler(
+            SQL.jsonValue(SQL.column('customer'), '$.value.firstName'),
+            {isJSONValue: true}
+        ),
+        lastName: createSQLExpressionFilterCompiler(
+            SQL.jsonValue(SQL.column('customer'), '$.value.lastName'),
+            {isJSONValue: true}
+        ),
+        name: createSQLExpressionFilterCompiler(
+            new SQLCast(
+                new SQLConcat(
+                    new SQLJsonUnquote(SQL.jsonValue(SQL.column('customer'), '$.value.firstName')),
+                    new SQLScalar(' '),
+                    new SQLJsonUnquote(SQL.jsonValue(SQL.column('customer'), '$.value.lastName')),
+                ),
+                'CHAR'
+            )
+        ),
+        company: createSQLFilterNamespace({
+            name: createSQLExpressionFilterCompiler(
+                SQL.jsonValue(SQL.column('customer'), '$.value.company.name'),
+                {isJSONValue: true}
+            ),
+            VATNumber: createSQLExpressionFilterCompiler(
+                SQL.jsonValue(SQL.column('customer'), '$.value.company.VATNumber'),
+                {isJSONValue: true}
+            ),
+            companyNumber: createSQLExpressionFilterCompiler(
+                SQL.jsonValue(SQL.column('customer'), '$.value.company.companyNumber'),
+                {isJSONValue: true}
+            ),
+            administrationEmail: createSQLExpressionFilterCompiler(
+                SQL.jsonValue(SQL.column('customer'), '$.value.company.administrationEmail'),
+                {isJSONValue: true}
+            ),
+        })
+    }),
+    balanceItemPayments: createSQLRelationFilterCompiler(
+        SQL.select()
+        .from(
+            SQL.table('balance_item_payments')
+        ).join(
+            SQL.join(
+                SQL.table('balance_items')
+            ).where(
+                SQL.column('balance_items', 'id'),
+                SQL.column('balance_item_payments', 'balanceItemId')
+            )
+        ).where(
+            SQL.column('paymentId'),
+            SQL.column('payments', 'id')
+        ),
+        balanceItemPaymentsCompilers
+    ),
+}
 
-    @field({ decoder: new StringArrayDecoder(new StringNullableDecoder(new EnumDecoder(PaymentProvider))), optional: true })
-    providers?: (PaymentProvider|null)[]
+const sorters: SQLSortDefinitions<Payment> = {
+    'id': {
+        getValue(a) {
+            return a.id
+        },
+        toSQL: (direction: SQLOrderByDirection): SQLOrderBy => {
+            return new SQLOrderBy({
+                column: SQL.column('id'),
+                direction
+            })
+        }
+    },
+    'createdAt': {
+        getValue(a) {
+            return Formatter.dateTimeIso(a.createdAt, 'UTC')
+        },
+        toSQL: (direction: SQLOrderByDirection): SQLOrderBy => {
+            return new SQLOrderBy({
+                column: SQL.column('createdAt'),
+                direction
+            })
+        }
+    },
+    'paidAt': {
+        getValue(a) {
+            return a.paidAt !== null ? Formatter.dateTimeIso(a.paidAt, 'UTC') : null
+        },
+        toSQL: (direction: SQLOrderByDirection): SQLOrderBy => {
+            return new SQLOrderBy({
+                column: SQL.column('paidAt'),
+                direction
+            })
+        }
+    },
+    'price': {
+        getValue(a) {
+            return a.price
+        },
+        toSQL: (direction: SQLOrderByDirection): SQLOrderBy => {
+            return new SQLOrderBy({
+                column: SQL.column('price'),
+                direction
+            })
+        }
+    }
 }
 
 export class GetPaymentsEndpoint extends Endpoint<Params, Query, Body, ResponseBody> {
-    protected queryDecoder = Query;
+    queryDecoder = LimitedFilteredRequest as Decoder<LimitedFilteredRequest>
 
     protected doesMatch(request: Request): [true, Params] | [false] {
         if (request.method != "GET") {
             return [false];
         }
 
-        const params = Endpoint.parseParameters(request.url, "/organization/payments", {});
+        const params = Endpoint.parseParameters(request.url, "/payments", {});
 
         if (params) {
             return [true, params as Params];
@@ -56,115 +162,168 @@ export class GetPaymentsEndpoint extends Endpoint<Params, Query, Body, ResponseB
         return [false];
     }
 
-    async handle(request: DecodedRequest<Params, Query, Body>) {
-        const organization = await Context.setOrganizationScope();
-        await Context.authenticate()
+    static async buildQuery(q: CountFilteredRequest|LimitedFilteredRequest) {
+        const organization = Context.organization
+        let scopeFilter: StamhoofdFilter|undefined = undefined;
+
+        if (!organization) {
+            throw Context.auth.error()
+        }
 
         if (!await Context.auth.canManagePayments(organization.id)) {
             throw Context.auth.error()
-        } 
+        }
 
-        return new Response(
-            (await this.getPayments(organization, request.query))
-        );
-    }
+        scopeFilter = {
+            organizationId: organization.id
+        };
+        
+        const query = SQL
+            .select()
+            .from(
+                SQL.table('payments')
+            );
+            
+        if (scopeFilter) {
+            query.where(compileToSQLFilter(scopeFilter, filterCompilers))
+        }
+
+        if (q.filter) {
+            query.where(compileToSQLFilter(q.filter, filterCompilers))
+        }
+
+        if (q.search) {
+            // todo
 
-    async getPayments(organization: Organization, query: Query) {
-        const paidSince = query.paidSince ?? new Date(Date.now() - (24 * 60 * 60 * 1000 * 7 ))
-        paidSince.setMilliseconds(0)
-        const payments: Payment[] = []
-
-        if (query.afterId) {
-            // First return all payments with id > afterId and paidAt == paidSince
-            payments.push(...await Payment.where({
-                organizationId: organization.id, 
-                paidAt: {
-                    sign: '=', 
-                    value: paidSince
-                },
-                id: {
-                    sign: '>',
-                    value: query.afterId ?? ""
-                },
-                method: {
-                    sign: 'IN', 
-                    value: query.methods ?? [PaymentMethod.Transfer]
-                },
-                provider: {
-                    sign: 'IN', 
-                    value: query.providers ?? [null]
+            let searchFilter: StamhoofdFilter|null = null
+            searchFilter = {
+                $or: [
+                    {
+                        customer: {
+                            name: {
+                                $contains: q.search
+                            }
+                        }
+                    },
+                    {
+                        customer: {
+                            company: {
+                                name: {
+                                    $contains: q.search
+                                }
+                            }
+                        }
+                    },
+                    {
+                        balanceItemPayments: {
+                            $elemMatch: {
+                                balanceItem: {
+                                    description: {
+                                        $contains: q.search
+                                    }
+                                }
+                            }
+                        }
+                    }
+                ]
+            }
+
+            if (q.search.includes('@')) {
+                searchFilter = {
+                    $or: [
+                        {
+                            customer: {
+                                email: {
+                                    $contains: q.search
+                                }
+                            }
+                        },
+                        {
+                            customer: {
+                                company: {
+                                    administrationEmail: {
+                                        $contains: q.search
+                                    }
+                                }
+                            }
+                        },
+                    ]
                 }
-            }, {
-                limit: query.limit ?? undefined,
-                sort: [{
-                    column: "id",
-                    direction: "ASC"
-                }]
-            }));
+            } 
+
+            if (searchFilter) {
+                query.where(compileToSQLFilter(searchFilter, filterCompilers))
+            }
         }
 
-        payments.push(...await Payment.where({
-            organizationId: organization.id, 
-            paidAt: query.paidBefore ? [{
-                sign: query.afterId  ? '>' : '>=', 
-                value: paidSince
-            }, {
-                sign: '<=', 
-                value: query.paidBefore
-            }] : {
-                sign: query.afterId  ? '>' : '>=', 
-                value: paidSince
-            },
-            method: {
-                sign: 'IN', 
-                value: query.methods ?? [PaymentMethod.Transfer]
-            },
-            provider: {
-                sign: 'IN', 
-                value: query.providers ?? [null]
+        if (q instanceof LimitedFilteredRequest) {
+            if (q.pageFilter) {
+                query.where(compileToSQLFilter(q.pageFilter, filterCompilers))
             }
-        }, {
-            limit: query.limit ? (query.limit - payments.length) : undefined,
-            sort: [{
-                column: "paidAt",
-                direction: "ASC"
-            }, 
-            {
-                column: "id",
-                direction: "ASC"
-            }]
-        }));
-
-
-        if (!query.paidSince && !query.methods && !query.providers) {
-            // Default behaviour is to return all not-paid transfer payments that are not yet paid
-
-            payments.push(...
-                await Payment.where({
-                    organizationId: organization.id, 
-                    paidAt: null,
-                    method: PaymentMethod.Transfer,
-                    status: {
-                        sign: '!=',
-                        value: PaymentStatus.Failed
-                    }
-                })
-            );
 
-            payments.push(...
-                await Payment.where({
-                    organizationId: organization.id, 
-                    paidAt: null,
-                    updatedAt: {
-                        sign: '>', 
-                        value: new Date(Date.now() - (24 * 60 * 60 * 1000 * 7 ))
-                    },
-                    method: PaymentMethod.Transfer,
-                    status: PaymentStatus.Failed
-                })
-            );
+            query.orderBy(compileToSQLSorter(q.sort, sorters))
+            query.limit(q.limit)
         }
+       
+        return query
+    }
+
+    static async buildData(requestQuery: LimitedFilteredRequest) {
+        const query = await this.buildQuery(requestQuery)
+        const data = await query.fetch()
+        
+        const payments = Payment.fromRows(data, 'payments')
+
+        let next: LimitedFilteredRequest|undefined;
 
-        return await AuthenticatedStructures.paymentsGeneral(payments, true)
+        if (payments.length >= requestQuery.limit) {
+            const lastObject = payments[payments.length - 1];
+            const nextFilter = getSortFilter(lastObject, sorters, requestQuery.sort);
+
+            next = new LimitedFilteredRequest({
+                filter: requestQuery.filter,
+                pageFilter: nextFilter,
+                sort: requestQuery.sort,
+                limit: requestQuery.limit,
+                search: requestQuery.search
+            })
+
+            if (JSON.stringify(nextFilter) === JSON.stringify(requestQuery.pageFilter)) {
+                console.error('Found infinite loading loop for', requestQuery);
+                next = undefined;
+            }
+        }
+
+        return new PaginatedResponse<PaymentGeneral[], LimitedFilteredRequest>({
+            results: await AuthenticatedStructures.paymentsGeneral(payments, false),
+            next
+        });
+    }
+
+    async handle(request: DecodedRequest<Params, Query, Body>) {
+        await Context.setOrganizationScope();
+        await Context.authenticate()
+
+        const maxLimit = Context.auth.hasSomePlatformAccess() ? 1000 : 100;
+
+        if (request.query.limit > maxLimit) {
+            throw new SimpleError({
+                code: 'invalid_field',
+                field: 'limit',
+                message: 'Limit can not be more than ' + maxLimit
+            })
+        }
+
+        if (request.query.limit < 1) {
+            throw new SimpleError({
+                code: 'invalid_field',
+                field: 'limit',
+                message: 'Limit can not be less than 1'
+            })
+        }
+        
+        return new Response(
+            await GetPaymentsEndpoint.buildData(request.query)
+        );
     }
 }

package/src/endpoints/organization/dashboard/payments/legacy/GetPaymentsEndpoint.ts

@@ -0,0 +1,170 @@
+import { AutoEncoder, DateDecoder, EnumDecoder, field, IntegerDecoder, StringDecoder } from "@simonbackx/simple-encoding";
+import { DecodedRequest, Endpoint, Request, Response } from "@simonbackx/simple-endpoints";
+import { Organization, Payment } from "@stamhoofd/models";
+import { PaymentGeneral, PaymentMethod, PaymentProvider, PaymentStatus } from "@stamhoofd/structures";
+
+import { StringArrayDecoder } from "../../../../../decoders/StringArrayDecoder";
+import { AuthenticatedStructures } from "../../../../../helpers/AuthenticatedStructures";
+import { Context } from "../../../../../helpers/Context";
+import { StringNullableDecoder } from "../../../../../decoders/StringNullableDecoder";
+
+type Params = Record<string, never>;
+type Body = undefined
+type ResponseBody = PaymentGeneral[]
+
+
+class Query extends AutoEncoder {
+    /**
+     * Usage in combination with paidSince is special!
+     */
+    @field({ decoder: StringDecoder, optional: true })
+    afterId?: string
+
+    /**
+     * Return all payments that were paid after (and including) this date. 
+     * Only returns orders **equal** to this date if afterId is not provided or if the id of those payments is also higher.
+     */
+    @field({ decoder: DateDecoder, optional: true })
+    paidSince?: Date
+
+    @field({ decoder: DateDecoder, optional: true })
+    paidBefore?: Date
+
+    @field({ decoder: IntegerDecoder, optional: true })
+    limit?: number
+
+    @field({ decoder: new StringArrayDecoder(new EnumDecoder(PaymentMethod)), optional: true })
+    methods?: PaymentMethod[]
+
+    @field({ decoder: new StringArrayDecoder(new StringNullableDecoder(new EnumDecoder(PaymentProvider))), optional: true })
+    providers?: (PaymentProvider|null)[]
+}
+
+export class GetPaymentsEndpoint extends Endpoint<Params, Query, Body, ResponseBody> {
+    protected queryDecoder = Query;
+
+    protected doesMatch(request: Request): [true, Params] | [false] {
+        if (request.method != "GET") {
+            return [false];
+        }
+
+        const params = Endpoint.parseParameters(request.url, "/organization/payments", {});
+
+        if (params) {
+            return [true, params as Params];
+        }
+        return [false];
+    }
+
+    async handle(request: DecodedRequest<Params, Query, Body>) {
+        const organization = await Context.setOrganizationScope();
+        await Context.authenticate()
+
+        if (!await Context.auth.canManagePayments(organization.id)) {
+            throw Context.auth.error()
+        } 
+
+        return new Response(
+            (await this.getPayments(organization, request.query))
+        );
+    }
+
+    async getPayments(organization: Organization, query: Query) {
+        const paidSince = query.paidSince ?? new Date(Date.now() - (24 * 60 * 60 * 1000 * 7 ))
+        paidSince.setMilliseconds(0)
+        const payments: Payment[] = []
+
+        if (query.afterId) {
+            // First return all payments with id > afterId and paidAt == paidSince
+            payments.push(...await Payment.where({
+                organizationId: organization.id, 
+                paidAt: {
+                    sign: '=', 
+                    value: paidSince
+                },
+                id: {
+                    sign: '>',
+                    value: query.afterId ?? ""
+                },
+                method: {
+                    sign: 'IN', 
+                    value: query.methods ?? [PaymentMethod.Transfer]
+                },
+                provider: {
+                    sign: 'IN', 
+                    value: query.providers ?? [null]
+                }
+            }, {
+                limit: query.limit ?? undefined,
+                sort: [{
+                    column: "id",
+                    direction: "ASC"
+                }]
+            }));
+        }
+
+        payments.push(...await Payment.where({
+            organizationId: organization.id, 
+            paidAt: query.paidBefore ? [{
+                sign: query.afterId  ? '>' : '>=', 
+                value: paidSince
+            }, {
+                sign: '<=', 
+                value: query.paidBefore
+            }] : {
+                sign: query.afterId  ? '>' : '>=', 
+                value: paidSince
+            },
+            method: {
+                sign: 'IN', 
+                value: query.methods ?? [PaymentMethod.Transfer]
+            },
+            provider: {
+                sign: 'IN', 
+                value: query.providers ?? [null]
+            }
+        }, {
+            limit: query.limit ? (query.limit - payments.length) : undefined,
+            sort: [{
+                column: "paidAt",
+                direction: "ASC"
+            }, 
+            {
+                column: "id",
+                direction: "ASC"
+            }]
+        }));
+
+
+        if (!query.paidSince && !query.methods && !query.providers) {
+            // Default behaviour is to return all not-paid transfer payments that are not yet paid
+
+            payments.push(...
+                await Payment.where({
+                    organizationId: organization.id, 
+                    paidAt: null,
+                    method: PaymentMethod.Transfer,
+                    status: {
+                        sign: '!=',
+                        value: PaymentStatus.Failed
+                    }
+                })
+            );
+
+            payments.push(...
+                await Payment.where({
+                    organizationId: organization.id, 
+                    paidAt: null,
+                    updatedAt: {
+                        sign: '>', 
+                        value: new Date(Date.now() - (24 * 60 * 60 * 1000 * 7 ))
+                    },
+                    method: PaymentMethod.Transfer,
+                    status: PaymentStatus.Failed
+                })
+            );
+        }
+
+        return await AuthenticatedStructures.paymentsGeneral(payments, true)
+    }
+}