piral-cli 1.0.0-pre.2217 → 1.0.0

package/lib/types/common.d.ts

@@ -1,3 +1,47 @@
+export interface Importmap {
+    imports: Record<string, string>;
+    inherit: Array<string>;
+}
+export interface PackageData {
+    name: string;
+    version: string;
+    description: string;
+    importmap?: Importmap;
+    main: string;
+    author: string | {
+        name?: string;
+        url?: string;
+        email?: string;
+    };
+    dependencies: Record<string, string>;
+    peerDependencies: Record<string, string>;
+    devDependencies: Record<string, string>;
+}
+export interface PiletPackageData extends PackageData {
+    piral?: {
+        name: string;
+    };
+    custom?: any;
+}
+export interface PiralPackageData extends PackageData {
+    pilets?: PiletsInfo;
+    piralCLI?: {
+        generated: boolean;
+        version: string;
+    };
+}
+export interface PiralInstancePackageData extends PiralPackageData {
+    root: string;
+    app: string;
+    port: number;
+}
+export interface AppDefinition {
+    appPackage: PiralInstancePackageData;
+    appFile: string;
+    appRoot: string;
+    appPort: number;
+    emulator: boolean;
+}
 export declare enum LogLevels {
     /**
      * Logging disabled
@@ -38,8 +82,36 @@ export interface Bundler {
     off(cb: (args: any) => void): void;
     ready(): Promise<void>;
 }
+export interface PlatformStartModuleOptions {
+    appDir?: string;
+    open: boolean;
+    fullBase: string;
+    feed: string | Array<string>;
+    publicUrl: string;
+    customkrasrc: string;
+    originalPort: number;
+    hooks: Record<string, Function>;
+    registerWatcher(file: string): void;
+    registerEnd(cb: () => void): void;
+    maxListeners: number;
+    pilets: Array<any>;
+}
+export interface PlatformStartShellOptions {
+    open: boolean;
+    fullBase: string;
+    root: string;
+    feed: string | Array<string>;
+    targetDir: string;
+    publicUrl: string;
+    bundler: Bundler;
+    customkrasrc: string;
+    originalPort: number;
+    hooks: Record<string, Function>;
+    registerWatcher(file: string): void;
+    registerEnd(cb: () => void): void;
+}
 export interface ReleaseProvider {
-    (files: Array<string>, args: Record<string, string>): Promise<void>;
+    (directory: string, files: Array<string>, args: Record<string, string>, interactive: boolean): Promise<void>;
 }
 export interface TemplateFileLocation {
     from: string;
@@ -49,7 +121,7 @@ export interface TemplateFileLocation {
 }
 export interface PiletsInfo {
     files: Array<string | TemplateFileLocation>;
-    externals: Array<string>;
+    template: string;
     devDependencies: Record<string, string | true>;
     scripts: Record<string, string>;
     validators: Record<string, any>;
@@ -69,6 +141,16 @@ export interface RuleContext {
     devDependencies: Record<string, string>;
     peerDependencies: Record<string, string>;
 }
+export interface SharedDependency {
+    id: string;
+    requireId: string;
+    name: string;
+    ref: string;
+    type: 'local' | 'remote';
+    entry: string;
+    parents?: Array<string>;
+    alias?: string;
+}
 export interface RuleRunner<T extends RuleContext> {
     (context: T, options: any): void | Promise<void>;
 }
@@ -78,13 +160,11 @@ export interface Rule<T extends RuleContext> {
 }
 export interface PiralRuleContext extends RuleContext {
     info: PiletsInfo;
+    externals: Array<SharedDependency>;
 }
 export interface PiletRuleContext extends RuleContext {
-    data: PiralData;
-    peerModules: Array<string>;
-}
-export interface PiralData {
-    appFile: string;
-    appPackage: any;
+    apps: Array<AppDefinition>;
     piletPackage: any;
+    peerModules: Array<string>;
+    importmap: Array<SharedDependency>;
 }

package/lib/types/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":";;;AAAA,IAAY,SA2BX;AA3BD,WAAY,SAAS;IACnB;;OAEG;IACH,iDAAY,CAAA;IACZ;;OAEG;IACH,2CAAS,CAAA;IACT;;OAEG;IACH,+CAAW,CAAA;IACX;;OAEG;IACH,yCAAQ,CAAA;IACR;;;OAGG;IACH,+CAAW,CAAA;IACX;;;OAGG;IACH,2CAAS,CAAA;AACX,CAAC,EA3BW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QA2BpB"}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":";;;AAmDA,IAAY,SA2BX;AA3BD,WAAY,SAAS;IACnB;;OAEG;IACH,iDAAY,CAAA;IACZ;;OAEG;IACH,2CAAS,CAAA;IACT;;OAEG;IACH,+CAAW,CAAA;IACX;;OAEG;IACH,yCAAQ,CAAA;IACR;;;OAGG;IACH,+CAAW,CAAA;IACX;;;OAGG;IACH,2CAAS,CAAA;AACX,CAAC,EA3BW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QA2BpB"}

package/lib/types/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyB;AACzB,6CAA2B;AAC3B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,6CAA2B;AAC3B,2CAAyB"}

package/lib/types/internal.d.ts

@@ -1,16 +1,15 @@
 /// <reference types="node" />
-import { LogLevels } from './common';
-export interface PackageData {
-    name: string;
-    version: string;
-    description: string;
-    main: string;
-    author: string | {
-        name?: string;
-        url?: string;
-        email?: string;
-    };
-    custom?: any;
+import type { LogLevels } from './common';
+import type { PiletSchemaVersion } from './public';
+/**
+ * Shape of the pilet.json
+ */
+export interface PiletDefinition {
+    schemaVersion?: PiletSchemaVersion;
+    piralInstances?: Record<string, {
+        selected?: boolean;
+        port?: number;
+    }>;
 }
 export interface PackageFiles {
     [file: string]: Buffer;
@@ -26,4 +25,4 @@ export interface FileInfo {
  * 1. The unique error code
  * 2. The (short) error message
  */
-export declare type QuickMessage = [LogLevels, string, string];
+export type QuickMessage = [LogLevels, string, string];

package/lib/types/public.d.ts

@@ -1,5 +1,5 @@
 import { Argv, Arguments } from 'yargs';
-import { RuleRunner, PiletRuleContext, PiralRuleContext, Bundler, BundleDetails, LogLevels, ReleaseProvider } from './common';
+import { RuleRunner, PiletRuleContext, PiralRuleContext, LogLevels, SharedDependency, ReleaseProvider } from './common';
 export interface ToolCommandRunner<U = {}> {
     (args: Arguments<U>): void | Promise<void>;
 }
@@ -55,23 +55,28 @@ export interface BaseBundleParameters {
     _: Record<string, any>;
 }
 export interface DebugPiralParameters extends BaseBundleParameters {
-    piral: string;
+    piralInstances: Array<string>;
     hmr: boolean;
     externals: Array<string>;
     publicUrl: string;
+    outFile: string;
+    outDir: string;
     entryFiles: string;
     logLevel: LogLevels;
 }
 export interface WatchPiralParameters extends BaseBundleParameters {
-    piral: string;
+    piralInstances: Array<string>;
     externals: Array<string>;
+    publicUrl: string;
     entryFiles: string;
     logLevel: LogLevels;
 }
 export interface BuildPiralParameters extends BaseBundleParameters {
-    piral: string;
+    piralInstances: Array<string>;
     emulator: boolean;
+    standalone: boolean;
     sourceMaps: boolean;
+    watch: boolean;
     contentHash: boolean;
     minify: boolean;
     externals: Array<string>;
@@ -82,20 +87,25 @@ export interface BuildPiralParameters extends BaseBundleParameters {
     logLevel: LogLevels;
 }
 export interface DebugPiletParameters extends BaseBundleParameters {
-    piral: string;
+    piralInstances: Array<string>;
     hmr: boolean;
     externals: Array<string>;
+    importmap: Array<SharedDependency>;
     targetDir: string;
+    outFile: string;
+    outDir: string;
     entryModule: string;
     logLevel: LogLevels;
     version: PiletSchemaVersion;
 }
 export interface BuildPiletParameters extends BaseBundleParameters {
-    piral: string;
+    piralInstances: Array<string>;
     sourceMaps: boolean;
+    watch: boolean;
     contentHash: boolean;
     minify: boolean;
     externals: Array<string>;
+    importmap: Array<SharedDependency>;
     targetDir: string;
     outFile: string;
     outDir: string;
@@ -103,24 +113,76 @@ export interface BuildPiletParameters extends BaseBundleParameters {
     logLevel: LogLevels;
     version: PiletSchemaVersion;
 }
-export interface WatchPiralBundlerDefinition {
-    run(args: WatchPiralParameters): Promise<Bundler>;
+export interface BundlerPrepareArgs<T> {
+    (args: T): T | Promise<T>;
+}
+export interface BaseBundlerDefinition<T> {
+    path: string;
+    prepare?: BundlerPrepareArgs<T>;
 }
-export interface DebugPiralBundlerDefinition {
+export interface WatchPiralBundlerDefinition extends BaseBundlerDefinition<WatchPiralParameters> {
+}
+export interface DebugPiralBundlerDefinition extends BaseBundlerDefinition<DebugPiralParameters> {
     flags?: ToolCommandFlagsSetter;
-    run(args: DebugPiralParameters): Promise<Bundler>;
 }
-export interface BuildPiralBundlerDefinition {
+export interface BuildPiralBundlerDefinition extends BaseBundlerDefinition<BuildPiralParameters> {
     flags?: ToolCommandFlagsSetter;
-    run(args: BuildPiralParameters): Promise<BundleDetails>;
 }
-export interface DebugPiletBundlerDefinition {
+export interface DebugPiletBundlerDefinition extends BaseBundlerDefinition<DebugPiletParameters> {
     flags?: ToolCommandFlagsSetter;
-    run(args: DebugPiletParameters): Promise<Bundler>;
 }
-export interface BuildPiletBundlerDefinition {
+export interface BuildPiletBundlerDefinition extends BaseBundlerDefinition<BuildPiletParameters> {
     flags?: ToolCommandFlagsSetter;
-    run(args: BuildPiletParameters): Promise<BundleDetails>;
+}
+export interface PiralBuildHandler {
+    create(config: {
+        root: string;
+        entryFiles: string;
+        outDir: string;
+        outFile: string;
+        externals: Array<string>;
+        emulator: boolean;
+        sourceMaps: boolean;
+        contentHash: boolean;
+        minify: boolean;
+        publicUrl: string;
+        hmr: boolean;
+        logLevel: LogLevels;
+        watch: boolean;
+        args: any;
+    }): Promise<BundleHandlerResponse>;
+}
+export interface PiletBuildHandler {
+    create(config: {
+        root: string;
+        piralInstances: Array<string>;
+        entryModule: string;
+        targetDir: string;
+        outDir: string;
+        outFile: string;
+        externals: Array<string>;
+        importmap: Array<SharedDependency>;
+        version: PiletSchemaVersion;
+        develop: boolean;
+        sourceMaps: boolean;
+        contentHash: boolean;
+        minify: boolean;
+        logLevel: LogLevels;
+        watch: boolean;
+        args: any;
+    }): Promise<BundleHandlerResponse>;
+}
+export interface BundleResult {
+    outDir: string;
+    outFile: string;
+    hash?: string;
+    name?: string;
+    requireRef?: string;
+}
+export interface BundleHandlerResponse {
+    onStart(cb: () => void): void;
+    onEnd(cb: (result: BundleResult) => void): void;
+    bundle(): Promise<BundleResult>;
 }
 export interface BundlerDefinition {
     debugPiral: DebugPiralBundlerDefinition;
@@ -129,17 +191,21 @@ export interface BundlerDefinition {
     debugPilet: DebugPiletBundlerDefinition;
     buildPilet: BuildPiletBundlerDefinition;
 }
-export declare type PiletSchemaVersion = 'none' | 'v0' | 'v1';
-export declare type PiletPublishSource = 'local' | 'npm' | 'remote';
-export declare type PiralBuildType = 'all' | 'release' | 'emulator' | 'emulator-sources';
-export declare type PackageType = 'registry' | 'file' | 'git';
-export declare type NpmClientType = 'npm' | 'yarn' | 'pnpm';
-export declare type Framework = 'piral' | 'piral-core' | 'piral-base';
+export type PiletSchemaVersion = 'none' | 'v0' | 'v1' | 'v2' | 'v3';
+export type SourceLanguage = 'js' | 'ts';
+export type PiletPublishScheme = 'none' | 'digest' | 'bearer' | 'basic';
+export type PiletPublishSource = 'local' | 'npm' | 'remote';
+export type PiralBuildType = 'all' | 'release' | 'emulator' | 'emulator-sources';
+export type PiletBuildType = 'default' | 'standalone' | 'manifest';
+export type PackageType = 'registry' | 'file' | 'git';
+export type NpmClientType = 'npm' | 'yarn' | 'pnp' | 'pnpm' | 'lerna' | 'rush';
+export type Framework = 'piral' | 'piral-core' | 'piral-base';
 export interface StandardEnvProps {
     production?: boolean;
     debugPiral?: boolean;
     debugPilet?: boolean;
     root: string;
-    piral?: string;
+    publicPath?: string;
+    piralInstances?: Array<string>;
     dependencies?: Array<string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-cli",
-  "version": "1.0.0-pre.2217",
+  "version": "1.0.0",
   "description": "The standard CLI for creating and building a Piral instance or a Pilet.",
   "keywords": [
     "portal",
@@ -15,7 +15,7 @@
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "engines": {
-    "node": ">=10.0"
+    "node": ">=14.18.0"
   },
   "files": [
     "lib",
@@ -41,41 +41,44 @@
     "pilet": "./lib/pilet-cli.js"
   },
   "scripts": {
-    "build": "tsc --declaration && rimraf lib/external && ncc build src/external/index.ts -o lib/external",
+    "cleanup": "rimraf lib",
+    "build": "yarn build:source && rimraf lib/external && yarn build:external",
+    "build:source": "tsc --declaration",
+    "build:external": "esbuild src/external/index.ts --bundle --outfile=lib/external/index.js --format=cjs --platform=node --external:pnpapi",
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "@parcel/logger": "^1.11.1",
-    "@types/ejs": "^2.6.3",
     "@types/express": "^4.16.1",
     "@types/glob": "^7.1.1",
     "@types/inquirer": "^6.0.0",
+    "@types/jju": "^1.4.2",
     "@types/mime": "^2.0.0",
-    "@types/node": "^12.7.2",
+    "@types/node": "18.0.1",
     "@types/rc": "^1.1.0",
     "@types/rimraf": "^2.0.2",
     "@types/tar": "^4.0.0",
     "@types/yargs": "^15.0.4",
-    "@zeit/ncc": "^0.22.3",
     "axios": "^0.21.1",
+    "chalk": "^4.0.0",
+    "enhanced-resolve": "^5.10.0",
     "form-data": "^3.0.0",
     "get-port": "^5.0.0",
     "glob": "^7.1.3",
     "inquirer": "^6.2.2",
-    "mime": "2.4.4",
+    "is-interactive": "^2.0.0",
+    "jju": "^1.4.0",
+    "mime": "^2.5.2",
     "open": "^7.1.0",
+    "ora": "^6.1.2",
     "rc": "^1.2.8",
-    "strip-ansi": "^5.2.0",
     "tar": "^4.4.8"
   },
   "dependencies": {
-    "chalk": "^2.4.2",
-    "dets": "^0.9.3",
-    "ejs": "^2.6.2",
-    "kras": "^0.12.1",
+    "dets": "^0.13.0",
+    "kras": "^0.15.4",
     "rimraf": "^3.0.0",
-    "typescript": "^4.0.2",
-    "yargs": "^15.4.1"
+    "typescript": "^5.0.0",
+    "yargs": "^15.0.0"
   },
-  "gitHead": "39479fee9a718f9f2fec97ce1a119fc0818805da"
+  "gitHead": "67d9a2920bd5231baf10bc87ae8985666b18fa3a"
 }

package/src/apps/add-piral-instance-pilet.ts

@@ -0,0 +1,98 @@
+import { dirname, resolve } from 'path';
+import { LogLevels, NpmClientType } from '../types';
+import {
+  setLogLevel,
+  progress,
+  log,
+  matchAnyPilet,
+  findFile,
+  readJson,
+  writeJson,
+  logDone,
+  installPiralInstance,
+  determineNpmClient,
+  findPiletRoot,
+  piletJson,
+} from '../common';
+
+export interface AddPiralInstancePiletOptions {
+  /**
+   * Sets the log level to use (1-5).
+   */
+  logLevel?: LogLevels;
+
+  /**
+   * The name of the Piral instance to add.
+   */
+  app?: string;
+
+  /**
+   * Sets the source directory for adding the Piral instance.
+   */
+  source?: string;
+
+  /**
+   * Defines if the provided Piral instance should be selected initially.
+   */
+  selected?: boolean;
+
+  /**
+   * The npm client to be used when scaffolding.
+   * @example 'yarn'
+   */
+  npmClient?: NpmClientType;
+}
+
+export const addPiralInstancePiletDefaults: AddPiralInstancePiletOptions = {
+  logLevel: LogLevels.info,
+  app: undefined,
+  source: '.',
+  selected: false,
+  npmClient: undefined,
+};
+
+export async function addPiralInstancePilet(baseDir = process.cwd(), options: AddPiralInstancePiletOptions = {}) {
+  const {
+    npmClient: defaultNpmClient = addPiralInstancePiletDefaults.npmClient,
+    logLevel = addPiralInstancePiletDefaults.logLevel,
+    source = addPiralInstancePiletDefaults.source,
+    selected = addPiralInstancePiletDefaults.selected,
+    app = addPiralInstancePiletDefaults.app,
+  } = options;
+  const fullBase = resolve(process.cwd(), baseDir);
+  setLogLevel(logLevel);
+  progress('Reading configuration ...');
+
+  const npmClient = await determineNpmClient(fullBase, defaultNpmClient);
+  const allEntries = await matchAnyPilet(fullBase, [source]);
+
+  const tasks = allEntries.map(async (entryModule) => {
+    const targetDir = dirname(entryModule);
+    const piletJsonPath = await findFile(targetDir, piletJson);
+
+    if (piletJsonPath) {
+      const piletJsonDir = dirname(piletJsonPath);
+      const root = await findPiletRoot(piletJsonDir);
+      const oldContent = await readJson(piletJsonDir, piletJson);
+      const [appName] = await installPiralInstance(app, fullBase, root, npmClient);
+
+      const newContent = {
+        ...oldContent,
+        piralInstances: {
+          ...oldContent.piralInstances,
+          [appName]: {
+            selected,
+          },
+        },
+      };
+
+      await writeJson(piletJsonDir, piletJson, newContent, true);
+    } else {
+      log('piletJsonNotAvailable_0180', targetDir);
+    }
+  });
+
+  await Promise.all(tasks);
+
+  logDone(`Added the Piral instance!`);
+}