@effected/config-file 0.19.0 → 0.19.1

package/EncryptedCodec.js

@@ -107,8 +107,7 @@ const keyEffect = (keySource) => keySource._tag === "CryptoKey" ? keySource.key
 */
 function EncryptedCodec(inner, keySource) {
 	const name = `encrypted(${inner.name})`;
-	const [resolveKey, invalidateKey] = Effect.runSync(Effect.cachedInvalidateWithTTL(keyEffect(keySource), Duration.infinity));
-	const getKey = Effect.onExit(resolveKey, (exit) => Exit.isSuccess(exit) ? Effect.void : invalidateKey);
+	const getKey = Effect.runSync(Effect.cachedWithTTL(keyEffect(keySource), (exit) => Exit.isSuccess(exit) ? Duration.infinity : Duration.zero));
 	return {
 		name,
 		parse: (raw) => Effect.gen(function* () {

package/README.md

@@ -190,7 +190,7 @@ One install covers every format, and you still pay only for the parser you name.
 Codecs compose. `EncryptedCodec` wraps any codec with AES-GCM, and `ConfigMigration.make` wraps any codec so parsed content is brought up to the latest version. Each *widens* the error channel rather than flattening its failures into the inner codec's error, and a decorated codec plugs into `ConfigFile.layer`, `ConfigFile.testLayer` and `ConfigFile.read` like any other: their error unions widen with it. A service key names the widened error as its third type argument:
 
 ```ts
-import type { ConfigCodecError, ConfigEncryptionError, ConfigMigrationError } from "@effected/config-file";
+import type { ConfigCodec } from "@effected/config-file";
 import {
   ConfigFile,
   ConfigMigration,
@@ -217,7 +217,8 @@ const migrating = ConfigMigration.make({
 export const secret = EncryptedCodec(migrating, EncryptedCodecKey.fromPassphrase("hunter2", new Uint8Array(16)));
 
 const Settings = Schema.Struct({ port: Schema.Number });
-type SecretError = ConfigCodecError | ConfigMigrationError | ConfigEncryptionError;
+// Read back from the codec value: ConfigCodecError | ConfigMigrationError | ConfigEncryptionError.
+type SecretError = ConfigCodec.ErrorOf<typeof secret>;
 
 class SecretSettings extends ConfigFile.Service<SecretSettings, typeof Settings.Type, SecretError>()(
   "app/SecretSettings",

package/index.d.ts

@@ -66,6 +66,43 @@ interface ConfigCodec<E = ConfigCodecError> {
   /** Turn a document back into file content. */
   readonly stringify: (value: unknown) => Effect.Effect<string, E>;
 }
+/**
+ * Type-level helpers over the `ConfigCodec` interface.
+ *
+ * @public
+ */
+declare namespace ConfigCodec {
+  /**
+   * The error channel of a codec value, read back from its type.
+   *
+   * @remarks
+   * A decorated codec's error union is already on the value —
+   * `EncryptedCodec(...)` over `ConfigMigration.make(...)` is a
+   * `ConfigCodec<ConfigCodecError | ConfigEncryptionError | ConfigMigrationError>`
+   * — and a `ConfigFile.Service` key has to name the same union as its third
+   * type argument. Spelling it out by hand drifts the moment the codec
+   * changes; `ConfigCodec.ErrorOf<typeof codec>` cannot.
+   *
+   * Anything that is not a `ConfigCodec` resolves to `never`.
+   *
+   * @example
+   * ```ts
+   * import type { ConfigCodec } from "@effected/config-file";
+   * import { ConfigFile, ConfigMigration, EncryptedCodec, EncryptedCodecKey, JsonCodec } from "@effected/config-file";
+   *
+   * const codec = EncryptedCodec(
+   * 	ConfigMigration.make({ codec: JsonCodec, migrations: [] }),
+   * 	EncryptedCodecKey.fromPassphrase("hunter2", new Uint8Array(16)),
+   * );
+   *
+   * // Stays in sync with the codec: ConfigCodecError | ConfigMigrationError | ConfigEncryptionError.
+   * class Secrets extends ConfigFile.Service<Secrets, { port: number }, ConfigCodec.ErrorOf<typeof codec>>()(
+   * 	"app/Secrets",
+   * ) {}
+   * ```
+   */
+  type ErrorOf<C> = C extends ConfigCodec<infer E> ? E : never;
+}
 /**
  * A reference to one configuration source that contributed to a load.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/config-file",
-	"version": "0.19.0",
+	"version": "0.19.1",
 	"private": false,
 	"description": "Composable config file loading for Effect: JSON, JSONC, YAML and TOML codecs, resolution strategies, and merge behaviors.",
 	"keywords": [
@@ -47,7 +47,7 @@
 		"@effected/jsonc": "^0.20.0",
 		"@effected/toml": "^0.16.0",
 		"@effected/walker": "^0.19.0",
-		"@effected/yaml": "^0.24.0",
+		"@effected/yaml": "^0.25.0",
 		"effect": "^4.0.0"
 	},
 	"engines": {