@x12i/credorix-docs 1.2.0
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 +25 -0
- package/bin/credorix-docs.js +2 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +56 -0
- package/dist/cli.js.map +1 -0
- package/dist/generated/bundle.d.ts +450 -0
- package/dist/generated/bundle.d.ts.map +1 -0
- package/dist/generated/bundle.js +738 -0
- package/dist/generated/bundle.js.map +1 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# @x12i/credorix-docs
|
|
2
|
+
|
|
3
|
+
Credorix ebook **knowledge SDK**. Install as a **devDependency only** — do not add to production service dependencies.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm i -D @x12i/credorix-docs
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { credorixDocs } from "@x12i/credorix-docs";
|
|
11
|
+
|
|
12
|
+
credorixDocs.getUseCaseMarkdown("orient-credorix");
|
|
13
|
+
credorixDocs.getBookMarkdown("00-platform-overview", "developers");
|
|
14
|
+
credorixDocs.manifest();
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
CLI:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx credorix-docs list-use-cases
|
|
21
|
+
npx credorix-docs use-case integrate-memorix-pipeline > pack.md
|
|
22
|
+
npx credorix-docs book 02-http-api developers > book.md
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Content lives in `credorix-docs/` in the [Credorix](https://github.com/x12i/credorix) monorepo. Rebuild with `npm run docs:build` from the repo root.
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
|
package/dist/cli.js
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { credorixDocs } from "./index.js";
|
|
3
|
+
const [cmd, id, audience] = process.argv.slice(2);
|
|
4
|
+
function usage() {
|
|
5
|
+
console.error(`Usage:
|
|
6
|
+
credorix-docs use-case <id> Print assembled use-case markdown
|
|
7
|
+
credorix-docs book <id> <audience> Print book markdown
|
|
8
|
+
credorix-docs list-use-cases List use case ids
|
|
9
|
+
credorix-docs list-books List book ids
|
|
10
|
+
`);
|
|
11
|
+
}
|
|
12
|
+
if (!cmd || cmd === "help" || cmd === "--help") {
|
|
13
|
+
usage();
|
|
14
|
+
process.exit(cmd ? 0 : 1);
|
|
15
|
+
}
|
|
16
|
+
if (cmd === "list-use-cases") {
|
|
17
|
+
for (const uc of credorixDocs.listUseCases()) {
|
|
18
|
+
console.log(`${uc.id}\t${uc.title}`);
|
|
19
|
+
}
|
|
20
|
+
process.exit(0);
|
|
21
|
+
}
|
|
22
|
+
if (cmd === "list-books") {
|
|
23
|
+
for (const b of credorixDocs.listBooks()) {
|
|
24
|
+
console.log(`${b.id}\t${b.title}\t${b.audiences.join(",")}`);
|
|
25
|
+
}
|
|
26
|
+
process.exit(0);
|
|
27
|
+
}
|
|
28
|
+
if (cmd === "use-case") {
|
|
29
|
+
if (!id) {
|
|
30
|
+
usage();
|
|
31
|
+
process.exit(1);
|
|
32
|
+
}
|
|
33
|
+
const md = credorixDocs.getUseCaseMarkdown(id);
|
|
34
|
+
if (!md) {
|
|
35
|
+
console.error(`Unknown use case: ${id}`);
|
|
36
|
+
process.exit(1);
|
|
37
|
+
}
|
|
38
|
+
process.stdout.write(md);
|
|
39
|
+
process.exit(0);
|
|
40
|
+
}
|
|
41
|
+
if (cmd === "book") {
|
|
42
|
+
if (!id || !audience) {
|
|
43
|
+
usage();
|
|
44
|
+
process.exit(1);
|
|
45
|
+
}
|
|
46
|
+
const md = credorixDocs.getBookMarkdown(id, audience);
|
|
47
|
+
if (!md) {
|
|
48
|
+
console.error(`Unknown book/audience: ${id} ${audience}`);
|
|
49
|
+
process.exit(1);
|
|
50
|
+
}
|
|
51
|
+
process.stdout.write(md);
|
|
52
|
+
process.exit(0);
|
|
53
|
+
}
|
|
54
|
+
usage();
|
|
55
|
+
process.exit(1);
|
|
56
|
+
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAElD,SAAS,KAAK;IACZ,OAAO,CAAC,KAAK,CAAC;;;;;CAKf,CAAC,CAAC;AACH,CAAC;AAED,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;IAC/C,KAAK,EAAE,CAAC;IACR,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED,IAAI,GAAG,KAAK,gBAAgB,EAAE,CAAC;IAC7B,KAAK,MAAM,EAAE,IAAI,YAAY,CAAC,YAAY,EAAE,EAAE,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,IAAI,YAAY,CAAC,SAAS,EAAE,EAAE,CAAC;QACzC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,GAAG,YAAY,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC/C,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;QACzC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,GAAG,YAAY,CAAC,eAAe,CAAC,EAAE,EAAE,QAAqC,CAAC,CAAC;IACnF,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,KAAK,EAAE,CAAC;AACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,450 @@
|
|
|
1
|
+
export declare const catalog: {
|
|
2
|
+
readonly roles: readonly [{
|
|
3
|
+
readonly id: "developers";
|
|
4
|
+
readonly label: "Developers";
|
|
5
|
+
readonly tagline: "Wire Credorix";
|
|
6
|
+
readonly description: "Engineers who call leases and the broker, register profiles, and integrate workers or BFFs with Credorix.";
|
|
7
|
+
}, {
|
|
8
|
+
readonly id: "builders";
|
|
9
|
+
readonly label: "Builders";
|
|
10
|
+
readonly tagline: "Operate and harden";
|
|
11
|
+
readonly description: "Operators and platform builders who deploy Credorix, set SERVICE_MODE gates, and own credential policy.";
|
|
12
|
+
}];
|
|
13
|
+
readonly families: readonly [{
|
|
14
|
+
readonly id: "credorix";
|
|
15
|
+
readonly name: "Credorix";
|
|
16
|
+
readonly tagline: "Isolated credential and authentication runtime for outbound calls.";
|
|
17
|
+
readonly description: "Caller auth, auth profiles, secret resolution, leases, and request brokering — without secrets in business envelopes.";
|
|
18
|
+
readonly color: "#0f2a44";
|
|
19
|
+
}];
|
|
20
|
+
readonly books: readonly [{
|
|
21
|
+
readonly id: "00-platform-overview";
|
|
22
|
+
readonly familyId: "credorix";
|
|
23
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
24
|
+
readonly status: "available";
|
|
25
|
+
readonly kicker: "CASE FILE · CRX-00";
|
|
26
|
+
readonly title: "Platform Overview";
|
|
27
|
+
readonly subtitle: "What Credorix owns";
|
|
28
|
+
readonly blurb: "What Credorix is, the two trust relationships, packages, and where to start.";
|
|
29
|
+
readonly tags: readonly ["platform", "start-here", "overview"];
|
|
30
|
+
readonly color: "#0f2a44";
|
|
31
|
+
readonly dir: "00-platform-overview";
|
|
32
|
+
}, {
|
|
33
|
+
readonly id: "01-architecture";
|
|
34
|
+
readonly familyId: "credorix";
|
|
35
|
+
readonly audiences: readonly ["developers"];
|
|
36
|
+
readonly status: "available";
|
|
37
|
+
readonly kicker: "CASE FILE · CRX-01";
|
|
38
|
+
readonly title: "Architecture";
|
|
39
|
+
readonly subtitle: "Profiles, cache, delivery";
|
|
40
|
+
readonly blurb: "Service components, profile resolution, cache identity, lease vs broker, and extension seams.";
|
|
41
|
+
readonly tags: readonly ["architecture", "runtime"];
|
|
42
|
+
readonly color: "#16324f";
|
|
43
|
+
readonly dir: "01-architecture";
|
|
44
|
+
}, {
|
|
45
|
+
readonly id: "02-http-api";
|
|
46
|
+
readonly familyId: "credorix";
|
|
47
|
+
readonly audiences: readonly ["developers"];
|
|
48
|
+
readonly status: "available";
|
|
49
|
+
readonly kicker: "CASE FILE · CRX-02";
|
|
50
|
+
readonly title: "HTTP API";
|
|
51
|
+
readonly subtitle: "Caller and admin surfaces";
|
|
52
|
+
readonly blurb: "Health, metadata, leases, broker, token-state ingest, and administration routes.";
|
|
53
|
+
readonly tags: readonly ["http", "api", "leases", "broker"];
|
|
54
|
+
readonly color: "#1b3a57";
|
|
55
|
+
readonly dir: "02-http-api";
|
|
56
|
+
}, {
|
|
57
|
+
readonly id: "03-providers-and-secrets";
|
|
58
|
+
readonly familyId: "credorix";
|
|
59
|
+
readonly audiences: readonly ["developers"];
|
|
60
|
+
readonly status: "available";
|
|
61
|
+
readonly kicker: "CASE FILE · CRX-03";
|
|
62
|
+
readonly title: "Providers and Secrets";
|
|
63
|
+
readonly subtitle: "Schemes and credential sources";
|
|
64
|
+
readonly blurb: "Built-in auth providers, credential URI schemes, and pluggable CredentialSource.";
|
|
65
|
+
readonly tags: readonly ["providers", "secrets", "oauth"];
|
|
66
|
+
readonly color: "#214666";
|
|
67
|
+
readonly dir: "03-providers-and-secrets";
|
|
68
|
+
}, {
|
|
69
|
+
readonly id: "04-security";
|
|
70
|
+
readonly familyId: "credorix";
|
|
71
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
72
|
+
readonly status: "available";
|
|
73
|
+
readonly kicker: "CASE FILE · CRX-04";
|
|
74
|
+
readonly title: "Security Model";
|
|
75
|
+
readonly subtitle: "Invariants and controls";
|
|
76
|
+
readonly blurb: "Security invariants, encrypted persistence, broker SSRF controls, audit, and rotation.";
|
|
77
|
+
readonly tags: readonly ["security", "ssrf", "encryption"];
|
|
78
|
+
readonly color: "#2a5478";
|
|
79
|
+
readonly dir: "04-security";
|
|
80
|
+
}, {
|
|
81
|
+
readonly id: "05-production";
|
|
82
|
+
readonly familyId: "credorix";
|
|
83
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
84
|
+
readonly status: "available";
|
|
85
|
+
readonly kicker: "CASE FILE · CRX-05";
|
|
86
|
+
readonly title: "Production Hardening";
|
|
87
|
+
readonly subtitle: "Deployment boundary";
|
|
88
|
+
readonly blurb: "Supported deployment shape, SERVICE_MODE gates, and what stays deployment-owned.";
|
|
89
|
+
readonly tags: readonly ["production", "ops", "hardening"];
|
|
90
|
+
readonly color: "#336089";
|
|
91
|
+
readonly dir: "05-production";
|
|
92
|
+
}, {
|
|
93
|
+
readonly id: "06-memorix-integration";
|
|
94
|
+
readonly familyId: "credorix";
|
|
95
|
+
readonly audiences: readonly ["developers"];
|
|
96
|
+
readonly status: "available";
|
|
97
|
+
readonly kicker: "CASE FILE · CRX-06";
|
|
98
|
+
readonly title: "Memorix Integration";
|
|
99
|
+
readonly subtitle: "MPS 1.4.0 contract";
|
|
100
|
+
readonly blurb: "How Memorix / pipeline-services consumes Credorix via credential-ref and token-ref — pinned to MPS 1.4.0.";
|
|
101
|
+
readonly tags: readonly ["memorix", "pipeline", "mps"];
|
|
102
|
+
readonly color: "#3c6c9a";
|
|
103
|
+
readonly dir: "06-memorix-integration";
|
|
104
|
+
}];
|
|
105
|
+
};
|
|
106
|
+
export declare const useCases: {
|
|
107
|
+
readonly useCases: readonly [{
|
|
108
|
+
readonly id: "orient-credorix";
|
|
109
|
+
readonly title: "Orient on Credorix";
|
|
110
|
+
readonly goal: "Understand what Credorix owns, the two trust relationships, and which package to install.";
|
|
111
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
112
|
+
readonly tags: readonly ["platform", "start-here"];
|
|
113
|
+
readonly path: readonly [{
|
|
114
|
+
readonly bookId: "00-platform-overview";
|
|
115
|
+
readonly audience: "developers";
|
|
116
|
+
readonly chapters: readonly ["the-central-idea", "1-what-credorix-is", "2-packages", "3-where-to-go-next"];
|
|
117
|
+
}];
|
|
118
|
+
readonly alsoSee: readonly ["01-architecture", "02-http-api"];
|
|
119
|
+
readonly prerequisites: readonly [];
|
|
120
|
+
readonly successCriteria: readonly [];
|
|
121
|
+
readonly nextUseCases: readonly [];
|
|
122
|
+
readonly scenarioIds: readonly [];
|
|
123
|
+
readonly guideIds: readonly [];
|
|
124
|
+
readonly troubleshooting: readonly [];
|
|
125
|
+
}, {
|
|
126
|
+
readonly id: "call-lease-and-broker";
|
|
127
|
+
readonly title: "Call leases and the broker";
|
|
128
|
+
readonly goal: "Authenticate as a caller, obtain a short-lived lease, or broker an outbound request through Credorix.";
|
|
129
|
+
readonly audiences: readonly ["developers"];
|
|
130
|
+
readonly tags: readonly ["http", "leases", "broker", "sdk"];
|
|
131
|
+
readonly path: readonly [{
|
|
132
|
+
readonly bookId: "02-http-api";
|
|
133
|
+
readonly audience: "developers";
|
|
134
|
+
readonly chapters: readonly ["caller-authentication", "leases", "broker-fetch"];
|
|
135
|
+
}, {
|
|
136
|
+
readonly bookId: "01-architecture";
|
|
137
|
+
readonly audience: "developers";
|
|
138
|
+
readonly chapters: readonly ["delivery-modes"];
|
|
139
|
+
}];
|
|
140
|
+
readonly alsoSee: readonly ["00-platform-overview", "04-security"];
|
|
141
|
+
readonly prerequisites: readonly [];
|
|
142
|
+
readonly successCriteria: readonly [];
|
|
143
|
+
readonly nextUseCases: readonly [];
|
|
144
|
+
readonly scenarioIds: readonly [];
|
|
145
|
+
readonly guideIds: readonly [];
|
|
146
|
+
readonly troubleshooting: readonly [];
|
|
147
|
+
}, {
|
|
148
|
+
readonly id: "choose-auth-provider";
|
|
149
|
+
readonly title: "Choose an auth provider";
|
|
150
|
+
readonly goal: "Pick the right built-in scheme and credential source for a destination API.";
|
|
151
|
+
readonly audiences: readonly ["developers"];
|
|
152
|
+
readonly tags: readonly ["providers", "oauth", "secrets"];
|
|
153
|
+
readonly path: readonly [{
|
|
154
|
+
readonly bookId: "03-providers-and-secrets";
|
|
155
|
+
readonly audience: "developers";
|
|
156
|
+
readonly chapters: readonly ["built-in-providers", "credential-sources", "choosing-a-scheme"];
|
|
157
|
+
}];
|
|
158
|
+
readonly alsoSee: readonly ["04-security", "06-memorix-integration"];
|
|
159
|
+
readonly prerequisites: readonly [];
|
|
160
|
+
readonly successCriteria: readonly [];
|
|
161
|
+
readonly nextUseCases: readonly [];
|
|
162
|
+
readonly scenarioIds: readonly [];
|
|
163
|
+
readonly guideIds: readonly [];
|
|
164
|
+
readonly troubleshooting: readonly [];
|
|
165
|
+
}, {
|
|
166
|
+
readonly id: "harden-production";
|
|
167
|
+
readonly title: "Harden for production";
|
|
168
|
+
readonly goal: "Deploy Credorix inside its supported boundary with SERVICE_MODE gates and encrypted persistence.";
|
|
169
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
170
|
+
readonly tags: readonly ["production", "ops", "hardening"];
|
|
171
|
+
readonly path: readonly [{
|
|
172
|
+
readonly bookId: "05-production";
|
|
173
|
+
readonly audience: "developers";
|
|
174
|
+
readonly chapters: readonly ["supported-deployment-boundary", "runtime-mode", "implemented-in-this-repository"];
|
|
175
|
+
}, {
|
|
176
|
+
readonly bookId: "04-security";
|
|
177
|
+
readonly audience: "developers";
|
|
178
|
+
readonly chapters: readonly ["invariants", "secret-storage"];
|
|
179
|
+
}];
|
|
180
|
+
readonly alsoSee: readonly ["00-platform-overview"];
|
|
181
|
+
readonly prerequisites: readonly [];
|
|
182
|
+
readonly successCriteria: readonly [];
|
|
183
|
+
readonly nextUseCases: readonly [];
|
|
184
|
+
readonly scenarioIds: readonly [];
|
|
185
|
+
readonly guideIds: readonly [];
|
|
186
|
+
readonly troubleshooting: readonly [];
|
|
187
|
+
}, {
|
|
188
|
+
readonly id: "integrate-memorix-pipeline";
|
|
189
|
+
readonly title: "Integrate Memorix pipelines";
|
|
190
|
+
readonly goal: "Map MPS credential-ref / token-ref envelopes to Credorix profiles and broker helpers.";
|
|
191
|
+
readonly audiences: readonly ["developers"];
|
|
192
|
+
readonly tags: readonly ["memorix", "pipeline", "mps"];
|
|
193
|
+
readonly path: readonly [{
|
|
194
|
+
readonly bookId: "06-memorix-integration";
|
|
195
|
+
readonly audience: "developers";
|
|
196
|
+
readonly chapters: readonly ["pinned-contract", "credential-profiles", "worker-to-vendor", "consent-custody"];
|
|
197
|
+
}];
|
|
198
|
+
readonly alsoSee: readonly ["02-http-api", "01-architecture"];
|
|
199
|
+
readonly prerequisites: readonly [];
|
|
200
|
+
readonly successCriteria: readonly [];
|
|
201
|
+
readonly nextUseCases: readonly [];
|
|
202
|
+
readonly scenarioIds: readonly [];
|
|
203
|
+
readonly guideIds: readonly [];
|
|
204
|
+
readonly troubleshooting: readonly [];
|
|
205
|
+
}, {
|
|
206
|
+
readonly id: "operate-admin-api";
|
|
207
|
+
readonly title: "Operate the admin API";
|
|
208
|
+
readonly goal: "Register profiles and callers, rotate tokens, and use idempotent admin mutations.";
|
|
209
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
210
|
+
readonly tags: readonly ["admin", "http", "ops"];
|
|
211
|
+
readonly path: readonly [{
|
|
212
|
+
readonly bookId: "02-http-api";
|
|
213
|
+
readonly audience: "developers";
|
|
214
|
+
readonly chapters: readonly ["administration-api", "profiles-and-callers"];
|
|
215
|
+
}, {
|
|
216
|
+
readonly bookId: "04-security";
|
|
217
|
+
readonly audience: "developers";
|
|
218
|
+
readonly chapters: readonly ["caller-bootstrap", "rotation"];
|
|
219
|
+
}];
|
|
220
|
+
readonly alsoSee: readonly ["05-production"];
|
|
221
|
+
readonly prerequisites: readonly [];
|
|
222
|
+
readonly successCriteria: readonly [];
|
|
223
|
+
readonly nextUseCases: readonly [];
|
|
224
|
+
readonly scenarioIds: readonly [];
|
|
225
|
+
readonly guideIds: readonly [];
|
|
226
|
+
readonly troubleshooting: readonly [];
|
|
227
|
+
}];
|
|
228
|
+
};
|
|
229
|
+
export declare const site: {
|
|
230
|
+
readonly product: "credorix";
|
|
231
|
+
readonly brand: "x12i · Credorix";
|
|
232
|
+
readonly brandAccent: "credorix";
|
|
233
|
+
readonly siteUrl: "https://docs.credorix.x12i.com";
|
|
234
|
+
readonly knowledgePackage: "@x12i/credorix-docs";
|
|
235
|
+
readonly footer: "Credorix";
|
|
236
|
+
readonly accent: "oklch(45% 0.12 230)";
|
|
237
|
+
readonly accentAlt: "oklch(55% 0.14 40)";
|
|
238
|
+
readonly productUrl: "https://github.com/x12i/credorix";
|
|
239
|
+
readonly nav: readonly [{
|
|
240
|
+
readonly label: "Getting started";
|
|
241
|
+
readonly href: "/getting-started";
|
|
242
|
+
}, {
|
|
243
|
+
readonly label: "Use cases";
|
|
244
|
+
readonly href: "/use-cases";
|
|
245
|
+
}, {
|
|
246
|
+
readonly label: "Catalog";
|
|
247
|
+
readonly href: "/catalog";
|
|
248
|
+
}];
|
|
249
|
+
readonly footerLinks: readonly [{
|
|
250
|
+
readonly label: "Docs home";
|
|
251
|
+
readonly href: "/docs";
|
|
252
|
+
}, {
|
|
253
|
+
readonly label: "Use cases";
|
|
254
|
+
readonly href: "/use-cases";
|
|
255
|
+
}, {
|
|
256
|
+
readonly label: "Agents/SDK";
|
|
257
|
+
readonly href: "/agents";
|
|
258
|
+
}, {
|
|
259
|
+
readonly label: "Repository";
|
|
260
|
+
readonly href: "https://github.com/x12i/credorix";
|
|
261
|
+
}];
|
|
262
|
+
};
|
|
263
|
+
export declare const manifest: {
|
|
264
|
+
readonly version: 1;
|
|
265
|
+
readonly product: "credorix";
|
|
266
|
+
readonly site: "https://docs.credorix.x12i.com";
|
|
267
|
+
readonly knowledgePackage: "@x12i/credorix-docs";
|
|
268
|
+
readonly roles: readonly ["developers", "builders"];
|
|
269
|
+
readonly books: readonly [{
|
|
270
|
+
readonly id: "00-platform-overview";
|
|
271
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
272
|
+
readonly md: {
|
|
273
|
+
readonly developers: "downloads/books/00-platform-overview/developers.md";
|
|
274
|
+
readonly builders: "downloads/books/00-platform-overview/builders.md";
|
|
275
|
+
};
|
|
276
|
+
readonly pdf: {
|
|
277
|
+
readonly developers: null;
|
|
278
|
+
readonly builders: null;
|
|
279
|
+
};
|
|
280
|
+
readonly chapters: {
|
|
281
|
+
readonly developers: "downloads/books/00-platform-overview/developers.chapters.json";
|
|
282
|
+
readonly builders: "downloads/books/00-platform-overview/builders.chapters.json";
|
|
283
|
+
};
|
|
284
|
+
}, {
|
|
285
|
+
readonly id: "01-architecture";
|
|
286
|
+
readonly audiences: readonly ["developers"];
|
|
287
|
+
readonly md: {
|
|
288
|
+
readonly developers: "downloads/books/01-architecture/developers.md";
|
|
289
|
+
};
|
|
290
|
+
readonly pdf: {
|
|
291
|
+
readonly developers: null;
|
|
292
|
+
};
|
|
293
|
+
readonly chapters: {
|
|
294
|
+
readonly developers: "downloads/books/01-architecture/developers.chapters.json";
|
|
295
|
+
};
|
|
296
|
+
}, {
|
|
297
|
+
readonly id: "02-http-api";
|
|
298
|
+
readonly audiences: readonly ["developers"];
|
|
299
|
+
readonly md: {
|
|
300
|
+
readonly developers: "downloads/books/02-http-api/developers.md";
|
|
301
|
+
};
|
|
302
|
+
readonly pdf: {
|
|
303
|
+
readonly developers: null;
|
|
304
|
+
};
|
|
305
|
+
readonly chapters: {
|
|
306
|
+
readonly developers: "downloads/books/02-http-api/developers.chapters.json";
|
|
307
|
+
};
|
|
308
|
+
}, {
|
|
309
|
+
readonly id: "03-providers-and-secrets";
|
|
310
|
+
readonly audiences: readonly ["developers"];
|
|
311
|
+
readonly md: {
|
|
312
|
+
readonly developers: "downloads/books/03-providers-and-secrets/developers.md";
|
|
313
|
+
};
|
|
314
|
+
readonly pdf: {
|
|
315
|
+
readonly developers: null;
|
|
316
|
+
};
|
|
317
|
+
readonly chapters: {
|
|
318
|
+
readonly developers: "downloads/books/03-providers-and-secrets/developers.chapters.json";
|
|
319
|
+
};
|
|
320
|
+
}, {
|
|
321
|
+
readonly id: "04-security";
|
|
322
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
323
|
+
readonly md: {
|
|
324
|
+
readonly developers: "downloads/books/04-security/developers.md";
|
|
325
|
+
readonly builders: "downloads/books/04-security/builders.md";
|
|
326
|
+
};
|
|
327
|
+
readonly pdf: {
|
|
328
|
+
readonly developers: null;
|
|
329
|
+
readonly builders: null;
|
|
330
|
+
};
|
|
331
|
+
readonly chapters: {
|
|
332
|
+
readonly developers: "downloads/books/04-security/developers.chapters.json";
|
|
333
|
+
readonly builders: "downloads/books/04-security/builders.chapters.json";
|
|
334
|
+
};
|
|
335
|
+
}, {
|
|
336
|
+
readonly id: "05-production";
|
|
337
|
+
readonly audiences: readonly ["developers", "builders"];
|
|
338
|
+
readonly md: {
|
|
339
|
+
readonly developers: "downloads/books/05-production/developers.md";
|
|
340
|
+
readonly builders: "downloads/books/05-production/builders.md";
|
|
341
|
+
};
|
|
342
|
+
readonly pdf: {
|
|
343
|
+
readonly developers: null;
|
|
344
|
+
readonly builders: null;
|
|
345
|
+
};
|
|
346
|
+
readonly chapters: {
|
|
347
|
+
readonly developers: "downloads/books/05-production/developers.chapters.json";
|
|
348
|
+
readonly builders: "downloads/books/05-production/builders.chapters.json";
|
|
349
|
+
};
|
|
350
|
+
}, {
|
|
351
|
+
readonly id: "06-memorix-integration";
|
|
352
|
+
readonly audiences: readonly ["developers"];
|
|
353
|
+
readonly md: {
|
|
354
|
+
readonly developers: "downloads/books/06-memorix-integration/developers.md";
|
|
355
|
+
};
|
|
356
|
+
readonly pdf: {
|
|
357
|
+
readonly developers: null;
|
|
358
|
+
};
|
|
359
|
+
readonly chapters: {
|
|
360
|
+
readonly developers: "downloads/books/06-memorix-integration/developers.chapters.json";
|
|
361
|
+
};
|
|
362
|
+
}];
|
|
363
|
+
readonly useCases: readonly [{
|
|
364
|
+
readonly id: "orient-credorix";
|
|
365
|
+
readonly title: "Orient on Credorix";
|
|
366
|
+
readonly md: "downloads/use-cases/orient-credorix.md";
|
|
367
|
+
readonly path: readonly [{
|
|
368
|
+
readonly bookId: "00-platform-overview";
|
|
369
|
+
readonly audience: "developers";
|
|
370
|
+
readonly chapters: readonly ["the-central-idea", "1-what-credorix-is", "2-packages", "3-where-to-go-next"];
|
|
371
|
+
}];
|
|
372
|
+
}, {
|
|
373
|
+
readonly id: "call-lease-and-broker";
|
|
374
|
+
readonly title: "Call leases and the broker";
|
|
375
|
+
readonly md: "downloads/use-cases/call-lease-and-broker.md";
|
|
376
|
+
readonly path: readonly [{
|
|
377
|
+
readonly bookId: "02-http-api";
|
|
378
|
+
readonly audience: "developers";
|
|
379
|
+
readonly chapters: readonly ["caller-authentication", "leases", "broker-fetch"];
|
|
380
|
+
}, {
|
|
381
|
+
readonly bookId: "01-architecture";
|
|
382
|
+
readonly audience: "developers";
|
|
383
|
+
readonly chapters: readonly ["delivery-modes"];
|
|
384
|
+
}];
|
|
385
|
+
}, {
|
|
386
|
+
readonly id: "choose-auth-provider";
|
|
387
|
+
readonly title: "Choose an auth provider";
|
|
388
|
+
readonly md: "downloads/use-cases/choose-auth-provider.md";
|
|
389
|
+
readonly path: readonly [{
|
|
390
|
+
readonly bookId: "03-providers-and-secrets";
|
|
391
|
+
readonly audience: "developers";
|
|
392
|
+
readonly chapters: readonly ["built-in-providers", "credential-sources", "choosing-a-scheme"];
|
|
393
|
+
}];
|
|
394
|
+
}, {
|
|
395
|
+
readonly id: "harden-production";
|
|
396
|
+
readonly title: "Harden for production";
|
|
397
|
+
readonly md: "downloads/use-cases/harden-production.md";
|
|
398
|
+
readonly path: readonly [{
|
|
399
|
+
readonly bookId: "05-production";
|
|
400
|
+
readonly audience: "developers";
|
|
401
|
+
readonly chapters: readonly ["supported-deployment-boundary", "runtime-mode", "implemented-in-this-repository"];
|
|
402
|
+
}, {
|
|
403
|
+
readonly bookId: "04-security";
|
|
404
|
+
readonly audience: "developers";
|
|
405
|
+
readonly chapters: readonly ["invariants", "secret-storage"];
|
|
406
|
+
}];
|
|
407
|
+
}, {
|
|
408
|
+
readonly id: "integrate-memorix-pipeline";
|
|
409
|
+
readonly title: "Integrate Memorix pipelines";
|
|
410
|
+
readonly md: "downloads/use-cases/integrate-memorix-pipeline.md";
|
|
411
|
+
readonly path: readonly [{
|
|
412
|
+
readonly bookId: "06-memorix-integration";
|
|
413
|
+
readonly audience: "developers";
|
|
414
|
+
readonly chapters: readonly ["pinned-contract", "credential-profiles", "worker-to-vendor", "consent-custody"];
|
|
415
|
+
}];
|
|
416
|
+
}, {
|
|
417
|
+
readonly id: "operate-admin-api";
|
|
418
|
+
readonly title: "Operate the admin API";
|
|
419
|
+
readonly md: "downloads/use-cases/operate-admin-api.md";
|
|
420
|
+
readonly path: readonly [{
|
|
421
|
+
readonly bookId: "02-http-api";
|
|
422
|
+
readonly audience: "developers";
|
|
423
|
+
readonly chapters: readonly ["administration-api", "profiles-and-callers"];
|
|
424
|
+
}, {
|
|
425
|
+
readonly bookId: "04-security";
|
|
426
|
+
readonly audience: "developers";
|
|
427
|
+
readonly chapters: readonly ["caller-bootstrap", "rotation"];
|
|
428
|
+
}];
|
|
429
|
+
}];
|
|
430
|
+
readonly indexes: {
|
|
431
|
+
readonly indexMd: "INDEX.md";
|
|
432
|
+
readonly searchJson: "SEARCH.json";
|
|
433
|
+
};
|
|
434
|
+
readonly concepts: readonly [];
|
|
435
|
+
readonly guides: readonly [];
|
|
436
|
+
readonly scenarios: readonly [];
|
|
437
|
+
readonly decisions: readonly [];
|
|
438
|
+
readonly glossary: readonly [];
|
|
439
|
+
readonly visuals: readonly [];
|
|
440
|
+
readonly diagrams: readonly [];
|
|
441
|
+
readonly relationships: readonly [];
|
|
442
|
+
readonly tutorials: readonly [];
|
|
443
|
+
readonly examples: readonly [];
|
|
444
|
+
readonly sampleData: readonly [];
|
|
445
|
+
readonly uiClients: readonly [];
|
|
446
|
+
readonly apis: readonly [];
|
|
447
|
+
readonly packs: readonly [];
|
|
448
|
+
};
|
|
449
|
+
export declare const files: Record<string, string>;
|
|
450
|
+
//# sourceMappingURL=bundle.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["../../src/generated/bundle.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkKV,CAAC;AAEX,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwOX,CAAC;AAEX,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0CP,CAAC;AAEX,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4QX,CAAC;AAEX,eAAO,MAAM,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CA2BxC,CAAC"}
|