image-renditions 0.1.0 → 0.3.0

package/dist/{url-BIvAw2BR.mjs → url-C6PtYIEf.mjs}

@@ -1,15 +1,5 @@
-import { i as formatExtensions, o as serializeRecipe } from "./recipe-DmOhQJWE.mjs";
+import { i as formatExtensions } from "./recipe-BavgOq0b.mjs";
 import { n as isSafePath, r as isSafeScope, t as encodePath } from "./path-hNFUjCbA.mjs";
-import { sha256 } from "@noble/hashes/sha2.js";
-import { bytesToHex, utf8ToBytes } from "@noble/hashes/utils.js";
-//#region src/hash.ts
-/** Length of a recipe hash in hex digits, which keeps 128 bits of SHA-256. */
-const RECIPE_HASH_LENGTH = 32;
-/** Identifies a recipe by the truncated SHA-256 of its canonical serialization. */
-function hashRecipe(recipe) {
-	return bytesToHex(sha256(utf8ToBytes(serializeRecipe(recipe)))).slice(0, 32);
-}
-//#endregion
 //#region src/url.ts
 /** Version segment of the rendition URL format this library builds and parses. */
 const URL_FORMAT_VERSION = "v1";
@@ -26,7 +16,8 @@ function formatRenditionPath(basePath, { scope, label, hash, format, path }) {
 	const extension = formatExtensions[format];
 	if (!isSafeLabel(label) || !isHash(hash) || !extension) throw new RangeError(`Invalid rendition variant "${label}.${hash}.${extension ?? format}".`);
 	if (!isSafePath(path)) throw new RangeError(`Unsafe rendition source path "${path}".`);
-	return `${basePath}/v1/${scope === void 0 ? "" : `${scope}/`}${label}.${hash}.${extension}/${encodePath(path)}`;
+	const scopePrefix = scope === void 0 ? "" : `${scope}/`;
+	return `${basePath}/${URL_FORMAT_VERSION}/${scopePrefix}${label}.${hash}.${extension}/${encodePath(path)}`;
 }
 /**
 * Parses the path of a rendition URL, ignoring any query string.
@@ -34,7 +25,7 @@ function formatRenditionPath(basePath, { scope, label, hash, format, path }) {
 * Returns `undefined` for a path outside `basePath`, another URL format version, or malformed or unsafe parts.
 */
 function parseRenditionPath(basePath, url) {
-	const prefix = `${basePath}/v1/`;
+	const prefix = `${basePath}/${URL_FORMAT_VERSION}/`;
 	const pathname = url.split("?", 1)[0];
 	if (!pathname.startsWith(prefix)) return;
 	const parts = pathname.slice(prefix.length).split("/");
@@ -67,8 +58,13 @@ const formats = Object.keys(formatExtensions);
 function isSafeLabel(label) {
 	return /^[\w@.-]{1,64}$/.test(label);
 }
+/**
+* Checks that a recipe hash is 1 to 64 ASCII letters, digits, `_` or `-`, which need no encoding in a URL or a storage key.
+*
+* The grammar does not fix the format of hashes, so a hash the catalog cannot produce is looked up as a published rendition instead of making the URL malformed.
+*/
 function isHash(hash) {
-	return hash.length === 32 && /^[\da-f]+$/.test(hash);
+	return /^[\w-]{1,64}$/.test(hash);
 }
 function decodeSegment(segment) {
 	try {
@@ -78,4 +74,4 @@ function decodeSegment(segment) {
 	}
 }
 //#endregion
-export { parseRenditionPath as a, formatRenditionPath as i, URL_FORMAT_VERSION as n, RECIPE_HASH_LENGTH as o, assertBasePath as r, hashRecipe as s, DEFAULT_BASE_PATH as t };
+export { parseRenditionPath as i, assertBasePath as n, formatRenditionPath as r, DEFAULT_BASE_PATH as t };

package/dist/{url-BByyAbmB.d.mts → url-DoJdUx9J.d.mts}

@@ -1,7 +1,5 @@
-import { o as RenditionFormat } from "./recipe-Je9DxqO1.mjs";
+import { s as RenditionFormat } from "./recipe-BT8D60Qb.mjs";
 //#region src/url.d.ts
-/** Version segment of the rendition URL format this library builds and parses. */
-declare const URL_FORMAT_VERSION = "v1";
 /** Mount path of the rendition handler unless a catalog sets another one. */
 declare const DEFAULT_BASE_PATH = "/_renditions";
 /** Parts of a rendition URL. */
@@ -28,11 +26,5 @@ declare function formatRenditionPath(basePath: string, { scope, label, hash, for
  * Returns `undefined` for a path outside `basePath`, another URL format version, or malformed or unsafe parts.
  */
 declare function parseRenditionPath(basePath: string, url: string): RenditionAddress | undefined;
-/**
- * Checks that a base path is absolute, has no trailing slash and needs no URL encoding.
- *
- * @throws {RangeError} When the base path is invalid.
- */
-declare function assertBasePath(basePath: string): void;
 //#endregion
-export { formatRenditionPath as a, assertBasePath as i, RenditionAddress as n, parseRenditionPath as o, URL_FORMAT_VERSION as r, DEFAULT_BASE_PATH as t };
+export { parseRenditionPath as i, RenditionAddress as n, formatRenditionPath as r, DEFAULT_BASE_PATH as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "image-renditions",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "On-demand image transformations that persist every result to durable storage and keep app servers stateless.",
   "homepage": "https://github.com/IlyaSemenov/image-renditions#readme",
   "bugs": "https://github.com/IlyaSemenov/image-renditions/issues",
@@ -64,12 +64,16 @@
     "vue": "^3.5.44"
   },
   "peerDependencies": {
+    "@aws-sdk/client-s3": "^3.1150.0",
     "h3": "^1.15.0 || ^2.0.0",
     "nuxt": "^4.0.0",
     "sharp": "^0.35.0",
     "vue": "^3.5.0"
   },
   "peerDependenciesMeta": {
+    "@aws-sdk/client-s3": {
+      "optional": true
+    },
     "h3": {
       "optional": true
     },

package/dist/catalog-CSnosQ1L.d.mts

@@ -1,64 +0,0 @@
-import { l as SourcePolicy, r as Recipe, s as RenditionOptions } from "./recipe-Je9DxqO1.mjs";
-//#region src/catalog.d.ts
-/** Named transformation in a catalog. */
-interface PresetDefinition extends RenditionOptions {
-  /** Pixel densities to render, as multipliers of `width` and `height`; defaults to `[1]`. */
-  densities?: readonly number[];
-}
-/** Shared configuration of renditions, imported by both the client and the server. */
-interface CatalogDefinition<Name extends string = string> {
-  /** Path the rendition handler is mounted at, `/_renditions` by default. */
-  basePath?: string;
-  /** Bumping it gives every variant a new hash, so every rendition is generated again. */
-  pipelineVersion?: number;
-  /** Options of every preset; a preset overrides them field by field. */
-  defaults?: PresetDefinition;
-  /** How special kinds of sources are rendered. */
-  sources?: Partial<SourcePolicy>;
-  presets: Record<Name, PresetDefinition>;
-}
-/** One density of a preset, which is a separate recipe with its own hash. */
-interface RenditionVariant {
-  readonly preset: string;
-  readonly density: number;
-  /** Readable URL label, such as `avatar` or `avatar@2x`. */
-  readonly label: string;
-  readonly recipe: Recipe;
-  readonly hash: string;
-}
-/** Source a rendition is made from. */
-interface RenditionTarget {
-  /** Application-defined space of the path, such as a tenant; omitted when the application has one space. */
-  scope?: string;
-  /** Logical source path inside the scope. */
-  path: string;
-}
-/** Validated catalog with its variants and URL builders. */
-interface Catalog<Name extends string = string> {
-  readonly basePath: string;
-  readonly presets: readonly Name[];
-  /** Variants of a preset ordered by density. */
-  variants(preset: Name): readonly RenditionVariant[];
-  /**
-   * Variant of a preset at a density, `1` by default.
-   *
-   * @throws {RangeError} When the preset does not declare the density.
-   */
-  variant(preset: Name, density?: number): RenditionVariant;
-  /** Variant with a recipe hash, if the catalog has one. */
-  findVariant(hash: string): RenditionVariant | undefined;
-  /** Root-relative URL of a rendition. */
-  url(preset: Name, target: RenditionTarget, density?: number): string;
-  /** `srcset` attribute value listing every density of a preset. */
-  srcset(preset: Name, target: RenditionTarget): string;
-}
-/**
- * Validates a catalog and computes the recipe and hash of every preset density.
- *
- * Preset names are only labels: renaming a preset keeps its hashes and thus its stored renditions.
- *
- * @throws {RangeError} When the catalog is invalid.
- */
-declare function defineCatalog<const Name extends string>(definition: CatalogDefinition<Name>): Catalog<Name>;
-//#endregion
-export { RenditionVariant as a, RenditionTarget as i, CatalogDefinition as n, defineCatalog as o, PresetDefinition as r, Catalog as t };

package/dist/processor-_xuwB7Aa.d.mts

@@ -1,14 +0,0 @@
-import { r as Recipe } from "./recipe-Je9DxqO1.mjs";
-import { t as EncodedImage } from "./stores-DFDRMZcC.mjs";
-//#region src/server/processor.d.ts
-/** Renders a source image according to a recipe. */
-interface Processor {
-  /**
-   * Renders the source.
-   *
-   * Rejects with a `RenditionError` of reason `unsupported-source` when the source cannot be decoded.
-   */
-  process(source: Uint8Array, recipe: Recipe): Promise<EncodedImage>;
-}
-//#endregion
-export { Processor as t };