@fabrika/control-contract 0.0.1

package/package.json

@@ -0,0 +1,30 @@
+{
+	"name": "@fabrika/control-contract",
+	"version": "0.0.1",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/contember/fabrika-platform.git",
+		"directory": "packages/control-contract"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"src"
+	],
+	"exports": {
+		".": {
+			"bun": "./src/index.ts",
+			"types": "./src/index.ts",
+			"default": "./src/index.ts"
+		}
+	},
+	"scripts": {
+		"typecheck": "tsc --noEmit"
+	},
+	"dependencies": {
+		"@fabrika/app": "^0.0.1",
+		"@fabrika/provider-contract": "^0.0.1"
+	}
+}

package/src/index.ts

@@ -0,0 +1,272 @@
+import type { JsonValue, ProviderEnvelope } from '@fabrika/provider-contract'
+
+export type { JsonValue }
+
+/** A plain list response. */
+export interface ListResponse<T> {
+	items: T[]
+}
+
+/** A keyset-paginated list. */
+export interface CursorList<T> {
+	items: T[]
+	nextCursor: string | null
+}
+
+export type ProviderEnvelopeDto = ProviderEnvelope
+
+/** One redacted line of deploy output exposed by the control API. */
+export interface RunLogLine {
+	readonly ts: number
+	readonly stream: 'stdout' | 'stderr' | 'meta'
+	readonly text: string
+}
+
+/** Backward-compatible short name for browser consumers. */
+export type LogLine = RunLogLine
+
+export interface SetSecretValueRequest {
+	value: string
+	env?: string | null
+}
+
+export interface AppDto {
+	id: string
+	repoUrl: string
+	defaultBranch: string
+	workerDir: string | null
+	buildCmd: string | null
+	configPath: string | null
+	githubInstallationId: number | null
+	createdAt: number
+}
+
+export interface AppOptionalFields {
+	defaultBranch?: string
+	workerDir?: string | null
+	buildCmd?: string | null
+	configPath?: string | null
+	githubInstallationId?: number | null
+	resolveInstallationId?: boolean
+}
+
+export interface UpdateAppRequest extends AppOptionalFields {
+	repoUrl?: string
+}
+
+export interface AppEnvDto {
+	appId: string
+	env: string
+	domain: string | null
+	publicOrigin: string | null
+	triggerRef: string | null
+	namespaceId: string | null
+	provider: string
+	target: ProviderEnvelopeDto
+	artifact: ProviderEnvelopeDto
+	createdAt: number
+}
+
+export interface PutAppEnvRequest {
+	domain?: string | null
+	publicOrigin?: string | null
+	triggerRef?: string | null
+	namespaceId?: string | null
+	target: ProviderEnvelopeDto
+	artifact: ProviderEnvelopeDto
+}
+
+export interface CloudflareTargetEnvelope extends ProviderEnvelopeDto {
+	provider: 'cloudflare'
+	version: 1
+	payload: {
+		stateNamespace?: string
+	}
+}
+
+export interface CloudflareArtifactEnvelope extends ProviderEnvelopeDto {
+	provider: 'cloudflare'
+	version: 1
+	payload: {
+		configPath: string
+	}
+}
+
+export type DeploymentNamespaceState = 'pending' | 'provisioning' | 'ready' | 'failed'
+
+export interface DeploymentNamespaceDto {
+	id: string
+	env: string
+	provider: string
+	exclusiveAppId: string | null
+	target: ProviderEnvelopeDto
+	state: DeploymentNamespaceState
+	lastError: string | null
+	createdAt: number
+}
+
+export interface DeploymentNamespaceDetailDto extends DeploymentNamespaceDto {
+	presentation: DeploymentNamespacePresentationDto | null
+}
+
+export interface CreateDeploymentNamespaceRequest {
+	id: string
+	env: string
+	exclusiveAppId?: string | null
+	target: ProviderEnvelopeDto
+}
+
+export interface AdoptDeploymentNamespaceRequest {
+	env: string
+	exclusiveAppId?: string | null
+	target: ProviderEnvelopeDto
+}
+
+export interface DeploymentNamespaceFactDto {
+	readonly label: string
+	readonly value: string
+}
+
+export interface DeploymentNamespacePresentationDto {
+	readonly preset: string
+	readonly title: string
+	readonly facts: readonly DeploymentNamespaceFactDto[]
+	readonly instructions: readonly string[]
+}
+
+export interface DeploymentNamespacePresetDto {
+	readonly id: string
+	readonly label: string
+	readonly description: string
+	readonly requiresExclusiveApp: boolean
+}
+
+export interface DeploymentNamespaceOperatorDto {
+	readonly presets: readonly DeploymentNamespacePresetDto[]
+}
+
+export interface DeploymentNamespaceListResponse {
+	items: DeploymentNamespaceDto[]
+	operator: DeploymentNamespaceOperatorDto | null
+}
+
+export interface PlanDeploymentNamespaceRequest {
+	id: string
+	env: string
+	preset: string
+	exclusiveAppId?: string
+	options?: JsonValue
+}
+
+export interface PlannedDeploymentNamespaceDto {
+	readonly id: string
+	readonly env: string
+	readonly exclusiveAppId?: string
+	readonly target: ProviderEnvelopeDto
+}
+
+export interface PlanDeploymentNamespaceResponse {
+	readonly namespace: PlannedDeploymentNamespaceDto
+	readonly presentation: DeploymentNamespacePresentationDto
+}
+
+export interface AppSecretDto {
+	appId: string
+	env: string | null
+	name: string
+	valueRef: string
+	createdAt: number
+}
+
+export interface PutAppSecretRequest {
+	name: string
+	valueRef: string
+	env?: string | null
+}
+
+export interface AppVarDto {
+	appId: string
+	env: string | null
+	name: string
+	value: string
+	createdAt: number
+}
+
+export interface PutAppVarRequest {
+	name: string
+	value: string
+	env?: string | null
+}
+
+export interface RegisterAppRequest extends AppOptionalFields {
+	id: string
+	repoUrl: string
+	env: string
+	domain?: string | null
+	publicOrigin?: string | null
+	triggerRef?: string | null
+	namespaceId?: string | null
+	target: ProviderEnvelopeDto
+	artifact: ProviderEnvelopeDto
+}
+
+export interface RegisterAppResponse {
+	app: AppDto
+	env: AppEnvDto
+}
+
+export type RunTrigger = 'webhook' | 'manual' | 'poll'
+export type RunStatus = 'pending' | 'running' | 'succeeded' | 'failed'
+
+export interface RunDto {
+	id: string
+	appId: string
+	env: string
+	ref: string
+	commitSha: string | null
+	trigger: RunTrigger
+	status: RunStatus
+	exitCode: number | null
+	externalRunId: string | null
+	logKey: string | null
+	createdAt: number
+	startedAt: number | null
+	finishedAt: number | null
+}
+
+export interface TriggerDeployRequest {
+	appId: string
+	env: string
+	ref?: string
+}
+
+export interface RunTailResponse {
+	lines: RunLogLine[]
+	cursor: number
+	done: boolean
+	status: RunStatus
+}
+
+export interface RunLogResponse {
+	lines: RunLogLine[]
+	status?: RunStatus
+}
+
+export type {
+	AdoptNamespaceInput,
+	AppEnvironmentInput,
+	AppIdInput,
+	AppNamedValueInput,
+	ControlRpcContract,
+	CreateAppRequest,
+	NamespaceIdInput,
+	OkResponse,
+	PutAppEnvironmentInput,
+	PutAppSecretInput,
+	PutAppVarInput,
+	RunIdInput,
+	RunListInput,
+	SecretValueInput,
+	SecretValueResponse,
+	TailRunInput,
+} from './rpc.js'

package/src/rpc.ts

@@ -0,0 +1,142 @@
+import type { RpcProcedureContract } from '@fabrika/app'
+import type {
+	AdoptDeploymentNamespaceRequest,
+	AppDto,
+	AppEnvDto,
+	AppSecretDto,
+	AppVarDto,
+	CreateDeploymentNamespaceRequest,
+	CursorList,
+	DeploymentNamespaceDetailDto,
+	DeploymentNamespaceListResponse,
+	ListResponse,
+	PlanDeploymentNamespaceRequest,
+	PlanDeploymentNamespaceResponse,
+	PutAppEnvRequest,
+	PutAppSecretRequest,
+	PutAppVarRequest,
+	RegisterAppRequest,
+	RegisterAppResponse,
+	RunDto,
+	RunLogResponse,
+	RunTailResponse,
+	SetSecretValueRequest,
+	TriggerDeployRequest,
+	UpdateAppRequest,
+} from './index.js'
+
+type RpcProcedure<TInput, TOutput> = RpcProcedureContract<TInput, TOutput>
+
+export interface AppIdInput {
+	readonly appId: string
+}
+
+export interface AppEnvironmentInput extends AppIdInput {
+	readonly env: string
+}
+
+export interface AppNamedValueInput extends AppIdInput {
+	readonly name: string
+	readonly env?: string | null
+}
+
+export interface CreateAppRequest extends UpdateAppRequest {
+	readonly id: string
+	readonly repoUrl: string
+}
+
+export interface PutAppEnvironmentInput extends AppEnvironmentInput {
+	readonly environment: PutAppEnvRequest
+}
+
+export interface PutAppSecretInput extends AppIdInput {
+	readonly secret: PutAppSecretRequest
+}
+
+export interface PutAppVarInput extends AppIdInput {
+	readonly variable: PutAppVarRequest
+}
+
+export interface SecretValueInput extends AppNamedValueInput {
+	readonly value: string
+}
+
+export interface SecretValueResponse {
+	readonly ok: boolean
+	readonly valueRef?: string
+}
+
+export interface OkResponse {
+	readonly ok: boolean
+}
+
+export interface NamespaceIdInput {
+	readonly namespaceId: string
+}
+
+export interface AdoptNamespaceInput extends NamespaceIdInput {
+	readonly namespace: AdoptDeploymentNamespaceRequest
+}
+
+export interface RunListInput {
+	readonly appId?: string
+	readonly env?: string
+	readonly before?: string
+	readonly limit?: number
+}
+
+export interface RunIdInput {
+	readonly runId: string
+}
+
+export interface TailRunInput extends RunIdInput {
+	readonly after?: number
+}
+
+/** Portable Delivery control API, implemented alongside the backward-compatible REST transport. */
+export interface ControlRpcContract {
+	apps: {
+		list: RpcProcedure<void, ListResponse<AppDto>>
+		get: RpcProcedure<AppIdInput, AppDto>
+		create: RpcProcedure<CreateAppRequest, AppDto>
+		update: RpcProcedure<AppIdInput & { app: UpdateAppRequest }, AppDto>
+		delete: RpcProcedure<AppIdInput, OkResponse>
+		environments: {
+			list: RpcProcedure<AppIdInput, ListResponse<AppEnvDto>>
+			put: RpcProcedure<PutAppEnvironmentInput, AppEnvDto>
+			delete: RpcProcedure<AppEnvironmentInput, OkResponse>
+		}
+		secrets: {
+			list: RpcProcedure<AppIdInput, ListResponse<AppSecretDto>>
+			put: RpcProcedure<PutAppSecretInput, AppSecretDto>
+			delete: RpcProcedure<AppNamedValueInput, OkResponse>
+		}
+		variables: {
+			list: RpcProcedure<AppIdInput, ListResponse<AppVarDto>>
+			put: RpcProcedure<PutAppVarInput, AppVarDto>
+			delete: RpcProcedure<AppNamedValueInput, OkResponse>
+		}
+	}
+	vault: {
+		set: RpcProcedure<SecretValueInput, SecretValueResponse>
+		rotate: RpcProcedure<SecretValueInput, OkResponse>
+		delete: RpcProcedure<AppNamedValueInput, OkResponse>
+	}
+	namespaces: {
+		list: RpcProcedure<void, DeploymentNamespaceListResponse>
+		get: RpcProcedure<NamespaceIdInput, DeploymentNamespaceDetailDto>
+		plan: RpcProcedure<PlanDeploymentNamespaceRequest, PlanDeploymentNamespaceResponse>
+		create: RpcProcedure<CreateDeploymentNamespaceRequest, DeploymentNamespaceDetailDto>
+		adopt: RpcProcedure<AdoptNamespaceInput, DeploymentNamespaceDetailDto>
+		reconcile: RpcProcedure<NamespaceIdInput, DeploymentNamespaceDetailDto>
+	}
+	runs: {
+		list: RpcProcedure<RunListInput, CursorList<RunDto>>
+		get: RpcProcedure<RunIdInput, RunDto>
+		log: RpcProcedure<RunIdInput, RunLogResponse>
+		tail: RpcProcedure<TailRunInput, RunTailResponse>
+		cancel: RpcProcedure<RunIdInput, RunDto>
+	}
+	deploy: RpcProcedure<TriggerDeployRequest, RunDto>
+	register: RpcProcedure<RegisterAppRequest, RegisterAppResponse>
+}