@eudi-verify/embed 0.1.0

package/LICENSE

@@ -0,0 +1,184 @@
+                                 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 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, as 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 recording and
+      tracking Contributions to the Work, but excluding communication that is
+      conspicuously marked or designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      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 the 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 any such
+      Contribution as incorporated in 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution, either on its own or as part of the Work.
+
+   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 conditions of TITLE,
+      NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+      PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing 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 exemplary 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 all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or 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 offer such obligations 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 2024 EUDI Wallet Verifier Kit 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,267 @@
+# @eudi-verify/embed
+
+`<eudi-verify>` — a vanilla Custom Element for EUDI Wallet verification. Drop it into any HTML page. No build step required.
+
+## Installation
+
+```bash
+pnpm add @eudi-verify/embed
+```
+
+Or include directly via CDN:
+
+```html
+<script type="module" src="https://unpkg.com/@eudi-verify/embed"></script>
+```
+
+## Quick Start
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <script type="module">
+    import '@eudi-verify/embed';
+  </script>
+</head>
+<body>
+  <eudi-verify
+    api-url="/api/eudi"
+    request='{"age_over_18":true}'
+  ></eudi-verify>
+
+  <script>
+    document.querySelector('eudi-verify')
+      .addEventListener('verified', (e) => {
+        console.log('Token:', e.detail.token);
+        console.log('Claims:', e.detail.claims);
+      });
+  </script>
+</body>
+</html>
+```
+
+## Attributes
+
+| Attribute | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `api-url` | string | Yes | Base URL for your verifier API |
+| `request` | JSON string | Yes | Verification request (e.g., `'{"age_over_18":true}'`) |
+| `auto-start` | boolean | No | Start verification automatically on page load |
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| `start()` | Start the verification flow |
+| `cancel()` | Cancel the current verification |
+| `reset()` | Reset to idle state |
+
+```js
+const widget = document.querySelector('eudi-verify');
+
+// Programmatically start
+widget.start();
+
+// Cancel ongoing verification
+widget.cancel();
+
+// Reset to try again
+widget.reset();
+```
+
+## Events
+
+| Event | Detail | Description |
+|-------|--------|-------------|
+| `verified` | `{ token: string, claims: object }` | Verification succeeded |
+| `rejected` | `{ error?: string }` | User rejected in wallet |
+| `expired` | `{}` | Session expired |
+| `error` | `{ error: string }` | Error occurred |
+| `state-change` | `{ state: VerificationState }` | Any state change |
+
+```js
+widget.addEventListener('verified', (e) => {
+  // Send token to your backend for validation
+  fetch('/checkout', {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({ eudiToken: e.detail.token }),
+  });
+});
+
+widget.addEventListener('rejected', () => {
+  alert('Verification was declined');
+});
+
+widget.addEventListener('error', (e) => {
+  console.error('Error:', e.detail.error);
+});
+
+widget.addEventListener('state-change', (e) => {
+  console.log('State:', e.detail.state.status);
+});
+```
+
+## Error Boundaries
+
+The widget wraps `@eudi-verify/client`'s state machine. **DOM events are your integration boundary** — there is no separate error-hook API.
+
+| Event | When | Typical handling |
+|-------|------|------------------|
+| `rejected` | User declined in wallet | Retry prompt; not usually an ops alert |
+| `expired` | Session timed out | Offer to restart |
+| `error` | Network/API failure, invalid config | Show message; report to error tracking |
+| `state-change` | Any transition | Escape hatch — full `VerificationState` in `e.detail.state` |
+
+```js
+// Error reporting (Sentry, Datadog browser SDK, etc.)
+widget.addEventListener('error', (e) => {
+  reportError({ source: 'eudi-verify', message: e.detail.error });
+});
+
+widget.addEventListener('rejected', (e) => {
+  reportEvent({ type: 'verification_rejected', detail: e.detail.error });
+});
+
+// Or handle everything via state-change
+widget.addEventListener('state-change', (e) => {
+  const { state } = e.detail;
+  if (state.status === 'error') reportError({ message: state.error });
+});
+```
+
+**Config errors:** invalid JSON in the `request` attribute dispatches `error`. A missing `api-url` logs to the console only (no event) — validate attributes before calling `start()`.
+
+The widget renders built-in UI for `rejected`, `expired`, and `error` states. Events fire in addition to that UI so host pages can react (alerts, analytics, redirects).
+
+See [INTEGRATION.md](../../docs/INTEGRATION.md#error-boundaries) for the full stack overview.
+
+## Theming
+
+Style the widget using CSS custom properties:
+
+```css
+eudi-verify {
+  --eudi-primary: #003399;      /* EU blue - buttons, success */
+  --eudi-text: #1a1a1a;         /* Body text */
+  --eudi-background: #ffffff;   /* Widget surface */
+  --eudi-border-radius: 8px;    /* Corner rounding */
+  --eudi-font-family: system-ui, sans-serif;
+  --eudi-error: #d32f2f;        /* Error/rejected state */
+}
+```
+
+Example with custom branding:
+
+```css
+eudi-verify {
+  --eudi-primary: #0052b4;
+  --eudi-border-radius: 12px;
+  --eudi-font-family: 'Inter', sans-serif;
+}
+```
+
+## Accessibility
+
+The widget is WCAG 2.1 AA compliant:
+
+- **ARIA live regions** announce state changes to screen readers
+- **Focus management** during the verification flow
+- **Keyboard navigation** for all interactive elements
+- **Color contrast** meets 4.5:1 ratio (default theme)
+- **Reduced motion** respects `prefers-reduced-motion`
+
+## Shadow DOM
+
+The widget uses open Shadow DOM for style encapsulation. Styles don't leak in or out, but you can inspect the structure in DevTools.
+
+```html
+<eudi-verify>
+  #shadow-root (open)
+    <style>/* Internal styles */</style>
+    <div class="eudi-widget" role="region" aria-label="Identity verification">
+      <!-- State containers -->
+    </div>
+</eudi-verify>
+```
+
+## States
+
+The widget cycles through these states:
+
+```
+idle → loading → showQR → waitingForWallet → verified
+                                           → rejected
+                                           → expired
+                                           → error
+```
+
+Each state renders different UI:
+
+| State | UI |
+|-------|-----|
+| `idle` | "Verify with EU Wallet" button |
+| `loading` | Spinner |
+| `showQR` | QR code with cancel button |
+| `waitingForWallet` | "Waiting for wallet approval..." |
+| `verified` | Success checkmark |
+| `rejected` | Error with retry button |
+| `expired` | Expired message with retry |
+| `error` | Error message with retry |
+
+## Claims You Can Request
+
+```json
+{
+  "age_over_18": true,
+  "age_over_21": true,
+  "nationality": true,
+  "given_name": true,
+  "family_name": true,
+  "birth_date": true
+}
+```
+
+## Browser Support
+
+- Chrome/Edge 90+
+- Firefox 90+
+- Safari 14+
+- Mobile browsers (iOS Safari, Chrome for Android)
+
+## Bundle Size
+
+~8KB gzipped (including the client library).
+
+## Build Outputs
+
+| File | Format | Usage |
+|------|--------|-------|
+| `dist/eudi-verify.js` | ES Module | `import '@eudi-verify/embed'` |
+| `dist/eudi-verify.cjs` | CommonJS | `require('@eudi-verify/embed')` |
+| `dist/eudi-verify.iife.js` | IIFE | `<script src="...">` |
+| `dist/index.d.ts` | TypeScript | Type definitions |
+
+## Development
+
+```bash
+# Build
+pnpm build
+
+# Watch mode
+pnpm dev
+
+# Unit tests
+pnpm test
+
+# E2E tests (requires demo server running)
+pnpm test:e2e
+
+# Type check
+pnpm typecheck
+```
+
+## License
+
+Apache-2.0