@xemahq/kernel-contracts 0.1.0

package/src/workflow/lib/workspace-manifest-enums.ts

@@ -0,0 +1,143 @@
+// ═══════════════════════════════════════════════════════════════════════════
+// ── Workspace Manifest closed-domain enums ──
+//
+// Kernel-tier closed sets consumed by `@xemahq/workspace-manifest-dsl`,
+// `@xemahq/agent-session-runtime`, the workflow DSL compiler, the
+// llm-registry-api composition seeder, and frontend manifest editors.
+// Each enum keeps the manifest contract auditable end-to-end —
+// Swagger/Orval, Zod, and Prisma all reference these strings, so adding
+// a new value is a single PR that fans out via codegen.
+// ═══════════════════════════════════════════════════════════════════════════
+
+/**
+ * Coarse-grained tool categories an agent may be allowed to use. The
+ * manifest's `spec.permissions.tools.{allow,deny}` lists are filtered
+ * against this closed set so a typo can't silently relax authority.
+ *
+ * `read`/`write` cover file IO on `/workspace/`. `exec` covers shell
+ * execution. `web` covers outbound HTTP. `mcp` is the umbrella for any
+ * tool surface registered via the MCP catalog. `delegate` is the
+ * sub-agent invocation primitive.
+ */
+export enum ToolsetKey {
+  READ = 'read',
+  WRITE = 'write',
+  EXEC = 'exec',
+  WEB = 'web',
+  MCP = 'mcp',
+  DELEGATE = 'delegate',
+}
+
+export const TOOLSET_KEYS: readonly ToolsetKey[] = [
+  ToolsetKey.READ,
+  ToolsetKey.WRITE,
+  ToolsetKey.EXEC,
+  ToolsetKey.WEB,
+  ToolsetKey.MCP,
+  ToolsetKey.DELEGATE,
+] as const;
+
+/**
+ * Credential backends a manifest may bind. `sourceRef` shape is
+ * backend-specific, but the kind is closed so the resolver always
+ * dispatches to a known fetcher.
+ *
+ * `llm-provider` resolves through llm-gateway (per-provider JWT mint).
+ * `scm-token` resolves through scm-integration (per-repo PAT/OAuth).
+ * `oauth-bearer` resolves a generic OAuth bearer (e.g. third-party API).
+ * `mcp-auth` resolves an MCP server-specific auth blob.
+ * `wallet-entry` resolves a user wallet entry (BYO secret).
+ * `generic-secret` falls back to secrets-api by path.
+ */
+export enum CredentialKind {
+  LLM_PROVIDER = 'llm-provider',
+  SCM_TOKEN = 'scm-token',
+  OAUTH_BEARER = 'oauth-bearer',
+  MCP_AUTH = 'mcp-auth',
+  WALLET_ENTRY = 'wallet-entry',
+  GENERIC_SECRET = 'generic-secret',
+}
+
+export const CREDENTIAL_KINDS: readonly CredentialKind[] = [
+  CredentialKind.LLM_PROVIDER,
+  CredentialKind.SCM_TOKEN,
+  CredentialKind.OAUTH_BEARER,
+  CredentialKind.MCP_AUTH,
+  CredentialKind.WALLET_ENTRY,
+  CredentialKind.GENERIC_SECRET,
+] as const;
+
+/**
+ * Kinds of output surface a workspace can expose. Consumed by
+ * `biomes/workspace-proxy/api/workspace-proxy/src/output-surface/engine.ts` to wire route lifecycle.
+ *
+ * `none` is the explicit no-output-surface default (omitting `outputSurface`
+ * is equivalent). `web` is a long-running webserver on `port`. `static`
+ * is a built artifact dir served by the proxy. `app` is a desktop-style
+ * embedded app surface. `tunnel` exposes an arbitrary TCP port via the
+ * proxy's tunnel handler.
+ */
+export enum OutputSurfaceKind {
+  NONE = 'none',
+  WEB = 'web',
+  STATIC = 'static',
+  APP = 'app',
+  TUNNEL = 'tunnel',
+}
+
+export const OUTPUT_SURFACE_KINDS: readonly OutputSurfaceKind[] = [
+  OutputSurfaceKind.NONE,
+  OutputSurfaceKind.WEB,
+  OutputSurfaceKind.STATIC,
+  OutputSurfaceKind.APP,
+  OutputSurfaceKind.TUNNEL,
+] as const;
+
+/**
+ * Execution surfaces a manifest declares compatibility with. Closed set
+ * because compile-time validation pairs this against the action's
+ * `consumes[].surfaces` and the call-site's runtime surface, and
+ * silently accepting an unknown surface would defeat the check.
+ */
+export enum ManifestSurface {
+  WORKFLOW = 'workflow',
+  AGENT_SESSION = 'agent-session',
+}
+
+export const MANIFEST_SURFACES: readonly ManifestSurface[] = [
+  ManifestSurface.WORKFLOW,
+  ManifestSurface.AGENT_SESSION,
+] as const;
+
+/**
+ * Mirror of `GitPushBranchSuffix` in `@xemahq/agent-workspace-contracts`.
+ * Duplicated here to break the circular dependency
+ * (`workspace-manifest-dsl → agent-workspace-contracts → workflow-contracts`).
+ * Values MUST stay in sync — `agent-workspace-contracts` is the kernel
+ * authority; this is the contract mirror that the manifest compiler and
+ * compiled-manifest type live against.
+ */
+export enum ManifestGitPushBranchSuffix {
+  SESSION_ID = 'sessionId',
+  PROJECT_ID = 'projectId',
+}
+
+export const MANIFEST_GIT_PUSH_BRANCH_SUFFIXES: readonly ManifestGitPushBranchSuffix[] = [
+  ManifestGitPushBranchSuffix.SESSION_ID,
+  ManifestGitPushBranchSuffix.PROJECT_ID,
+] as const;
+
+/**
+ * Mirror of `GitPushConcurrencyMode` in `@xemahq/agent-workspace-contracts`.
+ * See `ManifestGitPushBranchSuffix` for the rationale on duplication.
+ */
+export enum ManifestGitPushConcurrencyMode {
+  FORCE = 'force',
+  LEASE = 'lease',
+}
+
+export const MANIFEST_GIT_PUSH_CONCURRENCY_MODES: readonly ManifestGitPushConcurrencyMode[] = [
+  ManifestGitPushConcurrencyMode.FORCE,
+  ManifestGitPushConcurrencyMode.LEASE,
+] as const;
+