@eudiplo/sdk-core
v3.0.0
Published
Framework-agnostic EUDIPLO SDK for demos and integrations
Maintainers
Readme
@eudiplo/sdk-core
Framework-agnostic EUDIPLO SDK for demos and integrations. Works with Node.js, browsers, React, Vue, vanilla JS, and any other JavaScript environment.
Installation
npm install @eudiplo/sdk-core
# or
pnpm add @eudiplo/sdk-core
# or
yarn add @eudiplo/sdk-coreQuick Start - The Simplest Way
One-liner for Age Verification
import { verifyAndWait } from '@eudiplo/sdk-core';
const session = await verifyAndWait({
baseUrl: 'https://eudiplo.example.com',
clientId: 'my-demo',
clientSecret: 'secret',
configId: 'age-over-18',
onUri: (uri) => showQRCode(uri), // Your QR code display function
onUpdate: (s) => console.log('Status:', s.status),
});
console.log('Verified!', session.credentials);Two-step Flow (More Control)
import { verify } from '@eudiplo/sdk-core';
// Step 1: Create the request
const { uri, sessionId, waitForCompletion } = await verify({
baseUrl: 'https://eudiplo.example.com',
clientId: 'my-demo',
clientSecret: 'secret',
configId: 'age-over-18',
});
// Step 2: Show QR code
showQRCode(uri);
// Step 3: Wait for user to scan and respond
const session = await waitForCompletion();
console.log('Verified credentials:', session.credentials);Credential Issuance
import { issue } from '@eudiplo/sdk-core';
const { uri, waitForCompletion } = await issue({
baseUrl: 'https://eudiplo.example.com',
clientId: 'my-demo',
clientSecret: 'secret',
credentialConfigurationIds: ['PID'],
claims: {
PID: { given_name: 'John', family_name: 'Doe', birthdate: '1990-01-15' },
},
});
showQRCode(uri);
await waitForCompletion();Full API
Factory Functions (Easiest)
| Function | Description |
| ------------------------ | ----------------------------------------------------------------------------------------- |
| verify(options) | Create a presentation request, returns { uri, sessionId, waitForCompletion, getStatus } |
| issue(options) | Create an issuance offer, returns { uri, sessionId, waitForCompletion, getStatus } |
| verifyAndWait(options) | One-liner: create request + wait for result |
| issueAndWait(options) | One-liner: create offer + wait for result |
Digital Credentials API (Browser Native)
The SDK includes utilities for the Digital Credentials API, enabling browser-native credential presentation without QR codes.
import { isDcApiAvailable, verifyWithDcApi } from '@eudiplo/sdk-core';
// Check if browser supports DC API
if (isDcApiAvailable()) {
const result = await verifyWithDcApi({
baseUrl: 'https://eudiplo.example.com',
clientId: 'my-demo',
clientSecret: 'secret',
configId: 'age-over-18',
});
console.log('Verified!', result.session.credentials);
} else {
// Fall back to QR code flow
const session = await verifyAndWait({...});
}DC API Functions
| Function | Description |
| ---------------------- | --------------------------------------------------- |
| isDcApiAvailable() | Check if browser supports Digital Credentials API |
| verifyWithDcApi() | Complete verification flow using browser-native API |
| createDcApiRequest() | Create a DigitalCredentialRequestOptions object |
Lower-level DC API Usage
import { createDcApiRequest, EudiploClient } from '@eudiplo/sdk-core';
const client = new EudiploClient({...});
// Create presentation request
const { uri, sessionId } = await client.createPresentationRequest({
configId: 'age-over-18',
responseType: 'dc-api',
});
// Create the browser request object
const request = createDcApiRequest(uri);
// Call the browser API directly
const credential = await navigator.credentials.get(request);
// Submit the response and get verified session
const session = await client.submitDcApiResponse(sessionId, credential);Secure Server/Client Deployment (Recommended for Production)
When deploying to production, you should never expose your client credentials to the browser. The SDK provides helper functions to split the DC API flow between your server (where credentials are safe) and the browser (where the DC API runs).
Server-side Functions:
| Function | Description |
| -------------------------------- | ------------------------------------------------------ |
| createDcApiRequestForBrowser() | Create request on server, return safe data for browser |
| submitDcApiWalletResponse() | Submit wallet response to EUDIPLO from server |
Browser-side Functions:
| Function | Description |
| ------------- | ------------------------------------------------------ |
| callDcApi() | Call the native DC API with a request from your server |
Example: Express.js Backend + Browser Frontend
Server (Express.js / Next.js API route):
import {
createDcApiRequestForBrowser,
submitDcApiWalletResponse,
} from '@eudiplo/sdk-core';
// POST /api/start-verification
app.post('/api/start-verification', async (req, res) => {
const requestData = await createDcApiRequestForBrowser({
baseUrl: process.env.EUDIPLO_URL,
clientId: process.env.EUDIPLO_CLIENT_ID, // ✅ Safe on server
clientSecret: process.env.EUDIPLO_SECRET, // ✅ Safe on server
configId: 'age-over-18',
});
// Only safe data is sent to browser (no secrets)
res.json(requestData);
});
// POST /api/complete-verification
app.post('/api/complete-verification', async (req, res) => {
const { responseUri, walletResponse } = req.body;
const result = await submitDcApiWalletResponse({
responseUri,
walletResponse,
sendResponse: true, // Get verified claims back
});
// result.credentials contains the verified data
res.json(result);
});Browser (React / vanilla JS):
import { callDcApi, isDcApiAvailable } from '@eudiplo/sdk-core';
async function verifyAge() {
// 1. Get the request from your server (credentials stay on server)
const requestData = await fetch('/api/start-verification', {
method: 'POST',
}).then((r) => r.json());
// 2. Check DC API support and call it locally
if (!isDcApiAvailable()) {
throw new Error('Digital Credentials API not supported');
}
const walletResponse = await callDcApi(requestData.requestObject);
// 3. Send the wallet response back to your server for verification
const result = await fetch('/api/complete-verification', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
responseUri: requestData.responseUri,
walletResponse,
}),
}).then((r) => r.json());
console.log('Verified!', result.credentials);
return result;
}What stays where:
| Data | Location | Safe to expose? |
| ------------------------------ | ---------------- | ------------------- |
| clientId / clientSecret | Server only | ❌ Never expose |
| requestObject (signed JWT) | Server → Browser | ✅ Yes |
| responseUri | Server → Browser | ✅ Yes |
| Wallet response (encrypted VP) | Browser → Server | ✅ Yes |
| Verified credentials | Server only | Depends on use case |
Class-based API (More Control)
import { EudiploClient } from '@eudiplo/sdk-core';
const client = new EudiploClient({
baseUrl: 'https://eudiplo.example.com',
clientId: 'my-demo-client',
clientSecret: 'your-secret',
});
// Create a presentation request (e.g., for age verification)
const { uri, sessionId } = await client.createPresentationRequest({
configId: 'age-over-18',
});
console.log('Show this QR code:', uri);
// Wait for the user to scan and respond
const session = await client.waitForSession(sessionId, {
onUpdate: (s) => console.log('Status:', s.status),
});
console.log('Verified credentials:', session.credentials);API
new EudiploClient(config)
Create a new client instance.
const client = new EudiploClient({
baseUrl: 'https://eudiplo.example.com', // EUDIPLO server URL
clientId: 'my-client', // OAuth2 client ID
clientSecret: 'secret', // OAuth2 client secret
autoRefresh: true, // Auto-refresh tokens (default: true)
});createPresentationRequest(options)
Create a presentation request for credential verification.
const { uri, sessionId } = await client.createPresentationRequest({
configId: 'age-over-18', // Presentation config ID
responseType: 'uri', // 'uri' | 'qrcode' | 'dc-api'
redirectUri: 'https://...', // Optional redirect after completion
});createIssuanceOffer(options)
Create a credential issuance offer.
const { uri, sessionId } = await client.createIssuanceOffer({
credentialConfigurationIds: ['PID', 'mDL'],
claims: {
PID: { given_name: 'John', family_name: 'Doe' },
mDL: { driving_privileges: [...] }
},
flow: 'pre_authorized_code', // or 'authorization_code'
txCode: '1234' // Optional transaction code
});getSession(sessionId)
Get the current state of a session.
const session = await client.getSession(sessionId);
console.log(session.status); // 'active' | 'fetched' | 'completed' | 'expired' | 'failed'waitForSession(sessionId, options)
Poll until a session completes or fails.
const session = await client.waitForSession(sessionId, {
interval: 1000, // Poll every 1 second
timeout: 60000, // Timeout after 60 seconds
signal: abortController.signal, // Optional abort signal
onUpdate: (session) => {
console.log('Status:', session.status);
},
});subscribeToSession(sessionId, options)
Subscribe to real-time session status updates via Server-Sent Events (SSE). This is more efficient than polling and provides instant updates.
const subscription = await client.subscribeToSession(sessionId, {
onStatusChange: (event) => {
console.log(`Status: ${event.status}`);
if (['completed', 'expired', 'failed'].includes(event.status)) {
subscription.close();
}
},
onError: (error) => console.error('SSE error:', error),
onOpen: () => console.log('Connected'),
});
// Later, to close the connection:
subscription.close();waitForSessionWithSse(sessionId, options)
Wait for session completion using SSE instead of polling. Returns a Promise that resolves when the session completes.
try {
const finalStatus = await client.waitForSessionWithSse(sessionId, {
onStatusChange: (event) => console.log('Status:', event.status),
});
console.log('Session completed:', finalStatus);
} catch (error) {
console.error('Session failed:', error);
}Examples
Age Verification in a Web Shop
import { EudiploClient } from '@eudiplo/sdk-core';
const client = new EudiploClient({
baseUrl: process.env.EUDIPLO_URL,
clientId: process.env.EUDIPLO_CLIENT_ID,
clientSecret: process.env.EUDIPLO_CLIENT_SECRET,
});
// Express.js route handler
app.post('/api/verify-age', async (req, res) => {
const { uri, sessionId } = await client.createPresentationRequest({
configId: 'age-over-18',
redirectUri: `${req.headers.origin}/checkout`,
});
res.json({ qrCodeUri: uri, sessionId });
});
app.get('/api/verify-age/:sessionId', async (req, res) => {
const session = await client.getSession(req.params.sessionId);
res.json({
status: session.status,
verified: session.status === 'completed',
});
});React Hook Example
import { useState, useEffect } from 'react';
import { EudiploClient } from '@eudiplo/sdk-core';
const client = new EudiploClient({...});
function useAgeVerification(configId: string) {
const [uri, setUri] = useState<string>();
const [status, setStatus] = useState<string>('idle');
const [verified, setVerified] = useState(false);
const startVerification = async () => {
setStatus('pending');
const { uri, sessionId } = await client.createPresentationRequest({ configId });
setUri(uri);
try {
const session = await client.waitForSession(sessionId, {
onUpdate: (s) => setStatus(s.status)
});
setVerified(true);
setStatus('completed');
} catch (e) {
setStatus('failed');
}
};
return { uri, status, verified, startVerification };
}Advanced: Direct API Access
For advanced use cases, you can access the generated API functions directly:
import {
client,
sessionControllerGetAllSessions,
credentialConfigControllerGetConfigs,
} from '@eudiplo/sdk-core/api';
// Configure the client
client.setConfig({
baseUrl: 'https://eudiplo.example.com',
headers: { Authorization: 'Bearer your-token' },
});
// Use any API endpoint
const configs = await credentialConfigControllerGetConfigs({});Requirements
- Node.js 20+ (uses native
fetch) - For older environments, use a
fetchpolyfill
License
Apache-2.0
