@hitachivantara/app-shell-vite-plugin 0.5.1

package/dist/vite-plugin.js

@@ -0,0 +1,352 @@
+import virtual from "@rollup/plugin-virtual";
+import fs from "fs";
+import path from "path";
+import { viteStaticCopy } from "vite-plugin-static-copy";
+import { createRequire } from "node:module";
+import generateImportmap from "./vite-importmap-plugin.js";
+const require = createRequire(import.meta.url);
+/**
+ * Return the main app (identified by @self)
+ * @param appShellConfig The App shell configuration
+ */
+const getMainApp = (appShellConfig) => {
+    return appShellConfig.apps.filter(app => app.id === "@self")[0];
+};
+/**
+ * Return the public path to be use by vite to launch the application.
+ * Value is obtained by returning the baseUrl value of the main app {@link #getMainApp}
+ * @param appShellConfig The App shell configuration
+ */
+const getPublicPath = (appShellConfig) => {
+    const mainApp = getMainApp(appShellConfig);
+    if (!mainApp) {
+        return "/";
+    }
+    const url = mainApp.baseUrl;
+    try {
+        return new URL(url).pathname;
+    }
+    catch {
+        return url;
+    }
+};
+/**
+ * Resolves the module name and normalizes slashes to be posix/unix-like forward slashes.
+ *
+ * @param moduleName The name of the module to be searched for
+ * @returns The module path normalized
+ */
+function resolveModule(moduleName) {
+    const module = require.resolve(moduleName);
+    return module.replace(/\\+/g, "/");
+}
+/**
+ * This function will find out the module path using node `require.resolve` function
+ * and add the suffix param after the folder with module name.
+ *
+ * @param moduleName "@module/name"
+ * @param suffix to be added after the module path
+ * @returns the /path/to/@module/name/<suffix>
+ */
+function getModulePath(moduleName, suffix) {
+    const moduleNameWithSlashes = `/${moduleName}/`;
+    const module = resolveModule(moduleName);
+    const modulePosition = module.lastIndexOf(moduleNameWithSlashes);
+    return `${module.slice(0, modulePosition + moduleNameWithSlashes.length)}${suffix}`;
+}
+var ViteBuildMode;
+(function (ViteBuildMode) {
+    ViteBuildMode["PRODUCTION"] = "production";
+    ViteBuildMode["DEVELOPMENT"] = "development";
+})(ViteBuildMode || (ViteBuildMode = {}));
+var ViteCommand;
+(function (ViteCommand) {
+    ViteCommand["BUILD"] = "build";
+    ViteCommand["SERVE"] = "serve";
+})(ViteCommand || (ViteCommand = {}));
+/**
+ *  Returns the modules to be created by the build of the app.
+ *  The list of modules is defined by the app-shell-config.json file routes ( limited to the @self app)
+ *  The bundles will be created following the original directories structure ( having the src folder path removed)
+ *
+ * @param root Project root directory.
+ * @param appShellConfig The App Shell configuration.
+ */
+function getAppModules(root, appShellConfig) {
+    const appModules = {};
+    const selfApp = getMainApp(appShellConfig);
+    const selfViews = selfApp?.views?.map(view => {
+        const bundleName = view.bundle.replace(/^src\//, "");
+        return {
+            ...view,
+            bundleName
+        };
+    }) ?? [];
+    selfViews.forEach(view => {
+        appModules[view.bundleName] = path.resolve(root, view.bundle);
+    });
+    const selfModules = selfApp?.modules?.map(module => {
+        const bundleName = module.bundle.replace(/^src\//, "");
+        return {
+            ...module,
+            bundleName
+        };
+    }) ?? [];
+    selfModules.forEach(module => {
+        appModules[module.bundleName] = path.resolve(root, module.bundle);
+    });
+    console.info("Modules exported by the application bundle:", appModules);
+    return appModules;
+}
+/**
+ * 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
+ *  - Injects the APP_BASE_PATH env prop, to be used by the apps (if required)
+ * @param root Project root directory.
+ * @param appShellConfig The original App Shell configuration json.
+ * @param selfAppName The name of the application bundle being built.
+ */
+function processConfiguration(root, appShellConfig, selfAppName) {
+    const finalAppShellConfig = { ...appShellConfig };
+    const selfApp = getMainApp(finalAppShellConfig);
+    return {
+        name: "vite-plugin-appShell-configuration-processor",
+        config(config, { command }) {
+            const projectRoot = root ?? config.root;
+            const publicPath = getPublicPath(appShellConfig);
+            return {
+                build: {
+                    rollupOptions: {
+                        preserveEntrySignatures: "strict",
+                        input: {
+                            main: path.resolve(projectRoot, "index.html"),
+                            ...getAppModules(projectRoot, appShellConfig)
+                        },
+                        output: {
+                            entryFileNames: "[name].js"
+                        }
+                    }
+                },
+                // if serve (preview/dev) it uses the baseUrl. Otherwise(build), use ./
+                base: command === ViteCommand.SERVE ? publicPath : "./",
+                define: {
+                    ...config.define,
+                    APP_BASE_PATH: JSON.stringify(publicPath)
+                }
+            };
+        },
+        /**
+         * Rollup hook with the info for bundle generation
+         * It will be used to create a new configuration with:
+         *  - bundles replace with the final location (e.g. -> "bundle": "src/pages/Main" transformed to "bundle": "pages/Main.js",
+         * @param options build options
+         * @param bundle bundles information
+         */
+        async generateBundle(options, bundle) {
+            // obtain the directory (dist) where the new config file will be placed
+            let targetDir;
+            if (options.dir) {
+                targetDir = options.dir;
+            }
+            else if (options.file) {
+                targetDir = path.dirname(options.file);
+            }
+            if (!targetDir) {
+                throw new Error("Please set outputPath, so we can know where to place the json file");
+            }
+            // create the targetDir if it does not exist
+            if (!fs.existsSync(targetDir)) {
+                fs.mkdirSync(targetDir, { recursive: true });
+            }
+            /**
+             * Creating a map with each chunk and the final name. Only the bundles with type=chunck are important
+             * Filename do not include the src path at the value
+             */
+            const chunks = {};
+            Object.keys(bundle).forEach(key => {
+                const chunk = bundle[key];
+                if (chunk.type === "chunk") {
+                    const outputChunk = chunk;
+                    if (outputChunk.isEntry) {
+                        const { fileName } = outputChunk;
+                        const { name } = outputChunk;
+                        chunks[name] = fileName;
+                    }
+                }
+            });
+            if (selfApp) {
+                selfApp.views = selfApp.views?.map(view => {
+                    const bundleName = view.bundle.replace(/^src\//, "");
+                    return {
+                        ...view,
+                        bundle: chunks[bundleName]
+                    };
+                });
+                selfApp.modules = selfApp.modules?.map(module => {
+                    const bundleName = module.bundle.replace(/^src\//, "");
+                    return {
+                        ...module,
+                        bundle: chunks[bundleName]
+                    };
+                });
+                // replace references to @self with the name of this application bundle
+                selfApp.id = selfAppName;
+            }
+            fs.writeFileSync(path.resolve(targetDir, "app-shell.config.json"), JSON.stringify(finalAppShellConfig));
+        }
+    };
+}
+/**
+ * Add the <BASE> tag at index.html file. Tag value is obtained by the main app ({@link #getMainApp}) baseUrl ({@link #getPublicPath})‘
+ * @param appShellConfig The app shell configuration.
+ */
+const generateBaseTag = (appShellConfig) => {
+    const publicPath = getPublicPath(appShellConfig);
+    return {
+        name: "vite-plugin-generate-base",
+        enforce: "pre",
+        // except for react and react-dom when in dev mode
+        transformIndexHtml: {
+            enforce: "post",
+            transform: (html) => ({
+                html,
+                tags: [
+                    {
+                        tag: "base",
+                        attrs: { href: publicPath },
+                        injectTo: "head-prepend"
+                    }
+                ]
+            })
+        }
+    };
+};
+/**
+ * Vite plugin to support App Shell apps setup
+ * @param opts Plugin options
+ */
+export function appShellVitePlugin(opts = {}) {
+    const root = opts.root || process.cwd();
+    const mode = opts.mode || ViteBuildMode.PRODUCTION;
+    console.info(`Vite running in mode: ${mode}`);
+    const devMode = mode === ViteBuildMode.DEVELOPMENT;
+    const packageJsonRaw = fs.readFileSync(path.resolve(root, "package.json"), "utf-8");
+    const packageJson = JSON.parse(packageJsonRaw);
+    const appShellConfigRaw = fs.readFileSync(path.resolve(root, "app-shell.config.json"), "utf-8");
+    const appShellConfiguration = JSON.parse(appShellConfigRaw);
+    return [
+        // Copy all the required js bundles to final "bundles" folders, that will be injected by the importmap
+        viteStaticCopy({
+            targets: [
+                {
+                    src: getModulePath("es-module-shims", "dist/*"),
+                    dest: "bundles"
+                },
+                ...(!devMode
+                    ? [
+                        {
+                            src: [
+                                resolveModule("./esm-externals/react.production.min.js"),
+                                resolveModule("./esm-externals/react.production.min.js.map"),
+                                resolveModule("./esm-externals/react-dom.production.min.js"),
+                                resolveModule("./esm-externals/react-dom.production.min.js.map"),
+                                resolveModule("./esm-externals/react-router-dom.production.min.js"),
+                                resolveModule("./esm-externals/react-router-dom.production.min.js.map"),
+                                resolveModule("@hitachivantara/app-shell-shared/bundles/app-shell-shared.esm.js"),
+                                resolveModule("@hitachivantara/app-shell-shared/bundles/app-shell-shared.esm.js.map"),
+                                resolveModule("@hitachivantara/uikit-react-shared/bundles/uikit-react-shared.esm.js"),
+                                resolveModule("@hitachivantara/uikit-react-shared/bundles/uikit-react-shared.esm.js.map")
+                            ],
+                            dest: "bundles"
+                        }
+                    ]
+                    : [])
+            ]
+        }),
+        // create virtual endpoints to support dev mode
+        virtual({
+            "/bundles/react.production.min.js": `import * as React from "react";
+      export default React;
+
+      export {
+        Fragment,
+        StrictMode,
+        Profiler,
+        Suspense,
+        Children,
+        Component,
+        PureComponent,
+        cloneElement,
+        createContext,
+        createElement,
+        createFactory,
+        createRef,
+        forwardRef,
+        isValidElement,
+        lazy,
+        memo,
+        useCallback,
+        useContext,
+        useDebugValue,
+        useEffect,
+        useImperativeHandle,
+        useLayoutEffect,
+        useMemo,
+        useReducer,
+        useRef,
+        useState,
+        version,
+      } from "react";`,
+            "/bundles/react-dom.production.min.js": `export {
+        default,
+        flushSync,
+        createPortal,
+        findDOMNode,
+        hydrate,
+        render,
+        unmountComponentAtNode,
+        unstable_batchedUpdates,
+        unstable_renderSubtreeIntoContainer,
+        version,
+      } from "react-dom";`,
+            "/bundles/react-router-dom.production.min.js": `export * from "react-router-dom";`,
+            "/bundles/app-shell-shared.esm.js": `export * from "@hitachivantara/app-shell-shared";`,
+            "/bundles/uikit-react-shared.esm.js": `export * from "@hitachivantara/uikit-react-shared";`
+        }),
+        // generation of the importmap to create the link to the js bundles
+        generateImportmap({
+            react: `./bundles/react.production.min.js`,
+            "react-dom": `./bundles/react-dom.production.min.js`,
+            "react-router-dom": `./bundles/react-router-dom.production.min.js`,
+            "@hitachivantara/app-shell-shared": "./bundles/app-shell-shared.esm.js",
+            "@hitachivantara/uikit-react-shared": "./bundles/uikit-react-shared.esm.js",
+            ...appShellConfiguration?.apps?.reduce((acc, app) => {
+                if (app.id === "@self") {
+                    acc[`${packageJson.name}/`] = app.baseUrl;
+                    if (devMode) {
+                        acc[`${app.id}/`] = app.baseUrl;
+                    }
+                }
+                else {
+                    acc[`${app.id}/`] = app.baseUrl;
+                }
+                return acc;
+            }, {})
+        }, [
+            "react",
+            "react-dom",
+            "react-router-dom",
+            "@hitachivantara/app-shell-shared",
+            "@hitachivantara/uikit-react-shared",
+            "@self",
+            packageJson.name
+        ], opts.externalImportMap),
+        generateBaseTag(appShellConfiguration),
+        // process configuration
+        processConfiguration(root, appShellConfiguration, packageJson.name)
+    ];
+}
+export default appShellVitePlugin;
+//# sourceMappingURL=vite-plugin.js.map

package/dist/vite-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite-plugin.js","sourceRoot":"","sources":["../src/vite-plugin.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,wBAAwB,CAAC;AAE7C,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGzD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAK5C,OAAO,iBAAiB,MAAM,4BAA4B,CAAC;AAE3D,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE/C;;;GAGG;AACH,MAAM,UAAU,GAAG,CACjB,cAAgC,EACE,EAAE;IACpC,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,aAAa,GAAG,CAAC,cAAgC,EAAU,EAAE;IACjE,MAAM,OAAO,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAC3C,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,GAAG,CAAC;KACZ;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAC5B,IAAI;QACF,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;KAC9B;IAAC,MAAM;QACN,OAAO,GAAG,CAAC;KACZ;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,SAAS,aAAa,CAAC,UAAkB;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,aAAa,CAAC,UAAkB,EAAE,MAAc;IACvD,MAAM,qBAAqB,GAAG,IAAI,UAAU,GAAG,CAAC;IAChD,MAAM,MAAM,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,CAAC;IACjE,OAAO,GAAG,MAAM,CAAC,KAAK,CACpB,CAAC,EACD,cAAc,GAAG,qBAAqB,CAAC,MAAM,CAC9C,GAAG,MAAM,EAAE,CAAC;AACf,CAAC;AAED,IAAK,aAGJ;AAHD,WAAK,aAAa;IAChB,0CAAyB,CAAA;IACzB,4CAA2B,CAAA;AAC7B,CAAC,EAHI,aAAa,KAAb,aAAa,QAGjB;AAED,IAAK,WAGJ;AAHD,WAAK,WAAW;IACd,8BAAe,CAAA;IACf,8BAAe,CAAA;AACjB,CAAC,EAHI,WAAW,KAAX,WAAW,QAGf;AAED;;;;;;;GAOG;AACH,SAAS,aAAa,CAAC,IAAY,EAAE,cAAgC;IACnE,MAAM,UAAU,GAA8B,EAAE,CAAC;IAEjD,MAAM,OAAO,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAC3C,MAAM,SAAS,GACb,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACrD,OAAO;YACL,GAAG,IAAI;YACP,UAAU;SACX,CAAC;IACJ,CAAC,CAAC,IAAI,EAAE,CAAC;IAEX,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GACf,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE;QAC7B,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACvD,OAAO;YACL,GAAG,MAAM;YACT,UAAU;SACX,CAAC;IACJ,CAAC,CAAC,IAAI,EAAE,CAAC;IAEX,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC3B,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,IAAI,CAAC,6CAA6C,EAAE,UAAU,CAAC,CAAC;IACxE,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CAC3B,IAAY,EACZ,cAAgC,EAChC,WAAmB;IAEnB,MAAM,mBAAmB,GAAG,EAAE,GAAG,cAAc,EAAE,CAAC;IAClD,MAAM,OAAO,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAEhD,OAAO;QACL,IAAI,EAAE,8CAA8C;QAEpD,MAAM,CAAC,MAAkB,EAAE,EAAE,OAAO,EAAE;YACpC,MAAM,WAAW,GAAG,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC;YAExC,MAAM,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;YACjD,OAAO;gBACL,KAAK,EAAE;oBACL,aAAa,EAAE;wBACb,uBAAuB,EAAE,QAAQ;wBACjC,KAAK,EAAE;4BACL,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC;4BAC7C,GAAG,aAAa,CAAC,WAAW,EAAE,cAAc,CAAC;yBAC9C;wBACD,MAAM,EAAE;4BACN,cAAc,EAAE,WAAW;yBAC5B;qBACF;iBACF;gBACD,uEAAuE;gBACvE,IAAI,EAAE,OAAO,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI;gBACvD,MAAM,EAAE;oBACN,GAAG,MAAM,CAAC,MAAM;oBAChB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;iBAC1C;aACF,CAAC;QACJ,CAAC;QAED;;;;;;WAMG;QACH,KAAK,CAAC,cAAc,CAClB,OAAgC,EAChC,MAAoB;YAEpB,uEAAuE;YACvE,IAAI,SAA6B,CAAC;YAClC,IAAI,OAAO,CAAC,GAAG,EAAE;gBACf,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;aACzB;iBAAM,IAAI,OAAO,CAAC,IAAI,EAAE;gBACvB,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACxC;YAED,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;aACH;YAED,4CAA4C;YAC5C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBAC7B,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;aAC9C;YAED;;;eAGG;YACH,MAAM,MAAM,GAA2B,EAAE,CAAC;YAE1C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAChC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC1B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE;oBAC1B,MAAM,WAAW,GAAG,KAAK,CAAC;oBAC1B,IAAI,WAAW,CAAC,OAAO,EAAE;wBACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;wBACjC,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;wBAE7B,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;qBACzB;iBACF;YACH,CAAC,CAAC,CAAC;YAEH,IAAI,OAAO,EAAE;gBACX,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;oBACxC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBACrD,OAAO;wBACL,GAAG,IAAI;wBACP,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;qBAC3B,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE;oBAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBACvD,OAAO;wBACL,GAAG,MAAM;wBACT,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC;qBAC3B,CAAC;gBACJ,CAAC,CAAC,CAAC;gBAEH,uEAAuE;gBACvE,OAAO,CAAC,EAAE,GAAG,WAAW,CAAC;aAC1B;YAED,EAAE,CAAC,aAAa,CACd,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,uBAAuB,CAAC,EAChD,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,CACpC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,eAAe,GAAG,CAAC,cAAgC,EAAgB,EAAE;IACzE,MAAM,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;IACjD,OAAO;QACL,IAAI,EAAE,2BAA2B;QACjC,OAAO,EAAE,KAAK;QACd,kDAAkD;QAClD,kBAAkB,EAAE;YAClB,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC;gBAC5B,IAAI;gBACJ,IAAI,EAAE;oBACJ;wBACE,GAAG,EAAE,MAAM;wBACX,KAAK,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE;wBAC3B,QAAQ,EAAE,cAAc;qBACzB;iBACF;aACF,CAAC;SACH;KACF,CAAC;AACJ,CAAC,CAAC;AAsBF;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAkC,EAAE;IAEpC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,aAAa,CAAC,UAAU,CAAC;IAEnD,OAAO,CAAC,IAAI,CAAC,yBAAyB,IAAI,EAAE,CAAC,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAI,KAAK,aAAa,CAAC,WAAW,CAAC;IAEnD,MAAM,cAAc,GAAG,EAAE,CAAC,YAAY,CACpC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,cAAc,CAAC,EAClC,OAAO,CACR,CAAC;IACF,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAE/C,MAAM,iBAAiB,GAAG,EAAE,CAAC,YAAY,CACvC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,uBAAuB,CAAC,EAC3C,OAAO,CACR,CAAC;IACF,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CACtC,iBAAiB,CACE,CAAC;IAEtB,OAAO;QACL,sGAAsG;QACtG,cAAc,CAAC;YACb,OAAO,EAAE;gBACP;oBACE,GAAG,EAAE,aAAa,CAAC,iBAAiB,EAAE,QAAQ,CAAC;oBAC/C,IAAI,EAAE,SAAS;iBAChB;gBACD,GAAG,CAAC,CAAC,OAAO;oBACV,CAAC,CAAC;wBACE;4BACE,GAAG,EAAE;gCACH,aAAa,CAAC,yCAAyC,CAAC;gCACxD,aAAa,CAAC,6CAA6C,CAAC;gCAC5D,aAAa,CAAC,6CAA6C,CAAC;gCAC5D,aAAa,CACX,iDAAiD,CAClD;gCACD,aAAa,CACX,oDAAoD,CACrD;gCACD,aAAa,CACX,wDAAwD,CACzD;gCACD,aAAa,CACX,kEAAkE,CACnE;gCACD,aAAa,CACX,sEAAsE,CACvE;gCACD,aAAa,CACX,sEAAsE,CACvE;gCACD,aAAa,CACX,0EAA0E,CAC3E;6BACF;4BACD,IAAI,EAAE,SAAS;yBAChB;qBACF;oBACH,CAAC,CAAC,EAAE,CAAC;aACR;SACF,CAAC;QAEF,+CAA+C;QAC/C,OAAO,CAAC;YACN,kCAAkC,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBA+BpB;YAChB,sCAAsC,EAAE;;;;;;;;;;;0BAWpB;YACpB,6CAA6C,EAAE,mCAAmC;YAClF,kCAAkC,EAAE,mDAAmD;YACvF,oCAAoC,EAAE,qDAAqD;SAC5F,CAAC;QAEF,mEAAmE;QACnE,iBAAiB,CACf;YACE,KAAK,EAAE,mCAAmC;YAC1C,WAAW,EAAE,uCAAuC;YACpD,kBAAkB,EAAE,8CAA8C;YAClE,kCAAkC,EAAE,mCAAmC;YACvE,oCAAoC,EAClC,qCAAqC;YACvC,GAAG,qBAAqB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBAClD,IAAI,GAAG,CAAC,EAAE,KAAK,OAAO,EAAE;oBACtB,GAAG,CAAC,GAAG,WAAW,CAAC,IAAI,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;oBAC1C,IAAI,OAAO,EAAE;wBACX,GAAG,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;qBACjC;iBACF;qBAAM;oBACL,GAAG,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;iBACjC;gBACD,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAA4B,CAAC;SACjC,EACD;YACE,OAAO;YACP,WAAW;YACX,kBAAkB;YAClB,kCAAkC;YAClC,oCAAoC;YACpC,OAAO;YACP,WAAW,CAAC,IAAI;SACjB,EACD,IAAI,CAAC,iBAAiB,CACvB;QACD,eAAe,CAAC,qBAAqB,CAAC;QACtC,wBAAwB;QACxB,oBAAoB,CAAC,IAAI,EAAE,qBAAqB,EAAE,WAAW,CAAC,IAAI,CAAC;KACpE,CAAC;AACJ,CAAC;AAED,eAAe,kBAAkB,CAAC","sourcesContent":["import { NormalizedOutputOptions, OutputBundle } from \"rollup\";\nimport virtual from \"@rollup/plugin-virtual\";\n\nimport fs from \"fs\";\nimport path from \"path\";\n\nimport { viteStaticCopy } from \"vite-plugin-static-copy\";\nimport { PluginOption, UserConfig } from \"vite\";\n\nimport { createRequire } from \"node:module\";\nimport {\n  HvAppShellAppsConfig,\n  HvAppShellConfig\n} from \"@hitachivantara/app-shell-shared\";\nimport generateImportmap from \"./vite-importmap-plugin.js\";\n\nconst require = createRequire(import.meta.url);\n\n/**\n * Return the main app (identified by @self)\n * @param appShellConfig The App shell configuration\n */\nconst getMainApp = (\n  appShellConfig: HvAppShellConfig\n): HvAppShellAppsConfig | undefined => {\n  return appShellConfig.apps.filter(app => app.id === \"@self\")[0];\n};\n\n/**\n * Return the public path to be use by vite to launch the application.\n * Value is obtained by returning the baseUrl value of the main app {@link #getMainApp}\n * @param appShellConfig The App shell configuration\n */\nconst getPublicPath = (appShellConfig: HvAppShellConfig): string => {\n  const mainApp = getMainApp(appShellConfig);\n  if (!mainApp) {\n    return \"/\";\n  }\n  const url = mainApp.baseUrl;\n  try {\n    return new URL(url).pathname;\n  } catch {\n    return url;\n  }\n};\n\n/**\n * Resolves the module name and normalizes slashes to be posix/unix-like forward slashes.\n *\n * @param moduleName The name of the module to be searched for\n * @returns The module path normalized\n */\nfunction resolveModule(moduleName: string) {\n  const module = require.resolve(moduleName);\n  return module.replace(/\\\\+/g, \"/\");\n}\n\n/**\n * This function will find out the module path using node `require.resolve` function\n * and add the suffix param after the folder with module name.\n *\n * @param moduleName \"@module/name\"\n * @param suffix to be added after the module path\n * @returns the /path/to/@module/name/<suffix>\n */\nfunction getModulePath(moduleName: string, suffix: string) {\n  const moduleNameWithSlashes = `/${moduleName}/`;\n  const module = resolveModule(moduleName);\n  const modulePosition = module.lastIndexOf(moduleNameWithSlashes);\n  return `${module.slice(\n    0,\n    modulePosition + moduleNameWithSlashes.length\n  )}${suffix}`;\n}\n\nenum ViteBuildMode {\n  PRODUCTION = \"production\",\n  DEVELOPMENT = \"development\"\n}\n\nenum ViteCommand {\n  BUILD = \"build\",\n  SERVE = \"serve\"\n}\n\n/**\n *  Returns the modules to be created by the build of the app.\n *  The list of modules is defined by the app-shell-config.json file routes ( limited to the @self app)\n *  The bundles will be created following the original directories structure ( having the src folder path removed)\n *\n * @param root Project root directory.\n * @param appShellConfig The App Shell configuration.\n */\nfunction getAppModules(root: string, appShellConfig: HvAppShellConfig) {\n  const appModules: { [key: string]: string } = {};\n\n  const selfApp = getMainApp(appShellConfig);\n  const selfViews =\n    selfApp?.views?.map(view => {\n      const bundleName = view.bundle.replace(/^src\\//, \"\");\n      return {\n        ...view,\n        bundleName\n      };\n    }) ?? [];\n\n  selfViews.forEach(view => {\n    appModules[view.bundleName] = path.resolve(root, view.bundle);\n  });\n\n  const selfModules =\n    selfApp?.modules?.map(module => {\n      const bundleName = module.bundle.replace(/^src\\//, \"\");\n      return {\n        ...module,\n        bundleName\n      };\n    }) ?? [];\n\n  selfModules.forEach(module => {\n    appModules[module.bundleName] = path.resolve(root, module.bundle);\n  });\n\n  console.info(\"Modules exported by the application bundle:\", appModules);\n  return appModules;\n}\n\n/**\n * Process configuration, executing several tasks:\n *  - Create rollup configuration to support module creation\n *  - Generates final transformed configuration json\n *  - \"base\" value is always \"./\" for build, and main app baseUrl for preview or dev\n *  - Injects the APP_BASE_PATH env prop, to be used by the apps (if required)\n * @param root Project root directory.\n * @param appShellConfig The original App Shell configuration json.\n * @param selfAppName The name of the application bundle being built.\n */\nfunction processConfiguration(\n  root: string,\n  appShellConfig: HvAppShellConfig,\n  selfAppName: string\n): PluginOption {\n  const finalAppShellConfig = { ...appShellConfig };\n  const selfApp = getMainApp(finalAppShellConfig);\n\n  return {\n    name: \"vite-plugin-appShell-configuration-processor\",\n\n    config(config: UserConfig, { command }) {\n      const projectRoot = root ?? config.root;\n\n      const publicPath = getPublicPath(appShellConfig);\n      return {\n        build: {\n          rollupOptions: {\n            preserveEntrySignatures: \"strict\",\n            input: {\n              main: path.resolve(projectRoot, \"index.html\"),\n              ...getAppModules(projectRoot, appShellConfig)\n            },\n            output: {\n              entryFileNames: \"[name].js\"\n            }\n          }\n        },\n        // if serve (preview/dev) it uses the baseUrl. Otherwise(build), use ./\n        base: command === ViteCommand.SERVE ? publicPath : \"./\",\n        define: {\n          ...config.define,\n          APP_BASE_PATH: JSON.stringify(publicPath)\n        }\n      };\n    },\n\n    /**\n     * Rollup hook with the info for bundle generation\n     * It will be used to create a new configuration with:\n     *  - bundles replace with the final location (e.g. -> \"bundle\": \"src/pages/Main\" transformed to \"bundle\": \"pages/Main.js\",\n     * @param options build options\n     * @param bundle bundles information\n     */\n    async generateBundle(\n      options: NormalizedOutputOptions,\n      bundle: OutputBundle\n    ) {\n      // obtain the directory (dist) where the new config file will be placed\n      let targetDir: string | undefined;\n      if (options.dir) {\n        targetDir = options.dir;\n      } else if (options.file) {\n        targetDir = path.dirname(options.file);\n      }\n\n      if (!targetDir) {\n        throw new Error(\n          \"Please set outputPath, so we can know where to place the json file\"\n        );\n      }\n\n      // create the targetDir if it does not exist\n      if (!fs.existsSync(targetDir)) {\n        fs.mkdirSync(targetDir, { recursive: true });\n      }\n\n      /**\n       * Creating a map with each chunk and the final name. Only the bundles with type=chunck are important\n       * Filename do not include the src path at the value\n       */\n      const chunks: Record<string, string> = {};\n\n      Object.keys(bundle).forEach(key => {\n        const chunk = bundle[key];\n        if (chunk.type === \"chunk\") {\n          const outputChunk = chunk;\n          if (outputChunk.isEntry) {\n            const { fileName } = outputChunk;\n            const { name } = outputChunk;\n\n            chunks[name] = fileName;\n          }\n        }\n      });\n\n      if (selfApp) {\n        selfApp.views = selfApp.views?.map(view => {\n          const bundleName = view.bundle.replace(/^src\\//, \"\");\n          return {\n            ...view,\n            bundle: chunks[bundleName]\n          };\n        });\n        selfApp.modules = selfApp.modules?.map(module => {\n          const bundleName = module.bundle.replace(/^src\\//, \"\");\n          return {\n            ...module,\n            bundle: chunks[bundleName]\n          };\n        });\n\n        // replace references to @self with the name of this application bundle\n        selfApp.id = selfAppName;\n      }\n\n      fs.writeFileSync(\n        path.resolve(targetDir, \"app-shell.config.json\"),\n        JSON.stringify(finalAppShellConfig)\n      );\n    }\n  };\n}\n\n/**\n * Add the <BASE> tag at index.html file. Tag value is obtained by the main app ({@link #getMainApp}) baseUrl ({@link #getPublicPath})‘\n * @param appShellConfig The app shell configuration.\n */\nconst generateBaseTag = (appShellConfig: HvAppShellConfig): PluginOption => {\n  const publicPath = getPublicPath(appShellConfig);\n  return {\n    name: \"vite-plugin-generate-base\",\n    enforce: \"pre\",\n    // except for react and react-dom when in dev mode\n    transformIndexHtml: {\n      enforce: \"post\",\n      transform: (html: string) => ({\n        html,\n        tags: [\n          {\n            tag: \"base\",\n            attrs: { href: publicPath },\n            injectTo: \"head-prepend\"\n          }\n        ]\n      })\n    }\n  };\n};\n\ninterface AppShellVitePluginOptions {\n  /**\n   * Project root directory. Most likely location of the vite config file.\n   *\n   * @default process.cwd()\n   */\n  root?: string;\n  /**\n   * Execution mode.\n   */\n  mode?: string;\n  /**\n   * If true, the plugin will generate the importmap with an external js file instead of inline in the html.\n   * The map will be saved at the root of the application destination dir and named as \"importmap.js\"\n   *\n   * @default false\n   */\n  externalImportMap?: boolean;\n}\n\n/**\n * Vite plugin to support App Shell apps setup\n * @param opts Plugin options\n */\nexport function appShellVitePlugin(\n  opts: AppShellVitePluginOptions = {}\n): PluginOption {\n  const root = opts.root || process.cwd();\n  const mode = opts.mode || ViteBuildMode.PRODUCTION;\n\n  console.info(`Vite running in mode: ${mode}`);\n\n  const devMode = mode === ViteBuildMode.DEVELOPMENT;\n\n  const packageJsonRaw = fs.readFileSync(\n    path.resolve(root, \"package.json\"),\n    \"utf-8\"\n  );\n  const packageJson = JSON.parse(packageJsonRaw);\n\n  const appShellConfigRaw = fs.readFileSync(\n    path.resolve(root, \"app-shell.config.json\"),\n    \"utf-8\"\n  );\n  const appShellConfiguration = JSON.parse(\n    appShellConfigRaw\n  ) as HvAppShellConfig;\n\n  return [\n    // Copy all the required js bundles to final \"bundles\" folders, that will be injected by the importmap\n    viteStaticCopy({\n      targets: [\n        {\n          src: getModulePath(\"es-module-shims\", \"dist/*\"),\n          dest: \"bundles\"\n        },\n        ...(!devMode\n          ? [\n              {\n                src: [\n                  resolveModule(\"./esm-externals/react.production.min.js\"),\n                  resolveModule(\"./esm-externals/react.production.min.js.map\"),\n                  resolveModule(\"./esm-externals/react-dom.production.min.js\"),\n                  resolveModule(\n                    \"./esm-externals/react-dom.production.min.js.map\"\n                  ),\n                  resolveModule(\n                    \"./esm-externals/react-router-dom.production.min.js\"\n                  ),\n                  resolveModule(\n                    \"./esm-externals/react-router-dom.production.min.js.map\"\n                  ),\n                  resolveModule(\n                    \"@hitachivantara/app-shell-shared/bundles/app-shell-shared.esm.js\"\n                  ),\n                  resolveModule(\n                    \"@hitachivantara/app-shell-shared/bundles/app-shell-shared.esm.js.map\"\n                  ),\n                  resolveModule(\n                    \"@hitachivantara/uikit-react-shared/bundles/uikit-react-shared.esm.js\"\n                  ),\n                  resolveModule(\n                    \"@hitachivantara/uikit-react-shared/bundles/uikit-react-shared.esm.js.map\"\n                  )\n                ],\n                dest: \"bundles\"\n              }\n            ]\n          : [])\n      ]\n    }),\n\n    // create virtual endpoints to support dev mode\n    virtual({\n      \"/bundles/react.production.min.js\": `import * as React from \"react\";\n      export default React;\n\n      export {\n        Fragment,\n        StrictMode,\n        Profiler,\n        Suspense,\n        Children,\n        Component,\n        PureComponent,\n        cloneElement,\n        createContext,\n        createElement,\n        createFactory,\n        createRef,\n        forwardRef,\n        isValidElement,\n        lazy,\n        memo,\n        useCallback,\n        useContext,\n        useDebugValue,\n        useEffect,\n        useImperativeHandle,\n        useLayoutEffect,\n        useMemo,\n        useReducer,\n        useRef,\n        useState,\n        version,\n      } from \"react\";`,\n      \"/bundles/react-dom.production.min.js\": `export {\n        default,\n        flushSync,\n        createPortal,\n        findDOMNode,\n        hydrate,\n        render,\n        unmountComponentAtNode,\n        unstable_batchedUpdates,\n        unstable_renderSubtreeIntoContainer,\n        version,\n      } from \"react-dom\";`,\n      \"/bundles/react-router-dom.production.min.js\": `export * from \"react-router-dom\";`,\n      \"/bundles/app-shell-shared.esm.js\": `export * from \"@hitachivantara/app-shell-shared\";`,\n      \"/bundles/uikit-react-shared.esm.js\": `export * from \"@hitachivantara/uikit-react-shared\";`\n    }),\n\n    // generation of the importmap to create the link to the js bundles\n    generateImportmap(\n      {\n        react: `./bundles/react.production.min.js`,\n        \"react-dom\": `./bundles/react-dom.production.min.js`,\n        \"react-router-dom\": `./bundles/react-router-dom.production.min.js`,\n        \"@hitachivantara/app-shell-shared\": \"./bundles/app-shell-shared.esm.js\",\n        \"@hitachivantara/uikit-react-shared\":\n          \"./bundles/uikit-react-shared.esm.js\",\n        ...appShellConfiguration?.apps?.reduce((acc, app) => {\n          if (app.id === \"@self\") {\n            acc[`${packageJson.name}/`] = app.baseUrl;\n            if (devMode) {\n              acc[`${app.id}/`] = app.baseUrl;\n            }\n          } else {\n            acc[`${app.id}/`] = app.baseUrl;\n          }\n          return acc;\n        }, {} as Record<string, string>)\n      },\n      [\n        \"react\",\n        \"react-dom\",\n        \"react-router-dom\",\n        \"@hitachivantara/app-shell-shared\",\n        \"@hitachivantara/uikit-react-shared\",\n        \"@self\",\n        packageJson.name\n      ],\n      opts.externalImportMap\n    ),\n    generateBaseTag(appShellConfiguration),\n    // process configuration\n    processConfiguration(root, appShellConfiguration, packageJson.name)\n  ];\n}\n\nexport default appShellVitePlugin;\n"]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@hitachivantara/app-shell-vite-plugin",
+  "version": "0.5.1",
+  "description": "AppShell Vite Plugin",
+  "author": "Hitachi Vantara - Boba Fett Team",
+  "type": "module",
+  "sideEffects": false,
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "npm-run-all clean build:*",
+    "build:esm": "tsc -b tsconfig.json",
+    "build:esm-externals": "npx rollup --config",
+    "clean": "npx rimraf ./dist *.tgz",
+    "dev": "tsc-watch --noClear -p tsconfig.json",
+    "lint": "npm-run-all --parallel lint:*",
+    "lint:eslint": "npx eslint --ext .js,.jsx,.ts,.tsx src --color --cache --fix",
+    "lint:prettier": "npx prettier --write \"src/**/*.{html,css,js,jsx,ts,tsx}\""
+  },
+  "dependencies": {
+    "@hitachivantara/app-shell-shared": "0.5.1",
+    "@rollup/plugin-commonjs": "^24.0.0",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-replace": "^5.0.2",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@rollup/plugin-virtual": "^3.0.1",
+    "es-module-shims": "^1.6.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-router-dom": "^6.9.0",
+    "rollup": "^3.10.0",
+    "vite": "^4.1.4",
+    "vite-plugin-static-copy": "^0.13.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.28",
+    "@types/react-dom": "^18.0.11",
+    "tsc-watch": "^6.0.0"
+  },
+  "gitHead": "904a0e52b3728c0b962acc3af79dc1ffd090836e"
+}