@bunny.net/api-client-effect-v4-runtime 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# @bunny.net/api-client-effect-v4-runtime
+
+## 1.1.0
+
+### Minor Changes
+
+- 1baeec8: `BunnyCredentials.fromEnv()` without a name now reads `BUNNYNET_API_KEY`. The
+  previous default, `BUNNY_API_KEY`, is still read when `BUNNYNET_API_KEY` is
+  unset, and is deprecated: the fallback goes away in the next major. A name
+  passed explicitly is read as before.

package/README.md

@@ -43,7 +43,7 @@ const program = Effect.gen(function* () {
 );
 
 const Live = BunnyCore.Default.pipe(
-  Layer.provide(BunnyCredentials.layer(process.env.BUNNY_API_KEY!)),
+  Layer.provide(BunnyCredentials.layer(process.env.BUNNYNET_API_KEY!)),
   Layer.provide(FetchHttpClient.layer),
 );
 
@@ -52,9 +52,10 @@ console.log(await Effect.runPromise(program.pipe(Effect.provide(Live))));
 
 `BunnyCredentials.layer(key)` holds one key, as a string or an existing
 `Redacted`; `BunnyCredentials.fromEnv(name)` reads it from configuration,
-`BUNNY_API_KEY` by default. The key is kept `Redacted`, so it never shows up
-through `toString`, `JSON.stringify` or inspection, and it is revealed at one
-place only: when the auth header is set on the outgoing request.
+`BUNNYNET_API_KEY` by default, falling back to the deprecated `BUNNY_API_KEY`
+when it is unset. The key is kept `Redacted`, so it never shows up through
+`toString`, `JSON.stringify` or inspection, and it is revealed at one place
+only: when the auth header is set on the outgoing request.
 
 The errors are all `Data.TaggedError`, so `Effect.catchTag` narrows them:
 

package/dist/src/credentials.d.ts

@@ -14,7 +14,13 @@ declare const BunnyCredentials_base: Context.ServiceClass<BunnyCredentials, "@bu
 export declare class BunnyCredentials extends BunnyCredentials_base {
     /** A layer holding one key. Accepts a raw string (wrapped immediately) or an existing `Redacted`. */
     static readonly layer: (accessKey: string | Redacted.Redacted<string>) => Layer.Layer<BunnyCredentials>;
-    /** A layer reading the key from configuration (the environment by default); `BUNNY_API_KEY` unless another name is given. */
+    /**
+     * A layer reading the key from configuration (the environment by default).
+     *
+     * With a name, it reads that name only. Without one, it reads
+     * `BUNNYNET_API_KEY`, then the deprecated `BUNNY_API_KEY` when that is
+     * unset; the fallback goes away in the next major.
+     */
     static readonly fromEnv: (name?: string) => Layer.Layer<BunnyCredentials, Config.ConfigError>;
 }
 export {};

package/dist/src/credentials.js

@@ -13,7 +13,15 @@ export class BunnyCredentials extends Context.Service()("@bunny.net/api-client-e
             ? accessKey
             : Redacted.make(accessKey),
     });
-    /** A layer reading the key from configuration (the environment by default); `BUNNY_API_KEY` unless another name is given. */
-    static fromEnv = (name = "BUNNY_API_KEY") => Layer.effect(BunnyCredentials, Config.Redacted(name).pipe(Effect.map((accessKey) => ({ accessKey }))));
+    /**
+     * A layer reading the key from configuration (the environment by default).
+     *
+     * With a name, it reads that name only. Without one, it reads
+     * `BUNNYNET_API_KEY`, then the deprecated `BUNNY_API_KEY` when that is
+     * unset; the fallback goes away in the next major.
+     */
+    static fromEnv = (name) => Layer.effect(BunnyCredentials, (name === undefined
+        ? Config.Redacted("BUNNYNET_API_KEY").pipe(Config.orElse(() => Config.Redacted("BUNNY_API_KEY")))
+        : Config.Redacted(name)).pipe(Effect.map((accessKey) => ({ accessKey }))));
 }
 //# sourceMappingURL=credentials.js.map

package/dist/src/credentials.js.map

@@ -1 +1 @@
-{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../src/credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAOlE;;;;;;GAMG;AACH,MAAM,OAAO,gBACX,SAAQ,OAAO,CAAC,OAAO,EAA2C,CAChE,0DAA0D,CAC3D;IACD,qGAAqG;IACrG,MAAM,CAAU,KAAK,GAAG,CACtB,SAA6C,EACd,EAAE,CACjC,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE;QAC9B,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;YACvC,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;KAC7B,CAAC,CAAC;IAEL,6HAA6H;IAC7H,MAAM,CAAU,OAAO,GAAG,CACxB,IAAI,GAAG,eAAe,EAC6B,EAAE,CACrD,KAAK,CAAC,MAAM,CACV,gBAAgB,EAChB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CACvE,CAAC","sourcesContent":["import { Config, Context, Effect, Layer, Redacted } from \"effect\";\n\n/** What a Bunny.net client needs to authenticate: the API key (or, for the Edge Storage API, the zone password). */\nexport interface BunnyCredentialsShape {\n  readonly accessKey: Redacted.Redacted<string>;\n}\n\n/**\n * The credential service every generated client reads from context.\n *\n * The key is held as `Redacted` so it never appears through\n * `toString`/`JSON.stringify`/inspection; it is revealed at exactly one\n * place, when the auth header is set on the outgoing request.\n */\nexport class BunnyCredentials\n  extends Context.Service<BunnyCredentials, BunnyCredentialsShape>()(\n    \"@bunny.net/api-client-effect-v4-runtime/BunnyCredentials\",\n  ) {\n  /** A layer holding one key. Accepts a raw string (wrapped immediately) or an existing `Redacted`. */\n  static readonly layer = (\n    accessKey: string | Redacted.Redacted<string>,\n  ): Layer.Layer<BunnyCredentials> =>\n    Layer.succeed(BunnyCredentials, {\n      accessKey: Redacted.isRedacted(accessKey)\n        ? accessKey\n        : Redacted.make(accessKey),\n    });\n\n  /** A layer reading the key from configuration (the environment by default); `BUNNY_API_KEY` unless another name is given. */\n  static readonly fromEnv = (\n    name = \"BUNNY_API_KEY\",\n  ): Layer.Layer<BunnyCredentials, Config.ConfigError> =>\n    Layer.effect(\n      BunnyCredentials,\n      Config.Redacted(name).pipe(Effect.map((accessKey) => ({ accessKey }))),\n    );\n}\n"]}
+{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../src/credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAOlE;;;;;;GAMG;AACH,MAAM,OAAO,gBACX,SAAQ,OAAO,CAAC,OAAO,EAA2C,CAChE,0DAA0D,CAC3D;IACD,qGAAqG;IACrG,MAAM,CAAU,KAAK,GAAG,CACtB,SAA6C,EACd,EAAE,CACjC,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE;QAC9B,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;YACvC,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;KAC7B,CAAC,CAAC;IAEL;;;;;;OAMG;IACH,MAAM,CAAU,OAAO,GAAG,CACxB,IAAa,EACsC,EAAE,CACrD,KAAK,CAAC,MAAM,CACV,gBAAgB,EAChB,CAAC,IAAI,KAAK,SAAS;QACjB,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,IAAI,CACxC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CACtD;QACD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAC3C,CACJ,CAAC","sourcesContent":["import { Config, Context, Effect, Layer, Redacted } from \"effect\";\n\n/** What a Bunny.net client needs to authenticate: the API key (or, for the Edge Storage API, the zone password). */\nexport interface BunnyCredentialsShape {\n  readonly accessKey: Redacted.Redacted<string>;\n}\n\n/**\n * The credential service every generated client reads from context.\n *\n * The key is held as `Redacted` so it never appears through\n * `toString`/`JSON.stringify`/inspection; it is revealed at exactly one\n * place, when the auth header is set on the outgoing request.\n */\nexport class BunnyCredentials\n  extends Context.Service<BunnyCredentials, BunnyCredentialsShape>()(\n    \"@bunny.net/api-client-effect-v4-runtime/BunnyCredentials\",\n  ) {\n  /** A layer holding one key. Accepts a raw string (wrapped immediately) or an existing `Redacted`. */\n  static readonly layer = (\n    accessKey: string | Redacted.Redacted<string>,\n  ): Layer.Layer<BunnyCredentials> =>\n    Layer.succeed(BunnyCredentials, {\n      accessKey: Redacted.isRedacted(accessKey)\n        ? accessKey\n        : Redacted.make(accessKey),\n    });\n\n  /**\n   * A layer reading the key from configuration (the environment by default).\n   *\n   * With a name, it reads that name only. Without one, it reads\n   * `BUNNYNET_API_KEY`, then the deprecated `BUNNY_API_KEY` when that is\n   * unset; the fallback goes away in the next major.\n   */\n  static readonly fromEnv = (\n    name?: string,\n  ): Layer.Layer<BunnyCredentials, Config.ConfigError> =>\n    Layer.effect(\n      BunnyCredentials,\n      (name === undefined\n        ? Config.Redacted(\"BUNNYNET_API_KEY\").pipe(\n          Config.orElse(() => Config.Redacted(\"BUNNY_API_KEY\")),\n        )\n        : Config.Redacted(name)).pipe(\n          Effect.map((accessKey) => ({ accessKey })),\n        ),\n    );\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bunny.net/api-client-effect-v4-runtime",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Shared runtime for the Bunny.net Effect 4 API clients: the BunnyCredentials service, the error taxonomy, and the operation executor over Effect's HttpClient (effect/http).",
   "license": "MIT",
   "type": "module",