feat: vNext migration

Author: AndreyHirsa

.changeset/thirty-pots-judge.md

@@ -0,0 +1,9 @@
+---
+"@lingo.dev/compiler": minor
+"@lingo.dev/_compiler": minor
+"@lingo.dev/_spec": minor
+"lingo.dev": minor
+"@lingo.dev/_sdk": minor
+---
+
+Migrate SDK and CLI to unified API endpoints. All requests now use `api.lingo.dev` with `X-API-Key` auth. Added `engineId` config option (auto-migrated from `vNext`)

packages/cli/src/cli/cmd/ci/index.ts

@@ -84,41 +84,29 @@ export default new Command()
       process.chdir(originalCwd);
     }
 
-    const isVNext = !!config?.vNext;
-
     const settings = getSettings(options.apiKey);
 
-    if (isVNext) {
-      if (!settings.auth.vnext?.apiKey) {
-        console.error(
-          "No LINGO_API_KEY provided. vNext requires LINGO_API_KEY environment variable.",
-        );
-        return;
-      }
-    } else {
-      if (!settings.auth.apiKey) {
-        console.error("No API key provided");
-        return;
-      }
+    if (!settings.auth.apiKey) {
+      console.error(
+        "No API key provided. Set LINGO_API_KEY environment variable or use --api-key flag.",
+      );
+      return;
+    }
 
-      const authenticator = createAuthenticator({
-        apiUrl: settings.auth.apiUrl,
-        apiKey: settings.auth.apiKey,
-      });
+    const authenticator = createAuthenticator({
+      apiUrl: settings.auth.apiUrl,
+      apiKey: settings.auth.apiKey,
+    });
 
-      const auth = await authenticator.whoami();
-      if (!auth) {
-        console.error("Not authenticated");
-        return;
-      }
+    const auth = await authenticator.whoami();
+    if (!auth) {
+      console.error("Not authenticated");
+      return;
     }
 
     const env = {
       ...(settings.auth.apiKey && {
-        LINGODOTDEV_API_KEY: settings.auth.apiKey,
-      }),
-      ...(settings.auth.vnext?.apiKey && {
-        LINGO_API_KEY: settings.auth.vnext.apiKey,
+        LINGO_API_KEY: settings.auth.apiKey,
       }),
       LINGODOTDEV_PULL_REQUEST: options.pullRequest?.toString() || "false",
       ...(options.commitMessage && {
@@ -162,7 +150,7 @@ export default new Command()
     }
 
     const hasChanges = await flow.run({
-      parallel: isVNext || options.parallel,
+      parallel: options.parallel,
     });
     if (!hasChanges) {
       return;

packages/cli/src/cli/cmd/ci/platforms/_base.ts

@@ -47,6 +47,7 @@ export abstract class PlatformKit<
 
   get config() {
     const env = Z.object({
+      LINGO_API_KEY: Z.string().optional(),
       LINGODOTDEV_API_KEY: Z.string().optional(),
       LINGODOTDEV_PULL_REQUEST: Z.preprocess(
         (val) => val === "true" || val === true,
@@ -68,7 +69,7 @@ export abstract class PlatformKit<
     }).parse(process.env);
 
     return {
-      replexicaApiKey: env.LINGODOTDEV_API_KEY || "",
+      replexicaApiKey: env.LINGO_API_KEY || env.LINGODOTDEV_API_KEY || "",
       isPullRequestMode: env.LINGODOTDEV_PULL_REQUEST,
       commitMessage: env.LINGODOTDEV_COMMIT_MESSAGE || defaultMessage,
       pullRequestTitle: env.LINGODOTDEV_PULL_REQUEST_TITLE || defaultMessage,

packages/cli/src/cli/cmd/i18n.ts

@@ -439,6 +439,7 @@ export default new Command()
                 let processPayload = createProcessor(i18nConfig!.provider, {
                   apiKey: settings.auth.apiKey,
                   apiUrl: settings.auth.apiUrl,
+                  engineId: i18nConfig!.engineId,
                 });
                 processPayload = withExponentialBackoff(
                   processPayload,

packages/cli/src/cli/cmd/login.ts

@@ -49,7 +49,7 @@ Press Enter to open the browser for authentication.
 
 ---
 
-Having issues? Put LINGODOTDEV_API_KEY in your .env file instead.
+Having issues? Put LINGO_API_KEY in your .env file instead.
     `.trim() + "\n",
     );
 

packages/cli/src/cli/cmd/run/setup.ts

@@ -50,18 +50,18 @@ export default async function setup(input: CmdRunContext) {
       {
         title: "Selecting localization provider",
         task: async (ctx, task) => {
-          const isPseudo = ctx.flags.pseudo || ctx.config?.dev?.usePseudotranslator;
+          const isPseudo =
+            ctx.flags.pseudo || ctx.config?.dev?.usePseudotranslator;
           const provider = isPseudo ? "pseudo" : ctx.config?.provider;
-          const vNext = ctx.config?.vNext;
-          ctx.localizer = createLocalizer(provider, ctx.flags.apiKey, vNext);
+          const engineId = ctx.config?.engineId;
+          ctx.localizer = createLocalizer(provider, engineId, ctx.flags.apiKey);
           if (!ctx.localizer) {
             throw new Error(
               "Could not create localization provider. Please check your i18n.json configuration.",
             );
           }
           task.title =
-            ctx.localizer.id === "Lingo.dev" ||
-            ctx.localizer.id === "Lingo.dev vNext"
+            ctx.localizer.id === "Lingo.dev"
               ? `Using ${chalk.hex(colors.green)(ctx.localizer.id)} provider`
               : ctx.localizer.id === "pseudo"
                 ? `Using ${chalk.hex(colors.blue)("pseudo")} mode for testing`
@@ -71,8 +71,7 @@ export default async function setup(input: CmdRunContext) {
       {
         title: "Checking authentication",
         enabled: (ctx) =>
-          (ctx.localizer?.id === "Lingo.dev" ||
-            ctx.localizer?.id === "Lingo.dev vNext") &&
+          ctx.localizer?.id === "Lingo.dev" &&
           !ctx.flags.pseudo &&
           !ctx.config?.dev?.usePseudotranslator,
         task: async (ctx, task) => {
@@ -87,9 +86,7 @@ export default async function setup(input: CmdRunContext) {
       },
       {
         title: "Validating configuration",
-        enabled: (ctx) =>
-          ctx.localizer?.id !== "Lingo.dev" &&
-          ctx.localizer?.id !== "Lingo.dev vNext",
+        enabled: (ctx) => ctx.localizer?.id !== "Lingo.dev",
         task: async (ctx, task) => {
           const validationStatus = await ctx.localizer!.validateSettings!();
           if (!validationStatus.valid) {
@@ -103,9 +100,7 @@ export default async function setup(input: CmdRunContext) {
       {
         title: "Initializing localization provider",
         async task(ctx, task) {
-          const isLingoDotDev =
-            ctx.localizer!.id === "Lingo.dev" ||
-            ctx.localizer!.id === "Lingo.dev vNext";
+          const isLingoDotDev = ctx.localizer!.id === "Lingo.dev";
           const isPseudo = ctx.localizer!.id === "pseudo";
 
           const subTasks = isLingoDotDev

packages/cli/src/cli/localizer/_types.ts

@@ -17,11 +17,7 @@ export type LocalizerProgressFn = (
 ) => void;
 
 export interface ILocalizer {
-  id:
-    | "Lingo.dev"
-    | "Lingo.dev vNext"
-    | "pseudo"
-    | NonNullable<I18nConfig["provider"]>["id"];
+  id: "Lingo.dev" | "pseudo" | NonNullable<I18nConfig["provider"]>["id"];
   checkAuth: () => Promise<{
     authenticated: boolean;
     username?: string;

packages/cli/src/cli/localizer/index.ts

@@ -1,27 +1,21 @@
 import { I18nConfig } from "@lingo.dev/_spec";
 
 import createLingoDotDevLocalizer from "./lingodotdev";
-import createLingoDotDevVNextLocalizer from "./lingodotdev-vnext";
 import createExplicitLocalizer from "./explicit";
 import createPseudoLocalizer from "./pseudo";
 import { ILocalizer } from "./_types";
 
 export default function createLocalizer(
   provider: I18nConfig["provider"] | "pseudo" | null | undefined,
+  engineId?: string,
   apiKey?: string,
-  vNext?: string,
 ): ILocalizer {
   if (provider === "pseudo") {
     return createPseudoLocalizer();
   }
 
-  // Check if vNext is configured
-  if (vNext) {
-    return createLingoDotDevVNextLocalizer(vNext);
-  }
-
   if (!provider) {
-    return createLingoDotDevLocalizer(apiKey);
+    return createLingoDotDevLocalizer(apiKey, engineId);
   } else {
     return createExplicitLocalizer(provider);
   }

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

@@ -7,27 +7,31 @@ import { getSettings } from "../utils/settings";
 
 export default function createLingoDotDevLocalizer(
   explicitApiKey?: string,
+  engineId?: string,
 ): ILocalizer {
-  const { auth } = getSettings(explicitApiKey);
+  const settings = getSettings(explicitApiKey);
 
-  if (!auth) {
+  if (!settings.auth.apiKey) {
     throw new Error(
       dedent`
         You're trying to use ${chalk.hex(colors.green)(
           "Lingo.dev",
-        )} provider, however, you are not authenticated.
+        )} provider, however, no API key is configured.
 
         To fix this issue:
         1. Run ${chalk.dim("lingo.dev login")} to authenticate, or
-        2. Use the ${chalk.dim("--api-key")} flag to provide an API key.
-        3. Set ${chalk.dim("LINGODOTDEV_API_KEY")} environment variable.
+        2. Set ${chalk.dim("LINGO_API_KEY")} environment variable, or
+        3. Use the ${chalk.dim("--api-key")} flag to provide an API key.
       `,
     );
   }
 
+  const triggerType = process.env.CI ? "ci" : "cli";
+
   const engine = new LingoDotDevEngine({
-    apiKey: auth.apiKey,
-    apiUrl: auth.apiUrl,
+    apiKey: settings.auth.apiKey,
+    apiUrl: settings.auth.apiUrl,
+    ...(engineId && { engineId }),
   });
 
   return {
@@ -48,7 +52,7 @@ export default function createLingoDotDevLocalizer(
     localize: async (input: LocalizerData, onProgress) => {
       // Nothing to translate – return the input as-is.
       if (!Object.keys(input.processableData).length) {
-        return input;
+        return input.processableData;
       }
 
       const processedData = await engine.localizeObject(
@@ -61,6 +65,8 @@ export default function createLingoDotDevLocalizer(
             [input.targetLocale]: input.targetData,
           },
           hints: input.hints,
+          filePath: input.filePath,
+          triggerType,
         },
         onProgress,
       );