dataspace-client-sdk-node 0.1.1 → 0.1.2

package/docs/REACT_WEB_INTEGRATION.md

@@ -0,0 +1,72 @@
+# React Web Integration
+
+This guide is frontend-only.  
+Backend SDK usage is documented in `docs/BACKEND_NODE_INTEGRATION.md`.
+
+## 1. What the React app does
+
+1. Run ICA UX flow and obtain `vpToken`.
+2. Send onboarding payloads to your backend.
+3. Show progress and status from backend responses.
+
+React does not call privileged GW onboarding routes directly.
+
+## 2. Legal onboarding payload sent by frontend
+
+Minimum payload to backend endpoint `/api/onboarding/legal/activate`:
+
+```json
+{
+  "jurisdiction": "ES",
+  "sector": "health-care",
+  "vpToken": "<vp_token>"
+}
+```
+
+Notes:
+- `jurisdiction` is explicit route context. Do not infer from VAT.
+- `sector` is explicit route context. Do not infer from DID.
+- `organizationVc` / `legalRepresentativeVc` can be sent only for legacy compatibility.
+
+## 3. Frontend code example
+
+```ts
+export async function activateLegalOrganization(input: {
+  jurisdiction: string;
+  sector: string;
+  vpToken: string;
+}) {
+  const response = await fetch('/api/onboarding/legal/activate', {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify(input),
+  });
+  if (!response.ok) throw new Error(`Activation failed: ${response.status}`);
+  return response.json();
+}
+```
+
+## 4. Personal/family onboarding from frontend
+
+```ts
+export async function registerPersonalOrganization(payload: {
+  tenantId: string;
+  jurisdiction: string;
+  sector: string;
+  registrationPayload: unknown;
+  confirmationPayload?: unknown;
+}) {
+  const response = await fetch('/api/onboarding/personal/register', {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify(payload),
+  });
+  if (!response.ok) throw new Error(`Personal onboarding failed: ${response.status}`);
+  return response.json();
+}
+```
+
+## 5. Backend document
+
+For exact SDK methods and backend implementation steps, use:
+- `docs/BACKEND_NODE_INTEGRATION.md`

package/examples/smoke-legal-org-local.mjs

@@ -0,0 +1,40 @@
+import { DataspaceNodeClient } from '../dist/index.js';
+
+const baseUrl = process.env.BASE_URL || 'http://127.0.0.1:3000';
+const bearerToken = process.env.AUTH_BEARER || 'demo-token';
+const tenantId = process.env.TENANT_ID || 'acme';
+const jurisdiction = process.env.JURISDICTION || 'ES';
+const sector = process.env.HOST_REGISTRY_SECTOR || 'test';
+const vpToken = process.env.VP_TOKEN || 'demo-vp';
+
+const client = new DataspaceNodeClient({ baseUrl, bearerToken });
+client
+  .setContextOrg({ tenantId, jurisdiction, sector })
+  .setDefaultTimeoutSeconds(Number(process.env.TIMEOUT_SECONDS || 60))
+  .setDefaultIntervalSeconds(Number(process.env.INTERVAL_SECONDS || 2));
+
+try {
+  const activation = await client.activateOrganizationInGatewaySimple({
+    vpToken,
+    numberOfMembers: Number(process.env.NUMBER_OF_MEMBERS || 2),
+  });
+
+  console.log('[activate] submit=', activation.submit.status, 'poll=', activation.poll.status);
+
+  const offerId = client.getOfferIdFromResponse(activation);
+  const offer = client.getOfferPreviewFromResponse(activation);
+  console.log('[activate] offerId=', offerId || '<missing>');
+  console.log('[activate] offerPreview=', JSON.stringify(offer));
+
+  if (!offerId) {
+    console.log('[order] skipped: no offerId in activation response');
+    process.exit(0);
+  }
+
+  const order = await client.confirmLegalOrganizationOrderSimple({ offerId });
+  console.log('[order] submit=', order.submit.status, 'poll=', order.poll.status);
+  process.exit(order.poll.status === 200 ? 0 : 1);
+} catch (error) {
+  console.error('[smoke-legal-org-local] ERROR:', error?.message || error);
+  process.exit(1);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataspace-client-sdk-node",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Node.js SDK skeleton for GW/UNID DIDComm plain batch + async polling flows",
   "type": "module",
   "main": "dist/index.js",