librechat-data-provider 0.1.9 → 0.2.0

package/dist/index.es.js

@@ -1,6 +1,6 @@
 import axios from 'axios';
 import { z } from 'zod';
-import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
+import { useQueryClient, useMutation, useQuery } from '@tanstack/react-query';
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -245,6 +245,7 @@ var request = {
 };
 
 var user = function () { return '/api/user'; };
+var balance = function () { return '/api/balance'; };
 var userPlugins = function () { return '/api/user/plugins'; };
 var messages = function (conversationId, messageId) {
     return "/api/messages/".concat(conversationId).concat(messageId ? "/".concat(messageId) : '');
@@ -338,6 +339,9 @@ function getSearchEnabled() {
 function getUser() {
     return request.get(user());
 }
+function getUserBalance() {
+    return request.get(balance());
+}
 var searchConversations = function (q, pageNumber) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, request.get(search(q, pageNumber))];
@@ -705,6 +709,7 @@ var QueryKeys;
     QueryKeys["user"] = "user";
     QueryKeys["name"] = "name";
     QueryKeys["models"] = "models";
+    QueryKeys["balance"] = "balance";
     QueryKeys["endpoints"] = "endpoints";
     QueryKeys["presets"] = "presets";
     QueryKeys["searchResults"] = "searchResults";
@@ -713,9 +718,14 @@ var QueryKeys;
     QueryKeys["startupConfig"] = "startupConfig";
 })(QueryKeys || (QueryKeys = {}));
 var useAbortRequestWithMessage = function () {
+    var queryClient = useQueryClient();
     return useMutation(function (_a) {
         var endpoint = _a.endpoint, abortKey = _a.abortKey, message = _a.message;
         return abortRequestWithMessage(endpoint, abortKey, message);
+    }, {
+        onSuccess: function () {
+            queryClient.invalidateQueries([QueryKeys.balance]);
+        },
     });
 };
 var useGetUserQuery = function (config) {
@@ -724,6 +734,9 @@ var useGetUserQuery = function (config) {
 var useGetMessagesByConvoId = function (id, config) {
     return useQuery([QueryKeys.messages, id], function () { return getMessagesByConvoId(id); }, __assign({ refetchOnWindowFocus: false, refetchOnReconnect: false, refetchOnMount: false }, config));
 };
+var useGetUserBalance = function (config) {
+    return useQuery([QueryKeys.balance], function () { return getUserBalance(); }, __assign({ refetchOnWindowFocus: true, refetchOnReconnect: true, refetchOnMount: true }, config));
+};
 var useGetConversationByIdQuery = function (id, config) {
     return useQuery([QueryKeys.conversation, id], function () { return getConversationById(id); }, __assign({ refetchOnWindowFocus: false, refetchOnReconnect: false, refetchOnMount: false }, config));
 };
@@ -1192,4 +1205,4 @@ function createPayload(submission) {
     return { server: server, payload: payload };
 }
 
-export { EModelEndpoint, QueryKeys, SSE, abortRequestWithMessage, anthropicSchema, bingAISchema, chatGPTBrowserSchema, clearAllConversations, createPayload, createPreset, deleteConversation, deletePreset, eModelEndpointSchema, getAIEndpoints, getAvailablePlugins, getConversationById, getConversations, getLoginGoogle, getMessagesByConvoId, getModels, getPresets, getResponseSender, getSearchEnabled, getStartupConfig, getUser, googleSchema, gptPluginsSchema, login, logout, openAISchema, parseConvo, refreshToken, register, requestPasswordReset, resetPassword, revokeAllUserKeys, revokeUserKey, searchConversations, setAcceptLanguageHeader, setTokenHeader, tAgentOptionsSchema, tConversationSchema, tExampleSchema, tMessageSchema, tPluginAuthConfigSchema, tPluginSchema, tPresetSchema, updateConversation, updateMessage, updatePreset, updateTokenCount, updateUserKey, updateUserPlugins, useAbortRequestWithMessage, useAvailablePluginsQuery, useClearConversationsMutation, useCreatePresetMutation, useDeleteConversationMutation, useDeletePresetMutation, useGetConversationByIdMutation, useGetConversationByIdQuery, useGetConversationsQuery, useGetEndpointsQuery, useGetMessagesByConvoId, useGetModelsQuery, useGetPresetsQuery, useGetSearchEnabledQuery, useGetStartupConfig, useGetUserQuery, useLoginUserMutation, useLogoutUserMutation, useRefreshTokenMutation, useRegisterUserMutation, useRequestPasswordResetMutation, useResetPasswordMutation, useRevokeAllUserKeysMutation, useRevokeUserKeyMutation, useSearchQuery, useUpdateConversationMutation, useUpdateMessageMutation, useUpdatePresetMutation, useUpdateTokenCountMutation, useUpdateUserKeysMutation, useUpdateUserPluginsMutation, useUserKeyQuery, userKeyQuery };
+export { EModelEndpoint, QueryKeys, SSE, abortRequestWithMessage, anthropicSchema, bingAISchema, chatGPTBrowserSchema, clearAllConversations, createPayload, createPreset, deleteConversation, deletePreset, eModelEndpointSchema, getAIEndpoints, getAvailablePlugins, getConversationById, getConversations, getLoginGoogle, getMessagesByConvoId, getModels, getPresets, getResponseSender, getSearchEnabled, getStartupConfig, getUser, getUserBalance, googleSchema, gptPluginsSchema, login, logout, openAISchema, parseConvo, refreshToken, register, requestPasswordReset, resetPassword, revokeAllUserKeys, revokeUserKey, searchConversations, setAcceptLanguageHeader, setTokenHeader, tAgentOptionsSchema, tConversationSchema, tExampleSchema, tMessageSchema, tPluginAuthConfigSchema, tPluginSchema, tPresetSchema, updateConversation, updateMessage, updatePreset, updateTokenCount, updateUserKey, updateUserPlugins, useAbortRequestWithMessage, useAvailablePluginsQuery, useClearConversationsMutation, useCreatePresetMutation, useDeleteConversationMutation, useDeletePresetMutation, useGetConversationByIdMutation, useGetConversationByIdQuery, useGetConversationsQuery, useGetEndpointsQuery, useGetMessagesByConvoId, useGetModelsQuery, useGetPresetsQuery, useGetSearchEnabledQuery, useGetStartupConfig, useGetUserBalance, useGetUserQuery, useLoginUserMutation, useLogoutUserMutation, useRefreshTokenMutation, useRegisterUserMutation, useRequestPasswordResetMutation, useResetPasswordMutation, useRevokeAllUserKeysMutation, useRevokeUserKeyMutation, useSearchQuery, useUpdateConversationMutation, useUpdateMessageMutation, useUpdatePresetMutation, useUpdateTokenCountMutation, useUpdateUserKeysMutation, useUpdateUserPluginsMutation, useUserKeyQuery, userKeyQuery };

package/dist/index.js

@@ -247,6 +247,7 @@ var request = {
 };
 
 var user = function () { return '/api/user'; };
+var balance = function () { return '/api/balance'; };
 var userPlugins = function () { return '/api/user/plugins'; };
 var messages = function (conversationId, messageId) {
     return "/api/messages/".concat(conversationId).concat(messageId ? "/".concat(messageId) : '');
@@ -340,6 +341,9 @@ function getSearchEnabled() {
 function getUser() {
     return request.get(user());
 }
+function getUserBalance() {
+    return request.get(balance());
+}
 var searchConversations = function (q, pageNumber) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, request.get(search(q, pageNumber))];
@@ -707,6 +711,7 @@ exports.QueryKeys = void 0;
     QueryKeys["user"] = "user";
     QueryKeys["name"] = "name";
     QueryKeys["models"] = "models";
+    QueryKeys["balance"] = "balance";
     QueryKeys["endpoints"] = "endpoints";
     QueryKeys["presets"] = "presets";
     QueryKeys["searchResults"] = "searchResults";
@@ -715,9 +720,14 @@ exports.QueryKeys = void 0;
     QueryKeys["startupConfig"] = "startupConfig";
 })(exports.QueryKeys || (exports.QueryKeys = {}));
 var useAbortRequestWithMessage = function () {
+    var queryClient = reactQuery.useQueryClient();
     return reactQuery.useMutation(function (_a) {
         var endpoint = _a.endpoint, abortKey = _a.abortKey, message = _a.message;
         return abortRequestWithMessage(endpoint, abortKey, message);
+    }, {
+        onSuccess: function () {
+            queryClient.invalidateQueries([exports.QueryKeys.balance]);
+        },
     });
 };
 var useGetUserQuery = function (config) {
@@ -726,6 +736,9 @@ var useGetUserQuery = function (config) {
 var useGetMessagesByConvoId = function (id, config) {
     return reactQuery.useQuery([exports.QueryKeys.messages, id], function () { return getMessagesByConvoId(id); }, __assign({ refetchOnWindowFocus: false, refetchOnReconnect: false, refetchOnMount: false }, config));
 };
+var useGetUserBalance = function (config) {
+    return reactQuery.useQuery([exports.QueryKeys.balance], function () { return getUserBalance(); }, __assign({ refetchOnWindowFocus: true, refetchOnReconnect: true, refetchOnMount: true }, config));
+};
 var useGetConversationByIdQuery = function (id, config) {
     return reactQuery.useQuery([exports.QueryKeys.conversation, id], function () { return getConversationById(id); }, __assign({ refetchOnWindowFocus: false, refetchOnReconnect: false, refetchOnMount: false }, config));
 };
@@ -1217,6 +1230,7 @@ exports.getResponseSender = getResponseSender;
 exports.getSearchEnabled = getSearchEnabled;
 exports.getStartupConfig = getStartupConfig;
 exports.getUser = getUser;
+exports.getUserBalance = getUserBalance;
 exports.googleSchema = googleSchema;
 exports.gptPluginsSchema = gptPluginsSchema;
 exports.login = login;
@@ -1260,6 +1274,7 @@ exports.useGetModelsQuery = useGetModelsQuery;
 exports.useGetPresetsQuery = useGetPresetsQuery;
 exports.useGetSearchEnabledQuery = useGetSearchEnabledQuery;
 exports.useGetStartupConfig = useGetStartupConfig;
+exports.useGetUserBalance = useGetUserBalance;
 exports.useGetUserQuery = useGetUserQuery;
 exports.useLoginUserMutation = useLoginUserMutation;
 exports.useLogoutUserMutation = useLogoutUserMutation;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "librechat-data-provider",
-  "version": "0.1.9",
+  "version": "0.2.0",
   "description": "data services for librechat apps",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -28,7 +28,8 @@
   "dependencies": {
     "@tanstack/react-query": "^4.28.0",
     "axios": "^1.3.4",
-    "zod": "^3.22.2"
+    "openai": "^4.11.1",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.21.5",

package/src/api-endpoints.ts

@@ -1,5 +1,7 @@
 export const user = () => '/api/user';
 
+export const balance = () => '/api/balance';
+
 export const userPlugins = () => '/api/user/plugins';
 
 export const messages = (conversationId: string, messageId?: string) =>

package/src/data-service.ts

@@ -90,6 +90,10 @@ export function getUser(): Promise<t.TUser> {
   return request.get(endpoints.user());
 }
 
+export function getUserBalance(): Promise<string> {
+  return request.get(endpoints.balance());
+}
+
 export const searchConversations = async (
   q: string,
   pageNumber: string,

package/src/react-query-service.ts

@@ -18,6 +18,7 @@ export enum QueryKeys {
   user = 'user',
   name = 'name', // user key name
   models = 'models',
+  balance = 'balance',
   endpoints = 'endpoints',
   presets = 'presets',
   searchResults = 'searchResults',
@@ -31,8 +32,15 @@ export const useAbortRequestWithMessage = (): UseMutationResult<
   Error,
   { endpoint: string; abortKey: string; message: string }
 > => {
-  return useMutation(({ endpoint, abortKey, message }) =>
-    dataService.abortRequestWithMessage(endpoint, abortKey, message),
+  const queryClient = useQueryClient();
+  return useMutation(
+    ({ endpoint, abortKey, message }) =>
+      dataService.abortRequestWithMessage(endpoint, abortKey, message),
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries([QueryKeys.balance]);
+      },
+    },
   );
 };
 
@@ -64,6 +72,17 @@ export const useGetMessagesByConvoId = (
   );
 };
 
+export const useGetUserBalance = (
+  config?: UseQueryOptions<string>,
+): QueryObserverResult<string> => {
+  return useQuery<string>([QueryKeys.balance], () => dataService.getUserBalance(), {
+    refetchOnWindowFocus: true,
+    refetchOnReconnect: true,
+    refetchOnMount: true,
+    ...config,
+  });
+};
+
 export const useGetConversationByIdQuery = (
   id: string,
   config?: UseQueryOptions<s.TConversation>,

package/src/types.ts

@@ -1,5 +1,10 @@
-import type { TResPlugin, TMessage, TConversation, TEndpointOption } from './schemas';
+import OpenAI from 'openai';
 import type { UseMutationResult } from '@tanstack/react-query';
+import type { TResPlugin, TMessage, TConversation, TEndpointOption } from './schemas';
+
+export type TOpenAIMessage = OpenAI.Chat.ChatCompletionMessageParam;
+export type TOpenAIFunction = OpenAI.Chat.ChatCompletionCreateParams.Function;
+export type TOpenAIFunctionCall = OpenAI.Chat.ChatCompletionCreateParams.FunctionCallOption;
 
 export type TMutation = UseMutationResult<unknown>;
 
@@ -69,6 +74,7 @@ export type TGetConversationsResponse = {
 export type TUpdateMessageRequest = {
   conversationId: string;
   messageId: string;
+  model: string;
   text: string;
 };
 
@@ -174,6 +180,7 @@ export type TStartupConfig = {
   registrationEnabled: boolean;
   socialLoginEnabled: boolean;
   emailEnabled: boolean;
+  checkBalance: boolean;
 };
 
 export type TRefreshTokenResponse = {

package/types/api-endpoints.d.ts

@@ -1,4 +1,5 @@
 export declare const user: () => string;
+export declare const balance: () => string;
 export declare const userPlugins: () => string;
 export declare const messages: (conversationId: string, messageId?: string) => string;
 export declare const keys: () => string;

package/types/data-service.d.ts

@@ -17,6 +17,7 @@ export declare function updatePreset(payload: s.TPreset): Promise<s.TPreset[]>;
 export declare function deletePreset(arg: s.TPreset | object): Promise<s.TPreset[]>;
 export declare function getSearchEnabled(): Promise<boolean>;
 export declare function getUser(): Promise<t.TUser>;
+export declare function getUserBalance(): Promise<string>;
 export declare const searchConversations: (q: string, pageNumber: string) => Promise<t.TSearchResults>;
 export declare const getAIEndpoints: () => Promise<unknown>;
 export declare const getModels: () => Promise<unknown>;

package/types/react-query-service.d.ts

@@ -9,6 +9,7 @@ export declare enum QueryKeys {
     user = "user",
     name = "name",
     models = "models",
+    balance = "balance",
     endpoints = "endpoints",
     presets = "presets",
     searchResults = "searchResults",
@@ -23,6 +24,7 @@ export declare const useAbortRequestWithMessage: () => UseMutationResult<void, E
 }>;
 export declare const useGetUserQuery: (config?: UseQueryOptions<t.TUser>) => QueryObserverResult<t.TUser>;
 export declare const useGetMessagesByConvoId: (id: string, config?: UseQueryOptions<s.TMessage[]>) => QueryObserverResult<s.TMessage[]>;
+export declare const useGetUserBalance: (config?: UseQueryOptions<string>) => QueryObserverResult<string>;
 export declare const useGetConversationByIdQuery: (id: string, config?: UseQueryOptions<s.TConversation>) => QueryObserverResult<s.TConversation>;
 export declare const useGetConversationByIdMutation: (id: string) => UseMutationResult<s.TConversation>;
 export declare const useUpdateConversationMutation: (id: string) => UseMutationResult<t.TUpdateConversationResponse, unknown, t.TUpdateConversationRequest, unknown>;

package/types/types.d.ts

@@ -1,5 +1,9 @@
-import type { TResPlugin, TMessage, TConversation, TEndpointOption } from './schemas';
+import OpenAI from 'openai';
 import type { UseMutationResult } from '@tanstack/react-query';
+import type { TResPlugin, TMessage, TConversation, TEndpointOption } from './schemas';
+export type TOpenAIMessage = OpenAI.Chat.ChatCompletionMessageParam;
+export type TOpenAIFunction = OpenAI.Chat.ChatCompletionCreateParams.Function;
+export type TOpenAIFunctionCall = OpenAI.Chat.ChatCompletionCreateParams.FunctionCallOption;
 export type TMutation = UseMutationResult<unknown>;
 export * from './schemas';
 export type TMessages = TMessage[];
@@ -58,6 +62,7 @@ export type TGetConversationsResponse = {
 export type TUpdateMessageRequest = {
     conversationId: string;
     messageId: string;
+    model: string;
     text: string;
 };
 export type TUpdateUserKeyRequest = {
@@ -144,6 +149,7 @@ export type TStartupConfig = {
     registrationEnabled: boolean;
     socialLoginEnabled: boolean;
     emailEnabled: boolean;
+    checkBalance: boolean;
 };
 export type TRefreshTokenResponse = {
     token: string;