@maz-ui/node 5.2.0-beta.0 → 5.3.0

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import * as consola from 'consola';
 import { ConsolaOptions, InputLogObject, ConsolaReporter, ConsolaInstance } from 'consola';
 export { ConsolaOptions } from 'consola';
 import { FigletOptions } from 'figlet/node';
+export { AGENTS_MD_BEGIN, AGENTS_MD_END, AGENT_TARGETS, AgentDocs, AgentTarget, AgentsTool, DEFAULT_MCP_SERVER, MANAGED_MARKER, MAZ_UI_AGENTS_TOOL, MCP_SERVER_NAME, McpServerCommand, PackageManager, SetupAgentsAction, SetupAgentsChange, SetupAgentsOptions, SetupAgentsResult, compareVersions, detectAgentTargets, detectPackageManager, findInstalledPackage, findProjectPackage, findWorkspaceDirs, findWorkspacesUsing, installsMcpPackage, isEditedManagedContent, mcpServerCommand, readAgentDocs, readManagedVersion, readPackageVersion, readWorkspacePatterns, resolveRulePaths, setupAgents, writeFileAtomic } from './agents.js';
 
 declare const LogLevelMap: {
     silent: number;
@@ -168,152 +169,5 @@ declare function redactSecrets(input: string): string;
  */
 declare function redactError<T>(error: T): T;
 
-/**
- * AI coding agents supported by `setupAgents`.
- *
- * - `claude`: Claude Code rule (`.claude/rules/<tool>.md`) and MCP server (`.mcp.json`)
- * - `agents-md`: section in `AGENTS.md` (Codex, Cursor, Copilot, Windsurf, Zed, Gemini...)
- * - `cursor`: MCP server in `.cursor/mcp.json` (rules come from `AGENTS.md`)
- * - `vscode`: MCP server in `.vscode/mcp.json` for GitHub Copilot (rules come from `AGENTS.md`)
- */
-type AgentTarget = 'claude' | 'agents-md' | 'cursor' | 'vscode';
-declare const AGENT_TARGETS: AgentTarget[];
-interface SetupAgentsOptions {
-    /** Root of the project (where `AGENTS.md`, `.claude/`, `.mcp.json` live) */
-    rootDir: string;
-    /** Agents to configure. Default: the agents detected in the project */
-    targets?: AgentTarget[];
-    /** Write the rules of the tool (Claude Code rule, `AGENTS.md` section). Default `true` */
-    rules?: boolean;
-    /** Register the MCP server of the tool. Default `true` */
-    mcp?: boolean;
-    /** Compute the changes without writing anything */
-    dryRun?: boolean;
-    /** Remove everything `setupAgents` added */
-    remove?: boolean;
-    /** Folder of the maz-ui agent docs. Default: `docs/` of the maz-ui package installed in `rootDir` */
-    docsDir?: string;
-    /** Command used to start the MCP server. Default: `mcpServerCommand(rootDir, mcpVersion, tool)` */
-    mcpServer?: McpServerCommand;
-    /** Version of the MCP package pinned in the `npx -y` command, when the project does not install it. Default `latest` */
-    mcpVersion?: string;
-    /** Tool whose agents are configured. Default: maz-ui (`MAZ_UI_AGENTS_TOOL`) */
-    tool?: AgentsTool;
-    /** Rules of the tool, required with another `tool` than maz-ui. Default: the maz-ui agent docs of `docsDir` */
-    agentDocs?: AgentDocs;
-}
-interface McpServerCommand {
-    command: string;
-    args: string[];
-}
-type SetupAgentsAction = 'create' | 'update' | 'remove' | 'unchanged' | 'skip';
-interface SetupAgentsChange {
-    /** Path relative to `rootDir` */
-    file: string;
-    action: SetupAgentsAction;
-    reason?: string;
-}
-interface SetupAgentsResult {
-    targets: AgentTarget[];
-    version: string;
-    changes: SetupAgentsChange[];
-    /** Command registered in the MCP config files */
-    mcpServer: McpServerCommand;
-    /** `false` when the server runs through `npx -y` because the project does not install the MCP package */
-    localMcpServer: boolean;
-}
-declare const MANAGED_MARKER = "Managed by maz-ui";
-declare const AGENTS_MD_BEGIN = "<!-- BEGIN:maz-ui -->";
-declare const AGENTS_MD_END = "<!-- END:maz-ui -->";
-declare const MCP_SERVER_NAME = "maz-ui";
-declare const DEFAULT_MCP_SERVER: McpServerCommand;
-/**
- * A tool whose AI agents are configured by `setupAgents`: maz-ui by default,
- * or another package that ships its own MCP server and rules.
- */
-interface AgentsTool {
-    /** Name of the tool: key of its MCP server, `.claude/rules/<name>.md` and markers of the generated content */
-    name: string;
-    /** Package that ships the MCP server */
-    mcpPackage: string;
-    /** Bin of `mcpPackage` that starts the MCP server */
-    mcpBin: string;
-    /** Arguments of `mcpBin` that start the MCP server (e.g. `['mcp']`). Default `[]` */
-    mcpArgs?: string[];
-    /** What generates the rules, written in their header (markdown, e.g. `` `npx relizy mcp init` ``) */
-    generatedBy: string;
-    /** Line written under the title of the rules. Default: `> <name> <version> is installed: these rules match this version.` */
-    versionNote?: (version: string) => string;
-}
-declare const MAZ_UI_AGENTS_TOOL: AgentsTool;
-type PackageManager = 'pnpm' | 'yarn' | 'bun' | 'npm';
-/** `true` when the `package.json` of the project declares the MCP package of the tool (`@maz-ui/mcp` by default) */
-declare function installsMcpPackage(rootDir: string, tool?: AgentsTool): boolean;
-/** Package manager of a project: the `packageManager` field, else its lockfile */
-declare function detectPackageManager(rootDir: string): PackageManager;
-/**
- * Command of the MCP server of a tool (maz-ui by default) for a project. When
- * the project installs its package, the package manager starts the installed
- * version in about a second, at the version of the lockfile. Otherwise
- * `npx -y` downloads it, pinned to `version`: a dist-tag (`latest`) makes npx
- * query the registry at every start, which can exceed the start timeout of the
- * agents behind a slow registry.
- */
-declare function mcpServerCommand(rootDir: string, version?: string, tool?: AgentsTool): McpServerCommand;
-/**
- * `true` when generated rules were edited by hand since they were written:
- * they are kept, a newer version of the rules would overwrite the edits.
- */
-declare function isEditedManagedContent(content: string | undefined, tool?: AgentsTool): boolean;
-/** Detects the AI agents configured in a project */
-declare function detectAgentTargets(rootDir: string): AgentTarget[];
-interface AgentDocs {
-    directory: string;
-    version: string;
-    claudeRule: string;
-    agentsMdSection: string;
-}
-/**
- * Finds `node_modules/<name>` from a directory up to the filesystem root, like
- * the Node resolution but without the global folders (`NODE_PATH`), so only a
- * package installed for the project is found.
- */
-declare function findInstalledPackage(fromDir: string, name: string): string | undefined;
-/** Version of an installed package, read from its `package.json` */
-declare function readPackageVersion(packageDir: string): string | undefined;
-/**
- * Workspace patterns of a monorepo: the `packages` of `pnpm-workspace.yaml`,
- * else the `workspaces` of `package.json` (npm, yarn, bun), else `apps/*` and
- * `packages/*`. Negated patterns are ignored.
- */
-declare function readWorkspacePatterns(rootDir: string): string[];
-/** Folders of the workspaces of a monorepo, in the order of the patterns. Only the fixed part of each pattern is read (`apps/*` reads `apps`) */
-declare function findWorkspaceDirs(rootDir: string): string[];
-/**
- * Finds a package installed in a project: in the `node_modules` of the
- * project root and of its workspaces (monorepos without hoisting), then in
- * the parent folders.
- */
-declare function findProjectPackage(rootDir: string, name: string): string | undefined;
-/** Reads the agent files shipped in `maz-ui/docs/agents` */
-declare function readAgentDocs(rootDir: string, docsDir?: string): AgentDocs;
-/**
- * Writes a temporary file then renames it: a concurrent reader (several Nuxt
- * apps of a monorepo starting together) sees the old or the new file, never a
- * truncated one.
- */
-declare function writeFileAtomic(path: string, content: string): void;
-/** Compares two semver versions: negative when `a < b`, positive when `a > b`, `0` when equal */
-declare function compareVersions(a: string, b: string): number;
-/** Version of the tool (maz-ui by default) that generated a managed content, read from its header */
-declare function readManagedVersion(content: string | undefined, tool?: AgentsTool): string | undefined;
-/**
- * Configures the AI coding agents of a project to use a tool, maz-ui by
- * default: rules (version matched with the installed tool) and its MCP server.
- * Idempotent and conservative: it only writes files it owns, a delimited
- * section of `AGENTS.md` and its own entry of the MCP config files.
- */
-declare function setupAgents(options: SetupAgentsOptions): SetupAgentsResult;
-
-export { AGENTS_MD_BEGIN, AGENTS_MD_END, AGENT_TARGETS, DEFAULT_MCP_SERVER, MANAGED_MARKER, MAZ_UI_AGENTS_TOOL, MCP_SERVER_NAME, compareVersions, createLogger, detectAgentTargets, detectPackageManager, execPromise, findInstalledPackage, findProjectPackage, findWorkspaceDirs, installsMcpPackage, isEditedManagedContent, logger, mcpServerCommand, printBanner, readAgentDocs, readManagedVersion, readPackageVersion, readWorkspacePatterns, redactError, redactSecrets, setupAgents, writeFileAtomic };
-export type { AgentDocs, AgentTarget, AgentsTool, ExecPromiseOptions, LogLevel, Logger, LoggerOptions, McpServerCommand, PackageManager, SetupAgentsAction, SetupAgentsChange, SetupAgentsOptions, SetupAgentsResult };
+export { createLogger, execPromise, logger, printBanner, redactError, redactSecrets };
+export type { ExecPromiseOptions, LogLevel, Logger, LoggerOptions };