npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@xtandard/image

v0.1.1

Published

TypeScript client for the xtandard-image server (self-hosted image and video processing in Go and libvips): typed URL builder with signing and source encryption, and a fetch client.

Readme

xtandard-image for TypeScript

Typed URL builder, signing and fetch client for the xtandard-image server.

npm license: MIT

@xtandard/image is the TypeScript client for xtandard-image, an open-source media server that covers your application's image and video needs, built on libvips and FFmpeg. The package builds and signs the URLs your code sends to the server, and wraps its /info and health endpoints; it does not process images itself. To run a server, see Getting started, or start one with signing keys:

export XI_SIGNING_KEY="$(openssl rand -hex 32)" XI_SIGNING_SALT="$(openssl rand -hex 32)"
docker run -d --name xtandard-image -p 8080:8080 \
  -e XI_SOURCES=web -e XI_SOURCES_WEB_TYPE=http -e XI_SOURCES_WEB_ALLOW=images.unsplash.com \
  -e XI_SIGNING_KEYS="$XI_SIGNING_KEY" -e XI_SIGNING_SALTS="$XI_SIGNING_SALT" \
  ghcr.io/xantiagoma/xtandard-image:0.1.1

Install

npm i @xtandard/image   # or: bun add / pnpm add / deno add npm:@xtandard/image

Quick start

Build a signed URL with the keys the server was started with:

import { imgproxy } from "@xtandard/image";

const img = imgproxy({
  baseUrl: "http://localhost:8080",
  signing: { key: process.env.XI_SIGNING_KEY!, salt: process.env.XI_SIGNING_SALT! },
});

const url = await img
  .from("https://images.unsplash.com/photo-1506744038136-46273834b3fb")
  .resize("fill", 1200, 630)
  .gravity("sm")
  .extension("jpg")
  .build();
// http://localhost:8080/<signature>/rs:fill:1200:630/g:sm/aHR0cHM6….jpg

Ask the server about the source with the fetch client:

import { createClient } from "@xtandard/image/client";

const xi = createClient({
  baseUrl: "http://localhost:8080",
  imgproxy: { signing: { key: process.env.XI_SIGNING_KEY!, salt: process.env.XI_SIGNING_SALT! } },
});

const info = await xi.info({ source: "https://images.unsplash.com/photo-1506744038136-46273834b3fb" });
console.log(info.format, info.width, info.height); // jpeg 7360 4912

Sign URLs on a server only: a key shipped to a browser signs any URL.

Usage

Building URLs

There are two equivalent forms, an options object and a fluent chain with one method per option name and alias:

const img = imgproxy({ baseUrl: "https://img.example.com" });

await img.url({
  source: "s3://photos/cat.jpg",
  options: { resize: ["fill", 300, 400], gravity: "sm", quality: 80 },
  extension: "webp",
});
await img.from("s3://photos/cat.jpg").resize("fill", 300, 400).g("sm").quality(80).extension("webp").build();
// both: https://img.example.com/insecure/rs:fill:300:400/g:sm/q:80/czM6Ly9waG90b3MvY2F0LmpwZw.webp

Option names, aliases and argument tuples are typed from the server's catalogue, so an unknown option or a wrong argument does not compile. A tuple can stop early (["fit"]), null leaves an argument empty, and a single argument can be passed bare (quality: 80). build() and url() are async because signing and encryption use WebCrypto. The options themselves are documented in URL dialects §3.2.

Builder settings: separator (default :), unsignedSignature (insecure, unsafe or _), and optionNames ("short" by default, "canonical" or "given").

Chained pipelines

An array of option objects, or .chain() in the fluent form, writes /-/ between pipelines:

await img.url({ source, options: [{ rs: ["fit", 500, 500] }, { bl: 2 }] });
await img.from(source).rs("fit", 500, 500).chain().bl(2).build();

Sources

| sourceEncoding | URL | |---|---| | "base64" (default) | /…/czM6Ly9waG90b3MvY2F0LmpwZw.webp; splitSource: 16 splits it into segments | | "plain" | /…/plain/https://e.com/a%20b.jpg@webp, escaped for you | | "encrypted" | /…/enc/<token>.webp; needs encryption (below) |

Set it on the builder, per request (sourceEncoding) or per chain (.encoding("plain")). xiSource("photos", "2026/cat.jpg") writes a named source (xi://photos/2026/cat.jpg) and sourceUrl("s3", "bucket", "cat.jpg") a storage URL.

/info

await img.infoUrl({ source, options: { size: true, format: true } });
await img.info(source).size(true).format(true).build();

Video and streams

/video URLs use the video option catalogue; the extension is the container (mp4, webm, mp3, png for a waveform, …). streamUrl builds HLS and DASH manifests, whose segments a player fetches without any key:

await img.video("s3://media/talk.mov").rs("fill", 640, 360).vs(12).vd(5).extension("webm").build();
await img.streamUrl({ source: "s3://media/talk.mov", protocol: "hls", renditions: [360, 720], segmentDuration: 4 });

The server needs the full or gpl image for video. Options and containers: URL dialects §3.8 and §3.10.

Query dialect

queryUrls() builds /q/ URLs (native keys plus imgproxy options in o=), /q/video and imaginary endpoints, signed with xi_sig. The server needs XI_DIALECTS_QUERY_ENABLED=true.

import { queryUrls } from "@xtandard/image";

const q = queryUrls({ baseUrl: "https://img.example.com", signing });
await q.url({ source: "s3://photos/cat.jpg", params: { w: 300, fit: "cover" }, options: { bl: 2 }, extension: "webp" });
// https://img.example.com/q/?url=s3://photos/cat.jpg&w=300&fit=cover&o=bl:2&format=webp&xi_sig=…
await q.imaginaryUrl({ endpoint: "smartcrop", source: "s3://photos/cat.jpg", params: { width: 300, height: 300 } });

See URL dialects §4.

Signing and encryption

signing takes the server's hex key and salt (XI_SIGNING_KEYS / XI_SIGNING_SALTS, or imgproxy's IMGPROXY_KEY / IMGPROXY_SALT) and an optional size. encryption takes the first XI_ENCRYPTION_KEYS entry, for enc/ sources and password-protected PDFs:

const img = imgproxy({ baseUrl, signing, encryption: { key: process.env.XI_ENCRYPTION_KEY! } });
await img.url({ source: "s3://private/cat.jpg", options: { w: 300 }, sourceEncoding: "encrypted" });
await img.url({ source: "s3://docs/contract.pdf", options: { rs: ["fit", 800, 0] }, pdfPassword: "s3cret" });

Each enc/ token gets a random IV unless you pass a fixed 16-byte iv. The helpers sign, signImgproxyPath, signXiUrl, signXiQuery, encryptSource and encryptPdfPassword are exported too; signXiUrl adds an xi_sig to a URL of any other dialect. Schemes: URL dialects §2.

HTTP client

@xtandard/image/client has healthz, readyz, info, image, video, stream, media (with Range and HEAD) and playgroundMeta. Its response types come from the server's OpenAPI document, and every call takes an AbortSignal:

const res = await xi.image({ source, options: { w: 300 } }, { accept: "image/avif,image/webp" }); // a Response
const part = await xi.video({ source, options: { vd: 5 }, extension: "webm" }, { range: { start: 0, end: 65535 } });

Errors

The builders throw TypeError or RangeError for an invalid option, source or key. The client throws XtandardError for a non-2xx answer, with the server's status, kind and requestId:

import { XtandardError } from "@xtandard/image/client";

try {
  await xi.info({ source: "https://example.com/a.jpg" });
} catch (e) {
  if (e instanceof XtandardError) console.log(e.status, e.kind, e.requestId); // 403 "forbidden" …
}

Compatibility

  • Node.js 22 or later, Bun, Deno, browsers and workers: crypto runs on WebCrypto. ESM only, no runtime dependencies.
  • The package version is the server version: @xtandard/[email protected] matches ghcr.io/xantiagoma/xtandard-image:0.2.1. Versions follow ZeroVer: a minor bump may break the API, a patch does not, and prereleases are on the next dist-tag.

Links

A personal project, provided as is under the MIT licence: see the disclaimer.

Design: every official client is generated from one spec and passes one conformance fixture (ADR 0013).