@lukoweb/apitogo 0.2.42 → 0.2.44

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

@@ -0,0 +1,192 @@
+/**
+ * The backend of the full template: a small Node.js server with no dependencies, so the platform can build and run it
+ * as it is (`npm start`, port from `PORT`), and the OpenAPI file that describes it. The two must list the same
+ * endpoints: the gateway only forwards what the file names, and the API reference shows the file.
+ */
+
+/** The folder of the backend code, relative to the project. */
+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) =>
+  `${
+    name
+      .toLowerCase()
+      .replace(/[^a-z0-9-]+/g, "-")
+      .replace(/^-+|-+$/g, "") || "api"
+  }-server`;
+
+/** The files of the server, by path relative to its folder. */
+export function fullServerFiles(name: string): Record<string, string> {
+  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,
+    )}\n`,
+    "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.
+`,
+  };
+}
+
+/** The OpenAPI file of the full template, matching `fullServerFiles`. */
+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.
+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
+`;