socket-function 1.2.19 → 1.2.20

package/index.d.ts

@@ -1003,14 +1003,19 @@ declare module "socket-function/src/getUniqueTime" {
 declare module "socket-function/src/https" {
     /// <reference types="node" />
     /// <reference types="node" />
+    export interface HttpsResponseInfo {
+        statusCode?: number;
+        statusMessage?: string;
+        headers: {
+            [key: string]: string | undefined;
+        };
+    }
     export declare function httpsRequest(url: string, payload?: Buffer | Buffer[], method?: string, sendSessionCookies?: boolean, config?: {
         headers?: {
             [key: string]: string | undefined;
         };
         cancel?: Promise<void>;
-        outHeaders?: {
-            [key: string]: string | undefined;
-        };
+        outResponse?: HttpsResponseInfo;
     }): Promise<Buffer>;
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "socket-function",
-	"version": "1.2.19",
+	"version": "1.2.20",
 	"main": "index.js",
 	"license": "MIT",
 	"dependencies": {

package/src/https.d.ts

@@ -1,11 +1,16 @@
 /// <reference types="node" />
 /// <reference types="node" />
+export interface HttpsResponseInfo {
+    statusCode?: number;
+    statusMessage?: string;
+    headers: {
+        [key: string]: string | undefined;
+    };
+}
 export declare function httpsRequest(url: string, payload?: Buffer | Buffer[], method?: string, sendSessionCookies?: boolean, config?: {
     headers?: {
         [key: string]: string | undefined;
     };
     cancel?: Promise<void>;
-    outHeaders?: {
-        [key: string]: string | undefined;
-    };
+    outResponse?: HttpsResponseInfo;
 }): Promise<Buffer>;

package/src/https.ts

@@ -7,6 +7,14 @@ import { dnsCacheLookup, reportConnectionFailure } from "./dnsCache";
 const textEncoder = new TextEncoder();
 const textDecoder = new TextDecoder();
 
+// Response metadata surfaced back to the caller. Extend this rather than adding new out-params, so callers
+//  can read whatever they need without the signature churning.
+export interface HttpsResponseInfo {
+    statusCode?: number;
+    statusMessage?: string;
+    headers: { [key: string]: string | undefined };
+}
+
 // Error codes that mean the TCP connection was never established (so no request bytes reached the server
 //  and a full retry — even of a non-idempotent method — is safe). These are the failures a stale DNS
 //  answer produces, and the only ones we re-resolve + retry on.
@@ -47,8 +55,9 @@ export function httpsRequest(
     config?: {
         headers?: { [key: string]: string | undefined },
         cancel?: Promise<void>;
-        // Populated with the response headers once they arrive, so the caller can read them.
-        outHeaders?: { [key: string]: string | undefined };
+        // Populated with the response status code, message, and headers, so the caller can read them
+        //  without us adding a new out-param per field.
+        outResponse?: HttpsResponseInfo;
     }
 ): Promise<Buffer> {
     if (isNode()) {
@@ -98,10 +107,14 @@ export function httpsRequest(
                             autoSelectFamily: true,
                         } as https.RequestOptions,
                         async httpResponse => {
-                            if (config?.outHeaders) {
+                            if (config?.outResponse) {
+                                let headers: { [key: string]: string | undefined } = {};
                                 for (let [key, value] of Object.entries(httpResponse.headers)) {
-                                    config.outHeaders[key] = Array.isArray(value) ? value.join(", ") : value;
+                                    headers[key] = Array.isArray(value) ? value.join(", ") : value;
                                 }
+                                config.outResponse.statusCode = httpResponse.statusCode;
+                                config.outResponse.statusMessage = httpResponse.statusMessage;
+                                config.outResponse.headers = headers;
                             }
 
                             let data: Buffer[] = [];
@@ -166,12 +179,16 @@ export function httpsRequest(
         }
         return new Promise((resolve, reject) => {
             request.onload = () => {
-                if (config?.outHeaders) {
+                if (config?.outResponse) {
+                    let headers: { [key: string]: string | undefined } = {};
                     for (let line of request.getAllResponseHeaders().trim().split(/[\r\n]+/)) {
                         let index = line.indexOf(":");
                         if (index < 0) continue;
-                        config.outHeaders[line.slice(0, index).trim().toLowerCase()] = line.slice(index + 1).trim();
+                        headers[line.slice(0, index).trim().toLowerCase()] = line.slice(index + 1).trim();
                     }
+                    config.outResponse.statusCode = request.status;
+                    config.outResponse.statusMessage = request.statusText;
+                    config.outResponse.headers = headers;
                 }
                 if (!request.status.toString().startsWith("2")) {
                     try {