single-file-cli 2.0.48 → 2.0.49

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@single-file/single-file-cli",
-  "version": "2.0.48",
+  "version": "2.0.49",
   "description": "SingleFile CLI",
   "nodeModulesDir": true,
   "exports": {

package/lib/cdp-client.js

@@ -35,6 +35,7 @@ const EMPTY_PAGE_URL = "about:blank";
 const CAPTURE_SCREENSHOT_FUNCTION_NAME = "captureScreenshot";
 const SET_SCREENSHOT_FUNCTION_NAME = "setScreenshot";
 const SET_PAGE_DATA_FUNCTION_NAME = "setPageData";
+const REDIRECT_STATUS_CODES = [301, 302, 303, 307, 308];
 
 export { initialize, getPageData, closeBrowser };
 
@@ -104,8 +105,10 @@ async function getPageData(options) {
 				await Emulation.setUserAgentOverride(agentOptions);
 			}
 		}
-		if (options.httpProxyUsername) {
-			await Fetch.enable({ handleAuthRequests: true });
+		const handleAuthRequests = Boolean(options.httpProxyUsername);
+		const patterns = handleAuthRequests ? [{ requestStage: "Request" }, { requestStage: "Response" }] : [{ requestStage: "Response" }];
+		await Fetch.enable({ handleAuthRequests, patterns });
+		if (handleAuthRequests) {
 			Fetch.addEventListener("authRequired", ({ params }) => Fetch.continueWithAuth({
 				requestId: params.requestId,
 				authChallengeResponse: {
@@ -114,8 +117,42 @@ async function getPageData(options) {
 					password: options.httpProxyPassword
 				}
 			}));
-			Fetch.addEventListener("requestPaused", ({ params }) => Fetch.continueRequest({ requestId: params.requestId }));
 		}
+		let url = options.url;
+		let alternativeUrl = new URL(url);
+		if (!alternativeUrl.pathname.endsWith("/")) {
+			alternativeUrl.pathname = alternativeUrl.pathname + "/";
+		}
+		alternativeUrl = alternativeUrl.href;
+		let httpInfo;
+		delete options.zipScript;
+		Fetch.addEventListener("requestPaused", async ({ params }) => {
+			const { requestId, request, resourceType, responseHeaders, responseStatusCode, responseStatusText } = params;
+			if (options.outputJson && !httpInfo && (request.url == url || request.url == alternativeUrl) && responseStatusCode !== undefined) {
+				if (REDIRECT_STATUS_CODES.includes(responseStatusCode)) {
+					const redirect = responseHeaders.find(header => header.name.toLowerCase() == "location").value;
+					if (redirect) {
+						url = new URL(redirect, url).href;
+					}
+				} else {
+					httpInfo = {
+						request: {
+							url: request.url,
+							method: request.method,
+							headers: request.headers,
+							referrerPolicy: request.referrerPolicy
+						},
+						resourceType,
+						response: {
+							status: responseStatusCode,
+							statusText: responseStatusText,
+							headers: responseHeaders
+						}
+					};
+				}
+			}
+			await Fetch.continueRequest({ requestId });
+		});
 		if (options.httpHeaders && options.httpHeaders.length) {
 			await Network.setExtraHTTPHeaders({ headers: options.httpHeaders });
 		}
@@ -182,7 +219,9 @@ async function getPageData(options) {
 		if (subtype === "error") {
 			throw new Error(description);
 		}
-		return pageDataPromise;
+		const pageData = await pageDataPromise;
+		Object.assign(pageData, httpInfo);
+		return pageData;
 	} catch (error) {
 		if (error.code === LOAD_TIMEOUT_ERROR && options.browserWaitUntilFallback && options.browserWaitUntil) {
 			const browserWaitUntil = NETWORK_STATES[(NETWORK_STATES.indexOf(options.browserWaitUntil) + 1)];

package/lib/version.js

@@ -1 +1 @@
-export const version = "2.0.48";
+export const version = "2.0.49";

package/options.js

@@ -131,7 +131,8 @@ const OPTIONS_INFO = {
 	"prevent-appended-data": { description: "Prevent appending data after the compressed data when creating self-extracting HTML files", type: "boolean" },
 	"embed-screenshot": { description: "Embed a screenshot of the page as a PNG file in the compressed file (self-extracting HTML or ZIP file). When enabled, the resulting file can be read as a ZIP file or a PNG image.", type: "boolean" },
 	"output-directory": { description: "Path to where to save files, this path must exist.", type: "string" },
-	"version": { description: "Print the version number and exit.", type: "boolean" }
+	"version": { description: "Print the version number and exit.", type: "boolean" },
+	"output-json": { description: "Output the result as a JSON string containing the page and network info", type: "boolean" },
 };
 
 const { args, exit } = Deno;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "single-file-cli",
-	"version": "2.0.48",
+	"version": "2.0.49",
 	"description": "SingleFile CLI",
 	"author": "Gildas Lormeau",
 	"engines": {

package/single-file-cli-api.js

@@ -21,7 +21,7 @@
  *   Source.
  */
 
-/* global URL */
+/* global URL, Blob, FileReader */
 
 import * as backend from "./lib/cdp-client.js";
 import { getZipScriptSource } from "./lib/single-file-script.js";
@@ -244,29 +244,48 @@ function getHostURL(url) {
 
 async function capturePage(options) {
 	try {
-		let filename;
+		let filename, content;
 		options.zipScript = getZipScriptSource();
 		const pageData = await backend.getPageData(options);
+		filename = pageData.filename;
+		content = pageData.content;
+		if (options.outputJson) {
+			if (content instanceof Uint8Array) {
+				const fileReader = new FileReader();
+				fileReader.readAsDataURL(new Blob([content]));
+				content = await new Promise(resolve => {
+					fileReader.onload = () => resolve(fileReader.result);
+				});
+				content = content.replace(/^data:.*?;base64,/, "");
+				pageData.content = undefined;
+				pageData.binaryContent = content;
+			}
+			pageData.doctype = undefined;
+			pageData.viewport = undefined;
+			pageData.comment = undefined;
+			filename += filename.endsWith(".json") ? "" : ".json";
+			content = JSON.stringify(pageData, null, 2);
+		}
 		if (options.output) {
 			filename = await getFilename(options.output, options);
 		} else if (options.dumpContent) {
 			if (options.compressContent) {
-				await stdout.write(pageData.content);
+				await stdout.write(content);
 			} else {
-				console.log(pageData.content || ""); // eslint-disable-line no-console
+				console.log(content || ""); // eslint-disable-line no-console
 			}
 		} else {
-			filename = await getFilename(pageData.filename, options);
+			filename = await getFilename(filename, options);
 		}
-		if (filename) {
+		if (filename && !options.dumpContent) {
 			const directoryName = await path.dirname(filename);
 			if (directoryName !== ".") {
 				await mkdir(directoryName, { recursive: true });
 			}
-			if (pageData.content instanceof Uint8Array) {
-				await writeFile(filename, pageData.content);
+			if (content instanceof Uint8Array) {
+				await writeFile(filename, content);
 			} else {
-				await writeTextFile(filename, pageData.content);
+				await writeTextFile(filename, content);
 			}
 		}
 		return pageData;