piral-cli 1.6.1-beta.7289 → 1.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-cli",
-  "version": "1.6.1-beta.7289",
+  "version": "1.6.1",
   "description": "The standard CLI for creating and building a Piral instance or a Pilet.",
   "keywords": [
     "portal",
@@ -81,5 +81,5 @@
     "typescript": "^5.0.0",
     "yargs": "^15.0.0"
   },
-  "gitHead": "4748c3524b1da3cd677f2f8d299ce11ce7f1bd42"
+  "gitHead": "9fc8bab4468f424e458f5a5c75ba051a196624f5"
 }

package/src/apps/add-piral-instance-pilet.ts

@@ -6,13 +6,12 @@ import {
   log,
   matchAnyPilet,
   findFile,
-  readJson,
-  writeJson,
   logDone,
   installPiralInstance,
   determineNpmClient,
   findPiletRoot,
   piletJson,
+  ensure,
 } from '../common';
 
 export interface AddPiralInstancePiletOptions {
@@ -59,6 +58,10 @@ export async function addPiralInstancePilet(baseDir = process.cwd(), options: Ad
     selected = addPiralInstancePiletDefaults.selected,
     app = addPiralInstancePiletDefaults.app,
   } = options;
+
+  ensure('baseDir', baseDir, 'string');
+  ensure('source', source, 'string');
+
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
   progress('Reading configuration ...');

package/src/apps/build-pilet.ts

@@ -24,6 +24,7 @@ import {
   triggerBuildPilet,
   readText,
   writeText,
+  ensure,
 } from '../common';
 
 interface PiletData {
@@ -199,6 +200,14 @@ export async function buildPilet(baseDir = process.cwd(), options: BuildPiletOpt
     bundlerName,
     app,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('publicUrl', originalPublicUrl, 'string');
+  ensure('entry', entry, 'string');
+  ensure('_', _, 'object');
+  ensure('hooks', hooks, 'object');
+  ensure('target', target, 'string');
+  
   const publicUrl = normalizePublicUrl(originalPublicUrl);
   const fullBase = resolve(process.cwd(), baseDir);
   const entryList = Array.isArray(entry) ? entry : [entry];

package/src/apps/build-piral.ts

@@ -19,6 +19,7 @@ import {
   releaseName,
   triggerBuildEmulator,
   triggerBuildShell,
+  ensure,
 } from '../common';
 
 export interface BuildPiralOptions {
@@ -140,6 +141,14 @@ export async function buildPiral(baseDir = process.cwd(), options: BuildPiralOpt
     hooks = {},
     bundlerName,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('publicUrl', originalPublicUrl, 'string');
+  ensure('entry', entry, 'string');
+  ensure('_', _, 'object');
+  ensure('hooks', hooks, 'object');
+  ensure('target', target, 'string');
+  
   const publicUrl = normalizePublicUrl(originalPublicUrl);
   const fullBase = resolve(process.cwd(), baseDir);
   const useSubdir = type === 'all' || subdir;

package/src/apps/debug-pilet.ts

@@ -23,6 +23,7 @@ import {
   packageJson,
   piletJson,
   defaultSchemaVersion,
+  ensure,
 } from '../common';
 
 export interface DebugPiletOptions {
@@ -235,6 +236,14 @@ export async function debugPilet(baseDir = process.cwd(), options: DebugPiletOpt
     appInstanceDir,
     feed,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('_', _, 'object');
+  ensure('hooks', hooks, 'object');
+  ensure('target', target, 'string');
+  ensure('publicUrl', originalPublicUrl, 'string');
+  ensure('port', originalPort, ['number', 'undefined']);
+  
   const publicUrl = normalizePublicUrl(originalPublicUrl);
   const fullBase = resolve(process.cwd(), baseDir);
   const networks: Array<NetworkSpec> = [];

package/src/apps/debug-piral.ts

@@ -17,6 +17,7 @@ import {
   piralJson,
   packageJson,
   flattenExternals,
+  ensure,
 } from '../common';
 
 export interface DebugPiralOptions {
@@ -129,6 +130,15 @@ export async function debugPiral(baseDir = process.cwd(), options: DebugPiralOpt
     hooks = {},
     bundlerName,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('publicUrl', originalPublicUrl, 'string');
+  ensure('port', originalPort, ['number', 'undefined']);
+  ensure('entry', entry, 'string');
+  ensure('_', _, 'object');
+  ensure('hooks', hooks, 'object');
+  ensure('target', target, 'string');
+  
   const publicUrl = normalizePublicUrl(originalPublicUrl);
   const fullBase = resolve(process.cwd(), baseDir);
   const network: NetworkSpec = {

package/src/apps/declaration-pilet.ts

@@ -7,6 +7,7 @@ import {
   matchAnyPilet,
   retrievePiletData,
   combinePiletExternals,
+  ensure,
 } from '../common';
 import { LogLevels } from '../types';
 
@@ -47,6 +48,11 @@ export async function declarationPilet(baseDir = process.cwd(), options: Declara
     forceOverwrite = declarationPiletDefaults.forceOverwrite,
     logLevel = declarationPiletDefaults.logLevel,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('entry', entry, 'string');
+  ensure('target', target, 'string');
+  
   const entryList = Array.isArray(entry) ? entry : [entry];
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);

package/src/apps/declaration-piral.ts

@@ -1,5 +1,5 @@
 import { resolve } from 'path';
-import { setLogLevel, logDone, createPiralDeclaration, ForceOverwrite } from '../common';
+import { setLogLevel, logDone, createPiralDeclaration, ForceOverwrite, ensure } from '../common';
 import { LogLevels } from '../types';
 
 export interface DeclarationPiralOptions {
@@ -38,9 +38,14 @@ export async function declarationPiral(baseDir = process.cwd(), options: Declara
     forceOverwrite = declarationPiralDefaults.forceOverwrite,
     logLevel = declarationPiralDefaults.logLevel,
   } = options;
+
+  ensure('baseDir', baseDir, 'string');
+  ensure('entry', entry, 'string');
+  ensure('target', target, 'string');
+
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
-  
+
   if (await createPiralDeclaration(fullBase, entry, target, forceOverwrite, logLevel)) {
     logDone(`Declaration created successfully in "${target}"!`);
   }

package/src/apps/new-pilet.ts

@@ -28,6 +28,7 @@ import {
   piletJson,
   defaultSchemaVersion,
   piletJsonSchemaUrl,
+  ensure,
 } from '../common';
 
 export interface NewPiletOptions {
@@ -126,6 +127,13 @@ export async function newPilet(baseDir = process.cwd(), options: NewPiletOptions
     npmClient: defaultNpmClient = newPiletDefaults.npmClient,
     name = newPiletDefaults.name,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('source', source, 'string');
+  ensure('target', target, 'string');
+  ensure('template', template, ['string', 'undefined']);
+  ensure('variables', variables, 'object');
+  
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
   setLogLevel(logLevel);

package/src/apps/new-piral.ts

@@ -20,6 +20,7 @@ import {
   config,
   initNpmProject,
   piralJson,
+  ensure,
 } from '../common';
 
 export interface NewPiralOptions {
@@ -128,6 +129,15 @@ export async function newPiral(baseDir = process.cwd(), options: NewPiralOptions
     name = newPiralDefaults.name,
     npmClient: defaultNpmClient = newPiralDefaults.npmClient,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('framework', framework, 'string');
+  ensure('version', version, 'string');
+  ensure('target', target, 'string');
+  ensure('app', app, 'string');
+  ensure('template', template, 'string');
+  ensure('variables', variables, 'object');
+  
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
 

package/src/apps/pack-pilet.ts

@@ -1,5 +1,5 @@
 import { resolve } from 'path';
-import { createPiletPackage, logDone, setLogLevel, progress } from '../common';
+import { createPiletPackage, logDone, setLogLevel, progress, ensure } from '../common';
 import { LogLevels } from '../types';
 
 export interface PackPiletOptions {
@@ -31,6 +31,11 @@ export async function packPilet(baseDir = process.cwd(), options: PackPiletOptio
     target = packPiletDefaults.target,
     logLevel = packPiletDefaults.logLevel,
   } = options;
+
+  ensure('baseDir', baseDir, 'string');
+  ensure('source', source, 'string');
+  ensure('target', target, 'string');
+
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
   progress('Reading configuration ...');

package/src/apps/publish-pilet.ts

@@ -16,6 +16,7 @@ import {
   matchAnyPilet,
   triggerBuildPilet,
   getCertificate,
+  ensure,
 } from '../common';
 
 export interface PublishPiletOptions {
@@ -212,6 +213,13 @@ export async function publishPilet(baseDir = process.cwd(), options: PublishPile
     hooks = {},
     bundlerName,
   } = options;
+
+  ensure('baseDir', baseDir, 'string');
+  ensure('headers', headers, 'object');
+  ensure('fields', fields, 'object');
+  ensure('_', _, 'object');
+  ensure('hooks', hooks, 'object');
+
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
   progress('Reading configuration ...');

package/src/apps/publish-piral.ts

@@ -24,6 +24,7 @@ import {
   packageJson,
   triggerBuildShell,
   publishPackageEmulator,
+  ensure,
 } from '../common';
 
 export interface PublishPiralOptions {
@@ -128,6 +129,12 @@ export async function publishPiral(baseDir = process.cwd(), options: PublishPira
     hooks = {},
     bundlerName,
   } = options;
+
+  ensure('baseDir', baseDir, 'string');
+  ensure('headers', headers, 'object');
+  ensure('_', _, 'object');
+  ensure('hooks', hooks, 'object');
+
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
   progress('Reading configuration ...');
@@ -150,7 +157,10 @@ export async function publishPiral(baseDir = process.cwd(), options: PublishPira
   } = await retrievePiletsInfo(entryFiles);
 
   if (type === 'emulator' && ![emulatorPackageName, emulatorWebsiteName].includes(emulator)) {
-    fail('generalError_0002', `The emulator type "${emulator}" is not supported. Select one of these types to use the publish command: "${emulatorWebsiteName}", "${emulatorPackageName}".`);
+    fail(
+      'generalError_0002',
+      `The emulator type "${emulator}" is not supported. Select one of these types to use the publish command: "${emulatorWebsiteName}", "${emulatorPackageName}".`,
+    );
   }
 
   const dir = type === 'release' ? releaseName : emulatorName;
@@ -225,7 +235,7 @@ export async function publishPiral(baseDir = process.cwd(), options: PublishPira
     }
 
     progress(`Published successfully!`);
-  
+
     logDone(`Release artifacts published successfully!`);
   } else if (emulator === emulatorWebsiteName) {
     const { version } = await readJson(targetDir, emulatorJson);
@@ -250,7 +260,7 @@ export async function publishPiral(baseDir = process.cwd(), options: PublishPira
     }
 
     progress(`Published successfully!`);
-  
+
     logDone(`Emulator published successfully!`);
   } else if (emulator === emulatorPackageName) {
     log('generalInfo_0000', `Using npm registry "${url}".`);
@@ -271,7 +281,7 @@ export async function publishPiral(baseDir = process.cwd(), options: PublishPira
     } catch {
       fail('failedUploading_0064');
     }
-  
+
     logDone(`Emulator published successfully!`);
   } else {
     // we should not enter here - anyway let's do nothing

package/src/apps/remove-piral-instance-pilet.ts

@@ -13,6 +13,7 @@ import {
   determineNpmClient,
   uninstallNpmPackage,
   piletJson,
+  ensure,
 } from '../common';
 
 export interface RemovePiralInstancePiletOptions {
@@ -52,6 +53,11 @@ export async function removePiralInstancePilet(baseDir = process.cwd(), options:
     source = removePiralInstancePiletDefaults.source,
     app = removePiralInstancePiletDefaults.app,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('source', source, 'string');
+  ensure('app', app, 'string');
+  
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
   progress('Reading configuration ...');

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

@@ -17,6 +17,7 @@ import {
   ForceOverwrite,
   findPiralInstance,
   determineNpmClient,
+  ensure,
 } from '../common';
 
 export interface RunEmulatorPiralOptions {
@@ -96,6 +97,10 @@ export async function runEmulatorPiral(baseDir = process.cwd(), options: RunEmul
     app,
     feed,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('app', app, 'string');
+  
   const publicUrl = '/';
   const api = config.piletApi;
   const fullBase = resolve(process.cwd(), baseDir);

package/src/apps/upgrade-pilet.ts

@@ -25,6 +25,7 @@ import {
   isMonorepoPackageRef,
   getPiletScaffoldData,
   retrievePiletData,
+  ensure,
 } from '../common';
 
 export interface UpgradePiletOptions {
@@ -90,6 +91,11 @@ export async function upgradePilet(baseDir = process.cwd(), options: UpgradePile
     variables = upgradePiletDefaults.variables,
     npmClient: defaultNpmClient = upgradePiletDefaults.npmClient,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('variables', variables, 'object');
+  ensure('target', target, 'string');
+  
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
   setLogLevel(logLevel);

package/src/apps/upgrade-piral.ts

@@ -14,6 +14,7 @@ import {
   repositoryUrl,
   findSpecificVersion,
   determineNpmClient,
+  ensure,
 } from '../common';
 
 export interface UpgradePiralOptions {
@@ -82,6 +83,10 @@ export async function upgradePiral(baseDir = process.cwd(), options: UpgradePira
     install = upgradePiralDefaults.install,
     npmClient: defaultNpmClient = upgradePiralDefaults.npmClient,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('target', target, 'string');
+  
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
   setLogLevel(logLevel);

package/src/apps/validate-pilet.ts

@@ -1,5 +1,5 @@
 import { join, dirname, resolve } from 'path';
-import { ruleSummary, runRules, retrievePiletData, getPiletsInfo, setLogLevel, progress, log } from '../common';
+import { ruleSummary, runRules, retrievePiletData, getPiletsInfo, setLogLevel, progress, log, ensure } from '../common';
 import { getPiletRules } from '../rules';
 import { PiletRuleContext, LogLevels } from '../types';
 
@@ -32,6 +32,10 @@ export async function validatePilet(baseDir = process.cwd(), options: ValidatPil
     logLevel = validatePiletDefaults.logLevel,
     app = validatePiletDefaults.app,
   } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('entry', entry, 'string');
+  
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
   progress('Reading configuration ...');

package/src/apps/validate-piral.ts

@@ -1,5 +1,5 @@
 import { resolve } from 'path';
-import { retrievePiralRoot, retrievePiletsInfo, ruleSummary, runRules, config } from '../common';
+import { retrievePiralRoot, retrievePiletsInfo, ruleSummary, runRules, config, ensure } from '../common';
 import { setLogLevel, progress, log, checkCliCompatibility } from '../common';
 import { getPiralRules } from '../rules';
 import { LogLevels, PiralRuleContext } from '../types';
@@ -23,6 +23,10 @@ export const validatePiralDefaults: ValidatPiralOptions = {
 
 export async function validatePiral(baseDir = process.cwd(), options: ValidatPiralOptions = {}) {
   const { entry = validatePiralDefaults.entry, logLevel = validatePiralDefaults.logLevel } = options;
+  
+  ensure('baseDir', baseDir, 'string');
+  ensure('entry', entry, 'string');
+  
   const fullBase = resolve(process.cwd(), baseDir);
   setLogLevel(logLevel);
   progress('Reading configuration ...');

package/src/commands.ts

@@ -2,7 +2,6 @@ import * as apps from './apps';
 import {
   piletBuildTypeKeys,
   availableBundlers,
-  availableReleaseProviders,
   forceOverwriteKeys,
   keyOfForceOverwrite,
   valueOfForceOverwrite,

package/src/common/constants.ts

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

package/src/common/index.ts

@@ -37,6 +37,7 @@ export * from './shell';
 export * from './spec';
 export * from './template';
 export * from './url';
+export * from './validate';
 export * from './version';
 export * from './watcher';
 export * from './website';

package/src/common/validate.ts

@@ -0,0 +1,11 @@
+import { fail } from './log';
+
+export function ensure(name: string, value: any, expectedType: string | Array<string>) {
+  const actualType = typeof value;
+  const expectedTypes = Array.isArray(expectedType) ? expectedType : [expectedType];
+
+  if (!expectedTypes.includes(actualType)) {
+    const type = expectedTypes.length === 1 ? `"${expectedTypes[0]}"` : `one of "${expectedTypes.join('", "')}"`;
+    fail('generalError_0002', `The type for "${name}" is invalid - it should be ${type}, but was "${actualType}".`);
+  }
+}