@lukoweb/apitogo 0.2.42 → 0.2.43

package/dist/cli/cli.js

@@ -7322,14 +7322,22 @@ function missingManifestServices(resolved, manifest) {
     )
   );
 }
+var PREVIEW_MANAGED_ORIGIN_URL = "http://localhost:8080";
+function previewGatewayUrl(resolved) {
+  const gateway = resolved.gateway;
+  if (gateway?.enabled !== true) return void 0;
+  return gateway.origin.mode === "proxy" ? gateway.origin.url : PREVIEW_MANAGED_ORIGIN_URL;
+}
 function stubManifest(resolved) {
   const portal = resolved.portal;
   const consoleOn = portal?.enabled === true && portal.console.enabled;
+  const gatewayUrl = previewGatewayUrl(resolved);
   return parseManifest({
     schemaVersion: SUPPORTED_MANIFEST_SCHEMA,
     preview: true,
     project: { id: resolved.project.id, name: resolved.project.name },
     services: {
+      ...gatewayUrl ? { gateway: { status: "ready", baseUrl: gatewayUrl } } : {},
       ...consoleOn && resolved.identity?.enabled ? {
         identity: {
           provider: "apitogo",
@@ -7924,6 +7932,17 @@ function planPortal(profile, manifest) {
     skip("console", "portal.console.enabled is false");
     return plan2;
   }
+  if (plan2.preview && identity && !identity.issuer) {
+    plan2.demo = true;
+    plan2.userPanel = true;
+    skip("sign-in", "preview: the demo account signs in");
+    if (plans)
+      plan2.plansPlugin = {
+        billing: "none",
+        links: plan2.apiReference ? { api: `/${API_REFERENCE_PATH}` } : {}
+      };
+    return plan2;
+  }
   if (!identity) {
     skip("sign-in", "services.json has no identity entry");
   } else if (!serviceReady(identity)) {
@@ -8026,22 +8045,26 @@ function buildSiteConfig(resolved, plan2, theme, extras = {}) {
       ]
     } : {},
     ...navigation.length > 0 ? { navigation } : {},
-    // The sidebar link above is only seen inside the docs; the header is what every page shows.
+    // The sidebar link above is only seen inside the docs; the header is what every page shows. A header navigation
+    // replaces the docs tab, so the docs get a header link of their own.
     ...plan2.apiReference ? {
       header: {
         navigation: [
+          ...plan2.docs && extras.docsPath ? [{ label: "Documentation", to: extras.docsPath }] : [],
           { label: "API Reference", to: `/${API_REFERENCE_PATH}` }
         ]
       }
     } : {},
+    ...extras.demoPlans?.length ? { plans: extras.demoPlans } : {},
     ...redirects.length > 0 ? { redirects } : {},
     ...extras.protectedRoutes?.length ? { protectedRoutes: extras.protectedRoutes } : {},
     ...theme !== void 0 ? { theme } : {},
-    ...plan2.auth ? { authentication: authenticationFor(plan2) } : {},
+    ...plan2.auth || plan2.demo ? { authentication: authenticationFor(plan2) } : {},
     ...plan2.preview ? { preview: true } : {}
   };
 }
 function authenticationFor(plan2) {
+  if (plan2.demo) return { type: "dev-portal", demoMode: true };
   if (plan2.plansPlugin)
     return {
       type: "dev-portal",
@@ -8053,7 +8076,7 @@ function authenticationFor(plan2) {
   const { audience: _audience, ...signIn } = plan2.auth ?? {};
   return { type: "openid", ...signIn };
 }
-var PREVIEW_BANNER_MESSAGE = "Preview mode: sign-in and plans use a stand-in manifest. Run `apitogo deploy` for the real services.";
+var PREVIEW_BANNER_MESSAGE = "Preview mode: sign in with demo@apitogo.local / password to try the console. Run `apitogo deploy` for the real services.";
 function renderWrapper(plan2) {
   const imports = [
     'import { buildApitogoConfig } from "@lukoweb/apitogo/build-config";',
@@ -8077,6 +8100,15 @@ function renderWrapper(plan2) {
     ""
   ].join("\n");
 }
+async function readDemoPlans(file) {
+  if (!file) return void 0;
+  try {
+    const parsed = JSON.parse(await readFile6(file, "utf8"));
+    return Array.isArray(parsed.plans) ? parsed.plans : void 0;
+  } catch {
+    return void 0;
+  }
+}
 async function readTheme(resolved) {
   const file = resolved.portal?.theme;
   if (!file) return void 0;
@@ -8164,6 +8196,8 @@ async function preparePortal(resolved, manifest, mode, options = {}) {
     {
       redirects: home ? [home] : [],
       docsNavigation: docsNavigation(hostedDocRoutes),
+      docsPath: pickLandingRoute(hostedDocRoutes),
+      demoPlans: plan2.demo && plan2.plansPlugin ? await readDemoPlans(resolved.plans?.file) : void 0,
       protectedRoutes: protectedRoutesFor({
         requireAuth: resolved.portal?.requireAuth,
         hasAuth: !!plan2.auth,
@@ -8337,6 +8371,178 @@ import {
 } from "node:fs/promises";
 import path14 from "node:path";
 
+// src/config/v2/full-server.ts
+var FULL_SERVER_SOURCE = "server";
+var FULL_SERVER_RUNTIME = "nodejs";
+var FULL_SERVER_RUNTIME_VERSION = "NODE_22_LTS";
+var FULL_SERVER_HEALTH_PATH = "/health";
+var packageName = (name) => `${name.toLowerCase().replace(/[^a-z0-9-]+/g, "-").replace(/^-+|-+$/g, "") || "api"}-server`;
+function fullServerFiles(name) {
+  return {
+    "package.json": `${JSON.stringify(
+      {
+        name: packageName(name),
+        version: "1.0.0",
+        private: true,
+        type: "module",
+        main: "index.js",
+        scripts: { start: "node index.js" },
+        engines: { node: ">=22" }
+      },
+      null,
+      2
+    )}
+`,
+    "index.js": `// A small API for ${JSON.stringify(name)}. Every endpoint here is listed in apitogo/apis/openapi.yaml:
+// add an endpoint in both places, then run \`apitogo deploy\`.
+import { createServer } from "node:http";
+
+const items = [
+  { id: "1", name: "First item" },
+  { id: "2", name: "Second item" },
+  { id: "3", name: "Third item" },
+];
+
+// Lets the portal's API page call this server while you run it locally (\`apitogo dev\`). Once deployed, the gateway
+// answers browsers itself and keeps its own list of allowed sites.
+const cors = {
+  "access-control-allow-origin": "*",
+  "access-control-allow-methods": "GET, OPTIONS",
+  "access-control-allow-headers": "*",
+};
+
+function send(res, status, body) {
+  res.writeHead(status, { "content-type": "application/json", ...cors });
+  res.end(JSON.stringify(body));
+}
+
+const server = createServer((req, res) => {
+  const url = new URL(req.url ?? "/", "http://localhost");
+  const itemMatch = url.pathname.match(/^\\/items\\/([^/]+)$/);
+
+  if (req.method === "OPTIONS") {
+    res.writeHead(204, cors);
+    return res.end();
+  }
+  if (req.method !== "GET") return send(res, 405, { error: "Method not allowed" });
+  if (url.pathname === "/health") return send(res, 200, { status: "ok" });
+  if (url.pathname === "/hello") {
+    const who = url.searchParams.get("name") || "world";
+    return send(res, 200, { message: \`Hello, \${who}!\` });
+  }
+  if (url.pathname === "/items") return send(res, 200, items);
+  if (itemMatch) {
+    const item = items.find((candidate) => candidate.id === itemMatch[1]);
+    return item ? send(res, 200, item) : send(res, 404, { error: "Item not found" });
+  }
+  return send(res, 404, { error: "Not found" });
+});
+
+const port = Number(process.env.PORT) || 8080;
+server.listen(port, () => console.log(\`API listening on port \${port}\`));
+`,
+    "README.md": `# ${name} server
+
+A small Node.js API with no dependencies, created by \`apitogo create --template full\`.
+
+- Run it locally: \`npm start\` (port 8080, or \`PORT\`)
+- Deploy it: \`apitogo deploy\` from the project folder
+
+Every endpoint in \`index.js\` is also listed in \`apitogo/apis/openapi.yaml\`. Keep the two in step: the gateway only
+forwards the endpoints the file names, and the API reference of the portal is built from it.
+`
+  };
+}
+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.
+paths:
+  /health:
+    get:
+      operationId: getHealth
+      summary: Health check
+      responses:
+        "200":
+          description: The service is up.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    example: ok
+  /hello:
+    get:
+      operationId: getHello
+      summary: Say hello
+      parameters:
+        - name: name
+          in: query
+          required: false
+          description: Who to greet.
+          schema:
+            type: string
+            example: developer
+      responses:
+        "200":
+          description: A greeting.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Hello, developer!
+  /items:
+    get:
+      operationId: listItems
+      summary: List items
+      responses:
+        "200":
+          description: All items.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Item"
+  /items/{id}:
+    get:
+      operationId: getItem
+      summary: Get one item
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+            example: "1"
+      responses:
+        "200":
+          description: The item.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Item"
+        "404":
+          description: No item has this id.
+components:
+  schemas:
+    Item:
+      type: object
+      properties:
+        id:
+          type: string
+          example: "1"
+        name:
+          type: string
+          example: First item
+`;
+
 // src/config/v2/starter-landing.ts
 function starterLandingPage(options) {
   const name = JSON.stringify(options.name);
@@ -8523,6 +8729,7 @@ var serviceLabel = (service) => `${SERVICE_LABELS[service]} (${service})`;
 function isServiceName(value) {
   return SERVICES.includes(value);
 }
+var isFilled = (template) => template === "starter" || template === "full";
 var exists3 = (target) => access3(target).then(
   () => true,
   () => false
@@ -8688,7 +8895,7 @@ async function buildPortal(context) {
       const pages = path14.join(resolved.root, "portal", "pages");
       if (template === "blank")
         await addFile(context, path14.join(pages, ".gitkeep"), "");
-      else if (options.template === "starter") {
+      else if (isFilled(options.template)) {
         await addFile(
           context,
           path14.join(pages, "introduction.mdx"),
@@ -8727,21 +8934,30 @@ async function buildPortal(context) {
     ...o.search && !external ? { search: o.search } : {}
   };
 }
-async function createSourceFolder(context, sourcePath) {
+async function createSourceFolder(context, sourcePath, runtime) {
   const folder = path14.join(context.dir, sourcePath);
   const entries = await readdir3(folder).catch(() => []);
-  if (entries.some((name) => name !== ".gitkeep")) return;
+  if (entries.some((name) => name !== ".gitkeep")) return false;
+  if (context.options.template === "full" && runtime === FULL_SERVER_RUNTIME) {
+    for (const [file, content] of Object.entries(
+      fullServerFiles(context.resolved.project.name)
+    ))
+      await addFile(context, path14.join(folder, file), content);
+    return true;
+  }
   if (entries.length === 0)
     await addFile(context, path14.join(folder, ".gitkeep"), "");
   context.notes.push(
     `The folder ${sourcePath}/ is empty: put your backend code there before you deploy.`
   );
+  return false;
 }
 async function buildGateway(context) {
   const { options, dir, resolved } = context;
   const o = options.gateway ?? {};
   const ask4 = options.ask;
-  let mode = o.origin ?? (o.url ? "proxy" : o.source || o.runtime ? "managed" : void 0);
+  const full = options.template === "full" && !o.url && o.origin !== "proxy";
+  let mode = o.origin ?? (o.url ? "proxy" : o.source || o.runtime || full ? "managed" : void 0);
   if (!mode && ask4) {
     mode = await ask4.choose("How does the gateway reach your API?", [
       {
@@ -8761,6 +8977,7 @@ async function buildGateway(context) {
     );
   }
   let origin;
+  let sampleServer = false;
   if (mode === "proxy") {
     const url2 = o.url ?? (ask4 ? await ask4.text("https address of your API", {
       validate: httpsProblem
@@ -8769,15 +8986,15 @@ async function buildGateway(context) {
       throw new ServiceEditError("--origin proxy needs --url <https url>.");
     origin = { mode, url: url2 };
   } else {
-    const source = o.source ?? (ask4 ? await ask4.text("Folder with your code, relative to the project", {
+    const source = o.source ?? (full ? FULL_SERVER_SOURCE : void 0) ?? (ask4 ? await ask4.text("Folder with your code, relative to the project", {
       default: "server"
     }) : void 0);
-    const runtime = o.runtime ?? (ask4 ? await ask4.choose("Runtime of your code", [
+    const runtime = o.runtime ?? (full ? FULL_SERVER_RUNTIME : void 0) ?? (ask4 ? await ask4.choose("Runtime of your code", [
       { value: "nodejs", label: "Node.js" },
       { value: "python", label: "Python" },
       { value: "dotnet", label: ".NET" }
     ]) : void 0);
-    const runtimeVersion = o.runtimeVersion !== void 0 && runtime ? runtimeVersionSlug(runtime, o.runtimeVersion) : ask4 && runtime ? await ask4.choose(
+    const runtimeVersion = o.runtimeVersion !== void 0 && runtime ? runtimeVersionSlug(runtime, o.runtimeVersion) : full && runtime === FULL_SERVER_RUNTIME ? FULL_SERVER_RUNTIME_VERSION : ask4 && runtime ? await ask4.choose(
       "Runtime version",
       RUNTIME_VERSIONS[runtime].map((choice, index) => ({
         value: choice.value,
@@ -8791,14 +9008,15 @@ async function buildGateway(context) {
       );
     }
     const sourcePath = insideProject(dir, source, "Source folder");
+    sampleServer = await createSourceFolder(context, sourcePath, runtime);
     origin = {
       mode,
       source: sourcePath,
       runtime,
       runtimeVersion,
-      ...o.exclude?.length ? { exclude: o.exclude } : {}
+      ...o.exclude?.length ? { exclude: o.exclude } : {},
+      ...sampleServer ? { healthPath: FULL_SERVER_HEALTH_PATH } : {}
     };
-    await createSourceFolder(context, sourcePath);
   }
   let specs;
   let requestedSpecs = o.spec ?? [];
@@ -8833,7 +9051,7 @@ async function buildGateway(context) {
     await addFile(
       context,
       target,
-      options.template === "blank" ? BLANK_SPEC(resolved.project.name) : STARTER_SPEC(resolved.project.name)
+      options.template === "blank" ? BLANK_SPEC(resolved.project.name) : sampleServer ? FULL_SPEC(resolved.project.name) : STARTER_SPEC(resolved.project.name)
     );
     specs = [rel(dir, target)];
   } else {
@@ -8921,7 +9139,7 @@ async function buildIdentity(context) {
 async function buildPlans(context) {
   const { options, dir, resolved } = context;
   const o = options.plans ?? {};
-  const template = o.template ?? (options.template === "blank" ? "none" : options.template === "starter" ? "starter" : "free");
+  const template = o.template ?? (options.template === "blank" ? "none" : isFilled(options.template) ? "starter" : "free");
   const billing = o.billing ?? (template === "tiered" ? "stripe" : "none");
   if (template === "tiered" && billing === "none") {
     throw new ServiceEditError(
@@ -10371,7 +10589,7 @@ import {
 // package.json
 var package_default = {
   name: "@lukoweb/apitogo",
-  version: "0.2.42",
+  version: "0.2.43",
   type: "module",
   sideEffects: [
     "**/*.css",
@@ -14426,7 +14644,11 @@ function vitePlugin() {
 import { lstatSync, realpathSync } from "node:fs";
 import path40 from "node:path";
 var STATE_INSIDE_CONTENT = /[\\/]content[\\/](?:\.apitogo|apitogo[\\/]\.state)(?:[\\/]|$)/;
-var within = (base, file) => file === base || file.startsWith(base + path40.sep);
+var within = (base, file) => {
+  const resolvedBase = path40.resolve(base);
+  const resolvedFile = path40.resolve(file);
+  return resolvedFile === resolvedBase || resolvedFile.startsWith(resolvedBase + path40.sep);
+};
 var unique = (paths) => [...new Set(paths)];
 function isWorkspace(root) {
   try {
@@ -16216,7 +16438,7 @@ function addOptionsFromArguments(service, argv) {
     dir,
     disabled: argv.disabled === true,
     acceptAllDocs: argv.yes === true,
-    template: argv.template === "blank" || argv.template === "none" ? "blank" : argv.template === "starter" ? "starter" : void 0,
+    template: argv.template === "blank" || argv.template === "none" ? "blank" : argv.template === "starter" || argv.template === "full" ? argv.template : void 0,
     portal: service === "portal" ? {
       name: argv.name,
       docs: parseDocsFlag(argv.docs),
@@ -16554,8 +16776,15 @@ var add_default = {
     describe: "plans: catalog file (default <root>/plans.json)"
   }).option("template", {
     type: "string",
-    choices: ["blank", "starter", "free", "tiered", "none"],
-    describe: "Content to create: blank (empty shell) or starter (filled example). Plans also accept free, tiered and none; none is blank"
+    choices: [
+      "blank",
+      "starter",
+      "full",
+      "free",
+      "tiered",
+      "none"
+    ],
+    describe: "Content to create: blank (empty shell), starter (filled example) or full (starter plus a Node.js backend in server/). Plans also accept free, tiered and none; none is blank"
   }).option("billing", {
     type: "string",
     choices: ["stripe", "none"],
@@ -21341,9 +21570,15 @@ import { promisify } from "node:util";
 var execFileAsync = promisify(execFile);
 function nextStepHint(dir) {
   const linked = loadConfigV2(dir).resolved.project.id;
-  return linked ? "Next: apitogo deploy" : "Next: apitogo project create, then apitogo deploy";
+  const cd = path70.resolve(dir) === path70.resolve(process.cwd());
+  const steps = linked ? "apitogo deploy" : "apitogo project create, then apitogo deploy";
+  return cd ? `Next: ${steps}` : `Next: cd ${JSON.stringify(path70.relative(process.cwd(), dir))}, then ${steps}`;
+}
+function projectFolderName(name) {
+  return name.trim().replace(/[<>:"/\\|?*\s]+/g, "-").replace(/^[-.]+|[-.]+$/g, "") || "apitogo-project";
 }
 var DONE = "done";
+var TEMPLATES = ["full", "blank", "starter"];
 var STARTER_SERVICES = [
   "gateway",
   "identity",
@@ -21395,23 +21630,37 @@ async function createProject(argv, deps = {}) {
     if (!json) printDiagnosticsToConsole(line2);
   };
   try {
-    const dir = path70.resolve(process.cwd(), argv.dir ?? ".");
+    const base = path70.resolve(process.cwd(), argv.dir ?? ".");
+    let dir = base;
     let requested = parseServicesFlag(argv.services);
     let template = argv.template;
-    if (!asker && requested.length === 0) {
+    if (template !== void 0 && !TEMPLATES.includes(template))
+      throw new InitError(
+        `Unknown template: ${template}.`,
+        "Use --template full or --template blank."
+      );
+    const templateServices = template === "starter" || template === "full";
+    if (!asker && requested.length === 0 && !templateServices) {
       throw new InitError(
         "create needs a terminal to ask its questions, and none is available.",
-        "Pass --services <portal,gateway,identity,plans> (and --template blank|starter), or run `apitogo init` and `apitogo add <service>`."
+        "Pass --template full, or --services <portal,gateway,identity,plans> (and --template blank|starter|full), or run `apitogo init` and `apitogo add <service>`."
       );
     }
+    const existing = await isConfigV2(base);
+    let name;
+    if (!existing) {
+      name = argv.name?.trim() || (asker ? await asker.text("Project name", {
+        default: await defaultName(base)
+      }) : await defaultName(base));
+      const folder = projectFolderName(name);
+      if (argv.dir === void 0 && folder !== path70.basename(base))
+        dir = path70.join(base, folder);
+    }
     if (await (deps.hasUncommittedChanges ?? gitHasUncommittedChanges)(dir))
       say(
         "This folder has uncommitted changes. Commit first so you can undo this easily."
       );
-    if (!await isConfigV2(dir)) {
-      const name = argv.name?.trim() || (asker ? await asker.text("Project name", {
-        default: await defaultName(dir)
-      }) : await defaultName(dir));
+    if (name !== void 0 && !await isConfigV2(dir)) {
       const plan2 = await planInit({ dir, name });
       for (const line2 of formatInitPlan(plan2)) say(line2);
       commands.push(`apitogo init --name ${JSON.stringify(name)}`);
@@ -21431,7 +21680,9 @@ async function createProject(argv, deps = {}) {
         return;
       }
       await applyInitPlan(plan2);
-      say(`Created ${APITOGO_CONFIG_FILENAME}.`);
+      say(
+        dir === base ? `Created ${APITOGO_CONFIG_FILENAME}.` : `Created ${path70.relative(base, dir)}${path70.sep}${APITOGO_CONFIG_FILENAME}.`
+      );
     } else {
       say(`${APITOGO_CONFIG_FILENAME} exists: continuing from it.`);
     }
@@ -21440,17 +21691,17 @@ async function createProject(argv, deps = {}) {
         "What do you want to start from?",
         [
           {
-            value: "starter",
-            label: "Starter: every service with examples (home page, sample plans, API reference)"
+            value: "full",
+            label: "Full: every service with examples and a small Node.js backend, ready to deploy"
           },
           { value: "blank", label: "Blank: choose the services one by one" }
         ]
       );
-    if (template === "starter" && requested.length === 0)
+    if ((template === "starter" || template === "full") && requested.length === 0)
       requested = STARTER_SERVICES;
     const stepArgs = (service) => ({
       service,
-      dir: argv.dir,
+      dir,
       template,
       dryRun: argv.dryRun,
       install: argv.install,
@@ -21531,8 +21782,7 @@ var create_default = {
   command: "create",
   builder: (yargs2) => yargs2.option("dir", {
     type: "string",
-    describe: "Project directory",
-    default: ".",
+    describe: "Project directory (default: a new folder named after the project)",
     normalize: true,
     hidden: true
   }).option("name", {
@@ -21543,8 +21793,8 @@ var create_default = {
     describe: "Skip the menu and add these services, comma separated (portal, gateway, identity, plans)"
   }).option("template", {
     type: "string",
-    choices: ["blank", "starter"],
-    describe: "Template for the services added (default: ask)"
+    // `starter` is still accepted for older scripts but no longer offered: `full` replaces it.
+    describe: "Template: full (every service, a sample Node.js backend, ready to deploy) or blank. Default: ask"
   }).option("input", {
     type: "boolean",
     default: true,

package/package.json

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