piral-cli 1.8.0-beta.7544 → 1.8.0-beta.7653

package/src/apps/run-emulator-piral.ts

@@ -18,6 +18,8 @@ import {
   findPiralInstance,
   determineNpmClient,
   ensure,
+  getCertificate,
+  getAgent,
 } from '../common';
 
 export interface RunEmulatorPiralOptions {
@@ -61,6 +63,16 @@ export interface RunEmulatorPiralOptions {
    * The package registry to use for resolving the specified Piral app.
    */
   registry?: string;
+
+  /**
+   * Defines a custom certificate for the website emulator.
+   */
+  cert?: string;
+
+  /**
+   * Allow self-signed certificates.
+   */
+  allowSelfSigned?: boolean;
 }
 
 export const runEmulatorPiralDefaults: RunEmulatorPiralOptions = {
@@ -70,6 +82,8 @@ export const runEmulatorPiralDefaults: RunEmulatorPiralOptions = {
   strictPort: config.strictPort,
   registry: config.registry,
   npmClient: undefined,
+  cert: undefined,
+  allowSelfSigned: config.allowSelfSigned,
 };
 
 function createTempDir() {
@@ -94,13 +108,15 @@ export async function runEmulatorPiral(baseDir = process.cwd(), options: RunEmul
     logLevel = runEmulatorPiralDefaults.logLevel,
     npmClient: defaultNpmClient = runEmulatorPiralDefaults.npmClient,
     registry = runEmulatorPiralDefaults.registry,
+    cert = runEmulatorPiralDefaults.cert,
+    allowSelfSigned = runEmulatorPiralDefaults.allowSelfSigned,
     app,
     feed,
   } = options;
-  
+
   ensure('baseDir', baseDir, 'string');
   ensure('app', app, 'string');
-  
+
   const publicUrl = '/';
   const api = config.piletApi;
   const fullBase = resolve(process.cwd(), baseDir);
@@ -114,6 +130,8 @@ export async function runEmulatorPiral(baseDir = process.cwd(), options: RunEmul
   process.stdin?.setMaxListeners(16);
 
   const appRoot = await createTempDir();
+  const ca = await getCertificate(cert);
+  const agent = getAgent({ ca, allowSelfSigned });
 
   if (registry !== runEmulatorPiralDefaults.registry) {
     progress(`Setting up npm registry (%s) ...`, registry);
@@ -128,10 +146,8 @@ always-auth=true`,
   }
 
   const npmClient = await determineNpmClient(appRoot, defaultNpmClient);
-  const packageName = await installPiralInstance(app, fullBase, appRoot, npmClient);
-  const piral = await findPiralInstance(packageName, appRoot, {
-    port: originalPort,
-  });
+  const packageName = await installPiralInstance(app, fullBase, appRoot, npmClient, agent);
+  const piral = await findPiralInstance(packageName, appRoot, { port: originalPort }, agent);
   const port = await getAvailablePort(piral.port, strictPort);
 
   const krasBaseConfig = resolve(fullBase, krasrc);

package/src/apps/upgrade-pilet.ts

@@ -26,6 +26,9 @@ import {
   getPiletScaffoldData,
   retrievePiletData,
   ensure,
+  config,
+  getCertificate,
+  getAgent,
 } from '../common';
 
 export interface UpgradePiletOptions {
@@ -58,6 +61,16 @@ export interface UpgradePiletOptions {
    */
   install?: boolean;
 
+  /**
+   * Defines a custom certificate for the website emulator.
+   */
+  cert?: string;
+  
+  /**
+   * Allow self-signed certificates.
+   */
+  allowSelfSigned?: boolean;
+
   /**
    * Defines the used npm client. By default, "npm" is used
    * if no other client is autodetected. The autodetection
@@ -79,6 +92,8 @@ export const upgradePiletDefaults: UpgradePiletOptions = {
   install: true,
   npmClient: undefined,
   variables: {},
+  cert: undefined,
+  allowSelfSigned: config.allowSelfSigned,
 };
 
 export async function upgradePilet(baseDir = process.cwd(), options: UpgradePiletOptions = {}) {
@@ -90,6 +105,8 @@ export async function upgradePilet(baseDir = process.cwd(), options: UpgradePile
     install = upgradePiletDefaults.install,
     variables = upgradePiletDefaults.variables,
     npmClient: defaultNpmClient = upgradePiletDefaults.npmClient,
+    cert = upgradePiletDefaults.cert,
+    allowSelfSigned = upgradePiletDefaults.allowSelfSigned,
   } = options;
   
   ensure('baseDir', baseDir, 'string');
@@ -106,10 +123,12 @@ export async function upgradePilet(baseDir = process.cwd(), options: UpgradePile
   }
 
   const npmClient = await determineNpmClient(root, defaultNpmClient);
+  const ca = await getCertificate(cert);
+  const agent = getAgent({ ca, allowSelfSigned });
 
   // in case we run from a user's CLI we want to allow updating
   const interactive = isInteractive();
-  const { apps, piletPackage } = await retrievePiletData(root, undefined, interactive);
+  const { apps, piletPackage } = await retrievePiletData(root, undefined, agent, interactive);
   const { devDependencies = {}, dependencies = {}, source } = piletPackage;
 
   if (apps.length === 0) {
@@ -144,7 +163,7 @@ export async function upgradePilet(baseDir = process.cwd(), options: UpgradePile
     if (!monorepoRef) {
       // only install the latest if the shell does come from remote
       progress(`Updating npm package to %s ...`, packageRef);
-      await installNpmPackage(npmClient, packageRef, root, '--no-save');
+      await installNpmPackage(npmClient, packageRef, root);
     }
 
     const piralInfo = await readPiralPackage(root, sourceName);

package/src/commands.ts

@@ -218,6 +218,9 @@ const allCommands: Array<ToolCommand<any>> = [
         .string('ca-cert')
         .describe('ca-cert', 'Sets a custom certificate authority to use, if any.')
         .default('ca-cert', apps.publishPiralDefaults.cert)
+        .boolean('allow-self-signed')
+        .describe('allow-self-signed', 'Indicates that self-signed certificates should be allowed.')
+        .default('allow-self-signed', apps.publishPiralDefaults.allowSelfSigned)
         .number('log-level')
         .describe('log-level', 'Sets the log level to use (1-5).')
         .default('log-level', apps.publishPiralDefaults.logLevel)
@@ -250,6 +253,7 @@ const allCommands: Array<ToolCommand<any>> = [
         logLevel: args['log-level'] as LogLevels,
         apiKey: args['api-key'] as string,
         cert: args['ca-cert'] as string,
+        allowSelfSigned: args['allow-self-signed'] as boolean,
         url: args.url as string,
         interactive: args.interactive as boolean,
         mode: args.mode as PublishScheme,
@@ -687,6 +691,9 @@ const allCommands: Array<ToolCommand<any>> = [
         .boolean('interactive')
         .describe('interactive', 'Defines if authorization tokens can be retrieved interactively.')
         .default('interactive', apps.publishPiletDefaults.interactive)
+        .boolean('allow-self-signed')
+        .describe('allow-self-signed', 'Indicates that self-signed certificates should be allowed.')
+        .default('allow-self-signed', apps.publishPiletDefaults.allowSelfSigned)
         .string('base')
         .default('base', process.cwd())
         .describe('base', 'Sets the base directory. By default the current directory is used.');
@@ -698,6 +705,7 @@ const allCommands: Array<ToolCommand<any>> = [
         url: args.url as string,
         logLevel: args['log-level'] as LogLevels,
         cert: args['ca-cert'] as string,
+        allowSelfSigned: args['allow-self-signed'] as boolean,
         bundlerName: args.bundler as string,
         fresh: args.fresh as boolean,
         from: args.from as PiletPublishSource,
@@ -787,6 +795,12 @@ const allCommands: Array<ToolCommand<any>> = [
         .choices('bundler', bundlerKeys)
         .describe('bundler', 'Sets the default bundler to install.')
         .default('bundler', apps.newPiletDefaults.bundlerName)
+        .string('ca-cert')
+        .describe('ca-cert', 'Sets a custom certificate authority to use, if any.')
+        .default('ca-cert', apps.newPiletDefaults.cert)
+        .boolean('allow-self-signed')
+        .describe('allow-self-signed', 'Indicates that self-signed certificates should be allowed.')
+        .default('allow-self-signed', apps.newPiletDefaults.allowSelfSigned)
         .option('vars', undefined)
         .describe('vars', 'Sets additional variables to be used when scaffolding.')
         .default('vars', apps.newPiletDefaults.variables)
@@ -811,6 +825,8 @@ const allCommands: Array<ToolCommand<any>> = [
         bundlerName: args.bundler as string,
         variables: args.vars as Record<string, string>,
         name: args['name'] as string,
+        cert: args['ca-cert'] as string,
+        allowSelfSigned: args['allow-self-signed'] as boolean,
       });
     },
   },
@@ -819,7 +835,7 @@ const allCommands: Array<ToolCommand<any>> = [
     alias: ['upgrade'],
     description: 'Upgrades an existing pilet to the latest version of the used Piral instance.',
     arguments: ['[target-version]'],
-    flags(argv) {
+    flags(argv: any) {
       return argv
         .positional('target-version', {
           type: 'string',
@@ -842,6 +858,12 @@ const allCommands: Array<ToolCommand<any>> = [
         .choices('npm-client', clientTypeKeys)
         .describe('npm-client', 'Sets the npm client to be used when upgrading.')
         .default('npm-client', apps.upgradePiletDefaults.npmClient)
+        .string('ca-cert')
+        .describe('ca-cert', 'Sets a custom certificate authority to use, if any.')
+        .default('ca-cert', apps.upgradePiletDefaults.cert)
+        .boolean('allow-self-signed')
+        .describe('allow-self-signed', 'Indicates that self-signed certificates should be allowed.')
+        .default('allow-self-signed', apps.upgradePiletDefaults.allowSelfSigned)
         .option('vars', undefined)
         .describe('vars', 'Sets additional variables to be used when scaffolding.')
         .default('vars', apps.upgradePiletDefaults.variables)
@@ -858,6 +880,8 @@ const allCommands: Array<ToolCommand<any>> = [
         install: args.install as boolean,
         npmClient: args['npm-client'] as NpmClientType,
         variables: args.vars as Record<string, string>,
+        cert: args['ca-cert'] as string,
+        allowSelfSigned: args['allow-self-signed'] as boolean,
       });
     },
   },
@@ -916,6 +940,12 @@ const allCommands: Array<ToolCommand<any>> = [
         .boolean('selected')
         .describe('selected', 'Defines if the provided Piral instance should be selected initially.')
         .default('selected', apps.addPiralInstancePiletDefaults.selected)
+        .string('ca-cert')
+        .describe('ca-cert', 'Sets a custom certificate authority to use, if any.')
+        .default('ca-cert', apps.addPiralInstancePiletDefaults.cert)
+        .boolean('allow-self-signed')
+        .describe('allow-self-signed', 'Indicates that self-signed certificates should be allowed.')
+        .default('allow-self-signed', apps.addPiralInstancePiletDefaults.allowSelfSigned)
         .string('base')
         .default('base', process.cwd())
         .describe('base', 'Sets the base directory. By default the current directory is used.');
@@ -927,6 +957,8 @@ const allCommands: Array<ToolCommand<any>> = [
         npmClient: args['npm-client'] as NpmClientType,
         app: args.app as string,
         source: args.source as string,
+        cert: args['ca-cert'] as string,
+        allowSelfSigned: args['allow-self-signed'] as boolean,
       });
     },
   },
@@ -995,6 +1027,12 @@ const allCommands: Array<ToolCommand<any>> = [
         .choices('npm-client', clientTypeKeys)
         .describe('npm-client', 'Sets the npm client to be used when installing the emulator.')
         .default('npm-client', apps.runEmulatorPiralDefaults.npmClient)
+        .string('ca-cert')
+        .describe('ca-cert', 'Sets a custom certificate authority to use, if any.')
+        .default('ca-cert', apps.runEmulatorPiralDefaults.cert)
+        .boolean('allow-self-signed')
+        .describe('allow-self-signed', 'Indicates that self-signed certificates should be allowed.')
+        .default('allow-self-signed', apps.runEmulatorPiralDefaults.allowSelfSigned)
         .boolean('open')
         .describe('open', 'Opens the Piral instance directly in the browser.')
         .default('open', apps.runEmulatorPiralDefaults.open)
@@ -1014,6 +1052,8 @@ const allCommands: Array<ToolCommand<any>> = [
         logLevel: args['log-level'] as LogLevels,
         open: args.open as boolean,
         feed: args.feed as string,
+        cert: args['ca-cert'] as string,
+        allowSelfSigned: args['allow-self-signed'] as boolean,
       });
     },
   },

package/src/common/config.ts

@@ -73,6 +73,10 @@ export interface PiralCliConfig {
    * Npm registry.
    */
   registry?: string;
+  /**
+   * Allow self-signed certificates.
+   */
+  allowSelfSigned?: boolean;
 }
 
 export const config: PiralCliConfig = rc(
@@ -89,6 +93,7 @@ export const config: PiralCliConfig = rc(
     validators: {},
     schemaVersion: 'v2' as const,
     openBrowser: false,
+    allowSelfSigned: false,
     port: 1234,
     strictPort: false,
     language: 'ts' as const,

package/src/common/constants.ts

@@ -29,6 +29,7 @@ export const bundlerNames = [
   'webpack5' as const,
   'vite' as const,
   'vite5' as const,
+  'vite6' as const,
   'xbuild' as const,
 ];
 export const declarationEntryExtensions = ['.html', '.pug', ...entryModuleExtensions];

package/src/common/emulator.ts

@@ -1,4 +1,4 @@
-import { join, resolve, relative, basename, extname } from 'path';
+import { join, resolve, relative, basename, posix } from 'path';
 import { findDependencyVersion, copyScaffoldingFiles, isValidDependency, flattenExternals } from './package';
 import { createPiralStubIndexIfNotExists } from './template';
 import { filesTar, filesOnceTar, packageJson, piralJson, emulatorJson } from './constants';
@@ -139,9 +139,9 @@ export async function createEmulatorSources(
       version: cliVersion,
       generated: true,
     },
-    main: `./${join(appDir, 'index.js')}`,
-    typings: `./${join(appDir, 'index.d.ts')}`,
-    app: `./${join(appDir, 'index.html')}`,
+    main: `./${posix.join(appDir, 'index.js')}`,
+    typings: `./${posix.join(appDir, 'index.d.ts')}`,
+    app: `./${posix.join(appDir, 'index.html')}`,
     peerDependencies: {},
     optionalDependencies,
     devDependencies: {

package/src/common/http.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, vitest } from 'vitest';
-import { postFile, downloadFile } from './http';
+import { postFile, downloadFile, getAgent } from './http';
 
 const apiUrl = 'http://sample.fooo.com/api/v1/pilet';
 
@@ -80,7 +80,7 @@ vitest.mock('../external', async () => {
         },
       },
     },
-    FormData: (await vitest.importActual('form-data') as any).default,
+    FormData: ((await vitest.importActual('form-data')) as any).default,
   };
 });
 
@@ -155,10 +155,11 @@ describe('HTTP Module', () => {
 
   it('downloadFile calls results in error', async () => {
     errorOther = true;
-    let result = await downloadFile('http://sample.com/', Buffer.from('example'));
+    const agent = getAgent({ ca: Buffer.from('example') });
+    let result = await downloadFile('http://sample.com/', agent);
     expect(result.length).toBe(0);
     errorOther = false;
-    result = await downloadFile('http://sample.com/', Buffer.from('example'));
+    result = await downloadFile('http://sample.com/', agent);
     expect(result.length).toBe(0);
   });
 });

package/src/common/http.ts

@@ -100,8 +100,28 @@ export function getAuthorizationHeaders(scheme: PublishScheme, key: string) {
   return {};
 }
 
-export function downloadFile(target: string, ca?: Buffer): Promise<Array<string>> {
-  const httpsAgent = ca ? new Agent({ ca }) : undefined;
+export interface AgentOptions {
+  ca?: Buffer;
+  allowSelfSigned?: boolean;
+}
+
+export async function getDefaultAgent() {
+  const ca = await getCertificate();
+  const allowSelfSigned = config.allowSelfSigned;
+  return getAgent({ ca, allowSelfSigned });
+}
+
+export function getAgent({ allowSelfSigned, ca }: AgentOptions) {
+  if (ca) {
+    return new Agent({ ca });
+  } else if (allowSelfSigned) {
+    return new Agent({ rejectUnauthorized: false });
+  } else {
+    return undefined;
+  }
+}
+
+export function downloadFile(target: string, httpsAgent: Agent): Promise<Array<string>> {
   return axios.default
     .get<Stream>(target, {
       responseType: 'stream',
@@ -206,10 +226,9 @@ export async function postForm(
   key: string,
   formData: FormDataObj,
   customHeaders: Record<string, string> = {},
-  ca?: Buffer,
+  httpsAgent?: Agent,
   interactive = false,
 ): Promise<PostFormResult> {
-  const httpsAgent = ca ? new Agent({ ca }) : undefined;
   const form = createAxiosForm(formData);
 
   const headers: Record<string, string> = {
@@ -237,7 +256,7 @@ export async function postForm(
       error,
       interactive,
       httpsAgent,
-      (mode, token) => postForm(target, mode, token, formData, customHeaders, ca, false),
+      (mode, token) => postForm(target, mode, token, formData, customHeaders, httpsAgent, false),
       (status, statusText, response) => {
         if (status === 500) {
           log('failedHttpPost_0065', response);
@@ -266,9 +285,9 @@ export function postFile(
   file: Buffer,
   customFields: Record<string, string> = {},
   customHeaders: Record<string, string> = {},
-  ca?: Buffer,
+  agent?: Agent,
   interactive = false,
 ): Promise<PostFormResult> {
   const data: FormDataObj = { ...customFields, file: [file, 'pilet.tgz'] };
-  return postForm(target, scheme, key, data, customHeaders, ca, interactive);
+  return postForm(target, scheme, key, data, customHeaders, agent, interactive);
 }

package/src/common/npm.test.ts

@@ -202,39 +202,39 @@ describe('npm Module', () => {
 
   it('installs a package using the npm command line tool without a target', async () => {
     wrongCase = false;
-    await installNpmPackage('npm', 'foo', 'latest').then((result) => expect(result).toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'npm' }, 'foo', 'latest').then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
-    await installNpmPackage('npm', 'foo', 'latest').then((result) => expect(result).not.toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'npm' }, 'foo', 'latest').then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
   it('installs a package using the npm command line tool without a version', async () => {
     wrongCase = false;
-    await installNpmPackage('npm', 'foo').then((result) => expect(result).toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'npm' }, 'foo').then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
-    await installNpmPackage('npm', 'foo').then((result) => expect(result).not.toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'npm' }, 'foo').then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
   it('installs a package using the Yarn command line tool without a version', async () => {
     wrongCase = false;
-    await installNpmPackage('yarn', 'foo').then((result) => expect(result).toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'yarn' }, 'foo').then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
-    await installNpmPackage('yarn', 'foo').then((result) => expect(result).not.toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'yarn' }, 'foo').then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
   it('installs a package using the Pnpm command line tool without a version', async () => {
     wrongCase = false;
-    await installNpmPackage('pnpm', 'foo').then((result) => expect(result).toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'pnpm' }, 'foo').then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
-    await installNpmPackage('pnpm', 'foo').then((result) => expect(result).not.toEqual(jsonValueString));
+    await installNpmPackage({ direct: 'pnpm' }, 'foo').then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
   it('installs a package using the npm command line tool with some flag', async () => {
     wrongCase = false;
-    await installNpmPackage('npm', 'foo', '1.3', '.', '--a=b').then((result) =>
+    await installNpmPackage({ direct: 'pnpm' }, 'foo', '1.3', '.', '--a=b').then((result) =>
       expect(result).toEqual(jsonValueString),
     );
     wrongCase = true;
-    await installNpmPackage('npm', 'foo', '1.3', '.', '--a=b').then((result) =>
+    await installNpmPackage({ direct: 'pnpm' }, 'foo', '1.3', '.', '--a=b').then((result) =>
       expect(result).not.toEqual(jsonValueString),
     );
   });
@@ -281,23 +281,23 @@ describe('npm Module', () => {
 
   it('install dependencies with npm client', async () => {
     wrongCase = false;
-    await installNpmDependencies('npm').then((result) => expect(result).toEqual(jsonValueString));
+    await installNpmDependencies({ direct: 'npm' }).then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
-    await installNpmDependencies('npm').then((result) => expect(result).not.toEqual(jsonValueString));
+    await installNpmDependencies({ direct: 'npm' }).then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
   it('install dependencies with pnpm client', async () => {
     wrongCase = false;
-    await installNpmDependencies('pnpm').then((result) => expect(result).toEqual(jsonValueString));
+    await installNpmDependencies({ direct: 'pnpm' }).then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
-    await installNpmDependencies('pnpm').then((result) => expect(result).not.toEqual(jsonValueString));
+    await installNpmDependencies({ direct: 'pnpm' }).then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
   it('install dependencies with yarn client', async () => {
     wrongCase = false;
-    await installNpmDependencies('yarn').then((result) => expect(result).toEqual(jsonValueString));
+    await installNpmDependencies({ direct: 'yarn' }).then((result) => expect(result).toEqual(jsonValueString));
     wrongCase = true;
-    await installNpmDependencies('yarn').then((result) => expect(result).not.toEqual(jsonValueString));
+    await installNpmDependencies({ direct: 'yarn' }).then((result) => expect(result).not.toEqual(jsonValueString));
   });
 
   it('create npm package', async () => {