@openeudi/core 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 OpenEUDI Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,198 @@
+# @openeudi/core
+
+Framework-agnostic EUDI Wallet verification protocol engine.
+
+```bash
+npm install @openeudi/core
+```
+
+## Quick Start
+
+```ts
+import { VerificationService, DemoMode, VerificationType } from "@openeudi/core";
+
+const service = new VerificationService({ mode: new DemoMode() });
+
+service.on("session:verified", (session, result) => {
+  console.log(`Verified: ${result.country}, age: ${result.ageVerified}`);
+});
+
+const session = await service.createSession({ type: VerificationType.BOTH });
+console.log(session.walletUrl); // openid4vp://verify?session=<uuid>
+```
+
+## Modes
+
+### DemoMode
+
+Auto-completes sessions with randomized EU citizen data after a configurable delay. Ideal for product demos and landing pages.
+
+```ts
+import { DemoMode } from "@openeudi/core";
+
+const mode = new DemoMode({
+  delayMs: 2000, // auto-complete after 2s (default: 3000)
+});
+```
+
+### MockMode
+
+Returns deterministic results for integration testing. Supports global defaults and per-session overrides.
+
+```ts
+import { MockMode } from "@openeudi/core";
+
+const mode = new MockMode({
+  defaultResult: { verified: true, country: "FR", ageVerified: true },
+  delayMs: 100,
+});
+
+const service = new VerificationService({ mode });
+const session = await service.createSession({ type: VerificationType.AGE });
+
+// Override result for a specific session
+mode.setSessionResult(session.id, {
+  verified: false,
+  rejectionReason: "underage",
+});
+
+// Clean up override
+mode.clearSessionResult(session.id);
+```
+
+## Custom Mode
+
+Implement `IVerificationMode` to connect to a real EUDI Wallet relying party:
+
+```ts
+import type { IVerificationMode, VerificationSession, VerificationResult } from "@openeudi/core";
+
+class ProductionMode implements IVerificationMode {
+  readonly name = "production";
+
+  async processCallback(session: VerificationSession, walletResponse: unknown): Promise<VerificationResult> {
+    const claims = await verifyVPToken(walletResponse); // your OpenID4VP logic
+    return { verified: true, country: claims.country, ageVerified: claims.age >= 18 };
+  }
+}
+```
+
+## Custom Storage
+
+The default `InMemorySessionStore` works for single-process deployments. Implement `ISessionStore` for Redis, PostgreSQL, etc:
+
+```ts
+import type { ISessionStore, VerificationSession } from "@openeudi/core";
+
+class RedisSessionStore implements ISessionStore {
+  constructor(private redis: Redis) {}
+
+  async get(id: string): Promise<VerificationSession | null> {
+    const data = await this.redis.get(`session:${id}`);
+    return data ? JSON.parse(data) : null;
+  }
+  async set(session: VerificationSession): Promise<void> {
+    const ttl = Math.max(0, session.expiresAt.getTime() - Date.now());
+    await this.redis.set(`session:${session.id}`, JSON.stringify(session), "PX", ttl);
+  }
+  async delete(id: string): Promise<void> {
+    await this.redis.del(`session:${id}`);
+  }
+}
+
+const service = new VerificationService({
+  mode: new DemoMode(),
+  store: new RedisSessionStore(new Redis()),
+});
+```
+
+## Events
+
+`VerificationService` extends `EventEmitter`. Subscribe to lifecycle events:
+
+| Event              | Handler Signature                                                    | Description                    |
+| ------------------ | -------------------------------------------------------------------- | ------------------------------ |
+| `session:created`  | `(session: VerificationSession) => void`                             | Session created, QR code ready |
+| `session:verified` | `(session: VerificationSession, result: VerificationResult) => void` | Verification passed            |
+| `session:rejected` | `(session: VerificationSession, reason?: string) => void`            | Verification rejected          |
+| `session:expired`  | `(session: VerificationSession) => void`                             | Session TTL exceeded           |
+
+```ts
+service.on("session:created", (session) => sendSSE(session.id, { walletUrl: session.walletUrl }));
+service.on("session:verified", (session, result) =>
+  sendSSE(session.id, { status: "verified", country: result.country })
+);
+service.on("session:rejected", (session, reason) => sendSSE(session.id, { status: "rejected", reason }));
+service.on("session:expired", (session) => sendSSE(session.id, { status: "expired" }));
+```
+
+## QR Code
+
+Optional helper to generate QR code data URIs. Requires the `qrcode` peer dependency:
+
+```bash
+npm install qrcode
+```
+
+```ts
+import { generateQRCode } from "@openeudi/core/qr";
+
+const session = await service.createSession({ type: VerificationType.AGE });
+const dataUri = await generateQRCode(session.walletUrl);
+// => "data:image/png;base64,..."
+```
+
+## API Reference
+
+### `VerificationService`
+
+| Method                                      | Returns                        | Description                                                                    |
+| ------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------ |
+| `constructor(config)`                       | `VerificationService`          | Create service with mode, optional store and TTL                               |
+| `createSession(input)`                      | `Promise<VerificationSession>` | Create a new verification session                                              |
+| `getSession(id)`                            | `Promise<VerificationSession>` | Retrieve session by ID (throws `SessionNotFoundError`)                         |
+| `handleCallback(sessionId, walletResponse)` | `Promise<VerificationResult>`  | Process wallet callback (throws `SessionNotFoundError`, `SessionExpiredError`) |
+| `cleanupExpired()`                          | `Promise<number>`              | Remove expired sessions, returns count cleaned                                 |
+
+### Configuration
+
+```ts
+interface VerificationServiceConfig {
+  mode: IVerificationMode; // Required — DemoMode, MockMode, or custom
+  store?: ISessionStore; // Default: InMemorySessionStore
+  sessionTtlMs?: number; // Default: 300_000 (5 minutes)
+  walletBaseUrl?: string; // Default: 'openid4vp://verify'
+}
+```
+
+## Types
+
+All types are exported from the main entry point:
+
+```ts
+import type {
+  VerificationSession, // Full session object
+  VerificationResult, // Outcome of a verification
+  CreateSessionInput, // Input for createSession()
+  VerificationServiceConfig, // Constructor config
+  IVerificationMode, // Strategy interface for modes
+  ISessionStore, // Storage adapter interface
+  DemoModeConfig, // DemoMode constructor options
+  MockModeConfig, // MockMode constructor options
+} from "@openeudi/core";
+
+import {
+  VerificationType, // AGE | COUNTRY | BOTH
+  VerificationStatus, // PENDING | SCANNED | VERIFIED | REJECTED | EXPIRED
+  SessionNotFoundError, // Thrown by getSession / handleCallback
+  SessionExpiredError, // Thrown by handleCallback
+} from "@openeudi/core";
+```
+
+## License
+
+[Apache 2.0](./LICENSE)
+
+## Related
+
+[eIDAS Pro](https://eidas-pro.eu) -- managed verification service with WooCommerce/Shopify plugins, admin dashboard, and compliance tools built on `@openeudi/core`.

package/dist/index.cjs

@@ -0,0 +1,278 @@
+'use strict';
+
+var events = require('events');
+var uuid = require('uuid');
+
+// src/types/verification.ts
+var VerificationType = /* @__PURE__ */ ((VerificationType2) => {
+  VerificationType2["AGE"] = "AGE";
+  VerificationType2["COUNTRY"] = "COUNTRY";
+  VerificationType2["BOTH"] = "BOTH";
+  return VerificationType2;
+})(VerificationType || {});
+var VerificationStatus = /* @__PURE__ */ ((VerificationStatus2) => {
+  VerificationStatus2["PENDING"] = "PENDING";
+  VerificationStatus2["SCANNED"] = "SCANNED";
+  VerificationStatus2["VERIFIED"] = "VERIFIED";
+  VerificationStatus2["REJECTED"] = "REJECTED";
+  VerificationStatus2["EXPIRED"] = "EXPIRED";
+  return VerificationStatus2;
+})(VerificationStatus || {});
+
+// src/errors.ts
+var SessionNotFoundError = class extends Error {
+  constructor(sessionId) {
+    super(`Session not found: ${sessionId}`);
+    this.name = "SessionNotFoundError";
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+};
+var SessionExpiredError = class extends Error {
+  constructor(sessionId) {
+    super(`Session expired: ${sessionId}`);
+    this.name = "SessionExpiredError";
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+};
+
+// src/storage/memory.store.ts
+var InMemorySessionStore = class {
+  sessions = /* @__PURE__ */ new Map();
+  async get(id) {
+    return this.sessions.get(id) ?? null;
+  }
+  async set(session) {
+    this.sessions.set(session.id, session);
+  }
+  async delete(id) {
+    this.sessions.delete(id);
+  }
+};
+
+// src/modes/demo.mode.ts
+var EU_COUNTRIES = [
+  "AT",
+  "BE",
+  "BG",
+  "HR",
+  "CY",
+  "CZ",
+  "DK",
+  "EE",
+  "FI",
+  "FR",
+  "DE",
+  "GR",
+  "HU",
+  "IE",
+  "IT",
+  "LV",
+  "LT",
+  "LU",
+  "MT",
+  "NL",
+  "PL",
+  "PT",
+  "RO",
+  "SK",
+  "SI",
+  "ES",
+  "SE"
+];
+var DemoMode = class {
+  name = "demo";
+  delayMs;
+  constructor(config = {}) {
+    this.delayMs = config.delayMs ?? 3e3;
+  }
+  async processCallback(session, _walletResponse) {
+    const country = this.pickCountry(session.countryWhitelist);
+    return this.buildResult(session.type, country);
+  }
+  async simulateCompletion(session) {
+    await new Promise((resolve) => setTimeout(resolve, this.delayMs));
+    return this.processCallback(session, {});
+  }
+  pickCountry(whitelist) {
+    const pool = whitelist && whitelist.length > 0 ? whitelist : EU_COUNTRIES;
+    return pool[Math.floor(Math.random() * pool.length)];
+  }
+  buildResult(type, country) {
+    const includeAge = type === "AGE" /* AGE */ || type === "BOTH" /* BOTH */;
+    const includeCountry = type === "COUNTRY" /* COUNTRY */ || type === "BOTH" /* BOTH */;
+    return {
+      verified: true,
+      country,
+      ageVerified: includeAge ? true : void 0,
+      countryVerified: includeCountry ? true : void 0
+    };
+  }
+};
+
+// src/modes/mock.mode.ts
+var DEFAULT_RESULT = {
+  verified: true,
+  country: "DE",
+  ageVerified: true,
+  countryVerified: true
+};
+var MockMode = class {
+  name = "mock";
+  defaultResult;
+  delayMs;
+  sessionOverrides = /* @__PURE__ */ new Map();
+  constructor(config = {}) {
+    this.defaultResult = config.defaultResult ?? { ...DEFAULT_RESULT };
+    this.delayMs = config.delayMs ?? 0;
+  }
+  /** Set a per-session result override */
+  setSessionResult(sessionId, result) {
+    this.sessionOverrides.set(sessionId, result);
+  }
+  /** Clear a per-session result override */
+  clearSessionResult(sessionId) {
+    this.sessionOverrides.delete(sessionId);
+  }
+  async processCallback(session, _walletResponse) {
+    if (this.delayMs > 0) {
+      await new Promise((resolve) => setTimeout(resolve, this.delayMs));
+    }
+    return this.sessionOverrides.get(session.id) ?? { ...this.defaultResult };
+  }
+  async simulateCompletion(session) {
+    return this.processCallback(session, {});
+  }
+};
+var DEFAULT_TTL_MS = 3e5;
+var DEFAULT_WALLET_BASE_URL = "openid4vp://verify";
+var VerificationService = class extends events.EventEmitter {
+  store;
+  mode;
+  sessionTtlMs;
+  walletBaseUrl;
+  /** Track session IDs for cleanup (store interface has no list method) */
+  sessionIds = /* @__PURE__ */ new Set();
+  constructor(config) {
+    super();
+    this.mode = config.mode;
+    this.store = config.store ?? new InMemorySessionStore();
+    this.sessionTtlMs = config.sessionTtlMs ?? DEFAULT_TTL_MS;
+    this.walletBaseUrl = config.walletBaseUrl ?? DEFAULT_WALLET_BASE_URL;
+  }
+  /**
+   * Create a new verification session
+   */
+  async createSession(input) {
+    const id = uuid.v4();
+    const now = /* @__PURE__ */ new Date();
+    const session = {
+      id,
+      type: input.type,
+      status: "PENDING" /* PENDING */,
+      walletUrl: "",
+      // set below, may be async from mode
+      countryWhitelist: input.countryWhitelist,
+      countryBlacklist: input.countryBlacklist,
+      redirectUrl: input.redirectUrl,
+      metadata: input.metadata,
+      createdAt: now,
+      expiresAt: new Date(now.getTime() + this.sessionTtlMs)
+    };
+    session.walletUrl = this.mode.buildWalletUrl ? await this.mode.buildWalletUrl(id, input) : `${this.walletBaseUrl}?session=${id}`;
+    await this.store.set(session);
+    this.sessionIds.add(id);
+    this.emit("session:created", session);
+    if (this.mode.simulateCompletion) {
+      this.mode.simulateCompletion(session).then(async (result) => {
+        const current = await this.store.get(id);
+        if (current && current.status === "PENDING" /* PENDING */) {
+          await this.completeSession(current, result);
+        }
+      }).catch(() => {
+      });
+    }
+    return session;
+  }
+  /**
+   * Get a session by ID
+   * @throws SessionNotFoundError
+   */
+  async getSession(id) {
+    const session = await this.store.get(id);
+    if (!session) {
+      throw new SessionNotFoundError(id);
+    }
+    return session;
+  }
+  /**
+   * Handle a callback from the wallet
+   * @throws SessionNotFoundError
+   * @throws SessionExpiredError
+   */
+  async handleCallback(sessionId, walletResponse) {
+    const session = await this.store.get(sessionId);
+    if (!session) {
+      throw new SessionNotFoundError(sessionId);
+    }
+    if (/* @__PURE__ */ new Date() > session.expiresAt) {
+      throw new SessionExpiredError(sessionId);
+    }
+    const result = await this.mode.processCallback(session, walletResponse);
+    await this.completeSession(session, result);
+    return result;
+  }
+  /**
+   * Remove expired sessions from the store
+   * @returns Number of sessions cleaned up
+   */
+  async cleanupExpired() {
+    const now = /* @__PURE__ */ new Date();
+    let count = 0;
+    for (const id of this.sessionIds) {
+      const session = await this.store.get(id);
+      if (!session) {
+        this.sessionIds.delete(id);
+        continue;
+      }
+      if (now > session.expiresAt && session.status === "PENDING" /* PENDING */) {
+        const expired = { ...session, status: "EXPIRED" /* EXPIRED */ };
+        await this.store.set(expired);
+        await this.store.delete(id);
+        this.sessionIds.delete(id);
+        this.emit("session:expired", expired);
+        count++;
+      }
+    }
+    return count;
+  }
+  async completeSession(session, result) {
+    const status = result.verified ? "VERIFIED" /* VERIFIED */ : "REJECTED" /* REJECTED */;
+    const updated = {
+      ...session,
+      status,
+      completedAt: /* @__PURE__ */ new Date(),
+      result
+    };
+    await this.store.set(updated);
+    if (result.verified) {
+      this.emit("session:verified", updated, result);
+    } else {
+      this.emit("session:rejected", updated, result.rejectionReason);
+    }
+  }
+};
+
+// src/index.ts
+var VERSION = "0.1.0";
+
+exports.DemoMode = DemoMode;
+exports.InMemorySessionStore = InMemorySessionStore;
+exports.MockMode = MockMode;
+exports.SessionExpiredError = SessionExpiredError;
+exports.SessionNotFoundError = SessionNotFoundError;
+exports.VERSION = VERSION;
+exports.VerificationService = VerificationService;
+exports.VerificationStatus = VerificationStatus;
+exports.VerificationType = VerificationType;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map