@socialtip/asset-proxy-url-generator

Generate asset-proxy-compatible URL paths programmatically, with optional source URL encryption and HMAC signing.

Installation

npm install @socialtip/asset-proxy-url-generator

Usage

import { generateUrl } from "@socialtip/asset-proxy-url-generator";

const url = generateUrl({
  sourceUrl: "https://example.com/photo.jpg",
  outputFormat: "webp",
  resize: { type: "fill", width: 480, height: 360 },
  quality: 80,
});
// => /_/rs:fill:480:360/q:80/plain/https://example.com/photo.jpg@webp

Encrypted source URLs

const url = generateUrl(
  { sourceUrl: "https://example.com/photo.jpg", outputFormat: "webp" },
  { encryptionKey: "0123456789abcdef..." }, // hex-encoded 32-byte key
);
// => /_/enc/dGhpcyBpcy...@webp

Signed URLs

const url = generateUrl(
  { sourceUrl: "https://example.com/photo.jpg" },
  {
    signingKey: "...", // hex-encoded HMAC key
    signingSalt: "...", // hex-encoded salt
  },
);
// => /oKfUtW34Dvo.../plain/https://example.com/photo.jpg

All options

The generateUrl function accepts all processing options from the asset-proxy URL schema. See the full options reference for details.