feat: add remote-versions plugin

README-ru.md

@@ -459,6 +459,43 @@ interface UikitPluginOptions {
 }
 ```
 
+### Remote Versions
+
+Добавляет информацию о версиях микрофронтендов на страницу.
+
+Этот плагин создает глобальный объект `window.__REMOTE_VERSIONS__`, содержащий указанные версии микрофронтендов, который может использоваться module federation или аналогичными архитектурами микрофронтендов для определения того, какие версии удаленных модулей загружать.
+
+Он может использоваться в связке с [App Builder](https://github.com/gravity-ui/app-builder?tab=readme-ov-file#module-federation) и опцией `moduleFederation.remotesRuntimeVersioning` для автоматической загрузки удаленных модулей с соответствующими версиями.
+
+Использование:
+
+```js
+import {createRenderFunction, createRemoteVersionsPlugin} from '@gravity-ui/app-layout';
+
+const renderLayout = createRenderFunction([createRemoteVersionsPlugin()]);
+
+app.get((req, res) => {
+  res.send(
+    renderLayout({
+      title: 'Home page',
+      pluginsOptions: {
+        remoteVersions: {
+          header: '1.2.3',
+          footer: '2.1.0',
+          sidebar: '0.5.1',
+        },
+      },
+    }),
+  );
+});
+```
+
+Параметры плагина:
+
+```typescript
+type RemoteVersionsPluginOptions = Record<string, string>;
+```
+
 ### Утилиты
 
 Для создания плагинов используется предустановленная утилита:

README.md

@@ -459,6 +459,43 @@ interface UikitPluginOptions {
 }
 ```
 
+### Remote Versions
+
+Adds microfrontend versions information to the page.
+
+This plugin creates a global `window.__REMOTE_VERSIONS__` object containing the provided microfrontend versions, which can be used by module federation or similar microfrontend architectures to determine which versions of remote modules to load.
+
+It can be used in combination with [App Builder](https://github.com/gravity-ui/app-builder?tab=readme-ov-file#module-federation) and the `moduleFederation.remotesRuntimeVersioning` option to automatically load remote modules with the corresponding versions.
+
+Usage:
+
+```js
+import {createRenderFunction, createRemoteVersionsPlugin} from '@gravity-ui/app-layout';
+
+const renderLayout = createRenderFunction([createRemoteVersionsPlugin()]);
+
+app.get((req, res) => {
+  res.send(
+    renderLayout({
+      title: 'Home page',
+      pluginsOptions: {
+        remoteVersions: {
+          header: '1.2.3',
+          footer: '2.1.0',
+          sidebar: '0.5.1',
+        },
+      },
+    }),
+  );
+});
+```
+
+Plugin options:
+
+```typescript
+type RemoteVersionsPluginOptions = Record<string, string>;
+```
+
 ### Helpers
 
 There is helper to create all plugins:

src/index.ts

@@ -7,6 +7,7 @@ export {
     createYandexMetrikaPlugin,
     createLayoutPlugin,
     createUikitPlugin,
+    createRemoteVersionsPlugin,
     createDefaultPlugins,
 } from './plugins/index.js';
 
@@ -33,3 +34,4 @@ export type {
 } from './plugins/google-analytics/index.js';
 export type {LayoutPluginOptions, Manifest, LayoutInitOptions} from './plugins/layout/index.js';
 export type {UikitPluginOptions} from './plugins/uikit/index.js';
+export type {RemoteVersionsPluginOptions} from './plugins/remote-versions/index.js';

src/plugins/index.ts

@@ -1,6 +1,7 @@
 import {createGoogleAnalyticsPlugin} from './google-analytics/index.js';
 import {createLayoutPlugin} from './layout/index.js';
 import type {LayoutInitOptions} from './layout/index.js';
+import {createRemoteVersionsPlugin} from './remote-versions/index.js';
 import {createUikitPlugin} from './uikit/index.js';
 import {createYandexMetrikaPlugin} from './yandex-metrika/index.js';
 
@@ -18,4 +19,5 @@ export {
     createYandexMetrikaPlugin,
     createLayoutPlugin,
     createUikitPlugin,
+    createRemoteVersionsPlugin,
 };

src/plugins/remote-versions/index.ts

@@ -0,0 +1,25 @@
+import htmlescape from 'htmlescape';
+
+import type {Plugin} from '../../types.js';
+
+import type {RemoteVersionsPluginOptions} from './types.js';
+
+export type {RemoteVersionsPluginOptions} from './types.js';
+
+export function createRemoteVersionsPlugin(): Plugin<
+    RemoteVersionsPluginOptions,
+    'remoteVersions'
+> {
+    return {
+        name: 'remoteVersions',
+        apply({options: versions, renderContent}) {
+            if (!versions) {
+                return;
+            }
+
+            renderContent.inlineScripts.push(
+                `window.__REMOTE_VERSIONS__ = ${htmlescape(versions)};`,
+            );
+        },
+    };
+}

src/plugins/remote-versions/types.ts

@@ -0,0 +1 @@
+export type RemoteVersionsPluginOptions = Record<string, string>;