@scalar/cli 2.8.0 → 2.11.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.
Files changed (111) hide show
  1. package/README.md +84 -1076
  2. package/chunks/action-25QMCP5G.js +122 -0
  3. package/chunks/{action-354TUG4H.js → action-2VF6LODL.js} +20 -16
  4. package/chunks/{action-XIUO64C7.js → action-5I4XDPPG.js} +20 -14
  5. package/chunks/action-6M5PTDF6.js +100 -0
  6. package/chunks/{action-NVI5DWFP.js → action-73ELLN3T.js} +8 -11
  7. package/chunks/{action-Y6NXJQ4H.js → action-7H3AWCHX.js} +21 -16
  8. package/chunks/{action-LLH4QPXM.js → action-BRSLSOE5.js} +19 -18
  9. package/chunks/{action-EOAVVL52.js → action-CQQCKSNS.js} +17 -22
  10. package/chunks/action-D5QWDNQ2.js +65 -0
  11. package/chunks/{action-Y7OUGD56.js → action-DQDHBOLJ.js} +34 -31
  12. package/chunks/{action-5SK5NE7E.js → action-EYPYQQVM.js} +18 -23
  13. package/chunks/{action-YRX6SN5F.js → action-FMA5ECUA.js} +12 -10
  14. package/chunks/{action-7PEQXDWT.js → action-GXDJLF2G.js} +134 -25
  15. package/chunks/action-HUICEXJZ.js +75 -0
  16. package/chunks/action-IH6G77C5.js +38 -0
  17. package/chunks/{action-H3RTILLM.js → action-IIQMZVRJ.js} +1 -1
  18. package/chunks/action-IQM54ITT.js +164 -0
  19. package/chunks/{action-UIKH4SZX.js → action-J5TO3UJW.js} +32 -26
  20. package/chunks/{action-H6OUJWWM.js → action-KC3ZCNDR.js} +17 -22
  21. package/chunks/{action-6BYGBXRC.js → action-L7TMS3Q3.js} +44 -37
  22. package/chunks/{action-GWXLHL2Z.js → action-LAAHRDSR.js} +5 -4
  23. package/chunks/{action-FCAYFPVR.js → action-LR75GHBA.js} +14 -11
  24. package/chunks/action-MJMLQFLT.js +1552 -0
  25. package/chunks/action-NHU4CUKT.js +130 -0
  26. package/chunks/action-NKTFNFU7.js +64 -0
  27. package/chunks/{action-F7A2K74G.js → action-NMW5WPD2.js} +12 -16
  28. package/chunks/{action-VOFDW3U2.js → action-OTPXODUE.js} +8 -7
  29. package/chunks/{action-43YBNBDR.js → action-RPCDNGCI.js} +54 -39
  30. package/chunks/{action-QQZLPI42.js → action-RQCXSJPZ.js} +55 -27
  31. package/chunks/action-SOYSVG67.js +147 -0
  32. package/chunks/action-Y7EBKCUU.js +16 -0
  33. package/chunks/{action-WFDNRA7D.js → action-YN4TE7TG.js} +24 -23
  34. package/chunks/{action-AQRPFQKI.js → action-ZGNVWTHZ.js} +14 -12
  35. package/chunks/action-ZKKRPLDK.js +64 -0
  36. package/chunks/{action-HT2DJ34Z.js → action-ZUZL7R3H.js} +20 -15
  37. package/chunks/{actions-OGIVBQC7.js → actions-S6K76HCW.js} +46 -19
  38. package/chunks/{agent-ASPV3R5U.js → agent-IRNEV4K5.js} +46 -9
  39. package/chunks/{asyncapi-QNFKXHEI.js → asyncapi-WQPIQMEZ.js} +15 -10
  40. package/chunks/{build.action-NM6CAE5F.js → build.action-CLBVKFWD.js} +28 -24
  41. package/chunks/chunk-25XERWCE.js +1058 -0
  42. package/chunks/chunk-3RIUDHLG.js +467 -0
  43. package/chunks/{chunk-MLSZVVTT.js → chunk-3TFOA64C.js} +19 -8
  44. package/chunks/{chunk-HGOD6THU.js → chunk-4JKXZ5CF.js} +12 -25
  45. package/chunks/{chunk-C2KAWRIX.js → chunk-5ENKYZA4.js} +1 -1
  46. package/chunks/{chunk-W24BETFG.js → chunk-5L7V7RCH.js} +10 -10
  47. package/chunks/chunk-6PSYZO3U.js +24 -0
  48. package/chunks/{chunk-IMG35UXX.js → chunk-ALYM4ZB2.js} +1 -1
  49. package/chunks/chunk-AVZFSWPD.js +37 -0
  50. package/chunks/{chunk-5UHLAJQD.js → chunk-BQYVSPAI.js} +36 -10
  51. package/chunks/{chunk-XXSQUBXS.js → chunk-CSSTCHHF.js} +6212 -4642
  52. package/chunks/chunk-DFOZG7ZV.js +15 -0
  53. package/chunks/{chunk-22HYZ7LE.js → chunk-DQD2753S.js} +3 -3
  54. package/chunks/{action-F2ZJNURT.js → chunk-EBNFCIKS.js} +7 -10
  55. package/chunks/{chunk-EXY3ZTV4.js → chunk-F3OPMYME.js} +143 -301
  56. package/chunks/{chunk-FDC2IESH.js → chunk-FG5AOTDN.js} +8519 -14702
  57. package/chunks/chunk-GKCVATQJ.js +92 -0
  58. package/chunks/{chunk-PH3WFNXJ.js → chunk-GMHIK5K2.js} +1 -1
  59. package/chunks/{chunk-GTV2BVXV.js → chunk-GYR5E6RB.js} +2 -2
  60. package/chunks/{chunk-OJ2EWIJH.js → chunk-HZN6IIPZ.js} +11 -6
  61. package/chunks/{chunk-IKT5F47M.js → chunk-I57ID5K7.js} +24 -11
  62. package/chunks/{chunk-BPGFSSUH.js → chunk-KOD2HX5I.js} +1 -1
  63. package/chunks/{chunk-L3UXDCBI.js → chunk-LOLVJNI5.js} +4 -4
  64. package/chunks/{chunk-KCCFN4F7.js → chunk-MN2AFJXM.js} +36 -29
  65. package/chunks/{chunk-UXJ753NV.js → chunk-N5CJ5MTY.js} +5 -13
  66. package/chunks/chunk-NAC63XJF.js +10 -0
  67. package/chunks/{chunk-2OCWX42S.js → chunk-NWJ37GI2.js} +166 -22
  68. package/chunks/{chunk-3ZJYGGAA.js → chunk-ORCUZITN.js} +1 -1
  69. package/chunks/chunk-QMLRYD76.js +24 -0
  70. package/chunks/{chunk-KKRGBXCE.js → chunk-SEURG74P.js} +303 -209
  71. package/chunks/{chunk-R5LK6VPY.js → chunk-SOV4POMS.js} +370 -264
  72. package/chunks/chunk-T34TL6KL.js +222 -0
  73. package/chunks/{chunk-5DEU2DVL.js → chunk-U6VE6JOS.js} +3 -15
  74. package/chunks/{chunk-YILQODZF.js → chunk-UFSFY7Z4.js} +23 -20
  75. package/chunks/{chunk-6YPQGVF4.js → chunk-ULRJZXMS.js} +1 -1
  76. package/chunks/chunk-US54KYOJ.js +131 -0
  77. package/chunks/chunk-V6LUKXBV.js +37 -0
  78. package/chunks/{chunk-5JLVQVKO.js → chunk-VRZSDUZK.js} +190 -152
  79. package/chunks/chunk-VUXPDHTQ.js +22 -0
  80. package/chunks/chunk-XP5UM7SF.js +21 -0
  81. package/chunks/chunk-Y6XGC4K5.js +311 -0
  82. package/chunks/{create.action-FUQ2BVJA.js → create.action-ITEOQ644.js} +34 -30
  83. package/chunks/{delete.action-47E66R3I.js → delete.action-77MFPLUN.js} +30 -26
  84. package/chunks/{delete.action-BTDFH7WY.js → delete.action-C6VX4S5Q.js} +30 -26
  85. package/chunks/{get.action-XC7KC2JO.js → get.action-3BP4FHZC.js} +20 -14
  86. package/chunks/get.action-LNBOWUVE.js +95 -0
  87. package/chunks/list.action-6CRFQPJT.js +156 -0
  88. package/chunks/list.action-KR5YIDR4.js +126 -0
  89. package/chunks/{publish.action-OS27XOX4.js → publish.action-YBORRPBM.js} +49 -42
  90. package/chunks/query-WKATAJJ6.js +129 -0
  91. package/chunks/scripts-6CI6U32J.js +102 -0
  92. package/chunks/{update.action-AEIBLCWD.js → update.action-O7TSXDGV.js} +34 -27
  93. package/chunks/{update.action-ZMS4CQ3T.js → update.action-QZI7M2MV.js} +34 -27
  94. package/index.js +579 -382
  95. package/package.json +15 -14
  96. package/skills/scalar-cli/SKILL.md +52 -46
  97. package/template.md +71 -136
  98. package/chunks/action-CA4QYPI6.js +0 -125
  99. package/chunks/action-JAHFRYWZ.js +0 -423
  100. package/chunks/action-KTYOCA2V.js +0 -229
  101. package/chunks/action-LEUD5P2U.js +0 -92
  102. package/chunks/action-LXGXKXZZ.js +0 -72
  103. package/chunks/action-W3C53GPH.js +0 -54
  104. package/chunks/action-YLF2G4G5.js +0 -37
  105. package/chunks/chunk-6XWCMJDB.js +0 -404
  106. package/chunks/chunk-K74E42RV.js +0 -7311
  107. package/chunks/chunk-QVQ4PNVL.js +0 -610
  108. package/chunks/chunk-XEDGMZJD.js +0 -366
  109. package/chunks/list.action-LXKEUYKO.js +0 -116
  110. package/chunks/list.action-OFGLMRE7.js +0 -95
  111. package/docs.html +0 -6245
@@ -1,9 +1,17 @@
1
1
  import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
+ import {
3
+ SdkLanguage,
4
+ sdkVersionStatusSchema,
5
+ sdkVersionTargetStateSchema
6
+ } from "./chunk-Y6XGC4K5.js";
7
+ import {
8
+ cloudflareHostnameStateSchema
9
+ } from "./chunk-T34TL6KL.js";
2
10
  import {
3
11
  RegistryResourceTypes,
4
12
  baseRegistrySchema,
5
13
  contentShaSchema
6
- } from "./chunk-6XWCMJDB.js";
14
+ } from "./chunk-25XERWCE.js";
7
15
  import {
8
16
  brandedUid,
9
17
  docVersionSchema,
@@ -19,23 +27,184 @@ import {
19
27
  slugSchema,
20
28
  timestampSchema,
21
29
  unixTimestamp
22
- } from "./chunk-IKT5F47M.js";
30
+ } from "./chunk-I57ID5K7.js";
23
31
 
24
32
  // ../../packages/entities/dist/access-group/schema.js
25
33
  var emailDomainRegex = /^([A-Za-z0-9]+(-[A-Za-z0-9]+)*\.)+[A-Za-z]{2,}$/i;
26
- var emailDomainSchema = external_exports.string().regex(emailDomainRegex, "Invalid domain").max(253).meta({ id: "email-domain" });
34
+ var emailDomainSchema = external_exports.string().regex(emailDomainRegex, "Invalid domain").max(253).meta({ id: "email-domain", examples: ["example.com"] });
27
35
  var accessGroupEmails = scalarSet(external_exports.set(emailSchema).max(1e3, "You can only add up to 1000 emails"));
28
36
  var accessGroupDomains = scalarSet(external_exports.set(emailDomainSchema).max(1e3, "You can only add up to 1000 domains"));
29
- var accessGroupNameSchema = external_exports.string().max(40).meta({ id: "access-group-name" });
37
+ var accessGroupNameSchema = external_exports.string().max(40).meta({ id: "access-group-name", examples: ["Engineering"] });
30
38
  var accessGroupSchema = entitySchema.extend({
31
- name: accessGroupNameSchema.default(""),
32
- slug: slugSchema.default(randomAccessGroupSlug).meta({ default: "randomAccessGroupSlug()" }),
39
+ name: accessGroupNameSchema.default("").meta({ examples: ["Engineering"] }),
40
+ slug: slugSchema.default(randomAccessGroupSlug).meta({ default: void 0, examples: ["engineering"] }),
33
41
  /** Set of allowed external email addresses */
34
- allowedEmails: accessGroupEmails.default([]),
42
+ allowedEmails: accessGroupEmails.default([]).meta({ examples: [["alex@example.com"]] }),
35
43
  /** List of allowed email domains */
36
- allowedDomains: accessGroupDomains.default([])
44
+ allowedDomains: accessGroupDomains.default([]).meta({ examples: [["example.com"]] })
37
45
  }).meta({ id: "access-group" });
38
46
 
47
+ // ../../packages/entities/dist/auth/auth-store.js
48
+ var recordSchema = entitySchema.extend({ expiresAt: external_exports.date() });
49
+ var scopesSchema = external_exports.array(external_exports.custom((value) => typeof value === "string"));
50
+ var CONSUMER_METHODS = ["email", "google", "microsoft", "sso"];
51
+ var PLATFORM_METHODS = ["password", "google", "github", "sso"];
52
+ var authIdentitySchema = external_exports.discriminatedUnion("kind", [
53
+ external_exports.object({
54
+ kind: external_exports.literal("consumer"),
55
+ email: external_exports.string(),
56
+ /** `scalar` is a team member's own account: always offered, so no team switch turns it off */
57
+ via: external_exports.enum([...CONSUMER_METHODS, "scalar"]),
58
+ idpUid: external_exports.string().nullish(),
59
+ /** Unix seconds */
60
+ authTime: external_exports.number()
61
+ }),
62
+ external_exports.object({
63
+ kind: external_exports.literal("platform"),
64
+ userUid: external_exports.string(),
65
+ email: external_exports.string(),
66
+ /** `token` is a personal token: not a sign-in, so a team's sign-in policy does not apply to it */
67
+ via: external_exports.enum([...PLATFORM_METHODS, "token"]),
68
+ idpUid: external_exports.string().nullish(),
69
+ authTime: external_exports.number()
70
+ })
71
+ ]);
72
+ var authReaderResourceSchema = external_exports.discriminatedUnion("kind", [
73
+ external_exports.object({ kind: external_exports.literal("project"), uid: external_exports.string() }),
74
+ external_exports.object({ kind: external_exports.literal("registry"), uid: external_exports.string() }),
75
+ external_exports.object({
76
+ kind: external_exports.literal("mcp"),
77
+ /** The MCP server's uid with `environment`, or an installation uuid when `environment` is absent. */
78
+ uid: external_exports.string(),
79
+ /**
80
+ * The environment slug of the server named by `uid`. This is the shape
81
+ * minted today; a resource without it is the legacy installation-uuid
82
+ * shape, which resolves through the legacy address map.
83
+ */
84
+ environment: external_exports.string().nullish(),
85
+ /** The docs project whose host the environment was reached through, whose readers bound the grant too */
86
+ project: external_exports.string().nullish()
87
+ }),
88
+ /** A namespace's own pages, which list what the reader may see */
89
+ external_exports.object({ kind: external_exports.literal("namespace") })
90
+ ]);
91
+ var consumerTargetSchema = external_exports.object({
92
+ kind: external_exports.literal("consumer"),
93
+ /** The namespace a reader's subject is derived in */
94
+ namespace: external_exports.string(),
95
+ teamUid: external_exports.string(),
96
+ resource: authReaderResourceSchema
97
+ });
98
+ var authTargetSchema = external_exports.discriminatedUnion("kind", [
99
+ consumerTargetSchema,
100
+ external_exports.object({ kind: external_exports.literal("platform"), teamUid: external_exports.string() })
101
+ ]);
102
+ var authTargetRequestSchema = external_exports.discriminatedUnion("kind", [
103
+ consumerTargetSchema,
104
+ external_exports.object({ kind: external_exports.literal("platform"), teamUid: external_exports.string().nullish() })
105
+ ]);
106
+ var authClientSnapshotSchema = external_exports.object({
107
+ id: external_exports.string(),
108
+ name: external_exports.string(),
109
+ kind: external_exports.enum([
110
+ /** A constant of ours: `scalar-dashboard`, `scalar-cli`, `scalar-docs` */
111
+ "first-party",
112
+ /** `scalar-local`: a person's own script, loopback redirects only */
113
+ "local",
114
+ /** A Client ID Metadata Document, fetched from the `client_id` URL */
115
+ "metadata",
116
+ /** A stateless registration: the `client_id` is a signed blob */
117
+ "registered"
118
+ ]),
119
+ /** The fact the client did not choose: its metadata or redirect host. Absent for loopback */
120
+ host: external_exports.string().nullish()
121
+ });
122
+ var authGrantSchema = external_exports.object({
123
+ client: authClientSnapshotSchema,
124
+ identity: authIdentitySchema,
125
+ target: authTargetSchema,
126
+ scope: scopesSchema,
127
+ audience: external_exports.array(external_exports.string()),
128
+ issuer: external_exports.string()
129
+ });
130
+ var attemptRequestSchema = external_exports.object({
131
+ client: authClientSnapshotSchema,
132
+ redirectUri: external_exports.string(),
133
+ state: external_exports.string().nullish(),
134
+ codeChallenge: external_exports.string(),
135
+ scope: scopesSchema,
136
+ resource: external_exports.string(),
137
+ issuer: external_exports.string(),
138
+ audience: external_exports.array(external_exports.string()),
139
+ target: authTargetRequestSchema,
140
+ /** The name of what is being signed in to, as resolved from the resource: `@acme`, `docs.acme.com` */
141
+ entity: external_exports.string(),
142
+ /** The resource is a server Scalar does not vouch for, which consent warns of */
143
+ unverified: external_exports.boolean().nullish(),
144
+ /** The login portal that brands a reader's sign-in to the resource */
145
+ portalUid: external_exports.string().nullish(),
146
+ /**
147
+ * What the request's `prompt` asks of the sign-in: `none` answers the
148
+ * client with an error where a page would be shown, `consent` asks even
149
+ * when the approval is remembered
150
+ */
151
+ prompt: external_exports.enum(["none", "consent"]).nullish(),
152
+ /** Set by `prompt=login`: the person must have signed in at or after this time, in Unix seconds */
153
+ authAfter: external_exports.number().nullish()
154
+ });
155
+ var authAttemptSchema = recordSchema.extend({
156
+ ...attemptRequestSchema.shape,
157
+ /** Hash of the secret in the browser's attempt cookie */
158
+ browserHash: external_exports.string()
159
+ });
160
+ var authChallengeSchema = recordSchema.extend({
161
+ /** What the secret proves once presented: an address, a user */
162
+ subject: external_exports.string(),
163
+ consumedAt: external_exports.date().nullable(),
164
+ /**
165
+ * An emailed sign-in link proves the address alone, so it carries the
166
+ * request its attempt was made with: any browser that opens it can sign in
167
+ * to that. The link is refused after `signsInUntil` and kept a while
168
+ * longer, to say that it expired.
169
+ */
170
+ link: external_exports.object({
171
+ attemptId: external_exports.string(),
172
+ request: attemptRequestSchema,
173
+ signsInUntil: external_exports.date()
174
+ }).nullish()
175
+ });
176
+ var authCodeSchema = recordSchema.extend({
177
+ /** Whose it is, as on a family, so a password reset also ends the codes still out */
178
+ subject: external_exports.string(),
179
+ redirectUri: external_exports.string(),
180
+ codeChallenge: external_exports.string(),
181
+ grant: authGrantSchema,
182
+ consumedAt: external_exports.date().nullable(),
183
+ /** The family the code was redeemed into, so a replayed code can end it */
184
+ familyId: external_exports.string().nullish()
185
+ });
186
+ var authFamilySchema = recordSchema.extend({
187
+ grant: authGrantSchema,
188
+ /** Whose it is, for ending all of a person's sessions at once: the user uid of a team member */
189
+ subject: external_exports.string(),
190
+ revokedAt: external_exports.date().nullable()
191
+ });
192
+ var authRefreshTokenSchema = recordSchema.extend({
193
+ familyId: external_exports.string(),
194
+ rotatedAt: external_exports.date().nullable()
195
+ });
196
+ var authSessionSchema = recordSchema.extend({
197
+ platform: authIdentitySchema.nullish(),
198
+ /** The team member's user uid, so a password reset can end the session */
199
+ subject: external_exports.string().nullish(),
200
+ /** By namespace */
201
+ consumers: external_exports.record(external_exports.string(), authIdentitySchema)
202
+ });
203
+ var authConsentSchema = recordSchema.extend({ scope: scopesSchema });
204
+ var authCounterSchema = recordSchema.extend({
205
+ count: external_exports.number().int()
206
+ });
207
+
39
208
  // ../../packages/entities/dist/auth/identity-provider.js
40
209
  var identityProviders = [
41
210
  "local",
@@ -94,12 +263,6 @@ var googleProfileSchema = external_exports.object({
94
263
  picture: external_exports.string().optional(),
95
264
  email_verified: external_exports.boolean()
96
265
  }).meta({ id: "google-profile" });
97
- var githubProfileSchema = external_exports.object({
98
- login: external_exports.string(),
99
- name: external_exports.string().optional().nullable().default(null),
100
- email: emailSchema.optional().nullable().default(null),
101
- avatar_url: external_exports.string().optional().nullable().default(null)
102
- }).meta({ id: "github-profile" });
103
266
  var oauthStateSchema = external_exports.object({
104
267
  uid: external_exports.string(),
105
268
  redirect: external_exports.string(),
@@ -107,36 +270,6 @@ var oauthStateSchema = external_exports.object({
107
270
  teamInvite: external_exports.string().optional(),
108
271
  flow: external_exports.enum(OnboardingFlow).optional()
109
272
  }).meta({ id: "oauth-state" });
110
- var microsoftProfileSchema = external_exports.object({
111
- email: emailSchema,
112
- name: external_exports.string().optional(),
113
- /** Entra tenant id; the consumer tenant means a personal account */
114
- tid: external_exports.string(),
115
- /**
116
- * "Email domain owner verified" optional claim. Entra tenant admins can
117
- * put arbitrary emails on their users (nOAuth), so without this claim a
118
- * work-account email cannot be trusted for allowlist checks.
119
- */
120
- xms_edov: external_exports.union([external_exports.boolean(), external_exports.string()]).optional()
121
- }).meta({ id: "microsoft-profile" });
122
- var hostingOauthResourceSchema = external_exports.enum([
123
- ...RegistryResourceTypes,
124
- "sync-project",
125
- "project",
126
- "publish",
127
- "namespace"
128
- ]).meta({ id: "hosting-oauth-resource" });
129
- var hostingOauthStateSchema = external_exports.object({
130
- uid: nanoidSchema,
131
- resource: external_exports.object({
132
- uid: nanoidSchema,
133
- type: hostingOauthResourceSchema
134
- }),
135
- teamUid: nanoidSchema,
136
- redirect: external_exports.string().optional(),
137
- /** Stamped on the stored record so abandoned states can be vacuumed */
138
- createdAt: external_exports.number().optional()
139
- }).meta({ id: "hosting-oauth-state" });
140
273
 
141
274
  // ../../packages/entities/dist/auth/personal-token.js
142
275
  var personalTokenRecordSchema = external_exports.object({
@@ -153,20 +286,48 @@ var personalTokenRecordSchema = external_exports.object({
153
286
  revoked: external_exports.boolean()
154
287
  }).meta({ id: "personal-token-record" });
155
288
 
289
+ // ../../packages/entities/dist/auth/revocation.js
290
+ var REVOCATION_KINDS = ["fid", "member", "team"];
291
+ var authRevocationSchema = entitySchema.extend({
292
+ kind: external_exports.enum(REVOCATION_KINDS),
293
+ /** fid: the claim itself. member: `<teamUid>:<userUid>`. team: the team uid */
294
+ key: external_exports.string().min(1),
295
+ /** Epoch seconds, compared as `iat <= revokedBefore`. Null for `fid`, where presence revokes */
296
+ revokedBefore: external_exports.number().int().nullable(),
297
+ /** When the last credential this row can refuse has expired, as a Date for the TTL index */
298
+ expiresAt: external_exports.date()
299
+ });
300
+ var epochSchema = external_exports.strictObject({
301
+ key: external_exports.string(),
302
+ revokedBefore: external_exports.number().int()
303
+ });
304
+ var limitsSnapshotSchema = external_exports.strictObject({
305
+ /** Epoch ms on the clock of whoever read the rows, sampled before the read */
306
+ syncedAt: external_exports.number().int().min(0),
307
+ fids: external_exports.array(external_exports.string()),
308
+ members: external_exports.array(epochSchema),
309
+ teams: external_exports.array(epochSchema)
310
+ });
311
+
312
+ // ../../packages/entities/dist/auth/vcs-link-state.js
313
+ var vcsProviderSchema = external_exports.enum(["github", "bitbucket"]);
314
+ var vcsLinkStateSchema = external_exports.object({
315
+ uid: external_exports.string().min(5),
316
+ userUid: brandedUid(),
317
+ provider: vcsProviderSchema,
318
+ expiresAt: external_exports.date()
319
+ }).meta({ id: "vcs-link-state" });
320
+
321
+ // ../../packages/entities/dist/auth/domains.js
322
+ var AuthDomains;
323
+ (function(AuthDomains2) {
324
+ AuthDomains2["Client"] = "client";
325
+ AuthDomains2["Local"] = "local";
326
+ AuthDomains2["Dashboard"] = "dashboard";
327
+ AuthDomains2["Agent"] = "agent";
328
+ })(AuthDomains || (AuthDomains = {}));
329
+
156
330
  // ../../packages/entities/dist/auth/saml-state.js
157
- var samlStateSchema = external_exports.object({
158
- uid: nanoidSchema,
159
- // AuthN request identifier
160
- requestId: external_exports.string(),
161
- // IDP configuration identifier
162
- idpUid: nanoidSchema,
163
- // Random state
164
- relayState: external_exports.string().min(20),
165
- // Redirect after sign in
166
- redirect: external_exports.string().optional(),
167
- // Expiry
168
- expiresAt: external_exports.number()
169
- }).meta({ id: "saml-state" });
170
331
  var ssoResourceSchema = external_exports.enum([
171
332
  ...RegistryResourceTypes,
172
333
  "sync-project",
@@ -199,148 +360,70 @@ var relayStateSchema = external_exports.object({
199
360
  }).optional()
200
361
  }).meta({ id: "relay-state", default: "nanoid()" });
201
362
 
202
- // ../../packages/entities/dist/auth/domains.js
203
- var AuthDomains;
204
- (function(AuthDomains2) {
205
- AuthDomains2["Cli"] = "cli";
206
- AuthDomains2["Client"] = "client";
207
- AuthDomains2["Local"] = "local";
208
- AuthDomains2["Dashboard"] = "dashboard";
209
- AuthDomains2["Agent"] = "agent";
210
- AuthDomains2["Mcp"] = "mcp";
211
- })(AuthDomains || (AuthDomains = {}));
212
-
213
- // ../../packages/entities/dist/publish/publish.js
214
- var headingRecordSchema = external_exports.object({
215
- slug: external_exports.string(),
216
- name: external_exports.string(),
217
- level: external_exports.coerce.number().int(),
218
- uid: nanoidSchema,
219
- parent: external_exports.string().optional(),
220
- isPageTitle: external_exports.boolean().optional()
221
- }).meta({ id: "heading-record" });
222
- var publishAssetSchema = external_exports.object({
223
- path: external_exports.string(),
224
- data: external_exports.string()
225
- }).meta({ id: "publish-asset" });
226
- var typesenseConfigSchema = external_exports.object({
227
- keyId: external_exports.number(),
228
- keyValue: external_exports.string(),
229
- collectionName: external_exports.string()
230
- }).meta({ id: "typesense-config" });
231
-
232
- // ../../packages/entities/dist/deploys/deploy.js
233
- var subpathSchema = external_exports.object({
234
- subpath: external_exports.string(),
235
- projectUid: external_exports.string(),
236
- /**
237
- * The project's own title, for labelling it in cross-project search.
238
- * Written on publish, so it is absent until the project next publishes.
239
- */
240
- name: external_exports.string().optional(),
241
- /**
242
- * The project's active publish, used to cache-bust its search index the
243
- * way a project already busts its own. Absent until it next publishes.
244
- */
245
- publishUid: external_exports.string().optional(),
246
- /**
247
- * Present only for sites still served by Typesense. Builds on the jsonl
248
- * search backend omit it; federated search fetches `${subpath}/search-entries.jsonl`.
249
- */
250
- typesenseConfig: typesenseConfigSchema.optional().nullable()
251
- }).meta({ id: "subpath" });
252
- var cloudflareHttpTokenSchema = external_exports.object({
253
- /** URL path, e.g. `/.well-known/pki-validation/ca3-<id>.txt` */
254
- path: external_exports.string(),
255
- /** Plain-text response body the token path must answer with */
256
- body: external_exports.string()
257
- }).meta({ id: "cloudflare-http-token" });
258
- var cloudflareHostnameStateSchema = external_exports.object({
259
- /** Custom hostname id in the Cloudflare zone */
260
- hostnameId: external_exports.string(),
261
- /** Hostname ownership status reported by Cloudflare (pending, active, …) */
262
- status: external_exports.string(),
263
- /** Certificate status reported by Cloudflare (pending_validation, active, …) */
264
- sslStatus: external_exports.string(),
265
- httpTokens: cloudflareHttpTokenSchema.array().default([]),
266
- /** Unix seconds of the reconciler run that last wrote this state */
267
- syncedAt: external_exports.number()
268
- }).meta({ id: "cloudflare-hostname-state" });
269
- var siteDeploySchema = entitySchema.extend({
270
- domain: external_exports.string(),
271
- teamUid: nanoidSchema,
272
- projectUid: nanoidSchema,
273
- /**
274
- * Title of the project mounted at the domain root.
275
- *
276
- * The root project is deliberately not one of `subpaths` — both request
277
- * matchers resolve by longest path prefix, so a '/' entry would become a
278
- * catch-all that every request matched. It is denormalized here instead so
279
- * search can name and scope it without a second lookup.
280
- */
281
- rootName: external_exports.string().optional(),
282
- subpaths: subpathSchema.array().default([]),
283
- cloudflare: cloudflareHostnameStateSchema.optional().nullable()
284
- }).meta({ id: "site-deploy" });
285
- var searchConfigRootSchema = external_exports.object({
286
- projectUid: external_exports.string(),
287
- name: external_exports.string().optional()
288
- }).meta({ id: "search-config-root" });
289
- var searchConfigResponseSchema = external_exports.object({
290
- subpaths: subpathSchema.array(),
291
- root: searchConfigRootSchema.optional()
292
- }).meta({ id: "search-config-response" });
293
-
294
363
  // ../../packages/entities/dist/login-portals/customization.js
295
364
  var loginPortalEmailSchema = external_exports.object({
296
365
  /** @deprecated No longer rendered in the email template */
297
- logo: external_exports.string().default(""),
366
+ logo: external_exports.string().default("").meta({
367
+ examples: ['<img src="https://example.com/logo.svg" alt="Acme" />']
368
+ }),
298
369
  /** @deprecated No longer rendered in the email template */
299
- logoSize: external_exports.string().default("100"),
300
- buttonText: external_exports.string().max(50).default("Login"),
301
- message: external_exports.string().max(1e3).default("Click to access private documentation hosted by scalar.com"),
302
- title: external_exports.string().max(100).default("Private Docs"),
303
- mainColor: external_exports.string().max(100).default("#2a2f45"),
304
- mainBackground: external_exports.string().max(100).default("#f6f6f6"),
305
- cardColor: external_exports.string().max(100).default("#2a2f45"),
306
- cardBackground: external_exports.string().max(100).default("#fff"),
307
- buttonColor: external_exports.string().max(100).default("#fff"),
308
- buttonBackground: external_exports.string().max(100).default("#0f0f0f")
370
+ logoSize: external_exports.string().default("100").meta({ examples: ["100"] }),
371
+ buttonText: external_exports.string().max(50).default("Login").meta({ examples: ["Access documentation"] }),
372
+ message: external_exports.string().max(1e3).default("Click to access private documentation hosted by scalar.com").meta({ examples: ["Click to access Acme private API documentation."] }),
373
+ title: external_exports.string().max(100).default("Private Docs").meta({ examples: ["Acme API"] }),
374
+ mainColor: external_exports.string().max(100).default("#2a2f45").meta({ examples: ["#1f2937"] }),
375
+ mainBackground: external_exports.string().max(100).default("#f6f6f6").meta({ examples: ["#f9fafb"] }),
376
+ cardColor: external_exports.string().max(100).default("#2a2f45").meta({ examples: ["#1f2937"] }),
377
+ cardBackground: external_exports.string().max(100).default("#fff").meta({ examples: ["#ffffff"] }),
378
+ buttonColor: external_exports.string().max(100).default("#fff").meta({ examples: ["#ffffff"] }),
379
+ buttonBackground: external_exports.string().max(100).default("#0f0f0f").meta({ examples: ["#2563eb"] })
309
380
  }).meta({ id: "login-portal-email" });
310
381
  var loginPortalPageSchema = external_exports.object({
311
382
  /** Title of the page for the HTML Head */
312
- title: external_exports.string().max(100).default("Scalar Private Docs"),
383
+ title: external_exports.string().max(100).default("Scalar Private Docs").meta({ examples: ["Acme API"] }),
313
384
  /** Description of the page for the HTML Head */
314
- description: external_exports.string().max(500).default("Login to access your documentation"),
385
+ description: external_exports.string().max(500).default("Login to access your documentation").meta({
386
+ examples: [
387
+ "Sign in with your work email to access Acme documentation."
388
+ ]
389
+ }),
315
390
  /** Custom HTML for the head of the page */
316
- head: external_exports.string().default(""),
391
+ head: external_exports.string().default("").meta({ examples: ['<meta name="robots" content="noindex" />'] }),
317
392
  /** Script to include in the head of the page */
318
- script: external_exports.string().default(""),
393
+ script: external_exports.string().default("").meta({
394
+ examples: ['document.documentElement.dataset.company = "acme";']
395
+ }),
319
396
  /** UID of the team theme to apply to the page */
320
- theme: external_exports.string().default(""),
397
+ theme: external_exports.string().default("").meta({ examples: ["TakgbKJ5m9gl0JDMbcJqL"] }),
321
398
  /** Company name used in the header */
322
- companyName: external_exports.string().max(100).default(""),
399
+ companyName: external_exports.string().max(100).default("").meta({ examples: ["Acme"] }),
323
400
  /** Logo of the company used in the header as raw SVG/HTML */
324
- logo: external_exports.string().default(""),
401
+ logo: external_exports.string().default("").meta({
402
+ examples: ['<img src="https://example.com/logo.svg" alt="Acme" />']
403
+ }),
325
404
  /** Link that the logo redirects to when clicking */
326
- logoURL: external_exports.string().default(""),
405
+ logoURL: external_exports.string().default("").meta({ examples: ["https://example.com"] }),
327
406
  /** Favicon URL or dataURI */
328
- favicon: external_exports.string().default(""),
407
+ favicon: external_exports.string().default("").meta({ examples: ["https://example.com/favicon.ico"] }),
329
408
  /** Terms link */
330
- termsLink: external_exports.string().default(""),
409
+ termsLink: external_exports.string().default("").meta({ examples: ["https://example.com/terms"] }),
331
410
  /** Privacy link */
332
- privacyLink: external_exports.string().default(""),
411
+ privacyLink: external_exports.string().default("").meta({ examples: ["https://example.com/privacy"] }),
333
412
  /** Title of the form */
334
- formTitle: external_exports.string().max(100).default("Scalar Private Docs"),
413
+ formTitle: external_exports.string().max(100).default("Scalar Private Docs").meta({ examples: ["Sign in to Acme Documentation"] }),
335
414
  /** Description of the form */
336
- formDescription: external_exports.string().max(500).default("Login to access your documentation"),
415
+ formDescription: external_exports.string().max(500).default("Login to access your documentation").meta({
416
+ examples: [
417
+ "Sign in with your work email to access Acme documentation."
418
+ ]
419
+ }),
337
420
  /** Image of the form */
338
- formImage: external_exports.string().default("")
421
+ formImage: external_exports.string().default("").meta({ examples: ["https://example.com/login-banner.png"] })
339
422
  }).meta({ id: "login-portal-page" });
340
423
  var loginPortalSchema = external_exports.object({
341
- uid: nanoidSchema,
342
- title: external_exports.string().max(200),
343
- slug: slugSchema,
424
+ uid: nanoidSchema.meta({ examples: ["UakgbKJ5m9gl0JDMbcJqL"] }),
425
+ title: external_exports.string().max(200).meta({ examples: ["Acme API"] }),
426
+ slug: slugSchema.meta({ examples: ["acme-api"] }),
344
427
  email: loginPortalEmailSchema,
345
428
  page: loginPortalPageSchema
346
429
  }).meta({ id: "login-portal" });
@@ -348,54 +431,38 @@ var loginPortalSchema = external_exports.object({
348
431
  // ../../packages/entities/dist/managed-schema/schema.js
349
432
  var managedSchemaVersion = entitySchema.extend({
350
433
  /** Version identifier (e.g. 0.0.1) for schema */
351
- version: docVersionSchema.default("0.0.1"),
434
+ version: docVersionSchema.default("0.0.1").meta({ examples: ["1.2.0"] }),
352
435
  /**
353
436
  * SHA-256 hex digest of the YAML content the version serves, from its
354
437
  * chain head. Integrity metadata for the YAML serialization, never a
355
438
  * storage key.
356
439
  */
357
- yamlSha: contentShaSchema.optional(),
440
+ yamlSha: contentShaSchema.optional().meta({
441
+ examples: [
442
+ "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789"
443
+ ]
444
+ }),
358
445
  /**
359
446
  * SHA-256 hex digest of the JSON content the version serves, from its
360
447
  * chain head. This is the blob key for both formats, matching the API
361
448
  * document entity.
362
449
  */
363
- jsonSha: contentShaSchema.optional()
450
+ jsonSha: contentShaSchema.optional().meta({
451
+ examples: [
452
+ "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
453
+ ]
454
+ })
364
455
  }).meta({ id: "managed-schema-version" });
365
456
  var managedSchemaFormat = external_exports.enum(["json", "yaml"]).meta({ id: "managed-schema-format" });
366
457
  var managedSchema = baseRegistrySchema.extend({
367
458
  /** Own uid, branded so it cannot be confused with another entity's uid */
368
- uid: brandedUid().default(mintUid).meta({ default: "nanoid()" }),
459
+ uid: brandedUid().default(mintUid).meta({ default: void 0 }),
369
460
  /** The current version served to consumers by default */
370
- version: docVersionSchema.default("0.0.1"),
461
+ version: docVersionSchema.default("0.0.1").meta({ examples: ["1.2.0"] }),
371
462
  /** Default schema format for edit/view */
372
463
  format: managedSchemaFormat.default("json")
373
464
  }).meta({ id: "managed-schema" });
374
465
 
375
- // ../../packages/entities/dist/mcp-server/schema.js
376
- var mcpServerToolStates = ["enabled", "disabled"];
377
- var mcpServerRecordSchema = baseRegistrySchema.extend({
378
- /** Own uid, branded so it cannot be confused with another entity's uid */
379
- uid: brandedUid().default(mintUid).meta({ default: "nanoid()" }),
380
- /** The state a tool starts in when a linked document gains an operation. */
381
- defaultToolState: external_exports.enum(mcpServerToolStates).default("enabled"),
382
- /** A custom domain the server is served from, when one is configured. */
383
- domain: external_exports.string().nullable().default(null),
384
- /**
385
- * The Cloudflare custom hostname behind `domain`, mirrored by the edge
386
- * cache sync. Absent until the sync has provisioned it.
387
- */
388
- cloudflare: cloudflareHostnameStateSchema.optional().nullable(),
389
- /**
390
- * When core last asked the sync to re-read the hostname from Cloudflare,
391
- * in Unix milliseconds. The sync's own refresh schedule ends ten minutes
392
- * after a claim, and core holds no Cloudflare credentials, so a domain
393
- * check that finds the CNAME in place but the certificate not yet active
394
- * stamps this for the sync to pick up.
395
- */
396
- domainRefreshRequestedAt: external_exports.number().nullable().optional()
397
- }).meta({ id: "mcp-server-record" });
398
-
399
466
  // ../../packages/entities/dist/mcp-server/domain.js
400
467
  var mcpDomainStatuses = [
401
468
  "pending",
@@ -475,6 +542,23 @@ var webhookEventClaimRecordSchema = entitySchema.extend({
475
542
  expiresAt: external_exports.date()
476
543
  }).meta({ id: "webhook-event-claim-record" });
477
544
 
545
+ // ../../packages/entities/dist/sdk/version.js
546
+ var sdkVersionRecordSchema = entitySchema.extend({
547
+ /** Own uid, branded so it cannot be confused with another entity's uid */
548
+ uid: brandedUid().default(mintUid).meta({ default: "nanoid()" }),
549
+ version: docVersionSchema,
550
+ /** The exact API version this SDK version was created against. */
551
+ apiVersion: docVersionSchema,
552
+ apiDocumentHash: external_exports.string().nullish(),
553
+ status: sdkVersionStatusSchema,
554
+ publishedAt: timestampSchema.nullish(),
555
+ changeSource: external_exports.enum(["user", "api-version", "created"]).nullish(),
556
+ /** SHA-256 of the config string, naming its blob under the SDK's artifacts. */
557
+ configSha: contentShaSchema,
558
+ languages: external_exports.enum(SdkLanguage).array(),
559
+ targets: external_exports.partialRecord(external_exports.enum(SdkLanguage), sdkVersionTargetStateSchema)
560
+ }).meta({ id: "sdk-version-record" });
561
+
478
562
  // ../../packages/entities/dist/waitlist/index.js
479
563
  var WaitlistProducts;
480
564
  (function(WaitlistProducts2) {
@@ -526,7 +610,13 @@ var webhookSubscriptionSchema = entitySchema.extend({
526
610
  */
527
611
  disabledReason: webhookDisabledReasonSchema.nullable().optional(),
528
612
  /** When the platform disabled it, in unix seconds. Nullable, as above. */
529
- disabledAt: external_exports.number().nullable().optional()
613
+ disabledAt: external_exports.number().nullable().optional(),
614
+ /**
615
+ * The uid of the team secret deliveries are signed with, in the auth
616
+ * secret store. Null for a subscription whose secret is still the local
617
+ * record in `webhook-secrets`, keyed by the subscription uid.
618
+ */
619
+ signingSecretUid: nanoidSchema.nullish()
530
620
  }).meta({ id: "webhook-subscription" });
531
621
  var WEBHOOK_SECRET_KEY_VERSION = 1;
532
622
  var WEBHOOK_SECRET_GRACE_PERIOD_SECONDS = 24 * 60 * 60;
@@ -583,6 +673,12 @@ var webhookDeliverySchema = entitySchema.extend({
583
673
  /** Attempts made so far, across Cloud Tasks retries. */
584
674
  attempts: external_exports.number().int().min(0).default(0),
585
675
  status: webhookDeliveryStatusSchema.default("pending"),
676
+ /**
677
+ * Unix seconds until which the attempt last claimed is being made. A
678
+ * dispatch that arrives while it stands leaves the delivery alone; one
679
+ * that arrives after it takes over an attempt that never settled.
680
+ */
681
+ claimedUntil: external_exports.number().nullable().optional(),
586
682
  /** Unix seconds of the most recent attempt. Nullable for the round-trip reason above. */
587
683
  lastAttemptAt: external_exports.number().nullable().optional(),
588
684
  /** HTTP status the endpoint returned, when it returned one at all. */
@@ -755,9 +851,7 @@ export {
755
851
  accessGroupDomains,
756
852
  accessGroupNameSchema,
757
853
  accessGroupSchema,
758
- identityProviders,
759
854
  identityProviderRecordSchema,
760
- siteDeploySchema,
761
855
  loginPortalSchema,
762
856
  managedSchemaVersion,
763
857
  managedSchema,