@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
@@ -632,15 +632,17 @@
632
632
  "aliases": [],
633
633
  "args": {
634
634
  "customerPath": {
635
- "description": "The customer config path",
635
+ "description": "The customer config path (optional with --browse)",
636
636
  "name": "customerPath",
637
- "required": true
637
+ "required": false
638
638
  }
639
639
  },
640
640
  "description": "Start a local dev environment for building and testing the Speed Kit configuration",
641
641
  "examples": [
642
642
  "$ sk onboarding <customerPath> -c <configName> -d <domain>",
643
- "$ sk onboarding customers/decathlon.de -c production -d www.decathlon.de"
643
+ "$ sk onboarding customers/decathlon.de -c production -d www.decathlon.de",
644
+ "$ sk onboarding --browse -d www.decathlon.de --headless --debugPort 9290",
645
+ "$ sk onboarding customers/decathlon.de --browse -p"
644
646
  ],
645
647
  "flags": {
646
648
  "configName": {
@@ -710,6 +712,12 @@
710
712
  "allowNo": false,
711
713
  "type": "boolean"
712
714
  },
715
+ "browse": {
716
+ "description": "Open the live site in the onboarding Chrome, with its extensions, but without request interception or Speed Kit injection. Takes the domain from -d or from the customer config.",
717
+ "name": "browse",
718
+ "allowNo": false,
719
+ "type": "boolean"
720
+ },
713
721
  "browserFetch": {
714
722
  "description": "Fetch every origin document with a second headless Chrome instead of a direct request. Only needed when bot protection refuses the CLI outright — a refusal is otherwise detected and rerouted on its own.",
715
723
  "name": "browserFetch",
@@ -1283,149 +1291,6 @@
1283
1291
  "setup.js"
1284
1292
  ]
1285
1293
  },
1286
- "extension:add": {
1287
- "aliases": [],
1288
- "args": {
1289
- "ref": {
1290
- "description": "Chrome Web Store link or extension id",
1291
- "name": "ref",
1292
- "required": false
1293
- }
1294
- },
1295
- "description": "Install a Chrome extension into the onboarding browser by Web Store link or id",
1296
- "examples": [
1297
- "$ sk extension add fmkadmapgofadopljbjfkapdkoienihi",
1298
- "$ sk extension add https://chromewebstore.google.com/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi",
1299
- "$ sk extension add"
1300
- ],
1301
- "flags": {},
1302
- "hasDynamicHelp": false,
1303
- "hiddenAliases": [],
1304
- "id": "extension:add",
1305
- "pluginAlias": "@speedkit/cli",
1306
- "pluginName": "@speedkit/cli",
1307
- "pluginType": "core",
1308
- "strict": true,
1309
- "enableJsonFlag": false,
1310
- "isESM": true,
1311
- "relativePath": [
1312
- "dist",
1313
- "commands",
1314
- "extension",
1315
- "add.js"
1316
- ]
1317
- },
1318
- "extension:devtools": {
1319
- "aliases": [],
1320
- "args": {},
1321
- "description": "Install the integration-devtools extension for the onboarding browser, or update it to the latest release",
1322
- "examples": [
1323
- "$ sk extension devtools",
1324
- "$ sk extension devtools --force"
1325
- ],
1326
- "flags": {
1327
- "force": {
1328
- "description": "reinstall the latest release even when it is up to date",
1329
- "name": "force",
1330
- "allowNo": false,
1331
- "type": "boolean"
1332
- }
1333
- },
1334
- "hasDynamicHelp": false,
1335
- "hiddenAliases": [],
1336
- "id": "extension:devtools",
1337
- "pluginAlias": "@speedkit/cli",
1338
- "pluginName": "@speedkit/cli",
1339
- "pluginType": "core",
1340
- "strict": true,
1341
- "enableJsonFlag": false,
1342
- "isESM": true,
1343
- "relativePath": [
1344
- "dist",
1345
- "commands",
1346
- "extension",
1347
- "devtools.js"
1348
- ]
1349
- },
1350
- "extension:list": {
1351
- "aliases": [],
1352
- "args": {},
1353
- "description": "List Chrome extensions managed by the setup wizard",
1354
- "examples": [
1355
- "$ sk extension list"
1356
- ],
1357
- "flags": {},
1358
- "hasDynamicHelp": false,
1359
- "hiddenAliases": [],
1360
- "id": "extension:list",
1361
- "pluginAlias": "@speedkit/cli",
1362
- "pluginName": "@speedkit/cli",
1363
- "pluginType": "core",
1364
- "strict": true,
1365
- "enableJsonFlag": false,
1366
- "isESM": true,
1367
- "relativePath": [
1368
- "dist",
1369
- "commands",
1370
- "extension",
1371
- "list.js"
1372
- ]
1373
- },
1374
- "extension:remove": {
1375
- "aliases": [],
1376
- "args": {
1377
- "ref": {
1378
- "description": "Chrome Web Store link or extension id",
1379
- "name": "ref",
1380
- "required": false
1381
- }
1382
- },
1383
- "description": "Remove a managed Chrome extension",
1384
- "examples": [
1385
- "$ sk extension remove",
1386
- "$ sk extension remove <id>"
1387
- ],
1388
- "flags": {},
1389
- "hasDynamicHelp": false,
1390
- "hiddenAliases": [],
1391
- "id": "extension:remove",
1392
- "pluginAlias": "@speedkit/cli",
1393
- "pluginName": "@speedkit/cli",
1394
- "pluginType": "core",
1395
- "strict": true,
1396
- "enableJsonFlag": false,
1397
- "isESM": true,
1398
- "relativePath": [
1399
- "dist",
1400
- "commands",
1401
- "extension",
1402
- "remove.js"
1403
- ]
1404
- },
1405
- "extension:update": {
1406
- "aliases": [],
1407
- "args": {},
1408
- "description": "Check managed Chrome extensions for updates and install them",
1409
- "examples": [
1410
- "$ sk extension update"
1411
- ],
1412
- "flags": {},
1413
- "hasDynamicHelp": false,
1414
- "hiddenAliases": [],
1415
- "id": "extension:update",
1416
- "pluginAlias": "@speedkit/cli",
1417
- "pluginName": "@speedkit/cli",
1418
- "pluginType": "core",
1419
- "strict": true,
1420
- "enableJsonFlag": false,
1421
- "isESM": true,
1422
- "relativePath": [
1423
- "dist",
1424
- "commands",
1425
- "extension",
1426
- "update.js"
1427
- ]
1428
- },
1429
1294
  "query:parameter": {
1430
1295
  "aliases": [
1431
1296
  "build-parameter-query"
@@ -1736,7 +1601,150 @@
1736
1601
  "query",
1737
1602
  "prewarm.js"
1738
1603
  ]
1604
+ },
1605
+ "extension:add": {
1606
+ "aliases": [],
1607
+ "args": {
1608
+ "ref": {
1609
+ "description": "Chrome Web Store link or extension id",
1610
+ "name": "ref",
1611
+ "required": false
1612
+ }
1613
+ },
1614
+ "description": "Install a Chrome extension into the onboarding browser by Web Store link or id",
1615
+ "examples": [
1616
+ "$ sk extension add fmkadmapgofadopljbjfkapdkoienihi",
1617
+ "$ sk extension add https://chromewebstore.google.com/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi",
1618
+ "$ sk extension add"
1619
+ ],
1620
+ "flags": {},
1621
+ "hasDynamicHelp": false,
1622
+ "hiddenAliases": [],
1623
+ "id": "extension:add",
1624
+ "pluginAlias": "@speedkit/cli",
1625
+ "pluginName": "@speedkit/cli",
1626
+ "pluginType": "core",
1627
+ "strict": true,
1628
+ "enableJsonFlag": false,
1629
+ "isESM": true,
1630
+ "relativePath": [
1631
+ "dist",
1632
+ "commands",
1633
+ "extension",
1634
+ "add.js"
1635
+ ]
1636
+ },
1637
+ "extension:devtools": {
1638
+ "aliases": [],
1639
+ "args": {},
1640
+ "description": "Install the integration-devtools extension for the onboarding browser, or update it to the latest release",
1641
+ "examples": [
1642
+ "$ sk extension devtools",
1643
+ "$ sk extension devtools --force"
1644
+ ],
1645
+ "flags": {
1646
+ "force": {
1647
+ "description": "reinstall the latest release even when it is up to date",
1648
+ "name": "force",
1649
+ "allowNo": false,
1650
+ "type": "boolean"
1651
+ }
1652
+ },
1653
+ "hasDynamicHelp": false,
1654
+ "hiddenAliases": [],
1655
+ "id": "extension:devtools",
1656
+ "pluginAlias": "@speedkit/cli",
1657
+ "pluginName": "@speedkit/cli",
1658
+ "pluginType": "core",
1659
+ "strict": true,
1660
+ "enableJsonFlag": false,
1661
+ "isESM": true,
1662
+ "relativePath": [
1663
+ "dist",
1664
+ "commands",
1665
+ "extension",
1666
+ "devtools.js"
1667
+ ]
1668
+ },
1669
+ "extension:list": {
1670
+ "aliases": [],
1671
+ "args": {},
1672
+ "description": "List Chrome extensions managed by the setup wizard",
1673
+ "examples": [
1674
+ "$ sk extension list"
1675
+ ],
1676
+ "flags": {},
1677
+ "hasDynamicHelp": false,
1678
+ "hiddenAliases": [],
1679
+ "id": "extension:list",
1680
+ "pluginAlias": "@speedkit/cli",
1681
+ "pluginName": "@speedkit/cli",
1682
+ "pluginType": "core",
1683
+ "strict": true,
1684
+ "enableJsonFlag": false,
1685
+ "isESM": true,
1686
+ "relativePath": [
1687
+ "dist",
1688
+ "commands",
1689
+ "extension",
1690
+ "list.js"
1691
+ ]
1692
+ },
1693
+ "extension:remove": {
1694
+ "aliases": [],
1695
+ "args": {
1696
+ "ref": {
1697
+ "description": "Chrome Web Store link or extension id",
1698
+ "name": "ref",
1699
+ "required": false
1700
+ }
1701
+ },
1702
+ "description": "Remove a managed Chrome extension",
1703
+ "examples": [
1704
+ "$ sk extension remove",
1705
+ "$ sk extension remove <id>"
1706
+ ],
1707
+ "flags": {},
1708
+ "hasDynamicHelp": false,
1709
+ "hiddenAliases": [],
1710
+ "id": "extension:remove",
1711
+ "pluginAlias": "@speedkit/cli",
1712
+ "pluginName": "@speedkit/cli",
1713
+ "pluginType": "core",
1714
+ "strict": true,
1715
+ "enableJsonFlag": false,
1716
+ "isESM": true,
1717
+ "relativePath": [
1718
+ "dist",
1719
+ "commands",
1720
+ "extension",
1721
+ "remove.js"
1722
+ ]
1723
+ },
1724
+ "extension:update": {
1725
+ "aliases": [],
1726
+ "args": {},
1727
+ "description": "Check managed Chrome extensions for updates and install them",
1728
+ "examples": [
1729
+ "$ sk extension update"
1730
+ ],
1731
+ "flags": {},
1732
+ "hasDynamicHelp": false,
1733
+ "hiddenAliases": [],
1734
+ "id": "extension:update",
1735
+ "pluginAlias": "@speedkit/cli",
1736
+ "pluginName": "@speedkit/cli",
1737
+ "pluginType": "core",
1738
+ "strict": true,
1739
+ "enableJsonFlag": false,
1740
+ "isESM": true,
1741
+ "relativePath": [
1742
+ "dist",
1743
+ "commands",
1744
+ "extension",
1745
+ "update.js"
1746
+ ]
1739
1747
  }
1740
1748
  },
1741
- "version": "4.36.1"
1749
+ "version": "4.37.0"
1742
1750
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@speedkit/cli",
3
3
  "description": "Speed Kit CLI",
4
- "version": "4.36.1",
4
+ "version": "4.37.0",
5
5
  "author": {
6
6
  "name": "Baqend.com",
7
7
  "email": "info@baqend.com"
@@ -26,6 +26,7 @@
26
26
  "postbuild": "oclif manifest && oclif readme",
27
27
  "prepack": "npm run build",
28
28
  "test": "mocha",
29
+ "lint": "eslint src",
29
30
  "coverage": "nyc mocha",
30
31
  "coverage:report": "nyc --reporter cobertura mocha",
31
32
  "test:golden": "UPDATE_GOLDEN=1 mocha --grep \"golden queries\"",
@@ -45,7 +46,8 @@
45
46
  "ts"
46
47
  ],
47
48
  "spec": [
48
- "src/**/*.spec.ts"
49
+ "src/**/*.spec.ts",
50
+ "eslint-rules/**/*.spec.ts"
49
51
  ]
50
52
  },
51
53
  "bin": {
@@ -1,297 +0,0 @@
1
- import { Args, Flags } from "@oclif/core";
2
- // Imported from the modules rather than from the query-builder barrels: this
3
- // file is loaded by every command, and the rules barrel pulls in the automata
4
- // library.
5
- import { parseMatchPattern } from "../services/query-builder/rules/match-pattern.js";
6
- import { DEVICE_VARIATIONS } from "../services/query-builder/queries/device.js";
7
- import { DEFAULT_ATHENA_CATALOG } from "../services/athena/athena-service-model.js";
8
- export var CLIParameters;
9
- (function (CLIParameters) {
10
- CLIParameters["AppName"] = "app";
11
- CLIParameters["Artifacts"] = "artifacts";
12
- CLIParameters["ConfigName"] = "configName";
13
- CLIParameters["ContentTypes"] = "contentTypes";
14
- CLIParameters["Catalog"] = "catalog";
15
- CLIParameters["Cookies"] = "cookies";
16
- CLIParameters["Count"] = "count";
17
- CLIParameters["CustomerPath"] = "customerPath";
18
- CLIParameters["CustomersDirectory"] = "customersDirectory";
19
- CLIParameters["Days"] = "days";
20
- CLIParameters["Delay"] = "delay";
21
- CLIParameters["Device"] = "device";
22
- CLIParameters["Domain"] = "domain";
23
- CLIParameters["DryRun"] = "dryRun";
24
- CLIParameters["Execute"] = "execute";
25
- CLIParameters["BySet"] = "bySet";
26
- CLIParameters["ExcludeNoindex"] = "excludeNoindex";
27
- CLIParameters["ExcludeNotFound"] = "excludeNotFound";
28
- CLIParameters["ExcludeSuspicious"] = "excludeSuspicious";
29
- CLIParameters["Explain"] = "explain";
30
- CLIParameters["Group"] = "group";
31
- CLIParameters["HardNavigationsOnly"] = "hardNavigationsOnly";
32
- CLIParameters["HideDiff"] = "hideDiff";
33
- CLIParameters["Ips"] = "ips";
34
- CLIParameters["KeepParameterSorting"] = "keepParameterSorting";
35
- CLIParameters["Limit"] = "limit";
36
- CLIParameters["Match"] = "match";
37
- CLIParameters["MinHits"] = "minHits";
38
- CLIParameters["MinImpressions"] = "minImpressions";
39
- CLIParameters["Quiet"] = "quiet";
40
- CLIParameters["Mobile"] = "mobile";
41
- CLIParameters["PageUrl"] = "pageUrl";
42
- CLIParameters["Path"] = "path";
43
- CLIParameters["SlackToken"] = "slackToken";
44
- CLIParameters["TestId"] = "testId";
45
- CLIParameters["Urls"] = "urls";
46
- CLIParameters["Variation"] = "variation";
47
- CLIParameters["VariationPath"] = "variationPath";
48
- CLIParameters["Verbose"] = "verbose";
49
- CLIParameters["Workgroup"] = "workgroup";
50
- CLIParameters["useTestConfig"] = "useTestConfig";
51
- })(CLIParameters || (CLIParameters = {}));
52
- /* eslint-disable @typescript-eslint/no-duplicate-enum-values */
53
- export var CLIParametersChar;
54
- (function (CLIParametersChar) {
55
- CLIParametersChar["AppName"] = "a";
56
- CLIParametersChar["Artifacts"] = "a";
57
- CLIParametersChar["ConfigName"] = "c";
58
- CLIParametersChar["ContentTypes"] = "c";
59
- CLIParametersChar["Cookies"] = "c";
60
- CLIParametersChar["CustomerPath"] = "p";
61
- CLIParametersChar["CustomersDirectory"] = "d";
62
- CLIParametersChar["Days"] = "d";
63
- CLIParametersChar["Delay"] = "d";
64
- CLIParametersChar["Domain"] = "d";
65
- CLIParametersChar["DryRun"] = "d";
66
- CLIParametersChar["Execute"] = "e";
67
- CLIParametersChar["Group"] = "g";
68
- CLIParametersChar["HideDiff"] = "h";
69
- CLIParametersChar["Ips"] = "i";
70
- CLIParametersChar["KeepParameterSorting"] = "k";
71
- CLIParametersChar["Mobile"] = "m";
72
- CLIParametersChar["SlackToken"] = "t";
73
- CLIParametersChar["Path"] = "p";
74
- CLIParametersChar["Variation"] = "v";
75
- CLIParametersChar["VariationPath"] = "p";
76
- CLIParametersChar["Quiet"] = "q";
77
- CLIParametersChar["useTestConfig"] = "t";
78
- })(CLIParametersChar || (CLIParametersChar = {}));
79
- /* eslint-enable @typescript-eslint/no-duplicate-enum-values */
80
- export var CLIParametersExample;
81
- (function (CLIParametersExample) {
82
- CLIParametersExample["AppName"] = "decathlon";
83
- CLIParametersExample["Artifacts"] = "dynamic,SpeedKit";
84
- CLIParametersExample["ConfigName"] = "production";
85
- CLIParametersExample["ContentTypes"] = "image,style";
86
- CLIParametersExample["Cookies"] = "consentCookies";
87
- CLIParametersExample["CustomerPath"] = "customers/decathlon.de";
88
- CLIParametersExample["CustomersDirectory"] = "customers";
89
- CLIParametersExample["Delay"] = "1200";
90
- CLIParametersExample["Devices"] = "desktop,mobile";
91
- CLIParametersExample["Domain"] = "www.decathlon.de";
92
- CLIParametersExample["Group"] = "B";
93
- CLIParametersExample["Ips"] = "151.101.120.194";
94
- CLIParametersExample["Match"] = "^/p/";
95
- CLIParametersExample["Mobile"] = "Y";
96
- CLIParametersExample["PageUrl"] = "https://www.decathlon.de/";
97
- CLIParametersExample["Path"] = "C:\\Users\\testUser\\file.csv";
98
- CLIParametersExample["SlackToken"] = "someSlackToken";
99
- CLIParametersExample["TestId"] = "listing-50vs50";
100
- CLIParametersExample["Urls"] = "url1,url2,url3";
101
- CLIParametersExample["Variation"] = "MOBILE";
102
- CLIParametersExample["Variations"] = "MOBILE,DESKTOP";
103
- CLIParametersExample["VariationPath"] = "C:\\Users\\testUser\\variations.csv";
104
- })(CLIParametersExample || (CLIParametersExample = {}));
105
- export const CLI_CONFIG_NAME = {
106
- [CLIParameters.ConfigName]: Flags.string({
107
- char: CLIParametersChar.ConfigName,
108
- default: "production",
109
- description: "The costumer config name",
110
- required: false,
111
- }),
112
- };
113
- // to enable testMode for deploy and onboarding command
114
- // it will set the field app to the configured testApp
115
- // and name to the original configured app
116
- export const CLI_CONFIG_IS_TEST = {
117
- [CLIParameters.useTestConfig]: Flags.boolean({
118
- char: CLIParametersChar.useTestConfig,
119
- description: "Override app with configured testApp",
120
- }),
121
- };
122
- /** Shared wording, so every query command describes the window the same way. */
123
- export const CLI_QUERY_DAYS_DESCRIPTION = "Number of days the query looks back";
124
- /**
125
- * How far back a query looks. Its own object because `generate-pop-config`
126
- * takes it without the `-d` shorthand, which `--deploy` holds there.
127
- */
128
- export const CLI_QUERY_DAYS = {
129
- [CLIParameters.Days]: Flags.integer({
130
- char: CLIParametersChar.Days,
131
- description: CLI_QUERY_DAYS_DESCRIPTION,
132
- min: 1,
133
- required: false,
134
- }),
135
- };
136
- /**
137
- * What a query command does with the query it built. Both commands take them,
138
- * so a query can be piped or run without a detour through the clipboard.
139
- */
140
- export const CLI_QUERY_OUTPUT = {
141
- [CLIParameters.Execute]: Flags.boolean({
142
- char: CLIParametersChar.Execute,
143
- default: false,
144
- description: "Execute the query directly and write the result to a <app>-<date>-<query>.csv file",
145
- }),
146
- [CLIParameters.Quiet]: Flags.boolean({
147
- char: CLIParametersChar.Quiet,
148
- default: false,
149
- description: "Output only the raw query without clipboard copy or styling",
150
- }),
151
- };
152
- /**
153
- * Which page impressions a query leaves out, and whether to account for every
154
- * rule it does not carry over literally. Bots are always excluded.
155
- */
156
- export const CLI_QUERY_FILTERS = {
157
- [CLIParameters.ExcludeNoindex]: Flags.boolean({
158
- default: false,
159
- description: "Exclude page impressions of pages marked noindex",
160
- }),
161
- [CLIParameters.ExcludeSuspicious]: Flags.boolean({
162
- default: false,
163
- description: "Exclude page impressions Speed Kit classified as suspicious",
164
- }),
165
- [CLIParameters.Explain]: Flags.boolean({
166
- default: false,
167
- description: "Account for every rule the query leaves out, reduces or approximates",
168
- }),
169
- [CLIParameters.HardNavigationsOnly]: Flags.boolean({
170
- default: false,
171
- description: "Exclude soft (SPA) navigations",
172
- }),
173
- };
174
- /**
175
- * Which variation the pre-warm list carries per url, instead of leaving the
176
- * pre-warmer to request every url in every variation.
177
- *
178
- * The two flags answer the same question from two different sources — the
179
- * traffic, or the operator — so combining them would cross-produce the list
180
- * again, which is what they are there to stop. A command that also reads a
181
- * variations file from disk excludes that one on its own side.
182
- */
183
- export const CLI_QUERY_VARIATIONS = {
184
- [CLIParameters.Device]: Flags.string({
185
- delimiter: ",",
186
- 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",
187
- exclusive: [CLIParameters.Variation],
188
- multiple: true,
189
- options: [...DEVICE_VARIATIONS],
190
- required: false,
191
- }),
192
- [CLIParameters.Variation]: Flags.string({
193
- char: CLIParametersChar.Variation,
194
- delimiter: ",",
195
- 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'",
196
- exclusive: [CLIParameters.Device],
197
- multiple: true,
198
- required: false,
199
- }),
200
- };
201
- /**
202
- * What the pre-warm query keeps of a long tail that is mostly seen once.
203
- *
204
- * Every flag here shapes the list itself, so a command that builds that list
205
- * takes all of them — `sk auto-prewarm` included, or a count could describe a
206
- * list the pre-warmer would never produce.
207
- */
208
- export const CLI_QUERY_PREWARM_LIST = {
209
- ...CLI_QUERY_VARIATIONS,
210
- [CLIParameters.ExcludeNotFound]: Flags.boolean({
211
- default: false,
212
- description: "Leave out urls the origin answers with a 404 more often than not",
213
- }),
214
- [CLIParameters.Limit]: Flags.integer({
215
- description: "Keep only the most requested urls",
216
- min: 1,
217
- required: false,
218
- }),
219
- [CLIParameters.Match]: Flags.string({
220
- 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",
221
- multiple: true,
222
- parse: async (input) => {
223
- try {
224
- parseMatchPattern(input);
225
- }
226
- catch (error) {
227
- throw new Error(`--match ${input} is not a regular expression: ${error.message}`, { cause: error });
228
- }
229
- return input;
230
- },
231
- required: false,
232
- }),
233
- [CLIParameters.MinHits]: Flags.integer({
234
- description: "Keep only urls requested at least this often in the window",
235
- min: 1,
236
- required: false,
237
- }),
238
- };
239
- /**
240
- * The pre-warm query flags in full: the list-shaping ones plus `--count`, which
241
- * reports the list's size instead of returning it. Only a command that can
242
- * answer with a count takes this one — `sk auto-prewarm` warms the list, so it
243
- * takes {@link CLI_QUERY_PREWARM_LIST} instead.
244
- */
245
- export const CLI_QUERY_PREWARM = {
246
- ...CLI_QUERY_PREWARM_LIST,
247
- [CLIParameters.Count]: Flags.boolean({
248
- default: false,
249
- 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",
250
- exclusive: [CLIParameters.Execute],
251
- }),
252
- };
253
- /**
254
- * Where a query that is executed actually runs.
255
- *
256
- * The catalog is the account's, not the query's: our own logins reach the rum
257
- * tables under `live`, while a role scoped to one account reaches the same
258
- * tables under `AwsDataCatalog`. `SK_ATHENA_CATALOG` lets a CI job say so once.
259
- *
260
- * Athena resolves the account's default workgroup when none is named, which is
261
- * only right where the credentials are allowed to use it — a role scoped to one
262
- * workgroup is refused on any other, and the result location is a workgroup
263
- * setting too. `SK_ATHENA_WORKGROUP` lets a CI job set it once for every
264
- * command in the job.
265
- */
266
- export const CLI_ATHENA = {
267
- [CLIParameters.Catalog]: Flags.string({
268
- default: DEFAULT_ATHENA_CATALOG,
269
- description: "Athena data catalog holding the rum tables. Names the catalog both in the query and in the context it runs in, so the two always agree",
270
- env: "SK_ATHENA_CATALOG",
271
- required: false,
272
- }),
273
- [CLIParameters.Workgroup]: Flags.string({
274
- description: "Athena workgroup to run the query in, e.g. 'prewarming'. Defaults to the account's default workgroup",
275
- env: "SK_ATHENA_WORKGROUP",
276
- required: false,
277
- }),
278
- };
279
- /** How the parameter query presents what it found. */
280
- export const CLI_QUERY_PARAMETER = {
281
- [CLIParameters.BySet]: Flags.boolean({
282
- default: false,
283
- description: "Rank whole sets of parameters instead of single parameters, to see which ones travel together",
284
- }),
285
- [CLIParameters.MinImpressions]: Flags.integer({
286
- description: "Leave out parameters seen on fewer page impressions than this",
287
- min: 1,
288
- required: false,
289
- }),
290
- };
291
- export const CLI_CUSTOMER_CONFIG = {
292
- [CLIParameters.CustomerPath]: Args.directory({
293
- name: CLIParameters.CustomerPath,
294
- required: true,
295
- description: "The customer config path",
296
- }),
297
- };