@bleedingdev/modern-js-renderer-octane 3.9.3-ultramodern.8 → 3.9.3-ultramodern.9

package/dist/types/worker-federation-contexts.d.ts

@@ -0,0 +1,25 @@
+import type { NativeLocationRewrite } from '@modern-js/renderer-core/router';
+import { type Context, type ExternalSnapshotContextCodec } from 'octane';
+export declare const OCTANE_WORKER_CONTEXT_KEYS: Readonly<{
+    readonly router: 'ultramodern.octane.router-context.v1';
+    readonly match: 'ultramodern.octane.match-context.v1';
+    readonly i18n: 'ultramodern.octane.i18n-context.v1';
+}>;
+type OctaneWorkerContextKey = (typeof OCTANE_WORKER_CONTEXT_KEYS)[keyof typeof OCTANE_WORKER_CONTEXT_KEYS];
+export interface OctaneWorkerContextCodec<T> extends ExternalSnapshotContextCodec<T> {
+    readonly key: OctaneWorkerContextKey;
+    readonly dispose?: (value: T) => void | PromiseLike<void>;
+    readonly isProvided: (value: T) => boolean;
+}
+/** Optional renderer modules register their actual native context identities. */
+export declare function registerOctaneWorkerContext<T>(context: Context<T>, codec: OctaneWorkerContextCodec<T>): () => void;
+/** Read live providers on every render; explicit requirements retain native validation. */
+export declare function useOctaneWorkerContextKeys(explicit?: readonly string[]): readonly string[];
+export interface OctaneWorkerRouterRewrite {
+    readonly capture: (rewrite: NativeLocationRewrite) => unknown;
+    readonly restore: (descriptor: unknown) => NativeLocationRewrite;
+}
+/** The optional i18n owner supplies its own native rewrite provenance. */
+export declare function registerOctaneWorkerRouterRewrite(codec: OctaneWorkerRouterRewrite): () => void;
+export declare function getOctaneWorkerRouterRewrite(): OctaneWorkerRouterRewrite | undefined;
+export {};

package/dist/types/worker-federation.d.ts

@@ -0,0 +1,20 @@
+import type { NativeWorkerDispatchOptions } from '@modern-js/renderer-core/server';
+import { type AdmitWorkerRendererContract, createWorkerFederationHandler } from '@modern-js/renderer-core/worker-federation';
+import { prepareExternalSnapshotRequest } from 'octane/server';
+type NativeSnapshotRequest = Awaited<ReturnType<typeof prepareExternalSnapshotRequest>>;
+type HandlerOptions = Parameters<typeof createWorkerFederationHandler<NativeSnapshotRequest>>[0];
+/** The compiled registry pins its renderer publication and literal imports. */
+export interface OctaneWorkerFederationRegistry {
+    initialize(options: Omit<HandlerOptions, 'publication' | 'exposes'> & {
+        publication: unknown;
+    }): (request: Request) => Promise<Response | undefined>;
+}
+/** Created per dispatch; no publisher or native snapshot cache crosses documents. */
+export declare function createNativeWorkerFederationRuntime<Bindings extends object>(options: NativeWorkerDispatchOptions<Bindings>, compiler: {
+    readonly admitRendererContract: AdmitWorkerRendererContract;
+    readonly registry?: OctaneWorkerFederationRegistry;
+}): {
+    transport: import("@modern-js/renderer-core/worker-federation").WorkerFederationTransport | undefined;
+    handleRequest: (request: Request) => Promise<Response | undefined>;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bleedingdev/modern-js-renderer-octane",
-  "version": "3.9.3-ultramodern.8",
+  "version": "3.9.3-ultramodern.9",
   "description": "UltraModern native Octane application adapter.",
   "license": "MIT",
   "repository": {
@@ -143,7 +143,37 @@
         "default": "./dist/cjs/plugin/index.js"
       }
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./router-external-snapshot": {
+      "import": {
+        "types": "./dist/types/router-external-snapshot.d.ts",
+        "default": "./dist/esm/router-external-snapshot.mjs"
+      },
+      "require": {
+        "types": "./dist/types/router-external-snapshot.d.ts",
+        "default": "./dist/cjs/router-external-snapshot.js"
+      }
+    },
+    "./i18n-external-snapshot": {
+      "import": {
+        "types": "./dist/types/i18n-external-snapshot.d.ts",
+        "default": "./dist/esm/i18n-external-snapshot.mjs"
+      },
+      "require": {
+        "types": "./dist/types/i18n-external-snapshot.d.ts",
+        "default": "./dist/cjs/i18n-external-snapshot.js"
+      }
+    },
+    "./worker-federation-contexts": {
+      "import": {
+        "types": "./dist/types/worker-federation-contexts.d.ts",
+        "default": "./dist/esm/worker-federation-contexts.mjs"
+      },
+      "require": {
+        "types": "./dist/types/worker-federation-contexts.d.ts",
+        "default": "./dist/cjs/worker-federation-contexts.js"
+      }
+    }
   },
   "bin": {
     "octane-tsc": "bin/octane-tsc.mjs"
@@ -152,7 +182,7 @@
     "node": ">=26.12.0"
   },
   "dependencies": {
-    "@modern-js/renderer-core": "npm:@bleedingdev/modern-js-renderer-core@3.9.3-ultramodern.8",
+    "@modern-js/renderer-core": "npm:@bleedingdev/modern-js-renderer-core@3.9.3-ultramodern.9",
     "@volar/language-core": "2.4.28",
     "jsonc-parser": "3.3.1",
     "seroval": "1.6.9",
@@ -160,10 +190,11 @@
     "typescript": "7.0.2"
   },
   "peerDependencies": {
-    "@modern-js/i18n-runtime-extensions": "3.9.3-ultramodern.8",
+    "@modern-js/i18n-runtime-extensions": "3.9.3-ultramodern.9",
     "@octanejs/rspack-plugin": "0.2.4",
     "@octanejs/tanstack-router": "0.2.10",
     "@rsbuild/core": "2.2.13",
+    "@tanstack/router-core": "1.171.38",
     "@tsrx/oxc": "0.20.0",
     "i18next": ">=25.7.4",
     "octane": "0.13.8"
@@ -192,23 +223,52 @@
     }
   },
   "devDependencies": {
-    "@modern-js/i18n-runtime-extensions": "npm:@bleedingdev/modern-js-i18n-runtime-extensions@3.9.3-ultramodern.8",
-    "@modern-js/tsconfig": "npm:@bleedingdev/modern-js-tsconfig@3.9.3-ultramodern.8",
-    "@octanejs/rspack-plugin": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-d5988dd93614/octanejs-rspack-plugin-0.2.4.tgz",
-    "@octanejs/tanstack-router": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-d5988dd93614/octanejs-tanstack-router-0.2.10.tgz",
+    "@modern-js/i18n-runtime-extensions": "npm:@bleedingdev/modern-js-i18n-runtime-extensions@3.9.3-ultramodern.9",
+    "@modern-js/tsconfig": "npm:@bleedingdev/modern-js-tsconfig@3.9.3-ultramodern.9",
+    "@octanejs/rspack-plugin": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-0bf2313bbdfb/octanejs-rspack-plugin-0.2.4.tgz",
+    "@octanejs/tanstack-router": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-0bf2313bbdfb/octanejs-tanstack-router-0.2.10.tgz",
     "@rsbuild/core": "2.2.13",
     "@rslib/core": "1.0.3",
     "@scripts/rstest-config": "2.66.0",
+    "@tanstack/router-core": "https://github.com/BleedingDev/router/releases/download/ultramodern-router-core-585d3233f7f5/tanstack-router-core-1.171.38.tgz",
     "@tsrx/oxc": "0.20.0",
+    "@types/jsdom": "27.0.0",
     "@types/node": "^26.6.5",
     "happy-dom": "^21.0.3",
-    "octane": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-d5988dd93614/octane-0.13.8.tgz",
+    "i18next": "26.4.6",
+    "jsdom": "30.0.1",
+    "octane": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-0bf2313bbdfb/octane-0.13.8.tgz",
     "typescript": "7.0.2"
   },
   "sideEffects": false,
   "publishConfig": {
     "access": "public"
   },
+  "ultramodern": {
+    "nativeArtifacts": {
+      "octane": {
+        "request": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-0bf2313bbdfb/octane-0.13.8.tgz",
+        "version": "0.13.8",
+        "integrity": "sha512-5ReT/LEGpeLyAD1NAObxbcvlaC3yjcF2TNA0ZRT63tnO841r8u66WlSbEdcrQmUnIxl/ECsYrmN5LEampD8Jpg=="
+      },
+      "@octanejs/tanstack-router": {
+        "request": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-0bf2313bbdfb/octanejs-tanstack-router-0.2.10.tgz",
+        "version": "0.2.10",
+        "integrity": "sha512-wdnPhVZSQqZg2DDllUyz4RZufn7I0GEnPKrb/CB21Z8JYKnunAtZn41Dma/+xhg5xvN/USnIg9Eyyf2nbJgxMQ=="
+      },
+      "@octanejs/rspack-plugin": {
+        "request": "https://github.com/BleedingDev/octane/releases/download/ultramodern-octane-0bf2313bbdfb/octanejs-rspack-plugin-0.2.4.tgz",
+        "version": "0.2.4",
+        "integrity": "sha512-I8m/d/oj3Qh8nG5nqkWD90m8qgNwlPK9oNh5tlVvGNdSYCTLddRG7Og8wpYKFAGxe2D+0zOIhYGarC0ZKZgSzw=="
+      },
+      "@tanstack/router-core": {
+        "request": "https://github.com/BleedingDev/router/releases/download/ultramodern-router-core-585d3233f7f5/tanstack-router-core-1.171.38.tgz",
+        "version": "1.171.38",
+        "integrity": "sha512-d/aGvcyEVwDh2Cn9MuZM1n1dqTIqkFYi7AHY2Na/6x/a0jVSDVTNVVVY7QEsuKFXktaJF9zjVwetaRm/0MALZg=="
+      }
+    },
+    "sourceName": "@modern-js/renderer-octane"
+  },
   "scripts": {
     "build": "rslib build && tsc -p tsconfig.types.json",
     "test": "rstest"
@@ -216,8 +276,5 @@
   "homepage": "https://github.com/ultramodernjs/ultramodern.js#readme",
   "bugs": {
     "url": "https://github.com/ultramodernjs/ultramodern.js/issues"
-  },
-  "ultramodern": {
-    "sourceName": "@modern-js/renderer-octane"
   }
 }

package/src/client.ts

@@ -24,6 +24,11 @@ import {
   FederationApplication,
   type OctaneFederationScope,
 } from './federation-context';
+import {
+  type OctaneWorkerFederationFactory,
+  type OctaneWorkerFederationScope,
+  WorkerFederationApplication,
+} from './worker-federation-context';
 
 export type { OctaneDocumentBootstrap } from './bootstrap';
 export { readOctaneDocumentBootstrap } from './bootstrap';
@@ -50,9 +55,14 @@ export interface OctaneApplicationOptions {
   readonly signal?: AbortSignal;
   /** Hydration installs the native signal bridge before invoking this importer. */
   readonly load: () => Promise<OctaneApplicationModule>;
-  readonly options?: Omit<RootOptions, 'signalOwner'>;
+  readonly options?: Omit<RootOptions, 'signalOwner' | 'externalSnapshots'>;
   /** This browser compilation's native Module Federation runtime. */
   readonly federation?: NativeFederationBinding;
+  readonly workerFederation?:
+    | OctaneWorkerFederationScope
+    | OctaneWorkerFederationFactory;
+  /** Trusted document bootstrap identity, also present for a CSR document. */
+  readonly documentId?: string;
 }
 
 export interface OctaneHydrationOptions extends OctaneApplicationOptions {
@@ -296,6 +306,8 @@ function createHandle(input: {
   signal?: AbortSignal;
   onCleanupError?: (error: unknown) => void;
   federation?: OctaneFederationScope;
+  workerFederation?: OctaneWorkerFederationScope;
+  retireWorkerFederation?: () => void;
 }): OctaneApplicationHandle {
   let releaseModule = input.releaseModule;
   let disposed = false;
@@ -310,12 +322,18 @@ function createHandle(input: {
       const nextRelease = claimModuleResources(next);
       releaseModule = nextRelease;
       try {
-        input.federation
-          ? input.root.render(FederationApplication, {
-              scope: input.federation,
+        input.workerFederation
+          ? input.root.render(WorkerFederationApplication, {
+              scope: input.workerFederation,
+              federation: input.federation,
               application: next,
             })
-          : input.root.render(next.default, next.props);
+          : input.federation
+            ? input.root.render(FederationApplication, {
+                scope: input.federation,
+                application: next,
+              })
+            : input.root.render(next.default, next.props);
         previousRelease();
       } catch (error) {
         cleanupResources([previousRelease, () => handle.dispose()]);
@@ -327,6 +345,7 @@ function createHandle(input: {
       disposed = true;
       input.signal?.removeEventListener('abort', onAbort);
       cleanupResources([
+        () => input.retireWorkerFederation?.(),
         () => input.root.unmount(),
         () => releaseModule(),
         () => input.bridge?.dispose(),
@@ -356,6 +375,21 @@ async function startApplication(
   hydration?: { document: Document; documentId: string },
 ): Promise<OctaneApplicationHandle> {
   const errors = observeRootErrors(input.options);
+  const workerController = input.workerFederation
+    ? new AbortController()
+    : undefined;
+  let workerFederation: OctaneWorkerFederationScope | undefined;
+  const retireWorkerFederation = () =>
+    cleanupResources([
+      () =>
+        workerController?.abort(
+          new DOMException(
+            'The Worker federation document was disposed',
+            'AbortError',
+          ),
+        ),
+      () => workerFederation?.transport.dispose(),
+    ]);
   let bridge: StreamedSignalHydration | undefined;
   let root: Root | undefined;
   let releaseModule: (() => void) | undefined;
@@ -369,6 +403,7 @@ async function startApplication(
     if (cleaned) return;
     cleaned = true;
     cleanupResources([
+      retireWorkerFederation,
       () => root?.unmount(),
       () => releaseModule?.(),
       () => bridge?.dispose(),
@@ -376,10 +411,30 @@ async function startApplication(
     ]);
   };
   try {
-    // Capture the selected host before asynchronous application imports.
-    const federation = input.federation
-      ? createFederationScope(input.federation, false)
-      : undefined;
+    if (input.workerFederation && workerController) {
+      const signal = AbortSignal.any([
+        workerController.signal,
+        ...(input.signal ? [input.signal] : []),
+      ]);
+      const scope =
+        typeof input.workerFederation === 'function'
+          ? input.workerFederation(signal)
+          : input.workerFederation;
+      workerFederation = {
+        ...scope,
+        signal: scope.signal ? AbortSignal.any([signal, scope.signal]) : signal,
+      };
+    }
+    if (workerFederation && !hydration && !input.documentId)
+      throw new Error(
+        'Worker federation requires the trusted document identity before application loading',
+      );
+    // Capture the host before imports and retain Worker SSR's provider ranges
+    // even when no regular Module Federation binding is configured.
+    const federation =
+      input.federation || workerFederation
+        ? createFederationScope(input.federation, false)
+        : undefined;
     if (hydration) {
       const { document, documentId } = hydration;
       bridge = bootstrapStreamedSignalHydration({
@@ -402,15 +457,41 @@ async function startApplication(
     if (bridge) {
       root = hydrateRoot(
         input.container,
-        federation ? FederationApplication : application.default,
-        federation ? { scope: federation, application } : application.props,
-        { ...errors.options, signalOwner: bridge.signalOwner },
+        workerFederation
+          ? WorkerFederationApplication
+          : federation
+            ? FederationApplication
+            : application.default,
+        workerFederation
+          ? { scope: workerFederation, federation, application }
+          : federation
+            ? { scope: federation, application }
+            : application.props,
+        {
+          ...errors.options,
+          signalOwner: bridge.signalOwner,
+          externalSnapshots: { documentId: hydration!.documentId },
+        },
       );
     } else {
-      root = createRoot(input.container, errors.options);
-      federation
-        ? root.render(FederationApplication, { scope: federation, application })
-        : root.render(application.default, application.props);
+      root = createRoot(input.container, {
+        ...errors.options,
+        ...(input.documentId
+          ? { externalSnapshots: { documentId: input.documentId } }
+          : {}),
+      });
+      workerFederation
+        ? root.render(WorkerFederationApplication, {
+            scope: workerFederation,
+            federation,
+            application,
+          })
+        : federation
+          ? root.render(FederationApplication, {
+              scope: federation,
+              application,
+            })
+          : root.render(application.default, application.props);
     }
     errors.assertInitialRender();
     input.signal?.throwIfAborted();
@@ -421,6 +502,8 @@ async function startApplication(
       release,
       bridge,
       federation,
+      workerFederation,
+      retireWorkerFederation,
       ...(input.signal === undefined ? {} : { signal: input.signal }),
       onCleanupError: error => reportCleanupError(input, error),
     });

package/src/entry-application.ts

@@ -10,6 +10,7 @@ import {
 import { type ComponentBody, createElement } from 'octane';
 import { I18nProvider } from './i18n/I18nProvider';
 import type { I18nInstanceLike } from './i18n/types';
+import { associateOctaneFileRouteSnapshot } from './router-external-snapshot';
 import {
   createFileSystemRouteTree,
   type FileSystemRouteModule,
@@ -41,8 +42,8 @@ export const octaneRouterFactory: NativeRouterFactory<AnyRoute, AnyRouter> = {
       modules as Readonly<Record<string, FileSystemRouteModule>>,
       options,
     ),
-  router: ({ location, ...options }) =>
-    createRouter({
+  router: ({ location, ...options }) => {
+    const router = createRouter({
       ...options,
       ...(location
         ? {
@@ -50,7 +51,10 @@ export const octaneRouterFactory: NativeRouterFactory<AnyRoute, AnyRouter> = {
             history: createMemoryHistory({ initialEntries: [location.href] }),
           }
         : {}),
-    }),
+    });
+    associateOctaneFileRouteSnapshot(router);
+    return router;
+  },
 };
 
 interface LocalizedRouterProps {

package/src/entry-client.ts

@@ -21,11 +21,18 @@ import {
   OctaneRouterRoot,
   prepareOctaneRouterHydration,
 } from './router-client';
+import type {
+  OctaneWorkerFederationFactory,
+  OctaneWorkerFederationScope,
+} from './worker-federation-context';
 
 export interface OctaneClientEntryOptions
   extends NativeClientEntryOptions<NativeI18nInstance, LocalisedUrlsOption> {
   /** The native client compilation hash, `__webpack_hash__`. */
   readonly nativeHydrationBuildId: string;
+  readonly workerFederation?:
+    | OctaneWorkerFederationScope
+    | OctaneWorkerFederationFactory;
 }
 
 const LocalizedRouterRoot = localizedRouterRoot(OctaneRouterRoot);
@@ -38,6 +45,7 @@ export function startNativeClient(options: OctaneClientEntryOptions): void {
       readOctaneDocumentBootstrap(document, identity, nativeHydrationBuildId),
     createRouter: (application, routerOptions) =>
       createNativeRouter(application, routerOptions, octaneRouterFactory),
+    disposeRouter: router => router.history.destroy(),
     async prepareRouter(router, hydrating, signal) {
       // Hydration adopts the server's matches; a fresh mount loads its own.
       if (hydrating) await prepareOctaneRouterHydration(router, { signal });
@@ -49,6 +57,8 @@ export function startNativeClient(options: OctaneClientEntryOptions): void {
         identity,
         nativeHydrationBuildId,
         federation: options.federation,
+        workerFederation: options.workerFederation,
+        documentId: bootstrap?.documentId,
         signal,
         // Hydration installs the native signal bridge before this importer runs.
         load: async (): Promise<OctaneApplicationModule> => {

package/src/entry-server.ts

@@ -52,10 +52,12 @@ export function withOctaneDocumentFields(
     : policy;
 }
 
-export type OctaneServerEntryOptions = NativeServerEntryOptions<
-  NativeI18nInstance,
-  LocalisedUrlsOption
->;
+export { createNativeWorkerFederationRuntime } from './worker-federation';
+
+export interface OctaneServerEntryOptions
+  extends NativeServerEntryOptions<NativeI18nInstance, LocalisedUrlsOption> {
+  readonly workerFederationLocale?: string;
+}
 
 const LocalizedRouterServer = localizedRouterRoot(OctaneRouterServer);
 
@@ -77,16 +79,23 @@ export function createNativeServerEntry(
       createNativeRouter(application, routerOptions, octaneRouterFactory),
     renderCSR: ({ session }, document) =>
       renderOctaneCSRDocument({ session, document }),
-    renderComponent: ({ session }, component, document, i18n) =>
+    renderComponent: (
+      { session, workerFederation },
+      component,
+      document,
+      i18n,
+    ) =>
       renderOctaneApplication({
         session,
         App: componentView(component, i18n) as ServerRenderNode,
         document,
         federation: options.federation,
+        workerFederation,
+        workerFederationLocale: options.workerFederationLocale,
       }),
     async renderRoutes({
       request,
-      context: { session },
+      context: { session, workerFederation },
       router,
       outcomes,
       document,
@@ -127,6 +136,8 @@ export function createNativeServerEntry(
               }),
           document,
           federation: options.federation,
+          workerFederation,
+          workerFederationLocale: options.workerFederationLocale,
           router,
         });
         return createSsrStreamResponse(router, rendered);