@pogodisco/response 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types/response";
+export * from "./utils/response";

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./types/response";
+export * from "./utils/response";

package/dist/types/response.d.ts

@@ -0,0 +1,23 @@
+export interface BaseResponse {
+    ok: boolean;
+    message: string;
+    status: number;
+    level: ResponseLevel;
+}
+export declare enum ResponseLevel {
+    SUCCESS = "success",
+    WARNING = "warning",
+    ERROR = "error"
+}
+export interface SuccessResponse<T> extends BaseResponse {
+    ok: true;
+    level: ResponseLevel.SUCCESS;
+    data: T;
+}
+export interface FailureResponse extends BaseResponse {
+    ok: false;
+    level: ResponseLevel.WARNING | ResponseLevel.ERROR;
+    error: string;
+    errors: Record<string, string[]> | null;
+}
+export type TResponse<T> = SuccessResponse<T> | FailureResponse;

package/dist/types/response.js

@@ -0,0 +1,6 @@
+export var ResponseLevel;
+(function (ResponseLevel) {
+    ResponseLevel["SUCCESS"] = "success";
+    ResponseLevel["WARNING"] = "warning";
+    ResponseLevel["ERROR"] = "error";
+})(ResponseLevel || (ResponseLevel = {}));

package/dist/utils/response.d.ts

@@ -0,0 +1,7 @@
+import { type BaseResponse, type FailureResponse, type SuccessResponse, TResponse } from "../types/response";
+export declare function newSuccessResponse<T>(data: T, opts?: Partial<Pick<BaseResponse, "message" | "status">>): SuccessResponse<T>;
+export declare function newFailureResponse(error: string, opts?: Partial<Pick<FailureResponse, "message" | "status" | "level" | "errors">>): FailureResponse;
+export declare function isFailure<T>(resp: TResponse<T>): resp is FailureResponse;
+export declare function isSuccess<T>(resp: TResponse<T>): resp is SuccessResponse<T>;
+export declare function assertResponse<T>(res: TResponse<T>, msg?: string): T;
+export declare function withResponse<Args extends any[], Return>(fn: (...args: Args) => Promise<Return> | Return, validate?: (result: Return) => boolean, failureMessage?: string): (...args: Args) => Promise<TResponse<Return>>;

package/dist/utils/response.js

@@ -0,0 +1,44 @@
+import { ResponseLevel, } from "../types/response";
+export function newSuccessResponse(data, opts) {
+    const { message = "", status = 200 } = opts ?? {};
+    return { ok: true, data, message, status, level: ResponseLevel.SUCCESS };
+}
+export function newFailureResponse(error, opts) {
+    const { message = "", errors = null, status = 400, level = ResponseLevel.ERROR, } = opts ?? {};
+    return { ok: false, error, errors, message, status, level };
+}
+export function isFailure(resp) {
+    return !resp.ok;
+}
+export function isSuccess(resp) {
+    return resp.ok;
+}
+export function assertResponse(res, msg) {
+    if (isFailure(res))
+        throw new Error(res.error || msg || "Unknown error");
+    return res.data;
+}
+export function withResponse(fn, validate, failureMessage) {
+    return async (...args) => {
+        try {
+            const result = await fn(...args);
+            const isOk = validate ? validate(result) : true;
+            return isOk
+                ? newSuccessResponse(result)
+                : newFailureResponse(failureMessage || "Operation failed", {
+                    status: 400,
+                });
+        }
+        catch (err) {
+            if (typeof err === "object" && err !== null) {
+                if ("ok" in err && err.ok === false && "error" in err) {
+                    return err;
+                }
+                return newFailureResponse(err.message || "Unknown error", {
+                    ...err,
+                });
+            }
+            return newFailureResponse(err?.toString() || "Unknown error");
+        }
+    };
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@pogodisco/response",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Jakub Bystroński",
+  "description": "unified response type across consumers",
+  "keywords": [
+    "typescript"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}