superlore-cli 0.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.
- package/LICENSE +202 -0
- package/NOTICE +12 -0
- package/README.md +75 -0
- package/dist/config.d.ts +83 -0
- package/dist/config.js +111 -0
- package/dist/index.d.ts +92 -0
- package/dist/index.js +899 -0
- package/package.json +67 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
superlore-cli
|
|
2
|
+
Copyright 2026 Krishnan S G
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
5
|
+
|
|
6
|
+
This package's distributed build bundles third-party components, which retain
|
|
7
|
+
their own licenses:
|
|
8
|
+
|
|
9
|
+
- cac — MIT
|
|
10
|
+
- @clack/prompts — MIT
|
|
11
|
+
|
|
12
|
+
Each component's full license text is available from its respective repository.
|
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# superlore-cli
|
|
2
|
+
|
|
3
|
+
The command-line interface for [superlore](https://superlore.vercel.app) — **the company knowledge
|
|
4
|
+
base your agents run on.** Scaffold, run, and build an agent-native KB authored in MDX, where
|
|
5
|
+
humans get a clean visual site and agents read the same content over **MCP**.
|
|
6
|
+
|
|
7
|
+
> **One corpus. Humans and agents.**
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# one-liner (detects pnpm / bun / npm)
|
|
13
|
+
curl -fsSL https://superlore.vercel.app/install.sh | sh
|
|
14
|
+
|
|
15
|
+
# or with your package manager
|
|
16
|
+
npm i -g superlore-cli
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Windows (PowerShell): `irm https://superlore.vercel.app/install.ps1 | iex`. Requires Node ≥ 20.
|
|
20
|
+
|
|
21
|
+
## Quick start
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
superlore init my-kb # scaffold a new KB (asks 2 questions, writes superlore.json, seeds pages)
|
|
25
|
+
cd my-kb
|
|
26
|
+
superlore dev # local preview at http://localhost:3000
|
|
27
|
+
superlore build # production build (Next.js — deploy anywhere)
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Or skip the CLI entirely and let an agent do it: install the superlore Claude plugin and say
|
|
31
|
+
_"Make me a docs site using superlore."_ See
|
|
32
|
+
[Getting started](https://superlore.vercel.app/docs/getting-started).
|
|
33
|
+
|
|
34
|
+
## Commands
|
|
35
|
+
|
|
36
|
+
| Command | What it does |
|
|
37
|
+
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
38
|
+
| `superlore init [dir]` | Scaffold a new KB. Flags: `--name`, `--type <company-kb\|product-docs>`, `--auth` / `--no-auth`, `--allowed-domain <domain>`, `--accent <color>`, `--no-mcp`, `-y, --yes`. |
|
|
39
|
+
| `superlore dev` | Run the local site for preview (`--port`). |
|
|
40
|
+
| `superlore build` | Production build of the KB. |
|
|
41
|
+
| `superlore deploy` | Managed deploy via **superlore Cloud** — currently waitlisted; self-host free with `superlore build`. |
|
|
42
|
+
|
|
43
|
+
## `superlore.json`
|
|
44
|
+
|
|
45
|
+
`init` writes a `superlore.json` at your project root — the canonical config the CLI and the
|
|
46
|
+
`superlore` package both read:
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"name": "Acme Knowledge Base",
|
|
51
|
+
"type": "company-kb",
|
|
52
|
+
"accent": "#6D5CF0",
|
|
53
|
+
"auth": { "enabled": true, "provider": "google", "allowedDomain": "acme.com" },
|
|
54
|
+
"mcp": { "enabled": true, "path": "/api/mcp" }
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
- **`type`** — `company-kb` (internal, for your teams + agents) or `product-docs` (public, for
|
|
59
|
+
your users).
|
|
60
|
+
- **`auth`** — optional Google SSO that gates the site **and** the MCP. A company KB without auth
|
|
61
|
+
is warned about before deploy.
|
|
62
|
+
- **`mcp`** — the agent endpoint, on by default at `/api/mcp`.
|
|
63
|
+
|
|
64
|
+
The schema + loader are exported for programmatic use: `import { parseSuperloreJson } from "superlore-cli/config"`.
|
|
65
|
+
|
|
66
|
+
## Links
|
|
67
|
+
|
|
68
|
+
- **Docs:** https://superlore.vercel.app/docs
|
|
69
|
+
- **Core library:** [`superlore`](https://www.npmjs.com/package/superlore)
|
|
70
|
+
- **Repository:** https://github.com/KrishnanSG/superlore
|
|
71
|
+
|
|
72
|
+
## License
|
|
73
|
+
|
|
74
|
+
[Apache-2.0](./LICENSE) © [Krishnan S G](https://github.com/KrishnanSG). See [`NOTICE`](./NOTICE)
|
|
75
|
+
for bundled third-party components.
|
package/dist/config.d.ts
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The canonical `superlore.json` schema — owned by the CLI, importable everywhere.
|
|
3
|
+
*
|
|
4
|
+
* `superlore.json` lives at a superlore project's root and is the single source of truth for what a
|
|
5
|
+
* KB *is*: its name, whether it's a private company KB or public product docs, its brand accent,
|
|
6
|
+
* and how the human gate (auth) and the agent surface (MCP) are configured. The scaffolder writes
|
|
7
|
+
* it; `superlore dev`/`build`/`deploy` read it; skills and other packages import {@link SuperloreJson}
|
|
8
|
+
* to stay in lockstep with the contract.
|
|
9
|
+
*
|
|
10
|
+
* Validation is hand-rolled (no schema dependency) so this module is dependency-free and can be
|
|
11
|
+
* imported from anywhere — including the browser or an edge runtime — without dragging in a
|
|
12
|
+
* validator. Keep it that way.
|
|
13
|
+
*/
|
|
14
|
+
/** The two kinds of superlore KB. Drives defaults (notably the auth warning for company KBs). */
|
|
15
|
+
type SuperloreType = "company-kb" | "product-docs";
|
|
16
|
+
/** Supported SSO providers. Only Google ships today (Auth.js v5 + Google SSO). */
|
|
17
|
+
type SuperloreAuthProvider = "google";
|
|
18
|
+
/** The human gate. Optional and per-deploy — public by default. */
|
|
19
|
+
interface SuperloreAuthConfig {
|
|
20
|
+
/** When true, the site (and, by inheritance, the MCP) is gated. */
|
|
21
|
+
enabled: boolean;
|
|
22
|
+
/** SSO provider for the gate. Defaults to "google" when auth is enabled. */
|
|
23
|
+
provider?: SuperloreAuthProvider;
|
|
24
|
+
/** Restrict sign-in to a single email domain, e.g. "acme.com". */
|
|
25
|
+
allowedDomain?: string;
|
|
26
|
+
}
|
|
27
|
+
/** The agent surface. Enabled by default; served at {@link DEFAULT_MCP_PATH}. */
|
|
28
|
+
interface SuperloreMcpConfig {
|
|
29
|
+
/** When true, the KB exposes an MCP endpoint over its structured index. */
|
|
30
|
+
enabled: boolean;
|
|
31
|
+
/** Route the MCP is served at. Defaults to {@link DEFAULT_MCP_PATH}. */
|
|
32
|
+
path?: string;
|
|
33
|
+
}
|
|
34
|
+
/** The parsed, validated shape of a `superlore.json` file. */
|
|
35
|
+
interface SuperloreJson {
|
|
36
|
+
/** Human-facing KB name. */
|
|
37
|
+
name: string;
|
|
38
|
+
/** Whether this is a private company KB or public product docs. */
|
|
39
|
+
type: SuperloreType;
|
|
40
|
+
/** Brand accent — any CSS colour. superlore derives the rest of the family (light + dark). */
|
|
41
|
+
accent?: string;
|
|
42
|
+
/** The human gate. Omitted ⇒ public. */
|
|
43
|
+
auth?: SuperloreAuthConfig;
|
|
44
|
+
/** The agent surface. Omitted ⇒ MCP enabled at the default path. */
|
|
45
|
+
mcp?: SuperloreMcpConfig;
|
|
46
|
+
}
|
|
47
|
+
/** The default MCP route, matching the reference deploy (`apps/docs`). */
|
|
48
|
+
declare const DEFAULT_MCP_PATH = "/api/mcp";
|
|
49
|
+
/** The canonical config filename written at a project root. */
|
|
50
|
+
declare const SUPERLORE_JSON_FILENAME = "superlore.json";
|
|
51
|
+
/** Every valid {@link SuperloreType}, for prompts and validation. */
|
|
52
|
+
declare const SUPERLORE_TYPES: readonly SuperloreType[];
|
|
53
|
+
/** A validation failure, with the dotted path to the offending field. */
|
|
54
|
+
interface SuperloreJsonIssue {
|
|
55
|
+
/** Dotted field path, e.g. "auth.provider". */
|
|
56
|
+
path: string;
|
|
57
|
+
/** Human-readable problem. */
|
|
58
|
+
message: string;
|
|
59
|
+
}
|
|
60
|
+
/** Result of {@link validateSuperloreJson} / {@link parseSuperloreJson}. */
|
|
61
|
+
type SuperloreJsonResult = {
|
|
62
|
+
ok: true;
|
|
63
|
+
value: SuperloreJson;
|
|
64
|
+
} | {
|
|
65
|
+
ok: false;
|
|
66
|
+
issues: SuperloreJsonIssue[];
|
|
67
|
+
};
|
|
68
|
+
/**
|
|
69
|
+
* Validate an already-parsed value against the `superlore.json` contract, applying defaults.
|
|
70
|
+
*
|
|
71
|
+
* Defaults applied on success: when `mcp` is present and enabled but has no `path`, it is set to
|
|
72
|
+
* {@link DEFAULT_MCP_PATH}; when `auth` is present and enabled but has no `provider`, it is set to
|
|
73
|
+
* "google". Returns a discriminated result rather than throwing, so callers can render every issue.
|
|
74
|
+
*/
|
|
75
|
+
declare function validateSuperloreJson(input: unknown): SuperloreJsonResult;
|
|
76
|
+
/** Parse a `superlore.json` string and validate it. Surfaces JSON syntax errors as an issue. */
|
|
77
|
+
declare function parseSuperloreJson(raw: string): SuperloreJsonResult;
|
|
78
|
+
/** Serialize a {@link SuperloreJson} to the canonical, pretty-printed file body (trailing newline). */
|
|
79
|
+
declare function serializeSuperloreJson(config: SuperloreJson): string;
|
|
80
|
+
/** Resolve the MCP path for a config, falling back to the default when enabled and unset. */
|
|
81
|
+
declare function resolveMcpPath(config: SuperloreJson): string | undefined;
|
|
82
|
+
|
|
83
|
+
export { DEFAULT_MCP_PATH, SUPERLORE_JSON_FILENAME, SUPERLORE_TYPES, type SuperloreAuthConfig, type SuperloreAuthProvider, type SuperloreJson, type SuperloreJsonIssue, type SuperloreJsonResult, type SuperloreMcpConfig, type SuperloreType, parseSuperloreJson, resolveMcpPath, serializeSuperloreJson, validateSuperloreJson };
|
package/dist/config.js
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
// src/config.ts
|
|
2
|
+
var DEFAULT_MCP_PATH = "/api/mcp";
|
|
3
|
+
var SUPERLORE_JSON_FILENAME = "superlore.json";
|
|
4
|
+
var SUPERLORE_TYPES = ["company-kb", "product-docs"];
|
|
5
|
+
function isRecord(value) {
|
|
6
|
+
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
7
|
+
}
|
|
8
|
+
function validateSuperloreJson(input) {
|
|
9
|
+
const issues = [];
|
|
10
|
+
if (!isRecord(input)) {
|
|
11
|
+
return { ok: false, issues: [{ path: "", message: "must be a JSON object" }] };
|
|
12
|
+
}
|
|
13
|
+
const name = input.name;
|
|
14
|
+
if (typeof name !== "string" || name.trim().length === 0) {
|
|
15
|
+
issues.push({ path: "name", message: "is required and must be a non-empty string" });
|
|
16
|
+
}
|
|
17
|
+
const type = input.type;
|
|
18
|
+
if (typeof type !== "string" || !SUPERLORE_TYPES.includes(type)) {
|
|
19
|
+
issues.push({
|
|
20
|
+
path: "type",
|
|
21
|
+
message: `is required and must be one of ${SUPERLORE_TYPES.map((t) => `"${t}"`).join(" | ")}`
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
const accent = input.accent;
|
|
25
|
+
if (accent !== void 0 && (typeof accent !== "string" || accent.trim().length === 0)) {
|
|
26
|
+
issues.push({ path: "accent", message: "must be a non-empty string (a CSS colour)" });
|
|
27
|
+
}
|
|
28
|
+
let auth;
|
|
29
|
+
if (input.auth !== void 0) {
|
|
30
|
+
if (!isRecord(input.auth)) {
|
|
31
|
+
issues.push({ path: "auth", message: "must be an object" });
|
|
32
|
+
} else {
|
|
33
|
+
const a = input.auth;
|
|
34
|
+
if (typeof a.enabled !== "boolean") {
|
|
35
|
+
issues.push({ path: "auth.enabled", message: "is required and must be a boolean" });
|
|
36
|
+
}
|
|
37
|
+
if (a.provider !== void 0 && a.provider !== "google") {
|
|
38
|
+
issues.push({ path: "auth.provider", message: 'must be "google"' });
|
|
39
|
+
}
|
|
40
|
+
if (a.allowedDomain !== void 0 && (typeof a.allowedDomain !== "string" || a.allowedDomain.trim().length === 0)) {
|
|
41
|
+
issues.push({ path: "auth.allowedDomain", message: "must be a non-empty string" });
|
|
42
|
+
}
|
|
43
|
+
if (typeof a.enabled === "boolean") {
|
|
44
|
+
auth = {
|
|
45
|
+
enabled: a.enabled,
|
|
46
|
+
// Default the provider to Google when the gate is on.
|
|
47
|
+
provider: a.provider ?? (a.enabled ? "google" : void 0),
|
|
48
|
+
allowedDomain: typeof a.allowedDomain === "string" ? a.allowedDomain : void 0
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
let mcp;
|
|
54
|
+
if (input.mcp !== void 0) {
|
|
55
|
+
if (!isRecord(input.mcp)) {
|
|
56
|
+
issues.push({ path: "mcp", message: "must be an object" });
|
|
57
|
+
} else {
|
|
58
|
+
const m = input.mcp;
|
|
59
|
+
if (typeof m.enabled !== "boolean") {
|
|
60
|
+
issues.push({ path: "mcp.enabled", message: "is required and must be a boolean" });
|
|
61
|
+
}
|
|
62
|
+
if (m.path !== void 0 && (typeof m.path !== "string" || !m.path.startsWith("/"))) {
|
|
63
|
+
issues.push({ path: "mcp.path", message: 'must be a string starting with "/"' });
|
|
64
|
+
}
|
|
65
|
+
if (typeof m.enabled === "boolean") {
|
|
66
|
+
mcp = {
|
|
67
|
+
enabled: m.enabled,
|
|
68
|
+
path: typeof m.path === "string" ? m.path : m.enabled ? DEFAULT_MCP_PATH : void 0
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
if (issues.length > 0) {
|
|
74
|
+
return { ok: false, issues };
|
|
75
|
+
}
|
|
76
|
+
const value = {
|
|
77
|
+
name: name.trim(),
|
|
78
|
+
type
|
|
79
|
+
};
|
|
80
|
+
if (typeof accent === "string") value.accent = accent.trim();
|
|
81
|
+
if (auth) value.auth = auth;
|
|
82
|
+
if (mcp) value.mcp = mcp;
|
|
83
|
+
return { ok: true, value };
|
|
84
|
+
}
|
|
85
|
+
function parseSuperloreJson(raw) {
|
|
86
|
+
let data;
|
|
87
|
+
try {
|
|
88
|
+
data = JSON.parse(raw);
|
|
89
|
+
} catch (error) {
|
|
90
|
+
const message = error instanceof Error ? error.message : "invalid JSON";
|
|
91
|
+
return { ok: false, issues: [{ path: "", message: `not valid JSON: ${message}` }] };
|
|
92
|
+
}
|
|
93
|
+
return validateSuperloreJson(data);
|
|
94
|
+
}
|
|
95
|
+
function serializeSuperloreJson(config) {
|
|
96
|
+
return `${JSON.stringify(config, null, 2)}
|
|
97
|
+
`;
|
|
98
|
+
}
|
|
99
|
+
function resolveMcpPath(config) {
|
|
100
|
+
if (!config.mcp || !config.mcp.enabled) return void 0;
|
|
101
|
+
return config.mcp.path ?? DEFAULT_MCP_PATH;
|
|
102
|
+
}
|
|
103
|
+
export {
|
|
104
|
+
DEFAULT_MCP_PATH,
|
|
105
|
+
SUPERLORE_JSON_FILENAME,
|
|
106
|
+
SUPERLORE_TYPES,
|
|
107
|
+
parseSuperloreJson,
|
|
108
|
+
resolveMcpPath,
|
|
109
|
+
serializeSuperloreJson,
|
|
110
|
+
validateSuperloreJson
|
|
111
|
+
};
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import * as cac from 'cac';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* The canonical `superlore.json` schema — owned by the CLI, importable everywhere.
|
|
5
|
+
*
|
|
6
|
+
* `superlore.json` lives at a superlore project's root and is the single source of truth for what a
|
|
7
|
+
* KB *is*: its name, whether it's a private company KB or public product docs, its brand accent,
|
|
8
|
+
* and how the human gate (auth) and the agent surface (MCP) are configured. The scaffolder writes
|
|
9
|
+
* it; `superlore dev`/`build`/`deploy` read it; skills and other packages import {@link SuperloreJson}
|
|
10
|
+
* to stay in lockstep with the contract.
|
|
11
|
+
*
|
|
12
|
+
* Validation is hand-rolled (no schema dependency) so this module is dependency-free and can be
|
|
13
|
+
* imported from anywhere — including the browser or an edge runtime — without dragging in a
|
|
14
|
+
* validator. Keep it that way.
|
|
15
|
+
*/
|
|
16
|
+
/** The two kinds of superlore KB. Drives defaults (notably the auth warning for company KBs). */
|
|
17
|
+
type SuperloreType = "company-kb" | "product-docs";
|
|
18
|
+
/** Supported SSO providers. Only Google ships today (Auth.js v5 + Google SSO). */
|
|
19
|
+
type SuperloreAuthProvider = "google";
|
|
20
|
+
/** The human gate. Optional and per-deploy — public by default. */
|
|
21
|
+
interface SuperloreAuthConfig {
|
|
22
|
+
/** When true, the site (and, by inheritance, the MCP) is gated. */
|
|
23
|
+
enabled: boolean;
|
|
24
|
+
/** SSO provider for the gate. Defaults to "google" when auth is enabled. */
|
|
25
|
+
provider?: SuperloreAuthProvider;
|
|
26
|
+
/** Restrict sign-in to a single email domain, e.g. "acme.com". */
|
|
27
|
+
allowedDomain?: string;
|
|
28
|
+
}
|
|
29
|
+
/** The agent surface. Enabled by default; served at {@link DEFAULT_MCP_PATH}. */
|
|
30
|
+
interface SuperloreMcpConfig {
|
|
31
|
+
/** When true, the KB exposes an MCP endpoint over its structured index. */
|
|
32
|
+
enabled: boolean;
|
|
33
|
+
/** Route the MCP is served at. Defaults to {@link DEFAULT_MCP_PATH}. */
|
|
34
|
+
path?: string;
|
|
35
|
+
}
|
|
36
|
+
/** The parsed, validated shape of a `superlore.json` file. */
|
|
37
|
+
interface SuperloreJson {
|
|
38
|
+
/** Human-facing KB name. */
|
|
39
|
+
name: string;
|
|
40
|
+
/** Whether this is a private company KB or public product docs. */
|
|
41
|
+
type: SuperloreType;
|
|
42
|
+
/** Brand accent — any CSS colour. superlore derives the rest of the family (light + dark). */
|
|
43
|
+
accent?: string;
|
|
44
|
+
/** The human gate. Omitted ⇒ public. */
|
|
45
|
+
auth?: SuperloreAuthConfig;
|
|
46
|
+
/** The agent surface. Omitted ⇒ MCP enabled at the default path. */
|
|
47
|
+
mcp?: SuperloreMcpConfig;
|
|
48
|
+
}
|
|
49
|
+
/** The default MCP route, matching the reference deploy (`apps/docs`). */
|
|
50
|
+
declare const DEFAULT_MCP_PATH = "/api/mcp";
|
|
51
|
+
/** The canonical config filename written at a project root. */
|
|
52
|
+
declare const SUPERLORE_JSON_FILENAME = "superlore.json";
|
|
53
|
+
/** Every valid {@link SuperloreType}, for prompts and validation. */
|
|
54
|
+
declare const SUPERLORE_TYPES: readonly SuperloreType[];
|
|
55
|
+
/** A validation failure, with the dotted path to the offending field. */
|
|
56
|
+
interface SuperloreJsonIssue {
|
|
57
|
+
/** Dotted field path, e.g. "auth.provider". */
|
|
58
|
+
path: string;
|
|
59
|
+
/** Human-readable problem. */
|
|
60
|
+
message: string;
|
|
61
|
+
}
|
|
62
|
+
/** Result of {@link validateSuperloreJson} / {@link parseSuperloreJson}. */
|
|
63
|
+
type SuperloreJsonResult = {
|
|
64
|
+
ok: true;
|
|
65
|
+
value: SuperloreJson;
|
|
66
|
+
} | {
|
|
67
|
+
ok: false;
|
|
68
|
+
issues: SuperloreJsonIssue[];
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* Validate an already-parsed value against the `superlore.json` contract, applying defaults.
|
|
72
|
+
*
|
|
73
|
+
* Defaults applied on success: when `mcp` is present and enabled but has no `path`, it is set to
|
|
74
|
+
* {@link DEFAULT_MCP_PATH}; when `auth` is present and enabled but has no `provider`, it is set to
|
|
75
|
+
* "google". Returns a discriminated result rather than throwing, so callers can render every issue.
|
|
76
|
+
*/
|
|
77
|
+
declare function validateSuperloreJson(input: unknown): SuperloreJsonResult;
|
|
78
|
+
/** Parse a `superlore.json` string and validate it. Surfaces JSON syntax errors as an issue. */
|
|
79
|
+
declare function parseSuperloreJson(raw: string): SuperloreJsonResult;
|
|
80
|
+
/** Serialize a {@link SuperloreJson} to the canonical, pretty-printed file body (trailing newline). */
|
|
81
|
+
declare function serializeSuperloreJson(config: SuperloreJson): string;
|
|
82
|
+
/** Resolve the MCP path for a config, falling back to the default when enabled and unset. */
|
|
83
|
+
declare function resolveMcpPath(config: SuperloreJson): string | undefined;
|
|
84
|
+
|
|
85
|
+
/** The CLI version, kept in sync with package.json at build time. */
|
|
86
|
+
declare const VERSION = "0.1.0";
|
|
87
|
+
/** Build the argument parser. Exported for tests; `run()` wires it to argv. */
|
|
88
|
+
declare function buildCli(argv?: readonly string[]): cac.CAC;
|
|
89
|
+
/** Parse argv and dispatch. Reports unknown commands and unexpected errors cleanly. */
|
|
90
|
+
declare function run(argv?: readonly string[]): Promise<void>;
|
|
91
|
+
|
|
92
|
+
export { DEFAULT_MCP_PATH, SUPERLORE_JSON_FILENAME, SUPERLORE_TYPES, type SuperloreAuthConfig, type SuperloreAuthProvider, type SuperloreJson, type SuperloreJsonIssue, type SuperloreJsonResult, type SuperloreMcpConfig, type SuperloreType, VERSION, buildCli, parseSuperloreJson, resolveMcpPath, run, serializeSuperloreJson, validateSuperloreJson };
|