Image Builder

A lightweight utility for building Base64 encoded image transformation URLs for Sharp.

---

📦 Installation

``bash
npm install sharp-image-url-builder
`

---

🚀 Usage

`ts
import { ImageUrlBuilder } from 'sharp-image-url-builder';

const builder = new ImageUrlBuilder('https://cdn.example.com', 'my-bucket');

const url = builder
.setKey('images/photo.jpg')
.resize({
width: 800,
height: 600,
fit: 'cover',
position: 'center'
})
.blur(5)
.toURL();

console.log(url);
// https://cdn.example.com/eyJidWNrZXQiOiJteS1idWNrZXQiLCJrZXkiOiJpbWFnZXMvcGhvdG8uanBnIiwiZWRpdHMiOnsicmVzaXplIjp7IndpZHRoIjo4MDAsImhlaWdodCI6NjAwLCJmaXQiOiJjb3ZlciIsInBvc2l0aW9uIjoiY2VudGVyIn0sImJsdXIiOjV9fQ==
`

---

🔧 API

$3

Create a new builder instance.

- baseUrl – your CDN or image service base URL
- bucket – bucket/container name

---

$3

Set the image key (path to your file in the bucket).

---

$3

Apply resize options.

`ts
builder.resize({
width: 400,
height: 300,
fit: 'contain',
position: 'top',
gravity: 'north-west',
withoutEnlargement: true
});
`

#### Resize Options

- width?: number
- height?: number
- fit?: 'cover' | 'contain' | 'fill' | 'inside' | 'outside'
- position?: 'top' | 'bottom' | 'left' | 'right' | 'center' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
- gravity?: 'north' | 'south' | 'east' | 'west' | 'center' | 'north-east' | 'north-west' | 'south-east' | 'south-west'
- entropy?: 'entropy' | 'attention'
- withoutEnlargement?: boolean

---

$3

Apply a blur effect.

---

$3

Generate the final transformation URL. Encodes the transformObject` as Base64 JSON.

---

🛠 Use Cases

- Generate Base64 encoded URLs for serverless image transformers
- Apply simple effects (blur, crop) without heavy backend logic