Upload 8 files

Dockerfile

@@ -44,7 +44,8 @@ COPY package*.json ./
 
 # 清理 npm cache 并安装依赖
 RUN npm cache clean --force \
-    && npm ci --omit=dev --no-audit --no-fund \
+    # && npm ci --omit=dev --no-audit --no-fund \
+    && npm install --only=production --no-audit --no-fund \
     && npm cache clean --force
 
 # 复制应用代码

LICENSE

@@ -1,27 +1,53 @@
-PROPRIETARY SOFTWARE LICENSE
+PROPRIETARY NON-COMMERCIAL LICENSE
 
 Copyright (c) 2024. All rights reserved.
 
-NOTICE: This software and its documentation are proprietary and confidential 
-information. This software is provided under a proprietary license agreement.
+NOTICE: This software and its documentation are proprietary and confidential.
+This is NOT open source software and is subject to strict usage restrictions.
 
-RESTRICTIONS:
-- You may NOT copy, modify, or distribute this software
-- You may NOT reverse engineer or decompile this software  
-- You may NOT use this software for commercial purposes without a license
-- You may NOT redistribute or sublicense this software
+STRICT RESTRICTIONS:
+- COMMERCIAL USE IS STRICTLY PROHIBITED
+- You may NOT sell, rent, lease, or monetize this software in any way
+- You may NOT use this software in any business or commercial environment
+- You may NOT copy, modify, distribute, or redistribute this software
+- You may NOT reverse engineer, decompile, or disassemble this software
+- You may NOT sublicense or transfer rights to this software
+- You may NOT remove or modify copyright notices
 
-PERMITTED USES:
-- Personal, non-commercial use only
-- Educational purposes with proper attribution
-- Evaluation for potential commercial licensing
+PERMITTED USES ONLY:
+- Personal, non-commercial use for individual learning purposes
+- Educational use in academic institutions for teaching purposes only
+- Research and evaluation for non-commercial academic purposes
+- Internal testing and development (non-commercial)
+
+EDUCATIONAL USE REQUIREMENTS:
+- Must include proper attribution to original author
+- Cannot be used for any profit-generating activities
+- Students/teachers cannot commercialize any derivatives
+- Institution must be accredited educational organization
+
+TERMINATION:
+This license terminates automatically if you violate any terms.
+Upon termination, you must destroy all copies of the software.
+
+DISCLAIMER OF WARRANTY:
+This software is provided "AS IS" without warranty of any kind, express or
+implied. The author disclaims all warranties including merchantability and
+fitness for a particular purpose.
+
+LIMITATION OF LIABILITY:
+The author shall not be liable for any damages whatsoever arising from the
+use of this software, including but not limited to direct, indirect,
+incidental, or consequential damages.
 
 COMMERCIAL LICENSING:
-Commercial use requires a separate license agreement. Contact the developer
-for commercial licensing terms and pricing.
+For any commercial use, you must obtain a separate commercial license.
+Contact the developer for commercial licensing terms and pricing.
+
+VIOLATION CONSEQUENCES:
+Violation of this license may result in legal action and monetary damages.
 
-DISCLAIMER:
-This software is provided "AS IS" without warranty of any kind. The author
-shall not be liable for any damages arising from the use of this software.
+By using this software, you acknowledge that you have read, understood,
+and agree to be bound by the terms of this license.
 
-For licensing inquiries: [Contact Information]
+For licensing inquiries or permission requests, contact the developer.

README.md

@@ -5,12 +5,12 @@ colorFrom: blue
 colorTo: green
 sdk: docker
 pinned: false
-license: mit
+license: other
 ---
 
 # 📸 Page Screenshot API
 
-Professional web page screenshot service built with Node.js and Puppeteer, optimized for Hugging Face Spaces.
+Professional web page screenshot service built with Node.js and Puppeteer, optimized for Hugging Face Spaces with **full-page support** and **flexible authentication**.
 
 ## 🚀 Live Demo
 
@@ -18,84 +18,111 @@ Professional web page screenshot service built with Node.js and Puppeteer, optim
 - **Demo Interface**: `https://your-username-page-shot.hf.space/demo`
 - **Health Check**: `https://your-username-page-shot.hf.space/`
 
-## 🔐 Access Control
+## 🔐 Authentication Options
 
-This API uses **Hugging Face system-level authentication**:
+### Option 1: Custom API Key (Recommended)
+Set `API_KEY` environment variable in Space settings for secure access:
 
-### Public Spaces
-- Open access for all users
-- Rate limited to 100 requests per 15 minutes
-- Perfect for demos and testing
-
-### Private Spaces
-- Requires valid Hugging Face access token
-- Access controlled by HF platform automatically
-- Higher security for production use
+```bash
+# With API key authentication
+curl -X POST https://your-space.hf.space/screenshot \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer your-api-key-here" \
+  -d '{"url": "https://example.com", "fullPage": true}' \
+  --output screenshot.jpg
+```
 
-## 📖 API Usage
+### Option 2: Open Access Mode
+If no `API_KEY` is set, the API runs in open access mode:
 
-### Public Space Access
 ```bash
+# Open access (no authentication)
 curl -X POST https://your-space.hf.space/screenshot \
   -H "Content-Type: application/json" \
   -d '{"url": "https://example.com", "width": 1280, "height": 720}' \
   --output screenshot.jpg
 ```
 
-### Private Space Access
+### Option 3: Private Space with HF Token
+For private spaces, use HuggingFace access token:
+
 ```bash
+# Private space access
 curl -X POST https://your-space.hf.space/screenshot \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer hf_your_token_here" \
-  -d '{"url": "https://example.com", "width": 1280, "height": 720}' \
+  -d '{"url": "https://example.com"}' \
   --output screenshot.jpg
 ```
 
-### JavaScript Example
+## 📊 API Parameters
+
+| Parameter | Type | Default | Range | Description |
+|-----------|------|---------|-------|-------------|
+| `url` | string | **required** | - | Target webpage URL (must start with http/https) |
+| `width` | number | 1280 | 100-1600 | Screenshot width in pixels |
+| `height` | number | 720 | 100-1200 | Screenshot height in pixels |
+| `quality` | number | 75 | 10-100 | JPEG quality percentage (JPEG only) |
+| `fullPage` | boolean | false | - | **NEW**: Capture full page length (long screenshots) |
+| `format` | string | "jpeg" | jpeg/png | **NEW**: Output format (jpeg or png) |
+
+## 🆕 New Features in v1.5.0
+
+### 📜 Full Page Screenshots
+Capture entire webpage including content below the fold:
+
 ```javascript
-const response = await fetch('https://your-space.hf.space/screenshot', {
+// Capture full page length
+const response = await fetch('/screenshot', {
   method: 'POST',
   headers: {
     'Content-Type': 'application/json',
-    // Add this line only for private spaces:
-    // 'Authorization': 'Bearer hf_your_token_here'
+    'Authorization': 'Bearer your-api-key'
   },
   body: JSON.stringify({
     url: 'https://example.com',
-    width: 1280,
-    height: 720,
-    quality: 80
+    fullPage: true,  // 🆕 Captures entire page height
+    format: 'png'    // 🆕 PNG format for better quality
   })
 });
-
-const imageBlob = await response.blob();
 ```
 
-## 📊 Parameters
+### 🖼️ Multiple Image Formats
+Choose between JPEG (smaller size) and PNG (better quality):
 
-| Parameter | Type | Default | Range | Description |
-|-----------|------|---------|-------|-------------|
-| `url` | string | **required** | - | Target webpage URL |
-| `width` | number | 1280 | 100-1600 | Screenshot width in pixels |
-| `height` | number | 720 | 100-1200 | Screenshot height in pixels |
-| `quality` | number | 75 | 10-100 | JPEG quality percentage |
+```bash
+# PNG format (lossless, larger file)
+curl -X POST https://your-space.hf.space/screenshot \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer your-api-key" \
+  -d '{"url": "https://example.com", "format": "png"}' \
+  --output screenshot.png
+
+# JPEG format (compressed, smaller file)
+curl -X POST https://your-space.hf.space/screenshot \
+  -H "Content-Type: application/json" \
+  -H "Authorization: Bearer your-api-key" \
+  -d '{"url": "https://example.com", "format": "jpeg", "quality": 85}' \
+  --output screenshot.jpg
+```
 
 ## 🔄 Response Examples
 
 ### Success Response
 ```
 HTTP/1.1 200 OK
-Content-Type: image/jpeg
+Content-Type: image/jpeg  # or image/png
 Content-Length: 245760
 
-[Binary JPEG data]
+[Binary image data]
 ```
 
-### Error Response
+### Authentication Error
 ```json
 {
-  "error": "Failed to capture screenshot",
-  "message": "Navigation timeout exceeded"
+  "error": "Unauthorized",
+  "message": "Valid API key required. Please provide API key in Authorization header or x-api-key header.",
+  "hint": "Use \"Authorization: Bearer YOUR_API_KEY\" or \"x-api-key: YOUR_API_KEY\""
 }
 ```
 
@@ -111,53 +138,95 @@ Content-Length: 245760
 
 ## 🛠️ Features
 
+- ✅ **Full Page Screenshots** - Capture entire webpage length
+- ✅ **Multiple Formats** - JPEG (compressed) and PNG (lossless) support
+- ✅ **Flexible Authentication** - API key, open access, or HF token
+- ✅ **Global Font Support** - Renders CJK, Arabic, Emoji fonts correctly
 - ✅ **Queue Management** - Handles concurrent requests efficiently
 - ✅ **CPU Monitoring** - Automatic load balancing
-- ✅ **Rate Limiting** - Prevents abuse
-- ✅ **HF Authentication** - Integrated with HuggingFace platform
+- ✅ **Rate Limiting** - Prevents abuse (100 req/15min)
 - ✅ **Error Handling** - Comprehensive error responses
-- ✅ **Demo Interface** - Built-in testing UI
+- ✅ **Demo Interface** - Built-in testing UI with auth detection
 - ✅ **Health Monitoring** - Status endpoint for monitoring
 
-## 📈 Monitoring
+## 🔧 Setup Instructions
+
+### Step 1: Configure Authentication (Optional)
+```bash
+# In HuggingFace Space Settings → Variables
+API_KEY=sk-your-secure-random-key-here
+```
+
+### Step 2: Deploy to HuggingFace Spaces
+1. Create new Space with Docker SDK
+2. Upload all files to Space repository
+3. Set environment variables if needed
+4. Space will auto-deploy
+
+### Step 3: Test the API
+Visit the demo page: `https://your-space.hf.space/demo`
+
+## 📈 Monitoring Endpoints
 
 ### Health Check
 ```bash
 curl https://your-space.hf.space/
+# Returns API info and authentication status
 ```
 
 ### Server Status
 ```bash
 curl https://your-space.hf.space/status
+# Returns CPU usage, active requests, queue status
 ```
 
-## 🚨 Rate Limits
+## 🚨 Rate Limits & Performance
+
+| Metric | Limit | Notes |
+|--------|-------|-------|
+| Requests | 100/15min | Per IP address |
+| Concurrent | 3 requests | Server queue management |
+| CPU Threshold | 95% | Auto-rejects when overloaded |
+| Timeout | 15 seconds | Per screenshot request |
+| Max Dimensions | 1600x1200 | Viewport size limits |
+
+## 🔒 Security & License
+
+- **Proprietary License**: Commercial use requires separate license
+- **Non-Commercial Use**: Educational and personal use permitted
+- **API Security**: Optional API key authentication
+- **Resource Protection**: Built-in rate limiting and queue management
+
+## 🌍 Global Font Support
 
-| Space Type | Requests | Window |
-|------------|----------|--------|
-| Public | 100 | 15 minutes |
-| Private | 100 | 15 minutes |
+Optimized for international websites with support for:
+- **CJK Languages**: Chinese, Japanese, Korean
+- **RTL Languages**: Arabic, Hebrew
+- **Emoji & Symbols**: Full Unicode emoji support
+- **Latin Scripts**: European languages with proper rendering
 
-## 🔧 Deployment
+## 🛡️ Production Recommendations
 
-This application is optimized for Hugging Face Spaces with:
-- Docker-based deployment
-- Automatic dependency management
-- Resource-efficient Chrome configuration
-- Built-in security features
-- HuggingFace platform integration
+1. **Enable API Key**: Set `API_KEY` environment variable for production
+2. **Use Private Space**: For sensitive or commercial use
+3. **Implement Retry Logic**: Handle busy server responses
+4. **Monitor Usage**: Use `/status` endpoint for health checks
+5. **Choose Format Wisely**: JPEG for photos, PNG for graphics/text
 
-## 🔒 Security Notes
+## 📚 Documentation
 
-- **Private Spaces**: Access automatically controlled by HF platform
-- **Public Spaces**: Open access with rate limiting
-- **No API keys needed**: Authentication handled by HuggingFace
-- **Secure by design**: Follows HF Spaces best practices
+- [API Authentication Guide](API_GUIDE.md)
+- [Private Space Setup](PRIVATE_SPACE_GUIDE.md)  
+- [Environment Variables](HF_SPACES_ENV_GUIDE.md)
+- [Deployment Guide](DEPLOYMENT_GUIDE.md)
 
 ## 📄 License
 
-Proprietary - Commercial use requires license. See [LICENSE](LICENSE) for details.
+**Proprietary Non-Commercial License** - See [LICENSE](LICENSE) for full terms.
+- ✅ Educational and personal use
+- ❌ Commercial use without license
+- ❌ Redistribution or modification
 
 ## 🤝 Support
 
-For technical support or questions, please contact the administrator.
+For commercial licensing, technical support, or feature requests, please contact the administrator.

package.json

@@ -1,16 +1,16 @@
 {
   "name": "page-screenshot-api",
-  "version": "1.4.0",
-  "description": "Professional web page screenshot API service for Hugging Face Spaces",
+  "version": "1.5.0",
+  "description": "Professional web page screenshot API service for Hugging Face Spaces with full-page support",
   "main": "server.js",
   "scripts": {
     "start": "node server.js",
     "dev": "nodemon server.js",
     "build": "echo 'No build step required'"
   },
-  "keywords": ["screenshot", "api", "puppeteer", "huggingface", "spaces"],
+  "keywords": ["screenshot", "api", "puppeteer", "huggingface", "spaces", "fullpage"],
   "author": "",
-  "license": "UNLICENSED",
+  "license": "SEE LICENSE IN LICENSE",
   "private": true,
   "dependencies": {
     "express": "^4.18.2",

server.js

@@ -171,6 +171,13 @@ app.get('/demo', (req, res) => {
         <input type="number" id="height" value="720" min="100" max="1200">
         <label>Quality:</label>
         <input type="number" id="quality" value="75" min="10" max="100">
+        <label>Full Page:</label>
+        <input type="checkbox" id="fullPage">
+        <label>Format:</label>
+        <select id="format">
+            <option value="jpeg" selected>JPEG</option>
+            <option value="png">PNG</option>
+        </select>
     </div>
     
     <button onclick="takeScreenshot()">📸 Take Screenshot</button>
@@ -195,6 +202,8 @@ app.get('/demo', (req, res) => {
             const width = parseInt(document.getElementById('width').value);
             const height = parseInt(document.getElementById('height').value);
             const quality = parseInt(document.getElementById('quality').value);
+            const fullPage = document.getElementById('fullPage').checked;
+            const format = document.getElementById('format').value;
             const apiKey = document.getElementById('apiKey') ? document.getElementById('apiKey').value : '';
             
             if (!url) {
@@ -225,7 +234,7 @@ app.get('/demo', (req, res) => {
                 const response = await fetch('/screenshot', {
                     method: 'POST',
                     headers: headers,
-                    body: JSON.stringify({ url, width, height, quality })
+                    body: JSON.stringify({ url, width, height, quality, fullPage, format })
                 });
                 
                 if (response.ok) {
@@ -237,7 +246,7 @@ app.get('/demo', (req, res) => {
                         '<h3 class="success">✅ Screenshot Success!</h3>' +
                         '<p>Size: ' + size + ' KB | Dimensions: ' + width + 'x' + height + '</p>' +
                         '<img src="' + imageUrl + '" alt="Screenshot"><br><br>' +
-                        '<a href="' + imageUrl + '" download="screenshot.jpg">💾 Download Image</a>';
+                        '<a href="' + imageUrl + '" download="screenshot.' + format + '">💾 Download Image</a>';
                 } else {
                     const error = await response.json();
                     document.getElementById('result').innerHTML = 
@@ -256,7 +265,7 @@ app.get('/demo', (req, res) => {
 
 // 截图端点
 app.post('/screenshot', authenticate, async (req, res) => {
-  const { url, width = 1280, height = 720, quality = 75 } = req.body;
+  const { url, width = 1280, height = 720, quality = 75, fullPage = false, format = 'jpeg' } = req.body;
 
   // 验证参数
   if (!url) {
@@ -267,6 +276,11 @@ app.post('/screenshot', authenticate, async (req, res) => {
     return res.status(400).json({ error: 'URL must start with http:// or https://' });
   }
 
+  // 验证图片格式
+  if (!['jpeg', 'png'].includes(format.toLowerCase())) {
+    return res.status(400).json({ error: 'Format must be either "jpeg" or "png"' });
+  }
+
   const cpuUsage = getCpuUsage();
   if (cpuUsage > 95) {
     return res.status(503).json({
@@ -339,13 +353,22 @@ app.post('/screenshot', authenticate, async (req, res) => {
       timeout: 15000 
     });
 
-    const screenshot = await page.screenshot({
-      type: 'jpeg',
-      quality: parseInt(quality),
-      fullPage: false
-    });
+    // 配置截图选项
+    const screenshotOptions = {
+      type: format.toLowerCase(),
+      fullPage: Boolean(fullPage)
+    };
+
+    // 只有 JPEG 格式才支持 quality 参数
+    if (format.toLowerCase() === 'jpeg') {
+      screenshotOptions.quality = parseInt(quality);
+    }
+
+    const screenshot = await page.screenshot(screenshotOptions);
 
-    res.set('Content-Type', 'image/jpeg');
+    // 设置正确的 Content-Type
+    const mimeType = format.toLowerCase() === 'png' ? 'image/png' : 'image/jpeg';
+    res.set('Content-Type', mimeType);
     res.send(screenshot);
 
   } catch (error) {