Merge pull request #277 from beabee-communityrm/feat/payment-api

Add a basic read only payment API

package.json

@@ -31,7 +31,7 @@
     "test": "jest --setupFiles dotenv/config"
   },
   "dependencies": {
-    "@beabee/beabee-common": "^1.13.1",
+    "@beabee/beabee-common": "^1.13.2",
     "@sendgrid/mail": "^7.7.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",

src/api/app.ts

@@ -23,6 +23,7 @@ import { ContentController } from "./controllers/ContentController";
 import { EmailController } from "./controllers/EmailController";
 import { ContactController } from "./controllers/ContactController";
 import { NoticeController } from "./controllers/NoticeController";
+import { PaymentController } from "./controllers/PaymentController";
 import { SegmentController } from "./controllers/SegmentController";
 import { SignupController } from "./controllers/SignupController";
 import { StatsController } from "./controllers/StatsController";
@@ -104,6 +105,7 @@ db.connect().then(() => {
       EmailController,
       ContactController,
       NoticeController,
+      PaymentController,
       SegmentController,
       SignupController,
       StatsController,

src/api/controllers/ContactController.ts

@@ -37,11 +37,11 @@ import PaymentService from "@core/services/PaymentService";
 import { ContributionInfo } from "@core/utils";
 import { generatePassword } from "@core/utils/auth";
 
-import JoinFlow from "@models/JoinFlow";
 import Contact from "@models/Contact";
 import ContactProfile from "@models/ContactProfile";
-import Payment from "@models/Payment";
 import ContactRole from "@models/ContactRole";
+import JoinFlow from "@models/JoinFlow";
+import Payment from "@models/Payment";
 
 import { UUIDParam } from "@api/data";
 import {
@@ -53,8 +53,6 @@ import {
   GetContactRoleData,
   GetContactsQuery,
   GetContactWith,
-  GetPaymentData,
-  GetPaymentsQuery,
   UpdateContactRoleData,
   UpdateContactData,
   exportContacts
@@ -75,6 +73,7 @@ import {
   Paginated,
   GetExportQuery
 } from "@api/data/PaginatedData";
+import { GetPaymentData, GetPaymentsQuery } from "@api/data/PaymentData";
 
 import PartialBody from "@api/decorators/PartialBody";
 import CantUpdateContribution from "@api/errors/CantUpdateContribution";

src/api/controllers/PaymentController.ts

@@ -0,0 +1,40 @@
+import { Paginated, fetchPaginated, mergeRules } from "@api/data/PaginatedData";
+import {
+  Authorized,
+  CurrentUser,
+  Get,
+  JsonController,
+  QueryParams
+} from "routing-controllers";
+
+import {
+  GetPaymentData,
+  GetPaymentsQuery,
+  fetchPaginatedPayments
+} from "@api/data/PaymentData";
+
+import Contact from "@models/Contact";
+
+@JsonController("/payment")
+@Authorized()
+export class PaymentController {
+  @Get("/")
+  async getPayments(
+    @CurrentUser() contact: Contact,
+    @QueryParams() query: GetPaymentsQuery
+  ): Promise<Paginated<GetPaymentData>> {
+    const authedQuery = {
+      ...query,
+      rules: mergeRules([
+        query.rules,
+        // Non-admins can only see their own payments
+        !contact.hasRole("admin") && {
+          field: "contact",
+          operator: "equal",
+          value: [contact.id]
+        }
+      ])
+    };
+    return await fetchPaginatedPayments(authedQuery, contact);
+  }
+}

src/api/data/ContactData/interface.ts

@@ -1,7 +1,6 @@
 import {
   ContributionPeriod,
   NewsletterStatus,
-  PaymentStatus,
   RoleType,
   RoleTypes
 } from "@beabee/beabee-common";
@@ -213,15 +212,3 @@ export class CreateContactData extends UpdateContactData {
   @Type(() => CreateContactRoleData)
   roles?: CreateContactRoleData[];
 }
-
-export interface GetPaymentData {
-  amount: number;
-  chargeDate: Date;
-  status: PaymentStatus;
-}
-
-const paymentSortFields = ["amount", "chargeDate"] as const;
-export class GetPaymentsQuery extends GetPaginatedQuery {
-  @IsIn(paymentSortFields)
-  sort?: string;
-}

src/api/data/PaymentData/index.ts

@@ -0,0 +1,53 @@
+import Payment from "@models/Payment";
+import { GetPaymentData, GetPaymentWith, GetPaymentsQuery } from "./interface";
+import { Paginated, paymentFilters } from "@beabee/beabee-common";
+import { fetchPaginated } from "../PaginatedData";
+import Contact from "@models/Contact";
+import { convertContactToData, loadContactRoles } from "../ContactData";
+
+function convertPaymentToPaymentData(
+  payment: Payment,
+  _with?: GetPaymentWith[]
+): GetPaymentData {
+  return {
+    amount: payment.amount,
+    chargeDate: payment.chargeDate,
+    status: payment.status,
+    ...(_with?.includes(GetPaymentWith.Contact) && {
+      contact: payment.contact && convertContactToData(payment.contact)
+    })
+  };
+}
+
+export async function fetchPaginatedPayments(
+  query: GetPaymentsQuery,
+  contact: Contact
+): Promise<Paginated<GetPaymentData>> {
+  const data = await fetchPaginated(
+    Payment,
+    paymentFilters,
+    query,
+    contact,
+    undefined,
+    (qb, fieldPrefix) => {
+      if (query.with?.includes(GetPaymentWith.Contact)) {
+        qb.leftJoinAndSelect(`${fieldPrefix}contact`, "contact");
+      }
+    }
+  );
+
+  // Load contact roles after to ensure offset/limit work
+  const contacts = data.items
+    .map((item) => item.contact)
+    .filter((c) => !!c) as Contact[];
+  await loadContactRoles(contacts);
+
+  return {
+    ...data,
+    items: data.items.map((item) =>
+      convertPaymentToPaymentData(item, query.with)
+    )
+  };
+}
+
+export * from "./interface";

src/api/data/PaymentData/interface.ts

@@ -0,0 +1,27 @@
+import { PaymentStatus } from "@beabee/beabee-common";
+import { IsArray, IsEnum, IsIn, IsOptional } from "class-validator";
+
+import { GetPaginatedQuery } from "../PaginatedData";
+import { GetContactData } from "../ContactData";
+
+export interface GetPaymentData {
+  amount: number;
+  chargeDate: Date;
+  status: PaymentStatus;
+  contact?: GetContactData | null;
+}
+
+export enum GetPaymentWith {
+  Contact = "contact"
+}
+
+const paymentSortFields = ["amount", "chargeDate"] as const;
+export class GetPaymentsQuery extends GetPaginatedQuery {
+  @IsArray()
+  @IsOptional()
+  @IsEnum(GetPaymentWith, { each: true })
+  with?: GetPaymentWith[];
+
+  @IsIn(paymentSortFields)
+  sort?: string;
+}