@quenty/httppromise 10.10.1 → 10.10.2

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.10.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/httppromise@10.10.1...@quenty/httppromise@10.10.2) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 ## [10.10.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/httppromise@10.10.0...@quenty/httppromise@10.10.1) (2025-03-21)
 
 **Note:** Version bump only for package @quenty/httppromise

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/httppromise",
-  "version": "10.10.1",
+  "version": "10.10.2",
   "description": "HttpPromise - Wrapper functions around http requests in Roblox.",
   "keywords": [
     "Roblox",
@@ -27,11 +27,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.0",
-    "@quenty/promise": "^10.10.1"
+    "@quenty/loader": "^10.8.1",
+    "@quenty/promise": "^10.10.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Server/HttpPromise.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Provides a wrapper around HttpService with a promise API
 
@@ -32,6 +33,22 @@ local DEBUG_RESPONSE = false
 
 local HttpPromise = {}
 
+export type HTTPRequest = {
+	Url: string,
+	Method: "POST" | "GET" | "PUT" | "DELETE",
+	Headers: { [string]: string }?,
+	Body: string?,
+	Compress: Enum.HttpCompression?,
+}
+
+export type HTTPResponse = {
+	Success: boolean,
+	StatusCode: number,
+	StatusMessage: string,
+	Headers: { [string]: string },
+	Body: string,
+}
+
 --[=[
 	Decodes JSON from the response
 
@@ -46,10 +63,10 @@ local HttpPromise = {}
 	})
 	```
 
-	@param request table
+	@param request HTTPRequest
 	@return Promise<table>
 ]=]
-function HttpPromise.request(request)
+function HttpPromise.request(request: HTTPRequest): Promise.Promise<()>
 	if DEBUG_REQUEST then
 		print("Sending request", HttpService:JSONEncode(request))
 	end
@@ -85,7 +102,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function HttpPromise.isHttpResponse(value)
+function HttpPromise.isHttpResponse(value: any): boolean
 	return type(value) == "table"
 		and type(value.Success) == "boolean"
 		and type(value.StatusCode) == "number"
@@ -100,7 +117,7 @@ end
 	@param value HttpResponse
 	@return string
 ]=]
-function HttpPromise.convertHttpResponseToString(value)
+function HttpPromise.convertHttpResponseToString(value: HTTPResponse): string
 	assert(HttpPromise.isHttpResponse(value), "Bad value")
 
 	return string.format("%d: %s - %s", value.StatusCode, value.StatusMessage, value.Body)
@@ -117,16 +134,18 @@ end
 	@param request table | string
 	@return Promise<table>
 ]=]
-function HttpPromise.json(request)
+function HttpPromise.json(request: HTTPRequest | string): Promise.Promise<any>
+	local finalRequest: HTTPRequest
 	if type(request) == "string" then
-		request = {
-			Method = "GET";
-			Url = request;
+		finalRequest = {
+			Method = "GET",
+			Url = request,
 		}
+	else
+		finalRequest = request
 	end
 
-	return HttpPromise.request(request)
-		:Then(HttpPromise.decodeJson)
+	return HttpPromise.request(finalRequest):Then(HttpPromise.decodeJson)
 end
 
 --[=[
@@ -140,7 +159,7 @@ end
 	@param ... any -- A list of requests to retrieve. Meant to be used
 ]=]
 function HttpPromise.logFailedRequests(...)
-	for _, item in pairs({...}) do
+	for _, item in { ... } do
 		if type(item) == "string" then
 			warn(item)
 		elseif type(item) == "table" and type(item.StatusCode) == "number" then
@@ -155,7 +174,7 @@ end
 	@param response { Body: string }
 	@return table
 ]=]
-function HttpPromise.decodeJson(response)
+function HttpPromise.decodeJson(response: HTTPResponse)
 	assert(response, "Bad response")
 
 	if type(response.Body) ~= "string" then