pixel-serve-server 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hiprax
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,207 @@
+# Image Server Middleware
+
+A powerful and customizable middleware for processing, resizing, and serving images in Node.js applications. Built with **TypeScript** and powered by **Sharp**, this package allows you to handle local and network images with robust error handling, fallback images, and customizable options.
+
+---
+
+## Features
+
+- 🖼️ **Dynamic Image Resizing and Formatting**
+
+  - Supports various formats: `jpeg`, `png`, `webp`, `gif`, `tiff`, `avif`, and `svg`.
+  - Adjustable dimensions with constraints for safety.
+
+- 🌐 **Network and Local File Handling**
+
+  - Fetches images from allowed network domains.
+  - Processes images stored locally with safe path validation.
+
+- 🔒 **Fallback Images**
+
+  - Provides fallback images for invalid or missing sources.
+
+- 🔧 **Highly Configurable**
+
+  - Flexible option to set base directories, private folders, and user-specific paths.
+  - Supports user-defined ID handlers and folder logic.
+
+- 🚀 **Efficient and Scalable**
+  - Built on **Sharp** for high-performance image processing.
+  - Handles concurrent requests with ease.
+
+---
+
+## Installation
+
+Install the package using npm or yarn:
+
+```bash
+npm install pixel-serve-server
+```
+
+---
+
+## Usage
+
+### Basic Setup
+
+Here’s how to integrate the middleware with an Express application:
+
+```typescript
+import express from "express";
+import serveImage from "pixel-serve-server";
+
+const app = express();
+
+const options = {
+  baseDir: "/path/to/images", // Base directory for local images
+  idHandler: (id: string) => `user-${id}`, // Custom handler for user IDs
+  getUserFolder: async (id: string) => `/private/users/${id}`, // Logic for user-specific folder paths
+  websiteURL: "example.com", // Your website's base URL
+  apiRegex: /^\/api\/v1\//, // Regex for removing API prefixes
+  allowedNetworkList: ["trusted.com"], // List of allowed network domains
+};
+
+app.get("/api/v1/pixel/serve", (req, res, next) =>
+  serveImage(req, res, next, options)
+);
+
+app.listen(3000, () => {
+  console.log("Server is running on http://localhost:3000");
+});
+```
+
+---
+
+### Options
+
+The `serveImage` middleware accepts the following options:
+
+| Option               | Type       | Description                                                 |
+| -------------------- | ---------- | ----------------------------------------------------------- |
+| `baseDir`            | `string`   | Base directory for local image files.                       |
+| `idHandler`          | `Function` | Function to handle and format user IDs.                     |
+| `getUserFolder`      | `Function` | Async function to resolve a user-specific folder path.      |
+| `websiteURL`         | `string`   | Your website's base URL for identifying internal resources. |
+| `apiRegex`           | `RegExp`   | Regex to strip API prefixes from internal paths.            |
+| `allowedNetworkList` | `string[]` | List of allowed domains for network images.                 |
+
+---
+
+### Example Requests
+
+#### Fetching a Local Image
+
+```bash
+GET http://localhost:3000/images?src=/uploads/image1.jpg&width=300&height=300
+```
+
+#### Fetching a Network Image
+
+```bash
+GET http://localhost:3000/images?src=https://trusted.com/image2.jpg&format=webp
+```
+
+#### Handling Private User Folders
+
+```bash
+GET http://localhost:3000/images?src=/avatar.jpg&folder=private&userId=12345
+```
+
+---
+
+### User Data Parameters
+
+The middleware uses the following `UserData` query parameters:
+
+| Parameter | Type                    | Description                                          |
+| --------- | ----------------------- | ---------------------------------------------------- |
+| `src`     | `string`                | Path or URL to the image source.                     |
+| `format`  | `ImageFormat`           | Desired output format (e.g., `jpeg`, `png`, `webp`). |
+| `width`   | `number`                | Desired width of the output image.                   |
+| `height`  | `number`                | Desired height of the output image.                  |
+| `quality` | `number`                | Image quality (1-100, default: 80).                  |
+| `folder`  | `'public' \| 'private'` | Image folder type (default: `public`).               |
+| `userId`  | `string \| null`        | User ID for private folder access.                   |
+| `type`    | `'normal' \| 'avatar'`  | Image type (default: `normal`).                      |
+
+---
+
+### Image Formats
+
+The following image formats are supported:
+
+- `jpeg`
+- `jpg`
+- `png`
+- `webp`
+- `gif`
+- `tiff`
+- `avif`
+- `svg`
+
+Each format is processed with the specified quality settings.
+
+---
+
+### Advanced Configuration
+
+#### Custom ID Handler
+
+Use the `idHandler` option to customize how user IDs are formatted.
+
+```typescript
+const options = {
+  idHandler: (id) => `user-${id.toUpperCase()}`, // Converts ID to uppercase with "user-" prefix
+};
+```
+
+#### Resolving User Folders
+
+The `getUserFolder` function dynamically resolves private folder paths for users.
+
+```typescript
+const options = {
+  getUserFolder: async (id) => `/private/data/users/${id}`, // Returns a private directory path
+};
+```
+
+#### Allowed Network Domains
+
+Whitelist trusted domains for fetching network images.
+
+```typescript
+const options = {
+  allowedNetworkList: ["example.com", "cdn.example.com"], // Only allows images from these domains
+};
+```
+
+---
+
+### Error Handling
+
+The middleware automatically falls back to pre-defined images for errors:
+
+| Error Condition               | Fallback Behavior               |
+| ----------------------------- | ------------------------------- |
+| Invalid local path            | Returns a fallback image.       |
+| Unsupported network domain    | Returns a fallback image.       |
+| Invalid or missing parameters | Defaults to placeholder values. |
+
+### Dependencies
+
+This package uses the following dependencies:
+
+- **Express**: HTTP server framework.
+- **Sharp**: High-performance image processing.
+- **Axios**: HTTP client for fetching network images.
+
+---
+
+### License
+
+This package is licensed under the [MIT License](LICENSE).
+
+### Feedback
+
+If you encounter issues or have suggestions, feel free to open an [issue](https://github.com/Hiprax/pixel-serve-server/issues).

package/dist/index.d.mts

@@ -0,0 +1,49 @@
+import { Request, Response, NextFunction } from 'express';
+
+type ImageType = "avatar" | "normal";
+type ImageFormat = "jpeg" | "jpg" | "png" | "webp" | "gif" | "tiff" | "avif" | "svg";
+type Options = {
+    baseDir: string;
+    idHandler: (id: string) => string;
+    getUserFolder: (id: string, req: Request) => Promise<string>;
+    websiteURL: string;
+    apiRegex: RegExp;
+    allowedNetworkList: string[];
+};
+type UserData = {
+    quality: number | string;
+    format: ImageFormat;
+    src?: string;
+    folder?: string;
+    type?: ImageType;
+    userId?: string;
+    width?: number | string;
+    height?: number | string;
+};
+
+/**
+ * @typedef {Object} Options
+ * @property {string} baseDir - The base directory for public image files.
+ * @property {function(string): string} idHandler - A function to handle user IDs.
+ * @property {function(string, Request): Promise<string>} getUserFolder - Asynchronous function to retrieve user-specific folders.
+ * @property {string} websiteURL - The base URL of the website for internal link resolution.
+ * @property {RegExp} apiRegex - Regex to parse API endpoints from URLs.
+ * @property {string[]} allowedNetworkList - List of allowed network domains for external image fetching.
+ */
+/**
+ * @function serveImage
+ * @description Processes and serves an image based on user data and options.
+ * @param {Request} req - The Express request object.
+ * @param {Response} res - The Express response object.
+ * @param {NextFunction} next - The Express next middleware function.
+ * @param {Options} options - The options object for image processing.
+ * @returns {Promise<void>}
+ */
+declare const serveImage: (req: Request, res: Response, next: NextFunction, options: Options) => Promise<void>;
+
+/**
+ * @module ImageService
+ * @description A module to serve, process, and manage image delivery for web applications.
+ */
+
+export { type ImageFormat, type ImageType, type Options, type UserData, serveImage as default };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { Request, Response, NextFunction } from 'express';
+
+type ImageType = "avatar" | "normal";
+type ImageFormat = "jpeg" | "jpg" | "png" | "webp" | "gif" | "tiff" | "avif" | "svg";
+type Options = {
+    baseDir: string;
+    idHandler: (id: string) => string;
+    getUserFolder: (id: string, req: Request) => Promise<string>;
+    websiteURL: string;
+    apiRegex: RegExp;
+    allowedNetworkList: string[];
+};
+type UserData = {
+    quality: number | string;
+    format: ImageFormat;
+    src?: string;
+    folder?: string;
+    type?: ImageType;
+    userId?: string;
+    width?: number | string;
+    height?: number | string;
+};
+
+/**
+ * @typedef {Object} Options
+ * @property {string} baseDir - The base directory for public image files.
+ * @property {function(string): string} idHandler - A function to handle user IDs.
+ * @property {function(string, Request): Promise<string>} getUserFolder - Asynchronous function to retrieve user-specific folders.
+ * @property {string} websiteURL - The base URL of the website for internal link resolution.
+ * @property {RegExp} apiRegex - Regex to parse API endpoints from URLs.
+ * @property {string[]} allowedNetworkList - List of allowed network domains for external image fetching.
+ */
+/**
+ * @function serveImage
+ * @description Processes and serves an image based on user data and options.
+ * @param {Request} req - The Express request object.
+ * @param {Response} res - The Express response object.
+ * @param {NextFunction} next - The Express next middleware function.
+ * @param {Options} options - The options object for image processing.
+ * @returns {Promise<void>}
+ */
+declare const serveImage: (req: Request, res: Response, next: NextFunction, options: Options) => Promise<void>;
+
+/**
+ * @module ImageService
+ * @description A module to serve, process, and manage image delivery for web applications.
+ */
+
+export { type ImageFormat, type ImageType, type Options, type UserData, serveImage as default };

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";var D=Object.create;var d=Object.defineProperty;var M=Object.getOwnPropertyDescriptor;var _=Object.getOwnPropertyNames;var C=Object.getPrototypeOf,S=Object.prototype.hasOwnProperty;var B=(e,r)=>{for(var i in r)d(e,i,{get:r[i],enumerable:!0})},U=(e,r,i,a)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of _(r))!S.call(e,t)&&t!==i&&d(e,t,{get:()=>r[t],enumerable:!(a=M(r,t))||a.enumerable});return e};var g=(e,r,i)=>(i=e!=null?D(C(e)):{},U(r||!e||!e.__esModule?d(i,"default",{value:e,enumerable:!0}):i,e)),P=e=>U(d({},"__esModule",{value:!0}),e);var V={};B(V,{default:()=>K});module.exports=P(V);var G=()=>typeof document>"u"?new URL(`file:${__filename}`).href:document.currentScript&&document.currentScript.src||new URL("main.js",document.baseURI).href,s=G();var R=g(require("path")),F=g(require("sharp"));var I=require("fs/promises"),H=new URL("./assets/noimage.jpg",s).href,$=new URL("./assets/noavatar.png",s).href,p={normal:async()=>(0,I.readFile)(H),avatar:async()=>(0,I.readFile)($)},c=/^\/api\/v1\//,b=["jpeg","jpg","png","webp","gif","tiff","avif","svg"],u={jpeg:"image/jpeg",jpg:"image/jpeg",png:"image/png",webp:"image/webp",gif:"image/gif",tiff:"image/tiff",avif:"image/avif",svg:"image/svg+xml"};var y=g(require("path")),v=require("fs"),O=g(require("fs/promises")),T=g(require("axios"));var k=(e,r)=>{if(!e||!r)return!1;let i=y.default.resolve(e),a=y.default.resolve(i,r);return a.startsWith(i)&&(0,v.existsSync)(a)},z=async(e,r="normal")=>{try{let i=await T.default.get(e,{responseType:"arraybuffer",timeout:5e3}),a=i.headers["content-type"]?.toLowerCase();return Object.values(u).includes(a??"")?Buffer.from(i.data):await p[r]()}catch{return await p[r]()}},x=async(e,r,i="normal")=>{if(!k(r,e))return await p[i]();try{return await O.readFile(y.default.resolve(r,e))}catch{return await p[i]()}},L=(e,r,i,a="normal",t=c,o=[])=>{let n=new URL(e);if([i,`www.${i}`].includes(n.host)){let m=n.pathname.replace(t,"");return x(m,r,a)}else return o.includes(n.host)?z(e,a):p[a]()};var j=e=>({...{baseDir:"",idHandler:i=>i,getUserFolder:async()=>"",websiteURL:"",apiRegex:c,allowedNetworkList:[]},...e}),E=e=>({...{quality:80,format:"jpeg",src:"/placeholder/noimage.jpg",folder:"public",type:"normal",width:void 0,height:void 0,userId:void 0},...e,quality:e.quality?Math.min(Math.max(Number(e.quality)||80,1),100):100,width:e.width?Math.min(Math.max(Number(e.width),50),2e3):void 0,height:e.height?Math.min(Math.max(Number(e.height),50),2e3):void 0});var X=async(e,r,i,a)=>{try{let t=E(e.query),o=j(a),n,f=o.baseDir,m;if(t.userId){let l=typeof t.userId=="object"?String(Object.values(t.userId)[0]):String(t.userId);o.idHandler?m=o.idHandler(l):m=l}t.folder==="private"&&m&&(f=await o.getUserFolder(m,e));let h=b.includes(t.format.toLowerCase())?t.format.toLowerCase():"jpeg";t?.src?.startsWith("http")?n=await L(t.src,f,o.websiteURL,t.type,o.apiRegex):n=await x(t?.src??"",f,t.type);let w=(0,F.default)(n);if(t?.width||t?.height){let l={width:t?.width??void 0,height:t?.height??void 0,fit:F.default.fit.cover};w=w.resize(l)}let q=await w.toFormat(h,{quality:t?.quality?Number(t.quality):80}).toBuffer(),A=`${R.default.basename(t.src??"",R.default.extname(t.src??""))}.${h}`;r.type(u[h]),r.setHeader("Content-Disposition",`inline; filename="${A}"`),r.send(q)}catch(t){i(t)}},N=X;var K=N;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../node_modules/tsup/assets/cjs_shims.js","../src/pixel.ts","../src/variables.ts","../src/functions.ts","../src/renders.ts"],"sourcesContent":["/**\n * @module ImageService\n * @description A module to serve, process, and manage image delivery for web applications.\n */\n\nimport serveImage from \"./pixel\";\nexport * from \"./types\";\n\nexport default serveImage;\n","// Shim globals in cjs bundle\n// There's a weird bug that esbuild will always inject importMetaUrl\n// if we export it as `const importMetaUrl = ... __filename ...`\n// But using a function will not cause this issue\n\nconst getImportMetaUrl = () =>\n  typeof document === 'undefined'\n    ? new URL(`file:${__filename}`).href\n    : (document.currentScript && document.currentScript.src) ||\n      new URL('main.js', document.baseURI).href\n\nexport const importMetaUrl = /* @__PURE__ */ getImportMetaUrl()\n","import path from \"node:path\";\nimport sharp, { FormatEnum, ResizeOptions } from \"sharp\";\nimport type { Request, Response, NextFunction } from \"express\";\nimport type { Options, UserData, ImageFormat, ImageType } from \"./types\";\nimport { allowedFormats, mimeTypes } from \"./variables\";\nimport { fetchImage, readLocalImage } from \"./functions\";\nimport { renderOptions, renderUserData } from \"./renders\";\n\n/**\n * @typedef {Object} Options\n * @property {string} baseDir - The base directory for public image files.\n * @property {function(string): string} idHandler - A function to handle user IDs.\n * @property {function(string, Request): Promise<string>} getUserFolder - Asynchronous function to retrieve user-specific folders.\n * @property {string} websiteURL - The base URL of the website for internal link resolution.\n * @property {RegExp} apiRegex - Regex to parse API endpoints from URLs.\n * @property {string[]} allowedNetworkList - List of allowed network domains for external image fetching.\n */\n\n/**\n * @function serveImage\n * @description Processes and serves an image based on user data and options.\n * @param {Request} req - The Express request object.\n * @param {Response} res - The Express response object.\n * @param {NextFunction} next - The Express next middleware function.\n * @param {Options} options - The options object for image processing.\n * @returns {Promise<void>}\n */\nconst serveImage = async (\n  req: Request,\n  res: Response,\n  next: NextFunction,\n  options: Options\n) => {\n  try {\n    const userData = renderUserData(req.query as UserData);\n    const parsedOptions = renderOptions(options);\n\n    let imageBuffer;\n    let baseDir = parsedOptions.baseDir;\n    let parsedUserId;\n\n    if (userData.userId) {\n      const userIdStr =\n        typeof userData.userId === \"object\"\n          ? String(Object.values(userData.userId)[0])\n          : String(userData.userId);\n      if (parsedOptions.idHandler) {\n        parsedUserId = parsedOptions.idHandler(userIdStr);\n      } else {\n        parsedUserId = userIdStr;\n      }\n    }\n\n    if (userData.folder === \"private\" && parsedUserId) {\n      baseDir = await parsedOptions.getUserFolder(parsedUserId, req);\n    }\n\n    const outputFormat = allowedFormats.includes(\n      userData.format.toLowerCase() as ImageFormat\n    )\n      ? userData.format.toLowerCase()\n      : \"jpeg\";\n\n    if (userData?.src?.startsWith(\"http\")) {\n      imageBuffer = await fetchImage(\n        userData.src,\n        baseDir,\n        parsedOptions.websiteURL,\n        userData.type as ImageType,\n        parsedOptions.apiRegex\n      );\n    } else {\n      imageBuffer = await readLocalImage(\n        userData?.src ?? \"\",\n        baseDir,\n        userData.type as ImageType\n      );\n    }\n\n    let image = sharp(imageBuffer);\n\n    if (userData?.width || userData?.height) {\n      const resizeOptions = {\n        width: userData?.width ?? undefined,\n        height: userData?.height ?? undefined,\n        fit: sharp.fit.cover,\n      };\n      image = image.resize(resizeOptions as ResizeOptions);\n    }\n\n    const processedImage = await image\n      .toFormat(outputFormat as keyof FormatEnum, {\n        quality: userData?.quality ? Number(userData.quality) : 80,\n      })\n      .toBuffer();\n\n    const processedFileName = `${path.basename(\n      userData.src ?? \"\",\n      path.extname(userData.src ?? \"\")\n    )}.${outputFormat}`;\n\n    res.type(mimeTypes[outputFormat]);\n    res.setHeader(\n      \"Content-Disposition\",\n      `inline; filename=\"${processedFileName}\"`\n    );\n    res.send(processedImage);\n  } catch (error) {\n    next(error);\n  }\n};\n\nexport default serveImage;\n","import type { ImageFormat } from \"./types\";\nimport { readFile } from \"node:fs/promises\";\n\nconst NOT_FOUND_IMAGE = new URL(\"./assets/noimage.jpg\", import.meta.url).href;\n\nconst NOT_FOUND_AVATAR = new URL(\"./assets/noavatar.png\", import.meta.url).href;\n\nexport const FALLBACKIMAGES = {\n  normal: async () => readFile(NOT_FOUND_IMAGE),\n  avatar: async () => readFile(NOT_FOUND_AVATAR),\n};\n\nexport const API_REGEX: RegExp = /^\\/api\\/v1\\//;\n\nexport const allowedFormats: ImageFormat[] = [\n  \"jpeg\",\n  \"jpg\",\n  \"png\",\n  \"webp\",\n  \"gif\",\n  \"tiff\",\n  \"avif\",\n  \"svg\",\n];\n\nexport const mimeTypes: Readonly<Record<string, string>> = {\n  jpeg: \"image/jpeg\",\n  jpg: \"image/jpeg\",\n  png: \"image/png\",\n  webp: \"image/webp\",\n  gif: \"image/gif\",\n  tiff: \"image/tiff\",\n  avif: \"image/avif\",\n  svg: \"image/svg+xml\",\n};\n","import path from \"node:path\";\nimport { existsSync } from \"node:fs\";\nimport * as fs from \"node:fs/promises\";\nimport axios from \"axios\";\nimport { mimeTypes, API_REGEX, FALLBACKIMAGES } from \"./variables\";\nimport type { ImageType } from \"./types\";\n\n/**\n * @typedef {(\"avatar\" | \"normal\")} ImageType\n * @description Defines the type of image being processed.\n */\n\n/**\n * Checks if a specified path is valid within a base path.\n *\n * @param {string} basePath - The base directory to resolve paths.\n * @param {string} specifiedPath - The path to check.\n * @returns {boolean} True if the path is valid, false otherwise.\n */\nconst isValidPath = (basePath: string, specifiedPath: string): boolean => {\n  if (!basePath || !specifiedPath) return false;\n  const resolvedBase = path.resolve(basePath);\n  const resolvedPath = path.resolve(resolvedBase, specifiedPath);\n  return resolvedPath.startsWith(resolvedBase) && existsSync(resolvedPath);\n};\n\n/**\n * Fetches an image from a network source.\n *\n * @param {string} src - The URL of the image.\n * @param {ImageType} [type=\"normal\"] - Type of fallback image in case of an error.\n * @returns {Promise<Buffer>} A buffer containing the image data or a fallback image.\n */\nconst fetchFromNetwork = async (\n  src: string,\n  type: ImageType = \"normal\"\n): Promise<Buffer> => {\n  try {\n    const response = await axios.get(src, {\n      responseType: \"arraybuffer\",\n      timeout: 5000,\n    });\n\n    const contentType = response.headers[\"content-type\"]?.toLowerCase();\n    const allowedMimeTypes = Object.values(mimeTypes);\n\n    if (allowedMimeTypes.includes(contentType ?? \"\")) {\n      return Buffer.from(response.data);\n    }\n    return await FALLBACKIMAGES[type]();\n  } catch (error) {\n    return await FALLBACKIMAGES[type]();\n  }\n};\n\n/**\n * Reads an image from the local file system.\n *\n * @param {string} filePath - Path to the image file.\n * @param {string} baseDir - Base directory to resolve paths.\n * @param {ImageType} [type=\"normal\"] - Type of fallback image if the path is invalid.\n * @returns {Promise<Buffer>} A buffer containing the image data.\n */\nexport const readLocalImage = async (\n  filePath: string,\n  baseDir: string,\n  type: ImageType = \"normal\"\n) => {\n  if (!isValidPath(baseDir, filePath)) {\n    return await FALLBACKIMAGES[type]();\n  }\n  try {\n    return await fs.readFile(path.resolve(baseDir, filePath));\n  } catch (error) {\n    return await FALLBACKIMAGES[type]();\n  }\n};\n\n/**\n * Fetches an image from either a local file or a network source.\n *\n * @param {string} src - The URL or local path of the image.\n * @param {string} baseDir - Base directory to resolve local paths.\n * @param {string} websiteURL - The URL of the website.\n * @param {ImageType} [type=\"normal\"] - Type of fallback image if the path is invalid.\n * @param {RegExp} [apiRegex=API_REGEX] - Regular expression to match API routes.\n * @param {string[]} [allowedNetworkList=[]] - List of allowed network hosts.\n * @returns {Promise<Buffer>} A buffer containing the image data or a fallback image.\n */\nexport const fetchImage = (\n  src: string,\n  baseDir: string,\n  websiteURL: string,\n  type: ImageType = \"normal\",\n  apiRegex: RegExp = API_REGEX,\n  allowedNetworkList: string[] = []\n) => {\n  const url = new URL(src);\n  const isInternal = [websiteURL, `www.${websiteURL}`].includes(url.host);\n  if (isInternal) {\n    const localPath = url.pathname.replace(apiRegex, \"\");\n    return readLocalImage(localPath, baseDir, type);\n  } else {\n    const allowedCondition = allowedNetworkList.includes(url.host);\n    if (!allowedCondition) {\n      return FALLBACKIMAGES[type]();\n    }\n    return fetchFromNetwork(src, type);\n  }\n};\n","import { API_REGEX } from \"./variables\";\nimport type { Options, UserData } from \"./types\";\n\n/**\n * @typedef {(\"avatar\" | \"normal\")} ImageType\n * @description Defines the type of image being processed.\n */\n\n/**\n * @typedef {(\"jpeg\" | \"jpg\" | \"png\" | \"webp\" | \"gif\" | \"tiff\" | \"avif\" | \"svg\")} ImageFormat\n * @description Supported formats for image processing.\n */\n\n/**\n * @typedef {Object} Options\n * @property {string} baseDir - The base directory for public image files.\n * @property {function(string): string} idHandler - A function to handle user IDs.\n * @property {function(string, Request): Promise<string>} getUserFolder - Asynchronous function to retrieve user-specific folders.\n * @property {string} websiteURL - The base URL of the website for internal link resolution.\n * @property {RegExp} apiRegex - Regex to parse API endpoints from URLs.\n * @property {string[]} allowedNetworkList - List of allowed network domains for external image fetching.\n */\n\n/**\n * @typedef {Object} UserData\n * @property {number|string} quality - Quality of the image (1–100).\n * @property {ImageFormat} format - Desired format of the image.\n * @property {string} [src] - Source path or URL for the image.\n * @property {string} [folder] - The folder type (\"public\" or \"private\").\n * @property {ImageType} [type] - Type of the image (\"avatar\" or \"normal\").\n * @property {string|null} [userId] - Optional user identifier.\n * @property {number|string} [width] - Desired image width.\n * @property {number|string} [height] - Desired image height.\n */\n\n/**\n * Renders the options object with default values and user-provided values.\n *\n * @param {Partial<Options>} options - The user-provided options.\n * @returns {Options} The rendered options object.\n */\nexport const renderOptions = (options: Partial<Options>): Options => {\n  const initialOptions: Options = {\n    baseDir: \"\",\n    idHandler: (id: string) => id,\n    getUserFolder: async () => \"\",\n    websiteURL: \"\",\n    apiRegex: API_REGEX,\n    allowedNetworkList: [],\n  };\n  return {\n    ...initialOptions,\n    ...options,\n  };\n};\n\n/**\n * Renders the user data object with default values and user-provided values.\n *\n * @param {Partial<UserData>} userData - The user-provided data.\n * @returns {UserData} The rendered user data object.\n */\nexport const renderUserData = (userData: Partial<UserData>): UserData => {\n  const initialUserData: UserData = {\n    quality: 80,\n    format: \"jpeg\",\n    src: \"/placeholder/noimage.jpg\",\n    folder: \"public\",\n    type: \"normal\",\n    width: undefined,\n    height: undefined,\n    userId: undefined,\n  };\n  return {\n    ...initialUserData,\n    ...userData,\n    quality: userData.quality\n      ? Math.min(Math.max(Number(userData.quality) || 80, 1), 100)\n      : 100,\n    width: userData.width\n      ? Math.min(Math.max(Number(userData.width), 50), 2000)\n      : undefined,\n    height: userData.height\n      ? Math.min(Math.max(Number(userData.height), 50), 2000)\n      : undefined,\n  };\n};\n"],"mappings":"0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,aAAAE,IAAA,eAAAC,EAAAH,GCKA,IAAMI,EAAmB,IACvB,OAAO,SAAa,IAChB,IAAI,IAAI,QAAQ,UAAU,EAAE,EAAE,KAC7B,SAAS,eAAiB,SAAS,cAAc,KAClD,IAAI,IAAI,UAAW,SAAS,OAAO,EAAE,KAE9BC,EAAgCD,EAAiB,ECX9D,IAAAE,EAAiB,mBACjBC,EAAiD,oBCAjD,IAAAC,EAAyB,uBAEnBC,EAAkB,IAAI,IAAI,uBAAwBC,CAAe,EAAE,KAEnEC,EAAmB,IAAI,IAAI,wBAAyBD,CAAe,EAAE,KAE9DE,EAAiB,CAC5B,OAAQ,YAAY,YAASH,CAAe,EAC5C,OAAQ,YAAY,YAASE,CAAgB,CAC/C,EAEaE,EAAoB,eAEpBC,EAAgC,CAC3C,OACA,MACA,MACA,OACA,MACA,OACA,OACA,KACF,EAEaC,EAA8C,CACzD,KAAM,aACN,IAAK,aACL,IAAK,YACL,KAAM,aACN,IAAK,YACL,KAAM,aACN,KAAM,aACN,IAAK,eACP,EClCA,IAAAC,EAAiB,mBACjBC,EAA2B,cAC3BC,EAAoB,0BACpBC,EAAkB,oBAgBlB,IAAMC,EAAc,CAACC,EAAkBC,IAAmC,CACxE,GAAI,CAACD,GAAY,CAACC,EAAe,MAAO,GACxC,IAAMC,EAAe,EAAAC,QAAK,QAAQH,CAAQ,EACpCI,EAAe,EAAAD,QAAK,QAAQD,EAAcD,CAAa,EAC7D,OAAOG,EAAa,WAAWF,CAAY,MAAK,cAAWE,CAAY,CACzE,EASMC,EAAmB,MACvBC,EACAC,EAAkB,WACE,CACpB,GAAI,CACF,IAAMC,EAAW,MAAM,EAAAC,QAAM,IAAIH,EAAK,CACpC,aAAc,cACd,QAAS,GACX,CAAC,EAEKI,EAAcF,EAAS,QAAQ,cAAc,GAAG,YAAY,EAGlE,OAFyB,OAAO,OAAOG,CAAS,EAE3B,SAASD,GAAe,EAAE,EACtC,OAAO,KAAKF,EAAS,IAAI,EAE3B,MAAMI,EAAeL,CAAI,EAAE,CACpC,MAAgB,CACd,OAAO,MAAMK,EAAeL,CAAI,EAAE,CACpC,CACF,EAUaM,EAAiB,MAC5BC,EACAC,EACAR,EAAkB,WACf,CACH,GAAI,CAACR,EAAYgB,EAASD,CAAQ,EAChC,OAAO,MAAMF,EAAeL,CAAI,EAAE,EAEpC,GAAI,CACF,OAAO,MAAS,WAAS,EAAAJ,QAAK,QAAQY,EAASD,CAAQ,CAAC,CAC1D,MAAgB,CACd,OAAO,MAAMF,EAAeL,CAAI,EAAE,CACpC,CACF,EAaaS,EAAa,CACxBV,EACAS,EACAE,EACAV,EAAkB,SAClBW,EAAmBC,EACnBC,EAA+B,CAAC,IAC7B,CACH,IAAMC,EAAM,IAAI,IAAIf,CAAG,EAEvB,GADmB,CAACW,EAAY,OAAOA,CAAU,EAAE,EAAE,SAASI,EAAI,IAAI,EACtD,CACd,IAAMC,EAAYD,EAAI,SAAS,QAAQH,EAAU,EAAE,EACnD,OAAOL,EAAeS,EAAWP,EAASR,CAAI,CAChD,KAEE,QADyBa,EAAmB,SAASC,EAAI,IAAI,EAItDhB,EAAiBC,EAAKC,CAAI,EAFxBK,EAAeL,CAAI,EAAE,CAIlC,ECpEO,IAAMgB,EAAiBC,IASrB,CACL,GAT8B,CAC9B,QAAS,GACT,UAAYC,GAAeA,EAC3B,cAAe,SAAY,GAC3B,WAAY,GACZ,SAAUC,EACV,mBAAoB,CAAC,CACvB,EAGE,GAAGF,CACL,GASWG,EAAkBC,IAWtB,CACL,GAXgC,CAChC,QAAS,GACT,OAAQ,OACR,IAAK,2BACL,OAAQ,SACR,KAAM,SACN,MAAO,OACP,OAAQ,OACR,OAAQ,MACV,EAGE,GAAGA,EACH,QAASA,EAAS,QACd,KAAK,IAAI,KAAK,IAAI,OAAOA,EAAS,OAAO,GAAK,GAAI,CAAC,EAAG,GAAG,EACzD,IACJ,MAAOA,EAAS,MACZ,KAAK,IAAI,KAAK,IAAI,OAAOA,EAAS,KAAK,EAAG,EAAE,EAAG,GAAI,EACnD,OACJ,OAAQA,EAAS,OACb,KAAK,IAAI,KAAK,IAAI,OAAOA,EAAS,MAAM,EAAG,EAAE,EAAG,GAAI,EACpD,MACN,GH1DF,IAAMC,EAAa,MACjBC,EACAC,EACAC,EACAC,IACG,CACH,GAAI,CACF,IAAMC,EAAWC,EAAeL,EAAI,KAAiB,EAC/CM,EAAgBC,EAAcJ,CAAO,EAEvCK,EACAC,EAAUH,EAAc,QACxBI,EAEJ,GAAIN,EAAS,OAAQ,CACnB,IAAMO,EACJ,OAAOP,EAAS,QAAW,SACvB,OAAO,OAAO,OAAOA,EAAS,MAAM,EAAE,CAAC,CAAC,EACxC,OAAOA,EAAS,MAAM,EACxBE,EAAc,UAChBI,EAAeJ,EAAc,UAAUK,CAAS,EAEhDD,EAAeC,CAEnB,CAEIP,EAAS,SAAW,WAAaM,IACnCD,EAAU,MAAMH,EAAc,cAAcI,EAAcV,CAAG,GAG/D,IAAMY,EAAeC,EAAe,SAClCT,EAAS,OAAO,YAAY,CAC9B,EACIA,EAAS,OAAO,YAAY,EAC5B,OAEAA,GAAU,KAAK,WAAW,MAAM,EAClCI,EAAc,MAAMM,EAClBV,EAAS,IACTK,EACAH,EAAc,WACdF,EAAS,KACTE,EAAc,QAChB,EAEAE,EAAc,MAAMO,EAClBX,GAAU,KAAO,GACjBK,EACAL,EAAS,IACX,EAGF,IAAIY,KAAQ,EAAAC,SAAMT,CAAW,EAE7B,GAAIJ,GAAU,OAASA,GAAU,OAAQ,CACvC,IAAMc,EAAgB,CACpB,MAAOd,GAAU,OAAS,OAC1B,OAAQA,GAAU,QAAU,OAC5B,IAAK,EAAAa,QAAM,IAAI,KACjB,EACAD,EAAQA,EAAM,OAAOE,CAA8B,CACrD,CAEA,IAAMC,EAAiB,MAAMH,EAC1B,SAASJ,EAAkC,CAC1C,QAASR,GAAU,QAAU,OAAOA,EAAS,OAAO,EAAI,EAC1D,CAAC,EACA,SAAS,EAENgB,EAAoB,GAAG,EAAAC,QAAK,SAChCjB,EAAS,KAAO,GAChB,EAAAiB,QAAK,QAAQjB,EAAS,KAAO,EAAE,CACjC,CAAC,IAAIQ,CAAY,GAEjBX,EAAI,KAAKqB,EAAUV,CAAY,CAAC,EAChCX,EAAI,UACF,sBACA,qBAAqBmB,CAAiB,GACxC,EACAnB,EAAI,KAAKkB,CAAc,CACzB,OAASI,EAAO,CACdrB,EAAKqB,CAAK,CACZ,CACF,EAEOC,EAAQzB,EFxGf,IAAO0B,EAAQC","names":["index_exports","__export","index_default","__toCommonJS","getImportMetaUrl","importMetaUrl","import_node_path","import_sharp","import_promises","NOT_FOUND_IMAGE","importMetaUrl","NOT_FOUND_AVATAR","FALLBACKIMAGES","API_REGEX","allowedFormats","mimeTypes","import_node_path","import_node_fs","fs","import_axios","isValidPath","basePath","specifiedPath","resolvedBase","path","resolvedPath","fetchFromNetwork","src","type","response","axios","contentType","mimeTypes","FALLBACKIMAGES","readLocalImage","filePath","baseDir","fetchImage","websiteURL","apiRegex","API_REGEX","allowedNetworkList","url","localPath","renderOptions","options","id","API_REGEX","renderUserData","userData","serveImage","req","res","next","options","userData","renderUserData","parsedOptions","renderOptions","imageBuffer","baseDir","parsedUserId","userIdStr","outputFormat","allowedFormats","fetchImage","readLocalImage","image","sharp","resizeOptions","processedImage","processedFileName","path","mimeTypes","error","pixel_default","index_default","pixel_default"]}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import U from"node:path";import O from"sharp";import{readFile as I}from"node:fs/promises";var E=new URL("./assets/noimage.jpg",import.meta.url).href,N=new URL("./assets/noavatar.png",import.meta.url).href,m={normal:async()=>I(E),avatar:async()=>I(N)},d=/^\/api\/v1\//,x=["jpeg","jpg","png","webp","gif","tiff","avif","svg"],c={jpeg:"image/jpeg",jpg:"image/jpeg",png:"image/png",webp:"image/webp",gif:"image/gif",tiff:"image/tiff",avif:"image/avif",svg:"image/svg+xml"};import h from"node:path";import{existsSync as q}from"node:fs";import*as F from"node:fs/promises";import A from"axios";var D=(t,r)=>{if(!t||!r)return!1;let i=h.resolve(t),a=h.resolve(i,r);return a.startsWith(i)&&q(a)},M=async(t,r="normal")=>{try{let i=await A.get(t,{responseType:"arraybuffer",timeout:5e3}),a=i.headers["content-type"]?.toLowerCase();return Object.values(c).includes(a??"")?Buffer.from(i.data):await m[r]()}catch{return await m[r]()}},w=async(t,r,i="normal")=>{if(!D(r,t))return await m[i]();try{return await F.readFile(h.resolve(r,t))}catch{return await m[i]()}},R=(t,r,i,a="normal",e=d,s=[])=>{let o=new URL(t);if([i,`www.${i}`].includes(o.host)){let n=o.pathname.replace(e,"");return w(n,r,a)}else return s.includes(o.host)?M(t,a):m[a]()};var v=t=>({...{baseDir:"",idHandler:i=>i,getUserFolder:async()=>"",websiteURL:"",apiRegex:d,allowedNetworkList:[]},...t}),b=t=>({...{quality:80,format:"jpeg",src:"/placeholder/noimage.jpg",folder:"public",type:"normal",width:void 0,height:void 0,userId:void 0},...t,quality:t.quality?Math.min(Math.max(Number(t.quality)||80,1),100):100,width:t.width?Math.min(Math.max(Number(t.width),50),2e3):void 0,height:t.height?Math.min(Math.max(Number(t.height),50),2e3):void 0});var C=async(t,r,i,a)=>{try{let e=b(t.query),s=v(a),o,l=s.baseDir,n;if(e.userId){let f=typeof e.userId=="object"?String(Object.values(e.userId)[0]):String(e.userId);s.idHandler?n=s.idHandler(f):n=f}e.folder==="private"&&n&&(l=await s.getUserFolder(n,t));let u=x.includes(e.format.toLowerCase())?e.format.toLowerCase():"jpeg";e?.src?.startsWith("http")?o=await R(e.src,l,s.websiteURL,e.type,s.apiRegex):o=await w(e?.src??"",l,e.type);let y=O(o);if(e?.width||e?.height){let f={width:e?.width??void 0,height:e?.height??void 0,fit:O.fit.cover};y=y.resize(f)}let L=await y.toFormat(u,{quality:e?.quality?Number(e.quality):80}).toBuffer(),j=`${U.basename(e.src??"",U.extname(e.src??""))}.${u}`;r.type(c[u]),r.setHeader("Content-Disposition",`inline; filename="${j}"`),r.send(L)}catch(e){i(e)}},T=C;var oe=T;export{oe as default};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/pixel.ts","../src/variables.ts","../src/functions.ts","../src/renders.ts","../src/index.ts"],"sourcesContent":["import path from \"node:path\";\nimport sharp, { FormatEnum, ResizeOptions } from \"sharp\";\nimport type { Request, Response, NextFunction } from \"express\";\nimport type { Options, UserData, ImageFormat, ImageType } from \"./types\";\nimport { allowedFormats, mimeTypes } from \"./variables\";\nimport { fetchImage, readLocalImage } from \"./functions\";\nimport { renderOptions, renderUserData } from \"./renders\";\n\n/**\n * @typedef {Object} Options\n * @property {string} baseDir - The base directory for public image files.\n * @property {function(string): string} idHandler - A function to handle user IDs.\n * @property {function(string, Request): Promise<string>} getUserFolder - Asynchronous function to retrieve user-specific folders.\n * @property {string} websiteURL - The base URL of the website for internal link resolution.\n * @property {RegExp} apiRegex - Regex to parse API endpoints from URLs.\n * @property {string[]} allowedNetworkList - List of allowed network domains for external image fetching.\n */\n\n/**\n * @function serveImage\n * @description Processes and serves an image based on user data and options.\n * @param {Request} req - The Express request object.\n * @param {Response} res - The Express response object.\n * @param {NextFunction} next - The Express next middleware function.\n * @param {Options} options - The options object for image processing.\n * @returns {Promise<void>}\n */\nconst serveImage = async (\n  req: Request,\n  res: Response,\n  next: NextFunction,\n  options: Options\n) => {\n  try {\n    const userData = renderUserData(req.query as UserData);\n    const parsedOptions = renderOptions(options);\n\n    let imageBuffer;\n    let baseDir = parsedOptions.baseDir;\n    let parsedUserId;\n\n    if (userData.userId) {\n      const userIdStr =\n        typeof userData.userId === \"object\"\n          ? String(Object.values(userData.userId)[0])\n          : String(userData.userId);\n      if (parsedOptions.idHandler) {\n        parsedUserId = parsedOptions.idHandler(userIdStr);\n      } else {\n        parsedUserId = userIdStr;\n      }\n    }\n\n    if (userData.folder === \"private\" && parsedUserId) {\n      baseDir = await parsedOptions.getUserFolder(parsedUserId, req);\n    }\n\n    const outputFormat = allowedFormats.includes(\n      userData.format.toLowerCase() as ImageFormat\n    )\n      ? userData.format.toLowerCase()\n      : \"jpeg\";\n\n    if (userData?.src?.startsWith(\"http\")) {\n      imageBuffer = await fetchImage(\n        userData.src,\n        baseDir,\n        parsedOptions.websiteURL,\n        userData.type as ImageType,\n        parsedOptions.apiRegex\n      );\n    } else {\n      imageBuffer = await readLocalImage(\n        userData?.src ?? \"\",\n        baseDir,\n        userData.type as ImageType\n      );\n    }\n\n    let image = sharp(imageBuffer);\n\n    if (userData?.width || userData?.height) {\n      const resizeOptions = {\n        width: userData?.width ?? undefined,\n        height: userData?.height ?? undefined,\n        fit: sharp.fit.cover,\n      };\n      image = image.resize(resizeOptions as ResizeOptions);\n    }\n\n    const processedImage = await image\n      .toFormat(outputFormat as keyof FormatEnum, {\n        quality: userData?.quality ? Number(userData.quality) : 80,\n      })\n      .toBuffer();\n\n    const processedFileName = `${path.basename(\n      userData.src ?? \"\",\n      path.extname(userData.src ?? \"\")\n    )}.${outputFormat}`;\n\n    res.type(mimeTypes[outputFormat]);\n    res.setHeader(\n      \"Content-Disposition\",\n      `inline; filename=\"${processedFileName}\"`\n    );\n    res.send(processedImage);\n  } catch (error) {\n    next(error);\n  }\n};\n\nexport default serveImage;\n","import type { ImageFormat } from \"./types\";\nimport { readFile } from \"node:fs/promises\";\n\nconst NOT_FOUND_IMAGE = new URL(\"./assets/noimage.jpg\", import.meta.url).href;\n\nconst NOT_FOUND_AVATAR = new URL(\"./assets/noavatar.png\", import.meta.url).href;\n\nexport const FALLBACKIMAGES = {\n  normal: async () => readFile(NOT_FOUND_IMAGE),\n  avatar: async () => readFile(NOT_FOUND_AVATAR),\n};\n\nexport const API_REGEX: RegExp = /^\\/api\\/v1\\//;\n\nexport const allowedFormats: ImageFormat[] = [\n  \"jpeg\",\n  \"jpg\",\n  \"png\",\n  \"webp\",\n  \"gif\",\n  \"tiff\",\n  \"avif\",\n  \"svg\",\n];\n\nexport const mimeTypes: Readonly<Record<string, string>> = {\n  jpeg: \"image/jpeg\",\n  jpg: \"image/jpeg\",\n  png: \"image/png\",\n  webp: \"image/webp\",\n  gif: \"image/gif\",\n  tiff: \"image/tiff\",\n  avif: \"image/avif\",\n  svg: \"image/svg+xml\",\n};\n","import path from \"node:path\";\nimport { existsSync } from \"node:fs\";\nimport * as fs from \"node:fs/promises\";\nimport axios from \"axios\";\nimport { mimeTypes, API_REGEX, FALLBACKIMAGES } from \"./variables\";\nimport type { ImageType } from \"./types\";\n\n/**\n * @typedef {(\"avatar\" | \"normal\")} ImageType\n * @description Defines the type of image being processed.\n */\n\n/**\n * Checks if a specified path is valid within a base path.\n *\n * @param {string} basePath - The base directory to resolve paths.\n * @param {string} specifiedPath - The path to check.\n * @returns {boolean} True if the path is valid, false otherwise.\n */\nconst isValidPath = (basePath: string, specifiedPath: string): boolean => {\n  if (!basePath || !specifiedPath) return false;\n  const resolvedBase = path.resolve(basePath);\n  const resolvedPath = path.resolve(resolvedBase, specifiedPath);\n  return resolvedPath.startsWith(resolvedBase) && existsSync(resolvedPath);\n};\n\n/**\n * Fetches an image from a network source.\n *\n * @param {string} src - The URL of the image.\n * @param {ImageType} [type=\"normal\"] - Type of fallback image in case of an error.\n * @returns {Promise<Buffer>} A buffer containing the image data or a fallback image.\n */\nconst fetchFromNetwork = async (\n  src: string,\n  type: ImageType = \"normal\"\n): Promise<Buffer> => {\n  try {\n    const response = await axios.get(src, {\n      responseType: \"arraybuffer\",\n      timeout: 5000,\n    });\n\n    const contentType = response.headers[\"content-type\"]?.toLowerCase();\n    const allowedMimeTypes = Object.values(mimeTypes);\n\n    if (allowedMimeTypes.includes(contentType ?? \"\")) {\n      return Buffer.from(response.data);\n    }\n    return await FALLBACKIMAGES[type]();\n  } catch (error) {\n    return await FALLBACKIMAGES[type]();\n  }\n};\n\n/**\n * Reads an image from the local file system.\n *\n * @param {string} filePath - Path to the image file.\n * @param {string} baseDir - Base directory to resolve paths.\n * @param {ImageType} [type=\"normal\"] - Type of fallback image if the path is invalid.\n * @returns {Promise<Buffer>} A buffer containing the image data.\n */\nexport const readLocalImage = async (\n  filePath: string,\n  baseDir: string,\n  type: ImageType = \"normal\"\n) => {\n  if (!isValidPath(baseDir, filePath)) {\n    return await FALLBACKIMAGES[type]();\n  }\n  try {\n    return await fs.readFile(path.resolve(baseDir, filePath));\n  } catch (error) {\n    return await FALLBACKIMAGES[type]();\n  }\n};\n\n/**\n * Fetches an image from either a local file or a network source.\n *\n * @param {string} src - The URL or local path of the image.\n * @param {string} baseDir - Base directory to resolve local paths.\n * @param {string} websiteURL - The URL of the website.\n * @param {ImageType} [type=\"normal\"] - Type of fallback image if the path is invalid.\n * @param {RegExp} [apiRegex=API_REGEX] - Regular expression to match API routes.\n * @param {string[]} [allowedNetworkList=[]] - List of allowed network hosts.\n * @returns {Promise<Buffer>} A buffer containing the image data or a fallback image.\n */\nexport const fetchImage = (\n  src: string,\n  baseDir: string,\n  websiteURL: string,\n  type: ImageType = \"normal\",\n  apiRegex: RegExp = API_REGEX,\n  allowedNetworkList: string[] = []\n) => {\n  const url = new URL(src);\n  const isInternal = [websiteURL, `www.${websiteURL}`].includes(url.host);\n  if (isInternal) {\n    const localPath = url.pathname.replace(apiRegex, \"\");\n    return readLocalImage(localPath, baseDir, type);\n  } else {\n    const allowedCondition = allowedNetworkList.includes(url.host);\n    if (!allowedCondition) {\n      return FALLBACKIMAGES[type]();\n    }\n    return fetchFromNetwork(src, type);\n  }\n};\n","import { API_REGEX } from \"./variables\";\nimport type { Options, UserData } from \"./types\";\n\n/**\n * @typedef {(\"avatar\" | \"normal\")} ImageType\n * @description Defines the type of image being processed.\n */\n\n/**\n * @typedef {(\"jpeg\" | \"jpg\" | \"png\" | \"webp\" | \"gif\" | \"tiff\" | \"avif\" | \"svg\")} ImageFormat\n * @description Supported formats for image processing.\n */\n\n/**\n * @typedef {Object} Options\n * @property {string} baseDir - The base directory for public image files.\n * @property {function(string): string} idHandler - A function to handle user IDs.\n * @property {function(string, Request): Promise<string>} getUserFolder - Asynchronous function to retrieve user-specific folders.\n * @property {string} websiteURL - The base URL of the website for internal link resolution.\n * @property {RegExp} apiRegex - Regex to parse API endpoints from URLs.\n * @property {string[]} allowedNetworkList - List of allowed network domains for external image fetching.\n */\n\n/**\n * @typedef {Object} UserData\n * @property {number|string} quality - Quality of the image (1–100).\n * @property {ImageFormat} format - Desired format of the image.\n * @property {string} [src] - Source path or URL for the image.\n * @property {string} [folder] - The folder type (\"public\" or \"private\").\n * @property {ImageType} [type] - Type of the image (\"avatar\" or \"normal\").\n * @property {string|null} [userId] - Optional user identifier.\n * @property {number|string} [width] - Desired image width.\n * @property {number|string} [height] - Desired image height.\n */\n\n/**\n * Renders the options object with default values and user-provided values.\n *\n * @param {Partial<Options>} options - The user-provided options.\n * @returns {Options} The rendered options object.\n */\nexport const renderOptions = (options: Partial<Options>): Options => {\n  const initialOptions: Options = {\n    baseDir: \"\",\n    idHandler: (id: string) => id,\n    getUserFolder: async () => \"\",\n    websiteURL: \"\",\n    apiRegex: API_REGEX,\n    allowedNetworkList: [],\n  };\n  return {\n    ...initialOptions,\n    ...options,\n  };\n};\n\n/**\n * Renders the user data object with default values and user-provided values.\n *\n * @param {Partial<UserData>} userData - The user-provided data.\n * @returns {UserData} The rendered user data object.\n */\nexport const renderUserData = (userData: Partial<UserData>): UserData => {\n  const initialUserData: UserData = {\n    quality: 80,\n    format: \"jpeg\",\n    src: \"/placeholder/noimage.jpg\",\n    folder: \"public\",\n    type: \"normal\",\n    width: undefined,\n    height: undefined,\n    userId: undefined,\n  };\n  return {\n    ...initialUserData,\n    ...userData,\n    quality: userData.quality\n      ? Math.min(Math.max(Number(userData.quality) || 80, 1), 100)\n      : 100,\n    width: userData.width\n      ? Math.min(Math.max(Number(userData.width), 50), 2000)\n      : undefined,\n    height: userData.height\n      ? Math.min(Math.max(Number(userData.height), 50), 2000)\n      : undefined,\n  };\n};\n","/**\n * @module ImageService\n * @description A module to serve, process, and manage image delivery for web applications.\n */\n\nimport serveImage from \"./pixel\";\nexport * from \"./types\";\n\nexport default serveImage;\n"],"mappings":"AAAA,OAAOA,MAAU,YACjB,OAAOC,MAA0C,QCAjD,OAAS,YAAAC,MAAgB,mBAEzB,IAAMC,EAAkB,IAAI,IAAI,uBAAwB,YAAY,GAAG,EAAE,KAEnEC,EAAmB,IAAI,IAAI,wBAAyB,YAAY,GAAG,EAAE,KAE9DC,EAAiB,CAC5B,OAAQ,SAAYH,EAASC,CAAe,EAC5C,OAAQ,SAAYD,EAASE,CAAgB,CAC/C,EAEaE,EAAoB,eAEpBC,EAAgC,CAC3C,OACA,MACA,MACA,OACA,MACA,OACA,OACA,KACF,EAEaC,EAA8C,CACzD,KAAM,aACN,IAAK,aACL,IAAK,YACL,KAAM,aACN,IAAK,YACL,KAAM,aACN,KAAM,aACN,IAAK,eACP,EClCA,OAAOC,MAAU,YACjB,OAAS,cAAAC,MAAkB,UAC3B,UAAYC,MAAQ,mBACpB,OAAOC,MAAW,QAgBlB,IAAMC,EAAc,CAACC,EAAkBC,IAAmC,CACxE,GAAI,CAACD,GAAY,CAACC,EAAe,MAAO,GACxC,IAAMC,EAAeC,EAAK,QAAQH,CAAQ,EACpCI,EAAeD,EAAK,QAAQD,EAAcD,CAAa,EAC7D,OAAOG,EAAa,WAAWF,CAAY,GAAKG,EAAWD,CAAY,CACzE,EASME,EAAmB,MACvBC,EACAC,EAAkB,WACE,CACpB,GAAI,CACF,IAAMC,EAAW,MAAMC,EAAM,IAAIH,EAAK,CACpC,aAAc,cACd,QAAS,GACX,CAAC,EAEKI,EAAcF,EAAS,QAAQ,cAAc,GAAG,YAAY,EAGlE,OAFyB,OAAO,OAAOG,CAAS,EAE3B,SAASD,GAAe,EAAE,EACtC,OAAO,KAAKF,EAAS,IAAI,EAE3B,MAAMI,EAAeL,CAAI,EAAE,CACpC,MAAgB,CACd,OAAO,MAAMK,EAAeL,CAAI,EAAE,CACpC,CACF,EAUaM,EAAiB,MAC5BC,EACAC,EACAR,EAAkB,WACf,CACH,GAAI,CAACT,EAAYiB,EAASD,CAAQ,EAChC,OAAO,MAAMF,EAAeL,CAAI,EAAE,EAEpC,GAAI,CACF,OAAO,MAAS,WAASL,EAAK,QAAQa,EAASD,CAAQ,CAAC,CAC1D,MAAgB,CACd,OAAO,MAAMF,EAAeL,CAAI,EAAE,CACpC,CACF,EAaaS,EAAa,CACxBV,EACAS,EACAE,EACAV,EAAkB,SAClBW,EAAmBC,EACnBC,EAA+B,CAAC,IAC7B,CACH,IAAMC,EAAM,IAAI,IAAIf,CAAG,EAEvB,GADmB,CAACW,EAAY,OAAOA,CAAU,EAAE,EAAE,SAASI,EAAI,IAAI,EACtD,CACd,IAAMC,EAAYD,EAAI,SAAS,QAAQH,EAAU,EAAE,EACnD,OAAOL,EAAeS,EAAWP,EAASR,CAAI,CAChD,KAEE,QADyBa,EAAmB,SAASC,EAAI,IAAI,EAItDhB,EAAiBC,EAAKC,CAAI,EAFxBK,EAAeL,CAAI,EAAE,CAIlC,ECpEO,IAAMgB,EAAiBC,IASrB,CACL,GAT8B,CAC9B,QAAS,GACT,UAAYC,GAAeA,EAC3B,cAAe,SAAY,GAC3B,WAAY,GACZ,SAAUC,EACV,mBAAoB,CAAC,CACvB,EAGE,GAAGF,CACL,GASWG,EAAkBC,IAWtB,CACL,GAXgC,CAChC,QAAS,GACT,OAAQ,OACR,IAAK,2BACL,OAAQ,SACR,KAAM,SACN,MAAO,OACP,OAAQ,OACR,OAAQ,MACV,EAGE,GAAGA,EACH,QAASA,EAAS,QACd,KAAK,IAAI,KAAK,IAAI,OAAOA,EAAS,OAAO,GAAK,GAAI,CAAC,EAAG,GAAG,EACzD,IACJ,MAAOA,EAAS,MACZ,KAAK,IAAI,KAAK,IAAI,OAAOA,EAAS,KAAK,EAAG,EAAE,EAAG,GAAI,EACnD,OACJ,OAAQA,EAAS,OACb,KAAK,IAAI,KAAK,IAAI,OAAOA,EAAS,MAAM,EAAG,EAAE,EAAG,GAAI,EACpD,MACN,GH1DF,IAAMC,EAAa,MACjBC,EACAC,EACAC,EACAC,IACG,CACH,GAAI,CACF,IAAMC,EAAWC,EAAeL,EAAI,KAAiB,EAC/CM,EAAgBC,EAAcJ,CAAO,EAEvCK,EACAC,EAAUH,EAAc,QACxBI,EAEJ,GAAIN,EAAS,OAAQ,CACnB,IAAMO,EACJ,OAAOP,EAAS,QAAW,SACvB,OAAO,OAAO,OAAOA,EAAS,MAAM,EAAE,CAAC,CAAC,EACxC,OAAOA,EAAS,MAAM,EACxBE,EAAc,UAChBI,EAAeJ,EAAc,UAAUK,CAAS,EAEhDD,EAAeC,CAEnB,CAEIP,EAAS,SAAW,WAAaM,IACnCD,EAAU,MAAMH,EAAc,cAAcI,EAAcV,CAAG,GAG/D,IAAMY,EAAeC,EAAe,SAClCT,EAAS,OAAO,YAAY,CAC9B,EACIA,EAAS,OAAO,YAAY,EAC5B,OAEAA,GAAU,KAAK,WAAW,MAAM,EAClCI,EAAc,MAAMM,EAClBV,EAAS,IACTK,EACAH,EAAc,WACdF,EAAS,KACTE,EAAc,QAChB,EAEAE,EAAc,MAAMO,EAClBX,GAAU,KAAO,GACjBK,EACAL,EAAS,IACX,EAGF,IAAIY,EAAQC,EAAMT,CAAW,EAE7B,GAAIJ,GAAU,OAASA,GAAU,OAAQ,CACvC,IAAMc,EAAgB,CACpB,MAAOd,GAAU,OAAS,OAC1B,OAAQA,GAAU,QAAU,OAC5B,IAAKa,EAAM,IAAI,KACjB,EACAD,EAAQA,EAAM,OAAOE,CAA8B,CACrD,CAEA,IAAMC,EAAiB,MAAMH,EAC1B,SAASJ,EAAkC,CAC1C,QAASR,GAAU,QAAU,OAAOA,EAAS,OAAO,EAAI,EAC1D,CAAC,EACA,SAAS,EAENgB,EAAoB,GAAGC,EAAK,SAChCjB,EAAS,KAAO,GAChBiB,EAAK,QAAQjB,EAAS,KAAO,EAAE,CACjC,CAAC,IAAIQ,CAAY,GAEjBX,EAAI,KAAKqB,EAAUV,CAAY,CAAC,EAChCX,EAAI,UACF,sBACA,qBAAqBmB,CAAiB,GACxC,EACAnB,EAAI,KAAKkB,CAAc,CACzB,OAASI,EAAO,CACdrB,EAAKqB,CAAK,CACZ,CACF,EAEOC,EAAQzB,EIxGf,IAAO0B,GAAQC","names":["path","sharp","readFile","NOT_FOUND_IMAGE","NOT_FOUND_AVATAR","FALLBACKIMAGES","API_REGEX","allowedFormats","mimeTypes","path","existsSync","fs","axios","isValidPath","basePath","specifiedPath","resolvedBase","path","resolvedPath","existsSync","fetchFromNetwork","src","type","response","axios","contentType","mimeTypes","FALLBACKIMAGES","readLocalImage","filePath","baseDir","fetchImage","websiteURL","apiRegex","API_REGEX","allowedNetworkList","url","localPath","renderOptions","options","id","API_REGEX","renderUserData","userData","serveImage","req","res","next","options","userData","renderUserData","parsedOptions","renderOptions","imageBuffer","baseDir","parsedUserId","userIdStr","outputFormat","allowedFormats","fetchImage","readLocalImage","image","sharp","resizeOptions","processedImage","processedFileName","path","mimeTypes","error","pixel_default","index_default","pixel_default"]}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "pixel-serve-server",
+  "version": "0.0.1",
+  "description": "A robust Node.js utility for handling and processing images. This package provides features like resizing, format conversion and etc.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsup"
+  },
+  "files": [
+    "dist",
+    "dist/assets"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Hiprax/pixel-serve-server.git"
+  },
+  "keywords": [
+    "Pixel Serve",
+    "Image",
+    "Image Serving",
+    "Image Optimization",
+    "Image Resizing",
+    "Image Formatting",
+    "Image Transformation"
+  ],
+  "author": "Hiprax",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Hiprax/pixel-serve-server/issues"
+  },
+  "homepage": "https://github.com/Hiprax/pixel-serve-server#readme",
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.10.5",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3"
+  },
+  "engines": {
+    "node": ">=8.x"
+  },
+  "dependencies": {
+    "axios": "^1.7.9",
+    "express": "^4.21.2",
+    "sharp": "^0.33.5"
+  }
+}