# @ringcentral/mfe-service-worker

> A micro frontends framework for building Web applications

Latest version **0.5.1** (published 2026-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ringcentral/mfe-service-worker
pnpm add @ringcentral/mfe-service-worker
yarn add @ringcentral/mfe-service-worker
bun add @ringcentral/mfe-service-worker
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2026-09-17 |
| First published | 2024-03-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 127.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 14 |
| Author | RingCentral |
| Maintainers | kirill.konshin, tylerlong, conner.kang, lizhengdesign |
| Keywords | Micro Frontends |

## Links

- npm: https://www.npmjs.com/package/@ringcentral/mfe-service-worker
- Repository: https://github.com/ringcentral/ringcentral-mfe
- Homepage: https://github.com/ringcentral/ringcentral-mfe#readme
- Issues: https://github.com/ringcentral/ringcentral-mfe/issues
- npm.io page: https://npm.io/package/@ringcentral/mfe-service-worker

## Dependencies (4)

- [crypto](https://npm.io/package/crypto.md) ^1.0.1
- [ts-md5](https://npm.io/package/ts-md5.md) 1.3.1
- [workbox-window](https://npm.io/package/workbox-window.md) 6.5.4
- [@ringcentral/mfe-shared](https://npm.io/package/@ringcentral/mfe-shared.md) ^0.5.1

## Recent versions

- 0.5.1 (latest) — 2026-09-17
- 0.5.0 — 2026-08-28
- 0.4.21 — 2026-06-04
- 0.4.20 — 2026-04-16
- 0.4.19 — 2026-04-16
- 0.4.18 — 2025-08-18
- 0.4.17 — 2025-05-14
- 0.4.16 — 2025-05-08
- 0.4.15 — 2025-04-28
- 0.4.14 — 2025-04-25
- 0.4.13 — 2025-04-25
- 0.4.12 — 2025-04-21
- 0.4.11 — 2025-04-03
- 0.4.10 — 2025-03-31
- 0.4.9 — 2025-03-26
- … 22 more at https://npm.io/package/@ringcentral/mfe-service-worker/versions

## README

# @ringcentral/mfe-service-worker

![Node CI](https://github.com/ringcentral/ringcentral-mfe/workflows/Node%20CI/badge.svg)

A micro frontends framework for building Web applications

## Usage

```bash
npm install @ringcentral/mfe-service-worker
# or
yarn add @ringcentral/mfe-service-worker
```

You can visit [https://github.com/ringcentral/ringcentral-mfe](https://github.com/ringcentral/ringcentral-mfe) for more documentation.

1. init service worker

```ts
importScripts('/public-path/service-worker.mfe.js');

const subAppServiceWorkerManager = new mfe.SubAppServiceWorkerManager();

subAppServiceWorkerManager.listener();
```

2. register service worker

```ts
import mfe from '@ringcentral/mfe-service-worker';

await navigator.serviceWorker.register('/service-worker.js').then((res) => {
  console.log('[MAIN] register success');
});

// receive prefixes parmas which will match request path, if matched, will
// return cache file
mfe
  .registerSubApp({
    name: 'phone',
    scope: 'https://app.ringcentral.com/mfe/platform/23.2.10/',
    version: '0.0.1',
    manifestRelativePath: 'precache-manifest',
  })
  .then(() => {
    console.log('phone register success');
  });
```

3. add webpack plugin

```ts
import { GenerateManifestWebpackPlugin } from '@ringcentral/mfe-service-worker/generate-manifest-webpack-plugin';
{
    plugin: [
      new GenerateManifestWebpackPlugin();
    ]
}
```

---
_Source: https://npm.io/package/@ringcentral/mfe-service-worker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._