@h-rig/contracts 0.0.6-alpha.0

package/README.md

@@ -0,0 +1,14 @@
+# Contracts Package
+
+`@rig/contracts` is the shared schema and type surface across apps, runtime, and server.
+
+## Rules
+
+- Prefer additive changes.
+- If a contract changes, check web, desktop, runtime, and server callers in the same change.
+- Keep the package framework-neutral.
+
+## Commands
+
+- `bun run --filter=@rig/contracts build`
+- `bun run --filter=@rig/contracts test`

package/dist/src/artifact.js

@@ -0,0 +1,53 @@
+// @bun
+// packages/contracts/src/artifact.ts
+import { Schema as Schema2 } from "effect";
+
+// packages/contracts/src/baseSchemas.ts
+import { Schema } from "effect";
+var TrimmedString = Schema.Trim;
+var TrimmedNonEmptyString = TrimmedString.check(Schema.isNonEmpty());
+var NonNegativeInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(0));
+var PositiveInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(1));
+var IsoDateTime = Schema.String;
+var makeEntityId = (brand) => TrimmedNonEmptyString.pipe(Schema.brand(brand));
+var ThreadId = makeEntityId("ThreadId");
+var ProjectId = makeEntityId("ProjectId");
+var WorkspaceId = makeEntityId("WorkspaceId");
+var GraphId = makeEntityId("GraphId");
+var TaskId = makeEntityId("TaskId");
+var RunId = makeEntityId("RunId");
+var EngineRuntimeId = makeEntityId("EngineRuntimeId");
+var ConversationId = makeEntityId("ConversationId");
+var ActionId = makeEntityId("ActionId");
+var ArtifactId = makeEntityId("ArtifactId");
+var WorktreeId = makeEntityId("WorktreeId");
+var ValidationResultId = makeEntityId("ValidationResultId");
+var ReviewResultId = makeEntityId("ReviewResultId");
+var CommandId = makeEntityId("CommandId");
+var EventId = makeEntityId("EventId");
+var MessageId = makeEntityId("MessageId");
+var TurnId = makeEntityId("TurnId");
+var ProviderItemId = makeEntityId("ProviderItemId");
+var RuntimeSessionId = makeEntityId("RuntimeSessionId");
+var RuntimeItemId = makeEntityId("RuntimeItemId");
+var RuntimeRequestId = makeEntityId("RuntimeRequestId");
+var RuntimeTaskId = makeEntityId("RuntimeTaskId");
+var ApprovalRequestId = makeEntityId("ApprovalRequestId");
+var CheckpointRef = makeEntityId("CheckpointRef");
+var RemoteEndpointId = makeEntityId("RemoteEndpointId");
+
+// packages/contracts/src/artifact.ts
+var ArtifactSummary = Schema2.Struct({
+  id: ArtifactId,
+  runId: RunId,
+  taskId: Schema2.NullOr(TaskId),
+  kind: TrimmedNonEmptyString,
+  label: TrimmedNonEmptyString,
+  path: Schema2.NullOr(TrimmedNonEmptyString),
+  url: Schema2.NullOr(TrimmedNonEmptyString),
+  metadata: Schema2.Record(Schema2.String, Schema2.Unknown),
+  createdAt: IsoDateTime
+});
+export {
+  ArtifactSummary
+};

package/dist/src/baseSchemas.js

@@ -0,0 +1,66 @@
+// @bun
+// packages/contracts/src/baseSchemas.ts
+import { Schema } from "effect";
+var TrimmedString = Schema.Trim;
+var TrimmedNonEmptyString = TrimmedString.check(Schema.isNonEmpty());
+var NonNegativeInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(0));
+var PositiveInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(1));
+var IsoDateTime = Schema.String;
+var makeEntityId = (brand) => TrimmedNonEmptyString.pipe(Schema.brand(brand));
+var ThreadId = makeEntityId("ThreadId");
+var ProjectId = makeEntityId("ProjectId");
+var WorkspaceId = makeEntityId("WorkspaceId");
+var GraphId = makeEntityId("GraphId");
+var TaskId = makeEntityId("TaskId");
+var RunId = makeEntityId("RunId");
+var EngineRuntimeId = makeEntityId("EngineRuntimeId");
+var ConversationId = makeEntityId("ConversationId");
+var ActionId = makeEntityId("ActionId");
+var ArtifactId = makeEntityId("ArtifactId");
+var WorktreeId = makeEntityId("WorktreeId");
+var ValidationResultId = makeEntityId("ValidationResultId");
+var ReviewResultId = makeEntityId("ReviewResultId");
+var CommandId = makeEntityId("CommandId");
+var EventId = makeEntityId("EventId");
+var MessageId = makeEntityId("MessageId");
+var TurnId = makeEntityId("TurnId");
+var ProviderItemId = makeEntityId("ProviderItemId");
+var RuntimeSessionId = makeEntityId("RuntimeSessionId");
+var RuntimeItemId = makeEntityId("RuntimeItemId");
+var RuntimeRequestId = makeEntityId("RuntimeRequestId");
+var RuntimeTaskId = makeEntityId("RuntimeTaskId");
+var ApprovalRequestId = makeEntityId("ApprovalRequestId");
+var CheckpointRef = makeEntityId("CheckpointRef");
+var RemoteEndpointId = makeEntityId("RemoteEndpointId");
+export {
+  WorktreeId,
+  WorkspaceId,
+  ValidationResultId,
+  TurnId,
+  TrimmedString,
+  TrimmedNonEmptyString,
+  ThreadId,
+  TaskId,
+  RuntimeTaskId,
+  RuntimeSessionId,
+  RuntimeRequestId,
+  RuntimeItemId,
+  RunId,
+  ReviewResultId,
+  RemoteEndpointId,
+  ProviderItemId,
+  ProjectId,
+  PositiveInt,
+  NonNegativeInt,
+  MessageId,
+  IsoDateTime,
+  GraphId,
+  EventId,
+  EngineRuntimeId,
+  ConversationId,
+  CommandId,
+  CheckpointRef,
+  ArtifactId,
+  ApprovalRequestId,
+  ActionId
+};

package/dist/src/config.js

@@ -0,0 +1,214 @@
+// @bun
+// packages/contracts/src/config.ts
+import { Schema as Schema2 } from "effect";
+
+// packages/contracts/src/plugin.ts
+import { Schema } from "effect";
+var ValidatorCategory = Schema.Literals([
+  "boundary",
+  "contract",
+  "integration",
+  "regression",
+  "external",
+  "custom"
+]);
+var ValidatorRegistration = Schema.Struct({
+  id: Schema.String,
+  category: ValidatorCategory,
+  description: Schema.optional(Schema.String)
+});
+var HookEvent = Schema.Literals([
+  "PreToolUse",
+  "PostToolUse",
+  "UserPromptSubmit",
+  "Stop",
+  "SessionStart",
+  "SessionEnd"
+]);
+var HookMatcher = Schema.Union([
+  Schema.Struct({ kind: Schema.Literal("all") }),
+  Schema.Struct({ kind: Schema.Literal("tool"), name: Schema.String }),
+  Schema.Struct({ kind: Schema.Literal("glob"), pattern: Schema.String })
+]);
+var HookRegistration = Schema.Struct({
+  id: Schema.String,
+  event: HookEvent,
+  matcher: HookMatcher,
+  command: Schema.optional(Schema.String),
+  description: Schema.optional(Schema.String)
+});
+var SkillRegistration = Schema.Struct({
+  id: Schema.String,
+  path: Schema.String,
+  description: Schema.optional(Schema.String)
+});
+var RepoSourceRegistration = Schema.Struct({
+  id: Schema.String,
+  url: Schema.String,
+  defaultPath: Schema.optional(Schema.String),
+  description: Schema.optional(Schema.String),
+  defaultBranch: Schema.optional(Schema.String),
+  remoteEnvVar: Schema.optional(Schema.String),
+  checkoutEnvVar: Schema.optional(Schema.String)
+});
+var AgentRoleRegistration = Schema.Struct({
+  id: Schema.String,
+  defaultModel: Schema.optional(Schema.String),
+  description: Schema.optional(Schema.String)
+});
+var TaskFieldExtension = Schema.Struct({
+  id: Schema.String,
+  fieldName: Schema.String,
+  schemaJson: Schema.String
+});
+var TaskSourceKind = Schema.String;
+var TaskSourceRegistration = Schema.Struct({
+  id: Schema.String,
+  kind: Schema.String,
+  description: Schema.optional(Schema.String)
+});
+var CliCommandRegistration = Schema.Struct({
+  id: Schema.String,
+  command: Schema.String,
+  description: Schema.optional(Schema.String)
+});
+var PluginContributes = Schema.Struct({
+  validators: Schema.optional(Schema.Array(ValidatorRegistration)),
+  hooks: Schema.optional(Schema.Array(HookRegistration)),
+  skills: Schema.optional(Schema.Array(SkillRegistration)),
+  repoSources: Schema.optional(Schema.Array(RepoSourceRegistration)),
+  agentRoles: Schema.optional(Schema.Array(AgentRoleRegistration)),
+  taskFieldSchemas: Schema.optional(Schema.Array(TaskFieldExtension)),
+  taskSources: Schema.optional(Schema.Array(TaskSourceRegistration)),
+  cliCommands: Schema.optional(Schema.Array(CliCommandRegistration))
+});
+var RigPlugin = Schema.Struct({
+  name: Schema.String,
+  version: Schema.String,
+  contributes: Schema.optional(PluginContributes)
+});
+
+// packages/contracts/src/config.ts
+var WorkspaceIsolation = Schema2.Literals([
+  "worktree",
+  "directory"
+]);
+var ScopeSearchPrefix = Schema2.Struct({
+  prefix: Schema2.String,
+  matchStartsWith: Schema2.optional(Schema2.Array(Schema2.String)),
+  matchExact: Schema2.optional(Schema2.Array(Schema2.String))
+});
+var ScopeNormalizationRules = Schema2.Struct({
+  stripPrefixes: Schema2.optional(Schema2.Array(Schema2.String)),
+  searchPrefixes: Schema2.optional(Schema2.Array(ScopeSearchPrefix))
+});
+var WorkspaceConfig = Schema2.Struct({
+  mainRepo: Schema2.String,
+  isolation: WorkspaceIsolation,
+  scopeNormalization: Schema2.optional(ScopeNormalizationRules)
+});
+var TaskSourceConfig = Schema2.Struct({
+  kind: Schema2.String,
+  path: Schema2.optional(Schema2.String),
+  owner: Schema2.optional(Schema2.String),
+  repo: Schema2.optional(Schema2.String),
+  labels: Schema2.optional(Schema2.Array(Schema2.String)),
+  state: Schema2.optional(Schema2.Literals(["open", "closed", "all"])),
+  url: Schema2.optional(Schema2.String),
+  options: Schema2.optional(Schema2.Record(Schema2.String, Schema2.Unknown))
+});
+var RuntimeHarness = Schema2.Literals(["pi", "claude-code", "codex"]);
+var RigRuntimeMode = Schema2.Literals(["yolo", "approval-required"]);
+var RuntimeConfig = Schema2.Struct({
+  agentRoles: Schema2.optional(Schema2.Record(Schema2.String, Schema2.Unknown)),
+  timeouts: Schema2.optional(Schema2.Record(Schema2.String, Schema2.Number)),
+  harness: Schema2.optional(RuntimeHarness),
+  model: Schema2.optional(Schema2.String),
+  mode: Schema2.optional(RigRuntimeMode)
+});
+var ProjectIdentity = Schema2.Struct({
+  name: Schema2.String,
+  repo: Schema2.optional(Schema2.String)
+});
+var PlanningConfig = Schema2.Struct({
+  mode: Schema2.optional(Schema2.Literals(["auto", "always", "off"])),
+  requireForLabels: Schema2.optional(Schema2.Array(Schema2.String)),
+  skipForLabels: Schema2.optional(Schema2.Array(Schema2.String))
+});
+var GitHubProjectStatusConfig = Schema2.Struct({
+  enabled: Schema2.optional(Schema2.Boolean),
+  projectId: Schema2.optional(Schema2.String),
+  statusFieldId: Schema2.optional(Schema2.String),
+  statuses: Schema2.optional(Schema2.Struct({
+    running: Schema2.optional(Schema2.String),
+    prOpen: Schema2.optional(Schema2.String),
+    ciFixing: Schema2.optional(Schema2.String),
+    done: Schema2.optional(Schema2.String),
+    needsAttention: Schema2.optional(Schema2.String)
+  }))
+});
+var GitHubConfig = Schema2.Struct({
+  issueUpdates: Schema2.optional(Schema2.Literals(["lifecycle", "minimal", "off"])),
+  projects: Schema2.optional(GitHubProjectStatusConfig)
+});
+var AutomationConfig = Schema2.Struct({
+  maxValidationAttempts: Schema2.optional(Schema2.Number),
+  maxPrFixIterations: Schema2.optional(Schema2.Number)
+});
+var PullRequestConfig = Schema2.Struct({
+  mode: Schema2.optional(Schema2.Literals(["auto", "ask", "off"])),
+  watchChecks: Schema2.optional(Schema2.Boolean),
+  autoFixChecks: Schema2.optional(Schema2.Boolean),
+  autoFixReview: Schema2.optional(Schema2.Boolean)
+});
+var MergeConfig = Schema2.Struct({
+  mode: Schema2.optional(Schema2.Literals(["auto", "off", "pr-ready"])),
+  method: Schema2.optional(Schema2.Literals(["repo-default", "squash", "merge", "rebase"])),
+  deleteBranch: Schema2.optional(Schema2.Union([Schema2.Literal("repo-default"), Schema2.Boolean])),
+  allowedFailures: Schema2.optional(Schema2.Array(Schema2.String)),
+  bypass: Schema2.optional(Schema2.Boolean)
+});
+var IssueAnalysisConfig = Schema2.Struct({
+  enabled: Schema2.optional(Schema2.Boolean),
+  harness: Schema2.optional(Schema2.Literal("pi")),
+  model: Schema2.optional(Schema2.String),
+  mode: Schema2.optional(Schema2.Literals(["continuous", "off"]))
+});
+var ReviewConfig = Schema2.Struct({
+  mode: Schema2.optional(Schema2.Literals(["off", "advisory", "required"])),
+  provider: Schema2.optional(Schema2.Literal("greptile"))
+});
+var RigConfig = Schema2.Struct({
+  project: ProjectIdentity,
+  plugins: Schema2.Array(RigPlugin),
+  taskSource: TaskSourceConfig,
+  workspace: WorkspaceConfig,
+  runtime: Schema2.optional(RuntimeConfig),
+  planning: Schema2.optional(PlanningConfig),
+  github: Schema2.optional(GitHubConfig),
+  automation: Schema2.optional(AutomationConfig),
+  pr: Schema2.optional(PullRequestConfig),
+  merge: Schema2.optional(MergeConfig),
+  review: Schema2.optional(ReviewConfig),
+  issueAnalysis: Schema2.optional(IssueAnalysisConfig)
+});
+export {
+  WorkspaceIsolation,
+  WorkspaceConfig,
+  TaskSourceConfig,
+  ScopeSearchPrefix,
+  ScopeNormalizationRules,
+  RuntimeHarness,
+  RuntimeConfig,
+  RigRuntimeMode,
+  RigConfig,
+  ReviewConfig,
+  PullRequestConfig,
+  ProjectIdentity,
+  PlanningConfig,
+  MergeConfig,
+  IssueAnalysisConfig,
+  GitHubProjectStatusConfig,
+  GitHubConfig,
+  AutomationConfig
+};

package/dist/src/conversation.js

@@ -0,0 +1,95 @@
+// @bun
+// packages/contracts/src/conversation.ts
+import { Schema as Schema2 } from "effect";
+
+// packages/contracts/src/baseSchemas.ts
+import { Schema } from "effect";
+var TrimmedString = Schema.Trim;
+var TrimmedNonEmptyString = TrimmedString.check(Schema.isNonEmpty());
+var NonNegativeInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(0));
+var PositiveInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(1));
+var IsoDateTime = Schema.String;
+var makeEntityId = (brand) => TrimmedNonEmptyString.pipe(Schema.brand(brand));
+var ThreadId = makeEntityId("ThreadId");
+var ProjectId = makeEntityId("ProjectId");
+var WorkspaceId = makeEntityId("WorkspaceId");
+var GraphId = makeEntityId("GraphId");
+var TaskId = makeEntityId("TaskId");
+var RunId = makeEntityId("RunId");
+var EngineRuntimeId = makeEntityId("EngineRuntimeId");
+var ConversationId = makeEntityId("ConversationId");
+var ActionId = makeEntityId("ActionId");
+var ArtifactId = makeEntityId("ArtifactId");
+var WorktreeId = makeEntityId("WorktreeId");
+var ValidationResultId = makeEntityId("ValidationResultId");
+var ReviewResultId = makeEntityId("ReviewResultId");
+var CommandId = makeEntityId("CommandId");
+var EventId = makeEntityId("EventId");
+var MessageId = makeEntityId("MessageId");
+var TurnId = makeEntityId("TurnId");
+var ProviderItemId = makeEntityId("ProviderItemId");
+var RuntimeSessionId = makeEntityId("RuntimeSessionId");
+var RuntimeItemId = makeEntityId("RuntimeItemId");
+var RuntimeRequestId = makeEntityId("RuntimeRequestId");
+var RuntimeTaskId = makeEntityId("RuntimeTaskId");
+var ApprovalRequestId = makeEntityId("ApprovalRequestId");
+var CheckpointRef = makeEntityId("CheckpointRef");
+var RemoteEndpointId = makeEntityId("RemoteEndpointId");
+
+// packages/contracts/src/conversation.ts
+var EngineMessageRole = Schema2.Literals(["user", "assistant", "system"]);
+var EngineMessageState = Schema2.Literals([
+  "streaming",
+  "completed",
+  "interrupted",
+  "errored"
+]);
+var ConversationSummary = Schema2.Struct({
+  id: ConversationId,
+  runId: RunId,
+  title: TrimmedNonEmptyString,
+  createdAt: IsoDateTime,
+  updatedAt: IsoDateTime
+});
+var EngineMessage = Schema2.Struct({
+  id: MessageId,
+  conversationId: ConversationId,
+  role: EngineMessageRole,
+  text: Schema2.String,
+  attachments: Schema2.Array(Schema2.Unknown),
+  state: EngineMessageState,
+  createdAt: IsoDateTime,
+  completedAt: Schema2.NullOr(IsoDateTime)
+});
+var EngineAction = Schema2.Struct({
+  id: ActionId,
+  runId: RunId,
+  messageId: Schema2.NullOr(MessageId),
+  actionType: TrimmedNonEmptyString,
+  title: TrimmedNonEmptyString,
+  detail: Schema2.NullOr(Schema2.String),
+  state: TrimmedNonEmptyString,
+  payload: Schema2.Unknown,
+  startedAt: IsoDateTime,
+  completedAt: Schema2.NullOr(IsoDateTime)
+});
+var EngineLogTone = Schema2.Literals(["thinking", "tool", "info", "error"]);
+var EngineRunLog = Schema2.Struct({
+  id: TrimmedNonEmptyString,
+  runId: RunId,
+  title: TrimmedNonEmptyString,
+  detail: Schema2.NullOr(Schema2.String),
+  tone: EngineLogTone,
+  status: Schema2.NullOr(TrimmedNonEmptyString),
+  payload: Schema2.Unknown,
+  createdAt: IsoDateTime
+});
+export {
+  EngineRunLog,
+  EngineMessageState,
+  EngineMessageRole,
+  EngineMessage,
+  EngineLogTone,
+  EngineAction,
+  ConversationSummary
+};

package/dist/src/editor.js

@@ -0,0 +1,55 @@
+// @bun
+// packages/contracts/src/editor.ts
+import { Schema as Schema2 } from "effect";
+
+// packages/contracts/src/baseSchemas.ts
+import { Schema } from "effect";
+var TrimmedString = Schema.Trim;
+var TrimmedNonEmptyString = TrimmedString.check(Schema.isNonEmpty());
+var NonNegativeInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(0));
+var PositiveInt = Schema.Int.check(Schema.isGreaterThanOrEqualTo(1));
+var IsoDateTime = Schema.String;
+var makeEntityId = (brand) => TrimmedNonEmptyString.pipe(Schema.brand(brand));
+var ThreadId = makeEntityId("ThreadId");
+var ProjectId = makeEntityId("ProjectId");
+var WorkspaceId = makeEntityId("WorkspaceId");
+var GraphId = makeEntityId("GraphId");
+var TaskId = makeEntityId("TaskId");
+var RunId = makeEntityId("RunId");
+var EngineRuntimeId = makeEntityId("EngineRuntimeId");
+var ConversationId = makeEntityId("ConversationId");
+var ActionId = makeEntityId("ActionId");
+var ArtifactId = makeEntityId("ArtifactId");
+var WorktreeId = makeEntityId("WorktreeId");
+var ValidationResultId = makeEntityId("ValidationResultId");
+var ReviewResultId = makeEntityId("ReviewResultId");
+var CommandId = makeEntityId("CommandId");
+var EventId = makeEntityId("EventId");
+var MessageId = makeEntityId("MessageId");
+var TurnId = makeEntityId("TurnId");
+var ProviderItemId = makeEntityId("ProviderItemId");
+var RuntimeSessionId = makeEntityId("RuntimeSessionId");
+var RuntimeItemId = makeEntityId("RuntimeItemId");
+var RuntimeRequestId = makeEntityId("RuntimeRequestId");
+var RuntimeTaskId = makeEntityId("RuntimeTaskId");
+var ApprovalRequestId = makeEntityId("ApprovalRequestId");
+var CheckpointRef = makeEntityId("CheckpointRef");
+var RemoteEndpointId = makeEntityId("RemoteEndpointId");
+
+// packages/contracts/src/editor.ts
+var EDITORS = [
+  { id: "cursor", label: "Cursor", command: "cursor" },
+  { id: "vscode", label: "VS Code", command: "code" },
+  { id: "zed", label: "Zed", command: "zed" },
+  { id: "file-manager", label: "File Manager", command: null }
+];
+var EditorId = Schema2.Literals(EDITORS.map((e) => e.id));
+var OpenInEditorInput = Schema2.Struct({
+  cwd: TrimmedNonEmptyString,
+  editor: EditorId
+});
+export {
+  OpenInEditorInput,
+  EditorId,
+  EDITORS
+};