@hitachivantara/app-shell-vite-plugin 2.3.0 → 2.5.0

package/dist/vite-plugin.d.ts

@@ -97,6 +97,42 @@ export interface AppShellVitePluginOptions {
      * @default false
      */
     disableAppsKeyNormalization?: boolean;
+    /**
+     * Enables the experimental new package layout feature set.
+     *
+     * When `true`, the plugin activates behaviors that are part of the
+     * new app bundle distribution/publishing package layout. Currently, this gates:
+     *
+     * - **`dist/package.json` generation** — a cleaned-up `package.json` is
+     *   written to the Vite output directory after each build. The source
+     *   `package.json` contains dev-time fields and conditions that do not apply
+     *   to published/distributed packages; the generated manifest only includes
+     *   the fields relevant to consumers.
+     * - **`dist/app-shell.config.json`** — the resolved App Shell configuration
+     *   is written to the output directory so that app bundles are self-contained
+     *   and can be consumed both as standalone App Shells or as bundles for
+     *   another App Shell.
+     *
+     * Additional behaviors may be added under this flag in future PRs before
+     * the feature set is stabilized and the flag is removed.
+     *
+     * @default false
+     * @experimental
+     */
+    experimentalNewPackageLayout?: boolean;
+    /**
+     * The custom exports condition used to resolve TypeScript source files during
+     * development. Only applies when `experimentalNewPackageLayout` is `true`.
+     *
+     * Workspace packages declare a scoped condition (e.g. `"@pentaho-apps:source"`)
+     * in their `exports` map that points directly at the TypeScript source. This
+     * lets consumers import the live source during development without a prior
+     * build step. The condition is stripped from `dist/package.json` so it never
+     * leaks to consumers that don't have the TypeScript sources available.
+     *
+     * @default "@pentaho-apps:source"
+     */
+    sourceCondition?: string;
 }
 /**
  * Vite plugin to support App Shell apps setup

package/dist/vite-plugin.js

@@ -1,4 +1,3 @@
-import fs from "node:fs";
 import path from "node:path";
 import virtual from "@rollup/plugin-virtual";
 import { loadEnv } from "vite";
@@ -7,15 +6,17 @@ import { applyAutomaticMenu, applyAutomaticViewsAndRoutes, } from "./automatic-u
 import { findAppShellConfigFile, getFinalModuleName, loadConfigFile, } from "./config-utils.js";
 import { resolveModule } from "./nodeModule.js";
 import SHARED_DEPENDENCIES from "./shared-dependencies.js";
+import { readJsonFile } from "./utils.js";
 import getVirtualEntrypoints from "./virtual-entrypoints.js";
-import processConfiguration from "./vite-configuration-processor-plugin.js";
-import fixCrossOrigin from "./vite-crossorigin-fix-plugin.js";
-import generateBaseTag from "./vite-generate-base-plugin.js";
-import generateBashScript from "./vite-generate-bash-script-plugin.js";
-import generateImportmap, { extraDependencies, } from "./vite-importmap-plugin.js";
-import copyAppShellLocales from "./vite-locales-plugin.js";
-import injectMetadata from "./vite-metadata-plugin.js";
-import serveAppShellConfig from "./vite-watch-config-plugin.js";
+import processConfiguration from "./vite-plugin-configuration-processor.js";
+import fixCrossOrigin from "./vite-plugin-crossorigin-fix.js";
+import distPackageJsonPlugin from "./vite-plugin-dist-package-json.js";
+import generateBaseTag from "./vite-plugin-generate-base.js";
+import generateBashScript from "./vite-plugin-generate-bash-script.js";
+import generateImportmap, { extraDependencies, } from "./vite-plugin-importmap.js";
+import copyAppShellLocales from "./vite-plugin-locales.js";
+import injectMetadata from "./vite-plugin-metadata.js";
+import serveAppShellConfig from "./vite-plugin-watch-config.js";
 const ViteBuildMode = {
     PRODUCTION: "production",
     DEVELOPMENT: "development",
@@ -26,15 +27,14 @@ const ViteBuildMode = {
  * @param env Environment variable
  */
 export async function HvAppShellVitePlugin(opts = {}, env = {}) {
-    const { root = process.cwd(), mode = ViteBuildMode.PRODUCTION, externalImportMap = false, viewsFolder = "src/pages", autoViewsAndRoutes = false, autoMenu = false, inlineConfig = opts.generateEmptyShell ?? false, generateEmptyShell = false, modules = [], disableAppsKeyNormalization = false, } = opts;
+    const { root = process.cwd(), mode = ViteBuildMode.PRODUCTION, externalImportMap = false, viewsFolder = "src/pages", autoViewsAndRoutes = false, autoMenu = false, inlineConfig = opts.generateEmptyShell ?? false, generateEmptyShell = false, modules = [], disableAppsKeyNormalization = false, experimentalNewPackageLayout = false, sourceCondition, } = opts;
     const globalEnv = loadEnv(mode, process.cwd(), "");
     const { type = globalEnv.CI ? "bundle" : "app" } = opts;
     console.info(`Vite running in mode: ${mode}`);
     console.info(`AppShell Vite plugin running with type: ${type}`);
     const devMode = mode === ViteBuildMode.DEVELOPMENT;
     const buildEntryPoint = type !== "bundle";
-    const packageJsonRaw = fs.readFileSync(path.resolve(root, "package.json"), "utf-8");
-    const packageJson = JSON.parse(packageJsonRaw);
+    const packageJson = readJsonFile(path.resolve(root, "package.json"));
     const appShellConfigFile = !generateEmptyShell
         ? findAppShellConfigFile(root)
         : undefined;
@@ -112,7 +112,16 @@ export async function HvAppShellVitePlugin(opts = {}, env = {}) {
         buildEntryPoint &&
             generateBaseTag(appShellConfiguration, generateEmptyShell),
         // configure the build process based on the config file
-        processConfiguration(root, appShellConfiguration, packageJson.name, buildEntryPoint, inlineConfig, generateEmptyShell, modules.concat(autoViewsBundles)),
+        processConfiguration({
+            root,
+            appShellConfig: appShellConfiguration,
+            selfAppName: packageJson.name,
+            modules: modules.concat(autoViewsBundles),
+            buildEntryPoint,
+            inlineConfig,
+            generateEmptyShell,
+            experimentalNewPackageLayout,
+        }),
         // allow crossorigin="use-credentials" in the index.html
         fixCrossOrigin(),
         // serve the app shell config file as json and watch for changes
@@ -121,5 +130,8 @@ export async function HvAppShellVitePlugin(opts = {}, env = {}) {
         generateEmptyShell && generateBashScript(externalImportMap, inlineConfig),
         // copy/merge app-shell-ui locales into dist (build) or serve via middleware (dev)
         copyAppShellLocales(buildEntryPoint),
+        // generate dist/package.json for the build output directory
+        experimentalNewPackageLayout &&
+            distPackageJsonPlugin(root, sourceCondition),
     ];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hitachivantara/app-shell-vite-plugin",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "type": "module",
   "private": false,
   "author": "Hitachi Vantara UI Kit Team",
@@ -15,40 +15,42 @@
   },
   "bugs": "https://github.com/pentaho/hv-uikit-react/issues",
   "scripts": {
+    "build": "npm run clean && tsc -p tsconfig.json && rollup --config",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "clean": "rimraf dist",
     "prepare": "npm run build"
   },
   "dependencies": {
+    "@hitachivantara/app-shell-services": "^2.0.5",
+    "@hitachivantara/app-shell-shared": "^2.3.3",
+    "@hitachivantara/app-shell-ui": "^2.3.4",
+    "@hitachivantara/uikit-react-shared": "^6.0.6",
+    "@rollup/plugin-virtual": "^3.0.1",
+    "es-module-shims": "^1.6.3",
+    "jiti": "^2.6.1",
+    "vite-plugin-static-copy": "^4.1.0"
+  },
+  "peerDependencies": {
+    "vite": "^4.1.4 || ^5.0.4 || ^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "devDependencies": {
     "@emotion/cache": "^11.11.0",
     "@emotion/react": "^11.11.1",
-    "@hitachivantara/app-shell-services": "^2.0.3",
-    "@hitachivantara/app-shell-shared": "^2.3.1",
-    "@hitachivantara/app-shell-ui": "^2.3.2",
-    "@hitachivantara/uikit-react-icons": "^6.0.4",
-    "@hitachivantara/uikit-react-shared": "^6.0.4",
     "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-replace": "^6.0.3",
     "@rollup/plugin-terser": "^1.0.0",
-    "@rollup/plugin-virtual": "^3.0.1",
-    "es-module-shims": "^1.6.3",
-    "jiti": "^2.6.1",
+    "mock-fs": "^5.2.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-router-dom": "^6.9.0",
-    "rollup": "^4.57.1",
-    "vite-plugin-static-copy": "^4.1.0"
-  },
-  "peerDependencies": {
-    "vite": "^4.1.4 || ^5.0.4 || ^6.0.0 || ^7.0.0 || ^8.0.0"
+    "rollup": "^4.57.1"
   },
   "files": [
     "dist"
   ],
-  "publishConfig": {
-    "access": "public",
-    "directory": "package"
-  },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -59,5 +61,8 @@
     },
     "./package.json": "./package.json"
   },
-  "gitHead": "333e132a9823018d508ebbe71c81d0b467f9008d"
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "4d8cd01cd9b1786dc00fd9e8edb962b2c80e4b03"
 }

package/dist/vite-configuration-processor-plugin.d.ts

@@ -1,16 +0,0 @@
-import type { PluginOption } from "vite";
-import type { HvAppShellConfig } from "@hitachivantara/app-shell-shared";
-/**
- * Process configuration, executing several tasks:
- *  - Create rollup configuration to support module creation
- *  - Generates final transformed configuration json
- *  - "base" value is always "./" for build, and main app baseUrl for preview or dev
- * @param root Project root directory.
- * @param appShellConfig The original App Shell configuration json.
- * @param selfAppName The name of the application bundle being built.
- * @param buildEntryPoint If true, the index.html entry point will be added to the bundle.
- * @param inlineConfig flag to control if config is included at index.html
- * @param generateEmptyShell flag to control if we are creating an empty AppShell instance
- * @param modules the set of modules to be created by the rollup
- */
-export default function processConfiguration(root: string, appShellConfig: HvAppShellConfig, selfAppName: string, buildEntryPoint: boolean, inlineConfig: boolean, generateEmptyShell: boolean, modules?: string[]): PluginOption;