mtmsdk 0.0.42 → 0.0.43

package/src/supabase/utils.ts

@@ -0,0 +1,75 @@
+// --- 类型工具定义开始 ---
+
+import type { SBFunctions, TypedSupabaseClient } from "../types";
+
+export type SnakeCase<S extends string> = S extends `${infer T}${infer U}`
+	? `${T extends Uncapitalize<T> ? T : `_${Lowercase<T>}`}${SnakeCase<U>}`
+	: S;
+
+export type DbFunctionParams<T> = {
+	// 遍历 Key -> 转换为 snake_case -> 添加 p_ 前缀
+	[K in keyof T as `p_${SnakeCase<string & K>}`]: T[K];
+};
+const toSnakeCase = (str: string) => {
+	return str.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
+};
+/**
+ * 实用工具, 将参数的名称,添加"p_"前缀,并且以"snake_case"的方式转换参数名称.
+ * 原因是 postgresql 函数,都约定了这样的参数形式.
+ *
+ * Input: { chatId: string } -> Output Type: { p_chat_id: string }
+ * Input: { chat_id: string } -> Output Type: { p_chat_id: string }
+ */
+export const convertToDbFunctionParams = <InputT extends Record<string, any>>(
+	input: InputT,
+): DbFunctionParams<InputT> => {
+	const result: Record<string, any> = {};
+
+	// biome-ignore lint/complexity/noForEach: .
+	Object.entries(input).forEach(([key, value]) => {
+		const snakeKey = toSnakeCase(key);
+		const newKey = `p_${snakeKey}`;
+		result[newKey] = value;
+	});
+	return result as DbFunctionParams<InputT>;
+};
+
+export const sbRpc = async <
+	TRpcName extends keyof SBFunctions,
+	TInput extends Record<string, any>,
+>(
+	sb: TypedSupabaseClient,
+	rpcName: TRpcName,
+
+	// 3. 【核心黑魔法】在参数位置进行校验
+	//    我们允许传入 input: TInput
+	//    但是，我们附加了一个“条件类型”检查：
+	//    如果 "转换后的类型" (DbFunctionParams<TInput>) 不能赋值给 "数据库要求的类型" (SBFunctions[TRpcName]["Args"])
+	//    那么，我们将 input 的类型强制判定为 never (导致报错) 或者给出一个具体的错误提示类型。
+	input: TInput &
+		(DbFunctionParams<TInput> extends SBFunctions[TRpcName]["Args"]
+			? unknown // 如果匹配，啥也不做，类型检查通过
+			: // 如果不匹配，返回数据库需要的类型，这样 IDE 会提示缺少什么属性
+				SBFunctions[TRpcName]["Args"]),
+	// 或者更高级一点，返回一个去除 p_ 前缀的提示类型（取决于你的偏好）
+) => {
+	return await sb.rpc(rpcName as any, convertToDbFunctionParams(input) as any);
+};
+
+
+/**
+ * 仅作为类型测试,用于确认 sbRpc 的正确实现.
+ * @param sb
+ * @returns
+ */
+export const sbRpcTesting = async (sb: TypedSupabaseClient) => {
+	//用例1: 正确的参数
+	await sbRpc(sb, "chat_message_list", { chat_id: "123" });
+	await sbRpc(sb, "chat_message_list", { p_chat_id: "123" });
+	await sbRpc(sb, "chat_message_list", { chatId: "123" });
+	// await sbRpc(sb, "chat_message_list", { ChatId: "123" });
+
+	//用例2: 以下应当出现类型错误
+	//不正确的参数名称
+	//await sbRpc(sb, "chat_message_list", { chat_id_xxxx: "123" });
+};