@effected/images 0.6.2 → 0.8.0

package/ImageCacheKey.js

@@ -1,8 +1,8 @@
 import { DIGEST_PATTERN } from "./internal/digest.js";
 import { ImageCacheKeyError } from "./ImageCacheKeyError.js";
 import { canonicalJson } from "./internal/canonical.js";
-import { Crypto, Effect, Result, Schema } from "effect";
-import * as Hex from "effect/encoding/Hex";
+import { Effect, Result, Schema } from "effect";
+import { Digest } from "effect/crypto";
 
 // src/ImageCacheKey.ts
 /**
@@ -23,8 +23,9 @@ var ImageCacheKey = class ImageCacheKey extends Schema.Class("ImageCacheKey")({
 	*
 	* @remarks
 	* `params` are encoded through `schema`, so a transformation participates and the key reflects the wire form. The
-	* digest is core `Crypto`'s SHA-256, so `Crypto` is required — Node apps get it from `NodeServices.layer` or
-	* `NodeCrypto.layer`.
+	* digest is core `Digest`'s SHA-256, so `Digest.Digest` is required — provide `Digest.layerWebCrypto` from
+	* `effect/crypto`, or a platform family layer such as `NodeCrypto.layerDigest`. `NodeServices.layer` does not
+	* include it.
 	*/
 	static fromParams(schema, params, options) {
 		return Effect.gen(function* () {
@@ -38,13 +39,9 @@ var ImageCacheKey = class ImageCacheKey extends Schema.Class("ImageCacheKey")({
 				reason: "non-json",
 				detail: canonical.failure
 			});
-			const bytes = yield* (yield* Crypto.Crypto).digest("SHA-256", new TextEncoder().encode(`${options.salt}\u0000${canonical.success}`)).pipe(Effect.mapError((cause) => new ImageCacheKeyError({
-				reason: "digest",
-				detail: cause.message,
-				cause
-			})));
+			const hex = yield* (yield* Digest.Digest).digestHex(Digest.sha256, new TextEncoder().encode(`${options.salt}\u0000${canonical.success}`));
 			return ImageCacheKey.make({
-				digest: Hex.encode(bytes),
+				digest: hex,
 				salt: options.salt,
 				namespace: options.namespace
 			});

package/ImageCacheKeyError.js

@@ -6,20 +6,17 @@ import { Schema } from "effect";
 *
 * @remarks
 * `encode`: the parameter schema rejected the params. `non-json`: the encoded form holds a value canonical JSON
-* cannot carry (a `Date`, a `bigint`, a non-finite number, a class instance). `digest`: the `Crypto` service failed.
+* cannot carry (a `Date`, a `bigint`, a non-finite number, a class instance). The SHA-256 digest itself has no typed
+* failure, so it is not a reason.
 *
 * @public
 */
 var ImageCacheKeyError = class extends Schema.TaggedError()("ImageCacheKeyError", {
 	/** Which step failed. */
-	reason: Schema.Literals([
-		"encode",
-		"non-json",
-		"digest"
-	]),
+	reason: Schema.Literals(["encode", "non-json"]),
 	/** What exactly was wrong. */
 	detail: Schema.String,
-	/** The schema error (`encode`) or platform error (`digest`). */
+	/** The schema error (`encode`). */
 	cause: Schema.optionalKey(Schema.Defect())
 }) {
 	get message() {

package/README.md

@@ -8,10 +8,10 @@
 Image facts from bytes, and a cache for generated images. `ImageFacts` reads the format, MIME type and pixel dimensions of a PNG, JPEG, GIF, WebP or AVIF file straight from its header, with one typed failure for bytes that are not a readable image. `ImageCache` answers "have I already generated an image from these parameters?", so a build stops re-running an expensive renderer such as an Open Graph card generator on every run.
 
 > **Pre-`1.0.0`.** This package is part of the `@effected/*` kit, built on stable
-> Effect v4 (`effect` `^4.0.0`) and still in `0.x` development. Stable Effect
+> Effect v4 (`effect` `~4.1.0`) and still in `0.x` development. Stable Effect
 > makes a kit `1.0.0` possible, not automatic. To keep your `effect` and
 > `@effect/*` versions on the line the kit is built and tested against, install
-> [`@effected/pnpm-plugin-effect`](https://www.npmjs.com/package/@effected/pnpm-plugin-effect).
+> [`@effected/pnpm-plugin-effected`](https://www.npmjs.com/package/@effected/pnpm-plugin-effected).
 >
 > **Stability: unstable.** This package's API surface is not yet considered
 > complete and may change across `0.x` releases. Pin an exact version — even a
@@ -66,7 +66,7 @@ const facts = ImageFacts.fromBytes(bytes).pipe(
 
 ```ts
 import { ImageBackend, ImageCache, ImageCacheKey } from "@effected/images/cache";
-import { NodeServices } from "@effect/platform-node";
+import { NodeCrypto, NodeServices } from "@effect/platform-node";
 import { Effect, Layer, Schema } from "effect";
 
 const CardParams = Schema.Struct({ title: Schema.String, theme: Schema.String });
@@ -89,7 +89,10 @@ const program = Effect.gen(function* () {
     { accept: ["png"] },
   );
   return { bytes, width: facts.width, hit };
-}).pipe(Effect.provide(CacheLive), Effect.provide(NodeServices.layer));
+}).pipe(
+  Effect.provide(CacheLive),
+  Effect.provide(Layer.mergeAll(NodeServices.layer, NodeCrypto.layerDigest)),
+);
 ```
 
 `getOrGenerate` returns the bytes, their `ImageFacts` and whether it was a `hit`. With `accept`, the result's `facts.format` is typed as the accepted formats, so `["png", "jpeg", "webp"]` gives `"png" | "jpeg" | "webp"`; without it, every format. A stored entry that no longer parses, or whose format is outside `accept`, is treated as a miss and overwritten. A generator result that is empty, unparseable or outside `accept` fails with `ImageGenerateError` and is never stored. Backend failures surface as `ImageBackendError`; the generator's own error passes through untouched.
@@ -120,7 +123,7 @@ declare const cachingEnabled: boolean;
 const backend = cachingEnabled ? ImageBackend.layerDirectory({ directory: ".cache/og" }) : ImageBackend.layerNone;
 ```
 
-The key digest uses core `Crypto`, and the directory backend uses `FileSystem` and `Path`. On Node, `NodeServices.layer` from `@effect/platform-node` provides all three.
+The key digest uses core `Digest.Digest` (`effect/crypto`), and the directory backend uses `FileSystem` and `Path`. On Node, `NodeServices.layer` from `@effect/platform-node` provides `FileSystem` and `Path`, and `NodeCrypto.layerDigest` provides `Digest.Digest`; `Digest.layerWebCrypto` from `effect/crypto` works on any runtime with WebCrypto.
 
 ### Bring your own store
 

package/cache.d.ts

@@ -1,5 +1,6 @@
-import { Context, Crypto, Effect, FileSystem, Layer, Option, Path, Schema } from "effect";
+import { Context, Effect, FileSystem, Layer, Option, Path, Schema } from "effect";
 import * as Images from "@effected/images";
+import { Digest } from "effect/crypto";
 declare const ImageBackendError_base: Schema.Class<ImageBackendError, Schema.TaggedStruct<"ImageBackendError", {
   /** The backend operation that failed. */
   readonly operation: Schema.Literals<readonly ["get", "set"]>;
@@ -119,10 +120,10 @@ export declare class ImageBackend extends ImageBackend_base {
 }
 declare const ImageCacheKeyError_base: Schema.Class<ImageCacheKeyError, Schema.TaggedStruct<"ImageCacheKeyError", {
   /** Which step failed. */
-  readonly reason: Schema.Literals<readonly ["encode", "non-json", "digest"]>;
+  readonly reason: Schema.Literals<readonly ["encode", "non-json"]>;
   /** What exactly was wrong. */
   readonly detail: Schema.String;
-  /** The schema error (`encode`) or platform error (`digest`). */
+  /** The schema error (`encode`). */
   readonly cause: Schema.optionalKey<Schema.Defect>;
 }>, import("effect/Cause").YieldableError>;
 /**
@@ -130,7 +131,8 @@ declare const ImageCacheKeyError_base: Schema.Class<ImageCacheKeyError, Schema.T
  *
  * @remarks
  * `encode`: the parameter schema rejected the params. `non-json`: the encoded form holds a value canonical JSON
- * cannot carry (a `Date`, a `bigint`, a non-finite number, a class instance). `digest`: the `Crypto` service failed.
+ * cannot carry (a `Date`, a `bigint`, a non-finite number, a class instance). The SHA-256 digest itself has no typed
+ * failure, so it is not a reason.
  *
  * @public
  */
@@ -167,10 +169,11 @@ export declare class ImageCacheKey extends ImageCacheKey_base {
    *
    * @remarks
    * `params` are encoded through `schema`, so a transformation participates and the key reflects the wire form. The
-   * digest is core `Crypto`'s SHA-256, so `Crypto` is required — Node apps get it from `NodeServices.layer` or
-   * `NodeCrypto.layer`.
+   * digest is core `Digest`'s SHA-256, so `Digest.Digest` is required — provide `Digest.layerWebCrypto` from
+   * `effect/crypto`, or a platform family layer such as `NodeCrypto.layerDigest`. `NodeServices.layer` does not
+   * include it.
    */
-  static fromParams<S extends Schema.ConstraintEncoder<unknown>>(schema: S, params: S["Type"], options: ImageCacheKeyOptions): Effect.Effect<ImageCacheKey, ImageCacheKeyError, Crypto.Crypto>;
+  static fromParams<S extends Schema.ConstraintEncoder<unknown>>(schema: S, params: S["Type"], options: ImageCacheKeyOptions): Effect.Effect<ImageCacheKey, ImageCacheKeyError, Digest.Digest>;
 }
 declare const ImageGenerateError_base: Schema.Class<ImageGenerateError, Schema.TaggedStruct<"ImageGenerateError", {
   /** Why the output was refused. */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/images",
-	"version": "0.6.2",
+	"version": "0.8.0",
 	"private": false,
 	"description": "Image facts (format, MIME type, dimensions) from bytes, and a generated-image cache, for Effect.",
 	"keywords": [
@@ -45,7 +45,7 @@
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"effect": "^4.0.0"
+		"effect": "~4.1.0"
 	},
 	"engines": {
 		"node": ">=24.11.0"

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.59.4"
+      "packageVersion": "7.60.0"
     }
   ]
 }