piral-cli 0.15.0-alpha.4034 → 0.15.0-alpha.4098

package/src/common/importmap.ts

@@ -7,8 +7,11 @@ import { SharedDependency } from '../types';
 
 interface Importmap {
   imports: Record<string, string>;
+  inherit: Array<string>;
 }
 
+const shorthandsUrls = ['', '.', '...'];
+
 function tryResolve(baseDir: string, name: string) {
   try {
     return require.resolve(name, {
@@ -53,6 +56,7 @@ function getLocalDependencyVersion(
 async function resolveImportmap(dir: string, importmap: Importmap) {
   const dependencies: Array<SharedDependency> = [];
   const sharedImports = importmap?.imports;
+  const inheritedImports = importmap?.inherit;
 
   if (typeof sharedImports === 'object' && sharedImports) {
     for (const depName of Object.keys(sharedImports)) {
@@ -72,7 +76,7 @@ async function resolveImportmap(dir: string, importmap: Importmap) {
           ref: url,
           type: 'remote',
         });
-      } else if (url === identifier) {
+      } else if (url === identifier || shorthandsUrls.includes(url)) {
         const entry = tryResolve(dir, identifier);
 
         if (entry) {
@@ -88,7 +92,7 @@ async function resolveImportmap(dir: string, importmap: Importmap) {
             type: 'local',
           });
         } else {
-          fail('importMapReferenceNotFound_0027', dir, url);
+          fail('importMapReferenceNotFound_0027', dir, identifier);
         }
       } else {
         const entry = resolve(dir, url);
@@ -96,7 +100,9 @@ async function resolveImportmap(dir: string, importmap: Importmap) {
 
         if (exists) {
           const isDirectory = await checkIsDirectory(entry);
-          const packageJson = isDirectory ? resolve(entry, 'package.json') : await findFile(dirname(entry), 'package.json');
+          const packageJson = isDirectory
+            ? resolve(entry, 'package.json')
+            : await findFile(dirname(entry), 'package.json');
           const packageJsonExists = await checkExists(packageJson);
 
           if (packageJsonExists) {
@@ -131,6 +137,26 @@ async function resolveImportmap(dir: string, importmap: Importmap) {
     }
   }
 
+  if (Array.isArray(inheritedImports)) {
+    for (const inheritedImport of inheritedImports) {
+      const packageJson = tryResolve(dir, `${inheritedImport}/package.json`);
+
+      if (packageJson) {
+        const packageDir = dirname(packageJson);
+        const packageDetails = require(packageJson);
+        const otherDependencies = await readImportmap(packageDir, packageDetails);
+
+        for (const dependency of otherDependencies) {
+          const entry = dependencies.find((dep) => dep.name === dependency.name);
+
+          if (!entry) {
+            dependencies.push(dependency);
+          }
+        }
+      }
+    }
+  }
+
   return dependencies;
 }
 

package/src/common/package.test.ts

@@ -29,7 +29,7 @@ describe('CLI package module', () => {
   it('getPiletsInfo returns pilets information about provided piralInfo', () => {
     const emptyPiletsInfo = {
       files: [],
-      externals: [],
+      template: 'default',
       scripts: {},
       validators: {},
       devDependencies: {},
@@ -45,7 +45,7 @@ describe('CLI package module', () => {
     const piralInfo = {
       pilets: {
         files: ['foo.tgz', 'foo2.tgz'],
-        externals: [],
+        template: 'default',
         scripts: {},
         validators: {},
         devDependencies: {},

package/src/common/package.ts

@@ -150,8 +150,10 @@ function findPackage(pck: string | Array<string>, baseDir: string) {
     if (path) {
       log('generalDebug_0003', `Following the app package in "${path}" ...`);
       const appPackage = require(path);
+      const root = dirname(path);
       const relPath = appPackage && appPackage.app;
-      appPackage.app = relPath && resolve(dirname(path), relPath);
+      appPackage.app = relPath && resolve(root, relPath);
+      appPackage.root = root;
       return appPackage;
     }
   }
@@ -192,6 +194,10 @@ export function getPiralPackage(
       start: 'piral debug',
       build: 'piral build',
     },
+    importmap: {
+      imports: {},
+      inherit: ['piral-base', framework !== 'piral-base' && 'piral-core'].filter(Boolean),
+    },
     pilets: getPiletsInfo({}),
     dependencies,
     devDependencies,
@@ -345,8 +351,8 @@ export async function copyPiralFiles(
 export function getPiletsInfo(piralInfo: any): PiletsInfo {
   const {
     files = [],
-    externals = [],
     scripts = {},
+    template = 'default',
     validators = {},
     devDependencies = {},
     preScaffold = '',
@@ -358,8 +364,8 @@ export function getPiletsInfo(piralInfo: any): PiletsInfo {
 
   return {
     files,
-    externals,
     scripts,
+    template,
     validators,
     devDependencies,
     preScaffold,
@@ -442,6 +448,21 @@ export async function findPackageVersion(rootPath: string, packageName: string):
   }
 }
 
+export async function retrieveExternals(root: string, packageInfo: any) {
+  const sharedDependencies = await readImportmap(root, packageInfo);
+
+  if (sharedDependencies.length === 0) {
+    const allDeps = {
+      ...packageInfo.devDependencies,
+      ...packageInfo.dependencies,
+    };
+    const deps = packageInfo.pilets?.externals;
+    return makeExternals(allDeps, deps);
+  }
+
+  return sharedDependencies.map((m) => m.name);
+}
+
 export async function retrievePiletsInfo(entryFile: string) {
   const exists = await checkExists(entryFile);
 
@@ -456,12 +477,9 @@ export async function retrievePiletsInfo(entryFile: string) {
   }
 
   const packageInfo = require(packageJson);
-  const allDeps = {
-    ...packageInfo.devDependencies,
-    ...packageInfo.dependencies,
-  };
   const info = getPiletsInfo(packageInfo);
-  const externals = makeExternals(allDeps, info.externals);
+  const root = dirname(packageJson);
+  const externals = await retrieveExternals(root, packageInfo);
 
   return {
     ...info,
@@ -475,7 +493,7 @@ export async function retrievePiletsInfo(entryFile: string) {
     },
     scripts: packageInfo.scripts,
     ignored: checkArrayOrUndefined(packageInfo, 'preservedDependencies'),
-    root: dirname(packageJson),
+    root,
   };
 }
 
@@ -599,9 +617,10 @@ export async function retrievePiletData(target: string, app?: string) {
     app || (piletPackage.piral && piletPackage.piral.name) || Object.keys(piletPackage.devDependencies),
     target,
   );
-  const appFile: string = appPackage && appPackage.app;
+  const appFile: string = appPackage?.app;
+  const appRoot: string = appPackage?.root;
 
-  if (!appFile) {
+  if (!appFile || !appRoot) {
     fail('appInstanceInvalid_0011');
   }
 
@@ -616,6 +635,7 @@ export async function retrievePiletData(target: string, app?: string) {
     ignored: checkArrayOrUndefined(piletPackage, 'preservedDependencies'),
     importmap,
     appFile,
+    appRoot,
     piletPackage,
     appPackage,
     emulator,

package/src/common/scaffold.ts

@@ -39,6 +39,7 @@ async function getTemplateFiles(
   } else {
     await installPackage(templatePackageName, __dirname, '--registry', registry);
   }
+
   const templateRunner = getTemplatePackage(templatePackageName);
   const logLevel = getLogLevel();
   const details = {

package/src/injectors/pilet.test.ts

@@ -4,6 +4,8 @@ import PiletInjector from './pilet';
 
 const optionsMock = {
   pilets: [],
+  publicUrl: '/',
+  meta: 'debug-meta.json',
   api: '',
   app: '',
   active: true,
@@ -83,6 +85,8 @@ describe('Piral-CLI piral injector', () => {
     // Arrange
     const optionsMock = {
       pilets: [],
+      meta: 'debug-meta.json',
+      publicUrl: '/',
       api: 'http://someFakeApi:1234',
       app: '',
       active: true,
@@ -110,6 +114,8 @@ describe('Piral-CLI piral injector', () => {
     // Arrange
     const optionsMock = {
       pilets: [],
+      meta: 'debug-meta.json',
+      publicUrl: '/',
       api: 'http://someFakeApi:1234',
       app: '',
       active: true,

package/src/injectors/pilet.ts

@@ -19,6 +19,7 @@ interface Pilet {
 
 export interface PiletInjectorConfig extends KrasInjectorConfig {
   pilets: Array<Pilet>;
+  publicUrl: string;
   meta: string;
   api: string;
   app: string;
@@ -74,6 +75,7 @@ async function loadFeed(feed: string) {
 export default class PiletInjector implements KrasInjector {
   public config: PiletInjectorConfig;
   private piletApi: string;
+  private indexPath: string;
 
   constructor(options: PiletInjectorConfig, config: KrasConfiguration, core: EventEmitter) {
     this.config = options;
@@ -82,7 +84,8 @@ export default class PiletInjector implements KrasInjector {
       ? options.api
       : `${config.ssl ? 'https' : 'http'}://${host}:${config.port}${options.api}`;
 
-    const { pilets, api } = options;
+    const { pilets, api, publicUrl } = options;
+    this.indexPath = `${publicUrl}index.html`;
     const cbs = {};
 
     core.on('user-connected', (e) => {
@@ -210,26 +213,30 @@ export default class PiletInjector implements KrasInjector {
   }
 
   handle(req: KrasRequest): KrasResponse {
-    const { app, api } = this.config;
-    const path = req.url.substring(1).split('?')[0];
+    const { app, api, publicUrl } = this.config;
 
     if (!req.target) {
-      const target = join(app, path);
+      if (req.url.startsWith(publicUrl)) {
+        const path = req.url.substring(publicUrl.length).split('?')[0];
+        const target = join(app, path);
 
-      if (existsSync(target) && statSync(target).isFile()) {
-        if (req.url === '/index.html') {
-          return this.sendIndexFile(target, req.url);
+        if (existsSync(target) && statSync(target).isFile()) {
+          if (req.url === this.indexPath) {
+            return this.sendIndexFile(target, req.url);
+          } else {
+            return this.sendFile(target, req.url);
+          }
+        } else if (req.url !== this.indexPath) {
+          return this.handle({
+            ...req,
+            url: this.indexPath,
+          });
         }
-        return this.sendFile(target, req.url);
-      } else if (req.url !== '/index.html') {
-        return this.handle({
-          ...req,
-          url: '/index.html',
-        });
-      } else {
-        return undefined;
       }
+
+      return undefined;
     } else if (req.target === api) {
+      const path = req.url.substring(1).split('?')[0];
       return this.sendResponse(path, req.url);
     }
   }

package/src/rules/pilet-has-externals-as-peers.ts

@@ -1,5 +1,5 @@
 import { PiletRuleContext } from '../types';
-import { getPiletsInfo, getSourceFiles, isValidDependency } from '../common';
+import { retrieveExternals, getSourceFiles, isValidDependency } from '../common';
 
 export type Options = 'ignore' | 'active' | 'only-used';
 
@@ -21,7 +21,7 @@ Received: Missing "${missingNames.join('", "')}".
  */
 export default async function (context: PiletRuleContext, options: Options = 'ignore') {
   if (options !== 'ignore') {
-    const { externals } = getPiletsInfo(context.data.appPackage);
+    const externals = await retrieveExternals(context.data.appRoot, context.data.appPackage);
     const markedPeerDependencies = Object.keys(context.peerDependencies);
     const markedPeerModules = context.peerModules;
     const missingExternals = externals

package/src/types/common.ts

@@ -55,7 +55,8 @@ export interface TemplateFileLocation {
 
 export interface PiletsInfo {
   files: Array<string | TemplateFileLocation>;
-  externals: Array<string>;
+  template: string;
+  externals?: Array<string>;
   devDependencies: Record<string, string | true>;
   scripts: Record<string, string>;
   validators: Record<string, any>;
@@ -106,6 +107,7 @@ export interface PiletRuleContext extends RuleContext {
 }
 
 export interface PiralData {
+  appRoot: string;
   appFile: string;
   appPackage: any;
   piletPackage: any;

package/src/types/public.ts

@@ -80,6 +80,7 @@ export interface DebugPiralParameters extends BaseBundleParameters {
 export interface WatchPiralParameters extends BaseBundleParameters {
   piral: string;
   externals: Array<string>;
+  publicUrl: string;
   entryFiles: string;
   logLevel: LogLevels;
 }