dataspace-client-sdk-node 0.2.1 → 0.2.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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

@@ -4,20 +4,18 @@ Node.js SDK to consume GW/UNID async DIDComm endpoints.
 
 ## Documentation Index
 
-1. [Full API Reference](docs/API.md)
-2. [Data Model Alignment (GW + Chat + SDK)](docs/DATA_MODEL_ALIGNMENT.md)
-3. [Frontend/Backend SDK Ownership Matrix](../docs/SDK_AUTH_OWNERSHIP.md)
-4. [Developer Use-Case Cookbook (UC5 + additional patterns)](docs/DEVELOPER_USE_CASES.md)
-5. [Live Local GW UC5 E2E (no mocks)](docs/E2E_LOCAL_GW_UC5.md)
-6. [React Web Integration Guide](docs/REACT_WEB_INTEGRATION.md)
-7. [Backend Node Integration Guide](docs/BACKEND_NODE_INTEGRATION.md)
-8. [Controller Flow Step by Step](docs/CONTROLLER_FLOW_STEP_BY_STEP.md)
-9. [Legal Organization Flow Step by Step](docs/LEGAL_ORGANIZATION_FLOW_STEP_BY_STEP.md)
-10. [Practitioner Flow Step by Step](docs/PRACTITIONER_FLOW_STEP_BY_STEP.md)
-11. [Portal Backend Integration Handover](docs/PORTAL_BACKEND_INTEGRATION_HANDOVER.md)
+1. [Full API Reference](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/API.md)
+2. [Data Model Alignment (GW + Chat + SDK)](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/DATA_MODEL_ALIGNMENT.md)
+3. [Developer Use-Case Cookbook (UC5 + additional patterns)](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/DEVELOPER_USE_CASES.md)
+4. [Live Local GW UC5 E2E (no mocks)](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/E2E_LOCAL_GW_UC5.md)
+5. [React Web Integration Guide](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/REACT_WEB_INTEGRATION.md)
+6. [Backend Node Integration Guide](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/BACKEND_NODE_INTEGRATION.md)
+7. [Controller Flow Step by Step](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/CONTROLLER_FLOW_STEP_BY_STEP.md)
+8. [Legal Organization Flow Step by Step](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/LEGAL_ORGANIZATION_FLOW_STEP_BY_STEP.md)
+9. [Practitioner Flow Step by Step](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/PRACTITIONER_FLOW_STEP_BY_STEP.md)
+10. [Portal Backend Integration Handover](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/PORTAL_BACKEND_INTEGRATION_HANDOVER.md)
 
 ## TODO and Roadmap
 
-1. [Prompt Next Steps TODO](TODO_PROMPT_NEXT_STEPS.md)
-2. [SMART EHR Compatibility TODO](docs/TODO_SMART_EHR_COMPAT.md)
-3. [SDK Parity Map](../SDK_PARITY_MAP.md)
+1. [Prompt Next Steps TODO](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/TODO_PROMPT_NEXT_STEPS.md)
+2. [SMART EHR Compatibility TODO](https://github.com/Global-DataCare/dataspace-client-sdk-node/blob/main/docs/TODO_SMART_EHR_COMPAT.md)

package/package.json

@@ -1,7 +1,17 @@
 {
   "name": "dataspace-client-sdk-node",
-  "version": "0.2.1",
-  "description": "Node.js SDK skeleton for GW/UNID DIDComm plain batch + async polling flows",
+  "version": "0.2.3",
+  "description": "Node.js SDK for DIDComm plain batch + async polling flows",
+  "license": "Apache-2.0",
+  "author": "Antifraud Services Inc.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Global-DataCare/dataspace-client-sdk-node.git"
+  },
+  "homepage": "https://github.com/Global-DataCare/dataspace-client-sdk-node#readme",
+  "bugs": {
+    "url": "https://github.com/Global-DataCare/dataspace-client-sdk-node/issues"
+  },
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/TODO_PROMPT_NEXT_STEPS.md

@@ -1,185 +0,0 @@
-# TODO / Prompt - Next Steps (dataspace-client-sdk-node)
-
-Objetivo de este backlog:
-- Mantener `dataspace-client-sdk-node` como SDK backend oficial para Node.
-- Añadir una capa wallet/KMS reutilizable para clientes backend Node (paridad conceptual con Python).
-- Evitar que servicios consumidores implementen crypto/auth ad-hoc fuera del SDK.
-
-Importante (decisión de arquitectura actual):
-- El wallet/KMS se implementa temporalmente dentro de este repo en:
-  - `src/sdk/dataspace-wallet-sdk-node/`
-- Más adelante se extraerá a repo/npm independiente (`dataspace-wallet-sdk-node`) sin romper API.
-
-## Repositorio fuente y referencias obligatorias
-
-Estas son las fuentes que el agente debe tomar como referencia técnica antes de implementar:
-
-1. Frontend / cliente app:
-- `gdc-sdk-client-ts`
-- Papel: SDK frontend/wallet UX-side (no backend custodial KMS).
-
-2. Backend gateway template:
-- `gwtemplate-node-ts`
-- Ruta clave: `src/gdc-backend-utils-node`
-- Papel: utilidades backend de crypto/KMS y contratos base.
-
-3. Backend UNID (fork operativo):
-- `gdc-unid-node-ts`
-- Papel: integración real de GW + managers + KMS runtime + flujos de negocio.
-
-4. SDK Python de referencia de paridad:
-- `connector-sdk-py`
-- Papel: referencia 1:1 de casos de uso backend.
-
-5. Orquestador de canal (consumidor actual):
-- `uhc-unid-chat-node`
-- Papel: usa SDK de alto nivel; no debe contener crypto/KMS de backend.
-
-Regla: si hay contradicción entre implementación Node actual y Python, documentar la divergencia y dejar TODO de convergencia.
-
-## Contexto que el agente debe respetar
-
-1. `uhc-unid-chat-node` y otros consumidores deben seguir usando métodos de alto nivel del SDK.
-2. Los cambios internos de path builders de identidad son breaking solo para consumidores que montan rutas a mano.
-3. Si el consumidor usa `authenticateBackendPkceAndExchange(...)`, no debe cambiar nada en su código por la migración de rutas identity.
-
-## Funcionamiento actual de backend tools + KMS (baseline)
-
-Resumen operativo esperado por el ecosistema backend:
-
-1. Capa SDK cliente (`dataspace-client-sdk-node`):
-- construye paths canónicos,
-- hace submit/poll,
-- orquesta auth backend (`_dcr -> _code -> _token -> _exchange`).
-
-2. Capa backend utils / KMS (hoy en GW/template repos):
-- `KmsService` / `DemoKmsService`,
-- interfaces de crypto (`IKmsService`, tipos JWK/JWS/JWE),
-- utilidades KEK/envelope para protección de claves y datos.
-
-3. Capa GW backend (`gdc-unid-node-ts` / `gwtemplate-node-ts`):
-- runtime multitenant,
-- provisión y resolución de claves por tenant,
-- operaciones de firma/verificación/cifrado en contexto servidor.
-
-Límite de responsabilidad:
-- `dataspace-client-sdk-node` no debe replicar managers de GW.
-- Sí debe poder exponer wallet/KMS cliente reutilizable para backends no-GW.
-
-## Definición de Hecho (DoD)
-
-1. Existe módulo wallet interno funcional con interfaz pública estable.
-2. El flujo `identity-exchange.v1` está soportado por métodos de alto nivel en Node (sin construir rutas manuales fuera del SDK).
-3. Se documenta paridad Node/Python por capability (no solo por endpoint).
-4. Hay tests que fallen si se rompe la paridad mínima acordada.
-5. README y ejemplos permiten a otro equipo integrar sin leer código interno.
-
-## Alcance técnico a implementar
-
-### A) Wallet/KMS interno (nuevo)
-
-Crear módulo en `src/sdk/dataspace-wallet-sdk-node/`:
-
-- `types.ts`
-  - `WalletContext` (`tenantId`, `jurisdiction`, `sector`, opcional `walletId`)
-  - `PublicJwk`, `PrivateKeyRef`, `SignOptions`, `EncryptOptions`, `DecryptOptions`
-  - `WalletProviderKind = 'mem' | 'seed' | 'external'`
-
-- `provider.ts`
-  - `WalletProvider` interface:
-    - `init(...)`
-    - `getPublicJwks(context)`
-    - `sign(payload, context, options)`
-    - `verify(payload, signature, jwk)`
-    - `encrypt(plaintext, recipientJwk, options)`
-    - `decrypt(ciphertext, context, options)`
-
-- `providers/memory-provider.ts`
-  - provider mínimo productivo para pruebas.
-
-- `providers/seed-provider.ts`
-  - solo para `demo/dev` (determinístico).
-  - prohibido recomendarlo para staging/prod.
-
-- `WalletClient.ts`
-  - fachada single-tenant.
-
-- `MultiWalletClient.ts`
-  - resolución por `tenantId/jurisdiction/sector`.
-
-### B) Integración en `DataspaceNodeClient`
-
-- Aceptar opcionalmente `wallet` en constructor/options.
-- Mantener compatibilidad de los métodos actuales de negocio/auth.
-- No mover lógica de dominios al wallet: wallet solo crypto/key operations.
-
-### C) Auth de alto nivel (paridad Python)
-
-Asegurar métodos de alto nivel para:
-- `authenticateBackendPkceAndExchange(...)`
-- base para `authenticateBackendSmartStandard(...)` (si el contrato backend ya está listo)
-
-Notas:
-- Internamente usar path builders canónicos nuevos.
-- Evitar exponer helpers de rutas como API pública “recomendada” para auth.
-
-## Plan de ejecución (orden obligatorio)
-
-1. Fase 1 - Contratos y estructura
-- Crear árbol `src/sdk/dataspace-wallet-sdk-node/*`.
-- Definir interfaces y tipos.
-- Añadir tests unitarios de contrato (sin integración GW todavía).
-
-2. Fase 2 - Provider mem/seed
-- Implementar `memory-provider` y `seed-provider`.
-- Añadir tests de firma/verificación y cifrado/descifrado.
-
-3. Fase 3 - Integración client
-- Conectar wallet opcional en `src/client.ts`.
-- Mantener sin breaking en usos actuales.
-
-4. Fase 4 - Paridad y documentación
-- Actualizar `SDK_PARITY_MAP.md` con estado real.
-- Actualizar `README.md` con sección “Wallet/KMS for backend clients”.
-- Añadir ejemplo runnable en `examples/`.
-
-5. Fase 5 - Puerta de extracción futura
-- Definir imports internos de forma que luego sea fácil reemplazar:
-  - `src/sdk/dataspace-wallet-sdk-node/*` -> paquete npm externo.
-
-## Tests mínimos obligatorios
-
-1. Unit tests wallet:
-- sign/verify roundtrip
-- encrypt/decrypt roundtrip
-- error handling de context faltante
-
-2. Unit tests auth orchestration:
-- secuencia `_dcr -> _code -> _token -> _exchange`
-- gestión de token cacheado vs refresh
-
-3. Regression tests identity routes:
-- verificar que internamente se usa patrón canónico
-  - `/{prefix}/cds-{j}/v1/{sector}/{tenantId}/identity/auth/{action}`
-
-4. Public API smoke:
-- import del SDK no rompe para consumidores actuales.
-
-## Criterios de seguridad
-
-- Ninguna private key en logs.
-- `seed-provider` marcado explícitamente como no apto para staging/prod.
-- Errores crypto sin volcar material sensible.
-
-## Entregables esperados del agente
-
-1. PR con código + tests + docs.
-2. Resumen de decisiones (tradeoffs) en la descripción.
-3. Tabla de estado actualizada en `SDK_PARITY_MAP.md`.
-4. Lista de pendientes para extracción a repo independiente.
-
-## Plantilla de commit sugerida
-
-- `feat(wallet): add internal dataspace-wallet-sdk-node module (mem/seed providers)`
-- `feat(auth): keep pkce high-level orchestration aligned with canonical identity routes`
-- `docs(parity): update SDK parity map and wallet roadmap`