@codeguide/core 0.0.27 → 0.0.29

package/docs/.vitepress/theme/custom.css

@@ -0,0 +1,80 @@
+/* Custom styles for VitePress theme */
+
+:root {
+  --vp-c-brand: #42b983;
+  --vp-c-brand-light: #42b983;
+  --vp-c-brand-lighter: #66d9a3;
+  --vp-c-brand-lightest: #8ae5b8;
+  --vp-c-brand-dark: #35495e;
+  --vp-c-brand-darker: #2c3e50;
+}
+
+/* Code block styling */
+.vp-code-group .tabs {
+  border-radius: 8px 8px 0 0;
+}
+
+.vp-code-group .blocks {
+  border-radius: 0 0 8px 8px;
+}
+
+/* Custom code block background */
+div[class*='language-'] {
+  background-color: var(--vp-code-block-bg);
+}
+
+/* Improve table styling */
+table {
+  display: table;
+  width: 100%;
+}
+
+/* Better spacing for method documentation */
+.method-doc {
+  margin-bottom: 2rem;
+}
+
+.method-doc h3 {
+  margin-top: 2rem;
+  padding-bottom: 0.5rem;
+  border-bottom: 1px solid var(--vp-c-divider);
+}
+
+/* Improve code example readability */
+.vp-code-group {
+  margin: 1.5rem 0;
+}
+
+/* Better list spacing */
+.vp-doc ul,
+.vp-doc ol {
+  padding-left: 1.5rem;
+}
+
+/* Improve type definition blocks */
+.type-definition {
+  background-color: var(--vp-c-bg-soft);
+  padding: 1rem;
+  border-radius: 8px;
+  margin: 1rem 0;
+}
+
+/* Custom badge styling */
+.badge {
+  display: inline-block;
+  padding: 0.25rem 0.5rem;
+  border-radius: 4px;
+  font-size: 0.875rem;
+  font-weight: 500;
+}
+
+.badge-required {
+  background-color: var(--vp-c-red-soft);
+  color: var(--vp-c-red);
+}
+
+.badge-optional {
+  background-color: var(--vp-c-yellow-soft);
+  color: var(--vp-c-yellow);
+}
+

package/docs/.vitepress/theme/index.ts

@@ -0,0 +1,13 @@
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ app }) {
+    // You can add custom Vue components here if needed
+    // Example:
+    // app.component('CustomComponent', CustomComponent)
+  },
+} satisfies Theme
+

package/docs/.vitepress/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "moduleResolution": "bundler",
+    "strict": true,
+    "jsx": "preserve",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "types": ["node"]
+  },
+  "include": ["config.ts", "theme/**/*.ts"],
+  "exclude": ["node_modules"]
+}
+

package/docs/QUICKSTART.md

@@ -0,0 +1,77 @@
+# Quick Start Guide
+
+## Running the Documentation Locally
+
+1. **Install dependencies** (if not already installed):
+   ```bash
+   cd packages/core
+   npm install
+   ```
+
+2. **Start the development server**:
+   ```bash
+   npm run docs:dev
+   ```
+
+3. **Open your browser**:
+   Navigate to http://localhost:5173
+
+## Building for Production
+
+```bash
+npm run docs:build
+```
+
+The built files will be in `packages/core/docs/.vitepress/dist`
+
+## Previewing the Build
+
+```bash
+npm run docs:preview
+```
+
+## Project Structure
+
+```
+docs/
+├── .vitepress/
+│   ├── config.ts          # VitePress configuration (TypeScript)
+│   ├── theme/
+│   │   ├── index.ts       # Theme customization
+│   │   └── custom.css     # Custom styles
+│   └── tsconfig.json      # TypeScript config for VitePress
+├── README.md              # Homepage
+├── codeguide-client.md    # Client documentation
+├── authentication.md      # Authentication docs
+├── projects-service.md   # Projects service docs
+├── codespace-service.md  # Codespace service docs
+├── codespace-models.md   # Models documentation
+├── security-keys-service.md # Security keys docs
+└── usage-service.md      # Usage service docs
+```
+
+## Features
+
+- ✅ TypeScript-based configuration
+- ✅ Fast hot module replacement
+- ✅ Built-in search
+- ✅ Dark mode support
+- ✅ Mobile responsive
+- ✅ SEO optimized
+- ✅ Edit links to GitHub
+
+## Customization
+
+### Changing Colors
+
+Edit `docs/.vitepress/theme/custom.css` to customize the color scheme.
+
+### Adding Pages
+
+1. Create a new `.md` file in the `docs/` directory
+2. Add it to the sidebar in `docs/.vitepress/config.ts`
+
+### Custom Components
+
+Add Vue components in `docs/.vitepress/theme/index.ts` in the `enhanceApp` function.
+

package/docs/README.md

@@ -0,0 +1,134 @@
+---
+layout: home
+
+hero:
+  name: "@codeguide/core"
+  text: "TypeScript SDK"
+  tagline: Complete TypeScript SDK for integrating CodeGuide functionality into your applications
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /codeguide-client
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/CodeGuide-dev/codeguide
+
+features:
+  - title: 🔑 Multiple Authentication Methods
+    details: Database API keys, legacy keys, and JWT tokens with automatic fallback
+  - title: 📝 Project Management
+    details: Create, update, and manage projects programmatically with full CRUD operations
+  - title: 🤖 Codespace Tasks
+    details: Create and manage AI-powered coding tasks with support for multiple execution modes
+  - title: 🎯 Model Management
+    details: Query and manage LLM models and providers for your codespace tasks
+  - title: 🔐 Security Keys
+    details: Securely manage provider API keys and GitHub tokens with encryption
+  - title: 🛡️ TypeScript Support
+    details: Full type safety and IntelliSense support for all API methods
+---
+
+## Quick Start
+
+### Installation
+
+```bash
+npm install @codeguide/core
+```
+
+### Basic Usage
+
+```typescript
+import { CodeGuide } from '@codeguide/core'
+
+// Initialize the CodeGuide client
+const codeguide = new CodeGuide({
+  baseUrl: 'https://api.codeguide.ai',
+  databaseApiKey: 'sk_your_database_api_key', // Recommended
+})
+
+// Access services
+const projects = await codeguide.projects.getAllProjects()
+const tasks = await codeguide.codespace.getCodespaceTasksByProject({
+  project_id: 'your_project_id'
+})
+```
+
+## Documentation Structure
+
+### Core Components
+
+- **[CodeGuide Client](./codeguide-client.md)** - Main client class and initialization
+- **[Authentication](./authentication.md)** - Authentication methods and configuration
+
+### Services
+
+- **[Projects Service](./projects-service.md)** - Project management and repository connections
+- **[Codespace Service](./codespace-service.md)** - AI-powered coding tasks and workflows
+- **[Codespace Models](./codespace-models.md)** - LLM model providers and model management
+- **[Security Keys Service](./security-keys-service.md)** - Provider API keys and GitHub token management
+- **[Usage Service](./usage-service.md)** - Usage tracking and authorization
+
+## Features
+
+- 🔑 **Multiple Authentication Methods** - Database API keys, legacy keys, and JWT tokens
+- 📝 **Project Management** - Create, update, and manage projects programmatically
+- 🤖 **Codespace Tasks** - Create and manage AI-powered coding tasks
+- 🎯 **Model Management** - Query and manage LLM models and providers
+- 🔐 **Security Keys** - Securely manage provider API keys and GitHub tokens
+- 📊 **Usage Tracking** - Monitor API usage and credits
+- 🛡️ **TypeScript Support** - Full type safety and IntelliSense
+
+## Getting Started
+
+1. **Install the package**: `npm install @codeguide/core`
+2. **Get your API key**: Sign up at [codeguide.ai](https://codeguide.ai) to get your API key
+3. **Initialize the client**: See [CodeGuide Client](./codeguide-client.md) for setup instructions
+4. **Authenticate**: See [Authentication](./authentication.md) for authentication options
+5. **Start building**: Explore the service documentation to learn about available features
+
+## Common Use Cases
+
+### Creating a Project
+
+```typescript
+const project = await codeguide.projects.createProject({
+  title: 'My New Project',
+  description: 'Project description here'
+})
+```
+
+### Creating a Codespace Task
+
+```typescript
+const task = await codeguide.codespace.createCodespaceTaskV2({
+  project_id: project.id,
+  task_description: 'Implement user authentication',
+  execution_mode: 'implementation'
+})
+```
+
+### Managing Security Keys
+
+```typescript
+// Store a provider API key
+await codeguide.securityKeys.createProviderAPIKey({
+  provider_key: 'openai',
+  api_key: 'sk-your-openai-key'
+})
+
+// Store a GitHub token
+await codeguide.securityKeys.createGitHubToken({
+  github_token: 'ghp_your_github_token'
+})
+```
+
+## Support
+
+- **GitHub**: [CodeGuide Repository](https://github.com/CodeGuide-dev/codeguide)
+- **Issues**: [GitHub Issues](https://github.com/CodeGuide-dev/codeguide/issues)
+- **Documentation**: This documentation site
+
+## License
+
+MIT License - see the LICENSE file for details.

package/docs/README_SETUP.md

@@ -0,0 +1,46 @@
+# VitePress Setup Instructions
+
+## The Issue
+
+VitePress is an ESM-only package, but Node.js was trying to load it with CommonJS `require()`. This has been fixed by creating a separate `package.json` in the `docs/` directory with `"type": "module"`.
+
+## Setup Steps
+
+1. **Install dependencies in the docs directory**:
+   ```bash
+   cd packages/core
+   npm run docs:install
+   ```
+   
+   Or manually:
+   ```bash
+   cd packages/core/docs
+   npm install
+   ```
+
+2. **Start the development server**:
+   ```bash
+   cd packages/core
+   npm run docs:dev
+   ```
+
+3. **Open your browser**:
+   Navigate to http://localhost:5173
+
+## Available Commands
+
+From `packages/core/`:
+- `npm run docs:dev` - Start development server
+- `npm run docs:build` - Build for production
+- `npm run docs:preview` - Preview the built site
+- `npm run docs:install` - Install docs dependencies
+
+Or from `packages/core/docs/`:
+- `npm run dev` - Start development server
+- `npm run build` - Build for production
+- `npm run preview` - Preview the built site
+
+## Why Separate package.json?
+
+The docs directory has its own `package.json` with `"type": "module"` to ensure VitePress (which is ESM-only) works correctly without affecting the main package's CommonJS setup.
+