piral-cli 0.15.9-beta.5387 → 0.15.9-beta.5415

package/src/common/index.ts

@@ -25,6 +25,7 @@ export * from './package';
 export * from './parallel';
 export * from './patcher';
 export * from './patches';
+export * from './platform';
 export * from './port';
 export * from './rules';
 export * from './scaffold';

package/src/common/package.ts

@@ -611,12 +611,12 @@ export async function retrievePiletsInfo(entryFile: string) {
   };
 }
 
-export function validateSharedDependencies(externals: Array<SharedDependency | string>) {
+export function validateSharedDependencies(externals: Array<SharedDependency>) {
   // See #591 - we should warn in case somebody shared piral packages
   for (const external of externals) {
-    const name = typeof external === 'string' ? external : external.name;
+    const name = external.name;
 
-    if (name.startsWith('piral-') && name.indexOf('/') === -1) {
+    if (external.type === 'local' && name.startsWith('piral-') && name.indexOf('/') === -1) {
       log('invalidSharedDependency_0029', name);
     }
   }

package/src/common/platform.ts

@@ -0,0 +1,31 @@
+import { fail } from './log';
+import { PlatformStartShellOptions, PlatformStartModuleOptions } from '../types';
+
+export interface WebPlatformSettings {
+  platform: 'web';
+}
+
+export interface NodePlatformSettings {
+  platform: 'node';
+}
+
+export type PlatformSettings = WebPlatformSettings | NodePlatformSettings;
+
+export interface PlatformTarget {
+  startShell(options: PlatformStartShellOptions): Promise<void>;
+  startModule(options: PlatformStartModuleOptions): Promise<void>;
+}
+
+export function configurePlatform(target: Partial<PlatformSettings> = {}): PlatformTarget {
+  const { platform = 'web', ...options } = target;
+
+  if (platform === 'web') {
+    const { setup } = require('../platforms/web');
+    return setup(options);
+  } else if (platform === 'node') {
+    const { setup } = require('../platforms/node');
+    return setup(options);
+  }
+
+  return fail('platformNotSupported_0190', platform);
+}

package/src/messages.ts

@@ -2555,6 +2555,7 @@ export function invalidSchemaVersion_0171(schemaVersion: string, schemas: Array<
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
  * - [esbuild](https://esbuild.github.io)
+ * - [rspack](https://www.rspack.dev/)
  * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
  *
  * @example
@@ -2587,6 +2588,7 @@ export function bundlerMissing_0172(bundlerName: string, installed: Array<string
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
  * - [esbuild](https://esbuild.github.io)
+ * - [rspack](https://www.rspack.dev/)
  * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
  *
  * @example
@@ -2619,6 +2621,7 @@ export function defaultBundlerMissing_0173(): QuickMessage {
  * - [Webpack](https://webpack.js.org)
  * - [Parcel](https://parceljs.org)
  * - [esbuild](https://esbuild.github.io)
+ * - [rspack](https://www.rspack.dev/)
  * - [Pluggable bundlers](https://docs.piral.io/concepts/T02-bundlers)
  *
  * @example
@@ -2727,6 +2730,26 @@ export function piletJsonNotAvailable_0180(root: string): QuickMessage {
   return [LogLevels.warning, '0180', `No "pilet.json" was found for the pilet at "${root}".`];
 }
 
+/**
+ * @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)
+ */
+export function platformNotSupported_0190(platform: string): QuickMessage {
+  return [LogLevels.error, '0190', `The given platform "${platform}" is not supported.`];
+}
+
 /**
  * @kind Warning
  *

package/src/platforms/node.ts

@@ -0,0 +1,16 @@
+import { PlatformStartShellOptions, PlatformStartModuleOptions } from '../types';
+
+async function startModule(options: PlatformStartModuleOptions) {
+  //TODO
+}
+
+async function startShell(options: PlatformStartShellOptions) {
+  //TODO
+}
+
+export function setup() {
+  return {
+    startModule,
+    startShell,
+  };
+}

package/src/platforms/web.ts

@@ -0,0 +1,142 @@
+import { readKrasConfig, krasrc, buildKrasWithCli } from 'kras';
+import { join, resolve } from 'path';
+import { createInitialKrasConfig, notifyServerOnline } from '../common/injectors';
+import { log } from '../common/log';
+import { config } from '../common/config';
+import { openBrowser } from '../common/browser';
+import { checkExistingDirectory } from '../common/io';
+import { getAvailablePort } from '../common/port';
+import { PlatformStartShellOptions, PlatformStartModuleOptions } from '../types';
+
+async function startModule(options: PlatformStartModuleOptions) {
+  const {
+    appDir,
+    appRoot,
+    fullBase,
+    open,
+    feed,
+    publicUrl,
+    customkrasrc,
+    originalPort,
+    hooks,
+    registerWatcher,
+    registerEnd,
+    pilets,
+    maxListeners,
+  } = options;
+
+  const sources = pilets.map((m) => m.mocks).filter(Boolean);
+  const api = `${publicUrl}${config.piletApi.replace(/^\/+/, '')}`;
+  const baseMocks = resolve(fullBase, 'mocks');
+  const krasBaseConfig = resolve(fullBase, krasrc);
+  const krasRootConfig = resolve(appRoot, krasrc);
+  const initial = createInitialKrasConfig(baseMocks, sources, { [api]: '' }, feed);
+  const configs = [krasBaseConfig, ...pilets.map((p) => resolve(p.root, krasrc)), krasRootConfig];
+  const required = {
+    injectors: {
+      piral: {
+        active: false,
+      },
+      pilet: {
+        active: true,
+        pilets,
+        app: appDir,
+        publicUrl,
+        handle: ['/', api],
+        api,
+      },
+    },
+  };
+
+  if (customkrasrc) {
+    configs.push(resolve(fullBase, customkrasrc));
+  }
+
+  configs.forEach(registerWatcher);
+
+  const port = await getAvailablePort(originalPort);
+  const krasConfig = readKrasConfig({ port, initial, required }, ...configs);
+
+  log('generalVerbose_0004', `Using kras with configuration: ${JSON.stringify(krasConfig, undefined, 2)}`);
+
+  const krasServer = buildKrasWithCli(krasConfig);
+  krasServer.setMaxListeners(maxListeners);
+  krasServer.removeAllListeners('open');
+  krasServer.on('open', notifyServerOnline(publicUrl, krasConfig.api));
+
+  await hooks.beforeOnline?.({ krasServer, krasConfig, open, port, api, feed, pilets, publicUrl });
+  await krasServer.start();
+  openBrowser(open, port, publicUrl, !!krasConfig.ssl);
+  await hooks.afterOnline?.({ krasServer, krasConfig, open, port, api, feed, pilets, publicUrl });
+
+  registerEnd(() => krasServer.stop());
+}
+
+async function startShell(options: PlatformStartShellOptions) {
+  const {
+    fullBase,
+    open,
+    root,
+    targetDir,
+    feed,
+    publicUrl,
+    bundler,
+    customkrasrc,
+    originalPort,
+    hooks,
+    registerWatcher,
+    registerEnd,
+  } = options;
+  const krasBaseConfig = resolve(fullBase, krasrc);
+  const krasRootConfig = resolve(root, krasrc);
+
+  const mocks = join(targetDir, 'mocks');
+  const baseMocks = resolve(fullBase, 'mocks');
+  const mocksExist = await checkExistingDirectory(mocks);
+  const sources = [mocksExist ? mocks : undefined].filter(Boolean);
+  const initial = createInitialKrasConfig(baseMocks, sources);
+  const configs = [krasBaseConfig, krasRootConfig];
+  const required = {
+    injectors: {
+      piral: {
+        active: true,
+        handle: ['/'],
+        feed,
+        publicUrl,
+        bundler,
+      },
+      pilet: {
+        active: false,
+      },
+    },
+  };
+
+  if (customkrasrc) {
+    configs.push(resolve(fullBase, customkrasrc));
+  }
+
+  configs.forEach(registerWatcher);
+
+  const port = await getAvailablePort(originalPort);
+  const krasConfig = readKrasConfig({ port, initial, required }, ...configs);
+  log('generalVerbose_0004', `Using kras with configuration: ${JSON.stringify(krasConfig, undefined, 2)}`);
+
+  const krasServer = buildKrasWithCli(krasConfig);
+  krasServer.setMaxListeners(16);
+  krasServer.removeAllListeners('open');
+  krasServer.on('open', notifyServerOnline(publicUrl, krasConfig.api));
+
+  await hooks.beforeOnline?.({ krasServer, krasConfig, open, port, publicUrl });
+  await krasServer.start();
+  openBrowser(open, port, publicUrl, !!krasConfig.ssl);
+  await hooks.afterOnline?.({ krasServer, krasConfig, open, port, publicUrl });
+
+  registerEnd(() => krasServer.stop());
+}
+
+export function setup() {
+  return {
+    startModule,
+    startShell,
+  };
+}

package/src/types/common.ts

@@ -92,6 +92,38 @@ export interface Bundler {
   ready(): Promise<void>;
 }
 
+export interface PlatformStartModuleOptions {
+  appRoot: string;
+  appDir: string;
+  open: boolean;
+  fullBase: string;
+  feed: string | Array<string>;
+  publicUrl: string;
+  customkrasrc: string;
+  originalPort: number;
+  hooks: Record<string, Function>;
+  registerWatcher(file: string): void;
+  registerEnd(cb: () => void): void;
+
+  maxListeners: number;
+  pilets: Array<any>;
+}
+
+export interface PlatformStartShellOptions {
+  open: boolean;
+  fullBase: string;
+  root: string;
+  feed: string | Array<string>;
+  targetDir: string;
+  publicUrl: string;
+  bundler: Bundler;
+  customkrasrc: string;
+  originalPort: number;
+  hooks: Record<string, Function>;
+  registerWatcher(file: string): void;
+  registerEnd(cb: () => void): void;
+}
+
 export interface ReleaseProvider {
   (directory: string, files: Array<string>, args: Record<string, string>, interactive: boolean): Promise<void>;
 }