@temboplus/afloat 0.1.0

package/esm/src/features/contact/repository.js

@@ -0,0 +1,94 @@
+import { BaseRepository } from "../../shared/base_repository.js";
+import { contract } from "./contract.js";
+import { Contact, } from "../../models/contact/index.js";
+import { AfloatAuth } from "../auth/index.js";
+import { Permissions } from "../../models/index.js";
+import { PermissionError } from "../../errors/index.js";
+/**
+ * Repository class for managing `Contact` data through API interactions.
+ * Extends the `BaseRepository` to leverage shared functionality.
+ */
+export class ContactRepository extends BaseRepository {
+    /**
+     * Creates an instance of `ContactRepository` using the contact contract.
+     */
+    constructor() {
+        super("contact", contract);
+    }
+    /**
+     * Creates a new contact record.
+     * @param {ContactInput} input - The data required to create a new contact.
+     * @returns {Promise<Contact>} A promise that resolves to the newly created contact.
+     * @throws {APIError} If the response status code is not 201.
+     */
+    async create(input) {
+        if (!AfloatAuth.instance.checkPermission(Permissions.Contact.Create)) {
+            throw new PermissionError({
+                message: "You are not authorized to add contacts.",
+                requiredPermissions: [Permissions.Contact.Create],
+            });
+        }
+        const result = await this.client.postContact({ body: input });
+        const data = this.handleResponse(result, 201);
+        return Contact.create(data);
+    }
+    /**
+     * Updates an existing contact record by ID.
+     * @param {string} id - The unique identifier of the contact to edit.
+     * @param {ContactInput} input - The data to update the contact with.
+     * @returns {Promise<Contact>} A promise that resolves to the updated contact.
+     * @throws {APIError} If the response status code is not 200.
+     */
+    async edit(id, input) {
+        if (!AfloatAuth.instance.checkPermission(Permissions.Contact.Update)) {
+            throw new PermissionError({
+                message: "You are not authorized to update contacts.",
+                requiredPermissions: [Permissions.Contact.Update],
+            });
+        }
+        const result = await this.client.editContact({
+            params: { id },
+            body: input,
+        });
+        const data = this.handleResponse(result, 200);
+        return Contact.create(data);
+    }
+    /**
+     * Deletes a contact record by ID.
+     * @param {string} id - The unique identifier of the contact to remove.
+     * @returns {Promise<void>} A promise that resolves when the deletion is complete.
+     * @throws {APIError} If the response status code is not 200.
+     */
+    async remove(id) {
+        if (!AfloatAuth.instance.checkPermission(Permissions.Contact.Delete)) {
+            throw new PermissionError({
+                message: "You are not authorized to delete contacts.",
+                requiredPermissions: [Permissions.Contact.Delete],
+            });
+        }
+        const result = await this.client.deleteContact({ params: { id } });
+        this.handleResponse(result, 200);
+    }
+    /**
+     * Retrieves all contacts
+     * Results are ordered in descending order by default.
+     *
+     * @returns {Promise<Contact[]>} A promise that resolves to an array of contacts.
+     * @throws {APIError} If the response status code is not 200 or the range is invalid.
+     * @example
+     * const repository = new ContactRepository();
+     * repository.getAll().then(contacts => console.log(contacts));
+     */
+    async getAll() {
+        if (!AfloatAuth.instance.checkPermission(Permissions.Contact.List)) {
+            throw new PermissionError({
+                message: "You are not authorized to view contacts.",
+                requiredPermissions: [Permissions.Contact.List],
+            });
+        }
+        const query = { orderByDesc: "createdAt" };
+        const result = await this.client.getContacts({ query });
+        const data = this.handleResponse(result, 200);
+        return Contact.createMany(data);
+    }
+}

package/esm/src/features/files-gen/contract.d.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+import { STATEMENT_OUTPUT_TYPE } from "../../models/wallet/index.js";
+export declare const contract: {
+    genStatementPDF: {
+        method: "POST";
+        body: z.ZodObject<{
+            end_date: z.ZodDate;
+            start_date: z.ZodDate;
+            account_no: z.ZodOptional<z.ZodString>;
+            return_file_type: z.ZodEnum<[STATEMENT_OUTPUT_TYPE.EXCEL, STATEMENT_OUTPUT_TYPE.PDF]>;
+        }, "strip", z.ZodTypeAny, {
+            end_date: Date;
+            start_date: Date;
+            return_file_type: STATEMENT_OUTPUT_TYPE;
+            account_no?: string | undefined;
+        }, {
+            end_date: Date;
+            start_date: Date;
+            return_file_type: STATEMENT_OUTPUT_TYPE;
+            account_no?: string | undefined;
+        }>;
+        path: "/statement";
+        responses: {
+            201: z.ZodObject<{
+                file: z.ZodString;
+                file_extension: z.ZodString;
+                mime_type: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                file: string;
+                file_extension: string;
+                mime_type: string;
+            }, {
+                file: string;
+                file_extension: string;
+                mime_type: string;
+            }>;
+            202: z.ZodObject<{
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+            }, {
+                message: string;
+            }>;
+        };
+    };
+    genAccountDetailsPDF: {
+        method: "POST";
+        body: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        path: "/account_details";
+        responses: {
+            201: z.ZodObject<{
+                file: z.ZodString;
+                file_extension: z.ZodString;
+                mime_type: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                file: string;
+                file_extension: string;
+                mime_type: string;
+            }, {
+                file: string;
+                file_extension: string;
+                mime_type: string;
+            }>;
+        };
+    };
+};
+//# sourceMappingURL=contract.d.ts.map

package/esm/src/features/files-gen/contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../../../../src/src/features/files-gen/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCnB,CAAC"}

package/esm/src/features/files-gen/contract.js

@@ -0,0 +1,40 @@
+import { z } from "zod";
+import { initContract } from "@ts-rest/core";
+import { STATEMENT_OUTPUT_TYPE } from "../../models/wallet/index.js";
+export const contract = initContract().router({
+    genStatementPDF: {
+        method: "POST",
+        path: "/statement",
+        body: z.object({
+            end_date: z.date(),
+            start_date: z.date(),
+            account_no: z.string().optional(),
+            return_file_type: z.enum([
+                STATEMENT_OUTPUT_TYPE.EXCEL,
+                STATEMENT_OUTPUT_TYPE.PDF,
+            ]),
+        }),
+        responses: {
+            201: z.object({
+                file: z.string(),
+                file_extension: z.string(),
+                mime_type: z.string(),
+            }),
+            202: z.object({
+                message: z.string(),
+            }),
+        },
+    },
+    genAccountDetailsPDF: {
+        method: "POST",
+        path: "/account_details",
+        body: z.object({}),
+        responses: {
+            201: z.object({
+                file: z.string(),
+                file_extension: z.string(),
+                mime_type: z.string(),
+            }),
+        },
+    },
+});

package/esm/src/features/files-gen/repository.d.ts

@@ -0,0 +1,47 @@
+import { contract } from "./contract.js";
+import { BaseRepository } from "../../shared/index.js";
+import type { ClientInferRequest, ClientInferResponseBody } from "@ts-rest/core";
+import type { StatementFile } from "../../models/wallet/index.js";
+/**
+ * Type definition for statement generation input parameters.
+ * Inferred from the contract's genStatementPDF endpoint request body.
+ * @typedef {ClientInferRequest<typeof contract.genStatementPDF>["body"]} GenStatementInput
+ */
+type GenStatementInput = ClientInferRequest<typeof contract.genStatementPDF>["body"];
+/**
+ * Type definition for account details response.
+ * Inferred from the contract's genAccountDetailsPDF endpoint response body.
+ * @typedef {ClientInferResponseBody<typeof contract.genAccountDetailsPDF>} GenAccountDetailsResponse
+ */
+type GenAccountDetailsResponse = ClientInferResponseBody<typeof contract.genAccountDetailsPDF>;
+/**
+ * Repository class for managing file generation operations including
+ * statement PDFs and account details documents.
+ * @extends {BaseRepository<typeof contract>}
+ */
+export declare class AfloatFilesRepo extends BaseRepository<typeof contract> {
+    /**
+     * Creates an instance of AfloatFilesRepo initialized with the files generation contract.
+     * Configures the repository with the PDF maker service endpoint.
+     */
+    constructor();
+    /**
+     * Generates and downloads a statement PDF based on the provided parameters.
+     * @param {GenStatementInput} body - The statement generation parameters
+     * @param {Date} body.start_date - Start date for the statement period
+     * @param {Date} body.end_date - End date for the statement period
+     * @param {string} body.return_file_type - Desired file format for the statement
+     * @param {string} [body.account_no] - Optional account number to generate statement for
+     * @throws {APIError} If the statement generation operation fails
+     * @returns {Promise<StatementFile>} The generated statement file
+     */
+    downloadStatement(body: GenStatementInput): Promise<StatementFile>;
+    /**
+     * Generates a PDF containing detailed account information.
+     * @throws {APIError} If the PDF generation operation fails
+     * @returns {Promise<GenAccountDetailsResponse>} The generated account details PDF
+     */
+    genAccountDetailsPDF(): Promise<GenAccountDetailsResponse>;
+}
+export {};
+//# sourceMappingURL=repository.d.ts.map

package/esm/src/features/files-gen/repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../../../src/src/features/files-gen/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,KAAK,EACV,kBAAkB,EAClB,uBAAuB,EACxB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAElE;;;;GAIG;AACH,KAAK,iBAAiB,GAAG,kBAAkB,CACzC,OAAO,QAAQ,CAAC,eAAe,CAChC,CAAC,MAAM,CAAC,CAAC;AAEV;;;;GAIG;AACH,KAAK,yBAAyB,GAAG,uBAAuB,CACtD,OAAO,QAAQ,CAAC,oBAAoB,CACrC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,cAAc,CAAC,OAAO,QAAQ,CAAC;IAClE;;;OAGG;;IAOH;;;;;;;;;OASG;IACG,iBAAiB,CACrB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,aAAa,CAAC;IAUzB;;;;OAIG;IACG,oBAAoB,IAAI,OAAO,CAAC,yBAAyB,CAAC;CAWjE"}

package/esm/src/features/files-gen/repository.js

@@ -0,0 +1,48 @@
+import { contract } from "./contract.js";
+import { BaseRepository } from "../../shared/index.js";
+import { APIError } from "../../errors/api_error.js";
+/**
+ * Repository class for managing file generation operations including
+ * statement PDFs and account details documents.
+ * @extends {BaseRepository<typeof contract>}
+ */
+export class AfloatFilesRepo extends BaseRepository {
+    /**
+     * Creates an instance of AfloatFilesRepo initialized with the files generation contract.
+     * Configures the repository with the PDF maker service endpoint.
+     */
+    constructor() {
+        super("wallet", contract, {
+            root: "https://api.afloat.money/pdf-maker/afloat",
+        });
+    }
+    /**
+     * Generates and downloads a statement PDF based on the provided parameters.
+     * @param {GenStatementInput} body - The statement generation parameters
+     * @param {Date} body.start_date - Start date for the statement period
+     * @param {Date} body.end_date - End date for the statement period
+     * @param {string} body.return_file_type - Desired file format for the statement
+     * @param {string} [body.account_no] - Optional account number to generate statement for
+     * @throws {APIError} If the statement generation operation fails
+     * @returns {Promise<StatementFile>} The generated statement file
+     */
+    async downloadStatement(body) {
+        const result = await this.client.genStatementPDF({ body });
+        if (result.status === 201) {
+            return result.body;
+        }
+        throw APIError.unknown("An error occurred while generating statement PDF");
+    }
+    /**
+     * Generates a PDF containing detailed account information.
+     * @throws {APIError} If the PDF generation operation fails
+     * @returns {Promise<GenAccountDetailsResponse>} The generated account details PDF
+     */
+    async genAccountDetailsPDF() {
+        const result = await this.client.genAccountDetailsPDF();
+        if (result.status === 201) {
+            return result.body;
+        }
+        throw APIError.unknown("An error occurred while generating account details PDF");
+    }
+}