@module-federation/utilities NPM

3.1.21 • Published 7 months ago

Install

Weekly downloads

License

MIT

Repository

github

Last release

7 months ago

utils

For warning： @module-federation/runtime is recommended as a replacement

This library was generated with Nx.

Building

Run nx build utils to build the library.

Running unit tests

Run nx test utils to execute the unit tests via Jest.

React utilities

FederatedBoundary

A component wrapper that provides a fallback for safe imports if something were to fail when grabbing a module off of a remote host.

This wrapper also exposes an optional property for a custom react error boundary component.

Any extra props will be passed directly to the imported module.

Usage looks something like this:

import { FederationBoundary } from '@module-federation/utilities/src/utils/react';

// defining dynamicImport and fallback outside the Component to keep the component identity
// another alternative would be to use useMemo
const dynamicImport = () => import('some_remote_host_name').then((m) => m.Component);
const fallback = () => import('@npm/backup').then((m) => m.Component);

const MyPage = () => {
  return <FederationBoundary dynamicImporter={dynamicImport} fallback={fallback} customBoundary={CustomErrorBoundary} />;
};

ImportRemote

A function which will enable dynamic imports of remotely exposed modules using the Module Federation plugin. It uses the method described in the official Webpack configuration under Dynamic Remote Containers.

This function will allow you to provide a static url or an async method to retrieve a url from a configuration service.

Usage looks something like this:

import { importRemote } from '@module-federation/utilities';

// --
// If it's a regular js module:
// --
importRemote({
  url: 'http://localhost:3001',
  scope: 'Foo',
  module: 'Bar',
}).then(
  (
    {
      /* list of Bar exports */
    },
  ) => {
    // Use Bar exports
  },
);

// --
// If it's a ESM module (this is currently the default for NX):
// --
const Bar = lazy(() => importRemote({ url: 'http://localhost:3001', scope: 'Foo', module: 'Bar', esm: true }));

return (
  <Suspense fallback={<div>Loading Bar...</div>}>
    <Bar />
  </Suspense>
);

// --
// If Bar is a React component you can use it with lazy and Suspense just like a dynamic import:
// --
const Bar = lazy(() => importRemote({ url: 'http://localhost:3001', scope: 'Foo', module: 'Bar' }));

return (
  <Suspense fallback={<div>Loading Bar...</div>}>
    <Bar />
  </Suspense>
);

import { importRemote } from '@module-federation/utilities';

// If it's a regular js module:
importRemote({
  url: () => MyAsyncMethod('remote_name'),
  scope: 'Foo',
  module: 'Bar',
}).then(
  (
    {
      /* list of Bar exports */
    },
  ) => {
    // Use Bar exports
  },
);

// If Bar is a React component you can use it with lazy and Suspense just like a dynamic import:
const Bar = lazy(() =>
  importRemote({
    url: () => MyAsyncMethod('remote_name'),
    scope: 'Foo',
    module: 'Bar',
  }),
);

return (
  <Suspense fallback={<div>Loading Bar...</div>}>
    <Bar />
  </Suspense>
);

// You can also combine importRemote and FederationBoundary to have a dynamic remote URL and a fallback when there is an error on the remote

const dynamicImporter = () =>
  importRemote({
    url: 'http://localhost:3001',
    scope: 'Foo',
    module: 'Bar',
  });
const fallback = () => import('@npm/backup').then((m) => m.Component);

const Bar = () => {
  return <FederationBoundary dynamicImporter={dynamicImporter} fallback={fallback} />;
};

Apart from url, scope and module you can also pass additional options to the importRemote() function:

remoteEntryFileName: The name of the remote entry file. Defaults to "remoteEntry.js".
bustRemoteEntryCache: Whether to add a cache busting query parameter to the remote entry file URL. Defaults to true. You can disable it if cachebusting is handled by the server.

@module-federation/sdk

0.0.0-next-20241101074502

8 months ago

0.0.0-next-20241101093646

8 months ago

3.1.21

7 months ago

0.0.0-next-20241029093536

8 months ago

0.0.0-next-20241029083753

8 months ago

0.0.0-next-20241029032646

8 months ago

0.0.0-next-20241029065803

8 months ago

0.0.0-next-20241030095049

8 months ago

3.1.20

8 months ago

0.0.0-next-20241030074135

8 months ago

0.0.0-next-20241025122930

8 months ago

3.1.19

8 months ago

3.1.18

8 months ago

0.0.0-next-20241018073518

8 months ago

0.0.0-next-20241021083129

8 months ago

0.0.0-next-20241018073700

8 months ago

0.0.0-next-20241017090853

8 months ago

0.0.0-next-20241017102355

8 months ago

0.0.0-next-20241018034826

8 months ago

0.0.0-next-20241018034800

8 months ago

0.0.0-next-20241021084851

8 months ago

0.0.0-next-20241016082124

8 months ago

0.0.0-next-20241016071233

8 months ago

0.0.0-next-20241016083243

8 months ago

0.0.0-next-20241016062654

8 months ago

3.1.17

8 months ago

0.0.0-next-20241015065721

8 months ago

0.0.0-next-20241015060033

8 months ago

0.0.0-next-20241014085010

8 months ago

0.0.0-next-20241014092946

8 months ago

0.0.0-next-20240930063850

9 months ago

0.0.0-next-20241010040057

8 months ago

0.0.0-next-20241009075733

8 months ago

0.0.0-next-20241010084324

8 months ago

0.0.0-next-20240927195332

9 months ago

0.0.0-next-20241009081924

8 months ago

0.0.0-next-20241002194835

8 months ago

0.0.0-next-20241011105718

8 months ago

0.0.0-next-20241010031731

8 months ago

0.0.0-next-20241008081103

8 months ago

0.0.0-next-20241011070539

8 months ago

0.0.0-next-20241010063233

8 months ago

0.0.0-next-20241010035127

8 months ago

0.0.0-next-20240927010732

9 months ago

0.0.0-next-20240930091801

9 months ago

0.0.0-next-20241008193232

8 months ago

0.0.0-next-20240927065748

9 months ago

0.0.0-next-20241009084741

8 months ago

0.0.0-next-20240927185728

9 months ago

0.0.0-next-20241009072306

8 months ago

9 months ago

9 months ago

8 months ago

8 months ago

0.0.0-next-20241010034200

8 months ago

0.0.0-next-20241009093433

8 months ago

0.0.0-next-20241008193502

8 months ago

0.0.0-next-20240924091419

9 months ago

0.0.0-next-20240924012324

9 months ago

0.0.0-next-20240924022552

9 months ago

0.0.0-next-20240923073245

9 months ago

0.0.0-next-20240922002332

9 months ago

0.0.0-next-20240923065315

9 months ago

0.0.0-next-20240923071822

9 months ago

0.0.0-next-20240923034121

9 months ago

0.0.0-next-20240919100820

9 months ago

0.0.0-next-20240919023345

9 months ago

0.0.0-next-20240920074009

9 months ago

0.0.0-next-20240918080432

9 months ago

0.0.0-next-20240920075140

9 months ago

0.0.0-next-20240920040817

9 months ago

0.0.0-next-20240919075108

9 months ago

3.1.12

9 months ago

3.1.11

9 months ago

0.0.0-next-20240918073359

9 months ago

0.0.0-next-20240918063302

9 months ago

3.1.10

9 months ago

0.0.0-next-20240913095223

9 months ago

0.0.0-next-20240913094943

9 months ago

0.0.0-next-20240913081127

9 months ago

0.0.0-next-20240912023912

9 months ago

0.0.0-next-20240912070754

9 months ago

0.0.0-next-20240911084000

9 months ago

3.1.9

9 months ago

3.1.8

9 months ago

0.0.0-next-20240911062555

9 months ago

0.0.0-next-20240911063502

9 months ago

0.0.0-next-20240911095451

9 months ago

0.0.0-next-20240911035732

9 months ago

0.0.0-next-20240911074627

9 months ago

0.0.0-next-20240911025819

9 months ago

0.0.0-next-20240911083839

9 months ago

0.0.0-next-20240911025149

9 months ago

0.0.0-next-20240911090730

9 months ago

0.0.0-next-20240910102933

9 months ago

0.0.0-next-20240909083238

9 months ago

0.0.0-next-20240909073915

9 months ago

0.0.0-next-20240909092952

9 months ago

0.0.0-next-20240909101028

9 months ago

0.0.0-next-20240909062831

9 months ago

0.0.0-next-20240905215027

9 months ago

3.1.7

9 months ago

0.0.0-next-20240905014927

9 months ago

0.0.0-next-20240905092248

9 months ago

0.0.0-next-20240905200018

9 months ago

0.0.0-next-20240905232541

9 months ago

0.0.0-next-20240905093149

9 months ago

0.0.0-next-20240906012942

9 months ago

0.0.0-next-20240904030559

9 months ago

0.0.0-next-20240903212627

9 months ago

0.0.0-next-20240903075658

9 months ago

0.0.0-next-20240903063427

9 months ago

0.0.0-next-20240709105243

11 months ago

0.0.0-next-20240718035404

11 months ago

0.0.0-next-20240824225724

10 months ago

0.0.0-next-20240528093255

1 year ago

0.0.0-next-20240822101913

10 months ago

0.0.0-next-20240523085338

1 year ago

0.0.0-next-20240617070818

12 months ago

0.0.0-next-20240604074900

1 year ago

0.0.0-next-20240709063914

11 months ago

0.0.0-next-20240523121007

1 year ago

0.0.0-next-20240822035014

10 months ago

0.0.0-next-20240709071547

11 months ago

0.0.0-next-20240620034636

12 months ago

3.1.3

10 months ago

0.0.0-next-20240812084439

10 months ago

3.1.2

10 months ago

3.1.1

10 months ago

3.1.0

10 months ago

0.0.0-next-20240830062908

10 months ago

3.1.6

10 months ago

3.1.5

10 months ago

3.1.4

10 months ago

0.0.0-next-20240716093738

11 months ago

0.0.0-next-20240617093923

12 months ago

0.0.0-next-20240624115757

12 months ago

0.0.0-next-20240731105745

11 months ago

0.0.0-next-20240528100448

1 year ago

0.0.0-next-20240623084034

12 months ago

0.0.0-next-20240718035334

11 months ago

0.0.0-next-20240707072703

11 months ago

0.0.0-next-20240723065243

11 months ago

0.0.0-next-20240619032406

12 months ago

0.0.0-next-20240712032032

11 months ago

0.0.0-next-20240815094326

10 months ago

0.0.0-next-20240806095108

10 months ago

0.0.0-next-20240707094936

11 months ago

0.0.0-next-20240603071955

1 year ago

0.0.0-next-20240716104220

11 months ago

0.0.0-next-20240718080108

11 months ago

0.0.0-next-20240604070618

1 year ago

0.0.0-next-20240725035430

11 months ago

0.0.0-next-20240617024822

12 months ago

0.0.0-next-20240822063818

10 months ago

0.0.0-next-20240722034500

11 months ago

0.0.0-next-20240718061842

11 months ago

0.0.0-next-20240621075348

12 months ago

0.0.0-next-20240814085621

10 months ago

0.0.0-next-20240702090143

12 months ago

0.0.0-next-20240718040714

11 months ago

0.0.0-next-20240613022740

1 year ago

0.0.0-next-20240611070359

1 year ago

0.0.0-next-20240716034052

11 months ago

0.0.0-next-20240816102736

10 months ago

0.0.0-next-20240806034033

10 months ago

0.0.0-next-20240819031127

10 months ago

0.0.0-next-20240801085730

11 months ago

0.0.0-next-20240619084459

12 months ago

0.0.0-next-20240819022441

10 months ago

0.0.0-next-20240723095610

11 months ago

0.0.0-next-20240603142704

1 year ago

0.0.0-next-20240603062522

1 year ago

0.0.0-next-20240830100524

10 months ago

0.0.0-next-20240723033044

11 months ago

0.0.0-next-20240605092134

1 year ago

0.0.0-next-20240716130450

11 months ago

0.0.0-next-20240826081819

10 months ago

0.0.0-next-20240826075118

10 months ago

0.0.0-next-20240708090519

11 months ago

0.0.0-next-20240718063946

11 months ago

0.0.0-next-20240524034417

1 year ago

0.0.0-next-20240718072411

11 months ago

0.0.0-next-20240902075042

10 months ago

0.0.0-next-20240524010758

1 year ago

0.0.0-next-20240529032552

1 year ago

0.0.0-next-20240524213250

1 year ago

0.0.0-next-20240704115613

11 months ago

0.0.0-next-20240822090000

10 months ago

0.0.0-next-20240902023803

10 months ago

0.0.0-next-20240523224941

1 year ago

0.0.0-next-20240724103050

11 months ago

0.0.0-next-20240528083134

1 year ago

0.0.0-next-20240807100721

10 months ago

0.0.0-next-20240701101956

12 months ago

0.0.0-next-20240603152750

1 year ago

0.0.0-next-20240620052430

12 months ago

0.0.0-next-20240812114132

10 months ago

0.0.0-next-20240604033816

1 year ago

0.0.0-next-20240821075411

10 months ago

0.0.0-next-20240524225331

1 year ago

0.0.0-next-20240619100937

12 months ago

0.0.0-next-20240818132231

10 months ago

0.0.0-next-20240620075423

12 months ago

0.0.0-next-20240605100049

1 year ago

0.0.0-next-20240808030043

10 months ago

0.0.0-next-20240819112150

10 months ago

0.0.0-next-20240605083609

1 year ago

0.0.0-next-20240722031635

11 months ago

0.0.0-next-20240830065016

10 months ago

0.0.0-next-20240814082511

10 months ago

0.0.0-next-20240829065118

10 months ago

0.0.0-next-20240529015908

1 year ago

0.0.0-next-20240529231449

1 year ago

0.0.0-next-20240619030922

12 months ago

0.0.0-next-20240625070454

12 months ago

0.0.0-next-20240822032403

10 months ago

0.0.0-next-20240707075106

11 months ago

0.0.0-next-20240619092117

12 months ago

0.0.0-next-20240808065005

10 months ago

0.0.0-next-20240612203225

1 year ago

0.0.0-next-20240731082143

11 months ago

0.0.0-next-20240726084328

11 months ago

0.0.0-next-20240701075157

12 months ago

0.0.0-next-20240821090741

10 months ago

0.0.0-next-20240523225730

1 year ago

0.0.0-next-20240715061004

11 months ago

0.0.0-next-20240604020453

1 year ago

0.0.0-next-20240613063612

1 year ago

0.0.0-next-20240620115801

12 months ago

0.0.0-next-20240808024406

10 months ago

0.0.0-next-20240716133146

11 months ago

0.0.0-next-20240813065037

10 months ago

0.0.0-next-20240603101010

1 year ago

0.0.0-next-20240621074837

12 months ago

0.0.0-next-20240617071032

12 months ago

0.0.0-next-20240725054734

11 months ago

0.0.0-next-20240605063149

1 year ago

0.0.0-next-20240823062237

10 months ago

0.0.0-next-20240605063144

1 year ago

0.0.0-next-20240529103203

1 year ago

0.0.0-next-20240710093701

11 months ago

0.0.0-next-20240625025206

12 months ago

0.0.0-next-20240619092013

12 months ago

0.0.0-next-20240620023927

12 months ago

0.0.0-next-20240816090839

10 months ago

0.0.0-next-20240814104132

10 months ago

0.0.0-next-20240604044444

1 year ago

0.0.0-next-20240718033511

11 months ago

0.0.0-next-20240620090145

12 months ago

0.0.0-next-20240715065227

11 months ago

0.0.0-next-20240530085615

1 year ago

0.0.0-next-20240715111849

11 months ago

0.0.0-next-20240617084909

12 months ago

0.0.0-next-20240816084239

10 months ago

0.0.0-next-20240603143448

1 year ago

0.0.0-next-20240815093707

10 months ago

0.0.0-next-20240620060503

12 months ago

0.0.0-next-20240819040425

10 months ago

0.0.0-next-20240528115713

1 year ago

0.0.0-next-20240523235135

1 year ago

0.0.0-next-20240807111348

10 months ago

0.0.0-next-20240704021704

12 months ago

0.0.0-next-20240620124309

12 months ago

0.0.0-next-20240524042957

1 year ago

0.0.0-next-20240726075341

11 months ago

0.0.0-next-20240716111139

11 months ago

0.0.0-next-20240617071542

12 months ago

0.0.0-next-20240530073428

1 year ago

0.0.0-next-20240617032137

12 months ago

0.0.0-next-20240626050252

12 months ago

0.0.0-next-20240820034939

10 months ago

0.0.0-next-20240808083234

10 months ago

0.0.0-next-20240814073142

10 months ago

0.0.0-next-20240523080317

1 year ago

3.0.23

1 year ago

3.0.24

1 year ago

0.0.0-next-20240611032623

1 year ago

0.0.0-next-20240528203231

1 year ago

1 year ago

1 year ago

12 months ago

12 months ago

12 months ago

12 months ago

0.0.0-next-20240827062238

10 months ago

0.0.0-next-20240717101902

11 months ago

0.0.0-next-20240710061150

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

0.0.0-next-20240808084345

10 months ago

0.0.0-next-20240725030707

11 months ago

3.0.31

11 months ago

0.0.0-next-20240619091441

12 months ago

0.0.0-next-20240725061440

11 months ago

0.0.0-next-20240529095100

1 year ago

3.0.29

12 months ago

0.0.0-next-20240524231356

1 year ago

0.0.0-next-20240520072517

1 year ago

0.0.0-next-20240520131203

1 year ago

0.0.0-next-20240521125425

1 year ago

0.0.0-next-20240520135817

1 year ago

0.0.0-next-20240520082758

1 year ago

0.0.0-next-20240520083840

1 year ago

0.0.0-next-20240520094942

1 year ago

0.0.0-next-20240521035527

1 year ago

0.0.0-next-20240520135154

1 year ago

0.0.0-next-20240521071511

1 year ago

3.0.20

1 year ago

0.0.0-next-20240520070201

1 year ago

3.0.19

1 year ago

0.0.0-next-20240521123600

1 year ago

0.0.0-next-20240519120858

1 year ago

0.0.0-next-20240519072927

1 year ago

0.0.0-next-20240516030852

1 year ago

0.0.0-next-20240516090436

1 year ago

0.0.0-next-20240516132020

1 year ago

0.0.0-next-20240516132001

1 year ago

0.0.0-next-20240516124658

1 year ago

0.0.0-next-20240516123215

1 year ago

0.0.0-next-20240516123450

1 year ago

0.0.0-next-20240516035452

1 year ago

0.0.0-next-20240515104620

1 year ago

0.0.0-next-20240515091026

1 year ago

0.0.0-next-20240515113919

1 year ago

0.0.0-next-20240515125630

1 year ago

0.0.0-next-20240515062211

1 year ago

3.0.18

1 year ago

0.0.0-next-20240514062402

1 year ago

0.0.0-next-20240511023318

1 year ago

0.0.0-next-20240511031741

1 year ago

0.0.0-next-20240510094642

1 year ago

0.0.0-next-20240508024041

1 year ago

3.0.17

1 year ago

0.0.0-next-20240504082822

1 year ago

3.0.16

1 year ago

0.0.0-next-20240429033452

1 year ago

0.0.0-next-20240429010049

1 year ago

0.0.0-next-20240428095629

1 year ago

0.0.0-next-20240428094837

1 year ago

0.0.0-next-20240426220915

1 year ago

3.0.15

1 year ago

0.0.0-next-20240425094203

1 year ago

0.0.0-next-20240425095041

1 year ago

0.0.0-next-20240424224724

1 year ago

0.0.0-next-20240425091022

1 year ago

0.0.0-next-20240425010938

1 year ago

0.0.0-next-20240425095630

1 year ago

0.0.0-next-20240423035511

1 year ago

3.0.14

1 year ago

0.0.0-next-20240422222512

1 year ago

0.0.0-next-20240422214156

1 year ago

0.0.0-next-20240422225306

1 year ago

3.0.13

1 year ago

0.0.0-next-20240419054235

1 year ago

0.0.0-next-20240419222037

1 year ago

0.0.0-next-20240419064104

1 year ago

0.0.0-next-20240419034211

1 year ago

0.0.0-next-20240419203425

1 year ago

0.0.0-next-20240418220407

1 year ago

0.0.0-next-20240418224727

1 year ago

3.0.12

1 year ago

0.0.0-next-20240417205114

1 year ago

0.0.0-next-20240415222600

1 year ago

0.0.0-next-20240415101817

1 year ago

3.0.10

1 year ago

3.0.11

1 year ago

0.0.0-next-20240415100944

1 year ago

0.0.0-next-20240415102546

1 year ago

0.0.0-next-20240412182228

1 year ago

0.0.0-next-20240412180247

1 year ago

0.0.0-next-20240412103714

1 year ago

0.0.0-next-20240412091739

1 year ago

3.0.9

1 year ago

0.0.0-next-20240411115459

1 year ago

0.0.0-next-20240411081414

1 year ago

0.0.0-next-20240411125344

1 year ago

0.0.0-next-20240409202851

1 year ago

0.0.0-next-20240408215115

1 year ago

0.0.0-next-20240409025309

1 year ago

0.0.0-next-20240409213838

1 year ago

0.0.0-next-20240408213752

1 year ago

3.0.8

1 year ago

0.0.0-next-20240409191512

1 year ago

0.0.0-next-20240408040658

1 year ago

0.0.0-next-20240404165651

1 year ago

0.0.0-next-20240404164914

1 year ago

0.0.0-next-20240403162201

1 year ago

0.0.0-next-20240401122911

1 year ago

0.0.0-next-20240402071000

1 year ago

0.0.0-next-20240403002421

1 year ago

3.0.7

1 year ago

0.0.0-next-20240402191904

1 year ago

0.0.0-next-20240306224838

1 year ago

0.0.0-next-20240401084119

1 year ago

0.0.0-next-20240401073754

1 year ago

0.0.0-next-20240305014149

1 year ago

3.0.6

1 year ago

0.0.0-next-20240305014714

1 year ago

0.0.0-next-20240301081856

1 year ago

0.0.0-next-20240301034824

1 year ago

0.0.0-next-20240301023125

1 year ago

0.0.0-next-20240228024935

1 year ago

0.0.0-next-20240228024304

1 year ago

3.0.5

1 year ago

0.0.0-feat-node-support-1703050615268

1 year ago

0.0.0-feat-node-support-1702930274548

1 year ago

3.0.4

1 year ago

0.0.0-feat-node-support-1702694175668

1 year ago

0.0.0-feat-node-support-1702696727089

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago