@codeguide/core 0.0.24 → 0.0.26

package/dist/services/security-keys/security-keys-types.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Security Keys Service Types
+ *
+ * This file contains type definitions for the Security Keys service,
+ * which manages provider API keys and GitHub tokens.
+ */
+export interface SecurityKeyData {
+    id: string;
+    created_at: string;
+    user_id: string;
+    name: string;
+    displayed_name: string;
+    value_masked: string;
+    value?: string;
+    object_value: Record<string, any>;
+    encryption: string;
+    key_version: string;
+}
+export interface ProviderAPIKeyData extends SecurityKeyData {
+    provider_id: string;
+    provider_name: string;
+    provider_key: string;
+    provider_logo_src?: string;
+    object_value: {
+        provider_id: string;
+    };
+}
+export interface GitHubTokenData extends SecurityKeyData {
+    object_value: {
+        token_type: string;
+    };
+}
+export interface SuccessResponse<T> {
+    status: 'success';
+    data: T;
+}
+export interface ErrorResponse {
+    detail: string;
+}
+export interface CreateProviderAPIKeyRequest {
+    provider_key: string;
+    api_key: string;
+}
+export interface CreateProviderAPIKeyResponse extends SuccessResponse<ProviderAPIKeyData> {
+}
+export interface GetProviderAPIKeyResponse extends SuccessResponse<ProviderAPIKeyData> {
+}
+export interface ListProviderAPIKeysResponse extends SuccessResponse<ProviderAPIKeyData[]> {
+}
+export interface CreateGitHubTokenRequest {
+    github_token: string;
+}
+export interface CreateGitHubTokenResponse extends SuccessResponse<GitHubTokenData> {
+}
+export interface GetGitHubTokenResponse extends SuccessResponse<GitHubTokenData> {
+}
+export interface ProviderNotFoundError extends ErrorResponse {
+    detail: string;
+}
+export interface DuplicateKeyError extends ErrorResponse {
+    detail: string;
+}
+export interface KeyNotFoundError extends ErrorResponse {
+    detail: string;
+}
+export interface InvalidGitHubTokenFormatError extends ErrorResponse {
+    detail: string;
+}
+export interface GitHubTokenValidationError extends ErrorResponse {
+    detail: string;
+}
+export interface DuplicateGitHubTokenError extends ErrorResponse {
+    detail: string;
+}
+export interface GitHubTokenNotFoundError extends ErrorResponse {
+    detail: string;
+}
+export interface AuthenticationError extends ErrorResponse {
+    detail: string;
+}
+export interface InternalServerError extends ErrorResponse {
+    detail: string;
+}
+export type ProviderAPIKeyResponse = CreateProviderAPIKeyResponse | GetProviderAPIKeyResponse | ListProviderAPIKeysResponse | RevokeProviderAPIKeyResponse | SecurityKeysError;
+export interface RevokeProviderAPIKeyResponse {
+    status: string;
+    message: string;
+    revoked_provider_id: string;
+}
+export interface RevokeGitHubTokenResponse {
+    status: string;
+    message: string;
+    revoked_at: string;
+}
+export interface ProviderAPIKeyNotFoundError extends ErrorResponse {
+    detail: string;
+}
+export interface ProviderAPIKeyDeletionError extends ErrorResponse {
+    detail: string;
+}
+export interface GitHubTokenDeletionError extends ErrorResponse {
+    detail: string;
+}
+export type SecurityKeysError = ProviderNotFoundError | DuplicateKeyError | KeyNotFoundError | InvalidGitHubTokenFormatError | GitHubTokenValidationError | DuplicateGitHubTokenError | GitHubTokenNotFoundError | ProviderAPIKeyNotFoundError | ProviderAPIKeyDeletionError | GitHubTokenDeletionError | AuthenticationError | InternalServerError | ErrorResponse;
+export type GitHubTokenResponse = CreateGitHubTokenResponse | GetGitHubTokenResponse | RevokeGitHubTokenResponse | SecurityKeysError;

package/dist/services/security-keys/security-keys-types.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Security Keys Service Types
+ *
+ * This file contains type definitions for the Security Keys service,
+ * which manages provider API keys and GitHub tokens.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/examples/project-filtering-example.ts

@@ -52,8 +52,8 @@ async function demonstrateProjectFiltering() {
     }
 
     const paginatedResponse = await codeGuide.projects.getPaginatedProjects(paginatedRequest)
-    console.log(`Page ${paginatedResponse.pagination.page} of ${paginatedResponse.pagination.total_pages}`)
-    console.log(`Total projects with repositories: ${paginatedResponse.pagination.total}`)
+    console.log(`Page ${paginatedResponse.page} of ${paginatedResponse.total_pages}`)
+    console.log(`Total projects with repositories: ${paginatedResponse.count}`)
     console.log(`Showing ${paginatedResponse.data.length} projects:`)
 
     paginatedResponse.data.forEach((project: Project) => {
@@ -80,7 +80,7 @@ async function demonstrateProjectFiltering() {
     }
 
     const filteredProjects = await codeGuide.projects.getPaginatedProjects(combinedFilters)
-    console.log(`Found ${filteredProjects.pagination.total} projects matching filters:`)
+    console.log(`Found ${filteredProjects.count} projects matching filters:`)
     filteredProjects.data.forEach((project: Project) => {
       console.log(`- ${project.title} (Updated: ${project.updated_at})`)
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codeguide/core",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "description": "Core package for code guidance with programmatic API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/services/codespace/codespace-service.ts

@@ -15,6 +15,13 @@ import {
   CodespaceTaskDetailedResponse,
   CodespaceQuestionnaireRequest,
   CodespaceQuestionnaireResponse,
+  // Codespace Models Types
+  GetCodespaceModelsQuery,
+  GetCodespaceModelsResponse,
+  GetCodespaceModelResponse,
+  GetLLMModelProvidersResponse,
+  GetLLMModelProviderResponse,
+  GetModelsByProviderResponse,
 } from './codespace-types'
 
 export class CodespaceService extends BaseService {
@@ -91,6 +98,103 @@ export class CodespaceService extends BaseService {
     return this.get<CodespaceTaskDetailedResponse>(`/codespace/task/${codespaceTaskId}/detailed`)
   }
 
+  // ============================================================================
+  // Codespace Models Methods
+  // ============================================================================
+
+  /**
+   * Get all codespace models with optional filtering
+   *
+   * GET /api/codespace-models/models
+   *
+   * @param query - Optional query parameters for filtering
+   * @returns Promise resolving to array of codespace models with provider info
+   */
+  async getCodespaceModels(query?: GetCodespaceModelsQuery): Promise<GetCodespaceModelsResponse> {
+    const params = this.buildQueryParams(query)
+    const url = params
+      ? `/api/codespace-models/models?${params}`
+      : '/api/codespace-models/models'
+
+    return this.get<GetCodespaceModelsResponse>(url)
+  }
+
+  /**
+   * Get a specific codespace model by ID
+   *
+   * GET /api/codespace-models/models/{model_id}
+   *
+   * @param modelId - The UUID of the model
+   * @returns Promise resolving to the codespace model with provider info
+   */
+  async getCodespaceModel(modelId: string): Promise<GetCodespaceModelResponse> {
+    if (!modelId) {
+      throw new Error('model_id is required')
+    }
+    return this.get<GetCodespaceModelResponse>(`/api/codespace-models/models/${modelId}`)
+  }
+
+  /**
+   * Get all LLM model providers
+   *
+   * GET /api/codespace-models/providers
+   *
+   * @returns Promise resolving to array of LLM model providers
+   */
+  async getLLMModelProviders(): Promise<GetLLMModelProvidersResponse> {
+    return this.get<GetLLMModelProvidersResponse>('/api/codespace-models/providers')
+  }
+
+  /**
+   * Get a specific LLM model provider by ID
+   *
+   * GET /api/codespace-models/providers/{provider_id}
+   *
+   * @param providerId - The UUID of the provider
+   * @returns Promise resolving to the LLM model provider
+   */
+  async getLLMModelProvider(providerId: string): Promise<GetLLMModelProviderResponse> {
+    if (!providerId) {
+      throw new Error('provider_id is required')
+    }
+    return this.get<GetLLMModelProviderResponse>(`/api/codespace-models/providers/${providerId}`)
+  }
+
+  /**
+   * Get models by provider
+   *
+   * GET /api/codespace-models/providers/{provider_id}/models
+   *
+   * @param providerId - The UUID of the provider
+   * @returns Promise resolving to array of models from the specified provider
+   */
+  async getModelsByProvider(providerId: string): Promise<GetModelsByProviderResponse> {
+    if (!providerId) {
+      throw new Error('provider_id is required')
+    }
+    return this.get<GetModelsByProviderResponse>(`/api/codespace-models/providers/${providerId}/models`)
+  }
+
+  /**
+   * Build URL query parameters from an object
+   *
+   * @param params - The parameters object
+   * @returns URL query string
+   */
+  private buildQueryParams(params?: Record<string, any>): string {
+    if (!params) return ''
+
+    const searchParams = new URLSearchParams()
+
+    Object.entries(params).forEach(([key, value]) => {
+      if (value !== undefined && value !== null) {
+        searchParams.append(key, value.toString())
+      }
+    })
+
+    return searchParams.toString()
+  }
+
   private validateCodespaceTaskRequest(request: CreateCodespaceTaskRequestV2): void {
     if (!request.project_id) {
       throw new Error('project_id is required')

package/services/codespace/codespace-types.ts

@@ -181,4 +181,68 @@ export interface CodespaceQuestionnaireResponse {
   success: boolean
   questions: string[]
   message: string
-}
+}
+
+// ============================================================================
+// Codespace Models Types
+// ============================================================================
+
+export interface LLMModelProviderInDB {
+  id: string
+  created_at: string
+  name?: string
+  key?: string
+  logo_src?: string
+}
+
+export interface CodespaceModelInDB {
+  id: string
+  created_at: string
+  key?: string
+  name?: string
+  provider_id?: string
+  base_url?: string
+  completion_base_url?: string
+  execution_mode?: 'opencode' | 'claude-code' | 'docs-only' | 'implementation'
+  logo_src?: string
+}
+
+export interface CodespaceModelWithProvider extends CodespaceModelInDB {
+  provider?: LLMModelProviderInDB
+}
+
+export interface GetCodespaceModelsQuery {
+  provider_id?: string
+  execution_mode?: string
+}
+
+export interface GetCodespaceModelsResponse extends Array<CodespaceModelWithProvider> {}
+
+export interface GetCodespaceModelResponse extends CodespaceModelWithProvider {}
+
+export interface GetLLMModelProvidersResponse extends Array<LLMModelProviderInDB> {}
+
+export interface GetLLMModelProviderResponse extends LLMModelProviderInDB {}
+
+export interface GetModelsByProviderResponse extends Array<CodespaceModelInDB> {}
+
+// ============================================================================
+// Codespace Models Error Types
+// ============================================================================
+
+export interface CodespaceModelNotFoundError {
+  detail: string // "Codespace model with ID {model_id} not found"
+}
+
+export interface AuthenticationRequiredError {
+  detail: string // "Authentication required"
+}
+
+export interface CodespaceModelsFetchError {
+  detail: string // "Failed to fetch codespace models"
+}
+
+export type CodespaceModelsError =
+  | CodespaceModelNotFoundError
+  | AuthenticationRequiredError
+  | CodespaceModelsFetchError

package/services/codespace/index.ts

@@ -14,5 +14,16 @@ export type {
   TechnicalDocument,
   GetProjectTasksByCodespaceResponse,
   CodespaceQuestionnaireRequest,
-  CodespaceQuestionnaireResponse
+  CodespaceQuestionnaireResponse,
+  // Codespace Models Types
+  LLMModelProviderInDB,
+  CodespaceModelInDB,
+  CodespaceModelWithProvider,
+  GetCodespaceModelsQuery,
+  GetCodespaceModelsResponse,
+  GetCodespaceModelResponse,
+  GetLLMModelProvidersResponse,
+  GetLLMModelProviderResponse,
+  GetModelsByProviderResponse,
+  CodespaceModelsError
 } from './codespace-types'

package/services/index.ts

@@ -18,6 +18,7 @@ export { SubscriptionService } from './subscriptions'
 export { CancellationFunnelService } from './cancellation-funnel'
 export { CodespaceService } from './codespace'
 export { ExternalTokenService } from './external-tokens'
+export { SecurityKeysService } from './security-keys'
 
 // Re-export all types for convenience
 export * from './generation'
@@ -30,3 +31,4 @@ export * from './subscriptions'
 export * from './cancellation-funnel'
 export * from './codespace'
 export * from './external-tokens'
+export * from './security-keys'

package/services/projects/project-types.ts

@@ -117,12 +117,10 @@ export interface PaginatedProjectsRequest {
 export interface PaginatedProjectsResponse {
   status: string
   data: Project[]
-  pagination: {
-    total: number
-    page: number
-    page_size: number
-    total_pages: number
-  }
+  count: number
+  page: number
+  page_size: number
+  total_pages: number
 }
 
 export interface ConnectRepositoryRequest {

package/services/security-keys/index.ts

@@ -0,0 +1,25 @@
+export { SecurityKeysService } from './security-keys-service'
+
+// Export all types
+export * from './security-keys-types'
+
+// Re-export commonly used types for convenience
+export type {
+  SecurityKeyData,
+  ProviderAPIKeyData,
+  GitHubTokenData,
+  CreateProviderAPIKeyRequest,
+  CreateProviderAPIKeyResponse,
+  GetProviderAPIKeyResponse,
+  ListProviderAPIKeysResponse,
+  RevokeProviderAPIKeyResponse,
+  CreateGitHubTokenRequest,
+  CreateGitHubTokenResponse,
+  GetGitHubTokenResponse,
+  RevokeGitHubTokenResponse,
+  SuccessResponse,
+  ErrorResponse,
+  SecurityKeysError,
+  ProviderAPIKeyResponse,
+  GitHubTokenResponse
+} from './security-keys-types'

package/services/security-keys/security-keys-service.ts

@@ -0,0 +1,229 @@
+import { BaseService } from '../base/base-service'
+import { APIServiceConfig } from '../../types'
+import {
+  CreateProviderAPIKeyRequest,
+  CreateProviderAPIKeyResponse,
+  GetProviderAPIKeyResponse,
+  ListProviderAPIKeysResponse,
+  RevokeProviderAPIKeyResponse,
+  CreateGitHubTokenRequest,
+  CreateGitHubTokenResponse,
+  GetGitHubTokenResponse,
+  RevokeGitHubTokenResponse,
+  SecurityKeysError
+} from './security-keys-types'
+
+/**
+ * Security Keys Service
+ *
+ * This service provides methods for managing security keys including:
+ * - Provider API Keys (OpenAI, Anthropic, etc.)
+ * - GitHub Tokens
+ *
+ * API endpoints match the actual backend implementation:
+ * - POST /security-keys/provider-api-key
+ * - GET /security-keys/provider-api-key/{provider_key}
+ * - GET /security-keys/provider-api-keys
+ * - DELETE /security-keys/provider-api-key/{provider_key}
+ * - POST /security-keys/github-token
+ * - GET /security-keys/github-token
+ * - DELETE /security-keys/github-token
+ */
+export class SecurityKeysService extends BaseService {
+  constructor(config: APIServiceConfig) {
+    super(config)
+  }
+
+  // ============================================================================
+  // Provider API Key Methods
+  // ============================================================================
+
+  /**
+   * Save a new provider API key
+   *
+   * POST /security-keys/provider-api-key
+   *
+   * @param request - The provider API key creation request
+   * @returns Promise resolving to the created API key response
+   * @throws {Error} When provider_id or api_key is missing
+   */
+  async createProviderAPIKey(request: CreateProviderAPIKeyRequest): Promise<CreateProviderAPIKeyResponse> {
+    this.validateProviderAPIKeyRequest(request)
+
+    return this.post<CreateProviderAPIKeyResponse>(
+      '/security-keys/provider-api-key',
+      request
+    )
+  }
+
+  /**
+   * Get a provider API key by provider key
+   *
+   * GET /security-keys/provider-api-key/{provider_key}
+   *
+   * @param providerKey - The provider key (e.g., 'openai', 'anthropic')
+   * @param reveal - Whether to reveal the actual API key (default: false)
+   * @returns Promise resolving to the API key response
+   * @throws {Error} When provider_key is missing
+   */
+  async getProviderAPIKey(providerKey: string, reveal: boolean = false): Promise<GetProviderAPIKeyResponse> {
+    if (!providerKey) {
+      throw new Error('provider_key is required')
+    }
+
+    const url = reveal
+      ? `/security-keys/provider-api-key/${providerKey}?reveal=true`
+      : `/security-keys/provider-api-key/${providerKey}`
+
+    return this.get<GetProviderAPIKeyResponse>(url)
+  }
+
+  /**
+   * List all provider API keys
+   *
+   * GET /security-keys/provider-api-keys
+   *
+   * @param reveal - Whether to reveal the actual API keys (default: false)
+   * @returns Promise resolving to the list of all provider API keys
+   */
+  async listProviderAPIKeys(reveal: boolean = false): Promise<ListProviderAPIKeysResponse> {
+    const url = reveal
+      ? '/security-keys/provider-api-keys?reveal=true'
+      : '/security-keys/provider-api-keys'
+
+    return this.get<ListProviderAPIKeysResponse>(url)
+  }
+
+  /**
+   * Delete a provider API key by provider key
+   *
+   * DELETE /security-keys/provider-api-key/{provider_key}
+   *
+   * @param providerKey - The provider key (e.g., 'openai', 'anthropic')
+   * @returns Promise resolving to the deletion response
+   * @throws {Error} When provider_key is missing
+   */
+  async revokeProviderAPIKey(providerKey: string): Promise<RevokeProviderAPIKeyResponse> {
+    if (!providerKey) {
+      throw new Error('provider_key is required')
+    }
+
+    return this.delete<RevokeProviderAPIKeyResponse>(`/security-keys/provider-api-key/${providerKey}`)
+  }
+
+  // ============================================================================
+  // GitHub Token Methods
+  // ============================================================================
+
+  /**
+   * Save a new GitHub token
+   *
+   * POST /security-keys/github-token
+   *
+   * @param request - The GitHub token creation request
+   * @returns Promise resolving to the created GitHub token response
+   * @throws {Error} When github_token is missing or invalid
+   */
+  async createGitHubToken(request: CreateGitHubTokenRequest): Promise<CreateGitHubTokenResponse> {
+    this.validateGitHubTokenRequest(request)
+
+    return this.post<CreateGitHubTokenResponse>(
+      '/security-keys/github-token',
+      request
+    )
+  }
+
+  /**
+   * Get the GitHub token
+   *
+   * GET /security-keys/github-token
+   *
+   * @param reveal - Whether to reveal the actual token (default: false)
+   * @returns Promise resolving to the GitHub token response
+   */
+  async getGitHubToken(reveal: boolean = false): Promise<GetGitHubTokenResponse> {
+    const url = reveal
+      ? '/security-keys/github-token?reveal=true'
+      : '/security-keys/github-token'
+
+    return this.get<GetGitHubTokenResponse>(url)
+  }
+
+  /**
+   * Delete the GitHub token
+   *
+   * DELETE /security-keys/github-token
+   *
+   * @returns Promise resolving to the deletion response
+   */
+  async revokeGitHubToken(): Promise<RevokeGitHubTokenResponse> {
+    return this.delete<RevokeGitHubTokenResponse>('/security-keys/github-token')
+  }
+
+  // ============================================================================
+  // Utility Methods
+  // ============================================================================
+
+  /**
+   * Validate provider API key creation request
+   *
+   * @param request - The request to validate
+   * @throws {Error} When validation fails
+   */
+  private validateProviderAPIKeyRequest(request: CreateProviderAPIKeyRequest): void {
+    if (!request.provider_key) {
+      throw new Error('provider_key is required')
+    }
+    if (!request.api_key) {
+      throw new Error('api_key is required')
+    }
+    if (request.api_key.length < 10) {
+      throw new Error('api_key must be at least 10 characters long')
+    }
+  }
+
+  /**
+   * Validate GitHub token creation request
+   * Matches the API validation for GitHub token formats
+   *
+   * @param request - The request to validate
+   * @throws {Error} When validation fails
+   */
+  private validateGitHubTokenRequest(request: CreateGitHubTokenRequest): void {
+    if (!request.github_token) {
+      throw new Error('github_token is required')
+    }
+
+    // Valid GitHub token prefixes according to the API
+    const validPrefixes = ['ghp_', 'gho_', 'ghu_', 'ghs_', 'ghr_', 'github_pat_']
+    const hasValidPrefix = validPrefixes.some(prefix => request.github_token.startsWith(prefix))
+
+    if (!hasValidPrefix) {
+      throw new Error('Invalid GitHub token format. Expected format: ghp_*, gho_*, ghu_*, ghs_*, or ghr_* followed by 36 characters')
+    }
+
+    // GitHub tokens should be at least 40 characters (prefix + 36 chars)
+    if (request.github_token.length < 40) {
+      throw new Error('GitHub token must be at least 40 characters long')
+    }
+  }
+
+  /**
+   * Handle API errors consistently
+   *
+   * @param error - The error response from the API
+   * @throws {Error} With the API error message
+   */
+  private handleAPIError(error: any): never {
+    if (error.response?.data?.detail) {
+      throw new Error(error.response.data.detail)
+    }
+    if (error.response?.data?.message) {
+      throw new Error(error.response.data.message)
+    }
+    if (error.message) {
+      throw new Error(error.message)
+    }
+    throw new Error('An unexpected error occurred')
+  }
+}