@rc312/effect-aws-imds 0.1.0 → 0.2.0

package/README.md

@@ -3,7 +3,7 @@
 An **Effect-native client for the AWS EC2 Instance Metadata Service** (IMDSv2). It has no runtime dependencies besides its `effect` peer.
 
 ```sh
-bun add @rc312/effect-aws-imds 'effect@^4.0.5'
+bun add @rc312/effect-aws-imds 'effect@^4.1.2'
 ```
 
 ## Usage
@@ -13,7 +13,10 @@ import * as AwsImds from "@rc312/effect-aws-imds";
 import { Effect } from "effect";
 
 const program = Effect.gen(function* () {
+  // Yield the Effect to obtain the decoded, memoized document.
   const document = yield* AwsImds.identityDocument;
+  // document.instanceType is already available without another request.
+  // This extra request demonstrates uncached reads with get(path).
   const instanceType = yield* AwsImds.get("/latest/meta-data/instance-type");
 
   return {
@@ -141,21 +144,6 @@ const ImdsLive = AwsImds.layerFetch.pipe(
 
 - **Token handling.** The session token is held as a `Redacted` value. `x-aws-ec2-metadata-token` is added to `Headers.CurrentRedactedNames` for metadata requests, so client spans that capture request headers record it as `<redacted>`. Neither error type keeps the underlying HTTP request or its headers.
 
-## Migrating from `effect-extensions/aws/imds`
-
-| Before | Now |
-| --- | --- |
-| `awsIdentityDocument()` | `identityDocument` |
-| `layer` | `layer`, with settings from `AwsImdsConfig` |
-| `layerWithFetchHttpClient` | `layerFetch` |
-| `AwsImdsIdentityDocumentFetchError` | `AwsImdsMetadataError` (with `path` and `status`) |
-| `AwsImdsResolutionError` | `AwsImdsError` |
-| One 100 ms timeout around all retries | A 1 second timeout on each attempt |
-| 5 retries | `retryPolicy(2)`, or any bounded `Schedule` |
-| 1 minute token TTL, token used once | 6 hour token TTL, cached and reused |
-| `AwsImds` with `identityDocument` and `clearCache` | `InstanceIdentity` for the document; `AwsImds` for uncached `get(path)` |
-| — | `getSchema`, `optional`, and a replaceable `AwsImdsToken` |
-
 ## Example and end-to-end tests
 
 [`examples/instance-info`](examples/instance-info) is a CLI that uses the built package against a strict mock IMDS. Its end-to-end tests run the CLI as a real process for the healthy, throttled, token-expiry, malformed-document, unresponsive, and unreachable cases. See its [README](examples/instance-info/README.md) to run it by hand.

package/dist/index.d.ts

@@ -23,7 +23,10 @@
  * import * as AwsImds from "@rc312/effect-aws-imds"
  *
  * const program = Effect.gen(function* () {
+ *   // Yield the Effect to obtain the decoded, memoized document.
  *   const document = yield* AwsImds.identityDocument
+ *   // document.instanceType is already available without another request.
+ *   // This extra request demonstrates uncached reads with get(path).
  *   const instanceType = yield* AwsImds.get("/latest/meta-data/instance-type")
  *   return { region: document.region, instanceType }
  * })

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,OAAO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,GAAG,EACH,SAAS,EACT,QAAQ,GACT,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,aAAa,EACb,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,WAAW,GACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,GAAG,EACH,SAAS,EACT,QAAQ,GACT,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,aAAa,EACb,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,WAAW,GACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -23,7 +23,10 @@
  * import * as AwsImds from "@rc312/effect-aws-imds"
  *
  * const program = Effect.gen(function* () {
+ *   // Yield the Effect to obtain the decoded, memoized document.
  *   const document = yield* AwsImds.identityDocument
+ *   // document.instanceType is already available without another request.
+ *   // This extra request demonstrates uncached reads with get(path).
  *   const instanceType = yield* AwsImds.get("/latest/meta-data/instance-type")
  *   return { region: document.region, instanceType }
  * })

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,OAAO,EACL,OAAO,EAEP,GAAG,EACH,SAAS,EACT,QAAQ,GACT,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,aAAa,EAGb,WAAW,GACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,EACL,OAAO,EAEP,GAAG,EACH,SAAS,EACT,QAAQ,GACT,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,aAAa,EAGb,WAAW,GACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rc312/effect-aws-imds",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Effect-native client for the AWS EC2 Instance Metadata Service (IMDSv2).",
   "license": "MIT",
   "repository": {
@@ -30,15 +30,15 @@
     "prepack": "bun run build"
   },
   "devDependencies": {
-    "@effect/vitest": "^4.0.5",
+    "@effect/vitest": "^4.1.2",
     "@types/node": "^26.6.5",
-    "effect": "^4.0.5",
+    "effect": "^4.1.2",
     "vitest": "^5.0.4"
   },
   "peerDependencies": {
-    "effect": "^4.0.5"
+    "effect": "^4.1.2"
   },
   "engines": {
-    "node": ">=22.12.0"
+    "node": ">=22.19.0"
   }
 }

package/src/index.ts

@@ -23,7 +23,10 @@
  * import * as AwsImds from "@rc312/effect-aws-imds"
  *
  * const program = Effect.gen(function* () {
+ *   // Yield the Effect to obtain the decoded, memoized document.
  *   const document = yield* AwsImds.identityDocument
+ *   // document.instanceType is already available without another request.
+ *   // This extra request demonstrates uncached reads with get(path).
  *   const instanceType = yield* AwsImds.get("/latest/meta-data/instance-type")
  *   return { region: document.region, instanceType }
  * })