@kne/fastify-puppeteer 1.1.0 → 1.1.1

package/README.md

@@ -187,7 +187,7 @@ fastify-puppeteer 是一个基于 Fastify 的插件，它集成了 Puppeteer 来
 | 参数名 | 类型 | 必填 | 描述 |
 |-------|------|------|------|
 | url | string | 是 | 需要转换的网页 URL |
-| options | object | 否 | PDF 生成选项，参考 Puppeteer API |
+| options | object | 否 | PDF 生成选项，参考 Puppeteer API 和 URL 转换特有选项 |
 
 **响应结果：**
 - 返回生成的 PDF 文件流
@@ -207,7 +207,7 @@ fastify-puppeteer 是一个基于 Fastify 的插件，它集成了 Puppeteer 来
 | 参数名 | 类型 | 必填 | 描述 |
 |-------|------|------|------|
 | urlList | array | 是 | 需要转换的网页 URL 列表 |
-| options | object | 否 | PDF 生成选项，参考 Puppeteer API |
+| options | object | 否 | PDF 生成选项，参考 Puppeteer API 和 URL 转换特有选项 |
 
 **响应结果：**
 - 返回包含所有生成 PDF 的 ZIP 文件流
@@ -227,8 +227,8 @@ fastify-puppeteer 是一个基于 Fastify 的插件，它集成了 Puppeteer 来
 | 参数名 | 类型 | 必填 | 描述 |
 |-------|------|------|------|
 | url | string | 是 | 需要转换的网页 URL |
-| selector | string | 否 | 页面元素选择器，指定截图区域 |
-| options | object | 否 | 图片生成选项，参考 Puppeteer API |
+| selector | string | 否 | 页面元素选择器，指定截图区域。如果提供，将只截取该元素区域 |
+| options | object | 否 | 图片生成选项，参考 Puppeteer API 和 URL 转换特有选项 |
 
 **响应结果：**
 - 返回生成的图片文件流
@@ -248,8 +248,8 @@ fastify-puppeteer 是一个基于 Fastify 的插件，它集成了 Puppeteer 来
 | 参数名 | 类型 | 必填 | 描述 |
 |-------|------|------|------|
 | urlList | array | 是 | 需要转换的网页 URL 列表 |
-| selector | string | 否 | 页面元素选择器，指定截图区域 |
-| options | object | 否 | 图片生成选项，参考 Puppeteer API |
+| selector | string | 否 | 页面元素选择器，指定截图区域。如果提供，将只截取该元素区域 |
+| options | object | 否 | 图片生成选项，参考 Puppeteer API 和 URL 转换特有选项 |
 
 **响应结果：**
 - 返回包含所有生成图片的 ZIP 文件流
@@ -281,3 +281,13 @@ PDF 生成选项参考 Puppeteer 的 [page.pdf()](https://pptr.dev/api/puppeteer
 | clip | object | 裁剪区域，包含 x, y, width, height 属性 |
 | omitBackground | boolean | 是否隐藏默认白色背景 |
 
+#### URL 转换特有选项
+
+以下选项适用于 parseUrlToPdf、parseUrlToPdfBatch、parseUrlToPhoto 和 parseUrlToPhotoBatch 接口：
+
+| 选项名 | 类型 | 描述 |
+|-------|------|------|
+| waitForSelectors | array | 等待页面中特定元素出现的选择器数组，在继续处理前会等待这些元素加载完成 |
+| waitForVisible | boolean | 是否等待元素可见，默认为 false，仅检查元素是否存在于 DOM 中 |
+| waitForMaxTime | number | 等待元素出现的最大时间（毫秒），默认为 10000（10秒） |
+

package/libs/controllers.js

@@ -210,7 +210,7 @@ module.exports = fp(async (fastify, options) => {
     },
     async (request, reply) => {
       const filename = await services.parseUrlToPhotoBatch({
-        urlList: request.body.url,
+        urlList: request.body.urlList,
         selector: request.body.selector,
         options: request.body.options
       });

package/libs/services.js

@@ -73,11 +73,19 @@ module.exports = fp(async (fastify, options) => {
     });
   });
 
-  const parseUrlToPdf = memoCache('parseUrlToPdf', async ({ url, options }) => {
+  const parseUrlToPdf = memoCache('parseUrlToPdf', async ({ url, options = {} }) => {
     return await puppeteerPage.task(async ({ page }) => {
       await page.goto(url, {
         waitUntil: 'networkidle2'
       });
+      await Promise.all(
+        (options.waitForSelectors || []).map(waitForSelector => {
+          return page.waitForSelector(waitForSelector, {
+            visible: options.waitForVisible || false,
+            timeout: options.waitForMaxTime || 10000
+          });
+        })
+      );
       return await page.pdf(
         Object.assign(
           {},
@@ -98,11 +106,19 @@ module.exports = fp(async (fastify, options) => {
     });
   });
 
-  const parseUrlToPhoto = memoCache('parseUrlToPhoto', async ({ url, selector, options }) => {
+  const parseUrlToPhoto = memoCache('parseUrlToPhoto', async ({ url, selector, options = {} }) => {
     return await puppeteerPage.task(async ({ page }) => {
       await page.goto(url, {
         waitUntil: 'networkidle2'
       });
+      await Promise.all(
+        (options.waitForSelectors || []).map(waitForSelector => {
+          return page.waitForSelector(waitForSelector, {
+            visible: options.waitForVisible || false,
+            timeout: options.waitForMaxTime || 10000
+          });
+        })
+      );
       if (selector) {
         await page.locator(selector).wait();
         const element = await page.$(selector);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kne/fastify-puppeteer",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "用于操作无头浏览器截图保存pdf等",
   "main": "index.js",
   "scripts": {