@kitman-sh/sdk 0.8.0 → 0.10.52

package/types/packages/core/src/kit-setup.d.ts

@@ -0,0 +1,316 @@
+import * as Schema from 'effect/Schema';
+/** What a Kit's agents get; `instructions` is a Markdown file for the Harness's managed instructions block. */
+export declare const KitSetup: Schema.Struct<{
+    readonly skills: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly name: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly source: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"skills_sh">;
+            readonly slug: Schema.String;
+            readonly version: Schema.optionalKey<Schema.String>;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"kitman">;
+            readonly skillId: Schema.optionalKey<Schema.String>;
+            readonly name: Schema.optionalKey<Schema.String>;
+            readonly contentMarkdown: Schema.optionalKey<Schema.String>;
+            readonly files: Schema.optionalKey<Schema.$Record<Schema.String, Schema.String>>;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"git">;
+            readonly url: Schema.String;
+            readonly ref: Schema.optionalKey<Schema.String>;
+            readonly path: Schema.optionalKey<Schema.String>;
+            readonly sha256: Schema.optionalKey<Schema.String>;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"package">;
+            readonly packageName: Schema.String;
+            readonly version: Schema.String;
+            readonly path: Schema.optionalKey<Schema.String>;
+            readonly sha256: Schema.optionalKey<Schema.String>;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"url">;
+            readonly url: Schema.String;
+            readonly sha256: Schema.String;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"local_path">;
+            readonly path: Schema.String;
+        }>]>;
+        readonly appliesTo: Schema.optionalKey<Schema.Struct<{
+            readonly dependencies: Schema.optionalKey<Schema.$Array<Schema.String>>;
+            readonly files: Schema.optionalKey<Schema.$Array<Schema.String>>;
+        }>>;
+    }>>>;
+    readonly plugins: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly name: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly sources: Schema.NonEmptyArray<Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"package">;
+            readonly packageName: Schema.String;
+            readonly version: Schema.optionalKey<Schema.String>;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"git">;
+            readonly url: Schema.String;
+            readonly ref: Schema.optionalKey<Schema.String>;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"url">;
+            readonly url: Schema.String;
+            readonly sha256: Schema.String;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"local_path">;
+            readonly path: Schema.String;
+        }>]>>;
+    }>>>;
+    readonly mcpServers: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly name: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly transport: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"stdio">;
+            readonly command: Schema.String;
+            readonly args: Schema.optionalKey<Schema.$Array<Schema.String>>;
+            readonly env: Schema.optionalKey<Schema.$Record<Schema.String, Schema.String>>;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"streamable_http">;
+            readonly url: Schema.String;
+            readonly headers: Schema.optionalKey<Schema.$Record<Schema.String, Schema.String>>;
+        }>]>;
+    }>>>;
+    readonly harnessSettings: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly harness: Schema.Union<readonly [Schema.Literal<"opencode">, Schema.Literal<"claude-code">, Schema.Literal<"codex">, Schema.Literal<"pi">]>;
+        readonly key: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly value: Schema.Unknown;
+    }>>>;
+    readonly providerAuthRefs: Schema.optionalKey<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly provider: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly kind: Schema.Literal<"existing_harness_login">;
+        readonly accountHint: Schema.optionalKey<Schema.String>;
+    }>, Schema.Struct<{
+        readonly provider: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly kind: Schema.Literal<"local_env">;
+        readonly envName: Schema.String;
+    }>, Schema.Struct<{
+        readonly provider: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly kind: Schema.Literal<"runner_secret">;
+        readonly runnerSecretName: Schema.String;
+    }>, Schema.Struct<{
+        readonly provider: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly kind: Schema.Literal<"managed_oauth">;
+        readonly grantId: Schema.optionalKey<Schema.String>;
+    }>]>>>;
+    readonly runnerSecretRefs: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly name: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly source: Schema.Union<readonly [Schema.Struct<{
+            readonly kind: Schema.Literal<"env">;
+            readonly envName: Schema.String;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"file">;
+            readonly pathRef: Schema.String;
+        }>, Schema.Struct<{
+            readonly kind: Schema.Literal<"exec">;
+            readonly commandRef: Schema.String;
+        }>]>;
+        readonly capabilities: Schema.optionalKey<Schema.$Array<Schema.String>>;
+    }>>>;
+    readonly permissions: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly key: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly value: Schema.Unknown;
+    }>>>;
+    readonly hooks: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly name: Schema.String;
+        readonly event: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly command: Schema.String;
+        readonly args: Schema.optionalKey<Schema.$Array<Schema.String>>;
+        readonly timeoutMs: Schema.optionalKey<Schema.Finite>;
+    }>>>;
+    readonly runtimeConstraints: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly key: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly value: Schema.Unknown;
+    }>>>;
+    readonly sandboxPolicyRequirements: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly key: Schema.String;
+        readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+        readonly value: Schema.Unknown;
+    }>>>;
+    readonly instructions: Schema.optionalKey<Schema.String>;
+}>;
+export type KitSetup = typeof KitSetup.Type;
+export declare const SetupFile: Schema.Union<readonly [Schema.Struct<{
+    readonly utf8: Schema.String;
+}>, Schema.Struct<{
+    readonly base64: Schema.String;
+}>]>;
+export type SetupFile = typeof SetupFile.Type;
+/**
+ * A built Kit's setup with every file it names, by path in the archive; each source in `setup` is a local path into
+ * `files`. Stored by digest beside program bundles.
+ */
+export declare const SetupArchive: Schema.Struct<{
+    readonly setup: Schema.Struct<{
+        readonly skills: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly name: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly source: Schema.Union<readonly [Schema.Struct<{
+                readonly kind: Schema.Literal<"skills_sh">;
+                readonly slug: Schema.String;
+                readonly version: Schema.optionalKey<Schema.String>;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"kitman">;
+                readonly skillId: Schema.optionalKey<Schema.String>;
+                readonly name: Schema.optionalKey<Schema.String>;
+                readonly contentMarkdown: Schema.optionalKey<Schema.String>;
+                readonly files: Schema.optionalKey<Schema.$Record<Schema.String, Schema.String>>;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"git">;
+                readonly url: Schema.String;
+                readonly ref: Schema.optionalKey<Schema.String>;
+                readonly path: Schema.optionalKey<Schema.String>;
+                readonly sha256: Schema.optionalKey<Schema.String>;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"package">;
+                readonly packageName: Schema.String;
+                readonly version: Schema.String;
+                readonly path: Schema.optionalKey<Schema.String>;
+                readonly sha256: Schema.optionalKey<Schema.String>;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"url">;
+                readonly url: Schema.String;
+                readonly sha256: Schema.String;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"local_path">;
+                readonly path: Schema.String;
+            }>]>;
+            readonly appliesTo: Schema.optionalKey<Schema.Struct<{
+                readonly dependencies: Schema.optionalKey<Schema.$Array<Schema.String>>;
+                readonly files: Schema.optionalKey<Schema.$Array<Schema.String>>;
+            }>>;
+        }>>>;
+        readonly plugins: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly name: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly sources: Schema.NonEmptyArray<Schema.Union<readonly [Schema.Struct<{
+                readonly kind: Schema.Literal<"package">;
+                readonly packageName: Schema.String;
+                readonly version: Schema.optionalKey<Schema.String>;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"git">;
+                readonly url: Schema.String;
+                readonly ref: Schema.optionalKey<Schema.String>;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"url">;
+                readonly url: Schema.String;
+                readonly sha256: Schema.String;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"local_path">;
+                readonly path: Schema.String;
+            }>]>>;
+        }>>>;
+        readonly mcpServers: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly name: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly transport: Schema.Union<readonly [Schema.Struct<{
+                readonly kind: Schema.Literal<"stdio">;
+                readonly command: Schema.String;
+                readonly args: Schema.optionalKey<Schema.$Array<Schema.String>>;
+                readonly env: Schema.optionalKey<Schema.$Record<Schema.String, Schema.String>>;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"streamable_http">;
+                readonly url: Schema.String;
+                readonly headers: Schema.optionalKey<Schema.$Record<Schema.String, Schema.String>>;
+            }>]>;
+        }>>>;
+        readonly harnessSettings: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly harness: Schema.Union<readonly [Schema.Literal<"opencode">, Schema.Literal<"claude-code">, Schema.Literal<"codex">, Schema.Literal<"pi">]>;
+            readonly key: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly value: Schema.Unknown;
+        }>>>;
+        readonly providerAuthRefs: Schema.optionalKey<Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly provider: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly kind: Schema.Literal<"existing_harness_login">;
+            readonly accountHint: Schema.optionalKey<Schema.String>;
+        }>, Schema.Struct<{
+            readonly provider: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly kind: Schema.Literal<"local_env">;
+            readonly envName: Schema.String;
+        }>, Schema.Struct<{
+            readonly provider: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly kind: Schema.Literal<"runner_secret">;
+            readonly runnerSecretName: Schema.String;
+        }>, Schema.Struct<{
+            readonly provider: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly kind: Schema.Literal<"managed_oauth">;
+            readonly grantId: Schema.optionalKey<Schema.String>;
+        }>]>>>;
+        readonly runnerSecretRefs: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly name: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly source: Schema.Union<readonly [Schema.Struct<{
+                readonly kind: Schema.Literal<"env">;
+                readonly envName: Schema.String;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"file">;
+                readonly pathRef: Schema.String;
+            }>, Schema.Struct<{
+                readonly kind: Schema.Literal<"exec">;
+                readonly commandRef: Schema.String;
+            }>]>;
+            readonly capabilities: Schema.optionalKey<Schema.$Array<Schema.String>>;
+        }>>>;
+        readonly permissions: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly key: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly value: Schema.Unknown;
+        }>>>;
+        readonly hooks: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly name: Schema.String;
+            readonly event: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly command: Schema.String;
+            readonly args: Schema.optionalKey<Schema.$Array<Schema.String>>;
+            readonly timeoutMs: Schema.optionalKey<Schema.Finite>;
+        }>>>;
+        readonly runtimeConstraints: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly key: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly value: Schema.Unknown;
+        }>>>;
+        readonly sandboxPolicyRequirements: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+            readonly key: Schema.String;
+            readonly policy: Schema.Union<readonly [Schema.Literal<"recommended">, Schema.Literal<"required">]>;
+            readonly value: Schema.Unknown;
+        }>>>;
+        readonly instructions: Schema.optionalKey<Schema.String>;
+    }>;
+    readonly files: Schema.$Record<Schema.String, Schema.Union<readonly [Schema.Struct<{
+        readonly utf8: Schema.String;
+    }>, Schema.Struct<{
+        readonly base64: Schema.String;
+    }>]>>;
+}>;
+export type SetupArchive = typeof SetupArchive.Type;
+type McpTransport = NonNullable<KitSetup['mcpServers']>[number]['transport'];
+/** The Secrets an MCP server's environment and headers name by `{env:NAME}`. */
+export declare const kitMcpSecretNames: (transport: McpTransport) => string[];
+/** The Secrets the MCP servers of Kit setups in priority order read, the first Kit to name a server winning it. */
+export declare const kitSecretNames: (setups: readonly KitSetup[]) => string[];
+/** The MCP server Kitman provides itself, which no Kit may declare. */
+export declare const kitmanMcpServer = "kitman";
+/** A Kit version a Run was admitted with, from the Owner layer that provides it; `personal` only in a person's sync. */
+export type RunKitPin = {
+    readonly name: string;
+    readonly version: string;
+    readonly setupDigest: string;
+    readonly layer: 'personal' | 'team' | 'workspace' | 'shipped';
+};
+export {};