webpack-federation-types-plugin 1.2.2 → 1.2.3

package/FederationTypesPlugin.js

@@ -1,196 +1,196 @@
-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.error(`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.error(`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.error(`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 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.error(`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.error(`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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webpack-federation-types-plugin",
   "description": "This plugin adds type definitions for remote modules",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "main": "FederationTypesPlugin.js",
   "types": "types.d.ts",
   "scripts": {