piral-cli 1.0.0-pre.2217 → 1.0.0

package/lib/messages.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.piletMultiDebugExternalsDifferent_0303 = exports.piletMultiDebugAppShellVersions_0302 = exports.piletMultiDebugAppShellDifferent_0301 = exports.apiReleaseProviderInvalid_0207 = exports.apiBundlerInvalid_0206 = exports.pluginCouldNotBeLoaded_0205 = exports.apiPatchInvalid_0204 = exports.apiValidateRunInvalid_0203 = exports.apiValidateNameInvalid_0202 = exports.apiArgumentInvalid_0201 = exports.apiCommandNameInvalid_0200 = exports.bundlerUnspecified_0175 = exports.bundlingFailed_0174 = exports.defaultBundlerMissing_0173 = exports.bundlerMissing_0172 = exports.invalidSchemaVersion_0171 = exports.failedToOpenBrowser_0170 = exports.publishEmulatorSourcesInvalid_0114 = exports.publishProviderMissing_0113 = exports.publishXcopyMissingTarget_0112 = exports.publishEmulatorFilesUnexpected_0111 = exports.publishDirectoryMissing_0110 = exports.toolingIncompatible_0101 = exports.appShellIncompatible_0100 = exports.validationWarned_0081 = exports.validationFailed_0080 = exports.entryFileMissing_0077 = exports.declarationCouldNotBeGenerated_0076 = exports.packageJsonMissing_0075 = exports.packageJsonMissing_0074 = exports.entryPointDoesNotExist_0073 = exports.expectedArray_0072 = exports.entryPointMissing_0071 = exports.entryPointMissing_0070 = exports.failedToUploadSize_0163 = exports.failedToUploadVersion_0162 = exports.failedToUploadPayment_0161 = exports.failedHttpGet_0068 = exports.httpPostResponse_0067 = exports.unsuccessfulHttpPost_0066 = exports.failedHttpPost_0065 = exports.failedUploading_0064 = exports.failedToRead_0063 = exports.failedToUpload_0062 = exports.missingPiletTarball_0061 = exports.missingPiletFeedUrl_0060 = exports.cannotResolveDependency_0053 = exports.cannotResolveVersion_0052 = exports.gitLatestForUpgradeMissing_0051 = exports.localeFileForUpgradeMissing_0050 = exports.cannotFindFile_0046 = exports.didNotOverWriteFile_0045 = exports.cannotCreateDirectory_0044 = exports.invalidPiralReference_0043 = exports.invalidPiletPackage_0042 = exports.invalidPiletPackage_0041 = exports.invalidPiletTarget_0040 = exports.projectReferenceNotSupported_0032 = exports.upgradePathDoesNotExist_0031 = exports.scaffoldPathDoesNotExist_0030 = exports.packageVersionInvalid_0024 = exports.packageNotInstalled_0023 = exports.packageJsonMissingVersion_0022 = exports.packageJsonMissingName_0021 = exports.packageJsonNotFound_0020 = exports.appInstanceInvalid_0011 = exports.appInstanceNotFound_0010 = exports.generalVerbose_0004 = exports.generalDebug_0003 = exports.generalError_0002 = exports.generalWarning_0001 = exports.generalInfo_0000 = void 0;
+exports.packageJsonMissing_0074 = exports.entryPointDoesNotExist_0073 = exports.expectedArray_0072 = exports.entryPointMissing_0071 = exports.entryPointMissing_0070 = exports.failedToUploadSize_0163 = exports.failedToUploadVersion_0162 = exports.failedToUploadPayment_0161 = exports.failedHttpGet_0068 = exports.httpPostResponse_0067 = exports.unsuccessfulHttpPost_0066 = exports.failedHttpPost_0065 = exports.failedUploading_0064 = exports.failedToRead_0063 = exports.failedToUpload_0062 = exports.missingPiletTarball_0061 = exports.missingPiletFeedUrl_0060 = exports.cannotResolveDependency_0053 = exports.cannotResolveVersion_0052 = exports.gitLatestForUpgradeMissing_0051 = exports.localeFileForUpgradeMissing_0050 = exports.portNotFree_0047 = exports.cannotFindFile_0046 = exports.didNotOverWriteFile_0045 = exports.cannotCreateDirectory_0044 = exports.invalidPiralReference_0043 = exports.invalidPiletPackage_0042 = exports.invalidPiletPackage_0041 = exports.invalidPiletTarget_0040 = exports.projectReferenceNotSupported_0032 = exports.upgradePathDoesNotExist_0031 = exports.scaffoldPathDoesNotExist_0030 = exports.invalidSharedDependency_0029 = exports.importMapFileNotFound_0028 = exports.importMapReferenceNotFound_0027 = exports.importMapVersionSpecInvalid_0026 = exports.importMapVersionSpecNotSatisfied_0025 = exports.packageVersionInvalid_0024 = exports.packageNotInstalled_0023 = exports.packageJsonMissingVersion_0022 = exports.packageJsonMissingName_0021 = exports.packageJsonNotFound_0020 = exports.appInstancesNotGiven_0012 = exports.appInstanceInvalid_0011 = exports.appInstanceNotFound_0010 = exports.generalVerbose_0004 = exports.generalDebug_0003 = exports.generalError_0002 = exports.generalWarning_0001 = exports.generalInfo_0000 = void 0;
+exports.piletMultiDebugExternalsDifferent_0303 = exports.piletMultiDebugAppShellVersions_0302 = exports.piletMultiDebugAppShellDifferent_0301 = exports.apiReleaseProviderInvalid_0207 = exports.apiBundlerInvalid_0206 = exports.pluginCouldNotBeLoaded_0205 = exports.apiPatchInvalid_0204 = exports.apiValidateRunInvalid_0203 = exports.apiValidateNameInvalid_0202 = exports.apiArgumentInvalid_0201 = exports.apiCommandNameInvalid_0200 = exports.platformNotSupported_0190 = exports.piletJsonNotAvailable_0180 = exports.bundlerNotInstalled_0176 = exports.bundlerUnspecified_0175 = exports.bundlingFailed_0174 = exports.defaultBundlerMissing_0173 = exports.bundlerMissing_0172 = exports.invalidSchemaVersion_0171 = exports.failedToOpenBrowser_0170 = exports.publishFeedMissingVersion_0116 = exports.publishFeedMissingUrl_0115 = exports.publishEmulatorSourcesInvalid_0114 = exports.publishProviderMissing_0113 = exports.publishXcopyMissingTarget_0112 = exports.publishEmulatorFilesUnexpected_0111 = exports.publishDirectoryMissing_0110 = exports.appShellMaybeIncompatible_0102 = exports.toolingIncompatible_0101 = exports.appShellIncompatible_0100 = exports.validationWarned_0081 = exports.validationFailed_0080 = exports.frameworkLibMissing_0078 = exports.entryFileMissing_0077 = exports.declarationCouldNotBeGenerated_0076 = exports.packageJsonMissing_0075 = void 0;
 const types_1 = require("./types");
 /**
  * @kind Info
@@ -163,7 +164,7 @@ exports.appInstanceNotFound_0010 = appInstanceNotFound_0010;
  * It should be an HTML file.
  *
  * @see
- * - [Parcel HTML Asset](https://parceljs.org/html.html)
+ * - [Parcel HTML Asset](https://parceljs.org/languages/html/)
  *
  * @example
  * Make sure the package.json of the Piral instance is valid (has an "app" field).
@@ -182,6 +183,53 @@ function appInstanceInvalid_0011() {
     return [types_1.LogLevels.error, '0011', `Could not find a valid Piral instance.`];
 }
 exports.appInstanceInvalid_0011 = appInstanceInvalid_0011;
+/**
+ * @kind Error
+ *
+ * @summary
+ * Reported when no valid Piral instance was specified.
+ *
+ * @abstract
+ * The Piral instance is defined either in the package.json or in the pilet.json.
+ *
+ * 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.
+ *
+ * @see
+ * - [npm i](https://docs.npmjs.com/cli/install)
+ * - [npm install is missing modules](https://stackoverflow.com/questions/24652681/npm-install-is-missing-modules)
+ *
+ * @example
+ * Assuming that the available pilet.json of your pilet contains content such as:
+ *
+ * ```json
+ * {
+ *   // ...
+ *   "piralInstances": {
+ *     "my-app-shell": {}
+ *   }
+ * }
+ * ```
+ *
+ * However, running
+ *
+ * ```sh
+ * ls node_modules/my-app-shell
+ * ```
+ *
+ * returns an error.
+ *
+ * To mitigate it try running
+ *
+ * ```sh
+ * npm i
+ * ```
+ *
+ * which will install all dependencies.
+ */
+function appInstancesNotGiven_0012() {
+    return [types_1.LogLevels.error, '0012', `No Piral instances have been provided.`];
+}
+exports.appInstancesNotGiven_0012 = appInstancesNotGiven_0012;
 /**
  * @kind Error
  *
@@ -200,7 +248,7 @@ exports.appInstanceInvalid_0011 = appInstanceInvalid_0011;
  * project folder has a package.json in its root.
  *
  * @see
- * - [NPM Package Specification](https://docs.npmjs.com/files/package.json)
+ * - [npm Package Specification](https://docs.npmjs.com/files/package.json)
  *
  * @example
  * You can see if you are currently in a correct folder.
@@ -237,7 +285,7 @@ exports.packageJsonNotFound_0020 = packageJsonNotFound_0020;
  * The name of the pilet is provided by the name field specified in its package.json.
  *
  * A valid package.json file requires a valid name. The name has to follow standard naming
- * conventions of the NPM system.
+ * conventions of the npm system.
  *
  * @see
  * - [Package Naming Guidelines](https://docs.npmjs.com/package-name-guidelines)
@@ -287,7 +335,7 @@ exports.packageJsonMissingName_0021 = packageJsonMissingName_0021;
  * specification.
  *
  * @see
- * - [NPM on Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
+ * - [npm on Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
  *
  * @example
  * Check the contents of the available package.json:
@@ -332,7 +380,7 @@ exports.packageJsonMissingVersion_0022 = packageJsonMissingVersion_0022;
  * and which ones can remain at their current version.
  *
  * @see
- * - [NPM Install](https://docs.npmjs.com/cli/install)
+ * - [npm Install](https://docs.npmjs.com/cli/install)
  *
  * @example
  * Check that the package is indeed installed:
@@ -372,7 +420,7 @@ exports.packageNotInstalled_0023 = packageNotInstalled_0023;
  * versions. If no release for the given version was found then an error is emitted.
  *
  * @see
- * - [StackOverflow Listing NPM Versions](https://stackoverflow.com/questions/41415945/how-to-list-all-versions-of-an-npm-module)
+ * - [StackOverflow Listing npm Versions](https://stackoverflow.com/questions/41415945/how-to-list-all-versions-of-an-npm-module)
  *
  * @example
  * Check that the version is valid:
@@ -394,6 +442,273 @@ function packageVersionInvalid_0024(version) {
     return [types_1.LogLevels.error, '0024', `The given package version "${version}" is invalid.`];
 }
 exports.packageVersionInvalid_0024 = packageVersionInvalid_0024;
+/**
+ * @kind Error
+ *
+ * @summary
+ * Cannot add the shared dependency since its version constraint is not satisfied.
+ *
+ * @abstract
+ * The importmap definition allows you to define a version specifier separated with
+ * the '@' character. If you write down a version specifier then it has to be
+ * fulfilled already from the local version, otherwise the packaged version can
+ * potentially not be resolved at runtime. This would resolve in a pilet that fails
+ * when running in isolation and most likely fails when running with other pilets.
+ *
+ * @see
+ * - [import-maps specification](https://github.com/WICG/import-maps)
+ *
+ * @example
+ * Check the contents of the available package.json:
+ *
+ * ```sh
+ * cat package.json
+ * ```
+ *
+ * The displayed content should look similar to (i.e., contain an importmap such as):
+ *
+ * ```json
+ * {
+ *   "importmap": {
+ *     "imports": {
+ *       "foo@^3.2.1": "foo"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * For the error to occur the specifier (^3.2.1) potentially does not match the version (e.g., if
+ * the version of the dependency is 3.1.2).
+ *
+ * One strategy is to remove the specifier, which will automatically use the exact current version
+ * as specifier:
+ *
+ * ```json
+ * {
+ *   "importmap": {
+ *     "imports": {
+ *       "foo": "foo"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The best way, however, is to look at the used version and adjust the specifier to be correct again.
+ * Alternatively, change the used version to satisfy the constraint again.
+ */
+function importMapVersionSpecNotSatisfied_0025(depName, version) {
+    return [types_1.LogLevels.error, '0025', `The dependency "${depName}" in only available in version "${version}".`];
+}
+exports.importMapVersionSpecNotSatisfied_0025 = importMapVersionSpecNotSatisfied_0025;
+/**
+ * @kind Error
+ *
+ * @summary
+ * The version spec part of the importmap identifer is invalid.
+ *
+ * @abstract
+ * The importmap definition allows you to define a version specifier separated with
+ * the '@' character. This part has to follow the semver convention and rules.
+ *
+ * Check your specifier via online tools such as "Semver check" to verify it is
+ * valid and follows the semver specification.
+ *
+ * @see
+ * - [Online Checker](https://jubianchi.github.io/semver-check/)
+ *
+ * @example
+ * Check the contents of the available package.json:
+ *
+ * ```sh
+ * cat package.json
+ * ```
+ *
+ * The displayed content should look similar to (i.e., contain an importmap such as):
+ *
+ * ```json
+ * {
+ *   "importmap": {
+ *     "imports": {
+ *       "foo@bar": "foo"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * For the error to occur the specifier (bar) is not following the semver specification.
+ *
+ * One way is to remove the version spec, which will resolve to an exact version specifier
+ * and therefore always works:
+ *
+ * ```json
+ * {
+ *   "importmap": {
+ *     "imports": {
+ *       "foo": "foo"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The best way, however, is to look at the used version and adjust the specifier to be correct again,
+ * such as "^1.2.3" or "1.x" or "3" etc.
+ */
+function importMapVersionSpecInvalid_0026(depName) {
+    return [types_1.LogLevels.error, '0026', `The dependency "${depName}" has an invalid version spec.`];
+}
+exports.importMapVersionSpecInvalid_0026 = importMapVersionSpecInvalid_0026;
+/**
+ * @kind Error
+ *
+ * @summary
+ * The provided importmap reference could not be resolved.
+ *
+ * @abstract
+ * The importmap consists of keys and values. The keys represent the packages names and optional
+ * version specifiers to demand at runtime. The values represent the entry point or URL to use
+ * when the dependency is not yet loaded.
+ *
+ * In case of a non-URL value the reference has either to be a valid package name or a file path
+ * that leads to either a package or valid JS module. Either way, it needs to exist. If the path
+ * is invalid an error will be emitted.
+ *
+ * @see
+ * - [npm Install](https://docs.npmjs.com/cli/install)
+ *
+ * @example
+ * Check the contents of the available package.json:
+ *
+ * ```sh
+ * cat package.json
+ * ```
+ *
+ * The displayed content should look similar to (i.e., contain an importmap such as):
+ *
+ * ```json
+ * {
+ *   "importmap": {
+ *     "imports": {
+ *       "foo@bar": "./node_modules/prect"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * Note the potential misspelling. It maybe should have been "./node_modules/preact". In such
+ * cases the reference may not be resolved locally. If everything was written correctly the
+ * node modules are most likely not installed (correctly).
+ */
+function importMapReferenceNotFound_0027(dir, reference) {
+    return [
+        types_1.LogLevels.error,
+        '0027',
+        `The reference to "${reference}" could not be resolved from "${dir}". Are you sure the file or package exists?`,
+    ];
+}
+exports.importMapReferenceNotFound_0027 = importMapReferenceNotFound_0027;
+/**
+ * @kind Error
+ *
+ * @summary
+ * The provided importmap file could not be found.
+ *
+ * @abstract
+ * The importmap can be referenced in a file from the package.json. If the named
+ * file cannot be found the build process has to be stopped. Make sure that the
+ * file has been specified relative to the package.json where it was referenced
+ * from.
+ *
+ * @see
+ * - [import-maps specification](https://github.com/WICG/import-maps)
+ *
+ * @example
+ * Check the contents of the available package.json:
+ *
+ * ```sh
+ * cat package.json
+ * ```
+ *
+ * The displayed content should look similar to (i.e., contain an importmap such as):
+ *
+ * ```json
+ * {
+ *   "importmap": "./import-map.json"
+ * }
+ * ```
+ *
+ * If the importmap has instead been (re)named "importmap.json" then this will not work.
+ * Likewise, with the reference above the file is expected to be in the same directory
+ * as the package.json. If it is, e.g., in the "src" subfolder you'd should reference it
+ * as "./src/import-map.json" instead.
+ */
+function importMapFileNotFound_0028(dir, file) {
+    return [types_1.LogLevels.error, '0028', `The importmap "${file}" could not be found at "${dir}".`];
+}
+exports.importMapFileNotFound_0028 = importMapFileNotFound_0028;
+/**
+ * @kind Warning
+ *
+ * @summary
+ * The given dependency seems to be a Piral plugin and should not be exposed
+ * as a shared dependency.
+ *
+ * @abstract
+ * While you should be quite restrictive in general regarding sharing dependencies,
+ * there are some dependencies that should never be shared. One area are dependencies
+ * that are only meant for the app shell and don't make sense somewhere else.
+ *
+ * Even though many dependencies might exist that fall into that area the only ones
+ * we know for sure are the so-called Piral plugins. These are dependencies that only
+ * make sense to be used within an app shell, i.e., a Piral instance (or host application).
+ *
+ * When the Piral CLI detects that you want to share such a dependency from an app shell,
+ * or alternatively within a pilet directly, it will print a warning. There might be false
+ * positives here, so having an error here might be a bit too much. Nevertheless, depending
+ * on your scenario you might want to treat these warnings as errors.
+ *
+ * @see
+ * - [Sharing dependencies](https://docs.piral.io/concepts/I08-importmap)
+ *
+ * @example
+ * Check the contents of the available package.json:
+ *
+ * ```sh
+ * cat package.json
+ * ```
+ *
+ * The displayed content should look similar to (i.e., contain an importmap such as):
+ *
+ * ```json
+ * {
+ *   "importmap": {
+ *     "imports": {
+ *       "piral-ng": ""
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * This would share the whole Piral plugin, which does not make much sense. First of all,
+ * the plugin is presumably already installed - it even could only be installed in a
+ * Piral instance. Second, there is no use of the exported function somewhere else.
+ *
+ * Instead, you potentially might want to share a submodule. For instance, in the example
+ * above the "piral-ng/common" submodule should be shared.
+ *
+ * ```json
+ * {
+ *   "importmap": {
+ *     "imports": {
+ *       "piral-ng/common": ""
+ *     }
+ *   }
+ * }
+ * ```
+ */
+function invalidSharedDependency_0029(name) {
+    return [types_1.LogLevels.warning, '0029', `The dependency "${name}" should not be shared.`];
+}
+exports.invalidSharedDependency_0029 = invalidSharedDependency_0029;
 /**
  * @kind Error
  *
@@ -483,7 +798,7 @@ exports.projectReferenceNotSupported_0032 = projectReferenceNotSupported_0032;
  * CLI via command line parameters.
  *
  * @see
- * - [NPM Package Specification](https://docs.npmjs.com/files/package.json)
+ * - [npm Package Specification](https://docs.npmjs.com/files/package.json)
  *
  * @example
  * Make sure you are in the right directory by calling commands such as
@@ -529,7 +844,7 @@ exports.invalidPiletTarget_0040 = invalidPiletTarget_0040;
  * contains an object with additional fields.
  *
  * @see
- * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/metadata#pilets---package-definition)
+ * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/C31-pilet-metadata)
  *
  * @example
  * Your pilet's package.json may look similar to the following snippet:
@@ -578,7 +893,7 @@ exports.invalidPiletPackage_0041 = invalidPiletPackage_0041;
  * should contain (among others) a field `name` pointing to the Piral instance to use.
  *
  * @see
- * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/metadata#pilets---package-definition)
+ * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/C31-pilet-metadata)
  *
  * @example
  * If your Piral instance is called `my-piral` then the package.json may look similar to
@@ -613,12 +928,12 @@ exports.invalidPiletPackage_0042 = invalidPiletPackage_0042;
  * Even though everything seems to be correct on the first glance it may be that the
  * actual reference is broken. This could be due to various reasons.
  *
- * - NPM linking is broken
+ * - npm linking is broken
  * - The dependencies have not been installed yet (run `npm i`)
  * - The Piral instance's name is invalid (e.g., due to a typo)
  *
  * @see
- * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/metadata#pilets---package-definition)
+ * - [Pilet Package Definition](https://docs.piral.io/reference/documentation/C31-pilet-metadata)
  * - [Node Modules Loading](https://nodejs.org/api/modules.html#modules_loading_from_node_modules_folders)
  *
  * @example
@@ -752,6 +1067,41 @@ function cannotFindFile_0046(file) {
     return [types_1.LogLevels.error, '0046', `The file "${file}" does not exist!`];
 }
 exports.cannotFindFile_0046 = cannotFindFile_0046;
+/**
+ * @kind Warning
+ *
+ * @summary
+ * Reported when the provided / default port was not available.
+ *
+ * @abstract
+ * By default, the debug commands spawn at the port 1234. However, under certain
+ * circumstances (e.g., another debug command running somewhere) this port may not
+ * be free.
+ *
+ * The piral-cli can select a new port, which is free, however, it will still report
+ * a warning message in such cases. You can then always abort the current debug
+ * process and start a new one - either closing the other run blocking the port or
+ * explicitly selecting a new one using the `--port` flag.
+ *
+ * @see
+ * - [Port (computer networking)](https://en.wikipedia.org/wiki/Port_(computer_networking))
+ *
+ * @example
+ * If you start one process to debug an app shell using `piral debug` and another process
+ * to debug some pilet using `pilet debug` both processes would want to run on the default
+ * port 1234.
+ *
+ * As a mitigation you can now either be very explicit, e.g., `piral debug --port 1010` and
+ * `pilet debug --port 1020` or you can just drop one of the two and always only run a single
+ * debug process.
+ *
+ * In any case, running both without any options also works, but then a new port will be chosen.
+ * The output of the Piral CLI will always show you what port is currently used.
+ */
+function portNotFree_0047(newPort, oldPort) {
+    return [types_1.LogLevels.warning, '0047', `The selected port "${oldPort}" is already used. Changed port to "${newPort}".`];
+}
+exports.portNotFree_0047 = portNotFree_0047;
 /**
  * @kind Warning
  *
@@ -764,8 +1114,8 @@ exports.cannotFindFile_0046 = cannotFindFile_0046;
  * Since the local resolution only works against a filename the update process has also to be triggered with
  * a file location. Otherwise, there is no chance to know a different file location.
  *
- * Potentially, you wanted to switch / resolve the module from NPM instead. Therefore, we are then trying to
- * obtain the Piral instance from NPM instead using the known name.
+ * Potentially, you wanted to switch / resolve the module from npm instead. Therefore, we are then trying to
+ * obtain the Piral instance from npm instead using the known name.
  *
  * @see
  * - [Local File Dependencies](https://stackoverflow.com/questions/14381898/local-dependency-in-package-json)
@@ -802,11 +1152,11 @@ exports.localeFileForUpgradeMissing_0050 = localeFileForUpgradeMissing_0050;
  * Right now we only support "latest" for Git resolved Piral instances. In this scenario we obtain the
  * current head from the repository's default branch and update accordingly.
  *
- * Potentially, you wanted to switch / resolve the module from NPM instead. Therefore, we are then trying to
- * obtain the Piral instance from NPM instead using the known name.
+ * Potentially, you wanted to switch / resolve the module from npm instead. Therefore, we are then trying to
+ * obtain the Piral instance from npm instead using the known name.
  *
  * @see
- * - [Git Dependencies in NPM](https://medium.com/@jonchurch/use-github-branch-as-dependency-in-package-json-5eb609c81f1a)
+ * - [Git Dependencies in npm](https://medium.com/@jonchurch/use-github-branch-as-dependency-in-package-json-5eb609c81f1a)
  *
  * @example
  * You may have set up the pilet using a locally available tgz file. In this case your original command may
@@ -852,7 +1202,7 @@ exports.gitLatestForUpgradeMissing_0051 = gitLatestForUpgradeMissing_0051;
  * - Disk failures
  *
  * @see
- * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/metadata#piral-instance---package-definition)
+ * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/C21-piral-metadata)
  *
  * @example
  * The primary example hits when a dev dependency was specified that is otherwise not given.
@@ -913,7 +1263,7 @@ exports.cannotResolveVersion_0052 = cannotResolveVersion_0052;
  * - Disk failures
  *
  * @see
- * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/metadata#piral-instance---package-definition)
+ * - [Piral Instance Package Definition](https://docs.piral.io/reference/documentation/C21-piral-metadata)
  *
  * @example
  * The primary example hits when a dev dependency was specified that is otherwise not given.
@@ -946,9 +1296,14 @@ exports.cannotResolveVersion_0052 = cannotResolveVersion_0052;
  *     }
  *   }
  * }
+ * ```
  */
-function cannotResolveDependency_0053(name, rootDir) {
-    return [types_1.LogLevels.warning, '0053', `Could not resolve "${name}" from "${rootDir}". Taking "latest" version.`];
+function cannotResolveDependency_0053(names, rootDir) {
+    return [
+        types_1.LogLevels.warning,
+        '0053',
+        `Could not resolve any package (tried "${names.join('", "')}") from "${rootDir}". Taking "latest" version.`,
+    ];
 }
 exports.cannotResolveDependency_0053 = cannotResolveDependency_0053;
 /**
@@ -997,7 +1352,7 @@ exports.missingPiletFeedUrl_0060 = missingPiletFeedUrl_0060;
  * directly.
  *
  * @see
- * - [NPM Pack](https://docs.npmjs.com/cli-commands/pack.html)
+ * - [npm Pack](https://docs.npmjs.com/cli-commands/pack.html)
  *
  * @example
  * Make sure to have build a pilet beforehand:
@@ -1027,8 +1382,8 @@ exports.missingPiletFeedUrl_0060 = missingPiletFeedUrl_0060;
  * Using multiple commands is preferred if you use custom options, otherwise
  * just go for the single command.
  */
-function missingPiletTarball_0061(source) {
-    return [types_1.LogLevels.error, '0061', `No files found using pattern "${source}".`];
+function missingPiletTarball_0061(sources) {
+    return [types_1.LogLevels.error, '0061', `No files found using pattern "${sources.join('", "')}".`];
 }
 exports.missingPiletTarball_0061 = missingPiletTarball_0061;
 /**
@@ -1543,10 +1898,10 @@ exports.entryPointDoesNotExist_0073 = entryPointDoesNotExist_0073;
  * point for the bundler.
  *
  * @see
- * - [NPM Init](https://docs.npmjs.com/cli/init)
+ * - [npm Init](https://docs.npmjs.com/cli/init)
  *
  * @example
- * You can create a new NPM project using the `npm init` command. This will essentially guide
+ * You can create a new npm project using the `npm init` command. This will essentially guide
  * you through a number of decisions for creating a proper package.json.
  *
  * Even better you could start a new Piral instance using the following command:
@@ -1579,10 +1934,10 @@ exports.packageJsonMissing_0074 = packageJsonMissing_0074;
  * point for the bundler.
  *
  * @see
- * - [NPM Init](https://docs.npmjs.com/cli/init)
+ * - [npm Init](https://docs.npmjs.com/cli/init)
  *
  * @example
- * You can create a new NPM project using the `npm init` command. This will essentially guide
+ * You can create a new npm project using the `npm init` command. This will essentially guide
  * you through a number of decisions for creating a proper package.json.
  *
  * Even better you could start a new pilet using the following command:
@@ -1684,6 +2039,67 @@ function entryFileMissing_0077() {
     return [types_1.LogLevels.error, '0077', 'No valid entry file for the pilet found.'];
 }
 exports.entryFileMissing_0077 = entryFileMissing_0077;
+/**
+ * @kind Warning
+ *
+ * @summary
+ * The Piral instance is not referencing any framework package.
+ *
+ * @abstract
+ * A Piral instance has to reference either `piral-base`, `piral-core`
+ * or the whole `piral` framework package. If none of these dependencies
+ * is found then no framework dependencies can be shared automatically.
+ * Framework dependencies include react and react-router.
+ *
+ * @example
+ * You might use a monorepo where most / all dependencies are declared in
+ * a top-level package.json. Therefore, the package.json of the actual
+ * Piral instance could look like this:
+ *
+ * ```json
+ * {
+ *   "name": "my-piral-instance",
+ *   "version": "1.0.0",
+ *   "app": "./src/index.html",
+ *   "pilets": {}
+ * }
+ * ```
+ *
+ * While perfectly valid, this one lacks `dependencies` and `devDependencies`.
+ * Surely, those are not really needed in the described case, but under
+ * those conditions we cannot know what dependencies you may want to share. It
+ * could be that you only reference `piral-base` and therefore don't want to
+ * share anything except `tslib`. Or you use `piral-core` and also share things
+ * like `react` or `react-router-dom`.
+ *
+ * Either way, in order to recognize that you'll need to include the correct
+ * reference:
+ *
+ * ```json
+ * {
+ *   "name": "my-piral-instance",
+ *   "version": "1.0.0",
+ *   "app": "./src/index.html",
+ *   "pilets": {},
+ *   "dependencies": {
+ *     "piral": "latest"
+ *   }
+ * }
+ * ```
+ *
+ * If you only want to use `piral-base` or `piral-core` then replace `piral` in
+ * the example above. Also use the version that you'll like to use - `latest`
+ * is just one example.
+ *
+ */
+function frameworkLibMissing_0078(frameworkLibs) {
+    return [
+        types_1.LogLevels.warning,
+        '0078',
+        `Did not find any reference to either ${frameworkLibs.join(', ')}. No framework dependencies are shared.`,
+    ];
+}
+exports.frameworkLibMissing_0078 = frameworkLibMissing_0078;
 /**
  * @kind Error
  *
@@ -1843,6 +2259,26 @@ function toolingIncompatible_0101(piralVersion, cliVersion) {
     ];
 }
 exports.toolingIncompatible_0101 = toolingIncompatible_0101;
+/**
+ * @kind Info
+ *
+ * @summary
+ * The Piral CLI could not detect the tooling version used by the app shell. Therefore, it may be incompatible to the
+ * currently used version of the piral-cli. Keep an eye on weird errors.
+ *
+ * @abstract
+ * The emulator contains a special section to inform the Piral CLI about the used version of the tooling. This is
+ * important to detect potential alignment or incompatibilities. The used version of the emulator does not contain
+ * this information and therefore may be incompatible.
+ */
+function appShellMaybeIncompatible_0102(cliVersion) {
+    return [
+        types_1.LogLevels.info,
+        '0100',
+        `The Piral instance's CLI version is unknown and may be incompatible to the used version (${cliVersion}).`,
+    ];
+}
+exports.appShellMaybeIncompatible_0102 = appShellMaybeIncompatible_0102;
 /**
  * @kind Error
  *
@@ -1857,7 +2293,7 @@ exports.toolingIncompatible_0101 = toolingIncompatible_0101;
  *
  * @example
  * The following command first removes the output directory, then starts the build,
- * and finally publishes the emulator to NPM.
+ * and finally publishes the emulator to npm.
  *
  * ```sh
  * rm -rf dist
@@ -1883,7 +2319,7 @@ exports.publishDirectoryMissing_0110 = publishDirectoryMissing_0110;
  *
  * @example
  * The following command first removes the output directory, then starts the build,
- * and finally publishes the emulator to NPM.
+ * and finally publishes the emulator to npm.
  *
  * ```sh
  * rm -rf dist
@@ -1899,24 +2335,24 @@ exports.publishEmulatorFilesUnexpected_0111 = publishEmulatorFilesUnexpected_011
  * @kind Error
  *
  * @summary
- * The "xcopy" provider requires a "--fields.target" argument.
+ * The "xcopy" provider requires a "--opts.target" argument.
  *
  * @abstract
  * The `piral publish --type release` command requires the selection of a suitable
  * provider for running successfully. The "xcopy" provider just copies the sources from
  * the output directory (source) to a specified target directory.
  *
- * Make sure to supply the target directory via the `--fields.target` command line flag.
+ * Make sure to supply the target directory via the `--opts.target` command line flag.
  *
  * @example
  * The following command would specify `/temp/dest` as target directory:
  *
  * ```sh
- * piral publish --type release --provider xcopy --fields.target "/temp/dest"
+ * piral publish --type release --provider xcopy --opts.target "/temp/dest"
  * ```
  */
 function publishXcopyMissingTarget_0112() {
-    return [types_1.LogLevels.error, '0112', `The "xcopy" provider requires a "--fields.target" argument.`];
+    return [types_1.LogLevels.error, '0112', `The "xcopy" provider requires a "--opts.target" argument.`];
 }
 exports.publishXcopyMissingTarget_0112 = publishXcopyMissingTarget_0112;
 /**
@@ -1939,7 +2375,7 @@ exports.publishXcopyMissingTarget_0112 = publishXcopyMissingTarget_0112;
  * The following command uses the in-built "xcopy" provider for releasing to a local directory.
  *
  * ```sh
- * piral publish --type release --provider xcopy --fields.target "/temp/dest"
+ * piral publish --type release --provider xcopy --opts.target "/temp/dest"
  * ```
  */
 function publishProviderMissing_0113(providerName, availableProviders) {
@@ -1960,15 +2396,75 @@ exports.publishProviderMissing_0113 = publishProviderMissing_0113;
  * The following command uses the in-built "xcopy" provider for releasing to a local directory.
  *
  * ```sh
- * piral publish --type release --provider xcopy --fields.target "/temp/dest"
+ * piral publish --type release --provider xcopy --opts.target "/temp/dest"
  * ```
  *
  * The type is "release".
  */
 function publishEmulatorSourcesInvalid_0114() {
-    return [types_1.LogLevels.error, '0114', `The command "publish" cannot be done with "--type emulator-sources". Use another type instead.`];
+    return [
+        types_1.LogLevels.error,
+        '0114',
+        `The command "publish" cannot be done with "--type emulator-sources". Use another type instead.`,
+    ];
 }
 exports.publishEmulatorSourcesInvalid_0114 = publishEmulatorSourcesInvalid_0114;
+/**
+ * @kind Error
+ *
+ * @summary
+ * The "feed" provider requires a "--opts.url" argument.
+ *
+ * @abstract
+ * The `piral publish --type release` command requires the selection of a suitable
+ * provider for running successfully. The "feed" provider releases the files to
+ * the a Piral Feed Service with the static page feature.
+ *
+ * Make sure to supply the URL for the feed service via the `--opts.url` command
+ * line flag.
+ *
+ * @example
+ * The following command would specify `https://feed.piral.cloud/api/v1/feed/sample/page`
+ * for the feed service:
+ *
+ * ```sh
+ * piral publish --type release --provider feed --opts.url "https://feed.piral.cloud/api/v1/feed/sample/page" --opts.apikey "foobar123"
+ * ```
+ */
+function publishFeedMissingUrl_0115() {
+    return [types_1.LogLevels.error, '0115', `The "feed" provider requires a "--opts.url" argument.`];
+}
+exports.publishFeedMissingUrl_0115 = publishFeedMissingUrl_0115;
+/**
+ * @kind Error
+ *
+ * @summary
+ * The "feed" provider requires a "--opts.version" argument.
+ *
+ * @abstract
+ * The `piral publish --type release` command requires the selection of a suitable
+ * provider for running successfully. The "feed" provider releases the files to
+ * the a Piral Feed Service with the static page feature.
+ *
+ * Make sure to supply the version either explicitly via the `--opts.version` argument
+ * or implicitly by having the artifacts stored in a sub-directory of the project's root,
+ * which contains a package.json with the version to use.
+ *
+ * @example
+ * The following command would specify version "1.2.3" for the feed service:
+ *
+ * ```sh
+ * piral publish --type release --provider feed --opts.url "..." --opts.apikey "..." --opts.version "1.2.3"
+ * ```
+ */
+function publishFeedMissingVersion_0116() {
+    return [
+        types_1.LogLevels.error,
+        '0116',
+        `The "feed" provider requires either a "--opts.version" argument or a package.json with a version.`,
+    ];
+}
+exports.publishFeedMissingVersion_0116 = publishFeedMissingVersion_0116;
 /**
  * @kind Warning
  *
@@ -1988,7 +2484,7 @@ exports.publishEmulatorSourcesInvalid_0114 = publishEmulatorSourcesInvalid_0114;
  * - The API for opening the default browser is invalid
  *
  * @see
- * - [NPM Open Package](https://www.npmjs.com/package/open)
+ * - [npm Open Package](https://www.npmjs.com/package/open)
  *
  * @example
  * The browser is usually just opened via the command line:
@@ -2012,13 +2508,19 @@ exports.failedToOpenBrowser_0170 = failedToOpenBrowser_0170;
  * the interpretation of compatible feed services slightly and has an impact of the usage
  * of the pilet in the browser.
  *
- * The selected schema version needs to be either "v0" or "v1".
+ * The selected schema version needs to be either "v0", "v1", or "v2".
  *
  * - v0: will download and evaluate the pilet explicitly
- * - v1: will use a script tag for integration of the pilet (default)
+ * - v1: will use a script tag for integration of the pilet
+ * - v2: will use SystemJS for integration of the pilet (default)
  *
  * The v1 version has better support for older browsers, but requires a polyfill to work
- * correctly. This polyfill is part of the standard Piral polyfills.
+ * correctly. This polyfill is part of the `piral-ie11polyfills-utils` package.
+ * Alternatively, use the `currentScript-polyfill` package.
+ *
+ * The v2 version uses a SystemJS format for the pilet. It has the broadest browser support
+ * but requires the custom format as output. Most bundlers support SystemJS directly or
+ * indirectly, making it a quite broad choice.
  *
  * @see
  * - [GitHub currentScript-polyfill](https://github.com/amiller-gh/currentScript-polyfill)
@@ -2043,8 +2545,8 @@ exports.invalidSchemaVersion_0171 = invalidSchemaVersion_0171;
  *
  * @abstract
  * Piral allows you to set up your own tooling for building and debugging. This
- * is a powerful concept. By default, the Webpack bundler is used. Alternatives
- * include Parcel and Rollup.
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
+ * Alternatives include Parcel and Rollup.
  *
  * In case where multiple bundlers are installed the first one is picked. This
  * may not be what you want. In this scenario you can override the selection by
@@ -2055,7 +2557,9 @@ exports.invalidSchemaVersion_0171 = invalidSchemaVersion_0171;
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
+ * - [esbuild](https://esbuild.github.io)
+ * - [rspack](https://www.rspack.dev/)
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
  *
  * @example
  * Use the following command to make the parcel bundler available:
@@ -2077,8 +2581,8 @@ exports.bundlerMissing_0172 = bundlerMissing_0172;
  *
  * @abstract
  * Piral allows you to set up your own tooling for building and debugging. This
- * is a powerful concept. By default, the Webpack bundler is used. Alternatives
- * include Parcel and Rollup.
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
+ * Alternatives include Parcel and Rollup.
  *
  * In case where no bundler is installed and the default bundler could not be
  * successfully installed this error is shown.
@@ -2086,7 +2590,9 @@ exports.bundlerMissing_0172 = bundlerMissing_0172;
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
+ * - [esbuild](https://esbuild.github.io)
+ * - [rspack](https://www.rspack.dev/)
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
  *
  * @example
  * Use the following command to make the parcel bundler available:
@@ -2117,7 +2623,9 @@ exports.defaultBundlerMissing_0173 = defaultBundlerMissing_0173;
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
+ * - [esbuild](https://esbuild.github.io)
+ * - [rspack](https://www.rspack.dev/)
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
  *
  * @example
  * Use the following command to make the parcel bundler available:
@@ -2138,8 +2646,8 @@ exports.bundlingFailed_0174 = bundlingFailed_0174;
  *
  * @abstract
  * Piral allows you to set up your own tooling for building and debugging. This
- * is a powerful concept. By default, the Webpack bundler is used. Alternatives
- * include Parcel and Rollup.
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
+ * Alternatives include Parcel and Rollup.
  *
  * In case where multiple bundlers are installed the first one is picked. This
  * may not be what you want. In this scenario you can explicitly set the bundler
@@ -2150,7 +2658,7 @@ exports.bundlingFailed_0174 = bundlingFailed_0174;
  * dependent we recommend setting the bundler explicitly.
  *
  * @see
- * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
  *
  * @example
  * Use the following command to explicitly choose the Parcel bundler:
@@ -2168,6 +2676,85 @@ function bundlerUnspecified_0175(available) {
     ];
 }
 exports.bundlerUnspecified_0175 = bundlerUnspecified_0175;
+/**
+ * @kind Warning
+ *
+ * @summary
+ * No bundler has been installed yet.
+ *
+ * @abstract
+ * Piral allows you to set up your own tooling for building and debugging. This
+ * is a powerful concept. By default, the Webpack v5 bundler is used.
+ * Alternatives include Parcel and Rollup.
+ *
+ * In case no bundler is yet installed the Piral CLI will automatically install
+ * the default bundler. However, you should consider installing a bundler of your
+ * choice (even if this could also be the default bundler) explicitly.
+ *
+ * @see
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
+ *
+ * @example
+ * Use the following command to install esbuild as a bundler with the npm client:
+ *
+ * ```sh
+ * npm i piral-cli-esbuild --save-dev
+ * ```
+ */
+function bundlerNotInstalled_0176() {
+    return [types_1.LogLevels.warning, '0176', `Installing default bundler since no bundler has been found.`];
+}
+exports.bundlerNotInstalled_0176 = bundlerNotInstalled_0176;
+/**
+ * @kind Warning
+ *
+ * @summary
+ * No pilet.json has been found.
+ *
+ * @abstract
+ * For some functionality such as multi Piral instance support when debugging
+ * a pilet, a special file called pilet.json is required. While this file is
+ * optional in general, it must be available for certain tasks such as adding
+ * or removing a Piral instance for debugging purposes.
+ *
+ * @see
+ * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
+ *
+ * @example
+ * If no pilet.json is yet available you can create one. It should be adjacent to
+ * the package.json of your pilet, even though different locations are also possible.
+ * By default, the following content can be used for an empty file:
+ *
+ * ```json
+ * {
+ *   "$schema": "https://docs.piral.io/schemas/pilet-v0.json"
+ * }
+ * ```
+ */
+function piletJsonNotAvailable_0180(root) {
+    return [types_1.LogLevels.warning, '0180', `No "pilet.json" was found for the pilet at "${root}".`];
+}
+exports.piletJsonNotAvailable_0180 = piletJsonNotAvailable_0180;
+/**
+ * @kind Error
+ *
+ * @summary
+ * Using the given platform is not supported.
+ *
+ * @abstract
+ * The Piral instance can run on multiple platforms. The platform is specified via
+ * the piral.json file.
+ *
+ * The standard platform is "web", which starts a web server using the server
+ * proxy kras.
+ *
+ * @example
+ * (tbd)
+ */
+function platformNotSupported_0190(platform) {
+    return [types_1.LogLevels.error, '0190', `The given platform "${platform}" is not supported.`];
+}
+exports.platformNotSupported_0190 = platformNotSupported_0190;
 /**
  * @kind Warning
  *