piral-cli 0.15.0-alpha.4257 → 0.15.0-alpha.4314

package/src/common/template.ts

@@ -1,53 +1,32 @@
-import { renderFile } from 'ejs';
-import { writeFile } from 'fs';
-import { resolve } from 'path';
-import { log } from './log';
 import { ForceOverwrite } from './enums';
 import { createFileIfNotExists } from './io';
 
-export async function applyTemplate(file: string, data: Record<string, string>) {
-  const content = await new Promise<string>((resolve, reject) => {
-    log('generalDebug_0003', `Filling template in "${file}".`);
-    renderFile(file, data, (err, str) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(str);
-      }
-    });
-  });
-  await new Promise<void>((resolve, reject) => {
-    writeFile(file, content, 'utf8', (err) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve();
-      }
-    });
-  });
-}
+function fillTemplate(data: any = {}) {
+  return `if (process.env.NODE_ENV === 'test') {
+  // behavior for the test environment, we'll try to make it work
 
-export function fillTemplate(name: string, data: any = {}) {
-  const path = resolve(__dirname, '..', '..', 'templates', `${name}.ejs`);
-  return new Promise<string>((resolve, reject) => {
-    log('generalDebug_0003', `Rendering template "${name}" in "${path}".`);
-    renderFile(path, data, (err, str) => {
-      if (err) {
-        reject(err);
-      } else {
-        resolve(str);
-      }
-    });
-  });
+  if (typeof window !== 'undefined') {
+    require('./${data.outFile}');
+    const ctx = window['dbg:piral'];
+    const dependencies = (ctx && ctx.pilets && ctx.pilets.getDependencies({})) || {};
+    module.exports = dependencies['${data.name}'] || {};
+  } else {
+    console.error('Your test environment does not define "window". Please make sure to provide a proper environment.');
+    module.exports = {};
+  }
+} else {
+  // under "normal" circumstances disallow such an import
+  throw new Error("This file should not be included anywhere. Usually, this means you've imported the Piral instance directly.");
+}
+`;
 }
 
-export async function createFileFromTemplateIfNotExists(
-  prefix: string,
+export async function createPiralStubIndexIfNotExists(
   targetDir: string,
   fileName: string,
   forceOverwrite?: ForceOverwrite,
   data?: any,
 ) {
-  const content = await fillTemplate(`${prefix}-${fileName}`, data);
+  const content = fillTemplate(data);
   await createFileIfNotExists(targetDir, fileName, content, forceOverwrite);
 }

package/src/helpers.test.ts

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

package/src/helpers.ts

@@ -1,4 +1,4 @@
-import { ForceOverwrite, SourceLanguage } from './common/enums';
+import { ForceOverwrite } from './common/enums';
 import { bundlerNames, frameworkLibs } from './common/constants';
 import type {
   Framework,
@@ -8,6 +8,7 @@ import type {
   PiralBuildType,
   PiletBuildType,
   PiletPublishScheme,
+  SourceLanguage,
 } from './types';
 
 export const schemaKeys: Array<PiletSchemaVersion> = ['v0', 'v1', 'v2', 'none'];
@@ -15,7 +16,8 @@ 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 sourceLanguageKeys: Array<SourceLanguage> = ['ts', 'js'];
 export const bundlerKeys: Array<string> = ['none', ...bundlerNames];
 export const availableBundlers: Array<string> = [];
 export const availableReleaseProviders: Array<string> = [];
@@ -41,25 +43,3 @@ export function keyOfForceOverwrite(value: ForceOverwrite) {
 
   return forceOverwriteKeys[0];
 }
-
-export const sourceLanguageKeys = Object.keys(SourceLanguage).filter((m) => typeof SourceLanguage[m] === 'number');
-
-export function valueOfSourceLanguage(key: string): SourceLanguage {
-  for (const piletLanguageKey of sourceLanguageKeys) {
-    if (piletLanguageKey === key) {
-      return SourceLanguage[piletLanguageKey];
-    }
-  }
-
-  return SourceLanguage.ts;
-}
-
-export function keyOfSourceLanguage(value: SourceLanguage) {
-  for (const piletLanguageKey of sourceLanguageKeys) {
-    if (SourceLanguage[piletLanguageKey] === value) {
-      return piletLanguageKey;
-    }
-  }
-
-  return sourceLanguageKeys[0];
-}

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
  *

package/src/release.ts

@@ -1,8 +1,19 @@
-import { basename, resolve } from 'path';
-import { copy, fail } from './common';
+import { basename, dirname, relative, resolve } from 'path';
+import { copy, fail, findFile, FormDataObj, postForm, readBinary } from './common';
 import { availableReleaseProviders } from './helpers';
 import { ReleaseProvider } from './types';
 
+async function getVersion(directory: string) {
+  const data = await findFile(directory, 'package.json');
+
+  if (!data) {
+    fail('packageJsonNotFound_0020');
+  }
+
+  const { version } = require(data);
+  return version;
+}
+
 export interface QualifiedReleaseProvider {
   name: string;
   action: ReleaseProvider;
@@ -12,7 +23,7 @@ const providers: Record<string, ReleaseProvider> = {
   none() {
     return Promise.resolve();
   },
-  async xcopy(files, args) {
+  async xcopy(_, files, args) {
     const { target } = args;
 
     if (!target) {
@@ -21,8 +32,30 @@ const providers: Record<string, ReleaseProvider> = {
 
     await Promise.all(files.map(async (file) => copy(file, resolve(target, basename(file)))));
   },
-  async feed(files, args, interactive) {
-    //TODO post files to Piral Feed Service
+  async feed(directory, files, args, interactive) {
+    const { url, apiKey, scheme = 'basic', version = await getVersion(directory) } = args;
+
+    if (!url) {
+      fail('publishFeedMissingUrl_0115');
+    }
+
+    if (!version) {
+      fail('publishFeedMissingVersion_0116');
+    }
+
+    const data: FormDataObj = {
+      version,
+      type: 'custom',
+    };
+
+    for (const file of files) {
+      const relPath = relative(directory, file);
+      const fileName = basename(file);
+      const content = await readBinary(dirname(file), fileName);
+      data[relPath] = [content, fileName];
+    }
+
+    await postForm(url, scheme as any, apiKey, data, {}, undefined, interactive);
   },
 };
 
@@ -48,10 +81,11 @@ export function setReleaseProvider(provider: QualifiedReleaseProvider) {
 
 export function publishArtifacts(
   providerName: string,
+  directory: string,
   files: Array<string>,
   args: Record<string, string>,
   interactive: boolean,
 ) {
   const runRelease = findReleaseProvider(providerName);
-  return runRelease(files, args, interactive);
+  return runRelease(directory, files, args, interactive);
 }

package/src/types/common.ts

@@ -42,13 +42,12 @@ export interface Bundler {
 }
 
 export interface ReleaseProvider {
-  (files: Array<string>, args: Record<string, string>, interactive: boolean): Promise<void>;
+  (directory: string, files: Array<string>, args: Record<string, string>, interactive: boolean): Promise<void>;
 }
 
 export interface TemplateFileLocation {
   from: string;
   to: string;
-  template?: boolean;
   deep?: boolean;
   once?: boolean;
 }

package/src/types/public.ts

@@ -219,6 +219,8 @@ export interface BundlerDefinition {
 
 export type PiletSchemaVersion = 'none' | 'v0' | 'v1' | 'v2';
 
+export type SourceLanguage = 'js' | 'ts';
+
 export type PiletPublishScheme = 'none' | 'digest' | 'bearer' | 'basic';
 
 export type PiletPublishSource = 'local' | 'npm' | 'remote';
@@ -229,7 +231,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';
 

package/templates/piral-index.js.ejs

@@ -1,16 +0,0 @@
-if (process.env.NODE_ENV === 'test') {
-  // behavior for the test environment, we'll try to make it work
-
-  if (typeof window !== 'undefined') {
-    require('./<%- outFile %>');
-    const ctx = window['dbg:piral'];
-    const dependencies = (ctx && ctx.pilets && ctx.pilets.getDependencies({})) || {};
-    module.exports = dependencies['<%- name %>'] || {};
-  } else {
-    console.error('Your test environment does not define "window". Please make sure to provide a proper environment.');
-    module.exports = {};
-  }
-} else {
-  // under "normal" circumstances disallow such an import
-  throw new Error("This file should not be included anywhere. Usually, this means you've imported the Piral instance directly.");
-}