@scalar/cli 2.8.0 → 2.10.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 +281 -65
- package/chunks/action-4GZI2M5B.js +62 -0
- package/chunks/action-4W5GUGEG.js +63 -0
- package/chunks/{action-FCAYFPVR.js → action-5LF4XYHX.js} +10 -7
- package/chunks/{action-XIUO64C7.js → action-5N3P43MD.js} +17 -12
- package/chunks/{action-Y7OUGD56.js → action-5RL4NWUZ.js} +17 -17
- package/chunks/{action-LXGXKXZZ.js → action-657A4K2D.js} +16 -16
- package/chunks/{action-EOAVVL52.js → action-7XOHYWYM.js} +11 -14
- package/chunks/{action-AQRPFQKI.js → action-CABLS46Q.js} +9 -7
- package/chunks/{action-F7A2K74G.js → action-CB55NWAU.js} +9 -13
- package/chunks/{action-5SK5NE7E.js → action-DKDRAIKV.js} +11 -14
- package/chunks/{action-7PEQXDWT.js → action-DTEO4YNX.js} +127 -20
- package/chunks/{action-UIKH4SZX.js → action-EAUTQ77U.js} +27 -23
- package/chunks/{action-YLF2G4G5.js → action-FBRY5JKU.js} +16 -16
- package/chunks/{action-VOFDW3U2.js → action-GFLRD7LO.js} +6 -5
- package/chunks/{action-GWXLHL2Z.js → action-GWYYTUTM.js} +4 -3
- package/chunks/{action-6BYGBXRC.js → action-HT42NUUX.js} +27 -22
- package/chunks/action-JEYDBB3P.js +147 -0
- package/chunks/{action-LLH4QPXM.js → action-KDUFU7TZ.js} +11 -13
- package/chunks/{action-W3C53GPH.js → action-LYCNT3KA.js} +29 -10
- package/chunks/{action-CA4QYPI6.js → action-OJ2NK25F.js} +4 -8
- package/chunks/{action-NVI5DWFP.js → action-PAM2EZ22.js} +4 -8
- package/chunks/action-PPTFYZWD.js +1552 -0
- package/chunks/{action-43YBNBDR.js → action-R4PGILN4.js} +28 -24
- package/chunks/{action-QQZLPI42.js → action-TOBU74JH.js} +23 -19
- package/chunks/action-U2L5DCFG.js +91 -0
- package/chunks/{action-H6OUJWWM.js → action-UUL6SWV4.js} +11 -14
- package/chunks/{action-354TUG4H.js → action-X7BA7PQQ.js} +10 -8
- package/chunks/{action-WFDNRA7D.js → action-XLE37MZL.js} +16 -16
- package/chunks/{action-Y6NXJQ4H.js → action-XOADBXSX.js} +16 -12
- package/chunks/{action-LEUD5P2U.js → action-YSVTZVKV.js} +36 -17
- package/chunks/{action-YRX6SN5F.js → action-ZFI77WA5.js} +8 -6
- package/chunks/{action-HT2DJ34Z.js → action-ZKA3RR3S.js} +15 -11
- package/chunks/{actions-OGIVBQC7.js → actions-3SAMH7A5.js} +41 -17
- package/chunks/{agent-ASPV3R5U.js → agent-2ESZI7NO.js} +7 -5
- package/chunks/{asyncapi-QNFKXHEI.js → asyncapi-4HGVM3PR.js} +14 -10
- package/chunks/{build.action-NM6CAE5F.js → build.action-VBGFGACM.js} +19 -17
- package/chunks/chunk-35Z7VTJT.js +453 -0
- package/chunks/chunk-36LXIJIZ.js +52 -0
- package/chunks/{chunk-KKRGBXCE.js → chunk-43WALAW3.js} +248 -103
- package/chunks/{chunk-C2KAWRIX.js → chunk-5ENKYZA4.js} +1 -1
- package/chunks/{chunk-GTV2BVXV.js → chunk-5SMP756H.js} +2 -2
- package/chunks/{chunk-5JLVQVKO.js → chunk-6M7TL2G2.js} +146 -148
- package/chunks/chunk-6PSYZO3U.js +24 -0
- package/chunks/{chunk-EXY3ZTV4.js → chunk-ATNTXKMS.js} +36 -274
- package/chunks/{chunk-PH3WFNXJ.js → chunk-BIMLCGKS.js} +1 -1
- package/chunks/{chunk-HGOD6THU.js → chunk-CWVYOXXM.js} +2 -19
- package/chunks/chunk-DFOZG7ZV.js +15 -0
- package/chunks/chunk-DHZW7Q7U.js +133 -0
- package/chunks/{chunk-R5LK6VPY.js → chunk-G4HRW2FZ.js} +13 -20
- package/chunks/{chunk-KCCFN4F7.js → chunk-GLWTVLKM.js} +29 -29
- package/chunks/{chunk-5UHLAJQD.js → chunk-GYRQPDTK.js} +24 -10
- package/chunks/chunk-H467HDVV.js +24 -0
- package/chunks/chunk-IPZP3VRA.js +327 -0
- package/chunks/{chunk-2OCWX42S.js → chunk-JXGF5EHC.js} +152 -18
- package/chunks/chunk-K2HIB5BA.js +92 -0
- package/chunks/{chunk-FDC2IESH.js → chunk-KHF2QXBG.js} +1352 -8327
- package/chunks/{chunk-IMG35UXX.js → chunk-KZNRQVMY.js} +1 -1
- package/chunks/{chunk-OJ2EWIJH.js → chunk-MC4EMNOR.js} +5 -1
- package/chunks/{chunk-YILQODZF.js → chunk-MMWSCTDB.js} +7 -4
- package/chunks/{chunk-6XWCMJDB.js → chunk-MNNGUUKJ.js} +12 -11
- package/chunks/chunk-NAC63XJF.js +10 -0
- package/chunks/{chunk-XXSQUBXS.js → chunk-UDBSV3CK.js} +107 -453
- package/chunks/{chunk-IKT5F47M.js → chunk-VVRUSQCY.js} +11 -11
- package/chunks/{chunk-BPGFSSUH.js → chunk-VYFGRLVQ.js} +1 -1
- package/chunks/{chunk-UXJ753NV.js → chunk-WB6PWTMU.js} +5 -13
- package/chunks/{chunk-5DEU2DVL.js → chunk-WDIWLXLV.js} +3 -15
- package/chunks/{chunk-6YPQGVF4.js → chunk-WIEXQUTD.js} +1 -1
- package/chunks/{chunk-W24BETFG.js → chunk-XAGJJNQW.js} +3 -3
- package/chunks/{chunk-22HYZ7LE.js → chunk-ZGNDXPLU.js} +3 -3
- package/chunks/{chunk-XEDGMZJD.js → chunk-ZGVZU6L2.js} +81 -25
- package/chunks/{chunk-L3UXDCBI.js → chunk-ZKJPLWRJ.js} +2 -2
- package/chunks/{chunk-MLSZVVTT.js → chunk-ZYBLQ5CT.js} +13 -7
- package/chunks/{create.action-FUQ2BVJA.js → create.action-DBNIS665.js} +19 -17
- package/chunks/{delete.action-BTDFH7WY.js → delete.action-GBOZC45K.js} +19 -17
- package/chunks/{delete.action-47E66R3I.js → delete.action-K7BLK7DK.js} +19 -17
- package/chunks/{get.action-XC7KC2JO.js → get.action-N3JOY3OU.js} +17 -12
- package/chunks/get.action-QHKMYZBK.js +91 -0
- package/chunks/{list.action-LXKEUYKO.js → list.action-6SSO3JVN.js} +45 -15
- package/chunks/{list.action-OFGLMRE7.js → list.action-TJCS6UEY.js} +39 -19
- package/chunks/{publish.action-OS27XOX4.js → publish.action-T24VHRMR.js} +27 -22
- package/chunks/query-WKATAJJ6.js +129 -0
- package/chunks/scripts-VIBLGKYG.js +102 -0
- package/chunks/{update.action-ZMS4CQ3T.js → update.action-OGYNBXRU.js} +23 -18
- package/chunks/{update.action-AEIBLCWD.js → update.action-VOE6PH5F.js} +23 -18
- package/docs.html +941 -209
- package/index.js +374 -182
- package/package.json +14 -13
- package/skills/scalar-cli/SKILL.md +7 -1
- package/template.md +148 -26
- package/chunks/action-JAHFRYWZ.js +0 -423
- package/chunks/action-KTYOCA2V.js +0 -229
- package/chunks/chunk-K74E42RV.js +0 -7311
- package/chunks/chunk-QVQ4PNVL.js +0 -610
|
@@ -8,132 +8,18 @@ import {
|
|
|
8
8
|
scalarSet,
|
|
9
9
|
slugSchema,
|
|
10
10
|
timestampSchema
|
|
11
|
-
} from "./chunk-
|
|
11
|
+
} from "./chunk-VVRUSQCY.js";
|
|
12
12
|
|
|
13
13
|
// ../../packages/entities/dist/project/active-deployment.js
|
|
14
14
|
var activeDeploymentSchema = external_exports.object({
|
|
15
15
|
/** uid of the publish record for the last successful deployment */
|
|
16
|
-
uid: external_exports.string(),
|
|
16
|
+
uid: external_exports.string().meta({ examples: ["UakgbKJ5m9gl0JDMbcJqL"] }),
|
|
17
17
|
/** subdomain or custom domain */
|
|
18
|
-
domain: external_exports.string(),
|
|
18
|
+
domain: external_exports.string().meta({ examples: ["docs.example.com"] }),
|
|
19
19
|
/** timestamp of the last successful deployment */
|
|
20
20
|
publishedAt: timestampSchema
|
|
21
21
|
}).meta({ id: "active-deployment" });
|
|
22
22
|
|
|
23
|
-
// ../../packages/entities/dist/project/icon.js
|
|
24
|
-
var projectIconDefinitionSchema = external_exports.object({
|
|
25
|
-
/** Key to local icon OR URL to hosted icon */
|
|
26
|
-
src: external_exports.string().default(""),
|
|
27
|
-
/** Image alt or svg title */
|
|
28
|
-
title: external_exports.string().optional(),
|
|
29
|
-
/** Mask a non-svg image */
|
|
30
|
-
mask: external_exports.boolean().optional(),
|
|
31
|
-
/** Search and group tags */
|
|
32
|
-
tags: external_exports.string().array().default([]),
|
|
33
|
-
/** Sorting group in list */
|
|
34
|
-
group: external_exports.string().default("")
|
|
35
|
-
}).meta({ id: "project-icon-definition" });
|
|
36
|
-
var customProjectIconSchema = projectIconDefinitionSchema.extend({
|
|
37
|
-
/** Timestamp for when the icon was uploaded */
|
|
38
|
-
createdAt: timestampSchema,
|
|
39
|
-
/** User ID who uploaded the icon */
|
|
40
|
-
uploadedBy: external_exports.string(),
|
|
41
|
-
/** Always a custom icon */
|
|
42
|
-
group: external_exports.literal("custom")
|
|
43
|
-
}).meta({ id: "custom-project-icon" });
|
|
44
|
-
var projectIconInfoSchema = external_exports.object({
|
|
45
|
-
src: external_exports.string().default(""),
|
|
46
|
-
title: external_exports.string().optional(),
|
|
47
|
-
mask: external_exports.boolean().optional()
|
|
48
|
-
}).meta({ id: "project-icon-info" });
|
|
49
|
-
var projectIconSchema = external_exports.preprocess((arg) => {
|
|
50
|
-
if (!arg)
|
|
51
|
-
return arg;
|
|
52
|
-
if (!arg.src)
|
|
53
|
-
arg.src = arg.local || arg.remote;
|
|
54
|
-
if (arg.local)
|
|
55
|
-
arg.group = "solid";
|
|
56
|
-
if (arg.remote)
|
|
57
|
-
arg.group = "custom";
|
|
58
|
-
return arg;
|
|
59
|
-
}, projectIconInfoSchema).meta({ id: "project-icon" });
|
|
60
|
-
|
|
61
|
-
// ../../packages/entities/dist/project/version/sidebar.js
|
|
62
|
-
var SidebarType;
|
|
63
|
-
(function(SidebarType2) {
|
|
64
|
-
SidebarType2["Page"] = "Page";
|
|
65
|
-
SidebarType2["Folder"] = "Folder";
|
|
66
|
-
SidebarType2["Link"] = "Link";
|
|
67
|
-
})(SidebarType || (SidebarType = {}));
|
|
68
|
-
var baseSidebarItemSchema = external_exports.object({
|
|
69
|
-
uid: nanoidSchema,
|
|
70
|
-
title: external_exports.string().trim().min(1),
|
|
71
|
-
type: external_exports.enum(SidebarType),
|
|
72
|
-
link: external_exports.string().optional(),
|
|
73
|
-
icon: projectIconSchema.optional(),
|
|
74
|
-
children: external_exports.string().array().optional(),
|
|
75
|
-
description: external_exports.string().optional(),
|
|
76
|
-
show: external_exports.boolean()
|
|
77
|
-
}).meta({ id: "base-sidebar-item" });
|
|
78
|
-
var linkSchema = baseSidebarItemSchema.extend({
|
|
79
|
-
title: external_exports.preprocess((arg) => arg?.trim() || "Link", external_exports.string().trim().min(1)),
|
|
80
|
-
link: external_exports.string(),
|
|
81
|
-
type: external_exports.literal(SidebarType.Link)
|
|
82
|
-
}).meta({ id: "sidebar-link" });
|
|
83
|
-
var pageSchema = baseSidebarItemSchema.extend({
|
|
84
|
-
title: external_exports.preprocess((arg) => arg?.trim() || "Page", external_exports.string().trim().min(1)),
|
|
85
|
-
sidebarTitle: external_exports.string().optional(),
|
|
86
|
-
description: external_exports.string(),
|
|
87
|
-
children: external_exports.string().array().default([]),
|
|
88
|
-
type: external_exports.literal(SidebarType.Page),
|
|
89
|
-
defaultOpen: external_exports.boolean().optional(),
|
|
90
|
-
yjsReference: external_exports.string(),
|
|
91
|
-
backgroundImage: external_exports.string().optional(),
|
|
92
|
-
icon: projectIconSchema.optional(),
|
|
93
|
-
/**
|
|
94
|
-
* Automatically set during sync builds when we map markdown and mdx files to pages
|
|
95
|
-
*
|
|
96
|
-
* Used by the Vue builds to determine how to render a given page item.
|
|
97
|
-
*/
|
|
98
|
-
isMdx: external_exports.boolean().default(false),
|
|
99
|
-
/**
|
|
100
|
-
* Automatically set during sync builds when we map HTML files to pages.
|
|
101
|
-
*/
|
|
102
|
-
isHtml: external_exports.boolean().default(false)
|
|
103
|
-
}).meta({ id: "sidebar-page" });
|
|
104
|
-
var defaultPage = () => ({
|
|
105
|
-
uid: nanoid(),
|
|
106
|
-
title: "Getting Started",
|
|
107
|
-
type: SidebarType.Page,
|
|
108
|
-
description: "Start writing your API Documentation with our platform",
|
|
109
|
-
children: [],
|
|
110
|
-
show: true,
|
|
111
|
-
yjsReference: nanoid(),
|
|
112
|
-
isMdx: false,
|
|
113
|
-
isHtml: false
|
|
114
|
-
});
|
|
115
|
-
var folderSchema = baseSidebarItemSchema.extend({
|
|
116
|
-
title: external_exports.preprocess((arg) => arg?.trim() || "Folder", external_exports.string().trim().min(1)),
|
|
117
|
-
children: external_exports.string().array().default([]),
|
|
118
|
-
type: external_exports.literal(SidebarType.Folder),
|
|
119
|
-
defaultOpen: external_exports.boolean().optional()
|
|
120
|
-
}).meta({ id: "sidebar-folder" });
|
|
121
|
-
var sidebarItemSchema = external_exports.union([linkSchema, pageSchema, folderSchema]).meta({ id: "sidebar-item" });
|
|
122
|
-
var sidebarSchema = external_exports.object({
|
|
123
|
-
/** Complete record of ALL sidebar items */
|
|
124
|
-
items: external_exports.record(external_exports.string(), sidebarItemSchema),
|
|
125
|
-
/** Ordered list of the direct children */
|
|
126
|
-
children: external_exports.string().array()
|
|
127
|
-
}).overwrite((val) => {
|
|
128
|
-
const hasPage = Object.values(val.items).some((item) => item.type === SidebarType.Page);
|
|
129
|
-
if (!hasPage) {
|
|
130
|
-
const firstPage = defaultPage();
|
|
131
|
-
val.items[firstPage.uid] = firstPage;
|
|
132
|
-
val.children.push(firstPage.uid);
|
|
133
|
-
}
|
|
134
|
-
return val;
|
|
135
|
-
}).meta({ id: "sidebar" });
|
|
136
|
-
|
|
137
23
|
// ../../packages/entities/dist/project/footer.js
|
|
138
24
|
var defaultFooter = `<footer>
|
|
139
25
|
<div class="footer-content">
|
|
@@ -332,6 +218,120 @@ function getHeaderLinks({ guides, references, header }) {
|
|
|
332
218
|
return complete;
|
|
333
219
|
}
|
|
334
220
|
|
|
221
|
+
// ../../packages/entities/dist/project/icon.js
|
|
222
|
+
var projectIconDefinitionSchema = external_exports.object({
|
|
223
|
+
/** Key to local icon OR URL to hosted icon */
|
|
224
|
+
src: external_exports.string().default(""),
|
|
225
|
+
/** Image alt or svg title */
|
|
226
|
+
title: external_exports.string().optional(),
|
|
227
|
+
/** Mask a non-svg image */
|
|
228
|
+
mask: external_exports.boolean().optional(),
|
|
229
|
+
/** Search and group tags */
|
|
230
|
+
tags: external_exports.string().array().default([]),
|
|
231
|
+
/** Sorting group in list */
|
|
232
|
+
group: external_exports.string().default("")
|
|
233
|
+
}).meta({ id: "project-icon-definition" });
|
|
234
|
+
var customProjectIconSchema = projectIconDefinitionSchema.extend({
|
|
235
|
+
/** Timestamp for when the icon was uploaded */
|
|
236
|
+
createdAt: timestampSchema,
|
|
237
|
+
/** User ID who uploaded the icon */
|
|
238
|
+
uploadedBy: external_exports.string(),
|
|
239
|
+
/** Always a custom icon */
|
|
240
|
+
group: external_exports.literal("custom")
|
|
241
|
+
}).meta({ id: "custom-project-icon" });
|
|
242
|
+
var projectIconInfoSchema = external_exports.object({
|
|
243
|
+
src: external_exports.string().default(""),
|
|
244
|
+
title: external_exports.string().optional(),
|
|
245
|
+
mask: external_exports.boolean().optional()
|
|
246
|
+
}).meta({ id: "project-icon-info" });
|
|
247
|
+
var projectIconSchema = external_exports.preprocess((arg) => {
|
|
248
|
+
if (!arg)
|
|
249
|
+
return arg;
|
|
250
|
+
if (!arg.src)
|
|
251
|
+
arg.src = arg.local || arg.remote;
|
|
252
|
+
if (arg.local)
|
|
253
|
+
arg.group = "solid";
|
|
254
|
+
if (arg.remote)
|
|
255
|
+
arg.group = "custom";
|
|
256
|
+
return arg;
|
|
257
|
+
}, projectIconInfoSchema).meta({ id: "project-icon" });
|
|
258
|
+
|
|
259
|
+
// ../../packages/entities/dist/project/version/sidebar.js
|
|
260
|
+
var SidebarType;
|
|
261
|
+
(function(SidebarType2) {
|
|
262
|
+
SidebarType2["Page"] = "Page";
|
|
263
|
+
SidebarType2["Folder"] = "Folder";
|
|
264
|
+
SidebarType2["Link"] = "Link";
|
|
265
|
+
})(SidebarType || (SidebarType = {}));
|
|
266
|
+
var baseSidebarItemSchema = external_exports.object({
|
|
267
|
+
uid: nanoidSchema,
|
|
268
|
+
title: external_exports.string().trim().min(1),
|
|
269
|
+
type: external_exports.enum(SidebarType),
|
|
270
|
+
link: external_exports.string().optional(),
|
|
271
|
+
icon: projectIconSchema.optional(),
|
|
272
|
+
children: external_exports.string().array().optional(),
|
|
273
|
+
description: external_exports.string().optional(),
|
|
274
|
+
show: external_exports.boolean()
|
|
275
|
+
}).meta({ id: "base-sidebar-item" });
|
|
276
|
+
var linkSchema = baseSidebarItemSchema.extend({
|
|
277
|
+
title: external_exports.preprocess((arg) => arg?.trim() || "Link", external_exports.string().trim().min(1)),
|
|
278
|
+
link: external_exports.string(),
|
|
279
|
+
type: external_exports.literal(SidebarType.Link)
|
|
280
|
+
}).meta({ id: "sidebar-link" });
|
|
281
|
+
var pageSchema = baseSidebarItemSchema.extend({
|
|
282
|
+
title: external_exports.preprocess((arg) => arg?.trim() || "Page", external_exports.string().trim().min(1)),
|
|
283
|
+
sidebarTitle: external_exports.string().optional(),
|
|
284
|
+
description: external_exports.string(),
|
|
285
|
+
children: external_exports.string().array().default([]),
|
|
286
|
+
type: external_exports.literal(SidebarType.Page),
|
|
287
|
+
defaultOpen: external_exports.boolean().optional(),
|
|
288
|
+
yjsReference: external_exports.string(),
|
|
289
|
+
backgroundImage: external_exports.string().optional(),
|
|
290
|
+
icon: projectIconSchema.optional(),
|
|
291
|
+
/**
|
|
292
|
+
* Automatically set during sync builds when we map markdown and mdx files to pages
|
|
293
|
+
*
|
|
294
|
+
* Used by the Vue builds to determine how to render a given page item.
|
|
295
|
+
*/
|
|
296
|
+
isMdx: external_exports.boolean().default(false),
|
|
297
|
+
/**
|
|
298
|
+
* Automatically set during sync builds when we map HTML files to pages.
|
|
299
|
+
*/
|
|
300
|
+
isHtml: external_exports.boolean().default(false)
|
|
301
|
+
}).meta({ id: "sidebar-page" });
|
|
302
|
+
var defaultPage = () => ({
|
|
303
|
+
uid: nanoid(),
|
|
304
|
+
title: "Getting Started",
|
|
305
|
+
type: SidebarType.Page,
|
|
306
|
+
description: "Start writing your API Documentation with our platform",
|
|
307
|
+
children: [],
|
|
308
|
+
show: true,
|
|
309
|
+
yjsReference: nanoid(),
|
|
310
|
+
isMdx: false,
|
|
311
|
+
isHtml: false
|
|
312
|
+
});
|
|
313
|
+
var folderSchema = baseSidebarItemSchema.extend({
|
|
314
|
+
title: external_exports.preprocess((arg) => arg?.trim() || "Folder", external_exports.string().trim().min(1)),
|
|
315
|
+
children: external_exports.string().array().default([]),
|
|
316
|
+
type: external_exports.literal(SidebarType.Folder),
|
|
317
|
+
defaultOpen: external_exports.boolean().optional()
|
|
318
|
+
}).meta({ id: "sidebar-folder" });
|
|
319
|
+
var sidebarItemSchema = external_exports.union([linkSchema, pageSchema, folderSchema]).meta({ id: "sidebar-item" });
|
|
320
|
+
var sidebarSchema = external_exports.object({
|
|
321
|
+
/** Complete record of ALL sidebar items */
|
|
322
|
+
items: external_exports.record(external_exports.string(), sidebarItemSchema),
|
|
323
|
+
/** Ordered list of the direct children */
|
|
324
|
+
children: external_exports.string().array()
|
|
325
|
+
}).overwrite((val) => {
|
|
326
|
+
const hasPage = Object.values(val.items).some((item) => item.type === SidebarType.Page);
|
|
327
|
+
if (!hasPage) {
|
|
328
|
+
const firstPage = defaultPage();
|
|
329
|
+
val.items[firstPage.uid] = firstPage;
|
|
330
|
+
val.children.push(firstPage.uid);
|
|
331
|
+
}
|
|
332
|
+
return val;
|
|
333
|
+
}).meta({ id: "sidebar" });
|
|
334
|
+
|
|
335
335
|
// ../../packages/entities/dist/project/version/guide.js
|
|
336
336
|
var guideSchema = external_exports.object({
|
|
337
337
|
/** Unique identifier for the guide */
|
|
@@ -498,29 +498,29 @@ var logoSchema = external_exports.object({
|
|
|
498
498
|
}).meta({ id: "logo" });
|
|
499
499
|
var sharedProjectSchema = entitySchema.extend({
|
|
500
500
|
/** Name of the project */
|
|
501
|
-
name: external_exports.string(),
|
|
501
|
+
name: external_exports.string().meta({ examples: ["Acme Documentation"] }),
|
|
502
502
|
/** Record of the last successful deployment */
|
|
503
503
|
activeDeployment: activeDeploymentSchema.nullable().default(null),
|
|
504
504
|
/** Track last published timestamp to allow build interrupts */
|
|
505
505
|
lastPublished: timestampSchema.nullable().default(null),
|
|
506
506
|
/** Uid of the most recent publish record (failed or successful) */
|
|
507
|
-
lastPublishedUid: external_exports.string().nullable().default(null),
|
|
507
|
+
lastPublishedUid: external_exports.string().nullable().default(null).meta({ examples: ["PakgbKJ5m9gl0JDMbcJqL"] }),
|
|
508
508
|
/** Uid of the login portal customization object for private projects */
|
|
509
|
-
loginPortalUid: external_exports.string().default(""),
|
|
509
|
+
loginPortalUid: external_exports.string().default("").meta({ examples: ["LakgbKJ5m9gl0JDMbcJqL"] }),
|
|
510
510
|
/** HTTPS endpoint that enriches signed-in visitors, synced from the site config; empty when unset */
|
|
511
|
-
userInfoHookUrl: external_exports.string().default(""),
|
|
511
|
+
userInfoHookUrl: external_exports.string().default("").meta({ examples: ["https://example.com/hooks/user-info"] }),
|
|
512
512
|
/** Active theme id for the project */
|
|
513
|
-
activeThemeId: external_exports.string().default(""),
|
|
513
|
+
activeThemeId: external_exports.string().default("").meta({ examples: ["TakgbKJ5m9gl0JDMbcJqL"] }),
|
|
514
514
|
/** Typesense id for the project */
|
|
515
|
-
typesenseId: external_exports.number().optional(),
|
|
515
|
+
typesenseId: external_exports.number().optional().meta({ examples: [42] }),
|
|
516
516
|
/** Private projects require a login from a user in an access group */
|
|
517
|
-
isPrivate: external_exports.boolean().default(false),
|
|
517
|
+
isPrivate: external_exports.boolean().default(false).meta({ examples: [false] }),
|
|
518
518
|
/** Toggle AI agent features for the docs project */
|
|
519
|
-
agentEnabled: external_exports.boolean().default(false),
|
|
519
|
+
agentEnabled: external_exports.boolean().default(false).meta({ examples: [true] }),
|
|
520
520
|
/** Toggle analytics tracking for the docs project */
|
|
521
|
-
analyticsEnabled: external_exports.boolean().default(true),
|
|
521
|
+
analyticsEnabled: external_exports.boolean().default(true).meta({ examples: [true] }),
|
|
522
522
|
/** Set of allowed access groups */
|
|
523
|
-
accessGroups: scalarSet(external_exports.set(nanoidSchema).max(50)).default([])
|
|
523
|
+
accessGroups: scalarSet(external_exports.set(nanoidSchema).max(50)).default([]).meta({ examples: [["UakgbKJ5m9gl0JDMbcJqL"]] })
|
|
524
524
|
}).meta({ id: "shared-project" });
|
|
525
525
|
var projectSchema = sharedProjectSchema.extend({
|
|
526
526
|
/** Versions of the project */
|
|
@@ -545,16 +545,16 @@ var projectSchema = sharedProjectSchema.extend({
|
|
|
545
545
|
return project;
|
|
546
546
|
}).meta({ id: "project" });
|
|
547
547
|
var githubProjectRepositorySchema = external_exports.object({
|
|
548
|
-
linkedBy: external_exports.string(),
|
|
549
|
-
id: external_exports.number(),
|
|
550
|
-
name: external_exports.string().min(2),
|
|
551
|
-
configPath: external_exports.string().default(""),
|
|
552
|
-
branch: external_exports.string().default(""),
|
|
553
|
-
publishOnMerge: external_exports.boolean().default(false),
|
|
554
|
-
publishPreviews: external_exports.boolean().default(false),
|
|
555
|
-
prComments: external_exports.boolean().default(false),
|
|
548
|
+
linkedBy: external_exports.string().meta({ examples: ["UakgbKJ5m9gl0JDMbcJqL"] }),
|
|
549
|
+
id: external_exports.number().meta({ examples: [123456789] }),
|
|
550
|
+
name: external_exports.string().min(2).meta({ examples: ["Acme Documentation"] }),
|
|
551
|
+
configPath: external_exports.string().default("").meta({ examples: ["scalar.config.json"] }),
|
|
552
|
+
branch: external_exports.string().default("").meta({ examples: ["main"] }),
|
|
553
|
+
publishOnMerge: external_exports.boolean().default(false).meta({ examples: [true] }),
|
|
554
|
+
publishPreviews: external_exports.boolean().default(false).meta({ examples: [true] }),
|
|
555
|
+
prComments: external_exports.boolean().default(false).meta({ examples: [true] }),
|
|
556
556
|
/** One-time repository expired tracking */
|
|
557
|
-
expired: external_exports.boolean().default(false)
|
|
557
|
+
expired: external_exports.boolean().default(false).meta({ examples: [false] })
|
|
558
558
|
}).meta({ id: "github-project-repository" });
|
|
559
559
|
var githubInstallSchema = external_exports.object({
|
|
560
560
|
id: external_exports.number().int(),
|
|
@@ -574,9 +574,9 @@ var githubInstallSchema = external_exports.object({
|
|
|
574
574
|
var githubProjectSchema = sharedProjectSchema.extend({
|
|
575
575
|
slug: slugSchema,
|
|
576
576
|
/** Last publish status info */
|
|
577
|
-
publishStatus: external_exports.string().default(""),
|
|
577
|
+
publishStatus: external_exports.string().default("").meta({ examples: ["published"] }),
|
|
578
578
|
/** Last publish output message */
|
|
579
|
-
publishMessage: external_exports.string().default(""),
|
|
579
|
+
publishMessage: external_exports.string().default("").meta({ examples: ["Documentation published successfully."] }),
|
|
580
580
|
/**
|
|
581
581
|
*
|
|
582
582
|
* Reference info for the link repository
|
|
@@ -651,9 +651,9 @@ var remoteActivitySchema = external_exports.object({
|
|
|
651
651
|
actorName: external_exports.string().nullable()
|
|
652
652
|
}).meta({ id: "docs-project-remote-activity" });
|
|
653
653
|
var docsProjectSchema = sharedProjectSchema.extend({
|
|
654
|
-
slug: slugSchema,
|
|
655
|
-
publishStatus: external_exports.string().default(""),
|
|
656
|
-
publishMessage: external_exports.string().default(""),
|
|
654
|
+
slug: slugSchema.meta({ examples: ["acme-api"] }),
|
|
655
|
+
publishStatus: external_exports.string().default("").meta({ examples: ["published"] }),
|
|
656
|
+
publishMessage: external_exports.string().default("").meta({ examples: ["Documentation published successfully."] }),
|
|
657
657
|
repository: docsProjectRepositorySchema,
|
|
658
658
|
/**
|
|
659
659
|
* `.catch(undefined)` so a malformed bump degrades to "no signal" instead
|
|
@@ -717,11 +717,11 @@ var publishRecordSchema = entitySchema.extend({
|
|
|
717
717
|
|
|
718
718
|
// ../../packages/entities/dist/theme/index.js
|
|
719
719
|
var themeSchema = external_exports.object({
|
|
720
|
-
uid: nanoidSchema,
|
|
721
|
-
name: external_exports.string(),
|
|
722
|
-
description: external_exports.string(),
|
|
723
|
-
theme: external_exports.string(),
|
|
724
|
-
slug: slugSchema
|
|
720
|
+
uid: nanoidSchema.meta({ examples: ["UakgbKJ5m9gl0JDMbcJqL"] }),
|
|
721
|
+
name: external_exports.string().meta({ examples: ["Acme Theme"] }),
|
|
722
|
+
description: external_exports.string().meta({ examples: ["Custom colors for Acme documentation."] }),
|
|
723
|
+
theme: external_exports.string().meta({ examples: [":root { --scalar-color-1: #1f2937; }"] }),
|
|
724
|
+
slug: slugSchema.meta({ examples: ["acme-theme"] })
|
|
725
725
|
}).meta({ id: "theme" });
|
|
726
726
|
|
|
727
727
|
// ../../packages/entities/dist/project/signup.js
|
|
@@ -736,9 +736,7 @@ var signupDataSchema = external_exports.object({
|
|
|
736
736
|
export {
|
|
737
737
|
activeDeploymentSchema,
|
|
738
738
|
customProjectIconSchema,
|
|
739
|
-
SidebarType,
|
|
740
739
|
sharedProjectSchema,
|
|
741
|
-
projectSchema,
|
|
742
740
|
githubInstallSchema,
|
|
743
741
|
githubProjectSchema,
|
|
744
742
|
docsProjectSchema,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
|
|
2
|
+
|
|
3
|
+
// src/domains/project/project-details.ts
|
|
4
|
+
function projectDetails(project) {
|
|
5
|
+
const repository = project.repository;
|
|
6
|
+
const provider = repository && "provider" in repository ? repository.provider : repository ? "github" : "unlinked";
|
|
7
|
+
return {
|
|
8
|
+
uid: project.uid,
|
|
9
|
+
name: project.name,
|
|
10
|
+
slug: project.slug,
|
|
11
|
+
provider,
|
|
12
|
+
isPrivate: project.isPrivate,
|
|
13
|
+
repository: repository ? {
|
|
14
|
+
name: "forgejoOwner" in repository ? `${repository.forgejoOwner}/${repository.forgejoRepo}` : repository.name,
|
|
15
|
+
branch: repository.branch,
|
|
16
|
+
configPath: repository.configPath
|
|
17
|
+
} : null,
|
|
18
|
+
activeDeployment: project.activeDeployment
|
|
19
|
+
};
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export {
|
|
23
|
+
projectDetails
|
|
24
|
+
};
|