@feedmepos/mf-common 1.28.6 → 1.28.8

package/dist/vite-preset.d.ts

@@ -1,12 +1,100 @@
 import type { ConfigEnv, UserConfig } from "vite";
+/**
+ * Configuration options for the FeedMe Microfrontend (FMMF) Vite preset.
+ *
+ * This preset configures Vite to work with a microfrontend architecture using ES Module importmaps.
+ * It handles externalization of dependencies, CDN imports, and proper bundling for both development
+ * and production (fmmf) modes.
+ *
+ * @example
+ * ```typescript
+ * fmmfVitePresent(config, env, {
+ *   excludeFmmfPackages: ['@feedmepos/mf-old-app'],
+ *   externalize: true,
+ *   externalizeCore: true
+ * })
+ * ```
+ */
 export interface FmmfPresentOptions {
+    /**
+     * List of FMMF package names to exclude from the importmap.
+     *
+     * Use this when you want to bundle a specific microfrontend into your app instead of
+     * loading it externally. This only affects your local build; to exclude packages in the
+     * portal, contact the project leader.
+     *
+     * @example ['@feedmepos/mf-old-feature', '@feedmepos/mf-deprecated']
+     */
     excludeFmmfPackages?: string[];
+    /**
+     * List of additional FMMF package names to include in the importmap.
+     *
+     * Use this to add microfrontends that aren't in your package.json dependencies but
+     * should be available at runtime. This only affects your local build.
+     *
+     * @example ['@feedmepos/mf-experimental', '@feedmepos/mf-feature-flag']
+     */
     includeFmmfPackages?: string[];
+    /**
+     * Map of package names to custom CDN URLs to override default jsdelivr CDN.
+     *
+     * Useful for testing local builds or using different CDN sources. Keys must start with
+     * '@feedmepos/mf-' or be '@feedmepos/ui-library'. This only affects your local build.
+     *
+     * @example { '@feedmepos/mf-menu': 'http://localhost:5173/dist/app.js' }
+     * @throws Error if keys don't start with '@feedmepos/mf-' or '@feedmepos/ui-library'
+     */
     replaceFmmfPackages?: Record<string, string>;
+    /**
+     * Import map scopes for granular control over module resolution in specific contexts.
+     *
+     * Scopes allow different versions of the same module to be used in different parts of
+     * the application. See: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap#scopes
+     *
+     * @example { './local/': { 'vue': 'https://cdn.example.com/vue@3.4.0/dist/vue.esm.js' } }
+     */
     importMapScopes?: Record<string, string>;
+    /**
+     * Flag indicating development mode. Currently not actively used in the implementation.
+     *
+     * @deprecated This flag is not currently utilized in the preset logic.
+     */
     isDev?: boolean;
+    /**
+     * Controls externalization of microfrontends during development (esbuild phase).
+     *
+     * When enabled, microfrontend modules won't be bundled but will be loaded from CDN/importmap.
+     * This speeds up dev builds but requires proper importmap configuration.
+     *
+     * - `true`: Externalize all microfrontends and their dependencies
+     * - `string[]`: Externalize only specific package names
+     * - `false` or undefined: Bundle all dependencies normally
+     *
+     * @example true // Externalize everything
+     * @example ['@feedmepos/mf-menu', 'vue'] // Externalize specific packages
+     */
     externalize?: boolean | string[];
+    /**
+     * Whether to externalize @feedmepos/core packages (core, core/fn, core/entity, core/modules).
+     *
+     * When true, core packages are loaded from jsdelivr CDN instead of being bundled.
+     * Useful for sharing core logic across multiple microfrontends and reducing bundle size.
+     *
+     * @default false
+     */
     externalizeCore?: boolean;
 }
+/**
+ * FeedMe Microfrontend Vite Preset
+ *
+ * Configures Vite for microfrontend architecture with ES Module importmaps.
+ * Handles externalization, CDN imports, and proper bundling for dev and production.
+ *
+ * @param config - Base Vite configuration to extend
+ * @param command - Vite command ('build' or 'serve')
+ * @param mode - Build mode (e.g., 'development', 'production', 'fmmf')
+ * @param options - FMMF-specific configuration options
+ * @returns Modified Vite configuration with microfrontend support
+ */
 export declare const fmmfVitePresent: (config: UserConfig, { command, mode }: ConfigEnv, options?: FmmfPresentOptions) => Promise<UserConfig>;
 //# sourceMappingURL=vite-preset.d.ts.map

package/dist/vite-preset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vite-preset.d.ts","sourceRoot":"","sources":["../vite-preset.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAwB,UAAU,EAAE,MAAM,MAAM,CAAA;AAKvE,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC9B,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxC,KAAK,CAAC,EAAE,OAAO,CAAA;IAIf,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAA;IAChC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,eAAO,MAAM,eAAe,WAClB,UAAU,qBACC,SAAS,YACnB,kBAAkB,KAC1B,QAAQ,UAAU,CAkJpB,CAAA"}
+{"version":3,"file":"vite-preset.d.ts","sourceRoot":"","sources":["../vite-preset.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAwB,UAAU,EAAE,MAAM,MAAM,CAAA;AAKvE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE9B;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE9B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5C;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAExC;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAA;IAEhC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,WAClB,UAAU,qBACC,SAAS,YACnB,kBAAkB,KAC1B,QAAQ,UAAU,CAsMpB,CAAA"}

package/dist/vite-preset.js

@@ -74,6 +74,7 @@ const g = (l) => {
   });
   const a = {
     "@feedmepos/ui-library": "https://cdn.jsdelivr.net/npm/@feedmepos/ui-library@latest/dist/feedmepos-ui-library.js",
+    // Conditionally externalize core packages to share business logic
     ...t.externalizeCore ? {
       "@feedmepos/core": "https://cdn.jsdelivr.net/npm/@feedmepos/core@latest/es/index.js",
       "@feedmepos/core/fn": "https://cdn.jsdelivr.net/npm/@feedmepos/core@latest/es/fn.js",
@@ -101,8 +102,10 @@ const g = (l) => {
     lib: {
       entry: {
         app: h(process.cwd(), "src/app.ts")
+        // Entry must export routers, FmApp, etc.
       },
       formats: ["es"]
+      // ES module format for native browser import
     }
   }), n.plugins ?? (n.plugins = []), t.externalize) {
     const s = t.externalize === !0 ? m : t.externalize;
@@ -120,10 +123,14 @@ const g = (l) => {
   );
   const u = {
     imports: {
+      // Microfrontend applications
       ...d,
+      // Common dependencies (Vue ecosystem)
       ...Object.keys(o).reduce((s, i) => (s[i] = `https://cdn.jsdelivr.net/npm/${i}@${o[i]}`, s), {}),
+      // Specific external packages (UI library, core packages)
       ...a
     },
+    // Scopes allow different module resolution in specific contexts
     scopes: t.importMapScopes ?? {}
   };
   t.replaceFmmfPackages && Object.entries(t.replaceFmmfPackages).forEach(([s, i]) => {
@@ -135,28 +142,35 @@ const g = (l) => {
   const v = {
     name: "vite-plugin-feedme-microfrontend",
     enforce: "pre",
+    // Run before other plugins
     config: async () => {
     },
     transformIndexHtml: {
       enforce: "pre",
+      // Transform HTML early in the pipeline
       transform(s) {
         return {
           html: s,
           tags: [
+            // Inject the importmap script tag containing module mappings
             {
               tag: "script",
               attrs: {
                 type: "importmap"
+                // Special script type for ES module imports
               },
               children: JSON.stringify(u, null, 2),
               injectTo: "head-prepend"
+              // Add at the beginning of <head>
             },
+            // Inject es-module-shims for browsers without native importmap support
             {
               tag: "script",
               attrs: {
                 src: "https://cdn.jsdelivr.net/npm/es-module-shims@1.8.0/dist/es-module-shims.min.js"
               },
               injectTo: "head-prepend"
+              // Load before importmap
             }
           ]
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@feedmepos/mf-common",
-  "version": "1.28.6",
+  "version": "1.28.8",
   "type": "module",
   "files": [
     "dist"