@robosystems/client 0.1.14 → 0.1.16
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 +3 -5
- package/package.json +49 -7
- package/sdk/client/client.gen.d.ts +2 -0
- package/sdk/client/client.gen.js +153 -0
- package/sdk/client/client.gen.ts +200 -0
- package/sdk/client/index.d.ts +7 -0
- package/sdk/client/index.js +15 -0
- package/sdk/client/index.ts +25 -0
- package/sdk/client/types.gen.d.ts +122 -0
- package/sdk/client/types.gen.js +4 -0
- package/sdk/client/types.gen.ts +233 -0
- package/sdk/client/utils.gen.d.ts +45 -0
- package/sdk/client/utils.gen.js +296 -0
- package/sdk/client/utils.gen.ts +419 -0
- package/sdk/client.gen.d.ts +12 -0
- package/sdk/client.gen.js +8 -0
- package/sdk/client.gen.ts +18 -0
- package/sdk/core/auth.gen.d.ts +18 -0
- package/sdk/core/auth.gen.js +18 -0
- package/sdk/core/auth.gen.ts +42 -0
- package/sdk/core/bodySerializer.gen.d.ts +17 -0
- package/sdk/core/bodySerializer.gen.js +57 -0
- package/sdk/core/bodySerializer.gen.ts +90 -0
- package/sdk/core/params.gen.d.ts +33 -0
- package/sdk/core/params.gen.js +92 -0
- package/sdk/core/params.gen.ts +153 -0
- package/sdk/core/pathSerializer.gen.d.ts +33 -0
- package/sdk/core/pathSerializer.gen.js +123 -0
- package/sdk/core/pathSerializer.gen.ts +181 -0
- package/sdk/core/types.gen.d.ts +78 -0
- package/sdk/core/types.gen.js +4 -0
- package/sdk/core/types.gen.ts +121 -0
- package/sdk/index.d.ts +2 -0
- package/sdk/index.js +19 -0
- package/sdk/index.ts +3 -0
- package/sdk/sdk.gen.d.ts +1269 -0
- package/sdk/sdk.gen.js +2664 -0
- package/sdk/sdk.gen.ts +2677 -0
- package/sdk/types.gen.d.ts +6265 -0
- package/sdk/types.gen.js +3 -0
- package/sdk/types.gen.ts +6784 -0
- package/sdk-extensions/OperationClient.d.ts +64 -0
- package/sdk-extensions/OperationClient.js +251 -0
- package/sdk-extensions/OperationClient.ts +322 -0
- package/sdk-extensions/QueryClient.d.ts +50 -0
- package/sdk-extensions/QueryClient.js +190 -0
- package/sdk-extensions/QueryClient.ts +283 -0
- package/sdk-extensions/README.md +672 -0
- package/sdk-extensions/SSEClient.d.ts +48 -0
- package/sdk-extensions/SSEClient.js +148 -0
- package/sdk-extensions/SSEClient.ts +189 -0
- package/sdk-extensions/config.d.ts +32 -0
- package/sdk-extensions/config.js +74 -0
- package/sdk-extensions/config.ts +91 -0
- package/sdk-extensions/hooks.d.ts +110 -0
- package/sdk-extensions/hooks.js +371 -0
- package/sdk-extensions/hooks.ts +438 -0
- package/sdk-extensions/index.d.ts +46 -0
- package/sdk-extensions/index.js +110 -0
- package/sdk-extensions/index.ts +123 -0
- package/sdk.gen.d.ts +172 -48
- package/sdk.gen.js +297 -69
- package/sdk.gen.ts +296 -68
- package/types.gen.d.ts +647 -94
- package/types.gen.ts +727 -134
- package/openapi-ts.config.js +0 -9
- package/prepare.js +0 -221
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* RoboSystems SDK Extensions
|
|
3
|
+
* Enhanced clients with SSE support for the RoboSystems API
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
import { client } from '../sdk/client.gen'
|
|
7
|
+
import { OperationClient } from './OperationClient'
|
|
8
|
+
import { QueryClient } from './QueryClient'
|
|
9
|
+
import { SSEClient } from './SSEClient'
|
|
10
|
+
|
|
11
|
+
export interface RoboSystemsExtensionConfig {
|
|
12
|
+
baseUrl?: string
|
|
13
|
+
credentials?: 'include' | 'same-origin' | 'omit'
|
|
14
|
+
maxRetries?: number
|
|
15
|
+
retryDelay?: number
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export class RoboSystemsExtensions {
|
|
19
|
+
public readonly query: QueryClient
|
|
20
|
+
public readonly operations: OperationClient
|
|
21
|
+
private config: Required<RoboSystemsExtensionConfig>
|
|
22
|
+
|
|
23
|
+
constructor(config: RoboSystemsExtensionConfig = {}) {
|
|
24
|
+
// Get base URL from SDK client config or use provided/default
|
|
25
|
+
const sdkConfig = client.getConfig()
|
|
26
|
+
|
|
27
|
+
this.config = {
|
|
28
|
+
baseUrl: config.baseUrl || sdkConfig.baseUrl || 'http://localhost:8000',
|
|
29
|
+
credentials: config.credentials || 'include',
|
|
30
|
+
maxRetries: config.maxRetries || 5,
|
|
31
|
+
retryDelay: config.retryDelay || 1000,
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
this.query = new QueryClient({
|
|
35
|
+
baseUrl: this.config.baseUrl,
|
|
36
|
+
credentials: this.config.credentials,
|
|
37
|
+
})
|
|
38
|
+
|
|
39
|
+
this.operations = new OperationClient({
|
|
40
|
+
baseUrl: this.config.baseUrl,
|
|
41
|
+
credentials: this.config.credentials,
|
|
42
|
+
})
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Convenience method to monitor any operation
|
|
47
|
+
*/
|
|
48
|
+
async monitorOperation(operationId: string, onProgress?: (progress: any) => void): Promise<any> {
|
|
49
|
+
return this.operations.monitorOperation(operationId, { onProgress })
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Create custom SSE client for advanced use cases
|
|
54
|
+
*/
|
|
55
|
+
createSSEClient(): SSEClient {
|
|
56
|
+
return new SSEClient({
|
|
57
|
+
baseUrl: this.config.baseUrl,
|
|
58
|
+
credentials: this.config.credentials,
|
|
59
|
+
maxRetries: this.config.maxRetries,
|
|
60
|
+
retryDelay: this.config.retryDelay,
|
|
61
|
+
})
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Clean up all active connections
|
|
66
|
+
*/
|
|
67
|
+
close(): void {
|
|
68
|
+
this.query.close()
|
|
69
|
+
this.operations.closeAll()
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// Export all types and classes
|
|
74
|
+
export * from './OperationClient'
|
|
75
|
+
export * from './QueryClient'
|
|
76
|
+
export * from './SSEClient'
|
|
77
|
+
export { OperationClient, QueryClient, SSEClient }
|
|
78
|
+
|
|
79
|
+
// Export React hooks
|
|
80
|
+
export {
|
|
81
|
+
useMultipleOperations,
|
|
82
|
+
useOperation,
|
|
83
|
+
useQuery,
|
|
84
|
+
useSDKClients,
|
|
85
|
+
useStreamingQuery,
|
|
86
|
+
} from './hooks'
|
|
87
|
+
|
|
88
|
+
// Lazy initialization of default instance
|
|
89
|
+
let _extensions: RoboSystemsExtensions | null = null
|
|
90
|
+
|
|
91
|
+
function getExtensions(): RoboSystemsExtensions {
|
|
92
|
+
if (!_extensions) {
|
|
93
|
+
_extensions = new RoboSystemsExtensions()
|
|
94
|
+
}
|
|
95
|
+
return _extensions
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export const extensions = {
|
|
99
|
+
get query() {
|
|
100
|
+
return getExtensions().query
|
|
101
|
+
},
|
|
102
|
+
get operations() {
|
|
103
|
+
return getExtensions().operations
|
|
104
|
+
},
|
|
105
|
+
monitorOperation: (operationId: string, onProgress?: (progress: any) => void) =>
|
|
106
|
+
getExtensions().monitorOperation(operationId, onProgress),
|
|
107
|
+
createSSEClient: () => getExtensions().createSSEClient(),
|
|
108
|
+
close: () => getExtensions().close(),
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
// Export convenience functions that use the default instance
|
|
112
|
+
export const monitorOperation = (operationId: string, onProgress?: (progress: any) => void) =>
|
|
113
|
+
getExtensions().monitorOperation(operationId, onProgress)
|
|
114
|
+
|
|
115
|
+
export const executeQuery = (graphId: string, query: string, parameters?: Record<string, any>) =>
|
|
116
|
+
getExtensions().query.query(graphId, query, parameters)
|
|
117
|
+
|
|
118
|
+
export const streamQuery = (
|
|
119
|
+
graphId: string,
|
|
120
|
+
query: string,
|
|
121
|
+
parameters?: Record<string, any>,
|
|
122
|
+
chunkSize?: number
|
|
123
|
+
) => getExtensions().query.streamQuery(graphId, query, parameters, chunkSize)
|
package/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Options as ClientOptions, TDataShape, Client } from './client';
|
|
2
|
-
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshSessionData, RefreshSessionResponses, RefreshSessionErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, GetServiceStatusData, GetServiceStatusResponses,
|
|
2
|
+
import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, GetCurrentAuthUserData, GetCurrentAuthUserResponses, GetCurrentAuthUserErrors, RefreshSessionData, RefreshSessionResponses, RefreshSessionErrors, GenerateSsoTokenData, GenerateSsoTokenResponses, GenerateSsoTokenErrors, SsoLoginData, SsoLoginResponses, SsoLoginErrors, SsoTokenExchangeData, SsoTokenExchangeResponses, SsoTokenExchangeErrors, CompleteSsoAuthData, CompleteSsoAuthResponses, CompleteSsoAuthErrors, GetCaptchaConfigData, GetCaptchaConfigResponses, GetPasswordPolicyData, GetPasswordPolicyResponses, CheckPasswordStrengthData, CheckPasswordStrengthResponses, CheckPasswordStrengthErrors, GetServiceStatusData, GetServiceStatusResponses, GetCurrentUserData, GetCurrentUserResponses, GetCurrentUserErrors, UpdateUserData, UpdateUserResponses, UpdateUserErrors, GetUserGraphsData, GetUserGraphsResponses, GetUserGraphsErrors, SelectUserGraphData, SelectUserGraphResponses, SelectUserGraphErrors, GetAllCreditSummariesData, GetAllCreditSummariesResponses, GetAllCreditSummariesErrors, UpdateUserPasswordData, UpdateUserPasswordResponses, UpdateUserPasswordErrors, ListUserApiKeysData, ListUserApiKeysResponses, ListUserApiKeysErrors, CreateUserApiKeyData, CreateUserApiKeyResponses, CreateUserApiKeyErrors, RevokeUserApiKeyData, RevokeUserApiKeyResponses, RevokeUserApiKeyErrors, UpdateUserApiKeyData, UpdateUserApiKeyResponses, UpdateUserApiKeyErrors, GetUserLimitsData, GetUserLimitsResponses, GetUserLimitsErrors, GetUserUsageData, GetUserUsageResponses, GetUserUsageErrors, GetSharedRepositoryLimitsData, GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, GetAllSharedRepositoryLimitsData, GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, GetUserUsageOverviewData, GetUserUsageOverviewResponses, GetUserUsageOverviewErrors, GetDetailedUserAnalyticsData, GetDetailedUserAnalyticsResponses, GetDetailedUserAnalyticsErrors, GetUserSharedSubscriptionsData, GetUserSharedSubscriptionsResponses, GetUserSharedSubscriptionsErrors, SubscribeToSharedRepositoryData, SubscribeToSharedRepositoryResponses, SubscribeToSharedRepositoryErrors, UpgradeSharedRepositorySubscriptionData, UpgradeSharedRepositorySubscriptionResponses, UpgradeSharedRepositorySubscriptionErrors, CancelSharedRepositorySubscriptionData, CancelSharedRepositorySubscriptionResponses, CancelSharedRepositorySubscriptionErrors, GetSharedRepositoryCreditsData, GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, GetRepositoryCreditsData, GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, GetConnectionOptionsData, GetConnectionOptionsResponses, GetConnectionOptionsErrors, ListConnectionsData, ListConnectionsResponses, ListConnectionsErrors, CreateConnectionData, CreateConnectionResponses, CreateConnectionErrors, DeleteConnectionData, DeleteConnectionResponses, DeleteConnectionErrors, GetConnectionData, GetConnectionResponses, GetConnectionErrors, SyncConnectionData, SyncConnectionResponses, SyncConnectionErrors, CreateLinkTokenData, CreateLinkTokenResponses, CreateLinkTokenErrors, ExchangeLinkTokenData, ExchangeLinkTokenResponses, ExchangeLinkTokenErrors, InitOAuthData, InitOAuthResponses, InitOAuthErrors, OauthCallbackData, OauthCallbackResponses, OauthCallbackErrors, QueryFinancialAgentData, QueryFinancialAgentResponses, QueryFinancialAgentErrors, ListMcpToolsData, ListMcpToolsResponses, ListMcpToolsErrors, CallMcpToolData, CallMcpToolResponses, CallMcpToolErrors, CreateBackupData, CreateBackupResponses, CreateBackupErrors, ListBackupsData, ListBackupsResponses, ListBackupsErrors, ExportBackupData, ExportBackupResponses, ExportBackupErrors, RestoreBackupData, RestoreBackupResponses, RestoreBackupErrors, GetBackupStatsData, GetBackupStatsResponses, GetBackupStatsErrors, KuzuBackupHealthData, KuzuBackupHealthResponses, KuzuBackupHealthErrors, GetBackupDownloadUrlData, GetBackupDownloadUrlResponses, GetBackupDownloadUrlErrors, GetGraphMetricsData, GetGraphMetricsResponses, GetGraphMetricsErrors, GetGraphUsageStatsData, GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ExecuteCypherQueryData, ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, GetGraphSchemaInfoData, GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ValidateSchemaData, ValidateSchemaResponses, ValidateSchemaErrors, ExportGraphSchemaData, ExportGraphSchemaResponses, ExportGraphSchemaErrors, ListSchemaExtensionsData, ListSchemaExtensionsResponses, ListSchemaExtensionsErrors, GetCurrentGraphBillData, GetCurrentGraphBillResponses, GetCurrentGraphBillErrors, GetGraphMonthlyBillData, GetGraphMonthlyBillResponses, GetGraphMonthlyBillErrors, GetGraphBillingHistoryData, GetGraphBillingHistoryResponses, GetGraphBillingHistoryErrors, GetGraphUsageDetailsData, GetGraphUsageDetailsResponses, GetGraphUsageDetailsErrors, GetGraphPricingInfoV1GraphIdBillingPricingGetData, GetGraphPricingInfoV1GraphIdBillingPricingGetResponses, GetGraphPricingInfoV1GraphIdBillingPricingGetErrors, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostData, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostResponses, UpgradeGraphSubscriptionV1GraphIdBillingSubscriptionUpgradePostErrors, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetData, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetResponses, GetGraphSubscriptionV1GraphIdBillingSubscriptionGetErrors, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetData, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetResponses, GetAvailableSubscriptionPlansV1GraphIdBillingAvailablePlansGetErrors, GetCreditBillingInfoV1GraphIdBillingCreditsGetData, GetCreditBillingInfoV1GraphIdBillingCreditsGetResponses, GetCreditBillingInfoV1GraphIdBillingCreditsGetErrors, GetCreditSummaryData, GetCreditSummaryResponses, GetCreditSummaryErrors, ListCreditTransactionsData, ListCreditTransactionsResponses, ListCreditTransactionsErrors, CheckCreditBalanceData, CheckCreditBalanceResponses, CheckCreditBalanceErrors, GetStorageUsageData, GetStorageUsageResponses, GetStorageUsageErrors, CheckStorageLimitsData, CheckStorageLimitsResponses, CheckStorageLimitsErrors, GetDatabaseHealthData, GetDatabaseHealthResponses, GetDatabaseHealthErrors, GetDatabaseInfoData, GetDatabaseInfoResponses, GetDatabaseInfoErrors, ListSubgraphsData, ListSubgraphsResponses, ListSubgraphsErrors, CreateSubgraphData, CreateSubgraphResponses, CreateSubgraphErrors, DeleteSubgraphData, DeleteSubgraphResponses, DeleteSubgraphErrors, GetSubgraphQuotaData, GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, GetSubgraphInfoData, GetSubgraphInfoResponses, GetSubgraphInfoErrors, CreateGraphData, CreateGraphResponses, CreateGraphErrors, GetAvailableExtensionsData, GetAvailableExtensionsResponses, GetServiceOfferingsData, GetServiceOfferingsResponses, GetServiceOfferingsErrors, StreamOperationEventsData, StreamOperationEventsResponses, StreamOperationEventsErrors, GetOperationStatusData, GetOperationStatusResponses, GetOperationStatusErrors, CancelOperationData, CancelOperationResponses, CancelOperationErrors } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -78,11 +78,6 @@ export declare const checkPasswordStrength: <ThrowOnError extends boolean = fals
|
|
|
78
78
|
* Service health check endpoint for monitoring and load balancers
|
|
79
79
|
*/
|
|
80
80
|
export declare const getServiceStatus: <ThrowOnError extends boolean = false>(options?: Options<GetServiceStatusData, ThrowOnError>) => import("./client").RequestResult<GetServiceStatusResponses, unknown, ThrowOnError, "fields">;
|
|
81
|
-
/**
|
|
82
|
-
* MCP System Health Check
|
|
83
|
-
* Basic health check for MCP system components
|
|
84
|
-
*/
|
|
85
|
-
export declare const getMcpHealth: <ThrowOnError extends boolean = false>(options?: Options<GetMcpHealthData, ThrowOnError>) => import("./client").RequestResult<GetMcpHealthResponses, unknown, ThrowOnError, "fields">;
|
|
86
81
|
/**
|
|
87
82
|
* Get Current User
|
|
88
83
|
* Returns information about the currently authenticated user.
|
|
@@ -149,6 +144,24 @@ export declare const getUserLimits: <ThrowOnError extends boolean = false>(optio
|
|
|
149
144
|
* Retrieve current usage statistics and remaining limits for the authenticated user
|
|
150
145
|
*/
|
|
151
146
|
export declare const getUserUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUserUsageData, ThrowOnError>) => import("./client").RequestResult<GetUserUsageResponses, GetUserUsageErrors, ThrowOnError, "fields">;
|
|
147
|
+
/**
|
|
148
|
+
* Get shared repository rate limit status
|
|
149
|
+
* Get current rate limit status and usage for a shared repository.
|
|
150
|
+
*
|
|
151
|
+
* Returns:
|
|
152
|
+
* - Current usage across different time windows
|
|
153
|
+
* - Rate limits based on subscription tier
|
|
154
|
+
* - Remaining quota
|
|
155
|
+
* - Reset times
|
|
156
|
+
*
|
|
157
|
+
* Note: All queries are FREE - this only shows rate limit status.
|
|
158
|
+
*/
|
|
159
|
+
export declare const getSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options: Options<GetSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryLimitsResponses, GetSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
|
|
160
|
+
/**
|
|
161
|
+
* Get all shared repository limits
|
|
162
|
+
* Get rate limit status for all shared repositories the user has access to.
|
|
163
|
+
*/
|
|
164
|
+
export declare const getAllSharedRepositoryLimits: <ThrowOnError extends boolean = false>(options?: Options<GetAllSharedRepositoryLimitsData, ThrowOnError>) => import("./client").RequestResult<GetAllSharedRepositoryLimitsResponses, GetAllSharedRepositoryLimitsErrors, ThrowOnError, "fields">;
|
|
152
165
|
/**
|
|
153
166
|
* Get User Usage Overview
|
|
154
167
|
* Get a high-level overview of usage statistics for the current user.
|
|
@@ -186,7 +199,7 @@ export declare const cancelSharedRepositorySubscription: <ThrowOnError extends b
|
|
|
186
199
|
export declare const getSharedRepositoryCredits: <ThrowOnError extends boolean = false>(options?: Options<GetSharedRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetSharedRepositoryCreditsResponses, GetSharedRepositoryCreditsErrors, ThrowOnError, "fields">;
|
|
187
200
|
/**
|
|
188
201
|
* Get Repository Credits
|
|
189
|
-
* Get credit balance for a specific shared repository
|
|
202
|
+
* Get credit balance for a specific shared repository
|
|
190
203
|
*/
|
|
191
204
|
export declare const getRepositoryCredits: <ThrowOnError extends boolean = false>(options: Options<GetRepositoryCreditsData, ThrowOnError>) => import("./client").RequestResult<GetRepositoryCreditsResponses, GetRepositoryCreditsErrors, ThrowOnError, "fields">;
|
|
192
205
|
/**
|
|
@@ -252,10 +265,8 @@ export declare const listConnections: <ThrowOnError extends boolean = false>(opt
|
|
|
252
265
|
* - User completes bank authentication
|
|
253
266
|
* - Exchange public token for access
|
|
254
267
|
*
|
|
255
|
-
*
|
|
256
|
-
* -
|
|
257
|
-
* - Multiplied by graph tier
|
|
258
|
-
* - Additional credits consumed during data sync
|
|
268
|
+
* Note:
|
|
269
|
+
* This operation is FREE - no credit consumption required.
|
|
259
270
|
*/
|
|
260
271
|
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => import("./client").RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError, "fields">;
|
|
261
272
|
/**
|
|
@@ -268,9 +279,8 @@ export declare const createConnection: <ThrowOnError extends boolean = false>(op
|
|
|
268
279
|
* - Performs provider-specific cleanup
|
|
269
280
|
* - Revokes stored credentials
|
|
270
281
|
*
|
|
271
|
-
*
|
|
272
|
-
* -
|
|
273
|
-
* - Multiplied by graph tier
|
|
282
|
+
* Note:
|
|
283
|
+
* This operation is FREE - no credit consumption required.
|
|
274
284
|
*
|
|
275
285
|
* Only users with admin role can delete connections.
|
|
276
286
|
*/
|
|
@@ -311,10 +321,8 @@ export declare const getConnection: <ThrowOnError extends boolean = false>(optio
|
|
|
311
321
|
* - Updates account balances
|
|
312
322
|
* - Categorizes new transactions
|
|
313
323
|
*
|
|
314
|
-
*
|
|
315
|
-
* -
|
|
316
|
-
* - Multiplied by graph tier
|
|
317
|
-
* - Additional credits may be consumed during processing
|
|
324
|
+
* Note:
|
|
325
|
+
* This operation is FREE - no credit consumption required.
|
|
318
326
|
*
|
|
319
327
|
* Returns a task ID for monitoring sync progress.
|
|
320
328
|
*/
|
|
@@ -434,10 +442,10 @@ export declare const oauthCallback: <ThrowOnError extends boolean = false>(optio
|
|
|
434
442
|
* - Fallback to status polling endpoint if SSE unavailable
|
|
435
443
|
*
|
|
436
444
|
* **Credit Consumption:**
|
|
437
|
-
* -
|
|
438
|
-
* -
|
|
439
|
-
* -
|
|
440
|
-
* -
|
|
445
|
+
* - AI operations consume credits based on actual token usage
|
|
446
|
+
* - Claude 4/4.1 Opus: ~15 credits per 1K input tokens, ~75 credits per 1K output tokens
|
|
447
|
+
* - Claude 4 Sonnet: ~3 credits per 1K input tokens, ~15 credits per 1K output tokens
|
|
448
|
+
* - Credits are consumed after operation completes based on actual usage
|
|
441
449
|
*
|
|
442
450
|
* The agent automatically determines query complexity or you can force extended analysis.
|
|
443
451
|
*/
|
|
@@ -495,11 +503,8 @@ export declare const listMcpTools: <ThrowOnError extends boolean = false>(option
|
|
|
495
503
|
* - `408 Request Timeout`: Tool execution exceeded timeout
|
|
496
504
|
* - Clients should implement exponential backoff on errors
|
|
497
505
|
*
|
|
498
|
-
* **
|
|
499
|
-
*
|
|
500
|
-
* - Schema tools: 5-10 credits
|
|
501
|
-
* - Query tools: 10-50 credits (based on complexity)
|
|
502
|
-
* - Multiplied by graph tier
|
|
506
|
+
* **Note:**
|
|
507
|
+
* MCP tool calls are currently FREE and do not consume credits.
|
|
503
508
|
*/
|
|
504
509
|
export declare const callMcpTool: <ThrowOnError extends boolean = false>(options: Options<CallMcpToolData, ThrowOnError>) => import("./client").RequestResult<CallMcpToolResponses, CallMcpToolErrors, ThrowOnError, "fields">;
|
|
505
510
|
/**
|
|
@@ -636,9 +641,8 @@ export declare const getBackupDownloadUrl: <ThrowOnError extends boolean = false
|
|
|
636
641
|
* - Capacity planning
|
|
637
642
|
* - Performance optimization
|
|
638
643
|
*
|
|
639
|
-
*
|
|
640
|
-
* -
|
|
641
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
644
|
+
* Note:
|
|
645
|
+
* This operation is FREE - no credit consumption required.
|
|
642
646
|
*/
|
|
643
647
|
export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(options: Options<GetGraphMetricsData, ThrowOnError>) => import("./client").RequestResult<GetGraphMetricsResponses, GetGraphMetricsErrors, ThrowOnError, "fields">;
|
|
644
648
|
/**
|
|
@@ -664,9 +668,8 @@ export declare const getGraphMetrics: <ThrowOnError extends boolean = false>(opt
|
|
|
664
668
|
* - Usage trend analysis
|
|
665
669
|
* - Performance tuning
|
|
666
670
|
*
|
|
667
|
-
*
|
|
668
|
-
* -
|
|
669
|
-
* - Multiplied by graph tier
|
|
671
|
+
* Note:
|
|
672
|
+
* This operation is FREE - no credit consumption required.
|
|
670
673
|
*/
|
|
671
674
|
export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(options: Options<GetGraphUsageStatsData, ThrowOnError>) => import("./client").RequestResult<GetGraphUsageStatsResponses, GetGraphUsageStatsErrors, ThrowOnError, "fields">;
|
|
672
675
|
/**
|
|
@@ -682,7 +685,7 @@ export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(
|
|
|
682
685
|
* **Response Modes:**
|
|
683
686
|
* - `auto` (default): Intelligent automatic selection
|
|
684
687
|
* - `sync`: Force synchronous JSON response (best for testing)
|
|
685
|
-
* - `async`: Force queued response with polling
|
|
688
|
+
* - `async`: Force queued response with SSE monitoring endpoints (no polling needed)
|
|
686
689
|
* - `stream`: Force streaming response (SSE or NDJSON)
|
|
687
690
|
*
|
|
688
691
|
* **Client Detection:**
|
|
@@ -705,19 +708,19 @@ export declare const getGraphUsageStats: <ThrowOnError extends boolean = false>(
|
|
|
705
708
|
*
|
|
706
709
|
* **Queue Management:**
|
|
707
710
|
* - Automatic queuing under high load
|
|
708
|
-
* -
|
|
711
|
+
* - Real-time monitoring via SSE events (no polling needed)
|
|
709
712
|
* - Priority based on subscription tier
|
|
710
|
-
* - Queue position updates via SSE
|
|
713
|
+
* - Queue position and progress updates pushed via SSE
|
|
714
|
+
* - Connect to returned `/v1/operations/{id}/stream` endpoint for updates
|
|
711
715
|
*
|
|
712
716
|
* **Error Handling:**
|
|
713
717
|
* - `429 Too Many Requests`: Rate limit or connection limit exceeded
|
|
714
718
|
* - `503 Service Unavailable`: Circuit breaker open or SSE disabled
|
|
715
719
|
* - Clients should implement exponential backoff
|
|
716
720
|
*
|
|
717
|
-
* **
|
|
718
|
-
*
|
|
719
|
-
*
|
|
720
|
-
* - Queue position based on subscription tier
|
|
721
|
+
* **Note:**
|
|
722
|
+
* Query operations are FREE - no credit consumption required.
|
|
723
|
+
* Queue position is based on subscription tier for priority.
|
|
721
724
|
*/
|
|
722
725
|
export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(options: Options<ExecuteCypherQueryData, ThrowOnError>) => import("./client").RequestResult<ExecuteCypherQueryResponses, ExecuteCypherQueryErrors, ThrowOnError, "fields">;
|
|
723
726
|
/**
|
|
@@ -732,10 +735,7 @@ export declare const executeCypherQuery: <ThrowOnError extends boolean = false>(
|
|
|
732
735
|
* This is different from custom schema management - it shows what actually exists in the database,
|
|
733
736
|
* useful for understanding the current graph structure before writing queries.
|
|
734
737
|
*
|
|
735
|
-
*
|
|
736
|
-
* - Base cost: 2.0 credits
|
|
737
|
-
* - Multiplied by graph tier (standard=1x, enterprise=2x, premium=4x)
|
|
738
|
-
* - Schema information is cached for performance
|
|
738
|
+
* This operation is FREE - no credit consumption required.
|
|
739
739
|
*/
|
|
740
740
|
export declare const getGraphSchemaInfo: <ThrowOnError extends boolean = false>(options: Options<GetGraphSchemaInfoData, ThrowOnError>) => import("./client").RequestResult<GetGraphSchemaInfoResponses, GetGraphSchemaInfoErrors, ThrowOnError, "fields">;
|
|
741
741
|
/**
|
|
@@ -761,9 +761,7 @@ export declare const getGraphSchemaInfo: <ThrowOnError extends boolean = false>(
|
|
|
761
761
|
* - Performance problems
|
|
762
762
|
* - Naming conflicts
|
|
763
763
|
*
|
|
764
|
-
*
|
|
765
|
-
* - Base cost: 5.0 credits
|
|
766
|
-
* - Multiplied by graph tier
|
|
764
|
+
* This operation is FREE - no credit consumption required.
|
|
767
765
|
*/
|
|
768
766
|
export declare const validateSchema: <ThrowOnError extends boolean = false>(options: Options<ValidateSchemaData, ThrowOnError>) => import("./client").RequestResult<ValidateSchemaResponses, ValidateSchemaErrors, ThrowOnError, "fields">;
|
|
769
767
|
/**
|
|
@@ -993,6 +991,132 @@ export declare const getDatabaseHealth: <ThrowOnError extends boolean = false>(o
|
|
|
993
991
|
* This endpoint provides essential database information for capacity planning and monitoring.
|
|
994
992
|
*/
|
|
995
993
|
export declare const getDatabaseInfo: <ThrowOnError extends boolean = false>(options: Options<GetDatabaseInfoData, ThrowOnError>) => import("./client").RequestResult<GetDatabaseInfoResponses, GetDatabaseInfoErrors, ThrowOnError, "fields">;
|
|
994
|
+
/**
|
|
995
|
+
* List Subgraphs
|
|
996
|
+
* List all subgraphs for a parent graph.
|
|
997
|
+
*
|
|
998
|
+
* **Requirements:**
|
|
999
|
+
* - User must have at least read access to parent graph
|
|
1000
|
+
*
|
|
1001
|
+
* **Response includes:**
|
|
1002
|
+
* - List of all subgraphs with metadata
|
|
1003
|
+
* - Current usage vs limits
|
|
1004
|
+
* - Size and statistics per subgraph
|
|
1005
|
+
* - Creation timestamps
|
|
1006
|
+
*
|
|
1007
|
+
* **Filtering:**
|
|
1008
|
+
* Currently returns all subgraphs. Future versions will support:
|
|
1009
|
+
* - Filtering by status
|
|
1010
|
+
* - Filtering by creation date
|
|
1011
|
+
* - Pagination for large lists
|
|
1012
|
+
*/
|
|
1013
|
+
export declare const listSubgraphs: <ThrowOnError extends boolean = false>(options: Options<ListSubgraphsData, ThrowOnError>) => import("./client").RequestResult<ListSubgraphsResponses, ListSubgraphsErrors, ThrowOnError, "fields">;
|
|
1014
|
+
/**
|
|
1015
|
+
* Create New Subgraph
|
|
1016
|
+
* Create a new subgraph database under an Enterprise or Premium parent graph.
|
|
1017
|
+
*
|
|
1018
|
+
* **Requirements:**
|
|
1019
|
+
* - Parent graph must be Enterprise or Premium tier
|
|
1020
|
+
* - User must have admin access to parent graph
|
|
1021
|
+
* - Subgraph name must be unique within parent
|
|
1022
|
+
* - Subgraph name must be alphanumeric (1-20 chars)
|
|
1023
|
+
*
|
|
1024
|
+
* **Subgraph Benefits:**
|
|
1025
|
+
* - Shares parent's infrastructure (no additional cost)
|
|
1026
|
+
* - Inherits parent's credit pool
|
|
1027
|
+
* - Isolated database on same instance
|
|
1028
|
+
* - Full Kuzu database capabilities
|
|
1029
|
+
*
|
|
1030
|
+
* **Use Cases:**
|
|
1031
|
+
* - Separate environments (dev/staging/prod)
|
|
1032
|
+
* - Department-specific data isolation
|
|
1033
|
+
* - Multi-tenant applications
|
|
1034
|
+
* - Testing and experimentation
|
|
1035
|
+
*
|
|
1036
|
+
* **Schema Inheritance:**
|
|
1037
|
+
* - Subgraphs can use parent's schema or custom extensions
|
|
1038
|
+
* - Extensions are additive only
|
|
1039
|
+
* - Base schema always included
|
|
1040
|
+
*
|
|
1041
|
+
* **Limits:**
|
|
1042
|
+
* - Standard: Not supported (0 subgraphs)
|
|
1043
|
+
* - Enterprise: Configurable limit (default: 10 subgraphs)
|
|
1044
|
+
* - Premium: Unlimited subgraphs
|
|
1045
|
+
* - Limits are defined in deployment configuration
|
|
1046
|
+
*
|
|
1047
|
+
* **Response includes:**
|
|
1048
|
+
* - `graph_id`: Full subgraph identifier
|
|
1049
|
+
* - `parent_graph_id`: Parent graph ID
|
|
1050
|
+
* - `subgraph_name`: Short name within parent
|
|
1051
|
+
* - `status`: Creation status
|
|
1052
|
+
*/
|
|
1053
|
+
export declare const createSubgraph: <ThrowOnError extends boolean = false>(options: Options<CreateSubgraphData, ThrowOnError>) => import("./client").RequestResult<CreateSubgraphResponses, CreateSubgraphErrors, ThrowOnError, "fields">;
|
|
1054
|
+
/**
|
|
1055
|
+
* Delete Subgraph
|
|
1056
|
+
* Delete a subgraph database.
|
|
1057
|
+
*
|
|
1058
|
+
* **Requirements:**
|
|
1059
|
+
* - Must be a valid subgraph (not parent graph)
|
|
1060
|
+
* - User must have admin access to parent graph
|
|
1061
|
+
* - Optional backup before deletion
|
|
1062
|
+
*
|
|
1063
|
+
* **Deletion Options:**
|
|
1064
|
+
* - `force`: Delete even if contains data
|
|
1065
|
+
* - `backup_first`: Create backup before deletion
|
|
1066
|
+
*
|
|
1067
|
+
* **Warning:**
|
|
1068
|
+
* Deletion is permanent unless backup is created.
|
|
1069
|
+
* All data in the subgraph will be lost.
|
|
1070
|
+
*
|
|
1071
|
+
* **Backup Location:**
|
|
1072
|
+
* If backup requested, stored in S3 at:
|
|
1073
|
+
* `s3://robosystems-backups/{instance_id}/{database_name}_{timestamp}.backup`
|
|
1074
|
+
*/
|
|
1075
|
+
export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(options: Options<DeleteSubgraphData, ThrowOnError>) => import("./client").RequestResult<DeleteSubgraphResponses, DeleteSubgraphErrors, ThrowOnError, "fields">;
|
|
1076
|
+
/**
|
|
1077
|
+
* Get Subgraph Quota
|
|
1078
|
+
* Get subgraph quota and usage information for a parent graph.
|
|
1079
|
+
*
|
|
1080
|
+
* **Shows:**
|
|
1081
|
+
* - Current subgraph count
|
|
1082
|
+
* - Maximum allowed subgraphs per tier
|
|
1083
|
+
* - Remaining capacity
|
|
1084
|
+
* - Total size usage across all subgraphs
|
|
1085
|
+
*
|
|
1086
|
+
* **Tier Limits:**
|
|
1087
|
+
* - Standard: 0 subgraphs (not supported)
|
|
1088
|
+
* - Enterprise: Configurable limit (default: 10 subgraphs)
|
|
1089
|
+
* - Premium: Unlimited subgraphs
|
|
1090
|
+
* - Limits are defined in deployment configuration
|
|
1091
|
+
*
|
|
1092
|
+
* **Size Tracking:**
|
|
1093
|
+
* Provides aggregate size metrics when available.
|
|
1094
|
+
* Individual subgraph sizes shown in list endpoint.
|
|
1095
|
+
*/
|
|
1096
|
+
export declare const getSubgraphQuota: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphQuotaData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphQuotaResponses, GetSubgraphQuotaErrors, ThrowOnError, "fields">;
|
|
1097
|
+
/**
|
|
1098
|
+
* Get Subgraph Details
|
|
1099
|
+
* Get detailed information about a specific subgraph.
|
|
1100
|
+
*
|
|
1101
|
+
* **Requirements:**
|
|
1102
|
+
* - User must have read access to parent graph
|
|
1103
|
+
*
|
|
1104
|
+
* **Response includes:**
|
|
1105
|
+
* - Full subgraph metadata
|
|
1106
|
+
* - Database statistics (nodes, edges)
|
|
1107
|
+
* - Size information
|
|
1108
|
+
* - Schema configuration
|
|
1109
|
+
* - Creation/modification timestamps
|
|
1110
|
+
* - Last access time (when available)
|
|
1111
|
+
*
|
|
1112
|
+
* **Statistics:**
|
|
1113
|
+
* Real-time statistics queried from Kuzu:
|
|
1114
|
+
* - Node count
|
|
1115
|
+
* - Edge count
|
|
1116
|
+
* - Database size on disk
|
|
1117
|
+
* - Schema information
|
|
1118
|
+
*/
|
|
1119
|
+
export declare const getSubgraphInfo: <ThrowOnError extends boolean = false>(options: Options<GetSubgraphInfoData, ThrowOnError>) => import("./client").RequestResult<GetSubgraphInfoResponses, GetSubgraphInfoErrors, ThrowOnError, "fields">;
|
|
996
1120
|
/**
|
|
997
1121
|
* Create New Graph Database
|
|
998
1122
|
* Create a new graph database with specified schema and optionally an initial entity.
|
|
@@ -1051,7 +1175,7 @@ export declare const getAvailableExtensions: <ThrowOnError extends boolean = fal
|
|
|
1051
1175
|
* applications to display subscription options.
|
|
1052
1176
|
*
|
|
1053
1177
|
* Includes:
|
|
1054
|
-
* - Graph subscription tiers (
|
|
1178
|
+
* - Graph subscription tiers (standard, enterprise, premium)
|
|
1055
1179
|
* - Shared repository subscriptions (SEC, industry, economic data)
|
|
1056
1180
|
* - Operation costs and credit information
|
|
1057
1181
|
* - Features and capabilities for each tier
|