@olenbetong/appframe-vite 6.3.5 → 6.5.0

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import type { Plugin } from "vite";
 import { addAppframeBuildConfig } from "./build.js";
 import { createDevMiddleware } from "./devServer.js";
+import { publishSafeOutput } from "./publishSafeOutput.js";
 export interface AppframePluginOptions {
     /**
      * Whether to automatically generate TypeScript types from the Appframe article
@@ -10,6 +11,14 @@ export interface AppframePluginOptions {
      * @default true
      */
     generateTypes?: boolean;
+    /**
+     * Whether to enable the Appframe devtools panel and toolbar in dev mode.
+     * Set to `false` to skip serving the devtools app and injecting the toolbar
+     * script (e.g. when running Storybook).
+     *
+     * @default true
+     */
+    devtools?: boolean;
 }
-export default function appframe(options?: AppframePluginOptions): Plugin;
-export { addAppframeBuildConfig, createDevMiddleware };
+export default function appframe(options?: AppframePluginOptions): Plugin[];
+export { addAppframeBuildConfig, createDevMiddleware, publishSafeOutput };

package/lib/index.js

@@ -10,6 +10,7 @@ import { localizeMiddleware } from "./localization.js";
 import { checkSession, getLastSession, login } from "./proxy.js";
 import { RESOURCES_CONFIG_FILE } from "./resourcesConfig.js";
 import { createLogMessage, getServerName } from "./utils.js";
+import { publishSafeOutput } from "./publishSafeOutput.js";
 let command = "build";
 let interval;
 let server;
@@ -33,8 +34,8 @@ catch (error) {
 }
 const jsonParser = bodyParser.json();
 export default function appframe(options = {}) {
-    let { generateTypes = true } = options;
-    return {
+    let { generateTypes = true, devtools = true } = options;
+    let plugin = {
         name: "appframe",
         resolveId(source) {
             if (source.startsWith("/file/") || source.startsWith("/lib/")) {
@@ -178,7 +179,9 @@ export default function appframe(options = {}) {
                 }, 300);
             });
             // DevTools panel: serve the devtools app + REST API at /__appframe_devtools__/
-            _server.middlewares.use("/__appframe_devtools__", createDevtoolsMiddleware(hostname));
+            if (devtools) {
+                _server.middlewares.use("/__appframe_devtools__", createDevtoolsMiddleware(hostname));
+            }
             _server.middlewares.use(`/api/user/localize/new/${appframe.article.id}`, jsonParser);
             _server.middlewares.use(`/api/user/localize/new/${appframe.article.id}`, localizeMiddleware);
             _server.middlewares.use("/data/Logger/LogError", jsonParser);
@@ -197,7 +200,7 @@ export default function appframe(options = {}) {
         },
         transformIndexHtml(_html, ctx) {
             // Only inject the toolbar in dev mode
-            if (command !== "serve")
+            if (command !== "serve" || !devtools)
                 return;
             // Only inject for article pages (not the devtools app itself)
             if (ctx.originalUrl?.startsWith("/__appframe_devtools__"))
@@ -211,5 +214,6 @@ export default function appframe(options = {}) {
             ];
         },
     };
+    return [plugin, publishSafeOutput()];
 }
-export { addAppframeBuildConfig, createDevMiddleware };
+export { addAppframeBuildConfig, createDevMiddleware, publishSafeOutput };

package/lib/publishSafeOutput.d.ts

@@ -0,0 +1,25 @@
+import { type Plugin } from "vite";
+/**
+ * Rewrites emitted JavaScript so that no line ever ends with a backslash.
+ *
+ * Appframe deploys an article by embedding every script verbatim in a generated SQL
+ * script, which the target server executes with SQLCMD semantics. There, a backslash
+ * at the end of a line is a line-continuation character: both the backslash and the
+ * line break are silently removed. A minified bundle containing a template literal
+ * such as `` `\\<newline>` `` (produced for the string "\\\n") therefore arrives as
+ * `` `\` `` on stage/prod, where the closing backtick has become an escaped backtick.
+ * The literal never terminates and the whole chunk fails to parse with a misleading
+ * "Unexpected identifier" SyntaxError.
+ *
+ * The rewrite is semantics-preserving:
+ *   - An even number of trailing backslashes means they are all escaped backslashes and
+ *     the line break is a literal character inside a template literal. The line break is
+ *     re-encoded as `\n` (or `\r\n`) so the physical line ends without a backslash.
+ *   - An odd number means the last backslash escapes the line break (a line continuation),
+ *     which contributes nothing to the value, so both are dropped.
+ *
+ * Because a physical line break is removed, source map line numbers for a rewritten chunk
+ * are off by one from that point on. Rewrites are rare (typically a single occurrence deep
+ * inside a vendor chunk), so this is accepted and reported as a build warning.
+ */
+export declare function publishSafeOutput(): Plugin;

package/lib/publishSafeOutput.js

@@ -0,0 +1,106 @@
+import { parseAst } from "vite";
+/**
+ * Rewrites emitted JavaScript so that no line ever ends with a backslash.
+ *
+ * Appframe deploys an article by embedding every script verbatim in a generated SQL
+ * script, which the target server executes with SQLCMD semantics. There, a backslash
+ * at the end of a line is a line-continuation character: both the backslash and the
+ * line break are silently removed. A minified bundle containing a template literal
+ * such as `` `\\<newline>` `` (produced for the string "\\\n") therefore arrives as
+ * `` `\` `` on stage/prod, where the closing backtick has become an escaped backtick.
+ * The literal never terminates and the whole chunk fails to parse with a misleading
+ * "Unexpected identifier" SyntaxError.
+ *
+ * The rewrite is semantics-preserving:
+ *   - An even number of trailing backslashes means they are all escaped backslashes and
+ *     the line break is a literal character inside a template literal. The line break is
+ *     re-encoded as `\n` (or `\r\n`) so the physical line ends without a backslash.
+ *   - An odd number means the last backslash escapes the line break (a line continuation),
+ *     which contributes nothing to the value, so both are dropped.
+ *
+ * Because a physical line break is removed, source map line numbers for a rewritten chunk
+ * are off by one from that point on. Rewrites are rare (typically a single occurrence deep
+ * inside a vendor chunk), so this is accepted and reported as a build warning.
+ */
+export function publishSafeOutput() {
+    return {
+        name: "appframe:publish-safe-output",
+        apply: "build",
+        enforce: "post",
+        generateBundle(_options, bundle) {
+            for (let output of Object.values(bundle)) {
+                if (output.type === "asset") {
+                    if (typeof output.source === "string" && /\\\r?\n/.test(output.source)) {
+                        this.warn(`${output.fileName} contains a backslash at the end of a line. Appframe's deploy will strip it, ` +
+                            `which may corrupt the file.`);
+                    }
+                    continue;
+                }
+                let result = rewrite(output.code);
+                if (result.rewrites === 0)
+                    continue;
+                if (!isStillValid(output.code, result.code)) {
+                    this.error(`Failed to make ${output.fileName} deploy-safe: the rewritten chunk no longer parses. ` +
+                        `It contains a backslash at the end of a line, which Appframe's deploy will strip.`);
+                }
+                output.code = result.code;
+                this.warn(`${output.fileName} had ${result.rewrites} line break(s) escaped so no line ends with a backslash, ` +
+                    `which Appframe's deploy would strip. Source map line numbers for this chunk are shifted.`);
+            }
+        },
+    };
+}
+/**
+ * Rewrites `code` so that no physical line ends with a backslash, and reports how many
+ * line breaks had to be rewritten.
+ */
+function rewrite(code) {
+    let lines = code.split("\n");
+    let out = "";
+    let rewrites = 0;
+    for (let i = 0; i < lines.length; i++) {
+        let isLast = i === lines.length - 1;
+        let raw = lines[i];
+        let hasCarriageReturn = !isLast && raw.endsWith("\r");
+        let content = hasCarriageReturn ? raw.slice(0, -1) : raw;
+        let backslashes = 0;
+        while (backslashes < content.length && content[content.length - 1 - backslashes] === "\\") {
+            backslashes++;
+        }
+        if (!isLast && backslashes > 0) {
+            rewrites++;
+            if (backslashes % 2 === 0) {
+                out += content + (hasCarriageReturn ? "\\r\\n" : "\\n");
+            }
+            else {
+                out += content.slice(0, -1);
+            }
+            continue;
+        }
+        out += content;
+        if (!isLast) {
+            out += hasCarriageReturn ? "\r\n" : "\n";
+        }
+    }
+    return { code: out, rewrites };
+}
+/**
+ * The rewrite is only safe for backslashes inside string and template literals. A line
+ * comment ending with a backslash would be merged with the following line, so verify the
+ * result still parses whenever the original did.
+ */
+function isStillValid(original, rewritten) {
+    try {
+        parseAst(original);
+    }
+    catch {
+        return true;
+    }
+    try {
+        parseAst(rewritten);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olenbetong/appframe-vite",
-  "version": "6.3.5",
+  "version": "6.5.0",
   "description": "Tools to use and deploy Vite applications to Appframe",
   "main": "./lib/index.js",
   "type": "module",
@@ -45,9 +45,9 @@
   },
   "devDependencies": {
     "@types/jsdom": "^27.0.0",
-    "@types/node": "26.1.1",
+    "@types/node": "26.1.2",
     "typescript": "7.0.2",
-    "vite": "8.1.5"
+    "vite": "8.2.0"
   },
   "peerDependencies": {
     "vite": ">=8.1.5"