feat(sdk): add vNext API support to LingoDotDevEngine (#2027)

Author: AndreyHirsa

.changeset/bold-bushes-relax.md

@@ -0,0 +1,6 @@
+---
+"lingo.dev": patch
+"@lingo.dev/_sdk": patch
+---
+
+Add vNext API support to LingoDotDevEngine. When engineId is provided, the engine routes requests to the vNext API. Refactor vNext localizer to use LingoDotDevEngine from SDK instead of custom inline implementation

packages/cli/src/cli/localizer/lingodotdev-vnext.ts

@@ -2,185 +2,8 @@ import dedent from "dedent";
 import { ILocalizer, LocalizerData } from "./_types";
 import chalk from "chalk";
 import { colors } from "../constants";
+import { LingoDotDevEngine } from "@lingo.dev/_sdk";
 import { getSettings } from "../utils/settings";
-import { createId } from "@paralleldrive/cuid2";
-
-/**
- * Creates a custom engine for Lingo.dev vNext that sends requests to:
- * https://api.lingo.dev/process/<processId>/localize
- */
-function createVNextEngine(config: {
-  apiKey: string;
-  apiUrl: string;
-  processId: string;
-  sessionId: string;
-  triggerType: "cli" | "ci";
-}) {
-  const endpoint = `${config.apiUrl}/process/${config.processId}/localize`;
-
-  return {
-    async localizeChunk(
-      sourceLocale: string | null,
-      targetLocale: string,
-      payload: {
-        data: Record<string, any>;
-        reference?: Record<string, Record<string, any>>;
-        hints?: Record<string, string[]>;
-      },
-      fast: boolean,
-      filePath?: string,
-      signal?: AbortSignal,
-    ): Promise<Record<string, string>> {
-      const res = await fetch(endpoint, {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json; charset=utf-8",
-          "X-API-Key": config.apiKey,
-        },
-        body: JSON.stringify(
-          {
-            params: { fast },
-            sourceLocale,
-            targetLocale,
-            data: payload.data,
-            reference: payload.reference,
-            hints: payload.hints,
-            sessionId: config.sessionId,
-            triggerType: config.triggerType,
-            metadata: filePath ? { filePath } : undefined,
-          },
-          null,
-          2,
-        ),
-        signal,
-      });
-
-      if (!res.ok) {
-        if (res.status >= 500 && res.status < 600) {
-          const errorText = await res.text();
-          throw new Error(
-            `Server error (${res.status}): ${res.statusText}. ${errorText}. This may be due to temporary service issues.`,
-          );
-        } else if (res.status === 400) {
-          throw new Error(`Invalid request: ${res.statusText}`);
-        } else {
-          const errorText = await res.text();
-          throw new Error(errorText);
-        }
-      }
-
-      const jsonResponse = await res.json();
-
-      if (!jsonResponse.data && jsonResponse.error) {
-        throw new Error(jsonResponse.error);
-      }
-
-      return jsonResponse.data || {};
-    },
-
-    async whoami(
-      signal?: AbortSignal,
-    ): Promise<{ email: string; id: string } | null> {
-      // vNext uses a simple response for whoami
-      return { email: "vnext-user", id: config.processId };
-    },
-
-    async localizeObject(
-      obj: Record<string, any>,
-      params: {
-        sourceLocale: string | null;
-        targetLocale: string;
-        fast?: boolean;
-        reference?: Record<string, Record<string, any>>;
-        hints?: Record<string, string[]>;
-        filePath?: string;
-      },
-      progressCallback?: (
-        progress: number,
-        sourceChunk: Record<string, string>,
-        processedChunk: Record<string, string>,
-      ) => void,
-      signal?: AbortSignal,
-    ): Promise<Record<string, string>> {
-      const chunkedPayload = extractPayloadChunks(obj);
-      const processedPayloadChunks: Record<string, string>[] = [];
-
-      for (let i = 0; i < chunkedPayload.length; i++) {
-        const chunk = chunkedPayload[i];
-        const percentageCompleted = Math.round(
-          ((i + 1) / chunkedPayload.length) * 100,
-        );
-
-        const processedPayloadChunk = await this.localizeChunk(
-          params.sourceLocale,
-          params.targetLocale,
-          { data: chunk, reference: params.reference, hints: params.hints },
-          params.fast || false,
-          params.filePath,
-          signal,
-        );
-
-        if (progressCallback) {
-          progressCallback(percentageCompleted, chunk, processedPayloadChunk);
-        }
-
-        processedPayloadChunks.push(processedPayloadChunk);
-      }
-
-      return Object.assign({}, ...processedPayloadChunks);
-    },
-  };
-}
-
-/**
- * Helper functions for chunking payloads
- */
-function extractPayloadChunks(
-  payload: Record<string, string>,
-  batchSize: number = 25,
-  idealBatchItemSize: number = 250,
-): Record<string, string>[] {
-  const result: Record<string, string>[] = [];
-  let currentChunk: Record<string, string> = {};
-  let currentChunkItemCount = 0;
-
-  const payloadEntries = Object.entries(payload);
-  for (let i = 0; i < payloadEntries.length; i++) {
-    const [key, value] = payloadEntries[i];
-    currentChunk[key] = value;
-    currentChunkItemCount++;
-
-    const currentChunkSize = countWordsInRecord(currentChunk);
-    if (
-      currentChunkSize > idealBatchItemSize ||
-      currentChunkItemCount >= batchSize ||
-      i === payloadEntries.length - 1
-    ) {
-      result.push(currentChunk);
-      currentChunk = {};
-      currentChunkItemCount = 0;
-    }
-  }
-
-  return result;
-}
-
-function countWordsInRecord(
-  payload: any | Record<string, any> | Array<any>,
-): number {
-  if (Array.isArray(payload)) {
-    return payload.reduce((acc, item) => acc + countWordsInRecord(item), 0);
-  } else if (typeof payload === "object" && payload !== null) {
-    return Object.values(payload).reduce(
-      (acc: number, item) => acc + countWordsInRecord(item),
-      0,
-    );
-  } else if (typeof payload === "string") {
-    return payload.trim().split(/\s+/).filter(Boolean).length;
-  } else {
-    return 0;
-  }
-}
 
 export default function createLingoDotDevVNextLocalizer(
   processId: string,
@@ -207,15 +30,12 @@ export default function createLingoDotDevVNextLocalizer(
   // Use LINGO_API_URL from environment or default to api.lingo.dev
   const apiUrl = process.env.LINGO_API_URL || "https://api.lingo.dev";
 
-  const sessionId = createId();
   const triggerType = process.env.CI ? "ci" : "cli";
 
-  const engine = createVNextEngine({
+  const engine = new LingoDotDevEngine({
     apiKey,
     apiUrl,
-    processId,
-    sessionId,
-    triggerType,
+    engineId: processId,
   });
 
   return {
@@ -250,6 +70,7 @@ export default function createLingoDotDevVNextLocalizer(
           },
           hints: input.hints,
           filePath: input.filePath,
+          triggerType,
         },
         onProgress,
       );