@naman_deep_singh/http-response 3.3.3 → 3.3.4

package/README.md

@@ -1,6 +1,6 @@
 # @naman_deep_singh/http-response
 
-**Version:** 3.3.3
+**Version:** 3.3.4
 
 A flexible, framework-agnostic **TypeScript response utility library** for building consistent, typed, and configurable API responses.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naman_deep_singh/http-response",
-  "version": "3.3.3",
+  "version": "3.3.4",
   "description": "TypeScript utilities for standardized API responses",
   "author": "Naman Deep Singh",
   "license": "MIT",
@@ -60,6 +60,7 @@
   "scripts": {
     "build": "pnpm run build:types && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json",
     "build:types": "tsc -p tsconfig.types.json",
-    "clean": "rimraf dist"
+    "clean": "rimraf dist",
+    "clean:js": "find src -type f -name '*.js' -delete"
   }
 }

package/dist/cjs/adapters/express/ExpressResponder.d.ts

@@ -1,18 +0,0 @@
-import type { Response } from 'express';
-import { BaseResponder } from '../../core/BaseResponder.js';
-import type { ResponderConfig } from '../../core/config.js';
-export declare class ExpressResponder<P = unknown> extends BaseResponder<P> {
-    private readonly res;
-    constructor(cfg: Partial<ResponderConfig> | undefined, res: Response);
-    okAndSend(data?: P, message?: string): void;
-    createdAndSend(data?: P, message?: string): void;
-    badRequestAndSend(message?: string, error?: unknown): void;
-    unauthorizedAndSend(message?: string): void;
-    forbiddenAndSend(message?: string): void;
-    notFoundAndSend(message?: string): void;
-    conflictAndSend(message?: string): void;
-    unprocessableEntityAndSend(message?: string, error?: unknown): void;
-    tooManyRequestsAndSend(message?: string): void;
-    serverErrorAndSend(message?: string, error?: unknown): void;
-    paginateAndSend(data: P[], page: number, limit: number, total: number, message?: string): void;
-}

package/dist/cjs/adapters/express/index.d.ts

@@ -1 +0,0 @@
-export * from './ExpressResponder.js';

package/dist/cjs/adapters/index.d.ts

@@ -1 +0,0 @@
-export * from './express/index.js';

package/dist/cjs/constants/httpStatus.d.ts

@@ -1,54 +0,0 @@
-declare const SUCCESS: Readonly<{
-    readonly OK: 200;
-    readonly CREATED: 201;
-    readonly ACCEPTED: 202;
-    readonly NO_CONTENT: 204;
-}>;
-declare const REDIRECTION: Readonly<{
-    readonly NOT_MODIFIED: 304;
-}>;
-declare const CLIENT_ERROR: Readonly<{
-    readonly BAD_REQUEST: 400;
-    readonly UNAUTHORIZED: 401;
-    readonly FORBIDDEN: 403;
-    readonly NOT_FOUND: 404;
-    readonly METHOD_NOT_ALLOWED: 405;
-    readonly CONFLICT: 409;
-    readonly UNPROCESSABLE_ENTITY: 422;
-    readonly TOO_MANY_REQUESTS: 429;
-}>;
-declare const SERVER_ERROR: Readonly<{
-    readonly INTERNAL_SERVER_ERROR: 500;
-    readonly NOT_IMPLEMENTED: 501;
-    readonly BAD_GATEWAY: 502;
-    readonly SERVICE_UNAVAILABLE: 503;
-}>;
-export declare const HTTP_STATUS: Readonly<{
-    readonly SUCCESS: Readonly<{
-        readonly OK: 200;
-        readonly CREATED: 201;
-        readonly ACCEPTED: 202;
-        readonly NO_CONTENT: 204;
-    }>;
-    readonly REDIRECTION: Readonly<{
-        readonly NOT_MODIFIED: 304;
-    }>;
-    readonly CLIENT_ERROR: Readonly<{
-        readonly BAD_REQUEST: 400;
-        readonly UNAUTHORIZED: 401;
-        readonly FORBIDDEN: 403;
-        readonly NOT_FOUND: 404;
-        readonly METHOD_NOT_ALLOWED: 405;
-        readonly CONFLICT: 409;
-        readonly UNPROCESSABLE_ENTITY: 422;
-        readonly TOO_MANY_REQUESTS: 429;
-    }>;
-    readonly SERVER_ERROR: Readonly<{
-        readonly INTERNAL_SERVER_ERROR: 500;
-        readonly NOT_IMPLEMENTED: 501;
-        readonly BAD_GATEWAY: 502;
-        readonly SERVICE_UNAVAILABLE: 503;
-    }>;
-}>;
-export type HttpStatusCode = (typeof SUCCESS)[keyof typeof SUCCESS] | (typeof REDIRECTION)[keyof typeof REDIRECTION] | (typeof CLIENT_ERROR)[keyof typeof CLIENT_ERROR] | (typeof SERVER_ERROR)[keyof typeof SERVER_ERROR];
-export {};

package/dist/cjs/constants/index.d.ts

@@ -1 +0,0 @@
-export * from './httpStatus.js';

package/dist/cjs/core/BaseResponder.d.ts

@@ -1,31 +0,0 @@
-import { type ResponderConfig } from './config.js';
-import type { PaginationMeta, ResponseEnvelope, Sender } from './types.js';
-export declare class BaseResponder<P = unknown, M = PaginationMeta> {
-    protected readonly cfg: ResponderConfig;
-    protected sender?: Sender;
-    constructor(cfg?: Partial<ResponderConfig>, sender?: Sender);
-    attachSender(sender: Sender): void;
-    protected normalizeError(err: unknown): {
-        message: string;
-        code?: string;
-        details?: unknown;
-    };
-    protected buildEnvelope(data?: P, message?: string, error?: unknown, meta?: M): ResponseEnvelope<P, M>;
-    protected send(status: number, envelope: ResponseEnvelope<P, M>): any;
-    /** -----------------------------
-     *  Standard REST Response Helpers
-     * ----------------------------- */
-    ok(data?: P, message?: string): any;
-    created(data?: P, message?: string): any;
-    noContent(message?: string): any;
-    badRequest(message?: string, error?: unknown): any;
-    unauthorized(message?: string): any;
-    forbidden(message?: string): any;
-    notFound(message?: string): any;
-    conflict(message?: string): any;
-    unprocessableEntity(message?: string, error?: unknown): any;
-    tooManyRequests(message?: string): any;
-    serverError(message?: string, error?: unknown): any;
-    paginate(data: P[], page: number, limit: number, total: number, message?: string): any;
-    paginateOffset(data: P[], offset: number, limit: number, total: number, message?: string): any;
-}

package/dist/cjs/core/config.d.ts

@@ -1,15 +0,0 @@
-import type { PlainObject } from './types.js';
-export type EnvelopeKeys = {
-    success?: string;
-    message?: string;
-    data?: string;
-    error?: string;
-    meta?: string;
-};
-export type ResponderConfig = {
-    envelopeKeys?: EnvelopeKeys;
-    defaultStatus?: number;
-    timestamp?: boolean;
-    extra?: PlainObject | null;
-};
-export declare const defaultConfig: ResponderConfig;

package/dist/cjs/core/factory.d.ts

@@ -1,3 +0,0 @@
-import { ExpressResponder } from '../adapters/index.js';
-import type { ResponderConfig } from './config.js';
-export declare const createResponderFactory: (cfg?: Partial<ResponderConfig>) => <P = unknown, _M = Record<string, unknown>>(res: import("express").Response) => ExpressResponder<P>;

package/dist/cjs/core/index.d.ts

@@ -1,4 +0,0 @@
-export * from './BaseResponder.js';
-export * from './config.js';
-export * from './factory.js';
-export * from './types.js';

package/dist/cjs/core/types.d.ts

@@ -1,32 +0,0 @@
-export type PlainObject = Record<string, unknown>;
-export type ErrorShape = {
-    code?: string;
-    message: string;
-    details?: unknown;
-};
-export type ResponseEnvelope<T = unknown, M = PlainObject> = {
-    success: boolean;
-    message?: string;
-    data?: T;
-    error?: ErrorShape | null;
-    meta?: M | null;
-};
-export type TransportResult = {
-    status: number;
-    body: unknown;
-};
-export type Sender = (status: number, body: unknown) => Promise<any> | any;
-export interface PaginationMeta {
-    page: number;
-    limit: number;
-    total: number;
-    totalPages: number;
-    hasNext?: boolean;
-    hasPrev?: boolean;
-    offset?: number;
-    links?: {
-        next?: string;
-        prev?: string;
-        self: string;
-    };
-}

package/dist/cjs/index.d.ts

@@ -1,4 +0,0 @@
-export * from './core/index.js';
-export * from './constants/index.js';
-export * from './adapters/index.js';
-export * from './middleware/index.js';

package/dist/cjs/legacy.d.ts

@@ -1,19 +0,0 @@
-export declare const success: <T>(data: T, message?: string, status?: number, res?: {
-    status: (code: number) => any;
-    json: (body: unknown) => any;
-}) => any;
-export declare const error: (message: string, status?: number, err?: string, res?: {
-    status: (code: number) => any;
-    json: (body: unknown) => any;
-}) => any;
-declare const _default: {
-    success: <T>(data: T, message?: string, status?: number, res?: {
-        status: (code: number) => any;
-        json: (body: unknown) => any;
-    }) => any;
-    error: (message: string, status?: number, err?: string, res?: {
-        status: (code: number) => any;
-        json: (body: unknown) => any;
-    }) => any;
-};
-export default _default;

package/dist/cjs/legacy.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.error = exports.success = void 0;
-const success = (data, message = 'Success', status = 200, res) => {
-    if (res)
-        return res
-            .status(status)
-            .json({ success: true, message, data, statusCode: status });
-    return { success: true, message, data, statusCode: status };
-};
-exports.success = success;
-const error = (message, status = 500, err, res) => {
-    if (res)
-        return res
-            .status(status)
-            .json({ success: false, message, error: err, statusCode: status });
-    return { success: false, message, error: err, statusCode: status };
-};
-exports.error = error;
-exports.default = {
-    success: exports.success,
-    error: exports.error,
-};

package/dist/cjs/middleware/express/expressMiddleware.d.ts

@@ -1,3 +0,0 @@
-import type { RequestHandler } from 'express';
-import type { ResponderConfig } from '../../core/config.js';
-export declare const responderMiddleware: (cfg?: Partial<ResponderConfig>) => RequestHandler;

package/dist/cjs/middleware/express/index.d.ts

@@ -1 +0,0 @@
-export * from './expressMiddleware.js';

package/dist/cjs/middleware/index.d.ts

@@ -1 +0,0 @@
-export * from './express/index.js';

package/dist/esm/adapters/express/ExpressResponder.d.ts

@@ -1,18 +0,0 @@
-import type { Response } from 'express';
-import { BaseResponder } from '../../core/BaseResponder.js';
-import type { ResponderConfig } from '../../core/config.js';
-export declare class ExpressResponder<P = unknown> extends BaseResponder<P> {
-    private readonly res;
-    constructor(cfg: Partial<ResponderConfig> | undefined, res: Response);
-    okAndSend(data?: P, message?: string): void;
-    createdAndSend(data?: P, message?: string): void;
-    badRequestAndSend(message?: string, error?: unknown): void;
-    unauthorizedAndSend(message?: string): void;
-    forbiddenAndSend(message?: string): void;
-    notFoundAndSend(message?: string): void;
-    conflictAndSend(message?: string): void;
-    unprocessableEntityAndSend(message?: string, error?: unknown): void;
-    tooManyRequestsAndSend(message?: string): void;
-    serverErrorAndSend(message?: string, error?: unknown): void;
-    paginateAndSend(data: P[], page: number, limit: number, total: number, message?: string): void;
-}

package/dist/esm/adapters/express/index.d.ts

@@ -1 +0,0 @@
-export * from './ExpressResponder.js';

package/dist/esm/adapters/index.d.ts

@@ -1 +0,0 @@
-export * from './express/index.js';

package/dist/esm/constants/httpStatus.d.ts

@@ -1,54 +0,0 @@
-declare const SUCCESS: Readonly<{
-    readonly OK: 200;
-    readonly CREATED: 201;
-    readonly ACCEPTED: 202;
-    readonly NO_CONTENT: 204;
-}>;
-declare const REDIRECTION: Readonly<{
-    readonly NOT_MODIFIED: 304;
-}>;
-declare const CLIENT_ERROR: Readonly<{
-    readonly BAD_REQUEST: 400;
-    readonly UNAUTHORIZED: 401;
-    readonly FORBIDDEN: 403;
-    readonly NOT_FOUND: 404;
-    readonly METHOD_NOT_ALLOWED: 405;
-    readonly CONFLICT: 409;
-    readonly UNPROCESSABLE_ENTITY: 422;
-    readonly TOO_MANY_REQUESTS: 429;
-}>;
-declare const SERVER_ERROR: Readonly<{
-    readonly INTERNAL_SERVER_ERROR: 500;
-    readonly NOT_IMPLEMENTED: 501;
-    readonly BAD_GATEWAY: 502;
-    readonly SERVICE_UNAVAILABLE: 503;
-}>;
-export declare const HTTP_STATUS: Readonly<{
-    readonly SUCCESS: Readonly<{
-        readonly OK: 200;
-        readonly CREATED: 201;
-        readonly ACCEPTED: 202;
-        readonly NO_CONTENT: 204;
-    }>;
-    readonly REDIRECTION: Readonly<{
-        readonly NOT_MODIFIED: 304;
-    }>;
-    readonly CLIENT_ERROR: Readonly<{
-        readonly BAD_REQUEST: 400;
-        readonly UNAUTHORIZED: 401;
-        readonly FORBIDDEN: 403;
-        readonly NOT_FOUND: 404;
-        readonly METHOD_NOT_ALLOWED: 405;
-        readonly CONFLICT: 409;
-        readonly UNPROCESSABLE_ENTITY: 422;
-        readonly TOO_MANY_REQUESTS: 429;
-    }>;
-    readonly SERVER_ERROR: Readonly<{
-        readonly INTERNAL_SERVER_ERROR: 500;
-        readonly NOT_IMPLEMENTED: 501;
-        readonly BAD_GATEWAY: 502;
-        readonly SERVICE_UNAVAILABLE: 503;
-    }>;
-}>;
-export type HttpStatusCode = (typeof SUCCESS)[keyof typeof SUCCESS] | (typeof REDIRECTION)[keyof typeof REDIRECTION] | (typeof CLIENT_ERROR)[keyof typeof CLIENT_ERROR] | (typeof SERVER_ERROR)[keyof typeof SERVER_ERROR];
-export {};

package/dist/esm/constants/index.d.ts

@@ -1 +0,0 @@
-export * from './httpStatus.js';

package/dist/esm/core/BaseResponder.d.ts

@@ -1,31 +0,0 @@
-import { type ResponderConfig } from './config.js';
-import type { PaginationMeta, ResponseEnvelope, Sender } from './types.js';
-export declare class BaseResponder<P = unknown, M = PaginationMeta> {
-    protected readonly cfg: ResponderConfig;
-    protected sender?: Sender;
-    constructor(cfg?: Partial<ResponderConfig>, sender?: Sender);
-    attachSender(sender: Sender): void;
-    protected normalizeError(err: unknown): {
-        message: string;
-        code?: string;
-        details?: unknown;
-    };
-    protected buildEnvelope(data?: P, message?: string, error?: unknown, meta?: M): ResponseEnvelope<P, M>;
-    protected send(status: number, envelope: ResponseEnvelope<P, M>): any;
-    /** -----------------------------
-     *  Standard REST Response Helpers
-     * ----------------------------- */
-    ok(data?: P, message?: string): any;
-    created(data?: P, message?: string): any;
-    noContent(message?: string): any;
-    badRequest(message?: string, error?: unknown): any;
-    unauthorized(message?: string): any;
-    forbidden(message?: string): any;
-    notFound(message?: string): any;
-    conflict(message?: string): any;
-    unprocessableEntity(message?: string, error?: unknown): any;
-    tooManyRequests(message?: string): any;
-    serverError(message?: string, error?: unknown): any;
-    paginate(data: P[], page: number, limit: number, total: number, message?: string): any;
-    paginateOffset(data: P[], offset: number, limit: number, total: number, message?: string): any;
-}

package/dist/esm/core/config.d.ts

@@ -1,15 +0,0 @@
-import type { PlainObject } from './types.js';
-export type EnvelopeKeys = {
-    success?: string;
-    message?: string;
-    data?: string;
-    error?: string;
-    meta?: string;
-};
-export type ResponderConfig = {
-    envelopeKeys?: EnvelopeKeys;
-    defaultStatus?: number;
-    timestamp?: boolean;
-    extra?: PlainObject | null;
-};
-export declare const defaultConfig: ResponderConfig;

package/dist/esm/core/factory.d.ts

@@ -1,3 +0,0 @@
-import { ExpressResponder } from '../adapters/index.js';
-import type { ResponderConfig } from './config.js';
-export declare const createResponderFactory: (cfg?: Partial<ResponderConfig>) => <P = unknown, _M = Record<string, unknown>>(res: import("express").Response) => ExpressResponder<P>;

package/dist/esm/core/index.d.ts

@@ -1,4 +0,0 @@
-export * from './BaseResponder.js';
-export * from './config.js';
-export * from './factory.js';
-export * from './types.js';

package/dist/esm/core/types.d.ts

@@ -1,32 +0,0 @@
-export type PlainObject = Record<string, unknown>;
-export type ErrorShape = {
-    code?: string;
-    message: string;
-    details?: unknown;
-};
-export type ResponseEnvelope<T = unknown, M = PlainObject> = {
-    success: boolean;
-    message?: string;
-    data?: T;
-    error?: ErrorShape | null;
-    meta?: M | null;
-};
-export type TransportResult = {
-    status: number;
-    body: unknown;
-};
-export type Sender = (status: number, body: unknown) => Promise<any> | any;
-export interface PaginationMeta {
-    page: number;
-    limit: number;
-    total: number;
-    totalPages: number;
-    hasNext?: boolean;
-    hasPrev?: boolean;
-    offset?: number;
-    links?: {
-        next?: string;
-        prev?: string;
-        self: string;
-    };
-}

package/dist/esm/index.d.ts

@@ -1,4 +0,0 @@
-export * from './core/index.js';
-export * from './constants/index.js';
-export * from './adapters/index.js';
-export * from './middleware/index.js';

package/dist/esm/legacy.d.ts

@@ -1,19 +0,0 @@
-export declare const success: <T>(data: T, message?: string, status?: number, res?: {
-    status: (code: number) => any;
-    json: (body: unknown) => any;
-}) => any;
-export declare const error: (message: string, status?: number, err?: string, res?: {
-    status: (code: number) => any;
-    json: (body: unknown) => any;
-}) => any;
-declare const _default: {
-    success: <T>(data: T, message?: string, status?: number, res?: {
-        status: (code: number) => any;
-        json: (body: unknown) => any;
-    }) => any;
-    error: (message: string, status?: number, err?: string, res?: {
-        status: (code: number) => any;
-        json: (body: unknown) => any;
-    }) => any;
-};
-export default _default;

package/dist/esm/legacy.js

@@ -1,18 +0,0 @@
-export const success = (data, message = 'Success', status = 200, res) => {
-    if (res)
-        return res
-            .status(status)
-            .json({ success: true, message, data, statusCode: status });
-    return { success: true, message, data, statusCode: status };
-};
-export const error = (message, status = 500, err, res) => {
-    if (res)
-        return res
-            .status(status)
-            .json({ success: false, message, error: err, statusCode: status });
-    return { success: false, message, error: err, statusCode: status };
-};
-export default {
-    success,
-    error,
-};

package/dist/esm/middleware/express/expressMiddleware.d.ts

@@ -1,3 +0,0 @@
-import type { RequestHandler } from 'express';
-import type { ResponderConfig } from '../../core/config.js';
-export declare const responderMiddleware: (cfg?: Partial<ResponderConfig>) => RequestHandler;

package/dist/esm/middleware/express/index.d.ts

@@ -1 +0,0 @@
-export * from './expressMiddleware.js';

package/dist/esm/middleware/index.d.ts

@@ -1 +0,0 @@
-export * from './express/index.js';

package/dist/types/legacy.d.ts

@@ -1,19 +0,0 @@
-export declare const success: <T>(data: T, message?: string, status?: number, res?: {
-    status: (code: number) => any;
-    json: (body: unknown) => any;
-}) => any;
-export declare const error: (message: string, status?: number, err?: string, res?: {
-    status: (code: number) => any;
-    json: (body: unknown) => any;
-}) => any;
-declare const _default: {
-    success: <T>(data: T, message?: string, status?: number, res?: {
-        status: (code: number) => any;
-        json: (body: unknown) => any;
-    }) => any;
-    error: (message: string, status?: number, err?: string, res?: {
-        status: (code: number) => any;
-        json: (body: unknown) => any;
-    }) => any;
-};
-export default _default;