@matdata/yasqe 4.6.1 → 4.7.4

package/src/sparql.ts

@@ -1,215 +1,215 @@
-import { default as Yasqe, Config, RequestConfig } from "./";
-import { merge, isFunction } from "lodash-es";
-import * as queryString from "query-string";
-export type YasqeAjaxConfig = Config["requestConfig"];
-export interface PopulatedAjaxConfig {
-  url: string;
-  reqMethod: "POST" | "GET";
-  headers: { [key: string]: string };
-  accept: string;
-  args: RequestArgs;
-  withCredentials: boolean;
-}
-function getRequestConfigSettings(yasqe: Yasqe, conf?: Partial<Config["requestConfig"]>): RequestConfig<Yasqe> {
-  if (isFunction(conf)) {
-    return conf(yasqe) as RequestConfig<Yasqe>;
-  }
-  return (conf ?? {}) as RequestConfig<Yasqe>;
-}
-// type callback = AjaxConfig.callbacks['complete'];
-export function getAjaxConfig(
-  yasqe: Yasqe,
-  _config: Partial<Config["requestConfig"]> = {},
-): PopulatedAjaxConfig | undefined {
-  const config: RequestConfig<Yasqe> = merge(
-    {},
-    getRequestConfigSettings(yasqe, yasqe.config.requestConfig),
-    getRequestConfigSettings(yasqe, _config),
-  );
-  if (!config.endpoint || config.endpoint.length == 0) return; // nothing to query!
-
-  var queryMode = yasqe.getQueryMode();
-  /**
-   * initialize ajax config
-   */
-  const endpoint = isFunction(config.endpoint) ? config.endpoint(yasqe) : config.endpoint;
-  var reqMethod: "GET" | "POST" =
-    queryMode == "update" ? "POST" : isFunction(config.method) ? config.method(yasqe) : config.method;
-  const headers = isFunction(config.headers) ? config.headers(yasqe) : config.headers;
-  // console.log({headers})
-  const withCredentials = isFunction(config.withCredentials) ? config.withCredentials(yasqe) : config.withCredentials;
-  return {
-    reqMethod,
-    url: endpoint,
-    args: getUrlArguments(yasqe, config),
-    headers: headers,
-    accept: getAcceptHeader(yasqe, config),
-    withCredentials,
-  };
-  /**
-   * merge additional request headers
-   */
-}
-
-export async function executeQuery(yasqe: Yasqe, config?: YasqeAjaxConfig): Promise<any> {
-  const queryStart = Date.now();
-  try {
-    yasqe.emit("queryBefore", yasqe, config);
-    const populatedConfig = getAjaxConfig(yasqe, config);
-    if (!populatedConfig) {
-      return; // Nothing to query
-    }
-    const abortController = new AbortController();
-
-    const fetchOptions: RequestInit = {
-      method: populatedConfig.reqMethod,
-      headers: {
-        Accept: populatedConfig.accept,
-        ...(populatedConfig.headers || {}),
-      },
-      credentials: populatedConfig.withCredentials ? "include" : "same-origin",
-      signal: abortController.signal,
-    };
-    if (fetchOptions?.headers && populatedConfig.reqMethod === "POST") {
-      (fetchOptions.headers as Record<string, string>)["Content-Type"] = "application/x-www-form-urlencoded";
-    }
-    const searchParams = new URLSearchParams();
-    for (const key in populatedConfig.args) {
-      const value = populatedConfig.args[key];
-      if (Array.isArray(value)) {
-        value.forEach((v) => searchParams.append(key, v));
-      } else {
-        searchParams.append(key, value);
-      }
-    }
-    if (populatedConfig.reqMethod === "POST") {
-      fetchOptions.body = searchParams.toString();
-    } else {
-      const url = new URL(populatedConfig.url);
-      searchParams.forEach((value, key) => {
-        url.searchParams.append(key, value);
-      });
-      populatedConfig.url = url.toString();
-    }
-    const request = new Request(populatedConfig.url, fetchOptions);
-    yasqe.emit("query", request, abortController);
-    const response = await fetch(request);
-    if (!response.ok) {
-      throw new Error((await response.text()) || response.statusText);
-    }
-    // Await the response content and merge with the `Response` object
-    const queryResponse = {
-      ok: response.ok,
-      status: response.status,
-      statusText: response.statusText,
-      headers: response.headers,
-      type: response.type,
-      content: await response.text(),
-    };
-    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") {
-      // The query was aborted. We should not do or draw anything
-    } else {
-      yasqe.emit("queryResponse", e, Date.now() - queryStart);
-    }
-    yasqe.emit("error", e);
-    throw e;
-  }
-}
-
-export type RequestArgs = { [argName: string]: string | string[] };
-export function getUrlArguments(yasqe: Yasqe, _config: Config["requestConfig"]): RequestArgs {
-  var queryMode = yasqe.getQueryMode();
-
-  var data: RequestArgs = {};
-  const config: RequestConfig<Yasqe> = getRequestConfigSettings(yasqe, _config);
-  var queryArg = isFunction(config.queryArgument) ? config.queryArgument(yasqe) : config.queryArgument;
-  if (!queryArg) queryArg = yasqe.getQueryMode();
-  data[queryArg] = config.adjustQueryBeforeRequest ? config.adjustQueryBeforeRequest(yasqe) : yasqe.getValue();
-  /**
-   * add named graphs to ajax config
-   */
-  const namedGraphs = isFunction(config.namedGraphs) ? config.namedGraphs(yasqe) : config.namedGraphs;
-  if (namedGraphs && namedGraphs.length > 0) {
-    let argName = queryMode === "query" ? "named-graph-uri" : "using-named-graph-uri ";
-    data[argName] = namedGraphs;
-  }
-  /**
-   * add default graphs to ajax config
-   */
-  const defaultGraphs = isFunction(config.defaultGraphs) ? config.defaultGraphs(yasqe) : config.defaultGraphs;
-  if (defaultGraphs && defaultGraphs.length > 0) {
-    let argName = queryMode == "query" ? "default-graph-uri" : "using-graph-uri ";
-    data[argName] = namedGraphs;
-  }
-
-  /**
-   * add additional request args
-   */
-  const args = isFunction(config.args) ? config.args(yasqe) : config.args;
-  if (args && args.length > 0)
-    merge(
-      data,
-      args.reduce((argsObject: { [key: string]: string[] }, arg) => {
-        argsObject[arg.name] ? argsObject[arg.name].push(arg.value) : (argsObject[arg.name] = [arg.value]);
-        return argsObject;
-      }, {}),
-    );
-
-  return data;
-}
-export function getAcceptHeader(yasqe: Yasqe, _config: Config["requestConfig"]) {
-  const config: RequestConfig<Yasqe> = getRequestConfigSettings(yasqe, _config);
-  var acceptHeader = null;
-  if (yasqe.getQueryMode() == "update") {
-    acceptHeader = isFunction(config.acceptHeaderUpdate) ? config.acceptHeaderUpdate(yasqe) : config.acceptHeaderUpdate;
-  } else {
-    var qType = yasqe.getQueryType();
-    if (qType == "DESCRIBE" || qType == "CONSTRUCT") {
-      acceptHeader = isFunction(config.acceptHeaderGraph) ? config.acceptHeaderGraph(yasqe) : config.acceptHeaderGraph;
-    } else {
-      acceptHeader = isFunction(config.acceptHeaderSelect)
-        ? config.acceptHeaderSelect(yasqe)
-        : config.acceptHeaderSelect;
-    }
-  }
-  return acceptHeader;
-}
-export function getAsCurlString(yasqe: Yasqe, _config?: Config["requestConfig"]) {
-  let ajaxConfig = getAjaxConfig(yasqe, getRequestConfigSettings(yasqe, _config));
-  if (!ajaxConfig) return "";
-  let url = ajaxConfig.url;
-  if (ajaxConfig.url.indexOf("http") !== 0) {
-    //this is either a relative or absolute url, which is not supported by CURL.
-    //Add domain, schema, etc etc
-    url = `${window.location.protocol}//${window.location.host}`;
-    if (ajaxConfig.url.indexOf("/") === 0) {
-      //its an absolute path
-      url += ajaxConfig.url;
-    } else {
-      //relative, so append current location to url first
-      url += window.location.pathname + ajaxConfig.url;
-    }
-  }
-  const segments: string[] = ["curl"];
-
-  if (ajaxConfig.reqMethod === "GET") {
-    url += `?${queryString.stringify(ajaxConfig.args)}`;
-    segments.push(url);
-  } else if (ajaxConfig.reqMethod === "POST") {
-    segments.push(url);
-    segments.push("--data", queryString.stringify(ajaxConfig.args));
-  } else {
-    // I don't expect to get here but let's be sure
-    console.warn("Unexpected request-method", ajaxConfig.reqMethod);
-    segments.push(url);
-  }
-  segments.push("-X", ajaxConfig.reqMethod);
-  for (const header in ajaxConfig.headers) {
-    segments.push(`-H  '${header}: ${ajaxConfig.headers[header]}'`);
-  }
-  return segments.join(" ");
-}
+import { default as Yasqe, Config, RequestConfig } from "./";
+import { merge, isFunction } from "lodash-es";
+import * as queryString from "query-string";
+export type YasqeAjaxConfig = Config["requestConfig"];
+export interface PopulatedAjaxConfig {
+  url: string;
+  reqMethod: "POST" | "GET";
+  headers: { [key: string]: string };
+  accept: string;
+  args: RequestArgs;
+  withCredentials: boolean;
+}
+function getRequestConfigSettings(yasqe: Yasqe, conf?: Partial<Config["requestConfig"]>): RequestConfig<Yasqe> {
+  if (isFunction(conf)) {
+    return conf(yasqe) as RequestConfig<Yasqe>;
+  }
+  return (conf ?? {}) as RequestConfig<Yasqe>;
+}
+// type callback = AjaxConfig.callbacks['complete'];
+export function getAjaxConfig(
+  yasqe: Yasqe,
+  _config: Partial<Config["requestConfig"]> = {},
+): PopulatedAjaxConfig | undefined {
+  const config: RequestConfig<Yasqe> = merge(
+    {},
+    getRequestConfigSettings(yasqe, yasqe.config.requestConfig),
+    getRequestConfigSettings(yasqe, _config),
+  );
+  if (!config.endpoint || config.endpoint.length == 0) return; // nothing to query!
+
+  var queryMode = yasqe.getQueryMode();
+  /**
+   * initialize ajax config
+   */
+  const endpoint = isFunction(config.endpoint) ? config.endpoint(yasqe) : config.endpoint;
+  var reqMethod: "GET" | "POST" =
+    queryMode == "update" ? "POST" : isFunction(config.method) ? config.method(yasqe) : config.method;
+  const headers = isFunction(config.headers) ? config.headers(yasqe) : config.headers;
+  // console.log({headers})
+  const withCredentials = isFunction(config.withCredentials) ? config.withCredentials(yasqe) : config.withCredentials;
+  return {
+    reqMethod,
+    url: endpoint,
+    args: getUrlArguments(yasqe, config),
+    headers: headers,
+    accept: getAcceptHeader(yasqe, config),
+    withCredentials,
+  };
+  /**
+   * merge additional request headers
+   */
+}
+
+export async function executeQuery(yasqe: Yasqe, config?: YasqeAjaxConfig): Promise<any> {
+  const queryStart = Date.now();
+  try {
+    yasqe.emit("queryBefore", yasqe, config);
+    const populatedConfig = getAjaxConfig(yasqe, config);
+    if (!populatedConfig) {
+      return; // Nothing to query
+    }
+    const abortController = new AbortController();
+
+    const fetchOptions: RequestInit = {
+      method: populatedConfig.reqMethod,
+      headers: {
+        Accept: populatedConfig.accept,
+        ...(populatedConfig.headers || {}),
+      },
+      credentials: populatedConfig.withCredentials ? "include" : "same-origin",
+      signal: abortController.signal,
+    };
+    if (fetchOptions?.headers && populatedConfig.reqMethod === "POST") {
+      (fetchOptions.headers as Record<string, string>)["Content-Type"] = "application/x-www-form-urlencoded";
+    }
+    const searchParams = new URLSearchParams();
+    for (const key in populatedConfig.args) {
+      const value = populatedConfig.args[key];
+      if (Array.isArray(value)) {
+        value.forEach((v) => searchParams.append(key, v));
+      } else {
+        searchParams.append(key, value);
+      }
+    }
+    if (populatedConfig.reqMethod === "POST") {
+      fetchOptions.body = searchParams.toString();
+    } else {
+      const url = new URL(populatedConfig.url);
+      searchParams.forEach((value, key) => {
+        url.searchParams.append(key, value);
+      });
+      populatedConfig.url = url.toString();
+    }
+    const request = new Request(populatedConfig.url, fetchOptions);
+    yasqe.emit("query", request, abortController);
+    const response = await fetch(request);
+    if (!response.ok) {
+      throw new Error((await response.text()) || response.statusText);
+    }
+    // Await the response content and merge with the `Response` object
+    const queryResponse = {
+      ok: response.ok,
+      status: response.status,
+      statusText: response.statusText,
+      headers: response.headers,
+      type: response.type,
+      content: await response.text(),
+    };
+    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") {
+      // The query was aborted. We should not do or draw anything
+    } else {
+      yasqe.emit("queryResponse", e, Date.now() - queryStart);
+    }
+    yasqe.emit("error", e);
+    throw e;
+  }
+}
+
+export type RequestArgs = { [argName: string]: string | string[] };
+export function getUrlArguments(yasqe: Yasqe, _config: Config["requestConfig"]): RequestArgs {
+  var queryMode = yasqe.getQueryMode();
+
+  var data: RequestArgs = {};
+  const config: RequestConfig<Yasqe> = getRequestConfigSettings(yasqe, _config);
+  var queryArg = isFunction(config.queryArgument) ? config.queryArgument(yasqe) : config.queryArgument;
+  if (!queryArg) queryArg = yasqe.getQueryMode();
+  data[queryArg] = config.adjustQueryBeforeRequest ? config.adjustQueryBeforeRequest(yasqe) : yasqe.getValue();
+  /**
+   * add named graphs to ajax config
+   */
+  const namedGraphs = isFunction(config.namedGraphs) ? config.namedGraphs(yasqe) : config.namedGraphs;
+  if (namedGraphs && namedGraphs.length > 0) {
+    let argName = queryMode === "query" ? "named-graph-uri" : "using-named-graph-uri ";
+    data[argName] = namedGraphs;
+  }
+  /**
+   * add default graphs to ajax config
+   */
+  const defaultGraphs = isFunction(config.defaultGraphs) ? config.defaultGraphs(yasqe) : config.defaultGraphs;
+  if (defaultGraphs && defaultGraphs.length > 0) {
+    let argName = queryMode == "query" ? "default-graph-uri" : "using-graph-uri ";
+    data[argName] = namedGraphs;
+  }
+
+  /**
+   * add additional request args
+   */
+  const args = isFunction(config.args) ? config.args(yasqe) : config.args;
+  if (args && args.length > 0)
+    merge(
+      data,
+      args.reduce((argsObject: { [key: string]: string[] }, arg) => {
+        argsObject[arg.name] ? argsObject[arg.name].push(arg.value) : (argsObject[arg.name] = [arg.value]);
+        return argsObject;
+      }, {}),
+    );
+
+  return data;
+}
+export function getAcceptHeader(yasqe: Yasqe, _config: Config["requestConfig"]) {
+  const config: RequestConfig<Yasqe> = getRequestConfigSettings(yasqe, _config);
+  var acceptHeader = null;
+  if (yasqe.getQueryMode() == "update") {
+    acceptHeader = isFunction(config.acceptHeaderUpdate) ? config.acceptHeaderUpdate(yasqe) : config.acceptHeaderUpdate;
+  } else {
+    var qType = yasqe.getQueryType();
+    if (qType == "DESCRIBE" || qType == "CONSTRUCT") {
+      acceptHeader = isFunction(config.acceptHeaderGraph) ? config.acceptHeaderGraph(yasqe) : config.acceptHeaderGraph;
+    } else {
+      acceptHeader = isFunction(config.acceptHeaderSelect)
+        ? config.acceptHeaderSelect(yasqe)
+        : config.acceptHeaderSelect;
+    }
+  }
+  return acceptHeader;
+}
+export function getAsCurlString(yasqe: Yasqe, _config?: Config["requestConfig"]) {
+  let ajaxConfig = getAjaxConfig(yasqe, getRequestConfigSettings(yasqe, _config));
+  if (!ajaxConfig) return "";
+  let url = ajaxConfig.url;
+  if (ajaxConfig.url.indexOf("http") !== 0) {
+    //this is either a relative or absolute url, which is not supported by CURL.
+    //Add domain, schema, etc etc
+    url = `${window.location.protocol}//${window.location.host}`;
+    if (ajaxConfig.url.indexOf("/") === 0) {
+      //its an absolute path
+      url += ajaxConfig.url;
+    } else {
+      //relative, so append current location to url first
+      url += window.location.pathname + ajaxConfig.url;
+    }
+  }
+  const segments: string[] = ["curl"];
+
+  if (ajaxConfig.reqMethod === "GET") {
+    url += `?${queryString.stringify(ajaxConfig.args)}`;
+    segments.push(url);
+  } else if (ajaxConfig.reqMethod === "POST") {
+    segments.push(url);
+    segments.push("--data", queryString.stringify(ajaxConfig.args));
+  } else {
+    // I don't expect to get here but let's be sure
+    console.warn("Unexpected request-method", ajaxConfig.reqMethod);
+    segments.push(url);
+  }
+  segments.push("-X", ajaxConfig.reqMethod);
+  for (const header in ajaxConfig.headers) {
+    segments.push(`-H  '${header}: ${ajaxConfig.headers[header]}'`);
+  }
+  return segments.join(" ");
+}