@ng-doc/builder 22.0.0-beta.2 → 22.1.0

package/generator/bootstrap/candidate-output-committer.d.ts

@@ -0,0 +1,12 @@
+import { type OutputCommitterOptions } from '../artifacts/index.js';
+import type { OutputCommitter, PublishedGeneratorConfiguration } from '../contracts.js';
+export type CandidateOutputCommitterOptions = Omit<OutputCommitterOptions, 'outputRoot'>;
+/** Process-local host policy; this callback is never part of a worker DTO. */
+export interface CandidateOutputCommitterHostOptions {
+    admitConfiguration?: (configuration: Readonly<PublishedGeneratorConfiguration>) => void;
+}
+/**
+ * Selects the transactional output root from the first committed candidate.
+ * Later root/watcher-identity changes require a new session before any mutation.
+ */
+export declare function createCandidateOutputCommitter(options?: CandidateOutputCommitterOptions, host?: CandidateOutputCommitterHostOptions): OutputCommitter;

package/generator/bootstrap/cli.d.ts

@@ -0,0 +1,42 @@
+import { type ChildProcess } from 'node:child_process';
+import type { BuildSession, FileEventSource } from '../contracts.js';
+import type { ProgressStream } from '../progress/detect.js';
+import type { LiveStream } from '../progress/live.js';
+import { type GeneratorBootstrapOptions } from './index.js';
+export interface GeneratorCliIO {
+    cwd(): string;
+    stdout(text: string): void;
+    stderr(text: string): void;
+    /** Progress settings and terminal detection read it; `process.env` when omitted. */
+    env?: NodeJS.ProcessEnv;
+    /** Where the live progress line is drawn (`process.stderr`); without it progress uses lines. */
+    terminal?: LiveStream & ProgressStream;
+}
+/** @internal Injectable native ports; the public package entry exports only runGeneratorCli. */
+export interface GeneratorCliRuntime {
+    createSession(options: GeneratorBootstrapOptions): BuildSession;
+    createEventSource(root: string, ignore: string[]): FileEventSource;
+    spawnHost(command: string, args: string[], cwd: string): ChildProcess;
+}
+/** @internal Test ports of {@link spawnOwnedHost}. */
+export interface OwnedHostPorts {
+    readonly platform?: NodeJS.Platform;
+    readonly env?: NodeJS.ProcessEnv;
+    /** Ends a Windows process tree; `taskkill /T /F` by default. */
+    readonly killTree?: (pid: number) => Promise<void>;
+}
+/**
+ * @internal Starts the host command without a shell. On POSIX it leads its own process group,
+ * which the CLI joins completely. Windows has no process groups: the host is started in the CLI's
+ * console (so Ctrl+C reaches both), a `.cmd`/`.bat` command such as `ng` or `npx` through
+ * `cmd.exe` with quoted arguments, and it is stopped by ending its process tree.
+ */
+export declare function spawnOwnedHost(command: string, args: string[], cwd: string, ports?: OwnedHostPorts): ChildProcess;
+/**
+ * @internal Stops a host started by {@link spawnOwnedHost} (or another child) and waits for it:
+ * `closed` settles when the child has closed.
+ */
+export declare function stopHost(child: ChildProcess, closed: Promise<number>): Promise<void>;
+/** @internal Creates a CLI around explicit native ports for deterministic lifecycle tests. */
+export declare function createGeneratorCli(runtime: GeneratorCliRuntime): (argv: readonly string[], io?: GeneratorCliIO, signal?: AbortSignal) => Promise<number>;
+export declare const runGeneratorCli: (argv: readonly string[], io?: GeneratorCliIO, signal?: AbortSignal) => Promise<number>;