@thirtified/eudi-dev 0.1.1 → 0.1.2

package/README.md

@@ -19,6 +19,8 @@ pnpm add -D @thirtified/eudi-dev
 # or: npm install --save-dev @thirtified/eudi-dev
 ```
 
+With TypeScript, also install the Node types: `pnpm add -D @types/node`. The package's type definitions use them and load them for you, so you don't need `"types": ["node"]` in your tsconfig, which TypeScript 6 and later would otherwise require.
+
 The eudi-dev binary comes in one npm package per platform, listed as `optionalDependencies` with exact versions. The package manager installs only the one that matches your OS and CPU. Nothing is downloaded at install time or at runtime, and there is no install script.
 
 | Platform | Package | Upstream asset |
@@ -91,7 +93,16 @@ File-valued options (`key`, `trustedList`, `cert`, `csr`, `dcql`, `claims`, `ca`
 
 These commands work on the wallet in the instance's `EUDI_DEV_HOME`, which is created on first use. Pass `home` to keep state between instances.
 
+The example continues the one above: it uses `eudi` and `query` from there. The access-certificate calls need a PEM certificate signing request for your verifier's key, here `verifier.csr` in the working directory:
+
+```bash
+openssl ecparam -name prime256v1 -genkey -noout -out verifier.key
+openssl req -new -key verifier.key -subj "/CN=shop.example" -out verifier.csr
+```
+
 ```ts
+import { readFile } from 'node:fs/promises';
+
 const issued = await eudi.issue.sdjwt({ pid: true, wallet: true }); // issued.id
 const trustedList = await eudi.trust.show({ vct: 'urn:eudi:pid:1' }); // signed JWT
 await eudi.validate(issued.credential, { trustedList, statusList: false });
@@ -99,13 +110,18 @@ await eudi.validate(issued.credential, { trustedList, statusList: false });
 const caPem = await eudi.trust.caCert();
 const caJwks = await eudi.trust.caJwks();
 
+// Register a verifier, then get its registration and access certificates
 const rp = await eudi.registrar.verifiers.add({ name: 'Shop', purpose: 'Age check', dcql: query });
 const id = rp.identifier[0]!.identifier;
 const { registrationCertificate, verifierInfo } = await eudi.registrar.registrationCert({ identifier: id });
+const { certificate, chain } = await eudi.registrar.accessCert({ identifier: id, csr: { path: 'verifier.csr' } });
 await eudi.registrar.revoke({ identifier: id });
+
 await eudi.registrar.issuers.add({ name: 'Diplomas Inc', attestations: ['dc+sd-jwt:urn:example:diploma:1'] });
-await eudi.registrar.accessCert({ identifier: id, csr: { path: 'verifier.csr' } });
-await eudi.registrar.enrol({ relyingParty: { tradeName: 'X' }, access: { csr: csrPem } });
+
+// Register and get an access certificate in one step. The CSR can also be passed as content.
+const csrPem = await readFile('verifier.csr', 'utf8');
+await eudi.registrar.enrol({ relyingParty: { tradeName: 'Shop' }, access: { csr: csrPem } });
 ```
 
 A wallet-issued credential points to the wallet's own status list, which only `wallet serve` serves. Without a running server, validate it with `statusList: false`.

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" preserve="true" />
 export { PLATFORM_PACKAGES, type PlatformPackage, platformPackage, type ResolveBinaryOptions, resolveBinary, } from './binary.js';
 export { type CallOptions, type CredentialCategory, type DecodeFormat, type DecodeOptions, type IssueCommonOptions, type IssueDisplayOptions, type IssueJwtOptions, type IssueMdocOptions, type IssueRegistrationOptions, type IssueResult, type IssueSdJwtOptions, isDecodedCredential, type ValidateOptions, type ValidateResult, } from './commands/credentials.js';
 export type { AccessCertOptions, AddIssuerOptions, AddVerifierOptions, AttestationOptions, ExtendIssuerOptions, ExtendVerifierOptions, IntendedUseOptions, PartyCommands, PartyOptions, RegistrarCommands, RegistrationCertOptions, RegistrationScopeOptions, } from './commands/registrar.js';

package/dist/index.js

@@ -1,3 +1,8 @@
+// The public types use Node's (NodeJS.Platform, NodeJS.Signals, ...). Load them
+// for every program that imports this package, also under TypeScript 6+, where
+// "types" no longer defaults to all of node_modules/@types. preserve="true"
+// keeps the directive in the emitted index.d.ts.
+/// <reference types="node" preserve="true" />
 export { PLATFORM_PACKAGES, platformPackage, resolveBinary, } from './binary.js';
 export { isDecodedCredential, } from './commands/credentials.js';
 export { EudiDevBinaryError, EudiDevError } from './errors.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAEjB,eAAe,EAEf,aAAa,GACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAYL,mBAAmB,GAGpB,MAAM,2BAA2B,CAAC;AAgBnC,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAA4B,MAAM,aAAa,CAAC;AACzF,OAAO,EAAE,OAAO,EAAuB,MAAM,WAAW,CAAC;AAEzD,OAAO,EAAE,MAAM,EAAsD,MAAM,aAAa,CAAC;AACzF,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,+EAA+E;AAC/E,4EAA4E;AAC5E,iDAAiD;AACjD,8CAA8C;AAE9C,OAAO,EACL,iBAAiB,EAEjB,eAAe,EAEf,aAAa,GACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAYL,mBAAmB,GAGpB,MAAM,2BAA2B,CAAC;AAgBnC,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAA4B,MAAM,aAAa,CAAC;AACzF,OAAO,EAAE,OAAO,EAAuB,MAAM,WAAW,CAAC;AAEzD,OAAO,EAAE,MAAM,EAAsD,MAAM,aAAa,CAAC;AACzF,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thirtified/eudi-dev",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Typed Node.js wrapper for the eudi-dev CLI (decode, validate, dcql, issue, trust, registrar)",
   "keywords": [
     "eudi",

package/src/index.ts

@@ -1,3 +1,9 @@
+// The public types use Node's (NodeJS.Platform, NodeJS.Signals, ...). Load them
+// for every program that imports this package, also under TypeScript 6+, where
+// "types" no longer defaults to all of node_modules/@types. preserve="true"
+// keeps the directive in the emitted index.d.ts.
+/// <reference types="node" preserve="true" />
+
 export {
   PLATFORM_PACKAGES,
   type PlatformPackage,