🤖 Merge PR DefinitelyTyped#74777 Updating type definitions for puppeteer-har by @CaglarDeniz

Author: CaglarDeniz

types/puppeteer-har/index.d.ts

@@ -1,12 +1,18 @@
-interface PuppeteerHarOptions {
+import type { Frame, Page } from "puppeteer";
+
+export interface PuppeteerHarOptions {
     path?: string;
+    saveResponse?: boolean;
+    captureMimeTypes?: boolean;
 }
 
-declare class PuppeteerHar {
+export class PuppeteerHar {
     constructor(page: any, options?: PuppeteerHarOptions);
     start(options?: PuppeteerHarOptions): Promise<void>;
-    stop(): Promise<void>;
-    save(options: PuppeteerHarOptions): Promise<void>;
-}
+    stop(): Promise<PuppeteerHar | undefined>;
+    cleanUp(): Promise<void>;
 
-export = PuppeteerHar;
+    inProgress: boolean;
+    page: Page;
+    mainFrame: Frame;
+}

types/puppeteer-har/package.json

@@ -6,7 +6,7 @@
         "https://github.com/Everettss/puppeteer-har#readme"
     ],
     "dependencies": {
-        "@types/puppeteer": "*"
+        "puppeteer": "*"
     },
     "devDependencies": {
         "@types/puppeteer-har": "workspace:."
@@ -15,6 +15,10 @@
         {
             "name": "Julian Ordaz",
             "githubUsername": "jordaz14"
+        },
+        {
+            "name": "Deniz Caglar",
+            "githubUsername": "CaglarDeniz"
         }
     ]
 }

types/puppeteer-har/puppeteer-har-tests.ts

@@ -1,33 +1,40 @@
 /// <reference lib="dom" />
 
 // Import only for type-checking purposes
-import PuppeteerHar from "puppeteer-har";
+import { Frame, Page } from "puppeteer";
+import { PuppeteerHar, PuppeteerHarOptions } from "puppeteer-har";
 
 // Define a mock Page interface just for type-checking
-interface MockPage {
-    goto(url: string): Promise<void>;
-}
 
 // Create a mock Page object for type-checking
-const mockPage: MockPage = {
+const mockPage: any = {
     goto: async (url: string) => {
         // Mock implementation
     },
 };
 
 // Check if the PuppeteerHar class is correctly typed
-const page: MockPage = mockPage as any; // Type assertion to use MockPage
-const har = new PuppeteerHar(page);
+const page: Page = mockPage as any; // Type assertion to use Page
+
+const har = new PuppeteerHar(page, {
+    path: "",
+    saveResponse: true,
+    captureMimeTypes: true,
+} as PuppeteerHarOptions);
 
 // Type-check the methods of PuppeteerHar
 const startPromise: Promise<void> = har.start();
-const stopPromise: Promise<void> = har.stop();
-const savePromise: Promise<void> = har.save({ path: "example.har" });
+const stopPromise: Promise<PuppeteerHar | undefined> = har.stop();
+const cleanupPromise: Promise<void> = har.cleanUp();
 
 // Verify that the PuppeteerHar instance is correctly typed
 const harInstance: PuppeteerHar = har;
 
+const memberInProgress: boolean = har.inProgress;
+const memberPage: Page = har.page;
+const memberMainFrame: Frame = har.mainFrame;
+
 // Ensure that the methods return the correct types
 startPromise.then(() => console.log("Start method passed type check"));
 stopPromise.then(() => console.log("Stop method passed type check"));
-savePromise.then(() => console.log("Save method passed type check"));
+cleanupPromise.then(() => console.log("Cleanup method passed type check"));