@budgetbuddyde/api 0.1.0

package/lib/types/schemas/transaction.schema.d.ts

@@ -0,0 +1,207 @@
+import z from "zod";
+export declare const Transaction: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodUUID, "TransactionID">;
+    ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+    categoryId: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+    paymentMethodId: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+    processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+    receiver: z.ZodString;
+    transferAmount: z.ZodNumber;
+    information: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export declare const ExpandedTransaction: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodUUID, "TransactionID">;
+    ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+    processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+    receiver: z.ZodString;
+    transferAmount: z.ZodNumber;
+    information: z.ZodNullable<z.ZodString>;
+    category: z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+        ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+        name: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+    paymentMethod: z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+        ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+        name: z.ZodString;
+        provider: z.ZodString;
+        address: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const CreateOrUpdateTransactionPayload: z.ZodObject<{
+    categoryId: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+    paymentMethodId: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+    processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+    receiver: z.ZodString;
+    transferAmount: z.ZodNumber;
+    information: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export declare const ReceiverVH: z.ZodObject<{
+    receiver: z.ZodString;
+}, z.core.$strip>;
+export declare const GetAllTransactionsResponse: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    totalCount: z.ZodOptional<z.ZodNumber>;
+    from: z.ZodOptional<z.ZodEnum<{
+        db: "db";
+        cache: "cache";
+        external: "external";
+    }>>;
+    data: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodUUID, "TransactionID">;
+        ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+        receiver: z.ZodString;
+        transferAmount: z.ZodNumber;
+        information: z.ZodNullable<z.ZodString>;
+        category: z.ZodObject<{
+            id: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+            ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+            name: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            createdAt: z.ZodISODateTime;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+        paymentMethod: z.ZodObject<{
+            id: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+            ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+            name: z.ZodString;
+            provider: z.ZodString;
+            address: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            createdAt: z.ZodISODateTime;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const GetTransactionResponse: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    totalCount: z.ZodOptional<z.ZodNumber>;
+    from: z.ZodOptional<z.ZodEnum<{
+        db: "db";
+        cache: "cache";
+        external: "external";
+    }>>;
+    data: z.ZodNullable<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodUUID, "TransactionID">;
+        ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+        processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+        receiver: z.ZodString;
+        transferAmount: z.ZodNumber;
+        information: z.ZodNullable<z.ZodString>;
+        category: z.ZodObject<{
+            id: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+            ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+            name: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            createdAt: z.ZodISODateTime;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+        paymentMethod: z.ZodObject<{
+            id: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+            ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+            name: z.ZodString;
+            provider: z.ZodString;
+            address: z.ZodString;
+            description: z.ZodNullable<z.ZodString>;
+            createdAt: z.ZodISODateTime;
+            updatedAt: z.ZodISODateTime;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const CreateTransactionResponse: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    totalCount: z.ZodOptional<z.ZodNumber>;
+    from: z.ZodOptional<z.ZodEnum<{
+        db: "db";
+        cache: "cache";
+        external: "external";
+    }>>;
+    data: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodUUID, "TransactionID">;
+        ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+        categoryId: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+        paymentMethodId: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+        processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+        receiver: z.ZodString;
+        transferAmount: z.ZodNumber;
+        information: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const UpdateTransactionResponse: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    totalCount: z.ZodOptional<z.ZodNumber>;
+    from: z.ZodOptional<z.ZodEnum<{
+        db: "db";
+        cache: "cache";
+        external: "external";
+    }>>;
+    data: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodUUID, "TransactionID">;
+        ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+        categoryId: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+        paymentMethodId: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+        processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+        receiver: z.ZodString;
+        transferAmount: z.ZodNumber;
+        information: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const DeleteTransactionResponse: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    totalCount: z.ZodOptional<z.ZodNumber>;
+    from: z.ZodOptional<z.ZodEnum<{
+        db: "db";
+        cache: "cache";
+        external: "external";
+    }>>;
+    data: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodUUID, "TransactionID">;
+        ownerId: z.core.$ZodBranded<z.ZodString, "UserID">;
+        categoryId: z.core.$ZodBranded<z.ZodUUID, "CategoryID">;
+        paymentMethodId: z.core.$ZodBranded<z.ZodUUID, "PaymentMethodID">;
+        processedAt: z.ZodUnion<[z.ZodISODateTime, z.ZodDate]>;
+        receiver: z.ZodString;
+        transferAmount: z.ZodNumber;
+        information: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodISODateTime;
+        updatedAt: z.ZodISODateTime;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const ReceiverVHResponse: z.ZodObject<{
+    status: z.ZodNumber;
+    message: z.ZodOptional<z.ZodString>;
+    totalCount: z.ZodOptional<z.ZodNumber>;
+    from: z.ZodOptional<z.ZodEnum<{
+        db: "db";
+        cache: "cache";
+        external: "external";
+    }>>;
+    data: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        receiver: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;

package/lib/types/schemas/transaction.schema.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReceiverVHResponse = exports.DeleteTransactionResponse = exports.UpdateTransactionResponse = exports.CreateTransactionResponse = exports.GetTransactionResponse = exports.GetAllTransactionsResponse = exports.ReceiverVH = exports.CreateOrUpdateTransactionPayload = exports.ExpandedTransaction = exports.Transaction = void 0;
+const zod_1 = __importDefault(require("zod"));
+const category_schema_1 = require("./category.schema");
+const common_schema_1 = require("./common.schema");
+const paymentMethod_schema_1 = require("./paymentMethod.schema");
+exports.Transaction = zod_1.default.object({
+    id: zod_1.default.uuid().brand("TransactionID"),
+    ownerId: common_schema_1.UserID,
+    categoryId: category_schema_1.Category.shape.id,
+    paymentMethodId: paymentMethod_schema_1.PaymentMethod.shape.id,
+    processedAt: zod_1.default.iso.datetime().or(zod_1.default.date()),
+    receiver: zod_1.default.string(),
+    transferAmount: zod_1.default.number(),
+    information: zod_1.default.string().nullable(),
+    createdAt: zod_1.default.iso.datetime(),
+    updatedAt: zod_1.default.iso.datetime(),
+});
+exports.ExpandedTransaction = exports.Transaction.omit({
+    categoryId: true,
+    paymentMethodId: true,
+}).extend({
+    category: category_schema_1.Category,
+    paymentMethod: paymentMethod_schema_1.PaymentMethod,
+});
+// export const CreateTransactionPayload = Transaction.pick({
+// 	categoryId: true,
+// 	paymentMethodId: true,
+// 	processedAt: true,
+// 	receiver: true,
+// 	transferAmount: true,
+// 	information: true,
+// }).extend({
+// 	information: Transaction.shape.information.optional(),
+// });
+// export const UpdateTransactionPayload = Transaction.pick({
+// 	categoryId: true,
+// 	paymentMethodId: true,
+// 	processedAt: true,
+// 	receiver: true,
+// 	transferAmount: true,
+// 	information: true,
+// }).extend({
+// 	information: Transaction.shape.information.optional(),
+// });
+exports.CreateOrUpdateTransactionPayload = exports.Transaction.pick({
+    categoryId: true,
+    paymentMethodId: true,
+    processedAt: true,
+    receiver: true,
+    transferAmount: true,
+    information: true,
+}).extend({
+    information: exports.Transaction.shape.information.optional(),
+});
+exports.ReceiverVH = exports.Transaction.pick({
+    receiver: true,
+});
+exports.GetAllTransactionsResponse = common_schema_1.ApiResponse.extend({
+    data: zod_1.default.array(exports.ExpandedTransaction).nullable(),
+});
+exports.GetTransactionResponse = common_schema_1.ApiResponse.extend({
+    data: exports.ExpandedTransaction.nullable(),
+});
+exports.CreateTransactionResponse = common_schema_1.ApiResponse.extend({
+    data: zod_1.default.array(exports.Transaction).nullable(),
+});
+exports.UpdateTransactionResponse = exports.CreateTransactionResponse;
+exports.DeleteTransactionResponse = exports.CreateTransactionResponse;
+exports.ReceiverVHResponse = common_schema_1.ApiResponse.extend({
+    data: zod_1.default.array(exports.ReceiverVH).nullable(),
+});

package/lib/types/transaction.type.d.ts

@@ -0,0 +1,6 @@
+import type { TypeOfSchema } from "./common";
+import type * as schema from "./schemas/transaction.schema";
+export type TTransaction = TypeOfSchema<typeof schema.Transaction>;
+export type TExpandedTransaction = TypeOfSchema<typeof schema.ExpandedTransaction>;
+export type TCreateOrUpdateTransactionPayload = TypeOfSchema<typeof schema.CreateOrUpdateTransactionPayload>;
+export type TReceiverVH = TypeOfSchema<typeof schema.ReceiverVH>;

package/lib/types/transaction.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,144 @@
+{
+  "name": "@budgetbuddyde/api",
+  "version": "0.1.0",
+  "description": "",
+  "keywords": [],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "author": "Thorben",
+  "license": "MIT",
+  "homepage": "https://github.com/BudgetBuddyDE/BudgetBuddyDE",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BudgetBuddyDE/BudgetBuddyDE.git"
+  },
+  "bugs": {
+    "url": "https://github.com/BudgetBuddyDE/BudgetBuddyDE/issues"
+  },
+  "scripts": {
+    "build": "rimraf lib && tsc",
+    "pretest": "npm run check",
+    "test": "vitest run --silent",
+    "test:watch": "vitest",
+    "check": "biome check --error-on-warnings",
+    "check:write": "npm run check -- --write --unsafe",
+    "lint": "biome lint --write",
+    "format": "biome format --write"
+  },
+  "peerDependencies": {
+    "zod": "^4.1.12"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.0",
+    "@vitest/ui": "^3.2.4",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "dev-source": "./src/index.ts",
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./api": {
+      "dev-source": "./src/api.ts",
+      "types": "./lib/api.d.ts",
+      "default": "./lib/api.js"
+    },
+    "./client": {
+      "dev-source": "./src/api.ts",
+      "types": "./lib/api.d.ts",
+      "default": "./lib/api.js"
+    },
+    "./types": {
+      "dev-source": "./src/types/index.ts",
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/types/index.js"
+    },
+    "./interfaces": {
+      "dev-source": "./src/types/interfaces/index.ts",
+      "types": "./lib/types/interfaces/index.d.ts",
+      "default": "./lib/types/interfaces/index.js"
+    },
+    "./schemas": {
+      "dev-source": "./src/types/schemas/index.ts",
+      "types": "./lib/types/schemas/index.d.ts",
+      "default": "./lib/types/schemas/index.js"
+    },
+    "./error": {
+      "dev-source": "./src/error.ts",
+      "types": "./lib/error.d.ts",
+      "default": "./lib/error.js"
+    },
+    "./category": {
+      "dev-source": "./src/category.ts",
+      "types": "./lib/category.d.ts",
+      "default": "./lib/category.js"
+    },
+    "./paymentMethod": {
+      "dev-source": "./src/paymentMethod.ts",
+      "types": "./lib/paymentMethod.d.ts",
+      "default": "./lib/paymentMethod.js"
+    },
+    "./budget": {
+      "dev-source": "./src/budget.ts",
+      "types": "./lib/budget.d.ts",
+      "default": "./lib/budget.js"
+    },
+    "./transaction": {
+      "dev-source": "./src/transaction.ts",
+      "types": "./lib/transaction.d.ts",
+      "default": "./lib/transaction.js"
+    },
+    "./recurringPayment": {
+      "dev-source": "./src/recurringPayment.ts",
+      "types": "./lib/recurringPayment.d.ts",
+      "default": "./lib/recurringPayment.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./lib/index.d.js"
+      ],
+      "api": [
+        "./lib/api.d.ts"
+      ],
+      "client": [
+        "./lib/api.d.ts"
+      ],
+      "types": [
+        "./lib/types/index.d.ts"
+      ],
+      "interfaces": [
+        "./lib/types/interfaces/index.d.ts"
+      ],
+      "schemas": [
+        "./lib/types/schemas/index.d.ts"
+      ],
+      "error": [
+        "./lib/error.d.ts"
+      ],
+      "category": [ 
+        "./lib/category.d.ts"
+      ],
+      "paymentMethod": [
+        "./lib/paymentMethod.d.ts"
+      ],
+      "budget": [
+        "./lib/budget.d.ts"
+      ],
+      "transaction": [
+        "./lib/transaction.d.ts"
+      ],
+      "recurringPayment": [
+        "./lib/recurringPayment.d.ts"
+      ]
+    }
+  }
+}