eng-1754-Clean up the typing of validators/processors for better type inference (#1033)

* Clean up the typing of validators/processors for better type inference

* lint

* crud

* Correction for processSupabaseError

Author: maparent

apps/website/app/api/supabase/agent-identifier/route.ts

@@ -1,7 +1,7 @@
 import { NextResponse, NextRequest } from "next/server";
 
 import { createClient } from "~/utils/supabase/server";
-import { getOrCreateEntity, ItemValidator } from "~/utils/supabase/dbUtils";
+import { getOrCreateEntity } from "~/utils/supabase/dbUtils";
 import { asPostgrestFailure } from "@repo/database/lib/contextFunctions";
 import {
   createApiResponse,
@@ -11,25 +11,26 @@ import {
 import { type TablesInsert, Constants } from "@repo/database/dbTypes";
 
 type AgentIdentifierDataInput = TablesInsert<"AgentIdentifier">;
+// eslint-disable-next-line @typescript-eslint/naming-convention
 const { AgentIdentifierType } = Constants.public.Enums;
 
-const agentIdentifierValidator: ItemValidator<AgentIdentifierDataInput> = (
-  agent_identifier: any,
-) => {
+// ItemValidator<"AgentIdentifier">
+const agentIdentifierValidator = (
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  agent_identifier: AgentIdentifierDataInput,
+): string | null => {
   if (!agent_identifier || typeof agent_identifier !== "object")
     return "Invalid request body: expected a JSON object.";
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   const { identifier_type, account_id, value, trusted } = agent_identifier;
 
   if (!AgentIdentifierType.includes(identifier_type))
     return "Invalid identifier_type";
   if (!value || typeof value !== "string" || value.trim() === "")
     return "Missing or invalid value";
-  if (!account_id || Number.isNaN(Number.parseInt(account_id, 10)))
+  if (!account_id || typeof account_id !== "number" || Number.isNaN(account_id))
     return "Missing or invalid account_id";
-  if (
-    trusted !== undefined &&
-    !["true", "false", true, false].includes(trusted)
-  )
+  if (trusted !== undefined && typeof trusted !== "boolean")
     return "if included, trusted should be a boolean";
 
   const keys = ["identifier_type", "account_id", "value", "trusted"];
@@ -42,18 +43,16 @@ export const POST = async (request: NextRequest): Promise<NextResponse> => {
   const supabasePromise = createClient();
 
   try {
-    const body = await request.json();
+    const body = (await request.json()) as AgentIdentifierDataInput;
     const error = agentIdentifierValidator(body);
     if (error !== null)
       return createApiResponse(request, asPostgrestFailure(error, "invalid"));
 
-    body.account_id = Number.parseInt(body.account_id, 10);
-    body.trusted = body.trusted === true || body.trusted === "true" || false;
     const supabase = await supabasePromise;
-    const result = await getOrCreateEntity<"AgentIdentifier">({
+    const result = await getOrCreateEntity({
       supabase,
       tableName: "AgentIdentifier",
-      insertData: body as AgentIdentifierDataInput,
+      insertData: body,
       uniqueOn: ["value", "identifier_type", "account_id"],
     });
 

apps/website/app/api/supabase/content-embedding/batch/route.ts

@@ -8,13 +8,11 @@ import {
   handleRouteError,
   defaultOptionsHandler,
 } from "~/utils/supabase/apiUtils";
+import { processAndInsertBatch } from "~/utils/supabase/dbUtils";
 import {
-  processAndInsertBatch,
+  type ContentEmbeddingVecTables,
+  type ContentEmbeddingVecTablesInsert,
   KNOWN_EMBEDDING_TABLES,
-} from "~/utils/supabase/dbUtils";
-import {
-  type ApiInputEmbeddingItem,
-  type ApiOutputEmbeddingRecord,
   embeddingInputProcessing,
   embeddingOutputProcessing,
 } from "~/utils/supabase/validators";
@@ -23,12 +21,12 @@ const DEFAULT_MODEL = "openai_text_embedding_3_small_1536";
 
 const batchInsertEmbeddingsProcess = async (
   supabase: Awaited<ReturnType<typeof createClient>>,
-  embeddingItems: ApiInputEmbeddingItem[],
-): Promise<PostgrestResponse<ApiOutputEmbeddingRecord>> => {
+  embeddingItems: ContentEmbeddingVecTablesInsert[],
+): Promise<PostgrestResponse<ContentEmbeddingVecTables>> => {
   // groupBy is node21 only, we are using 20. Group by model, by hand.
   // Note: This means that later index values may be totally wrong.
   // Note2: The key is a ModelName, but I cannot use an enum as a key.
-  const byModel: { [key: string]: ApiInputEmbeddingItem[] } = {};
+  const byModel: { [key: string]: ContentEmbeddingVecTablesInsert[] } = {};
   try {
     embeddingItems.reduce((acc, item) => {
       const model = item?.model || DEFAULT_MODEL;
@@ -45,7 +43,7 @@ const batchInsertEmbeddingsProcess = async (
     throw error;
   }
 
-  const globalResults: ApiOutputEmbeddingRecord[] = [];
+  const globalResults: ContentEmbeddingVecTables[] = [];
   const partialErrors: string[] = [];
   let created = false,
     count = 0,
@@ -55,15 +53,11 @@ const batchInsertEmbeddingsProcess = async (
     if (embeddingItemsSet === undefined) continue;
     const tableData = KNOWN_EMBEDDING_TABLES[modelName];
     if (tableData === undefined) continue;
-    const results = await processAndInsertBatch<
-      // any ContentEmbedding table for type checking purposes only
-      "ContentEmbedding_openai_text_embedding_3_small_1536",
-      ApiInputEmbeddingItem,
-      ApiOutputEmbeddingRecord
-    >({
+    const { tableName } = tableData;
+    const results = await processAndInsertBatch({
       supabase,
       items: embeddingItemsSet,
-      tableName: tableData.tableName,
+      tableName,
       inputProcessor: embeddingInputProcessing,
       outputProcessor: embeddingOutputProcessing,
     });
@@ -108,7 +102,7 @@ export const POST = async (request: NextRequest): Promise<NextResponse> => {
   const supabase = await createClient();
 
   try {
-    const body: ApiInputEmbeddingItem[] = await request.json();
+    const body = (await request.json()) as ContentEmbeddingVecTablesInsert[];
     if (!Array.isArray(body)) {
       return createApiResponse(
         request,

apps/website/app/api/supabase/content-embedding/route.ts

@@ -8,13 +8,11 @@ import {
   handleRouteError,
   defaultOptionsHandler,
 } from "~/utils/supabase/apiUtils";
+import { getOrCreateEntity } from "~/utils/supabase/dbUtils";
 import {
-  getOrCreateEntity,
   KNOWN_EMBEDDING_TABLES,
-} from "~/utils/supabase/dbUtils";
-import {
-  ApiInputEmbeddingItem,
-  ApiOutputEmbeddingRecord,
+  ContentEmbeddingVecTablesInsert,
+  ContentEmbeddingVecTables,
   embeddingInputProcessing,
   embeddingOutputProcessing,
 } from "~/utils/supabase/validators";
@@ -23,9 +21,11 @@ const DEFAULT_MODEL = "openai_text_embedding_3_small_1536";
 
 const processAndCreateEmbedding = async (
   supabasePromise: ReturnType<typeof createClient>,
-  data: ApiInputEmbeddingItem,
-): Promise<PostgrestSingleResponse<ApiOutputEmbeddingRecord>> => {
-  const { valid, error, processedItem } = embeddingInputProcessing(data);
+  data: ContentEmbeddingVecTablesInsert,
+): Promise<PostgrestSingleResponse<ContentEmbeddingVecTables>> => {
+  const processed = embeddingInputProcessing(data);
+  if (!processed) return asPostgrestFailure("Could not process input", "valid");
+  const { valid, error, processedItem } = processed;
   if (
     !valid ||
     processedItem === undefined ||
@@ -78,7 +78,7 @@ export const POST = async (request: NextRequest): Promise<NextResponse> => {
   const supabasePromise = createClient();
 
   try {
-    const body: ApiInputEmbeddingItem = await request.json();
+    const body = (await request.json()) as ContentEmbeddingVecTablesInsert;
     const result = await processAndCreateEmbedding(supabasePromise, body);
     return createApiResponse(request, result);
   } catch (e: unknown) {

apps/website/app/api/supabase/content/batch/route.ts

@@ -18,7 +18,7 @@ const batchInsertContentProcess = async (
   supabase: Awaited<ReturnType<typeof createClient>>,
   contentItems: ContentDataInput[],
 ): Promise<PostgrestResponse<ContentRecord>> => {
-  return validateAndInsertBatch<"Content">({
+  return validateAndInsertBatch({
     supabase,
     tableName: "Content",
     items: contentItems,

apps/website/app/api/supabase/content/route.ts

@@ -27,7 +27,7 @@ const processAndUpsertContentEntry = async (
   // If no solid matchCriteria for a "get", getOrCreateEntity will likely proceed to "create".
   // If there are unique constraints other than (space_id, source_local_id), it will handle race conditions.
 
-  const result = await getOrCreateEntity<"Content">({
+  const result = await getOrCreateEntity({
     supabase,
     tableName: "Content",
     insertData: data,

apps/website/app/api/supabase/document/route.ts

@@ -2,7 +2,7 @@ import { NextResponse, NextRequest } from "next/server";
 import type { PostgrestSingleResponse } from "@supabase/supabase-js";
 
 import { createClient } from "~/utils/supabase/server";
-import { getOrCreateEntity, ItemValidator } from "~/utils/supabase/dbUtils";
+import { getOrCreateEntity } from "~/utils/supabase/dbUtils";
 import { asPostgrestFailure } from "@repo/database/lib/contextFunctions";
 import {
   createApiResponse,
@@ -14,7 +14,8 @@ import type { Tables, TablesInsert } from "@repo/database/dbTypes";
 type DocumentDataInput = TablesInsert<"Document">;
 type DocumentRecord = Tables<"Document">;
 
-const validateDocument: ItemValidator<DocumentDataInput> = (data) => {
+// ItemValidator<"Document">
+const validateDocument = (data: DocumentDataInput): string | null => {
   if (!data || typeof data !== "object")
     return "Invalid request body: expected a JSON object.";
   // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -33,7 +34,7 @@ const createDocument = async (
 ): Promise<PostgrestSingleResponse<DocumentRecord>> => {
   const supabase = await supabasePromise;
 
-  const result = await getOrCreateEntity<"Document">({
+  const result = await getOrCreateEntity({
     supabase,
     tableName: "Document",
     insertData: data,
@@ -50,7 +51,7 @@ export const POST = async (request: NextRequest): Promise<NextResponse> => {
   const supabasePromise = createClient();
 
   try {
-    const body: DocumentDataInput = await request.json();
+    const body = (await request.json()) as DocumentDataInput;
     const error = validateDocument(body);
     if (error !== null)
       return createApiResponse(request, asPostgrestFailure(error, "invalid"));

apps/website/app/api/supabase/platform-account/route.ts

@@ -1,7 +1,7 @@
 import { NextResponse, NextRequest } from "next/server";
 
 import { createClient } from "~/utils/supabase/server";
-import { getOrCreateEntity, ItemValidator } from "~/utils/supabase/dbUtils";
+import { getOrCreateEntity } from "~/utils/supabase/dbUtils";
 import { asPostgrestFailure } from "@repo/database/lib/contextFunctions";
 import {
   createApiResponse,
@@ -15,9 +15,8 @@ const { AgentType, Platform } = Constants.public.Enums;
 
 type PlatformAccountDataInput = TablesInsert<"PlatformAccount">;
 
-const accountValidator: ItemValidator<PlatformAccountDataInput> = (
-  account: any,
-) => {
+// ItemValidator<"PlatformAccount">
+const accountValidator = (account: PlatformAccountDataInput): string | null => {
   if (!account || typeof account !== "object")
     return "Invalid request body: expected a JSON object.";
   /* eslint-disable @typescript-eslint/naming-convention */
@@ -84,16 +83,16 @@ export const POST = async (request: NextRequest): Promise<NextResponse> => {
   const supabasePromise = createClient();
 
   try {
-    const body = await request.json();
+    const body = (await request.json()) as PlatformAccountDataInput;
     const error = accountValidator(body);
     if (error !== null)
       return createApiResponse(request, asPostgrestFailure(error, "invalid"));
 
     const supabase = await supabasePromise;
-    const result = await getOrCreateEntity<"PlatformAccount">({
+    const result = await getOrCreateEntity({
       supabase,
       tableName: "PlatformAccount",
-      insertData: body as PlatformAccountDataInput,
+      insertData: body,
       uniqueOn: ["account_local_id", "platform"],
     });