piral-cli 0.15.0-alpha.4284 → 0.15.0-alpha.4311

package/lib/types/public.d.ts

@@ -195,7 +195,7 @@ export declare type PiletPublishSource = 'local' | 'npm' | 'remote';
 export declare type PiralBuildType = 'all' | 'release' | 'emulator' | 'emulator-sources';
 export declare type PiletBuildType = 'default' | 'standalone' | 'manifest';
 export declare type PackageType = 'registry' | 'file' | 'git';
-export declare type NpmClientType = 'npm' | 'yarn' | 'pnpm' | 'lerna' | 'rush';
+export declare type NpmClientType = 'npm' | 'yarn' | 'pnp' | 'pnpm' | 'lerna' | 'rush';
 export declare type Framework = 'piral-native' | 'piral' | 'piral-core' | 'piral-base';
 export interface StandardEnvProps {
     production?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-cli",
-  "version": "0.15.0-alpha.4284",
+  "version": "0.15.0-alpha.4311",
   "description": "The standard CLI for creating and building a Piral instance or a Pilet.",
   "keywords": [
     "portal",
@@ -80,5 +80,5 @@
     "typescript": "^4.0.2",
     "yargs": "^15.4.1"
   },
-  "gitHead": "c48d6a2c320241d04e3c9c4c4edb423345003587"
+  "gitHead": "394262be7ca4f7883adf6d34d5635445fd1ef9b8"
 }

package/src/apps/new-pilet.ts

@@ -102,7 +102,7 @@ export const newPiletDefaults: NewPiletOptions = {
   install: true,
   template: undefined,
   logLevel: LogLevels.info,
-  npmClient: config.npmClient,
+  npmClient: undefined,
   bundlerName: 'none',
   variables: {},
 };
@@ -119,6 +119,7 @@ export async function newPilet(baseDir = process.cwd(), options: NewPiletOptions
     logLevel = newPiletDefaults.logLevel,
     bundlerName = newPiletDefaults.bundlerName,
     variables = newPiletDefaults.variables,
+    npmClient: defaultNpmClient = newPiletDefaults.npmClient,
   } = options;
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
@@ -128,7 +129,7 @@ export async function newPilet(baseDir = process.cwd(), options: NewPiletOptions
   const success = await createDirectory(root);
 
   if (success) {
-    const npmClient = await determineNpmClient(root, options.npmClient);
+    const npmClient = await determineNpmClient(root, defaultNpmClient);
     const projectName = basename(root);
 
     progress(`Scaffolding new pilet in %s ...`, root);

package/src/apps/new-piral.ts

@@ -22,7 +22,6 @@ import {
   config,
   initNpmProject,
 } from '../common';
-import { sourceLanguageKeys } from '..';
 
 export interface NewPiralOptions {
   /**
@@ -102,7 +101,7 @@ export const newPiralDefaults: NewPiralOptions = {
   install: true,
   template: 'default',
   logLevel: LogLevels.info,
-  npmClient: config.npmClient,
+  npmClient: undefined,
   bundlerName: 'none',
   variables: {},
 };
@@ -121,6 +120,7 @@ export async function newPiral(baseDir = process.cwd(), options: NewPiralOptions
     logLevel = newPiralDefaults.logLevel,
     bundlerName = newPiralDefaults.bundlerName,
     variables = newPiralDefaults.variables,
+    npmClient: defaultNpmClient = newPiralDefaults.npmClient,
   } = options;
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
@@ -134,7 +134,7 @@ export async function newPiral(baseDir = process.cwd(), options: NewPiralOptions
   const success = await createDirectory(root);
 
   if (success) {
-    const npmClient = await determineNpmClient(root, options.npmClient);
+    const npmClient = await determineNpmClient(root, defaultNpmClient);
     const packageRef = combinePackageRef(framework, version, 'registry');
     const projectName = basename(root);
 

package/src/apps/publish-piral.ts

@@ -1,7 +1,17 @@
 import { resolve } from 'path';
 import { publishArtifacts } from '../release';
+import {
+  setLogLevel,
+  progress,
+  checkExists,
+  fail,
+  logDone,
+  logReset,
+  publishNpmPackage,
+  matchFiles,
+  log,
+} from '../common';
 import { LogLevels, PiralBuildType } from '../types';
-import { setLogLevel, progress, checkExists, fail, logDone, logReset, publishNpmPackage, matchFiles } from '../common';
 
 export interface PublishPiralOptions {
   /**
@@ -15,9 +25,9 @@ export interface PublishPiralOptions {
   logLevel?: LogLevels;
 
   /**
-   * The additional fields to supply for the provider.
+   * The options to supply for the provider.
    */
-  fields?: Record<string, string>;
+  opts?: Record<string, string>;
 
   /**
    * Defines if authorization tokens can be retrieved interactively.
@@ -40,7 +50,7 @@ export const publishPiralDefaults: PublishPiralOptions = {
   logLevel: LogLevels.info,
   type: 'all',
   provider: 'none',
-  fields: {},
+  opts: {},
   interactive: false,
 };
 
@@ -59,6 +69,7 @@ async function publishEmulator(
   }
 
   const files = await matchFiles(directory, '*.tgz');
+  log('generalDebug_0003', `Found ${files.length} in "${directory}": ${files.join(', ')}`);
 
   if (files.length !== 1) {
     fail('publishEmulatorFilesUnexpected_0111', directory);
@@ -70,8 +81,7 @@ async function publishEmulator(
     return p;
   }, [] as Array<string>);
 
-  //TODO support interactive here, too?
-  await publishNpmPackage(directory, file, flags);
+  await publishNpmPackage(directory, file, flags, interactive);
 }
 
 async function publishRelease(
@@ -90,6 +100,7 @@ async function publishRelease(
   }
 
   const files = await matchFiles(directory, '**/*');
+  log('generalDebug_0003', `Found ${files.length} in "${directory}": ${files.join(', ')}`);
   await publishArtifacts(providerName, directory, files, args, interactive);
 }
 
@@ -98,7 +109,7 @@ export async function publishPiral(baseDir = process.cwd(), options: PublishPira
     source = publishPiralDefaults.source,
     type = publishPiralDefaults.type,
     logLevel = publishPiralDefaults.logLevel,
-    fields = publishPiralDefaults.fields,
+    opts = publishPiralDefaults.opts,
     provider = publishPiralDefaults.provider,
     interactive = publishPiralDefaults.interactive,
   } = options;
@@ -113,14 +124,14 @@ export async function publishPiral(baseDir = process.cwd(), options: PublishPira
 
   if (type !== 'release') {
     progress('Publishing emulator package ...');
-    await publishEmulator(fullBase, source, fields, interactive);
+    await publishEmulator(fullBase, source, opts, interactive);
     logDone(`Successfully published emulator.`);
     logReset();
   }
 
   if (type !== 'emulator') {
     progress('Publishing release files ...');
-    await publishRelease(fullBase, source, provider, fields, interactive);
+    await publishRelease(fullBase, source, provider, opts, interactive);
     logDone(`Successfully published release.`);
     logReset();
   }

package/src/apps/upgrade-pilet.ts

@@ -88,6 +88,7 @@ export async function upgradePilet(baseDir = process.cwd(), options: UpgradePile
     logLevel = upgradePiletDefaults.logLevel,
     install = upgradePiletDefaults.install,
     variables = upgradePiletDefaults.variables,
+    npmClient: defaultNpmClient = upgradePiletDefaults.npmClient,
   } = options;
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
@@ -98,7 +99,7 @@ export async function upgradePilet(baseDir = process.cwd(), options: UpgradePile
     fail('invalidPiletTarget_0040');
   }
 
-  const npmClient = await determineNpmClient(root, options.npmClient);
+  const npmClient = await determineNpmClient(root, defaultNpmClient);
   const pckg = await readJson(root, 'package.json');
   const { devDependencies = {}, dependencies = {}, piral, source } = pckg;
 

package/src/apps/upgrade-piral.ts

@@ -80,6 +80,7 @@ export async function upgradePiral(baseDir = process.cwd(), options: UpgradePira
     target = upgradePiralDefaults.target,
     logLevel = upgradePiralDefaults.logLevel,
     install = upgradePiralDefaults.install,
+    npmClient: defaultNpmClient = upgradePiralDefaults.npmClient,
   } = options;
   const fullBase = resolve(process.cwd(), baseDir);
   const root = resolve(fullBase, target);
@@ -91,7 +92,7 @@ export async function upgradePiral(baseDir = process.cwd(), options: UpgradePira
     fail('packageJsonNotFound_0020');
   }
 
-  const npmClient = await determineNpmClient(root, options.npmClient);
+  const npmClient = await determineNpmClient(root, defaultNpmClient);
 
   progress(`Checking provided version ...`);
   const realVersion = await findSpecificVersion('piral-cli', version);

package/src/commands.ts

@@ -205,9 +205,9 @@ const allCommands: Array<ToolCommand<any>> = [
         .choices('provider', availableReleaseProviders)
         .describe('provider', 'Sets the provider for publishing the release assets.')
         .default('provider', apps.publishPiralDefaults.provider)
-        .option('fields', undefined)
-        .describe('fields', 'Sets additional fields to be included in the feed service request.')
-        .default('fields', apps.publishPiralDefaults.fields)
+        .option('opts', undefined)
+        .describe('opts', 'Sets the options to forward to the chosen provider.')
+        .default('opts', apps.publishPiralDefaults.opts)
         .boolean('interactive')
         .describe('interactive', 'Defines if authorization tokens can be retrieved interactively.')
         .default('interactive', apps.publishPiralDefaults.interactive)
@@ -221,7 +221,7 @@ const allCommands: Array<ToolCommand<any>> = [
         logLevel: args['log-level'] as LogLevels,
         type: args.type as PiralBuildType,
         provider: args.provider as string,
-        fields: args.fields as Record<string, string>,
+        opts: args.opts as Record<string, string>,
         interactive: args.interactive as boolean,
       });
     },

package/src/common/clients/index.ts

@@ -1,5 +1,6 @@
 import * as lerna from './lerna';
 import * as npm from './npm';
+import * as pnp from './pnp';
 import * as pnpm from './pnpm';
 import * as rush from './rush';
 import * as yarn from './yarn';
@@ -7,6 +8,7 @@ import * as yarn from './yarn';
 export const clients = {
   lerna,
   npm,
+  pnp,
   pnpm,
   rush,
   yarn,
@@ -14,7 +16,7 @@ export const clients = {
 
 type ClientName = keyof typeof clients;
 
-const directClients = ['npm', 'yarn', 'pnpm'];
+const directClients = ['npm', 'pnp', 'yarn', 'pnpm'];
 
 export function isWrapperClient(client: ClientName) {
   return !directClients.includes(client);

package/src/common/clients/npm.ts

@@ -47,6 +47,10 @@ export async function initProject(projectName: string, target: string) {}
 
 // Functions to exclusively use from npm client:
 
+export async function loginUser() {
+  await runNpmProcess(['login'], '.');
+}
+
 export async function unpackPackage(packageRef: string, target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runNpmProcess(['pack', packageRef, ...flags], target, ms);

package/src/common/clients/pnp.ts

@@ -0,0 +1,77 @@
+import { resolve } from 'path';
+import { log } from '../log';
+import { findFile } from '../io';
+import { runCommand } from '../scripts';
+import { MemoryStream } from '../MemoryStream';
+
+// Helpers:
+
+function runYarnProcess(args: Array<string>, target: string, output?: NodeJS.WritableStream) {
+  log('generalDebug_0003', 'Starting the Yarn PnP process ...');
+  const cwd = resolve(process.cwd(), target);
+  return runCommand('yarn', args, cwd, output);
+}
+
+function convert(flags: Array<string>) {
+  return flags.map((flag) => {
+    switch (flag) {
+      case '--save-exact':
+        return '--exact';
+      case '--save-dev':
+        return '--dev';
+      case '--no-save':
+        // unfortunately no (https://github.com/yarnpkg/yarn/issues/1743)
+        return '';
+      default:
+        return flag;
+    }
+  });
+}
+
+// Client interface functions:
+
+export async function installDependencies(target = '.', ...flags: Array<string>) {
+  const ms = new MemoryStream();
+  await runYarnProcess(['install', ...convert(flags)], target, ms);
+  log('generalDebug_0003', `Yarn PnP install dependencies result: ${ms.value}`);
+  return ms.value;
+}
+
+export async function installPackage(packageRef: string, target = '.', ...flags: Array<string>) {
+  const ms = new MemoryStream();
+  await runYarnProcess(['add', packageRef, ...convert(flags)], target, ms);
+  log('generalDebug_0003', `Yarn PnP install package result: ${ms.value}`);
+  return ms.value;
+}
+
+export async function detectClient(root: string) {
+  return !!(await findFile(root, '.pnp.cjs'));
+}
+
+export async function initProject(projectName: string, target: string) {}
+
+export async function isProject(root: string, packageRef: string) {
+  const details = await listProjects(root);
+
+  if (typeof details === 'object') {
+    return typeof details?.[packageRef]?.location === 'string';
+  }
+
+  return false;
+}
+
+// Functions to exclusively use from yarn client:
+
+export async function listProjects(target: string) {
+  const ms = new MemoryStream();
+
+  try {
+    await runYarnProcess(['workspaces', 'info'], target, ms);
+  } catch (e) {
+    log('generalDebug_0003', `yarn workspaces error: ${e}`);
+    return {};
+  }
+
+  log('generalDebug_0003', `yarn workspaces result: ${ms.value}`);
+  return JSON.parse(ms.value);
+}

package/src/common/clients/yarn.ts

@@ -7,7 +7,7 @@ import { MemoryStream } from '../MemoryStream';
 // Helpers:
 
 function runYarnProcess(args: Array<string>, target: string, output?: NodeJS.WritableStream) {
-  log('generalDebug_0003', 'Starting the Yarn@1 process ...');
+  log('generalDebug_0003', 'Starting the Yarn Classic process ...');
   const cwd = resolve(process.cwd(), target);
   return runCommand('yarn', args, cwd, output);
 }
@@ -33,14 +33,14 @@ function convert(flags: Array<string>) {
 export async function installDependencies(target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runYarnProcess(['install', ...convert(flags)], target, ms);
-  log('generalDebug_0003', `Yarn@1 install dependencies result: ${ms.value}`);
+  log('generalDebug_0003', `Yarn Classic install dependencies result: ${ms.value}`);
   return ms.value;
 }
 
 export async function installPackage(packageRef: string, target = '.', ...flags: Array<string>) {
   const ms = new MemoryStream();
   await runYarnProcess(['add', packageRef, ...convert(flags)], target, ms);
-  log('generalDebug_0003', `Yarn@1 install package result: ${ms.value}`);
+  log('generalDebug_0003', `Yarn Classic install package result: ${ms.value}`);
   return ms.value;
 }
 

package/src/common/interactive.ts

@@ -56,7 +56,11 @@ export function getTokenInteractively(url: string, httpsAgent: Agent): TokenResu
       )
       .then((res) => {
         const { loginUrl, callbackUrl, expires } = res.data;
-        console.log(`Use the URL below to complete the login. The link expires at ${new Date(expires)}.`);
+        const now = new Date();
+        const then = new Date(expires);
+        const diff = ~~((then.valueOf() - now.valueOf()) / (60 * 1000));
+
+        console.log(`Use the URL below to complete the login. The link expires in ${diff} minutes (${then}).`);
         console.log('===');
         console.log(loginUrl);
         console.log('===');

package/src/common/npm.ts

@@ -43,6 +43,10 @@ async function detectMonorepoRoot(root: string): Promise<[] | [string, NpmClient
     const packageJson = await readJson(root, 'package.json');
 
     if (Array.isArray(packageJson?.workspaces)) {
+      if (await checkExists(resolve(root, '.pnp.cjs'))) {
+        return [root, 'pnp'];
+      }
+
       if (await checkExists(resolve(root, 'yarn.lock'))) {
         return [root, 'yarn'];
       }
@@ -74,8 +78,6 @@ export async function determineNpmClient(root: string, selected?: NpmClientType)
       `Results of the lock file check: ${searchedClients.map((m) => `${m.client}=${m.result}`).join(', ')}`,
     );
 
-    const defaultClient = config.npmClient;
-
     if (foundClients.length > 1) {
       const wrapperClient = foundClients.find((m) => isWrapperClient(m.client));
 
@@ -97,12 +99,14 @@ export async function determineNpmClient(root: string, selected?: NpmClientType)
       return client;
     }
 
+    const defaultClient = config.npmClient;
+
     if (clientTypeKeys.includes(defaultClient)) {
       log('generalDebug_0003', `Using the default client: "${defaultClient}".`);
       return defaultClient;
     }
 
-    log('generalDebug_0003', 'Using the default "npm" client.');
+    log('generalDebug_0003', 'Using the fallback "npm" client.');
     return 'npm';
   }
 
@@ -148,9 +152,20 @@ export function initNpmProject(client: NpmClientType, projectName: string, targe
   return initProject(projectName, target);
 }
 
-export function publishNpmPackage(target = '.', file = '*.tgz', flags: Array<string> = []): Promise<string> {
-  const { publishPackage } = clients.npm;
-  return publishPackage(target, file, ...flags);
+export function publishNpmPackage(
+  target = '.',
+  file = '*.tgz',
+  flags: Array<string> = [],
+  interactive = false,
+): Promise<string> {
+  const { publishPackage, loginUser } = clients.npm;
+  return publishPackage(target, file, ...flags).catch(err => {
+    if (!interactive) {
+      throw err;
+    }
+
+    return loginUser().then(() => publishNpmPackage(target, file, flags, false));
+  });
 }
 
 export function createNpmPackage(target = '.'): Promise<string> {

package/src/helpers.ts

@@ -15,7 +15,7 @@ export const publishModeKeys: Array<PiletPublishScheme> = ['none', 'basic', 'bea
 export const fromKeys: Array<PiletPublishSource> = ['local', 'remote', 'npm'];
 export const piralBuildTypeKeys: Array<PiralBuildType> = ['all', 'release', 'emulator', 'emulator-sources'];
 export const piletBuildTypeKeys: Array<PiletBuildType> = ['default', 'standalone', 'manifest'];
-export const clientTypeKeys: Array<NpmClientType> = ['npm', 'pnpm', 'yarn', 'lerna', 'rush'];
+export const clientTypeKeys: Array<NpmClientType> = ['npm', 'pnpm', 'pnp', 'yarn', 'lerna', 'rush'];
 export const bundlerKeys: Array<string> = ['none', ...bundlerNames];
 export const availableBundlers: Array<string> = [];
 export const availableReleaseProviders: Array<string> = [];

package/src/messages.ts

@@ -2217,24 +2217,24 @@ export function publishEmulatorFilesUnexpected_0111(directory: string): QuickMes
  * @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"
  * ```
  */
 export function publishXcopyMissingTarget_0112(): QuickMessage {
-  return [LogLevels.error, '0112', `The "xcopy" provider requires a "--fields.target" argument.`];
+  return [LogLevels.error, '0112', `The "xcopy" provider requires a "--opts.target" argument.`];
 }
 
 /**
@@ -2257,7 +2257,7 @@ export function publishXcopyMissingTarget_0112(): QuickMessage {
  * 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"
  * ```
  */
 export function publishProviderMissing_0113(providerName: string, availableProviders: Array<string>): QuickMessage {
@@ -2278,7 +2278,7 @@ export function publishProviderMissing_0113(providerName: string, availableProvi
  * 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".
@@ -2295,14 +2295,14 @@ export function publishEmulatorSourcesInvalid_0114(): QuickMessage {
  * @kind Error
  *
  * @summary
- * The "feed" provider requires a "--fields.url" argument.
+ * 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 `--fields.url` command
+ * Make sure to supply the URL for the feed service via the `--opts.url` command
  * line flag.
  *
  * @example
@@ -2310,25 +2310,25 @@ export function publishEmulatorSourcesInvalid_0114(): QuickMessage {
  * for the feed service:
  *
  * ```sh
- * piral publish --type release --provider feed --fields.url "https://feed.piral.cloud/api/v1/feed/sample/page" --fields.apikey "foobar123"
+ * piral publish --type release --provider feed --opts.url "https://feed.piral.cloud/api/v1/feed/sample/page" --opts.apikey "foobar123"
  * ```
  */
 export function publishFeedMissingUrl_0115(): QuickMessage {
-  return [LogLevels.error, '0115', `The "feed" provider requires a "--fields.url" argument.`];
+  return [LogLevels.error, '0115', `The "feed" provider requires a "--opts.url" argument.`];
 }
 
 /**
  * @kind Error
  *
  * @summary
- * The "feed" provider requires a "--fields.version" argument.
+ * 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 `--fields.version` argument
+ * 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.
  *
@@ -2336,11 +2336,11 @@ export function publishFeedMissingUrl_0115(): QuickMessage {
  * The following command would specify version "1.2.3" for the feed service:
  *
  * ```sh
- * piral publish --type release --provider feed --fields.url "..." --fields.apikey "..." --fields.version "1.2.3"
+ * piral publish --type release --provider feed --opts.url "..." --opts.apikey "..." --opts.version "1.2.3"
  * ```
  */
 export function publishFeedMissingVersion_0116(): QuickMessage {
-  return [LogLevels.error, '0116', `The "feed" provider requires either a "--fields.version" argument or a package.json with a version.`];
+  return [LogLevels.error, '0116', `The "feed" provider requires either a "--opts.version" argument or a package.json with a version.`];
 }
 
 /**

package/src/release.ts

@@ -49,7 +49,7 @@ const providers: Record<string, ReleaseProvider> = {
     };
 
     for (const file of files) {
-      const relPath = relative(file, directory);
+      const relPath = relative(directory, file);
       const fileName = basename(file);
       const content = await readBinary(dirname(file), fileName);
       data[relPath] = [content, fileName];

package/src/types/public.ts

@@ -229,7 +229,7 @@ export type PiletBuildType = 'default' | 'standalone' | 'manifest';
 
 export type PackageType = 'registry' | 'file' | 'git';
 
-export type NpmClientType = 'npm' | 'yarn' | 'pnpm' | 'lerna' | 'rush';
+export type NpmClientType = 'npm' | 'yarn' | 'pnp' | 'pnpm' | 'lerna' | 'rush';
 
 export type Framework = 'piral-native' | 'piral' | 'piral-core' | 'piral-base';