File size: 9,340 Bytes
f8b5d42 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
const prisma = require("../utils/prisma");
const moment = require("moment");
/**
* @typedef {Object} SystemPromptVariable
* @property {number} id
* @property {string} key
* @property {string|function} value
* @property {string} description
* @property {'system'|'user'|'static'} type
* @property {number} userId
* @property {boolean} multiUserRequired
*/
const SystemPromptVariables = {
VALID_TYPES: ["user", "system", "static"],
DEFAULT_VARIABLES: [
{
key: "time",
value: () => moment().format("LTS"),
description: "Current time",
type: "system",
multiUserRequired: false,
},
{
key: "date",
value: () => moment().format("LL"),
description: "Current date",
type: "system",
multiUserRequired: false,
},
{
key: "datetime",
value: () => moment().format("LLLL"),
description: "Current date and time",
type: "system",
multiUserRequired: false,
},
{
key: "user.name",
value: async (userId = null) => {
if (!userId) return "[User name]";
try {
const user = await prisma.users.findUnique({
where: { id: Number(userId) },
select: { username: true },
});
return user?.username || "[User name is empty or unknown]";
} catch (error) {
console.error("Error fetching user name:", error);
return "[User name is empty or unknown]";
}
},
description: "Current user's username",
type: "user",
multiUserRequired: true,
},
{
key: "user.bio",
value: async (userId = null) => {
if (!userId) return "[User bio]";
try {
const user = await prisma.users.findUnique({
where: { id: Number(userId) },
select: { bio: true },
});
return user?.bio || "[User bio is empty]";
} catch (error) {
console.error("Error fetching user bio:", error);
return "[User bio is empty]";
}
},
description: "Current user's bio field from their profile",
type: "user",
multiUserRequired: true,
},
],
/**
* Gets a system prompt variable by its key
* @param {string} key
* @returns {Promise<SystemPromptVariable>}
*/
get: async function (key = null) {
if (!key) return null;
const variable = await prisma.system_prompt_variables.findUnique({
where: { key: String(key) },
});
return variable;
},
/**
* Retrieves all system prompt variables with dynamic variables as well
* as user defined variables
* @param {number|null} userId - the current user ID (determines if in multi-user mode)
* @returns {Promise<SystemPromptVariable[]>}
*/
getAll: async function (userId = null) {
// All user-defined system variables are available to everyone globally since only admins can create them.
const userDefinedSystemVariables =
await prisma.system_prompt_variables.findMany();
const formattedDbVars = userDefinedSystemVariables.map((v) => ({
id: v.id,
key: v.key,
value: v.value,
description: v.description,
type: v.type,
userId: v.userId,
}));
// If userId is not provided, filter the default variables to only include non-multiUserRequired variables
// since we wont be able to dynamically inject user-related content.
const defaultSystemVariables = !userId
? this.DEFAULT_VARIABLES.filter((v) => !v.multiUserRequired)
: this.DEFAULT_VARIABLES;
return [...defaultSystemVariables, ...formattedDbVars];
},
/**
* Creates a new system prompt variable
* @param {{ key: string, value: string, description: string, type: string, userId: number }} data
* @returns {Promise<SystemPromptVariable>}
*/
create: async function ({
key,
value,
description = null,
type = "static",
userId = null,
}) {
await this._checkVariableKey(key, true);
return await prisma.system_prompt_variables.create({
data: {
key: String(key),
value: String(value),
description: description ? String(description) : null,
type: type ? String(type) : "static",
userId: userId ? Number(userId) : null,
},
});
},
/**
* Updates a system prompt variable by its unique database ID
* @param {number} id
* @param {{ key: string, value: string, description: string }} data
* @returns {Promise<SystemPromptVariable>}
*/
update: async function (id, { key, value, description = null }) {
if (!id || !key || !value) return null;
const existingRecord = await prisma.system_prompt_variables.findFirst({
where: { id: Number(id) },
});
if (!existingRecord) throw new Error("System prompt variable not found");
await this._checkVariableKey(key, false);
return await prisma.system_prompt_variables.update({
where: { id: existingRecord.id },
data: {
key: String(key),
value: String(value),
description: description ? String(description) : null,
},
});
},
/**
* Deletes a system prompt variable by its unique database ID
* @param {number} id
* @returns {Promise<boolean>}
*/
delete: async function (id = null) {
try {
await prisma.system_prompt_variables.delete({
where: { id: Number(id) },
});
return true;
} catch (error) {
console.error("Error deleting variable:", error);
return false;
}
},
/**
* Injects variables into a string based on the user ID (if provided) and the variables available
* @param {string} str - the input string to expand variables into
* @param {number|null} userId - the user ID to use for dynamic variables
* @returns {Promise<string>}
*/
expandSystemPromptVariables: async function (str, userId = null) {
if (!str) return str;
try {
const allVariables = await this.getAll(userId);
let result = str;
// Find all variable patterns in the string
const matches = str.match(/\{([^}]+)\}/g) || [];
// Process each match
for (const match of matches) {
const key = match.substring(1, match.length - 1); // Remove { and }
// Handle `user.X` variables with current user's data
if (key.startsWith("user.")) {
const userProp = key.split(".")[1];
const variable = allVariables.find((v) => v.key === key);
if (variable && typeof variable.value === "function") {
if (variable.value.constructor.name === "AsyncFunction") {
try {
const value = await variable.value(userId);
result = result.replace(match, value);
} catch (error) {
console.error(`Error processing user variable ${key}:`, error);
result = result.replace(match, `[User ${userProp}]`);
}
} else {
const value = variable.value();
result = result.replace(match, value);
}
} else {
result = result.replace(match, `[User ${userProp}]`);
}
continue;
}
// Handle regular variables (static types)
const variable = allVariables.find((v) => v.key === key);
if (!variable) continue;
// For dynamic and system variables, call the function to get the current value
if (
["system"].includes(variable.type) &&
typeof variable.value === "function"
) {
try {
if (variable.value.constructor.name === "AsyncFunction") {
const value = await variable.value(userId);
result = result.replace(match, value);
} else {
const value = variable.value();
result = result.replace(match, value);
}
} catch (error) {
console.error(`Error processing dynamic variable ${key}:`, error);
result = result.replace(match, match);
}
} else {
result = result.replace(match, variable.value || match);
}
}
return result;
} catch (error) {
console.error("Error in expandSystemPromptVariables:", error);
return str;
}
},
/**
* Internal function to check if a variable key is valid
* @param {string} key
* @param {boolean} checkExisting
* @returns {Promise<boolean>}
*/
_checkVariableKey: async function (key = null, checkExisting = true) {
if (!key) throw new Error("Key is required");
if (typeof key !== "string") throw new Error("Key must be a string");
if (!/^[a-zA-Z0-9_]+$/.test(key))
throw new Error("Key must contain only letters, numbers and underscores");
if (key.length > 255)
throw new Error("Key must be less than 255 characters");
if (key.length < 3) throw new Error("Key must be at least 3 characters");
if (key.startsWith("user."))
throw new Error("Key cannot start with 'user.'");
if (key.startsWith("system."))
throw new Error("Key cannot start with 'system.'");
if (checkExisting && (await this.get(key)) !== null)
throw new Error("System prompt variable with this key already exists");
return true;
},
};
module.exports = { SystemPromptVariables };
|