@sylphx/contract 0.2.0

package/dist/endpoints/databases.d.ts

@@ -0,0 +1,251 @@
+/**
+ * Databases endpoints — surfaced through the unified `/resources` router
+ * (`kind=database`). Mirrors `apps/api/src/server/platform/routes/management/resources/*`.
+ * Backups/restore/branch are CNPG-only; bindings apply to every resource kind.
+ */
+import { Schema } from 'effect';
+export declare const databasesEndpoints: {
+    readonly list: import("../endpoint.js").Endpoint<"GET", "/resources", Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        kind: Schema.optional<typeof Schema.String>;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        data: Schema.Array$<Schema.Struct<{
+            id: Schema.brand<Schema.filter<typeof Schema.String>, "DatabaseId">;
+            name: typeof Schema.String;
+            slug: Schema.optional<typeof Schema.String>;
+            status: typeof Schema.String;
+            kind: Schema.optional<typeof Schema.String>;
+            tier: typeof Schema.String;
+            host: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+            directHost: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+            port: Schema.optional<typeof Schema.Number>;
+            publicPort: Schema.optional<Schema.NullOr<typeof Schema.Number>>;
+            dbUser: Schema.optional<typeof Schema.String>;
+            dbName: Schema.optional<typeof Schema.String>;
+            connectionString: Schema.optional<typeof Schema.String>;
+            storageGb: Schema.optional<typeof Schema.Number>;
+            env: Schema.optional<typeof Schema.String>;
+            engine: Schema.optional<typeof Schema.String>;
+            instances: Schema.optional<typeof Schema.Number>;
+            clusterName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+            branchName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+            provider: Schema.optional<typeof Schema.String>;
+            backupRetentionDays: Schema.optional<typeof Schema.Number>;
+            reconcileStatus: Schema.optional<typeof Schema.String>;
+            config: Schema.optional<Schema.NullOr<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>>;
+            createdAt: Schema.optional<typeof Schema.String>;
+            updatedAt: Schema.optional<typeof Schema.String>;
+        }>>;
+    }>>;
+    readonly create: import("../endpoint.js").Endpoint<"POST", "/resources", Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        name: typeof Schema.String;
+        kind: Schema.Literal<["database", "kv", "blob", "search", "volume"]>;
+        provider: Schema.optional<typeof Schema.String>;
+        tier: Schema.optional<typeof Schema.String>;
+        env: Schema.optional<typeof Schema.String>;
+        storageGb: Schema.optional<typeof Schema.Number>;
+        maxMemoryMb: Schema.optional<typeof Schema.Number>;
+        nodes: Schema.optional<typeof Schema.Number>;
+        bucket: Schema.optional<typeof Schema.String>;
+        endpoint: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        region: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        accessKeyEncrypted: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        secretKeyEncrypted: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        accessMode: Schema.optional<Schema.Literal<["ReadWriteOnce", "ReadWriteMany"]>>;
+        sizeGb: Schema.optional<Schema.NullOr<typeof Schema.Number>>;
+        mountPath: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        config: Schema.optional<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    }>, Schema.Struct<{
+        id: Schema.brand<Schema.filter<typeof Schema.String>, "DatabaseId">;
+        name: typeof Schema.String;
+        slug: Schema.optional<typeof Schema.String>;
+        status: typeof Schema.String;
+        kind: Schema.optional<typeof Schema.String>;
+        tier: typeof Schema.String;
+        host: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        directHost: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        port: Schema.optional<typeof Schema.Number>;
+        publicPort: Schema.optional<Schema.NullOr<typeof Schema.Number>>;
+        dbUser: Schema.optional<typeof Schema.String>;
+        dbName: Schema.optional<typeof Schema.String>;
+        connectionString: Schema.optional<typeof Schema.String>;
+        storageGb: Schema.optional<typeof Schema.Number>;
+        env: Schema.optional<typeof Schema.String>;
+        engine: Schema.optional<typeof Schema.String>;
+        instances: Schema.optional<typeof Schema.Number>;
+        clusterName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        branchName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        provider: Schema.optional<typeof Schema.String>;
+        backupRetentionDays: Schema.optional<typeof Schema.Number>;
+        reconcileStatus: Schema.optional<typeof Schema.String>;
+        config: Schema.optional<Schema.NullOr<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>>;
+        createdAt: Schema.optional<typeof Schema.String>;
+        updatedAt: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly get: import("../endpoint.js").Endpoint<"GET", "/resources/:id", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        id: Schema.brand<Schema.filter<typeof Schema.String>, "DatabaseId">;
+        name: typeof Schema.String;
+        slug: Schema.optional<typeof Schema.String>;
+        status: typeof Schema.String;
+        kind: Schema.optional<typeof Schema.String>;
+        tier: typeof Schema.String;
+        host: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        directHost: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        port: Schema.optional<typeof Schema.Number>;
+        publicPort: Schema.optional<Schema.NullOr<typeof Schema.Number>>;
+        dbUser: Schema.optional<typeof Schema.String>;
+        dbName: Schema.optional<typeof Schema.String>;
+        connectionString: Schema.optional<typeof Schema.String>;
+        storageGb: Schema.optional<typeof Schema.Number>;
+        env: Schema.optional<typeof Schema.String>;
+        engine: Schema.optional<typeof Schema.String>;
+        instances: Schema.optional<typeof Schema.Number>;
+        clusterName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        branchName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        provider: Schema.optional<typeof Schema.String>;
+        backupRetentionDays: Schema.optional<typeof Schema.Number>;
+        reconcileStatus: Schema.optional<typeof Schema.String>;
+        config: Schema.optional<Schema.NullOr<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>>;
+        createdAt: Schema.optional<typeof Schema.String>;
+        updatedAt: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly update: import("../endpoint.js").Endpoint<"PATCH", "/resources/:id", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>, Schema.Struct<{
+        id: Schema.brand<Schema.filter<typeof Schema.String>, "DatabaseId">;
+        name: typeof Schema.String;
+        slug: Schema.optional<typeof Schema.String>;
+        status: typeof Schema.String;
+        kind: Schema.optional<typeof Schema.String>;
+        tier: typeof Schema.String;
+        host: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        directHost: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        port: Schema.optional<typeof Schema.Number>;
+        publicPort: Schema.optional<Schema.NullOr<typeof Schema.Number>>;
+        dbUser: Schema.optional<typeof Schema.String>;
+        dbName: Schema.optional<typeof Schema.String>;
+        connectionString: Schema.optional<typeof Schema.String>;
+        storageGb: Schema.optional<typeof Schema.Number>;
+        env: Schema.optional<typeof Schema.String>;
+        engine: Schema.optional<typeof Schema.String>;
+        instances: Schema.optional<typeof Schema.Number>;
+        clusterName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        branchName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        provider: Schema.optional<typeof Schema.String>;
+        backupRetentionDays: Schema.optional<typeof Schema.Number>;
+        reconcileStatus: Schema.optional<typeof Schema.String>;
+        config: Schema.optional<Schema.NullOr<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>>;
+        createdAt: Schema.optional<typeof Schema.String>;
+        updatedAt: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly delete: import("../endpoint.js").Endpoint<"DELETE", "/resources/:id", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        success: Schema.optional<typeof Schema.Boolean>;
+    }>>;
+    readonly metrics: import("../endpoint.js").Endpoint<"GET", "/resources/:id/metrics", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>;
+    readonly backups: import("../endpoint.js").Endpoint<"GET", "/resources/:id/backups", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        backups: Schema.Array$<Schema.Struct<{
+            name: typeof Schema.String;
+            startedAt: Schema.NullOr<typeof Schema.String>;
+            completedAt: Schema.NullOr<typeof Schema.String>;
+            status: typeof Schema.String;
+            method: typeof Schema.String;
+        }>>;
+        available: typeof Schema.Boolean;
+        reason: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly restore: import("../endpoint.js").Endpoint<"POST", "/resources/:id/restore", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        targetTime: typeof Schema.String;
+    }>, Schema.Struct<{
+        restored: typeof Schema.Boolean;
+        resourceId: Schema.optional<typeof Schema.String>;
+        clusterName: Schema.optional<typeof Schema.String>;
+        targetTime: Schema.optional<typeof Schema.String>;
+        message: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly restoreInPlace: import("../endpoint.js").Endpoint<"POST", "/resources/:id/restore-in-place", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        targetTime: typeof Schema.String;
+    }>, Schema.Struct<{
+        restored: typeof Schema.Boolean;
+        resourceId: Schema.optional<typeof Schema.String>;
+        clusterName: Schema.optional<typeof Schema.String>;
+        targetTime: Schema.optional<typeof Schema.String>;
+        message: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly branch: import("../endpoint.js").Endpoint<"POST", "/resources/:id/branch", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        name: Schema.optional<typeof Schema.String>;
+        env: Schema.optional<typeof Schema.String>;
+        fast: Schema.optional<typeof Schema.Boolean>;
+        sourceEnvironmentId: Schema.optional<typeof Schema.String>;
+        targetEnvironmentId: Schema.optional<typeof Schema.String>;
+    }>, Schema.Struct<{
+        id: Schema.brand<Schema.filter<typeof Schema.String>, "DatabaseId">;
+        name: typeof Schema.String;
+        slug: Schema.optional<typeof Schema.String>;
+        status: typeof Schema.String;
+        kind: Schema.optional<typeof Schema.String>;
+        tier: typeof Schema.String;
+        host: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        directHost: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        port: Schema.optional<typeof Schema.Number>;
+        publicPort: Schema.optional<Schema.NullOr<typeof Schema.Number>>;
+        dbUser: Schema.optional<typeof Schema.String>;
+        dbName: Schema.optional<typeof Schema.String>;
+        connectionString: Schema.optional<typeof Schema.String>;
+        storageGb: Schema.optional<typeof Schema.Number>;
+        env: Schema.optional<typeof Schema.String>;
+        engine: Schema.optional<typeof Schema.String>;
+        instances: Schema.optional<typeof Schema.Number>;
+        clusterName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        branchName: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        provider: Schema.optional<typeof Schema.String>;
+        backupRetentionDays: Schema.optional<typeof Schema.Number>;
+        reconcileStatus: Schema.optional<typeof Schema.String>;
+        config: Schema.optional<Schema.NullOr<Schema.Record$<typeof Schema.String, typeof Schema.Unknown>>>;
+        createdAt: Schema.optional<typeof Schema.String>;
+        updatedAt: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly listBindings: import("../endpoint.js").Endpoint<"GET", "/resources/:id/bindings", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        bindings: Schema.Array$<Schema.Struct<{
+            id: typeof Schema.String;
+            resourceId: typeof Schema.String;
+            projectEnvironmentId: typeof Schema.String;
+            role: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+            createdAt: Schema.optional<typeof Schema.String>;
+        }>>;
+    }>>;
+    readonly createBinding: import("../endpoint.js").Endpoint<"POST", "/resources/:id/bindings", Schema.Struct<{
+        id: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        projectEnvironmentId: Schema.optional<typeof Schema.String>;
+        environmentId: Schema.optional<typeof Schema.String>;
+        role: Schema.optional<typeof Schema.String>;
+    }>, Schema.Struct<{
+        id: typeof Schema.String;
+        resourceId: typeof Schema.String;
+        projectEnvironmentId: typeof Schema.String;
+        role: Schema.optional<Schema.NullOr<typeof Schema.String>>;
+        createdAt: Schema.optional<typeof Schema.String>;
+    }>>;
+    readonly deleteBinding: import("../endpoint.js").Endpoint<"DELETE", "/resources/:id/bindings/:bindingId", Schema.Struct<{
+        id: typeof Schema.String;
+        bindingId: typeof Schema.String;
+    }>, Schema.Schema.AnyNoContext | undefined, Schema.Schema.AnyNoContext | undefined, Schema.Struct<{
+        success: typeof Schema.Boolean;
+    }>>;
+};
+//# sourceMappingURL=databases.d.ts.map

package/dist/endpoints/databases.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"databases.d.ts","sourceRoot":"","sources":["../../src/endpoints/databases.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AA8C/B,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8GrB,CAAA"}

package/dist/endpoints/databases.js

@@ -0,0 +1,150 @@
+/**
+ * Databases endpoints — surfaced through the unified `/resources` router
+ * (`kind=database`). Mirrors `apps/api/src/server/platform/routes/management/resources/*`.
+ * Backups/restore/branch are CNPG-only; bindings apply to every resource kind.
+ */
+import { Schema } from 'effect';
+import { defineEndpoint } from '../endpoint.js';
+import { BranchDatabaseInput, CreateBindingInput, Database, DatabaseBackupList, DatabaseResourceBinding, RestoreDatabaseInput, RestoreDatabaseResult, } from '../schemas/database.js';
+const IdPath = Schema.Struct({ id: Schema.String });
+const BindingPath = Schema.Struct({ id: Schema.String, bindingId: Schema.String });
+const KindQuery = Schema.Struct({ kind: Schema.optional(Schema.String) });
+/**
+ * `POST /resources` accepts every managed resource kind — not just
+ * databases. Widened in Wave 2d to match the handler's kind-dispatching
+ * surface (database | kv | blob | search | volume). Per-kind body shapes
+ * differ widely (backups, buckets, memory limits, volume sizes, etc.), so
+ * we model the union as a base struct + open config — exhaustive per-kind
+ * refinement is a future ADR-084 wave when each kind gets its own schema.
+ */
+const CreateResourceBody = Schema.Struct({
+    name: Schema.String,
+    kind: Schema.Literal('database', 'kv', 'blob', 'search', 'volume'),
+    provider: Schema.optional(Schema.String),
+    tier: Schema.optional(Schema.String),
+    env: Schema.optional(Schema.String),
+    storageGb: Schema.optional(Schema.Number),
+    maxMemoryMb: Schema.optional(Schema.Number),
+    nodes: Schema.optional(Schema.Number),
+    bucket: Schema.optional(Schema.String),
+    endpoint: Schema.optional(Schema.NullOr(Schema.String)),
+    region: Schema.optional(Schema.NullOr(Schema.String)),
+    accessKeyEncrypted: Schema.optional(Schema.NullOr(Schema.String)),
+    secretKeyEncrypted: Schema.optional(Schema.NullOr(Schema.String)),
+    accessMode: Schema.optional(Schema.Literal('ReadWriteOnce', 'ReadWriteMany')),
+    sizeGb: Schema.optional(Schema.NullOr(Schema.Number)),
+    mountPath: Schema.optional(Schema.NullOr(Schema.String)),
+    config: Schema.optional(Schema.Record({ key: Schema.String, value: Schema.Unknown })),
+});
+const MetricsResponse = Schema.Record({ key: Schema.String, value: Schema.Unknown });
+export const databasesEndpoints = {
+    list: defineEndpoint({
+        method: 'GET',
+        path: '/resources',
+        query: KindQuery,
+        response: Schema.Struct({ data: Schema.Array(Database) }),
+        summary: 'List resources (filter via ?kind=database|kv|blob|search|volume)',
+        tags: ['databases'],
+    }),
+    create: defineEndpoint({
+        method: 'POST',
+        path: '/resources',
+        body: CreateResourceBody,
+        response: Database,
+        summary: 'Provision a new resource (database|kv|blob|search|volume — async, 202)',
+        tags: ['databases'],
+    }),
+    get: defineEndpoint({
+        method: 'GET',
+        path: '/resources/:id',
+        params: IdPath,
+        response: Database,
+        summary: 'Get a resource (includes live status)',
+        tags: ['databases'],
+    }),
+    update: defineEndpoint({
+        method: 'PATCH',
+        path: '/resources/:id',
+        params: IdPath,
+        body: Schema.Record({ key: Schema.String, value: Schema.Unknown }),
+        response: Database,
+        summary: 'Update resource name and/or config patch',
+        tags: ['databases'],
+    }),
+    delete: defineEndpoint({
+        method: 'DELETE',
+        path: '/resources/:id',
+        params: IdPath,
+        response: Schema.Struct({ success: Schema.optional(Schema.Boolean) }),
+        summary: 'Deprovision a resource (204 on success, 409 when bindings exist)',
+        tags: ['databases'],
+    }),
+    metrics: defineEndpoint({
+        method: 'GET',
+        path: '/resources/:id/metrics',
+        params: IdPath,
+        response: MetricsResponse,
+        summary: 'Prometheus metrics snapshot (adapts by resource kind)',
+        tags: ['databases'],
+    }),
+    backups: defineEndpoint({
+        method: 'GET',
+        path: '/resources/:id/backups',
+        params: IdPath,
+        response: DatabaseBackupList,
+        summary: 'List CNPG backups (database-only)',
+        tags: ['databases'],
+    }),
+    restore: defineEndpoint({
+        method: 'POST',
+        path: '/resources/:id/restore',
+        params: IdPath,
+        body: RestoreDatabaseInput,
+        response: RestoreDatabaseResult,
+        summary: 'Point-in-time restore to a new cluster (database-only)',
+        tags: ['databases'],
+    }),
+    restoreInPlace: defineEndpoint({
+        method: 'POST',
+        path: '/resources/:id/restore-in-place',
+        params: IdPath,
+        body: RestoreDatabaseInput,
+        response: RestoreDatabaseResult,
+        summary: 'In-place PITR restore (delete + recreate from B2)',
+        tags: ['databases'],
+    }),
+    branch: defineEndpoint({
+        method: 'POST',
+        path: '/resources/:id/branch',
+        params: IdPath,
+        body: BranchDatabaseInput,
+        response: Database,
+        summary: 'Branch a database (Neon-style copy-on-write or snapshot)',
+        tags: ['databases'],
+    }),
+    listBindings: defineEndpoint({
+        method: 'GET',
+        path: '/resources/:id/bindings',
+        params: IdPath,
+        response: Schema.Struct({ bindings: Schema.Array(DatabaseResourceBinding) }),
+        summary: 'List environment bindings for a resource',
+        tags: ['databases'],
+    }),
+    createBinding: defineEndpoint({
+        method: 'POST',
+        path: '/resources/:id/bindings',
+        params: IdPath,
+        body: CreateBindingInput,
+        response: DatabaseResourceBinding,
+        summary: 'Bind a resource to an environment',
+        tags: ['databases'],
+    }),
+    deleteBinding: defineEndpoint({
+        method: 'DELETE',
+        path: '/resources/:id/bindings/:bindingId',
+        params: BindingPath,
+        response: Schema.Struct({ success: Schema.Boolean }),
+        summary: 'Unbind a resource from an environment',
+        tags: ['databases'],
+    }),
+};