@secondlayer/cli 14.3.1 → 15.0.1

package/dist/index.d.ts

@@ -1,5 +1,19 @@
 import { AbiContract as AbiContract2 } from "@secondlayer/stacks/clarity";
-import { AbiContract } from "@secondlayer/stacks/clarity";
+interface ClarinetOptions {
+	/** Path to Clarinet.toml file */
+	path?: string;
+	/** Include only specific contracts */
+	include?: string[];
+	/** Exclude specific contracts */
+	exclude?: string[];
+	/**
+	* Also generate interfaces for dependency contracts declared under
+	* `[project.requirements]` in Clarinet.toml (default: true).
+	*/
+	includeRequirements?: boolean;
+	/** Enable debug output */
+	debug?: boolean;
+}
 /** Supported Stacks network identifiers for contract resolution. */
 type NetworkName = "mainnet" | "testnet" | "devnet";
 /** Specifies a contract to generate typed interfaces for, either from a deployed address or local Clarity source file. */
@@ -16,11 +30,15 @@ interface ContractSource {
 	* Optional name to use in generated code
 	*/
 	name?: string;
+	/**
+	* Pre-resolved ABI (from Clarinet simnet or direct input)
+	*/
+	abi?: AbiContract2;
 }
-/** Configuration for the `@secondlayer/cli` code generator. Defines which contracts to process, output paths, network settings, and plugins. */
+/** Configuration for the `@secondlayer/cli` code generator. */
 interface SecondLayerConfig {
 	/**
-	* Contracts to generate interfaces for (optional - plugins can provide these)
+	* Contracts to generate interfaces for (optional — Clarinet can provide these)
 	*/
 	contracts?: ContractSource[];
 	/**
@@ -28,9 +46,11 @@ interface SecondLayerConfig {
 	*/
 	out: string;
 	/**
-	* Plugins to use for generation
+	* Load contracts from a local Clarinet project via simnet.
+	* `true` uses defaults; pass options for path / include / exclude / requirements.
+	* Skips silently when Clarinet.toml is missing.
 	*/
-	plugins?: any[];
+	clarinet?: boolean | ClarinetOptions;
 	/**
 	* Network to use for fetching contracts
 	*/
@@ -49,239 +69,8 @@ interface SecondLayerConfig {
 	*/
 	defaultAddress?: string;
 }
-interface ResolvedContract {
-	name: string;
-	address: string;
-	contractName: string;
-	abi: AbiContract;
-	source: "api" | "local";
-}
 type ConfigDefiner = (config: SecondLayerConfig) => SecondLayerConfig;
 /**
-* Core plugin interface that all plugins must implement
-*/
-interface SecondLayerPlugin {
-	/** Plugin name (should be unique) */
-	name: string;
-	/** Plugin version */
-	version: string;
-	/** Called after config is resolved but before generation starts */
-	configResolved?: (config: ResolvedConfig) => void | Promise<void>;
-	/** Called before generation starts */
-	beforeGenerate?: (context: GenerateContext) => void | Promise<void>;
-	/** Called during generation phase - plugins can add their own outputs */
-	generate?: (context: GenerateContext) => void | Promise<void>;
-	/** Called after all generation is complete */
-	afterGenerate?: (context: GenerateContext) => void | Promise<void>;
-	/** Transform user config before resolution */
-	transformConfig?: (config: UserConfig) => UserConfig | Promise<UserConfig>;
-	/** Transform individual contracts during processing */
-	transformContract?: (contract: ContractConfig) => ContractConfig | Promise<ContractConfig>;
-	/** Transform generated output before writing to disk */
-	transformOutput?: (output: string, type: OutputType) => string | Promise<string>;
-}
-/**
-* User configuration (before plugin transformations)
-*/
-type UserConfig = SecondLayerConfig;
-/**
-* Resolved configuration (after plugin transformations)
-*/
-interface ResolvedConfig extends SecondLayerConfig {
-	/** Resolved plugins array */
-	plugins: SecondLayerPlugin[];
-}
-/**
-* Contract configuration that can be transformed by plugins
-*/
-interface ContractConfig {
-	name?: string;
-	address?: string | Partial<Record<NetworkName, string>>;
-	source?: string;
-	abi?: AbiContract2;
-	metadata?: Record<string, any>;
-}
-/**
-* Processed contract with resolved ABI and metadata
-*/
-interface ProcessedContract extends ResolvedContract {
-	/** Additional metadata added by plugins */
-	metadata?: Record<string, any>;
-}
-/**
-* Generated output from plugins
-*/
-interface GeneratedOutput {
-	/** File path where output should be written */
-	path: string;
-	/** Generated content */
-	content: string;
-	/** Output type for transformation hooks */
-	type?: OutputType;
-	/** Whether this output should overwrite existing files */
-	overwrite?: boolean;
-}
-/**
-* Types of outputs that can be generated
-*/
-type OutputType = "contracts" | "hooks" | "actions" | "types" | "utils" | "config" | "other";
-/**
-* Base context available to all plugin hooks
-*/
-interface PluginContext {
-	/** Resolved configuration */
-	config: ResolvedConfig;
-	/** Logger for plugin output */
-	logger: Logger;
-	/** Utility functions for plugins */
-	utils: PluginUtils;
-}
-/**
-* Context available during generation phase
-*/
-interface GenerateContext extends PluginContext {
-	/** Processed contracts ready for generation */
-	contracts: ProcessedContract[];
-	/** Map of output keys to generated content */
-	outputs: Map<string, GeneratedOutput>;
-	/** Function to augment existing outputs */
-	augment: (outputKey: string, contractName: string, content: any) => void;
-	/** Function to add new outputs */
-	addOutput: (key: string, output: GeneratedOutput) => void;
-}
-/**
-* Logger interface for plugin output
-*/
-interface Logger {
-	info: (message: string) => void;
-	warn: (message: string) => void;
-	error: (message: string) => void;
-	debug: (message: string) => void;
-	success: (message: string) => void;
-}
-/**
-* Utility functions available to plugins
-*/
-interface PluginUtils {
-	/** Convert kebab-case to camelCase */
-	toCamelCase: (str: string) => string;
-	/** Convert camelCase to kebab-case */
-	toKebabCase: (str: string) => string;
-	/** Validate Stacks address format */
-	validateAddress: (address: string) => boolean;
-	/** Parse contract identifier (address.contract-name) */
-	parseContractId: (contractId: string) => {
-		address: string
-		contractName: string
-	};
-	/** Format TypeScript code using prettier */
-	formatCode: (code: string) => Promise<string>;
-	/** Resolve file path relative to project root */
-	resolvePath: (relativePath: string) => string;
-	/** Check if file exists */
-	fileExists: (path: string) => Promise<boolean>;
-	/** Read file content */
-	readFile: (path: string) => Promise<string>;
-	/** Write file content */
-	writeFile: (path: string, content: string) => Promise<void>;
-	/** Create directory recursively */
-	ensureDir: (path: string) => Promise<void>;
-}
-/**
-* Plugin factory function type for creating plugins with options
-*/
-type PluginFactory<TOptions = any> = (options?: TOptions) => SecondLayerPlugin;
-/**
-* Plugin options base interface
-*/
-interface PluginOptions {
-	/** Include only specific contracts/functions */
-	include?: string[];
-	/** Exclude specific contracts/functions */
-	exclude?: string[];
-	/** Enable debug output */
-	debug?: boolean;
-}
-/**
-* Hook execution result
-*/
-interface HookResult<T = any> {
-	/** Whether the hook was successful */
-	success: boolean;
-	/** Result data from the hook */
-	data?: T;
-	/** Error if hook failed */
-	error?: Error;
-	/** Plugin that executed the hook */
-	plugin: string;
-}
-/**
-* Core plugin manager that orchestrates plugin execution
-*/
-declare class PluginManager {
-	private plugins;
-	private logger;
-	private utils;
-	private executionContext;
-	constructor();
-	/**
-	* Register a plugin
-	*/
-	register(plugin: SecondLayerPlugin): void;
-	/**
-	* Get all registered plugins
-	*/
-	getPlugins(): SecondLayerPlugin[];
-	/**
-	* Transform user config through all plugins
-	*/
-	transformConfig(config: UserConfig): Promise<ResolvedConfig>;
-	/**
-	* Transform contracts through all plugins
-	*/
-	transformContracts(contracts: ContractConfig[], _config: ResolvedConfig): Promise<ProcessedContract[]>;
-	/**
-	* Execute lifecycle hooks
-	*/
-	executeHook(hookName: keyof SecondLayerPlugin, context: any): Promise<void>;
-	/**
-	* Execute generation phase with full context
-	*/
-	executeGeneration(contracts: ProcessedContract[], config: ResolvedConfig): Promise<Map<string, GeneratedOutput>>;
-	/**
-	* Transform outputs through plugins
-	*/
-	transformOutputs(outputs: Map<string, GeneratedOutput>): Promise<Map<string, GeneratedOutput>>;
-	/**
-	* Write outputs to disk
-	*/
-	writeOutputs(outputs: Map<string, GeneratedOutput>): Promise<void>;
-	/**
-	* Get execution results for debugging
-	*/
-	getExecutionResults(): Map<string, HookResult[]>;
-	/**
-	* Convert a contract config with an ABI into a ProcessedContract
-	*/
-	private contractToProcessed;
-	/**
-	* Augment existing output with additional content
-	*/
-	private augmentOutput;
-	/**
-	* Record hook execution result
-	*/
-	private recordHookResult;
-	/**
-	* Create logger instance
-	*/
-	private createLogger;
-	/**
-	* Create utils instance
-	*/
-	private createUtils;
-}
-/**
 * Type-safe helper for creating a `secondlayer.config.ts` configuration.
 * Accepts either a config object or a factory function that receives a base config and returns a modified one.
 *
@@ -298,4 +87,4 @@ declare class PluginManager {
 declare function defineConfig(config: SecondLayerConfig): SecondLayerConfig;
 declare function defineConfig(definer: ConfigDefiner): ConfigDefiner;
 import { AbiContract as AbiContract3, AbiFunction, AbiType } from "@secondlayer/stacks/clarity";
-export { defineConfig, UserConfig, SecondLayerPlugin, SecondLayerConfig, ResolvedConfig, ProcessedContract, PluginUtils, PluginOptions, PluginManager, PluginFactory, PluginContext, OutputType, NetworkName, Logger, GeneratedOutput, GenerateContext, ContractSource, ContractConfig, AbiType, AbiFunction, AbiContract3 as AbiContract };
+export { defineConfig, SecondLayerConfig, NetworkName, ContractSource, ClarinetOptions, AbiType, AbiFunction, AbiContract3 as AbiContract };