@module-federation/native-federation-typescript 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+# 0.1.0 (2023-04-05)
+
+
+### Bug Fixes
+
+* build ([d0b2f72](https://github.com/module-federation/nextjs-mf/commit/d0b2f72f4fc3647825412be1574311c3152cf167))
+* build step ([a217170](https://github.com/module-federation/nextjs-mf/commit/a21717096cbc09bff20d3aeebfea2f3533afb0d7))
+* compiler instance ([e5c249d](https://github.com/module-federation/nextjs-mf/commit/e5c249d41d68339886268337654ff47b31b06a3a))
+* deps ([a378441](https://github.com/module-federation/nextjs-mf/commit/a37844194a3f189cc5863bbdd4776259bce69fa4))
+* dirtree tests ([5cb49fd](https://github.com/module-federation/nextjs-mf/commit/5cb49fd1c6520311a7d2e7d2b37a93389a500715))
+* eslintrc ([0f69dee](https://github.com/module-federation/nextjs-mf/commit/0f69dee253c2c608b2367d545c7d4a57ad0c2ca5))
+* format ([25fb765](https://github.com/module-federation/nextjs-mf/commit/25fb7659481287a791e9de4fe839e980dbf06968))
+* readme ([eaca0b3](https://github.com/module-federation/nextjs-mf/commit/eaca0b311d3b8d9e73309cb92d9a9488f9fc23c0))
+* readme ([fc0e5dc](https://github.com/module-federation/nextjs-mf/commit/fc0e5dc26e617664224e1c10548b151a44f8dff9))
+* README.md ([9159171](https://github.com/module-federation/nextjs-mf/commit/91591712e9a103fff351f0a168c149470c0d69ad))
+* remove changelog ([724918e](https://github.com/module-federation/nextjs-mf/commit/724918ebf888297689b6ed700bd14ec01fd1ef35))
+* ts build ([9ed3a52](https://github.com/module-federation/nextjs-mf/commit/9ed3a527d0ba903b6cfa6023a7ad5da63781970c))
+
+
+### Features
+
+* federated tests plugin ([063ab33](https://github.com/module-federation/nextjs-mf/commit/063ab336c4830aff4f5bd3b9894df60b4651a9be))
+* native-federation-typescript plugin ([#692](https://github.com/module-federation/nextjs-mf/issues/692)) ([b41c5aa](https://github.com/module-federation/nextjs-mf/commit/b41c5aacfeda0fada5b426086658235edfd86cdd))
+* test command ([3ade629](https://github.com/module-federation/nextjs-mf/commit/3ade629488f4ea1549314b82b41caef9a046da9f))

package/README.md

@@ -0,0 +1,166 @@
+# native-federation-typescript
+
+Bundler agnostic plugins to share federated types.
+
+## Install
+
+```bash
+npm i -D @module-federation/native-federation-typescript
+```
+
+This module provides two plugins:
+
+### NativeFederationTypeScriptRemote
+This plugin is used to build the federated types.
+
+#### Configuration
+```typescript
+{
+    moduleFederationConfig: any; // the configuration same configuration provided to the module federation plugin, it is MANDATORY
+    tsConfigPath?: string; // path where the tsconfig file is located, default is ''./tsconfig.json'
+    typesFolder?: string; // folder where all the files will be stored, default is '@mf-types',
+    compiledTypesFolder?: string; // folder where the federated modules types will be stored, default is 'compiled-types'
+    deleteTypesFolder?: boolean; // indicate if the types folder will be deleted when the job completes, default is 'true'
+    additionalFilesToCompile?: string[] // The path of each additional file which should be emitted
+    compilerInstance?: 'tsc' | 'vue-tsc' // The compiler to use to emit files, default is 'tsc'
+}
+```
+
+#### Additional configuration
+Note that, for Webpack, the plugin automatically inject the `devServer.static.directory` configuration.  
+For the other bundlers, you should configure it by yourself.
+
+### NativeFederationTypeScriptHost
+This plugin is used to download the federated types.
+
+### Configuration
+
+```typescript
+{
+    moduleFederationConfig: any; // the configuration same configuration provided to the module federation plugin, it is MANDATORY
+    typesFolder?: string; // folder where all the files will be stored, default is '@mf-types',
+    deleteTypesFolder?: boolean; // indicate if the types folder will be deleted before the job starts, default is 'true'
+}
+```
+
+## Bundler configuration
+
+<details>
+<summary>Vite</summary><br>
+
+```ts
+// vite.config.ts
+import {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} from '@module-federation/native-federation-typescript/vite'
+
+export default defineConfig({
+  plugins: [
+    NativeFederationTypeScriptRemote({ /* options */ }),
+    NativeFederationTypeScriptHost({ /* options */ }),
+  ],
+  /* ... */
+  server: { // This is needed to emulate the devServer.static.directory of WebPack and correctly serve the zip file
+    /* ... */
+    proxy: {
+      '/@mf-types.zip': {
+          target: 'http://localhost:3000',
+          changeOrigin: true,
+          rewrite: () => `/@fs/${process.cwd()}/dist/@mf-types.zip`
+      }
+    },
+    fs: {
+      /* ... */
+      allow: ['./dist']
+      /* ... */
+    }
+  }
+})
+```
+
+<br>
+</details>
+<details>
+<summary>Rollup</summary><br>
+
+```ts
+// rollup.config.js
+import {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} from '@module-federation/native-federation-typescript/rollup'
+
+export default {
+  plugins: [
+    NativeFederationTypeScriptRemote({ /* options */ }),
+    NativeFederationTypeScriptHost({ /* options */ }),
+  ],
+}
+```
+
+<br>
+</details>
+<details>
+<summary>Webpack</summary><br>
+
+```ts
+// webpack.config.js
+const {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} = require('@module-federation/native-federation-typescript/webpack')
+module.exports = {
+  /* ... */
+  plugins: [
+    NativeFederationTypeScriptRemote({ /* options */ }),
+    NativeFederationTypeScriptHost({ /* options */ })
+  ]
+}
+```
+
+<br>
+</details>
+<details>
+<summary>esbuild</summary><br>
+
+```ts
+// esbuild.config.js
+import { build } from 'esbuild'
+import {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} from '@module-federation/native-federation-typescript/esbuild'
+
+build({
+  plugins: [
+    NativeFederationTypeScriptRemote({ /* options */ }),
+    NativeFederationTypeScriptHost({ /* options */ })
+  ],
+})
+```
+
+<br>
+</details>
+<details>
+<summary>Rspack</summary><br>
+
+```ts
+// rspack.config.js
+const {NativeFederationTypeScriptHost, NativeFederationTypeScriptRemote} = require('@module-federation/native-federation-typescript/rspack')
+module.exports = {
+  /* ... */
+  plugins: [
+    NativeFederationTypeScriptRemote({ /* options */ }),
+    NativeFederationTypeScriptHost({ /* options */ })
+  ]
+}
+```
+
+<br>
+</details>
+
+## TypeScript configuration
+
+To have the type definitions automatically found for imports, add paths to the `compilerOptions` in the `tsconfig.json`:
+
+```json
+{  
+  "paths": {
+    "*": ["./@mf-types/*"]
+  }
+}
+```
+
+## Examples
+
+To use it in a `host` module, refer to [this example](https://github.com/ilteoood/module-federation-typescript/tree/host).  
+To use it in a `remote` module, refer to [this example](https://github.com/ilteoood/module-federation-typescript/tree/remote).

package/dist/RemoteOptions-ce85caac.d.ts

@@ -0,0 +1,17 @@
+interface HostOptions {
+    moduleFederationConfig: any;
+    typesFolder?: string;
+    deleteTypesFolder?: boolean;
+}
+
+interface RemoteOptions {
+    moduleFederationConfig: any;
+    tsConfigPath?: string;
+    typesFolder?: string;
+    compiledTypesFolder?: string;
+    deleteTypesFolder?: boolean;
+    additionalFilesToCompile?: string[];
+    compilerInstance?: 'tsc' | 'vue-tsc';
+}
+
+export { HostOptions as H, RemoteOptions as R };