@lumpcode/cli-types 0.0.12 → 0.0.14

package/README.md

@@ -10,6 +10,8 @@ TypeScript types and small `defineX` identity helpers for authoring **Lumpcode**
 npm install --save-dev @lumpcode/cli-types
 ```
 
+> Prefer [`@lumpcode/cli-utils`](https://www.npmjs.com/package/@lumpcode/cli-utils) for new authoring work (same `define*` helpers plus runtime utils and cursor/copilot preset variable contracts). This package stays soft-aligned: `defineConfig` / `defineStep` / hook helpers accept the same `<V, SV>` (or lump-only `<V>`) signatures.
+
 ## Usage
 
 `config.ts` (or `config.js`):
@@ -24,6 +26,8 @@ export default defineConfig({
 });
 ```
 
+With refined bags: `defineConfig<V, SV>({ … })` — `V` / `SV` default to unbound `LumpVariables` / `StepVariables` so untyped configs keep working.
+
 Command module (`.lumpcode/commands/my-agent.ts` or `.js`):
 
 ```ts

package/dist/index.cjs

@@ -1,42 +1,70 @@
 'use strict';
 
-const identity = (e) => e;
+function defineBranchFn(fn) {
+    return fn;
+}
 
-const defineBranchFn = (identity);
+function defineCommand(fn) {
+    return fn;
+}
 
-const defineCommand = (identity);
+function defineCommandModule(module) {
+    return module;
+}
 
-const defineCommandModule = (identity);
+function defineCommandSetup(fn) {
+    return fn;
+}
 
-const defineCommandSetup = (identity);
+function defineCommandTeardown(fn) {
+    return fn;
+}
 
-const defineCommandTeardown = (identity);
+function defineConfig(config) {
+    return config;
+}
 
-const defineConfig = identity;
+function defineContextMatchFn(fn) {
+    return fn;
+}
 
-const defineContextMatchFn = (identity);
+const identity = (e) => e;
 
 const defineContextOptionsFn = (identity);
 
-const defineGetContextListFn = (identity);
+function defineGetContextListFn(fn) {
+    return fn;
+}
 
 const defineGitAddCommandFn = (identity);
 
 const defineGitCommitCommandFn = (identity);
 
-const defineGitCommitMessageFn = (identity);
+function defineGitCommitMessageFn(fn) {
+    return fn;
+}
 
 const defineGitPushCommandFn = (identity);
 
-const definePostCommandExecFn = (identity);
+function definePostCommandExecFn(fn) {
+    return fn;
+}
 
-const definePromptFn = (identity);
+function definePromptFn(fn) {
+    return fn;
+}
 
-const defineStep = (identity);
+function defineStep(step) {
+    return step;
+}
 
-const defineSetupFn = (identity);
+function defineSetupFn(fn) {
+    return fn;
+}
 
-const defineTeardownFn = (identity);
+function defineTeardownFn(fn) {
+    return fn;
+}
 
 exports.defineBranchFn = defineBranchFn;
 exports.defineCommand = defineCommand;

package/dist/index.d.ts

@@ -1,21 +1,21 @@
-import { BranchFn, CommandFn, SetupFn, TeardownFn, Step, PromptFn, PostCommandExecFn, CodeBasePath, MaybePromise, Maybe, Context, PromptFnInput, LumpVariables, RunLumpInput, GetContextListFn, GitAddCommandFn, GitCommitCommandFn, GitCommitMessageFn, GitPushCommandFn } from '@lumpcode/core';
+import { LumpVariables, BranchFn, StepVariables, CommandFn, SetupFn, TeardownFn, PromptFnInput, MaybePromise, PostCommandExecFn, Step, PromptFn, CodeBasePath, Maybe, Context, RunLumpInput, GetContextListFn, GitAddCommandFn, GitCommitCommandFn, GitCommitMessageFn, GitPushCommandFn } from '@lumpcode/core';
 export { AsyncFnSuccess, BranchFn, CodeBasePath, CommandFn, Context, ContextList, ContextRunState, ContextStatus, ExtractSuccess, GetContextListFn, GetContextListFnInput, GetContextListFnOutput, GitAddCommandFn, GitCommitCommandFn, GitCommitMessageFn, GitPushCommandFn, LumpVariables, Maybe, MaybePromise, PostCommandExecFn, PromptFn, PromptFnInput, SetupFn, Step, StepVariables, Steps, TeardownFn } from '@lumpcode/core';
 
-declare const defineBranchFn: (e: BranchFn) => BranchFn;
+declare function defineBranchFn<V extends LumpVariables = LumpVariables>(fn: NoInfer<BranchFn<V>>): BranchFn<V>;
 
-declare const defineCommand: (e: CommandFn) => CommandFn;
+declare function defineCommand<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(fn: NoInfer<CommandFn<V, SV>>): CommandFn<V, SV>;
 
-interface CommandModule {
-    command: CommandFn;
-    setup?: SetupFn;
-    teardown?: TeardownFn;
+interface CommandModule<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> {
+    command: CommandFn<V, SV>;
+    setup?: SetupFn<V>;
+    teardown?: TeardownFn<V>;
 }
 
-declare const defineCommandModule: (e: CommandModule) => CommandModule;
+declare function defineCommandModule<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(module: NoInfer<CommandModule<V, SV>>): CommandModule<V, SV>;
 
-declare const defineCommandSetup: (e: SetupFn) => SetupFn;
+declare function defineCommandSetup<V extends LumpVariables = LumpVariables>(fn: NoInfer<SetupFn<V>>): SetupFn<V>;
 
-declare const defineCommandTeardown: (e: TeardownFn) => TeardownFn;
+declare function defineCommandTeardown<V extends LumpVariables = LumpVariables>(fn: NoInfer<TeardownFn<V>>): TeardownFn<V>;
 
 type FilePath = string;
 
@@ -25,17 +25,24 @@ type MergeObjs<T, U> = Omit<T, keyof U> & U;
 
 type CommandTag = string;
 
-type LumpJsConfigStep = MergeObjs<Step, {
+type LumpJsConfigStepsFn<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = (input: Omit<PromptFnInput<V, SV>, 'stepVariables'>) => MaybePromise<LumpJsConfigSteps<V, SV> | LumpJsConfigStepsItem<V, SV>>;
+type StepFn<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = LumpJsConfigStepsFn<V, SV>;
+type LumpJsConfigStepsItem<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = LumpJsConfigStep<V, SV> | LumpJsConfigStepsFn<V, SV> | LumpJsConfigStep<V, SV>['promptTemplate'];
+type LumpJsConfigSteps<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = Array<LumpJsConfigStepsItem<V, SV>>;
+
+type LumpJsConfigPostCommandExecFn<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = (input: Parameters<PostCommandExecFn<V, SV>>[0]) => MaybePromise<void | LumpJsConfigSteps<V, SV> | LumpJsConfigStepsItem<V, SV>>;
+
+type LumpJsConfigStep<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = MergeObjs<Step<V, SV>, {
     promptTemplate?: FilePathOrString;
-    promptFn?: FilePath | PromptFn;
-    postCommandExecFn?: FilePath | PostCommandExecFn;
-    command?: CommandTag | FilePath | Step['commandFn'];
+    promptFn?: FilePath | PromptFn<V, SV>;
+    postCommandExecFn?: FilePath | LumpJsConfigPostCommandExecFn<V, SV>;
+    command?: CommandTag | FilePath | Step<V, SV>['commandFn'];
 }>;
 
-type ContextMatchFn = (params: {
+type ContextMatchFn<V extends LumpVariables = LumpVariables> = (params: {
     codeBasePath: CodeBasePath;
     codeBasePaths: CodeBasePath[];
-    lumpVariables: Record<string, unknown>;
+    lumpVariables: V;
 }) => MaybePromise<Maybe<{
     contextName: Context['name'];
     filePathVariableName: string;
@@ -45,66 +52,64 @@ type ContextMatchFn = (params: {
 
 type ContextOptionsFn = (contextWithoutOptions: Omit<Context, 'options'>) => MaybePromise<Maybe<Context['options']>>;
 
-type LumpJsConfigSteps = Array<LumpJsConfigStep | ((input: Exclude<PromptFnInput, 'stepVariables'>) => MaybePromise<LumpJsConfigSteps>) | LumpJsConfigStep['promptTemplate']>;
-
-type LumpJsConfigSoloStep = LumpJsConfigStep | LumpJsConfigStep['promptTemplate'] | LumpJsConfigStep['promptFn'];
-type LumpJsConfig<V extends LumpVariables = LumpVariables> = MergeObjs<Omit<{
-    [K in keyof RunLumpInput<V>]?: NonNullable<RunLumpInput<V>[K]> extends Function ? (RunLumpInput<V>[K] | FilePath) : RunLumpInput<V>[K];
+type LumpJsConfigSoloStep<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = LumpJsConfigStep<V, SV> | LumpJsConfigStep<V, SV>['promptTemplate'] | LumpJsConfigStep<V, SV>['promptFn'];
+type LumpJsConfig<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = MergeObjs<Omit<{
+    [K in keyof RunLumpInput<V, SV>]?: NonNullable<RunLumpInput<V, SV>[K]> extends Function ? (RunLumpInput<V, SV>[K] | FilePath) : RunLumpInput<V, SV>[K];
 }, 'gitCommitMessageFn' | 'projectRoot' | 'branchFn' | 'baseBranch' | 'setupWorkspaceFn' | 'teardownWorkspaceFn' | 'gitAddCommandFn' | 'gitCommitCommandFn' | 'gitPushCommandFn'>, {
-    baseBranch?: RunLumpInput<V>['baseBranch'];
+    baseBranch?: RunLumpInput<V, SV>['baseBranch'];
     /** Which integration line this lump is discovered and scheduled on (defaults to primary branch from local.json). */
     discoveryBranch?: string;
-    command?: LumpJsConfigStep['command'];
+    command?: LumpJsConfigStep<V, SV>['command'];
     contextListJson?: FilePath | Record<string, string>;
-    contextMatchFn?: FilePath | ContextMatchFn;
+    contextMatchFn?: FilePath | ContextMatchFn<V>;
     contextOptionsFn?: FilePath | ContextOptionsFn;
     disabled?: boolean | (() => MaybePromise<boolean>) | FilePath;
     maximumNumberOfConcurrentBranches?: number;
-    prompt?: LumpJsConfigSoloStep;
-    steps?: LumpJsConfigSteps | LumpJsConfigSoloStep;
+    prompt?: LumpJsConfigSoloStep<V, SV>;
+    steps?: LumpJsConfigSteps<V, SV> | LumpJsConfigStepsItem<V, SV>;
     registerCommands?: string[];
     keepHistory?: boolean;
     verbose?: boolean;
 }>;
 
-declare const defineConfig: <V extends LumpVariables = LumpVariables>(config: LumpJsConfig<V>) => LumpJsConfig<V>;
+declare function defineConfig<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(config: NoInfer<LumpJsConfig<V, SV>>): LumpJsConfig<V, SV>;
 
-declare const defineContextMatchFn: (e: ContextMatchFn) => ContextMatchFn;
+declare function defineContextMatchFn<V extends LumpVariables = LumpVariables>(fn: NoInfer<ContextMatchFn<V>>): ContextMatchFn<V>;
 
 declare const defineContextOptionsFn: (e: ContextOptionsFn) => ContextOptionsFn;
 
-declare const defineGetContextListFn: (e: GetContextListFn) => GetContextListFn;
+declare function defineGetContextListFn<V extends LumpVariables = LumpVariables>(fn: NoInfer<GetContextListFn<V>>): GetContextListFn<V>;
 
 declare const defineGitAddCommandFn: (e: GitAddCommandFn) => GitAddCommandFn;
 
 declare const defineGitCommitCommandFn: (e: GitCommitCommandFn) => GitCommitCommandFn;
 
-declare const defineGitCommitMessageFn: (e: GitCommitMessageFn) => GitCommitMessageFn;
+declare function defineGitCommitMessageFn<V extends LumpVariables = LumpVariables>(fn: NoInfer<GitCommitMessageFn<V>>): GitCommitMessageFn<V>;
 
 declare const defineGitPushCommandFn: (e: GitPushCommandFn) => GitPushCommandFn;
 
-declare const definePostCommandExecFn: (e: PostCommandExecFn) => PostCommandExecFn;
+declare function definePostCommandExecFn<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(fn: NoInfer<LumpJsConfigPostCommandExecFn<V, SV>>): LumpJsConfigPostCommandExecFn<V, SV>;
 
-declare const definePromptFn: (e: PromptFn) => PromptFn;
+declare function definePromptFn<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(fn: NoInfer<PromptFn<V, SV>>): PromptFn<V, SV>;
 
-declare const defineStep: (e: LumpJsConfigStep) => LumpJsConfigStep;
+declare function defineStep<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables>(step: NoInfer<LumpJsConfigStep<V, SV>>): LumpJsConfigStep<V, SV>;
 
-declare const defineSetupFn: (e: SetupFn) => SetupFn;
+declare function defineSetupFn<V extends LumpVariables = LumpVariables>(fn: NoInfer<SetupFn<V>>): SetupFn<V>;
 
-declare const defineTeardownFn: (e: TeardownFn) => TeardownFn;
+declare function defineTeardownFn<V extends LumpVariables = LumpVariables>(fn: NoInfer<TeardownFn<V>>): TeardownFn<V>;
 
-type LumpJsonConfigStep = MergeObjs<Omit<Step, 'commandFn'>, {
+type LumpJsonConfigStep<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = MergeObjs<Omit<Step<V, SV>, 'commandFn'>, {
     promptTemplate?: FilePathOrString;
     promptFn?: FilePath;
     command?: string | FilePath;
     postCommandExecFn?: FilePath;
 }>;
 
-type LumpJsonConfig<V extends LumpVariables = LumpVariables> = {
-    [K in keyof LumpJsConfig<V>]: Exclude<LumpJsConfig<V>[K], Function>;
+type LumpJsonConfig<V extends LumpVariables = LumpVariables, SV extends StepVariables = StepVariables> = {
+    [K in keyof LumpJsConfig<V, SV>]: Exclude<LumpJsConfig<V, SV>[K], Function>;
 } & {
-    prompt?: LumpJsonConfigStep;
-    steps?: (LumpJsonConfigStep | string)[];
+    prompt?: LumpJsonConfigStep<V, SV>;
+    steps?: (LumpJsonConfigStep<V, SV> | string)[];
 };
 
 /**
@@ -152,4 +157,4 @@ interface ProjectConfig {
 }
 
 export { defineBranchFn, defineCommand, defineCommandModule, defineCommandSetup, defineCommandTeardown, defineConfig, defineContextMatchFn, defineContextOptionsFn, defineGetContextListFn, defineGitAddCommandFn, defineGitCommitCommandFn, defineGitCommitMessageFn, defineGitPushCommandFn, definePostCommandExecFn, definePromptFn, defineSetupFn, defineStep, defineTeardownFn };
-export type { CommandModule, CommandTag, ContextMatchFn, ContextOptionsFn, FilePath, FilePathOrString, LocalConfig, LumpJsConfig, LumpJsConfigStep, LumpJsConfigSteps, LumpJsonConfig, LumpJsonConfigStep, MergeObjs, Mode, ProjectConfig };
+export type { CommandModule, CommandTag, ContextMatchFn, ContextOptionsFn, FilePath, FilePathOrString, LocalConfig, LumpJsConfig, LumpJsConfigPostCommandExecFn, LumpJsConfigStep, LumpJsConfigSteps, LumpJsConfigStepsFn, LumpJsConfigStepsItem, LumpJsonConfig, LumpJsonConfigStep, MergeObjs, Mode, ProjectConfig, StepFn };

package/dist/index.js

@@ -1,39 +1,67 @@
-const identity = (e) => e;
+function defineBranchFn(fn) {
+    return fn;
+}
 
-const defineBranchFn = (identity);
+function defineCommand(fn) {
+    return fn;
+}
 
-const defineCommand = (identity);
+function defineCommandModule(module) {
+    return module;
+}
 
-const defineCommandModule = (identity);
+function defineCommandSetup(fn) {
+    return fn;
+}
 
-const defineCommandSetup = (identity);
+function defineCommandTeardown(fn) {
+    return fn;
+}
 
-const defineCommandTeardown = (identity);
+function defineConfig(config) {
+    return config;
+}
 
-const defineConfig = identity;
+function defineContextMatchFn(fn) {
+    return fn;
+}
 
-const defineContextMatchFn = (identity);
+const identity = (e) => e;
 
 const defineContextOptionsFn = (identity);
 
-const defineGetContextListFn = (identity);
+function defineGetContextListFn(fn) {
+    return fn;
+}
 
 const defineGitAddCommandFn = (identity);
 
 const defineGitCommitCommandFn = (identity);
 
-const defineGitCommitMessageFn = (identity);
+function defineGitCommitMessageFn(fn) {
+    return fn;
+}
 
 const defineGitPushCommandFn = (identity);
 
-const definePostCommandExecFn = (identity);
+function definePostCommandExecFn(fn) {
+    return fn;
+}
 
-const definePromptFn = (identity);
+function definePromptFn(fn) {
+    return fn;
+}
 
-const defineStep = (identity);
+function defineStep(step) {
+    return step;
+}
 
-const defineSetupFn = (identity);
+function defineSetupFn(fn) {
+    return fn;
+}
 
-const defineTeardownFn = (identity);
+function defineTeardownFn(fn) {
+    return fn;
+}
 
 export { defineBranchFn, defineCommand, defineCommandModule, defineCommandSetup, defineCommandTeardown, defineConfig, defineContextMatchFn, defineContextOptionsFn, defineGetContextListFn, defineGitAddCommandFn, defineGitCommitCommandFn, defineGitCommitMessageFn, defineGitPushCommandFn, definePostCommandExecFn, definePromptFn, defineSetupFn, defineStep, defineTeardownFn };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumpcode/cli-types",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Types and defineX helpers for Lumpcode CLI lump config and command modules",
   "keywords": [
     "lumpcode",
@@ -37,7 +37,7 @@
     "build": "rollup -c"
   },
   "dependencies": {
-    "@lumpcode/core": "^0.0.12"
+    "@lumpcode/core": "^0.0.14"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.1",