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

package/src/common/interactive.ts

@@ -1,6 +1,7 @@
 import { Agent } from 'https';
 import { openBrowserAt } from './browser';
 import { standardHeaders } from './info';
+import { logSuspend } from './log';
 import { axios, inquirer } from '../external';
 import { PiletPublishScheme } from '../types';
 
@@ -35,6 +36,8 @@ const tokenRetrievers: Record<string, TokenResult> = {};
 
 export function getTokenInteractively(url: string, httpsAgent: Agent): TokenResult {
   if (!(url in tokenRetrievers)) {
+    const logResume = logSuspend();
+
     tokenRetrievers[url] = axios.default
       .post(
         url,
@@ -53,19 +56,21 @@ 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('===');
 
         openBrowserAt(loginUrl);
 
-        return axios.default.get(callbackUrl).then(({ data }) => {
-          console.log('Logged in successfully.');
-          return {
-            ...data,
-          };
-        });
+        return axios.default
+          .get(callbackUrl)
+          .then(({ data }) => ({ ...data }))
+          .finally(logResume);
       });
   }
 

package/src/common/log.ts

@@ -8,6 +8,7 @@ import { LogLevels, QuickMessage } from '../types';
 
 type Messages = typeof messages;
 type MessageTypes = keyof Messages;
+let currentProgress: string = undefined;
 
 const logger = (() => {
   try {
@@ -92,7 +93,8 @@ export function logFail(message: string, ...args: Array<string | number | boolea
 }
 
 export function progress(message: string, ...args: Array<string | number | boolean>) {
-  logger.progress(format(message, ...args));
+  currentProgress = format(message, ...args)
+  logger.progress(currentProgress);
 }
 
 export function logReset() {
@@ -100,6 +102,12 @@ export function logReset() {
   logger.stopSpinner();
 }
 
+export function logSuspend() {
+  logReset();
+
+  return () => logger.progress(currentProgress);
+}
+
 export function fail<T extends MessageTypes>(type: T, ...args: Parameters<Messages[T]>): never {
   const message = log(type, ...args);
   const error = new Error(message);

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/common/port.ts

@@ -1,6 +1,16 @@
 import { log } from './log';
 import { getPort } from '../external';
 
+export async function getAvailablePort(defaultPort: number) {
+  const selectedPort = await getFreePort(defaultPort);
+
+  if (selectedPort !== defaultPort) {
+    log('portNotFree_0047', selectedPort, defaultPort);
+  }
+
+  return selectedPort;
+}
+
 export async function getFreePort(preferred?: number) {
   log('generalDebug_0003', `Looking for a free port. Preferred port: ${preferred}`);
   const port = await getPort(preferred && { port: preferred });

package/src/helpers.test.ts

@@ -1,4 +1,4 @@
-import { keyOfForceOverwrite, keyOfPiletLanguage, valueOfForceOverwrite, valueOfPiletLanguage } from './helpers';
+import { keyOfForceOverwrite, keyOfSourceLanguage, valueOfForceOverwrite, valueOfSourceLanguage } from './helpers';
 import { ForceOverwrite, SourceLanguage } from './common/enums';
 
 describe('Piral CLI Command Helpers Module', () => {
@@ -13,12 +13,12 @@ describe('Piral CLI Command Helpers Module', () => {
   });
 
   it('correct value of keyOfPiletLanguage results in same key', () => {
-    const result = keyOfPiletLanguage(SourceLanguage.ts);
+    const result = keyOfSourceLanguage(SourceLanguage.ts);
     expect(result).toBe('ts');
   });
 
   it('incorrect value of keyOfPiletLanguage results in key for TS', () => {
-    const result = keyOfPiletLanguage(5);
+    const result = keyOfSourceLanguage(5);
     expect(result).toBe('ts');
   });
 
@@ -33,12 +33,12 @@ describe('Piral CLI Command Helpers Module', () => {
   });
 
   it('correct key of valueOfPiletLanguage results in same value', () => {
-    const result = valueOfPiletLanguage('ts');
+    const result = valueOfSourceLanguage('ts');
     expect(result).toBe(SourceLanguage.ts);
   });
 
   it('incorrect key of valueOfPiletLanguage results in value for TS', () => {
-    const result = valueOfPiletLanguage('foo');
+    const result = valueOfSourceLanguage('foo');
     expect(result).toBe(SourceLanguage.ts);
   });
 });

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> = [];
@@ -42,10 +42,10 @@ export function keyOfForceOverwrite(value: ForceOverwrite) {
   return forceOverwriteKeys[0];
 }
 
-export const piletLanguageKeys = Object.keys(SourceLanguage).filter((m) => typeof SourceLanguage[m] === 'number');
+export const sourceLanguageKeys = Object.keys(SourceLanguage).filter((m) => typeof SourceLanguage[m] === 'number');
 
-export function valueOfPiletLanguage(key: string): SourceLanguage {
-  for (const piletLanguageKey of piletLanguageKeys) {
+export function valueOfSourceLanguage(key: string): SourceLanguage {
+  for (const piletLanguageKey of sourceLanguageKeys) {
     if (piletLanguageKey === key) {
       return SourceLanguage[piletLanguageKey];
     }
@@ -54,12 +54,12 @@ export function valueOfPiletLanguage(key: string): SourceLanguage {
   return SourceLanguage.ts;
 }
 
-export function keyOfPiletLanguage(value: SourceLanguage) {
-  for (const piletLanguageKey of piletLanguageKeys) {
+export function keyOfSourceLanguage(value: SourceLanguage) {
+  for (const piletLanguageKey of sourceLanguageKeys) {
     if (SourceLanguage[piletLanguageKey] === value) {
       return piletLanguageKey;
     }
   }
 
-  return piletLanguageKeys[0];
+  return sourceLanguageKeys[0];
 }

package/src/injectors/{pilet.test.ts → pilet-injector.test.ts}

@@ -1,6 +1,6 @@
 import { EventEmitter } from 'events';
 import { KrasRequest } from 'kras';
-import PiletInjector from './pilet';
+import PiletInjector from './pilet-injector';
 
 const optionsMock = {
   pilets: [],
@@ -9,6 +9,9 @@ const optionsMock = {
   api: '',
   app: '',
   active: true,
+  publicUrl: '/',
+  meta: '',
+  headers: {},
 };
 
 const configMock: any = {
@@ -89,6 +92,9 @@ describe('Piral-CLI piral injector', () => {
       publicUrl: '/',
       api: 'http://someFakeApi:1234',
       app: '',
+      publicUrl: '/',
+      meta: '',
+      headers: {},
       active: true,
     };
 
@@ -118,6 +124,9 @@ describe('Piral-CLI piral injector', () => {
       publicUrl: '/',
       api: 'http://someFakeApi:1234',
       app: '',
+      publicUrl: '/',
+      meta: '',
+      headers: {},
       active: true,
     };
     const core = new EventEmitter();

package/src/injectors/{pilet.ts → pilet-injector.ts}

@@ -24,6 +24,7 @@ export interface PiletInjectorConfig extends KrasInjectorConfig {
   api: string;
   app: string;
   feed?: string;
+  headers: Record<string, string>;
 }
 
 interface PiletMetadata {
@@ -79,40 +80,44 @@ export default class PiletInjector implements KrasInjector {
 
   constructor(options: PiletInjectorConfig, config: KrasConfiguration, core: EventEmitter) {
     this.config = options;
-    // either take a full URI or make it an absolute path relative to the current origin
-    this.piletApi = /^https?:/.test(options.api)
-      ? options.api
-      : `${config.ssl ? 'https' : 'http'}://${host}:${config.port}${options.api}`;
-
-    const { pilets, api, publicUrl } = options;
-    this.indexPath = `${publicUrl}index.html`;
-    const cbs = {};
-
-    core.on('user-connected', (e) => {
-      if (e.target === '*' && e.url === api.substring(1)) {
-        cbs[e.id] = (msg: string) => e.ws.send(msg);
-      }
-    });
 
-    core.on('user-disconnected', (e) => {
-      delete cbs[e.id];
-    });
+    if (this.config.active) {
+      // either take a full URI or make it an absolute path relative to the current origin
+      this.piletApi = /^https?:/.test(options.api)
+        ? options.api
+        : `${config.ssl ? 'https' : 'http'}://${host}:${config.port}${options.api}`;
 
-    pilets.forEach((p, i) =>
-      p.bundler.on(() => {
-        const basePath = `${this.piletApi}/${i}/`;
-        const meta = fillPiletMeta(p, basePath, options.meta);
+      const { pilets, api, publicUrl } = options;
+      this.indexPath = `${publicUrl}index.html`;
+      const cbs = {};
 
-        for (const id of Object.keys(cbs)) {
-          cbs[id](meta);
+      core.on('user-connected', (e) => {
+        if (e.target === '*' && e.url === api.substring(1)) {
+          cbs[e.id] = (msg: string) => e.ws.send(msg);
         }
-      }),
-    );
+      });
+
+      core.on('user-disconnected', (e) => {
+        delete cbs[e.id];
+      });
+
+      pilets.forEach((p, i) =>
+        p.bundler.on(() => {
+          const basePath = `${this.piletApi}/${i}/`;
+          const meta = fillPiletMeta(p, basePath, options.meta);
+
+          for (const id of Object.keys(cbs)) {
+            cbs[id](meta);
+          }
+        }),
+      );
+    }
   }
 
   get active() {
     return this.config.active;
   }
+
   set active(value) {
     this.config.active = value;
   }
@@ -159,9 +164,12 @@ export default class PiletInjector implements KrasInjector {
   }
 
   sendContent(content: Buffer | string, type: string, url: string): KrasResponse {
+    const { headers } = this.config;
+
     return {
       injector: { name: this.name },
       headers: {
+        ...headers,
         'content-type': type,
         'cache-control': 'no-cache, no-store, must-revalidate',
         pragma: 'no-cache',

package/src/injectors/{piral.test.ts → piral-injector.test.ts}

@@ -1,4 +1,4 @@
-import PiralInjector from './piral';
+import PiralInjector from './piral-injector';
 import { KrasRequest, KrasResult } from 'kras';
 import { EventEmitter } from 'events';
 
@@ -37,6 +37,7 @@ describe('Piral-CLI piral injector', () => {
       bundler,
       publicUrl: '/',
       active: true,
+      headers: {},
     };
     const injector = new PiralInjector(config, undefined, new EventEmitter());
     expect(injector.active).toBeTruthy();
@@ -48,6 +49,7 @@ describe('Piral-CLI piral injector', () => {
       bundler: bundlerMock,
       publicUrl: '/',
       active: true,
+      headers: {},
     };
     const injector = new PiralInjector(config, undefined, new EventEmitter());
 
@@ -67,6 +69,7 @@ describe('Piral-CLI piral injector', () => {
       bundler: bundlerMock,
       publicUrl: '/',
       active: true,
+      headers: {},
     };
     const injector = new PiralInjector(config, undefined, new EventEmitter());
 
@@ -83,6 +86,7 @@ describe('Piral-CLI piral injector', () => {
       bundler: bundlerMock,
       publicUrl: '/',
       active: true,
+      headers: {},
     };
     const injector = new PiralInjector(config, undefined, new EventEmitter());
     const request: KrasRequest = {

package/src/injectors/{piral.ts → piral-injector.ts}

@@ -14,6 +14,7 @@ export interface PiralInjectorConfig extends KrasInjectorConfig {
   bundler: Bundler;
   publicUrl: string;
   feed?: string;
+  headers: Record<string, string>;
 }
 
 export default class PiralInjector implements KrasInjector {
@@ -21,29 +22,33 @@ export default class PiralInjector implements KrasInjector {
 
   constructor(options: PiralInjectorConfig, _config: KrasConfiguration, core: EventEmitter) {
     this.config = options;
-    const api = '/$events';
-    const cbs = {};
 
-    core.on('user-connected', (e) => {
-      if (e.target === '*' && e.url === api.substring(1)) {
-        cbs[e.id] = (msg: string) => e.ws.send(msg);
-      }
-    });
-
-    core.on('user-disconnected', (e) => {
-      delete cbs[e.id];
-    });
-
-    this.config.bundler.on((args) => {
-      for (const id of Object.keys(cbs)) {
-        cbs[id](JSON.stringify(args));
-      }
-    });
+    if (this.config.active) {
+      const api = '/$events';
+      const cbs = {};
+
+      core.on('user-connected', (e) => {
+        if (e.target === '*' && e.url === api.substring(1)) {
+          cbs[e.id] = (msg: string) => e.ws.send(msg);
+        }
+      });
+
+      core.on('user-disconnected', (e) => {
+        delete cbs[e.id];
+      });
+
+      this.config.bundler.on((args) => {
+        for (const id of Object.keys(cbs)) {
+          cbs[id](JSON.stringify(args));
+        }
+      });
+    }
   }
 
   get active() {
     return this.config.active;
   }
+
   set active(value) {
     this.config.active = value;
   }
@@ -59,9 +64,11 @@ export default class PiralInjector implements KrasInjector {
   setOptions() {}
 
   sendContent(content: Buffer | string, type: string, url: string): KrasResponse {
+    const { headers } = this.config;
     return {
       injector: { name: this.name },
       headers: {
+        ...headers,
         'content-type': type,
         'cache-control': 'no-cache, no-store, must-revalidate',
         pragma: 'no-cache',

package/src/messages.ts

@@ -953,6 +953,41 @@ export function cannotFindFile_0046(file: string): QuickMessage {
   return [LogLevels.error, '0046', `The file "${file}" does not exist!`];
 }
 
+/**
+ * @kind Warning
+ *
+ * @summary
+ * Reported when the provided / default port was not available.
+ *
+ * @abstract
+ * By default, the debug commands spawn at the port 1234. However, under certain
+ * circumstances (e.g., another debug command running somewhere) this port may not
+ * be free.
+ *
+ * The piral-cli can select a new port, which is free, however, it will still report
+ * a warning message in such cases. You can then always abort the current debug
+ * process and start a new one - either closing the other run blocking the port or
+ * explicitly selecting a new one using the `--port` flag.
+ *
+ * @see
+ * - [Port (computer networking)](https://en.wikipedia.org/wiki/Port_(computer_networking))
+ *
+ * @example
+ * If you start one process to debug an app shell using `piral debug` and another process
+ * to debug some pilet using `pilet debug` both processes would want to run on the default
+ * port 1234.
+ *
+ * As a mitigation you can now either be very explicit, e.g., `piral debug --port 1010` and
+ * `pilet debug --port 1020` or you can just drop one of the two and always only run a single
+ * debug process.
+ *
+ * In any case, running both without any options also works, but then a new port will be chosen.
+ * The output of the Piral CLI will always show you what port is currently used.
+ */
+export function portNotFree_0047(newPort: number, oldPort: number): QuickMessage {
+  return [LogLevels.warning, '0047', `The selected port "${oldPort}" is already used. Changed port to "${newPort}".`];
+}
+
 /**
  * @kind Warning
  *
@@ -2182,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.`];
 }
 
 /**
@@ -2222,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 {
@@ -2243,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".
@@ -2256,6 +2291,58 @@ export function publishEmulatorSourcesInvalid_0114(): QuickMessage {
   ];
 }
 
+/**
+ * @kind Error
+ *
+ * @summary
+ * 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 `--opts.url` command
+ * line flag.
+ *
+ * @example
+ * The following command would specify `https://feed.piral.cloud/api/v1/feed/sample/page`
+ * for the feed service:
+ *
+ * ```sh
+ * 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 "--opts.url" argument.`];
+}
+
+/**
+ * @kind Error
+ *
+ * @summary
+ * 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 `--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.
+ *
+ * @example
+ * The following command would specify version "1.2.3" for the feed service:
+ *
+ * ```sh
+ * 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 "--opts.version" argument or a package.json with a version.`];
+}
+
 /**
  * @kind Warning
  *