@ooneex/http-response 0.16.0 → 1.0.0

package/README.md

@@ -1,58 +1,40 @@
 # @ooneex/http-response
 
-A comprehensive TypeScript/JavaScript library for building HTTP responses in web applications. This package provides a fluent API for creating JSON responses, handling exceptions, managing redirects, and working with HTTP headers in a type-safe manner.
+HTTP response builder with fluent API for setting status codes, headers, cookies, and streaming or buffered content delivery.
 
 ![Browser](https://img.shields.io/badge/Browser-Compatible-green?style=flat-square&logo=googlechrome)
 ![Bun](https://img.shields.io/badge/Bun-Compatible-orange?style=flat-square&logo=bun)
-![Deno](https://img.shields.io/badge/Deno-Compatible-blue?style=flat-square&logo=deno)
-![Node.js](https://img.shields.io/badge/Node.js-Compatible-green?style=flat-square&logo=node.js)
 ![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=flat-square&logo=typescript)
 ![MIT License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
 
 ## Features
 
-✅ **Fluent API** - Chain methods for easy response building
+✅ **Fluent API** - Chain methods like json(), exception(), notFound(), and redirect() for easy response building
 
-✅ **Type-Safe** - Full TypeScript support with generic types
+✅ **Type-Safe** - Full TypeScript support with generic data types
 
-✅ **JSON Responses** - Easy creation of JSON API responses
+✅ **JSON Responses** - Create structured JSON responses with success/error flags, status, and metadata
 
-✅ **Exception Handling** - Built-in error response formatting
+✅ **Exception Handling** - Built-in error response formatting with configurable status codes and data
 
-✅ **HTTP Redirects** - Support for all redirect status codes
+✅ **Not Found Responses** - Dedicated notFound() method for 404 responses
 
-✅ **Header Management** - Integrated HTTP header handling
+✅ **HTTP Redirects** - Support for all redirect status codes with Location header management
 
-✅ **Web Standards** - Returns native Web API Response objects
+✅ **Header Management** - Integrated HTTP header handling via @ooneex/http-header
 
-✅ **Method Chaining** - All methods return the instance for chaining
+✅ **Web Standards** - Returns native Web API Response objects
 
-✅ **State Management** - Proper state transitions between response types
+✅ **Environment-Aware** - Includes application environment info in response data
 
-✅ **Cross-Platform** - Works in Browser, Node.js, Bun, and Deno
+✅ **Socket Support** - Built-in done flag for WebSocket response completion tracking
 
 ## Installation
 
-### Bun
 ```bash
 bun add @ooneex/http-response
 ```
 
-### pnpm
-```bash
-pnpm add @ooneex/http-response
-```
-
-### Yarn
-```bash
-yarn add @ooneex/http-response
-```
-
-### npm
-```bash
-npm install @ooneex/http-response
-```
-
 ## Usage
 
 ### Basic JSON Responses

package/dist/index.d.ts

@@ -19,6 +19,7 @@ interface IResponse<DataType extends Record<string, unknown> = Record<string, un
 	redirect: (url: string | URL, status?: StatusCodeType) => IResponse<DataType>;
 	get: (env?: Environment) => Response;
 	getData: () => DataType | null;
+	getStatus: () => StatusCodeType;
 }
 type ResponseDataType<Data extends Record<string, unknown>> = {
 	data: Data;
@@ -54,6 +55,7 @@ declare class HttpResponse<Data extends Record<string, unknown> = Record<string,
 	}): IResponse<Data>;
 	redirect(url: string | URL, status?: StatusCodeType2): IResponse<Data>;
 	getData(): Data | null;
+	getStatus(): StatusCodeType2;
 	get(env?: Environment2): Response;
 }
 export { ResponseDataType, IResponse, HttpResponse };

package/dist/index.js

@@ -1,3 +1,3 @@
-import{Environment as r}from"@ooneex/app-env";import{Header as o}from"@ooneex/http-header";import{HttpStatus as s}from"@ooneex/http-status";class n{header;data=null;status=s.Code.OK;redirectUrl=null;message=null;done=!1;constructor(t){this.header=t||new o}json(t,e=s.Code.OK){return this.data=t,this.status=e,this.header.setJson(),this.header.remove("Location"),this.redirectUrl=null,this.message=null,this}exception(t,e){return this.message=t,this.status=e?.status??s.Code.InternalServerError,this.data=e?.data||null,this.redirectUrl=null,this.header.setJson(),this.header.remove("Location"),this}notFound(t,e){return this.message=t,this.status=e?.status||s.Code.NotFound,this.data=e?.data||null,this.redirectUrl=null,this.header.setJson(),this.header.remove("Location"),this}redirect(t,e=s.Code.Found){return this.redirectUrl=t,this.status=e,this.header.setLocation(t.toString()),this.data=null,this.message=null,this}getData(){return this.data}get(t){if(this.redirectUrl)return new Response(null,{status:this.status,headers:this.header.native});let e=new s,a={data:this.data||{},message:this.message,success:e.isSuccessful(this.status),done:this.done,status:this.status,isClientError:e.isClientError(this.status),isServerError:e.isServerError(this.status),isNotFound:!1,isUnauthorized:!1,isForbidden:!1,app:{env:t||r.PRODUCTION}};return new Response(JSON.stringify(a),{status:a.status,headers:this.header.native})}}export{n as HttpResponse};
+import{Environment as r}from"@ooneex/app-env";import{Header as o}from"@ooneex/http-header";import{HttpStatus as s}from"@ooneex/http-status";class n{header;data=null;status=s.Code.OK;redirectUrl=null;message=null;done=!1;constructor(t){this.header=t||new o}json(t,e=s.Code.OK){return this.data=t,this.status=e,this.header.setJson(),this.header.remove("Location"),this.redirectUrl=null,this.message=null,this}exception(t,e){return this.message=t,this.status=e?.status??s.Code.InternalServerError,this.data=e?.data||null,this.redirectUrl=null,this.header.setJson(),this.header.remove("Location"),this}notFound(t,e){return this.message=t,this.status=e?.status||s.Code.NotFound,this.data=e?.data||null,this.redirectUrl=null,this.header.setJson(),this.header.remove("Location"),this}redirect(t,e=s.Code.Found){return this.redirectUrl=t,this.status=e,this.header.setLocation(t.toString()),this.data=null,this.message=null,this}getData(){return this.data}getStatus(){return this.status}get(t){if(this.redirectUrl)return new Response(null,{status:this.status,headers:this.header.native});let e=new s,a={data:this.data||{},message:this.message,success:e.isSuccessful(this.status),done:this.done,status:this.status,isClientError:e.isClientError(this.status),isServerError:e.isServerError(this.status),isNotFound:!1,isUnauthorized:!1,isForbidden:!1,app:{env:t||r.PRODUCTION}};return new Response(JSON.stringify(a),{status:a.status,headers:this.header.native})}}export{n as HttpResponse};
 
-//# debugId=A1CEA356DBFBE4D664756E2164756E21
+//# debugId=9EA7148894EF116764756E2164756E21

package/dist/index.js.map

@@ -2,9 +2,9 @@
   "version": 3,
   "sources": ["src/HttpResponse.ts"],
   "sourcesContent": [
-    "import { Environment } from \"@ooneex/app-env\";\nimport { Header, type IHeader } from \"@ooneex/http-header\";\nimport { HttpStatus, type StatusCodeType } from \"@ooneex/http-status\";\nimport type { IResponse, ResponseDataType } from \"./types\";\n\nexport class HttpResponse<Data extends Record<string, unknown> = Record<string, unknown>> implements IResponse<Data> {\n  public readonly header: IHeader;\n  private data: Data | null = null;\n  private status: StatusCodeType = HttpStatus.Code.OK;\n  private redirectUrl: string | URL | null = null;\n  private message: string | null = null;\n  public done = false; // For socket\n\n  constructor(header?: IHeader) {\n    this.header = header || new Header();\n  }\n\n  public json(data: Data, status: StatusCodeType = HttpStatus.Code.OK): IResponse<Data> {\n    this.data = data;\n    this.status = status;\n    this.header.setJson();\n    this.header.remove(\"Location\");\n    this.redirectUrl = null;\n    this.message = null;\n\n    return this;\n  }\n\n  public exception(\n    message: string,\n    config?: {\n      data?: Data;\n      status?: StatusCodeType;\n    },\n  ): IResponse<Data> {\n    this.message = message;\n    this.status = config?.status ?? HttpStatus.Code.InternalServerError;\n    this.data = config?.data || null;\n    this.redirectUrl = null;\n    this.header.setJson();\n    this.header.remove(\"Location\");\n\n    return this;\n  }\n\n  public notFound(\n    message: string,\n    config?: {\n      data?: Data;\n      status?: StatusCodeType;\n    },\n  ): IResponse<Data> {\n    this.message = message;\n    this.status = config?.status || HttpStatus.Code.NotFound;\n    this.data = config?.data || null;\n    this.redirectUrl = null;\n    this.header.setJson();\n    this.header.remove(\"Location\");\n\n    return this;\n  }\n\n  public redirect(url: string | URL, status: StatusCodeType = HttpStatus.Code.Found): IResponse<Data> {\n    this.redirectUrl = url;\n    this.status = status;\n    this.header.setLocation(url.toString());\n    this.data = null;\n    this.message = null;\n\n    return this;\n  }\n\n  public getData(): Data | null {\n    return this.data;\n  }\n\n  public get(env?: Environment): Response {\n    if (this.redirectUrl) {\n      return new Response(null, {\n        status: this.status,\n        headers: this.header.native,\n      });\n    }\n\n    const status = new HttpStatus();\n\n    const responseData: ResponseDataType<Data> = {\n      data: this.data || ({} as Data),\n      message: this.message,\n      success: status.isSuccessful(this.status),\n      done: this.done,\n      status: this.status,\n      isClientError: status.isClientError(this.status),\n      isServerError: status.isServerError(this.status),\n      isNotFound: false,\n      isUnauthorized: false,\n      isForbidden: false,\n      app: {\n        env: env || Environment.PRODUCTION,\n      },\n    };\n\n    return new Response(JSON.stringify(responseData), {\n      status: responseData.status,\n      headers: this.header.native,\n    });\n  }\n}\n"
+    "import { Environment } from \"@ooneex/app-env\";\nimport { Header, type IHeader } from \"@ooneex/http-header\";\nimport { HttpStatus, type StatusCodeType } from \"@ooneex/http-status\";\nimport type { IResponse, ResponseDataType } from \"./types\";\n\nexport class HttpResponse<Data extends Record<string, unknown> = Record<string, unknown>> implements IResponse<Data> {\n  public readonly header: IHeader;\n  private data: Data | null = null;\n  private status: StatusCodeType = HttpStatus.Code.OK;\n  private redirectUrl: string | URL | null = null;\n  private message: string | null = null;\n  public done = false; // For socket\n\n  constructor(header?: IHeader) {\n    this.header = header || new Header();\n  }\n\n  public json(data: Data, status: StatusCodeType = HttpStatus.Code.OK): IResponse<Data> {\n    this.data = data;\n    this.status = status;\n    this.header.setJson();\n    this.header.remove(\"Location\");\n    this.redirectUrl = null;\n    this.message = null;\n\n    return this;\n  }\n\n  public exception(\n    message: string,\n    config?: {\n      data?: Data;\n      status?: StatusCodeType;\n    },\n  ): IResponse<Data> {\n    this.message = message;\n    this.status = config?.status ?? HttpStatus.Code.InternalServerError;\n    this.data = config?.data || null;\n    this.redirectUrl = null;\n    this.header.setJson();\n    this.header.remove(\"Location\");\n\n    return this;\n  }\n\n  public notFound(\n    message: string,\n    config?: {\n      data?: Data;\n      status?: StatusCodeType;\n    },\n  ): IResponse<Data> {\n    this.message = message;\n    this.status = config?.status || HttpStatus.Code.NotFound;\n    this.data = config?.data || null;\n    this.redirectUrl = null;\n    this.header.setJson();\n    this.header.remove(\"Location\");\n\n    return this;\n  }\n\n  public redirect(url: string | URL, status: StatusCodeType = HttpStatus.Code.Found): IResponse<Data> {\n    this.redirectUrl = url;\n    this.status = status;\n    this.header.setLocation(url.toString());\n    this.data = null;\n    this.message = null;\n\n    return this;\n  }\n\n  public getData(): Data | null {\n    return this.data;\n  }\n\n  public getStatus(): StatusCodeType {\n    return this.status;\n  }\n\n  public get(env?: Environment): Response {\n    if (this.redirectUrl) {\n      return new Response(null, {\n        status: this.status,\n        headers: this.header.native,\n      });\n    }\n\n    const status = new HttpStatus();\n\n    const responseData: ResponseDataType<Data> = {\n      data: this.data || ({} as Data),\n      message: this.message,\n      success: status.isSuccessful(this.status),\n      done: this.done,\n      status: this.status,\n      isClientError: status.isClientError(this.status),\n      isServerError: status.isServerError(this.status),\n      isNotFound: false,\n      isUnauthorized: false,\n      isForbidden: false,\n      app: {\n        env: env || Environment.PRODUCTION,\n      },\n    };\n\n    return new Response(JSON.stringify(responseData), {\n      status: responseData.status,\n      headers: this.header.native,\n    });\n  }\n}\n"
   ],
-  "mappings": "AAAA,sBAAS,wBACT,iBAAS,4BACT,qBAAS,4BAGF,MAAM,CAAwG,CACnG,OACR,KAAoB,KACpB,OAAyB,EAAW,KAAK,GACzC,YAAmC,KACnC,QAAyB,KAC1B,KAAO,GAEd,WAAW,CAAC,EAAkB,CAC5B,KAAK,OAAS,GAAU,IAAI,EAGvB,IAAI,CAAC,EAAY,EAAyB,EAAW,KAAK,GAAqB,CAQpF,OAPA,KAAK,KAAO,EACZ,KAAK,OAAS,EACd,KAAK,OAAO,QAAQ,EACpB,KAAK,OAAO,OAAO,UAAU,EAC7B,KAAK,YAAc,KACnB,KAAK,QAAU,KAER,KAGF,SAAS,CACd,EACA,EAIiB,CAQjB,OAPA,KAAK,QAAU,EACf,KAAK,OAAS,GAAQ,QAAU,EAAW,KAAK,oBAChD,KAAK,KAAO,GAAQ,MAAQ,KAC5B,KAAK,YAAc,KACnB,KAAK,OAAO,QAAQ,EACpB,KAAK,OAAO,OAAO,UAAU,EAEtB,KAGF,QAAQ,CACb,EACA,EAIiB,CAQjB,OAPA,KAAK,QAAU,EACf,KAAK,OAAS,GAAQ,QAAU,EAAW,KAAK,SAChD,KAAK,KAAO,GAAQ,MAAQ,KAC5B,KAAK,YAAc,KACnB,KAAK,OAAO,QAAQ,EACpB,KAAK,OAAO,OAAO,UAAU,EAEtB,KAGF,QAAQ,CAAC,EAAmB,EAAyB,EAAW,KAAK,MAAwB,CAOlG,OANA,KAAK,YAAc,EACnB,KAAK,OAAS,EACd,KAAK,OAAO,YAAY,EAAI,SAAS,CAAC,EACtC,KAAK,KAAO,KACZ,KAAK,QAAU,KAER,KAGF,OAAO,EAAgB,CAC5B,OAAO,KAAK,KAGP,GAAG,CAAC,EAA6B,CACtC,GAAI,KAAK,YACP,OAAO,IAAI,SAAS,KAAM,CACxB,OAAQ,KAAK,OACb,QAAS,KAAK,OAAO,MACvB,CAAC,EAGH,IAAM,EAAS,IAAI,EAEb,EAAuC,CAC3C,KAAM,KAAK,MAAS,CAAC,EACrB,QAAS,KAAK,QACd,QAAS,EAAO,aAAa,KAAK,MAAM,EACxC,KAAM,KAAK,KACX,OAAQ,KAAK,OACb,cAAe,EAAO,cAAc,KAAK,MAAM,EAC/C,cAAe,EAAO,cAAc,KAAK,MAAM,EAC/C,WAAY,GACZ,eAAgB,GAChB,YAAa,GACb,IAAK,CACH,IAAK,GAAO,EAAY,UAC1B,CACF,EAEA,OAAO,IAAI,SAAS,KAAK,UAAU,CAAY,EAAG,CAChD,OAAQ,EAAa,OACrB,QAAS,KAAK,OAAO,MACvB,CAAC,EAEL",
-  "debugId": "A1CEA356DBFBE4D664756E2164756E21",
+  "mappings": "AAAA,sBAAS,wBACT,iBAAS,4BACT,qBAAS,4BAGF,MAAM,CAAwG,CACnG,OACR,KAAoB,KACpB,OAAyB,EAAW,KAAK,GACzC,YAAmC,KACnC,QAAyB,KAC1B,KAAO,GAEd,WAAW,CAAC,EAAkB,CAC5B,KAAK,OAAS,GAAU,IAAI,EAGvB,IAAI,CAAC,EAAY,EAAyB,EAAW,KAAK,GAAqB,CAQpF,OAPA,KAAK,KAAO,EACZ,KAAK,OAAS,EACd,KAAK,OAAO,QAAQ,EACpB,KAAK,OAAO,OAAO,UAAU,EAC7B,KAAK,YAAc,KACnB,KAAK,QAAU,KAER,KAGF,SAAS,CACd,EACA,EAIiB,CAQjB,OAPA,KAAK,QAAU,EACf,KAAK,OAAS,GAAQ,QAAU,EAAW,KAAK,oBAChD,KAAK,KAAO,GAAQ,MAAQ,KAC5B,KAAK,YAAc,KACnB,KAAK,OAAO,QAAQ,EACpB,KAAK,OAAO,OAAO,UAAU,EAEtB,KAGF,QAAQ,CACb,EACA,EAIiB,CAQjB,OAPA,KAAK,QAAU,EACf,KAAK,OAAS,GAAQ,QAAU,EAAW,KAAK,SAChD,KAAK,KAAO,GAAQ,MAAQ,KAC5B,KAAK,YAAc,KACnB,KAAK,OAAO,QAAQ,EACpB,KAAK,OAAO,OAAO,UAAU,EAEtB,KAGF,QAAQ,CAAC,EAAmB,EAAyB,EAAW,KAAK,MAAwB,CAOlG,OANA,KAAK,YAAc,EACnB,KAAK,OAAS,EACd,KAAK,OAAO,YAAY,EAAI,SAAS,CAAC,EACtC,KAAK,KAAO,KACZ,KAAK,QAAU,KAER,KAGF,OAAO,EAAgB,CAC5B,OAAO,KAAK,KAGP,SAAS,EAAmB,CACjC,OAAO,KAAK,OAGP,GAAG,CAAC,EAA6B,CACtC,GAAI,KAAK,YACP,OAAO,IAAI,SAAS,KAAM,CACxB,OAAQ,KAAK,OACb,QAAS,KAAK,OAAO,MACvB,CAAC,EAGH,IAAM,EAAS,IAAI,EAEb,EAAuC,CAC3C,KAAM,KAAK,MAAS,CAAC,EACrB,QAAS,KAAK,QACd,QAAS,EAAO,aAAa,KAAK,MAAM,EACxC,KAAM,KAAK,KACX,OAAQ,KAAK,OACb,cAAe,EAAO,cAAc,KAAK,MAAM,EAC/C,cAAe,EAAO,cAAc,KAAK,MAAM,EAC/C,WAAY,GACZ,eAAgB,GAChB,YAAa,GACb,IAAK,CACH,IAAK,GAAO,EAAY,UAC1B,CACF,EAEA,OAAO,IAAI,SAAS,KAAK,UAAU,CAAY,EAAG,CAChD,OAAQ,EAAa,OACrB,QAAS,KAAK,OAAO,MACvB,CAAC,EAEL",
+  "debugId": "9EA7148894EF116764756E2164756E21",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/http-response",
-  "description": "HTTP response builder with status codes, headers, cookies, and content formatting support",
-  "version": "0.16.0",
+  "description": "HTTP response builder with fluent API for setting status codes, headers, cookies, and streaming or buffered content delivery",
+  "version": "1.0.0",
   "type": "module",
   "files": [
     "dist",
@@ -29,9 +29,9 @@
     "test": "bun test tests"
   },
   "dependencies": {
-    "@ooneex/app-env": "0.0.16",
-    "@ooneex/http-header": "0.15.0",
-    "@ooneex/http-status": "0.0.16"
+    "@ooneex/app-env": "0.0.19",
+    "@ooneex/http-header": "0.17.0",
+    "@ooneex/http-status": "0.0.18"
   },
   "devDependencies": {},
   "keywords": [