@lukoweb/apitogo 0.2.43 → 0.2.45

package/dist/declarations/lib/plugins/openapi/playground/result-panel/ResultPanel.d.ts

@@ -1,8 +1,10 @@
 import type { UseMutationResult } from "@tanstack/react-query";
 import type { PlaygroundResult } from "../Playground.js";
-export declare const ResultPanel: ({ queryMutation, showLongRunningWarning, onCancel, tip, isFinished, progress, }: {
+export declare const ResultPanel: ({ queryMutation, showLongRunningWarning, isWarmingUp, hasIdentities, onCancel, tip, isFinished, progress, }: {
     queryMutation: UseMutationResult<PlaygroundResult, Error, any>;
     showLongRunningWarning?: boolean;
+    isWarmingUp?: boolean;
+    hasIdentities?: boolean;
     onCancel?: () => void;
     isFinished: boolean;
     progress: number;

package/dist/declarations/lib/plugins/openapi/playground/warmUpRetry.d.ts

@@ -0,0 +1,5 @@
+export declare const WARM_UP_STATUSES: number[];
+export declare function fetchWithWarmUpRetry(request: Request, init: RequestInit, options?: {
+    delayMs?: number;
+    onRetry?: () => void;
+}): Promise<Response>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lukoweb/apitogo",
-  "version": "0.2.43",
+  "version": "0.2.45",
   "type": "module",
   "sideEffects": [
     "**/*.css",

package/src/config/v2/full-server.ts

@@ -9,6 +9,11 @@ export const FULL_SERVER_SOURCE = "server";
 export const FULL_SERVER_RUNTIME = "nodejs";
 export const FULL_SERVER_RUNTIME_VERSION = "NODE_22_LTS";
 export const FULL_SERVER_HEALTH_PATH = "/health";
+/**
+ * How long the gateway waits for the API. A hosted API that was idle takes longer than the default 30 seconds to wake
+ * up, so the first call after a quiet spell would end in a timeout; 120 is the most the platform allows.
+ */
+export const FULL_SERVER_TIMEOUT_SECONDS = 120;
 
 const packageName = (name: string) =>
   `${

package/src/config/v2/services.ts

@@ -11,6 +11,7 @@ import path from "node:path";
 import { ApitogoError } from "../../lib/util/invariant.js";
 import {
   FULL_SERVER_HEALTH_PATH,
+  FULL_SERVER_TIMEOUT_SECONDS,
   FULL_SERVER_RUNTIME,
   FULL_SERVER_RUNTIME_VERSION,
   FULL_SERVER_SOURCE,
@@ -462,18 +463,19 @@ async function buildPortal(
 
 /**
  * A managed gateway runs the code in its source folder, and a new project has none. The folder is made (a `.gitkeep`
- * keeps it in git) and the user is told it is empty; the full template writes a small Node.js server there instead.
- * A folder that has files is left as it is. Returns whether the sample server was written.
+ * keeps it in git) and the user is told it is empty; with `writeSample` (the full template's own API) a small Node.js
+ * server is written there instead. A folder that has files is left as it is. Returns whether the sample was written.
  */
 async function createSourceFolder(
   context: Context,
   sourcePath: string,
   runtime: Runtime,
+  writeSample: boolean,
 ): Promise<boolean> {
   const folder = path.join(context.dir, sourcePath);
   const entries = await readdir(folder).catch(() => [] as string[]);
   if (entries.some((name) => name !== ".gitkeep")) return false;
-  if (context.options.template === "full" && runtime === FULL_SERVER_RUNTIME) {
+  if (writeSample && runtime === FULL_SERVER_RUNTIME) {
     for (const [file, content] of Object.entries(
       fullServerFiles(context.resolved.project.name),
     ))
@@ -494,11 +496,35 @@ async function buildGateway(
   const { options, dir, resolved } = context;
   const o = options.gateway ?? {};
   const ask = options.ask;
-  // The full template runs a backend of its own, so it asks nothing about the origin.
-  const full = options.template === "full" && !o.url && o.origin !== "proxy";
+  const fullTemplate = options.template === "full";
+  // `full`: the platform runs the sample Node.js API in `server/`. That is what a script gets; in a terminal the full
+  // template asks first, because the user may have code of their own or an API that already runs somewhere else.
+  let full = fullTemplate && !o.url && o.origin !== "proxy";
   let mode =
     o.origin ??
-    (o.url ? "proxy" : o.source || o.runtime || full ? "managed" : undefined);
+    (o.url ? "proxy" : o.source || o.runtime ? "managed" : undefined);
+  if (fullTemplate && !mode && ask) {
+    const answer = await ask.choose("Where is your API?", [
+      {
+        value: "sample" as const,
+        label:
+          "I have none yet: create a small Node.js API in server/, ready to deploy",
+      },
+      {
+        value: "own" as const,
+        label:
+          "My code is in this project (Node.js, Python or .NET): the platform runs it",
+      },
+      {
+        value: "proxy" as const,
+        label:
+          "It already runs somewhere else: the gateway forwards calls to its https address",
+      },
+    ]);
+    full = answer === "sample";
+    mode = answer === "proxy" ? "proxy" : "managed";
+  }
+  if (!mode && full) mode = "managed";
   if (!mode && ask) {
     mode = await ask.choose("How does the gateway reach your API?", [
       {
@@ -575,7 +601,7 @@ async function buildGateway(
       );
     }
     const sourcePath = insideProject(dir, source, "Source folder");
-    sampleServer = await createSourceFolder(context, sourcePath, runtime);
+    sampleServer = await createSourceFolder(context, sourcePath, runtime, full);
     origin = {
       mode,
       source: sourcePath,
@@ -583,6 +609,8 @@ async function buildGateway(
       runtimeVersion,
       ...(o.exclude?.length ? { exclude: o.exclude } : {}),
       ...(sampleServer ? { healthPath: FULL_SERVER_HEALTH_PATH } : {}),
+      // A full project's API is hosted by the platform and sleeps when idle; the first call must outlast its start.
+      ...(fullTemplate ? { timeoutSeconds: FULL_SERVER_TIMEOUT_SECONDS } : {}),
     };
   }