@eudiplo/sdk-core 4.4.0 → 4.5.0

package/README.md

@@ -12,227 +12,102 @@ pnpm add @eudiplo/sdk-core
 yarn add @eudiplo/sdk-core
 ```
 
-## Quick Start - The Simplest Way
-
-### One-liner for Age Verification
+## Quick Start
 
 ```typescript
-import { verifyAndWait } from '@eudiplo/sdk-core';
+import { EudiploClient } from '@eudiplo/sdk-core';
 
-const session = await verifyAndWait({
+const client = new EudiploClient({
   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)
-
-```typescript
-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',
+// Verification (QR flow)
+const verifyOffer = await client.createPresentationRequest({
   configId: 'age-over-18',
 });
+showQRCode(verifyOffer.uri);
+const verifiedSession = await client.waitForSession(verifyOffer.sessionId);
 
-// 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
-
-```typescript
-import { issue } from '@eudiplo/sdk-core';
-
-const { uri, waitForCompletion } = await issue({
-  baseUrl: 'https://eudiplo.example.com',
-  clientId: 'my-demo',
-  clientSecret: 'secret',
+// Issuance (QR flow)
+const issuanceOffer = await client.createIssuanceOffer({
   credentialConfigurationIds: ['PID'],
   claims: {
     PID: { given_name: 'John', family_name: 'Doe', birthdate: '1990-01-15' },
   },
 });
-
-showQRCode(uri);
-await waitForCompletion();
+showQRCode(issuanceOffer.uri);
+await client.waitForSession(issuanceOffer.sessionId);
 ```
 
 ## Full API
 
-### Factory Functions (Easiest)
+### Class API
 
-| 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                                                 |
+Use `EudiploClient` methods directly:
+
+| Method                        | Description                                    |
+| ----------------------------- | ---------------------------------------------- |
+| `createPresentationRequest()` | Create verification request URI and session ID |
+| `createIssuanceOffer()`       | Create issuance offer URI and session ID       |
+| `waitForSession()`            | Poll session until terminal state              |
+| `subscribeToSession()`        | Subscribe via SSE                              |
+| `verifyWithDcApi()`           | Browser-native DC API end-to-end flow          |
 
 ### Digital Credentials API (Browser Native)
 
 The SDK includes utilities for the [Digital Credentials API](https://wicg.github.io/digital-credentials/), enabling browser-native credential presentation without QR codes.
 
 ```typescript
-import { isDcApiAvailable, verifyWithDcApi } from '@eudiplo/sdk-core';
+import { isDcApiAvailable, EudiploClient } from '@eudiplo/sdk-core';
+
+const client = new EudiploClient({
+  baseUrl: 'https://eudiplo.example.com',
+  clientId: 'my-demo',
+  clientSecret: 'secret',
+});
 
 // Check if browser supports DC API
 if (isDcApiAvailable()) {
-  const result = await verifyWithDcApi({
-    baseUrl: 'https://eudiplo.example.com',
-    clientId: 'my-demo',
-    clientSecret: 'secret',
+  const result = await client.verifyWithDcApi({
     configId: 'age-over-18',
   });
 
-  console.log('Verified!', result.session.credentials);
+  console.log('Verified!', result.credentials);
 } else {
-  // Fall back to QR code flow
-  const session = await verifyAndWait({...});
+  // Fall back to QR code flow using EudiploClient methods
 }
 ```
 
-#### DC API Functions
+#### DC API Methods
 
-| Function               | Description                                         |
-| ---------------------- | --------------------------------------------------- |
-| `isDcApiAvailable()`   | Check if browser supports Digital Credentials API   |
-| `verifyWithDcApi()`    | Complete verification flow using browser-native API |
-| `createDcApiRequest()` | Create a `DigitalCredentialRequestOptions` object   |
+| Method                                       | Description                                         |
+| -------------------------------------------- | --------------------------------------------------- |
+| `isDcApiAvailable()`                         | Check if browser supports Digital Credentials API   |
+| `client.verifyWithDcApi()`                   | Complete verification flow using browser-native API |
+| `client.createDcApiPresentationRequest(...)` | Create DC API session with request object           |
 
 #### Lower-level DC API Usage
 
 ```typescript
-import { createDcApiRequest, EudiploClient } from '@eudiplo/sdk-core';
+import { EudiploClient } from '@eudiplo/sdk-core';
 
 const client = new EudiploClient({...});
 
-// Create presentation request
-const { uri, sessionId } = await client.createPresentationRequest({
+// Create DC API session with request object
+const session = await client.createDcApiPresentationRequest({
   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):**
-
-```typescript
-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):**
 
-```typescript
-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;
-}
+// Submit using the browser-native DC API end-to-end
+const result = await client.submitDcApiPresentation(session);
 ```
 
-**What stays where:**
+#### Secure Deployment Note
 
-| 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 |
+For production deployments, keep `clientId` and `clientSecret` on the server.
+Use `EudiploClient` methods to run the full flow (`createDcApiPresentationRequest` + `submitDcApiPresentation`) from trusted backend/application code.
 
 ### Class-based API (More Control)
 

package/dist/api/client/client.gen.d.mts

@@ -1,4 +1,4 @@
-import { b as Config, C as Client } from '../../types.gen-DKrNRB-E.mjs';
+import { b as Config, C as Client } from '../../types.gen-Cc6DtXw9.mjs';
 
 declare const createClient: (config?: Config) => Client;
 

package/dist/api/client/client.gen.d.ts

@@ -1,4 +1,4 @@
-import { b as Config, C as Client } from '../../types.gen-DKrNRB-E.js';
+import { b as Config, C as Client } from '../../types.gen-Cc6DtXw9.js';
 
 declare const createClient: (config?: Config) => Client;
 

package/dist/api/client/client.gen.js

@@ -41,10 +41,7 @@ function createSseClient({
         }
         const _fetch = options.fetch ?? globalThis.fetch;
         const response = await _fetch(request);
-        if (!response.ok)
-          throw new Error(
-            `SSE failed: ${response.status} ${response.statusText}`
-          );
+        if (!response.ok) throw new Error(`SSE failed: ${response.status} ${response.statusText}`);
         if (!response.body) throw new Error("No body in SSE response");
         const reader = response.body.pipeThrough(new TextDecoderStream()).getReader();
         let buffer = "";
@@ -75,10 +72,7 @@ function createSseClient({
                 } else if (line.startsWith("id:")) {
                   lastEventId = line.replace(/^id:\s*/, "");
                 } else if (line.startsWith("retry:")) {
-                  const parsed = Number.parseInt(
-                    line.replace(/^retry:\s*/, ""),
-                    10
-                  );
+                  const parsed = Number.parseInt(line.replace(/^retry:\s*/, ""), 10);
                   if (!Number.isNaN(parsed)) {
                     retryDelay = parsed;
                   }
@@ -124,10 +118,7 @@ function createSseClient({
         if (sseMaxRetryAttempts !== void 0 && attempt >= sseMaxRetryAttempts) {
           break;
         }
-        const backoff = Math.min(
-          retryDelay * 2 ** (attempt - 1),
-          sseMaxRetryDelay ?? 3e4
-        );
+        const backoff = Math.min(retryDelay * 2 ** (attempt - 1), sseMaxRetryDelay ?? 3e4);
         await sleep(backoff);
       }
     }
@@ -235,11 +226,7 @@ var serializeObjectParam = ({
   if (style !== "deepObject" && !explode) {
     let values = [];
     Object.entries(value).forEach(([key, v]) => {
-      values = [
-        ...values,
-        key,
-        allowReserved ? v : encodeURIComponent(v)
-      ];
+      values = [...values, key, allowReserved ? v : encodeURIComponent(v)];
     });
     const joinedValues2 = values.join(",");
     switch (style) {
@@ -290,10 +277,7 @@ var defaultPathSerializer = ({ path, url: _url }) => {
         continue;
       }
       if (Array.isArray(value)) {
-        url = url.replace(
-          match,
-          serializeArrayParam({ explode, name, style, value })
-        );
+        url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
         continue;
       }
       if (typeof value === "object") {
@@ -381,10 +365,7 @@ var getAuthToken = async (auth, callback) => {
 
 // src/api/core/bodySerializer.gen.ts
 var jsonBodySerializer = {
-  bodySerializer: (body) => JSON.stringify(
-    body,
-    (_key, value) => typeof value === "bigint" ? value.toString() : value
-  )
+  bodySerializer: (body) => JSON.stringify(body, (_key, value) => typeof value === "bigint" ? value.toString() : value)
 };
 
 // src/api/client/utils.gen.ts
@@ -449,9 +430,7 @@ var getParseAs = (contentType) => {
   if (cleanContent === "multipart/form-data") {
     return "formData";
   }
-  if (["application/", "audio/", "image/", "video/"].some(
-    (type) => cleanContent.startsWith(type)
-  )) {
+  if (["application/", "audio/", "image/", "video/"].some((type) => cleanContent.startsWith(type))) {
     return "blob";
   }
   if (cleanContent.startsWith("text/")) {
@@ -468,11 +447,8 @@ var checkForExistence = (options, name) => {
   }
   return false;
 };
-var setAuthParams = async ({
-  security,
-  ...options
-}) => {
-  for (const auth of security) {
+async function setAuthParams(options) {
+  for (const auth of options.security ?? []) {
     if (checkForExistence(options, auth.name)) {
       continue;
     }
@@ -497,7 +473,7 @@ var setAuthParams = async ({
         break;
     }
   }
-};
+}
 var buildUrl = (options) => getUrl({
   baseUrl: options.baseUrl,
   path: options.path,
@@ -623,10 +599,7 @@ var createClient = (config = {}) => {
       serializedBody: void 0
     };
     if (opts.security) {
-      await setAuthParams({
-        ...opts,
-        security: opts.security
-      });
+      await setAuthParams(opts);
     }
     if (opts.requestValidator) {
       await opts.requestValidator(opts);
@@ -739,12 +712,7 @@ var createClient = (config = {}) => {
       let finalError = error;
       for (const fn of interceptors.error.fns) {
         if (fn) {
-          finalError = await fn(
-            finalError,
-            response,
-            request2,
-            options
-          );
+          finalError = await fn(finalError, response, request2, options);
         }
       }
       finalError = finalError || {};

package/dist/api/client/client.gen.mjs

@@ -39,10 +39,7 @@ function createSseClient({
         }
         const _fetch = options.fetch ?? globalThis.fetch;
         const response = await _fetch(request);
-        if (!response.ok)
-          throw new Error(
-            `SSE failed: ${response.status} ${response.statusText}`
-          );
+        if (!response.ok) throw new Error(`SSE failed: ${response.status} ${response.statusText}`);
         if (!response.body) throw new Error("No body in SSE response");
         const reader = response.body.pipeThrough(new TextDecoderStream()).getReader();
         let buffer = "";
@@ -73,10 +70,7 @@ function createSseClient({
                 } else if (line.startsWith("id:")) {
                   lastEventId = line.replace(/^id:\s*/, "");
                 } else if (line.startsWith("retry:")) {
-                  const parsed = Number.parseInt(
-                    line.replace(/^retry:\s*/, ""),
-                    10
-                  );
+                  const parsed = Number.parseInt(line.replace(/^retry:\s*/, ""), 10);
                   if (!Number.isNaN(parsed)) {
                     retryDelay = parsed;
                   }
@@ -122,10 +116,7 @@ function createSseClient({
         if (sseMaxRetryAttempts !== void 0 && attempt >= sseMaxRetryAttempts) {
           break;
         }
-        const backoff = Math.min(
-          retryDelay * 2 ** (attempt - 1),
-          sseMaxRetryDelay ?? 3e4
-        );
+        const backoff = Math.min(retryDelay * 2 ** (attempt - 1), sseMaxRetryDelay ?? 3e4);
         await sleep(backoff);
       }
     }
@@ -233,11 +224,7 @@ var serializeObjectParam = ({
   if (style !== "deepObject" && !explode) {
     let values = [];
     Object.entries(value).forEach(([key, v]) => {
-      values = [
-        ...values,
-        key,
-        allowReserved ? v : encodeURIComponent(v)
-      ];
+      values = [...values, key, allowReserved ? v : encodeURIComponent(v)];
     });
     const joinedValues2 = values.join(",");
     switch (style) {
@@ -288,10 +275,7 @@ var defaultPathSerializer = ({ path, url: _url }) => {
         continue;
       }
       if (Array.isArray(value)) {
-        url = url.replace(
-          match,
-          serializeArrayParam({ explode, name, style, value })
-        );
+        url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
         continue;
       }
       if (typeof value === "object") {
@@ -379,10 +363,7 @@ var getAuthToken = async (auth, callback) => {
 
 // src/api/core/bodySerializer.gen.ts
 var jsonBodySerializer = {
-  bodySerializer: (body) => JSON.stringify(
-    body,
-    (_key, value) => typeof value === "bigint" ? value.toString() : value
-  )
+  bodySerializer: (body) => JSON.stringify(body, (_key, value) => typeof value === "bigint" ? value.toString() : value)
 };
 
 // src/api/client/utils.gen.ts
@@ -447,9 +428,7 @@ var getParseAs = (contentType) => {
   if (cleanContent === "multipart/form-data") {
     return "formData";
   }
-  if (["application/", "audio/", "image/", "video/"].some(
-    (type) => cleanContent.startsWith(type)
-  )) {
+  if (["application/", "audio/", "image/", "video/"].some((type) => cleanContent.startsWith(type))) {
     return "blob";
   }
   if (cleanContent.startsWith("text/")) {
@@ -466,11 +445,8 @@ var checkForExistence = (options, name) => {
   }
   return false;
 };
-var setAuthParams = async ({
-  security,
-  ...options
-}) => {
-  for (const auth of security) {
+async function setAuthParams(options) {
+  for (const auth of options.security ?? []) {
     if (checkForExistence(options, auth.name)) {
       continue;
     }
@@ -495,7 +471,7 @@ var setAuthParams = async ({
         break;
     }
   }
-};
+}
 var buildUrl = (options) => getUrl({
   baseUrl: options.baseUrl,
   path: options.path,
@@ -621,10 +597,7 @@ var createClient = (config = {}) => {
       serializedBody: void 0
     };
     if (opts.security) {
-      await setAuthParams({
-        ...opts,
-        security: opts.security
-      });
+      await setAuthParams(opts);
     }
     if (opts.requestValidator) {
       await opts.requestValidator(opts);
@@ -737,12 +710,7 @@ var createClient = (config = {}) => {
       let finalError = error;
       for (const fn of interceptors.error.fns) {
         if (fn) {
-          finalError = await fn(
-            finalError,
-            response,
-            request2,
-            options
-          );
+          finalError = await fn(finalError, response, request2, options);
         }
       }
       finalError = finalError || {};

package/dist/api/client/index.d.mts

@@ -1,9 +1,9 @@
-export { A as Auth, C as Client, a as ClientOptions, b as Config, c as CreateClientConfig, O as Options, Q as QuerySerializerOptions, R as RequestOptions, d as RequestResult, e as ResolvedRequestOptions, f as ResponseStyle, T as TDataShape, g as createConfig, h as formDataBodySerializer, j as jsonBodySerializer, m as mergeHeaders, u as urlSearchParamsBodySerializer } from '../../types.gen-DKrNRB-E.mjs';
+export { A as Auth, C as Client, a as ClientOptions, b as Config, c as CreateClientConfig, O as Options, Q as QuerySerializerOptions, R as RequestOptions, d as RequestResult, e as ResolvedRequestOptions, f as ResponseStyle, T as TDataShape, g as createConfig, h as formDataBodySerializer, j as jsonBodySerializer, m as mergeHeaders, u as urlSearchParamsBodySerializer } from '../../types.gen-Cc6DtXw9.mjs';
 export { createClient } from './client.gen.mjs';
 
-type Slot = "body" | "headers" | "path" | "query";
+type Slot = 'body' | 'headers' | 'path' | 'query';
 type Field = {
-    in: Exclude<Slot, "body">;
+    in: Exclude<Slot, 'body'>;
     /**
      * Field name. This is the name we want the user to see and use.
      */
@@ -14,7 +14,7 @@ type Field = {
      */
     map?: string;
 } | {
-    in: Extract<Slot, "body">;
+    in: Extract<Slot, 'body'>;
     /**
      * Key isn't required for bodies.
      */

package/dist/api/client/index.d.ts

@@ -1,9 +1,9 @@
-export { A as Auth, C as Client, a as ClientOptions, b as Config, c as CreateClientConfig, O as Options, Q as QuerySerializerOptions, R as RequestOptions, d as RequestResult, e as ResolvedRequestOptions, f as ResponseStyle, T as TDataShape, g as createConfig, h as formDataBodySerializer, j as jsonBodySerializer, m as mergeHeaders, u as urlSearchParamsBodySerializer } from '../../types.gen-DKrNRB-E.js';
+export { A as Auth, C as Client, a as ClientOptions, b as Config, c as CreateClientConfig, O as Options, Q as QuerySerializerOptions, R as RequestOptions, d as RequestResult, e as ResolvedRequestOptions, f as ResponseStyle, T as TDataShape, g as createConfig, h as formDataBodySerializer, j as jsonBodySerializer, m as mergeHeaders, u as urlSearchParamsBodySerializer } from '../../types.gen-Cc6DtXw9.js';
 export { createClient } from './client.gen.js';
 
-type Slot = "body" | "headers" | "path" | "query";
+type Slot = 'body' | 'headers' | 'path' | 'query';
 type Field = {
-    in: Exclude<Slot, "body">;
+    in: Exclude<Slot, 'body'>;
     /**
      * Field name. This is the name we want the user to see and use.
      */
@@ -14,7 +14,7 @@ type Field = {
      */
     map?: string;
 } | {
-    in: Extract<Slot, "body">;
+    in: Extract<Slot, 'body'>;
     /**
      * Key isn't required for bodies.
      */