@x12i/catalox-docs 1.1.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.
@@ -0,0 +1,749 @@
1
+ export declare const catalog: {
2
+ readonly roles: readonly [{
3
+ readonly id: "developers";
4
+ readonly label: "Developers";
5
+ readonly tagline: "Embed, operate, integrate";
6
+ readonly description: "Engineers who embed Catalox, run the CLI, deploy catalox-service, and wire Authix or host context.";
7
+ }];
8
+ readonly families: readonly [{
9
+ readonly id: "catalox";
10
+ readonly name: "Catalox";
11
+ readonly tagline: "Governed catalogs as platform infrastructure.";
12
+ readonly description: "Reusable item inventories that apps discover, render, search, and validate — without rebuilding catalog plumbing.";
13
+ readonly color: "#1a3a52";
14
+ }];
15
+ readonly books: readonly [{
16
+ readonly id: "00-overview";
17
+ readonly familyId: "catalox";
18
+ readonly audiences: readonly ["developers"];
19
+ readonly status: "available";
20
+ readonly kicker: "CASE FILE · CAT-00";
21
+ readonly title: "Overview";
22
+ readonly subtitle: "Why Catalox exists";
23
+ readonly blurb: "Product rationale, what Catalox is and is not, fit vs misfit, and FAQ highlights.";
24
+ readonly tags: readonly ["platform", "start-here", "overview"];
25
+ readonly color: "#1a3a52";
26
+ readonly dir: "00-overview";
27
+ }, {
28
+ readonly id: "01-content-backend";
29
+ readonly familyId: "catalox";
30
+ readonly audiences: readonly ["developers"];
31
+ readonly status: "available";
32
+ readonly kicker: "CASE FILE · CAT-01";
33
+ readonly title: "Content Backend";
34
+ readonly subtitle: "Apps and agents on one catalog layer";
35
+ readonly blurb: "Recommended integration pattern: BFFs and agent runtimes share Catalox as the content/metadata API.";
36
+ readonly tags: readonly ["integration", "bff", "agents"];
37
+ readonly color: "#1f5c4a";
38
+ readonly dir: "01-content-backend";
39
+ }, {
40
+ readonly id: "02-persistence";
41
+ readonly familyId: "catalox";
42
+ readonly audiences: readonly ["developers"];
43
+ readonly status: "available";
44
+ readonly kicker: "CASE FILE · CAT-02";
45
+ readonly title: "Persistence";
46
+ readonly subtitle: "MongoDB as primary store";
47
+ readonly blurb: "createCataloxFromEnv, collection layout, env vars, and operator notes for Mongo-backed estates.";
48
+ readonly tags: readonly ["mongo", "storage", "ops"];
49
+ readonly color: "#8a5a12";
50
+ readonly dir: "02-persistence";
51
+ }, {
52
+ readonly id: "03-deploy-ops";
53
+ readonly familyId: "catalox";
54
+ readonly audiences: readonly ["developers"];
55
+ readonly status: "available";
56
+ readonly kicker: "CASE FILE · CAT-03";
57
+ readonly title: "Deploy & Ops";
58
+ readonly subtitle: "Embed, CLI, HTTP, onboard";
59
+ readonly blurb: "Deployment modes, private vs public HTTP, onboarding happy path, and environment reference.";
60
+ readonly tags: readonly ["deploy", "http", "onboarding"];
61
+ readonly color: "#8b3a28";
62
+ readonly dir: "03-deploy-ops";
63
+ }, {
64
+ readonly id: "04-auth-identity";
65
+ readonly familyId: "catalox";
66
+ readonly audiences: readonly ["developers"];
67
+ readonly status: "available";
68
+ readonly kicker: "CASE FILE · CAT-04";
69
+ readonly title: "Auth & Identity";
70
+ readonly subtitle: "Context, bindings, outcomes";
71
+ readonly blurb: "Orthogonal identity axes, superAdmin, catalog/item visibility, and empty vs denied vs misconfigured.";
72
+ readonly tags: readonly ["auth", "identity", "bindings"];
73
+ readonly color: "#4a3a6e";
74
+ readonly dir: "04-auth-identity";
75
+ }, {
76
+ readonly id: "05-cli-toolbox";
77
+ readonly familyId: "catalox";
78
+ readonly audiences: readonly ["developers"];
79
+ readonly status: "available";
80
+ readonly kicker: "CASE FILE · CAT-05";
81
+ readonly title: "CLI & Toolbox";
82
+ readonly subtitle: "Operator commands";
83
+ readonly blurb: "Elevated CLI access, items CRUD, toolbox diagnostics, and seed workflows.";
84
+ readonly tags: readonly ["cli", "ops", "seed"];
85
+ readonly color: "#2a4a62";
86
+ readonly dir: "05-cli-toolbox";
87
+ }];
88
+ };
89
+ export declare const useCases: {
90
+ readonly useCases: readonly [{
91
+ readonly id: "orient-catalox";
92
+ readonly title: "Orient on Catalox";
93
+ readonly goal: "Understand why Catalox exists, what it owns, and when not to use it.";
94
+ readonly audiences: readonly ["developers"];
95
+ readonly tags: readonly ["platform", "start-here"];
96
+ readonly path: readonly [{
97
+ readonly bookId: "00-overview";
98
+ readonly audience: "developers";
99
+ readonly chapters: readonly ["1-why-catalox-exists", "2-what-catalox-is", "3-fit-vs-misfit"];
100
+ }];
101
+ readonly alsoSee: readonly ["01-content-backend"];
102
+ readonly prerequisites: readonly [];
103
+ readonly successCriteria: readonly [];
104
+ readonly nextUseCases: readonly [];
105
+ readonly scenarioIds: readonly [];
106
+ readonly guideIds: readonly [];
107
+ readonly troubleshooting: readonly [];
108
+ }, {
109
+ readonly id: "embed-content-backend";
110
+ readonly title: "Embed as content backend";
111
+ readonly goal: "Wire a BFF and agent runtime so humans and agents share one catalog layer.";
112
+ readonly audiences: readonly ["developers"];
113
+ readonly tags: readonly ["integration", "bff", "agents"];
114
+ readonly path: readonly [{
115
+ readonly bookId: "01-content-backend";
116
+ readonly audience: "developers";
117
+ readonly chapters: readonly ["1-the-pattern", "2-architecture", "3-product-use-cases"];
118
+ }];
119
+ readonly alsoSee: readonly ["00-overview", "04-auth-identity"];
120
+ readonly prerequisites: readonly [];
121
+ readonly successCriteria: readonly [];
122
+ readonly nextUseCases: readonly [];
123
+ readonly scenarioIds: readonly [];
124
+ readonly guideIds: readonly [];
125
+ readonly troubleshooting: readonly [];
126
+ }, {
127
+ readonly id: "mongo-onboard";
128
+ readonly title: "Onboard with Mongo";
129
+ readonly goal: "Connect Mongo, probe, seed a preset, and validate catalogs for a new appId.";
130
+ readonly audiences: readonly ["developers"];
131
+ readonly tags: readonly ["mongo", "onboarding", "ops"];
132
+ readonly path: readonly [{
133
+ readonly bookId: "02-persistence";
134
+ readonly audience: "developers";
135
+ readonly chapters: readonly ["1-mongo-quick-start", "2-environment"];
136
+ }, {
137
+ readonly bookId: "03-deploy-ops";
138
+ readonly audience: "developers";
139
+ readonly chapters: readonly ["4-onboarding-happy-path"];
140
+ }];
141
+ readonly alsoSee: readonly ["05-cli-toolbox"];
142
+ readonly prerequisites: readonly [];
143
+ readonly successCriteria: readonly [];
144
+ readonly nextUseCases: readonly [];
145
+ readonly scenarioIds: readonly [];
146
+ readonly guideIds: readonly [];
147
+ readonly troubleshooting: readonly [];
148
+ }, {
149
+ readonly id: "auth-context";
150
+ readonly title: "Map host auth to Catalox context";
151
+ readonly goal: "Provide CataloxContext axes correctly and distinguish empty, denied, and misconfigured.";
152
+ readonly audiences: readonly ["developers"];
153
+ readonly tags: readonly ["auth", "identity"];
154
+ readonly path: readonly [{
155
+ readonly bookId: "04-auth-identity";
156
+ readonly audience: "developers";
157
+ readonly chapters: readonly ["1-identity-axes", "2-super-admin", "3-catalog-and-item-visibility", "4-empty-vs-denied"];
158
+ }];
159
+ readonly alsoSee: readonly ["01-content-backend"];
160
+ readonly prerequisites: readonly [];
161
+ readonly successCriteria: readonly [];
162
+ readonly nextUseCases: readonly [];
163
+ readonly scenarioIds: readonly [];
164
+ readonly guideIds: readonly [];
165
+ readonly troubleshooting: readonly [];
166
+ }, {
167
+ readonly id: "cli-seed-items";
168
+ readonly title: "Operate with CLI items and seed";
169
+ readonly goal: "Use elevated CLI access, items commands, and seed manifests safely.";
170
+ readonly audiences: readonly ["developers"];
171
+ readonly tags: readonly ["cli", "seed", "ops"];
172
+ readonly path: readonly [{
173
+ readonly bookId: "05-cli-toolbox";
174
+ readonly audience: "developers";
175
+ readonly chapters: readonly ["1-cli-access", "2-items-commands", "4-seed-workflow"];
176
+ }];
177
+ readonly alsoSee: readonly ["03-deploy-ops"];
178
+ readonly prerequisites: readonly [];
179
+ readonly successCriteria: readonly [];
180
+ readonly nextUseCases: readonly [];
181
+ readonly scenarioIds: readonly [];
182
+ readonly guideIds: readonly [];
183
+ readonly troubleshooting: readonly [];
184
+ }];
185
+ };
186
+ export declare const site: {
187
+ readonly product: "catalox";
188
+ readonly brand: "x12i · catalox";
189
+ readonly brandAccent: "catalox";
190
+ readonly siteUrl: "https://docs.catalox.x12i.com";
191
+ readonly knowledgePackage: "@x12i/catalox-docs";
192
+ readonly footer: "x12i · Catalox";
193
+ readonly accent: "oklch(45% 0.08 230)";
194
+ readonly accentAlt: "oklch(55% 0.12 160)";
195
+ readonly productUrl: "https://github.com/x12i/catalox";
196
+ readonly nav: readonly [{
197
+ readonly label: "Getting started";
198
+ readonly href: "/getting-started";
199
+ }, {
200
+ readonly label: "Use cases";
201
+ readonly href: "/use-cases";
202
+ }, {
203
+ readonly label: "Catalog";
204
+ readonly href: "/catalog";
205
+ }];
206
+ readonly footerLinks: readonly [{
207
+ readonly label: "Docs home";
208
+ readonly href: "/docs";
209
+ }, {
210
+ readonly label: "Getting started";
211
+ readonly href: "/getting-started";
212
+ }, {
213
+ readonly label: "Use cases";
214
+ readonly href: "/use-cases";
215
+ }, {
216
+ readonly label: "Catalog";
217
+ readonly href: "/catalog";
218
+ }, {
219
+ readonly label: "Agents/SDK";
220
+ readonly href: "/agents";
221
+ }, {
222
+ readonly label: "Repo";
223
+ readonly href: "https://github.com/x12i/catalox";
224
+ }];
225
+ };
226
+ export declare const manifest: {
227
+ readonly version: 1;
228
+ readonly product: "catalox";
229
+ readonly site: "https://docs.catalox.x12i.com";
230
+ readonly knowledgePackage: "@x12i/catalox-docs";
231
+ readonly roles: readonly ["developers"];
232
+ readonly books: readonly [{
233
+ readonly id: "00-overview";
234
+ readonly audiences: readonly ["developers"];
235
+ readonly md: {
236
+ readonly developers: "downloads/books/00-overview/developers.md";
237
+ };
238
+ readonly pdf: {
239
+ readonly developers: null;
240
+ };
241
+ readonly chapters: {
242
+ readonly developers: "downloads/books/00-overview/developers.chapters.json";
243
+ };
244
+ }, {
245
+ readonly id: "01-content-backend";
246
+ readonly audiences: readonly ["developers"];
247
+ readonly md: {
248
+ readonly developers: "downloads/books/01-content-backend/developers.md";
249
+ };
250
+ readonly pdf: {
251
+ readonly developers: null;
252
+ };
253
+ readonly chapters: {
254
+ readonly developers: "downloads/books/01-content-backend/developers.chapters.json";
255
+ };
256
+ }, {
257
+ readonly id: "02-persistence";
258
+ readonly audiences: readonly ["developers"];
259
+ readonly md: {
260
+ readonly developers: "downloads/books/02-persistence/developers.md";
261
+ };
262
+ readonly pdf: {
263
+ readonly developers: null;
264
+ };
265
+ readonly chapters: {
266
+ readonly developers: "downloads/books/02-persistence/developers.chapters.json";
267
+ };
268
+ }, {
269
+ readonly id: "03-deploy-ops";
270
+ readonly audiences: readonly ["developers"];
271
+ readonly md: {
272
+ readonly developers: "downloads/books/03-deploy-ops/developers.md";
273
+ };
274
+ readonly pdf: {
275
+ readonly developers: null;
276
+ };
277
+ readonly chapters: {
278
+ readonly developers: "downloads/books/03-deploy-ops/developers.chapters.json";
279
+ };
280
+ }, {
281
+ readonly id: "04-auth-identity";
282
+ readonly audiences: readonly ["developers"];
283
+ readonly md: {
284
+ readonly developers: "downloads/books/04-auth-identity/developers.md";
285
+ };
286
+ readonly pdf: {
287
+ readonly developers: null;
288
+ };
289
+ readonly chapters: {
290
+ readonly developers: "downloads/books/04-auth-identity/developers.chapters.json";
291
+ };
292
+ }, {
293
+ readonly id: "05-cli-toolbox";
294
+ readonly audiences: readonly ["developers"];
295
+ readonly md: {
296
+ readonly developers: "downloads/books/05-cli-toolbox/developers.md";
297
+ };
298
+ readonly pdf: {
299
+ readonly developers: null;
300
+ };
301
+ readonly chapters: {
302
+ readonly developers: "downloads/books/05-cli-toolbox/developers.chapters.json";
303
+ };
304
+ }];
305
+ readonly useCases: readonly [{
306
+ readonly id: "orient-catalox";
307
+ readonly title: "Orient on Catalox";
308
+ readonly md: "downloads/use-cases/orient-catalox.md";
309
+ readonly path: readonly [{
310
+ readonly bookId: "00-overview";
311
+ readonly audience: "developers";
312
+ readonly chapters: readonly ["1-why-catalox-exists", "2-what-catalox-is", "3-fit-vs-misfit"];
313
+ }];
314
+ }, {
315
+ readonly id: "embed-content-backend";
316
+ readonly title: "Embed as content backend";
317
+ readonly md: "downloads/use-cases/embed-content-backend.md";
318
+ readonly path: readonly [{
319
+ readonly bookId: "01-content-backend";
320
+ readonly audience: "developers";
321
+ readonly chapters: readonly ["1-the-pattern", "2-architecture", "3-product-use-cases"];
322
+ }];
323
+ }, {
324
+ readonly id: "mongo-onboard";
325
+ readonly title: "Onboard with Mongo";
326
+ readonly md: "downloads/use-cases/mongo-onboard.md";
327
+ readonly path: readonly [{
328
+ readonly bookId: "02-persistence";
329
+ readonly audience: "developers";
330
+ readonly chapters: readonly ["1-mongo-quick-start", "2-environment"];
331
+ }, {
332
+ readonly bookId: "03-deploy-ops";
333
+ readonly audience: "developers";
334
+ readonly chapters: readonly ["4-onboarding-happy-path"];
335
+ }];
336
+ }, {
337
+ readonly id: "auth-context";
338
+ readonly title: "Map host auth to Catalox context";
339
+ readonly md: "downloads/use-cases/auth-context.md";
340
+ readonly path: readonly [{
341
+ readonly bookId: "04-auth-identity";
342
+ readonly audience: "developers";
343
+ readonly chapters: readonly ["1-identity-axes", "2-super-admin", "3-catalog-and-item-visibility", "4-empty-vs-denied"];
344
+ }];
345
+ }, {
346
+ readonly id: "cli-seed-items";
347
+ readonly title: "Operate with CLI items and seed";
348
+ readonly md: "downloads/use-cases/cli-seed-items.md";
349
+ readonly path: readonly [{
350
+ readonly bookId: "05-cli-toolbox";
351
+ readonly audience: "developers";
352
+ readonly chapters: readonly ["1-cli-access", "2-items-commands", "4-seed-workflow"];
353
+ }];
354
+ }];
355
+ readonly indexes: {
356
+ readonly indexMd: "INDEX.md";
357
+ readonly searchJson: "SEARCH.json";
358
+ };
359
+ readonly concepts: readonly [{
360
+ readonly id: "catalog-as-platform";
361
+ readonly title: "Catalog as platform";
362
+ readonly md: "concepts/catalog-as-platform.md";
363
+ }, {
364
+ readonly id: "mongo-primary";
365
+ readonly title: "MongoDB is primary persistence";
366
+ readonly md: "concepts/mongo-primary.md";
367
+ }];
368
+ readonly guides: readonly [{
369
+ readonly id: "embed-catalox";
370
+ readonly title: "Embed Catalox from env";
371
+ readonly md: "guides/embed-catalox.md";
372
+ }];
373
+ readonly scenarios: readonly [{
374
+ readonly id: "choose-deploy-mode";
375
+ readonly title: "Choose embed vs HTTP service";
376
+ readonly md: "scenarios/choose-deploy-mode.md";
377
+ }];
378
+ readonly decisions: readonly [];
379
+ readonly glossary: readonly [];
380
+ readonly visuals: readonly [];
381
+ readonly diagrams: readonly [];
382
+ readonly relationships: readonly [];
383
+ readonly tutorials: readonly [];
384
+ readonly examples: readonly [];
385
+ readonly sampleData: readonly [];
386
+ readonly uiClients: readonly [];
387
+ readonly apis: readonly [];
388
+ readonly packs: readonly [{
389
+ readonly id: "concept/catalog-as-platform";
390
+ readonly type: "concept";
391
+ readonly path: "packs/concept/catalog-as-platform";
392
+ }, {
393
+ readonly id: "concept/mongo-primary";
394
+ readonly type: "concept";
395
+ readonly path: "packs/concept/mongo-primary";
396
+ }, {
397
+ readonly id: "guide/embed-catalox";
398
+ readonly type: "guide";
399
+ readonly path: "packs/guide/embed-catalox";
400
+ }, {
401
+ readonly id: "scenario/choose-deploy-mode";
402
+ readonly type: "scenario";
403
+ readonly path: "packs/scenario/choose-deploy-mode";
404
+ }];
405
+ };
406
+ export declare const knowledge: {
407
+ readonly concepts: readonly [{
408
+ readonly summary: "Catalox owns governed catalog definitions so product backends do not rebuild catalog plumbing.";
409
+ readonly problem: "Every app reinvents schemas, list/get APIs, admin field metadata, access rules, and agent-readable descriptors.";
410
+ readonly why: "Shared catalogs keep discovery, visibility, and validation consistent across web BFFs and agent runtimes.";
411
+ readonly mentalModel: "Catalox stores the selectable definition; the host stores the transaction, run, or event that uses it.";
412
+ readonly audiences: readonly ["developers"];
413
+ readonly whenItMatters: readonly [];
414
+ readonly whenNotToUse: readonly [];
415
+ readonly prerequisites: readonly [];
416
+ readonly related: readonly ["mongo-primary"];
417
+ readonly next: readonly ["embed-catalox"];
418
+ readonly exampleIds: readonly [];
419
+ readonly commonMistakes: readonly [];
420
+ readonly successCriteria: readonly [];
421
+ readonly invariants: readonly [];
422
+ readonly alternatives: readonly [];
423
+ readonly tags: readonly [];
424
+ readonly id: "catalog-as-platform";
425
+ readonly type: "concept";
426
+ readonly title: "Catalog as platform";
427
+ readonly visualIds: readonly [];
428
+ readonly diagramIds: readonly [];
429
+ readonly referenceIds: readonly [];
430
+ }, {
431
+ readonly summary: "Catalox 6 stores catalogs and items in MongoDB; Firestore operators are migration-only.";
432
+ readonly problem: "Dual-write or Firestore-first assumptions break onboarding and ops scripts.";
433
+ readonly why: "One primary store simplifies estate layout, CLI probes, and production deploys.";
434
+ readonly mentalModel: "createCataloxFromEnv → Mongo collections; R2 is optional object history, not the catalog DB.";
435
+ readonly audiences: readonly ["developers"];
436
+ readonly whenItMatters: readonly [];
437
+ readonly whenNotToUse: readonly [];
438
+ readonly prerequisites: readonly ["catalog-as-platform"];
439
+ readonly related: readonly [];
440
+ readonly next: readonly ["embed-catalox"];
441
+ readonly exampleIds: readonly [];
442
+ readonly commonMistakes: readonly [];
443
+ readonly successCriteria: readonly [];
444
+ readonly invariants: readonly [];
445
+ readonly alternatives: readonly [];
446
+ readonly tags: readonly [];
447
+ readonly id: "mongo-primary";
448
+ readonly type: "concept";
449
+ readonly title: "MongoDB is primary persistence";
450
+ readonly visualIds: readonly [];
451
+ readonly diagramIds: readonly [];
452
+ readonly referenceIds: readonly [];
453
+ }];
454
+ readonly guides: readonly [{
455
+ readonly summary: "Create an in-process Catalox client from environment variables and verify Mongo connectivity.";
456
+ readonly why: "Embedding is the default integration — HTTP service is optional.";
457
+ readonly audiences: readonly ["developers"];
458
+ readonly whenItMatters: readonly [];
459
+ readonly whenNotToUse: readonly [];
460
+ readonly prerequisites: readonly ["catalog-as-platform", "mongo-primary"];
461
+ readonly related: readonly ["choose-deploy-mode"];
462
+ readonly next: readonly [];
463
+ readonly exampleIds: readonly [];
464
+ readonly commonMistakes: readonly [];
465
+ readonly successCriteria: readonly [];
466
+ readonly invariants: readonly ["Mongo is the primary store", "appId selects the catalog tenant, not the cloud project id"];
467
+ readonly alternatives: readonly [];
468
+ readonly confirmationRequired: false;
469
+ readonly tags: readonly [];
470
+ readonly id: "embed-catalox";
471
+ readonly type: "guide";
472
+ readonly title: "Embed Catalox from env";
473
+ readonly useWhen: readonly [];
474
+ readonly doNotUseWhen: readonly [];
475
+ readonly inputs: readonly [];
476
+ readonly permissions: readonly [];
477
+ readonly steps: readonly [];
478
+ readonly verification: readonly [];
479
+ readonly recovery: readonly [];
480
+ readonly tutorialIds: readonly [];
481
+ readonly referenceIds: readonly [];
482
+ readonly scenarioIds: readonly [];
483
+ }];
484
+ readonly scenarios: readonly [{
485
+ readonly summary: "Decide whether to embed Catalox in-process or expose catalox-service.";
486
+ readonly audiences: readonly ["developers"];
487
+ readonly whenItMatters: readonly [];
488
+ readonly whenNotToUse: readonly [];
489
+ readonly prerequisites: readonly [];
490
+ readonly related: readonly [];
491
+ readonly next: readonly [];
492
+ readonly exampleIds: readonly [];
493
+ readonly commonMistakes: readonly [];
494
+ readonly successCriteria: readonly [];
495
+ readonly invariants: readonly ["Same Mongo estate either way", "Authix gates public HTTP; embed still needs host context"];
496
+ readonly alternatives: readonly [];
497
+ readonly tags: readonly [];
498
+ readonly id: "choose-deploy-mode";
499
+ readonly type: "scenario";
500
+ readonly title: "Choose embed vs HTTP service";
501
+ readonly situation: "You are integrating Catalox into a product and must pick embed vs HTTP service.";
502
+ readonly preconditions: readonly [];
503
+ readonly signals: readonly [];
504
+ readonly decisionQuestion: "Should this product embed Catalox or deploy catalox-service?";
505
+ readonly paths: readonly [{
506
+ readonly id: "embed";
507
+ readonly label: "Embed in-process";
508
+ readonly when: "One Node service owns catalog access and host identity.";
509
+ readonly rationale: "Prefer createCataloxFromEnv and CataloxContext inside the BFF.";
510
+ readonly guideIds: readonly ["embed-catalox"];
511
+ }, {
512
+ readonly id: "http-service";
513
+ readonly label: "HTTP service";
514
+ readonly when: "Other runtimes or networks must call Catalox over HTTP.";
515
+ readonly rationale: "Deploy catalox-service against the same Mongo estate; gate public routes with Authix.";
516
+ readonly guideIds: readonly ["embed-catalox"];
517
+ }];
518
+ readonly verification: readonly [];
519
+ readonly recovery: readonly [];
520
+ }];
521
+ readonly decisions: readonly [];
522
+ readonly glossary: readonly [];
523
+ readonly visuals: readonly [];
524
+ readonly diagrams: readonly [];
525
+ readonly relationships: readonly [];
526
+ readonly tutorials: readonly [];
527
+ readonly examples: readonly [];
528
+ readonly sampleData: readonly [];
529
+ readonly uiClients: readonly [];
530
+ readonly apis: readonly [];
531
+ };
532
+ export declare const search: {
533
+ readonly version: 1;
534
+ readonly product: "catalox";
535
+ readonly generatedAt: "2026-07-26T13:09:13.535Z";
536
+ readonly records: readonly [{
537
+ readonly id: "catalog-as-platform";
538
+ readonly type: "concept";
539
+ readonly title: "Catalog as platform";
540
+ readonly summary: "Catalox owns governed catalog definitions so product backends do not rebuild catalog plumbing.";
541
+ readonly aliases: readonly [];
542
+ readonly audiences: readonly ["developers"];
543
+ readonly tags: readonly [];
544
+ readonly goals: readonly [];
545
+ readonly path: "concepts/catalog-as-platform.md";
546
+ readonly webPath: "/concepts/catalog-as-platform";
547
+ readonly prerequisites: readonly [];
548
+ readonly related: readonly ["mongo-primary"];
549
+ readonly packIds: readonly ["concept/catalog-as-platform"];
550
+ }, {
551
+ readonly id: "mongo-primary";
552
+ readonly type: "concept";
553
+ readonly title: "MongoDB is primary persistence";
554
+ readonly summary: "Catalox 6 stores catalogs and items in MongoDB; Firestore operators are migration-only.";
555
+ readonly aliases: readonly [];
556
+ readonly audiences: readonly ["developers"];
557
+ readonly tags: readonly [];
558
+ readonly goals: readonly [];
559
+ readonly path: "concepts/mongo-primary.md";
560
+ readonly webPath: "/concepts/mongo-primary";
561
+ readonly prerequisites: readonly ["catalog-as-platform"];
562
+ readonly related: readonly [];
563
+ readonly packIds: readonly ["concept/mongo-primary"];
564
+ }, {
565
+ readonly id: "embed-catalox";
566
+ readonly type: "guide";
567
+ readonly title: "Embed Catalox from env";
568
+ readonly summary: "Create an in-process Catalox client from environment variables and verify Mongo connectivity.";
569
+ readonly aliases: readonly [];
570
+ readonly audiences: readonly ["developers"];
571
+ readonly tags: readonly [];
572
+ readonly goals: readonly [];
573
+ readonly path: "guides/embed-catalox.md";
574
+ readonly webPath: "/guides/embed-catalox";
575
+ readonly prerequisites: readonly ["catalog-as-platform", "mongo-primary"];
576
+ readonly related: readonly ["choose-deploy-mode"];
577
+ readonly packIds: readonly ["guide/embed-catalox"];
578
+ }, {
579
+ readonly id: "choose-deploy-mode";
580
+ readonly type: "scenario";
581
+ readonly title: "Choose embed vs HTTP service";
582
+ readonly summary: "Decide whether to embed Catalox in-process or expose catalox-service.";
583
+ readonly aliases: readonly [];
584
+ readonly audiences: readonly ["developers"];
585
+ readonly tags: readonly [];
586
+ readonly goals: readonly ["Should this product embed Catalox or deploy catalox-service?"];
587
+ readonly path: "scenarios/choose-deploy-mode.md";
588
+ readonly webPath: "/scenarios/choose-deploy-mode";
589
+ readonly prerequisites: readonly [];
590
+ readonly related: readonly [];
591
+ readonly packIds: readonly ["scenario/choose-deploy-mode"];
592
+ }, {
593
+ readonly id: "orient-catalox";
594
+ readonly type: "use-case";
595
+ readonly title: "Orient on Catalox";
596
+ readonly summary: "Understand why Catalox exists, what it owns, and when not to use it.";
597
+ readonly aliases: readonly [];
598
+ readonly audiences: readonly ["developers"];
599
+ readonly tags: readonly ["platform", "start-here"];
600
+ readonly goals: readonly ["Understand why Catalox exists, what it owns, and when not to use it."];
601
+ readonly path: "use-cases/orient-catalox.md";
602
+ readonly webPath: "/use-cases#orient-catalox";
603
+ readonly prerequisites: readonly [];
604
+ readonly related: readonly ["01-content-backend"];
605
+ readonly packIds: readonly ["use-case/orient-catalox"];
606
+ }, {
607
+ readonly id: "embed-content-backend";
608
+ readonly type: "use-case";
609
+ readonly title: "Embed as content backend";
610
+ readonly summary: "Wire a BFF and agent runtime so humans and agents share one catalog layer.";
611
+ readonly aliases: readonly [];
612
+ readonly audiences: readonly ["developers"];
613
+ readonly tags: readonly ["integration", "bff", "agents"];
614
+ readonly goals: readonly ["Wire a BFF and agent runtime so humans and agents share one catalog layer."];
615
+ readonly path: "use-cases/embed-content-backend.md";
616
+ readonly webPath: "/use-cases#embed-content-backend";
617
+ readonly prerequisites: readonly [];
618
+ readonly related: readonly ["00-overview", "04-auth-identity"];
619
+ readonly packIds: readonly ["use-case/embed-content-backend"];
620
+ }, {
621
+ readonly id: "mongo-onboard";
622
+ readonly type: "use-case";
623
+ readonly title: "Onboard with Mongo";
624
+ readonly summary: "Connect Mongo, probe, seed a preset, and validate catalogs for a new appId.";
625
+ readonly aliases: readonly [];
626
+ readonly audiences: readonly ["developers"];
627
+ readonly tags: readonly ["mongo", "onboarding", "ops"];
628
+ readonly goals: readonly ["Connect Mongo, probe, seed a preset, and validate catalogs for a new appId."];
629
+ readonly path: "use-cases/mongo-onboard.md";
630
+ readonly webPath: "/use-cases#mongo-onboard";
631
+ readonly prerequisites: readonly [];
632
+ readonly related: readonly ["05-cli-toolbox"];
633
+ readonly packIds: readonly ["use-case/mongo-onboard"];
634
+ }, {
635
+ readonly id: "auth-context";
636
+ readonly type: "use-case";
637
+ readonly title: "Map host auth to Catalox context";
638
+ readonly summary: "Provide CataloxContext axes correctly and distinguish empty, denied, and misconfigured.";
639
+ readonly aliases: readonly [];
640
+ readonly audiences: readonly ["developers"];
641
+ readonly tags: readonly ["auth", "identity"];
642
+ readonly goals: readonly ["Provide CataloxContext axes correctly and distinguish empty, denied, and misconfigured."];
643
+ readonly path: "use-cases/auth-context.md";
644
+ readonly webPath: "/use-cases#auth-context";
645
+ readonly prerequisites: readonly [];
646
+ readonly related: readonly ["01-content-backend"];
647
+ readonly packIds: readonly ["use-case/auth-context"];
648
+ }, {
649
+ readonly id: "cli-seed-items";
650
+ readonly type: "use-case";
651
+ readonly title: "Operate with CLI items and seed";
652
+ readonly summary: "Use elevated CLI access, items commands, and seed manifests safely.";
653
+ readonly aliases: readonly [];
654
+ readonly audiences: readonly ["developers"];
655
+ readonly tags: readonly ["cli", "seed", "ops"];
656
+ readonly goals: readonly ["Use elevated CLI access, items commands, and seed manifests safely."];
657
+ readonly path: "use-cases/cli-seed-items.md";
658
+ readonly webPath: "/use-cases#cli-seed-items";
659
+ readonly prerequisites: readonly [];
660
+ readonly related: readonly ["03-deploy-ops"];
661
+ readonly packIds: readonly ["use-case/cli-seed-items"];
662
+ }, {
663
+ readonly id: "00-overview";
664
+ readonly type: "book";
665
+ readonly title: "Overview";
666
+ readonly summary: "Product rationale, what Catalox is and is not, fit vs misfit, and FAQ highlights.";
667
+ readonly aliases: readonly ["CASE FILE · CAT-00"];
668
+ readonly audiences: readonly ["developers"];
669
+ readonly tags: readonly ["platform", "start-here", "overview"];
670
+ readonly goals: readonly [];
671
+ readonly path: "books/00-overview/";
672
+ readonly webPath: "/books/00-overview";
673
+ readonly prerequisites: readonly [];
674
+ readonly related: readonly [];
675
+ readonly packIds: readonly [];
676
+ }, {
677
+ readonly id: "01-content-backend";
678
+ readonly type: "book";
679
+ readonly title: "Content Backend";
680
+ readonly summary: "Recommended integration pattern: BFFs and agent runtimes share Catalox as the content/metadata API.";
681
+ readonly aliases: readonly ["CASE FILE · CAT-01"];
682
+ readonly audiences: readonly ["developers"];
683
+ readonly tags: readonly ["integration", "bff", "agents"];
684
+ readonly goals: readonly [];
685
+ readonly path: "books/01-content-backend/";
686
+ readonly webPath: "/books/01-content-backend";
687
+ readonly prerequisites: readonly [];
688
+ readonly related: readonly [];
689
+ readonly packIds: readonly [];
690
+ }, {
691
+ readonly id: "02-persistence";
692
+ readonly type: "book";
693
+ readonly title: "Persistence";
694
+ readonly summary: "createCataloxFromEnv, collection layout, env vars, and operator notes for Mongo-backed estates.";
695
+ readonly aliases: readonly ["CASE FILE · CAT-02"];
696
+ readonly audiences: readonly ["developers"];
697
+ readonly tags: readonly ["mongo", "storage", "ops"];
698
+ readonly goals: readonly [];
699
+ readonly path: "books/02-persistence/";
700
+ readonly webPath: "/books/02-persistence";
701
+ readonly prerequisites: readonly [];
702
+ readonly related: readonly [];
703
+ readonly packIds: readonly [];
704
+ }, {
705
+ readonly id: "03-deploy-ops";
706
+ readonly type: "book";
707
+ readonly title: "Deploy & Ops";
708
+ readonly summary: "Deployment modes, private vs public HTTP, onboarding happy path, and environment reference.";
709
+ readonly aliases: readonly ["CASE FILE · CAT-03"];
710
+ readonly audiences: readonly ["developers"];
711
+ readonly tags: readonly ["deploy", "http", "onboarding"];
712
+ readonly goals: readonly [];
713
+ readonly path: "books/03-deploy-ops/";
714
+ readonly webPath: "/books/03-deploy-ops";
715
+ readonly prerequisites: readonly [];
716
+ readonly related: readonly [];
717
+ readonly packIds: readonly [];
718
+ }, {
719
+ readonly id: "04-auth-identity";
720
+ readonly type: "book";
721
+ readonly title: "Auth & Identity";
722
+ readonly summary: "Orthogonal identity axes, superAdmin, catalog/item visibility, and empty vs denied vs misconfigured.";
723
+ readonly aliases: readonly ["CASE FILE · CAT-04"];
724
+ readonly audiences: readonly ["developers"];
725
+ readonly tags: readonly ["auth", "identity", "bindings"];
726
+ readonly goals: readonly [];
727
+ readonly path: "books/04-auth-identity/";
728
+ readonly webPath: "/books/04-auth-identity";
729
+ readonly prerequisites: readonly [];
730
+ readonly related: readonly [];
731
+ readonly packIds: readonly [];
732
+ }, {
733
+ readonly id: "05-cli-toolbox";
734
+ readonly type: "book";
735
+ readonly title: "CLI & Toolbox";
736
+ readonly summary: "Elevated CLI access, items CRUD, toolbox diagnostics, and seed workflows.";
737
+ readonly aliases: readonly ["CASE FILE · CAT-05"];
738
+ readonly audiences: readonly ["developers"];
739
+ readonly tags: readonly ["cli", "ops", "seed"];
740
+ readonly goals: readonly [];
741
+ readonly path: "books/05-cli-toolbox/";
742
+ readonly webPath: "/books/05-cli-toolbox";
743
+ readonly prerequisites: readonly [];
744
+ readonly related: readonly [];
745
+ readonly packIds: readonly [];
746
+ }];
747
+ };
748
+ export declare const files: Record<string, string>;
749
+ //# sourceMappingURL=bundle.d.ts.map