piral-cli 1.0.0-pre.2217 → 1.0.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 (408) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +30 -7
  3. package/lib/api.js +23 -23
  4. package/lib/api.js.map +1 -1
  5. package/lib/apps/add-piral-instance-pilet.d.ts +26 -0
  6. package/lib/apps/add-piral-instance-pilet.js +53 -0
  7. package/lib/apps/add-piral-instance-pilet.js.map +1 -0
  8. package/lib/apps/build-pilet.d.ts +33 -2
  9. package/lib/apps/build-pilet.js +159 -32
  10. package/lib/apps/build-pilet.js.map +1 -1
  11. package/lib/apps/build-piral.d.ts +18 -1
  12. package/lib/apps/build-piral.js +68 -52
  13. package/lib/apps/build-piral.js.map +1 -1
  14. package/lib/apps/debug-pilet.d.ts +38 -2
  15. package/lib/apps/debug-pilet.js +150 -108
  16. package/lib/apps/debug-pilet.js.map +1 -1
  17. package/lib/apps/debug-piral.d.ts +23 -0
  18. package/lib/apps/debug-piral.js +63 -52
  19. package/lib/apps/debug-piral.js.map +1 -1
  20. package/lib/apps/declaration-piral.js +5 -3
  21. package/lib/apps/declaration-piral.js.map +1 -1
  22. package/lib/apps/index.d.ts +3 -0
  23. package/lib/apps/index.js +8 -1
  24. package/lib/apps/index.js.map +1 -1
  25. package/lib/apps/new-pilet.d.ts +7 -3
  26. package/lib/apps/new-pilet.js +47 -52
  27. package/lib/apps/new-pilet.js.map +1 -1
  28. package/lib/apps/new-piral.d.ts +7 -3
  29. package/lib/apps/new-piral.js +33 -23
  30. package/lib/apps/new-piral.js.map +1 -1
  31. package/lib/apps/pack-pilet.d.ts +9 -0
  32. package/lib/apps/pack-pilet.js +6 -13
  33. package/lib/apps/pack-pilet.js.map +1 -1
  34. package/lib/apps/publish-pilet.d.ts +23 -3
  35. package/lib/apps/publish-pilet.js +112 -62
  36. package/lib/apps/publish-pilet.js.map +1 -1
  37. package/lib/apps/publish-piral.d.ts +6 -2
  38. package/lib/apps/publish-piral.js +30 -26
  39. package/lib/apps/publish-piral.js.map +1 -1
  40. package/lib/apps/remove-piral-instance-pilet.d.ts +22 -0
  41. package/lib/apps/remove-piral-instance-pilet.js +52 -0
  42. package/lib/apps/remove-piral-instance-pilet.js.map +1 -0
  43. package/lib/apps/run-emulator-piral.d.ts +34 -0
  44. package/lib/apps/run-emulator-piral.js +91 -0
  45. package/lib/apps/run-emulator-piral.js.map +1 -0
  46. package/lib/apps/upgrade-pilet.d.ts +6 -2
  47. package/lib/apps/upgrade-pilet.js +41 -43
  48. package/lib/apps/upgrade-pilet.js.map +1 -1
  49. package/lib/apps/upgrade-piral.d.ts +2 -2
  50. package/lib/apps/upgrade-piral.js +21 -20
  51. package/lib/apps/upgrade-piral.js.map +1 -1
  52. package/lib/apps/validate-pilet.js +30 -36
  53. package/lib/apps/validate-pilet.js.map +1 -1
  54. package/lib/apps/validate-piral.js +13 -10
  55. package/lib/apps/validate-piral.js.map +1 -1
  56. package/lib/build/bundler-calls.d.ts +3 -0
  57. package/lib/build/bundler-calls.js +117 -0
  58. package/lib/build/bundler-calls.js.map +1 -0
  59. package/lib/build/run-build-pilet.d.ts +1 -0
  60. package/lib/build/run-build-pilet.js +65 -0
  61. package/lib/build/run-build-pilet.js.map +1 -0
  62. package/lib/build/run-build-piral.d.ts +1 -0
  63. package/lib/build/run-build-piral.js +67 -0
  64. package/lib/build/run-build-piral.js.map +1 -0
  65. package/lib/build/run-debug-mono-piral.d.ts +1 -0
  66. package/lib/build/run-debug-mono-piral.js +70 -0
  67. package/lib/build/run-debug-mono-piral.js.map +1 -0
  68. package/lib/build/run-debug-pilet.d.ts +1 -0
  69. package/lib/build/run-debug-pilet.js +89 -0
  70. package/lib/build/run-debug-pilet.js.map +1 -0
  71. package/lib/build/run-debug-piral.d.ts +1 -0
  72. package/lib/build/run-debug-piral.js +85 -0
  73. package/lib/build/run-debug-piral.js.map +1 -0
  74. package/lib/bundler.js +75 -26
  75. package/lib/bundler.js.map +1 -1
  76. package/lib/cli.js +7 -4
  77. package/lib/cli.js.map +1 -1
  78. package/lib/commands.js +266 -46
  79. package/lib/commands.js.map +1 -1
  80. package/lib/common/archive.d.ts +4 -0
  81. package/lib/common/archive.js +31 -10
  82. package/lib/common/archive.js.map +1 -1
  83. package/lib/common/browser.d.ts +2 -1
  84. package/lib/common/browser.js +17 -8
  85. package/lib/common/browser.js.map +1 -1
  86. package/lib/common/clients/index.d.ts +21 -0
  87. package/lib/common/clients/index.js +48 -0
  88. package/lib/common/clients/index.js.map +1 -0
  89. package/lib/common/clients/lerna.d.ts +7 -1
  90. package/lib/common/clients/lerna.js +93 -7
  91. package/lib/common/clients/lerna.js.map +1 -1
  92. package/lib/common/clients/npm.d.ts +6 -1
  93. package/lib/common/clients/npm.js +66 -18
  94. package/lib/common/clients/npm.js.map +1 -1
  95. package/lib/common/clients/pnp.d.ts +7 -0
  96. package/lib/common/clients/pnp.js +104 -0
  97. package/lib/common/clients/pnp.js.map +1 -0
  98. package/lib/common/clients/pnpm.d.ts +5 -0
  99. package/lib/common/clients/pnpm.js +55 -6
  100. package/lib/common/clients/pnpm.js.map +1 -1
  101. package/lib/common/clients/rush.d.ts +7 -0
  102. package/lib/common/clients/rush.js +127 -0
  103. package/lib/common/clients/rush.js.map +1 -0
  104. package/lib/common/clients/yarn.d.ts +5 -0
  105. package/lib/common/clients/yarn.js +57 -6
  106. package/lib/common/clients/yarn.js.map +1 -1
  107. package/lib/common/compatibility.js +14 -9
  108. package/lib/common/compatibility.js.map +1 -1
  109. package/lib/common/config.d.ts +52 -1
  110. package/lib/common/config.js +10 -30
  111. package/lib/common/config.js.map +1 -1
  112. package/lib/common/constants.d.ts +10 -2
  113. package/lib/common/constants.js +22 -4
  114. package/lib/common/constants.js.map +1 -1
  115. package/lib/common/declaration.d.ts +2 -1
  116. package/lib/common/declaration.js +113 -56
  117. package/lib/common/declaration.js.map +1 -1
  118. package/lib/common/emoji.d.ts +8 -0
  119. package/lib/common/emoji.js +10 -1
  120. package/lib/common/emoji.js.map +1 -1
  121. package/lib/common/emulator.d.ts +2 -2
  122. package/lib/common/emulator.js +45 -32
  123. package/lib/common/emulator.js.map +1 -1
  124. package/lib/common/enums.d.ts +0 -4
  125. package/lib/common/enums.js +1 -6
  126. package/lib/common/enums.js.map +1 -1
  127. package/lib/common/envs.js +16 -5
  128. package/lib/common/envs.js.map +1 -1
  129. package/lib/common/hash.d.ts +1 -0
  130. package/lib/common/hash.js +8 -3
  131. package/lib/common/hash.js.map +1 -1
  132. package/lib/common/http.d.ts +5 -2
  133. package/lib/common/http.js +65 -23
  134. package/lib/common/http.js.map +1 -1
  135. package/lib/common/importmap.d.ts +2 -0
  136. package/lib/common/importmap.js +202 -0
  137. package/lib/common/importmap.js.map +1 -0
  138. package/lib/common/index.d.ts +10 -0
  139. package/lib/common/index.js +15 -1
  140. package/lib/common/index.js.map +1 -1
  141. package/lib/common/info.d.ts +5 -0
  142. package/lib/common/info.js +9 -2
  143. package/lib/common/info.js.map +1 -1
  144. package/lib/common/injectors.d.ts +36 -8
  145. package/lib/common/injectors.js +46 -19
  146. package/lib/common/injectors.js.map +1 -1
  147. package/lib/common/inspect.d.ts +5 -3
  148. package/lib/common/inspect.js +15 -15
  149. package/lib/common/inspect.js.map +1 -1
  150. package/lib/common/interactive.d.ts +9 -0
  151. package/lib/common/interactive.js +60 -1
  152. package/lib/common/interactive.js.map +1 -1
  153. package/lib/common/io.d.ts +9 -3
  154. package/lib/common/io.js +219 -116
  155. package/lib/common/io.js.map +1 -1
  156. package/lib/common/language.d.ts +9 -6
  157. package/lib/common/language.js +68 -12
  158. package/lib/common/language.js.map +1 -1
  159. package/lib/common/log.d.ts +5 -3
  160. package/lib/common/log.js +34 -48
  161. package/lib/common/log.js.map +1 -1
  162. package/lib/common/npm.d.ts +17 -16
  163. package/lib/common/npm.js +262 -158
  164. package/lib/common/npm.js.map +1 -1
  165. package/lib/common/pack.js +47 -26
  166. package/lib/common/pack.js.map +1 -1
  167. package/lib/common/package.d.ts +43 -20
  168. package/lib/common/package.js +377 -213
  169. package/lib/common/package.js.map +1 -1
  170. package/lib/common/parallel.d.ts +1 -0
  171. package/lib/common/parallel.js +29 -0
  172. package/lib/common/parallel.js.map +1 -0
  173. package/lib/common/patcher.js +20 -20
  174. package/lib/common/patcher.js.map +1 -1
  175. package/lib/common/platform.d.ts +13 -0
  176. package/lib/common/platform.js +29 -0
  177. package/lib/common/platform.js.map +1 -0
  178. package/lib/common/port.d.ts +1 -0
  179. package/lib/common/port.js +14 -4
  180. package/lib/common/port.js.map +1 -1
  181. package/lib/common/rules.js +4 -4
  182. package/lib/common/rules.js.map +1 -1
  183. package/lib/common/scaffold.d.ts +18 -4
  184. package/lib/common/scaffold.js +59 -36
  185. package/lib/common/scaffold.js.map +1 -1
  186. package/lib/common/scripts.js +8 -8
  187. package/lib/common/scripts.js.map +1 -1
  188. package/lib/common/shell.d.ts +2 -0
  189. package/lib/common/shell.js +33 -0
  190. package/lib/common/shell.js.map +1 -0
  191. package/lib/common/spec.d.ts +29 -0
  192. package/lib/common/spec.js +69 -0
  193. package/lib/common/spec.js.map +1 -0
  194. package/lib/common/template.d.ts +1 -2
  195. package/lib/common/template.js +23 -22
  196. package/lib/common/template.js.map +1 -1
  197. package/lib/common/url.d.ts +1 -0
  198. package/lib/common/url.js +17 -0
  199. package/lib/common/url.js.map +1 -0
  200. package/lib/common/utils.d.ts +1 -0
  201. package/lib/common/utils.js +8 -0
  202. package/lib/common/utils.js.map +1 -0
  203. package/lib/common/version.d.ts +2 -0
  204. package/lib/common/version.js +130 -0
  205. package/lib/common/version.js.map +1 -0
  206. package/lib/common/watcher.d.ts +13 -0
  207. package/lib/common/watcher.js +78 -0
  208. package/lib/common/watcher.js.map +1 -0
  209. package/lib/external/index.js +59413 -57862
  210. package/lib/helpers.d.ts +6 -6
  211. package/lib/helpers.js +10 -25
  212. package/lib/helpers.js.map +1 -1
  213. package/lib/index.js +5 -1
  214. package/lib/index.js.map +1 -1
  215. package/lib/inject.js +2 -2
  216. package/lib/inject.js.map +1 -1
  217. package/lib/injectors/pilet-injector.d.ts +75 -0
  218. package/lib/injectors/pilet-injector.js +246 -0
  219. package/lib/injectors/pilet-injector.js.map +1 -0
  220. package/lib/injectors/{piral.d.ts → piral-injector.d.ts} +10 -2
  221. package/lib/injectors/piral-injector.js +97 -0
  222. package/lib/injectors/piral-injector.js.map +1 -0
  223. package/lib/messages.d.ts +567 -47
  224. package/lib/messages.js +638 -51
  225. package/lib/messages.js.map +1 -1
  226. package/lib/pb-cli.js +1 -1
  227. package/lib/pb-cli.js.map +1 -1
  228. package/lib/pilet-cli.js +1 -1
  229. package/lib/pilet-cli.js.map +1 -1
  230. package/lib/piral-cli.js +1 -1
  231. package/lib/piral-cli.js.map +1 -1
  232. package/lib/platforms/node.d.ts +8 -0
  233. package/lib/platforms/node.js +30 -0
  234. package/lib/platforms/node.js.map +1 -0
  235. package/lib/platforms/web.d.ts +8 -0
  236. package/lib/platforms/web.js +120 -0
  237. package/lib/platforms/web.js.map +1 -0
  238. package/lib/plugin.js +36 -11
  239. package/lib/plugin.js.map +1 -1
  240. package/lib/questionnaire.d.ts +1 -1
  241. package/lib/questionnaire.js +9 -4
  242. package/lib/questionnaire.js.map +1 -1
  243. package/lib/release.d.ts +1 -1
  244. package/lib/release.js +38 -6
  245. package/lib/release.js.map +1 -1
  246. package/lib/resolvers.js +13 -13
  247. package/lib/resolvers.js.map +1 -1
  248. package/lib/rules/index.js +8 -8
  249. package/lib/rules/index.js.map +1 -1
  250. package/lib/rules/pilet-has-externals-as-peers.d.ts +1 -1
  251. package/lib/rules/pilet-has-externals-as-peers.js +9 -7
  252. package/lib/rules/pilet-has-externals-as-peers.js.map +1 -1
  253. package/lib/rules/pilet-has-no-self-reference.d.ts +1 -1
  254. package/lib/rules/pilet-has-no-self-reference.js +2 -2
  255. package/lib/rules/pilet-has-no-self-reference.js.map +1 -1
  256. package/lib/rules/pilet-has-no-third-party-dependency.d.ts +1 -1
  257. package/lib/rules/pilet-stays-small.d.ts +1 -1
  258. package/lib/rules/pilet-stays-small.js +4 -4
  259. package/lib/rules/pilet-stays-small.js.map +1 -1
  260. package/lib/rules/pilet-uses-latest-piral.d.ts +1 -1
  261. package/lib/rules/pilet-uses-latest-piral.js +18 -9
  262. package/lib/rules/pilet-uses-latest-piral.js.map +1 -1
  263. package/lib/rules/piral-depends-on-piral.d.ts +1 -1
  264. package/lib/rules/piral-entry-ends-with-html.d.ts +1 -1
  265. package/lib/rules/piral-entry-ends-with-html.js +1 -1
  266. package/lib/rules/piral-entry-ends-with-html.js.map +1 -1
  267. package/lib/rules/piral-has-valid-devDependencies.d.ts +1 -1
  268. package/lib/rules/piral-has-valid-externals.d.ts +1 -1
  269. package/lib/rules/piral-has-valid-externals.js +10 -24
  270. package/lib/rules/piral-has-valid-externals.js.map +1 -1
  271. package/lib/rules/piral-has-valid-files.d.ts +1 -1
  272. package/lib/rules/piral-has-valid-files.js +5 -5
  273. package/lib/rules/piral-has-valid-files.js.map +1 -1
  274. package/lib/rules/piral-has-valid-scripts.d.ts +1 -1
  275. package/lib/runner.js +1 -1
  276. package/lib/runner.js.map +1 -1
  277. package/lib/select.js +6 -6
  278. package/lib/select.js.map +1 -1
  279. package/lib/types/common.d.ts +88 -8
  280. package/lib/types/common.js.map +1 -1
  281. package/lib/types/index.js +5 -1
  282. package/lib/types/index.js.map +1 -1
  283. package/lib/types/internal.d.ts +12 -13
  284. package/lib/types/public.d.ts +89 -23
  285. package/package.json +19 -16
  286. package/src/apps/add-piral-instance-pilet.ts +98 -0
  287. package/src/apps/build-pilet.ts +286 -38
  288. package/src/apps/build-piral.test.ts +20 -7
  289. package/src/apps/build-piral.ts +90 -39
  290. package/src/apps/debug-pilet.ts +229 -123
  291. package/src/apps/debug-piral.ts +121 -68
  292. package/src/apps/declaration-piral.ts +4 -2
  293. package/src/apps/index.ts +3 -0
  294. package/src/apps/new-pilet.test.ts +28 -11
  295. package/src/apps/new-pilet.ts +60 -48
  296. package/src/apps/new-piral.test.ts +25 -13
  297. package/src/apps/new-piral.ts +43 -19
  298. package/src/apps/pack-pilet.test.ts +2 -2
  299. package/src/apps/pack-pilet.ts +12 -10
  300. package/src/apps/publish-pilet.ts +148 -43
  301. package/src/apps/publish-piral.ts +38 -11
  302. package/src/apps/remove-piral-instance-pilet.ts +92 -0
  303. package/src/apps/run-emulator-piral.ts +154 -0
  304. package/src/apps/upgrade-pilet.ts +37 -31
  305. package/src/apps/upgrade-piral.ts +9 -7
  306. package/src/apps/validate-pilet.ts +30 -22
  307. package/src/apps/validate-piral.ts +5 -2
  308. package/src/build/bundler-calls.ts +133 -0
  309. package/src/build/run-build-pilet.ts +91 -0
  310. package/src/build/run-build-piral.ts +93 -0
  311. package/src/build/run-debug-mono-piral.ts +86 -0
  312. package/src/build/run-debug-pilet.ts +116 -0
  313. package/src/build/run-debug-piral.ts +105 -0
  314. package/src/bundler.test.ts +86 -68
  315. package/src/bundler.ts +74 -19
  316. package/src/cli.ts +6 -2
  317. package/src/commands.ts +273 -44
  318. package/src/common/archive.test.ts +51 -45
  319. package/src/common/archive.ts +28 -1
  320. package/src/common/browser.test.ts +20 -10
  321. package/src/common/browser.ts +13 -6
  322. package/src/common/clients/index.ts +41 -0
  323. package/src/common/clients/lerna.ts +85 -1
  324. package/src/common/clients/npm.ts +56 -14
  325. package/src/common/clients/pnp.ts +84 -0
  326. package/src/common/clients/pnpm.ts +45 -1
  327. package/src/common/clients/rush.ts +118 -0
  328. package/src/common/clients/yarn.ts +49 -3
  329. package/src/common/compatibility.ts +8 -1
  330. package/src/common/config.ts +57 -22
  331. package/src/common/constants.ts +21 -3
  332. package/src/common/declaration.ts +124 -50
  333. package/src/common/emoji.ts +9 -0
  334. package/src/common/emulator.ts +43 -23
  335. package/src/common/enums.ts +0 -5
  336. package/src/common/envs.ts +15 -3
  337. package/src/common/hash.ts +5 -0
  338. package/src/common/http.test.ts +76 -64
  339. package/src/common/http.ts +88 -24
  340. package/src/common/importmap.ts +242 -0
  341. package/src/common/index.ts +10 -0
  342. package/src/common/info.ts +9 -1
  343. package/src/common/injectors.ts +49 -22
  344. package/src/common/inspect.ts +13 -14
  345. package/src/common/interactive.test.ts +6 -0
  346. package/src/common/interactive.ts +69 -1
  347. package/src/common/io.ts +199 -82
  348. package/src/common/language.ts +87 -10
  349. package/src/common/log.ts +32 -46
  350. package/src/common/npm.test.ts +187 -166
  351. package/src/common/npm.ts +263 -119
  352. package/src/common/pack.test.ts +11 -13
  353. package/src/common/pack.ts +60 -21
  354. package/src/common/package.test.ts +59 -49
  355. package/src/common/package.ts +406 -167
  356. package/src/common/parallel.test.ts +28 -0
  357. package/src/common/parallel.ts +21 -0
  358. package/src/common/platform.ts +31 -0
  359. package/src/common/port.test.ts +4 -1
  360. package/src/common/port.ts +10 -0
  361. package/src/common/rules.test.ts +3 -3
  362. package/src/common/scaffold.ts +69 -41
  363. package/src/common/scripts.ts +5 -4
  364. package/src/common/shell.ts +34 -0
  365. package/src/common/spec.ts +69 -0
  366. package/src/common/template.ts +20 -18
  367. package/src/common/url.test.ts +28 -0
  368. package/src/common/url.ts +15 -0
  369. package/src/common/utils.ts +3 -0
  370. package/src/common/version.test.ts +233 -0
  371. package/src/common/version.ts +142 -0
  372. package/src/common/watcher.ts +89 -0
  373. package/src/external/index.test.ts +2 -2
  374. package/src/external/index.ts +7 -3
  375. package/src/external/resolve.ts +29 -0
  376. package/src/helpers.test.ts +2 -22
  377. package/src/helpers.ts +21 -30
  378. package/src/injectors/{pilet.test.ts → pilet-injector.test.ts} +13 -4
  379. package/src/injectors/pilet-injector.ts +346 -0
  380. package/src/injectors/{piral.test.ts → piral-injector.test.ts} +14 -5
  381. package/src/injectors/piral-injector.ts +130 -0
  382. package/src/messages.ts +649 -63
  383. package/src/platforms/node.ts +16 -0
  384. package/src/platforms/web.ts +148 -0
  385. package/src/plugin.ts +34 -5
  386. package/src/questionnaire.ts +17 -3
  387. package/src/release.ts +47 -5
  388. package/src/rules/index.ts +1 -1
  389. package/src/rules/pilet-has-externals-as-peers.test.ts +3 -2
  390. package/src/rules/pilet-has-externals-as-peers.ts +9 -7
  391. package/src/rules/pilet-has-no-self-reference.ts +1 -1
  392. package/src/rules/pilet-stays-small.ts +1 -1
  393. package/src/rules/pilet-uses-latest-piral.ts +22 -12
  394. package/src/rules/piral-has-valid-externals.ts +10 -29
  395. package/src/types/common.ts +99 -9
  396. package/src/types/internal.ts +14 -14
  397. package/src/types/public.ts +93 -27
  398. package/lib/external/child.js +0 -144
  399. package/lib/external/classes.trie +0 -0
  400. package/lib/external/xdg-open +0 -1066
  401. package/lib/injectors/pilet.d.ts +0 -47
  402. package/lib/injectors/pilet.js +0 -187
  403. package/lib/injectors/pilet.js.map +0 -1
  404. package/lib/injectors/piral.js +0 -62
  405. package/lib/injectors/piral.js.map +0 -1
  406. package/src/injectors/pilet.ts +0 -219
  407. package/src/injectors/piral.ts +0 -76
  408. package/templates/piral-index.js.ejs +0 -16
package/lib/messages.d.ts CHANGED
@@ -142,7 +142,7 @@ export declare function appInstanceNotFound_0010(name: string): QuickMessage;
142
142
  * It should be an HTML file.
143
143
  *
144
144
  * @see
145
- * - [Parcel HTML Asset](https://parceljs.org/html.html)
145
+ * - [Parcel HTML Asset](https://parceljs.org/languages/html/)
146
146
  *
147
147
  * @example
148
148
  * Make sure the package.json of the Piral instance is valid (has an "app" field).
@@ -158,6 +158,50 @@ export declare function appInstanceNotFound_0010(name: string): QuickMessage;
158
158
  * ```
159
159
  */
160
160
  export declare function appInstanceInvalid_0011(): QuickMessage;
161
+ /**
162
+ * @kind Error
163
+ *
164
+ * @summary
165
+ * Reported when no valid Piral instance was specified.
166
+ *
167
+ * @abstract
168
+ * The Piral instance is defined either in the package.json or in the pilet.json.
169
+ *
170
+ * The resolution of the Piral instance is done via the `require.resolve` function of Node.js. Thus, if the defined module is simply not yet installed this error will be shown.
171
+ *
172
+ * @see
173
+ * - [npm i](https://docs.npmjs.com/cli/install)
174
+ * - [npm install is missing modules](https://stackoverflow.com/questions/24652681/npm-install-is-missing-modules)
175
+ *
176
+ * @example
177
+ * Assuming that the available pilet.json of your pilet contains content such as:
178
+ *
179
+ * ```json
180
+ * {
181
+ * // ...
182
+ * "piralInstances": {
183
+ * "my-app-shell": {}
184
+ * }
185
+ * }
186
+ * ```
187
+ *
188
+ * However, running
189
+ *
190
+ * ```sh
191
+ * ls node_modules/my-app-shell
192
+ * ```
193
+ *
194
+ * returns an error.
195
+ *
196
+ * To mitigate it try running
197
+ *
198
+ * ```sh
199
+ * npm i
200
+ * ```
201
+ *
202
+ * which will install all dependencies.
203
+ */
204
+ export declare function appInstancesNotGiven_0012(): QuickMessage;
161
205
  /**
162
206
  * @kind Error
163
207
  *
@@ -176,7 +220,7 @@ export declare function appInstanceInvalid_0011(): QuickMessage;
176
220
  * project folder has a package.json in its root.
177
221
  *
178
222
  * @see
179
- * - [NPM Package Specification](https://docs.npmjs.com/files/package.json)
223
+ * - [npm Package Specification](https://docs.npmjs.com/files/package.json)
180
224
  *
181
225
  * @example
182
226
  * You can see if you are currently in a correct folder.
@@ -210,7 +254,7 @@ export declare function packageJsonNotFound_0020(): QuickMessage;
210
254
  * The name of the pilet is provided by the name field specified in its package.json.
211
255
  *
212
256
  * A valid package.json file requires a valid name. The name has to follow standard naming
213
- * conventions of the NPM system.
257
+ * conventions of the npm system.
214
258
  *
215
259
  * @see
216
260
  * - [Package Naming Guidelines](https://docs.npmjs.com/package-name-guidelines)
@@ -257,7 +301,7 @@ export declare function packageJsonMissingName_0021(): QuickMessage;
257
301
  * specification.
258
302
  *
259
303
  * @see
260
- * - [NPM on Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
304
+ * - [npm on Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
261
305
  *
262
306
  * @example
263
307
  * Check the contents of the available package.json:
@@ -299,7 +343,7 @@ export declare function packageJsonMissingVersion_0022(): QuickMessage;
299
343
  * and which ones can remain at their current version.
300
344
  *
301
345
  * @see
302
- * - [NPM Install](https://docs.npmjs.com/cli/install)
346
+ * - [npm Install](https://docs.npmjs.com/cli/install)
303
347
  *
304
348
  * @example
305
349
  * Check that the package is indeed installed:
@@ -336,7 +380,7 @@ export declare function packageNotInstalled_0023(name: string): QuickMessage;
336
380
  * versions. If no release for the given version was found then an error is emitted.
337
381
  *
338
382
  * @see
339
- * - [StackOverflow Listing NPM Versions](https://stackoverflow.com/questions/41415945/how-to-list-all-versions-of-an-npm-module)
383
+ * - [StackOverflow Listing npm Versions](https://stackoverflow.com/questions/41415945/how-to-list-all-versions-of-an-npm-module)
340
384
  *
341
385
  * @example
342
386
  * Check that the version is valid:
@@ -355,6 +399,254 @@ export declare function packageNotInstalled_0023(name: string): QuickMessage;
355
399
  * Here the answer is 0.10.9.
356
400
  */
357
401
  export declare function packageVersionInvalid_0024(version: string): QuickMessage;
402
+ /**
403
+ * @kind Error
404
+ *
405
+ * @summary
406
+ * Cannot add the shared dependency since its version constraint is not satisfied.
407
+ *
408
+ * @abstract
409
+ * The importmap definition allows you to define a version specifier separated with
410
+ * the '@' character. If you write down a version specifier then it has to be
411
+ * fulfilled already from the local version, otherwise the packaged version can
412
+ * potentially not be resolved at runtime. This would resolve in a pilet that fails
413
+ * when running in isolation and most likely fails when running with other pilets.
414
+ *
415
+ * @see
416
+ * - [import-maps specification](https://github.com/WICG/import-maps)
417
+ *
418
+ * @example
419
+ * Check the contents of the available package.json:
420
+ *
421
+ * ```sh
422
+ * cat package.json
423
+ * ```
424
+ *
425
+ * The displayed content should look similar to (i.e., contain an importmap such as):
426
+ *
427
+ * ```json
428
+ * {
429
+ * "importmap": {
430
+ * "imports": {
431
+ * "foo@^3.2.1": "foo"
432
+ * }
433
+ * }
434
+ * }
435
+ * ```
436
+ *
437
+ * For the error to occur the specifier (^3.2.1) potentially does not match the version (e.g., if
438
+ * the version of the dependency is 3.1.2).
439
+ *
440
+ * One strategy is to remove the specifier, which will automatically use the exact current version
441
+ * as specifier:
442
+ *
443
+ * ```json
444
+ * {
445
+ * "importmap": {
446
+ * "imports": {
447
+ * "foo": "foo"
448
+ * }
449
+ * }
450
+ * }
451
+ * ```
452
+ *
453
+ * The best way, however, is to look at the used version and adjust the specifier to be correct again.
454
+ * Alternatively, change the used version to satisfy the constraint again.
455
+ */
456
+ export declare function importMapVersionSpecNotSatisfied_0025(depName: string, version: string): QuickMessage;
457
+ /**
458
+ * @kind Error
459
+ *
460
+ * @summary
461
+ * The version spec part of the importmap identifer is invalid.
462
+ *
463
+ * @abstract
464
+ * The importmap definition allows you to define a version specifier separated with
465
+ * the '@' character. This part has to follow the semver convention and rules.
466
+ *
467
+ * Check your specifier via online tools such as "Semver check" to verify it is
468
+ * valid and follows the semver specification.
469
+ *
470
+ * @see
471
+ * - [Online Checker](https://jubianchi.github.io/semver-check/)
472
+ *
473
+ * @example
474
+ * Check the contents of the available package.json:
475
+ *
476
+ * ```sh
477
+ * cat package.json
478
+ * ```
479
+ *
480
+ * The displayed content should look similar to (i.e., contain an importmap such as):
481
+ *
482
+ * ```json
483
+ * {
484
+ * "importmap": {
485
+ * "imports": {
486
+ * "foo@bar": "foo"
487
+ * }
488
+ * }
489
+ * }
490
+ * ```
491
+ *
492
+ * For the error to occur the specifier (bar) is not following the semver specification.
493
+ *
494
+ * One way is to remove the version spec, which will resolve to an exact version specifier
495
+ * and therefore always works:
496
+ *
497
+ * ```json
498
+ * {
499
+ * "importmap": {
500
+ * "imports": {
501
+ * "foo": "foo"
502
+ * }
503
+ * }
504
+ * }
505
+ * ```
506
+ *
507
+ * The best way, however, is to look at the used version and adjust the specifier to be correct again,
508
+ * such as "^1.2.3" or "1.x" or "3" etc.
509
+ */
510
+ export declare function importMapVersionSpecInvalid_0026(depName: string): QuickMessage;
511
+ /**
512
+ * @kind Error
513
+ *
514
+ * @summary
515
+ * The provided importmap reference could not be resolved.
516
+ *
517
+ * @abstract
518
+ * The importmap consists of keys and values. The keys represent the packages names and optional
519
+ * version specifiers to demand at runtime. The values represent the entry point or URL to use
520
+ * when the dependency is not yet loaded.
521
+ *
522
+ * In case of a non-URL value the reference has either to be a valid package name or a file path
523
+ * that leads to either a package or valid JS module. Either way, it needs to exist. If the path
524
+ * is invalid an error will be emitted.
525
+ *
526
+ * @see
527
+ * - [npm Install](https://docs.npmjs.com/cli/install)
528
+ *
529
+ * @example
530
+ * Check the contents of the available package.json:
531
+ *
532
+ * ```sh
533
+ * cat package.json
534
+ * ```
535
+ *
536
+ * The displayed content should look similar to (i.e., contain an importmap such as):
537
+ *
538
+ * ```json
539
+ * {
540
+ * "importmap": {
541
+ * "imports": {
542
+ * "foo@bar": "./node_modules/prect"
543
+ * }
544
+ * }
545
+ * }
546
+ * ```
547
+ *
548
+ * Note the potential misspelling. It maybe should have been "./node_modules/preact". In such
549
+ * cases the reference may not be resolved locally. If everything was written correctly the
550
+ * node modules are most likely not installed (correctly).
551
+ */
552
+ export declare function importMapReferenceNotFound_0027(dir: string, reference: string): QuickMessage;
553
+ /**
554
+ * @kind Error
555
+ *
556
+ * @summary
557
+ * The provided importmap file could not be found.
558
+ *
559
+ * @abstract
560
+ * The importmap can be referenced in a file from the package.json. If the named
561
+ * file cannot be found the build process has to be stopped. Make sure that the
562
+ * file has been specified relative to the package.json where it was referenced
563
+ * from.
564
+ *
565
+ * @see
566
+ * - [import-maps specification](https://github.com/WICG/import-maps)
567
+ *
568
+ * @example
569
+ * Check the contents of the available package.json:
570
+ *
571
+ * ```sh
572
+ * cat package.json
573
+ * ```
574
+ *
575
+ * The displayed content should look similar to (i.e., contain an importmap such as):
576
+ *
577
+ * ```json
578
+ * {
579
+ * "importmap": "./import-map.json"
580
+ * }
581
+ * ```
582
+ *
583
+ * If the importmap has instead been (re)named "importmap.json" then this will not work.
584
+ * Likewise, with the reference above the file is expected to be in the same directory
585
+ * as the package.json. If it is, e.g., in the "src" subfolder you'd should reference it
586
+ * as "./src/import-map.json" instead.
587
+ */
588
+ export declare function importMapFileNotFound_0028(dir: string, file: string): QuickMessage;
589
+ /**
590
+ * @kind Warning
591
+ *
592
+ * @summary
593
+ * The given dependency seems to be a Piral plugin and should not be exposed
594
+ * as a shared dependency.
595
+ *
596
+ * @abstract
597
+ * While you should be quite restrictive in general regarding sharing dependencies,
598
+ * there are some dependencies that should never be shared. One area are dependencies
599
+ * that are only meant for the app shell and don't make sense somewhere else.
600
+ *
601
+ * Even though many dependencies might exist that fall into that area the only ones
602
+ * we know for sure are the so-called Piral plugins. These are dependencies that only
603
+ * make sense to be used within an app shell, i.e., a Piral instance (or host application).
604
+ *
605
+ * When the Piral CLI detects that you want to share such a dependency from an app shell,
606
+ * or alternatively within a pilet directly, it will print a warning. There might be false
607
+ * positives here, so having an error here might be a bit too much. Nevertheless, depending
608
+ * on your scenario you might want to treat these warnings as errors.
609
+ *
610
+ * @see
611
+ * - [Sharing dependencies](https://docs.piral.io/concepts/I08-importmap)
612
+ *
613
+ * @example
614
+ * Check the contents of the available package.json:
615
+ *
616
+ * ```sh
617
+ * cat package.json
618
+ * ```
619
+ *
620
+ * The displayed content should look similar to (i.e., contain an importmap such as):
621
+ *
622
+ * ```json
623
+ * {
624
+ * "importmap": {
625
+ * "imports": {
626
+ * "piral-ng": ""
627
+ * }
628
+ * }
629
+ * }
630
+ * ```
631
+ *
632
+ * This would share the whole Piral plugin, which does not make much sense. First of all,
633
+ * the plugin is presumably already installed - it even could only be installed in a
634
+ * Piral instance. Second, there is no use of the exported function somewhere else.
635
+ *
636
+ * Instead, you potentially might want to share a submodule. For instance, in the example
637
+ * above the "piral-ng/common" submodule should be shared.
638
+ *
639
+ * ```json
640
+ * {
641
+ * "importmap": {
642
+ * "imports": {
643
+ * "piral-ng/common": ""
644
+ * }
645
+ * }
646
+ * }
647
+ * ```
648
+ */
649
+ export declare function invalidSharedDependency_0029(name: string): QuickMessage;
358
650
  /**
359
651
  * @kind Error
360
652
  *
@@ -435,7 +727,7 @@ export declare function projectReferenceNotSupported_0032(fullPath: string): Qui
435
727
  * CLI via command line parameters.
436
728
  *
437
729
  * @see
438
- * - [NPM Package Specification](https://docs.npmjs.com/files/package.json)
730
+ * - [npm Package Specification](https://docs.npmjs.com/files/package.json)
439
731
  *
440
732
  * @example
441
733
  * Make sure you are in the right directory by calling commands such as
@@ -478,7 +770,7 @@ export declare function invalidPiletTarget_0040(): QuickMessage;
478
770
  * contains an object with additional fields.
479
771
  *
480
772
  * @see
481
- * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/metadata#pilets---package-definition)
773
+ * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/C31-pilet-metadata)
482
774
  *
483
775
  * @example
484
776
  * Your pilet's package.json may look similar to the following snippet:
@@ -524,7 +816,7 @@ export declare function invalidPiletPackage_0041(): QuickMessage;
524
816
  * should contain (among others) a field `name` pointing to the Piral instance to use.
525
817
  *
526
818
  * @see
527
- * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/metadata#pilets---package-definition)
819
+ * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/C31-pilet-metadata)
528
820
  *
529
821
  * @example
530
822
  * If your Piral instance is called `my-piral` then the package.json may look similar to
@@ -556,12 +848,12 @@ export declare function invalidPiletPackage_0042(): QuickMessage;
556
848
  * Even though everything seems to be correct on the first glance it may be that the
557
849
  * actual reference is broken. This could be due to various reasons.
558
850
  *
559
- * - NPM linking is broken
851
+ * - npm linking is broken
560
852
  * - The dependencies have not been installed yet (run `npm i`)
561
853
  * - The Piral instance's name is invalid (e.g., due to a typo)
562
854
  *
563
855
  * @see
564
- * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/metadata#pilets---package-definition)
856
+ * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/C31-pilet-metadata)
565
857
  * - [Node Modules Loading](https://nodejs.org/api/modules.html#modules_loading_from_node_modules_folders)
566
858
  *
567
859
  * @example
@@ -683,6 +975,38 @@ export declare function didNotOverWriteFile_0045(file: string): QuickMessage;
683
975
  * configuration.
684
976
  */
685
977
  export declare function cannotFindFile_0046(file: string): QuickMessage;
978
+ /**
979
+ * @kind Warning
980
+ *
981
+ * @summary
982
+ * Reported when the provided / default port was not available.
983
+ *
984
+ * @abstract
985
+ * By default, the debug commands spawn at the port 1234. However, under certain
986
+ * circumstances (e.g., another debug command running somewhere) this port may not
987
+ * be free.
988
+ *
989
+ * The piral-cli can select a new port, which is free, however, it will still report
990
+ * a warning message in such cases. You can then always abort the current debug
991
+ * process and start a new one - either closing the other run blocking the port or
992
+ * explicitly selecting a new one using the `--port` flag.
993
+ *
994
+ * @see
995
+ * - [Port (computer networking)](https://en.wikipedia.org/wiki/Port_(computer_networking))
996
+ *
997
+ * @example
998
+ * If you start one process to debug an app shell using `piral debug` and another process
999
+ * to debug some pilet using `pilet debug` both processes would want to run on the default
1000
+ * port 1234.
1001
+ *
1002
+ * As a mitigation you can now either be very explicit, e.g., `piral debug --port 1010` and
1003
+ * `pilet debug --port 1020` or you can just drop one of the two and always only run a single
1004
+ * debug process.
1005
+ *
1006
+ * In any case, running both without any options also works, but then a new port will be chosen.
1007
+ * The output of the Piral CLI will always show you what port is currently used.
1008
+ */
1009
+ export declare function portNotFree_0047(newPort: number, oldPort: number): QuickMessage;
686
1010
  /**
687
1011
  * @kind Warning
688
1012
  *
@@ -695,8 +1019,8 @@ export declare function cannotFindFile_0046(file: string): QuickMessage;
695
1019
  * Since the local resolution only works against a filename the update process has also to be triggered with
696
1020
  * a file location. Otherwise, there is no chance to know a different file location.
697
1021
  *
698
- * Potentially, you wanted to switch / resolve the module from NPM instead. Therefore, we are then trying to
699
- * obtain the Piral instance from NPM instead using the known name.
1022
+ * Potentially, you wanted to switch / resolve the module from npm instead. Therefore, we are then trying to
1023
+ * obtain the Piral instance from npm instead using the known name.
700
1024
  *
701
1025
  * @see
702
1026
  * - [Local File Dependencies](https://stackoverflow.com/questions/14381898/local-dependency-in-package-json)
@@ -730,11 +1054,11 @@ export declare function localeFileForUpgradeMissing_0050(): QuickMessage;
730
1054
  * Right now we only support "latest" for Git resolved Piral instances. In this scenario we obtain the
731
1055
  * current head from the repository's default branch and update accordingly.
732
1056
  *
733
- * Potentially, you wanted to switch / resolve the module from NPM instead. Therefore, we are then trying to
734
- * obtain the Piral instance from NPM instead using the known name.
1057
+ * Potentially, you wanted to switch / resolve the module from npm instead. Therefore, we are then trying to
1058
+ * obtain the Piral instance from npm instead using the known name.
735
1059
  *
736
1060
  * @see
737
- * - [Git Dependencies in NPM](https://medium.com/@jonchurch/use-github-branch-as-dependency-in-package-json-5eb609c81f1a)
1061
+ * - [Git Dependencies in npm](https://medium.com/@jonchurch/use-github-branch-as-dependency-in-package-json-5eb609c81f1a)
738
1062
  *
739
1063
  * @example
740
1064
  * You may have set up the pilet using a locally available tgz file. In this case your original command may
@@ -777,7 +1101,7 @@ export declare function gitLatestForUpgradeMissing_0051(): QuickMessage;
777
1101
  * - Disk failures
778
1102
  *
779
1103
  * @see
780
- * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/metadata#piral-instance---package-definition)
1104
+ * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/C21-piral-metadata)
781
1105
  *
782
1106
  * @example
783
1107
  * The primary example hits when a dev dependency was specified that is otherwise not given.
@@ -835,7 +1159,7 @@ export declare function cannotResolveVersion_0052(name: string): QuickMessage;
835
1159
  * - Disk failures
836
1160
  *
837
1161
  * @see
838
- * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/metadata#piral-instance---package-definition)
1162
+ * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/C21-piral-metadata)
839
1163
  *
840
1164
  * @example
841
1165
  * The primary example hits when a dev dependency was specified that is otherwise not given.
@@ -868,8 +1192,9 @@ export declare function cannotResolveVersion_0052(name: string): QuickMessage;
868
1192
  * }
869
1193
  * }
870
1194
  * }
1195
+ * ```
871
1196
  */
872
- export declare function cannotResolveDependency_0053(name: string, rootDir: string): QuickMessage;
1197
+ export declare function cannotResolveDependency_0053(names: Array<string>, rootDir: string): QuickMessage;
873
1198
  /**
874
1199
  * @kind Error
875
1200
  *
@@ -913,7 +1238,7 @@ export declare function missingPiletFeedUrl_0060(): QuickMessage;
913
1238
  * directly.
914
1239
  *
915
1240
  * @see
916
- * - [NPM Pack](https://docs.npmjs.com/cli-commands/pack.html)
1241
+ * - [npm Pack](https://docs.npmjs.com/cli-commands/pack.html)
917
1242
  *
918
1243
  * @example
919
1244
  * Make sure to have build a pilet beforehand:
@@ -943,7 +1268,7 @@ export declare function missingPiletFeedUrl_0060(): QuickMessage;
943
1268
  * Using multiple commands is preferred if you use custom options, otherwise
944
1269
  * just go for the single command.
945
1270
  */
946
- export declare function missingPiletTarball_0061(source: string): QuickMessage;
1271
+ export declare function missingPiletTarball_0061(sources: Array<string>): QuickMessage;
947
1272
  /**
948
1273
  * @kind Warning
949
1274
  *
@@ -1406,10 +1731,10 @@ export declare function entryPointDoesNotExist_0073(app: string): QuickMessage;
1406
1731
  * point for the bundler.
1407
1732
  *
1408
1733
  * @see
1409
- * - [NPM Init](https://docs.npmjs.com/cli/init)
1734
+ * - [npm Init](https://docs.npmjs.com/cli/init)
1410
1735
  *
1411
1736
  * @example
1412
- * You can create a new NPM project using the `npm init` command. This will essentially guide
1737
+ * You can create a new npm project using the `npm init` command. This will essentially guide
1413
1738
  * you through a number of decisions for creating a proper package.json.
1414
1739
  *
1415
1740
  * Even better you could start a new Piral instance using the following command:
@@ -1435,10 +1760,10 @@ export declare function packageJsonMissing_0074(): QuickMessage;
1435
1760
  * point for the bundler.
1436
1761
  *
1437
1762
  * @see
1438
- * - [NPM Init](https://docs.npmjs.com/cli/init)
1763
+ * - [npm Init](https://docs.npmjs.com/cli/init)
1439
1764
  *
1440
1765
  * @example
1441
- * You can create a new NPM project using the `npm init` command. This will essentially guide
1766
+ * You can create a new npm project using the `npm init` command. This will essentially guide
1442
1767
  * you through a number of decisions for creating a proper package.json.
1443
1768
  *
1444
1769
  * Even better you could start a new pilet using the following command:
@@ -1497,7 +1822,7 @@ export declare function packageJsonMissing_0075(): QuickMessage;
1497
1822
  * The TypeScript declaration generator will take all files as input to
1498
1823
  * gather all required information for constructing the API declaration.
1499
1824
  */
1500
- export declare function declarationCouldNotBeGenerated_0076(rootDir: string, error: Error): QuickMessage;
1825
+ export declare function declarationCouldNotBeGenerated_0076(rootDir: string, error: Error | string): QuickMessage;
1501
1826
  /**
1502
1827
  * @kind Error
1503
1828
  *
@@ -1531,6 +1856,60 @@ export declare function declarationCouldNotBeGenerated_0076(rootDir: string, err
1531
1856
  * recommendation is to be explicit about the root module's extension.
1532
1857
  */
1533
1858
  export declare function entryFileMissing_0077(): QuickMessage;
1859
+ /**
1860
+ * @kind Warning
1861
+ *
1862
+ * @summary
1863
+ * The Piral instance is not referencing any framework package.
1864
+ *
1865
+ * @abstract
1866
+ * A Piral instance has to reference either `piral-base`, `piral-core`
1867
+ * or the whole `piral` framework package. If none of these dependencies
1868
+ * is found then no framework dependencies can be shared automatically.
1869
+ * Framework dependencies include react and react-router.
1870
+ *
1871
+ * @example
1872
+ * You might use a monorepo where most / all dependencies are declared in
1873
+ * a top-level package.json. Therefore, the package.json of the actual
1874
+ * Piral instance could look like this:
1875
+ *
1876
+ * ```json
1877
+ * {
1878
+ * "name": "my-piral-instance",
1879
+ * "version": "1.0.0",
1880
+ * "app": "./src/index.html",
1881
+ * "pilets": {}
1882
+ * }
1883
+ * ```
1884
+ *
1885
+ * While perfectly valid, this one lacks `dependencies` and `devDependencies`.
1886
+ * Surely, those are not really needed in the described case, but under
1887
+ * those conditions we cannot know what dependencies you may want to share. It
1888
+ * could be that you only reference `piral-base` and therefore don't want to
1889
+ * share anything except `tslib`. Or you use `piral-core` and also share things
1890
+ * like `react` or `react-router-dom`.
1891
+ *
1892
+ * Either way, in order to recognize that you'll need to include the correct
1893
+ * reference:
1894
+ *
1895
+ * ```json
1896
+ * {
1897
+ * "name": "my-piral-instance",
1898
+ * "version": "1.0.0",
1899
+ * "app": "./src/index.html",
1900
+ * "pilets": {},
1901
+ * "dependencies": {
1902
+ * "piral": "latest"
1903
+ * }
1904
+ * }
1905
+ * ```
1906
+ *
1907
+ * If you only want to use `piral-base` or `piral-core` then replace `piral` in
1908
+ * the example above. Also use the version that you'll like to use - `latest`
1909
+ * is just one example.
1910
+ *
1911
+ */
1912
+ export declare function frameworkLibMissing_0078(frameworkLibs: Array<string>): QuickMessage;
1534
1913
  /**
1535
1914
  * @kind Error
1536
1915
  *
@@ -1670,6 +2049,19 @@ export declare function appShellIncompatible_0100(piralVersion: string, cliVersi
1670
2049
  * ```
1671
2050
  */
1672
2051
  export declare function toolingIncompatible_0101(piralVersion: string, cliVersion: string): QuickMessage;
2052
+ /**
2053
+ * @kind Info
2054
+ *
2055
+ * @summary
2056
+ * The Piral CLI could not detect the tooling version used by the app shell. Therefore, it may be incompatible to the
2057
+ * currently used version of the piral-cli. Keep an eye on weird errors.
2058
+ *
2059
+ * @abstract
2060
+ * The emulator contains a special section to inform the Piral CLI about the used version of the tooling. This is
2061
+ * important to detect potential alignment or incompatibilities. The used version of the emulator does not contain
2062
+ * this information and therefore may be incompatible.
2063
+ */
2064
+ export declare function appShellMaybeIncompatible_0102(cliVersion: string): QuickMessage;
1673
2065
  /**
1674
2066
  * @kind Error
1675
2067
  *
@@ -1684,7 +2076,7 @@ export declare function toolingIncompatible_0101(piralVersion: string, cliVersio
1684
2076
  *
1685
2077
  * @example
1686
2078
  * The following command first removes the output directory, then starts the build,
1687
- * and finally publishes the emulator to NPM.
2079
+ * and finally publishes the emulator to npm.
1688
2080
  *
1689
2081
  * ```sh
1690
2082
  * rm -rf dist
@@ -1707,7 +2099,7 @@ export declare function publishDirectoryMissing_0110(directory: string): QuickMe
1707
2099
  *
1708
2100
  * @example
1709
2101
  * The following command first removes the output directory, then starts the build,
1710
- * and finally publishes the emulator to NPM.
2102
+ * and finally publishes the emulator to npm.
1711
2103
  *
1712
2104
  * ```sh
1713
2105
  * rm -rf dist
@@ -1720,20 +2112,20 @@ export declare function publishEmulatorFilesUnexpected_0111(directory: string):
1720
2112
  * @kind Error
1721
2113
  *
1722
2114
  * @summary
1723
- * The "xcopy" provider requires a "--fields.target" argument.
2115
+ * The "xcopy" provider requires a "--opts.target" argument.
1724
2116
  *
1725
2117
  * @abstract
1726
2118
  * The `piral publish --type release` command requires the selection of a suitable
1727
2119
  * provider for running successfully. The "xcopy" provider just copies the sources from
1728
2120
  * the output directory (source) to a specified target directory.
1729
2121
  *
1730
- * Make sure to supply the target directory via the `--fields.target` command line flag.
2122
+ * Make sure to supply the target directory via the `--opts.target` command line flag.
1731
2123
  *
1732
2124
  * @example
1733
2125
  * The following command would specify `/temp/dest` as target directory:
1734
2126
  *
1735
2127
  * ```sh
1736
- * piral publish --type release --provider xcopy --fields.target "/temp/dest"
2128
+ * piral publish --type release --provider xcopy --opts.target "/temp/dest"
1737
2129
  * ```
1738
2130
  */
1739
2131
  export declare function publishXcopyMissingTarget_0112(): QuickMessage;
@@ -1757,7 +2149,7 @@ export declare function publishXcopyMissingTarget_0112(): QuickMessage;
1757
2149
  * The following command uses the in-built "xcopy" provider for releasing to a local directory.
1758
2150
  *
1759
2151
  * ```sh
1760
- * piral publish --type release --provider xcopy --fields.target "/temp/dest"
2152
+ * piral publish --type release --provider xcopy --opts.target "/temp/dest"
1761
2153
  * ```
1762
2154
  */
1763
2155
  export declare function publishProviderMissing_0113(providerName: string, availableProviders: Array<string>): QuickMessage;
@@ -1774,12 +2166,58 @@ export declare function publishProviderMissing_0113(providerName: string, availa
1774
2166
  * The following command uses the in-built "xcopy" provider for releasing to a local directory.
1775
2167
  *
1776
2168
  * ```sh
1777
- * piral publish --type release --provider xcopy --fields.target "/temp/dest"
2169
+ * piral publish --type release --provider xcopy --opts.target "/temp/dest"
1778
2170
  * ```
1779
2171
  *
1780
2172
  * The type is "release".
1781
2173
  */
1782
2174
  export declare function publishEmulatorSourcesInvalid_0114(): QuickMessage;
2175
+ /**
2176
+ * @kind Error
2177
+ *
2178
+ * @summary
2179
+ * The "feed" provider requires a "--opts.url" argument.
2180
+ *
2181
+ * @abstract
2182
+ * The `piral publish --type release` command requires the selection of a suitable
2183
+ * provider for running successfully. The "feed" provider releases the files to
2184
+ * the a Piral Feed Service with the static page feature.
2185
+ *
2186
+ * Make sure to supply the URL for the feed service via the `--opts.url` command
2187
+ * line flag.
2188
+ *
2189
+ * @example
2190
+ * The following command would specify `https://feed.piral.cloud/api/v1/feed/sample/page`
2191
+ * for the feed service:
2192
+ *
2193
+ * ```sh
2194
+ * piral publish --type release --provider feed --opts.url "https://feed.piral.cloud/api/v1/feed/sample/page" --opts.apikey "foobar123"
2195
+ * ```
2196
+ */
2197
+ export declare function publishFeedMissingUrl_0115(): QuickMessage;
2198
+ /**
2199
+ * @kind Error
2200
+ *
2201
+ * @summary
2202
+ * The "feed" provider requires a "--opts.version" argument.
2203
+ *
2204
+ * @abstract
2205
+ * The `piral publish --type release` command requires the selection of a suitable
2206
+ * provider for running successfully. The "feed" provider releases the files to
2207
+ * the a Piral Feed Service with the static page feature.
2208
+ *
2209
+ * Make sure to supply the version either explicitly via the `--opts.version` argument
2210
+ * or implicitly by having the artifacts stored in a sub-directory of the project's root,
2211
+ * which contains a package.json with the version to use.
2212
+ *
2213
+ * @example
2214
+ * The following command would specify version "1.2.3" for the feed service:
2215
+ *
2216
+ * ```sh
2217
+ * piral publish --type release --provider feed --opts.url "..." --opts.apikey "..." --opts.version "1.2.3"
2218
+ * ```
2219
+ */
2220
+ export declare function publishFeedMissingVersion_0116(): QuickMessage;
1783
2221
  /**
1784
2222
  * @kind Warning
1785
2223
  *
@@ -1799,7 +2237,7 @@ export declare function publishEmulatorSourcesInvalid_0114(): QuickMessage;
1799
2237
  * - The API for opening the default browser is invalid
1800
2238
  *
1801
2239
  * @see
1802
- * - [NPM Open Package](https://www.npmjs.com/package/open)
2240
+ * - [npm Open Package](https://www.npmjs.com/package/open)
1803
2241
  *
1804
2242
  * @example
1805
2243
  * The browser is usually just opened via the command line:
@@ -1820,13 +2258,19 @@ export declare function failedToOpenBrowser_0170(error: string): QuickMessage;
1820
2258
  * the interpretation of compatible feed services slightly and has an impact of the usage
1821
2259
  * of the pilet in the browser.
1822
2260
  *
1823
- * The selected schema version needs to be either "v0" or "v1".
2261
+ * The selected schema version needs to be either "v0", "v1", or "v2".
1824
2262
  *
1825
2263
  * - v0: will download and evaluate the pilet explicitly
1826
- * - v1: will use a script tag for integration of the pilet (default)
2264
+ * - v1: will use a script tag for integration of the pilet
2265
+ * - v2: will use SystemJS for integration of the pilet (default)
1827
2266
  *
1828
2267
  * The v1 version has better support for older browsers, but requires a polyfill to work
1829
- * correctly. This polyfill is part of the standard Piral polyfills.
2268
+ * correctly. This polyfill is part of the `piral-ie11polyfills-utils` package.
2269
+ * Alternatively, use the `currentScript-polyfill` package.
2270
+ *
2271
+ * The v2 version uses a SystemJS format for the pilet. It has the broadest browser support
2272
+ * but requires the custom format as output. Most bundlers support SystemJS directly or
2273
+ * indirectly, making it a quite broad choice.
1830
2274
  *
1831
2275
  * @see
1832
2276
  * - [GitHub currentScript-polyfill](https://github.com/amiller-gh/currentScript-polyfill)
@@ -1847,8 +2291,8 @@ export declare function invalidSchemaVersion_0171(schemaVersion: string, schemas
1847
2291
  *
1848
2292
  * @abstract
1849
2293
  * Piral allows you to set up your own tooling for building and debugging. This
1850
- * is a powerful concept. By default, the Webpack bundler is used. Alternatives
1851
- * include Parcel and Rollup.
2294
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
2295
+ * Alternatives include Parcel and Rollup.
1852
2296
  *
1853
2297
  * In case where multiple bundlers are installed the first one is picked. This
1854
2298
  * may not be what you want. In this scenario you can override the selection by
@@ -1859,7 +2303,9 @@ export declare function invalidSchemaVersion_0171(schemaVersion: string, schemas
1859
2303
  * @see
1860
2304
  * - [Webpack](https://webpack.js.org)
1861
2305
  * - [Parcel](https://parceljs.org)
1862
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
2306
+ * - [esbuild](https://esbuild.github.io)
2307
+ * - [rspack](https://www.rspack.dev/)
2308
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
1863
2309
  *
1864
2310
  * @example
1865
2311
  * Use the following command to make the parcel bundler available:
@@ -1877,8 +2323,8 @@ export declare function bundlerMissing_0172(bundlerName: string, installed: Arra
1877
2323
  *
1878
2324
  * @abstract
1879
2325
  * Piral allows you to set up your own tooling for building and debugging. This
1880
- * is a powerful concept. By default, the Webpack bundler is used. Alternatives
1881
- * include Parcel and Rollup.
2326
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
2327
+ * Alternatives include Parcel and Rollup.
1882
2328
  *
1883
2329
  * In case where no bundler is installed and the default bundler could not be
1884
2330
  * successfully installed this error is shown.
@@ -1886,7 +2332,9 @@ export declare function bundlerMissing_0172(bundlerName: string, installed: Arra
1886
2332
  * @see
1887
2333
  * - [Webpack](https://webpack.js.org)
1888
2334
  * - [Parcel](https://parceljs.org)
1889
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
2335
+ * - [esbuild](https://esbuild.github.io)
2336
+ * - [rspack](https://www.rspack.dev/)
2337
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
1890
2338
  *
1891
2339
  * @example
1892
2340
  * Use the following command to make the parcel bundler available:
@@ -1914,7 +2362,9 @@ export declare function defaultBundlerMissing_0173(): QuickMessage;
1914
2362
  * @see
1915
2363
  * - [Webpack](https://webpack.js.org)
1916
2364
  * - [Parcel](https://parceljs.org)
1917
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
2365
+ * - [esbuild](https://esbuild.github.io)
2366
+ * - [rspack](https://www.rspack.dev/)
2367
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
1918
2368
  *
1919
2369
  * @example
1920
2370
  * Use the following command to make the parcel bundler available:
@@ -1932,8 +2382,8 @@ export declare function bundlingFailed_0174(error: string): QuickMessage;
1932
2382
  *
1933
2383
  * @abstract
1934
2384
  * Piral allows you to set up your own tooling for building and debugging. This
1935
- * is a powerful concept. By default, the Webpack bundler is used. Alternatives
1936
- * include Parcel and Rollup.
2385
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
2386
+ * Alternatives include Parcel and Rollup.
1937
2387
  *
1938
2388
  * In case where multiple bundlers are installed the first one is picked. This
1939
2389
  * may not be what you want. In this scenario you can explicitly set the bundler
@@ -1944,7 +2394,7 @@ export declare function bundlingFailed_0174(error: string): QuickMessage;
1944
2394
  * dependent we recommend setting the bundler explicitly.
1945
2395
  *
1946
2396
  * @see
1947
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
2397
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
1948
2398
  *
1949
2399
  * @example
1950
2400
  * Use the following command to explicitly choose the Parcel bundler:
@@ -1954,6 +2404,76 @@ export declare function bundlingFailed_0174(error: string): QuickMessage;
1954
2404
  * ```
1955
2405
  */
1956
2406
  export declare function bundlerUnspecified_0175(available: Array<string>): QuickMessage;
2407
+ /**
2408
+ * @kind Warning
2409
+ *
2410
+ * @summary
2411
+ * No bundler has been installed yet.
2412
+ *
2413
+ * @abstract
2414
+ * Piral allows you to set up your own tooling for building and debugging. This
2415
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
2416
+ * Alternatives include Parcel and Rollup.
2417
+ *
2418
+ * In case no bundler is yet installed the Piral CLI will automatically install
2419
+ * the default bundler. However, you should consider installing a bundler of your
2420
+ * choice (even if this could also be the default bundler) explicitly.
2421
+ *
2422
+ * @see
2423
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
2424
+ *
2425
+ * @example
2426
+ * Use the following command to install esbuild as a bundler with the npm client:
2427
+ *
2428
+ * ```sh
2429
+ * npm i piral-cli-esbuild --save-dev
2430
+ * ```
2431
+ */
2432
+ export declare function bundlerNotInstalled_0176(): QuickMessage;
2433
+ /**
2434
+ * @kind Warning
2435
+ *
2436
+ * @summary
2437
+ * No pilet.json has been found.
2438
+ *
2439
+ * @abstract
2440
+ * For some functionality such as multi Piral instance support when debugging
2441
+ * a pilet, a special file called pilet.json is required. While this file is
2442
+ * optional in general, it must be available for certain tasks such as adding
2443
+ * or removing a Piral instance for debugging purposes.
2444
+ *
2445
+ * @see
2446
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
2447
+ *
2448
+ * @example
2449
+ * If no pilet.json is yet available you can create one. It should be adjacent to
2450
+ * the package.json of your pilet, even though different locations are also possible.
2451
+ * By default, the following content can be used for an empty file:
2452
+ *
2453
+ * ```json
2454
+ * {
2455
+ * "$schema": "https://docs.piral.io/schemas/pilet-v0.json"
2456
+ * }
2457
+ * ```
2458
+ */
2459
+ export declare function piletJsonNotAvailable_0180(root: string): QuickMessage;
2460
+ /**
2461
+ * @kind Error
2462
+ *
2463
+ * @summary
2464
+ * Using the given platform is not supported.
2465
+ *
2466
+ * @abstract
2467
+ * The Piral instance can run on multiple platforms. The platform is specified via
2468
+ * the piral.json file.
2469
+ *
2470
+ * The standard platform is "web", which starts a web server using the server
2471
+ * proxy kras.
2472
+ *
2473
+ * @example
2474
+ * (tbd)
2475
+ */
2476
+ export declare function platformNotSupported_0190(platform: string): QuickMessage;
1957
2477
  /**
1958
2478
  * @kind Warning
1959
2479
  *