npm - @letsscrapedata/controller - Versions diffs - 0.0.12 → 0.0.14 - Mend

@letsscrapedata/controller 0.0.12 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/index.cjs CHANGED Viewed

@@ -763,8 +763,8 @@ var PlaywrightPage = class extends import_node_events.default {
     if (!this.#page) {
       throw new Error("No valid page");
     }
-    await this.#page.pdf(options);
-    return true;
+    const buffer = await this.#page.pdf(options);
+    return buffer;
   }
   async screenshot(options) {
     if (!this.#page) {
@@ -952,7 +952,7 @@ var PlaywrightPage = class extends import_node_events.default {
         return;
       }
       for (const option of this.#responseInterceptionOptions) {
-        const { requestMatch, responseMatch, responseItems, handler, handlerOptions } = option;
+        const { requestMatch, responseMatch, responseItems, handler, handlerOptions = {} } = option;
         let matchedFlag = !requestMatch || this.#checkRequestMatch(request, requestMatch);
         if (matchedFlag && responseMatch) {
           const { minLength, maxLength } = responseMatch;
@@ -981,7 +981,7 @@ var PlaywrightPage = class extends import_node_events.default {
           (0, import_utils2.loginfo)(`##browser cache matched response: ${requestUrl}`);
         }
         if (typeof handler === "function") {
-          await handler(response, handlerOptions);
+          await handler(response, handlerOptions, pageUrl);
         }
       }
       return;
@@ -2231,8 +2231,8 @@ var PuppeteerPage = class extends import_node_events4.default {
     if (!this.#page) {
       throw new Error("No valid page");
     }
-    await this.#page.pdf(options);
-    return true;
+    const buffer = await this.#page.pdf(options);
+    return buffer;
   }
   async screenshot(options) {
     if (!this.#page) {
@@ -2408,18 +2408,18 @@ var PuppeteerPage = class extends import_node_events4.default {
       return false;
     }
     this.#responseInterceptionNum++;
-    const pageUrl = this.#page.url();
     this.#page.on("response", async (response) => {
       try {
-        if (!response.ok()) {
+        if (!response.ok() || !this.#page) {
           return false;
         }
+        const pageUrl = this.#page.url();
         const request = response.request();
         if (!request) {
           return false;
         }
         for (const option of actOptions) {
-          const { requestMatch, responseMatch, responseItems, handler, handlerOptions } = option;
+          const { requestMatch, responseMatch, responseItems, handler, handlerOptions = {} } = option;
           let matchedFlag = !requestMatch || this.#checkRequestMatch(request, requestMatch);
           if (matchedFlag && responseMatch) {
             const { minLength, maxLength } = responseMatch;
@@ -2447,7 +2447,7 @@ var PuppeteerPage = class extends import_node_events4.default {
             });
           }
           if (typeof handler === "function") {
-            await handler(response, handlerOptions);
+            await handler(response, handlerOptions, pageUrl);
           }
         }
         return true;

package/dist/index.d.cts CHANGED Viewed

@@ -456,7 +456,7 @@ interface ResponseMatch {
     maxLength?: number;
 }
 type ResponseHandlerOptions = Record<string, any>;
-type ResponseHandler = (response: AllResponse, options?: ResponseHandlerOptions) => Promise<void> | void;
+type ResponseHandler = (response: AllResponse, options: ResponseHandlerOptions, pageUrl: string) => Promise<void> | void;
 interface ResponseInterceptionItem {
     /**
      * page.url()
@@ -490,6 +490,10 @@ interface ResponseInterceptionOption {
      * handler will be called if handler is a function
      */
     handler?: ResponseHandler;
+    /**
+     * valid only if handler is a function
+     * @default {}
+     */
     handlerOptions?: ResponseHandlerOptions;
 }
 interface PDFMargin {
@@ -802,7 +806,7 @@ interface LsdPage extends EventEmitter {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(options?: PDFOptions): Promise<boolean>;
+    pdf(options?: PDFOptions): Promise<Buffer>;
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
@@ -1001,7 +1005,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(options?: PDFOptions | undefined): Promise<boolean>;
+    pdf(options?: PDFOptions | undefined): Promise<Buffer>;
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
@@ -1109,7 +1113,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(options?: PDFOptions | undefined): Promise<boolean>;
+    pdf(options?: PDFOptions | undefined): Promise<Buffer>;
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
@@ -1181,7 +1185,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(): Promise<boolean>;
+    pdf(): Promise<Buffer>;
     screenshot(): Promise<Buffer>;
     scrollBy(): Promise<boolean>;
     scrollTo(): Promise<boolean>;

package/dist/index.d.ts CHANGED Viewed

@@ -456,7 +456,7 @@ interface ResponseMatch {
     maxLength?: number;
 }
 type ResponseHandlerOptions = Record<string, any>;
-type ResponseHandler = (response: AllResponse, options?: ResponseHandlerOptions) => Promise<void> | void;
+type ResponseHandler = (response: AllResponse, options: ResponseHandlerOptions, pageUrl: string) => Promise<void> | void;
 interface ResponseInterceptionItem {
     /**
      * page.url()
@@ -490,6 +490,10 @@ interface ResponseInterceptionOption {
      * handler will be called if handler is a function
      */
     handler?: ResponseHandler;
+    /**
+     * valid only if handler is a function
+     * @default {}
+     */
     handlerOptions?: ResponseHandlerOptions;
 }
 interface PDFMargin {
@@ -802,7 +806,7 @@ interface LsdPage extends EventEmitter {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(options?: PDFOptions): Promise<boolean>;
+    pdf(options?: PDFOptions): Promise<Buffer>;
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
@@ -1001,7 +1005,7 @@ declare class PlaywrightPage extends EventEmitter implements LsdPage {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(options?: PDFOptions | undefined): Promise<boolean>;
+    pdf(options?: PDFOptions | undefined): Promise<Buffer>;
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
@@ -1109,7 +1113,7 @@ declare class PuppeteerPage extends EventEmitter implements LsdPage {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(options?: PDFOptions | undefined): Promise<boolean>;
+    pdf(options?: PDFOptions | undefined): Promise<Buffer>;
     screenshot(options?: ScreenshotOptions): Promise<Buffer>;
     scrollBy(x: number, y: number): Promise<boolean>;
     scrollTo(x: number, y: number): Promise<boolean>;
@@ -1181,7 +1185,7 @@ declare class CheerioPage extends EventEmitter implements LsdPage {
     pageHeight(): Promise<number>;
     pageInfo(): PageInfo;
     pageWidth(): Promise<number>;
-    pdf(): Promise<boolean>;
+    pdf(): Promise<Buffer>;
     screenshot(): Promise<Buffer>;
     scrollBy(): Promise<boolean>;
     scrollTo(): Promise<boolean>;

package/dist/index.js CHANGED Viewed

@@ -743,8 +743,8 @@ var PlaywrightPage = class extends EventEmitter {
     if (!this.#page) {
       throw new Error("No valid page");
     }
-    await this.#page.pdf(options);
-    return true;
+    const buffer = await this.#page.pdf(options);
+    return buffer;
   }
   async screenshot(options) {
     if (!this.#page) {
@@ -932,7 +932,7 @@ var PlaywrightPage = class extends EventEmitter {
         return;
       }
       for (const option of this.#responseInterceptionOptions) {
-        const { requestMatch, responseMatch, responseItems, handler, handlerOptions } = option;
+        const { requestMatch, responseMatch, responseItems, handler, handlerOptions = {} } = option;
         let matchedFlag = !requestMatch || this.#checkRequestMatch(request, requestMatch);
         if (matchedFlag && responseMatch) {
           const { minLength, maxLength } = responseMatch;
@@ -961,7 +961,7 @@ var PlaywrightPage = class extends EventEmitter {
           loginfo(`##browser cache matched response: ${requestUrl}`);
         }
         if (typeof handler === "function") {
-          await handler(response, handlerOptions);
+          await handler(response, handlerOptions, pageUrl);
         }
       }
       return;
@@ -2211,8 +2211,8 @@ var PuppeteerPage = class extends EventEmitter4 {
     if (!this.#page) {
       throw new Error("No valid page");
     }
-    await this.#page.pdf(options);
-    return true;
+    const buffer = await this.#page.pdf(options);
+    return buffer;
   }
   async screenshot(options) {
     if (!this.#page) {
@@ -2388,18 +2388,18 @@ var PuppeteerPage = class extends EventEmitter4 {
       return false;
     }
     this.#responseInterceptionNum++;
-    const pageUrl = this.#page.url();
     this.#page.on("response", async (response) => {
       try {
-        if (!response.ok()) {
+        if (!response.ok() || !this.#page) {
           return false;
         }
+        const pageUrl = this.#page.url();
         const request = response.request();
         if (!request) {
           return false;
         }
         for (const option of actOptions) {
-          const { requestMatch, responseMatch, responseItems, handler, handlerOptions } = option;
+          const { requestMatch, responseMatch, responseItems, handler, handlerOptions = {} } = option;
           let matchedFlag = !requestMatch || this.#checkRequestMatch(request, requestMatch);
           if (matchedFlag && responseMatch) {
             const { minLength, maxLength } = responseMatch;
@@ -2427,7 +2427,7 @@ var PuppeteerPage = class extends EventEmitter4 {
             });
           }
           if (typeof handler === "function") {
-            await handler(response, handlerOptions);
+            await handler(response, handlerOptions, pageUrl);
           }
         }
         return true;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@letsscrapedata/controller",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Unified browser / HTML controller interfaces that support playwright, puppeteer and cheerio",
   "type": "module",
   "main": "./dist/index.mjs",