@budgetbuddyde/types 1.0.1 → 1.0.2

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/HttpStatusCode.type.d.ts

@@ -0,0 +1,26 @@
+export declare enum HTTPStatusCode {
+    Ok = 200,
+    Created = 201,
+    Accepted = 202,
+    NoContent = 204,
+    PartialContent = 206,
+    MultipleChoices = 300,
+    MovedPermanently = 301,
+    Found = 302,
+    BadRequest = 400,
+    Unauthorized = 401,
+    PaymentRequired = 402,
+    Forbidden = 403,
+    NotFound = 404,
+    MethodNotAllowed = 405,
+    RequestTimeout = 408,
+    Conflict = 409,
+    Gone = 410,
+    UnprocessableEntity = 422,
+    TooManyRequests = 429,
+    InternalServerError = 500,
+    NotImplemented = 501,
+    BadGateway = 502,
+    ServiceUnavailable = 503,
+    GatewayTiemout = 504
+}

package/lib/HttpStatusCode.type.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTPStatusCode = void 0;
+var HTTPStatusCode;
+(function (HTTPStatusCode) {
+    HTTPStatusCode[HTTPStatusCode["Ok"] = 200] = "Ok";
+    HTTPStatusCode[HTTPStatusCode["Created"] = 201] = "Created";
+    HTTPStatusCode[HTTPStatusCode["Accepted"] = 202] = "Accepted";
+    HTTPStatusCode[HTTPStatusCode["NoContent"] = 204] = "NoContent";
+    HTTPStatusCode[HTTPStatusCode["PartialContent"] = 206] = "PartialContent";
+    HTTPStatusCode[HTTPStatusCode["MultipleChoices"] = 300] = "MultipleChoices";
+    HTTPStatusCode[HTTPStatusCode["MovedPermanently"] = 301] = "MovedPermanently";
+    HTTPStatusCode[HTTPStatusCode["Found"] = 302] = "Found";
+    HTTPStatusCode[HTTPStatusCode["BadRequest"] = 400] = "BadRequest";
+    HTTPStatusCode[HTTPStatusCode["Unauthorized"] = 401] = "Unauthorized";
+    HTTPStatusCode[HTTPStatusCode["PaymentRequired"] = 402] = "PaymentRequired";
+    HTTPStatusCode[HTTPStatusCode["Forbidden"] = 403] = "Forbidden";
+    HTTPStatusCode[HTTPStatusCode["NotFound"] = 404] = "NotFound";
+    HTTPStatusCode[HTTPStatusCode["MethodNotAllowed"] = 405] = "MethodNotAllowed";
+    HTTPStatusCode[HTTPStatusCode["RequestTimeout"] = 408] = "RequestTimeout";
+    HTTPStatusCode[HTTPStatusCode["Conflict"] = 409] = "Conflict";
+    HTTPStatusCode[HTTPStatusCode["Gone"] = 410] = "Gone";
+    HTTPStatusCode[HTTPStatusCode["UnprocessableEntity"] = 422] = "UnprocessableEntity";
+    HTTPStatusCode[HTTPStatusCode["TooManyRequests"] = 429] = "TooManyRequests";
+    HTTPStatusCode[HTTPStatusCode["InternalServerError"] = 500] = "InternalServerError";
+    HTTPStatusCode[HTTPStatusCode["NotImplemented"] = 501] = "NotImplemented";
+    HTTPStatusCode[HTTPStatusCode["BadGateway"] = 502] = "BadGateway";
+    HTTPStatusCode[HTTPStatusCode["ServiceUnavailable"] = 503] = "ServiceUnavailable";
+    HTTPStatusCode[HTTPStatusCode["GatewayTiemout"] = 504] = "GatewayTiemout";
+})(HTTPStatusCode = exports.HTTPStatusCode || (exports.HTTPStatusCode = {}));

package/lib/index.d.ts

@@ -9,3 +9,4 @@ export * from './Subscription.type';
 export * from './Budget.type';
 export * from './DailyTransaction.type';
 export * from './Role.type';
+export * from './HttpStatusCode.type';

package/lib/index.js

@@ -25,3 +25,4 @@ __exportStar(require("./Subscription.type"), exports);
 __exportStar(require("./Budget.type"), exports);
 __exportStar(require("./DailyTransaction.type"), exports);
 __exportStar(require("./Role.type"), exports);
+__exportStar(require("./HttpStatusCode.type"), exports);

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@budgetbuddyde/types",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "description": "BudgetBuddy Typescript Types",
+  "description": "Budget Buddy Typescript Types",
   "keywords": [
     "typescript",
     "types",
@@ -16,10 +16,10 @@
   },
   "author": "Thorben",
   "license": "MIT",
-  "homepage": "https://github.com/BudegtBuddyDE",
+  "homepage": "https://github.com/BudgetBuddyDE",
   "repository": {
     "type": "git",
-    "url": "https://github.com/BudegtBuddyDE/types.git"
+    "url": "https://github.com/BudgetBuddyDE/types.git"
   },
   "bugs": {
     "url": "https://github.com/BudgetBuddyDE/types/issues"