@qelos/plugin-netlify-api 1.0.4 → 1.0.5

package/README.md

@@ -19,6 +19,19 @@ In your site’s `netlify.toml`, add the plugin next to your existing `[build]`
   package = "@qelos/plugin-netlify-api"
 ```
 
+**Nuxt / static frameworks (required):** Netlify evaluates `dist/_redirects` **before** `netlify.toml`. Nitro’s `netlify-static` preset emits a catch‑all `/*` rule first, so you must prepend the API rewrite **after** `nuxt build`. Add an npm **`postbuild`** script (runs automatically when Netlify runs `npm run build`):
+
+```json
+{
+  "scripts": {
+    "build": "nuxt build",
+    "postbuild": "qelos-netlify-patch-redirects"
+  }
+}
+```
+
+If your publish directory is not `dist`, set `QELOS_NETLIFY_PUBLISH` to that folder name (relative to the app root) for the patch script.
+
 Minimal variant (defaults API URL inside the plugin if you omit env):
 
 ```toml
@@ -43,7 +56,7 @@ Optional: set the API URL (default `http://159.203.152.168`) and/or enable bypas
 ## What it does
 
 - **Environment:** Sets `QELOS_API_IP` for the build (and for the proxy function at runtime).
-- **Redirect:** Adds a rewrite in `netlify.toml` and, **after the site build**, prepends the same rule to **`publish/_redirects`** when that file exists. Netlify applies `_redirects` **before** `netlify.toml`; frameworks (e.g. Nuxt `netlify-static`) often emit `/* → /404.html` first, which would otherwise match `/api/*` and never reach the proxy.
+- **Redirect:** Adds a rewrite in `netlify.toml` and ships **`qelos-netlify-patch-redirects`** to prepend the same line to **`publish/_redirects`** (use the **`postbuild`** script above — do not rely on the build plugin alone for Nuxt).
 - **Function:** Copies `qelos-api-proxy.ts` from the package into your Netlify **functions directory** (default `netlify/functions`, or `[functions] directory` in `netlify.toml`) during `onPreBuild`, so the bundler sees a normal function file. Forwards requests using `QELOS_API_IP` / `API_HOST` (full URL or hostname).
 
 No need to add redirects or commit the proxy yourself; the plugin writes it each build. Optional: add `netlify/functions/qelos-api-proxy.ts` to `.gitignore` if you run local Netlify builds and do not want the copy tracked.

package/index.js

@@ -1,17 +1,26 @@
 const fs = require('node:fs/promises');
 const path = require('node:path');
 
-const DEFAULT_API_URL = 'http://159.203.152.168';
+const { patchRedirects } = require('./scripts/patch-redirects.cjs');
 
-/** Must appear before any `/*` rule in publish/_redirects — Netlify evaluates that file before netlify.toml. */
-const REDIRECTS_FILE_LINE =
-  '/api/* /.netlify/functions/qelos-api-proxy 200!\n';
+const DEFAULT_API_URL = 'http://159.203.152.168';
 
 function resolveFunctionsDirectory(netlifyConfig) {
   const dir = netlifyConfig.functions?.directory ?? 'netlify/functions';
   return path.isAbsolute(dir) ? dir : path.join(process.cwd(), dir);
 }
 
+function resolvePublishDir(constants, netlifyConfig) {
+  if (constants?.PUBLISH_DIR) {
+    return constants.PUBLISH_DIR;
+  }
+  const p = netlifyConfig?.build?.publish;
+  if (!p) {
+    return path.join(process.cwd(), 'dist');
+  }
+  return path.isAbsolute(p) ? p : path.join(process.cwd(), p);
+}
+
 module.exports = {
   async onPreBuild({ netlifyConfig, inputs }) {
     const apiUrl =
@@ -53,21 +62,14 @@ module.exports = {
   },
 
   /**
-   * Nuxt/static generators emit `dist/_redirects` with `/* → 404` first. Netlify runs
-   * `_redirects` rules before `netlify.toml`, so that catch-all wins unless `/api/*` is
-   * prepended here (after the framework build).
+   * Best-effort: some Netlify builds omit logging or skip this hook; the supported fix
+   * for Nuxt is `postbuild` → `qelos-netlify-patch-redirects` (see README).
    */
-  async onPostBuild({ constants }) {
-    const publishDir = constants.PUBLISH_DIR;
-    if (!publishDir) return;
-    const redirectsPath = path.join(publishDir, '_redirects');
-    let existing = '';
-    try {
-      existing = await fs.readFile(redirectsPath, 'utf8');
-    } catch (e) {
-      if (e.code !== 'ENOENT') throw e;
-    }
-    if (existing.includes('qelos-api-proxy')) return;
-    await fs.writeFile(redirectsPath, REDIRECTS_FILE_LINE + existing, 'utf8');
+  async onPostBuild({ constants, netlifyConfig }) {
+    const publishDir = resolvePublishDir(constants, netlifyConfig);
+    const changed = patchRedirects(publishDir);
+    console.log(
+      `[@qelos/plugin-netlify-api] onPostBuild: ${changed ? 'patched' : 'skipped'} ${path.join(publishDir, '_redirects')}`,
+    );
   },
 };

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@qelos/plugin-netlify-api",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Netlify build plugin: proxy /api/* to Qelos API and inject config",
   "main": "index.js",
+  "bin": {
+    "qelos-netlify-patch-redirects": "./scripts/patch-redirects.cjs"
+  },
   "files": [
     "index.js",
     "manifest.yml",
-    "functions"
+    "functions",
+    "scripts"
   ],
   "author": "David Meir-Levy <davidmeirlevy@gmail.com>",
   "license": "MIT",

package/scripts/patch-redirects.cjs

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * Prepend `/api/*` → qelos-api-proxy to publish/_redirects *before* Netlify deploy.
+ * Netlify evaluates `_redirects` before netlify.toml; Nuxt `netlify-static` emits
+ * `/* → /404.html` first — without this line, `/api/*` never reaches the function.
+ *
+ * Run via npm lifecycle: "postbuild": "qelos-netlify-patch-redirects"
+ * (postbuild runs automatically after `nuxt build` when Netlify runs `npm run build`).
+ */
+
+const fs = require('node:fs');
+const path = require('node:path');
+
+const REDIRECT_LINE = '/api/* /.netlify/functions/qelos-api-proxy 200!\n';
+
+/**
+ * @param {string} publishDir absolute path to the directory Netlify deploys (e.g. …/dist)
+ * @returns {boolean} true if the file was written
+ */
+function patchRedirects(publishDir) {
+  if (!publishDir) return false;
+  const redirectsPath = path.join(publishDir, '_redirects');
+  let existing = '';
+  try {
+    existing = fs.readFileSync(redirectsPath, 'utf8');
+  } catch (e) {
+    if (e.code !== 'ENOENT') throw e;
+  }
+  if (existing.includes('qelos-api-proxy')) {
+    return false;
+  }
+  fs.writeFileSync(redirectsPath, REDIRECT_LINE + existing, 'utf8');
+  return true;
+}
+
+function resolvePublishDirFromEnv() {
+  const rel = process.env.QELOS_NETLIFY_PUBLISH || 'dist';
+  return path.isAbsolute(rel) ? rel : path.join(process.cwd(), rel);
+}
+
+if (require.main === module) {
+  const abs = resolvePublishDirFromEnv();
+  const changed = patchRedirects(abs);
+  const target = path.join(abs, '_redirects');
+  if (changed) {
+    console.log(`[qelos-netlify-patch-redirects] prepended /api/* rewrite → ${target}`);
+  } else {
+    console.log(
+      `[qelos-netlify-patch-redirects] skipped (already has qelos-api-proxy) → ${target}`,
+    );
+  }
+}
+
+module.exports = { patchRedirects, REDIRECT_LINE };