@hitachivantara/app-shell-vite-plugin 0.12.1 → 0.14.0

package/README.md

@@ -16,7 +16,6 @@ It performs the following actions:
 exported and consumed by others
 - create `importmap` and inject it into `index.html`
 - create <base href="...">  tag and inject it into `index.html`
-- creates APP_BASE_PATH variable that can be used in app code.
 
 ## How to use
 
@@ -64,17 +63,3 @@ Empty Configuration Validity: With these automatic features in place, the config
 
 The <base href="...">  tag is automatically injected at index.html file during the build process. The value of tag is the same as for the app base path. More information related to the way app base path is obtained can be checked [here](../../../docs/app-shell-utilities.md#usehvappshellbasepath). 
 
-## APP_BASE_PATH variable
-
-Vite supports the creation at configuration/build time of env variables that, if needed, can be used at apps.
-
-More information about vite env variables can be checked [here](https://vitejs.dev/guide/env-and-mode.html).
- 
-Vite plugin creates the following env properties:
-
-| Property      | Description         | Notes                                                                                                                                                                                       |
-| :------------ | :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| APP_BASE_PATH | App base path value | More information about the base path value can be checked [here](https://vitejs.dev/guide/env-and-mode.html). Usage example: [here](../../samples/internal-route-ice-cream-app/src/App.tsx) |
-
-
-_Typescript projects shall use [env.d.ts](../../samples/internal-route-ice-cream-app/src/env.d.ts) for type's definition._

package/dist/automatic-utils.d.ts

@@ -0,0 +1,6 @@
+import type { HvAppShellConfig, HvAppShellViewsConfig } from "@hitachivantara/app-shell-shared";
+export declare function findIndexFiles(dir: string): string[];
+export declare function mapIndexFilesToRoutes(files: string[], folder: string): HvAppShellViewsConfig[];
+export declare function applyAutomaticViewsAndRoutes(config: HvAppShellConfig, root: string, viewsFolder: string): void;
+export declare function applyAutomaticMenu(config: HvAppShellConfig): void;
+//# sourceMappingURL=automatic-utils.d.ts.map

package/dist/automatic-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"automatic-utils.d.ts","sourceRoot":"","sources":["../src/automatic-utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,kCAAkC,CAAC;AAI1C,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAepD;AAED,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,EAAE,EACf,MAAM,EAAE,MAAM,GACb,qBAAqB,EAAE,CAiBzB;AAED,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,gBAAgB,EACxB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,QAqCpB;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,QA+C1D"}

package/dist/automatic-utils.js

@@ -0,0 +1,105 @@
+import fs from "fs";
+import path from "path";
+import { getMainApp } from "./config-utils.js";
+export function findIndexFiles(dir) {
+    const files = [];
+    fs.readdirSync(dir).forEach(file => {
+        const filePath = path.join(dir, file);
+        const stat = fs.statSync(filePath);
+        if (stat.isDirectory()) {
+            files.push(...findIndexFiles(filePath));
+        }
+        else if (file.match(/^index\.[tj]sx?$/)) {
+            files.push(filePath);
+        }
+    });
+    return files;
+}
+export function mapIndexFilesToRoutes(files, folder) {
+    const routes = [];
+    files.forEach(filePath => {
+        const bundle = filePath.substring(filePath.lastIndexOf(`/${folder.replace(/^\/|\/$/g, "")}/`) + 1, filePath.lastIndexOf("/"));
+        const route = bundle
+            .replace(new RegExp(`^${folder}`), "")
+            .replace(/index\.[t|j]sx?$/, "")
+            .replaceAll(/\$/g, ":")
+            .toLowerCase();
+        routes.push({ bundle, route });
+    });
+    return routes;
+}
+export function applyAutomaticViewsAndRoutes(config, root, viewsFolder) {
+    const appShellConfiguration = config;
+    let selfApp = getMainApp(appShellConfiguration);
+    const folder = path.resolve(root, viewsFolder);
+    if (fs.existsSync(folder)) {
+        const views = mapIndexFilesToRoutes(findIndexFiles(folder), viewsFolder);
+        if (views.length > 0) {
+            if (selfApp == null) {
+                selfApp = {
+                    id: "@self",
+                    baseUrl: "/"
+                };
+                if (appShellConfiguration.apps == null) {
+                    appShellConfiguration.apps = [];
+                }
+                appShellConfiguration.apps.push(selfApp);
+            }
+            if (selfApp.views != null && selfApp.views.length > 0) {
+                const nowOverlappingViews = views.filter(view => {
+                    const exists = selfApp.views.some(existingView => existingView.bundle === view.bundle ||
+                        existingView.route === view.route);
+                    return !exists;
+                });
+                selfApp.views.push(...nowOverlappingViews);
+            }
+            else {
+                selfApp.views = views;
+            }
+        }
+    }
+}
+export function applyAutomaticMenu(config) {
+    const appShellConfiguration = config;
+    const selfApp = getMainApp(appShellConfiguration);
+    if (selfApp?.views != null && selfApp.views.length > 0) {
+        const menu = [];
+        for (let i = 0; i !== selfApp.views.length; i += 1) {
+            const view = selfApp.views[i];
+            // skip dynamic routes (e.g. /list/:id))
+            if (view.route.indexOf(":") === -1) {
+                let currentMenu = menu;
+                const bundleParts = view.bundle.split("/");
+                const numberOfParts = view.route
+                    .split("/")
+                    .filter(part => part !== "").length;
+                const srcFolderParts = bundleParts.length - numberOfParts;
+                if (bundleParts.length > srcFolderParts) {
+                    for (let j = srcFolderParts; j !== bundleParts.length - 1; j += 1) {
+                        const part = bundleParts[j];
+                        let submenu = currentMenu.find(item => item.label === part);
+                        if (submenu == null) {
+                            submenu = {
+                                label: part,
+                                submenus: []
+                            };
+                            currentMenu.push(submenu);
+                        }
+                        currentMenu = submenu.submenus;
+                    }
+                    const label = bundleParts[bundleParts.length - 1];
+                    let menuitem = currentMenu.find(item => item.label === label);
+                    if (menuitem == null) {
+                        menuitem = {
+                            label
+                        };
+                        currentMenu.push(menuitem);
+                    }
+                    menuitem.target = view.route;
+                }
+            }
+        }
+        appShellConfiguration.menu = menu;
+    }
+}
+//# sourceMappingURL=automatic-utils.js.map

package/dist/automatic-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"automatic-utils.js","sourceRoot":"","sources":["../src/automatic-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAOxB,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,MAAM,UAAU,cAAc,CAAC,GAAW;IACxC,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACtB,KAAK,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;SACzC;aAAM,IAAI,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE;YACzC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,KAAe,EACf,MAAc;IAEd,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACvB,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAC/B,QAAQ,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/D,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAC1B,CAAC;QACF,MAAM,KAAK,GAAG,MAAM;aACjB,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;aACrC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;aAC/B,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC;aACtB,WAAW,EAAE,CAAC;QACjB,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,MAAwB,EACxB,IAAY,EACZ,WAAmB;IAEnB,MAAM,qBAAqB,GAAG,MAAM,CAAC;IACrC,IAAI,OAAO,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAEhD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC/C,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QACzB,MAAM,KAAK,GAAG,qBAAqB,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,CAAC;QAEzE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,IAAI,OAAO,IAAI,IAAI,EAAE;gBACnB,OAAO,GAAG;oBACR,EAAE,EAAE,OAAO;oBACX,OAAO,EAAE,GAAG;iBACb,CAAC;gBACF,IAAI,qBAAqB,CAAC,IAAI,IAAI,IAAI,EAAE;oBACtC,qBAAqB,CAAC,IAAI,GAAG,EAAE,CAAC;iBACjC;gBACD,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC1C;YAED,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrD,MAAM,mBAAmB,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBAC9C,MAAM,MAAM,GAAG,OAAQ,CAAC,KAAM,CAAC,IAAI,CACjC,YAAY,CAAC,EAAE,CACb,YAAY,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;wBACnC,YAAY,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,CACpC,CAAC;oBACF,OAAO,CAAC,MAAM,CAAC;gBACjB,CAAC,CAAC,CAAC;gBAEH,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAC;aAC5C;iBAAM;gBACL,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;aACvB;SACF;KACF;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAAwB;IACzD,MAAM,qBAAqB,GAAG,MAAM,CAAC;IACrC,MAAM,OAAO,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAElD,IAAI,OAAO,EAAE,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACtD,MAAM,IAAI,GAA6B,EAAE,CAAC;QAE1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAClD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE9B,wCAAwC;YACxC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;gBAClC,IAAI,WAAW,GAAG,IAAI,CAAC;gBACvB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAC3C,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK;qBAC7B,KAAK,CAAC,GAAG,CAAC;qBACV,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;gBACtC,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,GAAG,aAAa,CAAC;gBAC1D,IAAI,WAAW,CAAC,MAAM,GAAG,cAAc,EAAE;oBACvC,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC,KAAK,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;wBACjE,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;wBAC5B,IAAI,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;wBAC5D,IAAI,OAAO,IAAI,IAAI,EAAE;4BACnB,OAAO,GAAG;gCACR,KAAK,EAAE,IAAI;gCACX,QAAQ,EAAE,EAAE;6BACb,CAAC;4BACF,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;yBAC3B;wBACD,WAAW,GAAG,OAAO,CAAC,QAAS,CAAC;qBACjC;oBAED,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAClD,IAAI,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;oBAC9D,IAAI,QAAQ,IAAI,IAAI,EAAE;wBACpB,QAAQ,GAAG;4BACT,KAAK;yBACN,CAAC;wBACF,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;qBAC5B;oBACD,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;iBAC9B;aACF;SACF;QAED,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;KACnC;AACH,CAAC","sourcesContent":["import fs from \"fs\";\nimport path from \"path\";\n\nimport type {\n  HvAppShellConfig,\n  HvAppShellViewsConfig\n} from \"@hitachivantara/app-shell-shared\";\n\nimport { getMainApp } from \"./config-utils.js\";\n\nexport function findIndexFiles(dir: string): string[] {\n  const files: string[] = [];\n\n  fs.readdirSync(dir).forEach(file => {\n    const filePath = path.join(dir, file);\n    const stat = fs.statSync(filePath);\n\n    if (stat.isDirectory()) {\n      files.push(...findIndexFiles(filePath));\n    } else if (file.match(/^index\\.[tj]sx?$/)) {\n      files.push(filePath);\n    }\n  });\n\n  return files;\n}\n\nexport function mapIndexFilesToRoutes(\n  files: string[],\n  folder: string\n): HvAppShellViewsConfig[] {\n  const routes: HvAppShellViewsConfig[] = [];\n\n  files.forEach(filePath => {\n    const bundle = filePath.substring(\n      filePath.lastIndexOf(`/${folder.replace(/^\\/|\\/$/g, \"\")}/`) + 1,\n      filePath.lastIndexOf(\"/\")\n    );\n    const route = bundle\n      .replace(new RegExp(`^${folder}`), \"\")\n      .replace(/index\\.[t|j]sx?$/, \"\")\n      .replaceAll(/\\$/g, \":\")\n      .toLowerCase();\n    routes.push({ bundle, route });\n  });\n\n  return routes;\n}\n\nexport function applyAutomaticViewsAndRoutes(\n  config: HvAppShellConfig,\n  root: string,\n  viewsFolder: string\n) {\n  const appShellConfiguration = config;\n  let selfApp = getMainApp(appShellConfiguration);\n\n  const folder = path.resolve(root, viewsFolder);\n  if (fs.existsSync(folder)) {\n    const views = mapIndexFilesToRoutes(findIndexFiles(folder), viewsFolder);\n\n    if (views.length > 0) {\n      if (selfApp == null) {\n        selfApp = {\n          id: \"@self\",\n          baseUrl: \"/\"\n        };\n        if (appShellConfiguration.apps == null) {\n          appShellConfiguration.apps = [];\n        }\n        appShellConfiguration.apps.push(selfApp);\n      }\n\n      if (selfApp.views != null && selfApp.views.length > 0) {\n        const nowOverlappingViews = views.filter(view => {\n          const exists = selfApp!.views!.some(\n            existingView =>\n              existingView.bundle === view.bundle ||\n              existingView.route === view.route\n          );\n          return !exists;\n        });\n\n        selfApp.views.push(...nowOverlappingViews);\n      } else {\n        selfApp.views = views;\n      }\n    }\n  }\n}\n\nexport function applyAutomaticMenu(config: HvAppShellConfig) {\n  const appShellConfiguration = config;\n  const selfApp = getMainApp(appShellConfiguration);\n\n  if (selfApp?.views != null && selfApp.views.length > 0) {\n    const menu: HvAppShellConfig[\"menu\"] = [];\n\n    for (let i = 0; i !== selfApp.views.length; i += 1) {\n      const view = selfApp.views[i];\n\n      // skip dynamic routes (e.g. /list/:id))\n      if (view.route.indexOf(\":\") === -1) {\n        let currentMenu = menu;\n        const bundleParts = view.bundle.split(\"/\");\n        const numberOfParts = view.route\n          .split(\"/\")\n          .filter(part => part !== \"\").length;\n        const srcFolderParts = bundleParts.length - numberOfParts;\n        if (bundleParts.length > srcFolderParts) {\n          for (let j = srcFolderParts; j !== bundleParts.length - 1; j += 1) {\n            const part = bundleParts[j];\n            let submenu = currentMenu.find(item => item.label === part);\n            if (submenu == null) {\n              submenu = {\n                label: part,\n                submenus: []\n              };\n              currentMenu.push(submenu);\n            }\n            currentMenu = submenu.submenus!;\n          }\n\n          const label = bundleParts[bundleParts.length - 1];\n          let menuitem = currentMenu.find(item => item.label === label);\n          if (menuitem == null) {\n            menuitem = {\n              label\n            };\n            currentMenu.push(menuitem);\n          }\n          menuitem.target = view.route;\n        }\n      }\n    }\n\n    appShellConfiguration.menu = menu;\n  }\n}\n"]}

package/dist/config-utils.d.ts

@@ -0,0 +1,34 @@
+import type { HvAppShellAppsConfig, HvAppShellConfig } from "@hitachivantara/app-shell-shared";
+import type { AppShellVitePluginOptions } from "./vite-plugin.js";
+export interface ConfigReplacement {
+    token: string;
+    value: string;
+}
+export type AppShellConfigFunction = (pluginOptions: AppShellVitePluginOptions, env: Record<string, string>) => HvAppShellConfig;
+export declare const DEFAULT_CONFIG_FILES: string[];
+export declare function findAppShellConfigFile(root: string): string | undefined;
+export declare function loadConfigFile(appShellConfigFile: string | undefined, opts: AppShellVitePluginOptions, env?: Record<string, string>): HvAppShellConfig;
+/**
+ * Return the main app (identified by @self)
+ * @param appShellConfig The App shell configuration
+ */
+export declare const getMainApp: (appShellConfig: HvAppShellConfig) => HvAppShellAppsConfig | undefined;
+/**
+ * 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
+ */
+export declare const getPublicPath: (appShellConfig: HvAppShellConfig) => string;
+/**
+ *  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.
+ * @param selfAppName The name of the application bundle being built.
+ */
+export declare function getAppModules(root: string, appShellConfig: HvAppShellConfig, selfAppName: string): {
+    [key: string]: string;
+};
+//# sourceMappingURL=config-utils.d.ts.map

package/dist/config-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-utils.d.ts","sourceRoot":"","sources":["../src/config-utils.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAalE,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,sBAAsB,GAAG,CACnC,aAAa,EAAE,yBAAyB,EACxC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACxB,gBAAgB,CAAC;AAEtB,eAAO,MAAM,oBAAoB,UAIhC,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAUvE;AAED,wBAAgB,cAAc,CAC5B,kBAAkB,EAAE,MAAM,GAAG,SAAS,EACtC,IAAI,EAAE,yBAAyB,EAC/B,GAAG,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAC/B,gBAAgB,CAgClB;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,mBACL,gBAAgB,KAC/B,oBAAoB,GAAG,SAEzB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,mBAAoB,gBAAgB,KAAG,MAWhE,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,gBAAgB,EAChC,WAAW,EAAE,MAAM;;EA4DpB"}

package/dist/config-utils.js

@@ -0,0 +1,126 @@
+import fs from "fs";
+import path from "path";
+import { register, createEsmHooks } from "ts-node";
+import { require } from "./nodeModule.js";
+createEsmHooks(register({
+    transpileOnly: true,
+    moduleTypes: {
+        "app-shell.config.ts": "cjs"
+    }
+}));
+export const DEFAULT_CONFIG_FILES = [
+    "app-shell.config.ts",
+    "app-shell.config.js",
+    "app-shell.config.json"
+];
+export function findAppShellConfigFile(root) {
+    const filename = DEFAULT_CONFIG_FILES.find(file => fs.existsSync(path.resolve(root, file)));
+    if (filename) {
+        return path.resolve(root, filename);
+    }
+    return undefined;
+}
+export function loadConfigFile(appShellConfigFile, opts, env = {}) {
+    if (!appShellConfigFile) {
+        // an empty configuration is actually valid
+        // and with the automatic views option, it can even make sense
+        return {};
+    }
+    if (appShellConfigFile.endsWith(".json")) {
+        let appShellConfigRaw = fs.readFileSync(appShellConfigFile, "utf-8");
+        // token replacement is only supported for json files
+        opts.configReplacements?.forEach(item => {
+            appShellConfigRaw = appShellConfigRaw.replaceAll(`@@${item.token}@@`, item.value);
+        });
+        return JSON.parse(appShellConfigRaw);
+    }
+    // using require instead of import to avoid using --experimental-loader ts-node/esm
+    // eslint-disable-next-line import/no-dynamic-require
+    const loadedAppShellConfig = require(appShellConfigFile).default;
+    if (typeof loadedAppShellConfig === "function") {
+        return loadedAppShellConfig(opts, env);
+    }
+    return loadedAppShellConfig;
+}
+/**
+ * Return the main app (identified by @self)
+ * @param appShellConfig The App shell configuration
+ */
+export 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
+ */
+export const getPublicPath = (appShellConfig) => {
+    const mainApp = getMainApp(appShellConfig);
+    if (!mainApp) {
+        return "/";
+    }
+    const url = mainApp.baseUrl;
+    try {
+        return new URL(url).pathname;
+    }
+    catch {
+        return url;
+    }
+};
+/**
+ *  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.
+ * @param selfAppName The name of the application bundle being built.
+ */
+export function getAppModules(root, appShellConfig, selfAppName) {
+    const appModules = {};
+    const selfApp = getMainApp(appShellConfig);
+    if (selfApp != null) {
+        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);
+        });
+    }
+    const implicitThemeModules = appShellConfig?.theming?.themes?.map(theme => {
+        if (theme.startsWith("/src/") ||
+            theme.startsWith("@self/") ||
+            theme.startsWith(selfAppName)) {
+            const bundle = theme
+                .replace(/^@self\//, "")
+                .replace(new RegExp(`^${selfAppName}/`), "");
+            const bundleName = bundle.replace(/^(\/?)src\//, "");
+            return {
+                bundle,
+                bundleName
+            };
+        }
+        return undefined;
+    }) ?? [];
+    implicitThemeModules.forEach(module => {
+        if (module != null && appModules[module.bundleName] == null) {
+            appModules[module.bundleName] = path.resolve(root, module.bundle);
+        }
+    });
+    return appModules;
+}
+//# sourceMappingURL=config-utils.js.map

package/dist/config-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-utils.js","sourceRoot":"","sources":["../src/config-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AASnD,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,cAAc,CACZ,QAAQ,CAAC;IACP,aAAa,EAAE,IAAI;IACnB,WAAW,EAAE;QACX,qBAAqB,EAAE,KAAK;KAC7B;CACF,CAAC,CACH,CAAC;AAYF,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,qBAAqB;IACrB,qBAAqB;IACrB,uBAAuB;CACxB,CAAC;AAEF,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChD,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CACxC,CAAC;IAEF,IAAI,QAAQ,EAAE;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;KACrC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,kBAAsC,EACtC,IAA+B,EAC/B,MAA8B,EAAE;IAEhC,IAAI,CAAC,kBAAkB,EAAE;QACvB,2CAA2C;QAC3C,8DAA8D;QAC9D,OAAO,EAAE,CAAC;KACX;IAED,IAAI,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACxC,IAAI,iBAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAErE,qDAAqD;QACrD,IAAI,CAAC,kBAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE;YACtC,iBAAiB,GAAG,iBAAiB,CAAC,UAAU,CAC9C,KAAK,IAAI,CAAC,KAAK,IAAI,EACnB,IAAI,CAAC,KAAK,CACX,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAqB,CAAC;KAC1D;IAED,mFAAmF;IACnF,qDAAqD;IACrD,MAAM,oBAAoB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,OAErC,CAAC;IAErB,IAAI,OAAO,oBAAoB,KAAK,UAAU,EAAE;QAC9C,OAAO,oBAAoB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;KACxC;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,cAAgC,EACE,EAAE;IACpC,OAAO,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,cAAgC,EAAU,EAAE;IACxE,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;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,cAAgC,EAChC,WAAmB;IAEnB,MAAM,UAAU,GAA8B,EAAE,CAAC;IAEjD,MAAM,OAAO,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAC3C,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,SAAS,GACb,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;YACxB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACrD,OAAO;gBACL,GAAG,IAAI;gBACP,UAAU;aACX,CAAC;QACJ,CAAC,CAAC,IAAI,EAAE,CAAC;QAEX,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GACf,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE;YAC5B,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACvD,OAAO;gBACL,GAAG,MAAM;gBACT,UAAU;aACX,CAAC;QACJ,CAAC,CAAC,IAAI,EAAE,CAAC;QAEX,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC3B,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;KACJ;IAED,MAAM,oBAAoB,GACxB,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE;QAC3C,IACE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC;YACzB,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC1B,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,EAC7B;YACA,MAAM,MAAM,GAAG,KAAK;iBACjB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;iBACvB,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,WAAW,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;YAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;YACrD,OAAO;gBACL,MAAM;gBACN,UAAU;aACX,CAAC;SACH;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,IAAI,EAAE,CAAC;IAEX,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACpC,IAAI,MAAM,IAAI,IAAI,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE;YAC3D,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;SACnE;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["import fs from \"fs\";\nimport path from \"path\";\n\nimport { register, createEsmHooks } from \"ts-node\";\n\nimport type {\n  HvAppShellAppsConfig,\n  HvAppShellConfig\n} from \"@hitachivantara/app-shell-shared\";\n\nimport type { AppShellVitePluginOptions } from \"./vite-plugin.js\";\n\nimport { require } from \"./nodeModule.js\";\n\ncreateEsmHooks(\n  register({\n    transpileOnly: true,\n    moduleTypes: {\n      \"app-shell.config.ts\": \"cjs\"\n    }\n  })\n);\n\nexport interface ConfigReplacement {\n  token: string;\n  value: string;\n}\n\nexport type AppShellConfigFunction = (\n  pluginOptions: AppShellVitePluginOptions,\n  env: Record<string, string>\n) => HvAppShellConfig;\n\nexport const DEFAULT_CONFIG_FILES = [\n  \"app-shell.config.ts\",\n  \"app-shell.config.js\",\n  \"app-shell.config.json\"\n];\n\nexport function findAppShellConfigFile(root: string): string | undefined {\n  const filename = DEFAULT_CONFIG_FILES.find(file =>\n    fs.existsSync(path.resolve(root, file))\n  );\n\n  if (filename) {\n    return path.resolve(root, filename);\n  }\n\n  return undefined;\n}\n\nexport function loadConfigFile(\n  appShellConfigFile: string | undefined,\n  opts: AppShellVitePluginOptions,\n  env: Record<string, string> = {}\n): HvAppShellConfig {\n  if (!appShellConfigFile) {\n    // an empty configuration is actually valid\n    // and with the automatic views option, it can even make sense\n    return {};\n  }\n\n  if (appShellConfigFile.endsWith(\".json\")) {\n    let appShellConfigRaw = fs.readFileSync(appShellConfigFile, \"utf-8\");\n\n    // token replacement is only supported for json files\n    opts.configReplacements?.forEach(item => {\n      appShellConfigRaw = appShellConfigRaw.replaceAll(\n        `@@${item.token}@@`,\n        item.value\n      );\n    });\n\n    return JSON.parse(appShellConfigRaw) as HvAppShellConfig;\n  }\n\n  // using require instead of import to avoid using --experimental-loader ts-node/esm\n  // eslint-disable-next-line import/no-dynamic-require\n  const loadedAppShellConfig = require(appShellConfigFile).default as\n    | AppShellConfigFunction\n    | HvAppShellConfig;\n\n  if (typeof loadedAppShellConfig === \"function\") {\n    return loadedAppShellConfig(opts, env);\n  }\n\n  return loadedAppShellConfig;\n}\n\n/**\n * Return the main app (identified by @self)\n * @param appShellConfig The App shell configuration\n */\nexport const 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 */\nexport const 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 *  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 * @param selfAppName The name of the application bundle being built.\n */\nexport function getAppModules(\n  root: string,\n  appShellConfig: HvAppShellConfig,\n  selfAppName: string\n) {\n  const appModules: { [key: string]: string } = {};\n\n  const selfApp = getMainApp(appShellConfig);\n  if (selfApp != null) {\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\n  const implicitThemeModules =\n    appShellConfig?.theming?.themes?.map(theme => {\n      if (\n        theme.startsWith(\"/src/\") ||\n        theme.startsWith(\"@self/\") ||\n        theme.startsWith(selfAppName)\n      ) {\n        const bundle = theme\n          .replace(/^@self\\//, \"\")\n          .replace(new RegExp(`^${selfAppName}/`), \"\");\n        const bundleName = bundle.replace(/^(\\/?)src\\//, \"\");\n        return {\n          bundle,\n          bundleName\n        };\n      }\n\n      return undefined;\n    }) ?? [];\n\n  implicitThemeModules.forEach(module => {\n    if (module != null && appModules[module.bundleName] == null) {\n      appModules[module.bundleName] = path.resolve(root, module.bundle);\n    }\n  });\n\n  return appModules;\n}\n"]}