@temboplus/afloat 0.1.0

package/script/src/shared/base_repository.d.ts

@@ -0,0 +1,56 @@
+import { type AppRouter } from "@ts-rest/core";
+import type { InitClientArgs } from "@ts-rest/core";
+/**
+ * BaseRepository
+ *
+ * A generic base class to build repositories for interacting with the Afloat API.
+ * This class initializes a "ts-rest" client using a specified "ts-rest" contract and provides
+ * helper methods to handle API responses consistently.
+ *
+ * @template TContract - The API contract extending `AppRouter` from `@npm/ts_rest.ts`.
+ */
+export declare class BaseRepository<TContract extends AppRouter> {
+    /**
+     * A "ts-rest" contract
+     *
+     * @protected
+     */
+    protected contract: TContract;
+    /**
+     * An API endpoint
+     *
+     * @protected
+     */
+    protected endpoint: string;
+    /**
+     * An API Root URL
+     *
+     * @protected
+     */
+    protected root: string | undefined;
+    /**
+     * Constructs a new instance of `BaseRepository`.
+     *
+     * @param contract - The "ts-rest" contract
+     * @param endpoint - API endpoint
+     */
+    constructor(endpoint: string, contract: TContract, args?: {
+        root?: string;
+    });
+    get client(): { [TKey in keyof TContract]: TContract[TKey] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey], InitClientArgs>> : TContract[TKey] extends AppRouter ? TContract[TKey] extends infer T extends AppRouter ? { [TKey_1 in keyof T]: TContract[TKey][TKey_1] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1], InitClientArgs>> : TContract[TKey][TKey_1] extends AppRouter ? TContract[TKey][TKey_1] extends infer T_1 extends AppRouter ? { [TKey_2 in keyof T_1]: TContract[TKey][TKey_1][TKey_2] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2] extends AppRouter ? TContract[TKey][TKey_1][TKey_2] extends infer T_2 extends AppRouter ? { [TKey_3 in keyof T_2]: TContract[TKey][TKey_1][TKey_2][TKey_3] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3] extends infer T_3 extends AppRouter ? { [TKey_4 in keyof T_3]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4] extends infer T_4 extends AppRouter ? { [TKey_5 in keyof T_4]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5] extends infer T_5 extends AppRouter ? { [TKey_6 in keyof T_5]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6] extends infer T_6 extends AppRouter ? { [TKey_7 in keyof T_6]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7] extends infer T_7 extends AppRouter ? { [TKey_8 in keyof T_7]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8] extends infer T_8 extends AppRouter ? { [TKey_9 in keyof T_8]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9] extends AppRouter ? TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9] extends infer T_9 extends AppRouter ? { [TKey_10 in keyof T_9]: TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10] extends import("@ts-rest/core").AppRoute ? import("@ts-rest/core").AppRouteFunction<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10], InitClientArgs, import("@ts-rest/core").PartialClientInferRequest<TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10], InitClientArgs>> : TContract[TKey][TKey_1][TKey_2][TKey_3][TKey_4][TKey_5][TKey_6][TKey_7][TKey_8][TKey_9][TKey_10] extends AppRouter ? any : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; } : never : never; };
+    /**
+     * Handles the API response by checking the HTTP status code and returning the response body
+     * for successful requests or throwing an `APIError` for errors.
+     *
+     * @template T - The expected type of the successful response body.
+     * @param result - The API response object containing the status code and response body.
+     * @param successStatusCode - The expected HTTP status code indicating success (e.g., 200, 201).
+     * @returns The response body typed as `T` if the status code matches the success criteria.
+     * @throws `APIError` - If the status code indicates a failure.
+     */
+    handleResponse<T>(result: {
+        status: number;
+        body: unknown;
+    }, successStatusCode: number): T;
+}
+//# sourceMappingURL=base_repository.d.ts.map

package/script/src/shared/base_repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base_repository.d.ts","sourceRoot":"","sources":["../../../src/src/shared/base_repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAc,MAAM,eAAe,CAAC;AAG3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAIpD;;;;;;;;GAQG;AACH,qBAAa,cAAc,CAAC,SAAS,SAAS,SAAS;IACrD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;IAM3E,IAAI,MAAM,k0LAcT;IAED;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,EACd,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,EACzC,iBAAiB,EAAE,MAAM,GACxB,CAAC;CAgBL"}

package/script/src/shared/base_repository.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseRepository = void 0;
+const core_1 = require("@ts-rest/core");
+const api_error_js_1 = require("../errors/api_error.js");
+const uuid_1 = require("uuid");
+const index_js_1 = require("../features/auth/index.js");
+/**
+ * BaseRepository
+ *
+ * A generic base class to build repositories for interacting with the Afloat API.
+ * This class initializes a "ts-rest" client using a specified "ts-rest" contract and provides
+ * helper methods to handle API responses consistently.
+ *
+ * @template TContract - The API contract extending `AppRouter` from `@npm/ts_rest.ts`.
+ */
+class BaseRepository {
+    /**
+     * Constructs a new instance of `BaseRepository`.
+     *
+     * @param contract - The "ts-rest" contract
+     * @param endpoint - API endpoint
+     */
+    constructor(endpoint, contract, args) {
+        /**
+         * A "ts-rest" contract
+         *
+         * @protected
+         */
+        Object.defineProperty(this, "contract", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * An API endpoint
+         *
+         * @protected
+         */
+        Object.defineProperty(this, "endpoint", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * An API Root URL
+         *
+         * @protected
+         */
+        Object.defineProperty(this, "root", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.contract = contract;
+        this.endpoint = endpoint;
+        this.root = args?.root;
+    }
+    get client() {
+        const baseUrl = this.root
+            ? `${this.root}/${this.endpoint}`
+            : `https://api.afloat.money/v1/${this.endpoint}`;
+        const args = {
+            baseUrl,
+            baseHeaders: {
+                "token": index_js_1.AfloatAuth.instance.getUserToken() ?? "",
+                "x-request-id": (0, uuid_1.v4)(),
+            },
+        };
+        return (0, core_1.initClient)(this.contract, args);
+    }
+    /**
+     * Handles the API response by checking the HTTP status code and returning the response body
+     * for successful requests or throwing an `APIError` for errors.
+     *
+     * @template T - The expected type of the successful response body.
+     * @param result - The API response object containing the status code and response body.
+     * @param successStatusCode - The expected HTTP status code indicating success (e.g., 200, 201).
+     * @returns The response body typed as `T` if the status code matches the success criteria.
+     * @throws `APIError` - If the status code indicates a failure.
+     */
+    handleResponse(result, successStatusCode) {
+        if (successStatusCode === result.status) {
+            return result.body;
+        }
+        if (result.status === 400) {
+            throw new api_error_js_1.APIError(result.body);
+        }
+        throw new api_error_js_1.APIError({
+            message: "We encountered an error trying to process your request. Please try again later",
+            statusCode: 520,
+            error: "UNKNOWN ERROR",
+        });
+    }
+}
+exports.BaseRepository = BaseRepository;

package/script/src/shared/common_responses.d.ts

@@ -0,0 +1,13 @@
+import type { AppRouteResponse } from "@ts-rest/core";
+import { z } from "zod";
+type ApiErrorResponseSchemaType = z.ZodObject<{
+    statusCode: z.ZodNumber;
+    message: z.ZodString;
+    error: z.ZodString;
+    details: z.ZodOptional<z.ZodRecord>;
+}>;
+export declare const common400ResponseSchema: ApiErrorResponseSchemaType;
+export type Common400APIResponse = z.infer<typeof common400ResponseSchema>;
+export declare const commonAPIResponses: Record<number, AppRouteResponse>;
+export {};
+//# sourceMappingURL=common_responses.d.ts.map

package/script/src/shared/common_responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common_responses.d.ts","sourceRoot":"","sources":["../../../src/src/shared/common_responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,KAAK,0BAA0B,GAAG,CAAC,CAAC,SAAS,CAAC;IAC5C,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC;IACxB,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC,SAAS,CAAC;IACnB,OAAO,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;CACrC,CAAC,CAAC;AACH,eAAO,MAAM,uBAAuB,EAAE,0BAKpC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE3E,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAE/D,CAAC"}

package/script/src/shared/common_responses.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commonAPIResponses = exports.common400ResponseSchema = void 0;
+const zod_1 = require("zod");
+exports.common400ResponseSchema = zod_1.z.object({
+    statusCode: zod_1.z.number(),
+    message: zod_1.z.string(),
+    error: zod_1.z.string(),
+    details: zod_1.z.record(zod_1.z.string()).optional(),
+});
+exports.commonAPIResponses = {
+    400: exports.common400ResponseSchema,
+};

package/script/src/shared/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./common_responses.js";
+export * from "./base_repository.js";
+//# sourceMappingURL=index.d.ts.map

package/script/src/shared/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/src/shared/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC"}

package/script/src/shared/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common_responses.js"), exports);
+__exportStar(require("./base_repository.js"), exports);