@lukoweb/apitogo 0.2.50 → 0.2.52

package/dist/cli/cli.js

@@ -6268,7 +6268,7 @@ title: Welcome
 
 # ${name}
 
-This page was created by \`apitogo init\`. Edit it, and add more \`.md\` or \`.mdx\` files next to it: each one becomes a page of your portal.
+Welcome to the ${name} developer portal. Here you will find guides, the API reference, and everything you need to get an API key and make your first call.
 `;
 }
 async function docsFromPaths(dir, requested) {
@@ -7657,7 +7657,8 @@ async function removeServicesFromManifest(state, names) {
 // src/config/v2/gateway-reference.ts
 import { readFile as readFile6 } from "node:fs/promises";
 import { parse } from "yaml";
-var DEFAULT_KEY_HEADER = "Ocp-Apim-Subscription-Key";
+var DEFAULT_KEY_HEADER = "X-API-Key";
+var KEY_HEADER_EXTENSION = "x-apitogo-key-header";
 var METHODS = [
   "get",
   "put",
@@ -7770,10 +7771,13 @@ function buildReferenceSpec(specText, options) {
   if (Object.keys(components).length > 0) doc.components = components;
   else delete doc.components;
   doc.security = Object.keys(requirement).length > 0 ? [requirement] : [];
-  for (const [, item, method] of operationsOf(paths)) {
+  for (const [path97, item, method] of operationsOf(paths)) {
     const operation = item[method];
     if (Array.isArray(operation.security) && operation.security.length > 0)
       delete operation.security;
+    if (options.apiKeyRequired && !options.publicOperations.has(actionKey(method, path97)))
+      operation[KEY_HEADER_EXTENSION] = options.apiKeyHeader;
+    else delete operation[KEY_HEADER_EXTENSION];
   }
   return JSON.parse(hideOrigin(JSON.stringify(doc), options));
 }
@@ -7962,6 +7966,12 @@ function contentGlob(configDir, glob9) {
   const relative = path13.relative(configDir, absolute).split(path13.sep).join("/");
   return `${negated ? "!" : ""}/${CONTENT_LINK}/${relative}`;
 }
+function contentFile(configDir, file) {
+  const relative = path13.relative(configDir, file);
+  if (relative.startsWith("..") || path13.isAbsolute(relative))
+    return file.split(path13.sep).join("/");
+  return `${CONTENT_LINK}/${relative.split(path13.sep).join("/")}`;
+}
 var PLANS_CONSOLE_CAPABILITIES = [
   "catalog",
   "checkout",
@@ -8089,6 +8099,8 @@ function planPortal(profile, manifest) {
       apiBaseUrl: plans.apiBaseUrl,
       keysApiBaseUrl: plans.keysApiBaseUrl,
       billing: plans.billing,
+      ...gateway?.keyHeaderName ? { keyHeader: gateway.keyHeaderName } : {},
+      ...gateway?.baseUrl && serviceReady(gateway) ? { gatewayBaseUrl: gateway.baseUrl } : {},
       links: {
         // Hosted docs are linked once their pages are known (see `buildPortalWorkspace`): there is no page to
         // name before that, and a guessed one was a 404 on every portal whose first page is not called `introduction`.
@@ -8122,13 +8134,13 @@ function buildSiteConfig(resolved, plan2, theme, extras = {}) {
     },
     modules: {
       docs: { enabled: plan2.docs },
-      // A custom home page (`portal.landing`) is served at `/`; the build imports the component from its absolute path.
+      // A custom home page (`portal.landing`) is served at `/`; the build imports the component through the content link.
       ...portal?.landing ? {
         landing: {
           enabled: true,
           path: "/",
           layout: "landing",
-          page: portal.landing.split(path13.sep).join("/")
+          page: contentFile(resolved.configDir, portal.landing)
         }
       } : {},
       // The plans pages (pricing, choosing a plan) exist only when billing is on, and the plans service is what makes it so.
@@ -8630,7 +8642,7 @@ var FULL_SPEC = (name) => `openapi: 3.1.0
 info:
   title: ${JSON.stringify(name)}
   version: 1.0.0
-  description: A small sample API. Edit server/index.js and this file together.
+  description: A sample API with a greeting and a list of items.
 paths:
   /health:
     get:
@@ -8719,10 +8731,14 @@ components:
 // src/config/v2/starter-landing.ts
 function starterLandingPage(options) {
   const name = JSON.stringify(options.name);
-  const plansImport = options.withPlans ? 'import { usePlansPreview } from "@lukoweb/apitogo-plugin-dev-portal-billing";\n' : "";
-  const plansHook = options.withPlans ? "  // The plans of the project's catalog: the same ones the pricing page shows.\n  const plans = usePlansPreview();\n\n" : "";
+  const plansImport = options.withPlans ? 'import {\n  useGatewayCall,\n  usePlansPreview,\n} from "@lukoweb/apitogo-plugin-dev-portal-billing";\n' : "";
+  const plansHook = options.withPlans ? "  // The plans of the project's catalog: the same ones the pricing page shows.\n  const plans = usePlansPreview();\n  // The real gateway address and key header, so the sample works when it is pasted with a key.\n  const gateway = useGatewayCall();\n\n" : "";
+  const sampleUrl = options.withPlans ? '${gateway.baseUrl ?? "https://YOUR-GATEWAY"}' : "https://YOUR-GATEWAY";
+  const sampleHeader = options.withPlans ? "${gateway.keyHeader}" : "X-API-Key";
   const plansSection = options.withPlans ? "      <PlansPreviewSection plans={plans} />\n" : "";
-  return `import {
+  return `// Your portal's home page. Edit this file (apitogo/portal/landing/LandingPage.tsx) to make it yours: everything
+// on it is public, so keep notes for yourself in comments like this one.
+import {
   ApiShowcaseSection,
   FeaturesSection,
   HeroSection,
@@ -8752,8 +8768,8 @@ ${plansHook}  return (
           {
             filename: "Call the API",
             language: "bash",
-            code: \`$ curl https://your-api.example.com/health \\\\
-  -H "x-api-key: YOUR_API_KEY"
+            code: \`$ curl ${sampleUrl}/health \\\\
+  -H "${sampleHeader}: YOUR_API_KEY"
 # { "status": "ok" }\`,
           },
         ]}
@@ -8763,7 +8779,7 @@ ${plansHook}  return (
           label: "What you get",
           title: "A developer portal that is ready on day one",
           description:
-            "Edit this page in apitogo/portal/landing/LandingPage.tsx to make it yours.",
+            "Docs, a live API reference, self-service API keys and clear plans, all in one place.",
         }}
         features={[
           {
@@ -9694,7 +9710,7 @@ init_invariant();
 
 // src/cli/check/v2.ts
 init_apitogo_config_core();
-import { readFile as readFile17 } from "node:fs/promises";
+import { readFile as readFile18 } from "node:fs/promises";
 import path50 from "node:path";
 
 // src/cli/platform/client/platform-api.ts
@@ -10517,8 +10533,8 @@ var PlatformApiClient = class {
   }
 };
 async function readFileBytes(filePath) {
-  const { readFile: readFile28 } = await import("node:fs/promises");
-  const buffer = await readFile28(filePath);
+  const { readFile: readFile29 } = await import("node:fs/promises");
+  const buffer = await readFile29(filePath);
   const arrayBuffer = new ArrayBuffer(buffer.byteLength);
   new Uint8Array(arrayBuffer).set(buffer);
   return arrayBuffer;
@@ -10615,7 +10631,7 @@ function resolveProjectId(explicit, config2) {
 import {
   access as access4,
   mkdir as mkdir12,
-  readFile as readFile14,
+  readFile as readFile15,
   rename as rename6,
   rm as rm8,
   writeFile as writeFile15
@@ -10623,7 +10639,7 @@ import {
 import path49 from "node:path";
 
 // src/vite/build.ts
-import { mkdir as mkdir11, readFile as readFile12, rename as rename5, rm as rm7, writeFile as writeFile13 } from "node:fs/promises";
+import { mkdir as mkdir11, readFile as readFile13, rename as rename5, rm as rm7, writeFile as writeFile13 } from "node:fs/promises";
 import path47 from "node:path";
 import { build as esbuild } from "esbuild";
 import { build as viteBuild, mergeConfig as mergeConfig3 } from "vite";
@@ -10771,7 +10787,7 @@ import {
 // package.json
 var package_default = {
   name: "@lukoweb/apitogo",
-  version: "0.2.50",
+  version: "0.2.52",
   type: "module",
   sideEffects: [
     "**/*.css",
@@ -12702,7 +12718,7 @@ var SchemaManager = class {
       this.storeDir,
       `${prefixPath}-${path26.basename(filePath)}${paramsSuffix(params)}.js`
     );
-    const importKey = processedFilePath;
+    const importKey = path26.posix.basename(processedFilePath);
     await fs3.writeFile(processedFilePath, code);
     const processedJsonPath = paramsSuffix(params) ? processedFilePath.replace(/\.js$/, ".json") : "";
     if (processedJsonPath) {
@@ -12729,6 +12745,7 @@ var SchemaManager = class {
       inputPath: filePath,
       params,
       importKey,
+      processedFilePath,
       downloadUrl: this.createSchemaPath(
         filePath,
         versionPath,
@@ -12781,6 +12798,7 @@ var SchemaManager = class {
         inputPath: path26.resolve(this.config.__meta.rootDir, input5.input),
         params: input5.params,
         importKey: "",
+        processedFilePath: "",
         downloadUrl: "",
         processedJsonPath: "",
         processedTime: 0
@@ -13296,7 +13314,7 @@ var viteApiPlugin = async () => {
               `  },`,
               `  schemaImports: {`,
               ...schemaImports.map(
-                (s) => `    "${s.importKey.replaceAll("\\", "\\\\")}": () => import("${s.importKey.replaceAll("\\", "/")}?d=${s.processedTime}"),`
+                (s) => `    ${JSON.stringify(s.importKey)}: () => import("${s.processedFilePath.replaceAll("\\", "/")}?d=${s.processedTime}"),`
               ),
               `  },`,
               "}));"
@@ -13458,6 +13476,7 @@ var plugin_component_default = viteAliasPlugin;
 // src/vite/plugin-config.ts
 init_package_json();
 init_loader();
+import { readFile as readFile11 } from "node:fs/promises";
 import path32 from "node:path";
 import { normalizePath } from "vite";
 var virtualModuleId3 = "virtual:zudoku-config";
@@ -13466,18 +13485,54 @@ var browserConfigLoaderPath = path32.join(
   getZudokuRootDir(),
   "src/config/apitogo-config-loader.browser.ts"
 );
+var BUILD_ONLY_KEYS = /* @__PURE__ */ new Set(["page"]);
+function stripBuildOnlyPaths(value) {
+  if (Array.isArray(value)) return value.map(stripBuildOnlyPaths);
+  if (typeof value !== "object" || value === null) return value;
+  return Object.fromEntries(
+    Object.entries(value).flatMap(
+      ([key, child]) => BUILD_ONLY_KEYS.has(key) && typeof child === "string" ? [] : [[key, stripBuildOnlyPaths(child)]]
+    )
+  );
+}
 function serializeClientConfig(config2) {
   const {
     plugins: _plugins,
     __meta: _meta,
+    // Folders of the plugin packages on the build machine, for the build's Tailwind sources only.
+    __pluginDirs: _pluginDirs,
     __resolvedModules,
+    modules,
     ...rest
   } = config2;
   return JSON.stringify(
-    { ...rest, __resolvedModules },
+    {
+      ...rest,
+      ...modules !== void 0 ? { modules: stripBuildOnlyPaths(modules) } : {},
+      __resolvedModules
+    },
     (_key, value) => typeof value === "function" ? void 0 : value
   );
 }
+function clientMetaOf(meta) {
+  return {
+    pricingEnabled: meta.pricingEnabled,
+    authenticationEnabled: meta.authenticationEnabled,
+    previewPlans: meta.previewPlans,
+    gatewayBaseUrl: meta.gatewayBaseUrl
+  };
+}
+async function rawConfigSource(configPath) {
+  if (!configPath.toLowerCase().endsWith(".json"))
+    return `import rawConfig from "${normalizePath(configPath)}";`;
+  let navigation;
+  try {
+    navigation = JSON.parse(await readFile11(configPath, "utf8")).navigation;
+  } catch {
+    navigation = void 0;
+  }
+  return `const rawConfig = ${JSON.stringify(navigation === void 0 ? {} : { navigation })};`;
+}
 var viteConfigPlugin = () => {
   let viteConfig;
   return {
@@ -13510,15 +13565,10 @@ var viteConfigPlugin = () => {
         },
         viteConfig.root
       );
-      const clientMeta = {
-        rootDir: loadedConfig.__meta.rootDir,
-        pricingEnabled: loadedConfig.__meta.pricingEnabled,
-        authenticationEnabled: loadedConfig.__meta.authenticationEnabled,
-        previewPlans: loadedConfig.__meta.previewPlans,
-        gatewayBaseUrl: loadedConfig.__meta.gatewayBaseUrl
-      };
+      const clientMeta = clientMetaOf(loadedConfig.__meta);
+      this.addWatchFile(configPath);
       return `
-import rawConfig from "${normalizePath(configPath)}";
+${await rawConfigSource(configPath)}
 import { runPluginTransformConfig } from "@lukoweb/apitogo/plugins";
 
 const embeddedConfig = ${serializeClientConfig(loadedConfig)};
@@ -15167,7 +15217,7 @@ async function writeOutput(dir, {
 // src/vite/prerender/prerender.ts
 init_logger();
 init_file_exists();
-import { readFile as readFile11, rm as rm6 } from "node:fs/promises";
+import { readFile as readFile12, rm as rm6 } from "node:fs/promises";
 import os from "node:os";
 import path46 from "node:path";
 import { pathToFileURL } from "node:url";
@@ -15443,7 +15493,7 @@ var prerender = async ({
     );
     let markdownFileInfos = [];
     if (await fileExists(markdownInfoPath)) {
-      const markdownInfoContent = await readFile11(markdownInfoPath, "utf-8");
+      const markdownInfoContent = await readFile12(markdownInfoPath, "utf-8");
       markdownFileInfos = JSON.parse(markdownInfoContent);
     }
     if (llmsConfig.llmsTxt || llmsConfig.llmsTxtFull) {
@@ -15594,7 +15644,7 @@ var bundleSSREntry = async (options) => {
   const { dir, adapter, serverOutDir, serverConfigFilename, html, basePath } = options;
   const tempEntryPath = path47.join(dir, "__ssr-entry.ts");
   const packageRoot = getZudokuRootDir();
-  const templateContent = await readFile12(
+  const templateContent = await readFile13(
     path47.join(packageRoot, "src/vite/ssr-templates", `${adapter}.ts`),
     "utf-8"
   );
@@ -15625,7 +15675,7 @@ init_package_json();
 
 // src/cli/init/v2-packages.ts
 import { existsSync as existsSync5 } from "node:fs";
-import { readFile as readFile13, writeFile as writeFile14 } from "node:fs/promises";
+import { readFile as readFile14, writeFile as writeFile14 } from "node:fs/promises";
 import path48 from "node:path";
 var CORE_PACKAGES = [
   "@lukoweb/apitogo",
@@ -15772,7 +15822,7 @@ async function buildV2(options) {
 }
 
 // src/cli/check/gateway-online.ts
-import { readFile as readFile15 } from "node:fs/promises";
+import { readFile as readFile16 } from "node:fs/promises";
 var SPEC_SEND_LIMIT = 5 * 1024 * 1024 + 64 * 1024;
 var issue2 = (code, path97, message, hint) => ({ code, path: path97, message, hint });
 function capabilityIssues(gateway, answer) {
@@ -15836,7 +15886,7 @@ async function onlineGatewayRules(gateway, projectId, api, derivedCors = []) {
   const specFile = gateway.specs[0];
   if (specFile) {
     try {
-      const text = await readFile15(specFile, "utf8");
+      const text = await readFile16(specFile, "utf8");
       if (text.length <= SPEC_SEND_LIMIT) spec = text;
     } catch {
     }
@@ -15863,7 +15913,7 @@ async function onlineGatewayRules(gateway, projectId, api, derivedCors = []) {
 }
 
 // src/cli/deploy/plans-file.ts
-import { readFile as readFile16 } from "node:fs/promises";
+import { readFile as readFile17 } from "node:fs/promises";
 import { z as z14 } from "zod";
 init_invariant();
 var PlansFileError = class extends ApitogoError {
@@ -15908,7 +15958,7 @@ var issuesOf = (error) => error.issues.map(
 async function readPlansFile(file) {
   let text;
   try {
-    text = await readFile16(file, "utf8");
+    text = await readFile17(file, "utf8");
   } catch {
     throw new PlansFileError(
       "PLANS_FILE_UNREADABLE",
@@ -16080,7 +16130,7 @@ async function onlinePlansRules(resolved, projectId, api) {
     const convert = (item) => issue3(
       "PLANS_PLAN_INVALID",
       `plans.file ${item.field}`,
-      `${item.sku ? `plan ${item.sku}: ` : ""}${item.message}`
+      withPlanName(item.message, item.sku)
     );
     return {
       errors: answer.errors.map(convert),
@@ -16094,12 +16144,13 @@ async function onlinePlansRules(resolved, projectId, api) {
     };
   }
 }
+var withPlanName = (message, sku) => !sku || message.toLowerCase().startsWith(`plan "${sku.toLowerCase()}"`) ? message : `plan ${sku}: ${message}`;
 
 // src/cli/check/v2.ts
 async function isConfigV2(dir) {
   try {
     return /"version"\s*:\s*2\b/.test(
-      await readFile17(path50.join(dir, APITOGO_CONFIG_FILENAME), "utf8")
+      await readFile18(path50.join(dir, APITOGO_CONFIG_FILENAME), "utf8")
     );
   } catch {
     return false;
@@ -17180,7 +17231,7 @@ function formatDevPortalBackendResponse(projectId, backend) {
 // src/cli/platform/helpers/dev-portal-manifest.ts
 init_gateway_limits();
 import { existsSync as existsSync7 } from "node:fs";
-import { access as access5, mkdir as mkdir13, readFile as readFile18, writeFile as writeFile16 } from "node:fs/promises";
+import { access as access5, mkdir as mkdir13, readFile as readFile19, writeFile as writeFile16 } from "node:fs/promises";
 import path56 from "node:path";
 
 // src/cli/make-config/header-pricing-nav.ts
@@ -17760,7 +17811,7 @@ function mergePublishPrerequisitesWithPlatformValidation(prerequisites, manifest
 async function readManifest2(siteDirectory) {
   const filePath = manifestFilePath(siteDirectory);
   if (await pathExists(filePath)) {
-    const raw = await readFile18(filePath, "utf8");
+    const raw = await readFile19(filePath, "utf8");
     const config2 = JSON.parse(raw);
     return extractManifestFromConfig(config2);
   }
@@ -17771,7 +17822,7 @@ async function writeManifest2(siteDirectory, manifest) {
   await mkdir13(path56.dirname(filePath), { recursive: true });
   let config2 = {};
   if (await pathExists(filePath)) {
-    const raw = await readFile18(filePath, "utf8");
+    const raw = await readFile19(filePath, "utf8");
     config2 = JSON.parse(raw);
   }
   const {
@@ -17790,7 +17841,7 @@ import {
   access as access6,
   appendFile,
   mkdir as mkdir14,
-  readFile as readFile19,
+  readFile as readFile20,
   unlink,
   writeFile as writeFile17
 } from "node:fs/promises";
@@ -17896,7 +17947,7 @@ function applyEnvOverrides2(config2, env) {
 }
 async function readEnvFile(filePath) {
   try {
-    const raw = await readFile19(filePath, "utf8");
+    const raw = await readFile20(filePath, "utf8");
     const env = {};
     for (const line2 of raw.split("\n")) {
       const trimmed = line2.trim();
@@ -18029,7 +18080,7 @@ var SECRETS_COLLECTION_INSTRUCTION = "For go-live, plans must already be in apit
 
 // src/cli/platform/helpers/dev-portal-site-validation.ts
 init_gateway_limits();
-import { readFile as readFile20 } from "node:fs/promises";
+import { readFile as readFile21 } from "node:fs/promises";
 import { createRequire as createRequire2 } from "node:module";
 import path58 from "node:path";
 var cachedFallbackTs;
@@ -18207,7 +18258,7 @@ async function validateDevPortalSiteConfig(sourceDirectory, options) {
     let parsed;
     let parseFailed = false;
     try {
-      parsed = JSON.parse(await readFile20(jsonPath, "utf8"));
+      parsed = JSON.parse(await readFile21(jsonPath, "utf8"));
     } catch (error) {
       parseFailed = true;
       issues.push({
@@ -18246,7 +18297,7 @@ async function validateDevPortalSiteConfig(sourceDirectory, options) {
     } else {
       for (const relativeFile of existingTsxFiles) {
         checkedFiles.push(relativeFile);
-        const content = await readFile20(
+        const content = await readFile21(
           path58.join(resolvedDir, relativeFile),
           "utf8"
         );
@@ -18269,7 +18320,7 @@ async function validateDevPortalSiteConfig(sourceDirectory, options) {
 
 // src/cli/platform/helpers/npm-build.ts
 import { spawn as spawn2 } from "node:child_process";
-import { access as access7, readFile as readFile21 } from "node:fs/promises";
+import { access as access7, readFile as readFile22 } from "node:fs/promises";
 import path59 from "node:path";
 var BUILD_LOG_TAIL_BYTES = 8192;
 var MIN_NODE_MAJOR = 20;
@@ -18915,7 +18966,7 @@ import { createInterface as createInterface3 } from "node:readline/promises";
 
 // src/cli/make-config/v2-edits.ts
 init_apitogo_config_core();
-import { access as access8, mkdir as mkdir15, readFile as readFile22, writeFile as writeFile18 } from "node:fs/promises";
+import { access as access8, mkdir as mkdir15, readFile as readFile23, writeFile as writeFile18 } from "node:fs/promises";
 import path62 from "node:path";
 import { glob as glob8 } from "glob";
 init_invariant();
@@ -19096,10 +19147,13 @@ export default function ${pageComponentName(slug)}() {
       <Typography>
         <Heading level={1}>{title}</Heading>
         <p>${text}</p>
-        <Callout type="info" title="Where this page lives">
-          Edit <code>${file}</code>. Files whose name starts with <code>_</code> are not pages, so you can keep shared
-          components next to your pages.
-        </Callout>
+        {/* A note for you while you run the portal locally (\`apitogo dev\`); the deployed portal does not show it. */}
+        {import.meta.env.DEV && (
+          <Callout type="info" title="Where this page lives">
+            Edit <code>${file}</code>. Files whose name starts with <code>_</code> are not pages, so you can keep
+            shared components next to your pages.
+          </Callout>
+        )}
       </Typography>
     </section>
   );
@@ -19144,7 +19198,7 @@ async function writeDocsPage(project, input5) {
         "Leave out --page-update to add it."
       );
     }
-    const source = await readFile22(existing, "utf8");
+    const source = await readFile23(existing, "utf8");
     const title = input5.title?.trim() || (existing.endsWith(".tsx") ? tsxPageLabel(source, existing) : titleOf(source));
     file = existing;
     action = "updated";
@@ -19233,7 +19287,7 @@ async function upsertPlan(project, plan2) {
   if (await exists4(plans.file)) {
     let raw;
     try {
-      raw = JSON.parse(await readFile22(plans.file, "utf8"));
+      raw = JSON.parse(await readFile23(plans.file, "utf8"));
     } catch (error) {
       throw new ConfigEditError(
         `${relativeToConfig(project, plans.file)} is not valid JSON (${error.message}).`
@@ -19709,7 +19763,7 @@ var config_default = {
 // src/cli/create/handler.ts
 init_apitogo_config_core();
 import { execFile } from "node:child_process";
-import { readFile as readFile23 } from "node:fs/promises";
+import { readFile as readFile24 } from "node:fs/promises";
 import path64 from "node:path";
 import { promisify } from "node:util";
 var execFileAsync = promisify(execFile);
@@ -19743,7 +19797,7 @@ async function gitHasUncommittedChanges(dir) {
 async function defaultName(dir) {
   try {
     const parsed = JSON.parse(
-      await readFile23(path64.join(dir, "package.json"), "utf8")
+      await readFile24(path64.join(dir, "package.json"), "utf8")
     );
     if (typeof parsed.name === "string" && parsed.name.trim())
       return parsed.name.replace(/^@[^/]+\//, "");
@@ -21005,7 +21059,7 @@ async function upsertGatewayPlansFromManifest(client, config2, projectId, plans,
 }
 
 // src/cli/platform/helpers/openapi-gateway-servers.ts
-import { mkdir as mkdir16, readFile as readFile24, writeFile as writeFile19 } from "node:fs/promises";
+import { mkdir as mkdir16, readFile as readFile25, writeFile as writeFile19 } from "node:fs/promises";
 import path67 from "node:path";
 import YAML from "yaml";
 var GATEWAY_URL_ENV_KEY = "APITOGO_GATEWAY_URL";
@@ -21037,7 +21091,7 @@ async function resolveProjectGatewayUrl(client, projectId) {
   return null;
 }
 async function readOpenApiDocument(filePath) {
-  const content = await readFile24(filePath, "utf8");
+  const content = await readFile25(filePath, "utf8");
   const ext = path67.extname(filePath).toLowerCase();
   const parsed = ext === ".json" ? JSON.parse(content) : YAML.parse(content);
   if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
@@ -21066,7 +21120,7 @@ async function pointSiteApisAtPublishOpenApi(siteDirectory, relativeInput) {
     path67.resolve(siteDirectory),
     APITOGO_CONFIG_FILENAME2
   );
-  const raw = await readFile24(configPath, "utf8");
+  const raw = await readFile25(configPath, "utf8");
   const config2 = JSON.parse(raw);
   const previousApis = config2.apis;
   const previousBackend = config2.backend;
@@ -21083,7 +21137,7 @@ async function pointSiteApisAtPublishOpenApi(siteDirectory, relativeInput) {
 `, "utf8");
   return {
     restore: async () => {
-      const currentRaw = await readFile24(configPath, "utf8");
+      const currentRaw = await readFile25(configPath, "utf8");
       const current = JSON.parse(currentRaw);
       if (previousApis === void 0) {
         delete current.apis;
@@ -21118,7 +21172,7 @@ async function prepareOpenApiServersForGatewayBuild(options) {
   );
   if (!openApiPath) {
     try {
-      const raw = await readFile24(
+      const raw = await readFile25(
         path67.join(siteDirectory, APITOGO_CONFIG_FILENAME2),
         "utf8"
       );
@@ -21192,7 +21246,7 @@ function collectManifestPublicActionKeys(gateway) {
 }
 
 // src/cli/platform/helpers/publish-ledger.ts
-import { mkdir as mkdir17, readFile as readFile25, writeFile as writeFile20 } from "node:fs/promises";
+import { mkdir as mkdir17, readFile as readFile26, writeFile as writeFile20 } from "node:fs/promises";
 import path68 from "node:path";
 var PUBLISH_LEDGER_RELATIVE_PATH = ".apitogo/publish-state.json";
 function publishLedgerPath(siteDirectory) {
@@ -21201,7 +21255,7 @@ function publishLedgerPath(siteDirectory) {
 async function readPublishLedger(siteDirectory) {
   const filePath = publishLedgerPath(siteDirectory);
   try {
-    const raw = await readFile25(filePath, "utf8");
+    const raw = await readFile26(filePath, "utf8");
     const parsed = JSON.parse(raw);
     if (parsed?.version !== 1 || !Array.isArray(parsed.steps)) {
       return null;
@@ -21330,7 +21384,7 @@ function buildPostPublishChecklist(args) {
   if (args.gatewayUrl) {
     items.push({
       id: "test_gateway",
-      label: "Call the API gateway with Ocp-Apim-Subscription-Key",
+      label: "Call the API gateway with X-API-Key",
       required: false,
       completed: false,
       url: args.gatewayUrl
@@ -23472,7 +23526,7 @@ async function resolveProjectIdForPublish(client, config2, args, wait, progress,
 import path75 from "node:path";
 
 // src/cli/platform/helpers/dev-portal-site-api-url.ts
-import { readdir as readdir5, readFile as readFile26, writeFile as writeFile21 } from "node:fs/promises";
+import { readdir as readdir5, readFile as readFile27, writeFile as writeFile21 } from "node:fs/promises";
 import path72 from "node:path";
 var SITE_API_BASE_URL_ENV_KEY = "VITE_APITOGO_AUTHENTICATION_API_BASE_URL";
 var PLACEHOLDER_HOST_MARKERS = [
@@ -23497,7 +23551,7 @@ async function readSiteApiBaseUrl(sourceDirectory) {
   const resolved = path72.resolve(sourceDirectory);
   for (const envFile of [".env", ".env.production"]) {
     try {
-      const content = await readFile26(path72.join(resolved, envFile), "utf8");
+      const content = await readFile27(path72.join(resolved, envFile), "utf8");
       const lines = [...content.matchAll(ENV_LINE_GLOBAL_RE)];
       if (lines.length === 0) {
         continue;
@@ -23528,7 +23582,7 @@ async function patchSiteApiBaseUrl(sourceDirectory, apiBaseUrl) {
   for (const envFile of [".env.production", ".env"]) {
     const envPath = path72.join(resolved, envFile);
     try {
-      const content = await readFile26(envPath, "utf8");
+      const content = await readFile27(envPath, "utf8");
       const withoutAssignments = content.replace(ENV_LINE_GLOBAL_RE, "").replace(/\n{3,}/g, "\n\n").trimEnd();
       const patched = withoutAssignments ? `${withoutAssignments}
 ${line2}
@@ -23608,7 +23662,7 @@ async function assertDeployableDistHasLiveApiBaseUrl(distDirectory, expectedApiB
   let found = false;
   let foundPlaceholder = false;
   for await (const file of walkFiles(dist)) {
-    const content = await readFile26(file, "utf8");
+    const content = await readFile27(file, "utf8");
     if (content.includes(needle)) {
       found = true;
     }
@@ -26233,7 +26287,7 @@ import path79 from "node:path";
 
 // src/cli/deploy/gateway.ts
 import { createHash as createHash4 } from "node:crypto";
-import { readFile as readFile27 } from "node:fs/promises";
+import { readFile as readFile28 } from "node:fs/promises";
 init_invariant();
 var GatewayDeployError = class extends ApitogoError {
   constructor(code, message, developerHint) {
@@ -26271,7 +26325,7 @@ async function readSpec(gateway) {
       "Add one to gateway.specs in the config."
     );
   try {
-    return await readFile27(file);
+    return await readFile28(file);
   } catch {
     throw new GatewayDeployError(
       "GATEWAY_SPEC_UNREADABLE",
@@ -26619,7 +26673,9 @@ async function deployGateway(resolved, projectId, deps, options = {}) {
             baseUrl,
             capabilities: capabilities.capabilities,
             openapiUrl: status2.openApiPath ?? void 0,
-            openapiHash: status2.openApiHash ?? status2.specSha256 ?? void 0
+            openapiHash: status2.openApiHash ?? status2.specSha256 ?? void 0,
+            // The portal's keys page and API page show this header (API-120).
+            keyHeaderName: resolved.gateway?.policies.access?.apiKeyHeader ?? DEFAULT_KEY_HEADER
           })
         );
       }

package/dist/declarations/lib/plugins/openapi/util/createHttpSnippet.d.ts

@@ -1,5 +1,7 @@
 import { HTTPSnippet } from "@zudoku/httpsnippet";
 import type { OperationsFragmentFragment } from "../graphql/graphql.js";
+export declare const KEY_HEADER_EXTENSION = "x-apitogo-key-header";
+export declare const KEY_PLACEHOLDER = "YOUR_API_KEY";
 export declare const createHttpSnippet: ({ operation, selectedServer, exampleBody, }: {
     operation: OperationsFragmentFragment;
     selectedServer: string;

package/package.json

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

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

@@ -105,7 +105,7 @@ export const FULL_SPEC = (name: string) => `openapi: 3.1.0
 info:
   title: ${JSON.stringify(name)}
   version: 1.0.0
-  description: A small sample API. Edit server/index.js and this file together.
+  description: A sample API with a greeting and a list of items.
 paths:
   /health:
     get: