@bleedingdev/modern-js-app-tools 3.8.2-ultramodern.11 → 3.8.2-ultramodern.12

package/dist/types/presetUltramodern.d.ts

@@ -40,14 +40,18 @@ export interface PresetUltramodernOptions {
     /**
      * OTLP exporter endpoint. Setting it (or the environment variable)
      * enables the OTLP exporter unless `enableTelemetryExporters` is `false`.
-     * @default process.env.MODERN_TELEMETRY_OTLP_ENDPOINT || 'http://127.0.0.1:4318/v1/logs'
+     * The localhost endpoint is used only when exporters are forced on with
+     * `enableTelemetryExporters: true` and no endpoint was provided.
+     * @default process.env.MODERN_TELEMETRY_OTLP_ENDPOINT
      */
     otlpEndpoint?: string;
     /**
      * VictoriaMetrics exporter endpoint. Setting it (or the environment
      * variable) enables the VictoriaMetrics exporter unless
      * `enableTelemetryExporters` is `false`.
-     * @default process.env.MODERN_TELEMETRY_VICTORIA_ENDPOINT || 'http://127.0.0.1:8428/api/v1/import/prometheus'
+     * The localhost endpoint is used only when exporters are forced on with
+     * `enableTelemetryExporters: true` and no endpoint was provided.
+     * @default process.env.MODERN_TELEMETRY_VICTORIA_ENDPOINT
      */
     victoriaMetricsEndpoint?: string;
     /**
@@ -62,5 +66,21 @@ export interface PresetUltramodernOptions {
      */
     enableModuleFederationSSR?: boolean;
 }
+/**
+ * Materialize a fresh UltraModern preset config.
+ *
+ * This is the advanced inspection API. Use `presetUltramodern` when composing
+ * an application config so nested records, arrays, and hooks keep the normal
+ * Modern.js merge behavior.
+ */
 export declare const createPresetUltramodernConfig: (options?: PresetUltramodernOptions) => AppUserConfig;
+/**
+ * Compose an application config over the UltraModern preset.
+ *
+ * The application config is merged after the preset. Nested records are
+ * preserved, scalar values and `false` override preset values, and omitted or
+ * `undefined` values keep the preset value. Arrays and hooks compose in
+ * preset-first order. An empty record does not reset nested preset defaults;
+ * use the typed `PresetUltramodernOptions` opt-outs instead.
+ */
 export declare const presetUltramodern: (config: AppUserConfig, options?: PresetUltramodernOptions) => AppUserConfig;

package/docs/guides/get-started/ultramodern.md

@@ -250,6 +250,94 @@ directories, and caches are isolated per app, build target, and Rspack
 environment so local `build`, `cloudflare:build`, and multi-environment
 compilers do not share mutable build state.
 
+## Configure the public preset
+
+Use `presetUltramodern(appConfig, presetOptions)` inside the normal Modern.js
+`defineConfig` call:
+
+```ts title="modern.config.ts"
+import { defineConfig, presetUltramodern } from '@modern-js/app-tools';
+
+export default defineConfig(
+  presetUltramodern(
+    {
+      output: {
+        precompress: false,
+      },
+      server: {
+        telemetry: {
+          failLoudStartup: true,
+        },
+      },
+    },
+    {
+      appId: 'catalog',
+      enableModuleFederationSSR: false,
+      enableTelemetryExporters: false,
+    },
+  ),
+);
+```
+
+The first argument is ordinary `AppUserConfig`. It contains app-owned config
+and wins where it supplies an override. The second argument controls the
+preset itself. Use its typed options, such as `enableBffRequestId: false`,
+`enableTelemetry: false`, `enableTelemetryExporters: false`, and
+`enableModuleFederationSSR: false`, to turn preset features off.
+
+Composition follows the Modern.js config merge rules:
+
+- Nested records merge, so changing one nested field keeps its preset
+  siblings.
+- Scalars and `false` supplied by the app override preset values. Omitting a
+  field, or leaving it `undefined`, keeps the preset value.
+- Arrays and config hooks compose in preset-first order. Non-function array
+  entries are deduplicated by deep equality, while function entries are all
+  retained. An empty array or empty record does not clear values already
+  supplied by the preset.
+
+There is no generic reset sentinel. Use a typed preset option for preset-owned
+behavior and a normal app config override for app-owned behavior.
+
+`createPresetUltramodernConfig(options)` is an advanced API for inspecting or
+materializing a fresh preset config. Do not spread its result into another
+config object. Object spread is shallow, so replacing `server`, `output`, or
+another nested record can silently discard preset siblings. Use
+`presetUltramodern(...)` for authoring `modern.config.ts`.
+
+### Bare preset and generated workspace policy
+
+The preset and the workspace generator own different parts of the config:
+
+| Source                                        | Identity                                                     | Remaining config                                                                                            |
+| --------------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
+| Bare `createPresetUltramodernConfig()` result | Uses `appId: 'app'` and has no `deliveryUnit`                | Uses the preset defaults. Telemetry stays enabled, but no exporter is configured until its endpoint is set. |
+| Generated app                                 | Supplies the app-specific `appId` and stamped `deliveryUnit` | Inherits the other strict defaults from `presetUltramodern(...)`.                                           |
+| Application                                   | Supplies the first `appConfig` argument                      | Overrides app-owned fields through the normal Modern.js merge.                                              |
+
+Keep the generated `appId` and `deliveryUnit` options intact. To change
+preset-owned behavior, use typed options such as
+`enableTelemetryExporters: false`,
+`enableTelemetry: false`, `enableBffRequestId: false`, or
+`enableModuleFederationSSR: false`. To change an app-owned field, put the
+override in the first argument, as in the example above.
+
+Telemetry exporter endpoints are unset by default:
+
+- `MODERN_TELEMETRY_OTLP_ENDPOINT` enables only the OTLP exporter.
+- `MODERN_TELEMETRY_VICTORIA_ENDPOINT` enables only the VictoriaMetrics
+  exporter.
+- Setting both enables both. Leaving both unset keeps the telemetry pipeline
+  enabled without configuring an exporter.
+
+The typed `otlpEndpoint` and `victoriaMetricsEndpoint` preset options provide
+the same per-exporter behavior without environment variables.
+
+```bash
+MODERN_TELEMETRY_OTLP_ENDPOINT=https://otel.example.com/v1/logs \
+  mise exec -- pnpm dev
+```
+
 ## Human Workflow
 
 The public BleedingDev create package has one supported generated product. The
@@ -428,18 +516,6 @@ BleedingDev packages are published through GitHub Actions trusted publishing.
 The public workflow is tokenless; do not publish packages manually from a
 developer machine.
 
-## Baseline Switches (Opt-out)
-
-The generated `presetUltramodern(...)` starter enables strict platform contracts. Use these env switches to opt out per app or per environment:
-
-- `MODERN_BASELINE_ENABLE_MF_SSR` (default: `true`): Enables app-level MF SSR baseline contract (`server.ssr.mode: 'stream'` + `moduleFederationAppSSR`). Disable when the app does not use app-level MF SSR, or when you need plain SSR/CSR behavior first.
-- `MODERN_BASELINE_ENABLE_BFF_REQUEST_ID` (default: `true`): Enables default BFF producer identity contract (`bff.requestId`). Disable when the app does not need cross-project producer isolation.
-- `MODERN_BASELINE_ENABLE_TELEMETRY_EXPORTERS` (default: `true`): Enables telemetry exporters in baseline config. Disable when the environment has no telemetry backend yet.
-- `MODERN_BASELINE_APP_ID` (default: `basename(process.cwd())`): Overrides baseline `bff.requestId` identity. Set this when you need a fixed platform-wide producer ID convention.
-- `MODERN_TELEMETRY_OTLP_ENDPOINT` (default: `http://127.0.0.1:4318/v1/logs`): OTLP exporter endpoint. Override when you route telemetry through a different collector endpoint.
-- `MODERN_TELEMETRY_VICTORIA_ENDPOINT` (default: `http://127.0.0.1:8428/api/v1/import/prometheus`): VictoriaMetrics exporter endpoint. Override when you use a different VM ingress endpoint.
-- `MODERN_TELEMETRY_FAIL_LOUD_STARTUP` (default: `true`): Fails startup if configured exporters fail startup health checks. Disable in local/dev environments where temporary telemetry outage should not block boot.
-
 ## Related Docs
 
 - [BFF Runtime Frameworks](/guides/advanced-features/bff/frameworks.md)

package/package.json

@@ -17,7 +17,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "3.8.2-ultramodern.11",
+  "version": "3.8.2-ultramodern.12",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
   "exports": {
@@ -134,16 +134,16 @@
     "@babel/traverse": "^8.0.0",
     "@babel/types": "^8.0.0",
     "@loadable/component": "5.16.7",
-    "@modern-js/builder": "npm:@bleedingdev/modern-js-builder@3.8.2-ultramodern.11",
-    "@modern-js/i18n-utils": "npm:@bleedingdev/modern-js-i18n-utils@3.8.2-ultramodern.11",
-    "@modern-js/plugin": "npm:@bleedingdev/modern-js-plugin@3.8.2-ultramodern.11",
-    "@modern-js/plugin-data-loader": "npm:@bleedingdev/modern-js-plugin-data-loader@3.8.2-ultramodern.11",
-    "@modern-js/prod-server": "npm:@bleedingdev/modern-js-prod-server@3.8.2-ultramodern.11",
-    "@modern-js/server": "npm:@bleedingdev/modern-js-server@3.8.2-ultramodern.11",
-    "@modern-js/server-core": "npm:@bleedingdev/modern-js-server-core@3.8.2-ultramodern.11",
-    "@modern-js/server-utils": "npm:@bleedingdev/modern-js-server-utils@3.8.2-ultramodern.11",
-    "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.8.2-ultramodern.11",
-    "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.8.2-ultramodern.11",
+    "@modern-js/builder": "npm:@bleedingdev/modern-js-builder@3.8.2-ultramodern.12",
+    "@modern-js/i18n-utils": "npm:@bleedingdev/modern-js-i18n-utils@3.8.2-ultramodern.12",
+    "@modern-js/plugin": "npm:@bleedingdev/modern-js-plugin@3.8.2-ultramodern.12",
+    "@modern-js/plugin-data-loader": "npm:@bleedingdev/modern-js-plugin-data-loader@3.8.2-ultramodern.12",
+    "@modern-js/prod-server": "npm:@bleedingdev/modern-js-prod-server@3.8.2-ultramodern.12",
+    "@modern-js/server": "npm:@bleedingdev/modern-js-server@3.8.2-ultramodern.12",
+    "@modern-js/server-core": "npm:@bleedingdev/modern-js-server-core@3.8.2-ultramodern.12",
+    "@modern-js/server-utils": "npm:@bleedingdev/modern-js-server-utils@3.8.2-ultramodern.12",
+    "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.8.2-ultramodern.12",
+    "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.8.2-ultramodern.12",
     "@rsbuild/core": "2.2.0-rc.0",
     "@swc/core": "1.15.43",
     "@swc/helpers": "^0.5.23",