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

package/dist/locales-utils.d.ts

@@ -1,8 +1,4 @@
 export declare const SUPPORTED_LOCALES_FILE = "supported-locales.json";
-/**
- * Deep merge two objects. `override` keys take priority over `base`.
- */
-export declare function deepMerge(base: Record<string, unknown>, override: Record<string, unknown>): Record<string, unknown>;
 /**
  * Reads a `supported-locales.json` file and returns its contents as an array
  * of locale strings. Returns an empty array if the file doesn't exist or
@@ -31,11 +27,6 @@ export declare function discoverLanguageDirs(localesDir: string): string[];
  * @param appLocalesDir   - The app's locales directory (downstream / local).
  */
 export declare function computeSupportedLocales(shellLocalesDir: string | undefined, appLocalesDir: string | undefined): string[];
-/**
- * Parses a JSON file, wrapping parse errors with the file path for
- * actionable diagnostics.
- */
-export declare function readJsonFile(filePath: string): unknown;
 /**
  * Recursively merges source directory into destination.
  * JSON files are deep-merged with destination keys taking priority.

package/dist/locales-utils.js

@@ -1,26 +1,7 @@
 import fs from "node:fs";
 import path from "node:path";
+import { deepMerge, readJsonFile } from "./utils.js";
 export const SUPPORTED_LOCALES_FILE = "supported-locales.json";
-/**
- * Deep merge two objects. `override` keys take priority over `base`.
- */
-export function deepMerge(base, override) {
-    const result = { ...base };
-    for (const [key, value] of Object.entries(override)) {
-        if (value != null &&
-            typeof value === "object" &&
-            !Array.isArray(value) &&
-            result[key] != null &&
-            typeof result[key] === "object" &&
-            !Array.isArray(result[key])) {
-            result[key] = deepMerge(result[key], value);
-        }
-        else {
-            result[key] = value;
-        }
-    }
-    return result;
-}
 /**
  * Reads a `supported-locales.json` file and returns its contents as an array
  * of locale strings. Returns an empty array if the file doesn't exist or
@@ -30,7 +11,7 @@ export function readSupportedLocales(filePath) {
     if (!fs.existsSync(filePath))
         return [];
     try {
-        const data = JSON.parse(fs.readFileSync(filePath, "utf-8"));
+        const data = readJsonFile(filePath);
         if (Array.isArray(data) && data.every((item) => typeof item === "string")) {
             return data;
         }
@@ -107,19 +88,6 @@ export function computeSupportedLocales(shellLocalesDir, appLocalesDir) {
     }
     return result.toSorted();
 }
-/**
- * Parses a JSON file, wrapping parse errors with the file path for
- * actionable diagnostics.
- */
-export function readJsonFile(filePath) {
-    const raw = fs.readFileSync(filePath, "utf-8");
-    try {
-        return JSON.parse(raw);
-    }
-    catch (cause) {
-        throw new Error(`[app-shell-locales] Failed to parse ${filePath}: ${cause instanceof Error ? cause.message : cause}`, { cause });
-    }
-}
 /**
  * Recursively merges source directory into destination.
  * JSON files are deep-merged with destination keys taking priority.

package/dist/shared-dependencies.js

@@ -87,7 +87,8 @@ export default [
         moduleId: "@hitachivantara/app-shell-services",
         bundle: "app-shell-services.esm.js",
         bundleSrc: "@hitachivantara/app-shell-services/bundles/app-shell-services.esm.js",
-        virtualSrc: `export * from "@hitachivantara/app-shell-services";`,
+        virtualSrc: `export { default } from "@hitachivantara/app-shell-services";
+    export * from "@hitachivantara/app-shell-services";`,
     },
     {
         moduleId: "@hitachivantara/uikit-react-shared",

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Deep merge two objects. `override` keys take priority over `base`.
+ */
+export declare function deepMerge(base: Record<string, unknown>, override: Record<string, unknown>): Record<string, unknown>;
+/**
+ * Parses a JSON file, wrapping parse errors with the file path for
+ * actionable diagnostics.
+ */
+export declare function readJsonFile(filePath: string): any;

package/dist/utils.js

@@ -0,0 +1,34 @@
+import { readFileSync } from "node:fs";
+/**
+ * Deep merge two objects. `override` keys take priority over `base`.
+ */
+export function deepMerge(base, override) {
+    const result = { ...base };
+    for (const [key, value] of Object.entries(override)) {
+        if (value != null &&
+            typeof value === "object" &&
+            !Array.isArray(value) &&
+            result[key] != null &&
+            typeof result[key] === "object" &&
+            !Array.isArray(result[key])) {
+            result[key] = deepMerge(result[key], value);
+        }
+        else {
+            result[key] = value;
+        }
+    }
+    return result;
+}
+/**
+ * Parses a JSON file, wrapping parse errors with the file path for
+ * actionable diagnostics.
+ */
+export function readJsonFile(filePath) {
+    const raw = readFileSync(filePath, "utf-8");
+    try {
+        return JSON.parse(raw);
+    }
+    catch (cause) {
+        throw new Error(`Failed to parse ${filePath}: ${cause instanceof Error ? cause.message : cause}`, { cause });
+    }
+}

package/dist/{vite-configuration-processor-plugin.js → vite-plugin-configuration-processor.js}

@@ -13,7 +13,7 @@ export default function processConfiguration(options) {
     let finalAppShellConfig;
     let basePath;
     return {
-        name: "vite-plugin-appShell-configuration-processor",
+        name: "vite-plugin-appShell-config-processor",
         config(config, { command }) {
             const projectRoot = root ?? config.root;
             let appModules = {};

package/dist/{vite-crossorigin-fix-plugin.d.ts → vite-plugin-crossorigin-fix.d.ts}

@@ -5,5 +5,4 @@ export declare const isExternalUrl: (url: string) => boolean;
 export declare const dataUrlRE: RegExp;
 export declare const isDataUrl: (url: string) => boolean;
 export declare function checkCrossOrigin(html: string): any[];
-declare const fixCrossOrigin: () => PluginOption;
-export default fixCrossOrigin;
+export default function fixCrossOrigin(): PluginOption;

package/dist/{vite-crossorigin-fix-plugin.js → vite-plugin-crossorigin-fix.js}

@@ -48,11 +48,11 @@ export function checkCrossOrigin(html) {
     }
     return withCredentials;
 }
-const fixCrossOrigin = () => {
+export default function fixCrossOrigin() {
     const withCredentials = {};
     return [
         {
-            name: "vite-crossorigin-fix-collect-info-plugin",
+            name: "vite-plugin-crossorigin-fix-collect-info",
             transformIndexHtml: {
                 order: "pre",
                 handler(html, info) {
@@ -61,7 +61,7 @@ const fixCrossOrigin = () => {
             },
         },
         {
-            name: "vite-crossorigin-fix-replace-plugin",
+            name: "vite-plugin-crossorigin-fix-replace",
             transformIndexHtml: {
                 order: "post",
                 handler(html, context) {
@@ -79,5 +79,4 @@ const fixCrossOrigin = () => {
             },
         },
     ];
-};
-export default fixCrossOrigin;
+}

package/dist/{vite-dist-package-json-plugin.js → vite-plugin-dist-package-json.js}

@@ -39,6 +39,20 @@ function readJsonFile(filePath) {
         return undefined;
     }
 }
+/**
+ * Extracts the package name from a module specifier.
+ *
+ * Examples:
+ *   react-dom/client       → react-dom
+ *   @emotion/react/jsx-dev → @emotion/react
+ */
+function toPackageName(specifier) {
+    if (specifier.startsWith("@")) {
+        const segments = specifier.split("/");
+        return segments.length >= 2 ? `${segments[0]}/${segments[1]}` : segments[0];
+    }
+    return specifier.split("/")[0];
+}
 /**
  * Removes the build output prefix from an export path.
  *
@@ -161,7 +175,7 @@ function appendStandardExports(exportsMap, outDir) {
  * - preserves explicit null exclusions
  * - supports nested conditional exports
  */
-function generateDistPackageJson(root, outDir, buildOutDir, sourceCondition) {
+function generateDistPackageJson(root, outDir, buildOutDir, sourceCondition, externalizedPackages) {
     const pkgPath = path.join(root, "package.json");
     const pkg = readJsonFile(pkgPath);
     if (!pkg || !fs.existsSync(outDir)) {
@@ -179,33 +193,79 @@ function generateDistPackageJson(root, outDir, buildOutDir, sourceCondition) {
     }
     appendStandardExports(transformedExports, outDir);
     const distPkg = {};
-    // Copy runtime-relevant fields
+    // Copy runtime-relevant fields. The "dependencies" and "optionalDependencies"
+    // fields are narrowed to only the modules that Rollup actually externalized,
+    // so the published package declares exactly the runtime modules it expects the
+    // host to provide.
     for (const field of INCLUDED_FIELDS) {
-        if (pkg[field] != null) {
-            distPkg[field] = pkg[field];
+        if (pkg[field] == null) {
+            continue;
+        }
+        if (field === "dependencies" || field === "optionalDependencies") {
+            const filtered = filterExternalizedDependencies(pkg[field], externalizedPackages);
+            if (Object.keys(filtered).length > 0) {
+                distPkg[field] = filtered;
+            }
+            continue;
         }
+        distPkg[field] = pkg[field];
     }
     distPkg.exports = transformedExports;
     fs.writeFileSync(path.join(outDir, "package.json"), JSON.stringify(distPkg, null, 2) + "\n");
     console.info(`[App Shell] Generated ${buildOutDir}/package.json for ${pkg.name}`);
     return true;
 }
+/**
+ * Keeps only the declared dependencies whose package was externalized by the
+ * bundle (i.e. expected to be resolved by the host at runtime).
+ */
+function filterExternalizedDependencies(dependencies, externalizedPackages) {
+    const filtered = {};
+    for (const [name, range] of Object.entries(dependencies)) {
+        if (externalizedPackages.has(name)) {
+            filtered[name] = range;
+        }
+    }
+    return filtered;
+}
 // ─── Plugin ──────────────────────────────────────────────────────────────────
 /**
  * Generates a cleaned dist/package.json during Vite builds.
  */
 export default function distPackageJsonPlugin(root, sourceCondition = DEFAULT_SOURCE_CONDITION) {
     let config;
+    const externalizedPackages = new Set();
     return {
-        name: "app-shell:vite-dist-package-json-plugin",
+        name: "vite-plugin-dist-package-json",
         apply: "build",
         configResolved(resolved) {
             config = resolved;
         },
+        buildStart() {
+            // Reset per build so stale externalized packages from a previous build
+            // (e.g. in watch mode, where the plugin instance is reused) don't leak
+            // into the next dist/package.json.
+            externalizedPackages.clear();
+        },
+        generateBundle(_options, bundle) {
+            const emittedFiles = new Set(Object.keys(bundle));
+            for (const file of Object.values(bundle)) {
+                if (file.type !== "chunk") {
+                    continue;
+                }
+                // Imports that do not point to an emitted file are external modules
+                // that Rollup left for the host runtime to resolve.
+                for (const imported of [...file.imports, ...file.dynamicImports]) {
+                    if (!emittedFiles.has(imported)) {
+                        externalizedPackages.add(toPackageName(imported));
+                    }
+                }
+            }
+        },
         closeBundle() {
             const packageRoot = root ?? config.root;
             const outDir = path.resolve(packageRoot, config.build.outDir);
-            generateDistPackageJson(packageRoot, outDir, config.build.outDir, sourceCondition);
+            generateDistPackageJson(packageRoot, outDir, config.build.outDir, sourceCondition, externalizedPackages);
         },
     };
 }

package/dist/{vite-generate-base-plugin.d.ts → vite-plugin-generate-base.d.ts}

@@ -8,7 +8,7 @@ import type { HvAppShellConfig } from "@hitachivantara/app-shell-shared";
  * @param appShellConfig App shell config values
  * @returns The app title
  */
-export declare const getAppTitle: (generateEmptyShell: boolean, appShellConfig: HvAppShellConfig) => any;
+export declare const getAppTitle: (generateEmptyShell: boolean, appShellConfig: HvAppShellConfig) => string;
 /**
  * Add the <BASE> tag and icons preload in the index.html file.
  * @param appShellConfig The app shell configuration.

package/dist/{vite-generate-bash-script-plugin.js → vite-plugin-generate-bash-script.js}

@@ -1,7 +1,7 @@
 import fs from "node:fs";
 import path from "node:path";
 import SHARED_DEPENDENCIES from "./shared-dependencies.js";
-import { getExtraDependenciesString } from "./vite-importmap-plugin.js";
+import { getExtraDependenciesString } from "./vite-plugin-importmap.js";
 export default function generateBashScript(externalImportMap, inlineConfig) {
     let config;
     let targetDir;

package/dist/{vite-locales-plugin.js → vite-plugin-locales.js}

@@ -1,7 +1,8 @@
 import fs from "node:fs";
 import { createRequire } from "node:module";
 import path from "node:path";
-import { computeSupportedLocales, deepMerge, mergeDirs, readJsonFile, SUPPORTED_LOCALES_FILE, } from "./locales-utils.js";
+import { computeSupportedLocales, mergeDirs, SUPPORTED_LOCALES_FILE, } from "./locales-utils.js";
+import { deepMerge, readJsonFile } from "./utils.js";
 /**
  * Resolves the app-shell-ui's locales directory path via its `./locales/*` export.
  */
@@ -63,7 +64,7 @@ export default function copyAppShellLocales(mergeUpstream = true) {
     let resolvedOutDir;
     let isBuild = false;
     return {
-        name: "vite-plugin-appshell-copy-locales",
+        name: "vite-plugin-copy-appShell-locales",
         // Capture the resolved output directory from Vite's config
         configResolved(config) {
             resolvedOutDir = path.resolve(config.root, config.build.outDir);

package/dist/{vite-metadata-plugin.d.ts → vite-plugin-metadata.d.ts}

@@ -4,5 +4,4 @@ import type { PluginOption } from "vite";
  * The metadata is used to help any troubleshoot activity by referencing
  * the version of the app-shell-vite-plugin and app-shell-ui packages used by the app.
  */
-declare const injectMetadata: () => PluginOption;
-export default injectMetadata;
+export default function injectMetadata(): PluginOption;

package/dist/{vite-metadata-plugin.js → vite-plugin-metadata.js}

@@ -1,20 +1,18 @@
-import fs from "node:fs";
 import { resolveModule } from "./nodeModule.js";
+import { readJsonFile } from "./utils.js";
 const extractVersion = (packageJsonFile) => {
-    const packageJson = fs.readFileSync(packageJsonFile, "utf8");
-    const packageObject = JSON.parse(packageJson);
-    return packageObject.version;
+    return readJsonFile(packageJsonFile).version;
 };
 /**
  * This plugin injects metadata into the index.html file.
  * The metadata is used to help any troubleshoot activity by referencing
  * the version of the app-shell-vite-plugin and app-shell-ui packages used by the app.
  */
-const injectMetadata = () => {
+export default function injectMetadata() {
     const appShellUIVersion = extractVersion(resolveModule("@hitachivantara/app-shell-ui/package.json"));
     const appShellVitePluginVersion = extractVersion(resolveModule("@hitachivantara/app-shell-vite-plugin/package.json"));
     return {
-        name: "vite-metadata-plugin",
+        name: "vite-plugin-metadata",
         transformIndexHtml() {
             return [
                 {
@@ -34,5 +32,4 @@ const injectMetadata = () => {
             ];
         },
     };
-};
-export default injectMetadata;
+}

package/dist/{vite-watch-config-plugin.js → vite-plugin-watch-config.js}

@@ -8,7 +8,7 @@ const prepareConfigForDevMode = (config, selfAppName) => {
 };
 export default function serveAppShellConfig(appShellConfig, root, selfAppName, appShellConfigFile, automaticViewsFolder) {
     return {
-        name: "vite-plugin-watch-app-shell-config",
+        name: "vite-plugin-watch-appShell-config",
         apply: "serve",
         configureServer(server) {
             const restartServer = (file) => {

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,16 +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 distPackageJsonPlugin from "./vite-dist-package-json-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",
@@ -34,8 +34,7 @@ export async function HvAppShellVitePlugin(opts = {}, env = {}) {
     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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hitachivantara/app-shell-vite-plugin",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "type": "module",
   "private": false,
   "author": "Hitachi Vantara UI Kit Team",
@@ -15,39 +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.4",
-    "@hitachivantara/app-shell-shared": "^2.3.2",
-    "@hitachivantara/app-shell-ui": "^2.3.3",
-    "@hitachivantara/uikit-react-shared": "^6.0.5",
     "@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",
@@ -58,5 +61,8 @@
     },
     "./package.json": "./package.json"
   },
-  "gitHead": "65c4f4394e8f8c7cccb58203e1c08c6832434638"
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "4d8cd01cd9b1786dc00fd9e8edb962b2c80e4b03"
 }