ipx 1.2.0 → 2.0.0-0

package/README.md

@@ -3,33 +3,74 @@
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 
-High performance, secure and easy to use image proxy based on [sharp](https://github.com/lovell/sharp) and [libvips](https://github.com/libvips/libvips).
+High performance, secure and easy-to-use image optimizer.
 
-## Usage
+Powered by [sharp](https://github.com/lovell/sharp) and [libvips](https://github.com/libvips/libvips).
 
-### Quick Start
+> [!IMPORTANT]  
+> This is the development branch for IPX v2. Check out [ipx/v1](https://github.com/unjs/ipx/tree/v1) for latest stable docs.
 
-You can use `ipx` command to start server using:
+## Using CLI
+
+You can use `ipx` command to start server.
+
+Using `npx`:
 
 ```bash
-$ npx ipx
+npx ipx@latest serve --dir ./
 ```
 
-The default server directory is the current working directory.
+Usin `bun`
+
+```bash
+bun x ipx@latest serve --dir ./
+```
+
+The default serve directory is the current working directory.
+
+## Programatic API
 
-### Programatic Usage
+You can use IPX as a middleware or directly use IPX interface.
 
-You can use IPX as a Connect/Express middleware or directly use ipx api.
+```ts
+import {
+  createIPX,
+  createIPXMiddleware,
+  ipxFSStorage,
+  ipxHttpStorage,
+} from "./src";
+
+const ipx = createIPX({
+  storage: ipxFSStorage({ dir: "./public" }),
+  httpStorage: ipxHttpStorage({ domains: ["picsum.photos"] }),
+});
+
+const ipxMiddleware = createIPXMiddleware(ipx);
+```
+
+**Example**: Using with [unjs/h3](https://github.com/unjs/h3):
 
 ```js
 import { createIPX, createIPXMiddleware } from "ipx";
+import { listen } from "listhen";
+
+const app = createApp().use("/", fromNodeMiddleware(ipxMiddleware));
+
+listen(toNodeListener(app));
+```
 
-const ipx = createIPX(/* options */);
-const app = express();
-app.use("/image", createIPXMiddleware(ipx));
+**Example:** Using [express](https://expressjs.com):
+
+```js
+import { listen } from "listhen";
+import express from "express";
+
+const app = express().use("/", ipxMiddleware);
+
+listen(app);
 ```
 
-### Examples
+## URL Examples
 
 Get original image:
 
@@ -47,17 +88,59 @@ Resize to `200x200px` using `embed` method and change format to `webp`:
 
 `/embed,f_webp,s_200x200/static/buffalo.png`
 
-### Modifiers
+## Config
+
+You can universally customize IPX configuration using `IPX_*` environment variables.
+
+- `IPX_ALIAS`
+
+  - Default: `{}`
+
+### Filesystem Source Options
+
+(enabled by default with CLI only)
+
+#### `IPX_FS_DIR`
+
+- Default: `.` (current working directory)
+
+#### `IPX_FS_MAX_AGE`
+
+- Default: `300`
+
+### HTTP(s) Source Options
+
+(enabled by default with CLI only)
+
+#### `IPX_HTTP_DOMAINS`
+
+- Default: `[]`
+
+#### `IPX_HTTP_MAX_AGE`
+
+- Default: `300`
+
+#### `IPX_HTTP_FETCH_OPTIONS`
+
+- Default: `{}`
+
+#### `IPX_HTTP_ALLOW_ALL_DOMAINS`
+
+- Default: `false`
+
+## Modifiers
 
 | Property       | Docs                                                            | Example                                              | Comments                                                                                                                                                          |
 | -------------- | :-------------------------------------------------------------- | :--------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | width / w      | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/width_200/buffalo.png`                             |
 | height / h     | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/height_200/buffalo.png`                            |
 | resize / s     | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200/buffalo.png`                             |
+| kernel         | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200,kernel_nearest/buffalo.png`              | Supported kernel: `nearest`, `cubic`, `mitchell`, `lanczos2` and `lanczos3` (default).                                                                            |
 | fit            | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200,fit_outside/buffalo.png`                 | Sets `fit` option for `resize`.                                                                                                                                   |
 | position / pos | [Docs](https://sharp.pixelplumbing.com/api-resize#resize)       | `/s_200x200,pos_top/buffalo.png`                     | Sets `position` option for `resize`.                                                                                                                              |
 | trim           | [Docs](https://sharp.pixelplumbing.com/api-resize#trim)         | `/trim_100/buffalo.png`                              |
 | extend         | [Docs](https://sharp.pixelplumbing.com/api-resize#extend)       | `/extend_{top}_{right}_{bottom}_{left}/buffalo.png`  | Extend / pad / extrude one or more edges of the image with either the provided background colour or pixels derived from the image.                                |
+| background / b | \_                                                              | `/r_45,b_00ff00/buffalo.png`                         |
 | extract        | [Docs](https://sharp.pixelplumbing.com/api-resize#extract)      | `/extract_{left}_{top}_{width}_{height}/buffalo.png` | Extract/crop a region of the image.                                                                                                                               |
 | format / f     | [Docs](https://sharp.pixelplumbing.com/api-output#toformat)     | `/format_webp/buffalo.png`                           | Supported format: `jpg`, `jpeg`, `png`, `webp`, `avif`, `gif`, `heif`, `tiff` and `auto` (experimental only with middleware)                                      |
 | quality / q    | \_                                                              | `/quality_50/buffalo.png`                            | Accepted values: 0 to 100                                                                                                                                         |
@@ -76,30 +159,6 @@ Resize to `200x200px` using `embed` method and change format to `webp`:
 | grayscale      | [Docs](https://sharp.pixelplumbing.com/api-colour#grayscale)    | `/grayscale/buffalo.png`                             |
 | animated       | -                                                               | `/animated/buffalo.gif`                              | Experimental                                                                                                                                                      |
 
-### Config
-
-Config can be customized using `IPX_*` environment variables.
-
-- `IPX_DIR`
-
-  - Default: `.` (current working directory)
-
-- `IPX_DOMAINS`
-
-  - Default: `[]`
-
-- `IPX_MAX_AGE`
-
-  - Default: `300`
-
-- `IPX_ALIAS`
-
-  - Default: `{}`
-
-- `IPX_FETCH_OPTIONS`
-
-  - Default: `{}`
-
 ## License
 
 [MIT](./LICENSE)

package/bin/ipx.mjs

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-import '../dist/cli.mjs'
+import "../dist/cli.mjs";

package/dist/cli.cjs

@@ -1,33 +1,63 @@
 'use strict';
 
-const consola = require('consola');
 const listhen = require('listhen');
-const index = require('./index.cjs');
+const citty = require('citty');
+const cli = require('listhen/cli');
+const nodeFs = require('./shared/ipx.0fc4e4c7.cjs');
 require('defu');
 require('image-meta');
 require('ufo');
-require('node:fs');
-require('pathe');
+require('h3');
 require('destr');
-require('node:http');
-require('node:https');
-require('node-fetch-native');
 require('@fastify/accept-negotiator');
 require('etag');
-require('xss');
-
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+require('node-fetch-native');
+require('pathe');
 
-const consola__default = /*#__PURE__*/_interopDefaultCompat(consola);
+const name = "ipx";
+const version = "2.0.0-0";
+const description = "High performance, secure and easy-to-use image optimizer.";
 
-async function main() {
-  const ipx = index.createIPX({});
-  const middleware = index.createIPXMiddleware(ipx);
-  await listhen.listen(middleware, {
-    clipboard: false
-  });
-}
-main().catch((error) => {
-  consola__default.error(error);
-  process.exit(1);
+const serve = citty.defineCommand({
+  meta: {
+    description: "Start IPX Server"
+  },
+  args: {
+    dir: {
+      type: "string",
+      required: false,
+      description: "Directory to serve (default: current directory) ENV: IPX_FS_DIR"
+    },
+    domains: {
+      type: "string",
+      required: false,
+      description: "Allowed domains (comma separated) ENV: IPX_HTTP_DOMAINS"
+    },
+    ...cli.getArgs()
+  },
+  async run({ args }) {
+    const ipx = nodeFs.createIPX({
+      storage: nodeFs.ipxFSStorage({
+        dir: args.dir
+      }),
+      httpStorage: nodeFs.ipxHttpStorage({
+        domains: args.domains
+      })
+    });
+    await listhen.listen(nodeFs.createIPXNodeServer(ipx), {
+      name: "IPX",
+      ...cli.parseArgs(args)
+    });
+  }
+});
+const main = citty.defineCommand({
+  meta: {
+    name,
+    version,
+    description
+  },
+  subCommands: {
+    serve
+  }
 });
+citty.runMain(main);

package/dist/cli.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/cli.d.ts

@@ -1,2 +1,2 @@
 
-export { }
+export {  }

package/dist/cli.mjs

@@ -1,27 +1,61 @@
-import consola from 'consola';
 import { listen } from 'listhen';
-import { createIPX, createIPXMiddleware } from './index.mjs';
+import { defineCommand, runMain } from 'citty';
+import { getArgs, parseArgs } from 'listhen/cli';
+import { c as createIPX, g as ipxFSStorage, i as ipxHttpStorage, e as createIPXNodeServer } from './shared/ipx.42c0c175.mjs';
 import 'defu';
 import 'image-meta';
 import 'ufo';
-import 'node:fs';
-import 'pathe';
+import 'h3';
 import 'destr';
-import 'node:http';
-import 'node:https';
-import 'node-fetch-native';
 import '@fastify/accept-negotiator';
 import 'etag';
-import 'xss';
+import 'node-fetch-native';
+import 'pathe';
+
+const name = "ipx";
+const version = "2.0.0-0";
+const description = "High performance, secure and easy-to-use image optimizer.";
 
-async function main() {
-  const ipx = createIPX({});
-  const middleware = createIPXMiddleware(ipx);
-  await listen(middleware, {
-    clipboard: false
-  });
-}
-main().catch((error) => {
-  consola.error(error);
-  process.exit(1);
+const serve = defineCommand({
+  meta: {
+    description: "Start IPX Server"
+  },
+  args: {
+    dir: {
+      type: "string",
+      required: false,
+      description: "Directory to serve (default: current directory) ENV: IPX_FS_DIR"
+    },
+    domains: {
+      type: "string",
+      required: false,
+      description: "Allowed domains (comma separated) ENV: IPX_HTTP_DOMAINS"
+    },
+    ...getArgs()
+  },
+  async run({ args }) {
+    const ipx = createIPX({
+      storage: ipxFSStorage({
+        dir: args.dir
+      }),
+      httpStorage: ipxHttpStorage({
+        domains: args.domains
+      })
+    });
+    await listen(createIPXNodeServer(ipx), {
+      name: "IPX",
+      ...parseArgs(args)
+    });
+  }
+});
+const main = defineCommand({
+  meta: {
+    name,
+    version,
+    description
+  },
+  subCommands: {
+    serve
+  }
 });
+runMain(main);