@codeguide/core 0.0.27 → 0.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -41
- package/__tests__/services/codespace/codespace-v2.test.ts +29 -18
- package/__tests__/services/usage/usage-service.test.ts +162 -9
- package/codeguide.ts +3 -0
- package/dist/codeguide.d.ts +2 -1
- package/dist/codeguide.js +1 -0
- package/dist/services/codespace/codespace-service.js +3 -5
- package/dist/services/codespace/codespace-types.d.ts +1 -1
- package/dist/services/index.d.ts +2 -0
- package/dist/services/index.js +4 -1
- package/dist/services/repository-analysis/repository-types.d.ts +1 -0
- package/dist/services/usage/usage-types.d.ts +60 -11
- package/dist/services/users/index.d.ts +2 -0
- package/dist/services/users/index.js +20 -0
- package/dist/services/users/user-service.d.ts +12 -0
- package/dist/services/users/user-service.js +17 -0
- package/dist/services/users/user-types.d.ts +55 -0
- package/dist/services/users/user-types.js +2 -0
- package/docs/codespace-service.md +114 -81
- package/docs/usage-service.md +326 -0
- package/package.json +1 -1
- package/services/codespace/codespace-service.ts +10 -8
- package/services/codespace/codespace-types.ts +1 -1
- package/services/index.ts +2 -0
- package/services/repository-analysis/repository-types.ts +1 -0
- package/services/usage/usage-types.ts +65 -11
- package/services/users/index.ts +2 -0
- package/services/users/user-service.ts +15 -0
- package/services/users/user-types.ts +59 -0
|
@@ -61,18 +61,67 @@ export interface UsageSummaryResponse {
|
|
|
61
61
|
status: string;
|
|
62
62
|
};
|
|
63
63
|
}
|
|
64
|
-
export interface
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
64
|
+
export interface CreditBalance {
|
|
65
|
+
total_allotted: number;
|
|
66
|
+
total_consumed: number;
|
|
67
|
+
remaining_credits: number;
|
|
68
|
+
is_over_limit: boolean;
|
|
69
|
+
utilization_percentage: number;
|
|
70
|
+
billing_cycle_start: string;
|
|
71
|
+
billing_cycle_end: string;
|
|
72
|
+
}
|
|
73
|
+
export interface LimitInfo {
|
|
74
|
+
allowed?: boolean;
|
|
75
|
+
current_usage?: number;
|
|
76
|
+
limit: number;
|
|
77
|
+
remaining?: number;
|
|
78
|
+
period_type?: string;
|
|
79
|
+
period_start?: string | null;
|
|
80
|
+
period_end?: string | null;
|
|
81
|
+
message?: string;
|
|
82
|
+
is_unlimited: boolean;
|
|
83
|
+
period?: string;
|
|
84
|
+
description?: string;
|
|
85
|
+
}
|
|
86
|
+
export interface PlanLimits {
|
|
87
|
+
plan_type: string;
|
|
88
|
+
limits: {
|
|
89
|
+
codespace_tasks: LimitInfo;
|
|
90
|
+
api_calls: LimitInfo;
|
|
91
|
+
storage_gb: LimitInfo;
|
|
92
|
+
projects: LimitInfo;
|
|
93
|
+
collaborators: LimitInfo;
|
|
74
94
|
};
|
|
75
|
-
|
|
95
|
+
}
|
|
96
|
+
export interface AuthorizationSubscription {
|
|
97
|
+
id: string;
|
|
98
|
+
status: string;
|
|
99
|
+
interval: string;
|
|
100
|
+
current_period_start: string;
|
|
101
|
+
current_period_end: string;
|
|
102
|
+
price_id: string;
|
|
103
|
+
product_name: string | null;
|
|
104
|
+
plan_name: string;
|
|
105
|
+
}
|
|
106
|
+
export interface AuthorizationData {
|
|
107
|
+
user_id: string;
|
|
108
|
+
subscription: AuthorizationSubscription | null;
|
|
109
|
+
credit_balance: CreditBalance;
|
|
110
|
+
has_active_subscription: boolean;
|
|
111
|
+
has_previous_subscriptions: boolean;
|
|
112
|
+
is_within_credit_limit: boolean;
|
|
113
|
+
authorization_level: string;
|
|
114
|
+
restrictions: string[];
|
|
115
|
+
can_create_tasks: boolean;
|
|
116
|
+
can_analyze_repos: boolean;
|
|
117
|
+
can_access_previous_projects: boolean;
|
|
118
|
+
plan_limits: PlanLimits;
|
|
119
|
+
codespace_task_limit: LimitInfo | null;
|
|
120
|
+
}
|
|
121
|
+
export interface AuthorizationResponse {
|
|
122
|
+
success: boolean;
|
|
123
|
+
data: AuthorizationData;
|
|
124
|
+
message: string;
|
|
76
125
|
}
|
|
77
126
|
export interface FreeUserStatusResponse {
|
|
78
127
|
is_free_user: boolean;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.UserService = void 0;
|
|
18
|
+
var user_service_1 = require("./user-service");
|
|
19
|
+
Object.defineProperty(exports, "UserService", { enumerable: true, get: function () { return user_service_1.UserService; } });
|
|
20
|
+
__exportStar(require("./user-types"), exports);
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { BaseService } from '../base/base-service';
|
|
2
|
+
import { GetCurrentClerkUserResponse } from './user-types';
|
|
3
|
+
export declare class UserService extends BaseService {
|
|
4
|
+
/**
|
|
5
|
+
* Get the current Clerk user information
|
|
6
|
+
*
|
|
7
|
+
* GET /users/me/clerk
|
|
8
|
+
*
|
|
9
|
+
* @returns Promise resolving to the current Clerk user data
|
|
10
|
+
*/
|
|
11
|
+
getCurrentClerkUser(): Promise<GetCurrentClerkUserResponse>;
|
|
12
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.UserService = void 0;
|
|
4
|
+
const base_service_1 = require("../base/base-service");
|
|
5
|
+
class UserService extends base_service_1.BaseService {
|
|
6
|
+
/**
|
|
7
|
+
* Get the current Clerk user information
|
|
8
|
+
*
|
|
9
|
+
* GET /users/me/clerk
|
|
10
|
+
*
|
|
11
|
+
* @returns Promise resolving to the current Clerk user data
|
|
12
|
+
*/
|
|
13
|
+
async getCurrentClerkUser() {
|
|
14
|
+
return this.get('/users/me/clerk');
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
exports.UserService = UserService;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Email address verification information
|
|
3
|
+
*/
|
|
4
|
+
export interface EmailVerification {
|
|
5
|
+
status: 'verified' | 'unverified';
|
|
6
|
+
strategy: string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Email address information
|
|
10
|
+
*/
|
|
11
|
+
export interface EmailAddress {
|
|
12
|
+
id: string;
|
|
13
|
+
email_address: string;
|
|
14
|
+
verification: EmailVerification;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Clerk user metadata
|
|
18
|
+
*/
|
|
19
|
+
export interface ClerkUserMetadata {
|
|
20
|
+
[key: string]: any;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Clerk user data structure
|
|
24
|
+
*/
|
|
25
|
+
export interface ClerkUserData {
|
|
26
|
+
user_id: string;
|
|
27
|
+
first_name: string | null;
|
|
28
|
+
last_name: string | null;
|
|
29
|
+
username: string | null;
|
|
30
|
+
email_addresses: EmailAddress[];
|
|
31
|
+
phone_numbers: Array<{
|
|
32
|
+
id: string;
|
|
33
|
+
phone_number: string;
|
|
34
|
+
verification: {
|
|
35
|
+
status: 'verified' | 'unverified';
|
|
36
|
+
strategy: string;
|
|
37
|
+
};
|
|
38
|
+
}>;
|
|
39
|
+
primary_email_address: string | null;
|
|
40
|
+
primary_phone_number: string | null;
|
|
41
|
+
image_url: string | null;
|
|
42
|
+
created_at: number;
|
|
43
|
+
updated_at: number;
|
|
44
|
+
last_sign_in_at: number | null;
|
|
45
|
+
public_metadata: ClerkUserMetadata;
|
|
46
|
+
private_metadata: ClerkUserMetadata;
|
|
47
|
+
unsafe_metadata: ClerkUserMetadata;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Response for getting current Clerk user
|
|
51
|
+
*/
|
|
52
|
+
export interface GetCurrentClerkUserResponse {
|
|
53
|
+
status: 'success' | 'error';
|
|
54
|
+
data: ClerkUserData;
|
|
55
|
+
}
|