@speedkit/cli 4.36.1 → 4.37.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 (310) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +12 -5
  3. package/dist/base/sk-command.d.ts +41 -0
  4. package/dist/base/sk-command.js +56 -0
  5. package/dist/commands/auto-prewarm.d.ts +6 -4
  6. package/dist/commands/auto-prewarm.js +13 -66
  7. package/dist/commands/autocomplete/fish.d.ts +2 -2
  8. package/dist/commands/autocomplete/fish.js +3 -2
  9. package/dist/commands/browser/clean.d.ts +2 -2
  10. package/dist/commands/browser/clean.js +6 -6
  11. package/dist/commands/browser/list.d.ts +2 -2
  12. package/dist/commands/browser/list.js +6 -7
  13. package/dist/commands/browser/update.d.ts +2 -2
  14. package/dist/commands/browser/update.js +9 -11
  15. package/dist/commands/bulk-deploy.d.ts +4 -2
  16. package/dist/commands/bulk-deploy.js +7 -37
  17. package/dist/commands/config/edit.d.ts +2 -2
  18. package/dist/commands/config/edit.js +2 -2
  19. package/dist/commands/config/setup.d.ts +5 -2
  20. package/dist/commands/config/setup.js +9 -19
  21. package/dist/commands/deploy.d.ts +12 -3
  22. package/dist/commands/deploy.js +14 -20
  23. package/dist/commands/diff-url-parameters.d.ts +3 -2
  24. package/dist/commands/diff-url-parameters.js +19 -16
  25. package/dist/commands/extension/add.d.ts +2 -2
  26. package/dist/commands/extension/add.js +6 -6
  27. package/dist/commands/extension/devtools.d.ts +2 -2
  28. package/dist/commands/extension/devtools.js +6 -7
  29. package/dist/commands/extension/list.d.ts +2 -2
  30. package/dist/commands/extension/list.js +5 -6
  31. package/dist/commands/extension/remove.d.ts +2 -2
  32. package/dist/commands/extension/remove.js +6 -6
  33. package/dist/commands/extension/update.d.ts +2 -2
  34. package/dist/commands/extension/update.js +5 -6
  35. package/dist/commands/find-pops.d.ts +2 -2
  36. package/dist/commands/find-pops.js +10 -11
  37. package/dist/commands/generate-customer-config.d.ts +5 -2
  38. package/dist/commands/generate-customer-config.js +9 -27
  39. package/dist/commands/generate-pop-config.d.ts +2 -2
  40. package/dist/commands/generate-pop-config.js +19 -15
  41. package/dist/commands/login.d.ts +2 -2
  42. package/dist/commands/login.js +6 -9
  43. package/dist/commands/onboarding.d.ts +19 -3
  44. package/dist/commands/onboarding.js +15 -11
  45. package/dist/commands/origin-request.d.ts +4 -2
  46. package/dist/commands/origin-request.js +10 -42
  47. package/dist/commands/prewarm.d.ts +4 -2
  48. package/dist/commands/prewarm.js +12 -56
  49. package/dist/commands/pull.d.ts +4 -2
  50. package/dist/commands/pull.js +9 -14
  51. package/dist/commands/query/parameter.d.ts +4 -2
  52. package/dist/commands/query/parameter.js +12 -19
  53. package/dist/commands/query/prewarm.d.ts +4 -2
  54. package/dist/commands/query/prewarm.js +16 -23
  55. package/dist/commands/revalidate.d.ts +4 -2
  56. package/dist/commands/revalidate.js +13 -56
  57. package/dist/commands/wpt-launcher.d.ts +2 -2
  58. package/dist/commands/wpt-launcher.js +16 -17
  59. package/dist/hooks/init/first-run.js +9 -10
  60. package/dist/models/context.d.ts +24 -0
  61. package/dist/models/context.js +31 -0
  62. package/dist/services/athena/athena-flags.d.ts +18 -0
  63. package/dist/services/athena/athena-flags.js +29 -0
  64. package/dist/services/athena/athena-service-build-context.d.ts +25 -0
  65. package/dist/services/athena/athena-service-build-context.js +4 -0
  66. package/dist/services/athena/athena-service-factory.d.ts +3 -16
  67. package/dist/services/athena/athena-service-factory.js +11 -27
  68. package/dist/services/athena/baqend-athena-service.d.ts +3 -14
  69. package/dist/services/athena/baqend-athena-service.js +8 -16
  70. package/dist/services/athena/index.d.ts +1 -0
  71. package/dist/services/athena/index.js +1 -0
  72. package/dist/services/athena/spec/baqend-athena-service.spec.js +2 -2
  73. package/dist/services/browser-fetch/browser-origin-fetch.d.ts +2 -2
  74. package/dist/services/browser-fetch/browser-origin-fetch.js +1 -1
  75. package/dist/services/browser-fetch/browser-origin-fetcher.d.ts +3 -3
  76. package/dist/services/browser-fetch/browser-origin-fetcher.js +5 -5
  77. package/dist/services/browser-fetch/spec/browser-origin-fetch.spec.js +10 -10
  78. package/dist/services/cli/cli-environment-factory.d.ts +25 -0
  79. package/dist/services/cli/cli-environment-factory.js +30 -0
  80. package/dist/services/cli/cli-environment.d.ts +73 -0
  81. package/dist/services/cli/cli-environment.js +216 -0
  82. package/dist/services/cli/cli-service-build-context.d.ts +10 -0
  83. package/dist/services/cli/cli-service-build-context.js +4 -0
  84. package/dist/services/cli/cli-service-factory.d.ts +7 -7
  85. package/dist/services/cli/cli-service-factory.js +7 -7
  86. package/dist/services/cli/cli-service-model.d.ts +0 -4
  87. package/dist/services/cli/cli-service-model.js +0 -6
  88. package/dist/services/cli/cli-service.d.ts +16 -2
  89. package/dist/services/cli/cli-service.js +17 -18
  90. package/dist/services/cli/cli-settings.d.ts +37 -0
  91. package/dist/services/cli/cli-settings.js +23 -0
  92. package/dist/services/cli/command-build-context.d.ts +23 -0
  93. package/dist/services/cli/index.d.ts +5 -1
  94. package/dist/services/cli/index.js +5 -1
  95. package/dist/services/cli/spec/cli-environment-detection.spec.js +52 -0
  96. package/dist/services/cli/spec/cli-environment.spec.js +125 -0
  97. package/dist/services/cli/spec/cli-service.spec.js +9 -19
  98. package/dist/services/config-api/client.d.ts +3 -3
  99. package/dist/services/config-api/client.js +4 -4
  100. package/dist/services/config-api/config-api-factory.js +3 -3
  101. package/dist/services/config-api/entity-manager-provider.d.ts +11 -0
  102. package/dist/services/config-api/{entity-manager-factory.js → entity-manager-provider.js} +7 -1
  103. package/dist/services/customer-config/customer-config-service-build-context.d.ts +33 -0
  104. package/dist/services/customer-config/customer-config-service-build-context.js +36 -0
  105. package/dist/services/customer-config/customer-config-service-factory.d.ts +3 -4
  106. package/dist/services/customer-config/customer-config-service-factory.js +5 -8
  107. package/dist/services/customer-config/customer-config-service.d.ts +2 -2
  108. package/dist/services/customer-config/index.d.ts +1 -1
  109. package/dist/services/customer-config/index.js +1 -1
  110. package/dist/services/customer-config/site-analyzer/index.d.ts +1 -0
  111. package/dist/services/customer-config/site-analyzer/index.js +1 -0
  112. package/dist/services/customer-config/site-analyzer/site-analyzer-service-build-context.d.ts +6 -0
  113. package/dist/services/customer-config/site-analyzer/site-analyzer-service-build-context.js +4 -0
  114. package/dist/services/customer-config/site-analyzer/site-analyzer-service-factory.d.ts +3 -3
  115. package/dist/services/customer-config/site-analyzer/site-analyzer-service-factory.js +4 -5
  116. package/dist/services/deploy/bulk/bulk-deploy-model.d.ts +0 -25
  117. package/dist/services/deploy/bulk/bulk-deploy-model.js +1 -27
  118. package/dist/services/deploy/bulk/bulk-deploy-service-build-context.d.ts +51 -0
  119. package/dist/services/deploy/bulk/bulk-deploy-service-build-context.js +50 -0
  120. package/dist/services/deploy/bulk/bulk-deploy-service-factory.d.ts +2 -4
  121. package/dist/services/deploy/bulk/bulk-deploy-service-factory.js +2 -5
  122. package/dist/services/deploy/bulk/bulk-deploy-service.d.ts +3 -2
  123. package/dist/services/deploy/bulk/config-deploy-factory.d.ts +3 -3
  124. package/dist/services/deploy/bulk/config-deploy-factory.js +16 -8
  125. package/dist/services/deploy/bulk/index.d.ts +1 -0
  126. package/dist/services/deploy/bulk/index.js +1 -0
  127. package/dist/services/deploy/checks/activation/customer-approval-check.d.ts +3 -1
  128. package/dist/services/deploy/checks/activation/customer-approval-check.js +4 -2
  129. package/dist/services/deploy/checks/pre-deploy/device-detection-changed-check.d.ts +3 -1
  130. package/dist/services/deploy/checks/pre-deploy/device-detection-changed-check.js +4 -2
  131. package/dist/services/deploy/checks/pre-deploy/split-change-check.d.ts +3 -1
  132. package/dist/services/deploy/checks/pre-deploy/split-change-check.js +4 -2
  133. package/dist/services/deploy/deploy-service-build-context.d.ts +63 -0
  134. package/dist/services/deploy/deploy-service-build-context.js +64 -0
  135. package/dist/services/deploy/deploy-service-factory.d.ts +5 -8
  136. package/dist/services/deploy/deploy-service-factory.js +28 -19
  137. package/dist/services/deploy/mr/base-config-reader.d.ts +6 -4
  138. package/dist/services/deploy/mr/base-config-reader.js +6 -8
  139. package/dist/services/deploy/mr/index.d.ts +1 -0
  140. package/dist/services/deploy/mr/index.js +1 -0
  141. package/dist/services/deploy/mr/merge-request-deploy-model.d.ts +0 -35
  142. package/dist/services/deploy/mr/merge-request-deploy-model.js +0 -34
  143. package/dist/services/deploy/mr/merge-request-deploy-service-build-context.d.ts +32 -0
  144. package/dist/services/deploy/mr/merge-request-deploy-service-build-context.js +20 -0
  145. package/dist/services/deploy/mr/merge-request-deploy-service-factory.d.ts +2 -4
  146. package/dist/services/deploy/mr/merge-request-deploy-service-factory.js +31 -10
  147. package/dist/services/deploy/mr/merge-request-deploy-service.d.ts +3 -2
  148. package/dist/services/deploy/spec/bulk/bulk-deploy-service.spec.js +14 -3
  149. package/dist/services/deploy/spec/checks/activation/customer-approval-check.spec.js +7 -5
  150. package/dist/services/deploy/spec/checks/pre-deploy/split-change-check.spec.js +2 -1
  151. package/dist/services/diff/diff-service-build-context.d.ts +14 -0
  152. package/dist/services/diff/diff-service-build-context.js +4 -0
  153. package/dist/services/diff/diff-service-factory.d.ts +4 -5
  154. package/dist/services/diff/diff-service-factory.js +4 -7
  155. package/dist/services/diff/index.d.ts +1 -1
  156. package/dist/services/diff/index.js +1 -1
  157. package/dist/services/document-handler-runtime/{context/document-handler-runtime-context.d.ts → document-handler-runtime-model.d.ts} +0 -5
  158. package/dist/services/document-handler-runtime/document-handler-runtime-service-build-context.d.ts +11 -0
  159. package/dist/services/document-handler-runtime/document-handler-runtime-service-build-context.js +4 -0
  160. package/dist/services/document-handler-runtime/document-handler-server.js +2 -2
  161. package/dist/services/document-handler-runtime/factory/document-handler-runtime-service-factory.d.ts +3 -6
  162. package/dist/services/document-handler-runtime/factory/document-handler-runtime-service-factory.js +14 -14
  163. package/dist/services/document-handler-runtime/server/request.js +1 -1
  164. package/dist/services/document-handler-runtime/templates/database-mock.d.ts +1 -1
  165. package/dist/services/document-handler-runtime/templates/database-mock.js +1 -1
  166. package/dist/services/integration-api/customer-config-flags.d.ts +16 -0
  167. package/dist/services/integration-api/customer-config-flags.js +30 -0
  168. package/dist/services/integration-api/handler/install-resource-handler.d.ts +8 -0
  169. package/dist/services/integration-api/handler/install-resource-handler.js +10 -1
  170. package/dist/services/integration-api/index.d.ts +1 -0
  171. package/dist/services/integration-api/index.js +1 -0
  172. package/dist/services/integration-api/integration-api-factory.d.ts +4 -6
  173. package/dist/services/integration-api/integration-api-factory.js +11 -11
  174. package/dist/services/integration-api/integration-api-model.d.ts +0 -9
  175. package/dist/services/integration-api/integration-api-model.js +0 -16
  176. package/dist/services/integration-api/integration-api-service-build-context.d.ts +19 -0
  177. package/dist/services/integration-api/integration-api-service-build-context.js +4 -0
  178. package/dist/services/integration-api/spec/config-plugin.spec.js +1 -1
  179. package/dist/services/integration-api/spec/integration-api-service.spec.js +7 -3
  180. package/dist/services/integration-api/spec/speed-kit-config-file.spec.js +9 -2
  181. package/dist/services/integration-api/struct/config-plugin.d.ts +1 -1
  182. package/dist/services/integration-api/struct/config-plugin.js +12 -7
  183. package/dist/services/integration-api/struct/speed-kit-config-file.d.ts +18 -2
  184. package/dist/services/integration-api/struct/speed-kit-config-file.js +22 -12
  185. package/dist/services/integration-api/struct/speed-kit-config.d.ts +1 -1
  186. package/dist/services/onboarding/browse/browse-service.d.ts +18 -0
  187. package/dist/services/onboarding/browse/browse-service.js +61 -0
  188. package/dist/services/onboarding/browse/browse-url.d.ts +10 -0
  189. package/dist/services/onboarding/browse/browse-url.js +19 -0
  190. package/dist/services/onboarding/browser/config/browser-config.d.ts +3 -3
  191. package/dist/services/onboarding/browser/config/browser-config.js +5 -5
  192. package/dist/services/onboarding/browser/executable/executable-validator.d.ts +3 -3
  193. package/dist/services/onboarding/browser/executable/executable-validator.js +20 -16
  194. package/dist/services/onboarding/browser/extension/extension-downloader.d.ts +3 -3
  195. package/dist/services/onboarding/browser/extension/extension-downloader.js +8 -6
  196. package/dist/services/onboarding/browser/extension/extension-validator.d.ts +3 -3
  197. package/dist/services/onboarding/browser/extension/extension-validator.js +4 -4
  198. package/dist/services/onboarding/browser/launch-browser.d.ts +9 -0
  199. package/dist/services/onboarding/browser/launch-browser.js +20 -0
  200. package/dist/services/onboarding/error/browse-domain-error.d.ts +6 -0
  201. package/dist/services/onboarding/error/browse-domain-error.js +11 -0
  202. package/dist/services/onboarding/error/missing-customer-path-error.d.ts +6 -0
  203. package/dist/services/onboarding/error/missing-customer-path-error.js +11 -0
  204. package/dist/services/onboarding/file-events/file-watcher.js +1 -0
  205. package/dist/services/onboarding/index.d.ts +1 -1
  206. package/dist/services/onboarding/index.js +1 -1
  207. package/dist/services/onboarding/onboarding-model.d.ts +8 -24
  208. package/dist/services/onboarding/onboarding-model.js +19 -87
  209. package/dist/services/onboarding/onboarding-service-build-context.d.ts +61 -0
  210. package/dist/services/onboarding/onboarding-service-build-context.js +79 -0
  211. package/dist/services/onboarding/onboarding-service-factory.d.ts +31 -6
  212. package/dist/services/onboarding/onboarding-service-factory.js +120 -48
  213. package/dist/services/onboarding/onboarding-service.d.ts +2 -0
  214. package/dist/services/onboarding/onboarding-service.js +5 -16
  215. package/dist/services/onboarding/spec/browse/browse-url.spec.d.ts +1 -0
  216. package/dist/services/onboarding/spec/browse/browse-url.spec.js +28 -0
  217. package/dist/services/onboarding/spec/onboarding-model.spec.js +11 -6
  218. package/dist/services/onboarding/spec/onboarding-service-factory.spec.d.ts +1 -0
  219. package/dist/services/onboarding/spec/onboarding-service-factory.spec.js +155 -0
  220. package/dist/services/origin-request/index.d.ts +1 -1
  221. package/dist/services/origin-request/index.js +1 -1
  222. package/dist/services/origin-request/origin-request-service-build-context.d.ts +52 -0
  223. package/dist/services/origin-request/origin-request-service-build-context.js +54 -0
  224. package/dist/services/origin-request/origin-request-service-factory.d.ts +2 -5
  225. package/dist/services/origin-request/origin-request-service-factory.js +12 -12
  226. package/dist/services/origin-request/origin-request-service.d.ts +2 -2
  227. package/dist/services/pop-config/index.d.ts +1 -0
  228. package/dist/services/pop-config/index.js +1 -0
  229. package/dist/services/pop-config/pop-config-factory.d.ts +4 -1
  230. package/dist/services/pop-config/pop-config-factory.js +10 -3
  231. package/dist/services/pop-config/pop-config-service-build-context.d.ts +10 -0
  232. package/dist/services/pop-config/pop-config-service-build-context.js +4 -0
  233. package/dist/services/prewarm/auto-pre-warm-factory.d.ts +3 -31
  234. package/dist/services/prewarm/auto-pre-warm-factory.js +6 -11
  235. package/dist/services/prewarm/auto-pre-warm-service-build-context.d.ts +84 -0
  236. package/dist/services/prewarm/auto-pre-warm-service-build-context.js +68 -0
  237. package/dist/services/prewarm/index.d.ts +2 -0
  238. package/dist/services/prewarm/index.js +2 -0
  239. package/dist/services/prewarm/pre-warm-factory.d.ts +4 -5
  240. package/dist/services/prewarm/pre-warm-factory.js +6 -8
  241. package/dist/services/prewarm/pre-warm-model.d.ts +0 -10
  242. package/dist/services/prewarm/pre-warm-model.js +0 -18
  243. package/dist/services/prewarm/pre-warm-service-build-context.d.ts +47 -0
  244. package/dist/services/prewarm/pre-warm-service-build-context.js +64 -0
  245. package/dist/services/pull/index.d.ts +1 -0
  246. package/dist/services/pull/index.js +1 -0
  247. package/dist/services/pull/pull-service-build-context.d.ts +28 -0
  248. package/dist/services/pull/pull-service-build-context.js +17 -0
  249. package/dist/services/pull/pull-service-factory.d.ts +3 -5
  250. package/dist/services/pull/pull-service-factory.js +13 -14
  251. package/dist/services/pull/pull-service-model.d.ts +0 -5
  252. package/dist/services/pull/pull-service-model.js +0 -9
  253. package/dist/services/query-builder/query-builder-factory.d.ts +9 -7
  254. package/dist/services/query-builder/query-builder-factory.js +26 -15
  255. package/dist/{models/cli-parameters.d.ts → services/query-builder/query-builder-flags.d.ts} +1 -120
  256. package/dist/services/query-builder/query-builder-flags.js +150 -0
  257. package/dist/services/query-builder/query-builder-model.d.ts +1 -14
  258. package/dist/services/query-builder/query-builder-service-build-context.d.ts +113 -0
  259. package/dist/services/query-builder/query-builder-service-build-context.js +68 -0
  260. package/dist/services/query-builder/query-builder-service.d.ts +3 -3
  261. package/dist/services/query-builder/spec/query-builder-flags.spec.d.ts +1 -0
  262. package/dist/{models/spec/cli-parameters.spec.js → services/query-builder/spec/query-builder-flags.spec.js} +1 -1
  263. package/dist/services/revalidate/index.d.ts +1 -0
  264. package/dist/services/revalidate/index.js +1 -0
  265. package/dist/services/revalidate/revalidate-factory.d.ts +3 -5
  266. package/dist/services/revalidate/revalidate-factory.js +2 -6
  267. package/dist/services/revalidate/revalidate-model.d.ts +0 -9
  268. package/dist/services/revalidate/revalidate-model.js +0 -8
  269. package/dist/services/revalidate/revalidate-service-build-context.d.ts +38 -0
  270. package/dist/services/revalidate/revalidate-service-build-context.js +59 -0
  271. package/dist/services/setup/browser/browser-setup-service.d.ts +3 -4
  272. package/dist/services/setup/browser/browser-setup-service.js +16 -18
  273. package/dist/services/setup/difftool/difftool-setup-service.d.ts +3 -4
  274. package/dist/services/setup/difftool/difftool-setup-service.js +5 -7
  275. package/dist/services/setup/extension/extension-setup-service.d.ts +3 -4
  276. package/dist/services/setup/extension/extension-setup-service.js +8 -10
  277. package/dist/services/setup/index.d.ts +1 -1
  278. package/dist/services/setup/index.js +1 -1
  279. package/dist/services/setup/setup-service-build-context.d.ts +27 -0
  280. package/dist/services/setup/setup-service-build-context.js +26 -0
  281. package/dist/services/setup/setup-service-factory.d.ts +2 -6
  282. package/dist/services/setup/setup-service-factory.js +10 -18
  283. package/dist/services/setup/setup-service.d.ts +4 -5
  284. package/dist/services/setup/setup-service.js +6 -7
  285. package/oclif.manifest.json +155 -147
  286. package/package.json +4 -2
  287. package/dist/models/cli-parameters.js +0 -297
  288. package/dist/services/cli/cli-config.d.ts +0 -59
  289. package/dist/services/cli/cli-config.js +0 -180
  290. package/dist/services/cli/environment.d.ts +0 -15
  291. package/dist/services/cli/environment.js +0 -40
  292. package/dist/services/cli/spec/cli-config.spec.js +0 -117
  293. package/dist/services/cli/spec/environment.spec.js +0 -28
  294. package/dist/services/config-api/entity-manager-factory.d.ts +0 -5
  295. package/dist/services/customer-config/customer-config-service-context.d.ts +0 -13
  296. package/dist/services/customer-config/customer-config-service-context.js +0 -21
  297. package/dist/services/deploy/context/deploy-context.d.ts +0 -32
  298. package/dist/services/deploy/context/deploy-context.js +0 -72
  299. package/dist/services/diff/diff-model.d.ts +0 -9
  300. package/dist/services/diff/diff-model.js +0 -12
  301. package/dist/services/origin-request/origin-request-context.d.ts +0 -13
  302. package/dist/services/origin-request/origin-request-context.js +0 -23
  303. package/dist/services/query-builder/query-command.d.ts +0 -28
  304. package/dist/services/query-builder/query-command.js +0 -37
  305. package/dist/services/setup/setup-context.d.ts +0 -14
  306. package/dist/services/setup/setup-context.js +0 -15
  307. /package/dist/{models/spec/cli-parameters.spec.d.ts → services/cli/command-build-context.js} +0 -0
  308. /package/dist/services/cli/spec/{cli-config.spec.d.ts → cli-environment-detection.spec.d.ts} +0 -0
  309. /package/dist/services/cli/spec/{environment.spec.d.ts → cli-environment.spec.d.ts} +0 -0
  310. /package/dist/services/document-handler-runtime/{context/document-handler-runtime-context.js → document-handler-runtime-model.js} +0 -0
@@ -0,0 +1,150 @@
1
+ import { Flags } from "@oclif/core";
2
+ // Imported from the modules rather than from the barrels: a build context that
3
+ // uses these flags is loaded with its command, and the rules barrel pulls in
4
+ // the automata library.
5
+ import { parseMatchPattern } from "./rules/match-pattern.js";
6
+ import { DEVICE_VARIATIONS } from "./queries/device.js";
7
+ /** The flags of the commands that build a query. */
8
+ /** Shared wording, so every query command describes the window the same way. */
9
+ export const CLI_QUERY_DAYS_DESCRIPTION = "Number of days the query looks back";
10
+ /**
11
+ * How far back a query looks. Its own object because `generate-pop-config`
12
+ * takes it without the `-d` shorthand, which `--deploy` holds there.
13
+ */
14
+ export const CLI_QUERY_DAYS = {
15
+ days: Flags.integer({
16
+ char: "d",
17
+ description: CLI_QUERY_DAYS_DESCRIPTION,
18
+ min: 1,
19
+ required: false,
20
+ }),
21
+ };
22
+ /**
23
+ * What a query command does with the query it built. Both commands take them,
24
+ * so a query can be piped or run without a detour through the clipboard.
25
+ */
26
+ export const CLI_QUERY_OUTPUT = {
27
+ execute: Flags.boolean({
28
+ char: "e",
29
+ default: false,
30
+ description: "Execute the query directly and write the result to a <app>-<date>-<query>.csv file",
31
+ }),
32
+ quiet: Flags.boolean({
33
+ char: "q",
34
+ default: false,
35
+ description: "Output only the raw query without clipboard copy or styling",
36
+ }),
37
+ };
38
+ /**
39
+ * Which page impressions a query leaves out, and whether to account for every
40
+ * rule it does not carry over literally. Bots are always excluded.
41
+ */
42
+ export const CLI_QUERY_FILTERS = {
43
+ excludeNoindex: Flags.boolean({
44
+ default: false,
45
+ description: "Exclude page impressions of pages marked noindex",
46
+ }),
47
+ excludeSuspicious: Flags.boolean({
48
+ default: false,
49
+ description: "Exclude page impressions Speed Kit classified as suspicious",
50
+ }),
51
+ explain: Flags.boolean({
52
+ default: false,
53
+ description: "Account for every rule the query leaves out, reduces or approximates",
54
+ }),
55
+ hardNavigationsOnly: Flags.boolean({
56
+ default: false,
57
+ description: "Exclude soft (SPA) navigations",
58
+ }),
59
+ };
60
+ /**
61
+ * Which variation the pre-warm list carries per url, instead of leaving the
62
+ * pre-warmer to request every url in every variation.
63
+ *
64
+ * The two flags answer the same question from two different sources — the
65
+ * traffic, or the operator — so combining them would cross-produce the list
66
+ * again, which is what they are there to stop. A command that also reads a
67
+ * variations file from disk excludes that one on its own side.
68
+ */
69
+ export const CLI_QUERY_VARIATIONS = {
70
+ device: Flags.string({
71
+ delimiter: ",",
72
+ description: "Split the list by device class, so every url is warmed in the variations it was actually requested in. A class not named is left out",
73
+ exclusive: ["variation"],
74
+ multiple: true,
75
+ options: [...DEVICE_VARIATIONS],
76
+ required: false,
77
+ }),
78
+ variation: Flags.string({
79
+ char: "v",
80
+ delimiter: ",",
81
+ description: "Pair every url of the list with each of these variations. For the custom variations no traffic can reveal, e.g. 'desktop-pdp-a,mobile-pdp-a'",
82
+ exclusive: ["device"],
83
+ multiple: true,
84
+ required: false,
85
+ }),
86
+ };
87
+ /**
88
+ * What the pre-warm query keeps of a long tail that is mostly seen once.
89
+ *
90
+ * Every flag here shapes the list itself, so a command that builds that list
91
+ * takes all of them — `sk auto-prewarm` included, or a count could describe a
92
+ * list the pre-warmer would never produce.
93
+ */
94
+ export const CLI_QUERY_PREWARM_LIST = {
95
+ ...CLI_QUERY_VARIATIONS,
96
+ excludeNotFound: Flags.boolean({
97
+ default: false,
98
+ description: "Leave out urls the origin answers with a 404 more often than not",
99
+ }),
100
+ limit: Flags.integer({
101
+ description: "Keep only the most requested urls",
102
+ min: 1,
103
+ required: false,
104
+ }),
105
+ match: Flags.string({
106
+ description: "Keep only urls whose path matches this regular expression, e.g. '^/p/'. The path is matched with its query string, the way a version 1 pathname rule matches it, so '[?&]size=' works too. Repeat the flag to keep the urls matching any of several patterns, and start a pattern with (?i) to match case-insensitively",
107
+ multiple: true,
108
+ parse: async (input) => {
109
+ try {
110
+ parseMatchPattern(input);
111
+ }
112
+ catch (error) {
113
+ throw new Error(`--match ${input} is not a regular expression: ${error.message}`, { cause: error });
114
+ }
115
+ return input;
116
+ },
117
+ required: false,
118
+ }),
119
+ minHits: Flags.integer({
120
+ description: "Keep only urls requested at least this often in the window",
121
+ min: 1,
122
+ required: false,
123
+ }),
124
+ };
125
+ /**
126
+ * The pre-warm query flags in full: the list-shaping ones plus `--count`, which
127
+ * reports the list's size instead of returning it. Only a command that can
128
+ * answer with a count takes this one — `sk auto-prewarm` warms the list, so it
129
+ * takes {@link CLI_QUERY_PREWARM_LIST} instead.
130
+ */
131
+ export const CLI_QUERY_PREWARM = {
132
+ ...CLI_QUERY_PREWARM_LIST,
133
+ count: Flags.boolean({
134
+ default: false,
135
+ description: "Run the query and report how large the list is instead of what is in it: urls, the impressions they stand for, and a row per variation where the list carries variations. Every other flag still applies, so this counts the list the same command would produce",
136
+ exclusive: ["execute"],
137
+ }),
138
+ };
139
+ /** How the parameter query presents what it found. */
140
+ export const CLI_QUERY_PARAMETER = {
141
+ bySet: Flags.boolean({
142
+ default: false,
143
+ description: "Rank whole sets of parameters instead of single parameters, to see which ones travel together",
144
+ }),
145
+ minImpressions: Flags.integer({
146
+ description: "Leave out parameters seen on fewer page impressions than this",
147
+ min: 1,
148
+ required: false,
149
+ }),
150
+ };
@@ -14,7 +14,7 @@ export interface QueryFilterOptions {
14
14
  /** Keep hard navigations only, dropping soft (SPA) navigations. */
15
15
  readonly hardNavigationsOnly?: boolean;
16
16
  }
17
- export interface QueryBuilderContext extends ParameterOptions, PrewarmOptions, QueryFilterOptions {
17
+ export interface QueryBuilderOptions extends ParameterOptions, PrewarmOptions, QueryFilterOptions {
18
18
  readonly app: string;
19
19
  /** Athena data catalog the rum tables live in. */
20
20
  readonly catalog?: string;
@@ -27,16 +27,3 @@ export interface QueryBuilderContext extends ParameterOptions, PrewarmOptions, Q
27
27
  readonly queryType: QueryType;
28
28
  readonly quiet?: boolean;
29
29
  }
30
- export interface QueryBuilderFactoryContext extends ParameterOptions, PrewarmOptions, QueryFilterOptions {
31
- /** Athena data catalog the rum tables live in. */
32
- readonly catalog?: string;
33
- readonly configName: string;
34
- readonly customerPath: string;
35
- readonly execute?: boolean;
36
- /** Report every rule the query leaves out, reduces or approximates. */
37
- readonly explain?: boolean;
38
- readonly isWindows?: boolean;
39
- readonly quiet?: boolean;
40
- /** Athena workgroup to execute in, when the query is executed at all. */
41
- readonly workgroup?: string;
42
- }
@@ -0,0 +1,113 @@
1
+ import { Interfaces } from "@oclif/core";
2
+ import { CliEnvironment, CommandContextValues } from "../cli/index.js";
3
+ import { ParameterOptions, PrewarmOptions } from "./queries/query-model.js";
4
+ import { QueryFilterOptions, QueryType } from "./query-builder-model.js";
5
+ export interface QueryBuilderServiceBuildContextValues extends CommandContextValues, ParameterOptions, PrewarmOptions, QueryFilterOptions {
6
+ /** Athena data catalog the rum tables live in. */
7
+ readonly catalog?: string;
8
+ readonly configName: string;
9
+ readonly customerPath: string;
10
+ readonly execute?: boolean;
11
+ /** Report every rule the query leaves out, reduces or approximates. */
12
+ readonly explain?: boolean;
13
+ readonly isWindows?: boolean;
14
+ readonly quiet?: boolean;
15
+ /** Athena workgroup to execute in, when the query is executed at all. */
16
+ readonly workgroup?: string;
17
+ }
18
+ declare const args: {
19
+ customerPath: Interfaces.Arg<string, {
20
+ exists?: boolean;
21
+ }>;
22
+ };
23
+ declare const prewarmFlags: {
24
+ count: Interfaces.BooleanFlag<boolean>;
25
+ excludeNotFound: Interfaces.BooleanFlag<boolean>;
26
+ limit: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
27
+ match: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
28
+ minHits: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
29
+ device: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
30
+ variation: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
31
+ execute: Interfaces.BooleanFlag<boolean>;
32
+ quiet: Interfaces.BooleanFlag<boolean>;
33
+ excludeNoindex: Interfaces.BooleanFlag<boolean>;
34
+ excludeSuspicious: Interfaces.BooleanFlag<boolean>;
35
+ explain: Interfaces.BooleanFlag<boolean>;
36
+ hardNavigationsOnly: Interfaces.BooleanFlag<boolean>;
37
+ days: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
38
+ configName: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
39
+ catalog: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
40
+ workgroup: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
41
+ };
42
+ declare const parameterFlags: {
43
+ bySet: Interfaces.BooleanFlag<boolean>;
44
+ minImpressions: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
45
+ execute: Interfaces.BooleanFlag<boolean>;
46
+ quiet: Interfaces.BooleanFlag<boolean>;
47
+ excludeNoindex: Interfaces.BooleanFlag<boolean>;
48
+ excludeSuspicious: Interfaces.BooleanFlag<boolean>;
49
+ explain: Interfaces.BooleanFlag<boolean>;
50
+ hardNavigationsOnly: Interfaces.BooleanFlag<boolean>;
51
+ days: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
52
+ configName: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
53
+ catalog: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
54
+ workgroup: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
55
+ };
56
+ declare const PrewarmQueryServiceBuildContext_base: new (values: QueryBuilderServiceBuildContextValues) => Readonly<QueryBuilderServiceBuildContextValues>;
57
+ /** What a prewarm query is built for: which urls of a customer to warm. */
58
+ export declare class PrewarmQueryServiceBuildContext extends PrewarmQueryServiceBuildContext_base {
59
+ static readonly args: {
60
+ customerPath: Interfaces.Arg<string, {
61
+ exists?: boolean;
62
+ }>;
63
+ };
64
+ static readonly flags: {
65
+ count: Interfaces.BooleanFlag<boolean>;
66
+ excludeNotFound: Interfaces.BooleanFlag<boolean>;
67
+ limit: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
68
+ match: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
69
+ minHits: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
70
+ device: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
71
+ variation: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
72
+ execute: Interfaces.BooleanFlag<boolean>;
73
+ quiet: Interfaces.BooleanFlag<boolean>;
74
+ excludeNoindex: Interfaces.BooleanFlag<boolean>;
75
+ excludeSuspicious: Interfaces.BooleanFlag<boolean>;
76
+ explain: Interfaces.BooleanFlag<boolean>;
77
+ hardNavigationsOnly: Interfaces.BooleanFlag<boolean>;
78
+ days: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
79
+ configName: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
80
+ catalog: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
81
+ workgroup: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
82
+ };
83
+ readonly queryType = QueryType.prewarm;
84
+ static create(parsedArgs: Interfaces.InferredArgs<typeof args>, parsedFlags: Interfaces.InferredFlags<typeof prewarmFlags>, environment: CliEnvironment): PrewarmQueryServiceBuildContext;
85
+ }
86
+ declare const ParameterQueryServiceBuildContext_base: new (values: QueryBuilderServiceBuildContextValues) => Readonly<QueryBuilderServiceBuildContextValues>;
87
+ /** What a parameter query is built for: which query parameters change a page. */
88
+ export declare class ParameterQueryServiceBuildContext extends ParameterQueryServiceBuildContext_base {
89
+ static readonly args: {
90
+ customerPath: Interfaces.Arg<string, {
91
+ exists?: boolean;
92
+ }>;
93
+ };
94
+ static readonly flags: {
95
+ bySet: Interfaces.BooleanFlag<boolean>;
96
+ minImpressions: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
97
+ execute: Interfaces.BooleanFlag<boolean>;
98
+ quiet: Interfaces.BooleanFlag<boolean>;
99
+ excludeNoindex: Interfaces.BooleanFlag<boolean>;
100
+ excludeSuspicious: Interfaces.BooleanFlag<boolean>;
101
+ explain: Interfaces.BooleanFlag<boolean>;
102
+ hardNavigationsOnly: Interfaces.BooleanFlag<boolean>;
103
+ days: Interfaces.OptionFlag<number, Interfaces.CustomOptions>;
104
+ configName: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
105
+ catalog: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
106
+ workgroup: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
107
+ };
108
+ readonly queryType = QueryType.parameter;
109
+ static create(parsedArgs: Interfaces.InferredArgs<typeof args>, parsedFlags: Interfaces.InferredFlags<typeof parameterFlags>, environment: CliEnvironment): ParameterQueryServiceBuildContext;
110
+ }
111
+ /** Either query's build context; the factory builds both. */
112
+ export type QueryServiceBuildContext = PrewarmQueryServiceBuildContext | ParameterQueryServiceBuildContext;
113
+ export {};
@@ -0,0 +1,68 @@
1
+ import { CLI_ATHENA } from "../athena/athena-flags.js";
2
+ import { CLI_CONFIG_NAME, CLI_CUSTOMER_CONFIG, } from "../integration-api/customer-config-flags.js";
3
+ import { CLI_QUERY_DAYS, CLI_QUERY_FILTERS, CLI_QUERY_OUTPUT, CLI_QUERY_PARAMETER, CLI_QUERY_PREWARM, } from "./query-builder-flags.js";
4
+ import { Context } from "../../models/context.js";
5
+ import { normalizeDevices } from "./queries/device.js";
6
+ import { QueryType } from "./query-builder-model.js";
7
+ const args = { ...CLI_CUSTOMER_CONFIG };
8
+ /** The flags both query commands take. */
9
+ const commonFlags = {
10
+ ...CLI_ATHENA,
11
+ ...CLI_CONFIG_NAME,
12
+ ...CLI_QUERY_DAYS,
13
+ ...CLI_QUERY_FILTERS,
14
+ ...CLI_QUERY_OUTPUT,
15
+ };
16
+ const prewarmFlags = { ...commonFlags, ...CLI_QUERY_PREWARM };
17
+ const parameterFlags = { ...commonFlags, ...CLI_QUERY_PARAMETER };
18
+ /** The values both query commands set from their common flags. */
19
+ function commonValues(parsedArgs, parsedFlags, environment) {
20
+ return {
21
+ environment,
22
+ customerPath: parsedArgs.customerPath,
23
+ configName: parsedFlags.configName,
24
+ catalog: parsedFlags.catalog,
25
+ workgroup: parsedFlags.workgroup,
26
+ days: parsedFlags.days,
27
+ excludeNoindex: parsedFlags.excludeNoindex,
28
+ excludeSuspicious: parsedFlags.excludeSuspicious,
29
+ explain: parsedFlags.explain,
30
+ hardNavigationsOnly: parsedFlags.hardNavigationsOnly,
31
+ execute: parsedFlags.execute,
32
+ quiet: parsedFlags.quiet,
33
+ isWindows: environment.oclif.windows,
34
+ };
35
+ }
36
+ /** What a prewarm query is built for: which urls of a customer to warm. */
37
+ export class PrewarmQueryServiceBuildContext extends Context() {
38
+ static args = args;
39
+ static flags = prewarmFlags;
40
+ queryType = QueryType.prewarm;
41
+ static create(parsedArgs, parsedFlags, environment) {
42
+ return new PrewarmQueryServiceBuildContext({
43
+ ...commonValues(parsedArgs, parsedFlags, environment),
44
+ count: parsedFlags.count,
45
+ excludeNotFound: parsedFlags.excludeNotFound,
46
+ limit: parsedFlags.limit,
47
+ match: parsedFlags.match,
48
+ minHits: parsedFlags.minHits,
49
+ devices: normalizeDevices(parsedFlags.device),
50
+ variations: parsedFlags.variation,
51
+ });
52
+ }
53
+ }
54
+ /** What a parameter query is built for: which query parameters change a page. */
55
+ export class ParameterQueryServiceBuildContext extends Context() {
56
+ static args = args;
57
+ static flags = parameterFlags;
58
+ queryType = QueryType.parameter;
59
+ static create(parsedArgs, parsedFlags, environment) {
60
+ return new ParameterQueryServiceBuildContext({
61
+ ...commonValues(parsedArgs, parsedFlags, environment),
62
+ bySet: parsedFlags.bySet,
63
+ minImpressions: parsedFlags.minImpressions,
64
+ });
65
+ }
66
+ }
67
+ PrewarmQueryServiceBuildContext;
68
+ ParameterQueryServiceBuildContext;
@@ -1,4 +1,4 @@
1
- import { QueryBuilderContext } from "./query-builder-model.js";
1
+ import { QueryBuilderOptions } from "./query-builder-model.js";
2
2
  import { ParsedRuleSets } from "./rules/index.js";
3
3
  import { CliServiceInterface } from "../cli/index.js";
4
4
  import { AthenaService } from "../athena/index.js";
@@ -7,7 +7,7 @@ import { AthenaService } from "../athena/index.js";
7
7
  * onboarding dashboard's query editor offers. Everything else a query is built
8
8
  * from (the app, its rule sets, the catalog) is fixed for the process.
9
9
  */
10
- export type QueryOverrides = Pick<QueryBuilderContext, "bySet" | "days" | "excludeNoindex" | "excludeSuspicious" | "hardNavigationsOnly" | "minImpressions">;
10
+ export type QueryOverrides = Pick<QueryBuilderOptions, "bySet" | "days" | "excludeNoindex" | "excludeSuspicious" | "hardNavigationsOnly" | "minImpressions">;
11
11
  /** {@link QueryOverrides} with every default filled in. */
12
12
  export type ResolvedQueryOptions = Required<QueryOverrides>;
13
13
  export declare class QueryBuilderService {
@@ -15,7 +15,7 @@ export declare class QueryBuilderService {
15
15
  private ruleSets;
16
16
  private cli;
17
17
  private athenaService?;
18
- constructor(context: QueryBuilderContext, ruleSets: ParsedRuleSets, cli: CliServiceInterface, athenaService?: AthenaService);
18
+ constructor(context: QueryBuilderOptions, ruleSets: ParsedRuleSets, cli: CliServiceInterface, athenaService?: AthenaService);
19
19
  /** The app the query targets, as read from the customer config. */
20
20
  get app(): string;
21
21
  run(): Promise<void>;
@@ -1,7 +1,7 @@
1
1
  import { parse } from "@oclif/core/parser";
2
2
  import { expect } from "chai";
3
3
  import { describe, it } from "mocha";
4
- import { CLI_QUERY_VARIATIONS } from "../cli-parameters.js";
4
+ import { CLI_QUERY_VARIATIONS } from "../query-builder-flags.js";
5
5
  async function parseFlags(argv) {
6
6
  const { flags } = await parse(argv, { flags: CLI_QUERY_VARIATIONS });
7
7
  return flags;
@@ -1,3 +1,4 @@
1
+ export * from "./revalidate-service-build-context.js";
1
2
  export * from "./revalidate-model.js";
2
3
  export * from "./revalidate-service.js";
3
4
  export * from "./revalidate-factory.js";
@@ -1,3 +1,4 @@
1
+ export * from "./revalidate-service-build-context.js";
1
2
  export * from "./revalidate-model.js";
2
3
  export * from "./revalidate-service.js";
3
4
  export * from "./revalidate-factory.js";
@@ -1,9 +1,7 @@
1
- import { CliServiceInterface } from "../cli/index.js";
2
- import { RevalidateContextInterface } from "./revalidate-model.js";
1
+ import { RevalidateServiceBuildContext } from "./revalidate-service-build-context.js";
3
2
  import { RevalidateService } from "./revalidate-service.js";
4
3
  export declare class RevalidateFactory {
5
- private context;
6
- private cli?;
7
- constructor(context: RevalidateContextInterface, cli?: CliServiceInterface);
4
+ private readonly context;
5
+ constructor(context: RevalidateServiceBuildContext);
8
6
  getService(): RevalidateService;
9
7
  }
@@ -1,16 +1,12 @@
1
- import { CliContext, CliServiceFactory, } from "../cli/index.js";
2
1
  import { ConfigApiContext, ConfigApiServiceFactory, } from "../config-api/index.js";
3
2
  import { RevalidateService } from "./revalidate-service.js";
4
3
  export class RevalidateFactory {
5
4
  context;
6
- cli;
7
- constructor(context, cli) {
5
+ constructor(context) {
8
6
  this.context = context;
9
- this.cli = cli;
10
7
  }
11
8
  getService() {
12
- const cli = this.cli ??
13
- new CliServiceFactory(new CliContext(this.context.quiet)).getService();
9
+ const cli = this.context.environment.cli;
14
10
  const configApi = new ConfigApiServiceFactory(new ConfigApiContext(this.context.app)).getService();
15
11
  return new RevalidateService(configApi, cli, this.context.app);
16
12
  }
@@ -39,12 +39,3 @@ export interface RevalidatePreviewInterface {
39
39
  count: number;
40
40
  sample: string[];
41
41
  }
42
- export interface RevalidateContextInterface {
43
- app: string;
44
- quiet: boolean;
45
- }
46
- export declare class RevalidateContext implements RevalidateContextInterface {
47
- readonly app: string;
48
- readonly quiet: boolean;
49
- constructor(app: string, quiet?: boolean);
50
- }
@@ -24,11 +24,3 @@ export const DROPPING_TYPES = new Set([
24
24
  "PURGE",
25
25
  "DEPLOYMENT",
26
26
  ]);
27
- export class RevalidateContext {
28
- app;
29
- quiet;
30
- constructor(app, quiet = false) {
31
- this.app = app;
32
- this.quiet = quiet;
33
- }
34
- }
@@ -0,0 +1,38 @@
1
+ import { Interfaces } from "@oclif/core";
2
+ import { CliEnvironment, CommandContextValues } from "../cli/index.js";
3
+ declare const args: {
4
+ app: Interfaces.Arg<string, Record<string, unknown>>;
5
+ };
6
+ declare const flags: {
7
+ pattern: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
8
+ prefix: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
9
+ query: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
10
+ type: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
11
+ dryRun: Interfaces.BooleanFlag<boolean>;
12
+ wait: Interfaces.BooleanFlag<boolean>;
13
+ yes: Interfaces.BooleanFlag<boolean>;
14
+ quiet: Interfaces.BooleanFlag<boolean>;
15
+ };
16
+ export interface RevalidateServiceBuildContextValues extends CommandContextValues {
17
+ readonly app: string;
18
+ readonly quiet: boolean;
19
+ }
20
+ declare const RevalidateServiceBuildContext_base: new (values: RevalidateServiceBuildContextValues) => Readonly<RevalidateServiceBuildContextValues>;
21
+ /** Which app `sk revalidate` purges or revalidates in. */
22
+ export declare class RevalidateServiceBuildContext extends RevalidateServiceBuildContext_base {
23
+ static readonly args: {
24
+ app: Interfaces.Arg<string, Record<string, unknown>>;
25
+ };
26
+ static readonly flags: {
27
+ pattern: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
28
+ prefix: Interfaces.OptionFlag<string[], Interfaces.CustomOptions>;
29
+ query: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
30
+ type: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
31
+ dryRun: Interfaces.BooleanFlag<boolean>;
32
+ wait: Interfaces.BooleanFlag<boolean>;
33
+ yes: Interfaces.BooleanFlag<boolean>;
34
+ quiet: Interfaces.BooleanFlag<boolean>;
35
+ };
36
+ static create(parsedArgs: Interfaces.InferredArgs<typeof args>, parsedFlags: Interfaces.InferredFlags<typeof flags>, environment: CliEnvironment): RevalidateServiceBuildContext;
37
+ }
38
+ export {};
@@ -0,0 +1,59 @@
1
+ import { Args, Flags } from "@oclif/core";
2
+ import { Context } from "../../models/context.js";
3
+ import { CONFIRMATION_THRESHOLD, REVALIDATE_TYPES, } from "./revalidate-model.js";
4
+ const args = {
5
+ app: Args.string({
6
+ name: "app",
7
+ required: true,
8
+ description: "The customer app name",
9
+ }),
10
+ };
11
+ const flags = {
12
+ ["pattern"]: Flags.string({
13
+ multiple: true,
14
+ description: 'URL pattern to purge, as a regex anchored at the scheme — mirror what the config excludes, e.g. "^https://www.example.com/en/.*-c1234$". Repeatable. The command derives the prefix the API requires from the pattern\'s literal head, and MongoDB reads that same literal as index bounds.',
15
+ }),
16
+ ["prefix"]: Flags.string({
17
+ multiple: true,
18
+ description: "URL prefix, matched against the start of the cached URL. Derived from --pattern by default; state it only to override that, or to purge a whole path without a pattern.",
19
+ }),
20
+ ["query"]: Flags.string({
21
+ description: "Raw MongoDB query on the asset fields, as JSON. An escape hatch for a rule --pattern cannot express, such as a condition on another field. It replaces the query --pattern would build.",
22
+ }),
23
+ ["type"]: Flags.string({
24
+ options: [...REVALIDATE_TYPES],
25
+ default: "REFRESH",
26
+ description: "REFRESH revalidates against origin and keeps serving the cached copy meanwhile. A URL that went out of scope needs PURGE instead: it drops the entries and does not rebuild them, which is the only type that stops serving for good.",
27
+ }),
28
+ dryRun: Flags.boolean({
29
+ char: "d",
30
+ default: false,
31
+ description: "Report the assets the filter selects and exit. Changes nothing.",
32
+ }),
33
+ ["wait"]: Flags.boolean({
34
+ default: false,
35
+ description: "Poll the job until it finishes.",
36
+ }),
37
+ ["yes"]: Flags.boolean({
38
+ default: false,
39
+ description: `Skip the confirmation a dropping job above ${CONFIRMATION_THRESHOLD} assets asks for. Required in a non-interactive shell.`,
40
+ }),
41
+ quiet: Flags.boolean({
42
+ char: "q",
43
+ default: false,
44
+ description: "less output non interactive",
45
+ }),
46
+ };
47
+ /** Which app `sk revalidate` purges or revalidates in. */
48
+ export class RevalidateServiceBuildContext extends Context() {
49
+ static args = args;
50
+ static flags = flags;
51
+ static create(parsedArgs, parsedFlags, environment) {
52
+ return new RevalidateServiceBuildContext({
53
+ environment,
54
+ app: parsedArgs["app"],
55
+ quiet: parsedFlags["quiet"],
56
+ });
57
+ }
58
+ }
59
+ RevalidateServiceBuildContext;
@@ -1,13 +1,12 @@
1
- import { CliConfig, CliServiceInterface, UserCliConfig } from "../../cli/index.js";
1
+ import { CliEnvironment, CliServiceInterface } from "../../cli/index.js";
2
2
  import { BrowserDetector } from "./browser-detector.js";
3
3
  import { BrowserManager } from "./browser-manager.js";
4
4
  export declare class BrowserSetupService {
5
5
  private readonly cli;
6
- private readonly cliConfig;
7
- private readonly userConfig;
6
+ private readonly environment;
8
7
  private readonly detector;
9
8
  private readonly manager;
10
- constructor(cli: CliServiceInterface, cliConfig: CliConfig, userConfig: UserCliConfig, detector: BrowserDetector, manager: BrowserManager);
9
+ constructor(cli: CliServiceInterface, environment: CliEnvironment, detector: BrowserDetector, manager: BrowserManager);
11
10
  /**
12
11
  * Interactive browser selection: pick a detected browser or download one via
13
12
  * puppeteer, then persist the choice.