@zanii/compliance 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -42
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,42 +1,43 @@
|
|
|
1
|
-
# @zanii/compliance
|
|
2
|
-
|
|
3
|
-
Turn a Zanii **audit bundle** into an auditor-ready compliance report — verified
|
|
4
|
-
offline, no network, no trust in Zanii's servers. Action breakdown by control,
|
|
5
|
-
on-chain anchoring coverage, and a Markdown renderer you can hand straight to an
|
|
6
|
-
auditor.
|
|
7
|
-
|
|
8
|
-
```sh
|
|
9
|
-
npm install @zanii/compliance
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
## Usage
|
|
13
|
-
|
|
14
|
-
```ts
|
|
15
|
-
import { buildComplianceReport, renderComplianceMarkdown } from '@zanii/compliance';
|
|
16
|
-
|
|
17
|
-
// bundle = the JSON from `zanii export <did>` (or GET /v1/export/<did>)
|
|
18
|
-
const report = buildComplianceReport(bundle, {
|
|
19
|
-
controls: {
|
|
20
|
-
crm: 'AC-2 Account Management',
|
|
21
|
-
email: 'AU-2 Audit Events',
|
|
22
|
-
pay: 'SC-13 Cryptographic Protection',
|
|
23
|
-
},
|
|
24
|
-
});
|
|
25
|
-
|
|
26
|
-
console.log(report.verified, report.flags); // false-verified bundles still summarize, with a flag
|
|
27
|
-
console.log(renderComplianceMarkdown(report)); // → hand to the auditor
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
`buildComplianceReport` verifies the bundle with `@zanii/core` first; every figure
|
|
31
|
-
is derived from the receipts, and anything an auditor should notice (failed
|
|
32
|
-
verification, unanchored receipts, revoked delegations, unmapped namespaces)
|
|
33
|
-
lands in `report.flags`.
|
|
34
|
-
|
|
35
|
-
## Changelog
|
|
36
|
-
|
|
37
|
-
- **0.2.
|
|
38
|
-
- **0.
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
1
|
+
# @zanii/compliance
|
|
2
|
+
|
|
3
|
+
Turn a Zanii **audit bundle** into an auditor-ready compliance report — verified
|
|
4
|
+
offline, no network, no trust in Zanii's servers. Action breakdown by control,
|
|
5
|
+
on-chain anchoring coverage, and a Markdown renderer you can hand straight to an
|
|
6
|
+
auditor.
|
|
7
|
+
|
|
8
|
+
```sh
|
|
9
|
+
npm install @zanii/compliance
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import { buildComplianceReport, renderComplianceMarkdown } from '@zanii/compliance';
|
|
16
|
+
|
|
17
|
+
// bundle = the JSON from `zanii export <did>` (or GET /v1/export/<did>)
|
|
18
|
+
const report = buildComplianceReport(bundle, {
|
|
19
|
+
controls: {
|
|
20
|
+
crm: 'AC-2 Account Management',
|
|
21
|
+
email: 'AU-2 Audit Events',
|
|
22
|
+
pay: 'SC-13 Cryptographic Protection',
|
|
23
|
+
},
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
console.log(report.verified, report.flags); // false-verified bundles still summarize, with a flag
|
|
27
|
+
console.log(renderComplianceMarkdown(report)); // → hand to the auditor
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
`buildComplianceReport` verifies the bundle with `@zanii/core` first; every figure
|
|
31
|
+
is derived from the receipts, and anything an auditor should notice (failed
|
|
32
|
+
verification, unanchored receipts, revoked delegations, unmapped namespaces)
|
|
33
|
+
lands in `report.flags`.
|
|
34
|
+
|
|
35
|
+
## Changelog
|
|
36
|
+
|
|
37
|
+
- **0.2.2** — now depends on `@zanii/core` 0.5 (protocol 1.2), so it shares one core with `@zanii/sdk` 0.5 instead of pulling in a second, older copy. No API change.
|
|
38
|
+
- **0.2.0** — added `reconcile` (provider-vs-ledger omission catcher).
|
|
39
|
+
- **0.1.0** — initial release: `buildComplianceReport`, `renderComplianceMarkdown`, `ControlMap`.
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
Apache-2.0.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zanii/compliance",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Turn a Zanii audit bundle into an auditor-ready compliance report - offline verification, action breakdown, anchoring coverage, and control mapping, rendered to Markdown.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"homepage": "https://ledger.zanii.agency",
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
"@types/node": "^26.1.0",
|
|
30
30
|
"typescript": "^5.8.2",
|
|
31
31
|
"vitest": "^3.0.9",
|
|
32
|
-
"@zanii/testing": "0.1.
|
|
32
|
+
"@zanii/testing": "0.1.2"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@zanii/core": "0.
|
|
35
|
+
"@zanii/core": "^0.5.2"
|
|
36
36
|
},
|
|
37
37
|
"scripts": {
|
|
38
38
|
"build": "tsc -p tsconfig.build.json",
|