@dualkit/convert 0.1.0-beta.0 → 0.2.0-beta.0

package/README.md

@@ -94,11 +94,12 @@ Convert flags these in the report instead of guessing:
 It refuses, with a one-line reason, when:
 
 - The app is not Next.js App Router or Vite React. The Pages Router, Create React App, Remix, Vue, Svelte and Angular are refused.
-- The app already has its own middleware or proxy file, or files with the names convert would write.
+- The app already has files with the names convert would write, such as `app-middleware`.
 - The root layout is a client component, has no `<html>` element, or takes its props in a form convert cannot add params to.
 
 ## Known gaps
 
+- If the app has its own middleware or proxy file, convert moves it to `app-middleware` and runs it first, on the path without its locale. We tested this with a hand-written login check on Next.js 15. Clerk and other auth libraries are untested, so check your login after converting.
 - Convert does not place the language switch, because that would change the English look. It writes `components/dualkit-language-switch.tsx` and tells you to add it.
 - Next.js sends a visitor whose browser asks for Arabic from an English URL to the Arabic page. That is next-intl's locale detection, and convert leaves it on.
 

package/dist/index.cjs

@@ -478,6 +478,15 @@ async function applyPlan(disk, plan) {
   return { touched, edits: edits2, writes, perFile };
 }
 var json = (value) => JSON.stringify(value, null, 2) + "\n";
+var isMessages = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+function keepHandAdded(existing, generated) {
+  const kept = Object.entries(existing).map(([key, value]) => {
+    const fresh = generated[key];
+    if (fresh === void 0) return [key, value];
+    return [key, isMessages(value) && isMessages(fresh) ? keepHandAdded(value, fresh) : fresh];
+  });
+  return { ...generated, ...Object.fromEntries(kept) };
+}
 var messagesFiles = (ledger) => ({
   [messagesPath("en")]: json(messagesFor(ledger, "en")),
   [messagesPath("ar")]: json(messagesFor(ledger, "ar"))
@@ -1686,6 +1695,88 @@ export const config = {
   matcher: '/((?!(?:api|_next|_vercel)(?:/|$)|.*\\\\..*).*)',
 }
 `;
+var composedMiddlewareFile = (routing, matcher, own) => `import { NextRequest, NextResponse, type NextFetchEvent } from 'next/server'
+import createMiddleware from 'next-intl/middleware'
+import { routing } from '${routing}'
+import { matchesApp, type Matcher } from '${matcher}'
+import * as own from '${own}'
+
+const intl = createMiddleware(routing)
+type OwnHandler = (request: NextRequest, event: NextFetchEvent) => Response | null | undefined | Promise<Response | null | undefined>
+// A spread, so the bundler does not warn about the export names this app does not use.
+const exported: Record<string, unknown> = { ...own }
+const candidate = exported.default ?? exported.middleware ?? exported.proxy
+if (typeof candidate !== 'function') throw new Error('Dualkit could not find the middleware function exported by ${own}.')
+const ownHandler = candidate as OwnHandler
+const ownMatcher = (exported as { config?: { matcher?: Matcher } }).config?.matcher
+const OWN_ONLY = /^\\/(?:api|trpc)(?:\\/|$)/
+
+export default async function middleware(request: NextRequest, event: NextFetchEvent) {
+  const url = request.nextUrl.clone()
+  const [, first = '', ...rest] = url.pathname.split('/')
+  if ((routing.locales as readonly string[]).includes(first)) url.pathname = \`/\${rest.join('/')}\`
+  const result = matchesApp(url.pathname, ownMatcher) ? await ownHandler(new NextRequest(url, request), event) : null
+  // Anything but a plain "continue" is the app's answer: a redirect, a rewrite, a 401 or a page. Keep it as it is.
+  if (result && result.headers.get('x-middleware-next') !== '1') return result
+  if (OWN_ONLY.test(url.pathname)) return result ?? NextResponse.next()
+  const response = intl(request)
+  if (result) {
+    for (const cookie of result.headers.getSetCookie()) response.headers.append('set-cookie', cookie)
+    // Headers the app set for the browser, such as a content security policy.
+    result.headers.forEach((value, key) => { if (key !== 'set-cookie' && !key.startsWith('x-middleware-')) response.headers.set(key, value) })
+    const overridden = result.headers.get('x-middleware-override-headers')
+    if (overridden) {
+      const names = new Set([...(response.headers.get('x-middleware-override-headers') ?? '').split(','), ...overridden.split(',')].filter(Boolean))
+      response.headers.set('x-middleware-override-headers', [...names].join(','))
+      result.headers.forEach((value, key) => { if (key.startsWith('x-middleware-request-')) response.headers.set(key, value) })
+    }
+  }
+  return response
+}
+
+export const config = {
+  matcher: '/((?!(?:_next|_vercel)(?:/|$)|.*\\\\..*).*)',
+}
+`;
+var APP_MATCHER = String.raw`/** Whether a path is covered by an app's own middleware matcher. No matcher means every path. */
+export type Matcher = string | { source: string }  | (string | { source: string })[]
+
+/** An entry with has or missing conditions is treated as matching, so the app's middleware runs rather than being skipped. */
+export function matchesApp(pathname: string, matcher: Matcher | undefined): boolean {
+  if (matcher === undefined) return true
+  return (Array.isArray(matcher) ? matcher : [matcher]).some((entry) => toRegExp(typeof entry === 'string' ? entry : entry.source).test(pathname))
+}
+
+function toRegExp(pattern: string): RegExp {
+  let out = ''
+  let i = 0
+  while (i < pattern.length) {
+    const char = pattern[i]!
+    const param = char === '/' ? /^\/:[A-Za-z0-9_]+([*+?]?)/.exec(pattern.slice(i)) : null
+    if (param && pattern[i + param[0].length] === '(') {
+      out += '/'
+      i += param[0].length
+    } else if (param) {
+      out += { '*': '(?:/.*)?', '+': '/.+', '?': '(?:/[^/]+)?', '': '/[^/]+' }[param[1]!]
+      i += param[0].length
+    } else if (char === '(') {
+      let depth = 0
+      let j = i
+      for (; j < pattern.length; j++) {
+        if (pattern[j] === '\\') j++
+        else if (pattern[j] === '(') depth++
+        else if (pattern[j] === ')' && --depth === 0) break
+      }
+      out += pattern.slice(i, j + 1)
+      i = j + 1
+    } else {
+      out += char.replace(/[.*+?^$|{}[\]\\]/g, '\\$&')
+      i++
+    }
+  }
+  return new RegExp('^' + out + (out.endsWith('/') ? '' : '/?') + '$')
+}
+`;
 var switchFile = (navigation) => `'use client'
 
 import { useLocale } from 'next-intl'
@@ -1738,16 +1829,24 @@ function alreadyWired(project, mode, appDir, files, paths) {
   const wired = (files(project.entry) ?? "").includes("NextIntlClientProvider") && files(`${sourceBase(project)}i18n/request.ts`) !== null;
   return wired ? project.entry : null;
 }
-function guardMiddleware(base, ours, text, files) {
+function findMiddleware(base, files) {
+  const found = [];
   for (const name of ["middleware", "proxy"]) {
     for (const ext of ["ts", "js", "mjs", "tsx", "jsx"]) {
       const path = `${base}${name}.${ext}`;
-      const existing = files(path);
-      if (existing === null || path === ours && existing === text) continue;
-      throw new UnsupportedError(`This app already has ${path}. Convert cannot merge the next-intl middleware into it, so it stopped before changing anything.`);
+      const text = files(path);
+      if (text !== null) found.push({ path, text });
     }
   }
+  if (found.length > 1) throw new UnsupportedError(`This app has both ${found[0].path} and ${found[1].path}. Convert cannot tell which one to compose with next-intl, so it stopped before changing anything.`);
+  const only = found[0] ?? null;
+  if (only && !EXPORTS_HANDLER.test(only.text)) {
+    throw new UnsupportedError(`Convert could not find the middleware function exported from ${only.path}, so it stopped before changing anything.`);
+  }
+  return only;
 }
+var EXPORTS_HANDLER = /export\s+default\b|export\s+(?:async\s+)?function\s+(?:middleware|proxy)\b|export\s+(?:const|let|var)\s+(?:middleware|proxy)\b|export\s*\{[^}]*\b(?:middleware|proxy|default)\b[^}]*\}/;
+var movedMiddlewarePath = (base, existing) => `${base}app-middleware.${existing.split(".").pop()}`;
 var merge = (into, from) => {
   const out = { ...into };
   for (const [path, edits2] of Object.entries(from)) out[path] = [...out[path] ?? [], ...edits2];
@@ -1757,8 +1856,13 @@ function bilingualParts(project, appDir, files, paths) {
   const base = sourceBase(project);
   const { moves, keptPages } = routeMoves(appDir, paths);
   const middlewarePath = `${base}${nextMajor(files) >= 16 ? "proxy" : "middleware"}.ts`;
-  const middleware = middlewareFile(specifierTo(middlewarePath, `${base}i18n/routing.ts`));
-  guardMiddleware(base, middlewarePath, middleware, files);
+  const own = findMiddleware(base, files);
+  const routingSpec = specifierTo(middlewarePath, `${base}i18n/routing.ts`);
+  const ownMoved = own ? movedMiddlewarePath(base, own.path) : null;
+  if (ownMoved && files(ownMoved) !== null) {
+    throw new UnsupportedError(`This app already has ${ownMoved}. Convert needs that name for the app's own middleware, so move or remove that file and run convert again.`);
+  }
+  const middleware = ownMoved ? composedMiddlewareFile(routingSpec, specifierTo(middlewarePath, `${base}i18n/app-matcher.ts`), specifierTo(middlewarePath, ownMoved)) : middlewareFile(routingSpec);
   const catchAll = topCatchAll(appDir, moves, paths);
   const flags = keptPages.map((page) => flagAt(
     page,
@@ -1766,6 +1870,14 @@ function bilingualParts(project, appDir, files, paths) {
     `${page} stays outside [locale], because the middleware skips its path, so it has no Arabic version.`,
     "Move the page to a path the middleware matches, or translate it by hand."
   ));
+  if (own && ownMoved) {
+    flags.push(flagAt(
+      ownMoved,
+      "info",
+      `${own.path} moved to ${ownMoved}, and the new ${middlewarePath} runs it first on the path without its locale prefix, then next-intl.`,
+      "Check the app middleware still behaves as before and that its auth checks still hold under /ar. Any answer other than a plain continue (a redirect, rewrite or 401) is returned as it is. Paths under /api and /trpc skip next-intl. Config options other than matcher, such as runtime, are not carried over, and has or missing conditions on a matcher entry are ignored, so the middleware runs on those paths."
+    ));
+  }
   if (catchAll) {
     flags.push(flagAt(
       catchAll,
@@ -1778,11 +1890,13 @@ function bilingualParts(project, appDir, files, paths) {
     [`${base}i18n/routing.ts`]: ROUTING,
     [`${base}i18n/navigation.ts`]: NAVIGATION,
     [middlewarePath]: middleware,
+    ...own ? { [`${base}i18n/app-matcher.ts`]: APP_MATCHER } : {},
     [switchPath(project)]: switchFile(specifierTo(switchPath(project), `${base}i18n/navigation.ts`)),
     ...catchAll ? {} : { [`${appDir}/[locale]/[...rest]/page.tsx`]: CATCH_ALL }
   };
   const rewrites = importRewrites(appDir, moves, paths, files, readAliases(files));
-  return { moves, writes, flags: [...flags, ...rewrites.flags], edits: rewrites.edits };
+  const ownMove = own && ownMoved ? [[own.path, ownMoved]] : [];
+  return { moves: [...moves, ...ownMove], writes, flags: [...flags, ...rewrites.flags], edits: rewrites.edits };
 }
 function wireNextIntl(project, mode, files, paths) {
   const appDir = project.appDir ?? "app";
@@ -3112,7 +3226,18 @@ function pendingCheck(ledger, force) {
 }
 function writeMessages(root, ledger) {
   const disk = { root, created: [] };
-  for (const [path, text] of Object.entries(messagesFiles(ledger))) writeText(disk, path, text);
+  for (const [path, text] of Object.entries(messagesFiles(ledger))) writeText(disk, path, mergedMessages(root, path, text));
+}
+function mergedMessages(root, path, generated) {
+  const full = (0, import_node_path19.join)(root, path);
+  if (!(0, import_node_fs11.existsSync)(full)) return generated;
+  try {
+    const existing = JSON.parse((0, import_node_fs11.readFileSync)(full, "utf8"));
+    if (typeof existing !== "object" || existing === null) return generated;
+    return JSON.stringify(keepHandAdded(existing, JSON.parse(generated)), null, 2) + "\n";
+  } catch {
+    return generated;
+  }
 }
 async function englishChecks(root, base, routes, shoot) {
   const english2 = [];

package/dist/index.js

@@ -443,6 +443,15 @@ async function applyPlan(disk, plan) {
   return { touched, edits: edits2, writes, perFile };
 }
 var json = (value) => JSON.stringify(value, null, 2) + "\n";
+var isMessages = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+function keepHandAdded(existing, generated) {
+  const kept = Object.entries(existing).map(([key, value]) => {
+    const fresh = generated[key];
+    if (fresh === void 0) return [key, value];
+    return [key, isMessages(value) && isMessages(fresh) ? keepHandAdded(value, fresh) : fresh];
+  });
+  return { ...generated, ...Object.fromEntries(kept) };
+}
 var messagesFiles = (ledger) => ({
   [messagesPath("en")]: json(messagesFor(ledger, "en")),
   [messagesPath("ar")]: json(messagesFor(ledger, "ar"))
@@ -1651,6 +1660,88 @@ export const config = {
   matcher: '/((?!(?:api|_next|_vercel)(?:/|$)|.*\\\\..*).*)',
 }
 `;
+var composedMiddlewareFile = (routing, matcher, own) => `import { NextRequest, NextResponse, type NextFetchEvent } from 'next/server'
+import createMiddleware from 'next-intl/middleware'
+import { routing } from '${routing}'
+import { matchesApp, type Matcher } from '${matcher}'
+import * as own from '${own}'
+
+const intl = createMiddleware(routing)
+type OwnHandler = (request: NextRequest, event: NextFetchEvent) => Response | null | undefined | Promise<Response | null | undefined>
+// A spread, so the bundler does not warn about the export names this app does not use.
+const exported: Record<string, unknown> = { ...own }
+const candidate = exported.default ?? exported.middleware ?? exported.proxy
+if (typeof candidate !== 'function') throw new Error('Dualkit could not find the middleware function exported by ${own}.')
+const ownHandler = candidate as OwnHandler
+const ownMatcher = (exported as { config?: { matcher?: Matcher } }).config?.matcher
+const OWN_ONLY = /^\\/(?:api|trpc)(?:\\/|$)/
+
+export default async function middleware(request: NextRequest, event: NextFetchEvent) {
+  const url = request.nextUrl.clone()
+  const [, first = '', ...rest] = url.pathname.split('/')
+  if ((routing.locales as readonly string[]).includes(first)) url.pathname = \`/\${rest.join('/')}\`
+  const result = matchesApp(url.pathname, ownMatcher) ? await ownHandler(new NextRequest(url, request), event) : null
+  // Anything but a plain "continue" is the app's answer: a redirect, a rewrite, a 401 or a page. Keep it as it is.
+  if (result && result.headers.get('x-middleware-next') !== '1') return result
+  if (OWN_ONLY.test(url.pathname)) return result ?? NextResponse.next()
+  const response = intl(request)
+  if (result) {
+    for (const cookie of result.headers.getSetCookie()) response.headers.append('set-cookie', cookie)
+    // Headers the app set for the browser, such as a content security policy.
+    result.headers.forEach((value, key) => { if (key !== 'set-cookie' && !key.startsWith('x-middleware-')) response.headers.set(key, value) })
+    const overridden = result.headers.get('x-middleware-override-headers')
+    if (overridden) {
+      const names = new Set([...(response.headers.get('x-middleware-override-headers') ?? '').split(','), ...overridden.split(',')].filter(Boolean))
+      response.headers.set('x-middleware-override-headers', [...names].join(','))
+      result.headers.forEach((value, key) => { if (key.startsWith('x-middleware-request-')) response.headers.set(key, value) })
+    }
+  }
+  return response
+}
+
+export const config = {
+  matcher: '/((?!(?:_next|_vercel)(?:/|$)|.*\\\\..*).*)',
+}
+`;
+var APP_MATCHER = String.raw`/** Whether a path is covered by an app's own middleware matcher. No matcher means every path. */
+export type Matcher = string | { source: string }  | (string | { source: string })[]
+
+/** An entry with has or missing conditions is treated as matching, so the app's middleware runs rather than being skipped. */
+export function matchesApp(pathname: string, matcher: Matcher | undefined): boolean {
+  if (matcher === undefined) return true
+  return (Array.isArray(matcher) ? matcher : [matcher]).some((entry) => toRegExp(typeof entry === 'string' ? entry : entry.source).test(pathname))
+}
+
+function toRegExp(pattern: string): RegExp {
+  let out = ''
+  let i = 0
+  while (i < pattern.length) {
+    const char = pattern[i]!
+    const param = char === '/' ? /^\/:[A-Za-z0-9_]+([*+?]?)/.exec(pattern.slice(i)) : null
+    if (param && pattern[i + param[0].length] === '(') {
+      out += '/'
+      i += param[0].length
+    } else if (param) {
+      out += { '*': '(?:/.*)?', '+': '/.+', '?': '(?:/[^/]+)?', '': '/[^/]+' }[param[1]!]
+      i += param[0].length
+    } else if (char === '(') {
+      let depth = 0
+      let j = i
+      for (; j < pattern.length; j++) {
+        if (pattern[j] === '\\') j++
+        else if (pattern[j] === '(') depth++
+        else if (pattern[j] === ')' && --depth === 0) break
+      }
+      out += pattern.slice(i, j + 1)
+      i = j + 1
+    } else {
+      out += char.replace(/[.*+?^$|{}[\]\\]/g, '\\$&')
+      i++
+    }
+  }
+  return new RegExp('^' + out + (out.endsWith('/') ? '' : '/?') + '$')
+}
+`;
 var switchFile = (navigation) => `'use client'
 
 import { useLocale } from 'next-intl'
@@ -1703,16 +1794,24 @@ function alreadyWired(project, mode, appDir, files, paths) {
   const wired = (files(project.entry) ?? "").includes("NextIntlClientProvider") && files(`${sourceBase(project)}i18n/request.ts`) !== null;
   return wired ? project.entry : null;
 }
-function guardMiddleware(base, ours, text, files) {
+function findMiddleware(base, files) {
+  const found = [];
   for (const name of ["middleware", "proxy"]) {
     for (const ext of ["ts", "js", "mjs", "tsx", "jsx"]) {
       const path = `${base}${name}.${ext}`;
-      const existing = files(path);
-      if (existing === null || path === ours && existing === text) continue;
-      throw new UnsupportedError(`This app already has ${path}. Convert cannot merge the next-intl middleware into it, so it stopped before changing anything.`);
+      const text = files(path);
+      if (text !== null) found.push({ path, text });
     }
   }
+  if (found.length > 1) throw new UnsupportedError(`This app has both ${found[0].path} and ${found[1].path}. Convert cannot tell which one to compose with next-intl, so it stopped before changing anything.`);
+  const only = found[0] ?? null;
+  if (only && !EXPORTS_HANDLER.test(only.text)) {
+    throw new UnsupportedError(`Convert could not find the middleware function exported from ${only.path}, so it stopped before changing anything.`);
+  }
+  return only;
 }
+var EXPORTS_HANDLER = /export\s+default\b|export\s+(?:async\s+)?function\s+(?:middleware|proxy)\b|export\s+(?:const|let|var)\s+(?:middleware|proxy)\b|export\s*\{[^}]*\b(?:middleware|proxy|default)\b[^}]*\}/;
+var movedMiddlewarePath = (base, existing) => `${base}app-middleware.${existing.split(".").pop()}`;
 var merge = (into, from) => {
   const out = { ...into };
   for (const [path, edits2] of Object.entries(from)) out[path] = [...out[path] ?? [], ...edits2];
@@ -1722,8 +1821,13 @@ function bilingualParts(project, appDir, files, paths) {
   const base = sourceBase(project);
   const { moves, keptPages } = routeMoves(appDir, paths);
   const middlewarePath = `${base}${nextMajor(files) >= 16 ? "proxy" : "middleware"}.ts`;
-  const middleware = middlewareFile(specifierTo(middlewarePath, `${base}i18n/routing.ts`));
-  guardMiddleware(base, middlewarePath, middleware, files);
+  const own = findMiddleware(base, files);
+  const routingSpec = specifierTo(middlewarePath, `${base}i18n/routing.ts`);
+  const ownMoved = own ? movedMiddlewarePath(base, own.path) : null;
+  if (ownMoved && files(ownMoved) !== null) {
+    throw new UnsupportedError(`This app already has ${ownMoved}. Convert needs that name for the app's own middleware, so move or remove that file and run convert again.`);
+  }
+  const middleware = ownMoved ? composedMiddlewareFile(routingSpec, specifierTo(middlewarePath, `${base}i18n/app-matcher.ts`), specifierTo(middlewarePath, ownMoved)) : middlewareFile(routingSpec);
   const catchAll = topCatchAll(appDir, moves, paths);
   const flags = keptPages.map((page) => flagAt(
     page,
@@ -1731,6 +1835,14 @@ function bilingualParts(project, appDir, files, paths) {
     `${page} stays outside [locale], because the middleware skips its path, so it has no Arabic version.`,
     "Move the page to a path the middleware matches, or translate it by hand."
   ));
+  if (own && ownMoved) {
+    flags.push(flagAt(
+      ownMoved,
+      "info",
+      `${own.path} moved to ${ownMoved}, and the new ${middlewarePath} runs it first on the path without its locale prefix, then next-intl.`,
+      "Check the app middleware still behaves as before and that its auth checks still hold under /ar. Any answer other than a plain continue (a redirect, rewrite or 401) is returned as it is. Paths under /api and /trpc skip next-intl. Config options other than matcher, such as runtime, are not carried over, and has or missing conditions on a matcher entry are ignored, so the middleware runs on those paths."
+    ));
+  }
   if (catchAll) {
     flags.push(flagAt(
       catchAll,
@@ -1743,11 +1855,13 @@ function bilingualParts(project, appDir, files, paths) {
     [`${base}i18n/routing.ts`]: ROUTING,
     [`${base}i18n/navigation.ts`]: NAVIGATION,
     [middlewarePath]: middleware,
+    ...own ? { [`${base}i18n/app-matcher.ts`]: APP_MATCHER } : {},
     [switchPath(project)]: switchFile(specifierTo(switchPath(project), `${base}i18n/navigation.ts`)),
     ...catchAll ? {} : { [`${appDir}/[locale]/[...rest]/page.tsx`]: CATCH_ALL }
   };
   const rewrites = importRewrites(appDir, moves, paths, files, readAliases(files));
-  return { moves, writes, flags: [...flags, ...rewrites.flags], edits: rewrites.edits };
+  const ownMove = own && ownMoved ? [[own.path, ownMoved]] : [];
+  return { moves: [...moves, ...ownMove], writes, flags: [...flags, ...rewrites.flags], edits: rewrites.edits };
 }
 function wireNextIntl(project, mode, files, paths) {
   const appDir = project.appDir ?? "app";
@@ -3077,7 +3191,18 @@ function pendingCheck(ledger, force) {
 }
 function writeMessages(root, ledger) {
   const disk = { root, created: [] };
-  for (const [path, text] of Object.entries(messagesFiles(ledger))) writeText(disk, path, text);
+  for (const [path, text] of Object.entries(messagesFiles(ledger))) writeText(disk, path, mergedMessages(root, path, text));
+}
+function mergedMessages(root, path, generated) {
+  const full = join11(root, path);
+  if (!existsSync8(full)) return generated;
+  try {
+    const existing = JSON.parse(readFileSync7(full, "utf8"));
+    if (typeof existing !== "object" || existing === null) return generated;
+    return JSON.stringify(keepHandAdded(existing, JSON.parse(generated)), null, 2) + "\n";
+  } catch {
+    return generated;
+  }
 }
 async function englishChecks(root, base, routes, shoot) {
   const english2 = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dualkit/convert",
-  "version": "0.1.0-beta.0",
+  "version": "0.2.0-beta.0",
   "description": "Converts an English React or Next.js app to Arabic on a new git branch.",
   "license": "MIT",
   "type": "module",