mfeflow 0.0.0-stage → 0.1.0

package/dist/commands/doctor.d.ts

@@ -0,0 +1,141 @@
+import type { ReportResult } from '../output.js';
+import type { Runtime } from '../runtime.js';
+export declare const DOCTOR_ARGS: {
+    readonly yes: {
+        readonly type: 'boolean';
+        readonly alias: 'y';
+        readonly description: 'Take the defaults and never prompt';
+    };
+    readonly preset: {
+        readonly type: 'string';
+        readonly description: 'Replay options from a JSON file or an https URL';
+        readonly valueHint: 'file|url';
+    };
+    readonly json: {
+        readonly type: 'boolean';
+        readonly description: 'Print one JSON document on stdout, nothing else';
+    };
+    readonly 'dry-run': {
+        readonly type: 'boolean';
+        readonly description: 'Print the summary and diff, write nothing';
+    };
+    readonly cwd: {
+        readonly type: 'string';
+        readonly description: 'Run as if started in this folder';
+        readonly valueHint: 'dir';
+    };
+    readonly install: {
+        readonly type: 'boolean';
+        readonly default: true;
+        readonly description: 'Run the package manager after writing (--no-install to skip)';
+    };
+    readonly verbose: {
+        readonly type: 'boolean';
+        readonly description: 'Show package manager output and stack traces';
+    };
+    readonly local: {
+        readonly type: 'string';
+        readonly description: 'Link @mfeflow/* from a built mfeflow checkout (env MFEFLOW_LOCAL)';
+        readonly valueHint: 'path';
+    };
+    readonly help: {
+        readonly type: 'boolean';
+        readonly alias: 'h';
+        readonly description: 'Show this help';
+    };
+    readonly fix: {
+        readonly type: 'boolean';
+        readonly description: 'Repair what is safe: missing workspace versions and registry entries';
+    };
+};
+export declare const VALIDATE_ARGS: {
+    readonly yes: {
+        readonly type: 'boolean';
+        readonly alias: 'y';
+        readonly description: 'Take the defaults and never prompt';
+    };
+    readonly preset: {
+        readonly type: 'string';
+        readonly description: 'Replay options from a JSON file or an https URL';
+        readonly valueHint: 'file|url';
+    };
+    readonly json: {
+        readonly type: 'boolean';
+        readonly description: 'Print one JSON document on stdout, nothing else';
+    };
+    readonly 'dry-run': {
+        readonly type: 'boolean';
+        readonly description: 'Print the summary and diff, write nothing';
+    };
+    readonly cwd: {
+        readonly type: 'string';
+        readonly description: 'Run as if started in this folder';
+        readonly valueHint: 'dir';
+    };
+    readonly install: {
+        readonly type: 'boolean';
+        readonly default: true;
+        readonly description: 'Run the package manager after writing (--no-install to skip)';
+    };
+    readonly verbose: {
+        readonly type: 'boolean';
+        readonly description: 'Show package manager output and stack traces';
+    };
+    readonly local: {
+        readonly type: 'string';
+        readonly description: 'Link @mfeflow/* from a built mfeflow checkout (env MFEFLOW_LOCAL)';
+        readonly valueHint: 'path';
+    };
+    readonly help: {
+        readonly type: 'boolean';
+        readonly alias: 'h';
+        readonly description: 'Show this help';
+    };
+};
+export declare const COMPAT_ARGS: {
+    readonly yes: {
+        readonly type: 'boolean';
+        readonly alias: 'y';
+        readonly description: 'Take the defaults and never prompt';
+    };
+    readonly preset: {
+        readonly type: 'string';
+        readonly description: 'Replay options from a JSON file or an https URL';
+        readonly valueHint: 'file|url';
+    };
+    readonly json: {
+        readonly type: 'boolean';
+        readonly description: 'Print one JSON document on stdout, nothing else';
+    };
+    readonly 'dry-run': {
+        readonly type: 'boolean';
+        readonly description: 'Print the summary and diff, write nothing';
+    };
+    readonly cwd: {
+        readonly type: 'string';
+        readonly description: 'Run as if started in this folder';
+        readonly valueHint: 'dir';
+    };
+    readonly install: {
+        readonly type: 'boolean';
+        readonly default: true;
+        readonly description: 'Run the package manager after writing (--no-install to skip)';
+    };
+    readonly verbose: {
+        readonly type: 'boolean';
+        readonly description: 'Show package manager output and stack traces';
+    };
+    readonly local: {
+        readonly type: 'string';
+        readonly description: 'Link @mfeflow/* from a built mfeflow checkout (env MFEFLOW_LOCAL)';
+        readonly valueHint: 'path';
+    };
+    readonly help: {
+        readonly type: 'boolean';
+        readonly alias: 'h';
+        readonly description: 'Show this help';
+    };
+};
+export declare function runDoctor(rt: Runtime, args: Record<string, unknown>, raw: readonly string[]): Promise<ReportResult>;
+export declare function runValidate(rt: Runtime, args: Record<string, unknown>, raw: readonly string[]): Promise<ReportResult>;
+export declare function runCheckCompat(rt: Runtime, args: Record<string, unknown>, raw: readonly string[]): Promise<ReportResult>;

package/dist/commands/env-key.d.ts

@@ -0,0 +1,4 @@
+import { type Globals } from '../args.js';
+import { type AddResult } from '../output.js';
+import type { Runtime } from '../runtime.js';
+export declare function addEnvKey(rt: Runtime, globals: Globals, args: Record<string, unknown>, key: string | undefined): Promise<AddResult>;

package/dist/commands/features.d.ts

@@ -0,0 +1,53 @@
+import type { FeatureInfo, FeaturesResult } from '../output.js';
+import type { Runtime } from '../runtime.js';
+export declare const FEATURES_ARGS: {
+    readonly yes: {
+        readonly type: 'boolean';
+        readonly alias: 'y';
+        readonly description: 'Take the defaults and never prompt';
+    };
+    readonly preset: {
+        readonly type: 'string';
+        readonly description: 'Replay options from a JSON file or an https URL';
+        readonly valueHint: 'file|url';
+    };
+    readonly json: {
+        readonly type: 'boolean';
+        readonly description: 'Print one JSON document on stdout, nothing else';
+    };
+    readonly 'dry-run': {
+        readonly type: 'boolean';
+        readonly description: 'Print the summary and diff, write nothing';
+    };
+    readonly cwd: {
+        readonly type: 'string';
+        readonly description: 'Run as if started in this folder';
+        readonly valueHint: 'dir';
+    };
+    readonly install: {
+        readonly type: 'boolean';
+        readonly default: true;
+        readonly description: 'Run the package manager after writing (--no-install to skip)';
+    };
+    readonly verbose: {
+        readonly type: 'boolean';
+        readonly description: 'Show package manager output and stack traces';
+    };
+    readonly local: {
+        readonly type: 'string';
+        readonly description: 'Link @mfeflow/* from a built mfeflow checkout (env MFEFLOW_LOCAL)';
+        readonly valueHint: 'path';
+    };
+    readonly help: {
+        readonly type: 'boolean';
+        readonly alias: 'h';
+        readonly description: 'Show this help';
+    };
+    readonly search: {
+        readonly type: 'positional';
+        readonly required: false;
+        readonly description: 'Only features whose name or description contains this';
+    };
+};
+export declare function matches(feature: FeatureInfo, search: string): boolean;
+export declare function runFeatures(rt: Runtime, args: Record<string, unknown>, raw: readonly string[]): Promise<FeaturesResult>;

package/dist/commands/init.d.ts

@@ -0,0 +1,102 @@
+import { type MfeflowProject } from '@mfeflow/core';
+import { type Globals } from '../args.js';
+import { type FeatureOptions } from '../options.js';
+import { type InitResult } from '../output.js';
+import { type Preset } from '../preset.js';
+import type { Runtime } from '../runtime.js';
+export declare const INIT_ARGS: {
+    readonly yes: {
+        readonly type: 'boolean';
+        readonly alias: 'y';
+        readonly description: 'Take the defaults and never prompt';
+    };
+    readonly preset: {
+        readonly type: 'string';
+        readonly description: 'Replay options from a JSON file or an https URL';
+        readonly valueHint: 'file|url';
+    };
+    readonly json: {
+        readonly type: 'boolean';
+        readonly description: 'Print one JSON document on stdout, nothing else';
+    };
+    readonly 'dry-run': {
+        readonly type: 'boolean';
+        readonly description: 'Print the summary and diff, write nothing';
+    };
+    readonly cwd: {
+        readonly type: 'string';
+        readonly description: 'Run as if started in this folder';
+        readonly valueHint: 'dir';
+    };
+    readonly install: {
+        readonly type: 'boolean';
+        readonly default: true;
+        readonly description: 'Run the package manager after writing (--no-install to skip)';
+    };
+    readonly verbose: {
+        readonly type: 'boolean';
+        readonly description: 'Show package manager output and stack traces';
+    };
+    readonly local: {
+        readonly type: 'string';
+        readonly description: 'Link @mfeflow/* from a built mfeflow checkout (env MFEFLOW_LOCAL)';
+        readonly valueHint: 'path';
+    };
+    readonly help: {
+        readonly type: 'boolean';
+        readonly alias: 'h';
+        readonly description: 'Show this help';
+    };
+    readonly dir: {
+        readonly type: 'positional';
+        readonly required: false;
+        readonly description: 'Folder to create (default mfeflow-app)';
+    };
+    readonly scope: {
+        readonly type: 'string';
+        readonly description: 'npm scope for the project packages, like @my-org';
+        readonly valueHint: '@scope';
+    };
+    readonly remotes: {
+        readonly type: 'string';
+        readonly description: 'Remotes to create, comma separated (default catalog,cart)';
+        readonly valueHint: 'a,b';
+    };
+    readonly features: {
+        readonly type: 'string';
+        readonly description: `Optional features, comma separated (${string})`;
+        readonly valueHint: 'a,b';
+    };
+    readonly 'package-manager': {
+        readonly type: 'string';
+        readonly description: 'pnpm (the only one in this release)';
+        readonly valueHint: 'pm';
+    };
+    readonly topology: {
+        readonly type: 'string';
+        readonly description: 'monorepo (the only one in this release)';
+        readonly valueHint: 'name';
+    };
+    readonly option: {
+        readonly type: 'string';
+        readonly description: 'A feature option, repeatable: --option feature.key=value';
+        readonly valueHint: 'f.k=v';
+    };
+};
+export interface InitOptions {
+    dir: string;
+    scope: string;
+    remotes: string[];
+    features: string[];
+    featureOptions: FeatureOptions;
+}
+/** `@` plus the folder name made safe for an npm scope. */
+export declare function scopeFor(dir: string, cwd?: string): string;
+export declare function checkRemotes(remotes: readonly string[]): void;
+/** The optional features to install, validated and in catalogue order. */
+export declare function checkFeatures(requested: readonly string[]): string[];
+/** Flags win over the preset, the preset over prompts, prompts over defaults. */
+export declare function resolveInitOptions(rt: Runtime, globals: Globals, args: Record<string, unknown>, raw: readonly string[], preset: Preset): Promise<InitOptions>;
+export declare function assertEmpty(root: string, readdir?: (dir: string) => Promise<string[]>): Promise<void>;
+export declare function skeleton(options: InitOptions): MfeflowProject;
+export declare function runInit(rt: Runtime, args: Record<string, unknown>, raw: readonly string[]): Promise<InitResult>;

package/dist/devregistry.d.ts

@@ -0,0 +1,19 @@
+import type { ProjectView } from './inspect.js';
+export interface DevRemote {
+    name: string;
+    entry: string;
+    version: string;
+}
+export interface DevIndex {
+    remotes: DevRemote[];
+}
+/** `name=url` flags as a map. A bare origin means its `/mf-manifest.json`. */
+export declare function parseOverrides(flags: readonly string[], remotes: readonly string[]): Map<string, string>;
+/** Throws E107 for an override outside localhost that `--allow-origin` did not name. */
+export declare function assertAllowed(overrides: ReadonlyMap<string, string>, allowed: readonly string[]): void;
+/**
+ * What the shell reads in dev: every remote of mfeflow.json, from registry/envs/dev when it has an
+ * entry (else from the remote's own port), with `overrides` replacing the entry URL.
+ */
+export declare function devIndex(view: ProjectView, overrides?: ReadonlyMap<string, string>): DevIndex;
+export declare const serializeIndex: (index: DevIndex) => string;

package/dist/exit.d.ts

@@ -0,0 +1,31 @@
+import { type MfeflowError } from '@mfeflow/core';
+/** Stable exit codes. Scripts can branch on them; changing one is a breaking change. */
+export declare const EXIT: {
+    readonly ok: 0;
+    readonly unexpected: 1;
+    readonly usage: 2;
+    readonly project: 3;
+    readonly feature: 4;
+    readonly build: 5;
+    readonly registry: 6;
+    readonly upgrade: 7;
+    readonly cancelled: 130;
+};
+/** Raised when the user backs out of a prompt. */
+export declare class Cancelled extends Error {
+    constructor();
+}
+/** The exit code of a catalogue code such as `MFEFLOW_E301`. */
+export declare function exitCodeOfCode(code: string): number;
+export declare function exitCodeFor(error: unknown): number;
+export interface ErrorReport {
+    code: string;
+    message: string;
+    fix: string;
+    docs: string;
+}
+export declare function reportOf(error: MfeflowError): ErrorReport;
+/** What `--json` reports for an error that is no MfeflowError: a bug, so no code from the catalogue. */
+export declare function unexpectedReport(error: unknown): ErrorReport;
+/** What an unexpected (non-mfeflow) error prints: the message, and the stack with --verbose. */
+export declare function unexpectedText(error: unknown, verbose: boolean): string;

package/dist/findings.d.ts

@@ -0,0 +1,35 @@
+import { type ErrorCode } from '@mfeflow/core';
+import type { ProjectView } from './inspect.js';
+export type Severity = 'error' | 'warning';
+export interface Finding {
+    code: string;
+    severity: Severity;
+    /** The check that found it, like `config.ports`. */
+    check: string;
+    message: string;
+    fix: string;
+    docs: string;
+    app?: string;
+    path?: string;
+    /** `doctor --fix` can repair it. */
+    fixable: boolean;
+}
+export interface FindingOptions {
+    severity?: Severity;
+    app?: string;
+    path?: string;
+    fixable?: boolean;
+}
+/** A finding carrying the catalogue's code, message, fix and docs link. */
+export declare function finding(check: string, code: ErrorCode, detail: string, options?: FindingOptions): Finding;
+export interface CheckOutcome {
+    findings: Finding[];
+    /** Why the check did not run. */
+    skipped?: string;
+}
+export interface Check {
+    id: string;
+    title: string;
+    run(view: ProjectView): Promise<CheckOutcome>;
+}
+export declare const done: (findings: Finding[]) => Promise<CheckOutcome>;

package/dist/glue.d.ts

@@ -0,0 +1,41 @@
+import { type LoadedFeature, type MfeflowProject } from '@mfeflow/core';
+import type { AssetRoots } from './assets.js';
+export declare const SHELL_PORT = 4300;
+export declare const REMOTE_PORT = 4311;
+export declare function assertAppName(name: string, apps?: MfeflowProject['apps']): void;
+/** The first free port from `start` upwards. */
+export declare function freePort(project: Pick<MfeflowProject, 'apps'>, start: number): number;
+export declare function routeComponent(remote: string): string;
+export declare const REGISTRY_ENVS: readonly ['dev', 'staging', 'prod'];
+export interface RemoteSpec {
+    name: string;
+    port: number;
+}
+export interface GlueOptions {
+    roots: AssetRoots;
+    /** Version of the `core` feature, so the plan records what generated these files. */
+    version: string;
+    remote: RemoteSpec;
+    /** Write `registry/envs/<env>/<name>.json`. */
+    registry: boolean;
+    /** Apps (a shell name, or "shell" for every shell) that get a route to the remote. */
+    shells: readonly string[];
+}
+export interface RegistryEntryFile {
+    path: string;
+    content: string;
+}
+/** `registry/envs/<env>/<name>.json` for dev, staging and prod: dev points at the remote's dev server. */
+export declare function registryEntryFiles(roots: AssetRoots, remote: RemoteSpec, envs?: readonly string[]): Promise<RegistryEntryFile[]>;
+/**
+ * The parts of adding a remote that belong to no single app: its registry
+ * entries, and a route in each shell. Returned as a feature so the engine
+ * applies it like any other, with the same checks and the same plan.
+ */
+export declare function remoteGlue(options: GlueOptions): Promise<LoadedFeature>;
+/**
+ * The parts of `feature` that target `from` (`shell` or `remotes`), retargeted
+ * at one app, so a new app gets what every existing one of its kind got.
+ * Undefined when the feature has nothing for that kind.
+ */
+export declare function partsForApp(feature: LoadedFeature, from: 'shell' | 'remotes', app: string): LoadedFeature | undefined;

package/dist/help.d.ts

@@ -0,0 +1,12 @@
+import type { ArgsDef } from 'citty';
+export declare const REPO_URL = "https://github.com/mfeflow/mfeflow";
+export interface CommandHelp {
+    name: string;
+    summary: string;
+    usage: string;
+    args: ArgsDef;
+    examples: readonly string[];
+}
+export declare function commandHelp(help: CommandHelp): string;
+export declare function exitCodesText(): string;
+export declare function rootHelp(commands: readonly CommandHelp[]): string;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { main } from './cli.js';
+export { COMMANDS } from './cli.js';
+export { EXIT, exitCodeFor } from './exit.js';
+export { validateResult } from './output.js';
+export type { AddResult, BudgetResult, DevResult, CliResult, FailureResult, FeatureInfo, FeaturesResult, InitResult, PlanReport, ReportResult, } from './output.js';
+export { realRuntime, type Runtime } from './runtime.js';
+export type { Io } from './io.js';
+export type { Prompter } from './prompter.js';