webpack-federation-types-plugin 1.2.5 → 1.3.0

package/FederationTypesPlugin.js

@@ -1,196 +1,207 @@
-const validate = require("schema-utils").validate
-const ts = require("typescript")
-const axios = require("axios")
-const fs = require("fs-extra")
-const path = require("path")
-const ms = require("ms")
-
-let isFirstCompilation = true
-const PLUGIN_NAME = "FederationTypesPlugin"
-const MF_TYPES_DIR = "federation-types"
-const DECLARATION_FILE_EXT = ".d.ts"
-
-const tscOptions = {
-  allowJs: true,
-  declaration: true,
-  emitDeclarationOnly: true,
-}
-
-const optionsSchema = {
-  type: "object",
-  properties: {
-    excludeRemotes: {
-      type: "array",
-    },
-    exposeTypes: {
-      type: "boolean",
-    },
-    importTypes: {
-      type: "boolean",
-    },
-    getTypesInterval: {
-      type: "string",
-    },
-  },
-}
-
-const getAssetData = (content) => {
-  const fileBuffer = Buffer.from(content, "utf-8")
-  const fileData = {
-    source: () => fileBuffer,
-    size: () => fileBuffer.length,
-  }
-  return fileData
-}
-
-class FederationTypesPlugin {
-  constructor(options = {}) {
-    validate(optionsSchema, options)
-    this._options = options
-  }
-
-  /**
-   * @param {import("webpack").Compiler} compiler
-   */
-  apply(compiler) {
-    let getTypesInterval
-    const federationPlugin =
-      compiler.options.plugins && compiler.options.plugins.find((plugin) => plugin.constructor.name === "ModuleFederationPlugin")
-    if (!federationPlugin) throw new Error("No ModuleFederationPlugin found.")
-    const logger = compiler.getInfrastructureLogger(PLUGIN_NAME)
-
-    const exposes = Object.fromEntries(Object.entries(federationPlugin._options.exposes || {}).map(([moduleName, currentPath]) => {
-      let isIndexFile = false
-      const absPath = path.resolve(process.cwd(), currentPath)
-      const hasExtension = !!path.extname(currentPath)
-      const extension = hasExtension ? "" : fs.existsSync(absPath + ".jsx") ? ".jsx" : fs.existsSync(absPath + ".js") ? ".js" : ""
-      if (!hasExtension && extension === "") {
-        if ( fs.existsSync(path.resolve(absPath, "index.js"))) {
-          isIndexFile = true
-        }
-        else logger.error(`Couldn't find ${currentPath}`)
-      }
-
-      return [moduleName.replace("./", ""), currentPath + (isIndexFile ? "/index.js" : "") + extension]
-    }
-    ))
-
-    const modulesPathsMap = Object.fromEntries(
-      Object.entries(exposes).map(([name, currentPath]) => {
-        return [name, path.join(process.cwd(), currentPath).replace(/\\/g, "/")]
-      })
-    )
-
-    const declarationFileToExposeNameMap = Object.entries(modulesPathsMap).reduce(
-      (result, [key, val]) => Object.assign(result, {[val.replace(/\.jsx?$/, DECLARATION_FILE_EXT)]: key}),
-      {}
-    )
-
-    const modulesPaths = Object.values(modulesPathsMap)
-
-    const createTypesDefinitions = (compilation) => {
-      const host = ts.createCompilerHost(tscOptions)
-
-      const createdFiles = {}
-      host.writeFile = (fileName, fileContent) => {
-        const isExposedModules = modulesPaths.some((current) => current.startsWith(fileName.replace(/\.d\.ts/, "")))
-        if (isExposedModules) {
-          createdFiles[fileName] = fileContent
-        }
-      }
-
-      const program = ts.createProgram(modulesPaths, tscOptions, host)
-      program.emit()
-
-      // create definitions files
-      modulesPaths.forEach((modulePath) => {
-        const typeDefFilePath = modulePath.replace(/\.jsx?$/, DECLARATION_FILE_EXT)
-        const typeDefFileContent = createdFiles[typeDefFilePath]
-        if (typeDefFileContent) {
-          compilation.emitAsset(
-            path.join(MF_TYPES_DIR, declarationFileToExposeNameMap[typeDefFilePath] + DECLARATION_FILE_EXT),
-            getAssetData(typeDefFileContent)
-          )
-        } else {
-          logger.warn(`failed to create ${typeDefFilePath}`)
-        }
-      })
-
-      // create index.json
-      const modulesNames = Object.keys(exposes).map((moduleName) => moduleName + DECLARATION_FILE_EXT)
-      compilation.emitAsset(path.join(MF_TYPES_DIR, "index.json"), getAssetData(JSON.stringify(modulesNames)))
-    }
-
-    const getRemoteDeclareDirPath = (remoteName) => path.resolve(process.cwd(), "node_modules", "@types", remoteName)
-
-    const getTypesDefinitions = async () => {
-      const remotes = federationPlugin._options.remotes
-      if (!remotes) return
-
-      const excludeRemotes = this._options.excludeRemotes || []
-      const wantedRemotes = Object.entries(remotes).filter((remote) => !excludeRemotes.find((c) => c === remote[0]))
-
-      for (const [remoteName, remoteEntryUri] of wantedRemotes) {
-        const {origin, pathname} = new URL(remoteEntryUri.split("@")[1])
-        const remotePublicUrl = origin + pathname.slice(0, pathname.lastIndexOf("/") + 1)
-        const remoteDeclareDirPath = getRemoteDeclareDirPath(remoteName)
-        const federationTypesUrl = remotePublicUrl + MF_TYPES_DIR + "/"
-
-        axios
-          // get types index from the current remote
-          .get(federationTypesUrl + "index.json")
-          .catch((error) => {
-            if (error.response?.status === 404) logger.warn(`WARNING: The remote ${remoteName} has no types`)
-            else logger.warn(`Failed to get remote types from ${remotePublicUrl}.`, error.message)
-          })
-          .then((response) => response?.data)
-          .then((modulesNames) => {
-            if (!modulesNames) return
-            // for each remote module get his types
-            modulesNames.forEach((moduleName) => {
-              const moduleDeclarationFileUrl = federationTypesUrl + moduleName
-              axios
-                .get(moduleDeclarationFileUrl)
-                .catch((error) => {
-                  logger.warn(`Failed to get ${moduleDeclarationFileUrl} ${error.message}`)
-                })
-                .then((declarationFileResponse) => {
-                  if (!declarationFileResponse) return
-                  const declarationFileContent = declarationFileResponse.data
-                  const decFilePath = path.join(remoteDeclareDirPath, moduleName)
-                  fs.promises
-                    .mkdir(path.dirname(decFilePath), {recursive: true})
-                    .catch((error) => logger.error(`Failed to write dir: ${decFilePath}`, error))
-                    .then(() => fs.writeFile(decFilePath, declarationFileContent, {recursive: true}))
-                    .catch((error) => logger.error(`Failed to write declaration file: ${decFilePath}`, error))
-                })
-                .catch((error) => {
-                  logger.warn(`Failed to get ${moduleDeclarationFileUrl} ${error.message}`)
-                })
-            })
-          })
-          .catch((error) => {
-            logger.error("Failed to add declaration file", error.message)
-          })
-      }
-    }
-
-    compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
-      const pluginOptions = this._options || {}
-      compilation.hooks.beforeCodeGeneration.tap(PLUGIN_NAME, () => {
-        if (!isFirstCompilation) return
-        isFirstCompilation = false
-        if (pluginOptions.exposeTypes !== false) createTypesDefinitions(compilation)
-        if (compilation.options.mode === "development" && pluginOptions.importTypes !== false) {
-          getTypesDefinitions()
-          if (pluginOptions.getTypesInterval) {
-            clearInterval(getTypesInterval)
-            getTypesInterval = setInterval(() => getTypesDefinitions(compilation), ms(pluginOptions.getTypesInterval))
-          }
-        }
-      })
-    })
-  }
-}
-
-module.exports = FederationTypesPlugin
+const validate = require("schema-utils").validate
+const {merge} = require("webpack-merge")
+const ts = require("typescript")
+const axios = require("axios")
+const fs = require("fs-extra")
+const path = require("path")
+const ms = require("ms")
+
+let isFirstCompilation = true
+const PLUGIN_NAME = "FederationTypesPlugin"
+const MF_TYPES_DIR = "federation-types"
+const DECLARATION_FILE_EXT = ".d.ts"
+
+const tscOptions = {
+  allowJs: true,
+  declaration: true,
+  emitDeclarationOnly: true,
+}
+
+const optionsSchema = {
+  type: "object",
+  properties: {
+    excludeRemotes: {
+      type: "array",
+    },
+    exposeTypes: {
+      type: "boolean",
+    },
+    importTypes: {
+      type: "boolean",
+    },
+    getTypesInterval: {
+      type: "string",
+    },
+    federationConfig: {
+      type: "object",
+      properties: {
+        exposes: {type: "object"},
+        remotes: {type: "object"},
+      },
+      additionalProperties: false,
+    },
+  },
+}
+
+const getAssetData = (content) => {
+  const fileBuffer = Buffer.from(content, "utf-8")
+  const fileData = {
+    source: () => fileBuffer,
+    size: () => fileBuffer.length,
+  }
+  return fileData
+}
+
+class FederationTypesPlugin {
+  constructor(options = {}) {
+    validate(optionsSchema, options)
+    this._options = options
+  }
+
+  /**
+   * @param {import("webpack").Compiler} compiler
+   */
+  apply(compiler) {
+    let getTypesInterval
+    const federationPlugin =
+      compiler.options.plugins && compiler.options.plugins.find((plugin) => plugin.constructor.name === "ModuleFederationPlugin")
+    if (!federationPlugin) throw new Error("No ModuleFederationPlugin found.")
+
+    const federationsOptions = merge(federationPlugin._options, this._options.federationConfig)
+    const logger = compiler.getInfrastructureLogger(PLUGIN_NAME)
+
+    const exposes = Object.fromEntries(
+      Object.entries(federationsOptions.exposes || {}).map(([moduleName, currentPath]) => {
+        let isIndexFile = false
+        const absPath = path.resolve(process.cwd(), currentPath)
+        const hasExtension = !!path.extname(currentPath)
+        const extension = hasExtension ? "" : fs.existsSync(absPath + ".jsx") ? ".jsx" : fs.existsSync(absPath + ".js") ? ".js" : ""
+        if (!hasExtension && extension === "") {
+          if (fs.existsSync(path.resolve(absPath, "index.js"))) {
+            isIndexFile = true
+          } else logger.error(`Couldn't find ${currentPath}`)
+        }
+
+        return [moduleName.replace("./", ""), currentPath + (isIndexFile ? "/index.js" : "") + extension]
+      }),
+    )
+
+    const modulesPathsMap = Object.fromEntries(
+      Object.entries(exposes).map(([name, currentPath]) => {
+        return [name, path.join(process.cwd(), currentPath).replace(/\\/g, "/")]
+      }),
+    )
+
+    const declarationFileToExposeNameMap = Object.entries(modulesPathsMap).reduce(
+      (result, [key, val]) => Object.assign(result, {[val.replace(/\.jsx?$/, DECLARATION_FILE_EXT)]: key}),
+      {},
+    )
+
+    const modulesPaths = Object.values(modulesPathsMap)
+
+    const createTypesDefinitions = (compilation) => {
+      const host = ts.createCompilerHost(tscOptions)
+
+      const createdFiles = {}
+      host.writeFile = (fileName, fileContent) => {
+        const isExposedModules = modulesPaths.some((current) => current.startsWith(fileName.replace(/\.d\.ts/, "")))
+        if (isExposedModules) {
+          createdFiles[fileName] = fileContent
+        }
+      }
+
+      const program = ts.createProgram(modulesPaths, tscOptions, host)
+      program.emit()
+
+      // create definitions files
+      modulesPaths.forEach((modulePath) => {
+        const typeDefFilePath = modulePath.replace(/\.jsx?$/, DECLARATION_FILE_EXT)
+        const typeDefFileContent = createdFiles[typeDefFilePath]
+        if (typeDefFileContent) {
+          compilation.emitAsset(
+            path.join(MF_TYPES_DIR, declarationFileToExposeNameMap[typeDefFilePath] + DECLARATION_FILE_EXT),
+            getAssetData(typeDefFileContent),
+          )
+        } else {
+          logger.warn(`failed to create ${typeDefFilePath}`)
+        }
+      })
+
+      // create index.json
+      const modulesNames = Object.keys(exposes).map((moduleName) => moduleName + DECLARATION_FILE_EXT)
+      compilation.emitAsset(path.join(MF_TYPES_DIR, "index.json"), getAssetData(JSON.stringify(modulesNames)))
+    }
+
+    const getRemoteDeclareDirPath = (remoteName) => path.resolve(process.cwd(), "node_modules", "@types", remoteName)
+
+    const getTypesDefinitions = async () => {
+      const remotes = federationsOptions.remotes
+      if (!remotes) return
+
+      const excludeRemotes = this._options.excludeRemotes || []
+      const wantedRemotes = Object.entries(remotes).filter((remote) => !excludeRemotes.find((c) => c === remote[0]))
+
+      for (const [remoteName, remoteEntryUri] of wantedRemotes) {
+        const {origin, pathname} = new URL(remoteEntryUri.split("@")[1])
+        const remotePublicUrl = origin + pathname.slice(0, pathname.lastIndexOf("/") + 1)
+        const remoteDeclareDirPath = getRemoteDeclareDirPath(remoteName)
+        const federationTypesUrl = remotePublicUrl + MF_TYPES_DIR + "/"
+
+        axios
+          // get types index from the current remote
+          .get(federationTypesUrl + "index.json")
+          .catch((error) => {
+            if (error.response?.status === 404) logger.warn(`WARNING: The remote ${remoteName} has no types`)
+            else logger.warn(`Failed to get remote types from ${remotePublicUrl}.`, error.message)
+          })
+          .then((response) => response?.data)
+          .then((modulesNames) => {
+            if (!modulesNames) return
+            // for each remote module get his types
+            modulesNames.forEach((moduleName) => {
+              const moduleDeclarationFileUrl = federationTypesUrl + moduleName
+              axios
+                .get(moduleDeclarationFileUrl)
+                .catch((error) => {
+                  logger.warn(`Failed to get ${moduleDeclarationFileUrl} ${error.message}`)
+                })
+                .then((declarationFileResponse) => {
+                  if (!declarationFileResponse) return
+                  const declarationFileContent = declarationFileResponse.data
+                  const decFilePath = path.join(remoteDeclareDirPath, moduleName)
+                  fs.promises
+                    .mkdir(path.dirname(decFilePath), {recursive: true})
+                    .catch((error) => logger.error(`Failed to write dir: ${decFilePath}`, error))
+                    .then(() => fs.writeFile(decFilePath, declarationFileContent, {recursive: true}))
+                    .catch((error) => logger.error(`Failed to write declaration file: ${decFilePath}`, error))
+                })
+                .catch((error) => {
+                  logger.warn(`Failed to get ${moduleDeclarationFileUrl} ${error.message}`)
+                })
+            })
+          })
+          .catch((error) => {
+            logger.error("Failed to add declaration file", error.message)
+          })
+      }
+    }
+
+    compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
+      const pluginOptions = this._options || {}
+      compilation.hooks.beforeCodeGeneration.tap(PLUGIN_NAME, () => {
+        if (!isFirstCompilation) return
+        isFirstCompilation = false
+        if (pluginOptions.exposeTypes !== false) createTypesDefinitions(compilation)
+        if (compilation.options.mode === "development" && pluginOptions.importTypes !== false) {
+          getTypesDefinitions()
+          if (pluginOptions.getTypesInterval) {
+            clearInterval(getTypesInterval)
+            getTypesInterval = setInterval(() => getTypesDefinitions(compilation), ms(pluginOptions.getTypesInterval))
+          }
+        }
+      })
+    })
+  }
+}
+
+module.exports = FederationTypesPlugin

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Daniel Amenou
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 Daniel Amenou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,58 +1,62 @@
-# webpack-federation-types-plugin
-
-This plugin generates TypeScript type declaration files for the modules that are exposed by a remote application.
-With this plugin, you can get type definitions for your modules and use them in your consuming applications without having to manually import and maintain them.
-
-It compiles the exposed files into type declaration files and shares them as public files
-On the consumer side, the plugin fetches the remote types declaration files and adds them to the "node_modules/@types" directory. This is the standard location for TypeScript type definitions that are used by the consuming application. By placing the generated type declaration files in this directory, the plugin makes them available to the consuming application without the need for any additional configuration.
-
-## Installation
-
-You can install the plugin by running the following command in your terminal:
-
-`npm i --save-dev webpack-federation-types-plugin`
-
-`yarn add --dev webpack-federation-types-plugin`
-
-## Usage
-
-After installing the plugin, you can use it in your webpack configuration file as follows:
-
-```javascript
-const FederationTypesPlugin = require("webpack-federation-types-plugin")
-
-module.exports = {
-  // ...
-  plugins: [new FederationTypesPlugin({excludeRemotes: ["remoteName"], importTypes: true, exposeTypes: true})],
-}
-```
-
-- This plugin should be added to the browser config
-
-## Plugin Options
-
-The plugin takes an options object with the following properties:
-
-##### exposeTypes
-
-Type: boolean
-Default: true
-Description: create and share the declaration files
-##### importTypes
-
-Type: boolean
-Default: true
-Description: fetch the remotes declaration files and add them to the @types directory
-
-##### excludeRemotes
-
-Type: string[]
-Default: undefined
-Description: remotes to ignore
-
-##### getTypesInterval
-
-Type: string
-Default: undefined
-Description: the interval between types requests
-Example: "5 minutes", "30 seconds"
+# webpack-federation-types-plugin
+
+This plugin generates TypeScript type declaration files for the modules exposed by a remote application. It enables the automatic creation, sharing, and fetching of type definitions for your modules across different applications in a Webpack Module Federation setup.
+
+The plugin compiles the exposed modules into TypeScript declaration files and shares them as public assets. On the consumer side, it automatically fetches these remote type declaration files and places them in the standard node_modules/@types directory. This ensures that the consuming application can seamlessly access the type definitions without any additional setup, making the integration of remote types effortless and transparent.
+
+## Installation
+
+You can install the plugin by running the following command in your terminal:
+
+`npm i --save-dev webpack-federation-types-plugin`
+
+`yarn add --dev webpack-federation-types-plugin`
+
+## Usage
+
+After installing the plugin, you can use it in your webpack configuration file as follows:
+
+```javascript
+const FederationTypesPlugin = require("webpack-federation-types-plugin")
+
+module.exports = {
+  // ...
+  plugins: [new FederationTypesPlugin({excludeRemotes: ["remoteName"], importTypes: true, exposeTypes: true})],
+}
+```
+
+- This plugin should be added to the browser config
+
+## Plugin Options
+
+The plugin takes an options object with the following properties:
+
+##### exposeTypes
+
+Type: boolean
+Default: true
+Description: create and share the declaration files
+
+##### importTypes
+
+Type: boolean
+Default: true
+Description: fetch the remotes declaration files and add them to the @types directory
+
+##### excludeRemotes
+
+Type: string[]
+Default: undefined
+Description: remotes to ignore
+
+##### getTypesInterval
+
+Type: string
+Default: undefined
+Description: the interval between types requests
+Example: "5 minutes", "30 seconds"
+
+##### federationConfig
+
+Type: object
+Description: Allows you to override certain configurations from the ModuleFederationPlugin. You can specify properties such as exposes and remotes to merge or replace the original settings.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webpack-federation-types-plugin",
   "description": "This plugin adds type definitions for remote modules",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "main": "FederationTypesPlugin.js",
   "types": "types.d.ts",
   "scripts": {
@@ -28,6 +28,7 @@
     "fs-extra": "^11.1.0",
     "ms": "^2.1.3",
     "schema-utils": "^4.0.0",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.4",
+    "webpack-merge": "^6.0.1"
   }
 }

package/types.d.ts

@@ -1,12 +1,12 @@
-declare interface FederationTypesPluginOptions {
-  exposeTypes?: boolean
-  importTypes?: boolean
-  excludeRemotes?: string[]
-}
-
-declare class FederationTypesPlugin {
-  constructor(options?: FederationTypesPluginOptions)
-  apply(compiler: any): void
-}
-
+declare interface FederationTypesPluginOptions {
+  exposeTypes?: boolean
+  importTypes?: boolean
+  excludeRemotes?: string[]
+}
+
+declare class FederationTypesPlugin {
+  constructor(options?: FederationTypesPluginOptions)
+  apply(compiler: any): void
+}
+
 export default FederationTypesPlugin