@secondlayer/cli 3.3.0 → 3.3.1

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import { AbiContract as AbiContract2 } from "@secondlayer/stacks/clarity";
 import { AbiContract } from "@secondlayer/stacks/clarity";
 /** Supported Stacks network identifiers for contract resolution. */
 type NetworkName = "mainnet" | "testnet" | "devnet";
@@ -56,6 +55,8 @@ interface ResolvedContract {
 	abi: AbiContract;
 	source: "api" | "local";
 }
+type ConfigDefiner = (config: SecondLayerConfig) => SecondLayerConfig;
+import { AbiContract as AbiContract2 } from "@secondlayer/stacks/clarity";
 /**
 * Core plugin interface that all plugins must implement
 */
@@ -215,6 +216,23 @@ interface HookResult<T = any> {
 	plugin: string;
 }
 /**
+* 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.
+*
+* @example
+* ```ts
+* import { defineConfig } from "@secondlayer/cli";
+*
+* defineConfig({
+*   contracts: [{ address: "SP000000000000000000002Q6VF78.bns" }],
+*   out: "./src/generated.ts",
+* });
+* ```
+*/
+declare function defineConfig(config: SecondLayerConfig): SecondLayerConfig;
+declare function defineConfig(definer: ConfigDefiner): ConfigDefiner;
+import { AbiContract as AbiContract3, AbiFunction, AbiType } from "@secondlayer/stacks/clarity";
+/**
 * Core plugin manager that orchestrates plugin execution
 */
 declare class PluginManager {
@@ -280,85 +298,4 @@ declare class PluginManager {
 	*/
 	private createUtils;
 }
-interface ClarinetPluginOptions {
-	/** Path to Clarinet.toml file */
-	path?: string;
-	/** Include only specific contracts */
-	include?: string[];
-	/** Exclude specific contracts */
-	exclude?: string[];
-	/** Enable debug output */
-	debug?: boolean;
-}
-/**
-* Clarinet plugin factory
-*/
-declare const clarinet: PluginFactory<ClarinetPluginOptions>;
-/**
-* Utility function to check if a Clarinet project exists
-*/
-declare function hasClarinetProject(path?: string): Promise<boolean>;
-interface ActionsPluginOptions {
-	/** Include only specific contracts */
-	include?: string[];
-	/** Exclude specific contracts */
-	exclude?: string[];
-	/** Include only specific functions */
-	includeFunctions?: string[];
-	/** Exclude specific functions */
-	excludeFunctions?: string[];
-	/** Enable debug output */
-	debug?: boolean;
-	/** Environment variable name for default sender key (default: "STX_SENDER_KEY") */
-	senderKeyEnv?: string;
-}
-/**
-* Actions plugin factory
-*/
-declare const actions: PluginFactory<ActionsPluginOptions>;
-/**
-* React plugin configuration options
-*/
-interface ReactPluginOptions extends PluginOptions {
-	/**
-	* Hooks to exclude from generation (both generic and contract-specific)
-	* By default, all hooks are generated
-	*/
-	exclude?: string[];
-}
-/**
-* React plugin factory
-*/
-declare const react: PluginFactory<ReactPluginOptions>;
-interface TestingPluginOptions {
-	/** Include only specific contracts */
-	include?: string[];
-	/** Exclude specific contracts */
-	exclude?: string[];
-	/** Output path for generated testing helpers (default: ./src/generated/testing.ts) */
-	out?: string;
-	/** Include private function helpers (default: false) */
-	includePrivate?: boolean;
-	/** Enable debug output */
-	debug?: boolean;
-}
-declare const testing: PluginFactory<TestingPluginOptions>;
-interface BasePluginOptions {
-	/** Include only specific contracts/functions */
-	include?: string[];
-	/** Exclude specific contracts/functions */
-	exclude?: string[];
-	/** Enable debug output */
-	debug?: boolean;
-}
-/**
-* Utility function to filter contracts/functions based on include/exclude options
-*/
-declare function filterByOptions<T extends {
-	name: string
-}>(items: T[], options?: BasePluginOptions): T[];
-/**
-* Utility function to create a simple plugin
-*/
-declare function createPlugin(name: string, version: string, implementation: Partial<SecondLayerPlugin>): SecondLayerPlugin;
-export { testing, react, hasClarinetProject, filterByOptions, createPlugin, clarinet, actions, TestingPluginOptions, SecondLayerPlugin, ReactPluginOptions, PluginUtils, PluginOptions, PluginManager, PluginFactory, PluginContext, Logger, GenerateContext, ClarinetPluginOptions, BasePluginOptions, ActionsPluginOptions };
+export { defineConfig, UserConfig, SecondLayerPlugin, SecondLayerConfig, ResolvedConfig, ProcessedContract, PluginUtils, PluginOptions, PluginManager, PluginFactory, PluginContext, OutputType, NetworkName, Logger, GeneratedOutput, GenerateContext, ContractSource, ContractConfig, AbiType, AbiFunction, AbiContract3 as AbiContract };