@temboplus/afloat 0.1.57 → 0.1.59

package/script/src/features/contact/repository.d.ts

@@ -0,0 +1,58 @@
+import { BaseRepository } from "../../shared/base_repository.js";
+import { contract } from "./contract.js";
+import { Contact, type ContactInput } from "../../models/contact/index.js";
+import type { AfloatAuth } from "../auth/manager.js";
+/**
+ * Repository class for managing `Contact` data through API interactions.
+ * Extends the `BaseRepository` to leverage shared functionality.
+ */
+export declare class ContactRepository extends BaseRepository<typeof contract> {
+    /**
+     * Creates an instance of `ContactRepository` using the contact contract.
+     * @param {Object} [props] - Optional constructor properties
+     * @param {AfloatAuth} [props.auth] - Optional auth instance to use
+     * @param {string} [props.root] - Optional API root URL
+     */
+    constructor(props?: {
+        auth?: AfloatAuth;
+        root?: string;
+    });
+    /**
+     * 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 {PermissionError} If the user lacks required permissions
+     * @throws {APIError} If the response status code is not 201.
+     */
+    create(input: ContactInput): Promise<Contact>;
+    /**
+     * 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 {PermissionError} If the user lacks required permissions
+     * @throws {APIError} If the response status code is not 200.
+     */
+    edit(id: string, input: ContactInput): Promise<Contact>;
+    /**
+     * 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 {PermissionError} If the user lacks required permissions
+     * @throws {APIError} If the response status code is not 200.
+     */
+    remove(id: string): Promise<void>;
+    /**
+     * Retrieves all contacts
+     * Results are ordered in descending order by default.
+     *
+     * @returns {Promise<Contact[]>} A promise that resolves to an array of contacts.
+     * @throws {PermissionError} If the user lacks required permissions
+     * @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));
+     */
+    getAll(): Promise<Contact[]>;
+}
+//# sourceMappingURL=repository.d.ts.map

package/script/src/features/contact/repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../../../src/src/features/contact/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EACL,OAAO,EAEP,KAAK,YAAY,EAClB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAIrD;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,cAAc,CAAC,OAAO,QAAQ,CAAC;IACpE;;;;;OAKG;gBACS,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,UAAU,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;IAIxD;;;;;;OAMG;IACG,MAAM,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBnD;;;;;;;OAOG;IACG,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB7D;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAevC;;;;;;;;;;OAUG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;CAgBnC"}

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

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContactRepository = void 0;
+const base_repository_js_1 = require("../../shared/base_repository.js");
+const contract_js_1 = require("./contract.js");
+const index_js_1 = require("../../models/contact/index.js");
+const index_js_2 = require("../../models/index.js");
+const index_js_3 = require("../../errors/index.js");
+/**
+ * Repository class for managing `Contact` data through API interactions.
+ * Extends the `BaseRepository` to leverage shared functionality.
+ */
+class ContactRepository extends base_repository_js_1.BaseRepository {
+    /**
+     * Creates an instance of `ContactRepository` using the contact contract.
+     * @param {Object} [props] - Optional constructor properties
+     * @param {AfloatAuth} [props.auth] - Optional auth instance to use
+     * @param {string} [props.root] - Optional API root URL
+     */
+    constructor(props) {
+        super("contact", contract_js_1.contract, props);
+    }
+    /**
+     * 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 {PermissionError} If the user lacks required permissions
+     * @throws {APIError} If the response status code is not 201.
+     */
+    async create(input) {
+        const auth = this.getAuthForPermissionCheck();
+        const requiredPerm = index_js_2.Permissions.Contact.Create;
+        if (!auth.checkPermission(requiredPerm)) {
+            throw new index_js_3.PermissionError({
+                message: "You are not authorized to add contacts.",
+                requiredPermissions: [requiredPerm],
+            });
+        }
+        const result = await this.client.postContact({ body: input });
+        const data = this.handleResponse(result, 201);
+        return index_js_1.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 {PermissionError} If the user lacks required permissions
+     * @throws {APIError} If the response status code is not 200.
+     */
+    async edit(id, input) {
+        const auth = this.getAuthForPermissionCheck();
+        const requiredPerm = index_js_2.Permissions.Contact.Update;
+        if (!auth.checkPermission(requiredPerm)) {
+            throw new index_js_3.PermissionError({
+                message: "You are not authorized to update contacts.",
+                requiredPermissions: [requiredPerm],
+            });
+        }
+        const result = await this.client.editContact({
+            params: { id },
+            body: input,
+        });
+        const data = this.handleResponse(result, 200);
+        return index_js_1.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 {PermissionError} If the user lacks required permissions
+     * @throws {APIError} If the response status code is not 200.
+     */
+    async remove(id) {
+        const auth = this.getAuthForPermissionCheck();
+        const requiredPerm = index_js_2.Permissions.Contact.Delete;
+        if (!auth.checkPermission(requiredPerm)) {
+            throw new index_js_3.PermissionError({
+                message: "You are not authorized to delete contacts.",
+                requiredPermissions: [requiredPerm],
+            });
+        }
+        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 {PermissionError} If the user lacks required permissions
+     * @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() {
+        const auth = this.getAuthForPermissionCheck();
+        const requiredPerm = index_js_2.Permissions.Contact.List;
+        if (!auth.checkPermission(requiredPerm)) {
+            throw new index_js_3.PermissionError({
+                message: "You are not authorized to view contacts.",
+                requiredPermissions: [requiredPerm],
+            });
+        }
+        const query = { orderByDesc: "createdAt" };
+        const result = await this.client.getContacts({ query });
+        const data = this.handleResponse(result, 200);
+        return index_js_1.Contact.createMany(data);
+    }
+}
+exports.ContactRepository = ContactRepository;