verify-image-url 1.5.0 → 1.5.1

package/README.md

@@ -1,6 +1,6 @@
 # verify-image-url
 
-A package to check if a URL is an image URL or not and also get the valid image link from it
+Verify if a URL is an image or extract the image URL from Open Graph meta tags.
 
 ## Install
 
@@ -16,21 +16,22 @@ const { verifyImageURL } = require('verify-image-url');
 await verifyImageURL('https://example.com/example.png');
 // -> { isImage: true, imageURL: 'https://example.com/example.png' }
 
-await verifyImageURL('https://example.com/example.png', { timeout: 10000 }); // Sets timeout to 10 seconds, default is 5
+// HTML page with og:image
+await verifyImageURL('https://giveaway.boats');
+// -> { isImage: true, imageURL: 'https://giveaway.boats/assets/logo.png' }
 
-await verifyImageURL('https://prnt.sc/zrfn0r');
-// -> { isImage: true, imageURL: 'https://image.prntscr.com/image/-ndZGuDMRfu7oDAR-fESzg.png' }
-// This link is from og:image meta tag since prnt.sc is a site where you can upload screenshots and get the web page url from it which isn't your image link but it's in the meta tag
+// Supports custom timeouts (default: 5s)
+await verifyImageURL('https://example.com/example.png', { timeout: 10000 });
 
-// Also works with SVGs
+// Works with SVGs
 await verifyImageURL('https://example.com/example.svg', { allowSVG: true });
 // -> { isImage: true, imageURL: 'https://example.com/example.svg' }
 
-// You can also have it send to a proxy if you want
+// Route through a proxy
 await verifyImageURL('https://example.com/example.png', { proxy: { url: 'https://proxy.example.com?url=' } });
 // This sends a GET request to https://proxy.example.com?url=https://example.com/example.png
 
-// Or if you'd like to protect your proxy with an auth, you can provide an auth like this:
-await verifyImageURL('https://example.com/example.png', { proxy: { url: 'https://proxy.example.com', auth: 'super secret auth' } });
-// This sends a POST request to the provided proxy url with the JSON body `{ method: 'GET', url: 'url' }` that the proxy can use to send request and send back the response
+// Proxy with authentication
+await verifyImageURL('https://example.com/example.png', { proxy: { url: 'https://proxy.example.com', auth: 'secret' } });
+// This sends a POST request to https://proxy.example.com with the JSON body `{ method: 'GET', url: 'https://example.com/example.png' }` along with Authorization header set to 'secret'
 ```

package/dist/index.js

@@ -1,19 +1,12 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyImageURL = void 0;
-const got_1 = __importDefault(require("got"));
-const image_type_1 = __importDefault(require("image-type"));
-const is_svg_1 = __importDefault(require("is-svg"));
-const is_url_1 = __importDefault(require("is-url"));
-const jsdom_1 = require("jsdom");
-const url_1 = require("url");
-const verifyImageURL = async (url, options) => {
-    var _a, _b, _c;
+import * as cheerio from 'cheerio';
+import got from 'got';
+import getImageType from 'image-type';
+import isSvg from 'is-svg';
+import isURL from 'is-url';
+import { URL } from 'url';
+export const verifyImageURL = async (url, options) => {
     const getReturnValue = (isImage = false, imageURL = url) => ({ isImage, imageURL });
-    if (!(0, is_url_1.default)(url))
+    if (!isURL(url))
         return getReturnValue();
     try {
         let requestURL;
@@ -21,44 +14,45 @@ const verifyImageURL = async (url, options) => {
             headers: {
                 'User-Agent': 'got',
             },
-            timeout: (_a = options === null || options === void 0 ? void 0 : options.timeout) !== null && _a !== void 0 ? _a : 5000,
+            timeout: options?.timeout ?? 5000,
         };
         // If proxy auth is provided, send a POST request to the proxy url with the provided auth
-        if ((_b = options === null || options === void 0 ? void 0 : options.proxy) === null || _b === void 0 ? void 0 : _b.auth) {
+        if (options?.proxy?.auth) {
             requestURL = options.proxy.url;
             requestOptions.method = 'POST';
             requestOptions.json = { method: 'GET', url };
             requestOptions.headers.Authorization = options.proxy.auth;
         }
         // Otherwise, if a proxy url is provided, use it
-        else if ((_c = options === null || options === void 0 ? void 0 : options.proxy) === null || _c === void 0 ? void 0 : _c.url)
+        else if (options?.proxy?.url)
             requestURL = `${options.proxy.url}${encodeURIComponent(url)}`;
         // Otherwise, send the request directly
         else
             requestURL = url;
-        const responseBuffer = (await (0, got_1.default)(requestURL, requestOptions)).rawBody;
-        const imageType = (0, image_type_1.default)(responseBuffer);
-        if (!(imageType === null || imageType === void 0 ? void 0 : imageType.mime.startsWith('image'))) {
+        const responseBuffer = (await got.default(requestURL, requestOptions)).rawBody;
+        const imageType = getImageType(responseBuffer);
+        if (!imageType?.mime.startsWith('image')) {
             if (responseBuffer.includes('og:image') || responseBuffer.includes('itemprop="image"')) {
-                const dom = new jsdom_1.JSDOM(responseBuffer);
-                const meta = dom.window.document.querySelector('meta[property="og:image"]') || dom.window.document.querySelector('meta[itemprop="image"]');
-                if (!(meta === null || meta === void 0 ? void 0 : meta.content))
+                const $ = cheerio.load(responseBuffer);
+                const meta = $('meta[property="og:image"]') || $('meta[itemprop="image"]');
+                let metaContent = meta?.attr('content');
+                if (!metaContent)
                     return getReturnValue();
-                if (meta.content[0] === '/' && meta.content[1] !== '/')
-                    meta.content = `${new url_1.URL(url).origin}${meta.content}`;
-                if (!(0, is_url_1.default)(meta.content))
+                if (metaContent[0] === '/' && metaContent[1] !== '/')
+                    metaContent = `${new URL(url).origin}${metaContent}`;
+                if (!isURL(metaContent))
                     return getReturnValue();
-                if (!/^https?:/.test(meta.content)) {
-                    if (/^\/\//.test(meta.content))
-                        meta.content = `http:${meta.content}`;
-                    else if (/^\//.test(meta.content))
-                        meta.content = `http:/${meta.content}`;
+                if (!/^https?:/.test(metaContent)) {
+                    if (/^\/\//.test(metaContent))
+                        metaContent = `http:${metaContent}`;
+                    else if (/^\//.test(metaContent))
+                        metaContent = `http:/${metaContent}`;
                     else
-                        meta.content = `http://${meta.content}`;
+                        metaContent = `http://${metaContent}`;
                 }
-                return getReturnValue(true, meta.content);
+                return getReturnValue(true, metaContent);
             }
-            else if ((options === null || options === void 0 ? void 0 : options.allowSVG) && (0, is_svg_1.default)(responseBuffer.toString()))
+            else if (options?.allowSVG && isSvg(responseBuffer.toString()))
                 return getReturnValue(true);
         }
         else
@@ -70,4 +64,3 @@ const verifyImageURL = async (url, options) => {
     }
     return getReturnValue();
 };
-exports.verifyImageURL = verifyImageURL;

package/package.json

@@ -1,9 +1,10 @@
 {
     "name": "verify-image-url",
-    "version": "1.5.0",
+    "version": "1.5.1",
     "description": "A package to check if a URL is an image URL or not and also get the valid image link from it",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
+    "type": "module",
     "scripts": {
         "build": "tsc",
         "prepare": "npm run build"
@@ -26,14 +27,13 @@
     },
     "homepage": "https://github.com/AwesomeStickz/verify-image-url#readme",
     "dependencies": {
+        "cheerio": "^1.2.0",
         "got": "^11.8.2",
         "image-type": "^4.1.0",
         "is-svg": "^6.1.0",
-        "is-url": "^1.2.4",
-        "jsdom": "^16.4.0"
+        "is-url": "^1.2.4"
     },
     "devDependencies": {
-        "@types/is-url": "^1.2.28",
-        "@types/jsdom": "^16.2.6"
+        "@types/is-url": "^1.2.28"
     }
 }

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-export declare const verifyImageURL: (url: string, options?: {
-    allowSVG?: boolean;
-    proxy?: {
-        url: string;
-        auth?: string;
-    };
-    timeout?: number;
-}) => Promise<{
-    isImage: boolean;
-    imageURL: string;
-}>;