@ebowwa/codespaces-types 0.1.0 → 1.0.0

package/README.md

@@ -1,6 +1,11 @@
 # @ebowwa/codespaces-types
 
-Shared TypeScript type definitions for Codespaces packages.
+Shared types and runtime validation schemas for codespaces projects.
+
+## Structure
+
+- **`/runtime`** - Zod schemas for runtime validation
+- **`/types`** - TypeScript type definitions for compile-time checking
 
 ## Installation
 
@@ -10,58 +15,50 @@ npm install @ebowwa/codespaces-types
 
 ## Usage
 
-This package contains shared type definitions used across various Codespaces packages:
-
-### Main Types
+### Runtime Validation (Zod Schemas)
 
 ```typescript
-import {
-  Environment,
-  EnvironmentStatus,
-  HetznerServerType,
-  HetznerLocation,
-  // ... and more
-} from '@ebowwa/codespaces-types';
-```
-
-### Resource Parsing
+import { CreateEnvironmentRequestSchema } from '@ebowwa/codespaces-types/runtime/api';
 
-```typescript
-import { parseResources, parseCPU, parseMemory } from '@ebowwa/codespaces-types/resources';
+// Validate data at runtime
+const result = CreateEnvironmentRequestSchema.parse(userData);
 ```
 
-### Terminal WebSocket Types
+### Compile-Time Types
 
 ```typescript
-import {
-  ClientToServerMessage,
-  ServerToClientMessage,
-  WebSocketCloseCode
-} from '@ebowwa/codespaces-types/terminal-websocket';
-```
+import type { Environment, HetznerServerType } from '@ebowwa/codespaces-types/types';
 
-### Time Formatting
-
-```typescript
-import { formatElapsedTime } from '@ebowwa/codespaces-types/time';
+// Type checking at compile time
+const env: Environment = { /* ... */ };
 ```
 
-### Validation
+### Type Inference (Recommended)
+
+Runtime schemas automatically export inferred TypeScript types:
 
 ```typescript
 import {
-  EnvironmentNameSchema,
-  validateEnvironmentName
-} from '@ebowwa/codespaces-types/validation';
+  CreateEnvironmentRequestSchema,
+  type CreateEnvironmentRequest
+} from '@ebowwa/codespaces-types/runtime/api';
+
+const data: CreateEnvironmentRequest = { /* ... */ };
+const validated = CreateEnvironmentRequestSchema.parse(data);
 ```
 
-## Features
+## Available Exports
+
+### Runtime (`./runtime/*`)
+- `api` - API request/response validation schemas
+- `ai` - AI-related schemas
+- `database` - Database validation schemas
+- `env` - Environment variable schemas
+- `glm` - GLM-specific schemas
+- `ssh` - SSH configuration schemas
 
-- **Shared Types**: Common interfaces for environments, Hetzner API, and more
-- **Resource Parsing**: Utilities for parsing CPU, memory, disk, and GPU usage
-- **WebSocket Types**: Terminal WebSocket message types for real-time communication
-- **Validation**: Zod schemas for validating environment names, SSH keys, and API tokens
-- **Time Utilities**: Functions for formatting elapsed time
+### Types (`./types/*`)
+- `index` - Main type exports (Environment, Hetzner types, etc.)
 
 ## License