@budgetbuddyde/types 1.0.1 → 1.0.3

package/lib/ApiResponse.type.d.ts

@@ -1,9 +1,68 @@
+import { HTTPStatusCode } from './HttpStatusCode.type';
+/**
+ * @deprecated Use ApiResponse and ApiResponseBuilder instead.
+ */
 export type TApiResponse<T> = {
-    status: 200;
+    status: 200 | HTTPStatusCode.Ok;
     message: null;
     data: T | null;
 } & {
-    status: number;
+    status: number | HTTPStatusCode;
     message: string | null;
     data: T | null;
 };
+/**
+ * Represents an API response.
+ * @template T - The type of the data in the response.
+ *
+ * Usage
+ * ```typescript
+ * const response: ApiResponse<string> = ApiResponse
+ *   .builder<string>()
+ *   .withStatus(200)
+ *   .withMessage('Hello World')
+ *   .withData('Hello World')
+ *   .build();
+ * ```
+ */
+export declare class ApiResponse<T> {
+    status: number | HTTPStatusCode;
+    message: string | null;
+    data: T | null;
+    private constructor();
+    /**
+     * Creates a new instance of ApiResponseBuilder.
+     * @returns An instance of ApiResponseBuilder.
+     */
+    static builder<T>(): ApiResponseBuilder<T>;
+}
+/**
+ * Builder class for ApiResponse.
+ * @template T - The type of the data in the response.
+ */
+export declare class ApiResponseBuilder<T> {
+    private response;
+    /**
+     * Sets the status of the API response.
+     * @param status - The status code.
+     * @returns The ApiResponseBuilder instance.
+     */
+    withStatus(status: number | HTTPStatusCode): ApiResponseBuilder<T>;
+    /**
+     * Sets the message of the API response.
+     * @param message - The message.
+     * @returns The ApiResponseBuilder instance.
+     */
+    withMessage(message: string | null): ApiResponseBuilder<T>;
+    /**
+     * Sets the data of the API response.
+     * @param data - The data.
+     * @returns The ApiResponseBuilder instance.
+     */
+    withData(data: T | null): ApiResponseBuilder<T>;
+    /**
+     * Builds the API response.
+     * @returns The built ApiResponse instance.
+     */
+    build(): ApiResponse<T>;
+}

package/lib/ApiResponse.type.js

@@ -1,2 +1,77 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiResponseBuilder = exports.ApiResponse = void 0;
+/**
+ * Represents an API response.
+ * @template T - The type of the data in the response.
+ *
+ * Usage
+ * ```typescript
+ * const response: ApiResponse<string> = ApiResponse
+ *   .builder<string>()
+ *   .withStatus(200)
+ *   .withMessage('Hello World')
+ *   .withData('Hello World')
+ *   .build();
+ * ```
+ */
+class ApiResponse {
+    constructor() {
+        this.status = 200;
+        this.message = null;
+        this.data = null;
+    }
+    /**
+     * Creates a new instance of ApiResponseBuilder.
+     * @returns An instance of ApiResponseBuilder.
+     */
+    static builder() {
+        return new ApiResponseBuilder();
+    }
+}
+exports.ApiResponse = ApiResponse;
+/**
+ * Builder class for ApiResponse.
+ * @template T - The type of the data in the response.
+ */
+class ApiResponseBuilder {
+    constructor() {
+        // @ts-expect-error can be private, because it can be accessed via the build method
+        this.response = new ApiResponse();
+    }
+    /**
+     * Sets the status of the API response.
+     * @param status - The status code.
+     * @returns The ApiResponseBuilder instance.
+     */
+    withStatus(status) {
+        this.response.status = status;
+        return this;
+    }
+    /**
+     * Sets the message of the API response.
+     * @param message - The message.
+     * @returns The ApiResponseBuilder instance.
+     */
+    withMessage(message) {
+        this.response.message = message;
+        return this;
+    }
+    /**
+     * Sets the data of the API response.
+     * @param data - The data.
+     * @returns The ApiResponseBuilder instance.
+     */
+    withData(data) {
+        this.response.data = data;
+        return this;
+    }
+    /**
+     * Builds the API response.
+     * @returns The built ApiResponse instance.
+     */
+    build() {
+        return this.response;
+    }
+}
+exports.ApiResponseBuilder = ApiResponseBuilder;

package/lib/Budget.type.d.ts

@@ -281,14 +281,371 @@ export declare const ZUpdateBudgetPayload: z.ZodObject<{
     budgetId: number;
 }>;
 export type TUpdateBudgetPayload = z.infer<typeof ZUpdateBudgetPayload>;
-export declare const ZDeleteBudgetPayload: z.ZodObject<{
+export declare const ZDeleteBudgetPayload: z.ZodArray<z.ZodObject<{
     budgetId: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     budgetId: number;
 }, {
     budgetId: number;
-}>;
+}>, "many">;
 export type TDeleteBudgetPayload = z.infer<typeof ZDeleteBudgetPayload>;
+export declare const ZDeleteBudgetResponsePayload: z.ZodObject<{
+    success: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        category: z.ZodObject<{
+            id: z.ZodNumber;
+            owner: z.ZodObject<{
+                uuid: z.ZodString;
+                isVerified: z.ZodDefault<z.ZodBoolean>;
+                role: z.ZodObject<{
+                    id: z.ZodNumber;
+                    name: z.ZodString;
+                    description: z.ZodDefault<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>>;
+                    permissions: z.ZodNumber;
+                    createdAt: z.ZodEffects<z.ZodUnion<[z.ZodDate, z.ZodNumber]>, Date, number | Date>;
+                }, "strip", z.ZodTypeAny, {
+                    id: number;
+                    name: string;
+                    description: string | null;
+                    permissions: number;
+                    createdAt: Date;
+                }, {
+                    id: number;
+                    name: string;
+                    permissions: number;
+                    createdAt: (number | Date) & (number | Date | undefined);
+                    description?: string | null | undefined;
+                }>;
+                email: z.ZodString;
+                name: z.ZodString;
+                surname: z.ZodString;
+                password: z.ZodString;
+                createdAt: z.ZodEffects<z.ZodUnion<[z.ZodDate, z.ZodNumber]>, Date, number | Date>;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    description: string | null;
+                    permissions: number;
+                    createdAt: Date;
+                };
+                email: string;
+                uuid: string;
+                createdAt: Date;
+                isVerified: boolean;
+                surname: string;
+                password: string;
+            }, {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    permissions: number;
+                    createdAt: (number | Date) & (number | Date | undefined);
+                    description?: string | null | undefined;
+                };
+                email: string;
+                uuid: string;
+                createdAt: (number | Date) & (number | Date | undefined);
+                surname: string;
+                password: string;
+                isVerified?: boolean | undefined;
+            }>;
+            name: z.ZodString;
+            description: z.ZodDefault<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>>;
+            createdAt: z.ZodEffects<z.ZodUnion<[z.ZodDate, z.ZodNumber]>, Date, number | Date>;
+        }, "strip", z.ZodTypeAny, {
+            id: number;
+            name: string;
+            description: string | null;
+            createdAt: Date;
+            owner: {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    description: string | null;
+                    permissions: number;
+                    createdAt: Date;
+                };
+                email: string;
+                uuid: string;
+                createdAt: Date;
+                isVerified: boolean;
+                surname: string;
+                password: string;
+            };
+        }, {
+            id: number;
+            name: string;
+            createdAt: (number | Date) & (number | Date | undefined);
+            owner: {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    permissions: number;
+                    createdAt: (number | Date) & (number | Date | undefined);
+                    description?: string | null | undefined;
+                };
+                email: string;
+                uuid: string;
+                createdAt: (number | Date) & (number | Date | undefined);
+                surname: string;
+                password: string;
+                isVerified?: boolean | undefined;
+            };
+            description?: string | null | undefined;
+        }>;
+        owner: z.ZodObject<{
+            uuid: z.ZodString;
+            isVerified: z.ZodDefault<z.ZodBoolean>;
+            role: z.ZodObject<{
+                id: z.ZodNumber;
+                name: z.ZodString;
+                description: z.ZodDefault<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>>;
+                permissions: z.ZodNumber;
+                createdAt: z.ZodEffects<z.ZodUnion<[z.ZodDate, z.ZodNumber]>, Date, number | Date>;
+            }, "strip", z.ZodTypeAny, {
+                id: number;
+                name: string;
+                description: string | null;
+                permissions: number;
+                createdAt: Date;
+            }, {
+                id: number;
+                name: string;
+                permissions: number;
+                createdAt: (number | Date) & (number | Date | undefined);
+                description?: string | null | undefined;
+            }>;
+            email: z.ZodString;
+            name: z.ZodString;
+            surname: z.ZodString;
+            password: z.ZodString;
+            createdAt: z.ZodEffects<z.ZodUnion<[z.ZodDate, z.ZodNumber]>, Date, number | Date>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            role: {
+                id: number;
+                name: string;
+                description: string | null;
+                permissions: number;
+                createdAt: Date;
+            };
+            email: string;
+            uuid: string;
+            createdAt: Date;
+            isVerified: boolean;
+            surname: string;
+            password: string;
+        }, {
+            name: string;
+            role: {
+                id: number;
+                name: string;
+                permissions: number;
+                createdAt: (number | Date) & (number | Date | undefined);
+                description?: string | null | undefined;
+            };
+            email: string;
+            uuid: string;
+            createdAt: (number | Date) & (number | Date | undefined);
+            surname: string;
+            password: string;
+            isVerified?: boolean | undefined;
+        }>;
+        budget: z.ZodNumber;
+        createdAt: z.ZodEffects<z.ZodUnion<[z.ZodDate, z.ZodNumber]>, Date, number | Date>;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+        createdAt: Date;
+        owner: {
+            name: string;
+            role: {
+                id: number;
+                name: string;
+                description: string | null;
+                permissions: number;
+                createdAt: Date;
+            };
+            email: string;
+            uuid: string;
+            createdAt: Date;
+            isVerified: boolean;
+            surname: string;
+            password: string;
+        };
+        category: {
+            id: number;
+            name: string;
+            description: string | null;
+            createdAt: Date;
+            owner: {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    description: string | null;
+                    permissions: number;
+                    createdAt: Date;
+                };
+                email: string;
+                uuid: string;
+                createdAt: Date;
+                isVerified: boolean;
+                surname: string;
+                password: string;
+            };
+        };
+        budget: number;
+    }, {
+        id: number;
+        createdAt: (number | Date) & (number | Date | undefined);
+        owner: {
+            name: string;
+            role: {
+                id: number;
+                name: string;
+                permissions: number;
+                createdAt: (number | Date) & (number | Date | undefined);
+                description?: string | null | undefined;
+            };
+            email: string;
+            uuid: string;
+            createdAt: (number | Date) & (number | Date | undefined);
+            surname: string;
+            password: string;
+            isVerified?: boolean | undefined;
+        };
+        category: {
+            id: number;
+            name: string;
+            createdAt: (number | Date) & (number | Date | undefined);
+            owner: {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    permissions: number;
+                    createdAt: (number | Date) & (number | Date | undefined);
+                    description?: string | null | undefined;
+                };
+                email: string;
+                uuid: string;
+                createdAt: (number | Date) & (number | Date | undefined);
+                surname: string;
+                password: string;
+                isVerified?: boolean | undefined;
+            };
+            description?: string | null | undefined;
+        };
+        budget: number;
+    }>, "many">;
+    failed: z.ZodArray<z.ZodArray<z.ZodObject<{
+        budgetId: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        budgetId: number;
+    }, {
+        budgetId: number;
+    }>, "many">, "many">;
+}, "strip", z.ZodTypeAny, {
+    failed: {
+        budgetId: number;
+    }[][];
+    success: {
+        id: number;
+        createdAt: Date;
+        owner: {
+            name: string;
+            role: {
+                id: number;
+                name: string;
+                description: string | null;
+                permissions: number;
+                createdAt: Date;
+            };
+            email: string;
+            uuid: string;
+            createdAt: Date;
+            isVerified: boolean;
+            surname: string;
+            password: string;
+        };
+        category: {
+            id: number;
+            name: string;
+            description: string | null;
+            createdAt: Date;
+            owner: {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    description: string | null;
+                    permissions: number;
+                    createdAt: Date;
+                };
+                email: string;
+                uuid: string;
+                createdAt: Date;
+                isVerified: boolean;
+                surname: string;
+                password: string;
+            };
+        };
+        budget: number;
+    }[];
+}, {
+    failed: {
+        budgetId: number;
+    }[][];
+    success: {
+        id: number;
+        createdAt: (number | Date) & (number | Date | undefined);
+        owner: {
+            name: string;
+            role: {
+                id: number;
+                name: string;
+                permissions: number;
+                createdAt: (number | Date) & (number | Date | undefined);
+                description?: string | null | undefined;
+            };
+            email: string;
+            uuid: string;
+            createdAt: (number | Date) & (number | Date | undefined);
+            surname: string;
+            password: string;
+            isVerified?: boolean | undefined;
+        };
+        category: {
+            id: number;
+            name: string;
+            createdAt: (number | Date) & (number | Date | undefined);
+            owner: {
+                name: string;
+                role: {
+                    id: number;
+                    name: string;
+                    permissions: number;
+                    createdAt: (number | Date) & (number | Date | undefined);
+                    description?: string | null | undefined;
+                };
+                email: string;
+                uuid: string;
+                createdAt: (number | Date) & (number | Date | undefined);
+                surname: string;
+                password: string;
+                isVerified?: boolean | undefined;
+            };
+            description?: string | null | undefined;
+        };
+        budget: number;
+    }[];
+}>;
+export type TDeleteBudgetResponsePayload = z.infer<typeof ZDeleteBudgetResponsePayload>;
 export declare const ZBudgetProgress: z.ZodObject<{
     id: z.ZodNumber;
     createdAt: z.ZodEffects<z.ZodUnion<[z.ZodDate, z.ZodNumber]>, Date, number | Date>;

package/lib/Budget.type.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZBudgetProgress = exports.ZDeleteBudgetPayload = exports.ZUpdateBudgetPayload = exports.ZCreateBudgetPayload = exports.ZBudget = void 0;
+exports.ZBudgetProgress = exports.ZDeleteBudgetResponsePayload = exports.ZDeleteBudgetPayload = exports.ZUpdateBudgetPayload = exports.ZCreateBudgetPayload = exports.ZBudget = void 0;
 const zod_1 = require("zod");
 const Category_type_1 = require("./Category.type");
 const User_type_1 = require("./User.type");
@@ -23,8 +23,12 @@ exports.ZUpdateBudgetPayload = zod_1.z.object({
     categoryId: zod_1.z.number(),
     budget: ZBudgetAmount,
 });
-exports.ZDeleteBudgetPayload = zod_1.z.object({
+exports.ZDeleteBudgetPayload = zod_1.z.array(zod_1.z.object({
     budgetId: zod_1.z.number(),
+}));
+exports.ZDeleteBudgetResponsePayload = zod_1.z.object({
+    success: zod_1.z.array(exports.ZBudget),
+    failed: zod_1.z.array(exports.ZDeleteBudgetPayload),
 });
 exports.ZBudgetProgress = exports.ZBudget.extend({
     amount_spent: zod_1.z.number(),