mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 08:12:00 +02:00

* refactor: move model definitions and database-related methods to packages/data-schemas * ci: update tests due to new DB structure fix: disable mocking `librechat-data-provider` feat: Add schema exports to data-schemas package - Introduced a new schema module that exports various schemas including action, agent, and user schemas. - Updated index.ts to include the new schema exports for better modularity and organization. ci: fix appleStrategy tests fix: Agent.spec.js ci: refactor handleTools tests to use MongoMemoryServer for in-memory database fix: getLogStores imports ci: update banViolation tests to use MongoMemoryServer and improve session mocking test: refactor samlStrategy tests to improve mock configurations and user handling ci: fix crypto mock in handleText tests for improved accuracy ci: refactor spendTokens tests to improve model imports and setup ci: refactor Message model tests to use MongoMemoryServer and improve database interactions * refactor: streamline IMessage interface and move feedback properties to types/message.ts * refactor: use exported initializeRoles from `data-schemas`, remove api workspace version (this serves as an example of future migrations that still need to happen) * refactor: update model imports to use destructuring from `~/db/models` for consistency and clarity * refactor: remove unused mongoose imports from model files for cleaner code * refactor: remove unused mongoose imports from Share, Prompt, and Transaction model files for cleaner code * refactor: remove unused import in Transaction model for cleaner code * ci: update deploy workflow to reference new Docker Dev Branch Images Build and add new workflow for building Docker images on dev branch * chore: cleanup imports
136 lines
4 KiB
JavaScript
136 lines
4 KiB
JavaScript
const { encrypt, decrypt } = require('~/server/utils/crypto');
|
|
const { PluginAuth } = require('~/db/models');
|
|
const { logger } = require('~/config');
|
|
|
|
/**
|
|
* Asynchronously retrieves and decrypts the authentication value for a user's plugin, based on a specified authentication field.
|
|
*
|
|
* @param {string} userId - The unique identifier of the user for whom the plugin authentication value is to be retrieved.
|
|
* @param {string} authField - The specific authentication field (e.g., 'API_KEY', 'URL') whose value is to be retrieved and decrypted.
|
|
* @param {boolean} throwError - Whether to throw an error if the authentication value does not exist. Defaults to `true`.
|
|
* @returns {Promise<string|null>} A promise that resolves to the decrypted authentication value if found, or `null` if no such authentication value exists for the given user and field.
|
|
*
|
|
* The function throws an error if it encounters any issue during the retrieval or decryption process, or if the authentication value does not exist.
|
|
*
|
|
* @example
|
|
* // To get the decrypted value of the 'token' field for a user with userId '12345':
|
|
* getUserPluginAuthValue('12345', 'token').then(value => {
|
|
* console.log(value);
|
|
* }).catch(err => {
|
|
* console.error(err);
|
|
* });
|
|
*
|
|
* @throws {Error} Throws an error if there's an issue during the retrieval or decryption process, or if the authentication value does not exist.
|
|
* @async
|
|
*/
|
|
const getUserPluginAuthValue = async (userId, authField, throwError = true) => {
|
|
try {
|
|
const pluginAuth = await PluginAuth.findOne({ userId, authField }).lean();
|
|
if (!pluginAuth) {
|
|
throw new Error(`No plugin auth ${authField} found for user ${userId}`);
|
|
}
|
|
|
|
const decryptedValue = await decrypt(pluginAuth.value);
|
|
return decryptedValue;
|
|
} catch (err) {
|
|
if (!throwError) {
|
|
return null;
|
|
}
|
|
logger.error('[getUserPluginAuthValue]', err);
|
|
throw err;
|
|
}
|
|
};
|
|
|
|
// const updateUserPluginAuth = async (userId, authField, pluginKey, value) => {
|
|
// try {
|
|
// const encryptedValue = encrypt(value);
|
|
|
|
// const pluginAuth = await PluginAuth.findOneAndUpdate(
|
|
// { userId, authField },
|
|
// {
|
|
// $set: {
|
|
// value: encryptedValue,
|
|
// pluginKey
|
|
// }
|
|
// },
|
|
// {
|
|
// new: true,
|
|
// upsert: true
|
|
// }
|
|
// );
|
|
|
|
// return pluginAuth;
|
|
// } catch (err) {
|
|
// logger.error('[getUserPluginAuthValue]', err);
|
|
// return err;
|
|
// }
|
|
// };
|
|
|
|
/**
|
|
*
|
|
* @async
|
|
* @param {string} userId
|
|
* @param {string} authField
|
|
* @param {string} pluginKey
|
|
* @param {string} value
|
|
* @returns {Promise<IPluginAuth>}
|
|
* @throws {Error}
|
|
*/
|
|
const updateUserPluginAuth = async (userId, authField, pluginKey, value) => {
|
|
try {
|
|
const encryptedValue = await encrypt(value);
|
|
const pluginAuth = await PluginAuth.findOne({ userId, authField }).lean();
|
|
if (pluginAuth) {
|
|
return await PluginAuth.findOneAndUpdate(
|
|
{ userId, authField },
|
|
{ $set: { value: encryptedValue } },
|
|
{ new: true, upsert: true },
|
|
).lean();
|
|
} else {
|
|
const newPluginAuth = await new PluginAuth({
|
|
userId,
|
|
authField,
|
|
value: encryptedValue,
|
|
pluginKey,
|
|
});
|
|
await newPluginAuth.save();
|
|
return newPluginAuth.toObject();
|
|
}
|
|
} catch (err) {
|
|
logger.error('[updateUserPluginAuth]', err);
|
|
return err;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @async
|
|
* @param {string} userId
|
|
* @param {string} authField
|
|
* @param {boolean} [all]
|
|
* @returns {Promise<import('mongoose').DeleteResult>}
|
|
* @throws {Error}
|
|
*/
|
|
const deleteUserPluginAuth = async (userId, authField, all = false) => {
|
|
if (all) {
|
|
try {
|
|
const response = await PluginAuth.deleteMany({ userId });
|
|
return response;
|
|
} catch (err) {
|
|
logger.error('[deleteUserPluginAuth]', err);
|
|
return err;
|
|
}
|
|
}
|
|
|
|
try {
|
|
return await PluginAuth.deleteOne({ userId, authField });
|
|
} catch (err) {
|
|
logger.error('[deleteUserPluginAuth]', err);
|
|
return err;
|
|
}
|
|
};
|
|
|
|
module.exports = {
|
|
getUserPluginAuthValue,
|
|
updateUserPluginAuth,
|
|
deleteUserPluginAuth,
|
|
};
|