@lumpcode/cli-types 0.0.16 → 0.1.1

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-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';
+import { LumpVariables, BranchFn, StepVariables, CommandFn, SetupFn, TeardownFn, ContextList, MaybePromise, PromptFnInput, PostCommandExecFn, Step, PromptFn, CodeBasePath, Maybe, Context, GetContextListFnOutput, RunLumpInput, GitAddCommandFn, GitCommitCommandFn, GitCommitMessageFn, GitPushCommandFn } from '@lumpcode/core';
+export { AsyncFnSuccess, BranchFn, CodeBasePath, CommandFn, Context, ContextList, ContextRunState, ContextStatus, ExtractSuccess, GetContextListFnOutput, GitAddCommandFn, GitCommitCommandFn, GitCommitMessageFn, GitPushCommandFn, LumpVariables, Maybe, MaybePromise, PostCommandExecFn, PromptFn, PromptFnInput, SetupFn, Step, StepVariables, Steps, TeardownFn } from '@lumpcode/core';
+import * as z from 'zod';
 
 declare function defineBranchFn<V extends LumpVariables = LumpVariables>(fn: NoInfer<BranchFn<V>>): BranchFn<V>;
 
@@ -17,6 +18,13 @@ declare function defineCommandSetup<V extends LumpVariables = LumpVariables>(fn:
 
 declare function defineCommandTeardown<V extends LumpVariables = LumpVariables>(fn: NoInfer<TeardownFn<V>>): TeardownFn<V>;
 
+type BaseBranchFnInput = {
+    effectiveDiscoveryBranch: string;
+    /** Pre-status raw list from the context source (not todo-filtered). */
+    contexts: ContextList;
+};
+type BaseBranchFn = (input: BaseBranchFnInput) => MaybePromise<string>;
+
 type FilePath = string;
 
 type FilePathOrString = FilePath | string;
@@ -43,6 +51,7 @@ type ContextMatchFn<V extends LumpVariables = LumpVariables> = (params: {
     codeBasePath: CodeBasePath;
     codeBasePaths: CodeBasePath[];
     lumpVariables: V;
+    discoveryBranch: string;
 }) => MaybePromise<Maybe<{
     contextName: Context['name'];
     filePathVariableName: string;
@@ -52,17 +61,38 @@ type ContextMatchFn<V extends LumpVariables = LumpVariables> = (params: {
 
 type ContextOptionsFn = (contextWithoutOptions: Omit<Context, 'options'>) => MaybePromise<Maybe<Context['options']>>;
 
+/**
+ * Author-facing CLI context list fn. Requires concrete `discoveryBranch`.
+ * At the run boundary, CLI adapts this to core `GetContextListFn` (no discovery field).
+ */
+type GetContextListFnInput<V extends LumpVariables = LumpVariables> = {
+    codeBasePaths: CodeBasePath[];
+    lumpVariables: V;
+    discoveryBranch: string;
+};
+type GetContextListFn<V extends LumpVariables = LumpVariables> = (params: GetContextListFnInput<V>) => GetContextListFnOutput;
+
 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, SV>['baseBranch'];
-    /** Which integration line this lump is discovered and scheduled on (defaults to primary branch from local.json). */
+}, 'gitCommitMessageFn' | 'projectRoot' | 'branchFn' | 'baseBranch' | 'setupWorkspaceFn' | 'teardownWorkspaceFn' | 'gitAddCommandFn' | 'gitCommitCommandFn' | 'gitPushCommandFn' | 'getContextListFn' | 'refreshRemoteTrackingRefsFn'>, {
+    /**
+     * Execution integration branch. Exact string, `BaseBranchFn`, or FilePath to a module.
+     * Omit → concrete effective discovery branch. Pattern strings are rejected at resolve.
+     */
+    baseBranch?: string | BaseBranchFn | FilePath;
+    /** Which integration line this lump is discovered and scheduled on (defaults to primary). Exact or git-glob. */
     discoveryBranch?: string;
+    /**
+     * Discovery rules (exact and/or git-glob). Mutually exclusive with `discoveryBranch`.
+     */
+    discoveryBranches?: string[];
     command?: LumpJsConfigStep<V, SV>['command'];
     contextListJson?: FilePath | Record<string, string>;
     contextMatchFn?: FilePath | ContextMatchFn<V>;
     contextOptionsFn?: FilePath | ContextOptionsFn;
+    /** Author context list fn (CLI shape with required `discoveryBranch`). */
+    getContextListFn?: FilePath | GetContextListFn<V>;
     disabled?: boolean | (() => MaybePromise<boolean>) | FilePath;
     maximumNumberOfConcurrentBranches?: number;
     prompt?: LumpJsConfigSoloStep<V, SV>;
@@ -112,6 +142,39 @@ type LumpJsonConfig<V extends LumpVariables = LumpVariables, SV extends StepVari
     steps?: (LumpJsonConfigStep<V, SV> | string)[];
 };
 
+declare const resolvedProjectLocalConfigSchema: z.ZodObject<{
+    verbose: z.ZodOptional<z.ZodBoolean>;
+    command: z.ZodOptional<z.ZodString>;
+    maximumNumberOfConcurrentBranches: z.ZodOptional<z.ZodNumber>;
+    keepHistory: z.ZodOptional<z.ZodBoolean>;
+    primaryBranch: z.ZodOptional<z.ZodString>;
+    projectBaseBranch: z.ZodOptional<z.ZodString>;
+    primaryBranches: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    projectName: z.ZodString;
+    mode: z.ZodEnum<{
+        shared: "shared";
+        dedicated: "dedicated";
+    }>;
+    workspaceStrategy: z.ZodEnum<{
+        checkout: "checkout";
+        worktree: "worktree";
+    }>;
+    disabled: z.ZodOptional<z.ZodBoolean>;
+    maxParallelRun: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+type ResolvedProjectLocalConfig = z.infer<typeof resolvedProjectLocalConfigSchema>;
+
+/**
+ * Shape of `.lumpcode/local.json` — Pick from resolved config.
+ * `mode` is required on the file schema; other keys optional.
+ */
+type LocalJsonConfig = Pick<ResolvedProjectLocalConfig, 'mode' | 'workspaceStrategy' | 'disabled' | 'maxParallelRun' | 'primaryBranch' | 'primaryBranches' | 'projectBaseBranch' | 'command' | 'maximumNumberOfConcurrentBranches' | 'keepHistory' | 'verbose'>;
+
+/**
+ * Shape of `.lumpcode/local.json` — alias of {@link LocalJsonConfig}.
+ */
+type LocalConfig = LocalJsonConfig;
+
 /**
  * Describes how Lumpcode runs lumps against the user's git working copy.
  *
@@ -124,37 +187,15 @@ type LumpJsonConfig<V extends LumpVariables = LumpVariables, SV extends StepVari
 type Mode = 'shared' | 'dedicated';
 
 /**
- * How Lumpcode prepares the per-lump git workspace inside the preflight repo root.
- *
- * - `checkout`: switch the main worktree to a fresh lump branch (default).
- * - `worktree`: add a linked worktree under `.lumpcode/worktrees/<branch>/`.
+ * Shape of `.lumpcode/project.json` — Pick from resolved config.
+ * `projectName` is required on the file schema; other keys optional.
  */
-type WorkspaceStrategy = 'checkout' | 'worktree';
+type ProjectJsonConfig = Pick<ResolvedProjectLocalConfig, 'projectName' | 'primaryBranch' | 'primaryBranches' | 'projectBaseBranch' | 'command' | 'maximumNumberOfConcurrentBranches' | 'keepHistory'>;
 
 /**
- * Shape of `.lumpcode/local.json` — gitignored, per-machine configuration that
- * tells Lumpcode where and how to run lumps from this checkout.
+ * Shape of `.lumpcode/project.json` — alias of {@link ProjectJsonConfig}.
  */
-interface LocalConfig {
-    mode: Mode;
-    /** Required when `primaryBranches` is omitted or empty. Primary integration branch for this install. */
-    primaryBranch?: string;
-    /**
-     * @deprecated Use `primaryBranch` instead.
-     * Legacy alias kept for existing `.lumpcode/local.json` files.
-     */
-    projectBaseBranch?: string;
-    /** When non-empty, wins over singular `primaryBranch` for the effective primary-branch list. Dedicated daemon scans these lines. */
-    primaryBranches?: string[];
-    workspaceStrategy?: WorkspaceStrategy;
-    /** When `true`, the background daemon skips every lump on this machine (`lumpcode start`). */
-    disabled?: boolean;
-}
-
-interface ProjectConfig {
-    projectName?: string;
-    maximumNumberOfConcurrentBranches?: number;
-}
+type ProjectConfig = ProjectJsonConfig;
 
 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, LumpJsConfigPostCommandExecFn, LumpJsConfigStep, LumpJsConfigSteps, LumpJsConfigStepsFn, LumpJsConfigStepsItem, LumpJsonConfig, LumpJsonConfigStep, MergeObjs, Mode, ProjectConfig, StepFn };
+export type { BaseBranchFn, BaseBranchFnInput, CommandModule, CommandTag, ContextMatchFn, ContextOptionsFn, FilePath, FilePathOrString, GetContextListFn, GetContextListFnInput, LocalConfig, LumpJsConfig, LumpJsConfigPostCommandExecFn, LumpJsConfigStep, LumpJsConfigSteps, LumpJsConfigStepsFn, LumpJsConfigStepsItem, LumpJsonConfig, LumpJsonConfigStep, MergeObjs, Mode, ProjectConfig, StepFn };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumpcode/cli-types",
-  "version": "0.0.16",
+  "version": "0.1.1",
   "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.16"
+    "@lumpcode/core": "^0.1.1"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.1",