shotsnap - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

build/src/index.js

@@ -7,3 +7,3 @@ "use strict";
 exports.takeScreenshot = void 0;
-const takeScreenshot_1 = __importDefault(require("./controllers/takeScreenshot"));
-exports.takeScreenshot = takeScreenshot_1.default;
+const take_screenshot_1 = __importDefault(require("./services/take-screenshot"));
+exports.takeScreenshot = take_screenshot_1.default;

jest.config.js

 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testTimeout: 30000,
+};

package.json

 {
   "name": "shotsnap",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Node.js web screenshot library without any webdriver dependency",
@@ -8,3 +8,6 @@ "main": "build/src/index.js",
     "test": "jest",
-    "build": "tsc"
+    "build": "tsc",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   },
@@ -43,4 +46,5 @@ "repository": {
     "ts-jest": "^29.0.5",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "vitepress": "^1.0.0-rc.28"
   }
 }

Readme.md

@@ -1,30 +0,67 @@
- 
-<p align="left"><h3><a href="https://shotsnap.vercel.app/">Shotsnap</a></h3>
-Node.js web screenshot library without any webdriver dependency<br><br>
-<a href="https://www.producthunt.com/posts/shotsnap?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-shotsnap" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=361871&theme=light" alt="Shotsnap - screenshot&#0044;&#0032;web&#0032;capture | Product Hunt" height="30" /></a>
+<p align="center" class="logo-section">
+<img src="https://i.ibb.co/3dMGNbQ/9179fcb5-b9e2-4a34-be0a-80c4318ac199.png"/>
+</br>
+<img src="https://halitsever-api.vercel.app/api/repo-title?title=Shotsnap">
+
+<p align="center">
+📷 Node.js web screenshot library with cloud & local browser support<br>
+<br/>
+  <a  href="https://www.producthunt.com/posts/shotsnap?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-shotsnap"  target="_blank"><img  src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=361871&theme=light"  alt="Shotsnap - screenshot&#0044;&#0032;web&#0032;capture | Product Hunt"  height="30" /></a>
+<br/><br/>
+<img src="https://img.shields.io/github/sponsors/halitsever"/> 
+  <img src="https://img.shields.io/github/license/halitsever/shotsnap"/>
+
 </p>
-<p align="right"><img src="https://i.ibb.co/3dMGNbQ/9179fcb5-b9e2-4a34-be0a-80c4318ac199.png"></p>
-<h2 align="center">Usage</h2> 
 <p align="center">
+<a align="center" href="https://halitsever.github.io/shotsnap/">Documentation</a> | <a href="https://halitsever.github.io/shotsnap/">Website</a>
 
-<code align="center">
-const shotSnap = require("shotsnap");</code><br>
-<code align="center">
-shotSnap.takeScreenshot({ pageUrl: 'https://google.com', saveFile: true, fileName: 'test.png' });
-</code><br><br>
-<b>Result:</b><br>
-<img height="500px" src="https://i.ibb.co/W6JKvnz/screenshot-1.png">
+  </p>
 </p>
 
-<p align="center">
-<b>Props:</b> <br>
-<code>pageUrl: The page url you want to screenshot from</code><br>
-<code>saveFile: true or false </code><br>
-<code>fileName: filename for saving file</code><br>
-<code>screenHeight: number of screen height</code>
-<code>screenWidth: number of screen width</code>
+<a align="center">
+<img src="https://halitsever-api.vercel.app/api/details"/>
+</a>
 
+- 🧑‍💻 [**Can run on local**](#) - can run on local with webdriver
+- 📝 [**Can run on cloud**](#) - can run on cloud without webdriver
+- 🎨 [**Proxy support**](#) - use your proxies
+
+<a align="center" >
+<img src="https://halitsever-api.vercel.app/api/installation"/>
+</a>
+
+<b>Build</b>
+
+```bash
+npm run build
+```
+
+<b>Test</b>
+
+```bash
+npm run test
+```
+
+<b>Installation:</b>
+
+```bash
+npm i --save shotsnap
+```
+
+For more information you can check the <a href="https://halitsever.github.io/shotsnap/">documentation</a> page
+
+<a align="center" href="https://github.com/halitsever/shotsnap/issues">
+<img src="https://halitsever-api.vercel.app/api/issue"/>
+</a>
+
+<a align="center">
+<img src="https://halitsever-api.vercel.app/api/sponsor"/>
+</a>
+
+<a align="center">
+<img src="https://halitsever-api.vercel.app/api/license"/>
+</a>
+
+<p>
+  MIT License © 2021 <a href="https://www.github.com/halitsever">Halit Sever</a>
 </p>
-
-<h2 align="center">Sponsors</h2>
-<p align="center"><a href="https://papadigi.com/"><img height="100" src="https://i.ibb.co/w0xTp4N/Whats-App-Image-2022-10-08-at-16-30-55.jpg"></a></p>

src/index.ts

@@ -1,3 +0,3 @@
-import takeScreenshot from "./controllers/takeScreenshot";
+import takeScreenshot from "./services/take-screenshot";
 
 export { takeScreenshot };

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

28113

increased by9.78%

Number of package files

28

increased by40%

Lines of code

290

increased by5.07%

Number of lines in readme file

68

increased by119.35%

Worsened metrics

Dev dependency count

7

increased by16.67%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes