express-typed-response 1.0.0

package/Readme.md

@@ -0,0 +1,19 @@
+# express-typed-response
+
+Typed and consistent API responses for Express.js.
+
+## Installation
+npm install express-typed-response
+
+## Usage
+
+```ts
+sendSuccess(res, {
+  message: "User created",
+  data: user
+});
+
+sendError(res, {
+  status: 401,
+  message: "Unauthorized"
+});

package/dist/index.cjs

@@ -0,0 +1,52 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  sendError: () => sendError,
+  sendSuccess: () => sendSuccess
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/success.ts
+function sendSuccess(res, options) {
+  const response = {
+    success: true,
+    message: options.message,
+    data: options.data,
+    meta: options.meta
+  };
+  return res.status(options.status ?? 200).json(response);
+}
+
+// src/error.ts
+function sendError(res, options) {
+  const response = {
+    success: false,
+    message: options.message,
+    error: options.error
+  };
+  return res.status(options.status ?? 500).json(response);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  sendError,
+  sendSuccess
+});

package/dist/index.d.cts

@@ -0,0 +1,31 @@
+import { Response } from 'express';
+
+interface SuccessResponse<T> {
+    success: true;
+    message: string;
+    data?: T;
+    meta?: Record<string, any>;
+}
+interface ErrorResponse {
+    success: false;
+    message: string;
+    error?: any;
+}
+type ExpressResponse = Response;
+
+interface SendSuccessOptions<T> {
+    status?: number;
+    message: string;
+    data?: T;
+    meta?: Record<string, any>;
+}
+declare function sendSuccess<T>(res: ExpressResponse, options: SendSuccessOptions<T>): ExpressResponse;
+
+interface SendErrorOptions {
+    status?: number;
+    message: string;
+    error?: any;
+}
+declare function sendError(res: ExpressResponse, options: SendErrorOptions): ExpressResponse;
+
+export { type ErrorResponse, type ExpressResponse, type SuccessResponse, sendError, sendSuccess };

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import { Response } from 'express';
+
+interface SuccessResponse<T> {
+    success: true;
+    message: string;
+    data?: T;
+    meta?: Record<string, any>;
+}
+interface ErrorResponse {
+    success: false;
+    message: string;
+    error?: any;
+}
+type ExpressResponse = Response;
+
+interface SendSuccessOptions<T> {
+    status?: number;
+    message: string;
+    data?: T;
+    meta?: Record<string, any>;
+}
+declare function sendSuccess<T>(res: ExpressResponse, options: SendSuccessOptions<T>): ExpressResponse;
+
+interface SendErrorOptions {
+    status?: number;
+    message: string;
+    error?: any;
+}
+declare function sendError(res: ExpressResponse, options: SendErrorOptions): ExpressResponse;
+
+export { type ErrorResponse, type ExpressResponse, type SuccessResponse, sendError, sendSuccess };

package/dist/index.js

@@ -0,0 +1,24 @@
+// src/success.ts
+function sendSuccess(res, options) {
+  const response = {
+    success: true,
+    message: options.message,
+    data: options.data,
+    meta: options.meta
+  };
+  return res.status(options.status ?? 200).json(response);
+}
+
+// src/error.ts
+function sendError(res, options) {
+  const response = {
+    success: false,
+    message: options.message,
+    error: options.error
+  };
+  return res.status(options.status ?? 500).json(response);
+}
+export {
+  sendError,
+  sendSuccess
+};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "express-typed-response",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsup src/index.ts --dts --format esm,cjs"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "devDependencies": {
+    "@types/express": "^5.0.6",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}