librechat-data-provider 0.8.402 → 0.8.404

package/dist/types/types.d.ts

@@ -0,0 +1,503 @@
+import type { InfiniteData } from '@tanstack/react-query';
+import type { TConversationTag, EModelEndpoint, TConversation, TSharedLink, TAttachment, TMessage, TBanner } from './schemas';
+import type { SettingDefinition } from './generate';
+import type { TMinimalFeedback } from './feedback';
+import type { ContentTypes } from './types/runs';
+import type { Agent } from './types/assistants';
+export * from './schemas';
+export type TMessages = TMessage[];
+export type TEndpointOption = Pick<TConversation, 'endpoint' | 'endpointType' | 'model' | 'modelLabel' | 'chatGptLabel' | 'promptPrefix' | 'temperature' | 'topP' | 'topK' | 'top_p' | 'frequency_penalty' | 'presence_penalty' | 'maxOutputTokens' | 'maxContextTokens' | 'max_tokens' | 'maxTokens' | 'resendFiles' | 'imageDetail' | 'reasoning_effort' | 'verbosity' | 'instructions' | 'additional_instructions' | 'append_current_datetime' | 'tools' | 'stop' | 'region' | 'additionalModelRequestFields' | 'promptCache' | 'thinking' | 'thinkingBudget' | 'thinkingLevel' | 'effort' | 'assistant_id' | 'agent_id' | 'iconURL' | 'greeting' | 'spec' | 'artifacts' | 'file_ids' | 'system' | 'examples' | 'context'> & {
+    modelDisplayLabel?: string;
+    key?: string | null;
+    /** @deprecated Assistants API */
+    thread_id?: string;
+    overrideConvoId?: string;
+    overrideUserMessageId?: string;
+    modelOptions?: Record<string, unknown>;
+    model_parameters?: Record<string, unknown>;
+    modelsConfig?: TModelsConfig;
+    attachments?: TAttachment[];
+    artifactsPrompt?: string;
+    agent?: Promise<Agent>;
+    clientOptions?: Record<string, unknown>;
+};
+export type TEphemeralAgent = {
+    mcp?: string[];
+    web_search?: boolean;
+    file_search?: boolean;
+    execute_code?: boolean;
+    artifacts?: string;
+};
+export type TPayload = Partial<TMessage> & Partial<TEndpointOption> & {
+    isContinued: boolean;
+    isRegenerate?: boolean;
+    conversationId: string | null;
+    messages?: TMessages;
+    isTemporary: boolean;
+    ephemeralAgent?: TEphemeralAgent | null;
+    editedContent?: TEditedContent | null;
+    /** Added conversation for multi-convo feature */
+    addedConvo?: TConversation;
+};
+export type TEditedContent = {
+    index: number;
+    type: ContentTypes.THINK;
+    [ContentTypes.THINK]: string;
+} | {
+    index: number;
+    type: ContentTypes.TEXT;
+    [ContentTypes.TEXT]: string;
+};
+export type TSubmission = {
+    userMessage: TMessage;
+    isEdited?: boolean;
+    isContinued?: boolean;
+    isTemporary: boolean;
+    messages: TMessage[];
+    isRegenerate?: boolean;
+    initialResponse?: TMessage;
+    conversation: Partial<TConversation>;
+    endpointOption: TEndpointOption;
+    clientTimestamp?: string;
+    ephemeralAgent?: TEphemeralAgent | null;
+    editedContent?: TEditedContent | null;
+    /** Added conversation for multi-convo feature */
+    addedConvo?: TConversation;
+};
+export type EventSubmission = Omit<TSubmission, 'initialResponse'> & {
+    initialResponse: TMessage;
+};
+export type TPluginAction = {
+    pluginKey: string;
+    action: 'install' | 'uninstall';
+    auth?: Partial<Record<string, string>> | null;
+    isEntityTool?: boolean;
+};
+export type GroupedConversations = [key: string, TConversation[]][];
+export type TUpdateUserPlugins = {
+    isEntityTool?: boolean;
+    pluginKey: string;
+    action: string;
+    auth?: Partial<Record<string, string | null>> | null;
+};
+export type TCategory = {
+    id?: string;
+    value: string;
+    label: string;
+    description?: string;
+    custom?: boolean;
+};
+export type TMarketplaceCategory = TCategory & {
+    count: number;
+};
+export type TError = {
+    message: string;
+    code?: number | string;
+    response?: {
+        data?: {
+            message?: string;
+        };
+        status?: number;
+    };
+};
+export type TBackupCode = {
+    codeHash: string;
+    used: boolean;
+    usedAt: Date | null;
+};
+export type TUser = {
+    id: string;
+    username: string;
+    email: string;
+    name: string;
+    avatar: string;
+    role: string;
+    provider: string;
+    plugins?: string[];
+    twoFactorEnabled?: boolean;
+    backupCodes?: TBackupCode[];
+    personalization?: {
+        memories?: boolean;
+    };
+    createdAt: string;
+    updatedAt: string;
+};
+export type TGetConversationsResponse = {
+    conversations: TConversation[];
+    pageNumber: string;
+    pageSize: string | number;
+    pages: string | number;
+};
+export type TUpdateMessageRequest = {
+    conversationId: string;
+    messageId: string;
+    model: string;
+    text: string;
+};
+export type TUpdateMessageContent = {
+    conversationId: string;
+    messageId: string;
+    index: number;
+    text: string;
+};
+export type TUpdateUserKeyRequest = {
+    name: string;
+    value: string;
+    expiresAt: string;
+};
+export type TAgentApiKeyCreateRequest = {
+    name: string;
+    expiresAt?: string | null;
+};
+export type TAgentApiKeyCreateResponse = {
+    id: string;
+    name: string;
+    key: string;
+    keyPrefix: string;
+    createdAt: string;
+    expiresAt?: string;
+};
+export type TAgentApiKeyListItem = {
+    id: string;
+    name: string;
+    keyPrefix: string;
+    lastUsedAt?: string;
+    expiresAt?: string;
+    createdAt: string;
+};
+export type TAgentApiKeyListResponse = {
+    keys: TAgentApiKeyListItem[];
+};
+export type TUpdateConversationRequest = {
+    conversationId: string;
+    title: string;
+};
+export type TUpdateConversationResponse = TConversation;
+export type TDeleteConversationRequest = {
+    conversationId?: string;
+    thread_id?: string;
+    endpoint?: string;
+    source?: string;
+};
+export type TDeleteConversationResponse = {
+    acknowledged: boolean;
+    deletedCount: number;
+    messages: {
+        acknowledged: boolean;
+        deletedCount: number;
+    };
+};
+export type TArchiveConversationRequest = {
+    conversationId: string;
+    isArchived: boolean;
+};
+export type TArchiveConversationResponse = TConversation;
+export type TSharedMessagesResponse = Omit<TSharedLink, 'messages'> & {
+    messages: TMessage[];
+};
+export type TCreateShareLinkRequest = Pick<TConversation, 'conversationId'>;
+export type TUpdateShareLinkRequest = Pick<TSharedLink, 'shareId'>;
+export type TSharedLinkResponse = Pick<TSharedLink, 'shareId'> & Pick<TConversation, 'conversationId'>;
+export type TSharedLinkGetResponse = TSharedLinkResponse & {
+    success: boolean;
+};
+export type TConversationTagsResponse = TConversationTag[];
+export type TConversationTagRequest = Partial<Omit<TConversationTag, 'createdAt' | 'updatedAt' | 'count' | 'user'>> & {
+    conversationId?: string;
+    addToConversation?: boolean;
+};
+export type TConversationTagResponse = TConversationTag;
+export type TTagConversationRequest = {
+    tags: string[];
+    tag: string;
+};
+export type TTagConversationResponse = string[];
+export type TDuplicateConvoRequest = {
+    conversationId?: string;
+};
+export type TDuplicateConvoResponse = {
+    conversation: TConversation;
+    messages: TMessage[];
+};
+export type TForkConvoRequest = {
+    messageId: string;
+    conversationId: string;
+    option?: string;
+    splitAtTarget?: boolean;
+    latestMessageId?: string;
+};
+export type TForkConvoResponse = {
+    conversation: TConversation;
+    messages: TMessage[];
+};
+export type TSearchResults = {
+    conversations: TConversation[];
+    messages: TMessage[];
+    pageNumber: string;
+    pageSize: string | number;
+    pages: string | number;
+    filter: object;
+};
+export type TConfig = {
+    order: number;
+    type?: EModelEndpoint;
+    azure?: boolean;
+    availableTools?: [];
+    availableRegions?: string[];
+    plugins?: Record<string, string>;
+    name?: string;
+    iconURL?: string;
+    version?: string;
+    modelDisplayLabel?: string;
+    userProvide?: boolean | null;
+    userProvideURL?: boolean | null;
+    disableBuilder?: boolean;
+    retrievalModels?: string[];
+    capabilities?: string[];
+    customParams?: {
+        defaultParamsEndpoint?: string;
+        paramDefinitions?: Partial<SettingDefinition>[];
+    };
+};
+export type TEndpointsConfig = Record<EModelEndpoint | string, TConfig | null | undefined> | undefined;
+export type TModelsConfig = Record<string, string[]>;
+export type TUpdateTokenCountResponse = {
+    count: number;
+};
+export type TMessageTreeNode = object;
+export type TSearchMessage = object;
+export type TSearchMessageTreeNode = object;
+export type TRegisterUserResponse = {
+    message: string;
+};
+export type TRegisterUser = {
+    name: string;
+    email: string;
+    username: string;
+    password: string;
+    confirm_password?: string;
+    token?: string;
+};
+export type TLoginUser = {
+    email: string;
+    password: string;
+    token?: string;
+    backupCode?: string;
+};
+export type TLoginResponse = {
+    token?: string;
+    user?: TUser;
+    twoFAPending?: boolean;
+    tempToken?: string;
+};
+/** Shared payload for any operation that requires OTP or backup-code verification. */
+export type TOTPVerificationPayload = {
+    token?: string;
+    backupCode?: string;
+};
+export type TEnable2FARequest = TOTPVerificationPayload;
+export type TEnable2FAResponse = {
+    otpauthUrl: string;
+    backupCodes: string[];
+    message?: string;
+};
+export type TVerify2FARequest = TOTPVerificationPayload;
+export type TVerify2FAResponse = {
+    message: string;
+};
+/** For verifying 2FA during login with a temporary token. */
+export type TVerify2FATempRequest = TOTPVerificationPayload & {
+    tempToken: string;
+};
+export type TVerify2FATempResponse = {
+    token?: string;
+    user?: TUser;
+    message?: string;
+};
+export type TDisable2FARequest = TOTPVerificationPayload;
+export type TDisable2FAResponse = {
+    message: string;
+};
+export type TRegenerateBackupCodesRequest = TOTPVerificationPayload;
+export type TRegenerateBackupCodesResponse = {
+    message?: string;
+    backupCodes: string[];
+    backupCodesHash: TBackupCode[];
+};
+export type TDeleteUserRequest = TOTPVerificationPayload;
+export type TRequestPasswordReset = {
+    email: string;
+};
+export type TResetPassword = {
+    userId: string;
+    token: string;
+    password: string;
+    confirm_password?: string;
+};
+export type VerifyEmailResponse = {
+    message: string;
+};
+export type TVerifyEmail = {
+    email: string;
+    token: string;
+};
+export type TResendVerificationEmail = Omit<TVerifyEmail, 'token'>;
+export type TRefreshTokenResponse = {
+    token: string;
+    user: TUser;
+};
+export type TCheckUserKeyResponse = {
+    expiresAt: string;
+};
+export type TRequestPasswordResetResponse = {
+    link?: string;
+    message?: string;
+};
+/**
+ * Represents the response from the import endpoint.
+ */
+export type TImportResponse = {
+    /**
+     * The message associated with the response.
+     */
+    message: string;
+};
+/** Prompts */
+export type TPrompt = {
+    groupId: string;
+    author: string;
+    prompt: string;
+    type: 'text' | 'chat';
+    createdAt: string;
+    updatedAt: string;
+    _id?: string;
+};
+export type TPromptGroup = {
+    name: string;
+    numberOfGenerations?: number;
+    command?: string;
+    oneliner?: string;
+    category?: string;
+    productionId?: string | null;
+    productionPrompt?: Pick<TPrompt, 'prompt'> | null;
+    author: string;
+    authorName: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    _id?: string;
+};
+export type TCreatePrompt = {
+    prompt: Pick<TPrompt, 'prompt' | 'type'> & {
+        groupId?: string;
+    };
+    group?: {
+        name: string;
+        category?: string;
+        oneliner?: string;
+        command?: string;
+    };
+};
+export type TCreatePromptRecord = TCreatePrompt & Pick<TPromptGroup, 'author' | 'authorName'>;
+export type TPromptsWithFilterRequest = {
+    groupId: string;
+    tags?: string[];
+    projectId?: string;
+    version?: number;
+};
+export type TPromptGroupsWithFilterRequest = {
+    category: string;
+    pageNumber?: string;
+    pageSize?: string | number;
+    limit?: string | number;
+    cursor?: string;
+    before?: string | null;
+    after?: string | null;
+    order?: 'asc' | 'desc';
+    name?: string;
+    author?: string;
+};
+export type PromptGroupListResponse = {
+    promptGroups: TPromptGroup[];
+    pageNumber: string;
+    pageSize: string | number;
+    pages: string | number;
+    has_more: boolean;
+    after: string | null;
+};
+export type PromptGroupListData = InfiniteData<PromptGroupListResponse>;
+export type TCreatePromptResponse = {
+    prompt: TPrompt;
+    group?: TPromptGroup;
+};
+export type TUpdatePromptGroupPayload = Partial<TPromptGroup>;
+export type TUpdatePromptGroupVariables = {
+    id: string;
+    payload: TUpdatePromptGroupPayload;
+};
+export type TUpdatePromptGroupResponse = TPromptGroup;
+export type TDeletePromptResponse = {
+    prompt: string;
+    promptGroup?: {
+        message: string;
+        id: string;
+    };
+};
+export type TDeletePromptVariables = {
+    _id: string;
+    groupId: string;
+};
+export type TMakePromptProductionResponse = {
+    message: string;
+};
+export type TMakePromptProductionRequest = {
+    id: string;
+    groupId: string;
+    productionPrompt: Pick<TPrompt, 'prompt'>;
+};
+export type TUpdatePromptLabelsRequest = {
+    id: string;
+    payload: {
+        labels: string[];
+    };
+};
+export type TUpdatePromptLabelsResponse = {
+    message: string;
+};
+export type TDeletePromptGroupResponse = TUpdatePromptLabelsResponse;
+export type TDeletePromptGroupRequest = {
+    id: string;
+};
+export type TGetCategoriesResponse = TCategory[];
+export type TGetRandomPromptsResponse = {
+    prompts: TPromptGroup[];
+};
+export type TGetRandomPromptsRequest = {
+    limit: number;
+    skip: number;
+};
+export type TCustomConfigSpeechResponse = {
+    [key: string]: string;
+};
+export type TUserTermsResponse = {
+    termsAccepted: boolean;
+};
+export type TAcceptTermsResponse = {
+    success: boolean;
+};
+export type TBannerResponse = TBanner | null;
+export type TUpdateFeedbackRequest = {
+    feedback?: TMinimalFeedback;
+};
+export type TUpdateFeedbackResponse = {
+    messageId: string;
+    conversationId: string;
+    feedback?: TMinimalFeedback;
+};
+export type TBalanceResponse = {
+    tokenCredits: number;
+    autoRefillEnabled: boolean;
+    refillIntervalValue?: number;
+    refillIntervalUnit?: 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months';
+    lastRefill?: Date;
+    refillAmount?: number;
+};

package/dist/types/utils.d.ts

@@ -0,0 +1,12 @@
+export declare const envVarRegex: RegExp;
+/** Returns true when `varName` refers to an infrastructure secret that must not leak. */
+export declare function isSensitiveEnvVar(varName: string): boolean;
+/** Extracts the environment variable name from a template literal string */
+export declare function extractVariableName(value: string): string | null;
+/** Extracts the value of an environment variable from a string. */
+export declare function extractEnvVariable(value: string): string;
+/**
+ * Normalize the endpoint name to system-expected value.
+ * @param name
+ */
+export declare function normalizeEndpointName(name?: string): string;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "librechat-data-provider",
-  "version": "0.8.402",
+  "version": "0.8.404",
   "description": "data services for librechat apps",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
   "types": "./dist/types/index.d.ts",
+  "sideEffects": false,
   "exports": {
     ".": {
       "import": "./dist/index.es.js",
@@ -17,6 +18,9 @@
       "types": "./dist/types/react-query/index.d.ts"
     }
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "clean": "rimraf dist",
     "build": "npm run clean && rollup -c --silent --bundleConfigAsCjs",

package/babel.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
-  plugins: ['babel-plugin-replace-ts-export-assignment'],
-};

package/check_updates.sh

@@ -1,52 +0,0 @@
-#!/bin/bash
-# SCRIPT USED TO DETERMINE WHICH PACKAGE HAD CHANGES
-
-# Set the directory containing the package.json file
-dir=${1:-.}
-
-# Today's date and the date 3 days ago in seconds since the Unix epoch
-today=$(date +%s)
-three_days_ago=$(date -d "3 days ago" +%s)
-
-# Read dependencies and devDependencies from package.json
-dependencies=$(jq -r '.dependencies,.devDependencies|keys[]' "$dir/package.json")
-packages=($dependencies) # Convert JSON array to bash array
-
-# Array to hold update messages
-declare -a updates
-
-# Loop over each package
-for pkg in "${packages[@]}"
-do
-    echo "Checking $pkg..."
-    # Retrieve the version time information as JSON
-    times=$(npm view "$pkg" time --json)
-
-    # Loop through dates from the JSON object and check if any are within the last 3 days
-    echo $times | jq -r '. | to_entries[] | select(.key as $k | $k|test("^[0-9]")) | [.key, .value] | @csv' | while IFS="," read -r version date
-    do
-        # Format the date to remove quotes and trim it
-        date=$(echo $date | tr -d '"' | xargs)
-        # Convert date to seconds since the Unix epoch
-        version_date=$(date -d "$date" +%s)
-
-        # Check if this date is within the last three days
-        if (( version_date > three_days_ago && version_date <= today ))
-        then
-            # Convert UTC to Eastern Time (ET), ensuring compatibility
-            et_date=$(date -u -d "$date" +"%Y-%m-%d %H:%M:%S UTC")
-            et_date=$(date -d "$et_date -4 hours" +"%Y-%m-%d %H:%M:%S ET")
-            update_message="Version $version of $pkg was released on $et_date"
-            echo "$update_message"
-            updates+=("$update_message")
-        fi
-    done
-done
-
-# Display all collected updates
-if [ ${#updates[@]} -eq 0 ]; then
-    echo "No recent updates found within the last three days."
-else
-    echo "Recent updates within the last three days:"
-    printf "%s\n" "${updates[@]}"
-fi

package/jest.config.js

@@ -1,19 +0,0 @@
-module.exports = {
-  collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}', '!<rootDir>/node_modules/'],
-  coveragePathIgnorePatterns: ['/node_modules/', '/dist/'],
-  coverageReporters: ['text', 'cobertura'],
-  testResultsProcessor: 'jest-junit',
-  moduleNameMapper: {
-    '^@src/(.*)$': '<rootDir>/src/$1',
-  },
-  // coverageThreshold: {
-  //   global: {
-  //     statements: 58,
-  //     branches: 49,
-  //     functions: 50,
-  //     lines: 57,
-  //   },
-  // },
-  maxWorkers: '50%',
-  restoreMocks: true,
-};