@mfeflow/core 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -11,7 +11,7 @@ export { realFs, symlinkedPrefix, writeFileAtomic, type FsOps } from './fs.js';
 export { findDiverged, findProjectRoot, loadProject, parseProject, PROJECT_FILE, recordPlan, saveProject, serializeProject, type DivergedFile, type MfeflowProject, } from './project.js';
 export { emptyPlan, PlanBuilder, renderDiff, summarize, type ChangeAction, type DependencyAdd, type EnvKeyAdd, type FileChange, type Plan, type PlanBuilderOptions, type PlanFeature, type ReadFile, type ScriptAdd, } from './plan.js';
 export { applyPlan, type ApplyOptions, type ApplyResult, type InstallContext, type InstallStep, } from './apply.js';
-export { detectBaseline, planUpgrade, type DivergedUpgrade, type DivergeReason, type Migration, type UpgradeDecisions, type UpgradeInput, type UpgradePlan, } from './upgrade.js';
+export { detectBaseline, isEnvKeyFile, planUpgrade, recordEnvKey, type DivergedUpgrade, type DivergeReason, type Migration, type UpgradeDecisions, type UpgradeInput, type UpgradePlan, } from './upgrade.js';
 export { renderTemplate, substitute, type TemplateData } from './templates.js';
 export { RUNTIME_CONFIG_FILE, runtimeConfigFiles } from './runtime-config.js';
 export { applyTransform, dotenvKeys, schemaKeys, type SchemaKey } from './transforms/index.js';

package/dist/index.js

@@ -448,6 +448,10 @@ function serializeProject(project) {
     const { $schema, ...rest } = project;
     const files = rest.files && Object.fromEntries(Object.entries(rest.files).toSorted(byKey));
     const kept = rest.kept && Object.fromEntries(Object.entries(rest.kept).toSorted(byKey));
+    const envKeys = rest.envKeys && Object.fromEntries(Object.entries(rest.envKeys).toSorted(byKey).map(([file, keys])=>[
+            file,
+            keys.toSorted((a, b)=>a < b ? -1 : a > b ? 1 : 0)
+        ]));
     const ordered = {
         $schema: $schema ?? SCHEMA_URLS.project,
         ...rest,
@@ -456,6 +460,9 @@ function serializeProject(project) {
         } : {},
         ...kept ? {
             kept
+        } : {},
+        ...envKeys ? {
+            envKeys
         } : {}
     };
     return `${JSON.stringify(ordered, null, 2)}\n`;
@@ -2190,8 +2197,15 @@ async function resolveFeature(input) {
     for (const needed of manifest.requires ?? [])if (!present.has(needed)) throw new MfeflowError('E206', `${manifest.name} needs ${needed}`);
     const options = resolveOptions(manifest, input.options);
     if ('tailwind' === manifest.name) assertUniqueTailwindPrefixes(Object.keys(project.apps));
+    const apps = Object.entries(project.apps).map(([name, app])=>({
+            name,
+            kind: app.kind,
+            path: app.path,
+            port: app.port
+        }));
     const dataFor = (place)=>({
             scope: project.scope,
+            apps,
             topology: project.topology,
             packageManager: project.packageManager,
             options,
@@ -2290,6 +2304,24 @@ const OWN_CLI = 'mfeflow';
 const PLACEHOLDER_RANGE = 'latest';
 const USER_DATA = /^registry\/envs\//;
 const ENV_KEY_FILES = /(^|\/)(env\.ts|src\/config\/schema\.ts|runtime-config(\.[^/]+)?\.json|\.env[^/]*)$/;
+const isEnvKeyFile = (file)=>ENV_KEY_FILES.test(file);
+function recordEnvKey(project, files, key) {
+    const touched = files.filter(isEnvKeyFile);
+    if (0 === touched.length) return project;
+    const envKeys = {
+        ...project.envKeys
+    };
+    for (const file of touched)envKeys[file] = [
+        ...new Set([
+            ...envKeys[file] ?? [],
+            key
+        ])
+    ].toSorted(byCodePoint);
+    return {
+        ...project,
+        envKeys
+    };
+}
 const KEEP_RANGE = /^(workspace|link|file|portal):/;
 const byCodePoint = (a, b)=>a < b ? -1 : a > b ? 1 : 0;
 const isOwn = (name)=>name === OWN_CLI || name.startsWith(OWN_PREFIX);
@@ -2481,7 +2513,7 @@ function lostKeys(file, disk, incoming) {
 }
 const writes = (verdict)=>'create' === verdict || 'replace' === verdict || 'missing' !== verdict && 'matching' !== verdict && 'leave' !== verdict && 'symlink' !== verdict;
 function judge(file, disk, incoming, state) {
-    const { recorded, kept, anySkipped } = state;
+    const { recorded, kept, anySkipped, envKeys = [] } = state;
     if (void 0 === disk) {
         if (void 0 !== recorded) return 'missing';
         return USER_DATA.test(file) ? 'leave' : 'create';
@@ -2495,6 +2527,7 @@ function judge(file, disk, incoming, state) {
     if (ENV_KEY_FILES.test(file)) {
         const lost = lostKeys(file, disk, incoming);
         if (void 0 === lost || lost.missing.length > 0) return 'edited-by-cli';
+        if (lost.changed.some((key)=>envKeys.includes(key))) return 'edited-by-cli';
     }
     return anySkipped ? 'skipped-feature' : 'replace';
 }
@@ -2519,7 +2552,10 @@ async function compareFiles(project, fresh, read, builder, options) {
             ...project.kept?.[file] === void 0 ? {} : {
                 kept: project.kept[file]
             },
-            anySkipped: options.anySkipped
+            anySkipped: options.anySkipped,
+            ...project.envKeys?.[file] === void 0 ? {} : {
+                envKeys: project.envKeys[file]
+            }
         });
         if (writes(verdict) && await options.isSymlink?.(file)) verdict = 'symlink';
         if ('missing' === verdict) out.missing.push(file);
@@ -4494,4 +4530,4 @@ function packageInfo() {
         version
     };
 }
-export { APP_FILE, ERROR_CATALOGUE, LEGACY_APP_FILE, MfeflowError, PROJECT_FILE, PlanBuilder, RUNTIME_CONFIG_FILE, TRUST_ENV, addTrusted, applyPlan, applyTransform, buildRegistry, checkIntegrity, configDirOf, detectBaseline, detectFederation, dotenvKeys, emptyPlan, fetchFeatureIndex, fetchRemoteText, findDiverged, findProjectRoot, getHttps, hasErrno, hashContent, inOrder, indexedVersion, integrityOf, isMfeflowError, isProtectedPath, legacyAppFileNotice, listLocalFeatures, loadFeature, loadProject, messageOf, packageInfo, parseFeature, parseProject, parseTrustEnv, planAdoption, planUpgrade, readAppFile, readCappedText, readTrusted, realFs, recordPlan, registryUrl, removeTrusted, renderDiff, renderTemplate, resolveFeature, resolveOptions, runtimeConfigFiles, saveProject, schemaKeys, serializeProject, substitute, summarize, symlinkedPrefix, trustFileIn, trustedNamespaces, writeFileAtomic };
+export { APP_FILE, ERROR_CATALOGUE, LEGACY_APP_FILE, MfeflowError, PROJECT_FILE, PlanBuilder, RUNTIME_CONFIG_FILE, TRUST_ENV, addTrusted, applyPlan, applyTransform, buildRegistry, checkIntegrity, configDirOf, detectBaseline, detectFederation, dotenvKeys, emptyPlan, fetchFeatureIndex, fetchRemoteText, findDiverged, findProjectRoot, getHttps, hasErrno, hashContent, inOrder, indexedVersion, integrityOf, isEnvKeyFile, isMfeflowError, isProtectedPath, legacyAppFileNotice, listLocalFeatures, loadFeature, loadProject, messageOf, packageInfo, parseFeature, parseProject, parseTrustEnv, planAdoption, planUpgrade, readAppFile, readCappedText, readTrusted, realFs, recordEnvKey, recordPlan, registryUrl, removeTrusted, renderDiff, renderTemplate, resolveFeature, resolveOptions, runtimeConfigFiles, saveProject, schemaKeys, serializeProject, substitute, summarize, symlinkedPrefix, trustFileIn, trustedNamespaces, writeFileAtomic };

package/dist/upgrade.d.ts

@@ -87,6 +87,13 @@ export interface UpgradePlan {
     /** Files the old version generated that you deleted. They are not brought back. */
     missing: string[];
 }
+/** Whether `mfeflow add env-key` may have edited this file. */
+export declare const isEnvKeyFile: (file: string) => boolean;
+/**
+ * `project` with `key` recorded under each of `files` that `add env-key` edits, so `upgrade` can
+ * ask before a new template changes its value. Files that are not env files are ignored.
+ */
+export declare function recordEnvKey(project: MfeflowProject, files: readonly string[], key: string): MfeflowProject;
 /**
  * The version of the CLI that made the project: `cli` in `mfeflow.json`, else the lowest version
  * the shell's `@mfeflow/runtime` range allows (0.1 projects have no `cli`). A `workspace:`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mfeflow/core",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "The engine behind the mfeflow CLI: project model, change plans with diffs, atomic apply with rollback, and feature resolution.",
   "keywords": [
     "micro-frontend",
@@ -45,7 +45,7 @@
   "dependencies": {
     "@babel/parser": "8.0.10",
     "@babel/types": "8.0.10",
-    "@mfeflow/contracts": "0.6.0",
+    "@mfeflow/contracts": "0.7.0",
     "diff": "9.0.0",
     "eta": "4.6.0",
     "semver": "7.8.5",