piral-cli 1.4.0-beta.6288 → 1.4.0-beta.6313

package/src/commands.ts

@@ -677,6 +677,40 @@ const allCommands: Array<ToolCommand<any>> = [
       });
     },
   },
+  {
+    name: 'declaration-pilet',
+    alias: ['declare-pilet'],
+    description: 'Creates the TypeScript declaration file (index.d.ts) for a pilet.',
+    arguments: ['[source]'],
+    flags(argv) {
+      return argv
+        .positional('source', {
+          type: 'string',
+          describe: 'Sets the source pilet path for collecting all the information.',
+          default: apps.declarationPiletDefaults.entry,
+        })
+        .string('target')
+        .describe('target', 'Sets the target directory for the generated .d.ts file.')
+        .default('target', apps.declarationPiletDefaults.target)
+        .number('log-level')
+        .describe('log-level', 'Sets the log level to use (1-5).')
+        .default('log-level', apps.declarationPiletDefaults.logLevel)
+        .choices('force-overwrite', forceOverwriteKeys)
+        .describe('force-overwrite', 'Determines if files should be overwritten by the command.')
+        .default('force-overwrite', keyOfForceOverwrite(apps.declarationPiletDefaults.forceOverwrite))
+        .string('base')
+        .default('base', process.cwd())
+        .describe('base', 'Sets the base directory. By default the current directory is used.');
+    },
+    run(args) {
+      return apps.declarationPilet(args.base as string, {
+        entry: args.source as string,
+        target: args.target as string,
+        forceOverwrite: valueOfForceOverwrite(args['force-overwrite'] as string),
+        logLevel: args['log-level'] as LogLevels,
+      });
+    },
+  },
   {
     name: 'new-pilet',
     alias: ['create-pilet', 'scaffold-pilet', 'scaffold', 'new', 'create'],

package/src/common/config.ts

@@ -1,6 +1,6 @@
 import { defaultRegistry } from './constants';
 import { rc } from '../external';
-import { SourceLanguage, NpmClientType, PiletSchemaVersion } from '../types';
+import { AuthConfig, SourceLanguage, NpmClientType, PiletSchemaVersion } from '../types';
 
 export interface PiralCliConfig {
   /**
@@ -12,6 +12,10 @@ export interface PiralCliConfig {
    * Feed URL to API key specifications.
    */
   apiKeys?: Record<string, string>;
+  /**
+   * Emulator URL to auth options mapping.
+   */
+  auth?: Record<string, AuthConfig>;
   /**
    * URL to be used for publishing a pilet in case
    * there is no specialized key in url specified.
@@ -69,6 +73,7 @@ export const config: PiralCliConfig = rc(
   {
     apiKey: undefined,
     apiKeys: {},
+    auth: {},
     url: undefined,
     cert: undefined,
     npmClient: 'npm' as const,

package/src/common/package.ts

@@ -606,6 +606,7 @@ export async function retrievePiletsInfo(entryFile: string) {
     externals,
     name: packageInfo.name,
     version: packageInfo.version,
+    emulator: piralJsonPkg.emulator,
     framework,
     dependencies,
     scripts: packageInfo.scripts,
@@ -672,6 +673,7 @@ async function getPiletPackage(
         start: 'pilet debug',
         build: 'pilet build',
         upgrade: 'pilet upgrade',
+        postinstall: 'pilet declaration',
         ...info.scripts,
       }
     : info.scripts;

package/src/common/spec.ts

@@ -55,6 +55,15 @@ export function getPiletSpecMeta(target: string, basePath: string) {
         requireRef,
         dependencies: getDependencies(plainDependencies, basePath),
       };
+    } else if (
+      content.includes(
+        '"Container initialization failed as it has already been initialized with a different share scope"',
+      ) &&
+      /^var [A-Za-z0-9_]+;/.test(content)
+    ) {
+      return {
+        spec: 'mf',
+      };
     } else {
       // uses no arguments
       return {

package/src/common/website.ts

@@ -1,5 +1,6 @@
 import { join, relative, resolve } from 'path';
 import { createPiralStubIndexIfNotExists } from './template';
+import { config } from './config';
 import { packageJson } from './constants';
 import { ForceOverwrite } from './enums';
 import { createDirectory, readJson, writeBinary } from './io';
@@ -8,6 +9,28 @@ import { progress, log } from './log';
 import { axios } from '../external';
 import { EmulatorWebsiteManifestFiles, EmulatorWebsiteManifest } from '../types';
 
+function requestManifest(url: string) {
+  const auth = config.auth?.[url];
+
+  switch (auth?.mode) {
+    case 'header':
+      return axios.default.get(url, {
+        headers: {
+          [auth.key]: auth.value,
+        },
+      });
+    case 'http':
+      return axios.default.get(url, {
+        auth: {
+          username: auth.username,
+          password: auth.password,
+        },
+      });
+    default:
+      return axios.default.get(url);
+  }
+}
+
 async function downloadEmulatorFiles(manifestUrl: string, target: string, files: EmulatorWebsiteManifestFiles) {
   const requiredFiles = [files.typings, files.main, files.app];
 
@@ -69,7 +92,7 @@ export async function updateFromEmulatorWebsite(targetDir: string, manifestUrl:
   progress(`Updating emulator from %s ...`, manifestUrl);
 
   try {
-    const response = await axios.default.get(manifestUrl);
+    const response = await requestManifest(manifestUrl);
     const nextEmulator: EmulatorWebsiteManifest = response.data;
     const currentEmulator = await readJson(targetDir, packageJson);
 
@@ -90,7 +113,7 @@ export async function updateFromEmulatorWebsite(targetDir: string, manifestUrl:
 
 export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl: string) {
   progress(`Downloading emulator from %s ...`, manifestUrl);
-  const response = await axios.default.get(manifestUrl);
+  const response = await requestManifest(manifestUrl);
   const emulatorJson: EmulatorWebsiteManifest = response.data;
   const targetDir = resolve(rootDir, 'node_modules', emulatorJson.name);
   const appDir = resolve(targetDir, 'app');

package/src/helpers.ts

@@ -11,13 +11,14 @@ import type {
   SourceLanguage,
 } from './types';
 
-export const schemaKeys: Array<PiletSchemaVersion> = ['v0', 'v1', 'v2', 'v3', 'none'];
+export const schemaKeys: Array<PiletSchemaVersion> = ['v0', 'v1', 'v2', 'v3', 'mf', 'none'];
 export const publishModeKeys: Array<PiletPublishScheme> = ['none', 'basic', 'bearer', 'digest'];
 export const fromKeys: Array<PiletPublishSource> = ['local', 'remote', 'npm'];
 export const piralBuildTypeKeys: Array<PiralBuildType> = [
   'all',
   'release',
   'emulator',
+  'emulator-package',
   'emulator-sources',
   'emulator-website',
 ];

package/src/injectors/pilet-injector.ts

@@ -333,6 +333,31 @@ export default class PiletInjector implements KrasInjector {
     return this.sendContent(content, mime.getType(target), url);
   }
 
+  private download(path: string) {
+    const url = new URL(path, this.proxyInfo.source);
+    const auth = commonConfig.auth?.[this.proxyInfo.source];
+
+    switch (auth?.mode) {
+      case 'header':
+        return axios.default.get(url.href, {
+          responseType: 'arraybuffer',
+          headers: {
+            [auth.key]: auth.value,
+          },
+        });
+      case 'http':
+        return axios.default.get(url.href, {
+          responseType: 'arraybuffer',
+          auth: {
+            username: auth.username,
+            password: auth.password,
+          },
+        });
+      default:
+        return axios.default.get(url.href, { responseType: 'arraybuffer' });
+    }
+  }
+
   private async shouldLoad(target: string, path: string) {
     if (this.proxyInfo) {
       if (!this.proxyInfo.files.includes(path)) {
@@ -342,17 +367,12 @@ export default class PiletInjector implements KrasInjector {
       const fileInfo = await stat(target).catch(() => undefined);
 
       if (!fileInfo || fileInfo.mtime < this.proxyInfo.date) {
-        const url = new URL(path, this.proxyInfo.source);
-
         try {
-          const response = await axios.default.get(url.href, { responseType: 'arraybuffer' });
+          const response = await this.download(path);
           await writeFile(target, response.data);
         } catch (ex) {
           log('generalDebug_0003', `HTTP request for emulator asset retrieval failed: ${ex}`);
-          log(
-            fileInfo ? 'optionalEmulatorAssetUpdateSkipped_0122' : 'requiredEmulatorAssetDownloadSkipped_0123',
-            url.href,
-          );
+          log(fileInfo ? 'optionalEmulatorAssetUpdateSkipped_0122' : 'requiredEmulatorAssetDownloadSkipped_0123', path);
           return !!fileInfo;
         }
       }

package/src/messages.ts

@@ -2628,11 +2628,12 @@ export function failedToOpenBrowser_0170(error: string): QuickMessage {
  * the interpretation of compatible feed services slightly and has an impact of the usage
  * of the pilet in the browser.
  *
- * The selected schema version needs to be either "v0", "v1", or "v2".
+ * The selected schema version needs to be either "v0", "v1", "v2", or "mf".
  *
  * - v0: will download and evaluate the pilet explicitly
  * - v1: will use a script tag for integration of the pilet
  * - v2: will use SystemJS for integration of the pilet (default)
+ * - mf: will use Module Federation for integration of the pilet (only supported bundlers)
  *
  * The v1 version has better support for older browsers, but requires a polyfill to work
  * correctly. This polyfill is part of the `piral-ie11polyfills-utils` package.
@@ -2641,6 +2642,10 @@ export function failedToOpenBrowser_0170(error: string): QuickMessage {
  * The v2 version uses a SystemJS format for the pilet. It has the broadest browser support
  * but requires the custom format as output. Most bundlers support SystemJS directly or
  * indirectly, making it a quite broad choice.
+ * 
+ * In bundlers that support Module Federation (e.g., Webpack 5) the "mf" format may be
+ * the best choice. Keep in mind that "mf" is only supported by applications using
+ * Piral 1.4.0 or higher.
  *
  * @see
  * - [GitHub currentScript-polyfill](https://github.com/amiller-gh/currentScript-polyfill)

package/src/types/public.ts

@@ -224,7 +224,21 @@ export type ImportmapVersions = 'all' | 'match-major' | 'any-patch' | 'exact';
 
 export type ImportmapMode = 'host' | 'remote';
 
-export type PiletSchemaVersion = 'none' | 'v0' | 'v1' | 'v2' | 'v3';
+export type PiletSchemaVersion = 'none' | 'v0' | 'v1' | 'v2' | 'v3' | 'mf';
+
+export interface HeaderAuthConfig {
+  mode: 'header';
+  key: string;
+  value: string;
+}
+
+export interface HttpAuthConfig {
+  mode: 'http';
+  username: string;
+  password: string;
+}
+
+export type AuthConfig = HeaderAuthConfig | HttpAuthConfig;
 
 export type SourceLanguage = 'js' | 'ts';
 
@@ -232,7 +246,13 @@ export type PiletPublishScheme = 'none' | 'digest' | 'bearer' | 'basic';
 
 export type PiletPublishSource = 'local' | 'npm' | 'remote';
 
-export type PiralBuildType = 'all' | 'release' | 'emulator' | 'emulator-sources' | 'emulator-website';
+export type PiralBuildType =
+  | 'all'
+  | 'release'
+  | 'emulator'
+  | 'emulator-package'
+  | 'emulator-sources'
+  | 'emulator-website';
 
 export type PiletBuildType = 'default' | 'standalone' | 'manifest';