@aep-foundation/agent 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @aep-foundation/agent
+
+## 0.1.0
+
+### Minor Changes
+
+- [#1](https://github.com/aep-foundation/aep-node/pull/1) [`3d4713e`](https://github.com/aep-foundation/aep-node/commit/3d4713e2a9cf85478a415192c7c0abc90c374073) Thanks [@nkavian](https://github.com/nkavian)! - Add the initial AEP Node SDK packages, framework adapters, and conformance helpers.
+
+### Patch Changes
+
+- Updated dependencies [[`3d4713e`](https://github.com/aep-foundation/aep-node/commit/3d4713e2a9cf85478a415192c7c0abc90c374073)]:
+  - @aep-foundation/core@0.1.0
+  - @aep-foundation/platform@0.1.0
+
+## 0.0.0
+
+Initial development version.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 AEP Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,104 @@
+# @aep-foundation/agent
+
+Agent-side workflows for AEP.
+
+## Responsibilities
+
+- fetch and validate Service Inspect documents from Service URLs
+- construct AEP command URLs from Inspect HTTP metadata
+- execute Enroll, Status, Grant, and Revoke over the AEP HTTP binding
+- create baseline AEP client assertions
+- use one pluggable Agent identity provider for Service-scoped identity and signing
+- store Agent identities and issued session credentials through user-provided stores
+- choose among advertised grant types
+- create protected-resource authentication headers
+
+The Agent package owns AEP network behavior. Applications provide storage and
+identity custody; they do not provide custom Inspect or command transports.
+For production storage and tenancy guidance, see the repository
+[Integration Guide](../../INTEGRATION.md).
+
+## High-Level API
+
+```ts
+import {
+  createAepAgent,
+  createInMemorySessionCredentialStore,
+  createPlatformIdentityProvider
+} from "@aep-foundation/agent";
+
+const agent = createAepAgent({
+  credentialStore: createInMemorySessionCredentialStore(),
+  identityProvider: createPlatformIdentityProvider({
+    authorization: "Bearer platform-api-token",
+    platformUrl: "https://platform.example.com"
+  })
+});
+
+const session = agent.serviceSession({
+  serviceUrl: "https://api.example.com"
+});
+
+const inspect = await session.inspect();
+const identity = await session.identity();
+
+await session.enroll({
+  claims: {
+    "contact.email": "ops@example.com"
+  }
+});
+
+const status = await session.status();
+
+const grant = await session.grant({
+  preferredGrantTypes: ["oauth-bearer", "api-key", "basic"],
+  requestedScopes: ["read"]
+});
+
+const headers = await session.authenticationHeaders();
+
+await session.revoke({
+  credentialId: grant.body.credential_id
+});
+```
+
+`createAepAgent()` accepts exactly one `identityProvider`. Platform-hosted
+`did:web` support is provided by `createPlatformIdentityProvider()`. Future
+sovereign Agent support can implement the same `AgentIdentityProvider` interface
+for local `did:key` or `did:jwk` custody without changing the Agent engine.
+
+## Storage Ports
+
+The Agent engine can use application-provided stores:
+
+- `AgentIdentityStore` persists the Service-scoped Agent identity.
+- `AgentCredentialStore` persists issued session credentials.
+- `AgentIdempotencyKeyProvider` creates command idempotency keys.
+- `AgentInspectCache` caches validated Inspect documents.
+
+In-memory implementations are provided for examples and tests.
+
+Production applications should provide durable stores scoped to the current
+principal. If one process hosts multiple Agent principals, create one Agent
+instance per principal or include the principal in every store lookup key.
+
+## Low-Level Primitives
+
+The package also exports low-level protocol primitives such as
+`inspectService()`, `enrollService()`, `statusService()`, `grantService()`,
+`revokeService()`, `discoverPlatform()`, `provisionPlatformIdentity()`, and
+`createPlatformDelegatedSigner()`.
+
+These functions still own their AEP HTTP behavior. They use the runtime
+`fetch()` implementation, validate responses, and return typed AEP results.
+
+`createJwtClientAssertionSigner()` is the built-in `jose` signer adapter for
+PEM, JWK, `CryptoKey`, `KeyObject`, and raw key material supported by `jose`.
+
+`credentialPresentationHeaders()` turns built-in credentials into HTTP headers
+for OAuth Bearer, API-key, and HTTP Basic presentation.
+
+`clientAssertionAuthenticationHeaders()` creates AEP JWT Authorization headers
+for protected Service resources, and `protectedResourceAuthenticationHeaders()`
+uses an issued built-in credential when one is available or falls back to AEP
+JWT authentication.