convex 1.42.2 → 1.43.0-alpha.0

package/dist/esm/cli/lib/typecheck.js

@@ -82,31 +82,7 @@ export async function typeCheckFunctions(ctx, typescriptCompiler, functionsDir,
   );
 }
 async function runTsc(ctx, typescriptCompiler, tscArgs, handleResult) {
-  let compilerPath;
-  switch (typescriptCompiler) {
-    case "tsgo": {
-      const tsgoPaths = ["tsgo", "tsgo.js"].map(
-        (filename) => path.join(
-          "node_modules",
-          "@typescript",
-          "native-preview",
-          "bin",
-          filename
-        )
-      );
-      compilerPath = tsgoPaths.find((path2) => ctx.fs.exists(path2));
-      break;
-    }
-    case "tsc": {
-      const tscPath = path.join("node_modules", "typescript", "bin", "tsc");
-      if (ctx.fs.exists(tscPath)) {
-        compilerPath = tscPath;
-      }
-      break;
-    }
-    default:
-      typescriptCompiler;
-  }
+  const compilerPath = findTypeScriptCompilerPath(ctx.fs, typescriptCompiler);
   if (!compilerPath) {
     return handleResult("cantTypeCheck", () => {
       logError(
@@ -131,6 +107,32 @@ async function runTsc(ctx, typescriptCompiler, tscArgs, handleResult) {
     );
   }
 }
+export function findTypeScriptCompilerPath(fs, typescriptCompiler) {
+  switch (typescriptCompiler) {
+    case "tsgo": {
+      const tsgoPaths = ["tsgo", "tsgo.js"].map(
+        (filename) => path.join(
+          "node_modules",
+          "@typescript",
+          "native-preview",
+          "bin",
+          filename
+        )
+      );
+      return tsgoPaths.find((path2) => fs.exists(path2));
+    }
+    case "tsc": {
+      const tscPaths = [
+        // TypeScript 7's recommended alias when the TypeScript 6 API is also installed.
+        path.join("node_modules", "@typescript", "native", "bin", "tsc"),
+        path.join("node_modules", "typescript", "bin", "tsc")
+      ];
+      return tscPaths.find((path2) => fs.exists(path2));
+    }
+    default:
+      typescriptCompiler;
+  }
+}
 async function runTscInner(ctx, tscPath, tscArgs, handleResult) {
   const result = await spawnAsync(ctx, process.execPath, [
     tscPath,

package/dist/esm/cli/lib/typecheck.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/cli/lib/typecheck.ts"],
-  "sourcesContent": ["import { chalkStderr } from \"chalk\";\nimport path from \"path\";\nimport { performance } from \"perf_hooks\";\nimport { Context } from \"../../bundler/context.js\";\nimport {\n  changeSpinner,\n  logError,\n  logFailure,\n  logMessage,\n  showSpinner,\n} from \"../../bundler/log.js\";\nimport * as Sentry from \"@sentry/node\";\nimport * as semver from \"semver\";\nimport { formatDuration, spawnAsync } from \"./utils/utils.js\";\nimport { readProjectConfig } from \"./config.js\";\nimport { WatchContext } from \"./watch.js\";\n\nexport type TypecheckResult = \"cantTypeCheck\" | \"success\" | \"typecheckFailed\";\n\nexport type TypeCheckMode = \"enable\" | \"try\" | \"disable\";\n\nexport type TypescriptCompiler = \"tsc\" | \"tsgo\";\n\nconst SLOW_TYPECHECK_THRESHOLD_MS = 10_000;\nconst SLOW_TYPECHECK_DOCS_URL =\n  \"https://docs.convex.dev/cli/troubleshooting/typecheck-performance\";\n\n/**\n * Resolves the TypeScript compiler to use based on CLI flag, config file, and default.\n * Precedence: CLI flag \u2192 config file \u2192 default \"tsc\"\n */\nexport async function resolveTypescriptCompiler(\n  ctx: Context,\n  cliOption?: TypescriptCompiler,\n): Promise<TypescriptCompiler> {\n  const { projectConfig } = await readProjectConfig(ctx);\n  return cliOption ?? projectConfig?.typescriptCompiler ?? \"tsc\";\n}\n\ntype TypecheckResultHandler = (\n  result: TypecheckResult,\n  logSpecificError?: () => void,\n  // If given, we run it to print out errors.\n  // We expect it to throw or resolve to \"success\"\n  // if a concurrent change invalidated the error result.\n  runOnError?: () => Promise<\"success\">,\n) => Promise<void>;\n\n/**\n * Conditionally run a typecheck function and interpret the result.\n *\n * If typeCheckMode === \"disable\", never run the typecheck function.\n * If typeCheckMode === \"enable\", run the typecheck and crash if typechecking\n * fails or we can't find tsc.\n * If typeCheckMode === \"try\", try and run the typecheck. crash if typechecking\n * fails but don't worry if tsc is missing and we can't run it.\n */\nexport async function typeCheckFunctionsInMode(\n  ctx: Context,\n  typeCheckMode: TypeCheckMode,\n  functionsDir: string,\n): Promise<void> {\n  if (typeCheckMode === \"disable\") {\n    return;\n  }\n  const typescriptCompiler = await resolveTypescriptCompiler(ctx);\n  const typecheckStart = performance.now();\n  const slowTypecheckTimeout = setTimeout(() => {\n    changeSpinner(\n      `Still running TypeScript... see ${SLOW_TYPECHECK_DOCS_URL} to troubleshoot.`,\n    );\n  }, SLOW_TYPECHECK_THRESHOLD_MS);\n  try {\n    await typeCheckFunctions(\n      ctx,\n      typescriptCompiler,\n      functionsDir,\n      async (result, logSpecificError, runOnError) => {\n        if (\n          (result === \"cantTypeCheck\" && typeCheckMode === \"enable\") ||\n          result === \"typecheckFailed\"\n        ) {\n          logSpecificError?.();\n          logError(\n            chalkStderr.gray(\n              \"To ignore failing typecheck, use `--typecheck=disable`.\",\n            ),\n          );\n          try {\n            const result = await runOnError?.();\n            // Concurrent change invalidated the error, don't fail\n            if (result === \"success\") {\n              return;\n            }\n          } catch {\n            // As expected, `runOnError` threw\n          }\n          await ctx.crash({\n            exitCode: 1,\n            errorType: \"invalid filesystem data\",\n            printedMessage: null,\n          });\n        }\n      },\n    );\n  } finally {\n    clearTimeout(slowTypecheckTimeout);\n  }\n  maybeLogSlowTypecheckSuggestion(ctx, performance.now() - typecheckStart);\n}\n\n// Runs TypeScript compiler to typecheck Convex query and mutation functions.\nexport async function typeCheckFunctions(\n  ctx: Context,\n  typescriptCompiler: TypescriptCompiler,\n  functionsDir: string,\n  handleResult: TypecheckResultHandler,\n): Promise<void> {\n  const tsconfig = path.join(functionsDir, \"tsconfig.json\");\n  if (!ctx.fs.exists(tsconfig)) {\n    return handleResult(\"cantTypeCheck\", () => {\n      logError(\n        \"Found no convex/tsconfig.json to use to typecheck Convex functions, so skipping typecheck.\",\n      );\n      logError(\"Run `npx convex codegen --init` to create one.\");\n    });\n  }\n  await runTsc(\n    ctx,\n    typescriptCompiler,\n    [\"--project\", functionsDir],\n    handleResult,\n  );\n}\n\nasync function runTsc(\n  ctx: Context,\n  typescriptCompiler: TypescriptCompiler,\n  tscArgs: string[],\n  handleResult: TypecheckResultHandler,\n): Promise<void> {\n  // Check if the TypeScript compiler is even installed\n  let compilerPath: string | undefined;\n  switch (typescriptCompiler) {\n    case \"tsgo\": {\n      // @typescript/native-preview@7.0.0-dev.20260626.1 switched to using `bin/tsgo` instead of `bin/tsgo.js`.\n      const tsgoPaths = [\"tsgo\", \"tsgo.js\"].map((filename) =>\n        path.join(\n          \"node_modules\",\n          \"@typescript\",\n          \"native-preview\",\n          \"bin\",\n          filename,\n        ),\n      );\n      compilerPath = tsgoPaths.find((path) => ctx.fs.exists(path));\n      break;\n    }\n    case \"tsc\": {\n      const tscPath = path.join(\"node_modules\", \"typescript\", \"bin\", \"tsc\");\n      if (ctx.fs.exists(tscPath)) {\n        compilerPath = tscPath;\n      }\n      break;\n    }\n    default:\n      typescriptCompiler satisfies never;\n  }\n  if (!compilerPath) {\n    return handleResult(\"cantTypeCheck\", () => {\n      logError(\n        chalkStderr.gray(\n          `No \\`${typescriptCompiler}\\` binary found, so skipping typecheck.`,\n        ),\n      );\n    });\n  }\n\n  // Check the TypeScript version matches the recommendation from Convex\n  const versionResult = await spawnAsync(ctx, process.execPath, [\n    compilerPath,\n    \"--version\",\n  ]);\n\n  const version = versionResult.stdout.match(/Version (.*)/)?.[1] ?? null;\n  const hasOlderTypeScriptVersion = version && semver.lt(version, \"4.8.4\");\n\n  await runTscInner(ctx, compilerPath, tscArgs, handleResult);\n\n  // Print this warning after any logs from running `tsc`\n  if (hasOlderTypeScriptVersion) {\n    logError(\n      chalkStderr.yellow(\n        \"Convex works best with TypeScript version 4.8.4 or newer -- npm i --save-dev typescript@latest to update.\",\n      ),\n    );\n  }\n}\n\nasync function runTscInner(\n  ctx: Context,\n  tscPath: string,\n  tscArgs: string[],\n  handleResult: TypecheckResultHandler,\n) {\n  // Run `tsc` once and have it print out the files it touched. This output won't\n  // be very useful if there's an error, but we'll run it again to get a nice\n  // user-facing error in this exceptional case.\n  // The `--listFiles` command prints out files touched on success or error.\n  const result = await spawnAsync(ctx, process.execPath, [\n    tscPath,\n    ...tscArgs,\n    \"--listFiles\",\n  ]);\n  if (result.status === null) {\n    return handleResult(\"typecheckFailed\", () => {\n      logFailure(`TypeScript typecheck timed out.`);\n      if (result.error) {\n        logError(chalkStderr.red(`${result.error.toString()}`));\n      }\n    });\n  }\n  // Okay, we may have failed `tsc` but at least it returned. Try to parse its\n  // output to discover which files it touched.\n  const filesTouched = result.stdout\n    .split(\"\\n\")\n    .map((s) => s.trim())\n    .filter((s) => s.length > 0);\n  let anyPathsFound = false;\n  for (const fileTouched of filesTouched) {\n    const absPath = path.resolve(fileTouched);\n    let st;\n    try {\n      st = ctx.fs.stat(absPath);\n      anyPathsFound = true;\n    } catch {\n      // Just move on if we have a bogus path from `tsc`. We'll log below if\n      // we fail to stat *any* of the paths emitted by `tsc`.\n      // TODO: Switch to using their JS API so we can get machine readable output.\n      continue;\n    }\n    ctx.fs.registerPath(absPath, st);\n  }\n  if (filesTouched.length > 0 && !anyPathsFound) {\n    const err = new Error(\n      `Failed to stat any files emitted by tsc (received ${filesTouched.length})`,\n    );\n    Sentry.captureException(err);\n  }\n\n  if (!result.error && result.status === 0) {\n    return handleResult(\"success\");\n  }\n\n  // This is the \"No inputs were found\", which is fine and we shouldn't\n  // report it to the user.\n  if (result.stdout.startsWith(\"error TS18003\")) {\n    return handleResult(\"success\");\n  }\n\n  // At this point we know that `tsc` failed. Rerun it without `--listFiles`\n  // and with stderr redirected to have it print out a nice error.\n  return handleResult(\n    \"typecheckFailed\",\n    () => {\n      logFailure(\"TypeScript typecheck via `tsc` failed.\");\n    },\n    async () => {\n      showSpinner(\"Collecting TypeScript errors\");\n      await spawnAsync(\n        ctx,\n        process.execPath,\n        [tscPath, ...tscArgs, \"--pretty\", \"true\"],\n        {\n          stdio: \"inherit\",\n        },\n      );\n      // If this passes, we had a concurrent file change that'll overlap with\n      // our observations in the first run. Invalidate our context's filesystem\n      // but allow the rest of the system to observe the success.\n      ctx.fs.invalidate();\n      return \"success\";\n    },\n  );\n}\n\nfunction maybeLogSlowTypecheckSuggestion(ctx: Context, durationMs: number) {\n  if (!(ctx instanceof WatchContext)) {\n    return;\n  }\n  if (!ctx.isFirstPush) {\n    return;\n  }\n  if (durationMs <= SLOW_TYPECHECK_THRESHOLD_MS) {\n    return;\n  }\n  const formattedDuration = formatDuration(durationMs);\n  logMessage(\n    chalkStderr.gray(\n      `Typechecking took ${formattedDuration}. For faster iteration, see ${SLOW_TYPECHECK_DOCS_URL} to troubleshoot typecheck performance.`,\n    ),\n  );\n}\n"],
-  "mappings": ";AAAA,SAAS,mBAAmB;AAC5B,OAAO,UAAU;AACjB,SAAS,mBAAmB;AAE5B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,YAAY,YAAY;AACxB,YAAY,YAAY;AACxB,SAAS,gBAAgB,kBAAkB;AAC3C,SAAS,yBAAyB;AAClC,SAAS,oBAAoB;AAQ7B,MAAM,8BAA8B;AACpC,MAAM,0BACJ;AAMF,sBAAsB,0BACpB,KACA,WAC6B;AAC7B,QAAM,EAAE,cAAc,IAAI,MAAM,kBAAkB,GAAG;AACrD,SAAO,aAAa,eAAe,sBAAsB;AAC3D;AAoBA,sBAAsB,yBACpB,KACA,eACA,cACe;AACf,MAAI,kBAAkB,WAAW;AAC/B;AAAA,EACF;AACA,QAAM,qBAAqB,MAAM,0BAA0B,GAAG;AAC9D,QAAM,iBAAiB,YAAY,IAAI;AACvC,QAAM,uBAAuB,WAAW,MAAM;AAC5C;AAAA,MACE,mCAAmC,uBAAuB;AAAA,IAC5D;AAAA,EACF,GAAG,2BAA2B;AAC9B,MAAI;AACF,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO,QAAQ,kBAAkB,eAAe;AAC9C,YACG,WAAW,mBAAmB,kBAAkB,YACjD,WAAW,mBACX;AACA,6BAAmB;AACnB;AAAA,YACE,YAAY;AAAA,cACV;AAAA,YACF;AAAA,UACF;AACA,cAAI;AACF,kBAAMA,UAAS,MAAM,aAAa;AAElC,gBAAIA,YAAW,WAAW;AACxB;AAAA,YACF;AAAA,UACF,QAAQ;AAAA,UAER;AACA,gBAAM,IAAI,MAAM;AAAA,YACd,UAAU;AAAA,YACV,WAAW;AAAA,YACX,gBAAgB;AAAA,UAClB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF,UAAE;AACA,iBAAa,oBAAoB;AAAA,EACnC;AACA,kCAAgC,KAAK,YAAY,IAAI,IAAI,cAAc;AACzE;AAGA,sBAAsB,mBACpB,KACA,oBACA,cACA,cACe;AACf,QAAM,WAAW,KAAK,KAAK,cAAc,eAAe;AACxD,MAAI,CAAC,IAAI,GAAG,OAAO,QAAQ,GAAG;AAC5B,WAAO,aAAa,iBAAiB,MAAM;AACzC;AAAA,QACE;AAAA,MACF;AACA,eAAS,gDAAgD;AAAA,IAC3D,CAAC;AAAA,EACH;AACA,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA,CAAC,aAAa,YAAY;AAAA,IAC1B;AAAA,EACF;AACF;AAEA,eAAe,OACb,KACA,oBACA,SACA,cACe;AAEf,MAAI;AACJ,UAAQ,oBAAoB;AAAA,IAC1B,KAAK,QAAQ;AAEX,YAAM,YAAY,CAAC,QAAQ,SAAS,EAAE;AAAA,QAAI,CAAC,aACzC,KAAK;AAAA,UACH;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AACA,qBAAe,UAAU,KAAK,CAACC,UAAS,IAAI,GAAG,OAAOA,KAAI,CAAC;AAC3D;AAAA,IACF;AAAA,IACA,KAAK,OAAO;AACV,YAAM,UAAU,KAAK,KAAK,gBAAgB,cAAc,OAAO,KAAK;AACpE,UAAI,IAAI,GAAG,OAAO,OAAO,GAAG;AAC1B,uBAAe;AAAA,MACjB;AACA;AAAA,IACF;AAAA,IACA;AACE;AAAA,EACJ;AACA,MAAI,CAAC,cAAc;AACjB,WAAO,aAAa,iBAAiB,MAAM;AACzC;AAAA,QACE,YAAY;AAAA,UACV,QAAQ,kBAAkB;AAAA,QAC5B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAGA,QAAM,gBAAgB,MAAM,WAAW,KAAK,QAAQ,UAAU;AAAA,IAC5D;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,UAAU,cAAc,OAAO,MAAM,cAAc,IAAI,CAAC,KAAK;AACnE,QAAM,4BAA4B,WAAW,OAAO,GAAG,SAAS,OAAO;AAEvE,QAAM,YAAY,KAAK,cAAc,SAAS,YAAY;AAG1D,MAAI,2BAA2B;AAC7B;AAAA,MACE,YAAY;AAAA,QACV;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAEA,eAAe,YACb,KACA,SACA,SACA,cACA;AAKA,QAAM,SAAS,MAAM,WAAW,KAAK,QAAQ,UAAU;AAAA,IACrD;AAAA,IACA,GAAG;AAAA,IACH;AAAA,EACF,CAAC;AACD,MAAI,OAAO,WAAW,MAAM;AAC1B,WAAO,aAAa,mBAAmB,MAAM;AAC3C,iBAAW,iCAAiC;AAC5C,UAAI,OAAO,OAAO;AAChB,iBAAS,YAAY,IAAI,GAAG,OAAO,MAAM,SAAS,CAAC,EAAE,CAAC;AAAA,MACxD;AAAA,IACF,CAAC;AAAA,EACH;AAGA,QAAM,eAAe,OAAO,OACzB,MAAM,IAAI,EACV,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EACnB,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC;AAC7B,MAAI,gBAAgB;AACpB,aAAW,eAAe,cAAc;AACtC,UAAM,UAAU,KAAK,QAAQ,WAAW;AACxC,QAAI;AACJ,QAAI;AACF,WAAK,IAAI,GAAG,KAAK,OAAO;AACxB,sBAAgB;AAAA,IAClB,QAAQ;AAIN;AAAA,IACF;AACA,QAAI,GAAG,aAAa,SAAS,EAAE;AAAA,EACjC;AACA,MAAI,aAAa,SAAS,KAAK,CAAC,eAAe;AAC7C,UAAM,MAAM,IAAI;AAAA,MACd,qDAAqD,aAAa,MAAM;AAAA,IAC1E;AACA,WAAO,iBAAiB,GAAG;AAAA,EAC7B;AAEA,MAAI,CAAC,OAAO,SAAS,OAAO,WAAW,GAAG;AACxC,WAAO,aAAa,SAAS;AAAA,EAC/B;AAIA,MAAI,OAAO,OAAO,WAAW,eAAe,GAAG;AAC7C,WAAO,aAAa,SAAS;AAAA,EAC/B;AAIA,SAAO;AAAA,IACL;AAAA,IACA,MAAM;AACJ,iBAAW,wCAAwC;AAAA,IACrD;AAAA,IACA,YAAY;AACV,kBAAY,8BAA8B;AAC1C,YAAM;AAAA,QACJ;AAAA,QACA,QAAQ;AAAA,QACR,CAAC,SAAS,GAAG,SAAS,YAAY,MAAM;AAAA,QACxC;AAAA,UACE,OAAO;AAAA,QACT;AAAA,MACF;AAIA,UAAI,GAAG,WAAW;AAClB,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEA,SAAS,gCAAgC,KAAc,YAAoB;AACzE,MAAI,EAAE,eAAe,eAAe;AAClC;AAAA,EACF;AACA,MAAI,CAAC,IAAI,aAAa;AACpB;AAAA,EACF;AACA,MAAI,cAAc,6BAA6B;AAC7C;AAAA,EACF;AACA,QAAM,oBAAoB,eAAe,UAAU;AACnD;AAAA,IACE,YAAY;AAAA,MACV,qBAAqB,iBAAiB,+BAA+B,uBAAuB;AAAA,IAC9F;AAAA,EACF;AACF;",
+  "sourcesContent": ["import { chalkStderr } from \"chalk\";\nimport path from \"path\";\nimport { performance } from \"perf_hooks\";\nimport { Context } from \"../../bundler/context.js\";\nimport {\n  changeSpinner,\n  logError,\n  logFailure,\n  logMessage,\n  showSpinner,\n} from \"../../bundler/log.js\";\nimport * as Sentry from \"@sentry/node\";\nimport * as semver from \"semver\";\nimport { formatDuration, spawnAsync } from \"./utils/utils.js\";\nimport { readProjectConfig } from \"./config.js\";\nimport { WatchContext } from \"./watch.js\";\nimport { Filesystem } from \"../../bundler/fs.js\";\n\nexport type TypecheckResult = \"cantTypeCheck\" | \"success\" | \"typecheckFailed\";\n\nexport type TypeCheckMode = \"enable\" | \"try\" | \"disable\";\n\nexport type TypescriptCompiler = \"tsc\" | \"tsgo\";\n\nconst SLOW_TYPECHECK_THRESHOLD_MS = 10_000;\nconst SLOW_TYPECHECK_DOCS_URL =\n  \"https://docs.convex.dev/cli/troubleshooting/typecheck-performance\";\n\n/**\n * Resolves the TypeScript compiler to use based on CLI flag, config file, and default.\n * Precedence: CLI flag \u2192 config file \u2192 default \"tsc\"\n */\nexport async function resolveTypescriptCompiler(\n  ctx: Context,\n  cliOption?: TypescriptCompiler,\n): Promise<TypescriptCompiler> {\n  const { projectConfig } = await readProjectConfig(ctx);\n  return cliOption ?? projectConfig?.typescriptCompiler ?? \"tsc\";\n}\n\ntype TypecheckResultHandler = (\n  result: TypecheckResult,\n  logSpecificError?: () => void,\n  // If given, we run it to print out errors.\n  // We expect it to throw or resolve to \"success\"\n  // if a concurrent change invalidated the error result.\n  runOnError?: () => Promise<\"success\">,\n) => Promise<void>;\n\n/**\n * Conditionally run a typecheck function and interpret the result.\n *\n * If typeCheckMode === \"disable\", never run the typecheck function.\n * If typeCheckMode === \"enable\", run the typecheck and crash if typechecking\n * fails or we can't find tsc.\n * If typeCheckMode === \"try\", try and run the typecheck. crash if typechecking\n * fails but don't worry if tsc is missing and we can't run it.\n */\nexport async function typeCheckFunctionsInMode(\n  ctx: Context,\n  typeCheckMode: TypeCheckMode,\n  functionsDir: string,\n): Promise<void> {\n  if (typeCheckMode === \"disable\") {\n    return;\n  }\n  const typescriptCompiler = await resolveTypescriptCompiler(ctx);\n  const typecheckStart = performance.now();\n  const slowTypecheckTimeout = setTimeout(() => {\n    changeSpinner(\n      `Still running TypeScript... see ${SLOW_TYPECHECK_DOCS_URL} to troubleshoot.`,\n    );\n  }, SLOW_TYPECHECK_THRESHOLD_MS);\n  try {\n    await typeCheckFunctions(\n      ctx,\n      typescriptCompiler,\n      functionsDir,\n      async (result, logSpecificError, runOnError) => {\n        if (\n          (result === \"cantTypeCheck\" && typeCheckMode === \"enable\") ||\n          result === \"typecheckFailed\"\n        ) {\n          logSpecificError?.();\n          logError(\n            chalkStderr.gray(\n              \"To ignore failing typecheck, use `--typecheck=disable`.\",\n            ),\n          );\n          try {\n            const result = await runOnError?.();\n            // Concurrent change invalidated the error, don't fail\n            if (result === \"success\") {\n              return;\n            }\n          } catch {\n            // As expected, `runOnError` threw\n          }\n          await ctx.crash({\n            exitCode: 1,\n            errorType: \"invalid filesystem data\",\n            printedMessage: null,\n          });\n        }\n      },\n    );\n  } finally {\n    clearTimeout(slowTypecheckTimeout);\n  }\n  maybeLogSlowTypecheckSuggestion(ctx, performance.now() - typecheckStart);\n}\n\n// Runs TypeScript compiler to typecheck Convex query and mutation functions.\nexport async function typeCheckFunctions(\n  ctx: Context,\n  typescriptCompiler: TypescriptCompiler,\n  functionsDir: string,\n  handleResult: TypecheckResultHandler,\n): Promise<void> {\n  const tsconfig = path.join(functionsDir, \"tsconfig.json\");\n  if (!ctx.fs.exists(tsconfig)) {\n    return handleResult(\"cantTypeCheck\", () => {\n      logError(\n        \"Found no convex/tsconfig.json to use to typecheck Convex functions, so skipping typecheck.\",\n      );\n      logError(\"Run `npx convex codegen --init` to create one.\");\n    });\n  }\n  await runTsc(\n    ctx,\n    typescriptCompiler,\n    [\"--project\", functionsDir],\n    handleResult,\n  );\n}\n\nasync function runTsc(\n  ctx: Context,\n  typescriptCompiler: TypescriptCompiler,\n  tscArgs: string[],\n  handleResult: TypecheckResultHandler,\n): Promise<void> {\n  const compilerPath = findTypeScriptCompilerPath(ctx.fs, typescriptCompiler);\n  if (!compilerPath) {\n    return handleResult(\"cantTypeCheck\", () => {\n      logError(\n        chalkStderr.gray(\n          `No \\`${typescriptCompiler}\\` binary found, so skipping typecheck.`,\n        ),\n      );\n    });\n  }\n\n  // Check the TypeScript version matches the recommendation from Convex\n  const versionResult = await spawnAsync(ctx, process.execPath, [\n    compilerPath,\n    \"--version\",\n  ]);\n\n  const version = versionResult.stdout.match(/Version (.*)/)?.[1] ?? null;\n  const hasOlderTypeScriptVersion = version && semver.lt(version, \"4.8.4\");\n\n  await runTscInner(ctx, compilerPath, tscArgs, handleResult);\n\n  // Print this warning after any logs from running `tsc`\n  if (hasOlderTypeScriptVersion) {\n    logError(\n      chalkStderr.yellow(\n        \"Convex works best with TypeScript version 4.8.4 or newer -- npm i --save-dev typescript@latest to update.\",\n      ),\n    );\n  }\n}\n\nexport function findTypeScriptCompilerPath(\n  fs: Pick<Filesystem, \"exists\">,\n  typescriptCompiler: TypescriptCompiler,\n): string | undefined {\n  switch (typescriptCompiler) {\n    case \"tsgo\": {\n      // @typescript/native-preview@7.0.0-dev.20260626.1 switched to using `bin/tsgo` instead of `bin/tsgo.js`.\n      const tsgoPaths = [\"tsgo\", \"tsgo.js\"].map((filename) =>\n        path.join(\n          \"node_modules\",\n          \"@typescript\",\n          \"native-preview\",\n          \"bin\",\n          filename,\n        ),\n      );\n      return tsgoPaths.find((path) => fs.exists(path));\n    }\n    case \"tsc\": {\n      const tscPaths = [\n        // TypeScript 7's recommended alias when the TypeScript 6 API is also installed.\n        path.join(\"node_modules\", \"@typescript\", \"native\", \"bin\", \"tsc\"),\n        path.join(\"node_modules\", \"typescript\", \"bin\", \"tsc\"),\n      ];\n      return tscPaths.find((path) => fs.exists(path));\n    }\n    default:\n      typescriptCompiler satisfies never;\n  }\n}\n\nasync function runTscInner(\n  ctx: Context,\n  tscPath: string,\n  tscArgs: string[],\n  handleResult: TypecheckResultHandler,\n) {\n  // Run `tsc` once and have it print out the files it touched. This output won't\n  // be very useful if there's an error, but we'll run it again to get a nice\n  // user-facing error in this exceptional case.\n  // The `--listFiles` command prints out files touched on success or error.\n  const result = await spawnAsync(ctx, process.execPath, [\n    tscPath,\n    ...tscArgs,\n    \"--listFiles\",\n  ]);\n  if (result.status === null) {\n    return handleResult(\"typecheckFailed\", () => {\n      logFailure(`TypeScript typecheck timed out.`);\n      if (result.error) {\n        logError(chalkStderr.red(`${result.error.toString()}`));\n      }\n    });\n  }\n  // Okay, we may have failed `tsc` but at least it returned. Try to parse its\n  // output to discover which files it touched.\n  const filesTouched = result.stdout\n    .split(\"\\n\")\n    .map((s) => s.trim())\n    .filter((s) => s.length > 0);\n  let anyPathsFound = false;\n  for (const fileTouched of filesTouched) {\n    const absPath = path.resolve(fileTouched);\n    let st;\n    try {\n      st = ctx.fs.stat(absPath);\n      anyPathsFound = true;\n    } catch {\n      // Just move on if we have a bogus path from `tsc`. We'll log below if\n      // we fail to stat *any* of the paths emitted by `tsc`.\n      // TODO: Switch to using their JS API so we can get machine readable output.\n      continue;\n    }\n    ctx.fs.registerPath(absPath, st);\n  }\n  if (filesTouched.length > 0 && !anyPathsFound) {\n    const err = new Error(\n      `Failed to stat any files emitted by tsc (received ${filesTouched.length})`,\n    );\n    Sentry.captureException(err);\n  }\n\n  if (!result.error && result.status === 0) {\n    return handleResult(\"success\");\n  }\n\n  // This is the \"No inputs were found\", which is fine and we shouldn't\n  // report it to the user.\n  if (result.stdout.startsWith(\"error TS18003\")) {\n    return handleResult(\"success\");\n  }\n\n  // At this point we know that `tsc` failed. Rerun it without `--listFiles`\n  // and with stderr redirected to have it print out a nice error.\n  return handleResult(\n    \"typecheckFailed\",\n    () => {\n      logFailure(\"TypeScript typecheck via `tsc` failed.\");\n    },\n    async () => {\n      showSpinner(\"Collecting TypeScript errors\");\n      await spawnAsync(\n        ctx,\n        process.execPath,\n        [tscPath, ...tscArgs, \"--pretty\", \"true\"],\n        {\n          stdio: \"inherit\",\n        },\n      );\n      // If this passes, we had a concurrent file change that'll overlap with\n      // our observations in the first run. Invalidate our context's filesystem\n      // but allow the rest of the system to observe the success.\n      ctx.fs.invalidate();\n      return \"success\";\n    },\n  );\n}\n\nfunction maybeLogSlowTypecheckSuggestion(ctx: Context, durationMs: number) {\n  if (!(ctx instanceof WatchContext)) {\n    return;\n  }\n  if (!ctx.isFirstPush) {\n    return;\n  }\n  if (durationMs <= SLOW_TYPECHECK_THRESHOLD_MS) {\n    return;\n  }\n  const formattedDuration = formatDuration(durationMs);\n  logMessage(\n    chalkStderr.gray(\n      `Typechecking took ${formattedDuration}. For faster iteration, see ${SLOW_TYPECHECK_DOCS_URL} to troubleshoot typecheck performance.`,\n    ),\n  );\n}\n"],
+  "mappings": ";AAAA,SAAS,mBAAmB;AAC5B,OAAO,UAAU;AACjB,SAAS,mBAAmB;AAE5B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,YAAY,YAAY;AACxB,YAAY,YAAY;AACxB,SAAS,gBAAgB,kBAAkB;AAC3C,SAAS,yBAAyB;AAClC,SAAS,oBAAoB;AAS7B,MAAM,8BAA8B;AACpC,MAAM,0BACJ;AAMF,sBAAsB,0BACpB,KACA,WAC6B;AAC7B,QAAM,EAAE,cAAc,IAAI,MAAM,kBAAkB,GAAG;AACrD,SAAO,aAAa,eAAe,sBAAsB;AAC3D;AAoBA,sBAAsB,yBACpB,KACA,eACA,cACe;AACf,MAAI,kBAAkB,WAAW;AAC/B;AAAA,EACF;AACA,QAAM,qBAAqB,MAAM,0BAA0B,GAAG;AAC9D,QAAM,iBAAiB,YAAY,IAAI;AACvC,QAAM,uBAAuB,WAAW,MAAM;AAC5C;AAAA,MACE,mCAAmC,uBAAuB;AAAA,IAC5D;AAAA,EACF,GAAG,2BAA2B;AAC9B,MAAI;AACF,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO,QAAQ,kBAAkB,eAAe;AAC9C,YACG,WAAW,mBAAmB,kBAAkB,YACjD,WAAW,mBACX;AACA,6BAAmB;AACnB;AAAA,YACE,YAAY;AAAA,cACV;AAAA,YACF;AAAA,UACF;AACA,cAAI;AACF,kBAAMA,UAAS,MAAM,aAAa;AAElC,gBAAIA,YAAW,WAAW;AACxB;AAAA,YACF;AAAA,UACF,QAAQ;AAAA,UAER;AACA,gBAAM,IAAI,MAAM;AAAA,YACd,UAAU;AAAA,YACV,WAAW;AAAA,YACX,gBAAgB;AAAA,UAClB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF,UAAE;AACA,iBAAa,oBAAoB;AAAA,EACnC;AACA,kCAAgC,KAAK,YAAY,IAAI,IAAI,cAAc;AACzE;AAGA,sBAAsB,mBACpB,KACA,oBACA,cACA,cACe;AACf,QAAM,WAAW,KAAK,KAAK,cAAc,eAAe;AACxD,MAAI,CAAC,IAAI,GAAG,OAAO,QAAQ,GAAG;AAC5B,WAAO,aAAa,iBAAiB,MAAM;AACzC;AAAA,QACE;AAAA,MACF;AACA,eAAS,gDAAgD;AAAA,IAC3D,CAAC;AAAA,EACH;AACA,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA,CAAC,aAAa,YAAY;AAAA,IAC1B;AAAA,EACF;AACF;AAEA,eAAe,OACb,KACA,oBACA,SACA,cACe;AACf,QAAM,eAAe,2BAA2B,IAAI,IAAI,kBAAkB;AAC1E,MAAI,CAAC,cAAc;AACjB,WAAO,aAAa,iBAAiB,MAAM;AACzC;AAAA,QACE,YAAY;AAAA,UACV,QAAQ,kBAAkB;AAAA,QAC5B;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAGA,QAAM,gBAAgB,MAAM,WAAW,KAAK,QAAQ,UAAU;AAAA,IAC5D;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,UAAU,cAAc,OAAO,MAAM,cAAc,IAAI,CAAC,KAAK;AACnE,QAAM,4BAA4B,WAAW,OAAO,GAAG,SAAS,OAAO;AAEvE,QAAM,YAAY,KAAK,cAAc,SAAS,YAAY;AAG1D,MAAI,2BAA2B;AAC7B;AAAA,MACE,YAAY;AAAA,QACV;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAEO,gBAAS,2BACd,IACA,oBACoB;AACpB,UAAQ,oBAAoB;AAAA,IAC1B,KAAK,QAAQ;AAEX,YAAM,YAAY,CAAC,QAAQ,SAAS,EAAE;AAAA,QAAI,CAAC,aACzC,KAAK;AAAA,UACH;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AACA,aAAO,UAAU,KAAK,CAACC,UAAS,GAAG,OAAOA,KAAI,CAAC;AAAA,IACjD;AAAA,IACA,KAAK,OAAO;AACV,YAAM,WAAW;AAAA;AAAA,QAEf,KAAK,KAAK,gBAAgB,eAAe,UAAU,OAAO,KAAK;AAAA,QAC/D,KAAK,KAAK,gBAAgB,cAAc,OAAO,KAAK;AAAA,MACtD;AACA,aAAO,SAAS,KAAK,CAACA,UAAS,GAAG,OAAOA,KAAI,CAAC;AAAA,IAChD;AAAA,IACA;AACE;AAAA,EACJ;AACF;AAEA,eAAe,YACb,KACA,SACA,SACA,cACA;AAKA,QAAM,SAAS,MAAM,WAAW,KAAK,QAAQ,UAAU;AAAA,IACrD;AAAA,IACA,GAAG;AAAA,IACH;AAAA,EACF,CAAC;AACD,MAAI,OAAO,WAAW,MAAM;AAC1B,WAAO,aAAa,mBAAmB,MAAM;AAC3C,iBAAW,iCAAiC;AAC5C,UAAI,OAAO,OAAO;AAChB,iBAAS,YAAY,IAAI,GAAG,OAAO,MAAM,SAAS,CAAC,EAAE,CAAC;AAAA,MACxD;AAAA,IACF,CAAC;AAAA,EACH;AAGA,QAAM,eAAe,OAAO,OACzB,MAAM,IAAI,EACV,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EACnB,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC;AAC7B,MAAI,gBAAgB;AACpB,aAAW,eAAe,cAAc;AACtC,UAAM,UAAU,KAAK,QAAQ,WAAW;AACxC,QAAI;AACJ,QAAI;AACF,WAAK,IAAI,GAAG,KAAK,OAAO;AACxB,sBAAgB;AAAA,IAClB,QAAQ;AAIN;AAAA,IACF;AACA,QAAI,GAAG,aAAa,SAAS,EAAE;AAAA,EACjC;AACA,MAAI,aAAa,SAAS,KAAK,CAAC,eAAe;AAC7C,UAAM,MAAM,IAAI;AAAA,MACd,qDAAqD,aAAa,MAAM;AAAA,IAC1E;AACA,WAAO,iBAAiB,GAAG;AAAA,EAC7B;AAEA,MAAI,CAAC,OAAO,SAAS,OAAO,WAAW,GAAG;AACxC,WAAO,aAAa,SAAS;AAAA,EAC/B;AAIA,MAAI,OAAO,OAAO,WAAW,eAAe,GAAG;AAC7C,WAAO,aAAa,SAAS;AAAA,EAC/B;AAIA,SAAO;AAAA,IACL;AAAA,IACA,MAAM;AACJ,iBAAW,wCAAwC;AAAA,IACrD;AAAA,IACA,YAAY;AACV,kBAAY,8BAA8B;AAC1C,YAAM;AAAA,QACJ;AAAA,QACA,QAAQ;AAAA,QACR,CAAC,SAAS,GAAG,SAAS,YAAY,MAAM;AAAA,QACxC;AAAA,UACE,OAAO;AAAA,QACT;AAAA,MACF;AAIA,UAAI,GAAG,WAAW;AAClB,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEA,SAAS,gCAAgC,KAAc,YAAoB;AACzE,MAAI,EAAE,eAAe,eAAe;AAClC;AAAA,EACF;AACA,MAAI,CAAC,IAAI,aAAa;AACpB;AAAA,EACF;AACA,MAAI,cAAc,6BAA6B;AAC7C;AAAA,EACF;AACA,QAAM,oBAAoB,eAAe,UAAU;AACnD;AAAA,IACE,YAAY;AAAA,MACV,qBAAqB,iBAAiB,+BAA+B,uBAAuB;AAAA,IAC9F;AAAA,EACF;AACF;",
   "names": ["result", "path"]
 }

package/dist/esm/cli/lib/usageLimits.js

@@ -0,0 +1,129 @@
+"use strict";
+import { deploymentFetch, logAndHandleFetchError } from "./utils/utils.js";
+export const USAGE_LIMIT_METRICS = [
+  "functionCalls",
+  "queryMutationComputeGbHours",
+  "actionComputeConvexGbHours",
+  "actionComputeNodeJsGbHours",
+  "actionComputeCpuGbHours",
+  "databaseIoGb",
+  "searchQueryGb",
+  "dataEgressGb"
+];
+const _metricsExhaustive = true;
+void _metricsExhaustive;
+export const USAGE_LIMIT_WINDOWS = ["day", "month"];
+export const USAGE_LIMIT_TYPES = ["warning", "disable"];
+export const METRIC_LABELS = {
+  functionCalls: "Function calls",
+  queryMutationComputeGbHours: "Query/Mutation compute",
+  actionComputeConvexGbHours: "Action compute",
+  actionComputeNodeJsGbHours: "Action compute (Node.js)",
+  actionComputeCpuGbHours: "Action compute (CPU)",
+  databaseIoGb: "Database I/O",
+  searchQueryGb: "Search queries",
+  dataEgressGb: "Data egress"
+};
+export function metricLabel(metric) {
+  return METRIC_LABELS[metric] ?? metric;
+}
+async function usageLimitFetch(ctx, deployment, path, init) {
+  const fetch = deploymentFetch(ctx, deployment);
+  try {
+    const response = await fetch(`/api/v1${path}`, {
+      method: init?.method ?? "GET",
+      ...init?.body !== void 0 ? { body: JSON.stringify(init.body) } : {}
+    });
+    const text = await response.text();
+    return text.length > 0 ? JSON.parse(text) : void 0;
+  } catch (e) {
+    return await logAndHandleFetchError(ctx, e);
+  }
+}
+export async function listUsageLimits(ctx, deployment) {
+  const result = await usageLimitFetch(
+    ctx,
+    deployment,
+    "/list_usage_limits"
+  );
+  return result.usageLimits;
+}
+export async function createUsageLimit(ctx, deployment, config) {
+  const result = await usageLimitFetch(
+    ctx,
+    deployment,
+    "/create_usage_limit",
+    {
+      method: "POST",
+      body: config
+    }
+  );
+  return result.usageLimit;
+}
+export async function updateUsageLimit(ctx, deployment, id, config) {
+  const result = await usageLimitFetch(
+    ctx,
+    deployment,
+    `/update_usage_limit/${id}`,
+    { method: "POST", body: config }
+  );
+  return result.usageLimit;
+}
+export async function deleteUsageLimit(ctx, deployment, id) {
+  await usageLimitFetch(ctx, deployment, `/delete_usage_limit/${id}`, {
+    method: "POST"
+  });
+}
+export async function getCurrentUsage(ctx, deployment) {
+  return await usageLimitFetch(
+    ctx,
+    deployment,
+    "/get_current_usage"
+  );
+}
+function metricRank(metric) {
+  const i = USAGE_LIMIT_METRICS.indexOf(metric);
+  return i === -1 ? USAGE_LIMIT_METRICS.length : i;
+}
+const windowRank = (w) => w === "month" ? 0 : 1;
+const typeRank = (t) => t === "warning" ? 0 : 1;
+export function compareUsageLimits(a, b) {
+  return metricRank(a.metric) - metricRank(b.metric) || windowRank(a.window) - windowRank(b.window) || typeRank(a.limitType) - typeRank(b.limitType);
+}
+export function compareMetricNames(a, b) {
+  return metricRank(a) - metricRank(b);
+}
+function usageInWindow(usage, metric, window) {
+  const m = usage.metrics[metric];
+  if (m === void 0) {
+    return null;
+  }
+  return window === "day" ? m.usage.current_day : m.usage.current_month;
+}
+export async function listUsageLimitsWithStatus(ctx, deployment) {
+  const [limits, usage] = await Promise.all([
+    listUsageLimits(ctx, deployment),
+    getCurrentUsage(ctx, deployment)
+  ]);
+  const withStatus = limits.map((limit) => {
+    const currentUsage = usageInWindow(usage, limit.metric, limit.window);
+    const unit = usage.metrics[limit.metric]?.unit ?? null;
+    const triggered = limit.enabled && currentUsage !== null && currentUsage >= limit.limit;
+    return { ...limit, currentUsage, unit, triggered };
+  }).sort(compareUsageLimits);
+  return { limits: withStatus, seedStatus: usage.seedStatus };
+}
+export async function findUsageLimitByKey(ctx, deployment, key) {
+  const match = (await listUsageLimits(ctx, deployment)).find(
+    (limit) => limit.metric === key.metric && limit.window === key.window && limit.limitType === key.limitType
+  );
+  if (match === void 0) {
+    return ctx.crash({
+      exitCode: 1,
+      errorType: "fatal",
+      printedMessage: `error: No ${key.limitType} usage limit on ${key.metric} per ${key.window}${deployment.deploymentNotice}.`
+    });
+  }
+  return match;
+}
+//# sourceMappingURL=usageLimits.js.map

package/dist/esm/cli/lib/usageLimits.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/cli/lib/usageLimits.ts"],
+  "sourcesContent": ["import type {\n  GetCurrentUsageResponse,\n  UsageLimitConfigRequest,\n  UsageLimitConfigResponse,\n  UsageLimitMetric,\n} from \"@convex-dev/platform/deploymentApi\";\nimport { Context } from \"../../bundler/context.js\";\nimport { deploymentFetch, logAndHandleFetchError } from \"./utils/utils.js\";\n\nexport type UsageLimitDeployment = {\n  deploymentUrl: string;\n  adminKey: string;\n};\n\nexport const USAGE_LIMIT_METRICS = [\n  \"functionCalls\",\n  \"queryMutationComputeGbHours\",\n  \"actionComputeConvexGbHours\",\n  \"actionComputeNodeJsGbHours\",\n  \"actionComputeCpuGbHours\",\n  \"databaseIoGb\",\n  \"searchQueryGb\",\n  \"dataEgressGb\",\n] as const satisfies readonly UsageLimitMetric[];\n\n// Fails to compile if the backend's `UsageLimitMetric` gains a metric not listed\n// above, so the CLI's `--metric` choices and ordering stay complete.\ntype MissingMetric = Exclude<\n  UsageLimitMetric,\n  (typeof USAGE_LIMIT_METRICS)[number]\n>;\nconst _metricsExhaustive: [MissingMetric] extends [never] ? true : never = true;\nvoid _metricsExhaustive;\n\nexport const USAGE_LIMIT_WINDOWS = [\"day\", \"month\"] as const;\nexport type UsageLimitWindow = (typeof USAGE_LIMIT_WINDOWS)[number];\n\nexport const USAGE_LIMIT_TYPES = [\"warning\", \"disable\"] as const;\nexport type UsageLimitType = (typeof USAGE_LIMIT_TYPES)[number];\n\nexport const METRIC_LABELS: Record<UsageLimitMetric, string> = {\n  functionCalls: \"Function calls\",\n  queryMutationComputeGbHours: \"Query/Mutation compute\",\n  actionComputeConvexGbHours: \"Action compute\",\n  actionComputeNodeJsGbHours: \"Action compute (Node.js)\",\n  actionComputeCpuGbHours: \"Action compute (CPU)\",\n  databaseIoGb: \"Database I/O\",\n  searchQueryGb: \"Search queries\",\n  dataEgressGb: \"Data egress\",\n};\n\nexport function metricLabel(metric: string): string {\n  // Look up permissively: a newer backend may report a metric this CLI's label\n  // map doesn't know, in which case fall back to the raw id.\n  return (METRIC_LABELS as Record<string, string>)[metric] ?? metric;\n}\n\nasync function usageLimitFetch(\n  ctx: Context,\n  deployment: UsageLimitDeployment,\n  path: string,\n  init?: { method?: string; body?: unknown },\n): Promise<unknown> {\n  const fetch = deploymentFetch(ctx, deployment);\n  try {\n    const response = await fetch(`/api/v1${path}`, {\n      method: init?.method ?? \"GET\",\n      ...(init?.body !== undefined ? { body: JSON.stringify(init.body) } : {}),\n    });\n    const text = await response.text();\n    return text.length > 0 ? JSON.parse(text) : undefined;\n  } catch (e) {\n    return await logAndHandleFetchError(ctx, e);\n  }\n}\n\nexport async function listUsageLimits(\n  ctx: Context,\n  deployment: UsageLimitDeployment,\n): Promise<UsageLimitConfigResponse[]> {\n  const result = (await usageLimitFetch(\n    ctx,\n    deployment,\n    \"/list_usage_limits\",\n  )) as {\n    usageLimits: UsageLimitConfigResponse[];\n  };\n  return result.usageLimits;\n}\n\nexport async function createUsageLimit(\n  ctx: Context,\n  deployment: UsageLimitDeployment,\n  config: UsageLimitConfigRequest,\n): Promise<UsageLimitConfigResponse> {\n  const result = (await usageLimitFetch(\n    ctx,\n    deployment,\n    \"/create_usage_limit\",\n    {\n      method: \"POST\",\n      body: config,\n    },\n  )) as { usageLimit: UsageLimitConfigResponse };\n  return result.usageLimit;\n}\n\nexport async function updateUsageLimit(\n  ctx: Context,\n  deployment: UsageLimitDeployment,\n  id: string,\n  config: UsageLimitConfigRequest,\n): Promise<UsageLimitConfigResponse> {\n  const result = (await usageLimitFetch(\n    ctx,\n    deployment,\n    `/update_usage_limit/${id}`,\n    { method: \"POST\", body: config },\n  )) as { usageLimit: UsageLimitConfigResponse };\n  return result.usageLimit;\n}\n\nexport async function deleteUsageLimit(\n  ctx: Context,\n  deployment: UsageLimitDeployment,\n  id: string,\n): Promise<void> {\n  await usageLimitFetch(ctx, deployment, `/delete_usage_limit/${id}`, {\n    method: \"POST\",\n  });\n}\n\nexport async function getCurrentUsage(\n  ctx: Context,\n  deployment: UsageLimitDeployment,\n): Promise<GetCurrentUsageResponse> {\n  return (await usageLimitFetch(\n    ctx,\n    deployment,\n    \"/get_current_usage\",\n  )) as GetCurrentUsageResponse;\n}\n\nfunction metricRank(metric: string): number {\n  const i = (USAGE_LIMIT_METRICS as readonly string[]).indexOf(metric);\n  // Unknown metrics (e.g. a newer backend adds one) sort last, stably.\n  return i === -1 ? USAGE_LIMIT_METRICS.length : i;\n}\n\n// Windows coarsest-first and warning-before-disable,.\nconst windowRank = (w: string) => (w === \"month\" ? 0 : 1);\nconst typeRank = (t: string) => (t === \"warning\" ? 0 : 1);\n\nexport function compareUsageLimits(\n  a: { metric: string; window: string; limitType: string },\n  b: { metric: string; window: string; limitType: string },\n): number {\n  return (\n    metricRank(a.metric) - metricRank(b.metric) ||\n    windowRank(a.window) - windowRank(b.window) ||\n    typeRank(a.limitType) - typeRank(b.limitType)\n  );\n}\n\nexport function compareMetricNames(a: string, b: string): number {\n  return metricRank(a) - metricRank(b);\n}\n\n// A limit annotated with the current usage in its window and whether it's\n// currently triggered.\nexport type UsageLimitStatus = UsageLimitConfigResponse & {\n  currentUsage: number | null;\n  unit: string | null;\n  triggered: boolean;\n};\n\nfunction usageInWindow(\n  usage: GetCurrentUsageResponse,\n  metric: string,\n  window: string,\n): number | null {\n  const m = usage.metrics[metric];\n  if (m === undefined) {\n    return null;\n  }\n  return window === \"day\" ? m.usage.current_day : m.usage.current_month;\n}\n\n// List usage limits annotated with current usage and triggered state, sorted in\n// dashboard order. Fetches the limits and current usage together.\nexport async function listUsageLimitsWithStatus(\n  ctx: Context,\n  deployment: UsageLimitDeployment,\n): Promise<{\n  limits: UsageLimitStatus[];\n  seedStatus: GetCurrentUsageResponse[\"seedStatus\"];\n}> {\n  const [limits, usage] = await Promise.all([\n    listUsageLimits(ctx, deployment),\n    getCurrentUsage(ctx, deployment),\n  ]);\n  const withStatus = limits\n    .map((limit): UsageLimitStatus => {\n      const currentUsage = usageInWindow(usage, limit.metric, limit.window);\n      const unit = usage.metrics[limit.metric]?.unit ?? null;\n      const triggered =\n        limit.enabled && currentUsage !== null && currentUsage >= limit.limit;\n      return { ...limit, currentUsage, unit, triggered };\n    })\n    .sort(compareUsageLimits);\n  return { limits: withStatus, seedStatus: usage.seedStatus };\n}\n\n// A usage limit is uniquely identified by (metric, window, limitType) \u2014 the\n// same key the backend enforces uniqueness on. The HTTP API addresses limits by\n// document id, so callers who know the natural key list and resolve it here.\nexport type UsageLimitKey = {\n  metric: UsageLimitMetric;\n  window: string;\n  limitType: string;\n};\n\nexport async function findUsageLimitByKey(\n  ctx: Context,\n  deployment: UsageLimitDeployment & { deploymentNotice: string },\n  key: UsageLimitKey,\n): Promise<UsageLimitConfigResponse> {\n  const match = (await listUsageLimits(ctx, deployment)).find(\n    (limit) =>\n      limit.metric === key.metric &&\n      limit.window === key.window &&\n      limit.limitType === key.limitType,\n  );\n  if (match === undefined) {\n    return ctx.crash({\n      exitCode: 1,\n      errorType: \"fatal\",\n      printedMessage: `error: No ${key.limitType} usage limit on ${key.metric} per ${key.window}${deployment.deploymentNotice}.`,\n    });\n  }\n  return match;\n}\n"],
+  "mappings": ";AAOA,SAAS,iBAAiB,8BAA8B;AAOjD,aAAM,sBAAsB;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAQA,MAAM,qBAAqE;AAC3E,KAAK;AAEE,aAAM,sBAAsB,CAAC,OAAO,OAAO;AAG3C,aAAM,oBAAoB,CAAC,WAAW,SAAS;AAG/C,aAAM,gBAAkD;AAAA,EAC7D,eAAe;AAAA,EACf,6BAA6B;AAAA,EAC7B,4BAA4B;AAAA,EAC5B,4BAA4B;AAAA,EAC5B,yBAAyB;AAAA,EACzB,cAAc;AAAA,EACd,eAAe;AAAA,EACf,cAAc;AAChB;AAEO,gBAAS,YAAY,QAAwB;AAGlD,SAAQ,cAAyC,MAAM,KAAK;AAC9D;AAEA,eAAe,gBACb,KACA,YACA,MACA,MACkB;AAClB,QAAM,QAAQ,gBAAgB,KAAK,UAAU;AAC7C,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,UAAU,IAAI,IAAI;AAAA,MAC7C,QAAQ,MAAM,UAAU;AAAA,MACxB,GAAI,MAAM,SAAS,SAAY,EAAE,MAAM,KAAK,UAAU,KAAK,IAAI,EAAE,IAAI,CAAC;AAAA,IACxE,CAAC;AACD,UAAM,OAAO,MAAM,SAAS,KAAK;AACjC,WAAO,KAAK,SAAS,IAAI,KAAK,MAAM,IAAI,IAAI;AAAA,EAC9C,SAAS,GAAG;AACV,WAAO,MAAM,uBAAuB,KAAK,CAAC;AAAA,EAC5C;AACF;AAEA,sBAAsB,gBACpB,KACA,YACqC;AACrC,QAAM,SAAU,MAAM;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAGA,SAAO,OAAO;AAChB;AAEA,sBAAsB,iBACpB,KACA,YACA,QACmC;AACnC,QAAM,SAAU,MAAM;AAAA,IACpB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,MACE,QAAQ;AAAA,MACR,MAAM;AAAA,IACR;AAAA,EACF;AACA,SAAO,OAAO;AAChB;AAEA,sBAAsB,iBACpB,KACA,YACA,IACA,QACmC;AACnC,QAAM,SAAU,MAAM;AAAA,IACpB;AAAA,IACA;AAAA,IACA,uBAAuB,EAAE;AAAA,IACzB,EAAE,QAAQ,QAAQ,MAAM,OAAO;AAAA,EACjC;AACA,SAAO,OAAO;AAChB;AAEA,sBAAsB,iBACpB,KACA,YACA,IACe;AACf,QAAM,gBAAgB,KAAK,YAAY,uBAAuB,EAAE,IAAI;AAAA,IAClE,QAAQ;AAAA,EACV,CAAC;AACH;AAEA,sBAAsB,gBACpB,KACA,YACkC;AAClC,SAAQ,MAAM;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,WAAW,QAAwB;AAC1C,QAAM,IAAK,oBAA0C,QAAQ,MAAM;AAEnE,SAAO,MAAM,KAAK,oBAAoB,SAAS;AACjD;AAGA,MAAM,aAAa,CAAC,MAAe,MAAM,UAAU,IAAI;AACvD,MAAM,WAAW,CAAC,MAAe,MAAM,YAAY,IAAI;AAEhD,gBAAS,mBACd,GACA,GACQ;AACR,SACE,WAAW,EAAE,MAAM,IAAI,WAAW,EAAE,MAAM,KAC1C,WAAW,EAAE,MAAM,IAAI,WAAW,EAAE,MAAM,KAC1C,SAAS,EAAE,SAAS,IAAI,SAAS,EAAE,SAAS;AAEhD;AAEO,gBAAS,mBAAmB,GAAW,GAAmB;AAC/D,SAAO,WAAW,CAAC,IAAI,WAAW,CAAC;AACrC;AAUA,SAAS,cACP,OACA,QACA,QACe;AACf,QAAM,IAAI,MAAM,QAAQ,MAAM;AAC9B,MAAI,MAAM,QAAW;AACnB,WAAO;AAAA,EACT;AACA,SAAO,WAAW,QAAQ,EAAE,MAAM,cAAc,EAAE,MAAM;AAC1D;AAIA,sBAAsB,0BACpB,KACA,YAIC;AACD,QAAM,CAAC,QAAQ,KAAK,IAAI,MAAM,QAAQ,IAAI;AAAA,IACxC,gBAAgB,KAAK,UAAU;AAAA,IAC/B,gBAAgB,KAAK,UAAU;AAAA,EACjC,CAAC;AACD,QAAM,aAAa,OAChB,IAAI,CAAC,UAA4B;AAChC,UAAM,eAAe,cAAc,OAAO,MAAM,QAAQ,MAAM,MAAM;AACpE,UAAM,OAAO,MAAM,QAAQ,MAAM,MAAM,GAAG,QAAQ;AAClD,UAAM,YACJ,MAAM,WAAW,iBAAiB,QAAQ,gBAAgB,MAAM;AAClE,WAAO,EAAE,GAAG,OAAO,cAAc,MAAM,UAAU;AAAA,EACnD,CAAC,EACA,KAAK,kBAAkB;AAC1B,SAAO,EAAE,QAAQ,YAAY,YAAY,MAAM,WAAW;AAC5D;AAWA,sBAAsB,oBACpB,KACA,YACA,KACmC;AACnC,QAAM,SAAS,MAAM,gBAAgB,KAAK,UAAU,GAAG;AAAA,IACrD,CAAC,UACC,MAAM,WAAW,IAAI,UACrB,MAAM,WAAW,IAAI,UACrB,MAAM,cAAc,IAAI;AAAA,EAC5B;AACA,MAAI,UAAU,QAAW;AACvB,WAAO,IAAI,MAAM;AAAA,MACf,UAAU;AAAA,MACV,WAAW;AAAA,MACX,gBAAgB,aAAa,IAAI,SAAS,mBAAmB,IAAI,MAAM,QAAQ,IAAI,MAAM,GAAG,WAAW,gBAAgB;AAAA,IACzH,CAAC;AAAA,EACH;AACA,SAAO;AACT;",
+  "names": []
+}

package/dist/esm/cli/usageLimits.js

@@ -0,0 +1,316 @@
+"use strict";
+import { Command, Option } from "@commander-js/extra-typings";
+import { logFinishedStep, logMessage, logOutput } from "../bundler/log.js";
+import { actionDescription } from "./lib/command.js";
+import { ensureHasConvexDependency } from "./lib/utils/utils.js";
+import { withRunningBackend } from "./lib/localDeployment/run.js";
+import { selectEnvDeployment } from "./env.js";
+import {
+  compareMetricNames,
+  createUsageLimit,
+  deleteUsageLimit,
+  findUsageLimitByKey,
+  getCurrentUsage,
+  listUsageLimits,
+  listUsageLimitsWithStatus,
+  metricLabel,
+  updateUsageLimit,
+  USAGE_LIMIT_METRICS,
+  USAGE_LIMIT_TYPES,
+  USAGE_LIMIT_WINDOWS
+} from "./lib/usageLimits.js";
+async function parseLimit(ctx, value) {
+  const limit = Number(value);
+  if (!Number.isInteger(limit) || limit < 1) {
+    return ctx.crash({
+      exitCode: 1,
+      errorType: "fatal",
+      printedMessage: `error: --limit must be a positive integer, got "${value}".`
+    });
+  }
+  return limit;
+}
+function formatTable(header, rows, rightAlign = []) {
+  const right = new Set(rightAlign);
+  const widths = header.map(
+    (cell, i) => Math.max(cell.length, ...rows.map((row) => (row[i] ?? "").length))
+  );
+  const pad = (cell, i) => right.has(i) ? cell.padStart(widths[i]) : cell.padEnd(widths[i]);
+  const rule = (left, mid, r) => left + widths.map((w) => "\u2500".repeat(w + 2)).join(mid) + r;
+  const line = (cells) => "\u2502 " + cells.map((cell, i) => pad(cell ?? "", i)).join(" \u2502 ") + " \u2502";
+  return [
+    rule("\u250C", "\u252C", "\u2510"),
+    line(header),
+    rule("\u251C", "\u253C", "\u2524"),
+    ...rows.map(line),
+    rule("\u2514", "\u2534", "\u2518")
+  ].join("\n");
+}
+const NUMBER_FORMAT_COMPACT = new Intl.NumberFormat("en-US", {
+  notation: "compact",
+  compactDisplay: "short",
+  maximumFractionDigits: 3
+});
+function formatNumberCompact(value) {
+  const formatted = NUMBER_FORMAT_COMPACT.format(value);
+  return formatted === "-0" ? "0" : formatted;
+}
+const LIMIT_FORMAT = new Intl.NumberFormat("en-US");
+function formatLimitAmount(value) {
+  return LIMIT_FORMAT.format(value);
+}
+const NUMBER_FORMAT = new Intl.NumberFormat("en-US");
+function formatNumber(value) {
+  const formatted = NUMBER_FORMAT.format(value);
+  return formatted === "-0" ? "0" : formatted;
+}
+function unitFor(amount, unit) {
+  return amount === 1 && unit === "calls" ? "call" : unit;
+}
+function formatAmount(value, unit) {
+  return unit === null ? formatNumberCompact(value) : `${formatNumberCompact(value)} ${unitFor(value, unit)}`;
+}
+function usageLimitRow(limit) {
+  const currentUsage = limit.currentUsage === null ? "\u2014" : `${formatAmount(limit.currentUsage, limit.unit)} (${formatNumber(
+    Math.round(limit.currentUsage / limit.limit * 100)
+  )}%)`;
+  return [
+    metricLabel(limit.metric),
+    limit.window,
+    limit.limitType,
+    formatAmount(limit.limit, limit.unit),
+    currentUsage,
+    limit.enabled ? "yes" : "no",
+    limit.triggered ? "yes" : "no"
+  ];
+}
+const metricOption = new Option(
+  "--metric <metric>",
+  "The metric to limit."
+).choices(USAGE_LIMIT_METRICS);
+const windowOption = new Option(
+  "--window <window>",
+  "The window the limit is measured over."
+).choices(USAGE_LIMIT_WINDOWS);
+const typeOption = new Option(
+  "--type <type>",
+  "`warning` only notifies; `disable` pauses the deployment when exceeded."
+).choices(USAGE_LIMIT_TYPES);
+function seedStatusMessage(seedStatus) {
+  return seedStatus === "failed" ? "We couldn't load this deployment's historical usage, so the usage shown below may understate its actual usage. Limits are still enforced going forward." : "Historical usage is still being loaded, so the usage shown below may understate this deployment's actual usage. Check back shortly for accurate totals.";
+}
+const listCmd = new Command("list").summary("List configured usage limits").description(
+  [
+    "List the usage limits configured on your deployment.",
+    "",
+    "\u2022 List all usage limits: `npx convex deployment usage-limits list`",
+    "\u2022 Print as JSON: `npx convex deployment usage-limits list --json`"
+  ].join("\n")
+).option("--json", "Output the usage limits as JSON.").configureHelp({ showGlobalOptions: true }).allowExcessArguments(false).action(async (cmdOptions, cmd) => {
+  const options = cmd.optsWithGlobals();
+  const { ctx, deployment } = await selectEnvDeployment(options);
+  await ensureHasConvexDependency(ctx, "deployment usage-limits list");
+  await withRunningBackend({
+    ctx,
+    deployment,
+    action: async () => {
+      const { limits, seedStatus } = await listUsageLimitsWithStatus(
+        ctx,
+        deployment
+      );
+      if (cmdOptions.json) {
+        logOutput(JSON.stringify(limits, null, 2));
+        return;
+      }
+      if (limits.length === 0) {
+        logMessage(
+          `No usage limits configured${deployment.deploymentNotice}.`
+        );
+        return;
+      }
+      if (seedStatus !== "complete") {
+        logMessage(seedStatusMessage(seedStatus));
+      }
+      logOutput(
+        formatTable(
+          [
+            "Metric",
+            "Window",
+            "Type",
+            "Limit",
+            "Current Usage",
+            "Active",
+            "Triggered"
+          ],
+          limits.map(usageLimitRow),
+          [3, 4]
+        )
+      );
+    }
+  });
+});
+const setCmd = new Command("set").summary("Create or update a usage limit").description(
+  [
+    "Create a usage limit, or update the existing one for the same",
+    "(metric, window, type). At most one limit exists per combination.",
+    "",
+    "\u2022 Set the amount (creates or replaces it):",
+    "  `npx convex deployment usage-limits set --metric functionCalls --window day --type disable --limit 1000000`",
+    "\u2022 Deactivate without deleting: add `--inactive` (use `--active` to re-enable).",
+    "\u2022 Toggle active state without changing the amount: omit `--limit`."
+  ].join("\n")
+).addOption(metricOption.makeOptionMandatory()).addOption(windowOption.makeOptionMandatory()).addOption(typeOption.makeOptionMandatory()).option(
+  "--limit <limit>",
+  "The limit amount, in the metric's native units. Required when creating; kept as-is when omitted while updating."
+).option("--active", "Enforce the limit (the default for a new limit).").option("--inactive", "Create or leave the limit unenforced.").configureHelp({ showGlobalOptions: true }).allowExcessArguments(false).action(async (cmdOptions, cmd) => {
+  const options = cmd.optsWithGlobals();
+  const { ctx, deployment } = await selectEnvDeployment(options);
+  await ensureHasConvexDependency(ctx, "deployment usage-limits set");
+  if (cmdOptions.active && cmdOptions.inactive) {
+    return ctx.crash({
+      exitCode: 1,
+      errorType: "fatal",
+      printedMessage: "error: Pass at most one of --active and --inactive."
+    });
+  }
+  const newLimit = cmdOptions.limit === void 0 ? void 0 : await parseLimit(ctx, cmdOptions.limit);
+  await withRunningBackend({
+    ctx,
+    deployment,
+    action: async () => {
+      const existing = (await listUsageLimits(ctx, deployment)).find(
+        (l) => l.metric === cmdOptions.metric && l.window === cmdOptions.window && l.limitType === cmdOptions.type
+      );
+      const label = `${cmdOptions.type} usage limit on ${metricLabel(cmdOptions.metric)} per ${cmdOptions.window}`;
+      if (existing === void 0) {
+        if (newLimit === void 0) {
+          return ctx.crash({
+            exitCode: 1,
+            errorType: "fatal",
+            printedMessage: "error: --limit is required when creating a usage limit."
+          });
+        }
+        const enabled2 = !cmdOptions.inactive;
+        const created = await createUsageLimit(ctx, deployment, {
+          metric: cmdOptions.metric,
+          window: cmdOptions.window,
+          limitType: cmdOptions.type,
+          limit: newLimit,
+          enabled: enabled2
+        });
+        logFinishedStep(
+          `Created ${label}: ${formatLimitAmount(created.limit)}, ${created.enabled ? "active" : "inactive"}${deployment.deploymentNotice}.`
+        );
+        return;
+      }
+      const enabled = cmdOptions.active ? true : cmdOptions.inactive ? false : existing.enabled;
+      const limit = newLimit ?? existing.limit;
+      const changes = [];
+      if (limit !== existing.limit) {
+        changes.push(
+          `limit ${formatLimitAmount(existing.limit)} \u2192 ${formatLimitAmount(limit)}`
+        );
+      }
+      if (enabled !== existing.enabled) {
+        changes.push(
+          `${existing.enabled ? "active" : "inactive"} \u2192 ${enabled ? "active" : "inactive"}`
+        );
+      }
+      if (changes.length === 0) {
+        logFinishedStep(
+          `No changes to ${label} (${formatLimitAmount(existing.limit)}, ${existing.enabled ? "active" : "inactive"})${deployment.deploymentNotice}.`
+        );
+        return;
+      }
+      await updateUsageLimit(ctx, deployment, existing.id, {
+        metric: existing.metric,
+        window: existing.window,
+        limitType: existing.limitType,
+        limit,
+        enabled
+      });
+      logFinishedStep(
+        `Updated ${label}: ${changes.join(", ")}${deployment.deploymentNotice}.`
+      );
+    }
+  });
+});
+const removeCmd = new Command("remove").alias("rm").alias("delete").summary("Delete a usage limit").description(
+  [
+    "Delete a usage limit, identified by its (metric, window, type).",
+    "",
+    "\u2022 `npx convex deployment usage-limits remove --metric functionCalls --window day --type warning`"
+  ].join("\n")
+).addOption(metricOption.makeOptionMandatory()).addOption(windowOption.makeOptionMandatory()).addOption(typeOption.makeOptionMandatory()).configureHelp({ showGlobalOptions: true }).allowExcessArguments(false).action(async (cmdOptions, cmd) => {
+  const options = cmd.optsWithGlobals();
+  const { ctx, deployment } = await selectEnvDeployment(options);
+  await ensureHasConvexDependency(ctx, "deployment usage-limits remove");
+  await withRunningBackend({
+    ctx,
+    deployment,
+    action: async () => {
+      const existing = await findUsageLimitByKey(ctx, deployment, {
+        metric: cmdOptions.metric,
+        window: cmdOptions.window,
+        limitType: cmdOptions.type
+      });
+      await deleteUsageLimit(ctx, deployment, existing.id);
+      logFinishedStep(
+        `Deleted ${existing.limitType} usage limit on ${metricLabel(existing.metric)} per ${existing.window}${deployment.deploymentNotice}.`
+      );
+    }
+  });
+});
+export const usage = new Command("usage").summary("Show current usage for each metric").description(
+  [
+    "Show usage so far in the current day and calendar month for every metric.",
+    "",
+    "\u2022 Show current usage: `npx convex deployment usage`",
+    "\u2022 Print as JSON: `npx convex deployment usage --json`"
+  ].join("\n")
+).option("--json", "Output the usage as JSON.").configureHelp({ showGlobalOptions: true }).allowExcessArguments(false).addDeploymentSelectionOptions(actionDescription("Show current usage for")).action(async (cmdOptions, cmd) => {
+  const options = cmd.optsWithGlobals();
+  const { ctx, deployment } = await selectEnvDeployment(options);
+  await ensureHasConvexDependency(ctx, "deployment usage");
+  await withRunningBackend({
+    ctx,
+    deployment,
+    action: async () => {
+      const usage2 = await getCurrentUsage(ctx, deployment);
+      if (cmdOptions.json) {
+        logOutput(JSON.stringify(usage2, null, 2));
+        return;
+      }
+      if (usage2.seedStatus !== "complete") {
+        logMessage(seedStatusMessage(usage2.seedStatus));
+      }
+      logOutput(
+        formatTable(
+          ["Metric", "Day", "Month"],
+          Object.entries(usage2.metrics).sort(([a], [b]) => compareMetricNames(a, b)).map(([metric, m]) => [
+            metricLabel(metric),
+            formatAmount(m.usage.current_day, m.unit),
+            formatAmount(m.usage.current_month, m.unit)
+          ])
+        )
+      );
+    }
+  });
+});
+export const usageLimits = new Command("usage-limits").summary("List and configure deployment usage limits").description(
+  [
+    "List and configure usage limits on your deployment.",
+    "",
+    "A usage limit either warns or pauses your deployment when a metric",
+    "(function calls, database bandwidth, \u2026) crosses a threshold within a",
+    "daily or monthly window. Each limit is identified by its",
+    "(metric, window, type).",
+    "",
+    "\u2022 List usage limits: `npx convex deployment usage-limits list`",
+    "\u2022 Create or update one: `npx convex deployment usage-limits set --metric functionCalls --window day --type disable --limit 1000000`",
+    "\u2022 Delete one: `npx convex deployment usage-limits remove --metric functionCalls --window day --type disable`"
+  ].join("\n")
+).addCommand(listCmd).addCommand(setCmd).addCommand(removeCmd).helpCommand(false).addDeploymentSelectionOptions(
+  actionDescription("List and configure usage limits on")
+);
+//# sourceMappingURL=usageLimits.js.map