@acarmisc/backstage-plugin-litellm-backend 0.1.13 → 0.1.15

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/dist/plugin.js DELETED
@@ -1,23 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.litellmPlugin = void 0;
4
- const backend_plugin_api_1 = require("@backstage/backend-plugin-api");
5
- const router_1 = require("./router");
6
- exports.litellmPlugin = (0, backend_plugin_api_1.createBackendPlugin)({
7
- pluginId: 'litellm',
8
- register(reg) {
9
- reg.registerInit({
10
- deps: {
11
- httpRouter: backend_plugin_api_1.coreServices.httpRouter,
12
- config: backend_plugin_api_1.coreServices.rootConfig,
13
- logger: backend_plugin_api_1.coreServices.logger,
14
- auth: backend_plugin_api_1.coreServices.auth,
15
- discovery: backend_plugin_api_1.coreServices.discovery,
16
- },
17
- async init({ httpRouter, config, logger, auth, discovery }) {
18
- const router = await (0, router_1.createRouter)({ config, logger, auth, discovery });
19
- httpRouter.use(router);
20
- },
21
- });
22
- },
23
- });
@@ -1,72 +0,0 @@
1
- import { Config } from '@backstage/config';
2
- import { AuthService } from '@backstage/backend-plugin-api';
3
- import { CatalogClient } from '@backstage/catalog-client';
4
- import { Request } from 'express';
5
- import { LiteLLMClient } from './client';
6
- import { UserInfo, ProvisioningDefaults, RoleConfig } from './types';
7
- /**
8
- * Converts a Backstage user entity ref to a LiteLLM user_id.
9
- *
10
- * When userIdDomain is configured, the entity name is suffixed with the domain
11
- * so that LiteLLM user_ids match the organisation's email addresses:
12
- * "user:default/andrea.carmisciano" + "abstract.it"
13
- * → "andrea.carmisciano@abstract.it"
14
- *
15
- * Without a domain the bare entity name is returned unchanged, which works for
16
- * deployments where LiteLLM users were created with plain usernames.
17
- */
18
- export declare function toLiteLLMUserId(userEntityRef: string, userIdDomain?: string): string;
19
- /**
20
- * Reads the provisioning block from config, applying safe defaults for every
21
- * field so the feature works out-of-the-box without any YAML required.
22
- *
23
- * Safe defaults rationale:
24
- * maxBudget: $10 — prevents runaway spend on a forgotten test account
25
- * budgetDuration: 30d — monthly reset, aligns with typical billing cycles
26
- * models: [] — empty means all proxy models are allowed;
27
- * restrict here or at team level for tighter control
28
- * teams: [] — no automatic team assignment; add IDs to enrol users
29
- * tpmLimit: none — LiteLLM global / team limits still apply
30
- * rpmLimit: none — same
31
- * metadata: backstage source tag only
32
- */
33
- export declare function readRoleConfigs(config: Config): RoleConfig[];
34
- /**
35
- * Merges role config over defaults. Role fields override defaults only when explicitly set.
36
- */
37
- export declare function applyRoleOverrides(defaults: ProvisioningDefaults, role: RoleConfig): ProvisioningDefaults;
38
- export declare function readProvisioningDefaults(config: Config): {
39
- enabled: boolean;
40
- defaults: ProvisioningDefaults;
41
- };
42
- /**
43
- * Extracts the authenticated Backstage user identity from the request token.
44
- * Returns the userEntityRef (e.g. "user:default/john.doe") or undefined when
45
- * the request carries no user credential (service-to-service calls).
46
- */
47
- export declare function resolveUserId(req: Request, auth: AuthService): Promise<string | undefined>;
48
- /**
49
- * Creates a LiteLLM user for the given Backstage identity using the configured
50
- * defaults. Returns the UserInfo of the newly created account.
51
- */
52
- export declare function provisionUser(client: LiteLLMClient, userId: string, defaults: ProvisioningDefaults, logger: any): Promise<UserInfo | null>;
53
- export declare class ProvisioningError extends Error {
54
- status: number;
55
- body: {
56
- error: string;
57
- hint: string;
58
- provisioning: boolean;
59
- };
60
- constructor(message: string, hint: string, provisioning: boolean);
61
- }
62
- /**
63
- * Ensures the LiteLLM user exists, returning its UserInfo.
64
- * When the user is missing and provisioning is enabled, attempts to create it.
65
- * When provisioning is disabled, throws a ProvisioningError with a clear message.
66
- */
67
- export declare function getOrProvisionUser(client: LiteLLMClient, tokenEntityRef: string | undefined, userId: string | undefined, provisioningEnabled: boolean, provisioningDefaults: ProvisioningDefaults, roleConfigs: RoleConfig[], catalogClient: CatalogClient, auth: AuthService, logger: any): Promise<UserInfo>;
68
- /**
69
- * Fetches the user's Backstage group memberships and returns the first matching
70
- * role config (priority order), or undefined when no role matches.
71
- */
72
- export declare function resolveUserRole(userEntityRef: string, roleConfigs: RoleConfig[], catalogClient: CatalogClient, auth: AuthService, logger: any): Promise<RoleConfig | undefined>;
@@ -1,196 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ProvisioningError = void 0;
4
- exports.toLiteLLMUserId = toLiteLLMUserId;
5
- exports.readRoleConfigs = readRoleConfigs;
6
- exports.applyRoleOverrides = applyRoleOverrides;
7
- exports.readProvisioningDefaults = readProvisioningDefaults;
8
- exports.resolveUserId = resolveUserId;
9
- exports.provisionUser = provisionUser;
10
- exports.getOrProvisionUser = getOrProvisionUser;
11
- exports.resolveUserRole = resolveUserRole;
12
- /**
13
- * Converts a Backstage user entity ref to a LiteLLM user_id.
14
- *
15
- * When userIdDomain is configured, the entity name is suffixed with the domain
16
- * so that LiteLLM user_ids match the organisation's email addresses:
17
- * "user:default/andrea.carmisciano" + "abstract.it"
18
- * → "andrea.carmisciano@abstract.it"
19
- *
20
- * Without a domain the bare entity name is returned unchanged, which works for
21
- * deployments where LiteLLM users were created with plain usernames.
22
- */
23
- function toLiteLLMUserId(userEntityRef, userIdDomain) {
24
- const name = userEntityRef.split('/').pop() ?? userEntityRef;
25
- return userIdDomain ? `${name}@${userIdDomain}` : name;
26
- }
27
- /**
28
- * Reads the provisioning block from config, applying safe defaults for every
29
- * field so the feature works out-of-the-box without any YAML required.
30
- *
31
- * Safe defaults rationale:
32
- * maxBudget: $10 — prevents runaway spend on a forgotten test account
33
- * budgetDuration: 30d — monthly reset, aligns with typical billing cycles
34
- * models: [] — empty means all proxy models are allowed;
35
- * restrict here or at team level for tighter control
36
- * teams: [] — no automatic team assignment; add IDs to enrol users
37
- * tpmLimit: none — LiteLLM global / team limits still apply
38
- * rpmLimit: none — same
39
- * metadata: backstage source tag only
40
- */
41
- function readRoleConfigs(config) {
42
- const raw = config.getOptional('litellm.provisioning.roles');
43
- if (!raw?.length)
44
- return [];
45
- return raw.map((r) => ({
46
- group: r.group,
47
- maxBudget: r.maxBudget,
48
- budgetDuration: r.budgetDuration,
49
- models: r.models,
50
- teams: r.teams,
51
- tpmLimit: r.tpmLimit,
52
- rpmLimit: r.rpmLimit,
53
- metadata: r.metadata,
54
- }));
55
- }
56
- /**
57
- * Merges role config over defaults. Role fields override defaults only when explicitly set.
58
- */
59
- function applyRoleOverrides(defaults, role) {
60
- return {
61
- maxBudget: role.maxBudget ?? defaults.maxBudget,
62
- budgetDuration: role.budgetDuration ?? defaults.budgetDuration,
63
- models: role.models ?? defaults.models,
64
- teams: role.teams ?? defaults.teams,
65
- tpmLimit: role.tpmLimit ?? defaults.tpmLimit,
66
- rpmLimit: role.rpmLimit ?? defaults.rpmLimit,
67
- metadata: { ...defaults.metadata, ...(role.metadata ?? {}) },
68
- };
69
- }
70
- function readProvisioningDefaults(config) {
71
- const enabled = config.getOptionalBoolean('litellm.provisioning.enabled') ?? false;
72
- const defaults = {
73
- maxBudget: config.getOptionalNumber('litellm.provisioning.defaults.maxBudget') ?? 10,
74
- budgetDuration: config.getOptionalString('litellm.provisioning.defaults.budgetDuration') ?? '30d',
75
- models: config.getOptionalStringArray('litellm.provisioning.defaults.models') ?? [],
76
- teams: config.getOptionalStringArray('litellm.provisioning.defaults.teams') ?? [],
77
- tpmLimit: config.getOptionalNumber('litellm.provisioning.defaults.tpmLimit'),
78
- rpmLimit: config.getOptionalNumber('litellm.provisioning.defaults.rpmLimit'),
79
- metadata: (config.getOptional('litellm.provisioning.defaults.metadata') ?? {}),
80
- };
81
- return { enabled, defaults };
82
- }
83
- /**
84
- * Extracts the authenticated Backstage user identity from the request token.
85
- * Returns the userEntityRef (e.g. "user:default/john.doe") or undefined when
86
- * the request carries no user credential (service-to-service calls).
87
- */
88
- async function resolveUserId(req, auth) {
89
- const rawToken = req.headers.authorization?.slice(7);
90
- if (!rawToken)
91
- return undefined;
92
- try {
93
- const credentials = await auth.authenticate(rawToken);
94
- const principal = credentials.principal;
95
- if (principal?.type === 'user') {
96
- return principal.userEntityRef;
97
- }
98
- }
99
- catch {
100
- // invalid or service token — caller gets query-param fallback
101
- }
102
- return undefined;
103
- }
104
- /**
105
- * Creates a LiteLLM user for the given Backstage identity using the configured
106
- * defaults. Returns the UserInfo of the newly created account.
107
- */
108
- async function provisionUser(client, userId, defaults, logger) {
109
- const payload = {
110
- user_id: userId,
111
- max_budget: defaults.maxBudget,
112
- budget_duration: defaults.budgetDuration,
113
- models: defaults.models,
114
- teams: defaults.teams,
115
- ...(defaults.tpmLimit !== undefined && { tpm_limit: defaults.tpmLimit }),
116
- ...(defaults.rpmLimit !== undefined && { rpm_limit: defaults.rpmLimit }),
117
- metadata: {
118
- ...defaults.metadata,
119
- provisioned_by: 'backstage',
120
- provisioned_at: new Date().toISOString(),
121
- backstage_entity: userId,
122
- },
123
- };
124
- logger.info(`Provisioning new LiteLLM user for Backstage identity: ${userId}`);
125
- try {
126
- await client.createUser(payload);
127
- // Fetch the freshly-created user record to return consistent UserInfo shape
128
- return await client.getUserInfo(userId);
129
- }
130
- catch (err) {
131
- logger.error(`Failed to provision LiteLLM user ${userId}: ${err.message}`);
132
- return null;
133
- }
134
- }
135
- class ProvisioningError extends Error {
136
- constructor(message, hint, provisioning) {
137
- super(message);
138
- this.status = 404;
139
- this.body = { error: message, hint, provisioning };
140
- }
141
- }
142
- exports.ProvisioningError = ProvisioningError;
143
- /**
144
- * Ensures the LiteLLM user exists, returning its UserInfo.
145
- * When the user is missing and provisioning is enabled, attempts to create it.
146
- * When provisioning is disabled, throws a ProvisioningError with a clear message.
147
- */
148
- async function getOrProvisionUser(client, tokenEntityRef, userId, provisioningEnabled, provisioningDefaults, roleConfigs, catalogClient, auth, logger) {
149
- if (!userId) {
150
- throw new ProvisioningError('User not found in LiteLLM', 'No user identity could be resolved from the request.', provisioningEnabled);
151
- }
152
- let userInfo = await client.getUserInfo(userId);
153
- if (!userInfo) {
154
- if (provisioningEnabled) {
155
- const catalogRef = tokenEntityRef ?? userId;
156
- const matchedRole = await resolveUserRole(catalogRef, roleConfigs, catalogClient, auth, logger);
157
- const effectiveDefaults = matchedRole
158
- ? applyRoleOverrides(provisioningDefaults, matchedRole)
159
- : provisioningDefaults;
160
- if (matchedRole) {
161
- logger.info(`User ${userId} matched role group ${matchedRole.group} — using role-specific provisioning`);
162
- }
163
- userInfo = await provisionUser(client, userId, effectiveDefaults, logger);
164
- }
165
- if (!userInfo) {
166
- if (provisioningEnabled) {
167
- throw new ProvisioningError('User not found in LiteLLM', 'Provisioning attempted but failed — check LiteLLM logs', true);
168
- }
169
- throw new ProvisioningError('User not found in LiteLLM', 'Enable litellm.provisioning.enabled in app-config.yaml or create the user manually', false);
170
- }
171
- }
172
- return userInfo;
173
- }
174
- /**
175
- * Fetches the user's Backstage group memberships and returns the first matching
176
- * role config (priority order), or undefined when no role matches.
177
- */
178
- async function resolveUserRole(userEntityRef, roleConfigs, catalogClient, auth, logger) {
179
- if (!roleConfigs.length)
180
- return undefined;
181
- try {
182
- const { token } = await auth.getPluginRequestToken({
183
- onBehalfOf: await auth.getOwnServiceCredentials(),
184
- targetPluginId: 'catalog',
185
- });
186
- const entity = await catalogClient.getEntityByRef(userEntityRef, { token });
187
- const groups = (entity?.relations ?? [])
188
- .filter(r => r.type === 'memberOf')
189
- .map(r => r.targetRef);
190
- return roleConfigs.find(rc => groups.includes(rc.group));
191
- }
192
- catch (err) {
193
- logger.warn(`Could not resolve Backstage groups for ${userEntityRef}: ${err.message}`);
194
- return undefined;
195
- }
196
- }
package/dist/router.d.ts DELETED
@@ -1,12 +0,0 @@
1
- import { Router } from 'express';
2
- import { Config } from '@backstage/config';
3
- import { AuthService, DiscoveryService } from '@backstage/backend-plugin-api';
4
- import { ProvisioningError } from './provisioning';
5
- export { ProvisioningError };
6
- export interface RouterOptions {
7
- config: Config;
8
- logger: any;
9
- auth: AuthService;
10
- discovery: DiscoveryService;
11
- }
12
- export declare function createRouter(options: RouterOptions): Promise<Router>;
package/dist/router.js DELETED
@@ -1,196 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ProvisioningError = void 0;
4
- exports.createRouter = createRouter;
5
- const express_1 = require("express");
6
- const catalog_client_1 = require("@backstage/catalog-client");
7
- const client_1 = require("./client");
8
- const provisioning_1 = require("./provisioning");
9
- Object.defineProperty(exports, "ProvisioningError", { enumerable: true, get: function () { return provisioning_1.ProvisioningError; } });
10
- async function createRouter(options) {
11
- const { config, logger, auth, discovery } = options;
12
- const baseUrl = config.getString('litellm.baseUrl');
13
- const masterKey = config.getString('litellm.masterKey');
14
- const userIdDomain = config.getOptionalString('litellm.userIdDomain');
15
- const client = new client_1.LiteLLMClient({ baseUrl, masterKey });
16
- const { enabled: provisioningEnabled, defaults: provisioningDefaults } = (0, provisioning_1.readProvisioningDefaults)(config);
17
- const roleConfigs = (0, provisioning_1.readRoleConfigs)(config);
18
- const catalogClient = new catalog_client_1.CatalogClient({ discoveryApi: discovery });
19
- if (provisioningEnabled) {
20
- logger.info(`LiteLLM auto-provisioning enabled — defaults: budget=$${provisioningDefaults.maxBudget}/${provisioningDefaults.budgetDuration}, models=${provisioningDefaults.models.length ? provisioningDefaults.models.join(',') : 'all'}, teams=[${provisioningDefaults.teams.join(',')}]`);
21
- }
22
- const router = (0, express_1.Router)();
23
- router.get('/health', (_req, res) => {
24
- res.json({ status: 'ok', provisioning: provisioningEnabled });
25
- });
26
- router.get('/user/info', async (req, res) => {
27
- try {
28
- const tokenEntityRef = await (0, provisioning_1.resolveUserId)(req, auth);
29
- const userId = tokenEntityRef
30
- ? (0, provisioning_1.toLiteLLMUserId)(tokenEntityRef, userIdDomain)
31
- : req.query.user_id;
32
- const userInfo = await (0, provisioning_1.getOrProvisionUser)(client, tokenEntityRef, userId, provisioningEnabled, provisioningDefaults, roleConfigs, catalogClient, auth, logger);
33
- res.json(userInfo);
34
- }
35
- catch (error) {
36
- if (error instanceof provisioning_1.ProvisioningError) {
37
- res.status(error.status).json(error.body);
38
- return;
39
- }
40
- logger.error('Failed to fetch user info', error);
41
- res.status(500).json({ error: error.message });
42
- }
43
- });
44
- router.get('/keys', async (req, res) => {
45
- try {
46
- const tokenEntityRef = await (0, provisioning_1.resolveUserId)(req, auth);
47
- const userId = tokenEntityRef
48
- ? (0, provisioning_1.toLiteLLMUserId)(tokenEntityRef, userIdDomain)
49
- : req.query.user_id;
50
- await (0, provisioning_1.getOrProvisionUser)(client, tokenEntityRef, userId, provisioningEnabled, provisioningDefaults, roleConfigs, catalogClient, auth, logger);
51
- const keys = await client.listKeys(userId);
52
- res.json(keys);
53
- }
54
- catch (error) {
55
- if (error instanceof provisioning_1.ProvisioningError) {
56
- res.status(error.status).json(error.body);
57
- return;
58
- }
59
- logger.error('Failed to list keys', error);
60
- res.status(500).json({ error: error.message });
61
- }
62
- });
63
- router.post('/keys/generate', async (req, res) => {
64
- try {
65
- const tokenEntityRef = await (0, provisioning_1.resolveUserId)(req, auth);
66
- const resolvedUserId = tokenEntityRef ? (0, provisioning_1.toLiteLLMUserId)(tokenEntityRef, userIdDomain) : undefined;
67
- if (resolvedUserId) {
68
- await (0, provisioning_1.getOrProvisionUser)(client, tokenEntityRef, resolvedUserId, provisioningEnabled, provisioningDefaults, roleConfigs, catalogClient, auth, logger);
69
- }
70
- const request = {
71
- ...req.body,
72
- ...(resolvedUserId && { user_id: resolvedUserId }),
73
- };
74
- const result = await client.generateKey(request);
75
- res.json(result);
76
- }
77
- catch (error) {
78
- if (error instanceof provisioning_1.ProvisioningError) {
79
- res.status(error.status).json(error.body);
80
- return;
81
- }
82
- logger.error('Failed to generate key', error);
83
- res.status(500).json({ error: error.message });
84
- }
85
- });
86
- router.post('/keys/:keyId/update', async (req, res) => {
87
- try {
88
- const { keyId } = req.params;
89
- if (!keyId) {
90
- res.status(400).json({ error: 'keyId is required' });
91
- return;
92
- }
93
- const request = { ...req.body, key: keyId };
94
- const result = await client.updateKey(request);
95
- res.json(result);
96
- }
97
- catch (error) {
98
- logger.error('Failed to update key', error);
99
- res.status(500).json({ error: error.message });
100
- }
101
- });
102
- router.delete('/keys/:keyId', async (req, res) => {
103
- try {
104
- const { keyId } = req.params;
105
- if (!keyId) {
106
- res.status(400).json({ error: 'keyId is required' });
107
- return;
108
- }
109
- await client.deleteKeys({ keys: [keyId] });
110
- res.json({ success: true });
111
- }
112
- catch (error) {
113
- logger.error('Failed to delete key', error);
114
- res.status(500).json({ error: error.message });
115
- }
116
- });
117
- router.get('/models', async (_req, res) => {
118
- try {
119
- const models = await client.listModels();
120
- res.json(models);
121
- }
122
- catch (error) {
123
- logger.error('Failed to list models', error);
124
- res.status(500).json({ error: error.message });
125
- }
126
- });
127
- router.get('/teams', async (req, res) => {
128
- try {
129
- const tokenEntityRef = await (0, provisioning_1.resolveUserId)(req, auth);
130
- const userId = tokenEntityRef
131
- ? (0, provisioning_1.toLiteLLMUserId)(tokenEntityRef, userIdDomain)
132
- : req.query.user_id;
133
- const userInfo = await (0, provisioning_1.getOrProvisionUser)(client, tokenEntityRef, userId, provisioningEnabled, provisioningDefaults, roleConfigs, catalogClient, auth, logger);
134
- if (!userInfo?.teams?.length) {
135
- res.json([]);
136
- return;
137
- }
138
- const teams = await Promise.all(userInfo.teams.map(teamId => client.getTeamInfo(teamId).catch(err => {
139
- logger.warn(`Failed to fetch team ${teamId}: ${err.message}`);
140
- return null;
141
- })));
142
- res.json(teams.filter(Boolean));
143
- }
144
- catch (error) {
145
- if (error instanceof provisioning_1.ProvisioningError) {
146
- res.status(error.status).json(error.body);
147
- return;
148
- }
149
- logger.error('Failed to fetch teams', error);
150
- res.status(500).json({ error: error.message });
151
- }
152
- });
153
- router.get('/teams/:teamId/usage', async (req, res) => {
154
- try {
155
- const { teamId } = req.params;
156
- const { start_date, end_date } = req.query;
157
- if (!start_date || !end_date) {
158
- res.status(400).json({ error: 'start_date and end_date are required' });
159
- return;
160
- }
161
- const usage = await client.getTeamUsage(teamId, start_date, end_date);
162
- res.json(usage);
163
- }
164
- catch (error) {
165
- logger.error('Failed to fetch team usage', error);
166
- res.status(500).json({ error: error.message });
167
- }
168
- });
169
- router.get('/usage', async (req, res) => {
170
- try {
171
- const { start_date, end_date, group_by } = req.query;
172
- if (!start_date || !end_date) {
173
- res.status(400).json({ error: 'start_date and end_date are required' });
174
- return;
175
- }
176
- const tokenEntityRef = await (0, provisioning_1.resolveUserId)(req, auth);
177
- const userId = tokenEntityRef
178
- ? (0, provisioning_1.toLiteLLMUserId)(tokenEntityRef, userIdDomain)
179
- : req.query.user_id;
180
- if (userId) {
181
- await (0, provisioning_1.getOrProvisionUser)(client, tokenEntityRef, userId, provisioningEnabled, provisioningDefaults, roleConfigs, catalogClient, auth, logger);
182
- }
183
- const usage = await client.getUsage(start_date, end_date, userId, group_by);
184
- res.json(usage);
185
- }
186
- catch (error) {
187
- if (error instanceof provisioning_1.ProvisioningError) {
188
- res.status(error.status).json(error.body);
189
- return;
190
- }
191
- logger.error('Failed to fetch usage', error);
192
- res.status(500).json({ error: error.message });
193
- }
194
- });
195
- return router;
196
- }
package/dist/types.d.ts DELETED
@@ -1,175 +0,0 @@
1
- export interface UserInfo {
2
- user_id: string;
3
- user_email?: string;
4
- email?: string;
5
- teams?: string[];
6
- models?: string[];
7
- max_budget?: number;
8
- spend?: number;
9
- current_spend?: number;
10
- soft_limit?: number;
11
- hard_limit?: number;
12
- }
13
- export interface TeamMember {
14
- user_id: string;
15
- role: 'admin' | 'user';
16
- }
17
- export interface TeamInfo {
18
- team_id: string;
19
- team_alias?: string;
20
- max_budget?: number;
21
- spend: number;
22
- members_with_roles?: TeamMember[];
23
- models?: string[];
24
- tpm_limit?: number;
25
- rpm_limit?: number;
26
- }
27
- export interface VirtualKey {
28
- key: string;
29
- key_alias?: string;
30
- created_at: string;
31
- expires_at?: string;
32
- spend: number;
33
- max_budget?: number;
34
- tpm_limit?: number;
35
- rpm_limit?: number;
36
- models?: string[];
37
- user_id?: string;
38
- }
39
- export interface ModelInfo {
40
- model_name: string;
41
- mode: string;
42
- supports_function_calling?: boolean;
43
- supports_vision?: boolean;
44
- input_cost_per_token?: number;
45
- output_cost_per_token?: number;
46
- }
47
- export interface UsageModelBreakdown {
48
- total_spend: number;
49
- total_tokens: number;
50
- prompt_tokens: number;
51
- completion_tokens: number;
52
- api_requests: number;
53
- successful_requests: number;
54
- failed_requests: number;
55
- }
56
- export interface UsageKeyBreakdown {
57
- key_alias?: string;
58
- team_id?: string | null;
59
- models: string[];
60
- total_spend: number;
61
- total_tokens: number;
62
- prompt_tokens: number;
63
- completion_tokens: number;
64
- api_requests: number;
65
- successful_requests: number;
66
- failed_requests: number;
67
- }
68
- export interface UsageDailyPoint {
69
- date: string;
70
- spend: number;
71
- total_tokens: number;
72
- prompt_tokens: number;
73
- completion_tokens: number;
74
- api_requests: number;
75
- successful_requests: number;
76
- failed_requests: number;
77
- }
78
- export interface UsageDailyModelPoint {
79
- date: string;
80
- model: string;
81
- spend: number;
82
- prompt_tokens: number;
83
- completion_tokens: number;
84
- total_tokens: number;
85
- api_requests: number;
86
- successful_requests: number;
87
- failed_requests: number;
88
- }
89
- export interface UsageMetrics {
90
- total_spend: number;
91
- total_tokens: number;
92
- prompt_tokens: number;
93
- completion_tokens: number;
94
- api_requests: number;
95
- successful_requests: number;
96
- failed_requests: number;
97
- usage_by_model: Record<string, UsageModelBreakdown>;
98
- usage_by_key: Record<string, UsageKeyBreakdown>;
99
- daily_usage: UsageDailyPoint[];
100
- daily_by_model: UsageDailyModelPoint[];
101
- }
102
- export interface GenerateKeyRequest {
103
- alias?: string;
104
- models?: string[];
105
- duration?: string;
106
- max_budget?: number;
107
- tpm_limit?: number;
108
- rpm_limit?: number;
109
- user_id?: string;
110
- team_id?: string;
111
- key_type?: string;
112
- }
113
- export interface UpdateKeyRequest {
114
- key: string;
115
- key_alias?: string;
116
- models?: string[];
117
- max_budget?: number;
118
- tpm_limit?: number;
119
- rpm_limit?: number;
120
- team_id?: string;
121
- duration?: string;
122
- }
123
- export interface GenerateKeyResponse {
124
- key: string;
125
- key_alias?: string;
126
- expires_at?: string;
127
- max_budget?: number;
128
- tpm_limit?: number;
129
- rpm_limit?: number;
130
- models?: string[];
131
- }
132
- export interface DeleteKeyRequest {
133
- keys: string[];
134
- }
135
- export interface LiteLLMConfig {
136
- baseUrl: string;
137
- masterKey: string;
138
- }
139
- export interface ProvisioningDefaults {
140
- maxBudget: number;
141
- budgetDuration: string;
142
- models: string[];
143
- teams: string[];
144
- tpmLimit?: number;
145
- rpmLimit?: number;
146
- metadata: Record<string, string>;
147
- }
148
- export interface RoleConfig {
149
- group: string;
150
- maxBudget?: number;
151
- budgetDuration?: string;
152
- models?: string[];
153
- teams?: string[];
154
- tpmLimit?: number;
155
- rpmLimit?: number;
156
- metadata?: Record<string, string>;
157
- }
158
- export interface CreateUserRequest {
159
- user_id: string;
160
- user_email?: string;
161
- max_budget?: number;
162
- budget_duration?: string;
163
- models?: string[];
164
- teams?: string[];
165
- tpm_limit?: number;
166
- rpm_limit?: number;
167
- metadata?: Record<string, string>;
168
- }
169
- export interface CreateUserResponse {
170
- user_id: string;
171
- user_email?: string;
172
- max_budget?: number;
173
- models?: string[];
174
- teams?: string[];
175
- }
package/dist/types.js DELETED
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });