@tomradex/repos 0.0.0-stage → 0.18.0

package/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Haoyuan Tang
+
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { Repos, ReposConfig, BranchInUseError, CheckoutUnsetError, HubUnsetError, type CheckoutSelection, type CheckoutView, type FolderRepo, type MissingWorkdir, type WorkdirView } from "./service.js";
+export { isLocalRemote, normalizeRemote, remoteIdentity, sameRepository, serverHost, sshHostName, type RemoteIdentity } from "./remotes.js";
+export { Repos as default } from "./service.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/remotes.d.ts

@@ -0,0 +1,21 @@
+/** Two spellings of one repository read the same: no credential, no trailing `.git`, no trailing slash. */
+export declare const normalizeRemote: (remote: string) => string;
+/** Where a network remote lives, whatever the scheme, user or port. Local paths have no identity beyond their spelling. */
+export interface RemoteIdentity {
+    host: string;
+    path: string;
+    ssh: boolean;
+}
+export declare const remoteIdentity: (remote: string) => RemoteIdentity | null;
+/** A path or file URL: a repository with no server behind it, known only by where it is. */
+export declare const isLocalRemote: (remote: string) => boolean;
+/** The real server behind an alias in ~/.ssh/config (`Host github.com-work` → `HostName github.com`), or the name itself. */
+export declare const sshHostName: (host: string) => Promise<string>;
+/** The server a network remote really reaches: an SSH alias resolved, an SSH-over-443 endpoint read as its main host. */
+export declare const serverHost: (id: RemoteIdentity, resolveHost?: (host: string) => Promise<string>) => Promise<string>;
+/**
+ * Whether two remotes are one repository: `git@github.com:acme/app.git`,
+ * `https://github.com/acme/app` and an SSH alias of github.com all are.
+ */
+export declare function sameRepository(a: string, b: string, resolveHost?: (host: string) => Promise<string>): Promise<boolean>;
+//# sourceMappingURL=remotes.d.ts.map

package/dist/runtime.js

@@ -0,0 +1 @@
+throw new Error("@tomradex/repos is Tomrade's own code: a full-mode plugin gets the running app's copy, so load the plugin in Tomrade");

package/dist/service.d.ts

@@ -0,0 +1,160 @@
+import { Context, Service } from "cordis";
+import { z } from "zod";
+import { type CreateRepoInput, type Repo, type RepoPatch } from "@tomradex/domain";
+import type { ReposReader } from "@tomradex/contracts";
+declare module "cordis" {
+    interface Context {
+        repos: Repos;
+    }
+    interface Events {
+        /** A checkout was placed successfully; consumers may inspect it immediately. */
+        "repos/checkout-set"(remote: string): void;
+    }
+}
+/** Where a workstream's code is on this machine, and whether it is ready for an agent. */
+export interface CheckoutView {
+    remote: string;
+    checkout: string | null;
+    runInCheckout: boolean;
+}
+/** Result of inspecting the folder the user explicitly chose. */
+export type CheckoutSelection = {
+    state: "ready";
+    view: CheckoutView;
+} | {
+    state: "clone";
+    remote: string;
+    parent: string;
+    dir: string; /** Set when the chosen folder is a checkout of another repository. */
+    origin?: string;
+};
+/** A folder the user chose as one of the project's repositories. */
+export interface FolderRepo {
+    repo: Repo;
+    view: CheckoutView;
+    /** The folder has no origin: it is the repository, and its branches stay on this machine. */
+    local: boolean;
+    /** The project already had this repository; the folder became its checkout. */
+    existing: boolean;
+}
+export interface WorkdirView {
+    repo: Repo;
+    /** The folder the agent runs in: a worktree of the checkout by default, the checkout itself when asked. */
+    cwd: string;
+    worktree: string | null;
+    checkout: string;
+    branch: string;
+}
+/** A thread's worktree that is not on this machine, asked about without leave to make it. */
+export type MissingWorkdir = Omit<WorkdirView, "cwd"> & {
+    cwd: null;
+};
+declare module "@tomradex/ipc" {
+    interface Channels {
+        "repos.list": (projectId: string) => Repo[];
+        "repos.create": (input: CreateRepoInput) => Repo;
+        /** Add the repository in a folder the user chose: its origin when it has one, the folder itself when it has none. */
+        "repos.addFromFolder": (projectId: string, dir: string) => FolderRepo;
+        "repos.update": (projectId: string, id: string, patch: RepoPatch) => Repo;
+        "repos.remove": (projectId: string, id: string) => void;
+        /** Every remote this machine has placed, by remote URL. */
+        "repos.checkouts": () => CheckoutView[];
+        /** Inspect the folder the user chose. If it is not this checkout, offer a named child folder for cloning. */
+        "repos.selectCheckout": (remote: string, dir: string) => CheckoutSelection;
+        "repos.clearCheckout": (remote: string) => void;
+        "repos.setRunInCheckout": (remote: string, on: boolean) => CheckoutView;
+        /** Clone as a named child of the folder the user chose, after explicit confirmation. */
+        "repos.cloneInto": (remote: string, branch: string, parent: string) => CheckoutView;
+    }
+    interface Broadcasts {
+        "repos.changed": () => void;
+    }
+}
+export declare const ReposConfig: z.ZodPreprocess<z.ZodObject<{
+    gitBinary: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>>;
+export type ReposConfig = z.infer<typeof ReposConfig>;
+/** The workstream has a repository but this machine has not said where its checkout is. */
+export declare class CheckoutUnsetError extends Error {
+    readonly remote: string;
+    constructor(remote: string);
+}
+/** Worktrees live under the Hub folder, and none is chosen on this machine. */
+export declare class HubUnsetError extends Error {
+    constructor();
+}
+/** git keeps a branch in one worktree at a time, and another worktree already has this one. */
+export declare class BranchInUseError extends Error {
+    readonly branch: string;
+    readonly at: string;
+    constructor(branch: string, at: string);
+}
+/**
+ * The code repositories a project's workstreams stand for. Their identity (the
+ * remote URL) is a project row and travels with it; where each is checked out
+ * is this machine's alone, in the catalog. Tomrade never pushes any of them:
+ * it fetches, and adds worktrees for agents to run in.
+ */
+export declare class Repos extends Service implements ReposReader {
+    readonly config: ReposConfig;
+    static provide: string;
+    static inject: string[];
+    static Config: z.ZodPreprocess<z.ZodObject<{
+        gitBinary: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
+    private readonly home;
+    private readonly runGit;
+    constructor(ctx: Context, config: ReposConfig);
+    [Service.init](): void;
+    private db;
+    private get hub();
+    private notify;
+    list(projectId: string): Repo[];
+    get(projectId: string, id: string): Repo | null;
+    /** A remote already known to the project is returned, not duplicated. */
+    create(input: CreateRepoInput): Repo;
+    /**
+     * A folder chosen as a repository. Its origin, when it has one, is the
+     * identity, and a row already naming it under any spelling is reused. With
+     * no origin the folder itself is the repository, local to this machine until
+     * it gains one (see adoptOrigins). The folder is only read.
+     */
+    addFromFolder(projectId: string, rawDir: string): Promise<FolderRepo>;
+    /** Where a folder's branches start: origin's HEAD, else main or master, else whatever is checked out. */
+    private trunkOf;
+    /**
+     * A local repository whose folder has since gained an origin takes that
+     * origin as its identity, so the project, and every machine it travels to,
+     * sees the remote. The row keeps its id: workstreams and links stay put.
+     */
+    adoptOrigins(projectId: string): Promise<Repo[]>;
+    update(projectId: string, id: string, patch: RepoPatch): Repo;
+    /** Refused while a workstream still stands for it. */
+    remove(projectId: string, id: string): void;
+    checkouts(): CheckoutView[];
+    checkout(remote: string): CheckoutView;
+    /** The folder must be a checkout of that very repository: its origin is compared, not trusted. */
+    setCheckout(remote: string, rawDir: string): Promise<CheckoutView>;
+    /** Choosing a folder never mutates it. A folder without this checkout gets an explicit clone offer. */
+    selectCheckout(remote: string, rawDir: string): Promise<CheckoutSelection>;
+    clearCheckout(remote: string): void;
+    setRunInCheckout(remote: string, on: boolean): CheckoutView;
+    /** Clone into a repository-named child of the folder the user selected and then confirmed. */
+    cloneInto(remote: string, branch: string, rawParent: string): Promise<CheckoutView>;
+    /**
+     * The folder a thread on a workstream runs in. A worktree of the checkout,
+     * detached at the remote's default branch, under the Hub where the user can
+     * open it; or the checkout itself when the user chose that for the workstream.
+     */
+    workdirFor(projectId: string, boardId: string, threadId: string, opts?: {
+        branch?: string | null;
+        create?: true;
+    }): Promise<WorkdirView | null>;
+    workdirFor(projectId: string, boardId: string, threadId: string, opts: {
+        branch?: string | null;
+        create: boolean;
+    }): Promise<WorkdirView | MissingWorkdir | null>;
+    /** Remove a thread's worktree. The branch, if the agent made one, stays in the checkout. */
+    removeWorktree(view: WorkdirView): Promise<void>;
+}
+//# sourceMappingURL=service.d.ts.map

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@tomradex/repos",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.18.0",
+  "type": "module",
+  "author": "Haoyuan Tang",
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "description": "ctx.repos — the code repositories a project's workstreams stand for, where they are checked out here, and the worktrees agents run in — declarations for full-mode plugins; Tomrade provides the code at run time",
+  "keywords": [
+    "tomrade",
+    "tomrade-plugin",
+    "types"
+  ],
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/runtime.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@tomradex/boards": "0.18.0",
+    "@tomradex/contracts": "0.18.0",
+    "@tomradex/db": "0.18.0",
+    "@tomradex/domain": "0.2.26",
+    "@tomradex/git": "0.18.0",
+    "@tomradex/hub": "0.18.0",
+    "@tomradex/ipc": "0.18.0",
+    "@tomradex/storage": "0.18.0",
+    "@tomradex/tools": "0.18.0",
+    "cordis": "4.0.0-rc.8",
+    "zod": "^4.4.3"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.