@sylphx/contract 0.3.0 → 0.5.0

package/dist/schemas/edge-deployments.js

@@ -1,87 +0,0 @@
-/**
- * Edge Deployments — customer code that runs on Cloudflare Workers at the
- * edge. Part of the P1 gap #10 design (`docs/design/edge-functions-isr-image-opt.md`).
- *
- * Plane: `management` — customers call `POST /projects/:id/edge-deployments`
- * via the CLI (`sylphx edge deploy`) to upload a pre-bundled ESM script. The
- * Platform API then speaks to Cloudflare's Workers Platform API on their
- * behalf (credentials never touch the customer machine, per § 8 of the design).
- *
- * The wire shapes are intentionally minimal for the scaffold step. When the
- * real Cloudflare integration lands, `CreateEdgeDeploymentInput` will grow
- * bindings / secrets / dispatch-namespace hints — but every new field must
- * pass through this contract (ADR-084 Rule 1).
- */
-import { Schema } from 'effect';
-// ── Status enum ────────────────────────────────────────────────────────────
-/** Lifecycle of a single edge-deployment row. Mirrors `edge_deployments.state` in the design doc (§ 5). */
-export const EdgeDeploymentStatus = Schema.Literal('pending', // CLI upload accepted, Cloudflare API call not yet made
-'deploying', // Cloudflare API call in-flight
-'active', // Worker script is serving traffic
-'failed', // Cloudflare API returned an error; see `error` field
-'retired');
-// ── Route definition carried alongside each deployment ─────────────────────
-/** A single HTTP method + path combo the worker handles (e.g. GET /api/hello). */
-export const EdgeRoute = Schema.Struct({
-    method: Schema.Literal('GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', '*'),
-    path: Schema.String.pipe(Schema.minLength(1)),
-});
-// ── Entity shape on the wire ───────────────────────────────────────────────
-/** Single deployment record. Mirrors the `edge_deployments` table in the design doc. */
-export const EdgeDeployment = Schema.Struct({
-    /** TypeID `edge_xxx`. */
-    id: Schema.String,
-    /** TypeID `proj_xxx`. */
-    projectId: Schema.String,
-    /** TypeID `env_xxx`. */
-    environmentId: Schema.String,
-    /** Cloudflare dispatch namespace + script id (e.g. `sylphx-prod/proj_abc-v3`). */
-    workerName: Schema.String,
-    /** Cloudflare script tag — opaque per upload, used for rollback. */
-    version: Schema.String,
-    /** Every URL pattern the deployment claims. */
-    routes: Schema.Array(EdgeRoute),
-    status: EdgeDeploymentStatus,
-    /** Populated only when `status === 'failed'`. */
-    error: Schema.NullOr(Schema.String),
-    /** Byte size of the uploaded bundle — useful for quota displays. */
-    bundleSizeBytes: Schema.Number,
-    /** TypeID `user_xxx` of the operator who triggered the deploy. */
-    deployedBy: Schema.String,
-    deployedAt: Schema.String,
-});
-// ── Inputs ─────────────────────────────────────────────────────────────────
-/**
- * Create-deployment body. The `bundle` field carries the raw ESM script as
- * a base64 string — matches the CLI's `bundle → base64 → POST` flow. For
- * larger bundles (> 1 MB) a follow-up multipart endpoint will land; scope
- * for the scaffold is the small-bundle path only.
- */
-export const CreateEdgeDeploymentInput = Schema.Struct({
-    /** Target environment for the deployment (dev / preview / production). */
-    environmentId: Schema.String,
-    /** Base64-encoded ESM worker bundle. */
-    bundle: Schema.String,
-    /** Optional route hints; server can also infer from the bundle on deploy. */
-    routes: Schema.optional(Schema.Array(EdgeRoute)),
-    /** Human label surfaced in the Console deploy list. */
-    label: Schema.optional(Schema.String),
-});
-// ── Responses ──────────────────────────────────────────────────────────────
-export const CreateEdgeDeploymentResult = Schema.Struct({
-    deployment: EdgeDeployment,
-});
-export const ListEdgeDeploymentsResult = Schema.Struct({
-    deployments: Schema.Array(EdgeDeployment),
-    total: Schema.Number,
-});
-export const DeleteEdgeDeploymentResult = Schema.Struct({
-    deleted: Schema.Boolean,
-});
-// ── Query params ───────────────────────────────────────────────────────────
-export const ListEdgeDeploymentsQuery = Schema.Struct({
-    environmentId: Schema.optional(Schema.String),
-    status: Schema.optional(EdgeDeploymentStatus),
-    limit: Schema.optional(Schema.String),
-    offset: Schema.optional(Schema.String),
-});