@matdata/yasqe 5.15.0 → 5.17.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@matdata/yasqe",
   "description": "Yet Another SPARQL Query Editor",
-  "version": "5.15.0",
+  "version": "5.17.0",
   "main": "build/yasqe.min.js",
   "types": "build/ts/src/index.d.ts",
   "license": "MIT",

package/src/__tests__/share-test.ts

@@ -105,7 +105,7 @@ describe("Share Functionality", () => {
         "    }",
         '    ContentType = "application/x-www-form-urlencoded"',
         '    Body = "query=SELECT"',
-        '    OutFile = "result.json"',
+        '    OutFile = "sparql-generated.json"',
         "}",
         "",
         "Invoke-WebRequest @params",
@@ -117,6 +117,37 @@ describe("Share Functionality", () => {
       expect(psString).to.include("Headers");
       expect(psString).to.include("OutFile");
       expect(psString).to.include("Accept");
+      expect(psString).to.include("sparql-generated");
+    });
+
+    it("should format PowerShell commands with here-string for query", () => {
+      const query = "SELECT * WHERE { ?s ?p ?o }";
+      const lines = [
+        '$query = @"',
+        query,
+        '"@',
+        "",
+        "$params = @{",
+        '    Uri = "https://example.com/sparql"',
+        '    Method = "Post"',
+        "    Headers = @{",
+        '        "Accept" = "application/sparql-results+json"',
+        "    }",
+        '    ContentType = "application/x-www-form-urlencoded"',
+        '    Body = "query=$([System.Net.WebUtility]::UrlEncode($query))"',
+        '    OutFile = "sparql-generated.json"',
+        "}",
+        "",
+        "Invoke-WebRequest @params",
+      ];
+      const psString = lines.join("\n");
+
+      expect(psString).to.include('$query = @"');
+      expect(psString).to.include('"@');
+      expect(psString).to.include(query);
+      expect(psString).to.include('Body = "query=$([System.Net.WebUtility]::UrlEncode($query))"');
+      expect(psString).to.not.include('Body = "query=`$query"'); // Should NOT escape the variable
+      expect(psString).to.include("sparql-generated");
     });
 
     it("should format wget commands with proper line breaks", () => {

package/src/index.ts

@@ -46,6 +46,10 @@ export interface Yasqe {
   off(eventName: "autocompletionClose", handler: (instance: Yasqe) => void): void;
   on(eventName: "resize", handler: (instance: Yasqe, newSize: string) => void): void;
   off(eventName: "resize", handler: (instance: Yasqe, newSize: string) => void): void;
+  on(eventName: "saveManagedQuery", handler: () => void): void;
+  off(eventName: "saveManagedQuery", handler: () => void): void;
+  on(eventName: "downloadRqFile", handler: () => void): void;
+  off(eventName: "downloadRqFile", handler: () => void): void;
   on(eventName: string, handler: () => void): void;
 }
 
@@ -59,7 +63,7 @@ export class Yasqe extends CodeMirror {
   private abortController: AbortController | undefined;
   private queryStatus: "valid" | "error" | undefined;
   private queryBtn: HTMLButtonElement | undefined;
-  private saveBtn: HTMLButtonElement | undefined;
+  private saveBtnWrapper: HTMLDivElement | undefined;
   private fullscreenBtn: HTMLButtonElement | undefined;
   private hamburgerBtn: HTMLButtonElement | undefined;
   private hamburgerMenu: HTMLDivElement | undefined;
@@ -570,24 +574,42 @@ export class Yasqe extends CodeMirror {
     }
 
     /**
-     * Draw save button (THIRD)
+     * Draw save buttons (THIRD)
      */
-    const saveBtn = document.createElement("button");
-    addClass(saveBtn, "yasqe_saveButton");
-    const saveIcon = document.createElement("i");
-    addClass(saveIcon, "fas");
-    addClass(saveIcon, "fa-save");
-    saveIcon.setAttribute("aria-hidden", "true");
-    saveBtn.appendChild(saveIcon);
-    saveBtn.onclick = () => {
-      // Call the managed query save function if available
+    const saveBtnWrapper = document.createElement("div");
+    addClass(saveBtnWrapper, "yasqe_saveWrapper");
+    saveBtnWrapper.style.display = "none"; // Hidden by default, shown when workspace is configured
+    this.saveBtnWrapper = saveBtnWrapper;
+
+    const saveManagedBtn = document.createElement("button");
+    addClass(saveManagedBtn, "yasqe_saveManagedButton");
+    const saveManagedIcon = document.createElement("i");
+    addClass(saveManagedIcon, "fas");
+    addClass(saveManagedIcon, "fa-database");
+    saveManagedIcon.setAttribute("aria-hidden", "true");
+    saveManagedBtn.appendChild(saveManagedIcon);
+    saveManagedBtn.title = "Save as managed query";
+    saveManagedBtn.setAttribute("aria-label", "Save as managed query");
+    saveManagedBtn.onclick = () => {
       this.emit("saveManagedQuery");
     };
-    saveBtn.title = "Save managed query (Ctrl+S)";
-    saveBtn.setAttribute("aria-label", "Save managed query");
-    saveBtn.style.display = "none"; // Hidden by default, shown when workspace is configured
-    this.saveBtn = saveBtn;
-    buttons.appendChild(saveBtn);
+    saveBtnWrapper.appendChild(saveManagedBtn);
+
+    const saveRqBtn = document.createElement("button");
+    addClass(saveRqBtn, "yasqe_saveRqButton");
+    const saveRqIcon = document.createElement("i");
+    addClass(saveRqIcon, "fas");
+    addClass(saveRqIcon, "fa-file-download");
+    saveRqIcon.setAttribute("aria-hidden", "true");
+    saveRqBtn.appendChild(saveRqIcon);
+    saveRqBtn.title = "Save as .rq file";
+    saveRqBtn.setAttribute("aria-label", "Save as .rq file");
+    saveRqBtn.onclick = () => {
+      this.emit("downloadRqFile");
+    };
+    saveBtnWrapper.appendChild(saveRqBtn);
+
+    buttons.appendChild(saveBtnWrapper);
 
     /**
      * Draw format btn (FOURTH)
@@ -671,21 +693,37 @@ export class Yasqe extends CodeMirror {
       this.hamburgerMenu.appendChild(shareItem);
     }
 
-    const saveItem = document.createElement("button");
-    saveItem.className = "yasqe_hamburgerMenuItem";
-    const saveIconMenu = document.createElement("i");
-    addClass(saveIconMenu, "fas");
-    addClass(saveIconMenu, "fa-save");
-    saveIconMenu.setAttribute("aria-hidden", "true");
-    saveItem.appendChild(saveIconMenu);
-    const saveLabel = document.createElement("span");
-    saveLabel.textContent = "Save";
-    saveItem.appendChild(saveLabel);
-    saveItem.onclick = () => {
+    const saveManagedItem = document.createElement("button");
+    saveManagedItem.className = "yasqe_hamburgerMenuItem";
+    const saveManagedIconMenu = document.createElement("i");
+    addClass(saveManagedIconMenu, "fas");
+    addClass(saveManagedIconMenu, "fa-database");
+    saveManagedIconMenu.setAttribute("aria-hidden", "true");
+    saveManagedItem.appendChild(saveManagedIconMenu);
+    const saveManagedLabel = document.createElement("span");
+    saveManagedLabel.textContent = "Save as managed query";
+    saveManagedItem.appendChild(saveManagedLabel);
+    saveManagedItem.onclick = () => {
       this.closeHamburgerMenu();
       this.emit("saveManagedQuery");
     };
-    this.hamburgerMenu.appendChild(saveItem);
+    this.hamburgerMenu.appendChild(saveManagedItem);
+
+    const saveRqItem = document.createElement("button");
+    saveRqItem.className = "yasqe_hamburgerMenuItem";
+    const saveRqIconMenu = document.createElement("i");
+    addClass(saveRqIconMenu, "fas");
+    addClass(saveRqIconMenu, "fa-file-download");
+    saveRqIconMenu.setAttribute("aria-hidden", "true");
+    saveRqItem.appendChild(saveRqIconMenu);
+    const saveRqLabel = document.createElement("span");
+    saveRqLabel.textContent = "Save as .rq file";
+    saveRqItem.appendChild(saveRqLabel);
+    saveRqItem.onclick = () => {
+      this.closeHamburgerMenu();
+      this.emit("downloadRqFile");
+    };
+    this.hamburgerMenu.appendChild(saveRqItem);
 
     if (this.config.showFormatButton) {
       const formatItem = document.createElement("button");
@@ -1553,8 +1591,8 @@ export class Yasqe extends CodeMirror {
   }
 
   public setSaveButtonVisible(visible: boolean) {
-    if (this.saveBtn) {
-      this.saveBtn.style.display = visible ? "inline-flex" : "none";
+    if (this.saveBtnWrapper) {
+      this.saveBtnWrapper.style.display = visible ? "inline-flex" : "none";
     }
   }
 

package/src/scss/buttons.scss

@@ -293,25 +293,33 @@
       }
     }
 
-    .yasqe_saveButton {
+    .yasqe_saveWrapper {
+      position: relative;
       display: inline-flex;
       align-items: center;
-      justify-content: center;
-      border: none;
-      background: none;
-      cursor: pointer;
-      padding: 6px;
+      vertical-align: middle;
       margin-left: 8px;
-      height: 36px;
-      width: 36px;
-      color: var(--yasgui-text-secondary, #505050);
 
-      i {
-        font-size: 20px;
-      }
+      .yasqe_saveManagedButton,
+      .yasqe_saveRqButton {
+        display: inline-flex;
+        align-items: center;
+        justify-content: center;
+        border: none;
+        background: none;
+        cursor: pointer;
+        padding: 6px;
+        height: 36px;
+        width: 36px;
+        color: var(--yasgui-text-secondary, #505050);
 
-      &:hover {
-        color: #337ab7;
+        i {
+          font-size: 20px;
+        }
+
+        &:hover {
+          color: #337ab7;
+        }
       }
     }
 
@@ -441,7 +449,7 @@
   @media (max-width: 768px) {
     .yasqe_buttons {
       .yasqe_share,
-      .yasqe_saveButton,
+      .yasqe_saveWrapper,
       .yasqe_formatButton,
       .yasqe_fullscreenButton {
         display: none !important;

package/src/sparql.ts

@@ -174,6 +174,13 @@ export function getAjaxConfig(
 export interface ExecuteQueryOptions {
   customQuery?: string;
   customAccept?: string;
+  /** Optional external abort signal, useful for plugin-driven background fetches. */
+  signal?: AbortSignal;
+  /**
+   * Execute without emitting Yasqe query lifecycle events.
+   * Useful for background/plugin-driven queries that should not update main UI state.
+   */
+  silent?: boolean;
 }
 
 export async function executeQuery(
@@ -182,13 +189,21 @@ export async function executeQuery(
   options?: ExecuteQueryOptions,
 ): Promise<any> {
   const queryStart = Date.now();
+  const silent = !!options?.silent;
   try {
-    yasqe.emit("queryBefore", yasqe, config);
+    if (!silent) yasqe.emit("queryBefore", yasqe, config);
     const populatedConfig = getAjaxConfig(yasqe, config);
     if (!populatedConfig) {
       return; // Nothing to query
     }
     const abortController = new AbortController();
+    if (options?.signal) {
+      if (options.signal.aborted) {
+        abortController.abort();
+      } else {
+        options.signal.addEventListener("abort", () => abortController.abort(), { once: true });
+      }
+    }
 
     // Use custom accept header if provided, otherwise use the default
     const acceptHeader = options?.customAccept || populatedConfig.accept;
@@ -256,17 +271,22 @@ export async function executeQuery(
       populatedConfig.url = url.toString();
     }
     const request = new Request(populatedConfig.url, fetchOptions);
-    yasqe.emit("query", request, abortController);
+    if (!silent) yasqe.emit("query", request, abortController);
     const response = await fetch(request);
 
     // Await the response content and merge with the `Response` object
+    const content = await response.text();
     const queryResponse = {
       ok: response.ok,
       status: response.status,
       statusText: response.statusText,
       headers: response.headers,
       type: response.type,
-      content: await response.text(),
+      content,
+      // Compatibility aliases for plugins that expect fetch-like or axios-like response objects.
+      data: content,
+      json: async () => JSON.parse(content),
+      text: async () => content,
     };
 
     if (!response.ok) {
@@ -278,8 +298,10 @@ export async function executeQuery(
       throw error;
     }
 
-    yasqe.emit("queryResponse", queryResponse, Date.now() - queryStart);
-    yasqe.emit("queryResults", queryResponse.content, Date.now() - queryStart);
+    if (!silent) {
+      yasqe.emit("queryResponse", queryResponse, Date.now() - queryStart);
+      yasqe.emit("queryResults", queryResponse.content, Date.now() - queryStart);
+    }
     return queryResponse;
   } catch (e) {
     if (e instanceof Error && e.message === "Aborted") {
@@ -292,12 +314,12 @@ export async function executeQuery(
         if (e.message.includes("Failed to fetch") || e.message.includes("NetworkError")) {
           enhancedError.message = `${e.message}. The server may have returned an error response (check browser dev tools), but CORS headers are preventing JavaScript from accessing it. Ensure the endpoint returns proper CORS headers even for error responses (Access-Control-Allow-Origin, etc.).`;
         }
-        yasqe.emit("queryResponse", enhancedError, Date.now() - queryStart);
+        if (!silent) yasqe.emit("queryResponse", enhancedError, Date.now() - queryStart);
       } else {
-        yasqe.emit("queryResponse", e, Date.now() - queryStart);
+        if (!silent) yasqe.emit("queryResponse", e, Date.now() - queryStart);
       }
     }
-    yasqe.emit("error", e);
+    if (!silent) yasqe.emit("error", e);
     throw e;
   }
 }
@@ -520,10 +542,48 @@ export function getAsPowerShellString(yasqe: Yasqe, _config?: Config["requestCon
       lines.push(headersLines.join("\n"));
       lines.push("    }");
     }
-    lines.push(`    OutFile = "result.${fileExtension}"`);
+    lines.push(`    OutFile = "sparql-generated.${fileExtension}"`);
     lines.push("}");
   } else if (ajaxConfig.reqMethod === "POST") {
-    const body = queryString.stringify(ajaxConfig.args);
+    // Extract the query/update parameter and other parameters separately
+    // Determine the query parameter name first (query takes precedence over update)
+    const queryParamName = ajaxConfig.args.query !== undefined ? "query" : "update";
+    const queryParam = ajaxConfig.args[queryParamName];
+
+    const otherArgs: RequestArgs = {};
+    for (const key in ajaxConfig.args) {
+      if (key !== "query" && key !== "update") {
+        otherArgs[key] = ajaxConfig.args[key];
+      }
+    }
+
+    // Build the query string using here-string for easy editing
+    if (queryParam) {
+      // Handle both string and string[] cases - use first element if array
+      const queryText = Array.isArray(queryParam) ? queryParam[0] : queryParam;
+      lines.push(`$${queryParamName} = @"`);
+      lines.push(queryText);
+      lines.push(`"@`);
+      lines.push("");
+    }
+
+    // Build the body with the query variable and any other parameters
+    // The query must be URL-encoded for application/x-www-form-urlencoded
+    let bodyExpression: string;
+    const urlEncodeExpr = `[System.Net.WebUtility]::UrlEncode($${queryParamName})`;
+    if (queryParam && Object.keys(otherArgs).length > 0) {
+      // Both query variable and other args
+      const otherArgsString = queryString.stringify(otherArgs);
+      bodyExpression = `"${queryParamName}=$(${urlEncodeExpr})&${escapePowerShellString(otherArgsString)}"`;
+    } else if (queryParam) {
+      // Only query variable - use subexpression for URL encoding
+      bodyExpression = `"${queryParamName}=$(${urlEncodeExpr})"`;
+    } else {
+      // Only other args (shouldn't happen, but handle it)
+      const otherArgsString = queryString.stringify(otherArgs);
+      bodyExpression = `"${escapePowerShellString(otherArgsString)}"`;
+    }
+
     lines.push("$params = @{");
     lines.push(`    Uri = "${escapePowerShellString(url)}"`);
     lines.push(`    Method = "Post"`);
@@ -533,8 +593,8 @@ export function getAsPowerShellString(yasqe: Yasqe, _config?: Config["requestCon
       lines.push("    }");
     }
     lines.push(`    ContentType = "application/x-www-form-urlencoded"`);
-    lines.push(`    Body = "${escapePowerShellString(body)}"`);
-    lines.push(`    OutFile = "result.${fileExtension}"`);
+    lines.push(`    Body = ${bodyExpression}`);
+    lines.push(`    OutFile = "sparql-generated.${fileExtension}"`);
     lines.push("}");
   } else {
     // Handle other methods (PUT, DELETE, etc.)
@@ -552,7 +612,7 @@ export function getAsPowerShellString(yasqe: Yasqe, _config?: Config["requestCon
       lines.push(`    ContentType = "application/x-www-form-urlencoded"`);
       lines.push(`    Body = "${body.replace(/"/g, '`"')}"`);
     }
-    lines.push(`    OutFile = "result.${fileExtension}"`);
+    lines.push(`    OutFile = "sparql-generated.${fileExtension}"`);
     lines.push("}");
   }