dataspace-client-sdk-ts
v0.1.0
Published
TypeScript SDK para clientes GDC. Expone contratos y helpers para workflows de consentimiento, interoperabilidad y verificación de PDF.
Downloads
16
Readme
gdc-client-sdk-ts
TypeScript SDK para clientes GDC. Expone contratos y helpers para workflows de consentimiento, interoperabilidad y verificación de PDF.
Flujos de onboarding (visión funcional)
Este paquete no implementa el onboarding E2E del Gateway; para ese flujo usa dataspace-client-sdk-node.
Separación recomendada de documentación:
Legal Organization Onboarding Flow(B2B/tenant):ICA _verify->GW Organization _activate-> (si aplica)Offer/Order->Device DCR (_dcr)->Token/SMART.Personal Organization Onboarding Flow(individual/family/subject):Organization _batch(family/personal registration) ->Order _batch(aceptación de offer) -> consent/data flows.
Referencia práctica:
dataspace-client-sdk-node/README.mddataspace-client-sdk-node/docs/DEVELOPER_USE_CASES.mddataspace-client-sdk-node/docs/E2E_BOOTSTRAP.md
Instalación
npm install gdc-client-sdk-tsDependencia de utilidades comunes
Este SDK depende de gdc-common-utils-ts (actualizado a la versión ^1.4.8).
Test y Build
Actualmente este paquete no define scripts de test ni build. Se recomienda agregar tests y build antes de publicar en producción.
Publicación en npm
Para publicar este paquete en npm:
- Asegúrate de tener el campo
namecorrecto enpackage.json(ejemplo: "name": "gdc-client-sdk-ts"). - Exporta tu NPM_TOKEN en el entorno:
- Puedes añadirlo a tu
.env.localo exportarlo en la terminal:export NPM_TOKEN=tu_token_aqui
- Puedes añadirlo a tu
- Ejecuta:
npm version patch --no-git-tag-version npm publish --access public
Notas importantes
- Si hay errores en los tests o build, la publicación debe abortarse.
- El script
prepublishOnlypuede usarse para forzar tests/build antes de publicar. - Si ves errores de autenticación, revisa que el NPM_TOKEN esté cargado y tengas permisos de publicación.
Ejemplo de uso
import { PdfSignatureVerificationHttpApi } from 'gdc-client-sdk-ts/src/consent/pdfSignatureVerification';
const api = new PdfSignatureVerificationHttpApi('/api/verify-pdf');
const result = await api.verifyPdfSignature({ pdfBase64, content_type: 'application/pdf' });
if (result.ok) { /* ... */ }