feature: added toolbox and consolidated logic

Author: tcouper

package-lock.json

@@ -32,13 +32,13 @@
     "@aws-sdk/lib-dynamodb": "^3.1004.0",
     "@grpc/grpc-js": "^1.14.3",
     "@grpc/proto-loader": "^0.8.0",
-    "@veramo/core": "^7.0.0",
-    "@veramo/credential-w3c": "^7.0.0",
-    "@veramo/did-manager": "^7.0.0",
-    "@veramo/did-provider-key": "^7.0.0",
-    "@veramo/did-resolver": "^7.0.0",
-    "@veramo/key-manager": "^7.0.0",
-    "@veramo/kms-local": "^7.0.0",
+    "@veramo/core": "^6.0.0",
+    "@veramo/credential-w3c": "^6.0.0",
+    "@veramo/did-manager": "^6.0.0",
+    "@veramo/did-provider-key": "^6.0.0",
+    "@veramo/did-resolver": "^6.0.0",
+    "@veramo/key-manager": "^6.0.0",
+    "@veramo/kms-local": "^6.0.0",
     "ajv-draft-04": "^1.0.0",
     "ajv-formats": "^3.0.1",
     "aws-cdk-lib": "^2.241.0",

package.json

@@ -8,18 +8,18 @@ import {
   QueryCommand
 } from "@aws-sdk/lib-dynamodb";
 import {
-  createPresentationFromSelection,
-  verifyPresentation,
+  createToolbox,
   type PresentationMetadata,
   type SelectedClaim,
   type SelectedCredential
-} from "../../../packages/veramo-wrapper/src/index.js";
+} from "../../../toolbox/src/index.js";
 
 const ddbDocClient = DynamoDBDocumentClient.from(new DynamoDBClient({}));
 const EVENT_TABLE = process.env.EVENT_TABLE_NAME ?? "";
 const CREDENTIAL_TABLE = process.env.CREDENTIAL_TABLE_NAME ?? "";
 const GRAPH_PROJECTION_TABLE = process.env.GRAPH_PROJECTION_TABLE_NAME ?? "";
 const TRUSTED_ISSUERS = (process.env.TRUSTED_ISSUERS ?? "").split(",").map((issuer) => issuer.trim()).filter(Boolean);
+let toolboxPromise: Promise<Awaited<ReturnType<typeof createToolbox>>> | undefined;
 
 interface HttpEvent {
   rawPath?: string;
@@ -398,7 +398,8 @@ async function handleCreatePresentation(event: HttpEvent) {
     expirationDate: request.expirationDate
   };
 
-  const vp = createPresentationFromSelection(policyOutcome.allowedCredentials, metadata);
+  const toolbox = await getToolbox();
+  const vp = toolbox.presentation.createFromSelection(policyOutcome.allowedCredentials, metadata);
 
   return json(200, {
     status: "created",
@@ -421,7 +422,8 @@ async function handleVerifyPresentation(event: HttpEvent) {
     });
   }
 
-  const result = verifyPresentation(request.vp, TRUSTED_ISSUERS);
+  const toolbox = await getToolbox();
+  const result = toolbox.presentation.verify(request.vp, TRUSTED_ISSUERS);
   const approvedContent = result.approvedContent.map((credential) => ({
     sessionId: `verified_${credential.credentialId}`,
     credentialId: credential.credentialId,
@@ -781,3 +783,13 @@ function json(statusCode: number, payload: Record<string, unknown>) {
     body: JSON.stringify(payload)
   };
 }
+
+async function getToolbox(): Promise<Awaited<ReturnType<typeof createToolbox>>> {
+  if (!toolboxPromise) {
+    toolboxPromise = createToolbox({
+      did: { method: "did:key" },
+      validation: { strict: true }
+    });
+  }
+  return toolboxPromise;
+}

services/learner-context-handler/src/index.ts

@@ -3,8 +3,8 @@ import { createHash } from "node:crypto";
 import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 import { DynamoDBDocumentClient, PutCommand, UpdateCommand } from "@aws-sdk/lib-dynamodb";
 import type { SQSEvent } from "aws-lambda";
-import { createToolbox } from "../../../toolbox/index.js";
-import type { CaliperEvent } from "../../../toolbox/index.js";
+import { createToolbox } from "../../../toolbox/src/index.js";
+import type { CaliperEvent } from "../../../toolbox/src/index.js";
 import {
   buildCredentialItem,
   buildEventItems,
@@ -311,7 +311,6 @@ async function buildProjectedCredentialPayload(input: {
     graphDigest: sourceEventHashes.join(",")
   });
   const signed = await toolbox.caliper.sign(unsigned);
-
   if (signed.verifiableCredential && typeof signed.verifiableCredential === "object") {
     return signed.verifiableCredential;
   }

services/persist-handler/src/index.ts

@@ -0,0 +1,115 @@
+# Credential Toolbox SDK
+
+TypeScript SDK for creating, signing, verifying, and transporting digital credentials across:
+
+- W3C Verifiable Credentials
+- Open Badges 3
+- Comprehensive Learner Record 2
+- Caliper Credential (Caliper v1.2 event-set VC)
+- DID methods (`did:key`, locally configured `did:web`)
+
+## Install
+
+```bash
+npm install
+```
+
+## Build And Validate
+
+```bash
+npm run build
+npm run typecheck
+npm run lint
+npm run test
+```
+
+## Example Commands
+
+```bash
+npm run example:export-validator -- --type=ob3 --format=jwt
+npm run example:export-validator:clr2
+npm run example:export-validator:caliper
+npm run example:caliper-rich
+```
+
+## Verify A Credential File
+
+Use the Veramo-backed helper to verify credential files produced by this project (JWT text, SDK `SignedCredential` JSON, or validator-style VC JSON):
+
+```ts
+import { verifyCredentialFile } from "@credential-toolbox/sdk";
+
+const result = await verifyCredentialFile({
+  credentialPath: "examples/export-validator/output/caliper.jwt.txt"
+});
+
+console.log(result.format); // jwt | signed | verifiableCredential
+console.log(result.verification.valid);
+```
+
+Or via npm script:
+
+```bash
+npm run verify:credential -- --file=examples/export-validator/output/caliper.jwt.txt
+```
+
+## Architecture Contract
+
+This repository is a **single library** that uses DDD + Clean Architecture with explicit layers:
+
+```text
+src/
+  domain/
+  application/
+  infrastructure/
+  interface/
+```
+
+### Layer Responsibilities
+
+- `src/domain`: core types, entities/value objects, service interfaces, no framework dependencies
+- `src/application`: use-case orchestration and bounded-context services (`ob3`, `clr2`, transport)
+- `src/infrastructure`: external adapters (Veramo, DID/crypto integration)
+- `src/interface`: public SDK composition and entrypoints (`createToolbox`)
+
+### Dependency Rules (Must Keep)
+
+- Domain must not import infrastructure or Veramo
+- Application depends on domain contracts only
+- Infrastructure implements domain/application interfaces
+- Interface composes services and exposes stable API
+
+## Veramo Boundary
+
+Veramo must remain isolated in:
+
+- `src/infrastructure/veramo`
+
+Do not import Veramo types or plugins into `domain`, `application`, or `interface`.
+
+## Public API
+
+```ts
+import { createToolbox } from "@credential-toolbox/sdk";
+
+const toolbox = await createToolbox({
+  did: {
+    method: "did:web",
+    defaultDomain: "example.org",
+    webPath: "issuers/main"
+  }
+});
+
+const issuer = await toolbox.did.create({ method: "web" });
+```
+
+## Contributor Guidance
+
+When adding features:
+
+1. Start with domain contracts
+2. Implement orchestration in application services
+3. Add or extend infrastructure adapters
+4. Wire through interface layer only
+
+If a change breaks these boundaries, redesign the change instead of bypassing the architecture.

toolbox/README.md

@@ -0,0 +1 @@
+tim.couper+badgedesign@gmail.com