piral-cli 0.13.8 → 0.14.0-beta.3156

package/src/messages.ts

@@ -161,7 +161,7 @@ export function appInstanceNotFound_0010(name: string): QuickMessage {
  * 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).
@@ -1277,10 +1277,10 @@ export function failedHttpGet_0068(error: string): QuickMessage {
  *
  * @abstract
  * While submitting the HTTP get request an error was reported.
- * 
+ *
  * Potentially, the server returned some more indicative error message. In this
  * case read it carefully to know what version was already published.
- * 
+ *
  * In any case only the documentation of the corresponding feed service can be
  * conclusive how this can be resolved. Presumably, some payment of some fee
  * is necessary to publish pilets.
@@ -1299,28 +1299,28 @@ export function failedToUploadPayment_0161(response: any): QuickMessage {
  *
  * @abstract
  * While submitting the HTTP get request an error was reported.
- * 
+ *
  * Potentially, the server returned some more indicative error message. In this
  * case read it carefully to know what version was already published.
- * 
+ *
  * In any case you need to change the version to continue. You can do that by
  * editing the "version" field in the pilet's package.json or using `npm version`.
  *
  * @example
  * If you already published the pilet, e.g., via
- * 
+ *
  * ```sh
  * pilet publish --api-key ... --url ...
  * ```
- * 
+ *
  * then doing this again without any change should result in this error.
- * 
+ *
  * Now we can patch-upgrade the version of the pilet:
- * 
+ *
  * ```sh
  * npm version patch
  * ```
- * 
+ *
  * And try the `pilet publish` command again. This time it should just work.
  */
 export function failedToUploadVersion_0162(response: any): QuickMessage {
@@ -1337,10 +1337,10 @@ export function failedToUploadVersion_0162(response: any): QuickMessage {
  *
  * @abstract
  * While submitting the HTTP get request an error was reported.
- * 
+ *
  * Potentially, the server returned some more indicative error message. In this
  * case read it carefully to know how much the limit was exceeded.
- * 
+ *
  * In any case the pilet must be somehow trimmed down. Most often, the size is
  * dominantly determined by some external packages that are referened. Use a
  * page such as bundlephobia.com or some IDE tools to find out which packages
@@ -1960,7 +1960,7 @@ export function publishProviderMissing_0113(providerName: string, availableProvi
  * ```sh
  * piral publish --type release --provider xcopy --fields.target "/temp/dest"
  * ```
- * 
+ *
  * The type is "release".
  */
 export function publishEmulatorSourcesInvalid_0114(): QuickMessage {
@@ -2010,14 +2010,19 @@ export function failedToOpenBrowser_0170(error: string): QuickMessage {
  * 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.
  *
+ * 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)
  *
@@ -2053,6 +2058,7 @@ export function invalidSchemaVersion_0171(schemaVersion: string, schemas: Array<
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
+ * - [esbuild](https://esbuild.github.io)
  * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
  *
  * @example
@@ -2084,6 +2090,7 @@ export function bundlerMissing_0172(bundlerName: string, installed: Array<string
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
+ * - [esbuild](https://esbuild.github.io)
  * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
  *
  * @example
@@ -2115,6 +2122,7 @@ export function defaultBundlerMissing_0173(): QuickMessage {
  * @see
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
+ * - [esbuild](https://esbuild.github.io)
  * - [Pluggable bundlers](https://docs.piral.io/reference/documentation/bundlers)
  *
  * @example

package/src/types/common.ts

@@ -76,6 +76,14 @@ export interface RuleContext {
   peerDependencies: Record<string, string>;
 }
 
+export interface SharedDependency {
+  id: string;
+  name: string;
+  ref: string;
+  type: 'local' | 'remote';
+  entry: string;
+}
+
 export interface RuleRunner<T extends RuleContext> {
   (context: T, options: any): void | Promise<void>;
 }
@@ -92,6 +100,7 @@ export interface PiralRuleContext extends RuleContext {
 export interface PiletRuleContext extends RuleContext {
   data: PiralData;
   peerModules: Array<string>;
+  importmap: Array<SharedDependency>;
 }
 
 export interface PiralData {

package/src/types/public.ts

@@ -1,13 +1,5 @@
 import { Argv, Arguments } from 'yargs';
-import {
-  RuleRunner,
-  PiletRuleContext,
-  PiralRuleContext,
-  Bundler,
-  BundleDetails,
-  LogLevels,
-  ReleaseProvider,
-} from './common';
+import { RuleRunner, PiletRuleContext, PiralRuleContext, LogLevels, SharedDependency, ReleaseProvider } from './common';
 
 export interface ToolCommandRunner<U = {}> {
   (args: Arguments<U>): void | Promise<void>;
@@ -108,6 +100,7 @@ export interface DebugPiletParameters extends BaseBundleParameters {
   piral: string;
   hmr: boolean;
   externals: Array<string>;
+  importmap: Array<SharedDependency>;
   targetDir: string;
   entryModule: string;
   logLevel: LogLevels;
@@ -120,6 +113,7 @@ export interface BuildPiletParameters extends BaseBundleParameters {
   contentHash: boolean;
   minify: boolean;
   externals: Array<string>;
+  importmap: Array<SharedDependency>;
   targetDir: string;
   outFile: string;
   outDir: string;
@@ -128,28 +122,85 @@ export interface BuildPiletParameters extends BaseBundleParameters {
   version: PiletSchemaVersion;
 }
 
-export interface WatchPiralBundlerDefinition {
-  run(args: WatchPiralParameters): Promise<Bundler>;
+export interface BundlerPrepareArgs<T> {
+  (args: T): T | Promise<T>;
 }
 
-export interface DebugPiralBundlerDefinition {
+export interface BaseBundlerDefinition<T> {
+  path: string;
+  prepare?: BundlerPrepareArgs<T>;
+}
+
+export interface WatchPiralBundlerDefinition extends BaseBundlerDefinition<WatchPiralParameters> {}
+
+export interface DebugPiralBundlerDefinition extends BaseBundlerDefinition<DebugPiralParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: DebugPiralParameters): Promise<Bundler>;
 }
 
-export interface BuildPiralBundlerDefinition {
+export interface BuildPiralBundlerDefinition extends BaseBundlerDefinition<BuildPiralParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: BuildPiralParameters): Promise<BundleDetails>;
 }
 
-export interface DebugPiletBundlerDefinition {
+export interface DebugPiletBundlerDefinition extends BaseBundlerDefinition<DebugPiletParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: DebugPiletParameters): Promise<Bundler>;
 }
 
-export interface BuildPiletBundlerDefinition {
+export interface BuildPiletBundlerDefinition extends BaseBundlerDefinition<BuildPiletParameters> {
   flags?: ToolCommandFlagsSetter;
-  run(args: BuildPiletParameters): Promise<BundleDetails>;
+}
+
+export interface PiralBuildHandler {
+  create(config: {
+    root: string;
+    entryFiles: string;
+    outDir: string;
+    outFile: string;
+    externals: Array<string>;
+    emulator: boolean;
+    sourceMaps: boolean;
+    contentHash: boolean;
+    minify: boolean;
+    publicUrl: string;
+    hmr: boolean;
+    logLevel: LogLevels;
+    watch: boolean;
+    args: any;
+  }): Promise<BundleHandlerResponse>;
+}
+
+export interface PiletBuildHandler {
+  create(config: {
+    root: string;
+    piral: string;
+    entryModule: string;
+    targetDir: string;
+    outDir: string;
+    outFile: string;
+    externals: Array<string>;
+    importmap: Array<SharedDependency>;
+    version: PiletSchemaVersion;
+    develop: boolean;
+    sourceMaps: boolean;
+    contentHash: boolean;
+    minify: boolean;
+    logLevel: LogLevels;
+    watch: boolean;
+    args: any;
+  }): Promise<BundleHandlerResponse>;
+}
+
+export interface BundleResult {
+  outDir: string;
+  outFile: string;
+  hash?: string;
+  name?: string;
+  requireRef?: string;
+}
+
+export interface BundleHandlerResponse {
+  onStart(cb: () => void): void;
+  onEnd(cb: (result: BundleResult) => void): void;
+  bundle(): Promise<BundleResult>;
 }
 
 export interface BundlerDefinition {
@@ -160,7 +211,7 @@ export interface BundlerDefinition {
   buildPilet: BuildPiletBundlerDefinition;
 }
 
-export type PiletSchemaVersion = 'none' | 'v0' | 'v1';
+export type PiletSchemaVersion = 'none' | 'v0' | 'v1' | 'v2';
 
 export type PiletPublishSource = 'local' | 'npm' | 'remote';