@nxgt/janus-telemetry 0.3.2 → 0.3.3

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.
Files changed (2) hide show
  1. package/README.md +15 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -121,6 +121,21 @@ when the flow knows them — `janus.signOut` carries neither:
121
121
  - [Troubleshooting](docs/troubleshooting.md) — what you see, why, and the fix
122
122
  - [Roadmap](docs/roadmap.md) — what is next, and what is not planned
123
123
 
124
+ ## Type safety, counted
125
+
126
+ Six plausible mistakes are refused by the compiler, each with a
127
+ `@ts-expect-error` case in `test/types/instrument.ts`. Three are refusals of
128
+ `@nxgt/janus` that must survive instrumenting, since an instrumented
129
+ instance is typed as the one it wraps:
130
+ - a sign-in without its password;
131
+ - a user type the instance does not have;
132
+ - a permission the model does not declare.
133
+
134
+ Three are this package's own:
135
+ - something other than a `janus()` instance passed to `instrumentJanus`;
136
+ - a `permissions()` instance passed to `instrumentJanus`;
137
+ - a `janus()` instance passed to `instrumentPermissions`.
138
+
124
139
  ## Licence
125
140
 
126
141
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nxgt/janus-telemetry",
3
- "version": "0.3.2",
3
+ "version": "0.3.3",
4
4
  "description": "Observability for @nxgt/janus on @nxgt/telemetry: a span per flow and per permission check, and the security events worth an audit trail — never a login, an e-mail, a password, a session token, a one-time token or a session id",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -49,13 +49,13 @@
49
49
  ]
50
50
  },
51
51
  "devDependencies": {
52
- "@nxgt/janus": "^0.8.0",
52
+ "@nxgt/janus": "^0.8.6",
53
53
  "@nxgt/telemetry": "0.2.1",
54
54
  "@types/bun": "^1.4.2",
55
55
  "zod": "^4.6.5"
56
56
  },
57
57
  "peerDependencies": {
58
- "@nxgt/janus": "^0.8.0",
58
+ "@nxgt/janus": "^0.8.6",
59
59
  "@nxgt/telemetry": "^0.2.1",
60
60
  "typescript": "^6.0.3"
61
61
  }