asherah 4.0.36 → 4.0.38

package/README.md

@@ -14,6 +14,18 @@ npm install asherah
 
 Requires Node.js >= 18.
 
+## Documentation
+
+Task-oriented walkthroughs under [`docs/`](./docs/):
+
+| Guide | When to read |
+|---|---|
+| [Getting started](./docs/getting-started.md) | First-time install through round-trip encrypt/decrypt. |
+| [Framework integration](./docs/framework-integration.md) | Express, Fastify, NestJS, Koa, AWS Lambda, worker patterns. |
+| [AWS production setup](./docs/aws-production-setup.md) | KMS keys, DynamoDB, IAM policy, region routing. |
+| [Testing](./docs/testing.md) | Jest/Vitest fixtures, Testcontainers, mocking patterns. |
+| [Troubleshooting](./docs/troubleshooting.md) | Common errors with what to check first. |
+
 ## Choosing an API style
 
 Two API styles are exposed; both are fully supported and produce the same
@@ -201,6 +213,7 @@ SDK) — both are auto-mapped. Pass to `setup()`, `setupAsync()`, or the
 | `sessionCacheDuration` | `number` | | Session cache TTL in seconds. |
 | `regionMap` | `Record<string, string>` | | AWS KMS multi-region key ARN map. |
 | `preferredRegion` | `string` | | Preferred AWS region from `regionMap`. |
+| `awsProfileName` | `string` | | AWS credentials profile name for KMS/DynamoDB/Secrets Manager clients. |
 | `enableRegionSuffix` | `boolean` | | Append AWS region suffix to key IDs. |
 | `expireAfter` | `number` | 90 days | Intermediate-key expiration in seconds. |
 | `checkInterval` | `number` | 60 minutes | Revoke-check interval in seconds. |

package/index.d.ts

@@ -92,6 +92,8 @@ export type AsherahConfig = {
   regionMap?: Record<string, string> | null;
   /** Preferred AWS region when `regionMap` is set. */
   preferredRegion?: string | null;
+  /** AWS shared-credentials profile name (typically from `~/.aws/credentials`); forwarded to the Rust aws-config loader for KMS, DynamoDB, and Secrets Manager clients. Omit to use the default credential chain. */
+  awsProfileName?: string | null;
   /** Append the AWS region as a suffix to the key ID. */
   enableRegionSuffix?: boolean | null;
 
@@ -139,6 +141,7 @@ export type AsherahConfigCompat = {
   readonly KMS?: 'aws' | 'static' | 'test-debug-static' | null;
   readonly RegionMap?: Record<string, string> | null;
   readonly PreferredRegion?: string | null;
+  readonly AwsProfileName?: string | null;
   readonly EnableRegionSuffix?: boolean | null;
   readonly EnableSessionCaching?: boolean | null;
   readonly Verbose?: boolean | null;

package/npm/index.js

@@ -116,6 +116,7 @@ const CONFIG_MAP = {
   KMS: 'kms',
   RegionMap: 'regionMap',
   PreferredRegion: 'preferredRegion',
+  AwsProfileName: 'awsProfileName',
   EnableRegionSuffix: 'enableRegionSuffix',
   EnableSessionCaching: 'enableSessionCaching',
   Verbose: 'verbose',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asherah",
-  "version": "4.0.36",
+  "version": "4.0.38",
   "private": false,
   "description": "Asherah application-layer encryption for Node.js with automatic key rotation, powered by the native Rust implementation.",
   "author": "Jay Gowdy",
@@ -70,13 +70,13 @@
     "node": ">= 18"
   },
   "optionalDependencies": {
-    "asherah-darwin-arm64": "4.0.36",
-    "asherah-darwin-x64": "4.0.36",
-    "asherah-linux-x64-gnu": "4.0.36",
-    "asherah-linux-arm64-gnu": "4.0.36",
-    "asherah-linux-x64-musl": "4.0.36",
-    "asherah-linux-arm64-musl": "4.0.36",
-    "asherah-windows-x64": "4.0.36",
-    "asherah-windows-arm64": "4.0.36"
+    "asherah-darwin-arm64": "4.0.38",
+    "asherah-darwin-x64": "4.0.38",
+    "asherah-linux-x64-gnu": "4.0.38",
+    "asherah-linux-arm64-gnu": "4.0.38",
+    "asherah-linux-x64-musl": "4.0.38",
+    "asherah-linux-arm64-musl": "4.0.38",
+    "asherah-windows-x64": "4.0.38",
+    "asherah-windows-arm64": "4.0.38"
   }
 }