@sylphx/contract 0.2.0

package/dist/schemas/environment.js

@@ -0,0 +1,211 @@
+/**
+ * Environment — a named deploy target within a project (production, staging,
+ * or an ephemeral preview). Carries lifecycle, DNS, and promotion config.
+ */
+import { Schema } from 'effect';
+import { EnvironmentId, ServiceId } from './ids.js';
+export const Environment = Schema.Struct({
+    id: EnvironmentId,
+    projectId: Schema.optional(Schema.String),
+    projectName: Schema.optional(Schema.String),
+    projectSlug: Schema.optional(Schema.String),
+    name: Schema.String,
+    envType: Schema.String,
+    isActive: Schema.Boolean,
+    publicKey: Schema.optional(Schema.NullOr(Schema.String)),
+    secretKeyPrefix: Schema.optional(Schema.NullOr(Schema.String)),
+    secretKeyLastUsedAt: Schema.optional(Schema.NullOr(Schema.String)),
+    secretKeyRotatedAt: Schema.optional(Schema.NullOr(Schema.String)),
+    hasSecretKey: Schema.optional(Schema.Boolean),
+    hasPublicKey: Schema.optional(Schema.Boolean),
+    hasWebhookSecret: Schema.optional(Schema.Boolean),
+    hasDatabaseBranch: Schema.optional(Schema.Boolean),
+    allowedOrigins: Schema.optional(Schema.NullOr(Schema.Array(Schema.String))),
+    webhookUrl: Schema.optional(Schema.NullOr(Schema.String)),
+    settings: Schema.optional(Schema.NullOr(Schema.Record({ key: Schema.String, value: Schema.Unknown }))),
+    url: Schema.optional(Schema.String),
+    deployAppId: Schema.optional(Schema.NullOr(Schema.String)),
+    namespace: Schema.optional(Schema.NullOr(Schema.String)),
+    createdAt: Schema.optional(Schema.String),
+    updatedAt: Schema.optional(Schema.String),
+    /** Embedded live deploy status (GET /environments/:envId only). */
+    status: Schema.optional(Schema.NullOr(Schema.Struct({
+        status: Schema.String,
+        url: Schema.optional(Schema.NullOr(Schema.String)),
+        lastDeployedAt: Schema.optional(Schema.NullOr(Schema.String)),
+    }))),
+});
+/** Reveal-secret returns a tombstone (prefix only — raw key never stored). */
+export const RevealSecretKeyResult = Schema.Struct({
+    id: EnvironmentId,
+    envType: Schema.String,
+    secretKeyPrefix: Schema.NullOr(Schema.String),
+});
+export const RegenerateWebhookSecretResult = Schema.Struct({
+    environmentId: Schema.String,
+    webhookSecret: Schema.String,
+});
+export const EnvironmentKeys = Schema.Struct({
+    id: EnvironmentId,
+    envType: Schema.String,
+    secretKeyPrefix: Schema.NullOr(Schema.String),
+    publicKey: Schema.NullOr(Schema.String),
+    webhookSecretPrefix: Schema.NullOr(Schema.String),
+});
+export const ProvisionEnvironmentResult = Schema.Struct({
+    envId: EnvironmentId,
+    namespace: Schema.String,
+    status: Schema.String,
+    message: Schema.optional(Schema.String),
+});
+export const CreateEnvironmentInput = Schema.Struct({
+    name: Schema.String,
+    envType: Schema.optional(Schema.String),
+    branchPattern: Schema.optional(Schema.String),
+    autoDeploy: Schema.optional(Schema.Boolean),
+    approvalRequired: Schema.optional(Schema.Boolean),
+    ephemeral: Schema.optional(Schema.Boolean),
+    ttl: Schema.optional(Schema.String),
+});
+export const CreateEnvironmentResult = Schema.Struct({
+    id: EnvironmentId,
+    name: Schema.String,
+    envType: Schema.optional(Schema.String),
+    publicKey: Schema.String,
+    secretKey: Schema.String,
+});
+export const UpdateEnvironmentInput = Schema.Struct({
+    name: Schema.optional(Schema.String),
+    branchPattern: Schema.optional(Schema.String),
+    autoDeploy: Schema.optional(Schema.Boolean),
+    approvalRequired: Schema.optional(Schema.Boolean),
+    ephemeral: Schema.optional(Schema.Boolean),
+    ttl: Schema.optional(Schema.String),
+    allowedOrigins: Schema.optional(Schema.Array(Schema.String)),
+    webhookUrl: Schema.optional(Schema.NullOr(Schema.String)),
+    webhookSecret: Schema.optional(Schema.NullOr(Schema.String)),
+    isActive: Schema.optional(Schema.Boolean),
+    githubRepo: Schema.optional(Schema.NullOr(Schema.String)),
+    githubBranch: Schema.optional(Schema.NullOr(Schema.String)),
+    useCustomRunner: Schema.optional(Schema.Boolean),
+    defaultFromEmail: Schema.optional(Schema.NullOr(Schema.String)),
+    defaultFromName: Schema.optional(Schema.NullOr(Schema.String)),
+    publicNetworking: Schema.optional(Schema.Boolean),
+    protection: Schema.optional(Schema.Literal('open', 'login-required')),
+    runtimeClassName: Schema.optional(Schema.NullOr(Schema.String)),
+    defaultSandboxImage: Schema.optional(Schema.NullOr(Schema.String)),
+    defaultSecurityContext: Schema.optional(Schema.Struct({
+        runAsNonRoot: Schema.optional(Schema.Boolean),
+        allowPrivilegeEscalation: Schema.optional(Schema.Boolean),
+        privileged: Schema.optional(Schema.Boolean),
+    })),
+    settings: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+});
+export const PromoteEnvironmentInput = Schema.Struct({
+    sourceEnvId: EnvironmentId,
+});
+export const PromoteResult = Schema.Struct({
+    promoted: Schema.Number,
+    services: Schema.Array(Schema.Struct({
+        serviceId: ServiceId,
+        image: Schema.String,
+    })),
+    sourceEnvironment: Schema.String,
+    targetEnvironment: Schema.String,
+});
+/**
+ * `GET /environments/projects/:id` — Console-only list-by-project-slug shape.
+ * Surfaces masked key prefixes alongside project metadata so the settings UI
+ * can render env chips without a second round-trip. Added in Wave 2d
+ * (ADR-084) to retire the last `@hono/zod-openapi` route in environments.ts.
+ */
+export const ListEnvironmentsByProjectSlugResult = Schema.Struct({
+    app: Schema.Struct({
+        id: Schema.String,
+        name: Schema.String,
+        slug: Schema.String,
+    }),
+    environments: Schema.Array(Schema.Struct({
+        id: EnvironmentId,
+        envType: Schema.String,
+        name: Schema.String,
+        publicKey: Schema.NullOr(Schema.String),
+        secretKeyPrefix: Schema.NullOr(Schema.String),
+        secretKeyLastUsedAt: Schema.NullOr(Schema.String),
+        secretKeyRotatedAt: Schema.String,
+        isActive: Schema.Boolean,
+    })),
+});
+/**
+ * OAuth provider configuration (BYOK) — per-environment OAuth app credentials.
+ * ADR-084 Wave 3E: contract coverage for the env-scoped BYOK endpoints that
+ * drive `apps/api/src/server/platform/routes/environments/oauth-providers.ts`.
+ * The client secret is never returned to callers — only the `clientId` prefix
+ * plus enable flag + timestamps surface through the API.
+ */
+export const OAuthProviderConfigView = Schema.Struct({
+    provider: Schema.String,
+    clientId: Schema.String,
+    enabled: Schema.Boolean,
+    createdAt: Schema.String,
+    updatedAt: Schema.String,
+});
+export const ListOAuthProvidersResult = Schema.Struct({
+    providers: Schema.Array(OAuthProviderConfigView),
+});
+export const UpsertOAuthProviderInput = Schema.Struct({
+    clientId: Schema.String,
+    clientSecret: Schema.String,
+    enabled: Schema.optional(Schema.Boolean),
+});
+export const UpsertOAuthProviderResult = OAuthProviderConfigView;
+export const DeleteOAuthProviderResult = Schema.Struct({
+    deleted: Schema.Boolean,
+});
+/**
+ * Console-plane environment with exposed secret prefixes + key lifecycle
+ * timestamps. Superset of the BaaS `Environment` shape, kept as a separate
+ * type so internal operator views get tighter inference.
+ */
+export const EnvironmentWithKeys = Environment;
+/** Environment type enum. */
+export const EnvType = Schema.Literal('development', 'staging', 'production');
+/** Environment settings envelope. */
+export const EnvSettings = Schema.Struct({
+    rateLimits: Schema.optional(Schema.Struct({
+        requestsPerMinute: Schema.optional(Schema.Number),
+        requestsPerDay: Schema.optional(Schema.Number),
+    })),
+    loggingLevel: Schema.optional(Schema.Literal('debug', 'info', 'warn', 'error')),
+    testMode: Schema.optional(Schema.Boolean),
+    skipEmailVerification: Schema.optional(Schema.Boolean),
+});
+/** `GET /environments` — list all environments. */
+export const ListEnvironmentsResult = Schema.Struct({
+    environments: Schema.Array(Environment),
+});
+/** `GET /environments/projects/:id` — aliased for hook ergonomics. */
+export const ListEnvironmentsBySlugResult = ListEnvironmentsByProjectSlugResult;
+/** `GET /environments/:envId` — single environment detail. */
+export const GetEnvironmentResult = Environment;
+/** `PATCH /environments/:envId` — returns the updated environment. */
+export const UpdateEnvironmentResult = Environment;
+/** `DELETE /environments/:envId` — standard success envelope. */
+export const DeleteEnvironmentResult = Schema.Struct({
+    success: Schema.Boolean,
+    deletedEnvironmentId: Schema.String,
+});
+/** `GET /environments/logs` — env-scoped log stream (SSE). */
+export const EnvironmentLogEntry = Schema.Struct({
+    timestamp: Schema.String,
+    level: Schema.optional(Schema.NullOr(Schema.String)),
+    message: Schema.String,
+    podName: Schema.optional(Schema.NullOr(Schema.String)),
+    containerName: Schema.optional(Schema.NullOr(Schema.String)),
+    source: Schema.optional(Schema.NullOr(Schema.String)),
+});
+export const EnvironmentLogsResult = Schema.Struct({
+    envId: EnvironmentId,
+    logs: Schema.Array(EnvironmentLogEntry),
+    nextCursor: Schema.optional(Schema.NullOr(Schema.String)),
+});