@dcsv-io/d2-auth-context-abstractions 0.1.1 → 0.1.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 +11 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,12 +4,16 @@ Copyright (c) DCSV. Licensed under the Apache License, Version 2.0.
|
|
|
4
4
|
|
|
5
5
|
# @dcsv-io/d2-auth-context-abstractions
|
|
6
6
|
|
|
7
|
-
> Parent: [`packages/typescript/`](../../README.md)
|
|
8
|
-
|
|
9
7
|
`IAuthContext` interface + supporting enums/types. Emitted from
|
|
10
8
|
`contracts/auth-context/IAuthContext.spec.json` (generated sources committed).
|
|
11
9
|
Mirrors `DcsvIo.D2.AuthContext.Abstractions` (.NET).
|
|
12
10
|
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm add @dcsv-io/d2-auth-context-abstractions
|
|
15
|
+
```
|
|
16
|
+
|
|
13
17
|
## Public API
|
|
14
18
|
|
|
15
19
|
Generated artifacts (committed to git):
|
|
@@ -63,7 +67,7 @@ Mirrors `DcsvIo.D2.AuthContext.Abstractions`:
|
|
|
63
67
|
|
|
64
68
|
- `IAuthContext` — same property set, camelCased per TS conventions.
|
|
65
69
|
- `OrgType` / `Role` / `ImpersonationKind` / `ActorKind` — same wire
|
|
66
|
-
|
|
70
|
+
values (string-literal unions).
|
|
67
71
|
- `ActorEntry` — same field shape.
|
|
68
72
|
|
|
69
73
|
The .NET-side codegen lives in `DcsvIo.D2.Context.SourceGen` (Roslyn
|
|
@@ -90,9 +94,9 @@ codebase's nullability rule. The spec's `?` suffix on a type entry
|
|
|
90
94
|
## Edge cases
|
|
91
95
|
|
|
92
96
|
- `IAuthContextRedactPaths` is empty when no spec entry carries
|
|
93
|
-
|
|
94
|
-
|
|
97
|
+
`redact: true`. Hand-register additional paths via
|
|
98
|
+
`markRedactedFields()` from `@dcsv-io/d2-logging` if needed.
|
|
95
99
|
- Generated files (`*.g.ts`) are committed to git so consumers don't
|
|
96
|
-
|
|
100
|
+
pay a generate-on-first-build penalty.
|
|
97
101
|
- `pnpm exec eslint` ignores generated files — formatting drift is
|
|
98
|
-
|
|
102
|
+
irrelevant for spec-derived output.
|