@codeguide/core 0.0.28 → 0.0.29

package/dist/services/usage/usage-service.js

@@ -11,6 +11,7 @@ class UsageService extends base_service_1.BaseService {
     }
     async checkCredits(params) {
         const queryParams = new URLSearchParams();
+        queryParams.append('model_key', params.model_key);
         if (params.input_tokens !== undefined)
             queryParams.append('input_tokens', params.input_tokens.toString());
         if (params.output_tokens !== undefined)
@@ -20,15 +21,6 @@ class UsageService extends base_service_1.BaseService {
         const url = `/usage/credit-check?${queryParams.toString()}`;
         return this.get(url);
     }
-    async getUsageSummary(params) {
-        const queryParams = new URLSearchParams();
-        if (params?.start_date)
-            queryParams.append('start_date', params.start_date);
-        if (params?.end_date)
-            queryParams.append('end_date', params.end_date);
-        const url = `/usage/summary${queryParams.toString() ? `?${queryParams.toString()}` : ''}`;
-        return this.get(url);
-    }
     async getAuthorization() {
         return this.get('/usage/authorization');
     }
@@ -64,5 +56,62 @@ class UsageService extends base_service_1.BaseService {
             return false;
         }
     }
+    // Dashboard Analytics Methods
+    async getDashboardAnalytics(params) {
+        const queryParams = new URLSearchParams();
+        if (params?.period)
+            queryParams.append('period', params.period);
+        if (params?.start_date)
+            queryParams.append('start_date', params.start_date);
+        if (params?.end_date)
+            queryParams.append('end_date', params.end_date);
+        if (params?.service_type)
+            queryParams.append('service_type', params.service_type);
+        const url = `/usage/dashboard/analytics${queryParams.toString() ? `?${queryParams.toString()}` : ''}`;
+        return this.get(url);
+    }
+    async getUsageDetails(params) {
+        const queryParams = new URLSearchParams();
+        if (params?.period)
+            queryParams.append('period', params.period);
+        if (params?.start_date)
+            queryParams.append('start_date', params.start_date);
+        if (params?.end_date)
+            queryParams.append('end_date', params.end_date);
+        if (params?.service_type)
+            queryParams.append('service_type', params.service_type);
+        if (params?.page !== undefined)
+            queryParams.append('page', params.page.toString());
+        if (params?.page_size !== undefined)
+            queryParams.append('page_size', params.page_size.toString());
+        if (params?.sort_by)
+            queryParams.append('sort_by', params.sort_by);
+        if (params?.sort_order)
+            queryParams.append('sort_order', params.sort_order);
+        const url = `/usage/dashboard/details${queryParams.toString() ? `?${queryParams.toString()}` : ''}`;
+        return this.get(url);
+    }
+    async getUsageSummary(params) {
+        const queryParams = new URLSearchParams();
+        if (params?.period)
+            queryParams.append('period', params.period);
+        if (params?.start_date)
+            queryParams.append('start_date', params.start_date);
+        if (params?.end_date)
+            queryParams.append('end_date', params.end_date);
+        const url = `/usage/dashboard/summary${queryParams.toString() ? `?${queryParams.toString()}` : ''}`;
+        return this.get(url);
+    }
+    async getServiceBreakdown(params) {
+        const queryParams = new URLSearchParams();
+        if (params?.period)
+            queryParams.append('period', params.period);
+        if (params?.start_date)
+            queryParams.append('start_date', params.start_date);
+        if (params?.end_date)
+            queryParams.append('end_date', params.end_date);
+        const url = `/usage/dashboard/services${queryParams.toString() ? `?${queryParams.toString()}` : ''}`;
+        return this.get(url);
+    }
 }
 exports.UsageService = UsageService;

package/dist/services/usage/usage-types.d.ts

@@ -11,7 +11,7 @@ export interface TrackUsageResponse {
     remaining_credits: number;
     message: string;
 }
-export interface CreditBalanceResponse {
+export interface CreditBalanceData {
     user_id: string;
     total_consumed: number;
     total_allotted: number;
@@ -24,6 +24,9 @@ export interface CreditBalanceResponse {
         status: string;
     };
 }
+export interface CreditBalanceResponse {
+    data: CreditBalanceData;
+}
 export interface CreditCheckRequest {
     model_key: string;
     input_tokens?: number;
@@ -36,31 +39,6 @@ export interface CreditCheckResponse {
     remaining_credits: number;
     model_key: string;
 }
-export interface UsageSummaryRequest {
-    start_date?: string;
-    end_date?: string;
-}
-export interface UsageSummaryResponse {
-    user_id: string;
-    period: {
-        start_date: string;
-        end_date: string;
-    };
-    usage_summary: {
-        total_credits_used: number;
-        total_calls: number;
-        model_breakdown: Record<string, any>;
-        daily_usage: Array<{
-            date: string;
-            credits_used: number;
-            calls: number;
-        }>;
-    };
-    subscription: {
-        plan: string;
-        status: string;
-    };
-}
 export interface CreditBalance {
     total_allotted: number;
     total_consumed: number;
@@ -180,3 +158,149 @@ export interface HealthResponse {
     timestamp: string;
     version: string;
 }
+export type PeriodType = "7d" | "1w" | "1m" | "3m";
+export type ServiceType = "docs" | "chat" | "codespace_task" | "api";
+export type SortOrder = "asc" | "desc";
+export type SortByField = "created_at" | "credits_consumed" | "cost_amount";
+export interface DashboardAnalyticsRequest {
+    period?: PeriodType;
+    start_date?: string;
+    end_date?: string;
+    service_type?: ServiceType;
+}
+export interface DailyUsage {
+    date: string;
+    credits_consumed: number;
+    cost_usd: number;
+    requests_count: number;
+    average_credits_per_request: number;
+}
+export interface ServiceUsage {
+    service_type: ServiceType;
+    credits_consumed: number;
+    requests_count: number;
+}
+export interface AnalyticsTotals {
+    credits_consumed: number;
+    cost_usd: number;
+    requests_count: number;
+}
+export interface AnalyticsAverages {
+    daily_credits: number;
+    daily_requests: number;
+}
+export interface AnalyticsTrends {
+    credits_consumed: number;
+    requests_count: number;
+}
+export interface PeriodInfo {
+    start: string;
+    end: string;
+    label: string;
+}
+export interface DashboardAnalyticsResponse {
+    status: string;
+    data: {
+        period: PeriodInfo;
+        daily_usage: DailyUsage[];
+        totals: AnalyticsTotals;
+        averages: AnalyticsAverages;
+        trends: AnalyticsTrends;
+        top_services: ServiceUsage[];
+    };
+}
+export interface UsageDetailsRequest {
+    period?: PeriodType;
+    start_date?: string;
+    end_date?: string;
+    service_type?: ServiceType;
+    page?: number;
+    page_size?: number;
+    sort_by?: SortByField;
+    sort_order?: SortOrder;
+}
+export interface UsageDetailRecord {
+    id: string;
+    created_at: string;
+    service_type: ServiceType;
+    model_name: string;
+    usage_type: string;
+    units_consumed: number;
+    credits_consumed: number;
+    cost_amount: number | null;
+}
+export interface UsageDetailsPagination {
+    page: number;
+    page_size: number;
+    total_count: number;
+    total_pages: number;
+    has_next: boolean;
+    has_prev: boolean;
+}
+export interface UsageDetailsFilters {
+    period: string | null;
+    start_date: string | null;
+    end_date: string | null;
+    service_type: string | null;
+}
+export interface UsageDetailsResponse {
+    status: string;
+    data: UsageDetailRecord[];
+    pagination: UsageDetailsPagination;
+    filters: UsageDetailsFilters;
+}
+export interface UsageSummaryRequest {
+    period?: PeriodType;
+    start_date?: string;
+    end_date?: string;
+}
+export interface CurrentPeriodUsage {
+    credits_consumed: number;
+    cost_usd: number;
+    requests_count: number;
+}
+export interface PreviousPeriodUsage {
+    credits_consumed: number;
+    cost_usd: number;
+    requests_count: number;
+}
+export interface BillingCycleInfo {
+    total_allotted: number;
+    total_consumed: number;
+    remaining_credits: number;
+}
+export interface UsageSummaryResponse {
+    status: string;
+    data: {
+        current_period: CurrentPeriodUsage;
+        previous_period: PreviousPeriodUsage;
+        billing_cycle: BillingCycleInfo;
+        utilization_percentage: number;
+        remaining_credits: number;
+        daily_average: number;
+        projected_monthly: number;
+    };
+}
+export interface ServiceBreakdownRequest {
+    period?: PeriodType;
+    start_date?: string;
+    end_date?: string;
+}
+export interface ServiceBreakdown {
+    service_type: ServiceType;
+    credits_consumed: number;
+    percentage: number;
+    cost_usd: number;
+    requests_count: number;
+    trend: number;
+}
+export interface ServiceBreakdownData {
+    period: PeriodInfo;
+    services: ServiceBreakdown[];
+    total_credits: number;
+    total_cost: number;
+}
+export interface ServiceBreakdownResponse {
+    status: string;
+    data: ServiceBreakdownData;
+}

package/docs/.vitepress/README.md

@@ -0,0 +1,51 @@
+# VitePress Documentation Setup
+
+This directory contains the VitePress configuration for the @codeguide/core documentation.
+
+## Structure
+
+- `config.ts` - Main VitePress configuration file (TypeScript)
+- `theme/` - Custom theme files
+  - `index.ts` - Theme entry point
+  - `custom.css` - Custom styles
+
+## Development
+
+To run the documentation locally:
+
+```bash
+cd packages/core
+npm install
+npm run docs:dev
+```
+
+Then open http://localhost:5173
+
+## Building
+
+To build the documentation for production:
+
+```bash
+npm run docs:build
+```
+
+The output will be in `packages/core/docs/.vitepress/dist`
+
+## Preview
+
+To preview the built documentation:
+
+```bash
+npm run docs:preview
+```
+
+## Configuration
+
+The main configuration is in `config.ts`. Key features:
+
+- TypeScript-based configuration
+- Sidebar navigation
+- Search functionality
+- Edit links to GitHub
+- Custom theme styling
+

package/docs/.vitepress/config.ts

@@ -0,0 +1,139 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: '@codeguide/core',
+  description: 'Documentation for @codeguide/core package - TypeScript SDK for CodeGuide API',
+  
+  // Server configuration
+  server: {
+    port: 5174,
+    host: true,
+  },
+  
+  // Base URL if deploying to a subdirectory
+  base: '/',
+  
+  // Theme configuration
+  themeConfig: {
+    // Logo (optional)
+    logo: '/logo.png', // You can add a logo later
+    
+    // Site title in nav
+    siteTitle: '@codeguide/core',
+    
+    // Navigation bar
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Getting Started', link: '/codeguide-client' },
+      { text: 'Services', link: '/projects-service' },
+      { text: 'GitHub', link: 'https://github.com/CodeGuide-dev/codeguide' },
+    ],
+    
+    // Sidebar navigation
+    sidebar: [
+      {
+        text: 'Getting Started',
+        items: [
+          { text: 'Overview', link: '/' },
+          { text: 'CodeGuide Client', link: '/codeguide-client' },
+          { text: 'Authentication', link: '/authentication' },
+        ],
+      },
+      {
+        text: 'Services',
+        items: [
+          { text: 'Projects Service', link: '/projects-service' },
+          { text: 'Codespace Service', link: '/codespace-service' },
+          { text: 'Codespace Models', link: '/codespace-models' },
+          { text: 'Security Keys Service', link: '/security-keys-service' },
+          { text: 'Usage Service', link: '/usage-service' },
+        ],
+      },
+    ],
+    
+    // Social links
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/CodeGuide-dev/codeguide' },
+    ],
+    
+    // Search configuration
+    search: {
+      provider: 'local',
+      options: {
+        locales: {
+          root: {
+            translations: {
+              button: {
+                buttonText: 'Search',
+                buttonAriaLabel: 'Search documentation',
+              },
+              modal: {
+                noResultsText: 'No results for',
+                resetButtonTitle: 'Reset search',
+                footer: {
+                  selectText: 'to select',
+                  navigateText: 'to navigate',
+                  closeText: 'to close',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    
+    // Footer
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2024 CodeGuide Team',
+    },
+    
+    // Edit link
+    editLink: {
+      pattern: 'https://github.com/CodeGuide-dev/codeguide/blob/main/packages/core/docs/:path',
+      text: 'Edit this page on GitHub',
+    },
+    
+    // Carbon ads (optional - remove if not needed)
+    // carbonAds: {
+    //   code: 'your-code',
+    //   placement: 'your-placement'
+    // },
+    
+    // Last updated
+    lastUpdated: {
+      text: 'Last updated',
+    },
+    
+    // Outline configuration
+    outline: {
+      level: [2, 3],
+      label: 'On this page',
+    },
+    
+    // Doc footer (prev/next links)
+    docFooter: {
+      prev: 'Previous page',
+      next: 'Next page',
+    },
+  },
+  
+  // Markdown configuration
+  markdown: {
+    lineNumbers: true,
+    theme: {
+      light: 'github-light',
+      dark: 'github-dark',
+    },
+    // Disable Vue component parsing in markdown to avoid conflicts
+    breaks: false,
+  },
+  
+  // Head configuration
+  head: [
+    ['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0' }],
+    ['meta', { name: 'description', content: 'Documentation for @codeguide/core package' }],
+    ['link', { rel: 'icon', href: '/favicon.ico' }],
+  ],
+})
+

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.
+