@lumpcode/cli-types 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Lumpcode
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,50 @@
+# @lumpcode/cli-types
+
+TypeScript types and small `defineX` identity helpers for authoring **Lumpcode** lump configuration (`config.js`) and command modules (`.lumpcode/commands/<name>.js`). Runtime is just identity functions; the value is purely the type hints.
+
+> Use **alongside the Lumpcode CLI** for typed `config.js` and command modules. The CLI is also on npm (`@lumpcode/cli`); standalone binaries are at [lumpcode.com](https://lumpcode.com).
+
+## Install
+
+```bash
+npm install --save-dev @lumpcode/cli-types@beta
+```
+
+During pre-launch, packages are published under the `beta` dist-tag. Omit `@beta` once `latest` is promoted.
+
+## Usage
+
+`config.js`:
+
+```js
+import { defineConfig } from '@lumpcode/cli-types';
+
+export default defineConfig({
+  baseBranch: 'main',
+  contextListJson: { FILE: 'src/{NAME}.ts' },
+  prompt: { promptTemplate: 'Fix @{FILE}', command: 'claude' },
+});
+```
+
+Command module (`.lumpcode/commands/my-agent.js`):
+
+```js
+import { defineCommand, defineCommandSetup } from '@lumpcode/cli-types';
+
+export const command = defineCommand(({ prompt }) => ({
+  executable: 'my-agent',
+  args: ['--message', prompt],
+}));
+
+export const setup = defineCommandSetup(async () => ({}));
+```
+
+## What's exported
+
+- **Config helpers:** `defineConfig`, `defineStep`, `defineGetContextListFn`, `defineContextMatchFn`, `defineContextOptionsFn`, `defineBranchFn`, `definePromptFn`, `definePostCommandExecFn`, `defineSetupFn`, `defineTeardownFn`, `defineGitAddCommandFn`, `defineGitCommitCommandFn`, `defineGitCommitMessageFn`, `defineGitPushCommandFn`.
+- **Command-module helpers:** `defineCommandModule`, `defineCommand`, `defineCommandSetup`, `defineCommandTeardown`.
+- **Types:** every shape referenced by lump config and command modules — `LumpJsConfig`, `LumpJsonConfig`, `ContextMatchFn`, `ContextOptionsFn`, `CommandModule`, plus engine types re-exported from `@lumpcode/core` (`Context`, `CommandFn`, `SetupFn`, `TeardownFn`, `PromptFn`, `GetContextListFn`, …).
+
+## Docs
+
+Field reference and hook signatures live in the CLI docs — see [lumpcode DOCS](https://lumpcode.com/docs).

package/dist/index.cjs

@@ -0,0 +1,58 @@
+'use strict';
+
+const identity = (e) => e;
+
+const defineBranchFn = (identity);
+
+const defineCommand = (identity);
+
+const defineCommandModule = (identity);
+
+const defineCommandSetup = (identity);
+
+const defineCommandTeardown = (identity);
+
+const defineConfig = identity;
+
+const defineContextMatchFn = (identity);
+
+const defineContextOptionsFn = (identity);
+
+const defineGetContextListFn = (identity);
+
+const defineGitAddCommandFn = (identity);
+
+const defineGitCommitCommandFn = (identity);
+
+const defineGitCommitMessageFn = (identity);
+
+const defineGitPushCommandFn = (identity);
+
+const definePostCommandExecFn = (identity);
+
+const definePromptFn = (identity);
+
+const defineStep = (identity);
+
+const defineSetupFn = (identity);
+
+const defineTeardownFn = (identity);
+
+exports.defineBranchFn = defineBranchFn;
+exports.defineCommand = defineCommand;
+exports.defineCommandModule = defineCommandModule;
+exports.defineCommandSetup = defineCommandSetup;
+exports.defineCommandTeardown = defineCommandTeardown;
+exports.defineConfig = defineConfig;
+exports.defineContextMatchFn = defineContextMatchFn;
+exports.defineContextOptionsFn = defineContextOptionsFn;
+exports.defineGetContextListFn = defineGetContextListFn;
+exports.defineGitAddCommandFn = defineGitAddCommandFn;
+exports.defineGitCommitCommandFn = defineGitCommitCommandFn;
+exports.defineGitCommitMessageFn = defineGitCommitMessageFn;
+exports.defineGitPushCommandFn = defineGitPushCommandFn;
+exports.definePostCommandExecFn = definePostCommandExecFn;
+exports.definePromptFn = definePromptFn;
+exports.defineSetupFn = defineSetupFn;
+exports.defineStep = defineStep;
+exports.defineTeardownFn = defineTeardownFn;

package/dist/index.d.ts

@@ -0,0 +1,143 @@
+import { BranchFn, CommandFn, SetupFn, TeardownFn, Step, PromptFn, PostCommandExecFn, CodeBasePath, MaybePromise, Maybe, Context, PromptFnInput, LumpVariables, 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 const defineCommand: (e: CommandFn) => CommandFn;
+
+interface CommandModule {
+    command: CommandFn;
+    setup?: SetupFn;
+    teardown?: TeardownFn;
+}
+
+declare const defineCommandModule: (e: CommandModule) => CommandModule;
+
+declare const defineCommandSetup: (e: SetupFn) => SetupFn;
+
+declare const defineCommandTeardown: (e: TeardownFn) => TeardownFn;
+
+type FilePath = string;
+
+type FilePathOrString = FilePath | string;
+
+type MergeObjs<T, U> = Omit<T, keyof U> & U;
+
+type CommandTag = string;
+
+type LumpJsConfigStep = MergeObjs<Step, {
+    promptTemplate?: FilePathOrString;
+    promptFn?: FilePath | PromptFn;
+    postCommandExecFn?: FilePath | PostCommandExecFn;
+    command?: CommandTag | FilePath | Step['commandFn'];
+}>;
+
+type ContextMatchFn = (params: {
+    codeBasePath: CodeBasePath;
+    codeBasePaths: CodeBasePath[];
+    lumpVariables: Record<string, unknown>;
+}) => MaybePromise<Maybe<{
+    contextName: Context['name'];
+    filePathVariableName: string;
+    moreContextVariables?: Record<string, string>;
+    contextOptions?: Maybe<Context['options']>;
+}>>;
+
+type ContextOptionsFn = (contextWithoutOptions: Omit<Context, 'options'>) => MaybePromise<Maybe<Context['options']>>;
+
+type LumpJsConfigSteps = Array<LumpJsConfigStep | ((input: Exclude<PromptFnInput, 'stepVariables'>) => MaybePromise<LumpJsConfigSteps>) | LumpJsConfigStep['promptTemplate']>;
+
+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];
+}, 'gitCommitMessageFn' | 'projectRoot' | 'branchFn' | 'baseBranch' | 'setupWorkspaceFn' | 'teardownWorkspaceFn' | 'gitAddCommandFn' | 'gitCommitCommandFn' | 'gitPushCommandFn'>, {
+    baseBranch?: RunLumpInput<V>['baseBranch'];
+    command?: LumpJsConfigStep['command'];
+    contextListJson?: FilePath | Record<string, string>;
+    contextMatchFn?: FilePath | ContextMatchFn;
+    contextOptionsFn?: FilePath | ContextOptionsFn;
+    disabled?: boolean | (() => MaybePromise<boolean>) | FilePath;
+    maximumNumberOfConcurrentBranches?: number;
+    prompt?: LumpJsConfigStep | LumpJsConfigStep['promptTemplate'] | LumpJsConfigStep['promptFn'];
+    steps?: LumpJsConfigSteps;
+    registerCommands?: string[];
+    keepHistory?: boolean;
+}>;
+
+declare const defineConfig: <V extends LumpVariables = LumpVariables>(config: LumpJsConfig<V>) => LumpJsConfig<V>;
+
+declare const defineContextMatchFn: (e: ContextMatchFn) => ContextMatchFn;
+
+declare const defineContextOptionsFn: (e: ContextOptionsFn) => ContextOptionsFn;
+
+declare const defineGetContextListFn: (e: GetContextListFn) => GetContextListFn;
+
+declare const defineGitAddCommandFn: (e: GitAddCommandFn) => GitAddCommandFn;
+
+declare const defineGitCommitCommandFn: (e: GitCommitCommandFn) => GitCommitCommandFn;
+
+declare const defineGitCommitMessageFn: (e: GitCommitMessageFn) => GitCommitMessageFn;
+
+declare const defineGitPushCommandFn: (e: GitPushCommandFn) => GitPushCommandFn;
+
+declare const definePostCommandExecFn: (e: PostCommandExecFn) => PostCommandExecFn;
+
+declare const definePromptFn: (e: PromptFn) => PromptFn;
+
+declare const defineStep: (e: LumpJsConfigStep) => LumpJsConfigStep;
+
+declare const defineSetupFn: (e: SetupFn) => SetupFn;
+
+declare const defineTeardownFn: (e: TeardownFn) => TeardownFn;
+
+type LumpJsonConfigStep = MergeObjs<Omit<Step, '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>;
+} & {
+    prompt?: LumpJsonConfigStep;
+    steps?: (LumpJsonConfigStep | string)[];
+};
+
+/**
+ * Describes how Lumpcode runs lumps against the user's git working copy.
+ *
+ * - `shared`: the current checkout is the user's day-to-day workspace.
+ *   Lumpcode never touches it; runs happen in a separate copy under
+ *   `<globalConfigFolderPath>/project-copies/<projectName>/`.
+ * - `dedicated`: the current checkout is dedicated to Lumpcode (typically a
+ *   distant daemon machine). Lumpcode pulls and runs in place.
+ */
+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>/`.
+ */
+type WorkspaceStrategy = 'checkout' | 'worktree';
+
+/**
+ * Shape of `.lumpcode/local.json` — gitignored, per-machine configuration that
+ * tells Lumpcode where and how to run lumps from this checkout.
+ */
+interface LocalConfig {
+    mode: Mode;
+    projectBaseBranch: string;
+    workspaceStrategy?: WorkspaceStrategy;
+    /** When `true`, the background daemon skips every lump on this machine (`lumpcode start`). */
+    disabled?: boolean;
+}
+
+interface ProjectConfig {
+    projectName?: string;
+    maximumNumberOfConcurrentBranches?: number;
+}
+
+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 };

package/dist/index.js

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

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@lumpcode/cli-types",
+  "version": "0.0.0",
+  "description": "Types and defineX helpers for Lumpcode CLI lump config and command modules",
+  "license": "Apache-2.0",
+  "author": "",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepublishOnly": "npm run build",
+    "clean": "rm -rf dist",
+    "build": "rollup -c"
+  },
+  "dependencies": {
+    "@lumpcode/core": "^0.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.1",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^12.1.0",
+    "rollup": "^4.52.5",
+    "rollup-plugin-dts": "^6.1.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.2"
+  }
+}