@virke/shared

v1.1.0

Published

Shared types and utilities for the Virke platform

Downloads

155

Readme

@virke/shared

Shared TypeScript types for the Virke platform.

Install

bun add @virke/shared

Usage

import type { Project, Deployment, Database, User } from "@virke/shared";

Exported Types

| Type | Description | |------|-------------| | Project | Project configuration and metadata | | Deployment | Deploy record with status and timestamps | | Database | Database instance with tier and settings | | User | Authenticated user profile | | Organization | Organization with members and roles | | Domain | Custom domain with SSL status | | EnvVar | Environment variable (plain or secret) | | KvNamespace | Key-value namespace | | Os3Bucket | Object storage bucket | | ApiKey | API key for programmatic access | | ApiResponse | Standard { data, error } response envelope | | ApiResult<T> | Typed API result | | VirkeConfig | virke.toml configuration shape |

This package is used internally by @virke/sdk and @virke/cli. You only need to install it directly if you want the types without the SDK client.

License

MIT