@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
@@ -2,16 +2,16 @@ import { createRequire as $$cR } from "node:module"; const require = $$cR(import
2
2
  import {
3
3
  findConfig,
4
4
  parseConfig
5
- } from "./chunk-XXSQUBXS.js";
5
+ } from "./chunk-CSSTCHHF.js";
6
6
  import {
7
7
  ConfigVersion
8
- } from "./chunk-5JLVQVKO.js";
8
+ } from "./chunk-VRZSDUZK.js";
9
9
  import {
10
10
  output
11
11
  } from "./chunk-T5HJUAWB.js";
12
12
  import {
13
13
  external_exports
14
- } from "./chunk-IKT5F47M.js";
14
+ } from "./chunk-I57ID5K7.js";
15
15
 
16
16
  // src/domains/project/check-config/parse-config.ts
17
17
  import fs from "node:fs";
@@ -23,7 +23,7 @@ function readAndParseConfig(configPath) {
23
23
  success: false,
24
24
  error: {
25
25
  type: "file-not-found",
26
- message: "Could not find the Scalar Configuration file",
26
+ message: "Could not find the Scalar configuration file",
27
27
  inputPath: configPath
28
28
  }
29
29
  };
@@ -36,7 +36,7 @@ function readAndParseConfig(configPath) {
36
36
  success: false,
37
37
  error: {
38
38
  type: "validation-error",
39
- message: "The given Scalar Configuration is invalid",
39
+ message: "Scalar configuration is invalid",
40
40
  filePath: file,
41
41
  prettyError: external_exports.prettifyError(parseConfigResult.error),
42
42
  version: parseConfigResult.version
@@ -47,7 +47,7 @@ function readAndParseConfig(configPath) {
47
47
  success: false,
48
48
  error: {
49
49
  type: "parse-error",
50
- message: "Could not parse the Scalar Configuration file",
50
+ message: "Could not parse the Scalar configuration file",
51
51
  filePath: file,
52
52
  detail: typeof parseConfigResult.error === "string" ? parseConfigResult.error : parseConfigResult.error instanceof Error ? parseConfigResult.error.message : void 0
53
53
  }
@@ -65,20 +65,20 @@ function readAndParseConfig(configPath) {
65
65
  import as from "ansis";
66
66
  function renderConfigError(error) {
67
67
  if (error.type === "file-not-found") {
68
- return output.error().title("Scalar Configuration file not found").message(error.inputPath).line(
68
+ return output.error().title("Scalar configuration file not found").message(error.inputPath).line(
69
69
  as.grey(
70
70
  "Create a `scalar.config.json`, or pass the path to your configuration file as an argument."
71
71
  )
72
72
  ).exit("error");
73
73
  }
74
74
  if (error.type === "parse-error") {
75
- const block2 = output.error().title("Invalid configuration file").message("Could not parse the Scalar Configuration file:").line(error.filePath);
75
+ const block2 = output.error().title("Invalid configuration file").message("Could not parse the Scalar configuration file:").line(error.filePath);
76
76
  if (error.detail) {
77
77
  block2.message(error.detail);
78
78
  }
79
79
  return block2.exit("error");
80
80
  }
81
- const block = output.error().title("The given Scalar Configuration is invalid").message(error.filePath);
81
+ const block = output.error().title("Scalar configuration is invalid").message(error.filePath);
82
82
  const note = versionNote(error.version);
83
83
  if (note) {
84
84
  block.line(note);
@@ -91,7 +91,7 @@ function renderConfigError(error) {
91
91
  }
92
92
  function versionNote(version) {
93
93
  if (version === ConfigVersion.V2) {
94
- return as.grey("Validated as Scalar Configuration v2.0.0.");
94
+ return as.grey("Validated as Scalar configuration v2.0.0.");
95
95
  }
96
96
  if (version === ConfigVersion.V1) {
97
97
  return as.grey(
@@ -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
+ };
@@ -2,7 +2,7 @@ import { createRequire as $$cR } from "node:module"; const require = $$cR(import
2
2
  import {
3
3
  getPublishPreviewUrl,
4
4
  getPublishUrl
5
- } from "./chunk-YILQODZF.js";
5
+ } from "./chunk-UFSFY7Z4.js";
6
6
 
7
7
  // src/domains/project/publish/url.ts
8
8
  function getPublishDeploymentUrl(publish) {
@@ -0,0 +1,37 @@
1
+ import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
+ import {
3
+ external_exports
4
+ } from "./chunk-I57ID5K7.js";
5
+
6
+ // ../../packages/entities/dist/environment/schema.js
7
+ var DEFAULT_ENVIRONMENT = "production";
8
+ var RESERVED_ENVIRONMENT_SLUGS = ["latest", "all"];
9
+ var ENVIRONMENT_SLUG_PATTERN = /^[a-z][a-z0-9-]{0,62}[a-z0-9]$/;
10
+ var MAX_TEAM_ENVIRONMENTS = 20;
11
+ var environmentSlugSchema = external_exports.string().regex(ENVIRONMENT_SLUG_PATTERN, {
12
+ message: "Environment slugs are 2 to 64 lowercase letters, digits or hyphens, starting with a letter and ending with a letter or digit."
13
+ }).refine((slug) => !RESERVED_ENVIRONMENT_SLUGS.includes(slug), {
14
+ message: `Environment slugs cannot be ${RESERVED_ENVIRONMENT_SLUGS.join(" or ")}.`
15
+ }).meta({ id: "environment-slug", examples: ["staging"] });
16
+ var teamEnvironmentSchema = external_exports.object({
17
+ slug: environmentSlugSchema,
18
+ name: external_exports.string().max(50),
19
+ /** Git branch globs that resolve here. List order is match order. */
20
+ branches: external_exports.string().array().default([])
21
+ }).meta({ id: "team-environment" });
22
+ var defaultTeamEnvironments = () => [
23
+ { slug: "development", name: "Development", branches: ["develop", "dev"] },
24
+ { slug: "staging", name: "Staging", branches: ["staging", "release/*"] },
25
+ {
26
+ slug: DEFAULT_ENVIRONMENT,
27
+ name: "Production",
28
+ branches: ["main", "master"]
29
+ }
30
+ ];
31
+
32
+ export {
33
+ MAX_TEAM_ENVIRONMENTS,
34
+ environmentSlugSchema,
35
+ teamEnvironmentSchema,
36
+ defaultTeamEnvironments
37
+ };
@@ -1,7 +1,12 @@
1
1
  import { createRequire as $$cR } from "node:module"; const require = $$cR(import.meta.url);
2
2
  import {
3
3
  customProjectIconSchema
4
- } from "./chunk-5JLVQVKO.js";
4
+ } from "./chunk-VRZSDUZK.js";
5
+ import {
6
+ MAX_TEAM_ENVIRONMENTS,
7
+ defaultTeamEnvironments,
8
+ teamEnvironmentSchema
9
+ } from "./chunk-AVZFSWPD.js";
5
10
  import {
6
11
  brandedUid,
7
12
  emailSchema,
@@ -14,7 +19,7 @@ import {
14
19
  slugSchema,
15
20
  timestampSchema,
16
21
  unixTimestamp
17
- } from "./chunk-IKT5F47M.js";
22
+ } from "./chunk-I57ID5K7.js";
18
23
 
19
24
  // ../../packages/entities/dist/team/access.js
20
25
  var ExternalAccessMethod;
@@ -192,10 +197,10 @@ var roleSchema = external_exports.enum(TeamUserRole).meta({ id: "role" });
192
197
  var userRefSchema = external_exports.object({
193
198
  uid: brandedUid(),
194
199
  role: roleSchema,
195
- displayName: external_exports.string(),
196
- imageUri: external_exports.string().optional(),
200
+ displayName: external_exports.string().meta({ examples: ["Alex Morgan"] }),
201
+ imageUri: external_exports.string().optional().meta({ examples: ["https://example.com/alex.png"] }),
197
202
  activeProjectUid: external_exports.string().default(""),
198
- nonBillable: external_exports.boolean().default(false).optional()
203
+ nonBillable: external_exports.boolean().default(false).optional().meta({ examples: [false] })
199
204
  }).meta({ id: "user-ref" });
200
205
  var billingPlanSchema = external_exports.enum(BillingPlan).meta({ id: "billing-plan" });
201
206
  var billingInfoSchema = external_exports.preprocess((arg) => {
@@ -284,13 +289,25 @@ var teamSdkPricing = external_exports.object({
284
289
  requiredTier: external_exports.enum(requiredTierLiterals)
285
290
  }).meta({ id: "team-sdk-pricing" });
286
291
  var pendingInviteSchema = external_exports.object({
287
- uid: nanoidSchema,
292
+ uid: nanoidSchema.meta({ examples: ["UakgbKJ5m9gl0JDMbcJqL"] }),
288
293
  role: roleSchema.default(TeamUserRole.Editor),
289
294
  email: emailSchema,
290
- expires: external_exports.number().optional()
295
+ expires: external_exports.number().optional().meta({ examples: [1735776e3] })
291
296
  }).meta({ id: "pending-invite" });
292
- var teamNameSchema = external_exports.string().trim().overwrite((s) => s.length ? s : "Untitled Team").meta({ id: "team-name" });
293
- var teamImageSchema = external_exports.string().optional().meta({ id: "team-image" });
297
+ var teamNameSchema = external_exports.string().trim().overwrite((s) => s.length ? s : "Untitled Team").meta({ id: "team-name", examples: ["Acme"] });
298
+ var TEAM_NAME_MAX_LENGTH = 100;
299
+ var teamNameInputSchema = teamNameSchema.max(TEAM_NAME_MAX_LENGTH).meta({ id: "team-name-input" });
300
+ var teamImageSchema = external_exports.string().optional().meta({ id: "team-image", examples: ["https://example.com/logo.svg"] });
301
+ var emailAllowanceSchema = external_exports.object({
302
+ /** UTC day the daily count belongs to, as `YYYY-MM-DD`. */
303
+ day: external_exports.string(),
304
+ dayCount: external_exports.number().int().nonnegative(),
305
+ /** UTC month the monthly count belongs to, as `YYYY-MM`. */
306
+ month: external_exports.string(),
307
+ monthCount: external_exports.number().int().nonnegative(),
308
+ /** The month a limit alert was last posted for, so it posts once a month. */
309
+ alertedMonth: external_exports.string().optional()
310
+ });
294
311
  var TeamOnboardingState;
295
312
  (function(TeamOnboardingState2) {
296
313
  TeamOnboardingState2["Setup"] = "setup";
@@ -366,9 +383,18 @@ var teamSchema = entitySchema.extend({
366
383
  namespaces: namespaceSchema.array().refine((ns) => !ns.includes("share"), {
367
384
  message: '"share" is a reserved namespace and cannot be used'
368
385
  }).default([]),
386
+ /**
387
+ * The team's environment vocabulary, shared by every entity: each entity's
388
+ * own environments are a subset of it. `production` is always in it and
389
+ * cannot be removed; a version's tag names an environment only once it is
390
+ * listed here.
391
+ */
392
+ environments: teamEnvironmentSchema.array().max(MAX_TEAM_ENVIRONMENTS).default(defaultTeamEnvironments),
369
393
  users: userRefSchema.array(),
370
394
  icons: customProjectIconSchema.array().default([]),
371
395
  pendingInvites: pendingInviteSchema.array().default([]),
396
+ /** Invite emails this team has sent in the current day and month. */
397
+ emailAllowance: emailAllowanceSchema.optional(),
372
398
  /** Team auth configuration */
373
399
  authentication: teamAuthenticationSchema.default(schemaModel({}, teamAuthenticationSchema)),
374
400
  externalAccess: externalAccessSchema.default(schemaModel({}, externalAccessSchema)),
@@ -486,7 +512,6 @@ var teamPermissions = {
486
512
  };
487
513
 
488
514
  export {
489
- TeamUserRole,
490
515
  roleSchema,
491
516
  userRefSchema,
492
517
  billingPlanSchema,
@@ -495,6 +520,7 @@ export {
495
520
  pendingInviteSchema,
496
521
  teamNameSchema,
497
522
  teamImageSchema,
523
+ emailAllowanceSchema,
498
524
  UnifiedDocsMigrationStatus,
499
525
  teamSchema
500
526
  };